Deploying connectors to the Helix Integration Service production site

As a developer, after you design, build, and test a custom connector, deploy this connector to a production instance. Before deploying a connector, make sure that this connector is tested, the bugs are addressed, and all the required connector information is added. After you deploy a connector, it is listed in BMC Helix Integration Studio under Catalog > Connectors.

Before you begin

  • Your production instance must be running Integration Controller on an on-premises, physical Linux server.
  • The Integration Controller must be configured to start and deploy the connectors. For more information about configuring the Integration Controller, see Installing and setting up the connector development environment.
  • If you are accessing BMC Helix Connector Designer or BMC Helix Integration Studio from behind a firewall, ensure that the firewall has access to https://npm.integrate.bmc.com. The firewall on the production and development site must also have access. This is required to download the node_modules published by BMC when you deploy the connector.

To deploy a connector

Important

If you change a name of an existing connector in BMC Helix Connector Designer, and then deploy the updated connector to a production instance in BMC Helix Integration Studio, a new connector is created instead of updating the existing one. The existing connector is not modified and is available in BMC Helix Integration Studio.

  1. To open BMC Helix Connector Designer in your browser, navigate to https://localhost:3000/ and log in

  2. Select Administration > Integration Controller and provide the following values, if they are not defined: 

    NameDescription
    Instance URL

    The URL of your production instance. For example, https://integrationServer.bmc.com.

    Important: Make sure you remove any trailing slashes ( / ) at the end of the URL.

    UsernameThe username that you are going to use to log in to the production instance.
    PasswordThe password to your user account.
    Site

    Select the production site from the list. To view the sites defined in BMC Helix Integration Studio, click .

    For more information about sites, see Installing and configuring sites to run on-premises connectors

  3. To save or start the updated credentials, perform one of the following actions:

    • To save the updated credentials of BMC Helix Integration Studio, click Save.

    • To save the updated credentials and start the BMC Helix Integration Studio production site, click Start.

  4. Click Connectors, select the connector you want to deploy, and then click .

  5. To deploy the connector to your production environment, on the Deploy tab, click Deploy.

    After the deployment confirmation message is displayed, open BMC Helix Integration Studio to install or upgrade the connector.

  6. Add or update the connector configuration and then complete the deployment.
    1. Log in to BMC Helix Integration Studio.
    2. Select Catalog > Connectors and then select the connector that you deployed. To add or update connector configuration, perform one of the following steps:
      • If no connector configurations exist, proceed to add a configuration.
      • If a configuration exists, but no user accounts are associated with the connecting application, proceed to add a user account.
    3. To complete the deployment, perform one of the following actions:
      • Click Install if you are deploying the first version of the connector.
      • Click Upgrade if you are deploying the updated version of the connector.

Important

To make a connector accessible to end users, on the Connectors page, select the Enable Usage check box next to a connector.

Where to go from here

After you have deployed your connector, configure the connector and create flows by using the connector in BMC Helix Integration Studio. For more information about configuring connectors, see Configuring connectors.

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

Comments

  1. John Marshall

    I just worked with BMC support on this and it may be worth mentioning to leave off any trailing "/" and the end of the instance URL. For example, I was not able to successfully deploy my connector when using "https://integrate-us2.onbmc.com/" as it needed to be adjusted to "https://integrate-us2.onbmc.com" (not slash at the end of the URL)

    Apr 15, 2020 12:43
    1. Priya Shetye

      John Marshall , thank you for your comment. I have added a note to include the information for the URL.

      Apr 17, 2020 09:08
  2. Keith Yim-lim

    Does the integration controller needs access to registry.npmjs.org ?

    I keep on getting an error timeout in the logs when deploying my connector to production site.

    If yes, can we add in the documentation, all the required ports and destinations that needs to be opened.

    May 12, 2020 09:18
  3. Priya Shetye

    Thank you for your comment Keith. I am working with my development team to get more details and should have an update in a couple of days.

    May 18, 2020 10:25
    1. Priya Shetye

      Hello Keith Yim-lim, the Integration Controller needs access to registry.npmjs.org to download the dependencies while building or creating the image JavaScript connector. 

      For a Java Connector Integration Controller requires access to the Maven repository. I am working on updating the required information in the documentation. 

      May 19, 2020 01:16
  4. Sudeepkumar Chandrasekaran

    Is helix connector designer different from Innovation studio?

    Jul 22, 2020 06:09