| Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision |
| 74:jira_feedback [2019/09/25 09:29] – fnpk | 74:jira_feedback [2019/10/11 07:36] – fnpk |
|---|
| <?xml version="1.0" encoding="UTF-8" ?> | <?xml version="1.0" encoding="UTF-8" ?> |
| <stages-config> | <stages-config> |
| <!-- Insert this block to your stages config.xml file --> | <!-- Insert this block to your stages config.xml file --> |
| <feedback-system name="jira"> | <feedback-system name="jira"> |
| <host url="https://jira.example.com/jira"> | <host url="https://jira.example.com/jira"> |
| | |
| <!-- Credentials for a (technical) user who is allowed to create issues in the Jira project --> | |
| <property name="authentication.type" value="basic"> | |
| <property name="user" value="user" /> | |
| <property name="password" value="secret" /> | |
| |
| <!-- Define the project where the issue should be created in --> | <!-- Credentials for a (technical) user who is allowed to create issues in the Jira project --> |
| <property name="projectKey" value="FEED" /> | <property name="authentication.type" value="basic" /> |
| <!-- As alternative to the project key you can specify the project by its id --> | <property name="user" value="user" /> |
| <!-- <property name="projectId" value="1234" /> --> | <property name="password" value="secret" /> |
| |
| <!-- Define the name of the issue type that should be created --> | <!-- Define the project where the issue should be created in --> |
| <property name="issuetypeName" value="Task" /> | <property name="projectKey" value="FEED" /> |
| | <!-- As alternative to the project key you can specify the project by its id --> |
| | <!-- <property name="projectId" value="1234" /> --> |
| |
| <!-- The summary field will always be available and is automatically mapped to the Jira "summary" field --> | <!-- Define the name of the issue type that should be created --> |
| | <property name="issuetypeName" value="Task" /> |
| |
| <!-- | <!-- The summary field will always be available and is automatically mapped to the Jira "summary" field --> |
| The user will be asked to enter the following text fields. All text fields are optional. | |
| - The "ident" must be unique and is used to identify the right translation property. | |
| - The "type" defines if the field is a multi-line text ("text") or a single line string ("string"). | |
| - The "target" defines the id of the custom field in Jira (e.g. "customfield_10101"). | |
| --> | |
| <attributes> | |
| <attribute ident="description" type="text" target="description" /> | |
| <!-- The following fields could be enabled if you want the users to provide more data with every feedback item: --> | |
| <!-- | |
| <attribute ident="annual_savings" type="string" target="customfield_10100" /> | |
| <attribute ident="priority" type="string" target="customfield_10101" /> | |
| --> | |
| </attributes> | |
| |
| <!-- | <!-- |
| You can map element specify information to your Jira issue. These sources are available: | The user will be asked to enter the following text fields. All text fields are optional. |
| - elementUrl e.g. https://stages.example.com/stages/index.html#/workspace/200/_vv/(process/activity/_wUV9sBbNHr-aicWx33VsQA) | - The "ident" must be unique and is used to identify the right translation property. |
| - workspaceName e.g. "Software Engineering" | - The "type" defines if the field is a multi-line text ("text") or a single line string ("string"). |
| - workspacePath e.g. "Company | Software" | - The "target" defines the id of the custom field in Jira (e.g. "customfield_10101"). |
| - creatorFullname "John Doe" | - Optional: The targetType defines the type of the Jira field. Supported Jira fields see below. |
| - creatorUsername "jdoe" | --> |
| The "target" defines the id for the custom field in Jira (e.g. "customfield_10101"). | <attributes> |
| --> | <attribute ident="description" type="text" target="description" /> |
| <system-attribute-mappings> | <!-- The following fields could be enabled if you want the users to provide more data with every feedback item: --> |
| <attribute source="elementUrl" target="customfield_10104" /> | <!-- |
| <attribute source="workspaceName" target="customfield_10105" /> | <attribute ident="annual_savings" type="string" target="customfield_10100" /> |
| <attribute source="workspacePath" target="customfield_10106" /> | <attribute ident="priority" type="string" target="customfield_10101" /> |
| <attribute source="creatorFullname" target="customfield_10107" /> | --> |
| <attribute source="creatorUsername" target="customfield_10108" /> | </attributes> |
| </system-attribute-mappings> | |
| </host> | <!-- |
| </feedback-system> | You can map element specify information to your Jira issue. These sources are available: |
| | - elementUrl e.g. https://stages.example.com/stages/index.html#/workspace/200/_vv/(process/activity/_wUV9sBbNHr-aicWx33VsQA) |
| | - workspaceName e.g. "Software Engineering" |
| | - workspacePath e.g. "Company | Software" |
| | - creatorFullname "John Doe" |
| | - creatorUsername "jdoe" |
| | The "target" defines the id for the custom field in Jira (e.g. "customfield_10101"). |
| | --> |
| | <system-attribute-mappings> |
| | <attribute source="elementUrl" target="customfield_10104" /> |
| | <attribute source="workspaceName" target="customfield_10105" /> |
| | <attribute source="workspacePath" target="customfield_10106" /> |
| | <attribute source="creatorFullname" target="customfield_10107" /> |
| | <attribute source="creatorUsername" target="customfield_10108" /> |
| | </system-attribute-mappings> |
| | </host> |
| | </feedback-system> |
| </stages-config> | </stages-config> |
| </code> | </code> |
| |
| === Custom Endpoint === | === Supported Jira fields ==== |
| | * Description: ''targetType=""'' (Empty) |
| | * Text Field (single line): ''targetType=""'' (Empty) |
| | * Text Field (multi line): ''targetType=""'' (Empty) |
| | * Select List (single choice): ''targetType="selectList-singleChoice"'' |
| | * Components: ''targetType="components"'' |
| |
| 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 ''%%https://api.example.com/example/api/2/issue%%'' then you have to specify ''%%https://api.example.com/example/%%'' as value for this property. | Other Jira fields are not supported at the moment. |
| | |
| | === Custom Endpoint === |
| |
| | 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 xml> | <code xml> |
| <property name="proxy.enabled" value="true"> | <property name="proxy.enabled" value="true" /> |
| <property name="proxy.type" value="https"> | <property name="proxy.type" value="https" /> |
| <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> |
| |
| |
| <code xml> | <code xml> |
| <property name="authentication.type" value="oauth20"> | <property name="authentication.type" value="oauth20" /> |
| <property name="authentication.oauth20.granttype" value="password"> | <property name="authentication.oauth20.granttype" value="password" /> |
| |
| <!-- URL to your OAuth 2.0 Token Endpiont --> | <!-- URL to your OAuth 2.0 Token Endpiont --> |