Differences

This shows you the differences between two versions of the page.

--- playground:playground [2021/09/13 00:03] – craigt
+++ playground:playground [2023/02/01 18:39] – craigt
@@ Line 1: / Line 1: @@
-===== Empty() =====
+{{ transformations:retrievecatalogitemaction.png}}
-Category:  Special function
+====== RETRIEVE CATALOG ITEM ======
+Category: Workflow / App/Cloud\\
 \\
 =====Description=====
-This function creates an [[syntax:types#empty_values|empty value]].
+This action retrieves a static or computed item from the Data Catalog.
 \\
 =====Use cases=====
-Use //empty()// to insert empty values into cells, or within other functions.
+Use the various modes of this action to extract information about Catalog items, and manipulate the structure of the Data Catalog.
+Use field items to store and retrieve metadata items about the resource or resource's data.
 \\
-=====Arguments=====
+=====Action settings=====
-This function does not require arguments.
+^ Setting  ^ Description  ^
+|Retrieve|Select the type of Catalog resource to retrieve.  Options: //Dataset// (an EasyMorph .dset file), //File// (any non-.dset file), or //URL//.|
+|Catalog item<sup>*</sup>|Enter or browse to the Catalog resource to retrieve.|
-**Return value type:** Empty value
+<sup>*</sup> Setting can be specified using a [[:parameters|parameter]] or the first value of a column.\\
-\\
-=====Remarks=====
-While a value can be tested for an empty value using a "value = empty()" expression, the [[syntax:functions:isempty|IsEmpty]] function can also be used.  The two approaches are equivalent.
-\\
+====Results settings====
-=====Examples=====
+Note:  These options are only available for the //Dataset// and //File// Catalog item types.
+^Setting  ^Description  ^
+|Return file path as action's output|Returns a single-row, 4-column dataset containing information about the selected Catalog resource:  the resource's relative path, the connector type used, the connector name used, and the resource's item type.|
+|Save as<sup>*</sup>|Downloads and saves the resource.  Enter or browse to a folder on the local system and enter a filename.|
-  [Content] = empty()  //Returns TRUE if [Content] contains an empty value, otherwise, FALSE.
-  coalesce(empty(), 'ABC', '')  //Using empty() as an argument within a function.
+====Parameters settings=====
+//Dataset// Catalog items (EasyMorph native .dset files) can contain parameters that may be set here by selecting the //Parameter// in the list and selecting the field in //This project// to use for the value.
-  if( [Value] = 10, 'Ten', empty() )  //Using empty() to set an empty value in an If statement.
 \\
-=====See also=====
+=====Remarks=====
-  * [[syntax:functions:isempty|IsEmpty(expression)]]
+**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.
-  * [[syntax:types|The EasyMorph Type system]]
+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.
+\\
+=====See also=====
+  * [[transformations:retrievecatalogitem|Retrieve Catalog item]]