Skip to main content

Workflow Metadata

The Documentation dialog displays the following data about a workflow:

Workflow Designer Documentation

Accessing the Documentation Dialog

To access metadata:

  • Click the three-dot menu and select Documentation on the workflow tab.

Reviewing Description and Information Text

The top of the Documentation dialog displays:

  • Description: A summary of the workflow's purpose and use cases.
  • Information: Additional HTML-formatted content.

To edit these fields:

  1. Click in the Information section.
  2. Enter or update text using the formatting toolbar.
  3. Click OK to save changes.

Managing Tags

Tags help categorize workflows and improve searchability.

  • Add or delete tags directly in the Documentation dialog.

Workflow Designer Documentation_3.png

For details on creating tags, see Adding New Tags.

Click OK to save your changes after editing tags.

Viewing Notes

Notes provide context or instructions for specific activities in a workflow.

In the Documentation dialog:

  • The Notes section lists all notes in the workflow.
  • A counter next to the title shows the number of notes.
  • The grid lists:
    • Activities that contain notes (in workflow order).
    • The content of each note.