Box.com Connected Service

  • Updated on Mar 18, 2025
  • Published on Feb 5, 2025
  • 4 minute(s) read
  • DL
  • Migration Team
 Prev Next

Overview

Integration with Box.com allows one-way files synchronization from Encodify to Box.

Current implementation of the integration with service supports:

  • Creation of folders and subfolders in Box service using values of the mapped Encodify fields

  • Sending of files uploaded in Encodify to the Box service on action triggering

  • Support copy of file from single and multiple file fields in Encodify to Box

  • Support copy of file from custom and main media holders in Encodify to Box

Not supported:

  • Deletion of directories

  • Deletion of files

  • Move of files across the folders in Box.com connected service

  • Version control management on the Box.com service side

Configuration of Box.com 

A precondition for configuration is a created account on Box.com with enabled 2 step verification.

The below steps following the configuration process assumes configurator has an account created.

Create an App

  • Open the Dev Console by following the URL and click "Create New App":

    https://yourAccountName.app.box.com/developers/console  Screenshot_2020-09-15_at_13.09.00.png

  • Select "Enterprise Integration" and click "Next"

    Screenshot_2020-09-11_at_14.51.41.png

  • Select "OAuth 2.0 with JWT (Server Authentication)"  as Authorization Method and click "Next"

    Screenshot_2020-09-11_at_14.52.06.png

  • Enter the name of your app and click "Create App"

    Screenshot_2020-09-11_at_14.52.24.png

  • After creating an app it will be required to perform the first API call to the service before the developer token expires in 60 minutes. This can be done either via suggested CURL request or via configured integration in Encodify. (Token can be revoked later in Dev Console > Configuration > Developer Token)

    Screenshot_2020-09-11_at_14.52.59.png

Authentication and Permissions Configuration

  • Dev Console > select the previously created App > Configuration > OAuth 2.0 Credentials > save the value of the ClientID locally

    Screenshot_2020-09-11_at_14.54.16.png

  • In the Application Scopes section, clear the "Manage users" and "Manage groups" checkboxes

    Screenshot_2020-09-11_at_14.55.01.png

  • In the Add and Manage Public Keys section, click "Generate a Public/Private Keypair" > make sure JSON file is downloaded and saved.

    Screenshot_2020-09-11_at_14.55.34.png

App Configuration 

  • Go to the Box's Admin Console 

    Screenshot_2020-09-15_at_13.43.36.png

  • Click Apps > Custom Apps > Click the "+" icon to authorize App

    Screenshot_2020-09-15_at_13.46.41.png

  • In the pop-up that opens, enter the previously locally saved ClientID and Click Next

    Screenshot_2020-09-11_at_15.03.52.png

  • Click "Authorize" and the app will appear in the list of Custom Apps.

    Screenshot_2020-09-11_at_15.04.04.png

Folder creation and Permissions Configuration

  • Being on Admin Console, click "Back to My Account" at the left bottom of the page.

  • Create new folder under "All Files" menu

    0cd70d6cfb.jpg

  • Enter folder name and select "Editor" in the "Permission" selectbox > Save

  • Go back to Admin Console > Users & Groups > Groups  and click "Create"

  • Enter the name of the group in the "Group Details" section > leave "Company" option selected > click "Next"

    4ed7f8f921 (1).jpg

  • Click "Add Members" > start typing to add the users.  Note, that user that is created for integration when app is created is the one that needs to be added. Example of user name: AutomationUser_1363840_x0Dhq84jCs@boxdevedition.com

  • Select the "Set as Group Admin" check box and click "Add" 

    Screenshot_2020-09-11_at_15.07.14.png

  • Click "Next" 

  • On Step 3, select the folders to share by clicking "Share Folders" > Click "Done" > "Done" when finished.

Configuration of Connected Service in Encodify

As mentioned previously, Box.com connector is controlled by the feature flag and needs to be enabled in webapp.yaml as precondition.

  • Go to Site Configuration > Connections > Connected services

  • Click "Add Service" next to the "Box.com" service type.

  • Fill in "Service Name" and "Account name" fields 

  • Leave "Create New" in the "Account" field if service is being configured for the first time

  • In the "Box JSON Key" field, paste the content of the previously downloaded json file with Public/Private keypair.

    Screenshot_2020-09-15_at_14.27.56.png

  • Click "Next"

  • In the "Module" selectbox, select the module for which integration is being set up and click "Next" 

  • On the Mappings page, select media holder, from which files will be synced with the external folder on box com. Both original and custom media holders are supported. It is also possible to use single and multiple file fields for integration.

    Screenshot_2020-09-15_at_14.57.38.png

  • "Server Folder Path Template" - specify the path to the synchronization destination folder on box.com. Path should start with the existing folder on Box.com.  Note, that it is possible to use Velocity template from actions to map the values of the fields to the folder path.

  • The "Allow Creation of Empty Folders" check box will define if new folders will be created in case no file are send on action triggering. Otherwise, folders are always created if missing when file is being synced to box.com on action execution.

Action Configuration

Last step in integration setup is configuration of action for module in question.

  • Go to Site Configuration > Module > Create action > enter name and select event > select "Send to connected service" in "Action" > select configured connected service > save.

Known Behavior

  • If mapped field value is empty > file will be copied to the 1st folder present

  • Field values having "/" in names: corresponding nested folders will be created

  • In case content of the preview mediaHolder is a folder > nothing will be copied to box (cases for extract of zip files)

  • If any of the field values are missing in the path, folders and files will be created  based on the available values:

e.g. path = /main/client/brand/campain, where client, brand and campaign are field values

items with fields:

client = client 1

brand = (empty/not specified)

campaign = campaign 1


Folder structure that will be created in box, is the following

client 1 > campaign 1

Class for Debug

dk.encode.ebms.connections.box.com.BoxComMessageHandlerImpl

Related articles