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
Next revisionBoth sides next revision
75:process_feedback [2020/05/12 09:18] – tssr75:process_feedback [2020/07/13 10:11] – fnpk
Line 2: Line 2:
  
 With this feature, users are able to provide feedback directly while navigating through the process. The feedback is created as a Jira or PTC-ILM item and can be triaged, planned, and tracked within the system. Every generated item contains a link back to the original process element where the feedback was 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 or PTC-ILM item and can be triaged, planned, and tracked within the system. Every generated item contains a link back to the original process element where the feedback was created, so full traceability of process change requests is assured.
- 
  
 ===== Configuration ===== ===== Configuration =====
  
-Changes in the Stages ''config.xml'', metamodel and language properties are required. +Changes in the Stages ''config.xml'', metamodel and language properties are required. In general, this configuration looks like the following:
-In general, this configuration looks like the following: +
 <code xml> <code xml>
 <?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
Line 16: Line 13:
  
   <feedback-system name=" jira || rtc || redmine || ptcilm ">   <feedback-system name=" jira || rtc || redmine || ptcilm ">
-      +
       <host url="https://some.example.com/feedback-system">       <host url="https://some.example.com/feedback-system">
  
       <!--       <!--
        Properties are configuration parameters for the feedback system.        Properties are configuration parameters for the feedback system.
-       Every feedback system defines its own parameter, which are +       Every feedback system defines its own parameter, which are
        e.g. - Username and password for authentication,        e.g. - Username and password for authentication,
-              - Project name etc.+            - Project name etc.
        Properties are configured as key:value pairs as follows        Properties are configured as key:value pairs as follows
       -->       -->
Line 37: Line 34:
       -->       -->
       <attributes>       <attributes>
-        <attribute ident="description" type="text" target="description" />+        <attribute ident="description" type="text" target="MyDescriptionField" targetType="MyFieldType" />
       </attributes>       </attributes>
  
       <!--       <!--
-       System attribute mappings are similar to the attributes but are NOT +       System attribute mappings are similar to the attributes but are NOT
        visible in the Stages Application. The values for these attributes come        visible in the Stages Application. The values for these attributes come
-       directly from the stages system. +       directly from Stages. 
-       + 
 +       Possible "source"-values are: 
 +         - 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"
       -->       -->
       <system-attribute-mappings>       <system-attribute-mappings>
-        <attribute source="elementUrl" target="customfield_10104" />+        <attribute source="elementUrl" target="MyField" targetType="MyField" targetType="MyFieldType" />
       </system-attribute-mappings>       </system-attribute-mappings>
     </host>     </host>
   </feedback-system>   </feedback-system>
 </stages-config> </stages-config>
-</code> 
  
 +
 +</code>
  
 ==== Stages config ==== ==== Stages config ====
  
- The changes in ''config.xml'' are system specific. Please refer the right manual page: +The changes in ''config.xml'' are system specific. Please refer the right manual page:
-  * [[75:process_feedback_jira|Jira]] +
-  * [[75:process_feedback_ptcilm|PTC-ILM]] +
-  * [[75:process_feedback_redmine|Redmine]] +
-  * [[75:process_feedback_rtc|RTC]]+
  
 +   * [[:75:process_feedback_jira|Jira]]
 +  * [[:75:process_feedback_ptcilm|PTC-ILM]]
 +  * [[:75:process_feedback_redmine|Redmine]]
 +  * [[:75:process_feedback_rtc|Rational Team Concert / IBM Engineering Workflow Management]]
  
 ==== Stages metamodel ==== ==== Stages metamodel ====
Line 70: Line 74:
 <code xml> <code xml>
 <widget:feedback/> <widget:feedback/>
 +
 +
 </code> </code>
  
Line 88: Line 94:
     </layout:tabbed-card>     </layout:tabbed-card>
 </widget:definition> </widget:definition>
 +
 +
 </code> </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> <code properties>
 process.feedback.mapping.summary = Summary process.feedback.mapping.summary = Summary
Line 98: Line 107:
 process.feedback.mapping.annual_savings = Estimated annual savings process.feedback.mapping.annual_savings = Estimated annual savings
 process.feedback.mapping.priority = Priority process.feedback.mapping.priority = Priority
 +
 +
 </code> </code>
  
-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.