This functionality is available on Codebeamer 2.1 or newer versions.
Introduction
Export a tracker item is a workflow action that exports the tracker item to Microsoft Word or Excel during a state transition. You can set up this action at the tracker level in a Codebeamer project.
Configuration
To set up the Export a tracker item workflow action in a tracker, follow these steps:
- Click
▶ Configure, and then click the State Transitions tab.
- Click the name of the state transition where you want to add the Export a tracker item action. The State Transition window opens.
- Click Actions ▶ Export a tracker item. Codebeamer displays the Export a tracker item window.
- Select the type of export using the Type of export list. The following options are available:
- Simple Word Export—Exports the tracker item to Word. For more information about this type of export, see
Word Templates in CB 9.3 and higher.
- Simple Excel Export—Exports the tracker item to Excel. For more information about this type of export, see
Excel Templates.
- roundtripWordExport—Starts a Word round trip for the tracker item. For more information about this type of export, see
Word Round-trip.
- roundtripExcelExport—Starts an Excel round trip for the tracker item. For more information about this type of export, see
Excel Round-trip and Excel import.
For details about the supported options for each export operation, see
Options for the Type of Export.
- Click OK to save the changes.
- After saving,
appears in the Actions column of the state transition where you added the Export a tracker item action.
Options for the Type of Export
Codebeamer displays different options based on the value that you choose in the Type of export field. For details, see the following table:
Option |
Description |
Condition |
Sets the condition to execute the workflow action. For more information, see Workflow Actions. |
Generate absolute links to Codebeamer |
When set to true, the links to the Codebeamer resources point to the Codebeamer instance where the export was initiated.
When unset, or set to false, the links to the Codebeamer resources in the exported document become internal links that point to bookmarks inside the document. This is useful to work on the document offline when the Codebeamer instance is not accessible.
For more information, see Word Templates in CB 9.3 and higher.
This option is not available when you select Simple Excel Export in the Type of export field. |
Convert to PDF |
When set to true, the document is exported and converted to PDF.
For more information, see Word Templates in CB 9.3 and higher.
This option is not available when you select Simple Excel Export in the Type of export field. |
Paragraph numbering |
Allows the selection of paragraph numbering, by using the following options:
• Keep original paragraph numbers
• Always start paragraph numbers with 1
• Remove paragraph numbers
This option is not available when you select Simple Excel Export in the Type of export field. |
Configuration item |
Selects a tracker item here whose fields will be used as replacements for placeholders in the template.
This option is not available when you select Simple Excel Export in the Type of export field. |
Filename prefix |
Sets the prefix of the exported document. |
Use template |
Selects a template for the export.
For more information, see Word and Excel Templates. |
Comment |
Adds a comment or a description for this action. |
Export description |
When set to true, the Description field of the tracker item is exported.
This option is not available when you select Simple Word Export in the Type of export field. |
Multi-values go to multiple rows |
When set to true, each value of a choice field is exported in a separate row.
This option is not available when you select Simple Word Export in the Type of export field. |
Export Dates in your Time-zone |
When set to true, the values of date fields are exported with the time zone of the user initiating the export.
When unset, or set to false, the values of date fields are exported with the time zone of the Codebeamer server.
This option is not available when you select Simple Word Export in the Type of export field. |
Operation
When performing the state transition configured for the Export a tracker item workflow action, Codebeamer exports the item to Word or Excel. When the export completes successfully, a notification appears in the lower-right area of the page. By clicking the file name in the notification, you can download the document.