...
| Tip |
|---|
For ServiceNow, BMC Remedyforce, and Freshworks Freshservice, and Jira ITSM, there are a number of out of he the box fields which are made available for you by default. These out of the box included fields cannot be removed. The Field Code must match the unique identifier as defined by the provider (i.e.g. JSON attribute names used in the provider's REST API). |
| Info |
|---|
@Since 5.5.0.1, dot-notated fields are supported. This allows for setting fields that are not at the root JSON level in the provider's REST API. At this time, using dot notation to access JSON arrays is not supported. Example: Adding "fields.customfield_10102.name" to Jira ITSM as a custom field allows accessing and setting the name attribute within the customfield_10102 JSON object while creating a change ticket. |
ServiceNow Ticket Fields
| Field Code | Display Name | Description | Data Type | Required |
|---|---|---|---|---|
| short_description | Short Description | A short description for the change ticket | String | No |
| description | Description | A description for the change ticket | String | No |
| state | State | String | No | |
| sys_class_name | Sys Class Name | String | No | |
| approval | Approval | String | No | |
| start_date | Planned Start Date | String | No | |
| end_date | Planned End Date | String | No | |
| closed_by | Closed By | String | No | |
| impact | Impact | String | No | |
| priority | Priority | String | No | |
| risk | Risk | String | No | |
| requested_by | Requested By | String | No | |
| assignment_group | Assignment Group | String | No | |
| assigned_to | Assigned To | String | No | |
| category | Category | String | No | |
| cmdb_ci | CI | String | No | |
| type | Type | String | No |
...
| Field Code | Display Name | Description | Data Type | Required |
|---|---|---|---|---|
| subject | Subject | A subject for the change ticket | String | No |
| description | Description | A description for the change ticket | String | No |
| change_type | Change Type | Long | Yes | |
| status | Status | Long | Yes | |
| priority | Priority | Long | Yes | |
| impact | Impact | Long | Yes | |
| requester_id | Requester Id | Long | Yes | |
| risk | Risk | Long | Yes | |
| planned_start_date | Start Date | String | Yes | |
| planned_end_date | End Date | String | Yes |
Jira ITSM Ticket Fields
| Field Code | Display Name | Description | Data Type | Required |
|---|---|---|---|---|
| fields.summary | Summary | Summary of the change | String | Yes |
| fields.project.key | Project Key | Key of project the change is in | String | Yes |
| fields.issuetype.name | Issue Type | Type of issue for ticket | String | Yes |
| fields.description | Description | Description for the change | String | No |
| fields.priority.name | Priority | Priority of the change | String | No |
Default Configuration
The Default Configuration tab allows global configuration for the CMS integration, which defines whether a ticket is required for deployment requests or whether tickets should be automatically created. When creating tickets automatically as part of a deployment request, default values can be provided for one or more of the ticket fields.
...
| Tip |
|---|
If you will be creating CMS Tickets per project/package in a pipeline external approval gate, EnvironmentName is the only Groovy variable that is applicable since the context is not related to a particular workflow request. The other variables will resolve to an empty String in that case. |
...
| Tip | ||
|---|---|---|
| ||
The Require Change Ticket for Deployment option, for both Default Configuration and Environment Configuration, is not applicable for CMS integration within a Pipeline. That configuration is implied by the presence of an External Approval Gate withing within a pipeline stage. The Create Ticket checkbox of the External Approval gate is defaulted based on the global configuration. |
...
| Key Name | Display Name | Description | Data Type | Required | Encrypted |
|---|---|---|---|---|---|
| FDBMCHR_URL | BMC Helix Remedyforce URL | BMC Helix Remedyforce Instance URL (https://<instance_name>.salesforce.com) | String | Yes | No |
| FDBMCHR_USER_NAME | BMC Helix Remedyforce User Name | BMC Helix User Name | String | Yes | No |
| FDBMCHR_PASSWORD | BMC Helix Remedyforce Password | BMC Helix Remedyforce Password | String | Yes | Yes |
| FDBMCHR_CLIENT_ID | Client Id | Connected App Client Id | String | Yes | Yes |
| FDBMCHR_CLIENT_SECRET_ID | Client Secret | BMC Helix Remedyforce Client Secret | String | Yes | Yes |
| FDBMCHR_APPROVED_SCRIPT | Approved Check Script | BMC Helix approved check Groovy script | String | No | No |
| FDBMCHR_REJECTED_SCRIPT | Rejected Check Script | BMC Helix rejected check Groovy script | String | No | No |
| FDBMCHR_DONT_POLL | Don't poll | Disable automatic polling (every minute) of BMC Helix tickets for status changes. Check if using REST API to communicate status changes to FlexDeploy. | Boolean | No | No |
| FDBMCHR_SOBJECT_URL | Specified Object URL | Object Name URL (/services/data/vXX.X/sobjects/{OBJECT_NAME}) | String | Yes | No |
| FDBMCHR_INCIDENT_CATEGORY_ID | Category Id | Category FK Id (e.g a216g0000005NvDAAU) | String | Yes | No |
...
| Key Name | Display Name | Description | Data Type | Required | Encrypted |
|---|---|---|---|---|---|
| FDFS_URL | Freshservice URL | Freshservice URL (https://<your_helpdesk_domain_name>.freshservice.com) | String | Yes | No |
| FDFS_API_KEY | Freshservice API Key | API key for Freshservice | String | Yes | Yes |
| FDFS_APPROVED_SCRIPT | Approved Check Script | Freshservice approved check Groovy script | String | No | No |
| FDFS_REJECTED_SCRIPT | Rejected Check Script | Freshservice rejected check Groovy script | String | No | No |
| FDFS_DONT_POLL | Don't poll | Disable automatic polling (every minute) of Freshservice tickets for status changes. Check if using REST API to communicate status changes to FlexDeploy. | Boolean | No | No |
| FDFS_REQUESTER_ID | Freshservice Requester Id | Freshservice agent id for API access(should be a number) | String | No | No |
Jira ITSM Properties
| Key Name | Display Name | Description | Data Type | Required | Encrypted |
|---|---|---|---|---|---|
| FDJIRAITSM_URL | Jira URL | Jira URL (http://myjira.atlassian.net) | String | Yes | No |
| FDJIRAITSM_USER_NAME | Jira User | Jira User Name | String | Yes | No |
| FDJIRAITSM_API_TOKEN | Jira API Token | API token for Jira | String | Yes | Yes |
| FDJIRAITSM_TICKET_URL_PATTERN | Jira Ticket URL Pattern | Jira Ticket URL Pattern (/browse/{JIRA_CHANGE_NUMBER}) | String | Yes | No |
| FDJIRAITSM_TICKET_REST_GET_PATTERN | Jira GET Rest API Pattern | Jira Rest API Pattern for GET request (/rest/api/2/issue/{JIRA_CHANGE_NUMBER}) | String | Yes | No |
| FDJIRAITSM_TICKET_REST_POST_PATTERN | Jira POST Rest API Pattern | Jira Rest API Pattern for POST request (/rest/api/2/issue) | String | Yes | No |
| FDJIRAITSM_APPROVED_SCRIPT | Approved Check Script | Jira approved check Groovy script | String | No | No |
| FDJIRAITSM_REJECTED_SCRIPT | Rejected Check Script | Jira rejected check Groovy script | String | No | No |
| FDJIRAITSM_DONT_POLL | Don't poll | Disable automatic polling (every minute) of Jira tickets for status changes. Check if using REST API to communicate status changes to FlexDeploy. | Boolean | No | No |
Groovy API
All out of the box Change Management Systems are implemented using Java. For custom integrations, either Java or Groovy can be used to provide the implementation. The Groovy API tab is enabled for custom integrations if no Java Implementation Class is provided. On this tab you can enter the Groovy script defining the implementation. A template script will be generated and should be modified according to your custom implementation.
...