Differences

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

--- 77:process_feedback_codebeamer [2021/07/07 10:56] – fnpk
+++ 77:process_feedback_codebeamer [2024/02/15 00:00] (current) – external edit 127.0.0.1
@@ Line 1: / Line 1: @@
-====== Process Feedback CodeBeamer specific ======
+====== Process Feedback Codebeamer specific ======
-First of all, create a CodeBeamer project where the feedback will be collected. If you want to collect more information than the summary and a description, you have to create a new tracker and add additional fields to it. Further information to creating and customizing trackers can be found at [[https://codebeamer.com/cb/wiki/23424|here]].
+First of all, create a Codebeamer project where the feedback will be collected. If you want to collect more information than the summary and a description, you have to create a new tracker and add additional fields to it. Further information to creating and customizing trackers can be found at [[https://codebeamer.com/cb/wiki/23424|here]].
 To configure Stages, the id of the target tracker is required. For custom fields, the customField ids are required. There are several ways to find them out (see below Configuration.xml - How to get the project, tracker and field id).
-Stages uses the CodeBeamer REST interface with Swagger V3 to create the trackerItem. [[https://codebeamer.com/cb/wiki/11631738|See here]] for more information.
+Stages uses the Codebeamer REST interface with Swagger V3 to create the trackerItem. [[https://codebeamer.com/cb/wiki/11631738|See here]] for more information.
-===== CodeBeamer config.xml =====
+===== Codebeamer config.xml =====
 To enable the following configuration section must be added in the ''conf/config.xml'':
@@ Line 15: / Line 15: @@
   <feedback-systems>
     <feedback-system name="codebeamer">
-        <host url="https://codebeamer.example.com/cb" ident="codebeamer1" displayName="Example Codebeamer">
+      <host url="https://codebeamer.example.com/cb" ident="codebeamer1" displayName="Example Codebeamer">
-        <!-- Credentials for a (technical) user who is allowed to create items in the CodeBeamer project and tracker -->
+        <!-- Credentials for a (technical) user who is allowed to create items in the Codebeamer project and tracker -->
         <property name="user" value="user" />
         <property name="password" value="secret" />
@@ Line 25: / Line 25: @@
         <property name="keyName" value="TASK" />
-        <!-- The summary field will always be available and is automatically mapped to the CodeBeamer name field -->
+        <!-- The summary field will always be available and is automatically mapped to the Codebeamer name field -->
         <!--
         See common feedback documentation
-        - The "target" defines the id of the custom field in CodeBeamer(e.g. "customfield_10101").
+        - The "target" defines the id of the custom field in Codebeamer (e.g. "customfield_10101").
-        - Optional: The targetType defines the type of the CodeBeamer trackerField. Supported tracker fields see below.
+        - Optional: The targetType defines the type of the Codebeamer trackerField. Supported tracker fields see below.
         -->
         <attributes>
@@ Line 38: / Line 38: @@
         <!--
         See common feedback documentation
-        The "target" defines the id for the custom field in CodeBeamer(e.g. "10000").
+        The "target" defines the id for the custom field in Codebeamer (e.g. "10000").
-        Optional: The targetType defines the type of the CodeBeamer tracker field. Supported tracker fields see below.
+        Optional: The targetType defines the type of the Codebeamer tracker field. Supported tracker fields see below.
         -->
         <system-attribute-mappings>
@@ Line 48: / Line 48: @@
         <!--
         See common feedback documentation
-        The "target" defines the id for the custom field in CodeBeamer(e.g. "10000").
+        The "target" defines the id for the custom field in Codebeamer (e.g. "10000").
-        Optional: The targetType defines the type of the CodeBeamer field. Supported CodeBeamer fields see below.
+        Optional: The targetType defines the type of the Codebeamer field. Supported Codebeamer fields see below.
         -->
         <custom-attribute-mappings>
             <attribute value="Stages" target="10001" />
         </custom-attribute-mappings>
-        </host>
+      </host>
     </feedback-system>
   </feedback-systems>
@@ Line 62: / Line 62: @@
 ==== Basic Authentication ====
-You need credentials for a (technical) user who is allowed to create issues in the CodeBeamer project. This user also needs to be allowed to use the CodeBeamer APIs (be part of the Group 'API User')
+You need credentials for a (technical) user who is allowed to create issues in the Codebeamer project. This user also needs to be allowed to use the Codebeamer APIs (be part of the Group 'API User')
 <code xml>
@@ Line 71: / Line 71: @@
 </code>
-=== CodeBeamer Server ===
+=== Codebeamer Server ===
 The ''user'' and ''password'' are the normal username and password of the user.
-=== CodeBeamer Tracker ===
+=== Codebeamer Tracker ===
 The ''trackerId'' of the targeted tracker. The ''keyName'' (short name) of the targeted tracker.
 ==== Mandatory fields ====
@@ Line 94: / Line 96: @@
 === Version 1: Via REST commands ===
-Just enter the following REST statements into your browser and login with your CodeBeamer username and password. Requires Permission to use CodeBeamer APIs (be part of the Group 'API User')
+Just enter the following REST statements into your browser and login with your Codebeamer username and password. Requires Permission to use Codebeamer APIs (be part of the Group 'API User')
   * For project id: '' GET {serveradress}/cb/rest/v3/projects''
@@ Line 100: / Line 102: @@
   * For field id: '' GET {serveradress}/cb/rest/v3/trackers/{trackerId}''
-Or see CodeBeamer documentation for [[https://codebeamer.com/cb/wiki/11375774#section-Getting+the+list+of+available+projects|Getting list of available projects]], [[https://codebeamer.com/cb/wiki/11375774#section-Getting+the+list+of+trackers+in+a+specific+project| Getting list of trackers in a project]], [[https://codebeamer.com/cb/wiki/11375774#section-Getting+the+fields+of+a+tracker| Getting the fields of a tracker]].
+Or see Codebeamer documentation for [[https://codebeamer.com/cb/wiki/11375774#section-Getting+the+list+of+available+projects|Getting list of available projects]], [[https://codebeamer.com/cb/wiki/11375774#section-Getting+the+list+of+trackers+in+a+specific+project| Getting list of trackers in a project]], [[https://codebeamer.com/cb/wiki/11375774#section-Getting+the+fields+of+a+tracker| Getting the fields of a tracker]].
 === Version 2: Via Codebeamer and calculation ===
@@ Line 112: / Line 114: @@
 {{https://doc.stagesasaservice.com/lib/plugins/ckgedit/fckeditor/userfiles/image/75/cb_findtrackerid_2.png?nolink&1372x326}}
-Or configure the tracker via the context points and read the id directly in CodeBeamer:
+Or configure the tracker via the context points and read the id directly in Codebeamer:
 {{https://doc.stagesasaservice.com/lib/plugins/ckgedit/fckeditor/userfiles/image/75/cb_findtrackerid_1_1.png?nolink&1130x539}}
@@ Line 125: / Line 127: @@
   * ChoiceField: Base Number is 1000, add the displayed number to get the field id.
-==== Supported CodeBeamer Tracker Fields and Types ====
+==== Supported Codebeamer Tracker Fields and Types ====
   * Description: Custom Field:
@@ Line 131: / Line 133: @@
       * Type Wikilink/Url: ''targetType="UrlFieldValue"''  (required to set hyperlinks)
   * Description: Choice Field:
-      * Type Text: ''targetType="UserReference"''  (required to set the requester automatically. Requester's username must be identical in Stages and CodeBeamer)
+      * Type Text: ''targetType="UserReference"''  (required to set the requester automatically. Requester's username must be identical in Stages and Codebeamer)