Playbooks Tasks User Documentation
| Purpose | Learn about the playbook tasks overview, its various components, and the information provided to help you better understand the flow of a playbook. |
|---|
| Created | July 22, 2024 |
|---|
What is the Playbook Tasks overview
The tasks overview in the playbook allows the users to gain insight on the information that goes round the playbook’s tasks and nodes. It provides information on each stage of the process so the progress can be observed, the data that is being processed can be reviewed, and possible problems or delays can be seen. This overview assists in guaranteeing that the users are in a position to handle and coordinate the work within the playbook optimally.
Accesing Tasks overview
There are two ways to access the task overview of the playbooks:
Main Interface Access
Open the main interface of the Playbook app, here you will see all the playbooks created before that you have permissions to view. Every playbook contains a button in the form of three dots at the right corner at the top of the page. By clicking this button the option to navigate to the tasks overview will appear.
Direct URL Access
Open the desired playbook.
In the URL, append /tasks after the playbook ID as shown below:
https://raven.dtact.com/playbook/{PLAYBOOK_ID}/tasks
Using either of the methods, you can quickly switch to the task overview to get more information about the tasks and nodes in the playbook. This makes it easier for you to be able to manage and optimize your work flows.
Tasks overview
Once inside the tasks overview, we will be able to see all tasks, including:
Task: The task ID.Node: Where the task is running.Status: Indicates whether the task ran successfully or if there is an error to check.Run at: The time when the task was run.Created at: The time when the task was created.
By clicking on the three-dotted button at the far right of each task, an option to run the task again will be provided.
Inside a Task
Once a specific task is selected, a new window will open, displaying the progress of the selected task, including its subtasks.
Within this window, each task node will provide detailed information such as:
Session: Information about the session in which the task is running.Data Configuration: Configuration details related to the data being used in the task.Input Variables: Variables that are input into the task.Output Variables: Variables that are output from the task.
For more information about the output variables of specific bricks, refer to the documentation of the respective brick.
Events Created: Any events that have been created as a result of the task.
You can see what a variable is by hovering over the icon or clicking on it. Input variables or events are characterized by an upward arrow, while output variables or events are marked by a downward arrow.
The Playbook task overview is extremely useful for debugging, as it precisely shows where the error is occurring.
If you run into any errors, just hover over the icon on the far right. It will give you a description of the issue, making it easier to understand and find a solution.