ORCANOS Docgen for Document Generation

OVERVIEW

The Docgen addon (Desktop EXE) allows generating HTML, PDF or Word documents from ORCANOS database.

Docgen Installation

In order to install add-in:

1.  Goto Admin

2.  Click on “ORCANOS Docgen Setup” link under “Apps & Add-Ons

3.  A setup file is downloaded. It is recommended to run setup using “Run as administrator” option.

4.  ORCANOS Docgen is installed on ~\program files (x86)\QPackClient\QPackDocGen.exe

5.  Run (sometimes it is also required to run ORCANOSDocGen.exe as administrator)

6.  A settings screen opens. Fill in the following details:

connection_settings

  • Server name: cloud.orcanos.com
  • Check the “Use different IIS directory” checkbox and put the account name (appears in your account url, for example https://cloud.orcanos.com/orcanos/web – you need to put orcanos)
  • Check the option “Use HTTPS
  • Click “Save“. Screen should be filled with connection details
  • Click Close

7.  Docgen screen opens. Now you can connect and generate documents

Login

Input your ORCANOS credentials and select the project/solution from which you wish to generate your document

 

The main screen shown. Now you can setup docgen properties

2016-05-16_23-42-36

NOTE: In case no prior installation of ORCANOS | Desktop was made on the target client the user must configure the Server Settings from the Advanced link in the login screen 

Main Screen

docgen_main_screen

Main Menu: Document

  • Open Private/Open Public: Allows user to open a pre-saved Docgen template (properties), either private or public and use it for generating the document
  • Save – save existing Docgen template
  • Save As – save current set or properties in a new name
  • Rename – renames a template name
  • Delete – deletes template
  • Generate – Generates the selected document

General Tab

General Tab – Front page section

  • Title – set document title appears on the first page
  • Description – set HTML description for the generated document, appears in the first page

General Tab – Filter section

  • By Type – select work items will be generated
  • By Filter – Select a specific filter. Only items retrieved by the selected filter will be generated

General Tab – Source

  • This option opens the project tree. Select the Root Work item to generate. The root item and its descendants will be printed in hierarchic/flat manner, based on the Docgen settings.
  • Revision – Select to print from specific tag (baseline) of the selected root item
  • Save copy as attachment to item – The generated document will be added as an attachment to the root item (source)
  • Include root item in TOC – include/exclude the root item from Docgen

General Tab – Print Mode

  • Print Descendants – print the descendants. if not checked – descendants will not be generated
  • Flat/ Hierarchic – Items will be printed at same level, or hierarchic
  • Depth Level – select the hierarchic level (limited to  7)
  • Print as form – usually used for forms such as CAP, ECO, etc. Generate the description and parse the dynamic fields to the work item value. Only source item is printed, not descendants

General Tab- Template

The default is report.dot. You can upload different templates and use them when you generate the document.

Please note: ORCANOS doesn’t save the templates names (.dotx/.dot), so you need to manually type it. report.dot must exist on server

There are 2 buttons: Upload and Download – to upload new template to server or download template from server if you wish to change it

Document Properties Tab

Document Properties tab – “Output Document Type” section

  • Select generated file format: HTML, MS-Word or PDF

Document Properties tab – “Format And Styling” section

  • Autofit to content – table size will be submitted to content size
  • Autofit to window – table size will be submitted to page size
  • Adjust tables images – Resize images within tables so images don’t exceed table border
  • Enable sync from Word Addin – Add bookmarks for ORCANOS work items. Not in use for this version. Will be supported in the future
  • Generate for edit (protected mode) – allows editing only work item description and name for syncing back with ORCANOS. Not supported in this release, will be supported in the future
  • Print item key on header – Print item key at the end of the header
    • Don’t print paragraph key – Print item key on header option will exclude paragraph work items
  • Print test case last run details – if a test case work item is generated – add last run details at the end of the test case description. User can select the columns to print (Last run status, Last run version, Last run by, Last run date)
    • Print steps – adds the steps table  at the end of test case description (description, Expected results)
      • Print steps run details (historical) – User can select the columns of step last run details to be included in the steps table (Last run actual results, last run status, last run version, last run by, last run date, last run defect ID)
    • Don’t print data – the selected columns of last run details will be empty (sometimes the test document has to be filled manually)
  • Item description font – select font properties for the work item description section
  • Clear web styling – use this option if your generated document has styling issues
  • Don’t print relation type – use on the traceability section – add the link type to the generated traceability table
  • Include audit trail – get the data from the item history of all generated items and include it at the beginning of a document. Select the dates from which you wish to include audit trail, and provide title to the audit trail section
  • Include attachments – add a table of attachments for each generated work item
    • Add attachment URL – Set attachment name as URL
  • Include table of content – add TOC at the beginning of the document
    • TOC Depth – set the hierarchy level of the TOC
  • Space between paragraphs – the line spaces to add after each generated work items
  • Disable spell check – in huge file, if spellcheck is on – it might take a while to generate the document. use this option to reduce generation time
  • Adjust table images – resize images in generated tables to fit cell size
  • Document creation buffer – for big documents, sometimes need to adjust this value when generating the document. Default should be all
  • Word copy time interval – if some work items are not generated correctly – adjust the time interval between generated work items
  • Use only item description HTML – when item is edited in Word, Docgen will take the Word version to generate. This option forces Dcogen to take only HTML version of work item description.

Properties Tab – Orientation

  • Landscape/Portrait

Properties tab – section direction

  • None/ Right to left/ Left to right

Buttons

  • Generate – generate the document
  • Save – save current properties to a template
  • Save as – save current Docgen properties as a new template
  • Cancel – cancels the document generation

Related articles: Generate RMF (Risk Management File)

 

Leave A Comment?

You must be logged in to post a comment.