JIRA is an issue tracking tool. You can use the tool to capture and organize issues, assign work, and track activities. Issues can be anything from development tasks, code errors, project tasks, help-desk tickets, or human resource request forms.
For the JIRA version older than v5.0, use plugin v5.
The JIRA plugin provides integrations with JIRA. You can create and update issues, add comments to an issue, and create reports.
The JIRA plugin includes steps to automate working with JIRA issues as a process step.
This plugin runs on all operating systems that HCL Deploy supports.
See Installing plugins in HCL Deploy for installing and removing plugins.
The following table describes the changes made in each plugin version.
| Version | Description |
|---|---|
| 19 | RFE - URBANCODE-I-635 - PAT Token feature added. |
| 18 | Added compatibility for Jira Version 9. |
| 17 | Log4j and Jettison dependency updated. |
| 16 | RFE 146322. Modified “project” field in “Does issues exists” to handle multiple project keys. |
| 15 | RFE 144997 - Added "project" field to step "Does issues exists". |
| 14 | RFE 143944 - Added support for "Does issues exists for an issue type and mark failure if they exist otherwise success". |
| 13 | RFE 119842 - Added support for setting additional standard and custom field values on issue create/transition. Rename the "Update Issue" step to "Transition Issue" Added a new "Edit Issue" step, for editing fields on an existing issue. When creating an issue, only set the Due Date field if the specified project and issue type allow it. |
| 12 | Fixed issue with setting proxy port. |
| 11 | Added ability to allow insecure connections. |
| 10 | Fixed APAR PI84297: Fix response text encoding. |
| 9 | Fixed APAR PI79900 - Support added for Http Web Proxies. Added ability to create issues with Parent IDs and attach labels. |
| 8 | Support property file encryption. |
| 7 | Updated step and property descriptions. |
| 6 | Fixed Story 107389 - Change WSDL/SOAP to RESTful services The REST API requires JIRA v5.0+. For JIRA version older than v5.0, please use plugin v5 |
| 5 | Fixed APAR PI37115 - Steps failing with "Assertion Error" |
| 4 | Fixed APAR PI35342 - compatibility defect with IBM Urbancode Deploy version 6.1.0.4 and later. |
| 3 | The JIRA integration provides component process steps to create, comment and resolve issues found in JIRA and publish a list of issues that were addressed in the deployment. |
Use the Jira plugin to work with issues using HCL Deploy process steps. This plugin uses the JIRA REST application program interface to communicate with the JIRA user interface.
To access this plugin in the palette, click Issue Tracking > JIRA Plugin.
The following process steps are available in the Jira for Deploy plugin.
Use this step to add comments from the current changelog to the matching JIRA issues.
| Name | Type | Description | Required |
|---|---|---|---|
| Comment | String | The template to use for adding a comment to JIRA issues. | Yes |
| Fail Mode | Enumeration | The action to take when an unknown issue ID is found. Values are WARN_ONLY, FAIL_FAST, and FAIL_ON_NO_UPDATES. | Yes |
| Issue IDs | String | A list of issue IDs to update. Separated by commas and/or newline characters. | Yes |
| JIRA Base URL | String | The URL of the JIRA server. | Yes |
| Password | Password | The password to use to connect to the JIRA server. | No |
| Password Script | String | The property or script to use to authenticate with the JIRA server. If this method is used to authenticate with the server, leave the Password property blank. |
No |
| Proxy Hostname | String | The hostname to be specified if connecting through http proxy. | No |
| Proxy Port | String | The port number to be specified if connecting through http proxy. | No |
| Trust All Certificates | Boolean | Select this option to allow insecure connections to the server. | No |
| User Name | String | The user name to use to connect to the JIRA server. | No |
Check JIRA Issues
| Name | Type | Description | Required |
|---|---|---|---|
| Fail Mode | Enumeration | The action to take when an issue ID cannot be found. Values are WARN_ONLY, FAIL_FAST, FAIL_ON_NO_UPDATES, and FAIL_ON_ANY_FAILURE. | Yes |
| Issue IDs | String | A list of issue IDs to check. Separated by commas and/or newline characters. | Yes |
| JIRA Base URL | String | The URL of the JIRA server. | Yes |
| Password | Password | The password to use to connect to the JIRA server. | No |
| Password Script | String | The property or script to use to authenticate with the JIRA server. If this method is used to authenticate with the server, leave the Password property blank. |
No |
| Proxy Hostname | String | The hostname to be specified if connecting through http proxy. | No |
| Proxy Port | String | The port number to be specified if connecting through http proxy. | No |
| Status Name | String | The expected status of the issue. | Yes |
| Trust All Certificates | Boolean | Select this option to allow insecure connections to the server. | No |
| User Name | String | The user name to use to connect to the JIRA server. | No |
Use this step to create a new issue in a JIRA Bug Tracker.
| Name | Type | Description | Required |
|---|---|---|---|
| Assignee | String | The assignee for the new issue. If there is no value for this property, the assignee uses the JIRA automatic assignment. |
No |
| Components | String | Components for the new issue. Separated by commas and/or newline characters. | No |
| Custom Fields | String | A JSON object used to set custom field values on the JIRA issue. If standard field names are used here, they will be silently ignored. See https://docs.atlassian.com/jira/REST/latest/ for syntax. |
No |
| Environment | String | The environment for this issue. | No |
| Fix Versions | String | Fix versions for the new issue. Separated by commas and/or newline characters. | No |
| Issue Description | String | The description of this issue. | No |
| Issue Type | String | The name of the issue type to create. | Yes |
| JIRA Base URL | String | The URL of the JIRA server. | Yes |
| Labels | String | Labels for the new issue. Separated by commas and/or newline characters. | No |
| Parent Issue ID | String | The issue ID of the parent issue. Overrides environment if entered, ignored if empty. | No |
| Password | Password | The password to use to connect to the JIRA server. | No |
| Password Script | String | The property or script to use to authenticate with the JIRA server. If this method is used to authenicate with the server, leave the Password field blank. |
No |
| Priority | String | The priority of the created issue. All values are predefined JIRA priority names. | Yes |
| Project Key | String | The project key in JIRA. | Yes |
| Proxy Hostname | String | The hostname to be specified if connecting through http proxy. | No |
| Proxy Port | String | The port number to be specified if connecting through http proxy. | No |
| Summary | String | The summary for this issue. | Yes |
| Trust All Certificates | Boolean | Select this option to allow insecure connections to the server. | No |
| User Name | String | The user name to use to connect to the JIRA server. | No |
Check if issues with specified issue type exists
| Name | Type | Description | Required |
|---|---|---|---|
| JIRA projects | String | A list of Jira project names or keys separated by commas. Note : Please surround the name with quotes if it has spaces. | No |
| Issue Type | Enumeration | Type of issue. Values are Bug, Epic, Story, Sub-task, and Task. | Yes |
| JIRA Base URL | String | The URL of the JIRA server. | Yes |
| Password | Password | The password to use to connect to the JIRA server. | No |
| Password Script | String | The property or script to use to authenticate with the JIRA server. If this method is used to authenticate with the server, leave the Password property blank. |
No |
| Proxy Hostname | String | The hostname to be specified if connecting through http proxy. | No |
| Proxy Port | String | The port number to be specified if connecting through http proxy. | No |
| Status Name | Enumeration | Search issues for sepcified status. Values are All, Closed, In Progress, Open, Reopened, To Do, Resolved, and Done. | Yes |
| Trust All Certificates | Boolean | Select this option to allow insecure connections to the server. | No |
| User Name | String | The user name to use to connect to the JIRA server. | No |
Use this step to edit fields on an existing JIRA issue.
| Name | Type | Description | Required |
|---|---|---|---|
| Components | String | Components to be added to the issue. Separated by commas and/or newline characters. | No |
| Custom Fields | String | A JSON object used to set custom field values on the JIRA issue. If standard field names are used here, they will be silently ignored. See https://docs.atlassian.com/jira/REST/latest/ for syntax. |
No |
| Fail Mode | Enumeration | The action to perform when an unknown issue ID is found. Values are WARN_ONLY, FAIL_FAST, FAIL_ON_NO_UPDATES, and FAIL_ON_ANY_FAILURE. | Yes |
| Fix Versions | String | Fix versions to be added to the issue. Separated by commas and/or newline characters. | No |
| Issue IDs | String | A list of issue IDs to edit. Separated by commas and/or newline characters. | Yes |
| JIRA Base URL | String | The URL of the JIRA server. | Yes |
| Password | Password | The password to use to connect to the JIRA server. | No |
| Password Script | String | The property or script to use to authenticate with the JIRA server. If this method is used to authenicate with the server, leave the Password field blank. |
No |
| Proxy Hostname | String | The hostname to be specified if connecting through http proxy. | No |
| Proxy Port | String | The port number to be specified if connecting through http proxy. | No |
| Trust All Certificates | Boolean | Select this option to allow insecure connections to the server. | No |
| User Name | String | The user name to use to connect to the JIRA server. | No |
Use this step to perform JIRA issue transitions.
| Name | Type | Description | Required |
|---|---|---|---|
| Additional Comment | String | Comments to add to the issue when it is updated. Leave the field blank to exclude comments. You can use scripts in this field. |
No |
| Custom Fields | String | A JSON object used to set custom field values on the JIRA issue during transition. If standard field names are used here, they will be silently ignored. See https://docs.atlassian.com/jira/REST/latest/ for syntax. |
No |
| Fail Mode | Enumeration | The action to perform when an unknown issue ID is found. Values are WARN_ONLY, FAIL_FAST, FAIL_ON_NO_UPDATES, and FAIL_ON_ANY_FAILURE. | Yes |
| Issue IDs | String | A list of issue IDs. Separated by commas and/or newline characters. | Yes |
| JIRA Base URL | String | The URL of the JIRA server. | Yes |
| Password | Password | The password to use to connect to the JIRA server. | No |
| Password Script | String | The property or script to use to authenticate with the JIRA server. If this method is used to authenticate with the server, leave the Password attribute blank. |
No |
| Proxy Hostname | String | The hostname to be specified if connecting through http proxy. | No |
| Proxy Port | String | The port number to be specified if connecting through http proxy. | No |
| Resolution Name | String | The resolution which the action has caused. For example, Fixed or Cannot Reproduce. This property is applicable only when the value for the Action Name property is Resolve Issue or Close Issue. |
No |
| Transition Name | String | The transition action to perform upon the issues. For example, Resolve Issue or Close Issue. |
Yes |
| Trust All Certificates | Boolean | Select this option to allow insecure connections to the server. | No |
| User Name | String | The user name to use to connect to the JIRA server. | No |
Uploaded: 21-Mar-2024 09:42
Uploaded: 15-Mar-2024 05:38
Uploaded: 28-Mar-2023 10:22
Uploaded: 12-Mar-2021 12:15
Summary
Usage
Steps
