With our Box Folder Listener and Box Notifier Output Block connections, you can integrate Box as both an input source and downstream destination for your Hyperscience data. If you use metadata templates in Box, you map document fields to fields in your metadata templates when setting up Box Notifier Output Block connections. These connections allow Hyperscience and Box to interact seamlessly, providing quicker time to value for our customers.
Required connections
A single Box Folder Listener connection can be used to connect your Box source folder to Hyperscience. However, if you want to map Hyperscience document data onto Box metadata templates, you need a Box Notifier Output Block connection for each layout whose fields you want to map onto Box metadata templates.
While you can use a Box Folder Listener connection without also setting up a Box Notifier Output Block connection, you cannot use a Box Notifier Output Block connection without a Box Folder Listener connection on the same flow.
How the integration works
Assuming you have set up both a Box Folder Listener connection and the Box Notifier Output Block connection, your Box integration works as follows:
A service account for a Custom App in Box polls the source folder for new files. When a new file is added to your source folder in Box, the app passes it to the Box Folder Listener.
NOTE: The integration currently does not support the processing of multiple documents in a single submission. If a submission includes multiple documents, data is extracted only from the first document listed in the submission’s JSON output.
Each file is processed as a single submission in Hyperscience.
If a file is placed in a subfolder of the source folder, the file will not be sent to the Box Folder Listener.
It is not possible to ingest metadata files with your submission files.
The Box Folder Listener retrieves the file and sends it to Hyperscience for processing, along with the file's box_file_id value assigned by Box.
Using the Box API, Hyperscience moves the file to the target folder in Box. If a file with the submission's file name already exists in the target folder, Box appends a timestamp to the end of the submission's file's name (YYYYMMDD_HHMMSS). The timestamp shows the time in UTC.
Hyperscience processes the submission, just as it would if the submission came from any other source. If your flow includes Supervision tasks, these tasks are created for the submission, and your keyers should monitor the application for the tasks as they become available.
After the system completely processes a document, it is processed by the Box Notifier Output Block connection whose routing filter matches the document’s layout tag.
The Box Notifier Output Block connection maps the layout's fields to the metadata template specified in the connection's settings. Any fields that you have not provided mappings for in the connection’s settings are ignored. Also, any fields that do not exist in the document are ignored, even if you provided mappings for them.
The connection sends the document’s extracted data to Box as searchable metadata.
Setting up the connections
To integrate your Hyperscience instance with your Box account, you will need to set up a Box Folder Listener connection. If you want to send metadata back to Box, you will also need to set up a Box Notifier Output Block connection for each layout or set of similar layouts whose documents you want to process.
Instructions for setting up these connections can be found in Box Listener and Box Notifier.