Install SharePoint Remote Connector

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

To install the SharePoint Remote Connector

  1. Run the SharePoint Remote 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 Remote 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 SharePoint Remote Connector Task Configuration dialog box opens.

  3. Enter the following information, and click Next.

    Sharepoint URL The starting point for the synchronize fetch action. For an on-premise SharePoint repository, you can type either a web application URL or a site collection URL. For SharePoint Online, type a tenant admin URL or a site collection URL.
    Username A user name for authentication with the SharePoint Web Services and Client API.
    Password A password for authentication with the SharePoint Web Services and Client API.
    Sharepoint instance type

    To retrieve information from SharePoint Online, click Online.

    • If you want the connector to crawl multiple site collections, ensure that the SharePoint URL you entered is a Tenant Admin URL and select the Crawl Site Collections check box.

    To retrieve information from a local SharePoint server, click Local Server.

    • In the User Domain box, type the domain for the user you specified.
    • In the SharePoint URL Type box, select the type of URL you entered.

    The CFS dialog box opens.

  4. 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 and click Next.

      The CFS dialog box opens. Type the Hostname and Port of your existing CFS. Then, click Next and go to Step 16.

  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 to find a list of site collections that you can retrieve information from. 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.