Add and configure a stage in a playbook

Add and configure a stage in your playbook.

Before you begin

Role required: playbook.admin or pd_author

Review Stages and activities.

Procedure

1. Add a stage.

<table id=“choicetable_z1g_1yz_21c”><thead><tr><th align=“left” id=“d39455e75”>

View

</th><th align=“left” id=“d39455e78”>

Steps

</th></tr></thead><tbody><tr><td id=“d39455e84”>

Diagram

</td><td>

1. Select the + icon after the trigger to add the first stage in your playbook.

2. In the mini-picker, select the dotted square icon. [Omitted image “diagram-stage-icon.png”] Alt text: Square dotted stage icon in Diagram view mini-picker.

</td></tr><tr><td id=“d39455e113”>

Board

</td><td>

In Board view, click + Add stage.

</td></tr></tbody> </table> Your new stage appears, and the Stage properties panel opens.

1. Fill in the following fields.

   1. Provide the basic details of the stage.

<table id=“table_zcq_mfv_21c”><tbody><tr><td>

Label

</td><td>

Enter a unique, user-facing name for your stage. This name appears to agents and fulfillers during runtime of your playbook.

</td></tr><tr><td>

Description

</td><td>

Optionally, enter some descriptive details about your stage.

</td></tr><tr><td>

Run condition

</td><td>

After the stage starts, the stage runs only if specific conditions are met.

</td></tr><tr><td>

Start Rule

</td><td>

Choose when you want your stage to start running. Options include:- When playbook starts: Your stage starts running as soon as the playbook starts. - After specific stages: Your stage starts running after specified stage(s) have finished running.

</td></tr></tbody> </table> 2. Show additional options in the activity for even more granular control.

    **Warning:** Changing the advanced property fields of an activity can potentially break your automation. Make sure you understand how the playbook and its activities flow before you make changes.

<table id=“choicetable_ffz_mct_vlb”><tbody><tr><td id=“d39455e257”>

Display order

</td><td>

When there are multiple stages running at the same time, define the order in which stages appear during a playbook run.Note: In Workflow Studio, this can also be helpful when viewing parallel activities in Diagram view.

</td></tr><tr><td id=“d39455e277”>

Start with delay

</td><td>

Specify a duration of time to wait before running an stage whose start rule and conditions have been met. For more information, see Start with delay input properties.

</td></tr><tr><td id=“d39455e300”>

Restart rules

</td><td>

Choose what this activity does when a playbook is restarted:- Skip on restart: Skip this stage when the run is due to a restart. - Run always: Always run this stage, including first runs. - Skip on first run: Skip this stage during the first run. For more information, see Configure restart for Playbooks.

</td></tr></tbody> </table>3. Under the Runtime permissions tab, add sets of users, user groups, user criteria and roles, and define whether they can add optional activities to the stage or restart the stage and its activities.

1. Click Save and close to finish adding the stage to your playbook.

   You can continue to add more stages to your playbook and fill in fields as described in the previous steps. In the Board view, use the Stage actions menu [Omitted image "icon-menu.png"] Alt text: Stage actions menu to add stages between existing stages.

   Stages are created.

What to do next

Add and configure your activities.

Parent Topic:Stages and activities