Table of Contents
CATALOG COMMAND
Category: Workflow / External
Description
This action performs a process on the Data Catalog or Data Catalog resources.
Capabilities
List of commands which EasyMorph can operate with:
- List Catalog assets
- List Catalog collections
- Add/update asset fields
- Update asset description
- List asset fields
- Delete asset fields
- Delete asset
- Move asset
- Rename asset
- Create collection
- Delete collection
- Move collection
- Rename collection
- Set metric value
- Get metric value
- Increment metric
- Set state
- Get state
Use cases
Use the various modes of this action to extract information about Catalog assets and manipulate the structure of the Data Catalog.
Use field items to store and retrieve metadata about the resource or the resource's data.
Action settings
| Setting | Description |
|---|---|
| Command | Choose the process to perform on the Data Catalog. Refer to the details below for each mode. |
List Catalog assets settings
Description: Returns a dataset of information about any assets within the selected collection. Columns include: Collection, Asset name, Asset type, Last modified, Definition, Parameters, Connector, Short description, and Long description.
| Setting | Description |
|---|---|
| In collection* | Enter or browse to the Catalog collection to list the assets it contains. If this option is not selected, the action will return assets in the root Catalog collection. |
* Setting can be specified using a parameter or the first value of a column.
List Catalog collections settings
Description: Returns a dataset listing the subcollections of the selected collection (if any).
| Setting | Description |
|---|---|
| In collection* | Enter or browse to the Catalog collection to list the subcollections it contains. If this option is not selected, the action will return subcollections of the root Catalog collection. |
* Setting can be specified using a parameter or the first value of a column.
Add/Update asset field settings
Description: Adds or updates the asset field settings of the selected resource using values from the input dataset.
| Setting | Description |
|---|---|
| Asset path* | Enter or browse to the Catalog collection to list the subcollections it contains. If this option is not selected, the action will return subcollections of the root Catalog collection. |
| Field names | Select a column from the input dataset to use for field item names. |
| Descriptions | Select a column from the input dataset to use for the field item descriptions. |
| Is optional | Check this to flag the field item as optional (i.e., this field may not be present in the result). |
| Delete item fields that are not on the list | Check this to remove any field items that do not match the items on the list set in this action. |
* Setting can be specified using a parameter or the first value of a column.
Update asset description settings
Description: Updates the description and/or long description of the selected asset.
| Setting | Description |
|---|---|
| Asset path* | Enter or browse to the Catalog asset to update. |
| Update description* | Check "Update description" and enter the description text in the subsequent field. |
| Update long description* | Check "Update long description" and enter the long description text in the subsequent field. |
* Setting can be specified using a parameter or the first value of a column.
List asset fields settings
Description: Returns a dataset of the selected asset's item fields and associated values.
| Setting | Description |
|---|---|
| Asset path* | Enter or browse to the Catalog asset to list the item fields it contains. |
* Setting can be specified using a parameter or the first value of a column.
Delete asset fields settings
Description: Removes all or selected item fields from the selected asset.
| Setting | Description |
|---|---|
| Asset path* | Enter or browse to the Catalog asset containing item fields. |
| Delete all fields | Select this option to remove all fields from the asset. |
| Delete selected fields | Select this option to remove only the fields chosen in the list below it. |
* Setting can be specified using a parameter or the first value of a column.
Delete asset settings
Description: Deletes the selected asset from the Catalog.
| Setting | Description |
|---|---|
| Asset path* | Enter or browse to the Catalog asset to be removed. |
| If asset doesn't exist | Select Fail to stop the workflow with an error, or Do nothing to continue the workflow. |
* Setting can be specified using a parameter or the first value of a column.
Move asset settings
Description: Moves the selected asset to a different collection.
| Setting | Description |
|---|---|
| Asset path* | Enter or browse to the Catalog asset to be moved. |
| New location* | Enter or browse to the Catalog collection the asset will be moved to. |
| If asset already exists | Select Overwrite to overwrite the existing asset with the new one. Select Fail to stop the workflow with an error, or Do nothing to continue the workflow without moving the asset. |
* Setting can be specified using a parameter or the first value of a column.
Rename asset settings
Description: Renames the selected Catalog asset to the name provided.
| Setting | Description |
|---|---|
| Asset path* | Enter or browse to the Catalog asset to be renamed. |
| New name* | Enter the new name for the asset. |
| If asset already exists | Select Overwrite to overwrite the existing asset with the new name. Select Fail to stop the workflow with an error, or Do nothing to continue the workflow without renaming the asset. |
* Setting can be specified using a parameter or the first value of a column.
Create collection settings
Description: Creates a new collection within the selected collection (creates a subcollection).
| Setting | Description |
|---|---|
| Location* | Enter or browse to the Catalog collection to create a new collection within (creates a subcollection). |
| Name* | Enter the name for the new collection. |
| If collection already exists | Select Fail to stop the workflow with an error, or Do nothing to continue the workflow without creating the collection. |
* Setting can be specified using a parameter or the first value of a column.
Delete collection settings
Description: Removes the selected Catalog collection.
| Setting | Description |
|---|---|
| Collection* | Enter or browse to the Catalog collection to be deleted. Note: All assets contained in this collection will be deleted as well! |
| If collection doesn't exist | Select Fail to stop the workflow with an error, or Do nothing to continue the workflow without taking any action. |
* Setting can be specified using a parameter or the first value of a column.
Move collection settings
Description: Moves the selected collection to a different collection (selected collection becomes a subcollection of the new location).
| Setting | Description |
|---|---|
| Collection* | Enter or browse to the Catalog collection to be moved. |
| New location* | Enter or browse to the destination collection to move the selected collection to. |
| If collection already exists | Select Fail to stop the workflow with an error, or Do nothing to continue the workflow without moving the collection. |
* Setting can be specified using a parameter or the first value of a column.
Rename collection settings
Description: Renames the selected collection to the name provided.
| Setting | Description |
|---|---|
| Collection* | Enter or browse to the Catalog collection to be renamed. |
| New name* | Enter the new name for the collection. |
| If collection already exists | Select Fail to stop the workflow with an error, or Do nothing to continue the workflow without renaming the collection. |
* Setting can be specified using a parameter or the first value of a column.
Set metric value settings
Description: Sets or updates the value of a Catalog metric asset.
| Setting | Description |
|---|---|
| Asset path* | Enter or browse to the Catalog metric asset to set or update. |
| New value* | Enter the metric's new value to apply. |
* Setting can be specified using a parameter or the first value of a column.
Get metric value settings
Description: Retrieves the value of a catalog metric asset.
| Setting | Description |
|---|---|
| Asset path* | Enter or browse to the Catalog metric asset to retrieve the value of. |
| Append column | By default, the returned metric value replaces the incoming dataset. Check this option on to append the returned values to the current dataset in new columns. Three columns are created: "(metric name)", "Meaning of (metric name)", and "Formatted (metric name)". |
* Setting can be specified using a parameter or the first value of a column.
Increment metric settings
Description: Increments the value of a Catalog metric. Incrementing is atomic (transactional) and works reliably in scenarios when multiple simultaneous increments happen at the same time.
| Setting | Description |
|---|---|
| Metric* | Enter or browse to the Catalog metric asset. |
| Increment by* | The numeric value by which the metric is incremented. Negative or fractional numbers are acceptable as well. |
* Setting can be specified using a parameter or the first value of a column.
Set state settings
Description: Sets or updates the value of a Catalog state asset.
| Setting | Description |
|---|---|
| Asset path* | Enter or browse to the Catalog state asset to set or update. |
| New value* | Enter the state's new value to apply. |
* Setting can be specified using a parameter or the first value of a column.
Get state settings
Description: Retrieves the current value of a Catalog state asset.
| Setting | Description |
|---|---|
| Asset path* | Enter or browse to the Catalog state asset. |
| Append column | By default, the returned state value replaces the incoming dataset. Check this option on to append the returned values to the current dataset in new columns. Two columns are created: "(state name)" and "Meaning of (state name)". |
* Setting can be specified using a parameter or the first value of a column.
Remarks
Delete collection - Use this mode with caution as any assets stored within the selected collection will be deleted as well. Structure your workflow to detect and/or move any assets you wish to keep before running this mode.
You can set and remove field items and settings manually using the Explorer section from the Home tab. Click the down arrow at the top-right corner of the asset and select "Edit…". In the "Edit catalog asset" window that appears, select the Fields tab to make changes.