Using the Box Source Component

The Box Source Component is an SSIS data flow pipeline component that can be used to read / retrieve data from Box.

The component includes the following two pages to configure how you want to read data from Box.

  • General
  • Columns

General page

The General page of the Box Source Component allows you to specify the general settings of the component. 

SSIS Box Source Component

Connection Manager

The Source Component requires a Box connection in order to connect with Box. The Connection Manager drop-down will show a list of all Box Connection Managers that are available to your current SSIS package.

Source Item Path

The Source Item Path specifies the base item to select. Click the eclipse button ('...') to open up a Box browser dialog to select an item.

Item Selection Mode

The Item Selection Mode specifies what Box item(s) will get selected. The Files Only modifier will still go through folders to retrieve items but will not return any records for the folders.

  • Selected Item: will only retrieve the item specified.
  • Recursive: will retrieve the selected item (specified in the Source Item Path field) and all sub items.
  • Selected Level: will retrieve the selected item and its sub items.
  • Recursive (Files only): will retrieve all files only from the selected item specified and its sub items.
  • Selected Level (Files only): will retrieve all files only from the selected item and its sub items.
Batch Size

The Batch Size option allows you to specify the maximum number of items to return. The default is 100 and maximum is 1000.

Output Timezone

The Output Timezone option allows you to specify how Box datetime value are produced. There are three options available:

  • Connection User Timezone
  • UTC Timezone
  • Local System Timezone
Refresh Component Button

Clicking the Refresh Component button causes the component to retrieve the latest metadata and update each field to its most recent metadata.

Expression fx Button 

Clicking the fx button to launch SSIS Expression Editor to enable dynamic update of the property at run time.

Generate Documentation Button 

Clicking the Generate Documentation button to generate a Word document which describes the component's metadata including relevant mapping, and so on.

Columns page

The Columns page of the Box Source Component shows you all available attributes from the object that you specified on the General page. 

SSIS Box Source Component - Columns Page

On the top left of the grid, you can see a checkbox, which can be used to toggle the selection of all available Box fields. This is a productive way to check or uncheck all available fields.

Note: As a general best practice, you should only select the Box fields that are needed for the downstream pipeline components.