Box connection information
  • 17 Jul 2024
  • PDF

Box connection information

  • PDF

Article summary

summary

Help page for creating Box connection information.

entry

item nameindispensableContents
NameYesEnter the name of the connection information to be used inside TROCCO.
memoNoYou can enter notes for connection information to be used inside TROCCO.
Authentication methodYesSelect the authentication method.
  • OAuth 2.0 Authentication
    • OAuth 2.0 authentication is only available in the source Box.
  • JWT Certification
Box AccountYesEnter when OAuth 2.0 authentication is selected as the authentication method.
Click on Box Account Verification.
custom apps configuration fileYesEnter this if you selected JWT authentication as the authentication method.
For more information on input content, see Data Transfer with Custom Application.

precautions

Some of the Box API tokens, codes, and URLs have an expiration date.

Expiration date of access token

An access token is used to retrieve data from the source Box.
The access token is valid for 60 minutes.

If the data to be transferred cannot be retrieved from the source Box within the expiration date, the relevant data will not be transferred.
In the unlikely event that data acquisition is not completed within the expiration date, please take measures such as reducing the size of the data to be transferred.

Renewal token expiration date

If OAuth 2.0 authentication is used as the authentication method, the update token is used to retrieve data from the source Box.
Renewal tokens are valid for 60 days from the date of creation or use of the renewal token.

The renewal token will expire if no data transfer has been made for 60 days since the creation of the connection information or the last data transfer.
If your renewal token has expired, please re-authenticate your Box account from the Edit Connection Information screen.

In addition to the above, there are other items with set expiration dates.
See Token and URL Expiration Dates for more information.

Data transfer using custom applications

The following describes the procedure for transferring data using a custom application.
This section is divided into three processes: creating, approving, and sharing custom apps.

Creation of custom apps and request for approval

  1. From My Account (the top screen of Box), click on Developer Console.
    cc_box_001

  2. From My Apps, click Create New App.
    cc_box_002

  3. Click on Custom Apps.
    cc_box_003

  4. Select Server Authentication (using JWT ) as the authentication method, enter any app name, and click Create App.
    cc_box_004

  5. From the Configuration tab > Add and Manage Public Keys, click Generate Public/Private Key Pair.
    cc_box_005
    A secret key with the following configuration will be downloaded in JSON file format.

{ "boxAppSettings":. { "clientID":. "YYYYYYY", "clientSecret":. "XXXXXXXXX", "appAuth":. { "publicKeyID":. "AAAA", "privateKey":. "BBBBB", "passphrase":. "CCCC" } }, "enterpriseID":. "ZZZZZ"}
  1. Copy the entire contents of the JSON file obtained in the previous step and paste it into the custom app settings file on TROCCO's connection information creation screen.
    cc_box_006

  2. From the Configuration tab > Application Scope, enable Write to all files and folders stored in the Box and click Save Changes.
    Note that by activating this item, files can be downloaded from Box during data transfer.
    cc_box_007

  3. Approval tab > Click Confirm and Submit.
    cc_box_008

  4. Enter a description as appropriate in the Application Description field and click Submit.
    cc_box_009
    An approval request for the custom app you created will be sent to a user with administrative privileges in Box.

Custom App Approval

The following steps can only be performed by users who have administrative rights to their Box accounts.

  1. From My Account (the top screen of Box), click on the Management Console.
    cc_box_010

  2. Click on the Apps > Custom App Manager tab and click Approve App from the menu of the custom app you created.
    cc_box_011

  3. Click Approval.
    cc_box_012
    The approval status is set to Approved.

Share settings for data to be transferred

  1. From My Account (the top screen of Box), click on Developer Console.
    cc_box_013

  2. Click on the custom app you created.
    cc_box_014

  3. Copy the Service Account ID from the General Settings tab > Service Account Information.
    cc_box_015

  4. Return to My Account (the top screen of Box) and click Share for the file or folder you wish to transfer.
    cc_box_016

  5. Under Invite Users, paste the Service Account ID copied in the previous step and click Submit.
    cc_box_017
    When you open the corresponding file/folder, you will see that the service account has been granted privileges.
    cc_box_018


Was this article helpful?