Testing connectors

As a developer, you can test newly built or existing custom connectors to check the generated code for errors before deploying these connectors to production instances.

You can use the test results to troubleshoot errors early in the connector development process. This prevents tenant administrators and end users from encountering errors when they use custom connectors to design and run flows in BMC Helix Integration Studio.


To reduce the possibility of errors while developing a custom connector, see Best practices for connector development.

You can test your custom connector by using the BMC command-line utility. This utility leverages the test driver functionality that simulates a flow run without actually deploying a connector to the BMC Helix Integration Service server and without creating a flow.

You can view the test results immediately.

Before you begin

To test connectors using the command-line utility

  1. From  BMC Communities , download the connector-test-driver.tar.gz file to your working directory.

  2. Decompress and unzip the file. 

    For example, you can use the following command: 

     tar -zxvf connector-test-driver.tar.gz
  3. Move the connector directory to the same directory level. 
    The following example shows the Remedy and Perftest connector directories in the test driver directory:

  4. Perform one of the following actions to test the connector:


    Each connector directory includes a test directory that consists of two files: test.script and test_data.json. The test driver loads these two files to perform the test.

    • To test a JavaScript connector, run the following command:

      node jsdriver/test-driver.js <jsConnector-name>

      The following example shows the output you can receive:

    • To test a Java connector, run the following command:

       java -jar javadriver/test-driver-0.0.1-SNAPSHOT.jar connector/target/Connector-0.0.1-SNAPSHOT.jar

      The following example shows the output you can receive:

    The output of the test is saved to the test_out.json file that is located in your working directory.

Where to go from here

After you test the connector, and resolve the errors, you can deploy the connector to a production instance. For more information, see Deploying connectors.

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