Registering a DataStage Project with MettleCI

To enable the MettleCI Workbench to perform Compliance testing or commit DataStage project assets to a Git repository the project must first be registered with MettleCI Workbench.

Step by step

1. To do this, log into the MettleCI Workbench where you’ll be taken to the Registered projects page.

   

   This page lists the DataStage projects currently registered with MettleCI Workbench. For each project listed, the page describes…

   • The project name

   • The name of the Git repository where your project assets are/will be stored.

   • The name of the default branch in the solution Git repository to which your assets will be comitted.

   • The name of the Git repository where your Compliance Rules are stored.

   • The name of the work item service integration associated with this project

   • Moving your mouse over a project will reveal a delete button on the right of the table which will unregister the project with Workbench. This button will not delete your DataStage project.

2. To register a new project with Workbench click Add project.

3. Select a DataStage Project from the dropdown list of existing (but unregistered) DataStage projects.

   

4. Specify the details of the Git repository where you’ll store your project assets. You can create a clean Git repository in your preferred Git system by cloning the template available here.

   

   • In the URL field, enter either the SSH or HTTP clone string for the project. Its exact format (including whether or not you prefix it with a protocol specifier - HTTP:// or SSH://) is dependant upon the features of your selected Git system, but will generally look very much like one of the following:

     1. https://<git.domain>/<repository-name>.git for HTTP/HTTPS-based URLs, or

     2. ssh://<user>@<git.domain>:<repository-path><repository-name>.git (or something similar) for SSH-based URLs

   • For example, the SSH clone string of a remote Git repository for a DataStage Project called ‘MYDATASTAGEPROJECT’ set up in Data Migrators' Atlassian’s Bitbucket Cloud instance would be ssh://git@bitbucket.org:datamigrators/mydatastageproject.git.

   • In the Branch field enter the branch you want MettleCI to commit to. Unless you have a good reason to specify otherwise, leave this field blank and MettleCI will use the repository’s default branch (typically master or main).

   • In the Path field, enter a location for your DataStage assets in the repository. If you’re using the Data Migrators repository template then enter datastage.

5. Specify the details of the Git repository where you’ll store your Compliance Rules. A .zip file containing an example Compliance Rules repository is shipped as part of your MettleCI media. For example, using an SSH URL to source compliance rules for MYDATASTAGEPROJECT from a compliance directory at the root of the DataStage Asset repository would be done using ssh://git@bitbucket.org:datamigrators/mydatastageproject.git. Note that Compliance rules can be sourced from a subdirectory of your DataStage solution repository, if that’s how you want to organise your repositories. We wouldn’t recommend this approach.

   

6. Finally, select the work item service integration (described here) that you wish to use with this project, or just use the ‘default’ integration which does not connect to a work item service.

   

7. Click Create.

8. Test the configuration of your registered project by…

   1. Running Compliance against a job and verifying that Workbench can read Compliance rules from the specified repository, and

   2. Making a trivial Job change (e.g. move an annotation a few pixels in any direction on the canvas) in the DataStage Classic Designer Client, remebering to save and compile your change) and then triggering a Git Commit process from the Workbench or custom menu item in the Designer Client.