SharePoint

Connect your SharePoint source to Aiimi Insight Engine to make the most of your data. Once you have selected a Source System type more detail will expand to customise this.

Azure Portal Azure AD Authentication

Azure Communication Services (ACS) are being deprecated. Authentication via Azure Portal and Azure AD is the modern way to manage app registration, communication and authentication.

You can use an Azure Registered Application with a certificate to connect to SharePoint Online. This allows for modern API Permission management scopes such as Sites.Selected via the SharePoint API in Azure.

For support setting this up use our guide on Azure Portal and Azure AD Authentication.


General

  1. Authentication Mode - Select the type of authentication to use when connecting to SharePoint.

  2. Tenant ID - Enter the SharePoint online or Azure Registered Application Tenant ID to use.

  3. Client ID - Enter the SharePoint online or Azure Registered Application Client ID to use.

  4. Select Credential (Username & Password) - Choose the credentials to use.

  5. Select Credential - If your SharePoint Online does not have a Username and Password you must use a secret or certificate. Select the matching SecretOnly or Certificate credential for your SharePoint.

  6. Site Collection URL - Enter the root URL of the site collection that needs crawling.

    • Formatted https://[site]-admin.sharepoint.com

  7. Site Collection Lists - If your site collections do not match the Site Collect Lists, make sure you update these.

    1. Do not include O365


Inclusions and Exclusions

  1. Sites - Choose the sites within the root collection to crawl.

    • Enter in specific Sites or leave blank to crawl all sites.

  2. Sites to Exclude - If sites need excluding from the Crawl add them to Sites to Exclude.

  3. Excluded libraries - Libraries can be excluded from the Crawl by adding them to the Excluded Libraries list.

    • The default excluded libraries can be removed or edited as needed.

  4. Included libraries - Add specific libraries to crawl. This list overrides any exclusions if there is an overlap.

  5. Permission Groups - Add extra Permission Groups on top of those from the security sync.

    • Allows SharePoint groups in content permissions.

  6. Excluded Permission Groups - Add permission groups to be ignored from every file.


Crawl Details

  1. Page Load Throttling - To reduce timeouts you can change the Page Load Throttling.

    • By changing this you can increase the wait time between Chromium Page loads.

    • Enter the time in MS (2000 ms = 2 seconds).

  2. Owner Content Type Mapping - Enter the content field type name to be uses as the owner of a file.

    • Formatted like SharePoints internal naming conventions. Content_x0020_Owner

  3. Content Limit Per Request - Enter the maximum number of requests that can be made to Sharepoint.

    • By lowering the Content Limit Per Request more requests will run but each run will be quicker.

  4. SharePoint Client Context Timeout - Set a timeout value for all requests made to Sharepoint.

    • Enter a CSOM value into the SharePoint Client Context Timeout.

    • By default this is set to -1.5.

  5. Path to Chromium - If Chromium has been manually deployed enter the full path including chrome.exe.

    • If this field is left black it will be downloaded once.

  6. Path to SharePoint Online (only) Cookie Utility - Enter the path to your preferred cookie authentication utility.

    • This will handle authentication when processing ASPX pages.

    • You must explicitly enter the full path including the .exe.

    • If this field is left blank Default utils install locations will be used.


Advanced Options

  1. Process without Delta Tokens - Check this to NOT use the library delta tokens.

    • This will do a reprocess of the full library at every crawl and can be enabled to sync an index. All documents will be retrieved from the library, regardless of changes. However, only necessary changes will be made to your index.

      • If this is not checked, only the changes since the last change token will be retrieved from the library. Likewise only the necessary changes will be made to your index.

    • To use SharePoint change tokens to enable delta crawls uncheck this option.

  2. Do Permissions Check - Check to test all the document permissions.

  3. Get Permissions In Bulk - Check to gather all document permissions for everything in a library at once.

    • The higher the document count the more memory intensive it will be.

    • Not retrieving the permissions in bulk will mean a permission request for every file indexed. This can get you rate limited by SharePoint if many requests are sent in quick succession.

  4. Build Site Caches - Check to build a cache of all users with access to a site.

    • If unchecked validation will be processed with each document.

  5. Include OneDrives - Check this to process OneDrives and sites.

  6. Do Metadata/Entity Update - Check to reprocess all entity or metadata mappings at crawl.

    • This should only be enabled when a field of column has been deleted.

    • Note files updated will need to go through enrichment again after the crawl.

  7. Generate Edit in Browser Link - Check to generate an Open In browser app as default (SP Online only).

  8. Generate Open in App Link (MS Office docs only) - Check to generate an Open In link as SharePoint does.

    • For example, Open in word on the Users Machine (SP Online).

    • This will override the open in browser option.


Meta tag mappings

  1. You can map the entity fields to meta tags from the web page.

    • Enter the full entity field in the left column. For example, entities.Websites.category.

    • Enter the meta tag name in the right column

  2. You can map the metadata fields to meta tags from the web page.

    • Enter the full metadata field in the left column. For example, metadata.webtype.

    • Enter the meta tag name in the right column

Last updated