Description:

The BoxGetFile step is used to download a file from Box as part of a FlowWright workflow.

The step provides True and False return paths so that subsequent workflow processing can respond to the result of the download operation.

Usage:

Use the BoxGetFile step whenever a workflow needs to retrieve a file from Box and make a local copy available for subsequent processing.

A typical workflow pattern is:

Identify Box File → Download File → Process Local File → Continue Workflow

The workflow specifies the Box source file by name or ID and provides the local path where it should save the downloaded file.

For example, a workflow can retrieve a document from Box before passing it to another FlowWright step for processing.

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. 

Typical Workflow Suggestions:

Download a Document for Local Processing

Use BoxGetFile when a workflow needs to retrieve a Box document before performing additional processing.

For example:

Identify Box Document → BoxGetFile → Process Local Document → Continue

The downloaded file is available at the specified local destination path for subsequent workflow operations.

Retrieve a File Before Data Extraction

Use the step when a workflow needs to download a file from Box before extracting or processing its contents.

For example:

Locate Source File → Download from Box → Extract Data → Process Results

The local destination path provides the location for the downloaded file.

Download an Approved Document

Use BoxGetFile after an approval step when a downstream process requires a local copy of the approved Box document.

For example:

Document Approval → BoxGetFile → Local Processing → Complete

The workflow can proceed through the True path after a successful download.

Retrieve a File for Automated Conversion

Use this step when a Box file needs to be downloaded before another workflow operation converts or transforms it.

For example:

Select Box File → BoxGetFile → Convert File → Generate Output

The downloaded file is saved to the configured local machine path before the conversion step executes.

Download a File as Part of an Integration Workflow

Use BoxGetFile when an integration process needs to retrieve a Box file and pass it to another local processing or integration operation.

For example:

Receive Integration Request → Identify Box File → BoxGetFile → Process/Transmit File

The source file name or ID and local destination path can be supplied dynamically from workflow data.

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.
• 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 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 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. When the workflow reaches the BoxGetFile step, FlowWright uses the selected OAuth provider to access Box and identifies the source file using the supplied name or ID. The file is downloaded to the local path specified by Path to save the file to the local machine. The result of the operation is stored in the Variable/Global specified by Store result in Variable/Global. The workflow then follows the True or False return path based on the result of the download operation. Click the process step to view its properties. The step should download the file from the box.

Tips:

• Select the correct OAuth provider: Ensure that the selected provider has access to the Box file being downloaded.
• Use a reliable source file name or ID: The source file input must identify the intended Box file.
• Use an appropriate local destination path: Ensure that the destination path represents the intended location on the local machine.
• Use Variables/Globals for dynamic paths: This allows source file identifiers and destination paths to be determined during workflow execution.
• Process the downloaded file after successful execution: Connect the True path to the next processing operation.
• Handle download failures: Use the False path for appropriate exception or error handling.
• Store the result: The result Variable/Global can be used by subsequent workflow logic when the operation result needs to be referenced.

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: After the import, verify and complete 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.