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_codebeamer [2021/03/22 11:49] – [Process Feedback CodeBeamer specific] prnr75:process_feedback_codebeamer [2021/03/23 09:36] (current) – removed mnwm
Line 1: Line 1:
-====== 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]]. 
- 
-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 (under 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. 
- 
- 
-===== CodeBeamer config.xml ===== 
- 
-To enable 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="CodeBeamer"> 
-    <host url="https://codebeamer.example.com/cb"> 
- 
-      <!-- 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" /> 
- 
-      <!-- Define the tracker where the item should be created in --> 
-      <property name="trackerId" value="1234" /> 
-      <property name="keyName" value="ABC" /> 
- 
-      <!-- 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"). 
-      - Optional: The targetType defines the type of the CodeBeamer trackerField. Supported tracker fields see below. 
-      --> 
-      <attributes> 
-        <attribute ident="description" type="text" target="description" /> 
-      </attributes> 
- 
-      <!-- 
-      See common feedback documentation 
-      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. 
-      --> 
-      <system-attribute-mappings> 
-        <attribute source="elementUrl" target="10000" targettype="UrlFieldValue" /> 
-        <attribute source="creatorUsername" target="1000" targettype="UserReference" /> 
-      </system-attribute-mappings> 
- 
-      <!-- 
-      See common feedback documentation 
-      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. 
-      --> 
-      <custom-attribute-mappings> 
-        <attribute value="Stages" target="10001" /> 
-      </custom-attribute-mappings> 
-    </host> 
-  </feedback-system> 
-</stages-config> 
- 
- 
-</code> 
- 
-==== 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') 
- 
-<code xml> 
-<property name="user" value="user" /> 
-<property name="password" value="secret" /> 
- 
- 
-</code> 
- 
-=== CodeBeamer Server === 
- 
-The ''user'' and ''password'' are the normal username and password of the user. 
-=== CodeBeamer Tracker === 
- 
-The ''trackerId'' of the targeted tracker. The ''keyName'' (short name) of the targeted tracker. 
-==== Mandatory fields ==== 
- 
-For all issues, the fields name and description are mandatory. Name is automatically configured and will display the summary text. Description has to be configured in the configuration.xml as followed: 
- 
-<code xml> 
-<attributes> 
-        <attribute ident="description" type="text" target="description" /> 
-</attributes> 
- 
- 
-</code> 
- 
- 
-==== How to get the project, tracker and field id ==== 
- 
-=== 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') 
- 
-  * For project id: '' GET {serveradress}/cb/rest/v3/projects'' 
-  * For tracker id: '' GET {serveradress}/cb/rest/v3/projects/{projectId}/trackers'' 
-  * 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]]. 
- 
-=== Version 2: Via Codebeamer and calculation === 
- 
-To locate the project id, edit the project via the context points and look into the url: 
- 
-{{https://doc.stagesasaservice.com/lib/plugins/ckgedit/fckeditor/userfiles/image/75/cb_findprojectid_1.png?nolink&1119x543}} 
- 
-To locate the tracker id, go to the tracker page and look into the url: 
- 
-{{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: 
- 
-{{https://doc.stagesasaservice.com/lib/plugins/ckgedit/fckeditor/userfiles/image/75/cb_findtrackerid_1_1.png?nolink&1130x539}} 
- 
-To calculate the field id, configure the tracker with the field, select the field tab and click on the field name. At the top, a number is displayed in brackets. 
- 
-{{https://doc.stagesasaservice.com/lib/plugins/ckgedit/fckeditor/userfiles/image/75/cb_findfieldid_1_1.png?nolink&1032x719}} 
- 
-This number has to be added to a base number, depending on the type of the field: 
- 
-  * CustomFields: Base Number is 10000, add the displayed number to get the field id. 
-  * ChoiceField: Base Number is 1000, add the displayed number to get the field id. 
- 
- 
-==== Supported CodeBeamer Tracker Fields and Types ==== 
- 
-  * Description: Custom Field: 
-      * Type Text: ''targettype="TextFieldValue"''  (default if no targetType is set) 
-      * 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) 
-