dropBoxRenameFile Step
Description:
The DropboxRenameFile workflow step renames a specified file in Dropbox as part of a FlowWright process.
The step uses a configured OAuth provider to access Dropbox and allows the workflow to specify the existing file path and the new file name.
The step supports:
- Selecting an OAuth provider.
- Specifying the Dropbox file to rename.
- Specifying the new file name.
- Renaming files as part of workflow automation.
- Using workflow-generated values for file paths or names where supported.
- Continuing the workflow through True or False return paths.
Inputs
- selOAuthProvider - The Select OAuth provider property specifies the OAuth provider that should be used to access Dropbox.
- filePath - The Path of the file to be renamed property specifies the existing Dropbox file that should be renamed.
- renamedTo – The Rename file to property specifies the new name for the selected Dropbox file.
Returns
- True – The True return path can be connected to the next workflow activity when the file rename operation succeeds.
- False – The False return path can be used for error handling or an alternative workflow path when the file rename operation does not succeed.
Usage:
The Rename File step is typically placed after a workflow has created, uploaded, processed, or otherwise obtained a file that needs to be renamed in Dropbox.
A typical workflow pattern is:
Create/Upload File → Rename File → Continue Process
For example:
Generate Report → Rename File → Notify User
The workflow identifies the existing Dropbox file using the path of the file to be renamed and provides the new file name using Rename File to.
A typical workflow can also use the result of the operation to determine whether processing should continue:
Rename File → True → Continue
Rename File → False → Error Handling
To use this step, you must configure the Dropbox connection in the FlowWright application. To do so, go to Integrate > Connections > OAuth and create a new OAuth source.
A sample Dropbox connection configuration is provided here for reference.
Typical Workflow Suggestions:
Rename a Generated Report
Use the step when a report uploaded to Dropbox initially has a temporary name and should receive its final name after processing.
Example:
Generate Report → Upload File → Rename File → Continue
Existing file:
/Reports/MonthlyReport_Temp.pdf
New file name:
MonthlyReport.pdf
The workflow can rename the file after report generation and upload are complete.
Rename a File After Approval
Use the step to rename a file after an approval event.
Example:
Approval → Rename File → Continue Process
Existing file:
/Requests/REQ-1045/Request-Pending.pdf
New file name:
Request-Approved.pdf
This can provide a file naming convention that reflects the workflow state.
Rename a File After Rejection
Use the same pattern when a workflow reaches a rejection state.
Example:
Review → Rename File
Existing file:
/Requests/REQ-1045/Request-Pending.pdf
New file name:
Request-Rejected.pdf
The True path can continue processing after the rename operation.
Rename Processed Documents
Use the step to rename a file after a document-processing operation has completed.
Example:
Process Document → Rename File → Archive
Existing file:
/Documents/Invoice_1045.pdf
New file name:
Invoice_1045_Processed.pdf
This can make the processing state visible through the file name.
Rename a File Based on Workflow Data
Use workflow-generated values when the new file name needs to reflect process information.
Example:
Get Request Data → Rename File
Existing file:
/Requests/REQ-1045/Document.pdf
New file name:
REQ-1045-Completed.pdf
The exact Variable reference syntax should follow the conventions supported by the FlowWright environment.
Rename a File After Upload
The Rename File step can be used immediately after a file has been uploaded to Dropbox.
Example:
Create File → Upload File → Rename File → Notify User
This pattern can be useful when the upload process initially uses a temporary or generated file name.
Rename a File After Document Generation
Use the step after a workflow generates a document.
Example:
Generate Document → Upload File → Rename File
For example:
Existing file:
/Reports/Report_Output.docx
New file name:
Final_Report.docx
This allows the workflow to apply a standardized name after document generation.
Handle Successful and Failed Rename Operations
Use the True and False return paths to handle the result of the rename operation.
Example:
Start → Rename File
True → Continue Process
**False → Log Error`
The XML explicitly defines the two return values as True and False.
Rename Files as Part of an Archive Process
Use the step when completed workflow files need to follow an archive naming convention.
Example:
Complete Workflow → Rename File → Archive Processing
Existing file:
/Active/Request-1045.pdf
New file name:
Request-1045-Archived.pdf
The workflow can then continue with other archive-related activities.
Rename Files According to Workflow Status
A workflow can use different Rename File steps for different process outcomes.
For example:
Approved path:
Review → Rename File → Approved
Existing file:
Request-1045-Pending.pdf
New file name:
Request-1045-Approved.pdf
Rejected path:
Review → Rename File → Rejected
Existing file:
Request-1045-Pending.pdf
New file name:
Request-1045-Rejected.pdf
This allows the Dropbox file name to reflect the workflow outcome.
Rename a File Before Notification
Use the Rename File step before sending a notification to users.
Example:
Complete Processing → Rename File → Send Notification
You can send the notification after the file has been successfully renamed.
Example:
Let’s build and execute the “DropboxRenameFileDef” example.
- Create a new definition named “DropboxRenameFileDef” and open it in designer mode.
- Drag a “DropboxRenameFile” step to the canvas.
- Connect the dots between the “Start” step and “DropboxRenameFile” steps, as shown above.
- Select the line between the steps to configure the “Connection Properties”. The default property values are “None, True, False, Error, and Evaluate”. Depending on the step’s purpose, you can configure additional values.
- Click the “DropboxRenameFile” step to configure its “Required” properties. Provide a name for the step. Select the “Dropbox” OAuth provider from the drop-down list. Provide the folder path and the file name to rename. Provide the new file name. Click the Save button. Note: Click the "AI Predict" button for the Copilot to add new process steps that match your process description.
- The “Logging” configuration is necessary for documentation and also measures workflow progress and percent complete. Configure the step state and percent fields individually, as shown below. Configure the “Logging” using the following properties.
- Save the process definition, create a new instance, and execute it. Render the process instance and click the Rename File step to view its properties. When the workflow reaches the Rename File step, FlowWright uses the configured OAuth provider, existing file path, and new file name to perform the rename operation. Verify:
- The correct OAuth provider is selected.
- The existing Dropbox file path is correct.
- The target file exists.
- The new file name is correct.
- The file has been renamed as expected.
- The workflow follows the expected True or False path.
Tips:
- Select the correct OAuth provider before executing the workflow.
- Verify that the OAuth configuration has the required access to the Dropbox location.
- Verify that the file specified in the Path of the file to be renamed exists.
- Use an exact and meaningful Dropbox file path.
- Use a clear and consistent file-naming convention.
- Test the rename operation with a representative Dropbox file before deploying the workflow.
- Verify the renamed file in Dropbox after execution.
- Test both the True and False workflow paths.
- Connect the False path to appropriate error handling or recovery processing.
- Verify that the new file name is appropriate before executing the rename operation.
- Avoid unintentionally renaming a file that is used by another workflow.
- Use consistent file-naming conventions across related workflows.
- When using dynamically generated file names, test the resulting name with representative workflow data.
- Verify any Variables used to construct file paths or names before the Rename File step executes.
- Test the workflow after changing the OAuth provider configuration.
- Test the workflow after changing the source file path.
- Test the workflow after changing the new file name.
- Verify the renamed file before allowing downstream workflow activities to use it.
- Consider connecting the False return path to logging or notification when a rename operation fails.
- Keep file names understandable for users who access the Dropbox location outside the workflow.
- Avoid including unnecessary sensitive information in file names.
- If multiple workflows operate on the same Dropbox files, establish consistent naming conventions.
Definition Sample:
You may provide a sample FlowWright Process Definition demonstrating the DropboxRenameFile step.
When importing the sample definition, verify and complete any missing configuration, including:
- OAuth provider.
- Existing Dropbox file path.
- New file name.
- Workflow Variable references used in file paths or names.
- Environment-specific OAuth configuration.
- Dropbox file availability.
- True workflow path.
- False workflow path.
- Downstream activities that reference the renamed file.
After verifying the configuration, save the Process Definition before execution.
Click here to download the sample file.