Deploying connectors

As a developer, after you design, build and test a custom connector, you can deploy this connector to a production instance. Before deploying a connector, make sure that this connector is tested, the bugs are addressed, and the connector documentation is complete. 

For more information about testing connectors, see Testing connectors.

Before you begin

Your production instance must be running Integration Controller on an on-premises, physical Linux server.

To deploy a connector


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.

  1. To open BMC Helix Connector Designer in your browser, go to https://localhost:3000.
  2. Click Connectors and select the required connector.
  3. Open the Deploy tab and provide the following values:

    • Instance URL—The URL of your production instance. For example, 

      Make sure you remove any trailing / at the end of the URL.

    • Username—The user name that you use to log in to the production instance
    • Password—The password to your user account

  4. Click Deploy to Production.
  5. After the deployment confirmation message is displayed, open BMC Helix Integration Studio to install or upgrade the connector.
  6. In BMC Helix Integration Studio, go to Catalog > Connectors, and select the required connector.

    • 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.

  7. 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.


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

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


  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 "" as it needed to be adjusted to "" (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 ?

    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 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