A playbook is built on triggers and actions/flows. Once it is triggered, the playbook moves along the actions to a final resolution. The flow of control executes from left to right beginning with a defined trigger (yellow box) as the first component, which is mandatory. It then moves to the second component that can be a set of defined actions Siemplify must perform (blue box). The last component involves determining the flow of the playbook with an “If then… or else” condition (purple box).
A screenshot of the Playbook page with the Monitoring screen opened is displayed below.
At the top segment of the playbook details pane, you can use the vertical toggling button to enable or disable the playbook. In addition, you can view a summary of the playbook that includes the playbook name, name of the user who created the playbook, playbook creation timestamp, name of the environment for which the playbook was created and a brief description of the playbook.
The following actions are available at the top left of the Playbooks screen.
From right to left:
- Plus
: Add a new Playbook or Block. Here you can choose which folder and which environment the Playbook/Block belongs to.
- Edit
: Allows you to select single or multiple Playbooks and Blocks for use with the Action menu detailed below. Note that to edit the folder name, you need to click on the Edit icon, and put your mouse on the name, click and then type new name.
- New Folder
: Adds new folder. The folder will appear at the end of the queue.
- Menu
: Before clicking on the menu to perform bulk actions, make sure to click Edit and select the required Playbooks/Blocks. Clicking on the Menu opens up the following actions:
- Duplicate Click to create a duplicate Playbook with the following options:
- Keep or Change Priority
- Keep in same folder or move to a different folder
- Choose environments it belongs to. Options include single or multiple environments or all environments where “all” means all currently defined environments as well as environments that will be defined in the future.
- For a single Playbook only, you can choose to save it as a Playbook block.
- Priority Click to change priority.
- Export/Import Useful for sending both Playbooks and Playbook blocks from staging to production server and vice versa. Note that the system only recognizes zip files for import. (Note that you can import playbooks without clicking on the Edit icon).
- Move To Can move Playbooks/Blocks to another folder or even create a new folder from this option.
- Delete Delete Playbooks/Blocks.
- Filter
: Clicking on the Filter opens up the following dialog box where you can choose to filter the display based on:
- Active/Inactive Playbooks – also referred to as Enabled/Disabled
- Priority Level
- Environments (multi-select option)
In the Playbook designer, on the top main part and right of the screen, you can perform the following actions:
- Toggle to enable the Playbook
- Edit Playbook title
- Add Playbook description
- Select Priority for Playbook
- See other Playbooks using this block (if on a Playbook block page)
Download a visual image of the Playbook/Playbook block
- Version Control - Click to see the following options:
- Save as New Version - Click to save the playbook as a new version, add your comments, then click Save.
- View Version History - Click to see the version history of the playbook in a tabular form. Click Restore to revert to any of the previous versions anytime. This is only available if you have clicked Save as New Version on a Playbook.
At times, you may not be able to see the entire playbook in case of multiple actions and flows defined for the playbook. In this case, you can:
- Use the mini map at the bottom right for easier navigation
- Use the mouse scroll wheel for zoom in or zoom out of the playbook view.
- Click the Fit to Screen icon at the top-left corner of the middle pane to fit the entire playbook to the screen.
- Hide the left pane by clicking the arrow located in between the left pane and the right pane.
For more information, refer to:
Actions
Using Expression Builder
Triggers
Flow
Playbook Blocks
Playbook Monitoring
Playbook Simulator
Playbook Navigator
Need more help with this?
Click here to open a Support ticket