Associate Runbooks with Cases to provide analysts with predefined guides, ensuring consistent and thorough investigations according to your organization's standards and best practices.
Learn how to use the Case Runbook during the investigation.
Runbooks can be managed automatically using workflows, or in the centralized Runbooks page.
Manage Runbooks Automatically
Runbooks can be managed automatically in Workflows using Runbook Steps, including creating, updating and associating Runbooks with cases.
Create and Associate Runbooks
Create a Runbook:
Search for the Create a runbook Step and drag it to your Workflow to formulate a new Runbook.
In the Properties panel, give it a unique title and fill the content area with HTML, Markdown, or plain text. This content can also be dynamically sourced from external systems like Confluence or Notion, enabling you to integrate comprehensive documentation directly into your Case-management system.
Associate the Runbook with a Case:
Search for the Associate a runbook to a case Step and drag it to your Workflow. Link your newly created or existing Runbook to a Case. This makes the Runbook readily accessible within the Case's Runbook tab.
Practical examples
Practical examples
Automate Runbook Retrieval
Set up a Workflow to automatically fetch a document from external services, such as Confluence or Notion, to use as a Runbook. If a Runbook with the provided title already exists, update its content; if not, create a new Runbook using the content retrieved from the Workflow context.
Case-Specific Runbook Association
Create a Workflow to automatically associate a relevant Runbook with each new case based on the Case category. This ensures that every case is supported by appropriate guidelines right from its inception.
Manage Runbooks in the Runbooks Page
Manage Runbooks efficiently using the centralized Runbooks page. The Runbooks page gives you complete visibility into all the Runbooks available in your workspace.
Navigate to Runbooks: In the left-hand menu, go to Investigate > Runbooks.
In the Runbooks page, you can search, add a new Runbook, and open the Runbook editor to edit or delete a Runbook.
Search for the Runbook you need: Use the search bar to search by Runbook name or ID.
Add a new Runbook: Click Add Runbook to open the editor and create a new Runbook in your workspace.
Give your Runbook a title.
Type your Runbook instructions directly in the editor, or paste from elsewhere.
Edit Runbooks: Open the Runbook you want to edit and make changes directly in the editor. Click Save to confirm your changes.
Delete Runbooks: Open the Runbook you want to delete, and click the trashcan icon in the top right.
Runbook Editor
In your Runbooks page, click on a Runbook to open the editor. You can edit the Runbook title by clicking on it, and edit Runbook instructions in rich text. In the top menu bar, you can see all users currently viewing the Runbook.
Runbooks created by Workflows can be inputed in markdown, HTML or plain text, and will appear in the editor in rich text. Runbooks that are created, or edited and saved in the editor are saved as HTML.
Editing or deleting a Runbook affects every case that it is associated with. Deleting a Runbook cannot be undone. Be sure to review the impact before confirming your action.
Permissions
To access the Runbooks page, users need cm.runbook.read or cm.runbook.write permissions. Based on the permissions they have, users can:
Description | Description | Actions |
| List and view Runbooks | View and read the Runbooks' content |
| Create and update Runbooks | Create, edit, and delete Runbooks |