Creating custom integrations using the integration SDK

You can create your own integration connectors to interact with IBM Cloud Pak for AIOps, such as for sending events, metrics, and topology data to IBM Cloud Pak for AIOps from an external source when a default integration is not available.

There are two frameworks you can use for creating integration connectors:

  • cp4waiops-connectors-java-template: A template for java connectors based on Open Liberty.
  • cp4aiops-connectors-ticket-template: A ticket integration template that generates dummy data that can train Similar Incident functionality by polling the data from an outbound system.

These frameworks are documented in the following repositories, which also host the Java templates:

IBM/cp4waiops-connectors-java-template

IBM/cp4aiops-connectors-ticket-template

These templates provide you with a working example for extending IBM Cloud Pak for AIOps. You can use these examples as a starting base for developing your own custom integration. Details are included in the repository documentation to help you understand the framework architecture and to help you proceed from development to deployment.

The Java templates use the integration SDK, which can be obtained from Maven central. This SDK abstracts away the gRPC logic, provides security, and provides common methods to help you accelerate your custom integration development. Check Maven central for the latest version of the SDK before you create or update your custom integrations.

With the SDK and templates, you can create your own integration connector for sending the following types of data to IBM Cloud Pak for AIOps:

  • Events
  • Metrics
  • Topology