Connector Configuration Reference
\t
for the tab character. When entering configuration values in the API, use escaped characters, such as \\t
for the tab character.Property | Description |
---|---|
Web Application name | Unique name of the web application in the specific configuration. Required field. Type: string. For example, webApp1 . |
Web Application URL | URL of the web application. Required field. For example, https://myWebApplication1 . |
Site Collection List | List of site collection paths. For example, if the site collection URL is https://webApplication/sites/MySiteCollection , the site collection path is /sites/MySiteCollection (which is the last portion of the URL). Multiple paths can be entered. |
SharePoint List or libraries in the site collection | A set of list or library names within the site collection to crawl. For example, Documents. |
SharePoint webs | List of web names to crawl within the parent site collecton. |
SharePoint List or library name | Name of a list or library under the SharePoint web context. For example, Documents. |
SharePoint Folders | Folders within the list to crawl. |
Excluded Site Collections | List of site collections to exclude from the crawl. Exclusions can improve performance. |
Included file extensions | Attachments with a file extension from this list are included (and indexed) when filtering occurs. For example, .txt . Attachments are the only object types with file extensions. |
Excluded file extensions | Attachments with a file extension from this list are excluded (and discarded) when filtering occurs. For example, .txt . |
Inclusive regexes | Regular expressions (regex) defined to index SharePoint objects including sites, lists, items, and attachments. The SharePoint object URL is used to match the regular expressions. |
Exclusive regexes | Regular expressions (regex) defined to discard SharePoint objects including sites, lists, items, and attachments. The SharePoint object URL is used to match the regular expressions. |
Property | Description |
---|---|
User | User name of the authenticating account |
Password | Password of the authenticating account |
Domain | Domain in which the client workstation has membership |
Workstation | Client workstation name |
Property | Description |
---|---|
Username | User name created in the membership database |
Password | Password of the user name created in the membership database |
Property | Description |
---|---|
SharePoint online account | Valid SharePoint account |
Password | SharePoint online account password |
Microsoft login URL | URL of the Microsoft login server |
Property | Description |
---|---|
Azure AD (Active Directory) client ID | Azure client ID of the application |
Azure AD tenant | Office365 tenant name |
Azure AD client secret | Azure client secret of the client ID |
Azure AD login endpoint | Login URL for authentication |
Property | Description |
---|---|
Azure AD (Active Directory) client ID | Azure client ID of the application |
Azure AD tenant | Office365 tenant name |
Azure AD login endpoint | Login URL for authentication |
Azure AD PKCS12 key | The base64 string of the PKCS12 keystore loaded with the PFX (personal exchange format) certificate file supplied by Azure AD |
Azure AD PKCS12 keystore password | Password of the Azure AD PKCS12 keystore |
Property | Description |
---|---|
Fetch lists | If enabled: ● Fetches and indexes lists included in site collection. ● Discards lists and associated items not included in site collection. |
Fetch list items | If enabled, retrieves and indexes list items. |
Fetch attachments | If enabled, retrieves and indexes item attachments. |
Index sites | If enabled, indexes sites. This option does not affect the list or subsites retrieval. |
Property | Description | ||
---|---|---|---|
API query row limit | Number of items to retrieve per page. Default value is 500. The connector paginates requests to retrieve list items. | ||
Changes API query row limit | Number of events to retrieve per page. Default value is 200. The connector paginates requests to retrieve changes per site collection. | ||
User agent | Value of the http header User-Agent for each request. Default value is **ISV | Lucidworks | Fusion/1.0**. |
Property | Description |
---|---|
Enable security trimming | If enabled, the connector indexes SharePoint groups and the role assignments of each object type. Object types are sites, lists, items, and attachments. |
ACL collection name | Access Control List (ACL) collection name. Role assignments and SharePoint groups are indexed in this collection. |
acl_ss
field in each document contains roleAssignment IDs, where the role assignments define each object.
For the access control collection, the SharePoint connector indexes:
Property | Description |
---|---|
Proxy URL | URL of proxy server |
Proxy username | User name to log in to the proxy server |
Proxy password | Password of the proxy username |
Property | Description |
---|---|
Maximum output limit | Maximum number of indexed documents. Default value is -1, which specifies no maximum limit. |
Property | Description |
---|---|
Maximum | Maximum byte size of an attachment |
Minimum | Minimum byte size of an attachment |
Property | Description |
---|---|
Max retry attempts | Maximum of attempts to retry if an item fails. |
Retry delay | Number of seconds (delay) between retries if an item fails. |
Property | Description |
---|---|
Read timeout | Number of milliseconds before timeout occurs. Value is passed to the http client. Default value is 300 000 ms. |
Connection timeout | Number of milliseconds before a connection attempt times out. Value is passed to the http client. Default value is 6 000 ms. |
Property | Description |
---|---|
Maximum connections | Maximum number of connections available in the pool. Default value is 1000. |
Maximum per route | Maximum number of connections per route in the same target URL. Default value is 200. |
Ignore SSL (Secure Sockets Layer) validation exceptions | If enabled, the http client does not fail if the server certificate cannot be validated. Default value is false. |
check-ntlm-account-can-crawl-sharepoint-site-collection.ps1
PowerShell script below to a folder on your computer.$site_col_url="https://your.sharepoint-site.com/sites/mysitecol"
to the URL of your site collection.