Organizing Playbook in the Canvas
the playbook canvas is where you build and edit flows visually use the tool panel, edit menu , multi select, and drag and drop to add actions, connect steps, disable nodes for testing, and group actions into components see components https //app archbee com/docs/wdlpsa7glls1ghfgxbo9d/c7ipcs5ndr9sgu4z6pjs0 for component details and the new component dialog canvas tool panel the canvas includes a floating tool panel in the top left corner that provides quick access to commonly used actions while building and editing playbooks this panel stays visible as you work, allowing you to easily interact with the canvas without navigating away tool panel options the tool panel includes the following options the screenshot above may not show add annotation if it was captured before that control shipped use the table below for the current tool panel option description build with hero ai opens the hero ai panel in playbook building mode use natural language to create or modify flows see create and modify playbooks with hero ai https //docs swimlane com/create and modify playbooks with hero ai toggle add panel opens or closes the add panel on the left side of the canvas browse and drag triggers, actions, and components into the playbook shortcut ⌘⇧a (mac) / ctrl+shift+a (windows) add annotation toggles annotation mode so you can add sticky note annotations on the canvas click the canvas to place an annotation, format text in the annotation toolbar, and use hide all annotations from the annotation or edit menu when you want a clean view annotations save with the playbook container edit menu quick actions for nodes and annotations (cut, copy, paste, disable, hide annotations, and so on) see the edit menu table below undo / redo reverse or restore canvas edits see undo and redo /#undo and redo below edit menu the edit menu provides the following quick actions for managing nodes (actions, conditions, loops, and so on) and annotations within a playbook option description shortcut cut removes the selected item and copies it to the clipboard ⌘ x copy copies the selected item ⌘ c paste pastes the copied item into the canvas ⌘ v group groups the selected action(s) into a new component (playbook canvas only) ⌘ g ungroup splits a selected component back into individual actions (when a component node is selected) ⌘ ⇧ g disable disables the selected item without deleting it ⌘ j delete removes the selected node from the canvas delete or backspace undo reverts the last action ⌘ z redo reapplies the last undone action ⌘ ⇧ z show all annotations / hide all annotations shows or hides sticky note annotations on the canvas shift y show minimap / hide minimap toggles the canvas minimap ⌘ ⇧ m some options appear only when the current selection supports them (for example group when multiple actions are selected, or ungroup when a component node is selected) undo and redo the canvas includes undo and redo buttons for quickly reversing or restoring changes undo reverses the most recent action redo reapplies the most recently undone action key details supports up to 30 undo and redo actions per session applies to all canvas changes, including drag and drop actions edit menu actions (cut, copy, paste, disable, and so on) configuration and editing steps undo and redo are only available during the current editing session once the playbook is saved, undo and redo history is cleared and cannot be used webhook trigger limitation undo and redo are not supported after generating a webhook url once you click generate url , the configuration changes are saved to the backend since undo/redo applies only to ui changes, these updates cannot be reverted configuration changes are grouped undo/redo does not track individual field changes inside the configuration panel instead all changes are grouped when you click apply a single undo will revert all configuration changes made in that session a redo will reapply them together use these controls to quickly correct mistakes or test changes while building your playbook group actions into a component group turns selected playbook actions into a reusable component without leaving the canvas for naming rules, saving, and ungrouping, see create a component from playbook actions in components https //app archbee com/docs/wdlpsa7glls1ghfgxbo9d/c7ipcs5ndr9sgu4z6pjs0 in a single flow, hold shift and drag across the canvas to select a region that includes the actions you want multi selection works within one flow only — you cannot select nodes across flows open the canvas edit menu and click group , or press ⌘ g (mac) / ctrl+g (windows) in the new component dialog, enter a name and click save group is disabled when nothing is selected, when the selection includes a trigger or flow header, or when the selection cannot be componentized to split an existing component back into steps, select the component node and use ungroup from the edit menu (or press ⌘⇧g / ctrl+shift+g ) add panel content library when the add panel is open, the actions , components , and ai agents tabs include a content library icon beside the search box the triggers tab does not include this icon open the add panel from the canvas tool panel ( toggle add panel ) select the tab for the item type you want ( actions , components , or ai agents ) click the content library icon (library icon) next to search the swimlane content dialog opens so you can browse and install connectors, components, or other content without leaving the canvas editor after installation, return to the add panel and search or filter to drag the new item onto the canvas for more about swimlane content, see swimlane content https //docs swimlane com/swimlane content and components https //docs swimlane com/components node toolbar (right click options) when you select or right click a node on the canvas (such as an action, trigger, or component), a horizontal toolbar appears above the selected item this toolbar provides quick access to common actions use more options to open the full edit menu toolbar options option description disable / enable toggles the node on or off without deleting it edit opens the node details panel on the right side of the canvas configure opens the configuration panel for inputs, outputs, and other settings expand / collapse expands or collapses a component node on the canvas (component nodes only) ungroup splits a component back into individual actions (component nodes only) open in editor opens the component in the component builder (component nodes only) delete removes the selected node from the canvas more options opens the full edit menu (cut, copy, paste, group , ungroup , and so on) behavior the toolbar appears only when a node is selected or right clicked disable option changes to enable when a node is disabled to enable it again, click enable disabling an action prevents it from running when the playbook is executed the action remains in the canvas but is skipped during execution this is useful for testing and debugging specific parts of your playbook when an action is disabled, a “disabled” label appears at the top of the action configure opens the configuration panel where you can edit inputs, outputs, and other settings edit opens the details panel on the right side of the canvas trigger nodes show edit and configure only (no disable on the floating toolbar) flow options each flow in a playbook includes a three dot menu in the top right corner that provides options for managing the flow flow menu options option description move left moves the flow one position to the left move right moves the flow one position to the right edit opens the flow details panel to update name, description, and settings disable / enable disables or enables the flow without deleting it delete removes the flow from the playbook behavior reordering flows use move left or move right button to rearrange flows within the playbook disable / enable flow you can disable entire flows in a playbook to temporarily exclude them from execution when a flow is disabled, a “disabled” label appears at the top of the flow the disable option changes to enable click enable to restore the flow edit flow opens the flow details panel allows you to update the flow name and description includes an option to enable or disable the flow cut, copy, and paste you can use cut, copy, and paste to quickly duplicate or move nodes and flows within the canvas basic actions action description shortcut cut removes the selected node(s) and copies them ⌘ x copy copies the selected node(s) ⌘ c paste pastes copied node(s) into the canvas ⌘ v how to paste right click on the + (plus) icon at the open end of a node in a flow select paste to insert the copied content multi selection you can select and work with multiple nodes within a flow at the same time select multiple nodes hold down the shift key click and drag across the canvas to select a region all nodes within the selected area will be selected behavior multi selection works within a single flow only you cannot select nodes across multiple flows at once each node is treated independently, even if connected to others you can perform actions (copy, cut, disable, group , and so on) on selected nodes clicking a single node without holding shift clears the region selection copying between flows you can copy nodes from one flow and paste them into another flow pasting at the end (+ icon) adds the nodes to the flow you can paste partial sections of a flow, including connected nodes overwriting content if you paste onto an existing action node, it will replace (override) that node with the copied action if you paste an entire flow onto another flow, you will see a prompt “overwrite flow” options overwrite or cancel edge placements you can paste copied nodes at the edge (end) of another flow the structure is preserved as much as possible if you copy only part of a flow, some actions may depend on other actions that were not included in your selection in this case, you may see the following warning “paste warning some actions contain references to actions that were not included in the selection those references have been marked as deleted ” when copying a loop or parallel node, you only need to select and copy the top (parent) branch all associated child nodes within that structure are automatically included in the copy review the pasted nodes to ensure they still work as expected canvas navigation you can zoom and move around the canvas to better view and work with your playbooks zoom in and out use the zoom controls (+ / –) at the bottom of the canvas you can also zoom using your touchpad by pinching (two finger swipe) this helps you focus on specific parts of your playbook or view the overall structure move around the canvas (pan) click and drag on an empty area of the canvas to move around you can reposition your view up, down, left, or right flows move together within the canvas as you navigate this allows you to manage space and work with large playbooks more easily annotations annotations allow you to document the purpose, reasoning, and expected outcomes of actions and workflows directly on the canvas annotations are intended for documentation and knowledge sharing and are not tied to a specific user add an annotation in the canvas tool panel, click add annotation the cursor changes to an annotation icon click anywhere on the canvas to place the annotation enter your annotation text press enter to save the annotation press shift + enter to add a new line within the annotation annotation editor each annotation includes an editor toolbar with the following options option description bold format selected text as bold italic format selected text as italic underline underline selected text bulleted list create a bulleted list numbered list create a numbered list link insert a hyperlink code block format text as code delete remove the annotation more options opens additional actions the more options menu includes cut copy paste delete hide annotation move and resize annotations click and drag an annotation to reposition it anywhere on the canvas drag the resize handle in the lower right corner to resize the annotation annotations can be resized up to 500 px wide and 300 px high scrollbars are available when annotation content exceeds the visible area hide and show annotations you can temporarily hide annotations without deleting them to hide or show all annotations press shift + y , or open the edit menu and select hide all annotations selecting the option again restores all hidden annotations annotation behaviour annotations are automatically associated with the nearest node on the canvas if the associated node is deleted, the annotation is automatically reassigned to the next nearest node annotations scale together with the canvas when zooming in or out annotation creation, editing, deletion, movement, and resizing support undo and redo copy, paste, and grouping behaviour annotations can be copied and pasted when they are included in the selected content if an annotation is grouped with the nodes being copied, the annotation is copied and pasted with the selection if an annotation is not included in the selection, it is not copied or pasted when creating a component from a grouped selection, included annotations are added to the component annotations are intended for documentation and are not comments annotations are not associated with specific users component annotations are only visible when the component is opened directly they are not displayed when the component is used within a playbook rich text support is limited to basic formatting options images, custom fonts, font colours, text alignment, and background formatting are not supported testing and run behaviour when running or testing a playbook disabled actions are skipped automatically in test data , disabled actions are marked with a disabled status (alongside statuses like success or failed) in runs , you will see a message “this action was skipped because it was disabled ”