Skip to content

Commit 5423557

Browse files
authored
DOCS-567 - Enable and disable playbooks (#5314)
* Start draft * Finish draft * Updates from review * More updates from review * Removed sentence from March-April release notes
1 parent 3c553af commit 5423557

File tree

7 files changed

+28
-0
lines changed

7 files changed

+28
-0
lines changed

docs/platform-services/automation-service/automation-service-playbooks.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -227,6 +227,34 @@ Every time you publish a playbook, a new version of the playbook is retained. In
227227

228228
<img src={useBaseUrl('img/platform-services/automation-service/playbook-versions.png')} alt="Playbook versions" style={{border:'1px solid gray'}} width="800"/>
229229

230+
## Enable or disable playbooks
231+
232+
You can enable playbooks for use in automations, or disable them to prevent them from being used. This gives you greater control over when a playbook can be run. If for example a playbook is causing a problem, such as exceeding your actions limit or sending too many emails, you could temporarily disable the playbook until you remedy the issue.
233+
234+
When enabling or disabling playbooks, keep in mind:
235+
* By default, draft playbooks are disabled.
236+
* Playbooks without any published versions are initially disabled and will be automatically enabled upon publishing their first version.
237+
* Disabled playbooks cannot be triggered automatically.
238+
* Deleted playbooks are set to disabled and remain so after restoration.
239+
* Cloned or imported playbooks are enabled by default, irrespective of the original playbook's status.
240+
* [Audit logs](/docs/platform-services/automation-service/automation-service-audit-logging/) are generated whenever playbooks are enabled or disabled manually.
241+
242+
### How to enable or disable a playbook
243+
244+
To enable or disable a playbook, open the playbook and click the toggle.<br/><img src={useBaseUrl('img/platform-services/automation-service/playbook-enabled-toggle.png')} alt="Playbook enabled toggle" style={{border:'1px solid gray'}} width="400"/><br/><img src={useBaseUrl('img/platform-services/automation-service/playbook-disabled-toggle.png')} alt="Playbook disabled toggle" style={{border:'1px solid gray'}} width="400"/>
245+
246+
The **Status** column shows whether a playbook is enabled <img src={useBaseUrl('img/platform-services/automation-service/playbook-enabled-symbol.png')} alt="Playbook enabled symbol" style={{border:'1px solid gray'}} width="30"/> or disabled <img src={useBaseUrl('img/platform-services/automation-service/playbook-disabled-symbol.png')} alt="Playbook disabled symbol" style={{border:'1px solid gray'}} width="30"/>.
247+
248+
<img src={useBaseUrl('img/platform-services/automation-service/playbook-status-enabled-disabled.png')} alt="Playbook status column" style={{border:'1px solid gray'}} width="800"/>
249+
250+
### Enable on publish
251+
252+
To publish a playbook, click the **Publish** button at the bottom of the playbook window:<br/><img src={useBaseUrl('img/cse/automations-publish-playbook.png')} style={{border:'1px solid gray'}} alt="Publish the playbook" width="300"/>
253+
254+
When you publish a playbook:
255+
* Playbooks without any published versions are automatically enabled.
256+
* Playbooks that have previously published versions will display an **Enable playbook on publish** option if they are in a disabled state:<br/><img src={useBaseUrl('img/platform-services/automation-service/playbook-enable-on-publish-toggle.png')} style={{border:'1px solid gray'}} alt="Publish enable on publish" width="400"/>
257+
230258
## Playbook preferences
231259

232260
1. Click the preferences button in the upper-right corner of the screen.<br/><img src={useBaseUrl('img/platform-services/automation-service/playbook-preferences.png')} alt="Playbook preferences button" style={{border:'1px solid gray'}} width="200"/>
5.11 KB
Loading
50.1 KB
Loading
74.9 KB
Loading
5.1 KB
Loading
48.6 KB
Loading
144 KB
Loading

0 commit comments

Comments
 (0)