This article is intended to help you understand:
- areas of the platform where you should troubleshoot
- why, when, and how to troubleshoot in CIC
- the tools and techniques available to you
Where should I troubleshoot?
There are two areas where you can troubleshoot in CIC: CIC Cockpit and CIC Studio.
You use CIC to set up connectivity and data movement between your systems and your partners' systems. Therefore, you should use the Cockpit to troubleshoot issues in these areas. Once you are in production, you can use the CIC Cockpit to perform troubleshooting and end-to-end testing of your system.
You use CIC Studio to create and modify integrations. Therefore, you should use the Studio to troubleshoot issues with integrations that arise as you build them.
Troubleshooting in CIC Cockpit
In general, there are two key areas where you can troubleshoot in the Cockpit: Jobs and Messages.
On the Jobs screen, you can see the runtime evidence of end-to-end executions of your integrations, including details about any messages processed as part of the jobs. Jobs generally include three main parts: connectivity with a partner or external application, processing by the CIC Integration Engine, and connectivity to your backend system. The Job Detail view shows a diagram of each of these steps and indicates if and where any failures occurred. You can drill into each step to view payloads that were present at that step as well as logs of what occurred during that step.
If an error is present anywhere in the Job, the Job is marked as failed and you see an Issues tab in the step that failed. View the Issues tab for details on what caused the failure. The Log tab next to the Issues tab can also be useful for troubleshooting and understanding what occurred.
If the job issue occurs during the processing of the payload within the Integration Engine, the issue is shown in the Transform step of the Job. When troubleshooting these kinds of issues, you often need to go to the Auditor in the CIC Studio for detailed information, including log files. To help you find the relevant logs that relate to the job you are investigating in the Auditor, we provide the Connection Number. The Auditor allows you to search by Connection Number, which takes you straight to the relevant logs. See Searching by Connection Number in CIC Studio Auditor.
On the Messages screen, you can get detailed information about the status and errors for individual messages. If a message contains an issue, it will have an Issues tab, as described above for Jobs, where you can find out more about the issue. At the bottom of the Message Details screen, there is a message life-cycle diagram that details the history of the message as it came through CIC. You can click on that view to go to the associated job that processed that message.
Sometimes, the integration fails before the messages are able to be extracted from the payload. For example, if the inbound connection fails and the integration engine is never able to inspect the payload. For these types of situations, you need to troubleshoot at the Job level, as that is where you can find more information about any failed inbound connections in the first step of the job.
Troubleshooting in CIC Studio
You use the CIC Studio for design-time troubleshooting, for example, when creating or modifying integrations, and sometimes for doing more detailed, technical troubleshooting once in production, as described above.
You can use the following tools for troubleshooting in CIC Studio:
- Auditor: This powerful diagnostic tool helps you to identify and troubleshoot integration runtime errors and exceptions. It is also used to manage other log-driven activities, such as process- and document-oriented logs, log filtering and customization, reprocessing, and purging.
- Run Transformation (Ruleset editor): Used for troubleshooting individual maps as you build them.
- Problems and Property views: These views can provide problem descriptions while designing integrations, and also data details for selected log entries.
- Server and Resource Monitor logs: These logs can provide insight into issues related to deployment or Cloud Monitor activity.