Plug-in Documentation

ServiceNow

Overview

ServiceNow supports application delivery by integrating service management processes, social collaboration for IT departments, software-as-a-service delivery, and web functionality. The ServiceNow plug-in provides for integration with a ServiceNow server. This plug-in imports incident management(Beta), change management and problem management data from a ServiceNow server and provides a single view of ServiceNow incidents, change request and problems in Urban Code Velocity value stream map. Data between the ServiceNow server and the UrbanCode Velocity server is synchronized every five minutes.

Compatibility

Must be running UrbanCode Velocity version 1.2.6 and later to use the plug-in.

The plug-in supports the ServiceNow Madrid, Orlando and Paris release.

Versions

There is no install process for this plug-in. The ServiceNowb plug-in is identified to UrbanCode Velocity as a value stream integration. UrbanCode Velocity plug-in images are located in DockerHub and the UrbanCode Velolcity code accesses the version that you select. To view available versions,
see the UrbanCode DockerHub.

History

Version 1.0.14

  • Added HTTP proxy support

Version 1.0.13

  • Bug fix

Version 1.0.12

  • Added the capability to pull problems

Version 1.0.9

  • Added access token support.

Version 1.0.6

  • Update plugin version from 0.x.x to 1.x.x format.

Version 0.0.4

  • Initial release

Usage

To use the ServiceNow plug-in you must define the integration, create a value stream, and upload the integration.

The value stream map contains the properties, you will use to define the plug-in integration. Basically, the plug-in integration is defined with a value stream within the UrbanCode Velocity user interface. Defining the integration includes defining configuration properties that connect the UrbanCode Velocity server to the ServiceNow server.

The basic flow to use the plug-in includes:

  1. 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 plug-in 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 Integration user interface page.

Integration type

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

Scheduled events
Name Description
syncIncidentData Queries the ServiceNow repository for Incidents
syncChangeData Queries the ServiceNow repository for Change request
syncProblemData Queries the ServiceNow repository for Problems

Integration

To create a value stream, complete the following tasks.

  1. From the user interface Value Streams page, click Create to create a new value stream for the integration.
  2. Locate and open the value stream on the Value Streams page.
  3. Click Download Sample and save the same JSON value stream file.
  4. Edit the file and include the properties needed to define the integration.
  5. Click Upload to upload the 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 UrbanCode Velocity value stream map.

      Value stream map information
      Name Description Required
      image The version of the plug-in that you want to use. To view available versions, see the UrbanCode DockerHub. If a value is not specified, the latest version is used. No
      name An assigned name to the value stream. Yes
      properties List of configuration properties used to connect and communicate with the ServiceNow server. Enclose the properties within braces. Yes
      loggingLevel The level of Log4j messages to log. Valid values are: all, debug, info, warn, error, fatal, off, and trace. The default is info. No
      tenant_id The name of the tenant. Yes
      type Unique identifier assigned to the plug-in. The value for the ServiceNow plug-in is ucv-ext-servicenow Yes

      Configuration Properties

      The configuration properties which are included in the properties field are unique to the ServiceNow plug-in and define the connection and communication to the ServiceNow server.

      Configuration properties
      Name Type Description Required Project Name
      Access Token Secure The access token used to authenticate with the ServiceNow server. You can use either this property or the Password property to authenticate with the server. No accessToken
      Password Secure The password used to authenticate with the ServiceNow server. You can use either this property or the Access Token property to authenticate with the server. No password
      UrbanCode Velocity User Access Key Secure The user access key to authenticate with the UrbanCode Velocity server. Yes ucvAccessKey
      URL String The URL of the ServiceNow server. Yes baseUrl
      User Name String The user name used to authenticate with the ServiceNow server. Yes username
      Proxy Server String The URL of the proxy server including the port number. No proxyServer
      Proxy User Name String The user name used to authenticate with the proxy server. No proxyUsername
      Proxy Password String The password used to authenticate with the proxy server. No proxyPassword

      Example

      The following example can be used as as template to include the ServiceNow plug-in integration into the JSON file.
      Copy and paste the template into the JSON file and make the appropriate changes.

      
        integrations": [
          {
            "type": "ucv-ext-servicenow",
            "name": "Plug-in 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" 
            }
          }
        ]
      

      Example using access key.

      
        integrations": [
          {
            "type": "ucv-ext-servicenow",
            "name": "Plug-in 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"  
            }
          }
        ]