View Source

Table of contents

Generate Report

In Blueriq it is possible to generate Studio project documentation using the function 'Generate report'.

How

The function 'Generate report' can be found in Studio under your File tab.

Steps

Go to File > Generate report (if you are working in a project close the project first)
Select plugin 'Document Generation Plugin'
Select a revision (optional)
Click Next
Select a project
(De)select Modules, Elements and/or Include Global Elements
Click Generate
Click Save

Steps 1 - 4:

Blueriq 14 Documentation > Generate documentation > Step1-4.png

Step 5:

Blueriq 14 Documentation > Generate documentation > Step5.png

Step 6 - 7:

Blueriq 14 Documentation > Generate documentation > Step6.png

Step 8:

Blueriq 14 Documentation > Generate documentation > Step7.png

Result

When the download is completed you can save the ZIP file containing the generated documents.

Options

Option	Description
Modules	The modules that are being documented.
Document process module in DCM style	Document the process module in DCM style.
Select root process	Only visible if 'Visual representation of processes' is selected. The main process of which the DCM processes are being documented hierarchically.
Depth of hierarchy	Only visible if 'Visual representation of processes' is selected. Represents how many subprocesses of the selected root process will be be generated.
Dcm Implementation module	The module that contains the logic for the process control. Blueriq will search for decision tables to include in the process documentation as precondition of processes and tasks.
Visual representation of process	When this option is selected, an html page containing an overview of the phases (based on the root process), activities (tasks), roles, and milestones is generated.
Elements	Selection of the elements that will be included in the documentation. If 'Processes' is not selected, the processes will not be documented, and therefore configuration for 'Select root process' en 'Depth of hierarchy' will not have effect.
Include Global Elements	Documentation for Global Elements will be generated when this option is selected.

Q & A

Q: How long does it take to generation our documentation?

A: If you have a large project the generation of your documents can take some time. You can also shorten the list of Modules and Elements to speed up the document generation.

Q: The standard report is not sufficient for my project. Can I build a custom report?

A: You can develop a custom plugin for Studio that generates a report tailored to your projects needs.