Box Connector 24.4
IDOL Box Connector Help

# Retrieve Information from Box Enterprise

To retrieve information from the users associated with a Box Enterprise repository, create a new fetch task by following these steps.

NOTE: Before configuring a fetch task, you must create a Box application to represent the connector and configure OAuth authentication. For more information, see Create a Box Application and Configure OAuth Authentication.

To create a new Fetch Task

1. Stop the connector.
2. Open the configuration file in a text editor.

3. In the `[FetchTasks]` section of the configuration file, specify the number of fetch tasks using the `Number` parameter. If you are configuring the first fetch task, type `Number=1`. If one or more fetch tasks have already been configured, increase the value of the `Number` parameter by one (1). Below the `Number` parameter, specify the names of the fetch tasks, starting from zero (0). For example:

       [FetchTasks]
       Number=1
       0=MyTask

4. Below the `[FetchTasks]` section, create a new TaskName section. The name of the section must match the name of the new fetch task. For example:

       [FetchTasks]
       Number=1
       0=MyTask

       [MyTask]

1. In the new section, set the parameters required to authenticate with Box. The OAuth configuration tool (described in Configure OAuth Authentication) creates a file that contains these parameters, and you can include them in the connector's configuration file using the following syntax:

       [MyTask] < "oauth.cfg" [OAUTH]

   For more information about including parameters from another file, see Include an External Configuration File

2. In the new section, set the following configuration parameters:

   `BoxEnterprise` | A Boolean value that specifies whether you are configuring the connector to access Box through a Box Enterprise admin or co-admin account, in order to synchronize the accounts of all managed users. Set this parameter to `TRUE`.
   `Username` | The user ID or login name to use to retrieve information from Box. This must be the username of an admin or co-admin.
   `MappedSecurity` | (Optional) To extract security information and add Access Control Lists (ACLs) to documents, set this parameter to `TRUE`.
   `EnterpriseLoginCantHaveRegex` | (Optional) A regular expression to restrict the user accounts synchronized by the connector. The connector does not synchronize any account where the login name matches the regular expression.
   `EnterpriseLoginMustHaveRegex` | (Optional) A regular expression to restrict the user accounts synchronized by the connector. The connector does not synchronize a user account unless the login name matches the regular expression.
   `ProxyHost` | (Optional) The host name or IP address of the proxy server to use to access Box.
   `ProxyPort` | (Optional) The port of the proxy server to use to access Box.

   For example:

       [MyTask] < "oauth.cfg" [OAUTH]
       BoxEnterprise=TRUE
       Username=admin@my_domain.com
       MappedSecurity=TRUE
       EnterpriseLoginMustHaveRegex=.*@my_domain\.com
       ProxyHost=proxy.domain.com
       ProxyPort=8080

   For more information about the configuration parameters that you can use to configure the connector, refer to the Box Connector Reference.

3. Save and close the configuration file. You can now start the connector.

Copyright 2024 Open Text
Version 24.4 | Last updated September 2024

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to MFI-swpdl.idoldocsfeedback@opentext.com.

We appreciate your feedback!

Product: IDOL Box Connector 24.4

Topic Title: Retrieve Information from Box Enterprise