Stages Documentation

Differences

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

Link to this comparison view

Next revision		Previous revision
Next revisionBoth sides next revision
75:process_feedback [2020/01/23 14:21] – created fnpk75:process_feedback [2020/05/12 09:18] – tssr
Line 1: Line 1:
 ====== Process feedback ====== ====== Process feedback ======
  
-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 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 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 =====
  
-In Stages changes in ''config.xml'' and 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: 
 + 
 +<code xml> 
 +<?xml version="1.0" encoding="UTF-8" ?> 
 +<stages-config> 
 + 
 +  <!-- Insert this block to your stages config.xml file --> 
 + 
 +  <feedback-system name=" jira || rtc || redmine || ptcilm "> 
 +       
 +      <host url="https://some.example.com/feedback-system"> 
 + 
 +      <!-- 
 +       Properties are configuration parameters for the feedback system. 
 +       Every feedback system defines its own parameter, which are  
 +       e.g. - Username and password for authentication, 
 +              - Project name etc. 
 +       Properties are configured as key:value pairs as follows 
 +      --> 
 +      <property name="propertyName" value="propertyValue" /> 
 + 
 +      <!-- 
 +       Attributes define the values, which are visible to the feedback-creator. 
 +       Each attribute will be shown in form of a text-box in the feedback widget 
 +       and will be sent to the feedback system once the user clicks on "save" in 
 +       the Stages Application. 
 +       The target attribute of each xml-attribute entry defines, where the values 
 +       will be stored in the feedback system. 
 +      --> 
 +      <attributes> 
 +        <attribute ident="description" type="text" target="description" /> 
 +      </attributes> 
 + 
 +      <!-- 
 +       System attribute mappings are similar to the attributes but are NOT  
 +       visible in the Stages Application. The values for these attributes come 
 +       directly from the stages system. 
 +        
 +      --> 
 +      <system-attribute-mappings> 
 +        <attribute source="elementUrl" target="customfield_10104" /> 
 +      </system-attribute-mappings> 
 +    </host> 
 +  </feedback-system> 
 +</stages-config> 
 +</code> 
  
 ==== Stages config ==== ==== Stages config ====
Line 11: Line 59:
  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_jira|Jira]]
-  * PTC-ILM+  * [[75:process_feedback_ptcilm|PTC-ILM]] 
 +  * [[75:process_feedback_redmine|Redmine]] 
 +  * [[75:process_feedback_rtc|RTC]]