An overview of the processor is detailed here
{
transaction: {
networkMap; // https://raw.githubusercontent.com/frmscoe/frms-coe-lib/aad0f12d07a82dd948fa9d8033f96e9bf8cb3dde/src/interfaces/NetworkMap.ts
ruleResult; // https://raw.githubusercontent.com/frmscoe/frms-coe-lib/aad0f12d07a82dd948fa9d8033f96e9bf8cb3dde/src/interfaces/rule/RuleResult.ts
transaction; // { TxTp: "pacs.002.001.12", "FIToFIPmtSts": { /* Pacs002 */ } }
metaData: // { traceParent: "00-4bf92f3577b34da6a3ce928d0e0e4736-00f067aa0ba902b7-01" }
}
};graph TD;
start[Start] --> saveToRedis;
saveToRedis -->|Success| aggregateRules;
saveToRedis -->|Failure| logError1[Log Error];
aggregateRules --> evaluateTypologySendRequest;
evaluateTypologySendRequest -->|Success| checkRuleCount;
evaluateTypologySendRequest -->|Failure| logError2[Log Error];
checkRuleCount -->|Enough Rules| deleteCacheAndEnd[Delete Cache and End];
checkRuleCount -->|Not Enough Rules| End[End];
https://github.com/frmscoe/uml-diagrams/blob/main/TP.plantuml
// TADP
{
transaction: {
networkMap; // https://raw.githubusercontent.com/frmscoe/frms-coe-lib/aad0f12d07a82dd948fa9d8033f96e9bf8cb3dde/src/interfaces/NetworkMap.ts
ruleResult; // https://raw.githubusercontent.com/frmscoe/frms-coe-lib/aad0f12d07a82dd948fa9d8033f96e9bf8cb3dde/src/interfaces/rule/RuleResult.ts
transaction; // { TxTp: "pacs.002.001.12", "FIToFIPmtSts": { /* Pacs002 */ } }
metaData: // { traceParent: "00-4bf92f3577b34da6a3ce928d0e0e4736-00f067aa0ba902b7-01" }
}
};
// CMS on interdiction
{
typologyResult: TypologyResult; // https://raw.githubusercontent.com/frmscoe/frms-coe-lib/46d1ec1fc9a07b6556baa4fecd80e09c709ccb1b/src/interfaces/processor-files/TypologyResult.ts
transaction: Pacs002; // https://raw.githubusercontent.com/frmscoe/frms-coe-lib/cb464248be1efc45ba2701131e75fcf89c478baf/src/interfaces/Pacs.002.001.12.ts
networkMap: NetworkMap; // https://raw.githubusercontent.com/frmscoe/frms-coe-lib/aad0f12d07a82dd948fa9d8033f96e9bf8cb3dde/src/interfaces/NetworkMap.ts
metaData?: {
prcgTmDp: number;
prcgTmED: number;
}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 .envA registry of environment variables is provided to provide more context for what each variable is used for.
| Variable | Purpose | Example |
|---|---|---|
DATABASE_NAME |
ArangoDB database for TP | Configuration |
DATABASE_URL |
ArangoDB server URL | tcp://arango:8529 |
COLLECTION_NAME |
ArangoDB collection inside database for Typology Expressions | typologyExpression |
DATABASE_NETWORKMAP |
ArangoDB collection inside database for Network Map | networkmap |
DATABASE_USER |
ArangoDB username | root |
DATABASE_PASSWORD |
ArangoDB password for username | <secure_user_password> |
DATABASE_CERT_PATH |
Certificate's path used for TLS by Arango | <path_to_certificate> |
{
"desc": "Use of several currencies, structured transactions, with a great number of persons involved, large number of transactions related to each other during a short time period.",
"id": "typology-processor@1.0.0",
"cfg": "001@1.0.0",
"workflow": {
"alertThreshold": 800
},
"rules": [
{
"id": "003@1.0.0",
"cfg": "1.0.0",
"ref": ".err",
"true": 0,
"false": 0
},
{
"id": "003@1.0.0",
"cfg": "1.0.0",
"ref": ".01",
"true": 0,
"false": 0
},
{
"id": "003@1.0.0",
"cfg": "1.0.0",
"ref": ".02",
"true": 400,
"false": 0
}
],
"expression": {
"operator": "+",
"terms": [
{
"id": "083@1.0.0",
"cfg": "1.0.0"
}
]
}
}{
"transaction": {
"TxTp": "pain.001.001.11",
"CstmrCdtTrfInitn": {
"GrpHdr": {
"MsgId": "2669e349-500d-44ba-9e27-7767a16608a0",
"CreDtTm": "2021-10-07T09:25:31.000Z",
"NbOfTxs": 1,
"InitgPty": {
"Nm": "Ivan Reese Russel-Klein",
"Id": {
"PrvtId": {
"DtAndPlcOfBirth": {
"BirthDt": "1967-11-23",
"CityOfBirth": "Unknown",
"CtryOfBirth": "ZZ"
},
"Othr": {
"Id": "+27783078685",
"SchmeNm": {
"Prtry": "MSISDN"
}
}
}
},
"CtctDtls": {
"MobNb": "+27-783078685"
}
}
},
"PmtInf": {
"PmtInfId": "b51ec534-ee48-4575-b6a9-ead2955b8069",
"PmtMtd": "TRA",
"ReqdAdvcTp": {
"DbtAdvc": {
"Cd": "ADWD",
"Prtry": "Advice with transaction details"
}
},
"ReqdExctnDt": {
"Dt": "2021-10-07",
"DtTm": "2021-10-07T09:25:31.000Z"
},
"Dbtr": {
"Nm": "Ivan Reese Russel-Klein",
"Id": {
"PrvtId": {
"DtAndPlcOfBirth": {
"BirthDt": "1967-11-23",
"CityOfBirth": "Unknown",
"CtryOfBirth": "ZZ"
},
"Othr": {
"Id": "+27783078685",
"SchmeNm": {
"Prtry": "MSISDN"
}
}
}
},
"CtctDtls": {
"MobNb": "+27-783078685"
}
},
"DbtrAcct": {
"Id": {
"Othr": {
"Id": "+27783078685",
"SchmeNm": {
"Prtry": "PASSPORT"
}
}
},
"Nm": "Ivan Russel-Klein"
},
"DbtrAgt": {
"FinInstnId": {
"ClrSysMmbId": {
"MmbId": "dfsp001"
}
}
},
"CdtTrfTxInf": {
"PmtId": {
"EndToEndId": "c51ec534-ee48-4575-b6a9-ead2955b8069"
},
"PmtTpInf": {
"CtgyPurp": {
"Prtry": "TRANSFER"
}
},
"Amt": {
"InstdAmt": {
"Amt": {
"Amt": "50431891779910900",
"Ccy": "USD"
}
},
"EqvtAmt": {
"Amt": {
"Amt": "50431891779910900",
"Ccy": "USD"
},
"CcyOfTrf": "USD"
}
},
"ChrgBr": "DEBT",
"CdtrAgt": {
"FinInstnId": {
"ClrSysMmbId": {
"MmbId": "dfsp002"
}
}
},
"Cdtr": {
"Nm": "April Sam Adamson",
"Id": {
"PrvtId": {
"DtAndPlcOfBirth": {
"BirthDt": "1923-04-26",
"CityOfBirth": "Unknown",
"CtryOfBirth": "ZZ"
},
"Othr": {
"Id": "+27782722305",
"SchmeNm": {
"Prtry": "MSISDN"
}
}
}
},
"CtctDtls": {
"MobNb": "+27-782722305"
}
},
"CdtrAcct": {
"Id": {
"Othr": {
"Id": "+27783078685",
"SchmeNm": {
"Prtry": "MSISDN"
}
}
},
"Nm": "April Adamson"
},
"Purp": {
"Cd": "MP2P"
},
"RgltryRptg": {
"Dtls": {
"Tp": "BALANCE OF PAYMENTS",
"Cd": "100"
}
},
"RmtInf": {
"Ustrd": "Payment of USD 49932566118723700.89 from Ivan to April"
},
"SplmtryData": {
"Envlp": {
"Doc": {
"Cdtr": {
"FrstNm": "Ivan",
"MddlNm": "Reese",
"LastNm": "Russel-Klein",
"MrchntClssfctnCd": "BLANK"
},
"Dbtr": {
"FrstNm": "April",
"MddlNm": "Sam",
"LastNm": "Adamson",
"MrchntClssfctnCd": "BLANK"
},
"DbtrFinSvcsPrvdrFees": {
"Ccy": "USD",
"Amt": "499325661187237"
},
"Xprtn": "2021-10-07T09:30:31.000Z"
}
}
}
}
},
"SplmtryData": {
"Envlp": {
"Doc": {
"InitgPty": {
"InitrTp": "CONSUMER",
"Glctn": {
"Lat": "-3.1291",
"Long": "39.0006"
}
}
}
}
}
}
},
"ruleResult": {
"rule": "003@1.0.0",
"result": true,
"subRuleRef": "123"
"prcgTm": 123456,
"wght": 0
},
"networkMap": {
"active": true,
"cfg": "1.0.0",
"messages": [
{
"id": "004@1.0.0",
"host": "NATS Server",
"cfg": "1.0.0",
"txTp": "pacs.002.001.12",
"channels": [
{
"id": "001@1.0.0",
"host": "NATS Server",
"cfg": "1.0.0",
"typologies": [
{
"id": "typology-processor@1.0.0",
"host": "NATS Server",
"cfg": "001@1.0.0",
"rules": [
{
"id": "003@1.0.0",
"host": "RuleRequest003",
"cfg": "1.0.0"
}
]
}
]
}
]
}
]
}
}Ensure generated token has read package rights
Ensure that you're on the current LTS version of Node.JS