Connector for Box, Version 2 Setup and Reference Guide

Transcription

1 Connector for Box, Version 2 Setup and Reference Guide Published: 2017-Jun-30

2 Contents 1 Box Connector Products Supported features Box Connector Limitations Box Specific Metadata Supported by the Connector Box Document Dates Author Information Box document authors Box note authors Box URL Hints Unknown Users Handling Box Custom and Template Metadata Box Connector Prerequisites Scopes Requirements to be provided by Box Start URI for Box Data Sources Crawl a Specific User or Folder Crawl Box Trash Granting Access to Box Account Provide Credentials for Token Generation Provide Tokens Recommind Box Token Generator Set up and Start Recommind Box Token Generator Configure Recommind Box Token Generator Proxy Setup and Network Access Configure Box for Token Generation Generate Tokens Configure the Box Connector Access token Box admin user Box folders to crawl for this user Box Note Authors Box users to be crawled, specified by login name ( address) Client ID Client secret Generate Tokens Enable this connector Index versions Index trash 31 2 Recommind, Inc

3 Proxy host Proxy port Proxy user name Proxy user password Refresh token Start URIs Use proxy authentication Use proxy server Working directory 33 2 Changes to this Document 35 3 Contact Us 36 4 Terms of Use 37 3 Recommind, Inc

4 1 Box Connector This document describes how to configure and use the Recommind connector for the cloud storage service Box.com. 1.1 Products This document applies to the following Recommind products and versions: Cloud/OnDemand: Axcelerate 5.8 and up 1.2 Supported features Feature Support Full Crawl Incremental Crawl (with modification date and checksum) Folder Security (ACL) Open Document Versions NAS Support Exception Handling Y N N N Y (with limitations to metadata) N Y The connector supports crawling of Box files, versions, notes, comments, tasks and bookmarks. 1.3 Box Connector Limitations Restricted Box trash extraction Due to Box API limitations, retrieving content from the trash is restricted. Box files, notes or bookmarks can be retrieved from the trash. However, any comments or tasks that have been added to a Box object cannot be retrieved. You cannot specify trashed folders in the list of the folders to crawl. 4 Recommind, Inc

5 Restricted metadata for Box versions Certain metadata values are extracted for current files, but will be missing for versions. This includes: box_description Impact: You cannot search, display, export, etc., the text in the description field rm_foldername box_trashed_at Impact: You cannot search, filter, display, export, etc. the date value of when the previous version was trashed. rm_creationdate Impact: You cannot search, filter, display, export, etc. the date value. rm_lastmodifieddate Impact: You cannot search, filter, display, export, etc. the date value. box_created_by_id, box_created_by_login, box_created_by_name, etc. Impact: You cannot search, filter, display, export, etc. the created-by values. We do however get the modified-by values for versions. box_owned_by_id, box_owned_by_login, box_owned_by_name, etc. Impact: You cannot search, filter, display, export, etc. the owned-by values. We do however get the modified-by values for versions. box_shared_link_url Impact: You cannot search, display, export, etc. the text in the Shared Link field box_tag Impact: You cannot search, filter, display, export, etc. the tags users have created on a Box file. Box template & custom metadata Impact: You cannot search, filter, display, export, etc. the Box template or custom metadata key-value pairs. No Box comments and tasks for Box versions Due to Box API limitations, comments and tasks are only extracted for the current file. Creation and modification dates for Box versions Due to Box API limitations, file system generated dates are only maintained for the current file, but not for versions. In addition, depending on how the file is uploaded (web page, mobile device, etc.) these dates may not be preserved. However, the date of the upload and of the last change on the Box server is available for all versions. 5 Recommind, Inc

