Download a file from the Box

Use this step to download a filder from the box

Last published at: February 13th, 2025

BoxGetFile Step

Description:

This step downloads a file from Box.

 

Inputs

  • filename– Name/ID of the source file to be downloaded. 
  • destinationFilePath– Path to save the file to the local machine.
 

 

Returns

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

 

 

Usage:

 

 

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

 

A sample OAuth configuration is provided for reference. 

 

 

Example:

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

  • Create a new definition named “BoxGetFileDef” and open it in designer mode. 
  • Drag a “BoxGetFile” step to the canvas.
  • Connect the dots between the “Start” and “BoxGetFile” step as shown above.
  • Define a variable or a global variable to store the result.
  • Click the "BoxGetFile" step to configure its "Required" properties. Provide a name for the step. Select the “Box” OAuth connection provider. Specify the source path to download the file. Specify the target path to store the file. Specify a variable or global reference to store the result after execution. 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. This is achieved by configuring 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. Click the process step to view its properties. The step should download the file from the box.

 

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 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. 

Click here to download the sample file.