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:
- 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 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 xxx. |
| syncChangeData |
Queries the ServiceNow repository for xxxs. |
Integration
To create a value stream, complete the following tasks.
- From the user interface Value Streams page, click Create to create a new value stream for the integration.
- Locate and open the value stream on the Value Streams page.
- Click Download Sample and save the same JSON value stream file.
- Edit the file and include the properties needed to define the integration.
- 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 |
| 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 |
| Password |
String |
The password associated with the user name to authenticate with the ServiceNow server. |
No |
| UrbanCode Velocity User Access Key |
Array |
The user access key to authenticate with the UrbanCode Velocity server. |
Yes |
| URL |
String |
The URL to the ServiceNow server. |
Yes |
| User Name |
String |
The user name to authenticate with the ServiceNow server. |
Yes |
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",
"properties": {
"ucvAccessKey": "<urbancodevelocit_user_accesskey>",
"baseUrl": "",
"username": "username",
"password": "password"
}
}
]