Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Your use of this download is governed by Stonebranch’s Terms of Use, which are available at https://www.stonebranch.com/integration-hub/Terms-and-Privacy/Terms-of-Use/

Overview

ServiceNow aims to deliver digital workflows that create great experiences and unlock productivity for enterprise operations. The company's core business revolves around management of "incident, problem, and change".

This Integration allows customers to create incident tickets in ServiceNow straight from the Universal Controller. A typical Use Case is creating a ticket in ServiceNow in the event of a Task failure within the Universal Controller.

Version Information

Template NameExtension Name
Extension
VersionStatus
ServiceNow Incidentue-servicenow-incident2.
1
2.0Fixes and new Features are introduced.


Refer to Changelog changelog for version history information.

...

  • Universal Agent for Windows x64 Version 7.23.0.0 and later with Python options installed.
  • Universal Agent for Linux Version 7.23.0.0 and later with Python options installed.

...

Universal Controller Version 7.23.0.0 and later.

Network and Connectivity Requirements

...

Modifications of this integration, applied by users or customers before or after import, might affect its supportability. For more information, refer to Integration Modifications.

Configure Universal Task

...

FieldInput typeDefault valueTypeDescription
ActionRequiredCreate IncidentChoiceAction performed upon the task execution. Available actions.
  • Create Incident
ServiceNow Instance URLRequired-TextURL of the ServiceNow instance.
Authentication TypeRequired

Basic Authentication

Choice

Authentication method to use. Available methods,

  • Basic Authentication

  • Oauth2 (ServiceNow API endpoint)

ServiceNow CredentialsRequired-CredentialsCredentials for accessing ServiceNow via API. The Credentials definition should be as follows.
  • ServiceNow username as "Runtime User".
  • ServiceNow password as "Runtime Password".
Client CredentialsOptional-Credentials

Credentials for authenticating using OAuth2 (retrieving access token). The Credentials definition should be as follows.

  • Client ID as "Runtime User"
  • Client Secret as "Runtime Password"

Required when Authentication Type is Oauth2 (ServiceNow API)

CallerOptional-Dynamic ChoiceUser who reported or is affected by this incident.
CategoryOptional-Dynamic ChoiceThe category for incident creation. If not provided, the default category defined on ServiceNow will be considered.
SubcategoryOptional-Dynamic ChoiceThe subcategory for incident creation. The choice of Subcategory depends on the previous choice of Category.
ImpactOptional-Dynamic ChoiceThe impact of the created incident
UrgencyOptional-Dynamic ChoiceThe urgency of the created incident.
Assigned ToOptional-Dynamic ChoiceThe user is primarily responsible for treating this incident in ServiceNow.
Assignment GroupOptional-Dynamic ChoiceAssignment group that is responsible for working on this incident in ServiceNow.
Short DescriptionRequired-TextShort description of the incident.
DescriptionOptional-Large TextDescription of the incident.
Attach Output SourceRequired-- None --ChoiceParameter controlling whether an attachment will be attached to the incident and the source of it. The following options are available.
  • -- None --
  • Sibling Task Instance
  • Any Task Instance
Output TypeOptionalAllChoiceThe type of output to be used as an attachment. The following options are available.
  • All
  • Standard Output
  • Standard Error
Required when Attach Output Source is “Sibling Task” or “Any Task Instance”.
Number of linesOptional100IntegerThe number of lines to be retrieved from the task instance output. The extension will provide up to the specified number of lines, less if there are not enough lines generated.

Required when Attach Output Source is “Sibling Task” or “Any Task Instance”.

The value must be greater than 0.
Task Instance IDOptional-TextUUID of the task instance, the output of which is attached. UAC Functions can be used to resolve the required Task Instance ID. For more information, the reader can refer to the task examples.

Required when Attach Output Source is “Sibling Task” or “Any Task Instance”.
UC URLOptional-TextBase URL of the target Universal Controller.

Required when Attach Output Source is “Sibling Task” or “Any Task Instance”.
UC CredentialOptional-
Credential for accessing the Controller.

The Credentials definition should be as follows.
  • UA Controller username as "Runtime User".
  • UA Controller password as "Runtime Password".
Required when Attach Output Source is “Sibling Task” or “Any Task Instance”.

...

Provide Additional FieldsRequired-- None --Choice

The Provide Additional Fields provided as Choice field. This field allows the user to choose whether to include or not additional ServiceNow fields in the request as a JSON formatted text. The following options are available.

  • -- None --

  • As JSON Text

Additional Fields (JSON)Optional-Text

Additional Fields (JSON) provided as JSON formatted text. Each additional field can be sent as a key/value pair.

Required when Provide Additional Fields is "As JSON Text".


Note

Using empty values for dynamic choice fields will result in ServiceNow setting a default value for the field if one exists.

...

Example of creation of an incident.

Image RemovedImage Added

Create an Incident with an attachment from a Sibling Task

...


An example of a task configured to use the information from the failed Universal Task Instance as an attachment for creating a ServiceNow Incident is provided below.

Image Modified

Create an Incident from any Task Instance

...

Step 1: Create a Monitor Task that monitors for the failure of tasks by configuring Monitor Details.

Image RemovedImage Added

Step 2: Configure the ServiceNow Incident task. The created Incident Task propagates the output of the failed Task Instance as an attachment to ServiceNow. For that, a Task Monitor trigger is required.

Image Removed

Step 3: Create a Task Monitor Trigger linked to the Monitor Task (on Step 1), which controls the action that needs to be taken when the monitor successfully monitors a failure, in this case, the trigger of an incident ticket configured on Step 2.

Image Removed

Create Incident using OAuth2 authentication

Image Removedrequired.

Image Added

Step 3: Create a Task Monitor Trigger linked to the Monitor Task (on Step 1), which controls the action that needs to be taken when the monitor successfully monitors a failure, in this case, the trigger of an incident ticket configured on Step 2.

Image Added

Create Incident using OAuth2 authentication

Image Added

Create Incident with Additional Fields

Info

If a ServiceNow Field is defined in Additional Fields (JSON), and at the same time it is defined with a value on another existing field, the value defined on the specific designated field has precedence and the one defined on Additional Fields (JSON) will be ignored.


Image Added

Task Output

Exit Codes

...

Anchor
Changelog
Changelog

Changelog

ue-servicenow-incident-2.2.0 (2024-07-19)

  • Enhancements: Added support for all ServiceNow Incident fields.
  • Breaking Changes: This integration is no longer importable on Universal Controller 7.2 or runnable on Agent version 7.2.

ue-servicenow-incident-2.1.0 (2024-02-15)

...