Installing and setting up the connector development environment

As a developer, you must set up the connector development environment to be able to create, test, and build custom connectors in BMC Helix Connector Designer and deploy the custom connectors to the BMC Helix Integration Studio instances.

Setting up the development environment includes installation of the following components:

  • The  Docker  application, which enables installing and using BMC Helix Connector Designer
  • BMC Helix Connector Designer
  • Integration Controller


Related topics

Before you begin

Ensure that your working environment matches the following system requirements for BMC Helix Connector Designer and Integration Controller.

System requirements for BMC Helix Connector Designer

ComponentRequirements
Supported operating systems
  • Microsoft Windows 10.x or later
  • Apple OS X or macOS 10.11.x and later
  • Linux
    • CentOS 7.1 or later (7.3 preferred)
    • Ubuntu 14.04.5 or later (16.04.x preferred)
    • Red Hat Enterprise Linux 7.3 or later (7.4 preferred)
Supported web browsers
  • Mozilla Firefox 53.x or later
  • Google Chrome 57.x or later
  • Microsoft Internet Explorer 11.x or later
  • Microsoft Edge 40.x or later  
Processor2.5 GHz, a minimum of 4 cores
RAMA minimum of 8 GB
Disk spaceA minimum of 30 GB of free space
Other
  • Docker CE —Generally preferred, but not supported for Red Hat Enterprise Linux
  • Docker EE —Required for Red Hat Enterprise Linux; version 17.06 preferred

System requirements for Integration Controller

ComponentRequirements
Supported operating systems

Linux (physical or a virtual machine):

  • CentOS 7.1 or later (7.3 preferred)
  • Ubuntu 14.04.5 or later (16.04.x preferred)
  • Red Hat Enterprise Linux 7.3 or later (7.4 preferred)

Processor 2.5 GHz, a minimum of 2 CPU
RAMA minimum of 8 GB
Disc spaceA minimum of 30 GB of free space
NetworksAllow egress (an outbound from one network to another) on port 61600 for bidirectional TCP traffic
Container software
  • Docker Engine 1.12 or later (included in  Docker )

    Note: Docker CE is not supported for Red Hat Enterprise Linux

  • Docker Compose 1.9 or later (might not be included in Docker,  depending on the OS )

To set up the connector development environment

  1. Log in to your BMC Helix Integration Studio development instance as a tenant administrator.
  2. Go to Sites and select Add New Site > Add a Development Site.
  3. Provide a Site Name (required) and a Description of your site (optional).
  4. Save the changes. 
    Next to the saved site, a Not Installed label and an Install Connector Designer button are displayed.
  5. Click Install Connector Designer.
    An installation link is displayed.
  6. Open the link and follow the steps described to start BMC Helix Connector Designer.



    BMC Helix Connector Designer opens in your browser at https://localhost:3000.

  7. In the main menu of BMC Helix Connector Designer, click Integration Controller.
  8. Provide or update the following values: Instance URLUsername, and Password.
  9. Select the site name you provided in step 3 as the Site.
  10. Click Start.
  11. Refresh the current page in your browser.
    The BMC Helix Connector Designer interface shows a green tick mark, which indicates that Integration Controller is running.



  12. (Optional) Refresh the BMC Helix Integration Studio page in your browser. 
    The development site you created previously is Online, which indicates that Integration Controller is set up correctly.

    Note

    To ensure that you have the latest version of Integration Controller, BMC recommends that you update your production and development sites every time new features are released.

Where to go from here

Validating the connector development environment

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

Comments