5. Transaction Aggregation and Decisioning Processor (TADP)

The sequence diagram below for the Transaction Aggregation and Decisioning Processor

Overview

Services

• PostgresQL: Database Management
• NATS: Message queue

You also need NodeJS to be installed in your system. The current LTS should be suitable. Please open an issue if the application fails to build on the current LTS version. Unix platforms, you should be able to find nodejs in your package manager's repositories.

Setting Up

git clone transaction-aggregation-decisioning-processor
cd transaction-aggregation-decisioning-processor

You then need to configure your environment: a sample configuration file has been provided and you may adapt that to your environment. Copy it to .env and modify as needed:

cp .env.template .env

A registry of environment variables is provided to provide more context for what each variable is used for.

Additional Variables

Name	Purpose	Example
SUPPRESS_ALERTS	Suppress forwarding report to NATS producer	false
RAW_HISTORY_DATABASE	PostgreSQL database name	raw_history
RAW_HISTORY_DATABASE_HOST	PostgreSQL hostname or endpoint	localhost
RAW_HISTORY_DATABASE_PORT	PostgreSQL post used	5432
RAW_HISTORY_DATABASE_USER	PostgreSQL username	root
RAW_HISTORY_DATABASE_PASSWORD	PostgreSQL database password	password
RAW_HISTORY_DATABASE_CERT_PATH	PostgreSQL certificate path	/path/to/cert
EVALUATION_DATABASE	PostgreSQL database name	evaluation
EVALUATION_DATABASE_HOST	PostgreSQL hostname or endpoint	localhost
EVALUATION_DATABASE_PORT	PostgreSQL post used	5432
EVALUATION_DATABASE_USER	PostgreSQL username	root
EVALUATION_DATABASE_PASSWORD	PostgreSQL database password	password
EVALUATION_DATABASE_CERT_PATH	PostgreSQL certificate path	/path/to/cert
CONFIGURATION_DATABASE	PostgreSQL database name	configuration
CONFIGURATION_DATABASE_HOST	PostgreSQL hostname or endpoint	localhost
CONFIGURATION_DATABASE_PORT	PostgreSQL post used	5432
CONFIGURATION_DATABASE_USER	PostgreSQL username	root
CONFIGURATION_DATABASE_PASSWORD	PostgreSQL database password	password
CONFIGURATION_DATABASE_CERT_PATH	PostgreSQL certificate path	/path/to/cert

Build and Start

npm i
npm run build
npm run start

Inputs

{
  typologyResult: TypologyResult; // https://raw.githubusercontent.com/tazama-lf/frms-coe-lib/46d1ec1fc9a07b6556baa4fecd80e09c709ccb1b/src/interfaces/processor-files/TypologyResult.ts
  transaction: Pacs002; // https://raw.githubusercontent.com/tazama-lf/frms-coe-lib/cb464248be1efc45ba2701131e75fcf89c478baf/src/interfaces/Pacs.002.001.12.ts
  networkMap: NetworkMap; // https://raw.githubusercontent.com/tazama-lf/frms-coe-lib/aad0f12d07a82dd948fa9d8033f96e9bf8cb3dde/src/interfaces/NetworkMap.ts
  metaData?: {
    prcgTmDp: number;
    prcgTmCRSP: number;
}

Where the transaction is described as a Pacs002 message defined here

Code Activity Diagram

  flowchart TD
  A([Start handleExecute]) -->|Parse rawTransaction| B[Set transaction details]
  B --> C[Start APM Transaction]
  C --> D{Typologies Matched?}
  D -->|Yes| E[Process Typologies]
  D -->|No| F[Log Error and Exit]
  E --> G{All Typologies Processed?}
  G -->|Yes| H[Create Alert and CMSRequest]
  H --> I[Insert Transaction History]
  I --> J[Calculate Processing Time]
  J --> K[Handle Server Response]
  K --> L([End APM Transaction])
  F --> L
  G -->|No| F

Loading

• Start handleExecute: Initiation of the handleExecute function.
• Set transaction details: Parsing and extracting data from rawTransaction into usable variables.
• Start APM Transaction: Begin a transaction monitoring session to track performance.
• Typologies Matched?: Checks if there are any matching typologies for the transaction.
• Process Typologies: Process matching typologies if found.
• All Typologies Processed?: Verifies if all typologies were processed.
• Create Alert and CMSRequest: Constructs an alert and formats the CMS request if all typologies are processed.
• Insert Transaction History: Inserts a record of the transaction into the database.
• Calculate Processing Time: Calculates the time taken to process the transaction.
• Handle Server Response: Sends a response back through the server.
• End APM Transaction: Marks the end of the APM transaction session.
• Log Error and Exit: Logs any errors encountered during the process and exits the function if any step fails significantly.

Outputs

The output is the input with an added tadpResult:

{
  typologyResult: TypologyResult; // https://raw.githubusercontent.com/tazama-lf/frms-coe-lib/46d1ec1fc9a07b6556baa4fecd80e09c709ccb1b/src/interfaces/processor-files/TypologyResult.ts
  transaction: Pacs002; // https://raw.githubusercontent.com/tazama-lf/frms-coe-lib/cb464248be1efc45ba2701131e75fcf89c478baf/src/interfaces/Pacs.002.001.12.ts
  networkMap: NetworkMap; // https://raw.githubusercontent.com/tazama-lf/frms-coe-lib/aad0f12d07a82dd948fa9d8033f96e9bf8cb3dde/src/interfaces/NetworkMap.ts
  metaData?: {
    prcgTmDp: number;
    prcgTmCRSP: number;
  },
  tadpResult: TADPResult;
}