Differences

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

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
75:process_feedback [2020/01/27 09:51]
prnr [Configuration]
75:process_feedback [2020/08/06 15:09] (current)
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:​ 
 +<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">​
 +
 +      <​property name="​propertyKey"​ value="​propertyValue"​ />
 +
 +      <​attributes>​
 +        <​attribute ident="​description"​ type="​text"​ target="​MyDescriptionField"​ targetType="​MyFieldType"​ />
 +      </​attributes>​
 +
 +      <​system-attribute-mappings>​
 +        <​attribute source="​elementUrl"​ target="​MyField"​ targetType="​MyField"​ targetType="​MyFieldType"​ />
 +      </​system-attribute-mappings>​
 +      ​
 +      <​custom-attribute-mappings>​
 +        <​attribute value="​Stages"​ target="​MySourceSystemField"​ targetType="​MyFieldType"​ />
 +      </​custom-attribute-mappings>​
 +      ​
 +    </​host>​
 +  </​feedback-system>​
 +</​stages-config>​
 +
 +
 +</​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_jira|Jira]] 
 +  * [[:75:​process_feedback_ptcilm|PTC-ILM]] 
 +  * [[:​75:​process_feedback_redmine|Redmine]] 
 +  * [[:​75:​process_feedback_rtc|Rational Team Concert / IBM Engineering Workflow Management]] 
 + 
 + 
 +===  Properties === 
 + 
 +<code xml> 
 +<​property name="​propertyKey"​ value="​propertyValue"​ /> 
 +</​code>​ 
 + 
 +Properties are configuration parameters for the feedback system. Every feedback system defines its own parameter, which are Username and password for authentication or project name etc. Properties are configured as key:value pairs. 
 + 
 +=== Attributes === 
 + 
 +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. 
 + 
 +<code xml> 
 +<​attribute ident="​description"​ type="​text"​ target="​MyDescriptionField"​ targetType="​MyFieldType"​ /> 
 +</​code>​ 
 + 
 +  * ''​ident'':​ Stages translation property 
 +  * ''​type'':​ Type of text field in Stags: 
 +    * ''​string'':​ Text Field (single line) 
 +    * ''​text'':​ Text Field (multi line) 
 +  * ''​target''​ and ''​targetType'':​ Defines feedback system specific configuration 
 + 
 +=== System Attribute Mappings === 
 + 
 +System attribute mappings are similar to the attributes but are NOT visible in the Stages Application. The values for these attributes come directly from Stages. 
 + 
 +<code xml> 
 +<​attribute source="​elementUrl"​ target="​MyField"​ targetType="​MyField"​ targetType="​MyFieldType"​ /> 
 +</​code>​ 
 + 
 +  * ''​source'':​ Which information from Stages should be taken 
 +    * ''​elementUrl'':​ Url to element 
 +    * ''​elementStableUrl'':​ Url to element with specific version (Since Stages 7.5.1.3) 
 +    * ''​originElementUrl'':​ Url to editable element if current element is imported by module import (Since Stages 7.5.1.3) 
 +    * ''​originElementStableUrl'':​ Url to editable element with specific version if current element is imported by module import (Since Stages 7.5.1.3) 
 +    * ''​elementIdentity'':​ e.g. _wUV9sBbNHr-aicWx33VsQA (Since Stages 7.5.1.3) 
 +    * ''​processVersionName'':​ e.g. V1 (Since Stages 7.5.1.3) 
 +    * ''​workspaceName'':​ e.g. Software Engineering 
 +    * ''​workspacePath'':​ e.g. Company > Software 
 +    * ''​workspaceFullPath'':​ e.g. Company > Software > Software Engineering (Since Stages 7.5.1.3) 
 +    * ''​originWorkspaceName'':​ e.g. Software Engineering (Since Stages 7.5.2.2) 
 +    * ''​originWorkspacePath'':​ e.g. Company > Software (Since Stages 7.5.2.2) 
 +    * ''​originWorkspaceFullPath'':​ e.g. Company > Software > Software Engineering (Since Stages 7.5.2.2) 
 +    * ''​creatorFullname'':​ e.g. John Doe 
 +    * ''​creatorUsername'':​ e.g. jdoe 
 +    * ''​creatorEmail'':​ e.g. jdoe@example.com (Since Stages 7.5.2.2) 
 +  * ''​target''​ and ''​targetType'':​ Defines feedback system specific configuration 
 + 
 +=== Custom Attribute Mappings === 
 + 
 +(Since Stages 7.5.1.3) 
 + 
 +Custom attribute mappings are similar to the attributes but are NOT visible in the Stages Application. The values for these attributes come directly from ''​config.xml''​. You can map static values to fields in the feedback system. 
 + 
 +<code xml> 
 +<​attribute value="​Stages"​ target="​MySourceSystemField"​ targetType="​MyFieldType"​ /> 
 +</​code>​ 
 + 
 +  * ''​value'':​ The value that should be mapped 
 +  * ''​target''​ and ''​targetType'':​ Defines feedback system specific configuration
  
  
Line 22: Line 114:
 <code xml> <code xml>
 <​widget:​feedback/>​ <​widget:​feedback/>​
 +
 +
 </​code>​ </​code>​
  
Line 40: Line 134:
     </​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 50: Line 147:
 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.