renameFile Step

Use this step to rename a file on the application server

Last published at: October 25th, 2024

Description:

This step is used to rename the existing file on the application server. Note: If the new filename has an extension, the file is renamed using the new filename and its extension. If the new file name doesn't have the extension, the file is renamed with the new filename and the source file name extension.

 

Inputs

  • newFileName – The file name is to be renamed.Ex: - testFile.txt to testFile_Old.txt (or) testFile.txt to testFile.html
  • filePath - the path of the source directory where the file resides
  • newFilePathVarGlobal – Variable/Global to store the new file path
 

 

Returns

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

 

Usage:

 

 

Example:

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

  • Create a new process definition called “renameFileDef”  
  • Select the definition and click the “design” button
  • Drag a “renameFile” step from the toolbox to the canvas
  • Connect the dots to the Start step and “renameFile” step
  • Declare a variable/global to store the new file path
  • Click the “renameFile” step to configure its “Settings” properties. Provide a step name.

 

  • Click the “renameFile” step to configure its “Advanced” properties. Provide the new file name. Provide the actual path information (on the server). Provide a variable/global to store the new file path information. 

 

  • 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 it. The process step renames an existing file on the server, and the new file path is stored in the variable filePath as configured. 

 

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.