How to set up playbooks

Have more questions? Submit a request
πŸ€“ Who can do this? You will need to be an admin user in Atlan to create playbooks.

A common question that data teams often face is how to automate metadata at scale.

Having started out as a data team ourselves, we know that automating repetitive tasks can help data teams maximize the value they provide to their organization. One way of doing so is through Atlan's playbooks!

Playbooks help power metadata automation for your data assets in Atlan. Users can create rule-based automations at scale and update metadata in bulk, helping streamline their workflows.

You can update the following asset metadata using playbooks:

For example, imagine your organization needs to transfer ownership of several data assets. Instead of your data team manually updating the ownership of each and every asset, you could create a playbook to automate this process and update the metadata of your assets at scale.

To create a playbook, complete the following steps.

Create a playbook

To create a playbook in Atlan:

  1. In the left menu in Atlan, click Governance.
  2. Under the Governance heading of the Governance center, click Playbooks.
  3. Click Create New to get started.
  4. In the Create new playbook dialog box, enter the following details:
    1. For Name, enter a name for the task to be accomplished β€” such as Update ownership.
    2. (Optional) For Description, enter a description.
    3. (Optional) Select an icon for your playbook.
  5. Click Create to save your playbook.

Set up rules as filters

To set up rules as filters for your playbook:

  1. In the Build Rules page of your playbook, click Filters.
  2. For name, add a name to your filter.
  3. To set a matching condition for the filters, select Match all or Match any. Match all will logically AND the criteria, while Match any will logically OR the criteria.
  4. For Attributes, select the relevant option. For this example, we'll click Connection and then select a Snowflake connection. (Optional) To further refine your asset selection:
    1. Click All databases to filter by databases in a selected connection.
    2. Click All schemas to filter by schemas in a selected connection.
  5. For Operator, select Is one of for values to include or Is not for values to exclude. Depending on the selected attribute(s), you can also choose from additional operators:
    • Select Equals (=) or Not Equals (!=) to include or exclude assets through exact match search.
    • Select Starts With or Ends With to filter assets using the starting or ending sequence of values.
    • Select Contains or Does not contain to find assets with or without specified values contained within the attribute.
    • Select Pattern to filter assets using supported Elastic DSL regular expressions.
    • Select Is empty to filter assets with null values.
  6. For Values, select the relevant values. The values will vary depending on the selected attributes.
  7. (Optional) To add more filters, click Add filter and select Filter to add individual filters or Filter Group to nest more filters in a group.
  8. (Optional) To view all the assets that match your rules, in the Filters card, click View all for a preview.
πŸ’ͺ Did you know? You can select from a wide range of attributes when setting up your playbook filters β€” including asset type, tags, schema qualified name, database qualified name, asset properties, asset usage, processes, queries, Monte Carlo asset metadata, Soda data quality status, and more. You can also select a specific glossary or category to bulk update all the nested terms or update multiple glossaries and categories.

Select the actions

To select the actions to be performed based on your rules:

  1. In the Build Rules page of your playbook, click Actions.
  2. For Select Action, select the relevant metadata option to update. For this example, we'll select Owners to update the ownership of the assets.
  3. For Select operator, select the relevant option. The operators will vary depending on the selected action.
  4. For Values, select the relevant option(s). The values will vary depending on the selected actions.
  5. (Optional) To add more actions, click Add Action.
πŸ’ͺ Did you know? You can control tag propagation when adding tags as an action in playbooks. Tag propagation is disabled by default. If you enable tag propagation, you will also be able to configure how tags are propagated.

Run the playbook

If you'd like to continue working on your playbook, you can save it as a draft. If your playbook is ready, you can proceed to running it.

To run the playbook:

  1. You can either:
    • To run the playbook once immediately, click Run once.
    • To schedule the playbook to run hourly, daily, weekly, or monthly, click Schedule and choose the preferred frequency, timezone, and time.
  2. Click Complete to run the playbook.
  3. In the resulting screen, click Go to profile to view your playbook profile.

Once your playbook has completed its run, you will see the metadata updated for your assets! πŸŽ‰

πŸ’ͺ Did you know? If you have any questions about setting up playbooks, head over here.

Related articles

Was this article helpful?
0 out of 0 found this helpful