Configuring the ServiceNow actor adapter - Documentation for TrueSight Orchestration Content 20.19.02

UI label

Element

Definition

Required

None

<config>

Specifies a container element for all other elements

Yes

None

<proxy-settings>

Indicates a parent tag that contains information about the proxy server

Note

To configure <proxy-settings>, you must switch to XML view as <proxy-settings> are not available as fields in a form view.

You must perform these steps only if you are using TrueSight Orchestration Content 20.19.02 Patch 2.

 To enable <proxy-settings>, do these steps:

1. On the server or the peer on which the ServiceNow adapter is installed and running, open the command line.

2. Go to the <AO_HOME>\tomcat\bin directory and run the following command:

   tomcat9w.exe //ES//<PEER_SERVICE_NAME>

   Example

   tomcat9w.exe //ES//BAO_CDP

3. On the service dialog box, click the Java tab, and in Java options, add the following property: 

   -Djdk.http.auth.tunneling.disabledSchemes=””

4. Restart the service. 

No

None

<host>

Specifies the IP address or host name of the proxy server

Conditional; required only if <proxy-settings> is provided

None

<port>

Specifies the port on which the proxy server listens for requests

Conditional; required only if <proxy-settings> is provided

None

<user-name>

Specifies the user name required for proxy server authentication

No

None

<password>

Specifies the password that corresponds to the proxy server <user-name>

The password element can contain an encryption-type attribute.

No

None

<encryption-type>

Indicates whether the password specified is encrypted; is an attribute of the <password> element and not an element itself

Valid values: Base64, Plain (default)

No

Target

<target>

Specifies the domain name of the ServiceNow application server

Yes

User Name

<user-name>

Specifies the user name required for remote host authentication

Yes

Password

<password>

Specifies the password that corresponds to the <user-name>

The password element can contain an <encryption-type> attribute.

Yes

Encryption Type

<encryption-type>

Indicates whether the password specified is encrypted; is an attribute of the <password> element and not an element itself

Valid values: Base64, Plain (default)

No

Timeout Secs

<timeout-secs>

Specifies the duration in seconds, after which timeout occurs Default value: 180

No

Min Thread Pool Size

<min-thread-pool-size>

Specifies the minimum number of threads that are created and stored in a thread pool for parallel processing of requests

Default value: 50

No

Max Thread Pool Size

<max-thread-pool-size>

Specifies the maximum number of threads that are created and stored in a thread pool for parallel processing of requests

Default value: 100

No

None

<tables>

Indicates a parent tag of one or more <table> elements

Allows you to specify a custom table

No

None

<table>

Indicates children tags nested within the <tables> element

This is optional. You can specify a custom table here.

1. Change Management: In case of change, the table in which records must be inserted is specified as follows: <table entity="change"> MyChangeTable </table>

   The table name specified in the above example is "MyChangeTable". If you do not specify the table name, the default change table, "change_request", is considered.

2. Incident Management: In case of incident, the table in which records must be inserted is specified as follows: <table entity="incident"> MyIncidentTable </table>

   The table name specified in the above example is "MyIncidentTable". If you do not specify the table name, the default incident table, "incident" is considered.

3. Import_set Management: In case of import sets, the table in which records must be inserted by using the "Create Import Set Record" action, is specified as follows: <table entity="import-set"> MyImportsetTable </table>

   The table name specified in the above example is "MyImportsetTable".

   Note

   It is mandatory to specify the import _set table name either in the request or while configuring the adapter, or else the request execution fails.

No

None

<import-set>

Indicates a parent tag

Contains the configuration for performing the following operations, which are specific to Import Sets:

• Create Change Using Import Set
• Update Change Using Import Set
• Create Incident Using Import Set
• Update Incident Using Import Set

No

None

<change>

Indicates the parent tag if an import set configuration for entity "Change" needs to be specified

No

None

<incident>

Indicates the parent tag if an import set configuration for entity "Incident" needs to be specified

No

None

<table-name>

Specifies the name of the table

Required only if an import set configuration is defined for either a Change or an Incident, and any of the following actions are used:

• Create Change Using Import Set
• Update Change Using Import Set
• Create Incident Using Import Set
• Update Incident Using Import Set 
• 
  If this element is specified under "change", then it should contain the import set table name for entity "Change". If this element is specified under "incident" then it should contain the import set table name for entity "Incident".

Conditional

None

<import-set-coalesce-field>

Specifies the name of the field that identifies a unique record in the Import_Set table

This field also coalesces to a certain field in the corresponding Change/Incident table.

Conditional; required only if an import set configuration is defined

None

<incident-coalesce-field>

Specifies the name of the field that identifies a unique record in a table configured for entity "Incident"

This field also coalesces to a certain field in the corresponding import set table for "Incident".

Valid only if an import set configuration is defined for "Incident".

Conditional; required only if an import set configuration is defined

None

<change-coalesce-field>

Specifies the name of the field that identifies a unique record in table configured for entity "Change"

This field also coalesces to a certain field in the corresponding import set table for "Change". Valid only if an import set configuration is defined for "Change".

Conditional; required only if an import set configuration is defined

Allow Unsigned Certificate

<allow-unsigned-certificates>

Specifies whether unsigned certificates are permitted for SSL authentication

Valid values: true, false (default)

No

Install Certificate

<install-certificate>

Updates the default keystore file (<java.home>\jre\lib\security\cacerts) with the certificates sent by the target URL during the SSL Handshake

Valid values: true, false (default)

Note

To successfully install certificates, the user that installed the peer that executes the request must have read and write access to the keystore file. If the verification of a certificate fails, that certificate is not installed.

No

Passphrase

<passphrase>

Specifies the passphrase for the keystore file, used for installation of certificates

Default value: changeit

Note

This value must match the passphrase in the keystore. The passphrase can be changed using keytool. If a change is made, this value must be updated to reflect the new passphrase. 

No

None<protocol>

Specifies the communication protocol used by the adapter

Valid values: HTTP, HTTPS (default)

No