ServiceNow URL

SN_URL

Yes

The URL for accessing ServiceNow.

ServiceNow User Name

SN_PORT

Yes

A local ServiceNow service account user with a non-expiring password. 

ServiceNow Password

SN_PASSWORD

No*

The password for the ServiceNow User Name above.

Note that encrypted properties are stored in Credential Store (Local or External) and can be configured using Edit button next to credential name drop down. Alternatively, you can reuse single credential for multiple properties also, in which case you should name that credential appropriately.

Required for the following Auth Types, BasicAuth and  OAuthResourceOwner

ServiceNow Auth Type

SN_AUTH_TYPE

Yes

Authentication method for connecting to ServiceNow, BasicAuth,  OAuthResourceOwner, OAuthJWTAssertion.  Defaults to BasicAuth.  

ServiceNow Client ID

SN_CLIENT_ID

No*

The auto-generated unique ID of the application. The instance uses the client ID when requesting an access token. 

Required for the following Auth Types, OAuthResourceOwner and OAuthJWTAssertion.

ServiceNow Client Secret

SN_CLIENT_SECRET

No*

The shared secret string that both the instance and the client application use to authorize communications with one another. The instance uses the client secret when requesting an access token. (Encrypted).  

Required for the following Auth Types, OAuthResourceOwner and OAuthJWTAssertion.

ServiceNow Keystore Path

SN_KEYSTORE_PATH

No*

ServiceNow Keystore Path (path to the jks file).  

Required for the following Auth Types, OAuthJWTAssertion.

ServiceNow Keystore Passphrase

SN_KEYSTORE_PASS

No*

Java keystore passphrase for the ServiceNow Keystore (Encrypted).  

Required for the following Auth Types, OAuthJWTAssertion.

ServiceNow Certificate Alias

SN_CERT_ALIAS

No*

Private certificate alias.  

Required for the following Auth Types, OAuthJWTAssertion.

ServiceNow Certificate Passphrase

SN_CERT_PASS

No*

Passphrase for the ServiceNow Certificate (Encrypted).  

Required for the following Auth Types, OAuthJWTAssertion.

ServiceNow JWT Verifier Map Key ID

SN_JWT_VERIFIER_MAP_KEY_ID

No*

ServiceNow JWT Verifier Map Key ID. 

Required for the following Auth Types, OAuthJWTAssertion.

ServiceNow Certificate Algorithm

SN_CERT_ALGORITHM

No*

Algorithm used for the certificate. Defaults to RS256.

Required for the following Auth Types, OAuthJWTAssertion.

ServiceNow Refresh Token Lifespan

SN_DEFAULT_REFRESH_TOKEN_LIFESPAN

No

The number of seconds that a refresh token is valid. The instance uses the lifespan value when requesting a refresh token. By default, refresh tokens expire in 100 days (8640000 seconds).

ServiceNow Request GET URL

SN_REQUEST_GET_URL

No

The URL to get the change request details as json response. 

• Default URL is /api/now/table/change_request?sysparm_query=number%3D{SN_CHANGE_NUMBER}

• If needed, you can change and use your custom GET url for ServiceNow REST endpoint.  The URL should include {SN_CHANGE_NUMBER} string as the execution system will replace it with the actual change number during execution.

  • e.g. /api/xyz/mycompanty_servicenow_generic_api/readChangeRequest?number%3{SN_CHANGE_NUMBER}

• If the response returned from this GET API contains an attribute called description it will be mapped to the description of the linked ticket, otherwise the description on the links tab will appear as empty.  Prior to 5.5.0.2, an error would occur if the description field was not present in the payload returned from this GET API.

• The response from Service Now can be optimized by providing specific element details which should be returned in response. As a result the payload size shall be reduced and performance also shall be improved. In case there is Approval check validation on any other fields, same also should be added in the fields list.

/api/now/table/u_instance_change?sysparm_query=number%3D{SN_CHANGE_NUMBER}&sysparm_fields=number,state,active,approval

Adding &sysparm_display_value=true to the end of the URL will return the display value for things like state. For example instead of returning state = 3, the value of state = Ready would be returned.

ServiceNow Navigation Request URL

SN_REQUEST_NAV_URL

No

The URL to open ServiceNow and navigate to the Change ticket associated to the project workflow execution

• Default URL is /nav_to.do?uri=change_request.do?sysparm_query=number={SN_CHANGE_NUMBER}

• The URL should include {SN_CHANGE_NUMBER} string as the execution system will replace it with the actual change number during execution.

  • e.g. https://<instance name>.service-now.com/nav_to.do?uri=change_request.do?sysparm_query%3Dnumber%3DCHG0080007

  • e.g., if you want to use Service Catalog, url will be like

    https://<instance name>.service-now.com/nav_to.do?uri=sc_request.do?sysparm_query%3Dnumber%3DREQ0067001

ServiceNow Request POST URL

SN_REQUEST_POST_URL

No

The URL to create a change request.

• Default URL is /api/now/table/change_request

• If needed, you can change and use your custom url to create a new change using the POST operation

  • if you want to use Service Catalog, then change the url to /api/now/table/sc_request

Approved Check Script

SN_APPROVED_SCRIPT

No

A Groovy expression which determines whether a task for the change ticket is approved or not.  The expression must return a boolean, and has access to the following variables:

• TICKET - an object with fields (JSON) contained in the change ticket, as returned by the ServiceNow REST API.  Fields are referenced as TICKET.<field name>.<sub-field name>

• FD_ENVIRONMENT_CODE - The environment for a particular deployment request or associated pipeline stage.

Simple Example which is used by default