Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
75:process_feedback_codebeamer [2021/03/22 11:49] – [Process Feedback CodeBeamer specific] prnr | 75: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, | ||
- | |||
- | 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 config.xml ===== | ||
- | |||
- | To enable the following configuration section must be added in the '' | ||
- | <code xml> | ||
- | <?xml version=" | ||
- | < | ||
- | <!-- Insert this block to your stages config.xml file --> | ||
- | < | ||
- | <host url=" | ||
- | |||
- | <!-- Credentials for a (technical) user who is allowed to create items in the CodeBeamer project and tracker --> | ||
- | < | ||
- | < | ||
- | |||
- | <!-- Define the tracker where the item should be created in --> | ||
- | < | ||
- | < | ||
- | |||
- | <!-- The summary field will always be available and is automatically mapped to the CodeBeamer name field --> | ||
- | |||
- | <!-- | ||
- | See common feedback documentation | ||
- | - The " | ||
- | - Optional: The targetType defines the type of the CodeBeamer trackerField. Supported tracker fields see below. | ||
- | --> | ||
- | < | ||
- | < | ||
- | </ | ||
- | |||
- | <!-- | ||
- | See common feedback documentation | ||
- | The " | ||
- | Optional: The targetType defines the type of the CodeBeamer tracker field. Supported tracker fields see below. | ||
- | --> | ||
- | < | ||
- | < | ||
- | < | ||
- | </ | ||
- | |||
- | <!-- | ||
- | See common feedback documentation | ||
- | The " | ||
- | Optional: The targetType defines the type of the CodeBeamer field. Supported CodeBeamer fields see below. | ||
- | --> | ||
- | < | ||
- | < | ||
- | </ | ||
- | </ | ||
- | </ | ||
- | </ | ||
- | |||
- | |||
- | </ | ||
- | |||
- | ==== 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> | ||
- | < | ||
- | < | ||
- | |||
- | |||
- | </ | ||
- | |||
- | === CodeBeamer Server === | ||
- | |||
- | The '' | ||
- | === CodeBeamer Tracker === | ||
- | |||
- | The '' | ||
- | ==== 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> | ||
- | < | ||
- | < | ||
- | </ | ||
- | |||
- | |||
- | </ | ||
- | |||
- | |||
- | ==== 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: '' | ||
- | * For tracker id: '' | ||
- | * For field id: '' | ||
- | |||
- | Or see CodeBeamer documentation for [[https:// | ||
- | |||
- | === Version 2: Via Codebeamer and calculation === | ||
- | |||
- | To locate the project id, edit the project via the context points and look into the url: | ||
- | |||
- | {{https:// | ||
- | |||
- | To locate the tracker id, go to the tracker page and look into the url: | ||
- | |||
- | {{https:// | ||
- | |||
- | Or configure the tracker via the context points and read the id directly in CodeBeamer: | ||
- | |||
- | {{https:// | ||
- | |||
- | 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:// | ||
- | |||
- | This number has to be added to a base number, depending on the type of the field: | ||
- | |||
- | * CustomFields: | ||
- | * ChoiceField: | ||
- | |||
- | |||
- | ==== Supported CodeBeamer Tracker Fields and Types ==== | ||
- | |||
- | * Description: | ||
- | * Type Text: '' | ||
- | * Type Wikilink/ | ||
- | * Description: | ||
- | * Type Text: '' | ||
- | |||