Usage

To use the ServiceNow plug-in, the plug-in must be loaded and an instance created before you can configure the plug-in integration and use plug-in automation tasks. You define configuration properties in the user interface or in a JSON file.

See the Automation Tasks tab for information on using automation tasks.

Integration type

The ServiceNow plug-in supports scheduled events integration which are listed in the following table.

Integration

There are two methods to integrate the plug-in:

• Using the user interface
• Using a JSON file

Using the user interface

• From the Plug-ins page, click Settings > Integrations > Plug-ins.
• Under the Action column for the plug-in, click Add Integration.
• On the Add Integration page enter values for the fields used to configure the integration and define communication.
• Click Save.

Using a JSON file

The JSON file contains the information for creating a value stream and integrating with the ServiceNow server. The following table describes the information for the creating a HCL DevOps Velocity value stream map.

• From a value stream page, download the value stream map. The value stream map is a JSON file used to define integrations.
• Edit the JSON file to include the plug-in configuration properties.
• Save and upload the JSON file. This replaces the current JSON file with the new content.
• View the new integration on the Integrations page.

Configuration Properties

The following tables describe the properties used to configure the integration. Each table contains the field name when using the user interface and the property name when using a JSON file.

• The General Configuration Properties table describes configuration properties used by all plug-in integrations.
• The ServiceNow Configuration Properties table describes the ServiceNow configuration properties that define the connection and communications with the ServiceNow server. When using the JSON method to integrate the plug-in these properties are coded within the properties configuration property.

Some properties might not be displayed in the user interface, to see all properties enable the Show Hidden Properties field.

JSON code sample

The following sample code can be used as a template to define the integration within the JSON file for a value stream. Copy and paste the template into the JSON file Integration section and make the appropriate changes.

integrations": [
    {
      "type": "ucv-ext-servicenow",
      "name": "Plugin for ServiceNow",
      "tenant_id": "tenant_id",
      "logginglevel": "info",
      "properties": {
        "ucvAccessKey": "urbancodevelocity_user_accesskey",
        "baseUrl": "url_servicenow_server",
        "username": "user_name",
        "password": "pass_word",
        "client_id": "client_Id",
        "client_secret": "client_secret",
        "refresh_token": "refresh_token",
        "proxyServer": "proxy_server_url",
        "proxyUsername": "proxy_server_user_name",
        "proxyPassword": "proxy_server_password" 
      }
    }
  ]

Automation Tasks

The following automation tasks are available in the ServiceNow plug-in:

• ServiceNow – Create Change Request and Change Task
• ServiceNow – Update Change Request and Change Task
• ServiceNow – Wait Change Request
• ServiceNow – Wait Change Task

ServiceNow – Create Change Request and Change Task

Use this step to create a ServiceNow change request in HCL DevOps Velocity.

ServiceNow – Update Change Request and Change Task

Use this step to update a ServiceNow change request in HCL DevOps Velocity.

ServiceNow – Wait Change Request

Use this task to wait ServiceNow change request in HCL DevOps Velocity.

ServiceNow – Wait Change Task

Use this step to create a ServiceNow wait change task.

Adding automation tasks to a release

After the plug-in is integrated, automated tasks are available to add as a task within a release.

• Verify that the ServiceNow server is connected to HCL DevOps Velocity.
• On the Create Task page, select the automation task from the Type field drop-down list.
• Complete the properties required for the task.
• Click Save.

Examples

integrations": [
    {
      "type": "ucv-ext-servicenow",
      "name": "Plugin for ServiceNow",
      "tenant_id": "tenant_id",
      "logginglevel": "info",
      "properties": {
        "ucvAccessKey": "urbancodevelocity_user_accesskey",
        "baseUrl": "url_servicenow_server",
        "username": "user_name",
        "client_id": "client_Id",
        "client_secret": "client_secret"
        "refresh_token": "refresh_token",
        "accessToken": "access_token",
        "proxyServer": "proxy_server_url",
        "proxyUsername": "proxy_server_user_name",
        "proxyPassword": "proxy_server_password"  
      }
    }
  ]

Using OAuth with ServiceNow

To use OAuth in your integration, you need to provide the following details during configuration:

• client_id
• client_secret
• refresh_token

Perform the following steps to obtain the client_id and client_secret from your ServiceNow instance:

1. Log in to your ServiceNow instance.

2. In the left-hand navigation pane, search for OAuth and select Application Registry.

3. Click New and choose Create an OAuth API endpoint for external clients.

4. Fill in the required details and click Submit.

5. After submission, navigate to the newly created OAuth record and click on it to view the client_id and client_secret.

To obtain the refresh token send a POST request by providing the username, password, Client ID and Client secret as shown in the below image.

Use the credentials client_id, client_secret and refresh_token in your integration to authenticate using OAuth.

Note: You must provide username and password along with client_id and client_secret if you are not providing the refresh token during the integration to authenticate using OAuth.