Customizing Exported Issues
The export document contains several issues and for each issue it contains:
• The name of the issue. This part can be edited, and when reimporting the document that will update the appropriate issue's name.
• The read-only properties of the issue. This part is never editable, but can contain rich content.
• Few editable properties of the issue. Some properties of the issue namely the "Priority", "Severity" and "Business Value" can be changed in this part, and such changes can be imported back to Codebeamer.
• The description part of the issue. This is editable, contains rich content like images and optionally the comments made earlier on this issue.
All these parts are somewhat customizable in the template document, which contains blocks of scripts that controls exporting these contents. These scripts are evaluated for each issue, and the result is inserted to the export document.
Customizing the Name part of issues
The Name part is the first part which exports the name of the issue. The content of this is a HTML markup, which is generated by the Velocity
template which can be found in the default template document as shown here:
template which can be found in the default template document as shown here:
So to customize the content or look of you will need to modify the Velocity template here. The output should be a valid html fragment - without the HTML body or head, that is added automatically.
The Velocity script can access the same variables as other scripts, plus these:
variable name | type | description |
|---|---|---|
describable | com.intland.codebeamer.persistence.dto.TrackerItemDto | The issue being exported |
requirementId | com.intland.codebeamer.persistence.dto.base.ReleaseId | The sequence number of the exported issue like "3.2" |
Customizing read-only properties of issues
The next part that will be added for each issue is the read-only properties. The content of this part also is a HTML markup generated by a Velocity template. That template is embedded into the default template document as visible here:
The default Velocity script produces HTML tables for the downstream and upstream associations of the issue, and the downstream and upstream references of the issue.
Customizing editable properties of issues
This is the next part which contains the editable properties of each issue. Unlike other parts this is implemented as a native Word table and using Word's own Content Control elements.
What happens during the export here that the exporter will look for any Content Control elements inside this table. The "Tag" property of the found Content Control elements are then used as an groovy expression, and evaluated on the current issue, and the result is inserted to the table. If the property is not available on the issue (for example the Tracker of that issue does not contain it) then the whole row of the table is removed.
If a "Drop-down" Content Control elements is found then the exporter will also insert the possible choice-values, so the export document will correctly show the options. As an example this screenshot shows how is the Priority of issues can be configured. First click on the "Priority" Content Control inside Word, and then the "Properties" button on the "Developer" tab, which opens up the dialog to customize this field. The "Tag" value of this drop-down now contains "editable:Priority". The "editable:" prefix makes this field editable in the export, and the "Priority" is the field name on the "issue" being exported:
(Hint: the "Developer" tab is not visible in Word by default, but can be turned on as described here)
)Customizing description of issues
For each issue the Description also is exported using a HTML fragment, which is generated by a Velocity template. This template is found and customizable here:
