Important

   

This documentation supports the releases of BMC Helix Intelligent Integrations and BMC Helix Developer Tools 22.2.00 and their patches. To view the documentation for earlier releases, see BMC Helix AIOps.

Building custom third-party integrations by using the Custom Integration template

BMC Helix Developer Tools provides a few third-party integrations out-of-the-box. BMC Helix Developer Tools facilitates third-party integrations to get monitoring data such as events, metrics, and topology data from third-party products, modify or transform data as required, and send this data to . For example, if you want to get SolarWinds NPM events into BMC Helix Platform so that you can monitor these events in BMC Helix Operations Management, you can configure the SolarWinds NPMintegration easily by using BMC Helix Developer Tools.

However, if there is a need to integrate with other third-party products, BMC Helix Developer Tools enables integration developers of your organization to build custom integrations by using the Custom Integration template.

For an end-to-end use to build an integration with TrueSight Impact Manager, see Use case: Building a custom third-party integration with BMC TrueSight Impact Manager.


Custom Integration template

BMC Helix Developer Tools provides a Custom Integration template to facilitate custom third-party integrations. Using the Custom Integration template, you can achieve the following goals:

  • Create a custom third-party integration: As an integration developer, you can use the Custom Integration template and create and configure a custom third-party integration. After you create a custom integration, you can create a deployable package of the created custom integration, and make it available to your end users.
  • Deploy a custom third-party integration: As an end user, use the custom integration deployable package created by the integration developer of your organization or a vendor, and deploy the integration package through the Custom Integration template and start receiving the data from the integrated product.

The following workflow diagram explains the create and deploy processes: 



The following table lists all the tasks and the relevant topics that provide the required instructions to perform these tasks:

Create workflow

Plan

TaskActionReference
1

Learn about BMC Helix Developer Tools connectors, Custom Integration templates, plug-ins, and pipelines.

Connectors, templates, plug-ins, and pipelines
2
  • Research vendors.
  • Explore third-party products and gather details.
  • Explore public APIs available for third-party product integrations.
  • Get familiar with the Fluentd environment.
Identifying third-party products for integration
3Explore additional Fluentd plug-ins and BMC custom plug-ins.Custom plug-ins used in BMC Helix Developer Tools

Prepare

TaskActionReference
1Set up the development environment.Downloading and installing connectors for third-party integrations
2Create a sandbox integration environment by using the Custom Integration template.Creating a sandbox environment by using the Custom Integration template
3Explore the out-of-the-box directories and configuration files available in the sandbox integration environment.Exploring the default sandbox directory structure and configuration files

Quick start

ActionReference
Get started with an example pipeline that is provided out-of-the-box in the sandbox integration environment.Getting started with an example pipeline

Create

ActionReference
Create a custom pipeline configuration file to integrate with a third-party product.Creating a custom pipeline configuration file to integrate with a third-party product

Configure

TaskActionReference
1Parameterize a custom pipeline configuration file.Parameterizing a custom pipeline configuration file
2

Create a deployable package of the pipeline configuration file and associate it with the custom third-party integration on the BMC Helix Developer Tools console.

Creating a deployable package for the custom pipeline configuration

Deploy workflow

ActionReference

Deploy the custom integration package by using the BMC Helix Developer Tools Custom Integration template to integrate with a third-party product.

Deploying custom third-party integrations by using the Custom Integration template

Was this page helpful? Yes No Submitting... Thank you

Comments