Box Connector

6 minute read Last updated on September 11, 2024

Box Connector Icon

Use the Box Connector node to distribute documents to Box, an online file sharing and cloud content management service. You can send documents to Box via an automated workflow, or you can access Box directly at the MFP panel.

Note: To use the Box Connector node, you must have a Box account.

Box

Configuring the Box Connector

To open the node’s configuration window (shown above), add a Box Connector distribution node to your workflow and double-click on it. You have the following options:

  • Enabled - To enable this node in the current workflow, select the toggle until “Enabled” displays. The default setting is “Enabled”. If you disable the node:

    • The workflow will ignore the node.

    • The node will not check for logic or error conditions.

    Important! If you disable this node, and no other distribution nodes are enabled, it will not cause the workflow to fail validation, but no processed documents will output and they may be lost.

  • Name - The name in this field appears below the node’s icon in the workflow. The node’s name defaults, but you can edit it. For example, you can specify a name that indicates the node’s function in the workflow.

  • Description - Enter a description for this node that details its purpose in the workflow, and/or to distinguish it from other nodes in the workflow. If the description is long, you can hover the mouse over the field to read its entire contents.

    This field is optional and is for internal use. That is, it appears only in this window and not in the workflow.

Buttons

  • Help - Accesses Online Help.
  • Metadata - Accesses the Metadata Browser.
  • Cancel - Exits the window without saving any changes.
  • Save - Preserves your node configuration and exits the window.

Authorization

To use this node in a workflow, you must connect it to a Box account. Once you connect to an account and save the node, the account will be available for selection the next time you access the node in the current workflow. To connect to a Box account, do the following:

  1. Select Add Account. The Box login window appears:

    Box Login

  2. Enter the login information for the Box account, then select Authorize. The Confirmation window appears:

    Box Login

  3. Either confirm you want to give Dispatcher Stratus access to your Box account, or select Deny access to Box to exit the window. You return to the Box Connector.

  4. If multiple accounts are available, select the radio button next to the desired account.

  5. To modify the default the number of seconds the system is allowed to attempt to connect with the specified account, enter a value in the Connection Timeout field.

Deleting an Account

To delete an account, select the Delete icon next to the account you want to delete. A window with the following options appears:

Delete Account

  • No - Cancel the delete action and return to the node configuration window.

  • Yes - Delete the account from this node. You can add the account again later.

  • Yes, Permanently - Delete the account from the tenant, including all workflows. You can add the account again later.

    Caution! Selecting this option can impact workflow performance.

Document Options

In the Document Options area, you can update certain aspects of documents that pass through the node.

  • Overwrite Document in Library - By checking this box, a document that is uploaded to Box with the same name as an existing document will replace the existing document. By default, this box is unchecked, and new documents with the same name will be appended with a unique number added so as to save both versions.

Note: The file will have an icon next to the file name with a number representing the number of times that file has been uploaded. Selecting that icon will show the other versions of that file. This functionality is only available from Box with an account level of “Pro” and higher. Standard Box account users will not be able to view file versions.

Customizing the Box Connector Node

Once connected to a Box account, the Folder Browser area populates with a tree-view of your Box folders, sub-folders, and files. Browse through your Box folder structure and choose a folder in which to store your documents. The Folder Path field automatically updates with the selected folder path.

Sending Documents to a New Folder

To create a new folder in Box, select New Folder from the Folder Browser toolbar. The Create New Folder window appears:

Create a New Folder

Enter the name for the new folder in the Folder Name field, and then select Create. The folder appears in the Folder Browser.

Tip: You can also type in a folder path that includes one or more folders that do not currently exist within the Box account. The Box Connector will automatically create any new folders and then upload the document(s) to that location.

File and Folder Name Restrictions

The following restrictions apply to file and/or folder names:

  • File names cannot start with a space or end with a space

  • You cannot start a file name with two period characters (..)

  • Non-printable characters cannot be included in a file name (tabs, newlines, etc.)

  • Do not use / or \

View Options

The toolbar in the Folder Browser area provides the following view options for your Box folders:

Icon Name Description
Box at the MFP Show/Hide Files Click this button to show or hide files stored in Box folders. When you have selected to Hide Files, you will only see folders.
Box at the MFP Refresh Click this button to refresh the current view with the most up-to-date folders/files.
Box at the MFP Change View Click this button to change from list view to grid view and back.

Accessing Box at the MFP

At the MFP, do the following:

  1. Select your workflow - If only one workflow is currently running, that workflow appears. If multiple workflows are running, the Selection screen appears and you must select a workflow.

  2. Scan your document - Use the MFP to scan your document. Available options are determined by your selections in the MFP Capture node.

    If you configured a Form Selector node, continue to step 3. Otherwise, skip to step 5.

  3. Enter your login credentials - If a Box account has not already been selected during node setup, you will need to add your Box account before entering your login credentials. Select Add Account to choose an account.

  4. Select your file destination - When you are logged in, you can use the folder navigation to select the destination for your file upload. The Folder Path field displays the current folder path of the destination folder.

  1. Select the “Scan” button - This sends the scanned document to the selected Box account and folder.