6 Box note formatting Due to Box API limitations, any rich text formatting in a Box note is lost when indexed. The content of the text will be converted to plain text. When images are embedded into a Box note, these images are stored in a separate Box folder at the same level as the Box note itself. The folder is Box Notes Images\<Name of box note> Images. During data load, a note and its embedded image are indexed as separate documents. More Box note versions shown than in Box When working on Box notes, a version of the document is automatically saved by Box every 30 seconds. All of these versions are extracted by the connector. The Box UI in contrast limits the versions so that only every 5 minutes a version is shown. No Box comments modification dates For Box comments, no modification date is given even though Box comments can be changed via the Box API. They cannot be changed with the Box UI however. Box Tasks on Box Notes For Box notes, no Box tasks are extracted. It is possible to add such Box tasks with the Box API, but not with the Box UI. No relationship indicated for comments and tasks on archives Box comments and tasks may be attached to archive files (e.g. ZIP files). Depending on the data source configuration, archives are not indexed. However, the comments and tasks that would be children to these archives are indexed, but will not have a relationship to their parent because the parent itself is not indexed. If the data source is configured to index archive files, comments and tasks will be shown as attachments after data load. Box custom metadata The indexed property names for custom metadata keys depend on the display name that is used when first creating this key. Due to Box API limitations, later changes to the name from the Box administration page will not be reflected by the property name when indexed. Duplicate ID Recomputation Re-computing (rehashing) the duplicate IDs for already indexed Box documents is not supported. Please note that this limitation only affects the re-computation (rehashing) of duplicate IDs based on already indexed data via the siblings.bat script. Consistent duplicate ID computation during re-crawls is supported for Box documents. Duplicate ID computation for trash Due to Box API limitations, when identical objects are in the Box trash and some of these objects have comments or tasks while others do not, these will be considered 6 Recommind, Inc

7 duplicates by the connector. Due to Box API limitations, when identical objects are in the Box trash and some of these objects have comments or tasks while others do not, these will be considered duplicates by the connector. Supported metadata are extracted from Box items and added to the indexed document as XML tags. To make metadata visible to users, or to make them searchable, create a new field in the document model of the respective Recommind application. Property name box_bookmark_url 1.4 Box Specific Metadata Supported by the Connector box_can_non_owners_invite box_comment_count box_comment_is_ reply box_created_at box_created_by_id box_created_by_login box_created_by_ name box_created_by_role box_created_by_language box_created_by_ timezone box_created_by_ space_amount box_created_by_ space_used URL of a bookmark Description of this property in Box Information whether or not the non-owners can invite collaborators to the folder. For documents that can have comments attached. Only meaningful for comments. Contains the -data creation date supplied by Box. The user that has created/uploaded the document. 7 Recommind, Inc

8 Property name box_created_by_ max_upload_size box_created_by_ status box_created_by_job_ title box_created_by_ phone box_created_by_ address box_created_by_ avatar_url box_created_by_ enterprise box_created_by_is_ sync_enabled box_created_by_is_ external_collab_ restricted box_created_by_can_ see_managed_users box_created_by_is_ exempt_from_device_ limits box_created_by_is_ exempt_from_login_ verification box_created_by_is_ password_reset_ required box_created_by_is_ platform_access_only Description of this property in Box 8 Recommind, Inc

9 Property name box_created_by_my_ tags box_created_by_ _alias box_description box_document_type box_file_id box_has_versions box_created_by_hostname box_has_collaborations box_metadata_<template>_<key> box_metadata_properties_<key> box_modified_at box_modified_by_id box_modified_by_ login box_modified_by_ name box_modified_by_role box_modified_by_language box_modified_by_ timezone Description of this property in Box The description as given by Box. Possible values: comment, file, file_version, folder, task File ID. Common ID between all file versions. Indicates whether there are collaborations for the item. Set for all files and versions. No means that no older versions exist. Metadata key/value pair. Custom key/value pairs have properties in their name. Contains the -data modification date supplied by Box. The user that has last modified the document. 9 Recommind, Inc

10 Property name box_modified_by_ space_amount box_modified_by_ space_used box_modified_by_ max_upload_size box_modified_by_ status box_modified_by_ job_title box_modified_by_ phone box_modified_by_ address box_modified_by_ avatar_url box_modified_by_ enterprise box_modified_by_is_ sync_enabled box_modified_by_is_ external_collab_ restricted box_modified_by_ can_see_managed_ users box_modified_by_is_ exempt_from_device_ limits box_modified_by_is_ exempt_from_login_ verification Description of this property in Box 10 Recommind, Inc

11 Property name box_modified_by_is_ password_reset_ required box_modified_by_is_ platform_access_only box_modified_by_ hostname box_modified_by_ my_tags box_modified_by_ _alias box_name box_note_author box_note_author_id box_note_author_ login box_note_author_ name box_owned_by_id box_owned_by_login Description of this property in Box Name, e.g. name of a bookmark. Indicates an author for a Box note. There may be multiple authors and each one is described with the properties box_ note_author_id, box_note_author_login and box_note_author_name. Example: <box_note_author type="main"> <box_ note_author_id> </box_note_ author_id> <box_note_author_ login>smith@recommind.com</box_note_ author_login> <box_note_author_ name>asmith</box_note_author_name> </box_note_author> The ID of this Box note author. The login name of this Box note author. The name of this Box note author. The user that has the role OWNER of a document. Can be different from the creator. 11 Recommind, Inc

