MettleCI Workbench installations prior to build 1165 were configured to use a single work item management system when searching for issues during Git commit operations. This presented a challenge where different projects on a single DataStage Engine needed to reference different work item management systems in their respective commit messages. This could be the case when different DataStage teams sharing an engine tier want to reference work items managed in different systems, or when an organisation migrates from one work item management platform to another (replacing Service Now with Jira, for example).

Workbench build 1165 (and later) provide the ability to define multiple work item management systems in your Workbench instance, and then associate each individual DataStage project with a one of those systems as part of the project registration process.

To get Workbench working correctly with the new capability, users of MettleCI Workbench versions prior to 1165 will need to update their work item management system connection details and define which work item management system each DataStage project should use during Git commits. Questions worth considering before proceeding are:

1. How many work item management systems you wish to support?

2. Which if those systems is the most commonly used, and hence should be the default for newly-registered DataStage projects?

The Upgrade Process

MettleCI build 1165+ is delivered with a single work item management system definition, referred to by its label ‘Default Generic Issue Manager’. When new DataStage projects are registered with MettleCI Workbench they are automatically associated with this work item management system by default. Most users will find it most convenient to edit the details of this entry to match their most commonly used work item management system. To do this follow these steps:

1. Upgrade your MettleCI installation to the 1165 or later build using the instructions appropriate to your platform (whether Unix or Windows). Be sure to restart your Workbench service.

2. Log in to the MettleCI Workbench as a user with DataStage Administrator privileges.

3. Go to User → Issue Management. If you don’t see this menu (or any other options described below) perform a force refresh of your browser as described on this page.

4. You'll be presented with the a list of registered work item management systems. Initially you will have only the single default available.

    

   Open

   

    

5. Click the Edit (pencil) icon next to the system whose details you wish to edit.

    

   Open

   

    

6. From the Issue Management Type drop down list select the default (most commonly used) work item management platform your DataStage projects

7. Edit the default name to something more descriptive

8. Enter the values specific to your chosen technology. Note:

   1. Users with the appropriate permissions who are having trouble finding their correct configuration values can SSH to their DataStage Engine tier and derive the appropriate values from the config.yml file in the MettleCI Home directory. For example:

      $> cd /opt/dm/mci/ $> # Get your previously configured work item management settings $> cat config.yml issueManagement: JIRA jira: url: http://demo.mettleci.io/jira consumerKey: "BC847C98-FDAF-48A0-87B1-7B4B8888AACC" consumerSecret: /opt/dm/mci/jira_privatekey.pcks8 ...

       

   2. double-quoted values in your config.yml should have the double-quotes removed when entered into the Workbench interface.

   3. Where your config.yml references private key files (e.g. /opt/dm/mci/jira_privatekey.pcks8) you actually need to retrieve the contents of those files for the Edit Issue Management Service form, not the file name specified in your config.yml. For example:

      $> # Get the contents of your previously configured private key $> cat /opt/dm/mci/jira_privatekey.pcks8 -----BEGIN PRIVATE KEY----- MIIp98nymta3498my4t398pmt43c98mt43gserooICAQDrp4tl//9kc7k6 6SDVlophmkvkwmBuvPRCegVPIKMde2H5xcyAFpnibZC61+Tfo/NgijZAUd08C/Jn ..... aW5dZNuXf5bfY4bujqixoVoUwM3eNSFe -----END PRIVATE KEY-----

       

9. Click Submit when you’re done. You’ll now see your default work item management system listed with its specified type (in this case, JIRA).

All of your currently registered projects will now use this Jira configuration by default, and you can choose to move to another issue management service or server by creating another configuration. To create additional issue management services simply click the [+] icon in the top right hand corner.

See also

• Registering Issue Management Systems in Workbench

• Integrating Atlassian Jira with MettleCI Workbench