Stages Documentation

Differences

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

Link to this comparison view

Next revision		Previous revision
75:process_feedback_rtc [2020/04/14 13:12] – created 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 ======
 +Getting Stages ready to create Feedback as new Work Items in a RTC Project Area is simple and works as follows:
 +
 +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 =====
 +
 +To enable the RTC Feedback-System, the following configuration section must be added in the ''conf/config.xml'':
 +<code xml>
 +<?xml version="1.0" encoding="UTF-8" ?>
 +<stages-config>
 +  <!-- Insert this block to your stages config.xml file -->
 +  <feedback-system name="rtc">
 +    <host url="https://rtc.example.com/ccm">
 +
 +      <!-- Name of the project area, which will contain all the work items created by stages -->
 +      <property name="projectAreaName" value="Scrum Demo" />
 +
 +      <!-- Type of the work item, which will be created by stages -->
 +      <property name="workItemType" value="task" />
 +      
 +      <!--
 +        Please only enable, if you know what you are doing here
 +        Can be enabled, if your RTC server uses untrusted (or self-signed) ssl certificates
 +      -->
 +      <property name="trustSsl" value="true" />
 +      
 +      <!-- The Username to access the RTC server and create work items -->
 +      <property name="username" value="admin" />
 +      
 +      <!-- The corresponding password -->
 +      <property name="password" value="admin" />
 +      
 +      <!--
 +        Authentication Method, to log into the RTC server
 +        Possible values are: "basic", "form" and "jas"
 +      -->
 +      <property name="authenticationMethod" value="form" />
 +
 +      <!--
 +        See common feedback documentation
 +        - 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").
 +        - Optional: The targetType defines the type of the RTC attribute. For supported RTC target types see below.
 +      -->
 +      <attributes>
 +        <attribute ident="text" type="text" target="test.text" />
 +        <attribute ident="boolean" type="text" target="test.boolean" />
 +        <attribute ident="description" type="text" target="description" />
 +      </attributes>
 +
 +      <!--
 +        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.
 +      -->
 +      <system-attribute-mappings>
 +        <attribute source="creatorFullname" target="test.user" targetType="contributor" />
 +        <attribute source="elementUrl" target="test.link" />
 +      </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>
 +  </feedback-system>
 +</stages-config>
 +</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]].