/AWS1/CL_KNDSHAREPOINTCONF

Provides the configuration information to connect to Microsoft SharePoint as your data source.

CONSTRUCTOR

IMPORTING

Required arguments:

iv_sharepointversion TYPE /AWS1/KNDSHAREPOINTVERSION /AWS1/KNDSHAREPOINTVERSION

The version of Microsoft SharePoint that you use.

it_urls TYPE /AWS1/CL_KNDSHAREPTURLLIST_W=>TT_SHAREPOINTURLLIST TT_SHAREPOINTURLLIST

The Microsoft SharePoint site URLs for the documents you want to index.

iv_secretarn TYPE /AWS1/KNDSECRETARN /AWS1/KNDSECRETARN

The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the user name and password required to connect to the SharePoint instance. For more information, see Microsoft SharePoint.

Optional arguments:

iv_crawlattachments TYPE /AWS1/KNDBOOLEAN /AWS1/KNDBOOLEAN

TRUE to index document attachments.

iv_usechangelog TYPE /AWS1/KNDBOOLEAN /AWS1/KNDBOOLEAN

TRUE to use the SharePoint change log to determine which documents require updating in the index. Depending on the change log's size, it may take longer for Amazon Kendra to use the change log than to scan all of your documents in SharePoint.

it_inclusionpatterns TYPE /AWS1/CL_KNDDATASRCINCLUSION00=>TT_DATASRCINCLUSIONSEXCLUSIO00 TT_DATASRCINCLUSIONSEXCLUSIO00

A list of regular expression patterns to include certain documents in your SharePoint. Documents that match the patterns are included in the index. Documents that don't match the patterns are excluded from the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.

The regex applies to the display URL of the SharePoint document.

it_exclusionpatterns TYPE /AWS1/CL_KNDDATASRCINCLUSION00=>TT_DATASRCINCLUSIONSEXCLUSIO00 TT_DATASRCINCLUSIONSEXCLUSIO00

A list of regular expression patterns to exclude certain documents in your SharePoint. Documents that match the patterns are excluded from the index. Documents that don't match the patterns are included in the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.

The regex applies to the display URL of the SharePoint document.

io_vpcconfiguration TYPE REF TO /AWS1/CL_KNDDATASOURCEVPCCONF /AWS1/CL_KNDDATASOURCEVPCCONF

Configuration information for an Amazon Virtual Private Cloud to connect to your Microsoft SharePoint. For more information, see Configuring a VPC.

it_fieldmappings TYPE /AWS1/CL_KNDDATASRCTOIDXFIEL00=>TT_DATASRCTOINDEXFIELDMAPLIST TT_DATASRCTOINDEXFIELDMAPLIST

A list of DataSourceToIndexFieldMapping objects that map SharePoint data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to SharePoint fields. For more information, see Mapping data source fields. The SharePoint data source field names must exist in your SharePoint custom metadata.

iv_documenttitlefieldname TYPE /AWS1/KNDDATASOURCEFIELDNAME /AWS1/KNDDATASOURCEFIELDNAME

The Microsoft SharePoint attribute field that contains the title of the document.

iv_disablelocalgroups TYPE /AWS1/KNDBOOLEAN /AWS1/KNDBOOLEAN

TRUE to disable local groups information.

io_sslcertificates3path TYPE REF TO /AWS1/CL_KNDS3PATH /AWS1/CL_KNDS3PATH

The path to the SSL certificate stored in an Amazon S3 bucket. You use this to connect to SharePoint Server if you require a secure SSL connection.

You can generate a self-signed X509 certificate on any computer using OpenSSL. For an example of using OpenSSL to create an X509 certificate, see Create and sign an X509 certificate.

iv_authenticationtype TYPE /AWS1/KNDSHAREPTONLINEAUTHTYPE /AWS1/KNDSHAREPTONLINEAUTHTYPE

Whether you want to connect to SharePoint Online using basic authentication of user name and password, or OAuth authentication of user name, password, client ID, and client secret, or AD App-only authentication of client secret.

io_proxyconfiguration TYPE REF TO /AWS1/CL_KNDPROXYCONFIGURATION /AWS1/CL_KNDPROXYCONFIGURATION

Configuration information to connect to your Microsoft SharePoint site URLs via instance via a web proxy. You can use this option for SharePoint Server.

You must provide the website host name and port number. For example, the host name of https://a.example.com/page1.html is "a.example.com" and the port is 443, the standard port for HTTPS.

Web proxy credentials are optional and you can use them to connect to a web proxy server that requires basic authentication of user name and password. To store web proxy credentials, you use a secret in Secrets Manager.

It is recommended that you follow best security practices when configuring your web proxy. This includes setting up throttling, setting up logging and monitoring, and applying security patches on a regular basis. If you use your web proxy with multiple data sources, sync jobs that occur at the same time could strain the load on your proxy. It is recommended you prepare your proxy beforehand for any security and load requirements.

---

Queryable Attributes

SharePointVersion

The version of Microsoft SharePoint that you use.

Accessible with the following methods

Method	Description
GET_SHAREPOINTVERSION()	Getter for SHAREPOINTVERSION, with configurable default
ASK_SHAREPOINTVERSION()	Getter for SHAREPOINTVERSION w/ exceptions if field has no v
HAS_SHAREPOINTVERSION()	Determine if SHAREPOINTVERSION has a value

Urls

The Microsoft SharePoint site URLs for the documents you want to index.

Accessible with the following methods

Method	Description
GET_URLS()	Getter for URLS, with configurable default
ASK_URLS()	Getter for URLS w/ exceptions if field has no value
HAS_URLS()	Determine if URLS has a value

