Available Merge Fields
The Merge field names are case-sensitive. All tracker item fields are accessible by label, including custom fields. Labels are expected to be in the same format as how they are returned on REST API. Labels are converted to a camel case format. The first letter is always lowercase. Then, the starting letter of subsequent words is capital letters. Capital letters inside a specific word are kept. For example:
• item.closedAt
• item.modifiedBy.name
• The label "I am a Custom field. 20 camelCase" can be accessed as "iAmACustomField20CamelCase".
You can verify names on the REST API by populating certain fields on an item, then querying it through following url:
/rest/item/<itemId>
Word export Merge Field notations follow the notation of Codebeamer REST API with some extensions. Properties which are available there are available here as well.
There is additional data available for export purposes. The appendix contains available field names.
If a tracker field label is changed, then the name on the REST API changes with it. As a result, the Word Export template should be updated as well or the field will remain empty in document.
Although there are some exceptions, following fields are not affected by renaming field labels, they are fixed:priority, comments, staff, closedAt
You can find available merge fields here:
From Codebeamer 9.4 you can generate this listing dynamically, which includes all fields:List available fields CB 9.4+
 | The following fields should not be used as the tracker field name as it conflicts with the export's built-in field names: author, title, baseline, exportDateTime, project, tracker, release, combinedTopLevelReviewStats, reviewStatsByReviewer, combinedStats |
The number of elements in multi-value fields can be accessed by <<*Count>> property. For example,
• For the <<item.downstream>> field, <<item.downstreamCount>> can be used
• For the <<item.assignedTo>> field, <<item.assignedToCount>> can be used
Multi-value fields can be printed without bookmark loops. In this case, only the names will be shown, separated by comma. For example, "item.assignedTo".
When there is a need for a more complex look, bookmark loops can be used with specific fields and properties. For more information, see the next section.
Comments
If "item.commentsPlace" is inside the template, then item comments are added to the document as Word comments anchored to this point. This field should be put into a separate line in the template like it is done for default templates.
Hyperlink fields
See: Hyperlink fields.