Skip to main content

Metadata Freshness Review Automation

About the automation

Important

You must run the Metadata Freshness Refresh automation before running this automation.

Use this automation to review the metadata freshness of resources in collections. This automation empowers Data Stewards to set up regular cadences for metadata review. It takes the guesswork out of the process and ensures data remains current.

Define the fields of the selected resources the automation should check for freshness and the shelf life of the field is days. If the field value has not changed in the defined days, it will mark the resource as Not Fresh. At the end of the run the automation will generate a report informing users about the outcomes.

Important

Only Organization administrators can view, configure, and run automations.

Configuring the automation

To configure the automation:

  1. On the Organization profile page, go to the Automations tab.

  2. In the Automation templates section, locate the Metadata Freshness Review template. Click the Configure button.

  3. In the Configure Metadata Freshness Review window, on the first screen set the following and click Next.

    • Automation name: A name for the automation.

    • Automation description: A brief description.

  4. In the Configure Metadata Freshness Review window, on the next screen set the following and click Next.

    • Collection: Select the collection for the automation.

    • Resource types: Select the resource types the automation should check.

    • Metadata Fields: Select the metadata field Refreshed On that represents the last time the resource was refreshed. This field is created by the Metadata Freshness Refresh automation.

    • Shelf Life (Days): Set the number of days that a resource should be considered fresh.

  5. On the last screen, select the Trigger Daily option if you want schedule the automation to run daily. After activation, the automation will execute each day within a 30-minute window from the time it was originally created. For instance, if the automation was set up at 3 PM, it will run every day between 3 PM and 3:30 PM. Click Save and continue.

Enabling automations

Once you have finished setting up the automation, the next step is to turn it on. This action will enable the automation to run.

To enable an automation:

  1. On the Organization profile page, go to the Automations tab.

  2. In the Automation section, locate the automation you want to enable and open it by clicking it.

  3. Click the Enable automation link. This option is available only for automations that have never been enabled. If you enable an automation and then disable it, it cannot be enabled again.

Running the automation

To run the automation:

  1. On the Organization profile page, go to the Automations tab.

  2. In the Automation section, locate the automation you want to run. Open the Automation details page.

  3. Click the Run button.

  4. After the automation is done running, a report is generated and made available in the Project created for the automation.

Viewing the report

To view the automation run report:

  1. On the Organization profile page, go to the Resources tab.

  2. From the Resources tab of the Organization profile page, locate the Project that contains the report for the automation. View the details captured by the automation. Each time the automation runs, it adds a new report to the same project.

    freshness_review.png

Archiving automations

Important

Once you archive an automation it cannot be enabled again. Only active automations can be archived.

To archive an automation:

  1. On the Organization profile page, go to the Automations tab.

  2. In the Automation section, from the Activated tab, locate the automation you want to archive and open it.

  3. Click the Archive automation link.The archived automation is moved to the Archived tab.

    gov_automation_archive.png