Usage

To install the plug-in, perform the following steps:

1. In HCL DevOps Velocity, click Settings > Integrations > Available.
2. In the Action column for the ServiceNow plug-in, click Install.

There are two methods to integrate the plug-in:

• Using the user interface
• Using a JSON file

Integrating the plug-in by using user interface

To integrate the plug-in using the user interface, perform the following steps:

1. In HCL DevOps Velocity, click Settings > Integrations > Installed.
2. In the Action column for the ServiceNow plug-in, click Add Integration.
3. On the Add Integration dialog, enter the values for the fields to configure the integration and define communication.
4. Click Add.

Integrating the plug-in by using JSON file

The JSON file contains the information for creating a value stream. Within the JSON file is a section for integrations. It is in this section that plugin properties can be defined. Refer to the sample JSON code.

To integrate the plug-in using a JSON, perform the following steps:

1. Navigate to value stream page, and then click the necessary value stream.
2. Click  icon, and then Select Edit value stream to modify the JSON file in the code or tree view editors.
3. Alternatively, you can also click Download JSON option to download the JSON file, and then select the Import JSON option to upload the revised JSON file.
4. Edit the integration information in the JSON file to add the plug-in configuration properties. Refer to JSON sample code in the Configuration Properties section more details.
5. Click Save.

Integration type

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

Custom Field Mapping

ServiceNow now supports user-defined fields, to enable mapping of these fields to Velocity fields, a custom field mapping option is introduced within the ServiceNow plug-in. Additionally, ServiceNow allows custom values for any field. To implement the change failure rate matrix, it is essential to determine which change requests have a failed status, making value mapping necessary.

For example

   [
  {
    "type": "change_request",
    "fieldMapping": {
      "changeType": "u_deployment_category"
    },
    "valueMapping": {
      "resolution": {
        "failed": ["unsuccessful", "rejected"]
      }
    }
  }
]

In the above custom mapping configuration example, we are defining a mapping for the change_request resource in ServiceNow. The custom mapping ensures that specific fields from the velocity system are appropriately mapped to corresponding fields in ServiceNow.

Resource Type:

The resource type is identified as change_request. This is the type of record in ServiceNow where we want to implement the custom mapping.

Field Mapping:

The field changeType in the velocity system will be mapped to the field u_deployment_category in ServiceNow. This mapping ensures that when a record is transferred or synced, the changeType value will correctly correspond to the u_deployment_category field in ServiceNow.

Value Mapping for Resolution:

The resolution field in the velocity system may currently contain values like "unsuccessful" or "rejected." After applying the custom value mapping, these values will be mapped to a standardized value of failed. This ensures that records in ServiceNow will use a consistent value for the resolution status.

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": "devopsvelocity_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" 
        "fieldMapping": "Custom Field Mapping" 
      }
    }
  ]

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.

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.