@capriza/connector-controller v2.13.0

Capriza Connectors

Backend systems connectors.

##Architecture The architecture of a connector is composed of several layers - Connector controller, a Business Logic (BL) connector and Drivers that enable technical connection to the backend system.

###Drivers A Driver is a technical object that provides access the a backend system API. Examples:

• HTTP - A driver that enables connection to a REST API of a backend system.
• Web Engine - Provides a scripting ability to automatically run the backend system's WEB UI, extract data and perform actions.
• node-rfc - a node based driver that enables connection to SAP rfc functions.

Drivers does not contain business logic, and does not depend on the connector use-case. Drivers does not have a predefined API.

###Business Logic (BL) Connector A node module that exports an object that contains the business logic of a one or more use-cases (e.g. expense approval, PO approval). The BL connector may use one or more Drivers, to implement the use-case. The BL connector should implement the following interface:

• init(options) - Will be called by the controller connector when the process starts. Meant to allow initialization of the business logic if necessary. The options parameter includes: {"config", "logger"} properties.
• stop() - Will be called before the connector is stopped.
• fetch(options) - Connects to the source system, and fetches the data relevant for the use-case(s).
• getApproval(approval, options) - Fetches a single "PENDING" approval record, given an already fetched approval (for validation comparison). The method should return only pending approvals, otherwise return null.
• approve(data, options) - Performs the approve action in the source system given approval data and the approver credentials (if needed). the data input object is assumed to follow this structure {approval, credentials}
• reject(data, options) - Performs the reject action in the source system given approval data, the approver credentials (if needed), and a rejection reason (as string). the data input object is assumed to follow this structure {approval, credentials, rejectionReason}.
• downloadAttachment(data, options) - Downloads the attachment and returns a Uint8Array of binary data.

The BL connector can expose settings for the controller under "settings" key in the exported object.
supported settings:

• selfValidation - If true, the controller wouldn't validate the approval (using getApproval()) before calling approve / reject. The validation should be performed by the BL itself.
• disableMiniSync - If true, the controller wouldn't perform mini-sync (using getApproval()) after calling approve / reject. Instead it would mark the approval as "deleted".

Important guidelines for the BL Connector:

• Logging - All of the BL connector methods receives "options" parameter that contains logger property based on pino npm pacakge.
• Approval Id - Both fetch() and getApproval() functions should return an id field of type string in the private section of the approval. This id should uniqly identify the approval in the source system, per approver (In case the same approval can be approved by several approvers, it should be reflected in the id of the approval). In case the "real" source system id of the approval comprises of several fields, these should be added to the private section of the approval (see Schema)
• Approver - Both fetch() and getApproval() functions should return an approver field of type string in the private section of the approval. The approver identifies the approver user of this approval. It should match the mapping of the source user id and the capriza user id.
• Approvals 'pending' status - Both fetch() and getApproval() should return approvals with 'pending' status.

####Module Structure: Connector should contain this minimum file structure:

/index.js  
/package.json  
/lib  
    /lib/connector.js  
/resources  
    /resources/config.json 

####Configuration The BL connector can (and should) use a configuration file (json). The BL connector is assumed to use 2 types of configurations:

• blConfig - "Private" configuration of the connector (e.g. source system types, fields..). This configuration is saved on the cloud, and given to the controller at run-time.
• systemConfig - Configuration that contains system/environment "sensitive" information (e.g. system url, integration user credentials..). This configuration should be placed manually on the connector's machine.
  

* See "Deployment section for more configuration details.

####Error reporting Generally, the BL connector communicate errors using the promises it returns (as rejections) or exceptions. In some cases, we would want to report more meaningful errors to the backend, which in turn would reach the end user. In these cases (listed below), the BL connector is expected to reject the promise with an Error object, that includes an "error" attribute, with the Capriza's error code. example code:

var err = new Error ("System returned code 4"); 
err.error = "SYSTEM_UNAVAILABLE";
throw err;

Error types expected:

• SYSTEM_UNAVAILABLE - When the BL connector identifies a state of source system unavailability, it should reject the relevant method (promise) with this error.
• ATTACHMENT_NOT_FOUND - When the requested attachment was not found in the source system.
• APPROVAL_DATA_MISMATCH - When the BL connector performs the validation itself (selfValidation=true in the BL connector settings), and the approval data mismatches to the source system, it should throw this error.

