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
Last revisionBoth sides next revision
75:process_feedback_codebeamer [2021/03/19 14:32] – [Configuration.xml - How to get the project, tracker and field id] mnwm75:process_feedback_codebeamer [2021/03/22 12:42] – [CodeBeamer config.xml] prnr
Line 3: Line 3:
 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 (under Configuration.xml - How to get the project, tracker and field id).+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.
Line 22: Line 22:
       <property name="password" value="secret" />       <property name="password" value="secret" />
  
-      <!-- Define the tracker where the item should be created in --> +      <!-- Define the tracker (with the trackerId and the correspoinding keyName) where the item should be created in  --> 
-      <property name="trackerId" value="1234" /> +      <property name="trackerId" value="2267" /> 
-      <property name="keyName" value="ABC" />+      <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 -->
Line 64: Line 64:
 ==== Basic Authentication ==== ==== Basic Authentication ====
  
-You need credentials for a (technical) user who is allowed to create issues in the CodeBeamer project.+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> <code xml>
Line 79: Line 79:
  
 The ''trackerId'' of the targeted tracker. The ''keyName'' (short name) of the targeted tracker. The ''trackerId'' of the targeted tracker. The ''keyName'' (short name) of the targeted tracker.
-==== Configuration.xml - How to get the project, tracker and field id ====+==== 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> 
 +        <!-- map the stages-description (ident) into the codebeamer-description (target) --> 
 +        <attribute ident="description" type="text" target="description" /> 
 +</attributes> 
 + 
 + 
 +</code> 
 + 
 + 
 +==== How to get the project, tracker and field id ====
  
 === Version 1: Via REST commands === === 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 (Part of 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''   * For project id: '' GET {serveradress}/cb/rest/v3/projects''