Differences

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

--- transformations:exportexcel [2015/10/01 22:04] – created dmitry
+++ transformations:exportexcel [2021/07/17 15:35] – craigt
@@ Line 1: / Line 1: @@
-===== Export into Excel spreadsheet =====
+{{ transformations:ExportExcelAction.png}}
+====== EXPORT INTO EXCEL SPREADSHEET ======
+Category: Export / File\\
-This transformation exports table into a spreadsheet.
+\\
+=====Description=====
+This action exports a table into an Excel spreadsheet (.xlsx) file.  The file name can use either a full or relative path.\\
-File name can use either full or relative path.
+\\
+=====Use cases=====
+You can subdivide a dataset and export it to a multi-tabbed Excel file using iterations and passing the sheet names in using Parameters in the called module.\\
-The transformation can operate in two modes:
+\\
-  * Create new file - creates a new spreadsheet
+=====Action settings=====
-  * Replace sheet in existing file - takes existing spreadsheet and replaces specified sheet content with table from EasyMorph. Other sheets remain intact.
+^ Setting  ^ Description  ^
+|File<sup>*</sup>|Enter a fully-qualified file name for the output file (includes relative or absolute path).  |
+|Mode|Select whether this action will create a new file, create a new sheet in an existing file,\\ or replace a sheet or range in an existing file .  See the table below for details.|
+|File already exists|When selecting to "Create new file" in the option above, 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.|
+|Sheet name<sup>*</sup>|When selecting to "Create new file" or "Create a new sheet in existing file" in the option above, enter the name\\ for the new sheet.|
+|Sheet or range<sup>*</sup>|When selecting "Replace sheet/range in existing file", select the sheet or named range to replace.|
+|Create named range|When "Create new file" is selected in the option above, the dataset will be written into a named range in the new file.\\  Enter the name of the range in the //Range name// field.|
+<sup>*</sup> Setting can be specified using a [[:parameters|parameter]].\\
+\\
+====Export mode options====
+^Option ^Description ^
+|Create new file|Create a new Excel file or overwrite an existing file with the same name.  See the "File already exists\\ options" table below for additional details.|
+|Create new sheet in existing file|This option will export the dataset to a new sheet inserted into the existing file selected in the //File//\\ setting, above.|
+|Replace sheet/range in existing file|This option will output the dataset to an existing sheet or named range within the file selected in the\\ //File// setting, overwriting its content.|
+\\
+====File already exists options====
+^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// setting.|
+|Halt project execution|The project will stop processing and this action will display a warning symbol.|
+\\
+=====Remarks=====
+If you're "creating a new sheet" or "replacing a sheet/range", or "overwriting an existing file", the target file must be closed prior to running this action or it will result in a warning and no content will be written.  Close the target file and rerun this action to complete it successfully.
+When creating a new sheet in an existing file, the new sheet will appear in the rightmost (last) position.  A sheet being replaced in an existing file will retain its original position within the file.\\
+\\
+=====Community examples=====
+  * [[https://community.easymorph.com/t//1273/6|Split Excel spreadsheets into multiple spreadsheets]] ([[https://community.easymorph.com/uploads/short-url/6iWYdZJc4yAvqYMbTGZWXtVFmvL.morph|Project]]; Module: //Main//; Group: //Tab 1//; Table: //Table 1//; Action position: //4//)
+  * [[https://community.easymorph.com/t//1392/6|Data validation list]] ([[https://community.easymorph.com/uploads/short-url/aZNapMreakaQZa83qs7fB3TS2oq.morph|Project]]; Module: //Main//; Group: //Tab 1//; Table: //Change validation list values//; Action position: //2//)
+  * [[https://community.easymorph.com/t//1625/4|Create a new table with columns based on row values]] ([[https://community.easymorph.com/uploads/short-url/4oGLUNDHrUfB971H80ciuOAtOTG.morph|Project]]; Module: //Module 1//; Group: //Tab 1//; Table: //Table 1//; Action position: //7//)
+\\
+=====See also=====
+  * [[transformations:importexcel|Import Excel spreadsheet]]