Using Stewardship Workbench

Alation Cloud Service Applies to Alation Cloud Service instances of Alation

Customer Managed Applies to customer-managed instances of Alation

Alation’s Stewardship Workbench is part of the Data Governance App. Stewards are able to make updates to the catalog in bulk, instead of navigating to multiple different object pages to make the same change, such as applying a data masking or row access policy.

Selected objects are validated for relevance and the changes will then be applied. For some policy types, only relevant objects will be updated. For example, data masking policies will only update column objects and row access policies will only update table objects in the selection. The user will receive an email notification when policies are successfully applied.

Upon committing changes such as Bulk Add Data Policy or Bulk Remove Data Policy, Alation communicates with Snowflake via bulk processing API to carry out the requested action. Alation sends the requested action to Snowflake to process for the desired objects and after completion of the action, the user will receive an email confirmation. This process is also notified to the user making the update in the final dialog “Request Sent” as displayed in the Bulk Add Data Policy or Bulk Remove Data Policy sections below.

How to Access Stewardship Workbench

  1. After Stewardship Workbench has been enabled, select the Govern icon in the Apps menu.

../../_images/dg_app_menu.png
  1. Click the STEWARDSHIP WORKBENCH icon to view the Stewardship Workbench page.

../../_images/sw.png

Bulk Add Data Policy

  1. After filtering the results to only show the data objects that you want to edit, select the checkboxes for the columns you want to apply the data policy to. If you would like to add the data policy to all columns, select the checkbox in the header row.

../../_images/sw_ex1.png
  1. Click the Bulk Actions button and select Add Data Policy from the list of options.

../../_images/sw_ex2.png
  1. Click the Select Policy button.

../../_images/sw_ex3.png
  1. From the list, select a Dynamic Data Masking policy. If you are unsure which policy is for Dynamic Data Masking, you will need to go to the Policy Center and view the list of policies.

../../_images/sw_ex4.png
  1. Click the Add button.

../../_images/sw_ex5.png
  1. You will be prompted for credentials to the Snowflake data source. Once you have entered the appropriate credentials, you can click the Test and Continue button.

../../_images/sw_ex6.png
  1. You will see a notification that the request to apply the data policy has been sent and that you will receive an email notification when it is complete.

../../_images/sw_ex7.png

Bulk Remove Data Policy

  1. After filtering the results to only show the data objects that you want to edit, select the checkboxes for the columns you want to remove the data policy from. If you would like to remove the data policy from all columns, select the checkbox in the header row.

../../_images/sw_ex1.png
  1. Click the Bulk Actions button and select Remove Data Policy from the list of options.

../../_images/sw_ex8.png
  1. Click the Select Policy button.

../../_images/sw_ex9.png
  1. From the list, select the Dynamic Data Masking policy you want to remove.

../../_images/sw_ex10.png
  1. Click the Remove button.

../../_images/sw_ex11.png
  1. You will be prompted for credentials to the Snowflake data source. Once you have entered the appropriate credentials, you can click the Test and Continue button.

../../_images/sw_ex12.png
  1. You will see a notification that the request to remove the data policy has been sent and that you will receive an email notification when it is complete.

../../_images/sw_ex13.png

Bulk Add Policy

In 2022.1.3 and later, the ability to add policies in bulk was incorporated into Stewardship Workbench.

Note

An Object Set custom field must be created and added to the Policy catalog template page in order to perform bulk addition of policy to objects.

  1. After filtering the results to only show the objects that you want to edit, select the checkboxes for the objects you want to apply the policy to. If you would like to add the policy to all objects, select the checkbox in the header row.

../../_images/sw_ex1a.png

Note

If objects are selected to add a policy to for which a policy cannot be applied, an error message will display.

../../_images/sw_ex15a.png
  1. Click the Bulk Actions button and select Add Policy from the list of options.

    ../../_images/sw_ex2a.png
  2. Click the Select Policy button.

    ../../_images/sw_ex3a.png
  3. From the list, select a policy. If you are unsure which policy should be applied or would like to modify the policy, you will need to go to the Policy Center to view and edit the list of policies.

    ../../_images/sw_ex4a.png
  4. From the Select Custom Field list, select the custom field which will display objects this policy is applied to.

    ../../_images/sw_ex5a.png
  5. Click the Add button.

    ../../_images/sw_ex6a.png
  6. You will see a notification that the request to apply the policy has been sent and that you will receive an email notification when it is complete.

    ../../_images/sw_ex7a.png

Bulk Remove Policy

In 2022.1.3 and later, the ability to remove policies in bulk was incorporated into Stewardship Workbench.

  1. After filtering the results to only show the objects that you want to edit, select the checkboxes for the objects you want to remove the policy from. If you would like to remove the policy from all objects, select the checkbox in the header row.

../../_images/sw_ex1a.png

Note

If objects are selected to remove a policy from for which a policy cannot be removed, an error message will display.

../../_images/sw_ex16a.png
  1. Click the Bulk Actions button and select Remove Policy from the list of options.

../../_images/sw_ex8a.png
  1. Click the Select Policy button.

../../_images/sw_ex9a.png
  1. From the list, select the policy you want to remove.

../../_images/sw_ex10a.png
  1. Click the Remove button.

../../_images/sw_ex11a.png
  1. You will see a notification that the request to remove the policy has been sent and that you will receive an email notification when it is complete.

    ../../_images/sw_ex13a.png