12 Property name box_owned_by_name box_owned_by_role box_owned_by_ timezone box_owned_by_ space_amount box_owned_by_ space_amount box_owned_by_max_ upload_size box_owned_by_ status box_owned_by_job_ title box_owned_by_ phone box_owned_by_ address box_owned_by_ avatar_url box_owned_by_language box_owned_by_enterprise box_owned_by_is_ sync_enabled box_owned_by_is_ external_collab_ restricted Description of this property in Box 12 Recommind, Inc

13 Property name box_owned_by_can_ see_managed_users box_owned_by_is_ exempt_from_device_ limits box_owned_by_is_ exempt_from_login_ verification box_owned_by_is_ password_reset_ required box_owned_by_is_ platform_access_only box_owned_by_hostname box_owned_by_my_ tags box_owned_by_ _alias box_shared_link_url box_status box_tag box_task_action box_task_due_at box_task_assigned_at Description of this property in Box URL of a shared link Can be either 'active', 'trashed' or 'deleted'. 'trashed' indicates that an item can be restored. 'deleted' items cannot be (directly) restored, since they are, e.g., in a deleted folder. Contains custom tags assigned to a document in Box. Each value reflects one tag. The action that the assignee of the task shall perform. At the moment this can only be REVIEW. The due date of the task, if a due date has been set. For each task assignment this is the date indicating when this task was assigned. Currently not filled by Box. 13 Recommind, Inc

14 Property name box_task_assigned_ by_id box_task_assigned_ by_login box_task_assigned_ by_name box_task_assigned_ to_id box_task_assigned_ to_login box_task_assigned_ to_name box_task_completed_ at box_task_is_completed box_task_message box_task_reminded_ at box_task_resolution_ state box_trashed_at box_upload_ box_upload_ _ access Description of this property in Box For each task assignment this is the ID of the user that assigned this task. Currently not filled by Box. For each task assignment this is the log name of the user that assigned this task. Currently not filled by Box. For each task assignment this is the name of the user that assigned this task. Currently not filled by Box. For each task assignment this is the ID of the user the task is assigned to. For each task assignment this is the login name of the user the task is assigned to. For each task assignment this is the name of the user the task is assigned to. For each task assignment this is the date at which the assignment is to be completed at. Currently not filled by Box. Indicates whether this task is completed (true) or not (false). For each task assignment this is the message that will is included with the assignment of the task. Currently not filled by Box. For each task assignment this is the date at which the assignee shall be reminded about this task. Currently not filled by Box. For each task assignment this is the resolution state of the task assignment. Values can be COMPLETED, INCOMPLETE, APPROVED or REJECTED. Currently not filled by Box. Date at which the document was trashed. address that uploads for a folder can be sent to. Access level for an upload address. Can be COLLABORATORS or OPEN. 14 Recommind, Inc

15 Property name box_url_hint box_version_number Description of this property in Box URL to track back an item in the Box front-end if logged on with the user found in the URI. Version number of a file. When making changes this number is incremented automatically Box Document Dates For the individual documents, Box provides different dates. These date properties may occur in XML metadata after data load: box_created_at Indicates the time when the document (or version) was uploaded to the Box server. box_modified_at Indicates the time that the document was last changed on the Box server. This can be an upload or a direct modification on the server (e.g. in case of Box notes). rm_creationdate Indicates the creation of the content. Is derived from the file properties during upload. Usually reflects the time that the file was originally created. Note: This type of date is not available for Box versions. rm_lastmodifieddate Indicates the last modification date of the content. Is derived from the file properties during upload and usually reflects the time that the file was last changed before upload. This date is overwritten when the document is modified directly on the Box server (e.g. for Box notes). Note: This type of date is not available for Box versions. Note: The dates derived from the file properties may not be available, depending on the method of upload. More details on how Box handles dates can be found here: Timestamps/ta-p/ Recommind, Inc

