HubSpot Connector 23.3

# Install HubSpot Connector on Windows

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

To install the HubSpot Connector

1. Run the HubSpot 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 HubSpot 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 that you want to index data into, and click Next.

   The Proxy Server dialog box opens.

2. If you have installed the connector on a machine that is behind a proxy server, 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 HubSpot Authentication dialog box opens.

3. Choose whether to authenticate with HubSpot using OAuth or an API Key. If you choose API Key, type the API key in the box. Then, click Next.

   The HubSpot Types dialog box opens.

4. Select the check boxes for the types of information that you want to retrieve from HubSpot and index into IDOL. If you are retrieving data from a HubSpot marketing environment, you can select the Use HubSpot Marketing Environment check box and choose whether to retrieve additional data types that are not available in the HubSpot CRM/Sales environment. After choosing what to synchronize, click Next.

5. (Only for OAuth Authentication). If you chose to authenticate with HubSpot using OAuth, type the following information and then 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`.

6. 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 Connector Framework Server dialog box opens. Type the Hostname and Port of your existing CFS. Then, click Next and go to Step 18.

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. (Only for OAuth Authentication) The installation program can run the OAuth tool, which obtains the token necessary to retrieve information from HubSpot.

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

     Your default web browser opens to the HubSpot web site, so that you can authorize the connector to access HubSpot. After you authorize the connector, the OAuth tool obtains the access token from HubSpot 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.

   The Advanced Configuration dialog box opens.

2. The installation program can run the connector and help you configure what to synchronize.

   - To configure what to synchronize, select the Perform advanced connector configuration check box and click Next.

     The connector queries the repository to obtain a list of files that you can retrieve. Go to the next step.

   - To configure the connector manually, clear the Perform advanced connector configuration check box, and click Next.

     The installation is complete. Click Finish.

3. In the PathMustHaveRegex, PathCantHaveRegex, and FileFilter boxes, type values to choose the files that you want to retrieve from HubSpot.

   PathMustHaveRegex | A regular expression to limit the files retrieved by the connector. Unless the full path of a file matches the regular expression, the file is ignored.
   PathCantHaveRegex | A regular expression to limit the files retrieved by the connector. If the full path of a file matches the regular expression, the file is ignored.
   FileFilter | A comma-separated list of parameter/value pairs to filter the files that are ingested by the connector. For information about the parameters and values that you can set, refer to the HubSpot documentation at https://developers.hubspot.com/docs/methods/files/get_files. Do not set the parameters `limit` or `offset` as these are used for paging and are set automatically by the connector.

   Then, in the Next action list, choose one of the following options and click Next:

   - Test parameters - filter the list of items, using the parameter values you entered.
   - Finish configuration - save the configuration and end the configuration process.
   - Continue configuration - continue configuring the connector.

   If you choose to continue configuring the connector, the connector queries the repository for other items.

4. You can add filters to choose the items that are ingested by the connector. To set a filter, complete the following steps:

   1. In the Item Type list, choose the type of item that you want to filter.
   2. In the Filter box, type a comma-separated list of parameter-value pairs to filter the items. For information about the parameters and values that you can set, refer to the HubSpot API documentation for Folders, Broadcast Messages, Pages, Blog Topics, Blog Posts, Blog Comments, Blog Authors, and Blogs. Do not set the parameters `limit` or `offset` as these are used for paging and are set automatically by the connector.
   3. In the Next action list, click Test parameters and click Next. It is important to complete this step, so that the filter value you entered is saved in the connector's configuration file. When you are satisfied with the list of filtered items, you can repeat step 22 for the other types of items, or proceed to the next step.

5. In the Next action list, click Finish configuration and click Next.

   The configuration is complete.

6. Click Next, and then click Finish.

Copyright 2023 Open Text
Version 23.3 | Last updated June 2023

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 HubSpot Connector 23.3

Topic Title: Install HubSpot Connector on Windows