Rename a folder in the Box

Use this step to rename a folder in the box

Last published at: February 13th, 2025

BoxRenameFolder Step

Description:

Rename Folder enables a FlowWright workflow to rename an existing folder in Box using a configured OAuth provider, the folder path or Folder ID, and the new folder name.

The Rename Folder workflow step is used to change the name of a folder in Box from within a FlowWright workflow.

The step supports:

  • Selecting an OAuth provider for the Box operation.
  • Identifying the folder using its path or Folder ID.
  • Specifying the new folder name.
  • Storing the operation result in a Variable or Global variable.
  • Continuing the workflow through the True return path.
  • Using the False return path for an alternative workflow path or error handling.

 

Inputs

  • Select OAuth Provider - Specifies the OAuth provider that should be used to access Box.
  • Path/FolderID of the Folder to be Renamed - Identifies the Box folder that should be renamed.
  • Rename Folder To - Specifies the new name that should be assigned to the selected Box folder.
  • Variable/Global to Store the Result - Specifies the Variable or Global variable where the result of the folder-renaming operation should be stored.
 

 

Returns

  • True – The True return path can be connected to the next workflow activity when the folder-renaming operation succeeds.
  • False – The False return path can be used for an alternative workflow path or error-handling logic when the folder-renaming operation does not succeed.
 

 

Usage:

The Rename Folder step is typically placed after a workflow has determined that an existing Box folder needs to be renamed.

The workflow supplies the OAuth provider, identifies the folder using its path or Folder ID, and specifies the new folder name. The operation result is then stored in the configured Variable or Global variable.

A typical workflow pattern is:

Identify Box Folder → Rename Folder → Continue Process

The resulting value can then be used by later workflow steps to:

  • Record the result of the rename operation.
  • Continue Box document-management activities.
  • Process the renamed folder.
  • Trigger subsequent workflow activities.
  • Route the workflow through success or failure paths.

 

 

To use this step, you must first configure Dropbox in the FlowWright application. Then, go to the Integrate—Connections—OAuth page to create a new OAuth source. 

 

A sample OAuth configuration is provided for reference. 

 

Typical Workflow Suggestions:

Rename a Folder After Project Completion

Use the step to rename a Box folder when a project reaches a particular stage.

Example:

Complete Project → Rename Folder → Notify Project Team

The workflow can change the folder name to reflect the project's completed status.

 

Organize Folders During Document Processing

Use the step when a workflow needs to update the name of an existing Box folder as part of document-management processing.

Example:

Process Documents → Rename Folder → Continue Processing

The workflow can dynamically provide the target folder and new name.

 

Rename a Folder Based on Workflow Data

Use the step when the new Box folder name is generated from information collected during workflow execution.

Example:

Collect Project Information → Build Folder Name → Rename Folder → Continue Process

The folder path or Folder ID and new folder name can be supplied through workflow values.

 

Rename a Folder After a Status Change

Use the step to reflect a business or process status in the name of an existing Box folder.

Example:

Evaluate Status → Rename Folder → Process Next Activity

The workflow can use the status to determine the new folder name.

 

Route Processing After a Folder Rename

Use the True and False return paths to control workflow processing after attempting to rename the Box folder.

Example:

Rename Folder → True: Continue Process / False: Handle Rename Failure

The success path can continue downstream processing, while the False path can connect to appropriate error-handling or notification activities.

 

Example:

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

  • Create a new process definition named “BoxRenameFolderDef” and open it in designer mode. 
  • Drag a “BoxRenameFolder” step to the canvas.
  • Connect the dots between the “Start” and “BoxRenameFolder” 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.
  • Define a variable or a global to store the result.
  • Click the "BoxRenameFolder" step to configure its "Required" properties. Provide a name for the step. Select the “Box” OAuth connection provider. Enter the source folder name. Enter the new folder name. Enter a variable or global reference to store the result after execution. Click the Save button. Note: Click the "AI Predict" button to have Copilot 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 process instance, and execute it. When the workflow reaches the Rename Folder step, FlowWright uses the configured OAuth provider to access the specified Box folder and perform the rename operation. The operation result is stored in the configured Variable or Global variable. The workflow continues through the appropriate return path.

 

Tips:

  • Configure the correct OAuth provider before executing the step.
  • Verify that the specified Box folder path or Folder ID identifies the intended folder.
  • Use a meaningful and consistent folder naming convention.
  • Verify the new folder name before executing the workflow.
  • Use a meaningful Variable or Global name for the operation result.
  • Test the workflow with representative Box folders before deploying it.
  • Consider dynamically generating the new folder name from workflow data when appropriate.
  • Verify that the configured Box destination is accessible through the selected OAuth provider.
  • Connect the True path to the next activity when the rename operation succeeds.
  • Connect the False path to appropriate error-handling or notification logic.
  • Verify the stored result before using it in downstream workflow activities.
  • Test workflows across different environments when OAuth providers or Box configurations differ.

 

Definition Sample:

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

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

Click here to download the sample file.