Playbook Details
Enter the following details in Playbook Details to configure the playbook:
Name: Enter a unique name for the playbook. For example, Block Indicators using CTIX. You can enter a maximum of 200 characters.
Note
Starting from Orchestrate Next Gen v3.12.8, you can generate a playbook name using Quarterback AI. Click the Generate Name with Quarterback AI icon to automatically create a playbook name. Quarterback AI analyzes the workflow logic and nodes to provide a relevant playbook name.
To use this feature, ensure you have configured the OpenAI app and instance in Apps > Appstore. The default instance of the app will be used to generate the title. For more information, see Install and Configure the OpenAI App.
Status: Set the status of the Playbook as either active or inactive. To execute Playbook automatically based on a cron schedule or the occurrence of an event, Playbook must be in an active state. By default, the Playbooks are in an active state.
Description: Add a description for the playbook. It is recommended to add a relevant description for the playbook, as analysts can use this for their reference. You can enter a maximum of 500 characters.
Note
Starting from Orchestrate Next Gen v3.12.8, you can generate a playbook description using Quarterback AI. Click the Generate Description with Quarterback AI icon to automatically create a description based on the nodes included in the playbook. Quarterback AI analyzes the workflow logic and nodes to provide a relevant description.
To use this feature, ensure you have configured the OpenAI app and instance in Apps > Appstore. The default instance of the app will be used to generate the title. For more information, see Install and Configure the OpenAI App.
Labels: Select one or more labels to automatically trigger the execution of a Playbook on the occurrence of an event. For more information, see Labels, Triggers, and Events.
Tags: Select one or more tags to define role-based access control (RBAC) for Playbooks. For more information, see Create Playbook Tags.
Execution Timeout: Configure the total time to wait for the playbook to complete its execution before it terminates. This includes the time for which the playbook is paused for user input. By default, this option is disabled. You can specify the execution timeout in the range of 5 to 90 minutes in HH:MM:SS format. For example, 00:05:00 indicates 5 minutes.
Schedule Playbooks: You can schedule a Playbook to run on a once, daily, weekly, or monthly schedule using the date and time picker. You can also use cron expressions to schedule a Playbook. For more information, see Schedule Playbooks.
Output Parameters: Playbook output parameters help analysts send the execution result of a sub-Playbook to the master Playbook. The master Playbook can utilize the received output parameter to build complex orchestration workflows.
Associated Playbooks: View the master playbook and the associated sub-playbooks.
App & Action: View the associated app actions used in the Playbook.
After configuring and saving the playbook overview, you must define the sequence of your playbook workflow by adding an action, condition, input, or memory node as per your use case.