User Tools

Site Tools


transformations:folderlist
no way to compare when less than two revisions

Differences

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


Previous revision
Next revision
transformations:folderlist [2021/03/19 12:51] craigt
Line 1: Line 1:
 +{{ transformations:FolderListAction.png}}
 +====== LIST OF FOLDERS ======
 +Category: Create / Generate
 +
 +=====Description=====
 +This action creates a table with a list of folders in the specified folder.\\
 +
 +\\ 
 +=====Action settings=====
 +^ Setting  ^ Description  ^
 +|Folder|The folder to extract the list of //direct// subfolders 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^
 +|Folder name with pull path|Returns the fully-qualified folder name including absolute path.  Default.|
 +|Folder name only|Returns the folder name only, excluding path.|
 +
 +\\ 
 +====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.|
 +|Ignore scan errors|Select to ignore any errors produced when scanning subfolders for files.  This is useful for avoiding errors when\\ scanning folder depths that may not exist in all subfolders.|
 +
 +\\ 
 +=====Use cases=====
 +Such a table can be used later for iterations, folder commands, or file commands.\\
 +
 +\\ 
 +=====See also=====
 +  * [[transformations:filelist|List of files]]
 +  * [[transformations:iterate|Iterate]]
 +  * [[transformations:iterateprogram|Iterate external program]]
  
transformations/folderlist.txt · Last modified: 2023/04/21 00:59 by craigt

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki