Available Merge Fields
The Merge field names are case sensitive. All tracker item fields are accessible by label including custom fields. Labels are expected in the same format how it is returned on REST API. Labels are converted to a camel case format. First letter is always lowercase. Then starting letter of subsequent words are capital letters. Capital letters inside a specific word are kept.)
Examples:
• 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. Populate certain field on an item then query it through following url:
/rest/item/<itemId>
Word export Merge Field notation follows notation of Codebeamer REST API with some extensions. Properties which are available there are available here as well.
Plus there are additional data available for export purposes. Appendix contains available field names.
If a tracker field label is changed then name on REST API changes with it. As a result Word Export template should be updated as well or else 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 including custom fields:
List available fields CB 9.4+
 | Following fields should not be used as tracker field name as it conflicts with export's built-in field names: author, title, baseline, exportDateTime, project, tracker, release, combinedTopLevelReviewStats, reviewStatsByReviewer, combinedStats |
Number of elements in multi-value fields can be accessed by <<*Count>> property. Examples:
• in case of <<item.downstream>> field <<item.downstreamCount>> can be used
• in case of <<item.assignedTo>> field <<item.assignedToCount>> can be used
Multi-value fields can be printed simply without bookmark loops too. In this case only the names will be shown, separated by comma.
eg.: "item.assignedTo"
When there is a need for more complex look, then bookmark loops can be used with specific fields/properties. Please see 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 in case of default templates.
Hyperlink fields
See: Hyperlink fields