Developing connectors

Developers can create new custom connectors for their organizations by using BMC Helix Connector Designer. Tenant administrators and end users use custom connectors to create flows in BMC Helix Integration Studio for resolving multiple business tasks.

Connector development overview

The following diagram provides a high-level overview of the actions and roles that might be involved in the connector development process. The exact roles and distribution of responsibilities might vary depending on the nature of a particular project and a company structure.

For example, if a connector is being designed for a development tool, such as GitHub, the following roles might be appointed:

  • A software architect takes on the Business Analyst role for the project.
  • Developers and QA engineers take on the Developer and the Tenant Administrator roles.
  • Other employees in the business organization are the End Users.

Before you begin

Before you start the connector development process, ensure that the following tasks are completed:

TaskReference

Ensure that the connector required for accomplishing your business tasks does not already exist. By default, BMC Helix Integration Studio includes out-of-the-box connectors for popular BMC and third-party applications.

If the required connector exists, but does not meet your organization's business requirements, you can try to configure the connector in BMC Helix Integration Studio as a tenant administrator.

To verify if the required connector exists, see Finding existing connectors.

For instructions on configuring existing connectors, see Configuring connectors.

Learn about the target application. For example, for a HootSuite connector development project, you must be familiar with HootSuite's functionalities, particularly those that are exposed through its APIs. A clear understanding of the third-party application's input and output requirements can potentially prevent a significant amount of development effort.Refer to the documentation of a third-party application.

Since Integration Controller runs only in Linux environments, you should be comfortable working in the supported Linux operating systems.

You must also be proficient in reading and writing code in Java or JavaScript. These programming languages are currently supported in BMC Helix Connector Designer.

N/A

Verify that you can log in to the development and production instances of BMC Helix Integration Studio.

To verify access, log in to your production and developer instances.

Note: Production instances vary by region. For more information, see Accessing BMC Helix Integration Service.

Learn about the best practices for connector development.For more information, see Best practices for connector development.

Connector development process

Use the information in the following table to understand the workflow and the sequence of tasks to be performed for an end-to-end connector development process:

ActionTaskReference
1

Set up the connector development environment to be able to create, test, and build custom connectors in BMC Helix Connector Designer and deploy these connectors to the BMC Helix Integration Studio instances.

You need to set up the connector development environment only once, and then you can use it further for developing new custom connectors.

Installing and setting up the connector development environment


2Ensure that the connector development environment is set up correctly by using the validation utility and running the health checks.Validating the connector development environment
3

Start the development process by creating a connector project in BMC Helix Connector Designer.

Creating or deleting a connector project
4After a connector project is created, proceed to providing general connector details.Updating connector details
5

Add trigger details, trigger definition, and other trigger-related information to specify the triggering events for future flows that will use the connector.

Adding connector triggers
6

Add action details, action definitions, and other action-related information to specify what actions must be performed when a flow that uses the connector is triggered.

Adding connector actions
7

Build your connector and make it available to your organization within BMC Helix Integration Service.

Building connectors
8Test your connector to check the generated code for errors before deploying the connector to a production instance.Testing connectors
9Deploy the connector to a production instance.Deploying connectors

Where to go from here

Installing and setting up the connector development environment

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

Comments