renameFile Step
Description:
This step renames the existing file on the application server. Note: If the new filename includes an extension, the file is renamed using that extension. If the new filename doesn't include an extension, the file is renamed with the new filename and the source file's 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 or 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” and open it in Designer mode.
- Drag a “renameFile” step to the canvas.
- Connect the dots to the “Start” and “renameFile” steps, as shown above.
- Declare a variable or a global to store the new file path.
- Click the “renameFile” step to configure its “Required” properties. Provide a name for the step, then click the Save button. Note: Click the "AI Predict" button to have the Copilot add new process steps that match your process description.
- Click the “renameFile” step to configure its “Optional” properties. Enter the new file name. Enter the actual path on the server. Enter a variable or a global to store the new file path. Click the Save button.
- The “Logging” configuration is necessary for documentation and also measures workflow progress and 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 instance, and execute it. Render the process instance. Click the process step to view its properties. The process step renames an existing file on the server, and the new file path is stored in the filePath variable as configured.
Definition Sample:
You may download the sample definition(s) from the link here and later import them (drag-and-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 the import. Then, save the definition to confirm the changes.