readFile Step

Use this step to read from a text file.

Last published at: June 7th, 2024


This step reads from a TEXT file.



  • txtVarGlobalFilePath – Input file path
  • contentVariable - Variable/Global to hold the content



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






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

  • Create a new definition called “readTxtFileDef.” 
  • Select the definition and click the “design” button
  • Drag a “readFile” step from the toolbox
  • Connect the dots between the start and “readFile” step
  • Configure Variable variable.newFilePath as string 
  • Click the “readFile” step to configure its “Settings” properties. Provide a name to the step. Provide the input file path with text content. Provide a variable/global that holds the text content after execution.


  • 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 in the images below. Configure the “Logging” using the following properties.


  • Save the process definition, create a new instance, and execute. Render the process instance. Click on the process step to view the properties. The step should read the file contents to the variable/global.