Overview
With our Box Listener Input Block, you can process content stored in Box. This content can then be mapped back to Box content as metadata or can be sent to other downstream systems.
The Box Listener Input Block is available in both SaaS and on-premise versions of the Hyperscience application.
Sample use cases
Users can take extracted metadata from Box’s content and map it to the metadata fields on the content itself.
Users can take extracted data from Box’s content and send it downstream for further processing via an HTTP Notifier Block or another Output Block.
Block settings table
In addition to the settings outlined below, you can also configure the settings described in Universal Integration Block Settings.
Name | Required? | Description |
|---|---|---|
Folder To Scan For Submissions | Yes | The ID of the Box folder the connector scans for image files. |
Folder to Move Completed Files | Yes | The ID of the Box folder that files are sent to after they have been ingested in Hyperscience. |
File Extensions | Yes | A list of the extensions that image files will need to have to be eligible for processing.
To edit the list, click on the field, and select or deselect file extensions in the drop-down list that appears. Click outside of the list to save your selections.
If there are file extensions that you want to support but do not see in the drop-down list, select Other, and enter the extensions in Other File Extension Types. |
Other File Extension Types | No | A comma-separated list of file extensions that do not appear in File Extensions. This field only appears if Other is selected in File Extensions. |
Private-Key | Yes | The value of the privateKey element in the JWT credentials JSON file. |
Passphrase | Yes | The value of the passphrase element in the JWT credentials JSON file. |
Public-Key ID | Yes | The value of the publicKeyID element in the JWT credentials JSON file. |
Client ID | Yes | The value of the clientID element in the JWT credentials JSON file. |
Client Secret | Yes | The value of the clientSecret element in the JWT credentials JSON file. |
Enterprise ID | Yes | The value of the enterpriseID element in the JWT credentials JSON file. |
Polling Interval (In Seconds) | No | The frequency at which the connector will monitor the source folder for submissions. Defaults to 10. |
Warm-up Interval (In Seconds) | No | The length of time that a file must remain unmodified before it is eligible for processing. Defaults to 15. |
Setting up Box Listener
1. Create a Box Custom App with server authentication (JWT).
Follow the steps in Box's Setup with JWT.
Have Box generate a public/private keypair by going to the Configuration tab of the Developer Console and clicking Generate a Public/Private Keypair in the Manage Public Keys section.
In the Application Access section of that same tab, set the App Access Level to App Access Only.
In that same section, find Application Scopes, and select Write all files and folders stored in Box.
When you are finished, click the Download as JSON button at the bottom of the Configuration tab to download the JWT credentials. You will need to refer to this file when setting up your Box connections in Hyperscience.
2. Obtain the email address of the app's Service Account.
When you create the app, your organization’s Box administrator receives an email requesting that they authorize the app for use in your enterprise. After your app has been authorized, go to the General Settings tab of the Developer Console, and copy the email address (or "ID") found in Service Account Info.
3. Add the Service Account as a collaborator, and obtain the IDs of the source and target folders.
Follow these steps for both your source and target folders:
Using the Service Account's email address, invite the Service Account to collaborate on the folder as an Editor.
To learn how, see Box's Inviting Collaborators.
Go to the folder in Box, and copy the folder ID from the end of the URL shown in your browser's address bar (https://app.box.com/folder/).
4. Create the Box Folder Listener connection in Hyperscience.
Follow the steps in Managing Connections to add a Box Folder Listener connection.
5. Configure the Box Folder Listener connection.
Enter the information for your connection in the connection’s settings, as described in the Block settings table above.