Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revisionBoth sides next revision
75:process_feedback [2020/07/13 10:11] fnpk75:process_feedback [2020/07/13 11:04] fnpk
Line 12: Line 12:
   <!-- Insert this block to your stages config.xml file -->   <!-- Insert this block to your stages config.xml file -->
  
-  <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">
  
-      <!-- +      <property name="propertyKey" value="propertyValue" />
-       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>       <attributes>
         <attribute ident="description" type="text" target="MyDescriptionField" targetType="MyFieldType" />         <attribute ident="description" type="text" target="MyDescriptionField" targetType="MyFieldType" />
       </attributes>       </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 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="MyField" targetType="MyField" targetType="MyFieldType" />         <attribute source="elementUrl" target="MyField" targetType="MyField" targetType="MyFieldType" />
       </system-attribute-mappings>       </system-attribute-mappings>
 +      
 +      <custom-attribute-mappings>
 +        <attribute value="Stages" target="MySourceSystemField" targetType="MyFieldType" />
 +      </custom-attribute-mappings>
 +      
     </host>     </host>
   </feedback-system>   </feedback-system>
Line 63: Line 40:
 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]]
   * [[:75:process_feedback_ptcilm|PTC-ILM]]   * [[:75:process_feedback_ptcilm|PTC-ILM]]
   * [[:75:process_feedback_redmine|Redmine]]   * [[:75:process_feedback_redmine|Redmine]]
   * [[:75:process_feedback_rtc|Rational Team Concert / IBM Engineering Workflow Management]]   * [[: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)
 +    * ''creatorFullname'': e.g. John Doe
 +    * ''creatorUsername'': e.g. jdoe
 +  * ''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
 +
  
 ==== Stages metamodel ==== ==== Stages metamodel ====