​

Overview

The Playbook Editor view allows you to view, edit, create, import, export and share playbooks. It consists of four main parts:

1. The action bar that includes key actions like commenting, sharing, executing, validating and saving a playbook.
2. The canvas area where the steps and connections among steps are visualised.
3. The node panel that allows you to select and drag a step to the canvas area.
4. The control buttons panel that provide the functionality to fit view, align nodes, zoom in and out as well as pasting.

img here

​

Creating a step

Drag and drop a step from the node panel to the canvas area.

• The step properties drawer panel will automatically appear on the right side of your screen.

mini video here Edit the step properties.

• Fill in properties with the desired information.
• Mandatory fields are marked with an asterisk (*).
• Properties are automatically saved.

img here

​

Deleting a step

1. Select the node you want to delete
2. Click on the Delete option at the bottom right corner of the step

img here

3. Confirm that you want

​

Connecting steps

Once you have created a step, you can connect it to other steps. Different step types have different connection options:

• Start and playbook action steps have only on completion connections.
• End step has no connection options.
• Action steps have on completion, on success and on failure connections.
• If condition step has on completion, on true and on false connections.
• Switch condition step has on completion and cases (multiple) connections.
• Parallel step has next steps (multiple) and on completion connections.
• While condition step has on completion and on true connections.

1. Click on the source step.
   • The available connections will be displayed at the bottom of the step.
     
     img here
2. Click on the connection type tag and it will transform into a connecting line.
3. Drag to the destination step and release to connect it.
   mini video here

​

How to delete a connection

1. Select the connection.
   • Click on the connection you want to delete. The connection will be highlighted.
   • A Delete icon will appear next to the connection name.
2. Delete the connection.
   • Click on the Delete icon.
   • Confirm the deletion on the confirmation dialog that appears.
   • Alternatively, you can press the delete on your keyboard to delete the connection without confirmation.
   img here

​

How to edit step properties

1. Click on Details for the step you want to edit the properties for.
   • The step properties drawer panel will appear.
   • Alternatively, you can double click on the step.
     
     img here
2. Edit step properties.
3. Close the properties panel.
   • Click on the X button on the top left corner of the properties panel.
   • Alternatively, press the escape key on your keyboard.

​

How to edit playbook properties

Playbook properties include key metadata, like ID, name, date created and modified among others.

1. Open playbook properties.
   • Click on the playbook properties icon on the editor action bar.
     
     img here
2. Edit playbook properties.
   • Mandatory fields are marked with an asterisk (*).
3. Close the properties panel.
   • Click on the X button on the top left corner of the properties panel.
   • Alternatively, press the escape key.

​

Adding notes

description here

​

Undoing and redoing actions

description here

​

How to handle validation errors

There are two possible places where validation errors can happen:

• Playbook properties: There errors relate to the playbook metadata. The details about these errors will appear on the playbook properties panel. A counter will also appear on the playbook properties indicating the number of validation errors.
• Playbook steps: There errors concern the properties of the individual steps. The details about these errors will appear on the step properties panel. A warning message will also appear on the step node in the canvas area indicating the number of validation errors.

​

How to check for playbook properties validation errors

1. Check for error counter on the playbook properties icon.
   • If there are any errors, a red error counter will appear.
     
     img here
2. Open playbook properties panel.
3. Hover over the error message.
   • An error message in the format of “X validation errors” appears on the top right corner of the properties panel.
   • A detailed list of validation errors will appear when you hover over the warning message.
     
     mini video here

​

How to check for playbook step validation errors

1. Check if an error message appears in the step.
   • If there are any errors, a red warning message in the format “X Validation errors” will appear.
     
     img here
2. Open step properties panel.
3. Hover over the error message.
   • An error message in the format of “X Validation errors” appears on the top right corner of the properties panel.
   • A detailed list of validation errors will appear when you hover over the warning message.
     
     mini video here

​

How to validate a playbook

Although playbook steps and properties are validated continuously, you can still manually trigger validation when desired.

1. Trigger playbook validation.
   • Click on the Validate button on the editor action bar.
2. Validation errors, if any, will appear on individual steps and/or playbook properties panel.

​

How to copy and paste steps

1. Select the step you want to copy.
   • Click on the step. The step will be highlighted.
2. Copy the step.
   • Click on Copy link of the step. Alternatively you can press CTRL-C on your keyboard
   img here
3. Paste the step.
   • Option 1: click on the Paste icon in the controls buttons area.
   • Option 2: press CTRL-V on your keyboard
     img here
4. A new step will appear.
   • A step with the same properties but without any connections will appear next to the source step.
     
     img here

​

How to view and manage comments

1. Open the comments panel.
   • Click on the Comment icon on the action bar of the editor.
   • The comments panel will appear and existing comments will be displayed.

From the comments panel, there are several actions you can take on comments:

• Add your comment (optional).
  • Write your comment in the text area on the bottom of the panel.
  • Click Submit to add your comment.
• Reply to an existing comment (optional).
  • Click the Reply icon next the comment you want to reply.
  • Write your comment in the text area on the bottom of the panel.
  • Click Submit to add your comment.
• Delete an existing comment (optional).
  • Click on the Delete icon next to the comment you want to delete.
  • The comment and all its replies will be deleted.
  • Only the author of the comment can delete it.
• Edit an existing comment (optional).
  • Click on the Edit icon next to the comment you want to edit.
  • Enter the new text and click Submit to save your changes.
  • The suffix “(edited)” will appear next to the edited comment.
  • Only the authors of the comment can edit it.

​

How to save changes

1. Click the Save Playbook button.
   • An informational message will appear when the playbook is saved.
     
     img here

​

How to align, fit view and zoom

The control buttons area contains three main controls:

1. Fit view: The canvas is zoomed out until all steps of the playbook are visible. img here
2. Align: Steps are aligned in such a way that do not overlap
   img here
3. Zoom in/out: Canvas is zoomed in/out.
   img here

• You can also click and drag anywhere that is empty in the canvas area to move your viewport.

​

How to exit the editor

There are two options to exit the editor:

• Click the Cymph logo.
  • It is located on the top left corner of the editor.
• Click the Back to main page button.

If there are unsaved changes, a prompt will appear to ask how you will like to proceed:

• Save: Save changes and exit the editor.
• Discard changes: Do not save changes and exit the editor.
• Cancel: Ignore and return back to the editor.