Managing existing metadata enrichments
Metadata enrichment assets are listed in the Metadata enrichments section of the Assets page. You can update, rerun, or delete metadata enrichment assets.
- Required permissions
-
To edit, run, or delete a metadata enrichment, you must have the Admin or the Editor role in the project, and you must have at least view access to the categories that you want to use in the enrichment. Also, you must be authorized to access the connections to the data sources of the data assets to be enriched.
If any of these connections are locked, you are asked to enter your personal credentials. This is a one-time step that permanently unlocks the connections for you.
All operations that are run as part of a metadata enrichment require credentials for secure authorization. Typically, your user API key is used to execute such long-running operations without disruption. If credentials are not available when you create a metadata enrichment or try to run any type of enrichment, you are prompted to create an API key. That API key is then saved as your task credentials. See Managing the user API key.
You can also edit, run, or delete metadata enrichments with APIs instead of the user interface. The links to these APIs are listed in the Learn more section.
Basic enrichment information
A summary of relevant information about a metadata enrichment is provided in the side panel. This panel is open by default, but you can also access it by clicking the Info icon .
Editing the metadata enrichment
Edit a metadata enrichment to change any of these configuration settings:
- Asset details such as the asset name, the description, or tags. Note that changing the asset name does not change the name of the associated enrichment job.
- The data scope.
- The enrichment objectives, the category selection, and the sampling option.
- The schedule and the data scope of reruns.
You can edit a metadata enrichment asset in these ways:
- Open the metadata enrichment. In the Metadata enrichments section of the Assets page, click the asset's name or click View from the asset's overflow menu. Then, click Edit enrichment.
- In the Metadata enrichments section of the Assets page, select Edit from the overflow menu next to the asset name.
Hint: The metadata enrichment does not run automatically when you save configuration changes. For example, even if you delete the schedule, you must manually run the metadata enrichment. See Running the enrichment manually.
Running an enrichment manually
You can manually run a metadata enrichment at any time for the entire set of assets or a subset of assets.
To run the enrichment for the entire set of assets:
- Open the metadata enrichment asset and select Enrich all assets from the overflow menu next to the asset name.
- Open the metadata enrichment asset. On the Assets tab, select all assets and select Enrich from the toolbar.
- Go to the project's Jobs page and run the enrichment job from there. See Jobs.
To run the enrichment for a subset of the assets:
-
Open the metadata enrichment asset. On the Assets tab, select assets as required and select Enrich from the overflow menu next to the asset name.
-
Open the metadata enrichment asset. On the Assets tab, select assets as required and select Enrich from the toolbar.
You have several enrichment options.
- You can rerun the enrichment as configured.
- You can run an analysis to identify primary keys for the assets. See Identifying primary keys.
- You can run an analysis to identify relationships between the assets, or to detect overlapping or redundant data. See Identifying relationships.
- You can run advanced data profiling to get more accurate profiling results without any approximations. See Advanced data profiling.
If an enrichment ran at least once, also your selection of the data scope on reruns determines which assets are actually reenriched when you run the configured enrichment again.
At any time, you can change the metadata enrichment configuration by updating the metadata enrichment asset before you run the enrichment. Assets are then profiled and analyzed according to the current enrichment configuration.
In case of a rerun, assets might not be available for reenrichment because they were deleted from the data source or were removed from the enrichment scope. For such assets, the timestamp of the asset profile will still show the date and time of the previous run.
Pausing and resuming enrichment job runs
At any time, you can pause a job run for a metadata enrichment and later resume it. This does not apply to job runs of any of the advanced analyses key or relationship analysis or advanced profiling.
When you pause an enrichment, processing is halted. The job run log shows the status Paused
. When you resume the job run, assets where enrichment hadn't started or wasn't complete at the time of pausing are processed. The job run
log shows the job run status as Running
and contains an entry that shows the start and end time of the pause. Only the last pause is listed in the log even if the job run was paused several times.
Deleting a metadata enrichment asset
You can delete a metadata enrichment asset from a project in one of these ways:
- Select the Delete option from the overflow menu for the asset on the project Assets page.
- Open the asset and select Delete from the overflow menu next to the asset name.
The metadata enrichment configuration and its associated metadata enrichment job are deleted. Assets in the project or a catalog that were enriched with this metadata enrichment asset are not affected. You might need to refresh your browser to see the deletion reflected.
Learn more
Next steps
- Identifying primary keys
- Identifying relationships
- Running advanced data profiling
- Working with the enrichment results
Parent topic: Managing metadata enrichment