InsightConnect Control Panel
The Control Panel is your top-level view of an automation workflow. The Control Panel page includes Notes, some key workflow or snippet statistics, and access to common workflow or snippet operations. You can reach the Control Panel page for a specific workflow or snippet by clicking on the desired workflow or snippet on the Workflows or Snippets tab within the Workflows page.
The Notes section of the Control Panel provides a space to add a description, usage instructions, comments, recommendations, and much more for your workflow or snippet. 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 or Snippet.
How do I edit the workflow or snippet notes?
Notes can be edited from the Control Panel or Builder pages. If you are viewing the Control Panel for an active workflow or published snippet, 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 or published Control Panel view. Within the Builder, click the book icon in top bar to view and edit notes.
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 notes are saved in the Description field in the workflow or snippet. This Description is also accessible through the Builder by clicking the edit pencil in the top-left, next to the workflow or snippet name.
From the Workflow or Snippet Control Panel page, you may:
- Add or edit notes to a snippet or a workflow
- Activate or deactivate a workflow
- Open the builder
- Publish or discard Changes to a snippet or a workflow
- Select connections and update plugins used within snippet or a workflow
- Define parameters for a workflow
- View all linked workflows for a snippet
Stay tuned for more updates and functionality in the Control Panel!