Download File from Box

Use this step to download a filder from the box.

Last published at: August 29th, 2023

BoxGetFile Step

Description:

This step downloads a file from the 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 configure Dropbox in the FlowWright application. Then, navigate to the Integrate—Connections—oAuth page to create a new oAuth source. 

 

A sample oAuth configuration is shown as a reference here. 

 

Example:

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

  • Create a new definition called “BoxGetFileDef”
  • Select the definition and click the “design” button
  • Drag a “BoxGetFile” step to the canvas
  • Connect the dots between the start and “BoxGetFile” step
  • Define a variable/global to store the result after execution
  • Click the "BoxGetFile" step to configure its "Settings" properties. Provide a name to the step. Select the “Box” oAuth connection provider. Provide the source path to download the file. Provide the target path to store the file. Provide a variable/global to store the result after execution. 

 

  • 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. Render the process instance. Click on the process step to view the properties. The step should download the file from the box.

 

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.