Removes a file from the file system

Use this step to remove a file from the folder.

Last published at: September 12th, 2023

removeFile Step

Description:

This step removes a file (permanently) from the folder path on the application server.

Inputs

  • filePath – full path to the file on the server
 

 

Returns

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

 

Usage:

 

 

Example:

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

  • Create a new definition called “removeFileDef” 
  • Select the definition and click the “design” button
  • Drag a “removeFile” step from the toolbox
  • Connect the dots between the start and “removeFile” step
  • Click on the “removeFile” step to configure its “Settings” properties. Provide a name to the step. 
  • Click on the “removeFile” step to configure its “Advanced” properties. Provide a file path info to remove.
  • 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 remove file permanently from the server.