Property Name | Property Code | Required | Description |
|---|
Jira URL | FDJIRAITSM_URL | Yes | Jira URL (http://myjira.atlassian.net) |
Jira User | FDJIRAITSM_USER_NAME | Yes | Jira User Name |
Jira Auth Type | FDJIRAITSM_AUTH_TYPE | No | @since 7.0.0.12 Authentication method for connecting to Jira. Defaults to BasicAuth. Useful for connecting to On-premise instances of Jira where basic authentication will not work with username and password or API token alike. In those cases authentication type must be set to the BearerToken and API token provided. |
Jira API Token | FDJIRAITSM_API_TOKEN | Yes | 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 | FDJIRAITSM_TICKET_URL_PATTERN | Yes | The URL to open Jira ITSM and navigate to the change ticket associated to the project workflow execution |
Jira GET Rest API Pattern | FDJIRAITSM_TICKET_REST_GET_PATTERN | Yes | 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. The response from Jira 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. /rest/api/2/issue/{JIRA_CHANGE_NUMBER}?fields=status,summary
|
Jira POST Rest API Pattern | FDJIRAITSM_TICKET_REST_POST_PATTERN | Yes | 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 | FDJIRAITSM_APPROVED_SCRIPT | No | 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. |
Default Check| Code Block |
|---|
| TICKET.fields.status.name == 'Awaiting implementation' || TICKET.fields.status.name == 'Implementing' || TICKET.fields.status.name == 'Completed' |
Example that checks custom field value specific to target environment| Code Block |
|---|
| (TICKET.fields.customfield_10107.status == 'UATApproved' && FD_ENVIRONMENT_CODE='UAT') || (TICKET.fields.customfield_10107.status == 'PRODApproved' && FD_ENVIRONMENT_CODE='PROD') |
| Info |
|---|
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 | FDJIRAITSM_REJECTED_SCRIPT | No | 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. |
|
Additional Info Script | FDJIRAITSM_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.
|
Don't poll | FDJIRAITSM_DONT_POLL | No | 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. |