Workflow Control Panel

The Workflow Control Panel is your top-level view of an automation workflow. The Control Panel page includes Workflow Notes, some key workflow statistics, and access to common workflow operations. You can reach the Control Panel page for a workflow by clicking on the desired workflow on the Workflows page.

Workflow Notes

The Notes section of the Workflow Control Panel provides a space to add a description, usage instructions, comments, recommendations, and much more for your workflow. Workflow Notes are written in markdown and may be edited by clicking the pencil icon in the top-right of the Notes section for any Workflow.

How do I edit the workflow notes?

Notes can only be edited from the Workflow Control Panel page. If you are viewing the Control Panel for an active workflow, click the pencil in the top-right of the Notes section to edit. After saving your changes, select Publish Changes to push your Notes to the active workflow Control Panel view.

When you import a workflow from the Rapid7 Extension Library, the Notes field is automatically filled with the documentation present in the Extension Library. This typically includes a Description, Key Features, Requirements, Setup Instructions, Usage Instructions, Technical Details, Troubleshooting, Version History, Links, and References. Note that workflow documentation does vary and some workflows may have different sections than those mentioned above.

Where are notes saved?

Your workflow notes are saved in the Description field in the workflow. This Description is also accessible through the Workflow Builder by clicking the edit pencil in the top-left, next to the workflow name.

From the Workflow Control Panel page, you may:

  • Add or edit workflow notes
  • Activate or deactivate a workflow
  • Open workflow builder
  • Publish or discard Changes
  • Update plugins used within a workflow

Stay tuned for more updates and functionality in the Workflow Control Panel!