Workflow auto documentation

This recipe will showcase the automatic documentation ability of Orchestrator. We will learn what Orchestrator documents and how it documents workflows.

Getting ready

We need at least one workflow for this recipe that we can document. A good example workflow would be one that contains other workflows, actions, and scriptable tasks.

How to do it...

  1. Right-click on a workflow or a folder and select Generate Documentation.
  2. Select a directory and give the file a name.

A PDF with the documentation is now created.

How it works...

The documentation that is created isn't that flashy, but it is quite useful. The created PDF document contains the following sections:

Section

Description

Versions

This is a summary of all existing versions this workflow has, including the create date, create user, and any comments you have made regarding this version.

Inputs

This contains a list of all the in-parameters of the workflow as well as their type and description.

Outputs

This contains a list of all out-parameters of the workflow as well as their type and description.

Attributes

This contains a list of all attributes of the workflow as well as their type and description. It does not contain any values.

Parameter presentation

This shows all properties of all in-parameters that are defined in the presentation of this workflow.

Workflow schema

This is a picture of the workflow that shows the elements of the schema.

Workflow items

This is a tabular overview of all existing elements in the workflow schema.

Source code for the used actions

This lists every script that was used in an action, scriptable task, log element, and so on.

If you are running the documentation feature from a folder, each workflow in this folder will be documented.

..................Content has been hidden....................

You can't read the all page of ebook, please click here login for view all page.
Reset