Open topic with navigation

# Install SharePoint OData Connector on Windows

To install the SharePoint OData Connector on Windows, use the following procedure.

To install the SharePoint OData Connector

1. Run the SharePoint OData 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 SharePoint OData 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. Then, click Next.

   The Proxy Server dialog box opens.

2. If the connector must use a proxy server to access SharePoint, type the following information. 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 SharePoint Online Server dialog box opens.

3. Choose whether you intend to retrieve data from an instance of SharePoint Online and click Next.

4. Type the following information, and click Next.

   Sharepoint site collection URL | The site collection URL to use as the starting point for the `synchronize` fetch action.
   Username | The user name to use to authenticate with SharePoint.
   Password | The password to use to authenticate with SharePoint.
   Domain | (Not for SharePoint Online). The domain of the specified user.

5. 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.

     Type the Hostname and Port of your existing CFS. Then, click Next and go to step 17.

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 and the Advanced Configuration dialog box opens.

1. The installation wizard can run the connector, query the repository, and help you to 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. If you are connecting to SharePoint Online, go to step 20 because SharePoint Online does not have Site Collections. Otherwise, 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. You can now edit the connector's configuration file and start the connector.

2. In the SiteCollectionUrlMustHaveRegex and SiteCollectionUrlCantHaveRegex boxes, type regular expressions to choose the site collections that you want to retrieve information from.

   SiteCollectionUrlMustHaveRegex | The absolute URL of a site collection must match the regular expression, or the site collection is not indexed.
   SiteCollectionUrlCantHaveRegex | If the absolute URL of a site collection matches the regular expression, the site collection is not indexed.

   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 a list of sites contained in your chosen site collections.

3. In the SiteUrlMustHaveRegex and SiteUrlCantHaveRegex boxes, type regular expressions to choose the sites that you want to retrieve information from.

   SiteUrlMustHaveRegex | The absolute URL of a site must match the regular expression, or the site is not indexed.
   SiteUrlCantHaveRegex | If the absolute URL of a site matches the regular expression, the site is not indexed.

   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 to find the lists contained in your chosen sites.

4. In the ListUrlMustHaveRegex and ListUrlCantHaveRegex boxes, type regular expressions to choose the lists that you want to retrieve information from.

   ListUrlMustHaveRegex | The absolute URL of a list must match the regular expression, or the list is not indexed.
   ListUrlCantHaveRegex | If the absolute URL of a list matches the regular expression, the list is not indexed.

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

   - Test regexes - filter the list of items, using the regular expressions you entered.
   - Finish configuration - save the configuration and complete the configuration process.

   When you finish configuring the connector, the Connector Configuration Completed dialog box opens.

5. Click Next, and then click Finish.

© 2018 EntIT Software LLC, a Micro Focus company | Send documentation feedback to Micro Focus Close Send documentation feedback To open the configured email client on this computer, open an email window. Otherwise, copy the information below to a web mail client, and send this email to swpdl.idoldocsfeedback@microfocus.com. We appreciate your feedback! Product: Topic Title: Help Topic: Feedback:

_FT_HTML5_bannerTitle.htm