The Box Connector performs full and incremental scans over a Box repository and will extract security, metadata, and content from each object scanned. Each scanned object will be tagged with one of three possible actions--add, update, or delete--and can be routed to any Aspire pipeline as desired.
The connector, once started, can be stopped, paused or resumed via the Scheduler Component. Typically the start job will contain all information required by the job to perform the scan. When pausing or stopping, the connector will wait until all the jobs it published have completed before updating the statistics and status of the connector.
| Box Application Bundle | |
|---|---|
| AppBundle Name | Box Connector |
| Maven Coordinates | com.searchtechnologies.aspire:app-box-connector |
| Versions | 3.1 |
| Inputs | AspireObject from a content source submitter holding all the information required for a crawl. |
| Outputs | An AspireObject containing the URL, content, ACLs and Metadata processed for each file. |
Configuration
This section lists all configuration parameters available to install the Box Application Bundle and to execute crawls using the connector.
| Property | Type | Default | Description |
|---|---|---|---|
| snapshotDir | string | ${aspire.home}/snapshots | The directory for snapshot files to be stored. |
| disableTextExtract | boolean | false | By default, connectors use Apache Tika to extract text from downloaded documents. If you wish to apply special text processing to the downloaded document in the workflow, you should disable text extraction. The downloaded document is then available as a content stream. |
| workflowReloadPeriod | integer | 15m | The period after which to reload the business rules. Defaults to ms, but can be suffixed with ms, s, m, h or d to indicate the required units. |
| workflowErrorTolerant | boolean | false | When set, exceptions in workflow rules will only effect the execution of the rule in which the exception occurs. Subsequent rules will be executed and the job will complete the workflow sucessfully. If not set, exceptions in workflow rules will be re-thrown and the job will be moved to the error workflow. |
| useGE | boolean | false | true if group expansion is going to be used. |
| geSchedule | string | 0 0 0 * * ? | Indicates how often the group expasion is going to fetch all the security groups. |
| Server | string | https://app.box.com | The Box server Url |
| Server API Url | string | https://api.box.com | URL for Box API |
| API version | string | 2.0 | The Rest API version that Box is using. |
| Client Id | string | None | The client id of a content applicaton in Box.com with access to the Box account. |
| Client Secret | string | None | The Client Secret of a content application in Box.com with access to the Box account |
| User Name | string | None | Box user account |
| Working Box Directory | string | This folder will contain the access and refresh token files. | |
| PageSize | integer | 100 | Indicates the amount of documents or folders that will be returned by the Rest API get query. |
| Impersonate Users | boolean | false | Impersonate each user of Box account in order to crawl all shared and private content. If unchecked, only shared content accessible by the crawling account will be crawled. |
| indexFolders | boolean | false | Indicates if folders (as well as files) should be indexed. |
| scanRecursively | boolean | true | Indicates if subfolders should be scan. |
| scanExcludeItems | boolean | false | Indicates if exclude items should be scan. |
| ExcludeSubFolders | string | None | A list of folders that can be excluded from the crawling. |
| IncludePatterns | string | None | A regular expression pattern to evaluate file urls against; if the file name matches the pattern, the file is included by the scanner. Multiple include nodes can be added. |
| ExcludePatterns | string | None | A regular expression pattern to evaluate file urls against; if the file name matches the pattern, the file is excluded by the scanner. Multiple exclude nodes can be added. |
Configuration Example
To install the application bundle, add the configuration, as follows, to the <autoStart> section of the Aspire settings.xml.
| Configuration |
|---|
<application config="com.searchtechnologies.aspire:aspire-box-source"> <properties> <property name="useGE">true</property>
</properties> </application> |
Overview
Content Tools