How to manage playbooks

Once you've created a playbook, you can monitor, modify, or delete it at any time. You can also enable notifications to monitor your playbook runs directly in Slack or Microsoft Teams.

Monitor a playbook

To monitor your playbooks runs:

• When running a playbook immediately, you will be redirected to the monitoring page within 5 seconds.
• At any other moment:
  1. From the left menu of any screen in Atlan, click Governance.
  2. Under the Governance heading of the Governance center, click Playbooks.
  3. In the playbooks manager, select the playbook you'd like to view.
  4. In the Overview section of your playbook, you'll be able to monitor:
     • A summary of the rules, actions, and updated assets.
     • An activity log for recent runs and updates over time.

Modify a playbook

To modify an existing playbook:

1. From the left menu of any screen in Atlan, click Governance.
2. Under the Governance heading of the Governance center, click Playbooks.
3. In the playbooks manager, click the playbook you'd like to modify.
4. On your playbook page:
   • To edit the name and description of your playbook, hover over your playbook and click Edit.
   • To modify the rules of your playbook, click Rules to make your changes and then click Update to save them.
     • (Optional) To add a new rule to an existing playbook, in the left menu for playbook rules, click + Add new Rule. 
   • To turn off a playbook filter, to the right of any filter, click the three horizontal dots and then click Disable. Click Enable to turn on any disabled filters.
   • To modify the schedule for your playbook, in the upper right of your screen:
     • Click Run Now to run it immediately.
     • Click the pencil icon to modify or remove the schedule.

Delete a playbook

To delete an existing playbook:

1. From the left menu of any screen in Atlan, click Governance.
2. Under the Governance heading of the Governance center, click Playbooks.
3. In the playbooks manager, hover over the playbook you'd like to delete and click Delete Playbook.
4. Click Delete to confirm.

Enable playbook notifications

You can set up Slack or Microsoft Teams alerts for your playbook runs in Atlan. This can help you monitor your playbooks directly in Slack or Microsoft Teams. You can also choose to receive alerts for failed playbook runs only.

Before you can enable notifications for playbooks, you will need to either:

• Integrate Slack and Atlan
• Integrate Microsoft Teams and Atlan

To enable notifications for playbook runs:

1. From the left menu of any screen in Atlan, click Governance.
2. Under the Governance heading of the Governance center, click Playbooks.
3. In the upper-right of the playbooks manager, under Activity, click the bell icon.
4. In the Enable notifications popup:
   • Click Setup now to integrate Slack or Microsoft Teams.
   • If you have already integrated Slack or Microsoft Teams, click Enable.
5. In the notifications setup dialog, configure the following:
   1. For Notifications channel, you can either:
      • If you have already configured a Slack or Microsoft Teams channel to receive workflow alerts, that channel will be preselected. You can use the same channel to receive both workflow and playbook run alerts and skip to the next step.
      • If you have not configured a workflow alerts channel or want to add a different one, enter the channel name to receive notifications for playbook runs. This channel will be displayed as the Playbooks alert channel in your Slack or Microsoft Teams integration.
   2. To select the type of notifications you want to receive, you can either:
      1. Click Both success and failure alerts to receive notifications for both successful and failed playbook runs.
      2. Click Failure alerts only to limit notifications to failed playbook runs only.
   3. Click Save to save your notification preferences.
6. (Optional) To disable notifications, from the notifications setup dialog, remove the playbook alerts channel configured for Slack or Microsoft Teams.

You will now receive Slack or Microsoft Teams notifications for all your playbook runs in Atlan! 🎉

The Atlan bot will share playbook run alerts, including details like run status, start time, run time, trigger type, last three runs, and more.