Page Comparison

To create a Change Management instance, select the Change Management tab, and click the button. To edit an existing instance, click on an Instance row from the list.

Enter values for the fields as described in the table below.

...

Click the Test button to test the connection and verify that the url, port, username, and password are correct. Click the Save button to save the changes. Optionally click the Apply button to save the changes, but remain on the current screen until the Cancel button is clicked.

ServiceNow Properties

Property

Type

Description

ServiceNow URL

String

The URL for accessing ServiceNow.

ServiceNow User Name

String

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

ServiceNow Password

String

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.

ServiceNow Request GET URL

String

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

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}

ServiceNow Navigation Request URL

String

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

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.
- eg e.g. https://<instance name>.service-now.com/nav_to.do?uri=change_request.do?sysparm_query%3Dnumber%3DCHG0080007
- ege.g., if you want to use Service Catalog, url will be like
  https://<instnace <instance name>.service-now.com/nav_to.do?uri=sc_request.do?sysparm_query%3Dnumber%3DREQ0067001

ServiceNow Request POST URL

String

The URL to create a change request. @Since 5.4.0.3

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

String

A Groovy expressions 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".

Code Block

language	groovy
theme	Eclipse
title	Simple Example which is used by default

TICKET.approval == 'approved'

Code Block

language	groovy
theme	Eclipse
title	Example that checks myfield value specific to target environment

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

Code Block

language	groovy
theme	Eclipse
title	Check if now is between start_date and end_date defined on ticket
linenumbers	true

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

String

A Groovy expressions 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".

Code Block

language	groovy
theme	Eclipse
title	Simple Example which is used by default

TICKET.approval == 'rejected'

Code Block

language	groovy
theme	Eclipse
title	Example that checks myfield value specific to target environment

(TICKET.myfield == 'UATRejected' && FD_ENVIRONMENT_CODE='UAT') || (TICKET.myfield == 'PRODRejected' && FD_ENVIRONMENT_CODE='PROD')

Don't Poll Boolean 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 is used to communicate ticket approval/rejection.

...

Tip

title	ServiceNow Modules

Most common usage for ServiceNow is using the change request module, but other objects like service catalog request can be used by modifying the default GET, POST, and Nav URLs. If you plan to use a different module, for POST operation, use the tickets tab in the CMS configuration screen to add any additional fields required to create the object.

BMC Remedyforce Properties

Property

Type

Description

BMC Helix Remedyforce URL String BMC Helix Remedyforce Instance URL (https://<instance_name>.salesforce.com)

BMC Helix Remedyforce User Name String BMC Helix User Name

BMC Helix Remedyforce Password

String

BMC Helix Remedyforce Password

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.

Client Id String Connected App Client Id

Client Secret String BMC Helix Remedyforce Client Secret

Approved Check Script

String

A Groovy expressions 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 BMC Remedyforce 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.
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.

Rejected Check Script

String

A Groovy expressions 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 BMC Remedyforce 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.

Don't poll Boolean Disable automatic polling (every minute) of BMC Helix tickets for status changes. Check if using REST API to communicate status changes to FlexDeploy.

Specified Object URL String Object Name URL (/services/data/vXX.X/sobjects/{OBJECT_NAME})

Category Id String Category FK Id (e.g a216g0000005NvDAAU)

Freshworks Freshservice Properties

Property

Type

Description

Freshservice URL String Freshservice URL (https://<your_helpdesk_domain_name>.freshservice.com)

Freshservice API Key

String

API key for Freshservice

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.

Approved Check Script

String

A Groovy expressions 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 Freshservice 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.
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.

Rejected Check Script

String

A Groovy expressions 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 Freshservice 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.

Don't poll Boolean Disable automatic polling (every minute) of Freshservice tickets for status changes. Check if using REST API to communicate status changes to FlexDeploy.

Freshservice Requester Id String Freshservice agent id for API access(should be a number)

Jira ITSM Properties

Property

Type

Description

Jira URL String Jira URL (http://myjira.atlassian.net)

Jira User String Jira User Name

Jira API Token

String

API token for Jira

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.

Jira Ticket URL Pattern

String

The URL to open Jira ITSM and navigate to the change ticket associated to the project workflow execution

Default URL pattern is /browse/{JIRA_CHANGE_NUMBER}
The URL should include {JIRA_CHANGE_NUMBER} string as the execution system will replace it with the actual change number during execution

Jira GET Rest API Pattern

String

Jira Rest API URL Pattern for a GET request

Default URL is /rest/api/2/issue/{JIRA_CHANGE_NUMBER}
If needed, you can change and use your custom GET URL pattern for Jira ITSM REST endpoint. The URL should include {JIRA_CHANGE_NUMBER} string as the execution system will replace it with the actual change number during execution.

Jira POST Rest API Pattern

String

Jira Rest API URL pattern for creating a change ticket

Default URL pattern is /rest/api/2/issue
If needed, you can change and use your custom URL to create a new change using the POST operation

Approved Check Script

String

A Groovy expressions 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 Jira ITSM 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 checks the status of the ticket to determine if it's approved. Statuses of awaiting implementation, implementing, and completed are considered approved and return true.

Code Block

language	groovy
theme	Eclipse
title	Default Check

TICKET.fields.status.name == 'Awaiting implementation' || TICKET.fields.status.name == 'Implementing' || TICKET.fields.status.name == 'Completed'

Code Block

language	groovy
theme	Eclipse
title	Example that checks custom field value specific to target environment

(TICKET.fields.customfield_10107.status == 'UATApproved' && FD_ENVIRONMENT_CODE='UAT') || (TICKET.fields.customfield_10107.status == '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.

Rejected Check Script

String

A Groovy expressions 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 Jira ITSM 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 checks the status of the ticket to determine if it's rejected. Statuses of declined, canceled, and failed are considered rejected and return true.

Don't poll Boolean Disable automatic polling (every minute) of Jira tickets for status changes. 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.

Versions Compared

Old Version 12

New Version 13

Key

ServiceNow Properties

BMC Remedyforce Properties

Freshworks Freshservice Properties

Jira ITSM Properties