/AWS1/CL_KNDCONFLUENCESPACEC00

Configuration information for indexing Confluence spaces.

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_crawlpersonalspaces TYPE /AWS1/KNDBOOLEAN /AWS1/KNDBOOLEAN

TRUE to index personal spaces. You can add restrictions to items in personal spaces. If personal spaces are indexed, queries without user context information may return restricted items from a personal space in their results. For more information, see Filtering on user context.

iv_crawlarchivedspaces TYPE /AWS1/KNDBOOLEAN /AWS1/KNDBOOLEAN

TRUE to index archived spaces.

it_includespaces TYPE /AWS1/CL_KNDCONFLUENCESPACEL00=>TT_CONFLUENCESPACELIST TT_CONFLUENCESPACELIST

A list of space keys for Confluence spaces. If you include a key, the blogs, documents, and attachments in the space are indexed. Spaces that aren't in the list aren't indexed. A space in the list must exist. Otherwise, Amazon Kendra logs an error when the data source is synchronized. If a space is in both the IncludeSpaces and the ExcludeSpaces list, the space is excluded.

it_excludespaces TYPE /AWS1/CL_KNDCONFLUENCESPACEL00=>TT_CONFLUENCESPACELIST TT_CONFLUENCESPACELIST

A list of space keys of Confluence spaces. If you include a key, the blogs, documents, and attachments in the space are not indexed. If a space is in both the ExcludeSpaces and the IncludeSpaces list, the space is excluded.

it_spacefieldmappings TYPE /AWS1/CL_KNDCONFLUENCESPACET00=>TT_CONFLUENCESPACEFIELDMAPSLST TT_CONFLUENCESPACEFIELDMAPSLST

Maps attributes or field names of Confluence spaces to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Confluence fields. For more information, see Mapping data source fields. The Confluence data source field names must exist in your Confluence custom metadata.

If you specify the SpaceFieldMappings parameter, you must specify at least one field mapping.

---

Queryable Attributes

CrawlPersonalSpaces

TRUE to index personal spaces. You can add restrictions to items in personal spaces. If personal spaces are indexed, queries without user context information may return restricted items from a personal space in their results. For more information, see Filtering on user context.

Accessible with the following methods

Method	Description
GET_CRAWLPERSONALSPACES()	Getter for CRAWLPERSONALSPACES

CrawlArchivedSpaces

TRUE to index archived spaces.

Accessible with the following methods

Method	Description
GET_CRAWLARCHIVEDSPACES()	Getter for CRAWLARCHIVEDSPACES

IncludeSpaces

A list of space keys for Confluence spaces. If you include a key, the blogs, documents, and attachments in the space are indexed. Spaces that aren't in the list aren't indexed. A space in the list must exist. Otherwise, Amazon Kendra logs an error when the data source is synchronized. If a space is in both the IncludeSpaces and the ExcludeSpaces list, the space is excluded.

Accessible with the following methods

Method	Description
GET_INCLUDESPACES()	Getter for INCLUDESPACES, with configurable default
ASK_INCLUDESPACES()	Getter for INCLUDESPACES w/ exceptions if field has no value
HAS_INCLUDESPACES()	Determine if INCLUDESPACES has a value

ExcludeSpaces

A list of space keys of Confluence spaces. If you include a key, the blogs, documents, and attachments in the space are not indexed. If a space is in both the ExcludeSpaces and the IncludeSpaces list, the space is excluded.

Accessible with the following methods

Method	Description
GET_EXCLUDESPACES()	Getter for EXCLUDESPACES, with configurable default
ASK_EXCLUDESPACES()	Getter for EXCLUDESPACES w/ exceptions if field has no value
HAS_EXCLUDESPACES()	Determine if EXCLUDESPACES has a value

SpaceFieldMappings

Maps attributes or field names of Confluence spaces to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Confluence fields. For more information, see Mapping data source fields. The Confluence data source field names must exist in your Confluence custom metadata.

If you specify the SpaceFieldMappings parameter, you must specify at least one field mapping.

Accessible with the following methods

Method	Description
GET_SPACEFIELDMAPPINGS()	Getter for SPACEFIELDMAPPINGS, with configurable default
ASK_SPACEFIELDMAPPINGS()	Getter for SPACEFIELDMAPPINGS w/ exceptions if field has no
HAS_SPACEFIELDMAPPINGS()	Determine if SPACEFIELDMAPPINGS has a value