Update Issue
Description
This plugin step updates a JIRA issue on on-premise or on-cloud versions of a JIRA instance.
Limitation
The following fields are unsupported: Time Tracking, Original Estimate, and Remaining Estimate.
Note: Supported format for Date type fields, such as Due Date is ‘YYYY-MM-DD’.
Configurations
| No. | Field Name | Description |
|---|---|---|
| 1 | Step Name | Name of the step. This name has to be unique in a single workflow. |
| Connection | ||
| 2 | Base URL | For on-premise JIRA instance specify IP/Fully Qualified Domain Name/Hostname:Port of the JIRA Server (e.g. xxx.xxx.xxx.xxx:Port). Port can be optional as per network configuration. In case of Cloud instance specify the JIRA instance URL (e.g. https://xxxx.atlassian.net/). |
| 3 | Username | A username with appropriate permissions to authenticate to JIRA instance and update issue. This field is mandatory. |
| Password | ||
| 4 | Accept Value as variable/static | Leave checkbox unchecked to accept Password value from a field in the previous steps of the stream using a drop down list. Else enable checkbox for Password field to appear as Text box. |
| 5 | Password/API Key | Password can be entered as Text (for static value or environment variable) and Combo (drop down containing values from previous steps). This field is mandatory. If checkbox above is enabled Password field appears as Text box and accepts static or variable values. Else if checkbox above is disabled Password field appears as a drop down to select fields from previous steps. Provide an API Key in case of on cloud instance. Note: Following is the link to find the steps to generate token for on-cloud JIRA instance: https://confluence.atlassian.com/cloud/api-tokens-938839638.html |
| 6 | Test Connection | Verifies whether the connection is established or not. Note: For the purpose of verification fields coming from previous steps are not allowed since field values can only be accessed when workflow is in running state. Static values and environment variables are allowed. |
| Input Fields | ||
| 1 | Issue Key | The key of an issue that is to be updated. This field is mandatory. |
| 2 | Button: Get | Clicking on this button brings up the issue keys available as per the access permission of Username provided in Connection. |
| 3 | Accept Update fields as JSON | Enable checkbox to accept the fields to be updated in JSON format. |
| 4 | Update fields JSON | Select the filed in the stream containing the JSON text. Sample JSON is shown below: {“Summary”:”summaryfromAE”,”Project”:”SP”,”Priority”:”Medium”,”description”:”Dec from AE”,”Issue Type”:”Bug”}The JSON field can be any field in the stream or can be created using any step such as Generate Rows, Modified Java Script, Set field value to a constant etc. |
| Tabular Fields: | ||
| 5 | Variable Field Name | This is an optional field. Choose a field in input stream from drop down list or provide a user or system defined variable. |
| 6 | Field Name | Clicking on this column field brings a dialog with the list of available fields that can be updated in the issue and as per the access permission of Username provided in Connection. |
| 7 | Field Value | Provide an updated value for the field name selected in Field Name column above. |