Breadcrumbs

Box - Download Files to Workflows

Overview

Quickly export one or more files from your company's Box account. Once the files have downloaded, transfer them to another service or run another Vessel against the data.

Variables

Name

Reference

Type

Required

Default

Options

Description

Box Folder Name

BOX_SOURCE_FOLDER_NAME

Alphanumeric

None

-

Name of the folder where the file is stored in Box. Leaving blank will look for the file in the root directory of Box.

Box File Name

BOX_SOURCE_FILE_NAME

Alphanumeric

None

-

Name of the target file in Box. Can be regex if "Match Type" is set accordingly.

Box File Name Match Type

BOX_SOURCE_FILE_NAME_MATCH_TYPE

Select

exact_match

Exact Match: exact_match

Regex Match: regex_match

Determines if the text in "Box File Name" will look for one file with exact match, or multiple files using regex.

Workflows Folder Name

BOX_DESTINATION_FOLDER_NAME

Alphanumeric

None

-

Folder where the file(s) should be downloaded. Leaving blank will place the file in the home directory.

Workflows File Name

BOX_DESTINATION_FILE_NAME

Alphanumeric

None

-

What to name the file(s) being downloaded. If left blank, defaults to the original file name(s).

Service Account Credentials

BOX_APPLICATION_CREDENTIALS

Password

-

JSON from a Box Service Account key

YAML

Below is the YAML template

YAML

source:
  template: Box - Download Files to Workflows
  inputs:
    BOX_SOURCE_FOLDER_NAME:
    BOX_SOURCE_FILE_NAME:
    BOX_SOURCE_FILE_NAME_MATCH_TYPE: exact_match
    BOX_DESTINATION_FOLDER_NAME:
    BOX_DESTINATION_FILE_NAME:
    BOX_APPLICATION_CREDENTIALS: ''
  type: TEMPLATE
guardrails:
  retry_count: 1
  retry_wait: 0h0m0s
  runtime_cutoff: 1h0m0s
  exclude_exit_code_ranges: []