Property Name | Property Code | Required | Description |
|---|
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. 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 |
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
|
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.
| Info |
|---|
If the Approved Check Script is left blank, the default implementation is to return true if the "approval" field of the ticket is set to "approved". |
Simple Example which is used by default | Code Block |
|---|
| TICKET.approval == 'approved' |
Example that checks myfield value specific to target environment| Code Block |
|---|
| (TICKET.myfield == 'UATApproved' && FD_ENVIRONMENT_CODE='UAT') || (TICKET.myfield == 'PRODApproved' && FD_ENVIRONMENT_CODE='PROD') |
| Tip |
|---|
If you want to see values that can be used, enable FINEST log level for flexagon.fd.model.integration.cms.CMSScript using Admin Operations. |
Following example is to check if current date time is between start_date and end_date defined on Ticket. Let's assume format for the date string returned and TimeZone as GMT. Check if now is between start_date and end_date defined on ticket| Code Block |
|---|
| import java.util.Date;
import java.util.TimeZone;
import flexagon.ff.common.core.utils.FlexDateTimeUtils;
if(TICKET.approval == 'approved' && TICKET.start_date != null && TICKET.end_date != null)
{
Date start = FlexDateTimeUtils.stringToDate(TICKET.start_date, "yyyy-MM-dd HH:mm:ss", TimeZone.getTimeZone("GMT"));
Date end = FlexDateTimeUtils.stringToDate(TICKET.end_date, "yyyy-MM-dd HH:mm:ss", TimeZone.getTimeZone("GMT"));
Date now = new Date();
if(now.after(start) && now.before(end))
{
return true;
}
}
return false; |
|
Rejected Check Script | SN_REJECTED_SCRIPT
| No | A Groovy expression which determines whether a task for a change ticket is rejected or not. The expression must return a boolean, and as 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.
| Info |
|---|
If the Rejected Check Script is left blank, the default implementation is to return true if the "approval" field of the ticket is set to "rejected". |
Simple Example which is used by default | Code Block |
|---|
| TICKET.approval == 'rejected' |
Example that checks myfield value specific to target environment| Code Block |
|---|
| (TICKET.myfield == 'UATRejected' && FD_ENVIRONMENT_CODE='UAT') || (TICKET.myfield == 'PRODRejected' && FD_ENVIRONMENT_CODE='PROD') |
|
Additional Info Script | SN_ADDITIONAL_INFO_SCRIPT
| No | A Groovy expression which determines additional information to add to an external approval when it is approved or rejected. The expression must return a Map<String, String> and have an entry with the key of "notes" for the value to get added to external approval as a task note. Script 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.
Example where ServiceNow Approver(s) and time of approval are added to task notes | Code Block |
|---|
| import flexagon.ff.common.core.rest.FlexRESTClient;
import flexagon.ff.common.core.rest.FlexRESTClientResponse;
import flexagon.ff.common.core.utils.FlexJsonUtils;
import flexagon.fd.model.integration.util.ApiException;
import org.json.JSONObject;
import org.json.JSONArray;
import java.util.HashMap;
import java.util.Map;
import javax.ws.rs.client.Entity;
import javax.ws.rs.core.Form;
import javax.ws.rs.core.MediaType;
def returnMap = [:]
def snowUrl = '{SN_URL}'
def user = '{SN_USER_NAME}'
def password = '{SN_PASSWORD}'
def resourcePath = '/api/now/table/sysapproval_approver?sysparm_display_value=all&sysparm_query=state%3Dapproved%5Edocument_id%3D' + TICKET.sys_id
try
{
FlexRESTClient restService = new FlexRESTClient();
FlexRESTClientResponse response = restService.url(snowUrl).path(resourcePath).basicauth(user, password).mediatype(MediaType.APPLICATION_JSON).setValidateResponse(true).get();
JSONObject jsonResponse = null;
jsonResponse = FlexJsonUtils.getJSON(response.getResponseString());
def listOfApprovers = jsonResponse.getJSONArray('result');
for (int i = 0; i < listOfApprovers.length(); i++)
{
def approver = listOfApprovers.get(i);
def linkRequestUrl = approver.getJSONObject('approver').getString('link')
restService = new FlexRESTClient();
response = restService.url(linkRequestUrl).basicauth(user, password).mediatype(MediaType.APPLICATION_JSON).setValidateResponse(true).get();
jsonResponse = FlexJsonUtils.getJSON(response.getResponseString());
jsonResponse = jsonResponse.getJSONObject('result')
if (returnMap.isEmpty())
{
returnMap['notes'] = 'Approvers: ' + System.getProperty("line.separator")
}
else
{
returnMap['notes'] = returnMap['notes'] + System.getProperty("line.separator")
}
returnMap['notes'] = returnMap['notes'] + jsonResponse.getString('name') + ' (' + approver.getJSONObject('sys_updated_on').getString('display_value') + ')'
}
}
catch(Exception ex)
{
returnMap['notes'] = ex.getMessage()
}
return returnMap
|
|
Don't Poll | SN_DONT_POLL
| No | Returns whether FlexDeploy should poll ServiceNow to check the change tickets for Approval/Rejection. The default value is false, which means polling will occur. Only check this box if you are using the FlexDeploy REST API to communicate ticket approval/rejection. If you don’t want poll, then you can set up the ServiceNow Integration with FlexDeploy via Incoming Webhook and automate the approval/rejection of the tasks in FlexDeploy based on ServiceNow change ticket status. You can configure to poll and incoming webhook at the same time also. |