Skip to content

/AWS1/CL_KNDBOXCONFIGURATION

Provides the configuration information to connect to Box as your data source.

CONSTRUCTOR

IMPORTING

Required arguments:

iv_enterpriseid TYPE /AWS1/KNDENTERPRISEID /AWS1/KNDENTERPRISEID

The identifier of the Box Enterprise platform. You can find the enterprise ID in the Box Developer Console settings or when you create an app in Box and download your authentication credentials. For example, 801234567.

iv_secretarn TYPE /AWS1/KNDSECRETARN /AWS1/KNDSECRETARN

The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs required to connect to your Box platform. The secret must contain a JSON structure with the following keys:

  • clientID—The identifier of the client OAuth 2.0 authentication application created in Box.

  • clientSecret—A set of characters known only to the OAuth 2.0 authentication application created in Box.

  • publicKeyId—The identifier of the public key contained within an identity certificate.

  • privateKey—A set of characters that make up an encryption key.

  • passphrase—A set of characters that act like a password.

You create an application in Box to generate the keys or credentials required for the secret. For more information, see Using a Box data source.

Optional arguments:

iv_usechangelog TYPE /AWS1/KNDBOOLEAN /AWS1/KNDBOOLEAN

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

iv_crawlcomments TYPE /AWS1/KNDBOOLEAN /AWS1/KNDBOOLEAN

TRUE to index comments.

iv_crawltasks TYPE /AWS1/KNDBOOLEAN /AWS1/KNDBOOLEAN

TRUE to index the contents of tasks.

TRUE to index web links.

it_filefieldmappings TYPE /AWS1/CL_KNDDATASRCTOIDXFIEL00=>TT_DATASRCTOINDEXFIELDMAPLIST TT_DATASRCTOINDEXFIELDMAPLIST

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

it_taskfieldmappings TYPE /AWS1/CL_KNDDATASRCTOIDXFIEL00=>TT_DATASRCTOINDEXFIELDMAPLIST TT_DATASRCTOINDEXFIELDMAPLIST

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

it_commentfieldmappings TYPE /AWS1/CL_KNDDATASRCTOIDXFIEL00=>TT_DATASRCTOINDEXFIELDMAPLIST TT_DATASRCTOINDEXFIELDMAPLIST

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

it_weblinkfieldmappings TYPE /AWS1/CL_KNDDATASRCTOIDXFIEL00=>TT_DATASRCTOINDEXFIELDMAPLIST TT_DATASRCTOINDEXFIELDMAPLIST

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

it_inclusionpatterns TYPE /AWS1/CL_KNDDATASRCINCLUSION00=>TT_DATASRCINCLUSIONSEXCLUSIO00 TT_DATASRCINCLUSIONSEXCLUSIO00

A list of regular expression patterns to include certain files and folders in your Box platform. Files and folders that match the patterns are included in the index. Files and folders that don't match the patterns are excluded from the index. If a file or folder matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file or folder isn't included in the index.

it_exclusionpatterns TYPE /AWS1/CL_KNDDATASRCINCLUSION00=>TT_DATASRCINCLUSIONSEXCLUSIO00 TT_DATASRCINCLUSIONSEXCLUSIO00

A list of regular expression patterns to exclude certain files and folders from your Box platform. Files and folders that match the patterns are excluded from the index.Files and folders that don't match the patterns are included in the index. If a file or folder matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file or folder isn't included in the index.

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

Configuration information for an Amazon VPC to connect to your Box. For more information, see Configuring a VPC.

Queryable Attributes

EnterpriseId

The identifier of the Box Enterprise platform. You can find the enterprise ID in the Box Developer Console settings or when you create an app in Box and download your authentication credentials. For example, 801234567.

Accessible with the following methods

Method Description
GET_ENTERPRISEID() Getter for ENTERPRISEID, with configurable default
ASK_ENTERPRISEID() Getter for ENTERPRISEID w/ exceptions if field has no value
HAS_ENTERPRISEID() Determine if ENTERPRISEID has a value

SecretArn

The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs required to connect to your Box platform. The secret must contain a JSON structure with the following keys:

  • clientID—The identifier of the client OAuth 2.0 authentication application created in Box.

  • clientSecret—A set of characters known only to the OAuth 2.0 authentication application created in Box.

  • publicKeyId—The identifier of the public key contained within an identity certificate.

  • privateKey—A set of characters that make up an encryption key.

  • passphrase—A set of characters that act like a password.

You create an application in Box to generate the keys or credentials required for the secret. For more information, see Using a Box data source.

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

UseChangeLog

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

Accessible with the following methods

Method Description
GET_USECHANGELOG() Getter for USECHANGELOG

CrawlComments

TRUE to index comments.

Accessible with the following methods

Method Description
GET_CRAWLCOMMENTS() Getter for CRAWLCOMMENTS

CrawlTasks

TRUE to index the contents of tasks.

Accessible with the following methods

Method Description
GET_CRAWLTASKS() Getter for CRAWLTASKS

TRUE to index web links.

Accessible with the following methods

Method Description
GET_CRAWLWEBLINKS() Getter for CRAWLWEBLINKS

FileFieldMappings

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

Accessible with the following methods

Method Description
GET_FILEFIELDMAPPINGS() Getter for FILEFIELDMAPPINGS, with configurable default
ASK_FILEFIELDMAPPINGS() Getter for FILEFIELDMAPPINGS w/ exceptions if field has no v
HAS_FILEFIELDMAPPINGS() Determine if FILEFIELDMAPPINGS has a value

TaskFieldMappings

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

Accessible with the following methods

Method Description
GET_TASKFIELDMAPPINGS() Getter for TASKFIELDMAPPINGS, with configurable default
ASK_TASKFIELDMAPPINGS() Getter for TASKFIELDMAPPINGS w/ exceptions if field has no v
HAS_TASKFIELDMAPPINGS() Determine if TASKFIELDMAPPINGS has a value

CommentFieldMappings

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

Accessible with the following methods

Method Description
GET_COMMENTFIELDMAPPINGS() Getter for COMMENTFIELDMAPPINGS, with configurable default
ASK_COMMENTFIELDMAPPINGS() Getter for COMMENTFIELDMAPPINGS w/ exceptions if field has n
HAS_COMMENTFIELDMAPPINGS() Determine if COMMENTFIELDMAPPINGS has a value

WebLinkFieldMappings

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

Accessible with the following methods

Method Description
GET_WEBLINKFIELDMAPPINGS() Getter for WEBLINKFIELDMAPPINGS, with configurable default
ASK_WEBLINKFIELDMAPPINGS() Getter for WEBLINKFIELDMAPPINGS w/ exceptions if field has n
HAS_WEBLINKFIELDMAPPINGS() Determine if WEBLINKFIELDMAPPINGS has a value

InclusionPatterns

A list of regular expression patterns to include certain files and folders in your Box platform. Files and folders that match the patterns are included in the index. Files and folders that don't match the patterns are excluded from the index. If a file or folder matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file or folder isn't included in the index.

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 files and folders from your Box platform. Files and folders that match the patterns are excluded from the index.Files and folders that don't match the patterns are included in the index. If a file or folder matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file or folder isn't included in the index.

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 VPC to connect to your Box. For more information, see Configuring a VPC.

Accessible with the following methods

Method Description
GET_VPCCONFIGURATION() Getter for VPCCONFIGURATION