Differences

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

--- transformations:filelist [2020/10/06 04:52] – dmitry
+++ transformations:filelist [2021/03/19 12:32] – craigt
@@ Line 1: / Line 1: @@
-===== List of files =====
+{{ transformations:FileListAction.png}}
+====== LIST OF FILES ======
+Category: Create / Generate
-This action creates a table with a list of files in specified folder and their attributes. Such list can later be used for iterations or file commands.
+=====Description=====
+This action creates a table with a list of files in the specified folder and their attributes.\\
-**See also:**
+\\
-  * [[folderlist|List of folders]]
+=====Action settings=====
-  * [[iterate|Iterate]]
+^ Setting  ^ Description  ^
-  * [[iterateprogram|Iterate external program]]
+|Folder|The folder to extract the list of files from.|
+|Columns|Provides options to select the types of data to return as fields in the dataset.  See below.|
+|Subfolders|Provides options to scan through subfolders within the chosen folder.  See below.|
+\\
+====Columns====
+These options define the columns that will be included in the generated dataset. At least one option must be selected.
+^Option^Description^
+|File name with pull path|Returns the fully-qualified file name including absolute path.  Default.|
+|File name only|Returns the file name only, excluding path.|
+|File extension|Returns the file's extension only.|
+|Size|Returns the file's size, in bytes.|
+|Date created|Returns the date the file was originally created.|
+|Date modified|Returns the date the file was last edited.|
+|Read-only|Returns a Boolean (TRUE/FALSE) value defining whether the file is set to read-only mode, or is editable (read/write).|
+\\
+====Subfolders====
+^Option^Description^
+|Scan subfolders|When selected, additional options are presented to define the //scan depth// and //scan error handling//.|
+|Scanning depth|The number of subfolder levels, under the parent folder, the action will scan within.  e.g. "1" will scan through the\\ subfolders found //directly// under the parent folder only; "2" will scan through the subfolders of the subfolders\\ (i.e. 2 levels deep) found under the parent folder.|
+\\
+=====Use cases=====
+ The created file list can be used later for iterations or file commands.\\
+\\
+=====See also=====
+  * [[transformations:folderlist|List of folders]]
+  * [[transformations:iterate|Iterate]]
+  * [[transformations:iterateprogram|Iterate external program]]