Get a list of files

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

Last published at: September 12th, 2023

getFiles Step


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


  • 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 



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






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

  • Create a new definition called “getFilesDef” 
  • Select the definition and click the “design” button
  • Drag a “getFiles” step from the toolbox
  • Configure Variable variable.storeXML as string 
  • Connect the dots between the start and “getFiles”  step
  • Click on the “getFiles” step to configure its “Settings” properties. Provide a name to the step. Provide the folder path to download from. Provide the variable/global to store the file list in XML format after execution. 
  • Click on the “getFiles” step to configure its “Advanced” properties. Provide the file scope (wild card to filter). Select “YES” to download files from sub-folders. 
  • The “Logging” setting configuration is necessary for documentation and also measure the workflow progress and the percent complete. This is acheived by configuring the step state and percent fields individually as shown in the images below. Configure the “Logging” using the following properties.
  • Save the process definition, create a new process instance and execute. Render the process instance. Click on the process step to view the properties. The step should get list of files from directory to XML format and store the result in the variable or global.