Updating connector code for connectors developed in previous versions
You can view the connectors that were developed by using earlier versions of the BMC Helix Connector Designer in the connector list in the new BMC Helix Connector Designer. These connectors are available for use in flows created by using BMC Helix Integration Studio. However, you cannot update any of the connector configurations in the new BMC Helix Connector Designer.
The earlier versions of the BMC Helix Connector Designer generated a single code file for the connector. However, the new BMC Helix Connector Designer generates multiple code files for specific configurations for the connector like triggers, actions, or lookups. To be able to modify the configuration of the connectors you had developed, you must update the connector code files to match the format of the files generated by the new BMC Helix Connector Designer.
You do not need to make any changes to connectors that are provided out-of-the-box.
To update the configuration of existing connectors in the current version of BMC Helix Connector Designer
- Create a backup of the existing connector code file located in the panama/connectors/ directory.
- To open BMC Helix Connector Designer in your browser, navigate to https://localhost:3000/ and log in.
On the Connectors page, to view a list of the old connectors, click.
In the Discover Connectors dialog box, click Discover.
A list of the older connectors, which are available under the panama/connectors/ directory, is displayed. It also displays a message to indicate if any parameters are missing in the previous version of connectors.
- Click Close.
The listed connectors are added to the BMC Helix Connector Designer.
On the Connectors page, select the connector that you want to update, and click.
To generate the source code and associated resource files, on the Build tab, click Generate.
An alert is displayed, notifying you that your existing code will be overwritten with the updated code.
The BMC Helix Connector Designer generates connector code files.
Update the following files with the information from the backup you created of the older connector code file.
The following files are generated in the panama/connectors/ directory:
Files generated for Java-based connector:
File Name Description Action Overwritten BaseConnector.java This is the main connector file maintained by BMC that provides the default implementation for the connector based on the configuration.
No action required.
Yes <connectorName>Connector.java This file is generated for developers to add custom code to override the configuration in the base connector implementation.
Copy any custom implementations that you added to the override methods to this file from the BaseConnector.java file.
For example, validateConnection is a custom implementation by the developer, which should be added in the <connectorName>Connector.java class.
No <triggerName>Trigger.java One file is generated for each trigger. Developers can add custom code for that particular trigger.
Copy any trigger specific implementation to the proceessTrigger method in <triggerName>Trigger.java class.
No <actionName>Action.java One file is generated for each action. Developers can add custom code for that particular action.
Copy any action specific implementation to the proceessAction method in <actionName>Action.java class.
No <lookupName>Lookup.java One file is generated for each lookup. Developers can add custom code for that particular lookup.
Copy any lookup specific implementation to the processLookup method in <lookupName>Lookup.java class.
No <queryName>Query.java One file is generated for each query. Developers can add custom code for that particular query.
Copy any query specific implementation to the executeQuery method in <queryName>Query.java class.
Files generated for Java-script based connector:
File Name Description Action Overwritten?
Main connector file maintained by BMC that provides the basic functions of the connector.
No action required.
Additional functions maintained by BMC that can be used by custom codes and BMC codes
No action required.
Custom codes can be added to this file when initializing (initialize), closing (closeConnector), or validating (validateConnector) a connector.
Copy any custom implementation that you added to the override methods to this file.
For example, custom implementation of validateConnector by the developer needs to be added to this file.
One file for each trigger.
Developers can add custom codes for that particular trigger.
Copy all the trigger-specific implementations to the triggerPollCustom method in connector_trigger_<triggerName>.js
One file for each action.
Developers can add custom codes for that particular action.
Copy all the action-specific implementations to the executeActionCustom method in connector_action_<actionName>.js
One file for each lookup.
Developers can add custom codes for that particular lookup.
Copy all the lookup-specific implementation to the executeQueryCustom method in connector_query_<queryName>.js
One file for each query, custom codes can be added for that particular query.
Copy all the query specific implementations to the LookupCustom method in connector_lookup_<lookupName>.js
After you update the files, you can modify the connector configurations by using the new BMC Helix Connector Designer.