containsInFile Step

Use this step to verify the search item is contained in the file contents.

Last published at: September 1st, 2023


This step verifies the search item is contained in the file contents. 


  • inputFilePath - Path for the file on the App server
  • searchTerms - List of search terms
  • variableToStoreValue - Variable/Global to store the list of matched search terms



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






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

  • Create a new definition called “containsInFileDef” 
  • Select the definition and click the “design” button
  • Drag a "containsInFile" step to the canvas
  • Connect the dots between the start and "containsInFile" step
  • Define a variable/global to store the result after execution
  • Click on the "containsInFile" step to configure its “Settings” properties. Provide a name to the step. Provide the file path. Provide the search items list separated by a carriage return. Provide a variable/global to store the result. 
  • 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. The process step should search the "terms" in the file contents and store the match in variable.result, as configured.