Both sides previous revisionPrevious revisionNext revision | Previous revision |
75:process_feedback_jira [2021/05/12 15:11] – fnpk | 75:process_feedback_jira [2024/02/15 00:00] (current) – external edit 127.0.0.1 |
---|
<!-- The summary field will always be available and is automatically mapped to the Jira "summary" field --> | <!-- The summary field will always be available and is automatically mapped to the Jira "summary" field --> |
| |
<!-- | <!-- |
See common feedback documentation | See common feedback documentation |
- The "target" defines the id of the custom field in Jira (e.g. "customfield_10101"). | - The "target" defines the id of the custom field in Jira (e.g. "customfield_10101"). |
</feedback-system> | </feedback-system> |
</stages-config> | </stages-config> |
| |
| |
</code> | </code> |
| |
<property name="user" value="user" /> | <property name="user" value="user" /> |
<property name="password" value="secret" /> | <property name="password" value="secret" /> |
| |
| |
</code> | </code> |
| |
=== Jira Server === | === Jira Server === |
| * The ''user'' and ''password'' are the normal username and password of the user. |
The ''user'' and ''password'' are the normal username and password of the user. | * [[https://confluence.atlassian.com/enterprise/disabling-basic-authentication-1044776464.html|Basic authentication must not be deactivated]] |
=== Jira Cloud === | === Jira Cloud === |
| |
In Jira cloud there are no usernames. The ''username'' is the mail address (e.g. ''user@example.com''). The **password is a API-Token** and not the password of the user. You can create a Token in your [[https://id.atlassian.com/manage-profile/security/api-tokens|Atlassian Account Management]]. | In Jira cloud there are no usernames. The ''username'' is the mail address (e.g. ''user@example.com''). The **password is a API-Token** and not the password of the user. You can create a Token in your [[https://id.atlassian.com/manage-profile/security/api-tokens|Atlassian Account Management]]. |
| |
==== Supported Jira fields ==== | ==== Supported Jira fields ==== |
| * Description: ''targetType=""'' (Empty) |
* Description: ''targetType=_ckgedit_QUOT__ckgedit>'' (Empty) * Text Field (single line): ''targetType=_ckgedit_QUOT__ckgedit>'' (Empty) | * Text Field (single line): ''targetType=""'' (Empty) |
* Text Field (multi line): ''targetType=_ckgedit_QUOT__ckgedit>'' (Empty) * URL Field: ''targetType=_ckgedit_QUOT__ckgedit>'' (Empty) | * Text Field (multi line): ''targetType=""'' (Empty) |
| * URL Field: ''targetType=""'' (Empty) |
* Select List (single choice): ''targetType="selectList-singleChoice"'' | * Select List (single choice): ''targetType="selectList-singleChoice"'' |
* User Picker (single user): ''targetType="user-singleChoice"'' (Only Jira Server, not Jira Cloud) | * User Picker (single user): ''targetType="user-singleChoice"'' (Only Jira Server, not Jira Cloud) |
* Assignee: ''targetType="user-singleChoice"'' (Only Jira Server, not Jira Cloud) | * Assignee: ''target="assignee" targetType="user-singleChoice"'' (Only Jira Server, not Jira Cloud) |
* Reporter: ''targetType="user-singleChoice"'' (Only Jira Server, not Jira Cloud) | * Reporter: ''target="reporter" targetType="user-singleChoice"'' (Only Jira Server, not Jira Cloud) |
* Components: ''targetType="components"'' | * Components: ''target="components" targetType="components"'' |
| |
**Be aware**: | **Be aware**: |
| * If you choose **Select** or **Component** then the user entered values must be configured in Jira. Otherwise the ticket creation will fail. |
* If you choose **Select** or **Component** then the user entered values must be configured in Jira. Otherwise the ticket creation will fail. | * If you choose **User Picker**, **Assignee** or **Reporter** then the users must be vald Jira user. Otherwise the ticket creation will fail. |
* If you choose **User Picker**, **Assignee** or **Reporter** then the users must be vald Jira user. Otherwise the ticket creation will fail. | * To set the **Reporter** field it is [[https://community.atlassian.com/t5/Answers-Developer-Questions/Re-Assigning-a-reporter-when-creating-an-issue-with-rest/qaq-p/475645/comment-id/13300#M13300|mandatory to grant "Modify Reporter" to the technical user]]. Otherwise the ticket creation will fail. |
* To set the **Reporter** field it is [[https://community.atlassian.com/t5/Answers-Developer-Questions/Re-Assigning-a-reporter-when-creating-an-issue-with-rest/qaq-p/475645/comment-id/13300#M13300|mandatory to grant "Modify Reporter" to the technical user]]. Otherwise the ticket creation will fail. | |
| |
Other Jira fields are not supported at the moment. | Other Jira fields are not supported at the moment. |
==== Custom Endpoint (Optional) ==== | ==== Custom Endpoint (Optional) ==== |
| |
If your Jira REST-Endpiont differs from the standard location, you can specify it. If your link to the Jira-API is for example like ''<nowiki>https://api.example.com/example/api/2/issue</nowiki>'' then you have to specify ''<nowiki>https://api.example.com/example/</nowiki>'' as value for this property. | If your Jira REST-Endpiont differs from the standard location, you can specify it. If your link to the Jira-API is for example like ''<nowiki>https://api.example.com/example/api/2/issue</nowiki>'' then you have to specify ''<nowiki>https://api.example.com/example/</nowiki>'' as value for this property. |
<code xml> | <code xml> |
<property name="jira.rest.endpoint" value="https://api.example.com/example/" /> | <property name="jira.rest.endpoint" value="https://api.example.com/example/" /> |
| |
| |
</code> | </code> |
| |
<property name="proxy.port" value="3128" /> | <property name="proxy.port" value="3128" /> |
<property name="proxy.hostname" value="proxy.example.com" /> | <property name="proxy.hostname" value="proxy.example.com" /> |
| |
| |
</code> | </code> |
| |
<!-- OAuth 2.0 password --> | <!-- OAuth 2.0 password --> |
<property name="authentication.oauth20.password" value="" /> | <property name="authentication.oauth20.password" value="" /> |
| |
| |
</code> | </code> |
| |
<property name="jira.rest.customheader.key" value="" /> | <property name="jira.rest.customheader.key" value="" /> |
<property name="jira.rest.customheader.value" value="" /> | <property name="jira.rest.customheader.value" value="" /> |
| </code> |
| |
| ==== Troubleshooting ==== |
| |
</code> | If the username/password settings are not correct or the password is changed on the Jira side, but not in Stages, Jira might lock the account after a few tries. This will result in a "HTTP 403 Forbidden" error in stages.log. |
| |
| In that case, the Jira account needs to be unlocked again. Log into Jira as an administrator and follow these steps: |
| * Click on the Gear icon in the upper right of Jira |
| * Select "User Management" |
| * Find the right user |
| * Click on the "Reset Failed Login Count" link in the "Login Details" column. |
| |