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
75:process_feedback_rtc [2020/04/14 14:02] – [Process Feedback RTC specific] tssr75:process_feedback_rtc [2024/02/15 00:00] (current) – external edit 127.0.0.1
Line 1: Line 1:
 ====== Process Feedback RTC specific ====== ====== Process Feedback RTC specific ======
-[[https://oslc.github.io/developing-oslc-applications/eclipse_lyo/eclipse-lyo.html|OSLC]] +Getting Stages ready to create Feedback as new Work Items in a RTC Project Area is simple and works as follows: 
-[[https://github.com/eclipse/lyo|Eclipse Lyo]]+ 
 +Create a new Project Area (PA) or use an existing one. For the configuration you will need the name of that PA. In this example we use "Scrum Demo". 
 +Next, we need a user, who can log into the RTC server and is allowed to create work items in the PA named **Scrum Demo**. 
 +For this example, we select the user, whose id is **admin** and password is **admin** as well. 
 +Next step is to consider, which authentication is used. In our example, we are using the form based authentication. 
 + 
 +The last step is, to think about the data you want to attach to a work item, which will be created, when a Stages-User submits feedback. 
 + 
 +This data can be specified in the sections **<nowiki><attributes></nowiki>** and **<nowiki><system-attribute-mappings></nowiki>** of the stages configuration file (config.xml). 
 ===== Stages config.xml ===== ===== Stages config.xml =====
  
Line 37: Line 46:
  
       <!--       <!--
-        The user will be asked to enter the following text fields. All text fields are optional. +        See common feedback documentation
-        - The "ident" must be unique and is used to identify the right translation property.+
         - The "type" defines, if the field is a multi-line text ("text") or a single line string ("string").         - The "type" defines, if the field is a multi-line text ("text") or a single line string ("string").
         - The "target" defines the id of the custom attribute in RTC (e.g. "some.custom.attribute").         - The "target" defines the id of the custom attribute in RTC (e.g. "some.custom.attribute").
Line 50: Line 58:
  
       <!--       <!--
-        You can map Stages-Element specify information to your RTC work item. These sources are available: +        See common feedback documentation
-        - 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"+
         The "target" defines the id for the custom attribute in RTC (e.g. "some.custom.attribute").         The "target" defines the id for the custom attribute in RTC (e.g. "some.custom.attribute").
         Optional: The targetType defines the type of the RTC attribute. For supported RTC target types see below.         Optional: The targetType defines the type of the RTC attribute. For supported RTC target types see below.
Line 63: Line 66:
         <attribute source="elementUrl" target="test.link" />         <attribute source="elementUrl" target="test.link" />
       </system-attribute-mappings>       </system-attribute-mappings>
 +
 +      <!--
 +        See common feedback documentation
 +        The "target" defines the id for the custom attribute in RTC (e.g. "some.custom.attribute").
 +        Optional: The targetType defines the type of the RTC attribute. For supported RTC target types see below.
 +      -->
 +      <custom-attribute-mappings>
 +        <attribute value="Stages" target="MySourceSystemField" targetType="some.custom.attribute" />
 +      </custom-attribute-mappings>
 +
     </host>     </host>
   </feedback-system>   </feedback-system>
 </stages-config> </stages-config>
 </code> </code>
 +
 +===== Technical detail =====
 +
 +The RTC Feedback Integration uses the discovery mechanisms of [[https://oslc.github.io/developing-oslc-applications/eclipse_lyo/eclipse-lyo.html|OSLC]]. It is build using the OSLC library [[https://github.com/eclipse/lyo|Eclipse Lyo]].