| Both sides previous revisionPrevious revision | |
| transformations:catalogcommand [2025/05/06 23:44] – [Increment metric settings] dmitry | transformations:catalogcommand [2026/06/22 20:35] (current) – updates to v6.0.1 craigt |
|---|
| =====Capabilities===== | =====Capabilities===== |
| List of commands which EasyMorph can operate with: | List of commands which EasyMorph can operate with: |
| * List Catalog items | * List Catalog assets |
| * List Catalog directories | * List Catalog collections |
| * Add/update item fields | * Add/update asset fields |
| * List item fields | * Update asset description |
| * Delete item fields | * List asset fields |
| * Delete item | * Delete asset fields |
| * Move item | * Delete asset |
| * Rename item | * Move asset |
| * Create directory | * Rename asset |
| * Delete directory | * Create collection |
| * Move directory | * Delete collection |
| * Rename directory | * Move collection |
| | * Rename collection |
| * Set metric value | * Set metric value |
| * Get metric value | * Get metric value |
| * Increment metric | * Increment metric |
| | * Set state |
| | * Get state |
| |
| |
| \\ | \\ |
| =====Use cases===== | =====Use cases===== |
| Use the various modes of this action to extract information about Catalog items, and manipulate the structure of the Data Catalog. | 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 items about the resource or resource's data. | Use field items to store and retrieve metadata about the resource or the resource's data. |
| |
| \\ | \\ |
| |
| \\ | \\ |
| ====List Catalog item settings==== | ====List Catalog assets settings==== |
| **Description:** Returns a dataset of information about any items within the selected directory. Columns include: Directory, Item name, Item type, Last modified, Definition, Parameters, Connector, Short description, and Long description. | **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 ^ | ^ Setting ^ Description ^ |
| |In directory<sup>*</sup>|Enter or browse to the Catalog directory to list the items it contains. If this option is not selected, the action will return items in the\\ root Catalog directory.| | |In Collection<sup>*</sup>|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.| |
| |
| <sup>*</sup> Setting can be specified using a [[:parameters|parameter]] or the first value of a column.\\ | <sup>*</sup> Setting can be specified using a [[:parameters|parameter]] or the first value of a column.\\ |
| |
| \\ | \\ |
| ====List Catalog directories settings==== | ====List Catalog collections settings==== |
| **Description:** Returns a dataset listing the subdirectories of the selected directory (if any). | **Description:** Returns a dataset listing the subcollections of the selected collection (if any). |
| ^ Setting ^ Description ^ | ^ Setting ^ Description ^ |
| |In directory<sup>*</sup>|Enter or browse to the Catalog directory to list the subdirectories it contains. If this option is not selected, the action will return\\ subdirectories of the root Catalog directory.| | |In collection<sup>*</sup>|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.| |
| |
| <sup>*</sup> Setting can be specified using a [[:parameters|parameter]] or the first value of a column.\\ | <sup>*</sup> Setting can be specified using a [[:parameters|parameter]] or the first value of a column.\\ |
| |
| \\ | \\ |
| ====Add/Update item fields settings==== | ====Add/Update asset field settings==== |
| **Description:** Adds or updates the item field settings of the selected resource using values from the input dataset. | **Description:** Adds or updates the asset field settings of the selected resource using values from the input dataset. |
| ^ Setting ^ Description ^ | ^ Setting ^ Description ^ |
| |Item path<sup>*</sup>|Enter or browse to the Catalog directory to list the subdirectories it contains. If this option is not selected, the action will return subdirectories of the root Catalog directory.| | |Asset path<sup>*</sup>|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.| | |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.| | |Descriptions|Select a column from the input dataset to use for the field item descriptions.| |
| |
| \\ | \\ |
| ====List item fields settings==== | ====Update asset description settings==== |
| **Description:** Returns a dataset of the item's item fields and associated values. | **Description:** Updates the description and/or long description of the selected asset. |
| ^ Setting ^ Description ^ | ^ Setting ^ Description ^ |
| |Item path<sup>*</sup>|Enter or browse to the Catalog item to list the item fields it contains.| | |Asset path<sup>*</sup>|Enter or browse to the Catalog asset to update.| |
| | |Update description<sup>*</sup>|Check "Update description" and enter the description text in the subsequent field.| |
| | |Update long description<sup>*</sup>|Check "Update long description" and enter the long description text in the subsequent field.| |
| | |
| | <sup>*</sup> Setting can be specified using a [[:parameters|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<sup>*</sup>|Enter or browse to the Catalog asset to list the item fields it contains.| |
| |
| <sup>*</sup> Setting can be specified using a [[:parameters|parameter]] or the first value of a column.\\ | <sup>*</sup> Setting can be specified using a [[:parameters|parameter]] or the first value of a column.\\ |
| |
| \\ | \\ |
| ====Delete item fields settings==== | ====Delete asset fields settings==== |
| **Description:** Removes all, or the selected item fields from the selected item. | **Description:** Removes all or selected item fields from the selected asset. |
| ^ Setting ^ Description ^ | ^ Setting ^ Description ^ |
| |Item path<sup>*</sup>|Enter or browse to the Catalog item containing item fields.| | |Asset path<sup>*</sup>|Enter or browse to the Catalog asset containing item fields.| |
| |Delete all fields|Select this option to remove //all// item fields from the resource.| | |Delete all fields|Select this option to remove //all// fields from the asset.| |
| |Delete selected fields|Select this option to only remove the fields chosen in the list below it.| | |Delete selected fields|Select this option to remove only the fields chosen in the list below it.| |
| |
| <sup>*</sup> Setting can be specified using a [[:parameters|parameter]] or the first value of a column.\\ | <sup>*</sup> Setting can be specified using a [[:parameters|parameter]] or the first value of a column.\\ |
| |
| \\ | \\ |
| ====Delete item settings==== | ====Delete asset settings==== |
| **Description:** Deletes the selected item from the Catalog. | **Description:** Deletes the selected asset from the Catalog. |
| ^ Setting ^ Description ^ | ^ Setting ^ Description ^ |
| |Item path<sup>*</sup>|Enter or browse to the Catalog item to be removed.| | |Asset path<sup>*</sup>|Enter or browse to the Catalog asset to be removed.| |
| |If item doesn't exist|Select //Fail// to stop the workflow with an error, or //Do nothing// to continue the workflow.| | |If asset doesn't exist|Select //Fail// to stop the workflow with an error, or //Do nothing// to continue the workflow.| |
| |
| <sup>*</sup> Setting can be specified using a [[:parameters|parameter]] or the first value of a column.\\ | <sup>*</sup> Setting can be specified using a [[:parameters|parameter]] or the first value of a column.\\ |
| |
| \\ | \\ |
| ====Move item settings==== | ====Move asset settings==== |
| **Description:** Moves the selected item to a different directory. | **Description:** Moves the selected asset to a different collection. |
| ^ Setting ^ Description ^ | ^ Setting ^ Description ^ |
| |Item path<sup>*</sup>|Enter or browse to the Catalog item to be moved.| | |Asset path<sup>*</sup>|Enter or browse to the Catalog asset to be moved.| |
| |New location<sup>*</sup>|Enter or browse to the Catalog directory the item will be moved to.| | |New location<sup>*</sup>|Enter or browse to the Catalog collection the asset will be moved to.| |
| |If item already exists|Select //Overwrite// to overwrite the existing item with the new one. Select //Fail// to stop the workflow with an error,\\ or //Do nothing// to continue the workflow without moving the item.| | |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.| |
| |
| <sup>*</sup> Setting can be specified using a [[:parameters|parameter]] or the first value of a column.\\ | <sup>*</sup> Setting can be specified using a [[:parameters|parameter]] or the first value of a column.\\ |
| |
| \\ | \\ |
| ====Rename item settings==== | ====Rename asset settings==== |
| **Description:** Renames the selected Catalog item to the new name provided. | **Description:** Renames the selected Catalog asset to the name provided. |
| ^ Setting ^ Description ^ | ^ Setting ^ Description ^ |
| |Item path<sup>*</sup>|Enter or browse to the Catalog item to be renamed.| | |Asset path<sup>*</sup>|Enter or browse to the Catalog asset to be renamed.| |
| |New name<sup>*</sup>|Enter the new name for the item.| | |New name<sup>*</sup>|Enter the new name for the asset.| |
| |If item already exists|Select //Overwrite// to overwrite the existing item with the new one. Select //Fail// to stop the workflow with an error,\\ or //Do nothing// to continue the workflow without renaming the item.| | |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.| |
| |
| <sup>*</sup> Setting can be specified using a [[:parameters|parameter]] or the first value of a column.\\ | <sup>*</sup> Setting can be specified using a [[:parameters|parameter]] or the first value of a column.\\ |
| |
| \\ | \\ |
| ====Create directory settings==== | ====Create collection settings==== |
| **Description:** Creates a new directory within the selected directory (creates a subdirectory). | **Description:** Creates a new collection within the selected collection (creates a subcollection). |
| ^ Setting ^ Description ^ | ^ Setting ^ Description ^ |
| |Location<sup>*</sup>|Enter or browse to the Catalog directory to create a new directory within (creates a subdirectory).| | |Location<sup>*</sup>|Enter or browse to the Catalog collection to create a new collection within (creates a subcollection).| |
| |Name<sup>*</sup>|Enter the name for the new directory.| | |Name<sup>*</sup>|Enter the name for the new collection.| |
| |If directory already exists|Select //Fail// to stop the workflow with an error, or //Do nothing// to continue the workflow without creating the directory.| | |If collection already exists|Select //Fail// to stop the workflow with an error, or //Do nothing// to continue the workflow without creating the collection.| |
| |
| <sup>*</sup> Setting can be specified using a [[:parameters|parameter]] or the first value of a column.\\ | <sup>*</sup> Setting can be specified using a [[:parameters|parameter]] or the first value of a column.\\ |
| |
| \\ | \\ |
| ====Delete directory settings==== | ====Delete collection settings==== |
| **Description:** Removes the selected Catalog directory. | **Description:** Removes the selected Catalog collection. |
| ^ Setting ^ Description ^ | ^ Setting ^ Description ^ |
| |Directory<sup>*</sup>|Enter or browse to the Catalog directory to be deleted. Note: All items contained in this directory will be deleted\\ as well!| | |Collection<sup>*</sup>|Enter or browse to the Catalog collection to be deleted. Note: All assets contained in this collection will be deleted\\ as well!| |
| |If directory doesn't exist|Select //Fail// to stop the workflow with an error, or //Do nothing// to continue the workflow without taking any action.| | |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.| |
| |
| <sup>*</sup> Setting can be specified using a [[:parameters|parameter]] or the first value of a column.\\ | <sup>*</sup> Setting can be specified using a [[:parameters|parameter]] or the first value of a column.\\ |
| |
| \\ | \\ |
| ====Move directory settings==== | ====Move collection settings==== |
| **Description:** Moves the selected directory to a different directory (selected directory becomes a //subdirectory// of the new location). | **Description:** Moves the selected collection to a different collection (selected collection becomes a //subcollection// of the new location). |
| ^ Setting ^ Description ^ | ^ Setting ^ Description ^ |
| |Directory<sup>*</sup>|Enter or browse to the Catalog directory to be moved.| | |Collection<sup>*</sup>|Enter or browse to the Catalog collection to be moved.| |
| |New location<sup>*</sup>|Enter or browse to the destination directory to move the selected directory to.| | |New location<sup>*</sup>|Enter or browse to the destination collection to move the selected collection to.| |
| |If directory already exists|Select //Fail// to stop the workflow with an error, or //Do nothing// to continue the workflow without moving the directory.| | |If collection already exists|Select //Fail// to stop the workflow with an error, or //Do nothing// to continue the workflow without moving the collection.| |
| |
| <sup>*</sup> Setting can be specified using a [[:parameters|parameter]] or the first value of a column.\\ | <sup>*</sup> Setting can be specified using a [[:parameters|parameter]] or the first value of a column.\\ |
| |
| \\ | \\ |
| ====Rename directory settings==== | ====Rename collection settings==== |
| **Description:** Renames the selected directory to the name provided. | **Description:** Renames the selected collection to the name provided. |
| ^ Setting ^ Description ^ | ^ Setting ^ Description ^ |
| |Directory<sup>*</sup>|Enter or browse to the Catalog directory to be renamed.| | |Collection<sup>*</sup>|Enter or browse to the Catalog collection to be renamed.| |
| |New name<sup>*</sup>|Enter the new name for the directory.| | |New name<sup>*</sup>|Enter the new name for the collection.| |
| |If directory already exists|Select //Fail// to stop the workflow with an error, or //Do nothing// to continue the workflow without renaming the directory.| | |If collection already exists|Select //Fail// to stop the workflow with an error, or //Do nothing// to continue the workflow without renaming the collection.| |
| |
| <sup>*</sup> Setting can be specified using a [[:parameters|parameter]] or the first value of a column.\\ | <sup>*</sup> Setting can be specified using a [[:parameters|parameter]] or the first value of a column.\\ |
| \\ | \\ |
| ====Set metric value settings==== | ====Set metric value settings==== |
| **Description:** Sets or updates the value of a catalog metric item. | **Description:** Sets or updates the value of a Catalog metric asset. |
| ^ Setting ^ Description ^ | ^ Setting ^ Description ^ |
| |Item path<sup>*</sup>|Enter or browse to the Catalog metric item to set or update the value of.| | |Asset path<sup>*</sup>|Enter or browse to the Catalog metric asset to set or update.| |
| |New value<sup>*</sup>|Enter the new metric item value to apply.| | |New value<sup>*</sup>|Enter the metric's new value to apply.| |
| |
| <sup>*</sup> Setting can be specified using a [[:parameters|parameter]] or the first value of a column.\\ | <sup>*</sup> Setting can be specified using a [[:parameters|parameter]] or the first value of a column.\\ |
| \\ | \\ |
| ====Get metric value settings==== | ====Get metric value settings==== |
| **Description:** Retrieves the value of a catalog metric item. | **Description:** Retrieves the value of a catalog metric asset. |
| ^ Setting ^ Description ^ | ^ Setting ^ Description ^ |
| |Item path<sup>*</sup>|Enter or browse to the Catalog metric item to retrieve the value of.| | |Asset path<sup>*</sup>|Enter or browse to the Catalog metric asset to retrieve the value of.| |
| |Append column|By default, the returned metric value becomes the current dataset. Check this option //on// to append the\\ returned value to the current dataset in a new column.| | |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)". | |
| |
| <sup>*</sup> Setting can be specified using a [[:parameters|parameter]] or the first value of a column.\\ | <sup>*</sup> Setting can be specified using a [[:parameters|parameter]] or the first value of a column.\\ |
| |
| ====Increment metric settings==== | ====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. | **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 ^ | ^ Setting ^ Description ^ |
| |Metric<sup>*</sup>|Enter or browse to the Catalog metric asset.| | |Metric<sup>*</sup>|Enter or browse to the Catalog metric asset.| |
| |Increment by<sup>*</sup>|The numeric value by which the metric is incremented. Negative or fractional numbers are acceptable, too.| | |Increment by<sup>*</sup>|The numeric value by which the metric is incremented. Negative or fractional numbers are acceptable as well.| |
| | |
| | <sup>*</sup> Setting can be specified using a [[:parameters|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<sup>*</sup>|Enter or browse to the Catalog state asset to set or update.| |
| | |New value<sup>*</sup>|Enter the state's new value to apply.| |
| | |
| | <sup>*</sup> Setting can be specified using a [[:parameters|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<sup>*</sup>|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)". | |
| |
| <sup>*</sup> Setting can be specified using a [[:parameters|parameter]] or the first value of a column.\\ | <sup>*</sup> Setting can be specified using a [[:parameters|parameter]] or the first value of a column.\\ |
| \\ | \\ |
| =====Remarks===== | =====Remarks===== |
| **Delete directory** - Use this mode //with caution// as any items stored within the selected directory will be deleted as well. Structure your workflow to detect and/or move any items you wish to keep before running this mode. | **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 //Data catalog// section from the //Start// tab. Click the down arrow at the top-right corner of the resource and select "Edit...". In the "Edit catalog item" window that appears, select the //Fields// tab. | 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. |
| |
| |
| =====See also===== | =====See also===== |
| |
| * [[transformations:retrievecatalogitem|Retrieve Catalog item]] | * [[transformations:retrievecatalogitem|Retrieve Catalog asset]] |
| | * [[transformations:sharedmemory|Shared memory]] |
| |