16 1.4.2 Author Information Author information is provided by Box. Authors are the users that created a document in Box or uploaded a document to Box. For Box notes, a special mapping is used Box document authors The author for uploaded documents is the user that performed the upload. For instance, if John Smith wrote a Microsoft Word document, and Ann Miller uploaded it to Box, Ann Miller is shown in the Sender/Author Smart Filter. You find Box document creator information in the box_created_by_name property, which is mapped to the CORE rm_author field. Versions inherit the author from the current document. Note: If Box does not provide a creator for a document, the rm_author field remains empty. This may happen when a user is deleted and his data is transferred to another account. In this case, the transferred documents will not have an author, as the creator has been deleted Box note authors Box note author information is also mapped to the CORE rm_author field. Box notes may have several authors, but only one is shown in the rm_author field. Box notes author information has up to three properties: box_note_author_name, box_note_author_id, box_note_author_login. If the default configuration is not changed, these are concatenated to form one value in the CORE rm_author field. Example: Box note author information in the CORE XML structure This author information for a Box note: <box_note_author type="main"> <box_note_author_id> </box_note_author_id> <box_note_author_login>miller@recommind.com</box_ note_author_login> <box_note_author_name>mandy_miller</box_note_ author_name> </box_note_author> is concatenated and mapped to the rm_author field like this: <rm_author type="main">mandy_miller (miller@recommind.com, )</rm_author> 16 Recommind, Inc

17 Related: "Box Note Authors" on page 28 "Unknown Users Handling" below Box URL Hints The CORE XML tag box_url_hint is filled with a Box URL hint. You can use this URL to directly find and access the corresponding document from a web browser on Box.com, for analyzing or troubleshooting. The URL does not contain user information. To make the Box URL hint work correctly, you must log in to Box with the correct account. The account belonging to the URL can be derived from the Location Smart Filter. 1.5 Unknown Users Handling Documents may contain references to Box users that have been deleted in Box. In this case, user information will be missing in the loaded data. Only the box_modified_ by_id, box_created_by_id or box_owned_by_id tags are filled. In addition, the unknown user's ID is added to the indexed document as an XML tag: box_unknown_ user_reference. You can create a CORE field to make this ID visible, e.g., in the Metadata fly-in. 1.6 Box Custom and Template Metadata In addition to default Box metadata, the connector supports metadata added by users. Box allows a user to add key-value pairs to certain Box documents, as custom metadata. An administrator can create metadata templates that each define a set of keys. A user can assign such a template to a document and then assign values to the individual keys belonging to the template. For each key the connector creates a corresponding output property in the XML file, with the corresponding value or no value if none has been set. The name of the property follows one of these patterns: box_metadata_<templatename> <key> <templatename> is the name of the template. <key> is the name of the key. For template metadata key names, some operations affecting the string are carried out by Box: e.g., characters are changed to lowercase, non-alphanumeric characters are dropped and so on. 17 Recommind, Inc

18 Note: The name for a template metadata key depends on the display name that is used when first creating this key in the template. Later changes to the name will not be reflected upon indexing. box_metadata_properties <key> properties indicates that this is a custom property. <key> is the name of the key. 18 Recommind, Inc

19 Example: Metadata as set in Box and in the XML file after data load Assume these user-added metadata: Metadata set in Box In the XML file, these metadata look like this: <box_metadata_exampletemplate exampletext type="main">example Text Value</box_metadata_ exampletemplate exampletext> <box_metadata_exampletemplate examplenumber type="main">21.0</box_metadata_exampletemplate examplenumber> <box_metadata_exampletemplate exampledate type="main"> t00:00:00.000z</box_metadata_ exampletemplate exampledate> <box_metadata_exampletemplate exampledropdown 19 Recommind, Inc

20 type="main">option One</box_metadata_exampleTemplate exampledropdown> <box_metadata_properties Example_0x20_custom_0x20_ metadata_0x20_field type="main">example custom metadata value </box_metadata_properties Example_ 0x20_custom_0x20_metadata_0x20_field> 1.7 Box Connector Prerequisites Scopes Before you can configure the Recommind connector for Box, you must create a Box application that provides programmatic access to the Box Enterprise account. To create and configure such an application, log in as Box administrator and go to The scope required by the connector is called Read and write all files and folders stored in Box and is enabled by default. Other configurable scopes such as e.g. Manage enterprise or Manage app users are not required Requirements to be provided by Box There are some additional settings that cannot be satisfied by configuration changes, but must be provided by Box support. To meet these requirements: File a request with Box to activate the On Behalf Of feature, which enables the Box application to access any Box Enterprise user account. The connector uses this access. If data is to be retrieved from trash, also file a request with Box to activate the GCM scope. Note: If this scope is not active, content cannot be retrieved from the trash. Send your requests to api@box.com. Note: These settings affect only newly generated tokens. So in case a token pair has already been created, clear the working directory configured for the connector (and if applicable the tokens specified in the data source configuration) after Box provides the changes. Related: "Client secret" on page Recommind, Inc

