Configure restart for Playbooks

Configure restart so that agents and fulfillers in Playbook Experience can restart a playbook from the beginning, or from a specific stage or activity.

Before you begin

Role required: pd_author

Note:

Once restart is enabled for a playbook, it cannot be disabled. If you don't want agents to be able to restart a playbook or its activities and stages, do not perform the following task.

Procedure

1. Enable restart for an entire playbook.
   1. Navigate to All > Process Automation > Workflow Studio and select Playbooks.
      The Playbooks list displays.
   2. Open the playbook you want to enable restart for.
      The Playbooks builder displays.
   3. In the upper right-hand corner, open the More actions menu, and select Properties.
      The Additional Properties modal displays.
   4. At the bottom of the General tab, select the Allow this process to be restarted during runtime box.
      
      
      Agents can now restart the whole playbook.

      Note:

      Restart can be enabled for activities and stages even if the whole playbook cannot be restarted.
2. Define restart rules for each stage and activity.
   Note:

   Restart settings for a stage do not apply to its activities. Each activity also has its own restart settings.
   1. In the Playbooks builder, open the stage or activity you want to configure restart settings for.
   2. Under Restart rules, select what you want the stage or activity to do when restarted.
      
      

   Rule	Description
   Skip on restart	The stage or activity only runs during a playbook's initial run. It never runs during a restarted run. Note: This setting is helpful if you don't want new tasks or records to be created during a restarted run, because the original execution and resulting record is still relevant.
   Run always	The stage or activity always runs, whether during an initial or restarted run.
   Skip on first run	The stage or activity runs only during restarted runs. It never runs during an initial run.

   Your restart rules are applied.

   • Restart settings are reflected in both the Diagram view and Board view of the Workflow Studio Playbooks builder.
     
     
     
     
   • Restart buttons are added to context menus in your playbook.
     
     
3. Optional: To test your playbook with the restart options, select Test in the upper right-hand corner and open the Playbook preview.