| Both sides previous revisionPrevious revisionNext revision | Previous revision |
| 77:process_feedback_codebeamer [2021/03/23 09:33] – mnwm | 77:process_feedback_codebeamer [2024/02/15 00:00] (current) – external edit 127.0.0.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). | 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'': | To enable the following configuration section must be added in the ''conf/config.xml'': |
| <code xml> | <code xml> |
| <?xml version="1.0" encoding="UTF-8" ?> | |
| <stages-config> | <stages-config> |
| <!-- Insert this block to your stages config.xml file --> | <!-- Insert this block to your stages config.xml file --> |
| <feedback-system name="CodeBeamer"> | <feedback-systems> |
| <host url="https://codebeamer.example.com/cb"> | <feedback-system name="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="user" value="user" /> |
| <property name="password" value="secret" /> | <property name="password" value="secret" /> |
| |
| <!-- Define the tracker (with the trackerId and the correspoinding keyName) 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="2267" /> | <property name="trackerId" value="2267" /> |
| <property name="keyName" value="TASK" /> | <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 | 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> | <attributes> |
| <attribute ident="description" type="text" target="description" /> | <attribute ident="description" type="text" target="description" /> |
| </attributes> | </attributes> |
| |
| <!-- | <!-- |
| See common feedback documentation | 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> | <system-attribute-mappings> |
| <attribute source="elementUrl" target="10000" targettype="UrlFieldValue" /> | <attribute source="elementUrl" target="10000" targetType="UrlFieldValue" /> |
| <attribute source="creatorUsername" target="1000" targettype="UserReference" /> | <attribute source="creatorUsername" target="1000" targetType="UserReference" /> |
| </system-attribute-mappings> | </system-attribute-mappings> |
| |
| <!-- | <!-- |
| See common feedback documentation | 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> | <custom-attribute-mappings> |
| <attribute value="Stages" target="10001" /> | <attribute value="Stages" target="10001" /> |
| </custom-attribute-mappings> | </custom-attribute-mappings> |
| </host> | </host> |
| </feedback-system> | </feedback-system> |
| | </feedback-systems> |
| </stages-config> | </stages-config> |
| |
| |
| </code> | </code> |
| |
| ==== Basic Authentication ==== | ==== 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> | <code xml> |
| </code> | </code> |
| |
| === CodeBeamer Server === | === Codebeamer Server === |
| |
| The ''user'' and ''password'' are the normal username and password of the user. | 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. | The ''trackerId'' of the targeted tracker. The ''keyName'' (short name) of the targeted tracker. |
| | |
| ==== Mandatory fields ==== | ==== Mandatory fields ==== |
| |
| === 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 (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'' | * For project id: '' GET {serveradress}/cb/rest/v3/projects'' |
| * For field id: '' GET {serveradress}/cb/rest/v3/trackers/{trackerId}'' | * 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 === | === Version 2: Via Codebeamer and calculation === |
| {{https://doc.stagesasaservice.com/lib/plugins/ckgedit/fckeditor/userfiles/image/75/cb_findtrackerid_2.png?nolink&1372x326}} | {{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}} | {{https://doc.stagesasaservice.com/lib/plugins/ckgedit/fckeditor/userfiles/image/75/cb_findtrackerid_1_1.png?nolink&1130x539}} |
| * ChoiceField: Base Number is 1000, 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 ==== | ==== Supported Codebeamer Tracker Fields and Types ==== |
| |
| * Description: Custom Field: | * Description: Custom Field: |
| * Type Text: ''targettype="TextFieldValue"'' (default if no targetType is set) | * Type Text: ''targetType="TextFieldValue"'' (default if no targetType is set) |
| * Type Wikilink/Url: ''targettype="UrlFieldValue"'' (required to set hyperlinks) | * Type Wikilink/Url: ''targetType="UrlFieldValue"'' (required to set hyperlinks) |
| * Description: Choice Field: | * 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) |
| |
| |