Stages Documentation

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
72:jira_feedback [2018/10/24 11:19] – Code formatting fnpk72:jira_feedback [2024/02/15 00:00] (current) – external edit 127.0.0.1
Line 8: Line 8:
 ==== Jira ==== ==== 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, you have to [[https://confluence.atlassian.com/adminjiraserver/adding-a-custom-field-938847222.html|add custom fields to your Jira project]] and add them to your ''Create Issue Screen''.+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, you have to [[https://confluence.atlassian.com/adminjiraserver/adding-a-custom-field-938847222.html|add custom fields to your Jira project]] and add them to your ''Create Issue Screen''. To locate the correct fields, use the Jira assistant "Where is my field?" for more info.
  
 To configure Stages, ids of the Jira custom fields are required. There are several ways to find them out in the [[https://confluence.atlassian.com/jirakb/how-to-find-id-for-custom-field-s-744522503.html|Jira documentation]]. The ids consist of the prefix ''customfield_'' and a number e.g. ''customfield_10101''. To configure Stages, ids of the Jira custom fields are required. There are several ways to find them out in the [[https://confluence.atlassian.com/jirakb/how-to-find-id-for-custom-field-s-744522503.html|Jira documentation]]. The ids consist of the prefix ''customfield_'' and a number e.g. ''customfield_10101''.
 +
 +Stages will use the Jira REST interface to create the issue. [[https://docs.atlassian.com/software/jira/docs/api/REST/8.2.1/?_ga=2.49222754.599077736.1559584770-75849189.1559330334#api/2/issue-createIssue|See here]] for more info.
 +
 ==== Stages config.xml ==== ==== Stages config.xml ====
  
 To enable the following configuration section must be added in the ''conf/config.xml'': To enable the following configuration section must be added in the ''conf/config.xml'':
- +<code xml>
-<file xml>+
 <?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
 <stages-config> <stages-config>
Line 43: Line 45:
             <attributes>             <attributes>
                 <attribute ident="description" type="text" target="description" />                 <attribute ident="description" type="text" target="description" />
-                <attribute ident="feedback_type" type="string" target="customfield_10101" /> +                <!-- The following fields could be enabled if you want the users to provide more data with every feedback item: --> 
-                <attribute ident="impacted_org" type="string" target="customfield_10102" />+                <!--
                 <attribute ident="annual_savings" type="string" target="customfield_10100" />                 <attribute ident="annual_savings" type="string" target="customfield_10100" />
-                <attribute ident="submitter_review" type="string" target="customfield_10103" />+                <attribute ident="priority" type="string" target="customfield_10101" /> 
 +                -->
             </attributes>             </attributes>
  
Line 68: Line 71:
     </feedback-system>     </feedback-system>
 </stages-config> </stages-config>
-</file>+</code>
  
 ==== Stages metamodel ==== ==== Stages metamodel ====
Line 74: Line 77:
 The feedback widget must be added to your Stages metamodel. The XML-Element is: The feedback widget must be added to your Stages metamodel. The XML-Element is:
  
-<file xml>+<code xml>
 <widget:feedback/> <widget:feedback/>
-</file>+</code>
  
 For adding the widget to the social section, you can adopt it like this: For adding the widget to the social section, you can adopt it like this:
  
-<file xml>+<code xml>
 <widget:definition id="social"> <widget:definition id="social">
     <layout:tabbed-card id="info">     <layout:tabbed-card id="info">
Line 94: Line 97:
     </layout:tabbed-card>     </layout:tabbed-card>
 </widget:definition> </widget:definition>
-</file>+</code>
  
 ==== Stages language properties ==== ==== Stages language properties ====
  
 As last step you have to provide translations for the introduced custom fields. The translation property consists of the prefix ''process.feedback.mapping.'' and the ident you defined in the config.xml file. For the example the translations are: As last step you have to provide translations for the introduced custom fields. The translation property consists of the prefix ''process.feedback.mapping.'' and the ident you defined in the config.xml file. For the example the translations are:
- +<code properties>
-properties +
- +
-<file properties>+
 process.feedback.mapping.summary = Summary process.feedback.mapping.summary = Summary
 process.feedback.mapping.description = Description process.feedback.mapping.description = Description
-process.feedback.mapping.feedback_type = Feedback Type +process.feedback.mapping.annual_savings = Estimated annual savings 
-process.feedback.mapping.impacted_org  = Impact +process.feedback.mapping.priority = Priority 
-process.feedback.mapping.annual_savings = Savings +</code>
-process.feedback.mapping.submitter_review = Submitter +
-</file>+
  
 After all, don't forget to execute ''update.bat'' / ''update.sh'' and restart your Stages. After all, don't forget to execute ''update.bat'' / ''update.sh'' and restart your Stages.