Get Filelist

Use this step to fetch a list of files from a directory.

Last published at: February 24th, 2025

getFiles Step

Description:

This step retrieves a list of files from a directory in XML format.

 

Inputs

  • folderPath – The physical path of the folder from which the files are to be downloaded. Ex: - C:\Folder1
  • fileScope – File Scope (for e.g: *.png)
  • selectSubFolders – Selection of sub folders which are displayed in the main folder. Ex: - /folder1/folder2
  • variableToStore - Variable to store the list of files XML downloaded from the directory 
 

 

Returns

  • True – step executed successfully
  • False – step failed to execute 
 

 

 

Usage:

 

 

Example:

Let’s build and execute the “getFilesDef” example.          

  • Create a new process definition called “getFilesDef” and open it in Designer mode. 
  • Drag a “getFiles” step to the canvas.
  • Connect the dots between the “Start” step and “getFiles” steps, as shown above. 
  • Define a variable or a global to store the result. 
  • Click the “getFiles” step to configure its “Required” properties. Provide a name for the step. Provide the folder path to download from. Provide a variable or global reference to store the file list in XML format after execution. Click the Save button. Note: Click the "AI Predict" button for the Copilot to add new process steps that match your process description. 

 

  • Click the “getFiles” step to configure its “Optional” properties. Provide the file scope (wild card to filter). Select “Yes” to download files from sub-folders. Click the Save button. 

 

  • The “Logging” setting configuration is necessary for documentation and also measures the workflow progress and the percent complete. This is achieved by configuring the step state and percent fields individually, as shown below. Configure the “Logging” using the following properties.

 

  • Save the process definition, create a new instance, and then execute it. Render the process instance. Click the process step to view the properties. The step should get a list of files from the directory in XML format and store the result in a variable or a global variable.

 

Definition Sample:

You may download the sample definition(s) from the link here and later import them (drag-and-drop) to your FlowWright Process Definition (XML file) or Form Definition (HTML file) page.

Note: Please verify and complete the process steps for any missing configurations, such as file path references and database connections, after import. Then, save the definition to confirm the changes.

Click here to download the sample file.