Creating Documentation in the Factory

Not available in Factory Lite license.

In the Flow Summary, by clicking on the Documentation tab, you can create documentation for each individual task and/or for the flow as a whole, to make it easier to use and understand.

This documentation can be exported as a .pdf file.

The Documentation tab is made of three buttons:

  1. The Add comment to flow button, which allows to write additional notes on the flow and to format them.

  2. The Export documentation button, which allows to export the documentation and to save it on the sources available.

  3. The Search button, which allows to look for specific tasks and their corresponding in the list.

Prerequisites

Procedure

  1. Click the Documentation button in the Flow summary.

  2. Click Add comment to flow and add information to the documentation. (optional)

  3. Then, click Export documentation to export the documentation to an available source.

  4. Set the Export Parameters listed in the table below.

  5. Click Export to export the documentation.

  6. Click Cancel to cancel the operation.

Export Parameter Name

Description

Source

Choose whether you want to use a Custom or a Saved source, then choose the filesystem you need.

Insert desired documentation name

Write the desired exported file name.

Autofill empty spaces

Choose among the following options:

  • None: no empty spaces will be filled.

  • Only flow: each task of the flow will have a summary, which will be generated automatically, of the operations performed in it.

  • Both flows and modules: along with the automatic flow documentation, automatic documentation on modules will be provided.

The exported documentation contains also the parent/child relationship between tasks.

Search