Search and replace file

Use this step to search and replace text in new file.

Last published at: September 1st, 2023

searchAndReplaceFile Step


This step does a search and replace text in a new file. 


  • inputFilePath– Input file path
  • outputFilePath – Output file path
  • mappingString – Mapping of search and replace strings 



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






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

  • Create a new definition called “searchAndReplaceFileDef” 
  • Select the definition and click the “design” button
  • Drag a “searchAndReplaceFile” step from the toolbox
  • Connect the dots between the start and “searchAndReplaceFile” step 
  • Click on the “searchAndReplaceFile” step to configure its “Settings” properties. Provide a name to the step. Provide a file patch for input source. Provide a file path to store for output. Click on the button to map the search and replace strings.  
  •  Click on the button to map the search and replace strings.  
  • 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 search and replace file contents and creates new file.