How to Install the SharePoint Online Connector

All BA Insight connectors can be downloaded from Right Answers under Knowledge > BA Insight > Product Downloads > Connectors.

This connector is installed with the same generic steps as any BA Insight connector.

Satisfy the Prerequisites for your connector before installing.

Configuration specifics are detailed below.

Connector-specific Settings

Set the Connection: Certificate Authentication

  1. After setting your generic information, click the Connect or Refresh Web Service link.
  2. The page refreshes and displays additional settings.

  3. In the Certificate field, enter your Certificate common name. The Connector supports certificate authentication only.

    If you copy your certificate details, as shown in the Certificate console graphic below, your syntax will contain unnecessary spaces.

    You must ensure you enter your certificate information in syntax without spaces or your certificate will not work.

    CORRECT SYNTAX example: "CN=Jeff Smith"
    INCORRECT SYNTAX example: "CN = Jeff Smith"

  4. In the Password field, enter the Application ID.

    1. This is a GUID such as "c87a7836-a1da-455c-9171-836bf793c195".

  5. Site collections/Site Collections Enumerator Filter:
    1. This value depends on your use case.
    2. Typically, users enter a site collection with inclusion (*) set.
    3. This captures all of the sites with the base URL.
      1. If you are using a Site Collection Enumerator, the format is described under the field in the user interface.
        1. Use the include and exclude keywords, followed by a list of site collections.
        2. Multiple site collections are separated by the pipe character |.
        3. Wild cards (*) are valid.
          For example:
          include=https://sitecollection.sharepoint.com/site1| https://sitecollection.sharepoint.com/sites*
          exclude= https://sitecollection.sharepoint.com/excluded
      2. If you are not using the Site Collection Enumerator, enter one site collection to be crawled per line.
  6. Synchronized Domain: Enter the fully qualified domain name of the internal domain synchronized with your Azure Active Directory.
  7. Disabled Security: Check to disable security. This results in no content be scurity-trimmed.


  8. Complete the following fields. 
    Carefully read the instructions under each field.
    Refer to the graphic below for sample values.
    1. Native Properties:
      1. Used only for Connector Framework implementations.
      2. Checking this box enables all metadata/properties to be returned directly as native SharePoint crawled properties.
    2. Compound Properties:
      1. Provide a comma-separated list of properties to be combined and returned as a single appended string from multiple values. 
    3. Azure Portal Configuration Settings:
      1. Enter the following values in the following order, as shown in the graphic below, one per line:
        1. Tenant name
        2. Audience URI
        3. Admin URL


  9. Next, complete all remaining fields. Carefully read the instructions under each field.


  10. To property map well known groups from SharePoint (like Everyone except external users, All Authenticated Users, and Authenticated Users), use the following Group load script:

    Group Load Script
    Copy 
    dim sysId as string = HOST.GetSystemId()

    If sysId = "true"
    HOST.SetAdId("NT AUTHORITY\Authenticated Users")
    End If


    If sysId = "windows"
    HOST.SetAdId("NT AUTHORITY\Authenticated Users")
    End If


    If sysId.startswith("spo-grid-all-users")
    HOST.SetAdId("NT AUTHORITY\Everyone")
    End If

  11. If you use Connectivity Hub as your framework, you must replace the default security sync scripts to properly resolve users and groups. Use the security sync scripts below:

    User Load Script
    Copy 
    Dim systemId as String = HOST.GetSystemId()
    if (String.IsNullOrEmpty(systemId)) then
    Return TargetDirectory.GetUserByDisplayIdentifier(HOST.GetSystemName())
    else
    Return TargetDirectory.GetUserByDisplayIdentifier(systemId)

    end if
    Group Load Script
    Copy 
    Dim systemName as String = HOST.GetSystemName()
    if (String.IsNullOrEmpty(systemName)) then
    Return TargetDirectory.GetGroupByDisplayIdentifier(HOST.GetSystemId())
    else
    Return TargetDirectory.GetGroupByDisplayIdentifier(systemName)

    end if

Complete the information in the remaining tabs using the generic instructions here: