(v5) Deploying Message Handlers with Bamboo

There are two types of Message Handlers in DataStage.

Project Level Message Handlers: These are installed in an application directory per Engine and and aren't supported by MettleCI so should be migrated manually.
Job Level Message Handlers: There is a MettleCI plugin to support their deployment only. While MettleCI deploys Job Level Message Handler files from a Project's Git repository, it doesn't offer native check-in and deletion functions for them (as they are not “DataStage assets”, see https://datamigrators.atlassian.net/wiki/pages/createpage.action?spaceKey=SDT&title=%28v5%29%20Why%20do%20Data%20Migrators%20suggest%20switching%20away%20from%20Message%20Handlers%3F&linkCreation=true&fromPageId=2690154506 for more information) so they must be managed via command line Git.

Message Handler Deployment Plug-In

There is a Bamboo Plugin to support deployment of Job-Level Message Handlers: dm-dsmsgh-plugin. Installing this plugin enables the https://datamigrators.atlassian.net/wiki/spaces/MCIDOC/pages/412155905. There is also corresponding MettleCI CLI command isx. message-handlers as well, see https://datamigrators.atlassian.net/wiki/spaces/MCIDOC/pages/412286979 for more information.

The Plugin includes a task that will read all Message Handlers that follow the "<Job Name>.msh" naming convention and "inject" them into the ISX file of the corresponding Job during deployment. The updated ISX file can then be deployed like normal, resulting in both the Job design and Job-Level Message Handler ending up in the target DataStage instance.

In order to use this MettleCI feature:

All Job-Level Message Handlers in a particular DataStage Project will need to be added to the corresponding Git repository, alongside the existing ISX files. These files need to be named following the "<Job Name>.msh" convention.
Continuous Integration Build Plans and Deployment Environments in Bamboo will need to be updated to execute the new "DataStage Message Handlers Task" immediately before the "DataStage Incremental Deployment Task".
For each Message Handler added to Git, the corresponding <Job Name>.isx jobs need to be checked in to Git again. This is necessary to ensure that the subsequent CI Build Plan deployment (triggered by the check-in) will process the Message Handler as necessary.
No change to Bamboo Deployment Environment configuration is required.

How to find the relevant Local.msh in the Information Server File System.

For example: There is a Job called “GR_ACCOUNTS_LOCAL"
Within the relevant Project filesystem, find the RT_SC<Job Number> directory that corresponds to the Job. The simplest method is to use Director to open up a log entry for the Job then get the "Job No." entry from that dialog box.
Within the RT_SC<Job Number> directory, find the Job-Level Message Handler config file (Local.msh)
Once found, copy and rename that file to GR_ACCOUNTS_LOCAL.msh and check it into Git alongside the existing ISX file
Once this file has been checked in, re-check in the corresponding Job. This ensures that automated deployments pick it up.
The (updated) Continuous Integration Bamboo Plan for the corresponding DataStage Project will be auto-triggered and must complete successfully. This will ensure that subsequent deployments to other environments (Test, QA, Production) will include Job-Level Message Handlers.

Changes to CI Plans

Continuous Integration Build Plans in Bamboo will need to be updated to execute the "DataStage Message Handlers" Task.

Once you have deployed the dm-dsmsgh-plugin plugin .jar to Bamboo, you will be able to add a 'DataStage Message Handlers' Task to an existing Continuous Integration Build Plan.

Ensure the new Task is immediately before the "Incremental DataStage Deployment" Task.

Both the 'Root ISX directory' and 'Root message handler directory' fields must contain: datastage.

These techniques will let you manage and deploy your job level message handlers. We suggest that where possible you migrate away from using message handlers as discussed in