Cockpit Ruleset Actions (Used to populate data)

Use the following Ruleset Actions to populate data into the CIC Cockpit.

For Outbound:

• OutboundCreateMessageHeader
• OutboundAddMessageDetails
• OutboundAddSummaryString
• OutputAddAggregates
• OutboundAddMessageDetailsV2
• OutboundAddReprocessingString
• OutboundCloseMessage

 For Inbound:

• InboundAddKeyToMessageHeader
• InboundCreateMessageHeader

OutboundCreateMessageHeader

This is the first action that must be called with the necessary parameters to insert the transaction data into the Cockpit. This needs to be mandatorily called once.

• For all the optional parameters ‘null’ or empty string has to be mapped if the MS doesn't want to map those fields and ‘null’ is case sensitive. 
• faExpected should be ‘true’ or ‘false’ and these values are case-sensitive.
• timestamp should be in the current time millis(epoch time in millis).
  
  

Inputs: All the properties are strings. 

Output: Returns the Data Type: Object

OutboundAddMessageDetails

This is used to add information to be displayed in the Message Details pane. The parameters passed to this action are displayed in the area shown in red below. This is optional. If not used, the details page is empty.

• Accepts messageInfo object from OutboundCreateMessageHeader, key string, and value string as an input.
• This must be called multiple times in a Ruleset: one time for each key-value pair required to be shown in the Message Details page.  Whatever key-value pair is passed is displayed.

OutboundAddSummaryString

Used to add values to the summary string in the Message Tile view of the Cockpit. The summary string is shown marked in red below. 

• This accepts messageInfo object from OutboundCreateMessageHeader, key string, and value string as an input. ‘key’ can be any random string because it is ignored. 

Inputs

Output

OutputAddAggregates

This is used to add aggregate values to the doctype chart on the Activity page of the Cockpit.

• This accepts messageInfo object from OutboundCreateMessageHeader, key string, and value string as an input. The key should contain the aggregate name and value contain the actual aggregate value. Both Key and value are mandatory fields. Note: Currently Key is Fixed, and it should be ‘Amount’

Inputs

Outputs

OutboundAddMessageDetailsV2

This is used to add information that needs to be displayed in the Message Details pane. The parameters passed to this will be displayed in the area shown in red below. This is optional; if not used, then nothing is displayed.

• Accepts messageInfo object from OutboundCreateMessageHeader, key string, and value string and type string as an input.
• The parameter type is used to specify the type of key i.e., if the key is of type currency then input would be {c}.

  There are four parameter types:

  Type	Description
  {c}	Indicates Currency Format Example: “Key”:{“value”:“13232435678”,”type”: “{c}”}
  {n}	Indicates Number Format Example: “Key”:{“value”:“62343278”,”type”: “{n}”}
  {d}	Indicates signifies Date Format Should be in YYYYMMDD format Example: “Key”:{“value”:“20170221 13:14:10:546”,”type”: “{d}”}
  {s}	Indicates String values Example: “Key”:{“value”:“Manju Muthuraj”,”type”: “{s}”}

  Note: If a type is not specified, no formatting is applied and the value is shown as-is.

• OutboundAddMessageDetailsV2 must be called multiple times in a Ruleset; one time for each key-value pair to be shown in the Message Details page.  Whatever key-value pair is passed will be displayed.

Inputs

OutboundAddReprocessingString

This needs to be used to reprocess the outbound message from the Cockpit.

• Accepts messageInfo object from OutboundCreateMessageHeader , key string, and value string.
• Must be called multiple times in order to provide the information required to reprocess the message.
• It can accept upto 20 route values i.e., RouteValue01, RouteValue02,………...RouteValue20. 

Note:

1. RouteValue01 should be the complete path of ‘Application Interface’ name.
2. Create a global variable “originalLOM” if it is not already there (RDO) and map the same to RouteValue. Refer Original logOfMessageId section below for rule and condition.
   
   

Inputs: Application Interface

Inputs: Trading partner id

Original logOfMessageId

Key: originalLOM, 

Value: glb.originalLOM

OutboundCloseMessage

This should be called once at the end of the Ruleset. This posts the message to the Cockpit. It is only after this call that the updated message displays.

• Accepts messageInfo object from OutboundCreateMessageHeader as an input.

Inputs: property messageInfo is Data Type: Object 

Output: Returns Data Type : void

 

InboundCreateMessageHeader

• Required
• For all the optional parameters ‘null’ or empty string has to be mapped if not mapping those fields and the value ‘null’ is case sensitive. 
• faExpected should be ‘true’ or ‘false’ and these values are case sensitive.
• timestamp should be in current time millis(epoch time in millis).
• ownerId should be mapped from ReceiverId from env.

Inputs: All the properties are strings.

Output: Returns the Data Type: Object

InboundAddKeyToMessageHeader

This is used to add any new key-value pairs to the existing inbound message header.

• Accepts messageInfo object from InboundCreateMessageHeader, key string, and value string as an input.
  

  Note: The APIs InboundAddMessageDetails, InboundAddMessageDetailsV2,InboundAddSummaryString,InboundAddAggregates and InboundCloseMessage for an Inbound message would function identically to the Outbound APIs.