21 "Working directory" on page Start URI for Box Data Sources Start URIs for the Box connector use the scheme box. A valid URL is, for example: box:anything. Multiple Box start URIs are not supported. Related: "Start URIs" on page Crawl a Specific User or Folder In the case that only a part of the Box enterprise account shall be crawled, you can configure the connector to crawl only certain folders in certain accounts. Under Box Scope Settings you can add the login names ( addresses) of the Box accounts to include in the crawl. If the list is empty, all accounts are crawled. As soon as there is an entry, only the listed accounts are crawled. List of user accounts ( addresses) to include in the crawl For each account that you add to the list, a new configuration node named like the account is added to the tree. Open it to add the folders to crawl for that account to the List of Box folders to be included. 21 Recommind, Inc

22 When specifying folders, the All Files folder shown in the Box UI must not be included. Instead the entries have to start with a slash /. A folder deeper in the folder hierarchy can be given by using / as delimiter between the folders in the path. A trailing /will be ignored. List of folders to be included If the list is empty, all folders of the account are crawled. Note: If the Index folders check box is activated, the root folder is always indexed. Related: "Box users to be crawled, specified by login name ( address)" on page 28 "Box folders to crawl for this user" on page Recommind, Inc

23 1.10 Crawl Box Trash If you want to crawl Box trash, make sure that the Index trash option is active in the data source configuration. There is also an additional prerequisite related to trash. Related: "Index trash" on page 31 "Box Connector Prerequisites" on page Granting Access to Box Account The connector connects to the Box application using OAuth 2 authentication. Therefore, access to the Box enterprise account to be crawled has to be granted before starting a crawl. There are two ways to do this: Provide credentials for automatic token generation Provide tokens Provide Credentials for Token Generation If SSO required is not enabled on the Box admin account, specify the Box admin login name and password in the data source configuration. Using these credentials, the connector automatically generates an initial token pair. Whenever needed, a new token pair is created with the most recent refresh token. Providing credentials is more convenient than providing tokens. Related: "Generate Tokens" on page Provide Tokens If SSO required is enabled on the Box admin account, or if the admin credentials shall not be directly exposed due to security policy, provide a token pair consisting of an access token and a refresh token. Caution: Only use an account with Box administrator rights to create the tokens. The tokens will infer the rights from the account they have been created with. In case of insufficient rights, you will see a 403 error in the crawler log files when the generated tokens are being used by the connector. 23 Recommind, Inc

24 Note: If SSO is required, tokens cannot be created automatically, using admin credentials. This is due to the login process being different for each different Identity Provider (IdP). To provide tokens, create a token pair with the Recommind Box Token Generator and copy it to the data source configuration. The provided token pair is only needed for the initial data source setup. For the following runs (with the same connector working directory), the tokens will automatically be replaced with new pairs that are created with the latest refresh token. Only after 60 days of inactivity the latest refresh token will expire. You then have to provide a new valid token pair generated with the Recommind Box Token Generator. Note: A token pair can only be used by a single connector. Each data source needs its own dedicated token pair. Related: "Recommind Box Token Generator" below "Generate Tokens" on page 30 "Access token" on page 27 "Refresh token" on page Recommind Box Token Generator The Recommind Box Token Generator is a small standalone tool that facilitates the initial generation of a token pair. It starts a web server that serves a page guiding the user through token pair generation Set up and Start Recommind Box Token Generator Required: You downloaded connectors\recommind-box-token-generation.zip from Recommind s FTP server, or Recommind Support provided a link. Java Runtime Environment (JRE) with Java8 is installed on the machine the tool shall run on. The path to java.exe is set in the PATH system variable. 1. Download the ZIP file containing the tool. 2. Extract the tool to an arbitrary folder. 3. Edit the configuration in the application.properties file. 24 Recommind, Inc

