User Tools

Site Tools


transformations:exportdataset

EXPORT DATASET (.dset)

Category: Export / File


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.


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* The fully-qualified file name of the output dataset (includes relative or absolute path).
File already existsIf 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 columnsWhen 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.

* Setting can be specified using a parameter.

EasyMorph Server file settings

Setting Description
Link to ServerSelect 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*Select the pre-configured connector to the EasyMorph Server.
Path*The fully-qualified file name of the dataset.
File already existsIf 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 columnsWhen 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.

* Setting can be specified using a parameter.


Encrypt columns options

Option Description
Password Provide the password that will be required to access the encrypted data.
Encrypt columnsSelect whether to encrypt all columns in the .dset file, or just selected columns (and choose which columns to encrypt).


Mode options

Option Description
Create or overwriteThis option will create a new dataset file (if one doesn't already exist) or overwrite the file if it already exists.
Append or createThis 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
OverwriteThe new file replaces the original file.
RenameThe 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 executionThe 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 columnsThis option will add columns from the exported file that are not found in the existing dataset file.
Ignore new columns and warnThis 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 executionThe project will stop processing and this action will display a warning symbol.



Remarks

When importing a dataset (.dset) file with encrypted columns, the 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.

Community examples


See also

transformations/exportdataset.txt · Last modified: 2023/11/24 20:01 by craigt

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki