	ATTENTION: This page has been migrated to the Tazama GitHub repository and is now located at: https://github.com/frmscoe/docs/blob/main/Product/07-Creating-And-Maintaining-Processors/02-Create-New-Rule-Processor.md This page will no longer be maintained in Confluence.

	ATTENTION: This page has been migrated to the Tazama GitHub repository and is now located at: https://github.com/frmscoe/docs/blob/main/Product/07-Creating-And-Maintaining-Processors/02-Create-New-Rule-Processor.md This page will no longer be maintained in Confluence.

Steps:

Develop the rule processor module (see: https://frmscoe.atlassian.net/wiki/spaces/FRMS/pages/1739942 )
1. A rule processor will have a unique ID
2. A rule processor will have a name
3. A rule processor will have a brief description
4. A rule processor will have a unique version
Create the rule processor configuration (see: https://frmscoe.atlassian.net/wiki/spaces/FRMS/pages/1739942/3.+Rule+Processing#3.1.-Read-rule-config )
1. The rule processor configuration will share the rule processor’s unique ID
2. The rule processor configuration will have its own, unique version
Connect the rule processor
1. Prerequisite: A rule processor must be associated with an existing typology. If the typology for a rule processor has not yet been created, the typology must be created before the rule processor can be connected. (There are cascading dependencies for the channel and transactions to also exist, though these are direct prerequisites for the typology and channel, respectively.)
2. Update the typology expression (see: https://frmscoe.atlassian.net/wiki/spaces/FRMS/pages/1740494/Typology+Processing#5.5.-Read-typology-configuration )
  1. The result for a rule (or each of the sub-rules), which will be either TRUE or FALSE, must be associated with an integer between 0 and 100
  2. The typology expression must be updated by adding the rule ID for the new rule to the expression
3. Update the Network Map (see: )
  1. The new rule must be linked to all typologies for which it is to be executed by adding the rule to the transactions.channels.typologies.rules objects under the channel in the Network Map.
  2. The new rule must be described in the network map with the following information:

"id": "003@1.0.0",
"host": "http://gateway.openfaas:8080/function/off-rule-003-rel-1-1-0"
"cfg": "1.0.0",

Config file

{
    "id": "002@1.0.0",
    "cfg": "1.0.0",
    "config": {
       "timeframes": [
            {
                "threshold": 86400000
            }
        ],
        "bands": [
            {
                "subRuleRef": ".01",
                "outcome": true,
                "reason": "Transaction convergence detected on debtor account"
            },
            {
                "subRuleRef": ".00",
                "outcome": false,
                "reason": "No Transaction convergence detected on debtor account"
            }
                ]
    }
  }

Result sample:

{
    "transaction": { transaction stuff
    },
    "networkMap": { networkMap stuff
    },
    "ruleResult": {
        "id": "002@1.0.0",
        "cfg": "1.0.0",
        "subRuleRef": ".01",
        "result": true,
        "reason": "Transaction convergence detected on debtor account"
    }
}

Network map sample: