Versions Compared

Key

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


Panel

Table of Contents

Disclaimer

...

Template NameExtension NameVersionStatus
ServiceNow Incidentue-servicenow-incident2.3.2Fixes and new Features are introduced.

Refer to Changelog for version history information.

...

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

Configure Universal Task

For a new Universal Task, create a new task and enter the required input fields.

...

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.
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. The key corresponds to the column name of the incident entry, as defined in the incident table's configuration. The value is set according to the entry's type. For more information, refer to Additional Fields (JSON) Configuration /wiki/spaces/IS/pages/150082745.

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

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.

Attach Instance InformationRequired-- 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

Label of this Field changed since version 2.3.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”.
Instance Output TypeOptional-- None --Choice

The type of output to be used as an attachment. The following options are available.

  • -- None --
  • All - all available task outputs related to the task instance will be attached
  • Standard Output
  • Standard Error

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

The full content of the outputs selected will be retrieved with the exception of STDOUT/STDERR which is controlled by field Number of lines for STDERR/STDOUT.

Number of lines for STDERR/STDOUTOptional100IntegerThe number of lines to be retrieved from the task instance output. The extension will provide up to the specified number of lines, or less if there are not enough lines generated.

Required when Instance Output Type is “All”, “Standard Output” or ”Standard Error”.

The value must be greater than 0.
Instance FieldsOptional-Multiple Choice

The instance fields to be retrieved related to the task instance. The following options are available.

  • Status Description

  • Exit Code
  • Execution User
  • Task Name

More than one options can be selected. Instance Field information appears at the top of the ServiceNow Incident Attachment. 

Not all task outputs provide error information, in such cases the Task Instance “Status Description” can provide more meaningful information to the ServiceNow Incident attachment.

UC URLOptional-Text

Base URL of the target Universal Controller.

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

This Field and UC Credential is necessary for the task instance information to be retrieved and used to create the ServiceNow Incident attachment.

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”.

This Field and UC URL is necessary for the task instance information to be retrieved and used to create the ServiceNow Incident attachment.

...

This document references the following documents.

Document LinkDescription
Universal TemplatesUser documentation for creating, working with, and understanding Universal Templates and Integrations.
Universal TasksUser documentation for creating Universal Tasks in the Universal Controller user interface.
CredentialsUser documentation for creating and working with credentials.
Resolvable Credentials Permitted PropertyUser documentation for Resolvable Credentials Permitted Property.
ServiceNow DocumentationUser documentation for ServiceNow.

...

  • Fixes: Fixed table name when creating attachments. (#43111, #126145)

ue-servicenow-incident-2.3.1 (2024-09-26)

  • Fixes: Enhanced Choice fields value retrieval to handle cases where commas are part of the field values. (#42430, #123607)

ue-servicenow-incident-2.3.0 (2024-08-29)

...