Skip to main content

Metadata Completeness Automation

About the automation

Use this automation to check the metadata completeness of resources in a collection. This gives you automated insights into the completeness of metadata across your resources, enabling better data tracking and quality control.

Define the parameters of the selected resources that the automation will check for completeness. At the end of the run the automation will generate a report providing a list of all the resources that don't meet the defined completeness standards.

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 Completeness template. Click the Configure button.

  3. In the Configure Metadata Completeness 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 Completeness window, on the next screen set the following and click Next.

    • Collection: Select the collection for the automation. The automation will apply only to the resources in the selected collection.

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

    • Metadata Fields: Select the metadata fields to be checked for completeness. In addition to other fields, this automation allows you to select Summary and Descriptions fields.

  5. On the last screen, set a schedule for the automation. You can set it to run daily, weekly, or monthly at a specific time. Once activated, the automation will execute on the scheduled day and time (within a 30-minute window of the scheduled time). 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 button. 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

Important

Automations with a configured schedule will automatically run at the specified time. However, you can also choose to run them manually if needed.

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. You also get an option to set a schedule for running the automation.

  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.

The report includes the following information.

check_metadata_completeness.png
  • Summary: The summary section provides the following information.

    Table 1.

    Field

    Description

    Resources_Complete

    The number of resources identified as complete.

    Resources_Incomplete

    The number of resources identified as incomplete.

    All_Resources

    The total number of resources checked by the automation for completeness.

    Percent_Complete

    The percentage of resources that were identified as complete.



  • Report: Lists the resources that are incomplete. Click the value in the field to navigate to the identified resource and take the required action to complete it.

Editing automations

To edit an automation:

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

  2. In the Automations section, from the Activated or Pending Activation tabs, select the automation you want to edit. Note that Archived automations cannot be edited.

  3. Click the Edit Automations button. Follow the wizard to make any necessary adjustments to the automation configuration. The new configurations will take effect the next time the automation runs.

    edit_automation.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