Configure Change Management Systems
- Muthu Sankaralingam
- Emily Simon
FlexDeploy change management systems integration (out of box or custom) can be configured globally for use by various Projects. Configurations can be overridden at Application, Folder or Global level as necessary.
To configure the integration at the Global level, select the Administration->Change Management Systems menu item.
Select a particular change management system (Ex ServiceNow) and click the Edit button.
You can update name, description and implementation.
Field Name | Required | Description |
|---|---|---|
Id | Yes | System generated identifier (read-only). |
Name | Yes | Name of the change management system. (read-only for out of box integrations) |
Description | No | Description of the change management system. |
| Java Implementation | Yes | Implementation class for change management integration. (read-only for out of box integrations) |
Default Configuration
You can provide default configuration for change management system on Default Configuration tab. You can still override these settings at the project, folder or environment level.
The Default tab provides configuration for the Global scope, meaning it applies to all deployment system-wide. One or more of these options may be selected.
- Require Change Ticket for Deployment - When submitting deployment requests, a user is required to specify a valid Change Management Ticket number.
- Create Change Ticket on Deployment - When a deployment request is submitted, a Change Ticket is automatically created within Change Management System.
- Create Incident on Deployment Failure - Whenever a deployment request fails, an Incident will automatically be created within Change Management System.
When choosing Create Change Ticket on Deployment you have the option of providing a Groovy expressions which calculate specific fields to set on the generated Change Ticket.
| Field | ServiceNow Change Ticket Mapping |
|---|---|
| Change Ticket Description Pattern | Description |
| Change Ticket Comment Pattern | Short description |
When choosing Create Incident on Deployment Failure you have the option of providing a Groovy expressions which calculate specific fields to set on the generated Change Ticket.
| Field | ServiceNow Change Ticket Mapping |
|---|---|
| Incident Description Pattern | Short description |
| Incident Comment Pattern | Description |
All Groovy script fields have access to the following variables, and can be selected using the 
drop-down on the right side of the field:
| Field | Description |
|---|---|
| EnvironmentName | The name of the target environment. |
| PackageName | The package name requested for deployment. Same as ProjectVersion for full deployments. |
| ProjectName | The name of the project requested for deployment. |
| ProjectVersion | The project version which was requested for deployment. |
| StreamName | The stream from which the project version was built from. |
| WorkflowRequestor | The FlexDeploy username which requested the deployment. |
Example Groovy expressions
- "Deployment request to " + EnvironmentName + " for project " + ProjectName + " by " + WorkflowRequestor
- "Deployment for " + ProjectName + " failed in " + EnvironmentName
- "Simple String"
Environment Configuration
The Environment Configuration tab allows configuration by environment. Click the Add button to add a new configuration, and select an environment. This overrides any configuration on the Default tab for the selected environment.
The remaining configuration options are exactly as defined for the Default configuration. Optionally, click the Add button again to add configuration for other environments.
Properties
The Properties tab lists the metadata which is required for this Change Management System. Values for these properties will be provided when you create a Change Management Instance in the topology. See Creating/Editing a Change Management Instance, Properties are read-only for out of box integrations.
- style