< Back to CIC Studio Top

Cockpit Ruleset Actions (Used to populate data)

The following Ruleset Actions are for use to populate data into the Cockpit.

For Outbound:

  • OutboundCreateMessageHeader
  • OutboundAddMessageDetails
  • OutboundAddSummaryString
  • OutputAddAggregates
  • OutboundAddMessageDetailsV2
  • OutboundAddReprocessingString
  • OutboundCloseMessage
 For Inbound:
  • InboundAddKeyToMessageHeader
  • InboundCreateMessageHeader

This is the first action that needs to 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

mceclip1.png

mceclip1.png

OutboundAddMessageDetails

This is used to add information 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; and if not used, then the details page will be empty.

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


mceclip0.png

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. 

mceclip2.png

  • 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
mceclip3.png

Output

mceclip4.png

OutputAddAggregates

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

mceclip5.png

  • 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
mceclip6.png

Outputs

mceclip7.png

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 4 types, 

type : {c} signifies Currency Format

                        Eg :  “Key”:{“value”:“13232435678”,”type”: “{c}”}

type : {n} signifies Number Format

                        Eg :  “Key”:{“value”:“62343278”,”type”: “{n}”}

type : {d} signifies Date Format Should be in YYYYMMDD format

                        Eg :  “Key”:{“value”:“20170221 13:14:10:546”,”type”: “{d}”}

type : {s} signifies String values

                        Eg :  “Key”:{“value”:“Manju Muthuraj”,”type”: “{s}”}

type : "" signifies No Formatting asits optional params hence value will be shown as it is.

Eg :  “Key”:{“value”:“564367”,”type”: “”}

 

  • This needs to be called multiple times in a Ruleset;one time for each key-value pair to be shown in the Message Details page.  Whatever Key and Value pair is passe will be displayed.

Inputs

mceclip8.png

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

mceclip9.png

Inputs: Trading partner id

mceclip10.png

Original logOfMessageId

Key: originalLOM, 

Value: glb.originalLOM

mceclip11.png

mceclip12.png

OutboundCloseMessage

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

  • Accepts messageInfo object from OutboundCreateMessageHeader as an input.

Inputs: property messageInfo is Data Type: Object 

mceclip13.png

Output: Returns Data Type : void

mceclip14.png

 

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.

mceclip15.png

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.

Related articles