Differences

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

--- transformations:exportdataset [2018/08/15 08:26] – created dmitry
+++ transformations:exportdataset [2024/08/17 09:09] (current) – [Remarks] dmitry
@@ Line 1: / Line 1: @@
-===== Export dataset =====
+{{ transformations:ExportDatasetAction.png}}
+====== EXPORT DATASET (.dset) ======
+Category: Export / File\\
-This action exports a dataset (tabular data) into a file in the native EasyMorph format (.dset). The native format allows very fast loading data into EasyMorph as there is no data conversion.
+\\
+=====Description=====
+This action exports a dataset (tabular data) into a file in the native EasyMorph format (.dset) that is stored either locally or on EasyMorph Server. The native format allows very fast writing as well as loading of the data into EasyMorph as there is no data conversion.
-One .dset file contains one dataset.
+One .dset file contains one dataset.\\
-==See also==
+\\
+=====Use cases=====
+When working with large datasets that require significant load times, converting the source tables to .dset files and loading those into the workflow can increase overall process performance.\\
+Exporting a dataset into a .dset file that is stored on EasyMorph Server or is encrypted can be more secure than saving it into a CSV file or a spreadsheet.
+\\
+=====Action settings=====
+^ Setting  ^ Description  ^
+|Export to| Select whether the .dset file will be written to a local file (on your system) or to an EasyMorph Server.\\ Options:  //Local file// or //EasyMorph Server//. |
+\\
+====Local file settings====
+^Setting ^ Description ^
+|File<sup>*</sup>| The fully-qualified file name of the output dataset (includes relative or absolute path). |
+|File already exists|If a file with the same name already exists, choose whether to overwrite the existing file, rename the existing file,\\ or halt the action's execution.  See the "File already exists options" table below for details.|
+|Encrypt columns|When checked, one or more columns in the dataset will be encrypted and require a password to access.\\  See the "Encrypt columns options" below for details.|
+<sup>*</sup> Setting can be specified using a [[:parameters|parameter]].\\
+\\
+====EasyMorph Server file settings====
+^Setting ^Description ^
+|Link to Server|Select to use the pre-configured link to an EasyMorph Server.  (Use the Start screen to configure the Server Link\\ if you haven't already done so.|
+|Connector<sup>*</sup>|Select the pre-configured connector to the EasyMorph Server.|
+|Path<sup>*</sup>|The fully-qualified file name of the dataset.|
+|File already exists|If a file with the same name already exists, choose whether to overwrite the existing file, rename the existing file,\\ or halt the action's execution.  See the "File already exists options" table below for details.|
+|Encrypt columns|When checked, one or more columns in the dataset will be encrypted and require a password to access.\\  See the "Encrypt columns options" below for details.|
+<sup>*</sup> Setting can be specified using a [[:parameters|parameter]].\\
+\\
+====Advanced options====
+^Option ^Description ^
+|Encryption|Check "Encrypt columns" //on// and provide an encryption password.  Select whether all or selected columns will be encrypted.|
+|Custom properties|Enter Name and Value<sup>*</sup> custom property pairs.  Custom properties are //not// encrypted.  Do not use for sensitive data.|
+<sup>*</sup> Setting can be specified using a [[:parameters|parameter]].\\
+\\
+====Mode options====
+^Option ^Description ^
+|Create or overwrite|This option will create a new dataset file (if one doesn't already exist) or overwrite the file if it already exists.|
+|Append or create|This open will create a new dataset file (if one doesn't already exist) or append rows to an existing file.|
+\\
+====Create or overwrite options====
+//If a file with such name already exists//
+^Option ^Description ^
+|Overwrite|The new file replaces the original file.|
+|Rename|The original file will be renamed with "backup" and a serial number appended to the file name.  The new file will\\ possess the name specified in the //File// or //Path// setting.|
+|Halt project execution|The project will stop processing and this action will display a warning symbol.|
+\\
+====Append or create options====
+//If appended data contains new columns//
+^Option ^Description ^
+|Add new columns|This option will add columns from the exported file that are not found in the existing dataset file.|
+|Ignore new columns and warn|This option will ignore (not append) columns in the exported file that are not found in the existing dataset file, display a warning, and the workflow will continue running.|
+|Halt project execution|The project will stop processing and this action will display a warning symbol.|
+\\ \\
+=====Remarks=====
+When importing a dataset (.dset) file with encrypted columns, the [[transformations:importdataset|Import dataset]] action icon will initially appear with a warning symbol and no data will show in the data grid.  Enter the //Password// in the action settings to decrypt and view all columns.
+If you do not have access to a dataset's password, select //Load only selected columns// and scroll down the dataset's column list.  Encrypted columns will appear with "lock" next to their names.  Select only unencrypted columns and click "Apply" to display those columns' data in the data grid.\\
+:!: The encryption password can't be recovered. If it's lost, all the data encrypted with the password will become inaccessible.
+\\
+When appending rows to a target file on EasyMorph Server, this action will fail if another workflow modifies the file before appending finishes. In case of parallel access to the file, use the [[transformations:exclusiveaccess|Start/finish exclusive access]] action.
+\\
+The .dset format stores compressed data in columns. Therefore, appending new rows to a dataset can be slow on large tables because appending requires decompressing and re-compressing the whole dataset.
+\\
+=====Community examples=====
+  * [[https://community.easymorph.com/t//1769/1|How to do recursive loops in EasyMorph]] ([[https://community.easymorph.com/uploads/short-url/qM6kmqrDRWiEDJFljIa2u6QWre1.morph|Project]]; Module: //Main//; Group: //Tab 1//; Table: //Data//; Action position: //2//)
+  * [[https://community.easymorph.com/t//1854/2|Product of Rows in a Column]] ([[https://community.easymorph.com/uploads/short-url/8o7F1FHzlEr0hUV2BgCLFNEMKqk.morph|Project]]; Module: //Multiply line//; Group: //Tab 1//; Table: //Imported table 1//; Action position: //3//)
+  * [[https://community.easymorph.com/t//2653/1|Extracting all projects published in the Community and their actions]] ([[https://community.easymorph.com/uploads/short-url/mrnJQUJJL8Do1T8ioicyzE1VgmK.morph|Project]]; Module: //Main loop//; Group: //Group 1//; Table: //Actions//; Action position: //5//)
+\\
+=====See also=====
   * [[transformations:importdataset|Import dataset]]