search

tazama-lf / event-flow

Apache License 2.0
0 stars 0 forks source link

readme

Event-flow

Overview

Specialized rule processor receives a message from the Event-Director and determines a result for a rule in a typology like a normal rule.

Services

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 https://github.com/tazama/event-flow
cd event-flow

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.

Build and Start

npm i
npm run build
npm run start

Testing

npm run test

Inputs

A message received from ED:

{
  metaData: { traceParent: "00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01" }, // https://www.w3.org/TR/trace-context/#examples-of-http-traceparent-headers
  transaction: { TxTp: "pacs.002.001.12", "FIToFIPmtSts": { /* Pacs002 */ } },
  networkMap: { /* Network Map */ },
  DataCache: { /* cached data relevant to the transaction */ }
};

Internal Process Flow

Sequence Diagram

sequenceDiagram
    participant A as TMS API
    participant B as NATS<br>(event-director)
    participant C as EVENT<br>DIRECTOR
    participant D as NATS<br>(sub-rule-EFRuP-*)

    A->>B: Publish message
    B->>+C: Read message
    C->>C: handleTransaction()
    C->>-D: Publish message/s

Activity Diagram

graph TD;
    start[Start] -->|Start| handleTransaction;
    handleTransaction -->|Success| getConditions;
    getConditions -->|Success| decodeConditions;
    decodeConditions -->|Failure| logError[Log Error];
    decodeConditions -->|Success| filter[Filter Conditions];
    filter[Filter Conditions] -->|Success| determineOutcome;
    determineOutcome -->|Success| sendResponse;
    determineOutcome -->|Failure| logError2[Log Error];
    determineOutcome -->|Alert| sendAlert;
    sendAlert -->|Success| sendResponse;
    sendResponse -->|Success| End;
    sendResponse -->|Failure| logError3[Log Error];

Outputs

The output is the input with an added RuleResult:

{
  metaData: { traceParent: "00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01" }, // https://www.w3.org/TR/trace-context/#examples-of-http-traceparent-headers
  transaction: { TxTp: "pacs.002.001.12", "FIToFIPmtSts": { /* Pacs002 */ } },
  networkMap: { /* Network Map */ },
  DataCache: { /* cached data relevant to the transaction */ },
  ruleResult: { /* rule result */ }
};

Publishing

EFRuP is standalone and does not require publishing like normal rules.

Troubleshooting