Differences

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

--- transformations:spreadsheetmetadata [2021/03/10 11:32] – craigt
+++ transformations:spreadsheetmetadata [2021/07/15 12:56] (current) – craigt
@@ Line 1: / Line 1: @@
 {{ transformations:ExcelMetadataAction.png}}
-===== SPREADSHEET METADATA =====
+====== SPREADSHEET METADATA ======
-(Category: //Import | File//)
+Category: Import / File\\
+\\
 =====Description=====
 This action creates a list of sheet names, range names, or both, in a spreadsheet (.xls or .xlsx) file.\\
+\\
+=====Use cases=====
+The //Spreadsheet metadata// action can be convenient for extracting sheet and range names to pass down the workflow to reference specific parts of the Excel file:\\
+  * Iterate through all or specific sheets.
+  * Retrieve data from all or specific named ranges.
+  * Iterate through all or specific named ranges.
 \\
 =====Action settings=====
 ^ Setting  ^ Description  ^
-|File|Fully-qualified file name of the Excel file (.xls or .xlsx) (includes relative or absolute path).|
+|File<sup>*</sup>|Fully-qualified file name of the Excel file (.xls or .xlsx) (includes relative or absolute path).|
-|Mode|Defines the scope of the list returned.\\ Options: ⊕ //Sheets only//, ⊕ //Named ranges only//, ⊕ //Sheets and named ranges//.|
+|Mode|Defines the scope of the list returned.\\ Options: //Sheets only//, //Named ranges only//, //Sheets and named ranges//.|
+<sup>*</sup> Setting can be specified using a [[:parameters|parameter]].\\
-^**//Mode// settings**^^
+\\
+====Mode settings====
 ^Setting^Description^
-|Sheets only|Returns a single-column dataset listing the __sheet names__ found within the source file.|
+|Sheets only|Returns a two-column dataset listing the //sheet names// found within the source file, and whether the sheets are hidden or not.|
-|Named ranges only|Returns a single-column dataset listing the __named range names__ found within the source file.|
+|Named ranges only|Returns a two-column dataset listing the //named range names// found within the source file, and whether the ranges are hidden or not.|
-|Sheets and named ranges|Returns a single-column dataset listing __both__ the sheet names and named range names found within the source file.|
+|Sheets and named ranges|Returns a two-column dataset listing //both// the sheet names and named range names found within the source file, and whether these entities are hidden or not.|
 \\
-=====Use cases=====
+=====Community examples=====
+  * [[https://community.easymorph.com/t//1766/1|Load only workbooks with given number of sheets]] ([[https://community.easymorph.com/uploads/short-url/AbWPlfPVBecqgZUBVTYlljwb9NO.morph|Project]]; Module: //Get sheet names//; Group: //Tab 1//; Table: //Imported table 1//;\\ Action position: //1//)
-The ''Spreadsheet metadata'' action can be convenient for extracting sheet and range names to pass down the workflow to reference specific parts of the Excel file:\\
-  * Iterate through all or specific sheets.
-  * Retreive data from all or specific named ranges.
-  * Iterate through all or specific named ranges.
 \\