25 4. Run recommind-box-token-generator.bat. Optionally, check the log output in recommind-box-token-generator.log. 5. Open the URL with a web browser. If you specified another server or port in the application.properties file, use an URL with these settings. If the setup was successful, the Recommind Box Token Generator s main page with the configured settings is shown Configure Recommind Box Token Generator To configure Recommind Box Token Generator, edit the application.properties file. To apply changed properties, start Recommind Box Token Generator by clicking boxtoken-generator.bat. To restart it, close the command prompt for the BAT file with [CTRL]+[C] and then click box-token-generator.bat again. Configuration properties server.port Mandatory setting Default: 5858 Sets the port under which you can reach the tool with a browser. Use the same port for the redirect URL configured for the Box application. clientid This mandatory value indicates the Box application Client ID. It has to match the Client ID in the data source configuration. clientsecret This mandatory value indicates the Box Application secret. It has to match the Client secret in the data source configuration. proxyhost This optional value indicates the host of the proxy to use when accessing the Box servers internally. When no value is given here, no proxy is used for this communication. proxyport Port of the proxy to use. It is mandatory when a proxy is used. proxyuser User name to use when authenticating at the proxy. It is only needed when a proxy is configured and the proxy requires authentication. If left empty, no authentication is 25 Recommind, Inc

26 used for the proxy. proxypassword Password to use when authenticating at the proxy. This value is mandatory, when a proxy with authentication is used Proxy Setup and Network Access For the proper functioning of the Recommind Box Token Generator, network access is required. This has to be taken into account when working in a network restricted environment. The token generator itself needs access to *.box.com. If a proxy is configured for the Recommind Box Token Generator, the proxy needs access to *.box.com The web browser needs access to the token generator and to *.box.com. If SSO is used, it also needs access to the server of the Identity Provider (IdP). These are the same requirements that apply to logging in to Box Configure Box for Token Generation For the Recommind Box Token Generator to work properly, configure the correct redirect URL in the Box application. The redirect URL must point to the Token Generator s main page. By default, this is When running the generator on a different machine, change the redirect URL to point to that machine instead of localhost. Also make sure that the port matches that of the Recommind Box Token Generator s configuration. To change the relevant Box configuration parameter, 1. log in as Box admin. 2. Go to and click Edit Application for the respective application. 3. Under OAuth2 Parameters, adapt the redirect_uri parameter Generate Tokens Required: You are not logged in to Box, or you are logged in with the admin account for which tokens will be generated. 1. To start the Box Token Generator, run recommind-box-token-generator.bat. 26 Recommind, Inc

27 The main page is opened in a web browser. Note: Verify that the correct configuration values and redirect URL are shown. 2. Click the Generate Tokens link. If you are not logged in to Box, you will be redirected to a Box login page. 3. Log in with your Box admin account either directly or by using SSO. You are redirected to a Box page asking you to grant permissions to the Box App indicated with Client ID in the Box Token Generator configuration. 4. Click Grant access to Box. You are redirected to the Box Token Generator web page. There is an additional section labeled Resulting Tokens that shows the token pair that has been generated. 5. Copy these values into the corresponding fields of the connector configuration. Tip: To generate another pair, click Generate Tokens again. To return to the initial page, click Reset Page. Note: Do not use the browser's back button and do not reload the page. This may lead to errors because provided URL parameters are valid only once. Instead use the Reset Page link (if available) or enter the initial URL again Configure the Box Connector Multiple configuration settings in CORE Administration are shown in alphabetical order Access token Access token created with the Recommind Box Token Generator. This field must only be filled if Generate Tokens is disabled. Location: Data source: Crawler connectors > DMS connectors > Box > Connection settings > Box API Access Allowed values: a string of characters None Related: "Provide Tokens" on page Recommind, Inc

28 Box admin user The Box login name ( address) of an admin of the Box enterprise account to be crawled. Location: Data source: Crawler connectors > DMS connectors > Box > Connection Settings > Box API Access Allowed values: address None Box folders to crawl for this user List of folders within a specific Box account to be included. Leave empty to include all folders of the account. To specify a folder, go to the respective Box user node, add the folder name and click +. Location: Data source: Crawler connectors > DMS Connectors > Box > Scope settings > Box users to be included > <Box user name> Allowed values: folder names as shown in the user s account empty (=all) Related: "Crawl a Specific User or Folder" on page 21 "Box users to be crawled, specified by login name ( address)" below Box Note Authors Field to which the Box note author information is mapped. If empty, no mapping takes place. Location: Data source: Crawler connectors > DMS Connectors > Box > Crawl Configuration > Mapping Allowed values: CORE field name rm_author Box users to be crawled, specified by login name ( address) Add accounts to be included in the crawl. Leave empty to include all. 28 Recommind, Inc

