How to Set Up and Configure the IBM Connections Connector Common API

When you install the IBM Connections connector, you install the web service that enables you to connect to the source system Your Source System is the repository where your data is stored (data to be indexed). This repository is managed by applications such as: - SharePoint O365 - SharePoint 2013/16/19 - Documentum - File Share - OpenText - Lotus Notes - etc. Your Source System repository can also be a database such as SQL or Oracle..

You can install your IBM Connections connector on either:

A local SharePoint server
Any Windows-based server with IIS

All BA Insight connectors can be downloaded from the Upland Right Answers Portal under Knowledge > BA Insight > Product Downloads > Connectors. This connector is installed with the same generic steps as any BA Insight connector. You must satisfy the Prerequisites for your connector before installing. The configuration specifics are detailed below.

After you install the IBM Connections connector, you must configure this connector to use the same web service port that you specified during installation.

For more information, see the following topic, "Install the Connector Common API."

Install the Connector Common API

Web Service connectors such as the IBM Connections connector, require you to install a separate API in order to connect to the source system. This is the Connector Common API.

To install the Connector Common API, follow these steps:

Download the zipped installation file and extract the .msi file to the location of your choice.
Right-click the .msi file and select Install.
If prompted, click Yes to enable the installer to make changes to your server. The BA Insight Setup Wizard appears.
Follow the steps in the wizard.
The Web Service Information screen appears. Enter the following details:
- Web Service Port: By default, the port number is entered for you.
  - This port number must be unique.
  - Record this number.
  - You need this number to in order to specify the connection Connection defines the how Connectivity Hub connects to your Source System (which contains your documents, graphics, etc.,). Your Connection includes identifying elements such as: URL of the BA Insight web service connector you are using, (File Share connector, SharePoint Online connector, etc.), Authentication mode, User Accounts and Credentials, Database information (for database connectors).
  - For more information about reusing this number, see Add the Connections Information.
- Domain Service Account for API WebService:
  - Leave the default entry NetworkService Local account used by the service control manager. Not recognized by the security subsystem, so you cannot specify its name in a call to the LookupAccountName function. Has minimum privileges on the local computer and acts as the computer on the network. or enter a new account.
  - The web service listens and crawls the server that is accessible using this service from the port specified above.
- Password:
  - A password is required only if you change the domain Service Account for API WebService.
  Note: You must enter a valid account and password to run the site in IIS and the application pool.
Finish the wizard installation.

Verifying the Installation

When you verify your IBM Connections Connector installation, you check to see that you can access the DataConnector page.

Note: In order to verify the installation you must have the port number that you specified during the installation of the Connector Common API.

Enter the URL to the DataConnector, which is in this format: http://localhost:<your port number>/dataconnector
The DataConnector page appears confirming that you installed the Connector Common API.