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 the “removeFile” step to configure its “Settings” properties. Provide a name to the step. 

 

  • Click 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 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 process instance, and execute. Render the process instance. Click on the process step to view its properties. The step should permanently remove the file from the server.

 

Definition Sample:

You may download the sample definition(s) from the link here and later import it (drag-drop) to your FlowWright Process Definition (XML file) or Form Definition (HTML file) page.

NOTE: Please verify and complete the process steps for any missing configurations, such as file path references and database connections after import. Then, save the definition to confirm the changes.

Click here to download the sample file.