###Connector Controller The Connector Controller is a generic wrapper for each connector that uses a single BL Connector to implement one or more use-cases in a specific system, and fulfill the Backend tasks:

• Data transformation - The data returned from the BL is transformed to comply with the corresponding approval schema. the data transformation is performed using the jslt npm package that allows to transform one JSON object to another using a JSON "template" that follows the Mongo query langauge.
• Sync - Enables to synchronize 2 different fetch() calls in order to determine the difference between those (added, removed, updated). The Sync functionality includes comparison of the list of approvals from the Capriza's backend to the Source System's.
• Hash - After each fetch() call, the Connector Controller Creates an object (approval) signature using a hash function, for easy comparison between approvals, in later syncs. In addition, there is an options to prepare a different hash on partial approval data for the approve/reject actions (under actionSignatureTemplate key in the config).
• Approve/Reject - Given an approve/reject task, the Connector Controller will first check the validity of the received approval (by using the getApproval() function of the BL Connector). If the approval is still valid, it will call the approve/reject function of the BL Connector. Then, it will re-fetch the approval and perform "sync" for that specific approval in order to update the backend with the latest status of this approval.
• Added Data for each approval - The Connector Controller extends each approval object with:
  • id - A UUID given by the backend to approvals sent (new approvals wouldn't have an id).
  • syncver - Sync version represents the version of the record in the backend DB at the time it was send to the connector, it should be returned as is to the backend (new approvals wouldn't have an id).
  • schemaId - The data schema id of the approval.
  • sourceUserId - Signature (hash) that represents the source system user (based on the "approver" field in the private section of the approval).
  • signature - An object with 2 hash results: (1) sync: the hash result (string) of the whole approval object; (2) action: the hash result (string) of the partial approval object that is "sensitive" to change for approve/reject actions (configured in the config using jslt template).
  • deleted - An optional flag that would mark an approval as deleted (relevant for sync).

Final approval structure (root level):

{id, syncver, signature, sourceUserId, schemaId, public, private, [deleted]}

####configuration The controller has its own configuration "controllerConfig", that includes 2 types of configurations: "controllerConfig", "caprizaConfig".

• controllerConfig - Includes configuration for the controller:

  • schemaTransformer - Relies on the JSLT library that enables transformations of JSON objects according to a JSLT Template. The controller uses JSLT to enable transformation of the JSON data exported by the BL Connector to a JSON object that is sent to the Capriza's backend allowing for complex operators (e.g 1:1 field mapping, aggregation functions, logic operators and more..). The JSLT template is a part of the controller configuration.
  • bulkSize - Send updates on approvals to the backend in bulks of this size (in string length). Default: 100,000.
  • taskProgressInterval - Update the progress of a task to the backend in intervals of this length (in ms). Default: 30,000 (30 s).
  • monitorMemoryInterval - Check the memory usage of the process in intervals of this length (in ms). Default: 5 60 1000 (5 min).
  • memoryMaxLowerLimit - Maximum memory usage (rss memory, in MB) the node process may reach before starting to shut down the process (draining tasks), by not pulling any more tasks, finish the current active tasks, and kill the process. Default: 1000 (1 GB).
  • memoryMaxUpperLimit - Maximum memory usage (rss memory, in MB) the node process may reach before killing the process without draining of tasks. Default: 1500 (1.5 GB).
  • maxConcurrentTasks - A number that limits the number of concurrent tasks the connector would do at runtime. If the controller has reached its limit, it would stop pulling tasks, until a task is completed. Default: 5.
  • taskTimeout - Fails task if it wasn't completed in this time (in ms). Default: 30 60 1000 (30 min).
  • separateBlLog - When true, will write the BL log to a separate file (bl.log).

• caprizaConfig - Contains the Capriza (backend) API keys, secret, and urls. This file is auto-generated on deployment using Fortitude (see below) for production deployment. For develpment purposes, this file should be manually created on the machine, and it's path should be mentioned in the config.json of the connector.
  Example:

{
    "connectorId": "xxxx-xxxx-xxxx-xxxxxxx-xxxxx",
    "apiUrl": "https://approvals.capriza.com",
    "creds": {
        "apiKey":       "<Environment API key>",
        "apiSecret":    "<Environment API secret>"
    }
}

* See "Deployment section for more configuration details.

###COM component Handles the communication with the Backend server, Pulls tasks and delegates these to the Connector Controller.

###Deployment Connector deployment is done using outpost.