Skip to main content

Cyware Orchestrate

Import Custom Playbooks in JSON format

You can import custom playbooks in JSON format to your instance. Playbooks exported from one Orchestrate instance can be imported to a different instance.

While importing Playbooks, a few items that get imported are:

  • Apps

  • Sub-Playbooks

  • Instances of the apps

  • Schedules

  • Labels

For example, you can import Playbooks from a development to a production environment or when the Playbook has been developed offsite or on any other Orchestrate instance.

Before you Start

Ensure that you have the Import Playbook permission.

Steps

To import playbooks, follow these steps.

  1. Click the main menu icon on the left sidebar, and go to Playbooks > Manage Playbooks.

  2. Click Import Playbook on the top right.

  3. Browse and select the Playbook to import, and click Open .

  4. Click Import.

Validation for Playbook Import

The system validates the Playbook since the Playbook import sequence can vary depending on a few specific scenarios. The Playbook must be in JSON format. It is recommended to install all the associated apps of the Playbook before importing it. Otherwise, the Playbook could break at those nodes where the app is invoked. You can only install the apps from the Appstore, and not under the custom apps. If an instance is not configured for an app, then an instance must be created for the app in the Apps module. In addition, you cannot create new app instances during the import Playbook workflow. If the app instances are not selected, then the default instance is mapped to the nodes. You also have the option to update the instance for all the nodes at once.

You can also change the instance from the default instance to any other instance from the listing for each node/action specified. All the actions in the Playbook are automatically assigned to a default instance of the apps through suitable mappings. An action can be assigned to multiple instances. If the imported Playbook instance matches with the Orchestrate instance, then that instance itself will be used.