Box Connector 12.13

# Install Box Connector on Windows

To install the Box Connector on Windows, use the following procedure.

To install the Box Connector

1. Run the Box Connector installation program.

   The installation wizard opens.

2. Read the installation instructions and click Next.

   The License Agreement dialog box opens.

3. Read the license agreement. If you agree to its terms, click I accept the agreement and click Next.

   The Installation Directory dialog box opens.

4. Choose an installation folder for Box Connector and click Next.

   The Service Name dialog box opens.

5. In the Service name box, type a name to use for the connector’s Windows service and click Next.

   The Service Port and ACI Port dialog box opens.

6. Type the following information, and click Next.

   Service port | The port used by the connector to listen for service actions.
   ACI port | The port used by the connector to listen for actions.

   The License Server Configuration dialog box opens.

7. Type the following information, and click Next.

   License server host | The host name or IP address of your License server.
   License server port | The ACI port of your License server.

   The IDOL database dialog box opens.

1. In the IDOL database box, type the name of the IDOL database into which you want to index documents, and click Next.

   The Proxy Server dialog box opens.

2. If a proxy is required to communicate with the repository from the machine on which you are installing the connector, type the following information and then click Next.

   Proxy host | The host name or IP address of the proxy server to use to access the repository.
   Proxy port | The port of the proxy server to use to access the repository.
   Proxy username | The user name to use to authenticate with the proxy server.
   Proxy password | The password to use to authenticate with the proxy server.

   The Box connection dialog box opens.

3. In the Box user name box, type the user name to use to access the Box repository. If you want to retrieve information from Box Enterprise, this must be the user name of an admin or co-admin.

4. (Optional) If you want to retrieve information from Box Enterprise, select the Box Enterprise check box. You can also use regular expressions to limit the user accounts from which information is retrieved.

   "Must Have" regex | A regular expression to restrict the user accounts synchronized by the connector. If set, the connector does not synchronize a user account unless the login name matches the regular expression.
   "Cant Have" regex | A regular expression to restrict the user accounts synchronized by the connector. If set, the connector does not synchronize any account where the login name matches the regular expression.

5. Click Next.

   The OAuth Authentication Parameters dialog box opens.

6. Type the following information and click Next.

   AppKey | The application key that was provided when you set up an application to represent the connector.
   AppSecret | The application secret that was provided when you set up an application to represent the connector.
   Redirect URL | The URL at which the OAuth tool will run. For example, `http://localhost:7878/oauth`.

   The CFS dialog box opens.

7. Choose whether to install a new CFS or use an existing CFS.

   - To install a new CFS, select the Install a new CFS check box and click Next.

     The Installation directory dialog box opens. Go to the next step.

   - To use an existing CFS, clear the Install a new CFS check box and click Next.

     The CFS dialog box opens. Type the host name and port of your existing CFS installation. Then, click Next and go to Step 19.

1. Choose an installation folder for the Connector Framework Server and then click Next.

   The Installation name dialog box opens.

2. In the Service name box, type a unique name for the Connector Framework service and click Next. The name must not contain any spaces.

   The CFS dialog box opens.

3. Type the following information, and click Next.

   Service port | The port used by CFS to listen for service actions.
   ACI port | The port used by CFS to listen for actions.

4. Type the following information and click Next.

   IDOL Server hostname | The host name or IP address of the IDOL server that you want to index documents into.
   ACI port | The ACI port of the IDOL server.

   The Pre-Installation Summary dialog box opens.

5. Review the installation settings. If necessary, click Back to go back and change any settings. If you are satisfied with the settings, click Next.

   The connector is installed.

1. The installation program can run the OAuth tool, which obtains the token necessary to retrieve information from Box.

   - To run the OAuth tool, select the Run OAuth tool check box, and click Next.

     Your default web browser opens to the Box web site, so that you can authorize the connector to access Box. After you authorize the connector, the OAuth tool obtains the access token from Box and writes it to a file named `oauth.cfg`, in the connector's installation folder. The parameters in `oauth.cfg` are included in the default connector configuration.

   - To finish installing the connector without running the OAuth tool, clear the Run OAuth tool check box and click Finish. For information about how to run the OAuth tool at a later time, see Configure OAuth Authentication.

2. Click Finish.

   The installation is complete.

© Copyright 2022 Micro Focus or one of its affiliates
Version 12.13 | Last updated October 2022

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 swpdl.idoldocsfeedback@microfocus.com.

We appreciate your feedback!

Product: IDOL Box Connector 12.13

Topic Title: Install Box Connector on Windows