Online Document Generator (Export to Word document)

OVERVIEW

Orcanos DocGen allows you to export your Design Control documents from the product tree into a Word document.

This feature includes exporting documents like your Software Requirement Specification. The resulting Word document will have a table of contents that reflects your project’s hierarchical structure.

You have the option to use custom Word templates (.Dotx files) and can incorporate dynamic filters into the generated document.

For further information on how to manage your design control documents, please watch the accompanying video.

HOW TO GENERATE DOCUMENT

Select a document in your Product Tree
Right-click and select “Import/Export ->Export To Word Document“
In the DocGen configuration interface, you can create a preset layout for your generated document.

To create a document, press the ‘Generate’ button. This will bring up a progress bar in the top right corner, indicating the download status of the document.

User can acess the Orcanos Docgen Log File to track the status of document generation.

See a quick walkthrough here:

CONFIGURATION

Docgen Configuration: this is a list of saved layouts (configurations) of your exported document
- Choose a predefined configuration for generation.
- Save modifications to the existing configuration by clicking ‘Save’.
- Create a new configuration by selecting the ‘Save As’ button.
Word Template (.dotx) – Select Word template or upload your template.

Important: The .dotx file requires Headings 1 through 8. It’s strongly advised to download the system’s default.dotx file and customize it to match your preferences.

DOCUMENT GENERATOR DETAILS

Item – Displays the chosen item in the product tree, which will ve the root of your exported document.
Revision – Select a previously created tag (snapshot from history), the default is Head (Current).
Work Items – Select the work items type you wish to include in the generated document
Print Levels – Select the hierarchic heading level (1-8)

STYLING

Override Item Description Font – Select a font to override existing paragraph’s font
- Font: Allow setting Item Description Font Family
- Font Size: Allows setting Item Description minimum font size of 5px
Space between Paragraphs – Space between each printed work item like 1,2,3,4,5,6,12,18,24 etc.
Orientation – Portrait/Landscape
Section direction – RTL/LTR, default is LTR
Allow Row to Break Across Pages – Insert page breaks in the generated file

DYNAMIC TABLE SETTINGS

Dynamic Table Header Font – Allow setting Table header Font Family
Dynamic Table Header Font Size – Allow user to set the minimum font size of 5px of the dynamic table header
Dynamic Table Font – Allow setting Table content Font Family
Dynamic Table Font Size – Allow user to set the minimum font size of 5px of the dynamic table content

ADDITIONAL SETTINGS

Print Item Key On Header – Print Item key on the printed item heading (name)
Don’t Print Paragraph Key – Does not Print key for Paragraphs when checked
Include Original ID in case of the branch – Display original id of branched work item when checked
Include attachments – Print Work Item attachments
Show Download Attachment button in the Generated Document – Print download button for Attachments/URL.

TABLE OF CONTENT

Include Table of content – Add TOC at the beginning
TOC level – Set level of TOC

TEST CASES

Include Test Case Results – Print Steps of the Test Cases
Include Test Run Columns
- Last Run Status – Print last run status in the test result
- Last Run By – Print name of the person who last executed the test
- Last Run Version – Print version in which test case was last executed
- Last Run Date – Print date on which the last run has done
Execution Set – Print test case details for the selected execution set or execution set group
Include run parameters – Print run parameter info for last execution run or for the runs done in selected execution set or execution set group
Make run values empty – Does not print data in the Step settings column of Steps Result although it has data recorded.
Add An Empty Line After Steps Table: Allow to add an empty line after the test steps table, to increase readability in the generated document

Test Steps

You can adjust the size of each column in the test steps table. It’s often advisable to use Landscape mode for the test document, especially if you have images in the step descriptions and actual results.

Include Test Steps – Print steps mentioned in the test case
Steps settings:
- Include Steps: Allows the user to select only Test Steps. It displays the following fields:
  - ID – Print Step ID. Read-only
  - Description – Print Steps Description. Read-only
  - Expected Results – Print Executed Result. Read-only
  - Lower Limit – Print lower limit as mentioned in steps, enabled from Admin > System Configuration > System Settings
  - Upper Limit – Print upper limit as mentioned in steps.
- Include Steps Results: This allows the user to select to include Test Steps Results. It displays the following fields along with the above fields:
  - ID – Print Step ID. Read-only
  - Description – Print Steps Description. Read-only
  - Expected Results – Print Executed Result. Read-only
  - Lower Limit – Print Lower Limit
  - Upper Limit – Print Upper Limit
  - Actual Results – Print Actual Result
  - Defect ID – Print Defect ID of the related Test step (Available in 5.0.0.9 and above)
  - Last Run Status – Print Execution Run status
  - Last Run By – Print name of the person who executed the test
  - Last Run Version – Print Run version
  - Last Run Date – Print Run date