SecretArn

The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the user name and password required to connect to the SharePoint instance. For more information, see Microsoft SharePoint.

Accessible with the following methods

Method	Description
GET_SECRETARN()	Getter for SECRETARN, with configurable default
ASK_SECRETARN()	Getter for SECRETARN w/ exceptions if field has no value
HAS_SECRETARN()	Determine if SECRETARN has a value

CrawlAttachments

TRUE to index document attachments.

Accessible with the following methods

Method	Description
GET_CRAWLATTACHMENTS()	Getter for CRAWLATTACHMENTS

UseChangeLog

TRUE to use the SharePoint change log to determine which documents require updating in the index. Depending on the change log's size, it may take longer for Amazon Kendra to use the change log than to scan all of your documents in SharePoint.

Accessible with the following methods

Method	Description
GET_USECHANGELOG()	Getter for USECHANGELOG

InclusionPatterns

A list of regular expression patterns to include certain documents in your SharePoint. Documents that match the patterns are included in the index. Documents that don't match the patterns are excluded from the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.

The regex applies to the display URL of the SharePoint document.

Accessible with the following methods

Method	Description
GET_INCLUSIONPATTERNS()	Getter for INCLUSIONPATTERNS, with configurable default
ASK_INCLUSIONPATTERNS()	Getter for INCLUSIONPATTERNS w/ exceptions if field has no v
HAS_INCLUSIONPATTERNS()	Determine if INCLUSIONPATTERNS has a value

ExclusionPatterns

A list of regular expression patterns to exclude certain documents in your SharePoint. Documents that match the patterns are excluded from the index. Documents that don't match the patterns are included in the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.

The regex applies to the display URL of the SharePoint document.

Accessible with the following methods

Method	Description
GET_EXCLUSIONPATTERNS()	Getter for EXCLUSIONPATTERNS, with configurable default
ASK_EXCLUSIONPATTERNS()	Getter for EXCLUSIONPATTERNS w/ exceptions if field has no v
HAS_EXCLUSIONPATTERNS()	Determine if EXCLUSIONPATTERNS has a value

VpcConfiguration

Configuration information for an Amazon Virtual Private Cloud to connect to your Microsoft SharePoint. For more information, see Configuring a VPC.

Accessible with the following methods

Method	Description
GET_VPCCONFIGURATION()	Getter for VPCCONFIGURATION

FieldMappings

A list of DataSourceToIndexFieldMapping objects that map SharePoint data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to SharePoint fields. For more information, see Mapping data source fields. The SharePoint data source field names must exist in your SharePoint custom metadata.

Accessible with the following methods

Method	Description
GET_FIELDMAPPINGS()	Getter for FIELDMAPPINGS, with configurable default
ASK_FIELDMAPPINGS()	Getter for FIELDMAPPINGS w/ exceptions if field has no value
HAS_FIELDMAPPINGS()	Determine if FIELDMAPPINGS has a value

DocumentTitleFieldName

The Microsoft SharePoint attribute field that contains the title of the document.

Accessible with the following methods

Method	Description
GET_DOCUMENTTITLEFIELDNAME()	Getter for DOCUMENTTITLEFIELDNAME, with configurable default
ASK_DOCUMENTTITLEFIELDNAME()	Getter for DOCUMENTTITLEFIELDNAME w/ exceptions if field has
HAS_DOCUMENTTITLEFIELDNAME()	Determine if DOCUMENTTITLEFIELDNAME has a value

DisableLocalGroups

TRUE to disable local groups information.

Accessible with the following methods

Method	Description
GET_DISABLELOCALGROUPS()	Getter for DISABLELOCALGROUPS

SslCertificateS3Path

The path to the SSL certificate stored in an Amazon S3 bucket. You use this to connect to SharePoint Server if you require a secure SSL connection.

You can generate a self-signed X509 certificate on any computer using OpenSSL. For an example of using OpenSSL to create an X509 certificate, see Create and sign an X509 certificate.

Accessible with the following methods

Method	Description
GET_SSLCERTIFICATES3PATH()	Getter for SSLCERTIFICATES3PATH

AuthenticationType

Whether you want to connect to SharePoint Online using basic authentication of user name and password, or OAuth authentication of user name, password, client ID, and client secret, or AD App-only authentication of client secret.

Accessible with the following methods

Method	Description
GET_AUTHENTICATIONTYPE()	Getter for AUTHENTICATIONTYPE, with configurable default
ASK_AUTHENTICATIONTYPE()	Getter for AUTHENTICATIONTYPE w/ exceptions if field has no
HAS_AUTHENTICATIONTYPE()	Determine if AUTHENTICATIONTYPE has a value

ProxyConfiguration

Configuration information to connect to your Microsoft SharePoint site URLs via instance via a web proxy. You can use this option for SharePoint Server.

You must provide the website host name and port number. For example, the host name of https://a.example.com/page1.html is "a.example.com" and the port is 443, the standard port for HTTPS.

Web proxy credentials are optional and you can use them to connect to a web proxy server that requires basic authentication of user name and password. To store web proxy credentials, you use a secret in Secrets Manager.

It is recommended that you follow best security practices when configuring your web proxy. This includes setting up throttling, setting up logging and monitoring, and applying security patches on a regular basis. If you use your web proxy with multiple data sources, sync jobs that occur at the same time could strain the load on your proxy. It is recommended you prepare your proxy beforehand for any security and load requirements.

Accessible with the following methods

Method	Description
GET_PROXYCONFIGURATION()	Getter for PROXYCONFIGURATION