Tags: Export Word Word export Workflow Action

Export to Word Workflow Action

This page describes the operation of the Export to Word workflow action.

Introduction

Since Codebeamer release 2.1 (IMPALA), the tracker items of a tracker can be exported to Microsoft Word documents if a specific item status change defined in the tracker configuration is completed. The set configuration is applied on tracker level.

The generated .docx documents are stored in document type trackers.

Prerequisite

At least one documentation type tracker must exist in Codebeamer for the usage of the Export to Word workflow action.

Configuration

To set up the Export to Word workflow action,

Select the relevant tracker and click the top left context menu > Configuration > State Transitions tab.
Find the relevant state transition, click the context menu in the Actions column and click Edit.
On the State Transition overlay, click the Actions drop-down list > Export to Word option.
The New Action: Export to Word overlay is displayed where the relevant details need be provided.
Once all the details are provided, click OK, and click Save on the State Transitions tab.

Field Descriptions

The below table lists and describes the fields of the New Action: Export to Word overlay.

Field	Description
Condition	Optional. Set any relevant condition for the workflow action.
Source	Select the source item to be exported to word. Options: Current item Current item and its children Report - Click the pencil icon to select the relevant report. Traceability reports are not supported.
Filename	Add a file name for the generated, exported document. The generated file names get the .docx extension. Invalid characters, such as / : * > \| or space, in the file names are replaced with an underscore (_). The name of the generated file is limited to 255 characters.
Target	Select a document type tracker in which the generated file is to be stored. In the left side selector, select the document type tracker that can be either the default or a custom document type tracker created by the user. In the right side selector, select the relevant folder of the previously selected documentation type tracker to store the generated file. The root folder is selected by default, other folders of the tracker are loaded into the selector in a tree structure. In case documentation type trackers are not available within Codebeamer, neither the trackers and folders can be set in the selectors, nor the Export to Word workflow action can be saved.
New version	If set to True, each time the defined status change is completed, a new version of the file is created with a timestamp appended to the file name. If set to False, the existing file is overwritten upon each export. Click OK to save your selection. Click the value to edit.
Word template	Select the Word template to be used for the export.
Comment	Optional. Any relevant comment can be provided.

Operation

Performing the status change configured for the Export to Word workflow action triggers the file export by starting a background job.

Once the background job is finished, clicking the name of the exported .docx file on the green pop-up notification, displayed on the bottom right of the screen, opens the documentation type tracker defined previously in the workflow action configuration overlay.

To download the exported file, click the file name in the Document field.

[!exportedDocument.jpg#0dfe8c65db28f3c2001e1d07646cc7a0!]

Edit the Configuration

Previously configured Export to Word workflow actions can be edited. To make any changes,

Find the relevant state transition and click the value in the Name column to open the State Transitions overlay.
In the Actions field, the following editing options are available:
- Export to Word - Click to update the workflow action in an in-line editor on the State Transitions overlay.
- Edit - Click to update the workflow action on the Edit Action: Export to Word overlay.
- Delete - Click to delete the previously configured Export to Word workflow action.
  When deleting an Export to Word workflow action, the following message is displayed: Do you really want to delete this action?
  Click OK to confirm.
Click OK on both overlays, and save the configuration changes.

[!editExportWFA.jpg#1186e9a0ca639122b842590eabf0ac9b!]