The Cleo Cockpit Projects (CCP) can also be used to display non-EDI data (XML, proprietary delimited & fixed-length flat file, JSON, spreadsheets, database, etc.) in several CIC Cockpit views (Message tile, Message List).
Due to the non-standard data types and the uniqueness to which integrations can be built for non-EDI data, there are currently no data-specific Rulesets in the CCP available (as is the case for EDI). Users will create their own "Cockpit" Rulesets (and supporting resources) based on their data and the purpose of a specific integration. Pre-supplied Ruleset Actions provide the means to make data viewable.
Still, using the CCP to populate the CIC Cockpit follows the same basic process as using EDI.
- Checking out Cleo-supplied Projects from the Cleo repository.
- Setting dependencies between those Projects and your existing integration Projects.
- Calling the predefined BP tasks and Rulesets of the CCP from the Application Routes, Business Processes, and Rulesets that are in your existing Customer integration Project(s).
The main difference is that you'll need to create your own Cockpit Ruleset (creating a separate Cockpit Project is recommended); this Ruleset will then be configured to work with existing integration Projects.
We know that one size doesn't fit all and that you might want to customize the CIC Cockpit to show the information that is most pertinent to your organization labeled in a way that will be recognizable to users across your organization. To that end, we can help you customize certain aspects of the CIC Dashboards, Message Tiles, and Message Detail pages.
For more information about what can be customized and how we can help, contact Cleo Managed Services.
Please read, understand, and complete any required setup steps as described in the articles below before starting to use the CCP resources to populate the CIC Cockpit.
Overall Process Summary
- Checkout CCP resources
- Set Dependencies between Projects
- Create your Cockpit Ruleset (using mandatory Actions)
Note: While you can configure the Cockpit Ruleset to solely populate data to the Cockpit, you can also follow the same process to populate EDI data in the Cockpit This involves configuring Business Processes, Application Routes, and transformation Rulesets in your integration Projects (which then calls the Actions from the Cockpit Ruleset).
Checking out CCP resources
Cleo hosts an SVN repository to share Projects and resources you can use to set up the CIC Integration Engine to perform data transformation and populate the CIC Cockpit. The CIC Studio provides an interface to SVN that allows you to check the projects out.
- Open the SVN Repository Exploring perspective.
- Add the following directory:
- To check out com.cleo.b2biaas.clarify.
- Right-click com.cleo.b2biaas.clarify and select Checkout.
- Click Finish to check out Project.
- Check out com.cleo.cic.cockpit.core. (follow bullets above).
Note: The cockpit.core project is optional if just using the Cockpit Actions directly within your Transformation ruleset.
Once you have the required projects checked out to your local system, you declare dependencies between your own integration Projects, where a given Project is provided access to resources in another Project. Your integration Projects must be edited to declare dependencies on those pre-configured Projects from the CCP. This is explained in Obtaining the Cleo Cockpit Projects (CCP).
Remember that any integration Projects to be used to populate data to the CIC Cockpit (and using CCP resources) must have dependencies set.
- Go to The Project Explorer. Open the Integration Project to which you will set the reference and go to src>META-INF>MANIFEST.MF.
- Open (double-click) MANIFEST.MF file. This will display in an editor.
- Select the Dependencies tab from the bottom of the editor.
- Once in the Dependencies page, click Add. The Plug-in Selection dialog box appears.
Tip: You can filter the list based on the package name.
- Select the following packages and click Add: (bulk or individually)
- Save and close the MANIFEST.MF file.
- Repeat the above steps for all other integration Projects involved.
Create a separate Cockpit Ruleset (or optionally use this as a your Transformation Ruleset)
Create this targetless Ruleset and call several mandatory Ruleset Actions that are pre-supplied in the CCP, although there are others that can be used. The following actions allow you to create a Message tile in the CIC Cockpit. (These are only available after the Project you're creating the Ruleset in has been made dependent on CCP resources.)
By creating a separate cockpit Ruleset, the input schema can be the same input schema as the one in your Transformation Ruleset (based on your integration). This will allow you to use the values from the file for the Messages [input payload will need to be passed]. This method is useful as well since it separates the transformation from the message population and you are able to reuse the Cockpit reference Business Processes (inbound/outboundCockpitReferenceBPS and inbound/outboundErrorCockpitBPS). These are described in the steps to populate EDI data in the Cockpit.
For a complete list of Actions, see: Cockpit Ruleset Actions (Used to populate Cockpit with data)
Required Ruleset Actions used for inbound transformations:
Required Ruleset Actions used for outbound transformations:
The above Ruleset Actions contain several mandatory parameters:
messageID and parentMessageID
For each message that comes into the CIC, the system assigns a message id. The passing of this logOfMessageId into these Ruleset Actions in an important part of populating the Message tile.
In order to ensure that all related messages are populated as part of the Cockpit's Business Process view, the parentMessageId must be configured. This denotes the document that is related to this document and represents the start of the Business Process view.
Notes on the order of Rules:
- The composite rule that calls these Actions should be at the start of the map.
- Check for the ‘messageId’ is null and if it’s null, don’t execute the composite rule.