Integrating your MettleCI Workbench with ServiceNow will enable MettleCI Workbench to perform a dynamic lookup when linking DataStage Git commits to one or more ServiceNow work items directly within the Workbench user interface. It is a two step process, there are some items to configure and collect from the Service Now instance, and then some items to configure in Workbench
...
Register Workbench as an OAuth2 ServiceNow Application
...
Access the MettleCI Workbench page to integrate with your Service Now Work Item Management system by logging in to MettleCI Workbench and select Issue Management from the Profile menu (top right)
On the Registered Issue Management Systems screen select the “+” to create a new Issue Management type.. Initially you will have only the “Default Generic Issue Manager” present, but you can add as many as you need to (including more than one of the same type if necessary) one at a time. It is recommended that you get one working before you add another.
On the Add Issue Management screen that appears
select Service Now from the Select Issue Management Type dropdown
...
Field list
Name: Anything you like, but something that identifies your Service Now organisational instance would be a sensible choice
URL: The URI of your Service Now instance recorded earlier.
Client ID: Your Application (client) ID recorded earlier
Client Secret: Your client secret recorded earlier
Search Queries: This has no default, you will need to create at least one query. Consult with your ServiceNow administrators to determine what table(s) your organization uses, and thus, what table(s), then add or edit the query or queries as needed by using the “pencil” icon and “+” icon to edit what is queried or add a new table to query, respectively. The example uses change_task as the table, keyed on number with number: short_description as the summary shown to the user.
OPTIONAL - In the Search Queries section of any query, you can add add a filter expression to limit what is returned. Note that this expression is not checked for correct syntax. Consult with your ServiceNow administrators to determine whether you need to filter (most organizations will not) and what columns/values to filter on.
It is not necessary to restart the Workbench service, but clearing the log and then restarting the service may aid in debugging
Code Block $> cd /opt/dm/mci $> mv mci.log mci.log_preIssueManagementChanges $> sudo service dm-mettleci-workbench restart
...
That concludes Service Now setup.
(cut the rest of this as it’s obsolete)
For older Workbench installations prior to 1520 (??)
...
setup
...
Change the issueManagement property to serviceNow, add an serviceNow section as shown below and replace the <tags> with the values noted in the previous steps:
| Code Block | ||
|---|---|---|
| ||
issueManagement: serviceNow
serviceNow:
url: <your ServiceNow instance URL>
clientId: <your Client ID>
clientSecret: "<your Client Secret>" |
Add at least one ServiceNow Table to search during Work Item lookup:
| Code Block |
|---|
issueManagement: serviceNow
serviceNow:
url: <your ServiceNow instance URL>
clientId: <your Client ID>
clientSecret: "<your Client Secret>"
search:
- table: <first ServiceNow Table to search>
id: <template string>
summary: <template string>
- table: <second ServiceNow Table to search>
id: <template string>
summary: <template string> |
...
.
...
| Code Block |
|---|
issueManagement: serviceNow
serviceNow:
url: <your ServiceNow instance URL>
clientId: <your Client ID>
clientSecret: "<your Client Secret>"
search:
- table: incident
id: "${number}"
summary: "${number}: ${short_description}"
- table: problem
id: "${number}"
summary: "${number}: ${short_description}" |
Restart the workbench service
| Code Block |
|---|
sudo service dm-mettleci-workbench restart |
ServiceNow work items will be available from the the Issues drop down during Check-in:
...