Differences

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

--- playground:playground [2021/09/17 22:10] – craigt
+++ playground:playground [2023/02/01 18:39] – craigt
@@ Line 1: / Line 1: @@
-====== Decode(method, text) ======
+{{ transformations:retrievecatalogitemaction.png}}
-Category:  Web function
+====== RETRIEVE CATALOG ITEM ======
+Category: Workflow / App/Cloud\\
 \\
 =====Description=====
-This function decodes a text string using one of the available methods below.
+This action retrieves a static or computed item from the Data Catalog.
 \\
-=====Arguments=====
+=====Use cases=====
-^Argument^Type^Description^
+Use the various modes of this action to extract information about Catalog items, and manipulate the structure of the Data Catalog.
-|method  | Text |The decoding method to use on //text//.  See the table below.  |
-|text  |Text |The text string to be decoded.  |
+Use field items to store and retrieve metadata items about the resource or resource's data.
-**Return value type:** Text.
 \\
-^Method  ^Notes  ^
+=====Action settings=====
-|'uriComponentEscape' |Unescapes a URI, and then converts any plus characters ("+") into spaces. |
+^ Setting  ^ Description  ^
-|'Base64' |
+|Retrieve|Select the type of Catalog resource to retrieve.  Options: //Dataset// (an EasyMorph .dset file), //File// (any non-.dset file), or //URL//.|
-|'Base64url' | Base64 in URL encoding |
+|Catalog item<sup>*</sup>|Enter or browse to the Catalog resource to retrieve.|
+<sup>*</sup> Setting can be specified using a [[:parameters|parameter]] or the first value of a column.\\
+====Results settings====
+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.|
+====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.
 \\
-=====Examples=====
+=====Remarks=====
-  decode("uriComponentEscape", "one%2Bone")  //Returns 'one+one'
+**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.
+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=====
-  * [[syntax:functions:encode|Encode(method, text)]]
-  * [[syntax:functions:hexdecode|HexDecode(encoding, hex_text)]]
-  * [[syntax:functions:uridecode|URIDecode(encoding, value)]]
+  * [[transformations:retrievecatalogitem|Retrieve Catalog item]]