29 Location: Data source: Crawler connectors > DMS connectors > Box > Scope settings > Users and Folders Allowed values: Box user login names empty (=all) Related: Client ID "Crawl a Specific User or Folder" on page 21 "Box folders to crawl for this user" on the previous page Client_ID (API key) of the Box application used for access. To find the value to enter here, log in as administrator, go to and click Edit Application. Location: Data source: Crawler connectors > DMS connectors > Box > Connection Settings > Box API Access Allowed values: a string of characters None Client secret client_secret as specified by the OAuth2 standard. To find the value to enter here, log in as administrator, go to and click Edit Application. Location: Data source: Crawler connectors > DMS connectors > Box > Connection Settings > Box API Access Allowed values: a string of characters None Related: "Box Connector Prerequisites" on page Recommind, Inc

30 Generate Tokens When set to true, tokens will be generated using the provided admin credentials. When set to false, tokens have to be provided using Recommind Box Token Generator. Location: Data source: Crawler connectors > DMS connectors > Box > Connection Settings > Box API Access Allowed values: true false true Related: " Granting Access to Box Account" on page Enable this connector Activate check box to enable the connector. Only if this is true, the connector is available to process its assigned URIs. Location: Data source: Crawler connectors > DMS connectors > Box > Connection settings Allowed values: true false false Index versions Activate the check box to make the connector retrieve all document versions. Deactivate to only retrieve the most recent version of each document. Location: Data source: Crawler connectors > DMS connectors > Box > Scope Settings > Features Allowed values: true false true 30 Recommind, Inc

31 Index trash Activate this check box to make the connector include items that have been marked as deleted in Box. Location: Data source: Crawler connectors > DMS connectors > Box > Scope Settings > Features Allowed values: true false false Proxy host Host name of the proxy server to use. Mandatory if Use proxy server is enabled. Location: Data source: Crawler connectors > DMS connectors > Box > Connection Settings > Proxy configuration Allowed values: string None Proxy port Port of the proxy server to use. Mandatory if Use proxy server is enabled. Location: Data source: Crawler connectors > DMS connectors > Box > Connection Settings > Proxy configuration Allowed values: port number None Proxy user name User name for proxy authentication. Mandatory if Use proxy authentication is enabled. Location: Data source: Crawler connectors > DMS connectors > Box > Connection Settings > Proxy Authentication 31 Recommind, Inc

32 Allowed values: string None Proxy user password User password for proxy authentication. Mandatory if Use proxy authentication is enabled. Location: Data source: Crawler connectors > DMS connectors > Box > Connection Settings > Proxy Authentication Allowed values: string None Refresh token Refresh token created with the Box Token Generator. This field must only be filled if Generate Tokens is disabled. Location: Data source: Crawler connectors > DMS connectors > Box > Connection settings > Box API Access Allowed values: a string of characters None Related: Start URIs "Generate Tokens" on page 26 Start URIs can trigger the use of a specific connector. For some connectors, the Start URI is the access point to the data to be loaded. Some connectors require additional connection information. Besides URIs, certain common file path syntaxes are allowed. Note: Look for connector-specific start URI information in the first part of this documentation. Example URIs are file:///d:/data/, d:\data for files in Windows file systems; /home/usr/data/, file:///home/usr/data/ for files on a UNIX file system, 32 Recommind, Inc

33 csv:///d:/data for CSV load files; and for the Web. For access to a database using an ODBC bridge use jdbc:obdc:odbcdatasource, and for a generic JDBC data source use the appropriate JDBC connection string. Location: Data source: Dataset definition > Dataset Allowed values: anything allowed in URIs or file paths None Use proxy authentication Activate if authentication is needed for accessing the proxy server. Location: Data source: Crawler connectors > DMS connectors > Box > Connection Settings > Proxy Authentication Allowed values: true false false Use proxy server Activate if you use a proxy server to access Box servers. Location: Data source: Crawler connectors > DMS connectors > Box > Connection Settings > Proxy configuration Allowed values: true false false Working directory The folder where the connector stores Box API authentication data (access token). The path is relative to the config folder within the data source project folder. Location: Data source: Crawler connectors > DMS connectors > Box > Crawl configuration > Workspace settings 33 Recommind, Inc

34 Allowed values: a string denoting a file path../box-cache 34 Recommind, Inc

