ServiceNow Plugin
With the Release ServiceNow plugin, you can work with release tasks on a ServiceNow host from the Release UI.
Install the ServiceNow plugin in Digital.ai Release
For more information on the installation, refer to Install a plugin.
Connect the ServiceNow server from Digital.ai Release
To set up a connection to a ServiceNow server:
- Import the ServiceNow Digital.ai Release plugin (See above section)
- In Digital.ai Release, from the navigation pane, go to Configuration > Connections > ServiceNow: Server, and click the Add button to add a new ServiceNow server
- Input the Title and Url
- Choose your authorization method
Basic auth:
- Input the Username for service now
- Input the Password for service now
Oauth:
- Check the Use ServiceNow OAuth box
- Input the External OAuth URL (Ignore this if the ServiceNow OAuth server is used)
- Input the Username for Oauth (Username for Servicenow)
- Input the Password (Password for Servicenow)
- Input Client Id
- Input Client Secret
Wait For Status:
- Select the Wait Progression Type (Enumeration. Exponential or Custom list.)
- Input the Max Tries (Maximum number of attempts for Exponential. Task fails after reaching this limit. A value of 0 indicates no limit.)
- Input the Wait Interval (Number of seconds to wait between attempts for Exponential)
- Input the Wait Interval Increase (Wait time is increase by this factor in each iteration for Exponential Progression Type)
- Input the values in Wait Custom List (Format example:
number of tries
,wait interval
)- Wait Custom list assigns the number of tries to attempt with an assigned interval of second between. Enter a comma-separated integer pair. Entering multiple list values will execute in sequential order. For example, when using the numbers in the image above, the count begins incrementing on its way to 10, the wait interval is 300 seconds. This will make the first 10 iterations be 300 seconds each. Continuing down the list, the next 5 iterations, from 10 to 15, will be 900 second each. This process continues in the same manner down the rest of the list.
Custom configuration:
- Input the API URL Endpoint (A custom URL endpoint for API calls is a value that will replace '/api/now/table')
- Input the HTTP Authorization Header (The value of an HTTP Request authorization header e.g. Basic dXNlcm5hbWU6cGFzc3dvcmQ=)
-
Click the test button. If configured correctly, the following message will appear:
-
Click Save
ITSM task types
The following ITSM task types are included:
- ServiceNow: Create Change Request
- ServiceNow: Update Change Request
- ServiceNow: Find Change Request
- ServiceNow: Create Change Task
- ServiceNow: Update Change Task
- ServiceNow: Find Change Task
- ServiceNow: Find Change Task by Parent
- ServiceNow: Wait for Status
- ServiceNow: Create Application
- ServiceNow: Update Application
- ServiceNow: Publish Article
- ServiceNow: Create Incident
- ServiceNow: Update Incident
- ServiceNow: Find Incident
- ServiceNow: Create Service Request
- ServiceNow: Find Service Request
- ServiceNow: Update Service Request
- ServiceNow: Create Request Item
- ServiceNow: Update Request Item
- ServiceNow: Find Request Item
- ServiceNow: Find Record by Number
- ServiceNow: Find Records by Query
- ServiceNow: Find Configuration item by Name
Agile task types
For Agile-related task types, an extra update will need to be installed on the ServiceNow side. The available Agile development-related task types are:
- ServiceNow: Create Story
- ServiceNow: Update Story
- ServiceNow: Find Story
- ServiceNow: wait for Status
- ServiceNow: Create Scrum Task
- ServiceNow: Update Scrum Task
- ServiceNow: Find Scrum Task by Story
- ServiceNow: Create Epic
- ServiceNow: Update Epic
- ServiceNow: Find Epic
- ServiceNow: Find Sprint
- ServiceNow: Update Sprint
- ServiceNow: Create Release
- ServiceNow: Update Release
- ServiceNow: Find Release
In the release flow editor, the ServiceNow tasks have a blue border.
With 22.2 version of Release, three new task have been added with which you can create a release, update an existing release, and find an existing release using the ServiceNow plugin:
- ServiceNow: Create Release
- ServiceNow: Update Release
- ServiceNow: Find Release
Deprecation of task types
The following ITSM task types are still present and functional as of 8.6.0, but will be deprecated in a later version:
- ServiceNow: Check Change Request
- ServiceNow: Request Approval
- ServiceNow: Get Change Request
- ServiceNow: Check Status
- ServiceNow: Update CMDB
- ServiceNow: Schedule Task
The following task types are removed and must be migrated. To migrate these tasks, you can use the Digital.ai ServiceNow migration tool. For more information on how to use the migration tool, see the migration tool documentation.
- ServiceNow: Create Record
- ServiceNow: Create New Record
- ServiceNow: Update Record
- ServiceNow: Create New Service Request
- ServiceNow: Create New Request Item
- ServiceNow: Create New Change Request
- ServiceNow: Create Task
- ServiceNow: Update Task
- ServiceNow: Create Request
Because these tasks will be deprecated, we recommend migrating your processes to existing processes, which should be able to perform the same functions.
The table below describes the recommended replacements and implementation tips for deprecated task types.
Old task type | Task type to use | How to use |
---|---|---|
Request approval | Update change request | Set the change to the correct state that initiates approval |
Get Change Request | Find Change Request | All methods return a complete set of fields for the change |
Check Status | Wait for Status | Similar, but with more options |
Update CMDB | Update Application | Use 'Additional fields' instead of removed ones |
Schedule Task | No alternative | - |
Task type descriptions
This section describes the fields available for each task type as well as the output properties.
Many of the task types use the same set of fields, so the descriptions are common to similar tasks.
"Create" task type
Since most of the create task types are similar, only the general information is explained here.
The ServiceNow: Create task type creates a new record in the ServiceNow server. The following properties are available:
Server
: [Required] The ServiceNow server to connect to.Username
: Overrides the username in Connections.Password
: Overrides the password in Connections.Short Description
: [Required] A short description of the record to be created.Description
: Comments in the record to be createdConfiguration Item
: Related configuration item (display value or sys_id)Assignment Group
: The group the record will be assigned to (display value or sys_id).Assigned To
: The user the record will be assigned to (display value or sys_id).State
: The display value of the state the record will be set to.Priority
: The priority to enter for the record.Comments
: [Required] Comments in the record to be created.Additional Fields
: Additional fields can be added by providing the technical name and the value to enter.
The task output properties are Data
, Sys Id
, and Ticket
.
"Update" task type
The ServiceNow: Update task type updates an existing record in the ServiceNow server. The properties are similar to the create task type except for the following property:
Sys Id
: [Required] The sys ID of the task that needs to be updated (Example:d1a37dcadb0023006ab155d0cf9619d5
).
The task output properties are Data
and Number
.
"Find" task type
The ServiceNow: Find task type finds an existing record in the ServiceNow server. The following properties are available:
Server
: [Required] The ServiceNow Server to connect to.Username
: Overrides the username in Connections.Password
: Overrides the password in Connections.Number
: [Required] The number of the ticket that needs to be found (Example:REQ0010001
).
The task output properties are Data
and Sys Id
.
"Wait for status" task type
The ServiceNow: Wait for Status task type verifies the value of an existing task in the ServiceNow server.
The following properties are available:
-
Server
: [Required] The ServiceNow Server to connect to. -
Username
: Overrides the username in Connections. -
Password
: Overrides the password in Connections. -
Table Name
: [Required] The table name of the table in ServiceNow (Example:change_task
). -
System ID
: [Required] The system ID of the ticket that needs to be updated (Example:d1a37dcadb0023006ab155d0cf9619d5
). -
Status Field
: [Required] The status field to use (Example:state
). -
Status to check for
: [Required] The value of the status field to check against the status field (Example:Closed,Canceled
). -
Override Server Wait Config
: Checked (true) lets the properties on the task override the server properties.For more information on configuring the Wait Progression Type, Max Tries, Wait Interval, Wait Interval Increase and Wait Custom List, see the Connect the ServiceNow server from Release section above.
The task output properties are
Data
,Number
,Status
, andNum Tries
.
Using the Override Server Wait Config option:
- This option allows the user to manually configure the number of attempts and wait interval for the Wait for status task. While using the Wait for status task users must decide to either set a constant interval over a set number of tries, by not selecting the Override Server Wait Config box or set their own custom list. This can be done by checking the Override Server Wait Config box. Checking this option will ignore the options Wait Progression Type, Max Tries, Wait Interval and Wait Interval Increase. Instead, it will use the values of the Wait Custom List. For more information on how the Wait Custom List operates see the above note.
"Find Change Task by Parent" task type
The ServiceNow: Find Change Task by Parent task type finds the child change task of a change request from the change request details and the beginning of the short description of the change task. The ServiceNow: Find Scrum Task by Story task type looks and functions similarly to this. The following properties are available:
Server
: [Required] The ServiceNow Server to connect to.Username
: Overrides the username in Connections.Password
: Overrides the password in Connections.Short Description
: The short description of the record to search for.Parent
: [Required] The sys_id of the parent Change Request.
The task output properties are Data
and Sys Id
.
Find Record by Number
This task finds a record by number in ServiceNow. It is used to locate a specific record using its unique identifier.
Find Records by Query
This task finds records by query in ServiceNow. It is used to search for records based on specified query criteria.
Create Change Request
This task creates a change request in ServiceNow. It is used to initiate a request for changes within the system.
Update Change Request
This task updates a change request in ServiceNow. It is used to modify the details of an existing change request.
Find Change Request
This task finds a change request by ticket in ServiceNow. It is used to locate a change request using its ticket number.
Create Change Task
This task creates a change task in ServiceNow. It is used to generate a new task associated with a change request.
Update Change Task
This task updates a change task in ServiceNow. It is used to modify the details of an existing change task.
Find Change Task
This task finds a change task by task ID in ServiceNow. It is used to locate a specific change task using its unique identifier.
Create Application
This task creates a new application in ServiceNow. It is used to add a new application to the system.
Update Application
This task updates an application version in ServiceNow. It is used to modify the version details of an existing application.
Find Configuration Item by Name
This task finds a configuration item (CI) by name in ServiceNow. It is used to locate a specific CI using its name.
Publish Article
This task publishes an article in ServiceNow. It is used to make an article available for viewing.
Create Incident
This task creates an incident in ServiceNow. It is used to report and track incidents.
Update Incident
This task updates an incident in ServiceNow. It is used to modify the details of an existing incident.
Find Incident
This task finds an incident by ticket in ServiceNow. It is used to locate an incident using its ticket number.
Create Story
This task creates a story in ServiceNow. It is used to add a new story for tracking purposes.
Update Story
This task updates a story in ServiceNow. It is used to modify the details of an existing story.
Find Story
This task finds a story in ServiceNow. It is used to locate a specific story.
Create Scrum Task
This task creates a scrum task in ServiceNow. It is used to add a new task to a scrum board.
Update Scrum Task
This task updates a scrum task in ServiceNow. It is used to modify the details of an existing scrum task.
Find Scrum Task by Story
This task finds a scrum task by story in ServiceNow. It is used to locate scrum tasks associated with a specific story.
Create Epic
This task creates an epic in ServiceNow. It is used to add a new epic for tracking large work items.
Update Epic
This task updates an epic in ServiceNow. It is used to modify the details of an existing epic.
Find Epic
This task finds an epic in ServiceNow. It is used to locate a specific epic.
Update Sprint
This task updates a sprint in ServiceNow. It is used to modify the details of an existing sprint.
Find Sprint
This task finds a sprint in ServiceNow. It is used to locate a specific sprint.
Create Service Request
This task creates a service request in ServiceNow. It is used to initiate a request for service.
Update Service Request
This task updates a service request in ServiceNow. It is used to modify the details of an existing service request.
Find Service Request
This task finds a service request in ServiceNow. It is used to locate a specific service request.
Create Requested Item
This task creates a request item in ServiceNow. It is used to add a new item to a service request.
Update Requested Item
This task updates a request item in ServiceNow. It is used to modify the details of an existing request item.
Find Requested Item
This task finds a request item in ServiceNow. It is used to locate a specific request item.
Request Approval
This task requests approval in ServiceNow. It is used to initiate the approval process for a change or request.
Get Change Request
This task gets a change request in ServiceNow. It is used to retrieve the details of a specific change request.
Check Change Request
This task checks the status of a change request in ServiceNow. It is used to verify the current state of a change request.
Schedule Task
This task schedules a task in ServiceNow. It is used to set a task to be performed at a specific time.
Update CMDB
This task updates the CMDB (Configuration Management Database) in ServiceNow. It is used to modify configuration items in the CMDB.
Check Status
This task checks the status of an item in ServiceNow. It is used to verify the current state of a specific item.
Create Release
This task creates a release in ServiceNow. It is used to initiate a new release process.
Update Release
This task updates a release in ServiceNow. It is used to modify the details of an existing release.
Find Release
This task finds a release in ServiceNow. It is used to locate a specific release.