Usage

To use the ServiceNow plugin, the plugin must be loaded and an instance created before you can configure the plugin integration and use plugin 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 plugin supports scheduled events integration which are listed in the following table.

Integration

There are two methods to integrate the plugin:

• Using the user interface
• Using a JSON file

Using the user interface

The tables in the Configuration properties topic describe the properties used to define the integration.

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

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

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

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

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.

1. From a value stream page, download the value stream map. The value stream map is a JSON file used to define integrations.
2. Edit the JSON file to include the plugin configuration properties.
3. Save and upload the JSON file. This replaces the current JSON file with the new content.
4. 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 plugin 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 plugin 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",
        "proxyServer": "proxy_server_url",
        "proxyUsername": "proxy_server_user_name",
        "proxyPassword": "proxy_server_password" 
      }
    }
  ]

Automation Tasks

The following automation tasks are available in the ServiceNow plugin:

• 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 and change task.

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 plugin is integrated automated tasks are available to add as a task within a release.

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

Examples

Example using the access key

  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",
        "accessToken": "access_token",
        "proxyServer": "proxy_server_url",
        "proxyUsername": "proxy_server_user_name",
        "proxyPassword": "proxy_server_password"  
      }
    }
  ]