Process Feedback Codebeamer specific [Stages Documentation]

This is an old revision of the document!

<h1>Process Feedback CodeBeamer specific</h1>

<div class=“level1”>
<p>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 <a class=“urlextern” href=“https://codebeamer.com/cb/wiki/23424” rel=“nofollow” title=“https://codebeamer.com/cb/wiki/23424”>here</a>.</p>

<p>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).</p>

<p>Stages uses the CodeBeamer REST interface with Swagger V3 to create the trackerItem. <a class=“urlextern” href=“https://codebeamer.com/cb/wiki/11631738” rel=“nofollow” title=“https://codebeamer.com/cb/wiki/11631738”>See here</a> for more information.</p>
</div>

<h2>CodeBeamer config.xml</h2>

<div class=“level2”>
<p>To enable the following configuration section must be added in the

conf/config.xml

:</p>

</pre>

<h3>Basic Authentication</h3>

<div class=“level3”>
<p>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')</p>

</pre>

<h4>CodeBeamer Server</h4>

<div class=“level4”>
<p>The

user

and

password

are the normal username and password of the user.</p>
</div>

<h4>CodeBeamer Tracker</h4>

<div class=“level4”>
<p>The

trackerId

of the targeted tracker. The

keyName

(short name) of the targeted tracker.</p>
</div>

<h3>Mandatory fields</h3>

<div class=“level3”>
<p>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:</p>

</pre>

<h3>How to get the project, tracker and field id</h3>

<h4>Version 1: Via REST commands</h4>

<div class=“level4”>
<p>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')</p>

<ul>
<li class=“level1”>For project id:

 GET {serveradress}/cb/rest/v3/projects

</li>
<li class=“level1”>For tracker id:

 GET {serveradress}/cb/rest/v3/projects/{projectId}/trackers

</li>
<li class=“level1”>For field id:

 GET {serveradress}/cb/rest/v3/trackers/{trackerId}

</li>
</ul>

<p>Or see CodeBeamer documentation for <a class=“urlextern” href=“https://codebeamer.com/cb/wiki/11375774#section-Getting+the+list+of+available+projects” rel=“nofollow” title=“https://codebeamer.com/cb/wiki/11375774#section-Getting+the+list+of+available+projects”>Getting list of available projects</a>, <a class=“urlextern” href=“https://codebeamer.com/cb/wiki/11375774#section-Getting+the+list+of+trackers+in+a+specific+project” rel=“nofollow” title=“https://codebeamer.com/cb/wiki/11375774#section-Getting+the+list+of+trackers+in+a+specific+project”> Getting list of trackers in a project</a>, <a class=“urlextern” href=“https://codebeamer.com/cb/wiki/11375774#section-Getting+the+fields+of+a+tracker” rel=“nofollow” title=“https://codebeamer.com/cb/wiki/11375774#section-Getting+the+fields+of+a+tracker”> Getting the fields of a tracker</a>.</p>
</div>

<h4>Version 2: Via Codebeamer and calculation</h4>

<div class=“level4”>
<p>To locate the project id, edit the project via the context points and look into the url:</p>

<p>To locate the tracker id, go to the tracker page and look into the url:</p>

<p>Or configure the tracker via the context points and read the id directly in CodeBeamer:</p>

<p>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.</p>

<p>This number has to be added to a base number, depending on the type of the field:</p>

<ul>
<li class=“level1”>CustomFields: Base Number is 10000, add the displayed number to get the field id.</li>
<li class=“level1”>ChoiceField: Base Number is 1000, add the displayed number to get the field id.</li>
</ul>
</div>

<h3>Supported CodeBeamer Tracker Fields and Types</h3>

<div class=“level3”>
<ul>
<li class=“level1 node”>Description: Custom Field:
<ul>

   <li class="level3">Type Text: <code>targettype=&quot;TextFieldValue&quot;

</code> (default if no targetType is set)</li>

   <li class="level3">Type Wikilink/Url: <code>targettype=&quot;UrlFieldValue&quot;

</code> (required to set hyperlinks)</li>
</ul>
</li>
<li class=“level1 node”>Description: Choice Field:
<ul>

   <li class="level3">Type Text: <code>targettype=&quot;UserReference&quot;

</code> (required to set the requester automatically. Requester's username must be identical in Stages and CodeBeamer)</li>
</ul>
</li>
</ul>
</div>