35 2 Changes to this Document 2 Changes to this Document Date Topic title Text before change Text after change Remarks "Provide Tokens" on page 23 - Only use an account with Box administrator rights to create the tokens. Otherwise, 403 errors may occur. 35 Recommind, Inc

36 3 Contact Us 3 Contact Us About Recommind Recommind provides the most accurate and automated enterprise search, automatic classification, and ediscovery software available, giving organizations and their users the information they need when they need it. Visit us at Support For support issues on Recommind products, visit the Recommind Ticketing System at Documentation Find Recommind product documentation, Knowledge Base articles, and more information at the Recommind Customer Portal at For login access to the site, contact your product support: For : SearchSupport@recommind.com For : Axcelerate@recommind.com The Recommind Documentation team is interested in your feedback. For comments or questions about Recommind product documentation, contact us at rec-documentation@opentext.com. 36 Recommind, Inc

37 4 Terms of Use 4 Terms of Use Disclaimer This document, as well as the products and services described in it, is furnished under license and may only be used or copied in accordance with the terms of the license. The information in this document is furnished for informational use only, is subject to change without notice, and should not be construed as a commitment by Recommind, Inc., including its affiliates and subsidiaries (collectively, "Recommind"). Recommind assumes no responsibility or liability for any errors or inaccuracies that may appear in this document or any software or services that may be provided in association with this document. Except as permitted by such license, no part of this document may be reproduced, stored in a retrieval system, or transmitted in any form or by any means without the express written consent of Recommind. Information in this document is provided in connection with Recommind's products and services. No license, express or implied, by estoppel or otherwise, to any intellectual property rights is granted by this document. EXCEPT AS PROVIDED IN RECOMMIND S SOFTWARE LICENSE AGREEMENT OR SERVICES AGREEMENT FOR SUCH PRODUCTS OR SERVICES, RECOMMIND ASSUMES NO LIABILITY WHATSOEVER, AND RECOMMIND DISCLAIMS ANY EXPRESS OR IMPLIED WARRANTY, RELATING TO SALE AND/OR USE OF RECOMMIND PRODUCTS OR SERVICES INCLUDING LIABILITY OR WARRANTIES RELATING TO FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR INFRINGEMENT OF ANY PATENT, COPYRIGHT OR OTHER INTELLECTUAL PROPERTY RIGHT. RECOMMIND MAKES NO WARRANTIES REGARDING THE COMPLETENESS OR ACCURACY OF ANY INFORMATION, NOR THAT THE PRODUCTS OR SERVICES WILL BE ERROR FREE, UNINTERRUPTED, OR SECURE. IN NO EVENT WILL RECOMMIND, THEIR DIRECTORS, EMPLOYEES, SHAREHOLDERS AND LICENSORS, BE LIABLE FOR ANY CONSEQUENTIAL, INCIDENTAL, INDIRECT, SPECIAL OR EXEMPLARY DAMAGES INCLUDING, BUT NOT LIMITED TO, LOSS OF ANTICIPATED PROFITS OR BENEFITS. Recommind may make changes to specifications, and product and service descriptions at any time, without prior notice. Recommind's products may contain design defects or errors known as errata that may cause the product or service to deviate from published specifications. Current characterized errata are available on request. Whilst every effort has been made to ensure that the information and content within this document is accurate, up-to-date and reliable, Recommind cannot be held responsible for inaccuracies or errors. Recommind software, services and documentation have been developed and prepared with the appropriate degree of skill, expertise and care. While every effort has been made to ensure that this documentation contains the most up-to-date and accurate information available, Recommind accepts no responsibility for any damage that 37 Recommind, Inc

38 4 Terms of Use may be claimed by any user whatsoever for the specifications, errors or omissions in the use of the products, services and documentation. Trademarks and Patents Recommind's underlying technology is patented under U.S. Patent Nos. 6,687,696, 7,328,216, 7,657,522, 7,747,631, 7,933,859, 8,024,333, 8,103,678, 8,429,159 and 8,489,538 Recommind, Inc. is the leader in predictive information management and analysis software, delivering business applications that transform the way enterprises, government entities and law firms conduct ediscovery, enterprise search, and information governance. Recommind, Axcelerate, Axcelerate Cloud, Axcelerate OnDemand, and CORE s name and logo are registered trademarks of Recommind, Inc. Copyright Copyright Recommind, Inc Recommind, Inc