Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
72:jira_feedback [2018/10/04 14:42] – fnpk | 72:jira_feedback [2024/02/15 00:00] (current) – external edit 127.0.0.1 | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== | + | ====== |
- | With this feature, users are able to provide feedback directly while navigating through the process. The feedback is then created as a Jira item and can be triaged, planned, and tracked within Jira. Every generated Jira item contains a link back to the original process element where the feedback was being created, so full traceability of process change requests is assured. | + | With this feature, users are able to provide feedback directly while navigating through the process. The feedback is created as a Jira item and can be triaged, planned, and tracked within Jira. Every generated Jira item contains a link back to the original process element where the feedback was being created, so full traceability of process change requests is assured. |
- | To enable the following configuration section must be enabled in '' | + | ===== Configuration ===== |
- | … | + | For configuration a Jira project is necessary. In Stages changes in '' |
+ | ==== Jira ==== | ||
+ | |||
+ | First of all, create a Jira project where the feedback will be collected. If you want to collect more information than the summary and a description, | ||
+ | |||
+ | To configure Stages, ids of the Jira custom fields are required. There are several ways to find them out in the [[https:// | ||
+ | |||
+ | Stages will use the Jira REST interface to create the issue. [[https:// | ||
+ | |||
+ | ==== Stages config.xml ==== | ||
+ | |||
+ | To enable the following configuration section must be added in the '' | ||
+ | <code xml> | ||
+ | <?xml version=" | ||
+ | < | ||
+ | <!-- Insert this block to your stages config.xml file --> | ||
+ | < | ||
+ | <host url=" | ||
+ | <!-- Credentials for a (technical) user who is allowed to create issues in the Jira project --> | ||
+ | < | ||
+ | < | ||
+ | |||
+ | <!-- Define the project where the issue should be created in --> | ||
+ | < | ||
+ | <!-- As alternative to the project key you can specify the project by its id --> | ||
+ | <!-- < | ||
+ | |||
+ | <!-- Define the name of the issue type that should be created --> | ||
+ | < | ||
+ | |||
+ | <!-- The summary field will always be available and is automatically mapped to the Jira " | ||
+ | |||
+ | <!-- | ||
+ | The user will be asked to enter the following text fields. All text fields are optional. | ||
+ | - The " | ||
+ | - The " | ||
+ | - The " | ||
+ | --> | ||
+ | < | ||
+ | < | ||
+ | <!-- The following fields could be enabled if you want the users to provide more data with every feedback item: --> | ||
+ | <!-- | ||
+ | < | ||
+ | < | ||
+ | --> | ||
+ | </ | ||
+ | |||
+ | <!-- | ||
+ | You can map element specify information to your Jira issue. These sources are available: | ||
+ | - elementUrl e.g. https:// | ||
+ | - workspaceName e.g. " | ||
+ | - workspacePath e.g. " | ||
+ | - creatorFullname "John Doe" | ||
+ | - creatorUsername " | ||
+ | The " | ||
+ | --> | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | </ | ||
+ | </ | ||
+ | </ | ||
+ | </ | ||
+ | </ | ||
+ | |||
+ | ==== Stages metamodel ==== | ||
+ | |||
+ | The feedback widget must be added to your Stages metamodel. The XML-Element is: | ||
+ | |||
+ | <code xml> | ||
+ | < | ||
+ | </ | ||
+ | |||
+ | For adding the widget to the social section, you can adopt it like this: | ||
+ | |||
+ | <code xml> | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | </ | ||
+ | < | ||
+ | < | ||
+ | </ | ||
+ | < | ||
+ | < | ||
+ | </ | ||
+ | </ | ||
+ | </ | ||
+ | </ | ||
+ | |||
+ | ==== Stages language properties ==== | ||
+ | |||
+ | As last step you have to provide translations for the introduced custom fields. The translation property consists of the prefix '' | ||
+ | <code properties> | ||
+ | process.feedback.mapping.summary = Summary | ||
+ | process.feedback.mapping.description = Description | ||
+ | process.feedback.mapping.annual_savings = Estimated annual savings | ||
+ | process.feedback.mapping.priority = Priority | ||
+ | </ | ||
+ | |||
+ | After all, don't forget to execute '' | ||