Activate a playbook in Creator Studio

  • Release version: Xanadu
  • Updated August 1, 2024
  • 2 minutes to read
  • Activating a playbook means that it will run when its related form is created or updated on your non-production, development instance. However, the app must still be deployed to production.

    Before you begin

    You must resolve any errors in the playbook before you can activate it.

    To activate a playbook, you must be given permission to work on the app.

    About this task

    You can check the activation status of a playbook at any time in the Automations tab header.

    Figure 1. Playbook activation status
    Playbook activation status appears in header

    If you don't activate a playbook and its app is deployed to production, the automation won't run on the applicable records. However, your App Engine admin can activate the deployed playbook for you.

    Procedure

    1. Go to All > App Engine > Creator Studio to see all the apps on the Creator Studio home page.
    2. Open the app that contains the playbook you want to activate.
    3. Select to Preview how different forms appear in various experiences, or select the View or Edit button to view or edit the application experience.
      Select different previewing options if you want to make sure that you've selected the correct application and see how it will appear in the following formats:
      • Portal (see a preview of how it'll appear on a desktop website)
      • Now Mobile (see a preview of how it'll appear on a mobile phone or device)
      • Virtual agent (see a representation of how it'll appear on a chatbot interface)
        Note:
        Your organization should have the correct plugins installed to see how the form will appear in Virtual Agent. If you're interested, ask your admin and see Catalog builder preview topic conversation for more information on previewing forms and their catalog items in Virtual Agent.

      The View button displays forms that have been published and doesn't explicitly create a new draft form for development. The Edit button takes you to a development form, for example, a new draft version of a form that's already been published.

      Figure 2. Preview the app's experience
      Preview how your app will look

      You can also check out a representation of how the form submissions workspace will appear by selecting the Submissions preview, as well as the records your app generates for it (by selecting the Record preview).

    4. Select the Automations tab in the application header.
    5. Check that you're activating the correct playbook in your app by selecting it from the Automations tab.
      Figure 3. Select automation
      Select automation to activate
    6. Select the Activate button.
      Figure 4. Activate the playbook
      Select the button to activate the playbook

    Result

    The status displayed in Automations tab header updates from Inactive to Saving to Active, informing you of when changes are made.

    The playbook is ready to be deployed with your app. Once the app is deployed, the form is available in the associated service catalog. If the form's app hasn't been deployed, you need to deploy it.