Skip to main content

Inherited Value Automation

Danger

data.world University!

Check out our Inherited Value automation and Set up an Inherited value automation videos!

About the automation

Use this automation to assign an inherited value to resource fields that do not have any value set. This allows you to easily inherit metadata values from related resources, saving time and reducing redundancy.

Define the fields of the selected resources the automation will check for values. If the field has no value set for it, the field will inherit the value of the field set for the parent resource. This works if the Is Part of relation is set between the two resources and both resources have the exact same metadata field defined for them.

For example, you can set the automation to check if Columns have the Owner email set. If they don't, they will inherit the value of the Owner email field set for the Table it is part of. Note that all automations currently update the information in the base layer. The automations get the information from the flattened catalog (user+base layer), but saves its results into the base layer, so that if there are any values set in the user layer, the automation does not override them.

At the end of the run the automation will generate a report informing users about the outcomes.

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

  3. In the Configure Inherited Value 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 Inherited Value 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 Field: Select the metadata field from which the value should be inherited.

  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.

set_inherited_value.png
  • Summary: The summary section lists the number of resource where the inherited value is set by the automation.

  • Report: The detailed reports lists the following information.

    Table 1.

    Field

    Description

    Resource

    Link to the resource that was updated by the automation.

    Field

    Name of the field that was updated.

    Inherited_Values

    Link to the value that was inherited by the field.

    identifier_select

    Identifier for the value that was applied to the field.

    Label

    The label of the value that was applied to the field.



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