BoxGetFile Step

Use this step to download a file from the box.

Last published at: December 28th, 2023


This step downloads a file from the box.



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



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




To use this step, you must configure Dropbox in FlowWright application. Navigate to Integrate - Connections - oAuth page to create a new oAuth source. 

A sample oAuth configuration is shown as reference here. 



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 on 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 file. Provide the target path to store file. Provide a variable/global to store the result after execution. 
  • The “Logging” setting configuration is necessary for documentation and also measure the workflow progress and the percent complete. This is acheived 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.