Versions Compared

Key

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

Change Management System Instance is configuration details to connect with specific change management system like ServiceNow, BMC RemedyForce etc. This information is used to manage tickets and incidents.

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

Image Removed

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

...

Field Name

...

Required

...

Description

...

Instance Code

...

Yes

...

Short name for the instance.

...

Instance Name

...

Yes

...

Long display name for the instance.

...

Change Management

...

Yes

...

The change management system.

...

Description

...

Yes

...

A description of the instance.

...

Active

...

Yes

...

Whether or not the instance is active in the system. Defaults to "Yes".

...

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 Port

...

String

...

The HTTP/HTTPS port for ServiceNow.  If you don't typically specify a port on the URL, provide the default (80 for HTTP and 443 for HTTPS).

...

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.

...

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 (as of 4.5.2) - an object with fields (JSON) contained in the change ticket, as returned by the ServiceNow REST API.  Fields are referenced as TICKET.<field name>.
  • REQUEST (deprecated as of 4.5.2) - same object as TICKET.
  • FD_ENVIRONMENT_CODE (as of 4.5.2) - 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
languagegroovy
titleExamples
TICKET.approval == 'approved'
TICKET.myfield == 'some value'
(TICKET.myfield == 'some value' && FD_ENVIRONMENT_CODE='UAT') || (TICKET.myfield == 'some other value' && 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.

...

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 (as of 4.5.2) - an object with fields (JSON) contained in the change ticket, as returned by the ServiceNow REST API.  Fields are referenced as TICKET.<field name>.
  • REQUEST (deprecated as of 4.5.2) - same object as TICKET.
  • FD_ENVIRONMENT_CODE (as of 4.5.2) - 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
languagegroovy
titleExamples
TICKET.approval == 'rejected'
TICKET.myfield == 'some value'
(TICKET.myfield == 'some value' && FD_ENVIRONMENT_CODE='UAT') || (TICKET.myfield == 'some other value' && FD_ENVIRONMENT_CODE='PROD')
TICKET.state == '4'

...

See Configuring Change Management Instances for details on what options to select.