/AWS1/CL_KNDJIRACONFIGURATION

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

CONSTRUCTOR

IMPORTING

Required arguments:

iv_jiraaccounturl TYPE /AWS1/KNDJIRAACCOUNTURL /AWS1/KNDJIRAACCOUNTURL

The URL of the Jira account. For example, company.atlassian.net.

iv_secretarn TYPE /AWS1/KNDSECRETARN /AWS1/KNDSECRETARN

The Amazon Resource Name (ARN) of a secret in Secrets Manager contains the key-value pairs required to connect to your Jira data source. The secret must contain a JSON structure with the following keys:

• jiraId—The Jira user name or email.

• jiraCredentials—The Jira API token. For more information, see Using a Jira data source.

Optional arguments:

iv_usechangelog TYPE /AWS1/KNDBOOLEAN /AWS1/KNDBOOLEAN

TRUE to use the Jira 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 Jira.

it_project TYPE /AWS1/CL_KNDPROJECT_W=>TT_PROJECT TT_PROJECT

Specify which projects to crawl in your Jira data source. You can specify one or more Jira project IDs.

it_issuetype TYPE /AWS1/CL_KNDISSUETYPE_W=>TT_ISSUETYPE TT_ISSUETYPE

Specify which issue types to crawl in your Jira data source. You can specify one or more of these options to crawl.

it_status TYPE /AWS1/CL_KNDJIRASTATUS_W=>TT_JIRASTATUS TT_JIRASTATUS

Specify which statuses to crawl in your Jira data source. You can specify one or more of these options to crawl.

it_issuesubentityfilter TYPE /AWS1/CL_KNDISSUESUBENTFILT_W=>TT_ISSUESUBENTITYFILTER TT_ISSUESUBENTITYFILTER

Specify whether to crawl comments, attachments, and work logs. You can specify one or more of these options.

it_attachmentfieldmappings TYPE /AWS1/CL_KNDDATASRCTOIDXFIEL00=>TT_DATASRCTOINDEXFIELDMAPLIST TT_DATASRCTOINDEXFIELDMAPLIST

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

it_commentfieldmappings TYPE /AWS1/CL_KNDDATASRCTOIDXFIEL00=>TT_DATASRCTOINDEXFIELDMAPLIST TT_DATASRCTOINDEXFIELDMAPLIST

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

it_issuefieldmappings TYPE /AWS1/CL_KNDDATASRCTOIDXFIEL00=>TT_DATASRCTOINDEXFIELDMAPLIST TT_DATASRCTOINDEXFIELDMAPLIST

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

it_projectfieldmappings TYPE /AWS1/CL_KNDDATASRCTOIDXFIEL00=>TT_DATASRCTOINDEXFIELDMAPLIST TT_DATASRCTOINDEXFIELDMAPLIST

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

it_worklogfieldmappings TYPE /AWS1/CL_KNDDATASRCTOIDXFIEL00=>TT_DATASRCTOINDEXFIELDMAPLIST TT_DATASRCTOINDEXFIELDMAPLIST

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

it_inclusionpatterns TYPE /AWS1/CL_KNDDATASRCINCLUSION00=>TT_DATASRCINCLUSIONSEXCLUSIO00 TT_DATASRCINCLUSIONSEXCLUSIO00

A list of regular expression patterns to include certain file paths, file names, and file types in your Jira data source. Files that match the patterns are included in the index. Files that don't match the patterns are excluded from the index. If a file matches both an inclusion pattern and an exclusion pattern, the exclusion pattern takes precedence and the file 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 file paths, file names, and file types in your Jira data source. Files that match the patterns are excluded from the index. Files that don’t match the patterns are included in the index. If a file matches both an inclusion pattern and an exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.

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

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

---

Queryable Attributes

JiraAccountUrl

The URL of the Jira account. For example, company.atlassian.net.

Accessible with the following methods

Method	Description
GET_JIRAACCOUNTURL()	Getter for JIRAACCOUNTURL, with configurable default
ASK_JIRAACCOUNTURL()	Getter for JIRAACCOUNTURL w/ exceptions if field has no valu
HAS_JIRAACCOUNTURL()	Determine if JIRAACCOUNTURL has a value

SecretArn

The Amazon Resource Name (ARN) of a secret in Secrets Manager contains the key-value pairs required to connect to your Jira data source. The secret must contain a JSON structure with the following keys:

• jiraId—The Jira user name or email.

• jiraCredentials—The Jira API token. For more information, see Using a Jira 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 Jira 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 Jira.

Accessible with the following methods

Method	Description
GET_USECHANGELOG()	Getter for USECHANGELOG

Project

Specify which projects to crawl in your Jira data source. You can specify one or more Jira project IDs.

Accessible with the following methods

Method	Description
GET_PROJECT()	Getter for PROJECT, with configurable default
ASK_PROJECT()	Getter for PROJECT w/ exceptions if field has no value
HAS_PROJECT()	Determine if PROJECT has a value

IssueType

Specify which issue types to crawl in your Jira data source. You can specify one or more of these options to crawl.

Accessible with the following methods

Method	Description
GET_ISSUETYPE()	Getter for ISSUETYPE, with configurable default
ASK_ISSUETYPE()	Getter for ISSUETYPE w/ exceptions if field has no value
HAS_ISSUETYPE()	Determine if ISSUETYPE has a value

Status

Specify which statuses to crawl in your Jira data source. You can specify one or more of these options to crawl.

Accessible with the following methods

Method	Description
GET_STATUS()	Getter for STATUS, with configurable default
ASK_STATUS()	Getter for STATUS w/ exceptions if field has no value
HAS_STATUS()	Determine if STATUS has a value

IssueSubEntityFilter

Specify whether to crawl comments, attachments, and work logs. You can specify one or more of these options.

Accessible with the following methods

Method	Description
GET_ISSUESUBENTITYFILTER()	Getter for ISSUESUBENTITYFILTER, with configurable default
ASK_ISSUESUBENTITYFILTER()	Getter for ISSUESUBENTITYFILTER w/ exceptions if field has n
HAS_ISSUESUBENTITYFILTER()	Determine if ISSUESUBENTITYFILTER has a value

AttachmentFieldMappings

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

Accessible with the following methods

Method	Description
GET_ATTACHMENTFIELDMAPPINGS()	Getter for ATTACHMENTFIELDMAPPINGS, with configurable defaul
ASK_ATTACHMENTFIELDMAPPINGS()	Getter for ATTACHMENTFIELDMAPPINGS w/ exceptions if field ha
HAS_ATTACHMENTFIELDMAPPINGS()	Determine if ATTACHMENTFIELDMAPPINGS has a value

CommentFieldMappings

A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Jira comments to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Jira fields. For more information, see Mapping data source fields. The Jira data source field names must exist in your Jira 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

IssueFieldMappings

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

Accessible with the following methods

Method	Description
GET_ISSUEFIELDMAPPINGS()	Getter for ISSUEFIELDMAPPINGS, with configurable default
ASK_ISSUEFIELDMAPPINGS()	Getter for ISSUEFIELDMAPPINGS w/ exceptions if field has no
HAS_ISSUEFIELDMAPPINGS()	Determine if ISSUEFIELDMAPPINGS has a value

ProjectFieldMappings

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

Accessible with the following methods

Method	Description
GET_PROJECTFIELDMAPPINGS()	Getter for PROJECTFIELDMAPPINGS, with configurable default
ASK_PROJECTFIELDMAPPINGS()	Getter for PROJECTFIELDMAPPINGS w/ exceptions if field has n
HAS_PROJECTFIELDMAPPINGS()	Determine if PROJECTFIELDMAPPINGS has a value

WorkLogFieldMappings

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

Accessible with the following methods

Method	Description
GET_WORKLOGFIELDMAPPINGS()	Getter for WORKLOGFIELDMAPPINGS, with configurable default
ASK_WORKLOGFIELDMAPPINGS()	Getter for WORKLOGFIELDMAPPINGS w/ exceptions if field has n
HAS_WORKLOGFIELDMAPPINGS()	Determine if WORKLOGFIELDMAPPINGS has a value

InclusionPatterns

A list of regular expression patterns to include certain file paths, file names, and file types in your Jira data source. Files that match the patterns are included in the index. Files that don't match the patterns are excluded from the index. If a file matches both an inclusion pattern and an exclusion pattern, the exclusion pattern takes precedence and the file 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 file paths, file names, and file types in your Jira data source. Files that match the patterns are excluded from the index. Files that don’t match the patterns are included in the index. If a file matches both an inclusion pattern and an exclusion pattern, the exclusion pattern takes precedence and the file 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 Virtual Private Cloud to connect to your Jira. For more information, see Configuring a VPC.

Accessible with the following methods

Method	Description
GET_VPCCONFIGURATION()	Getter for VPCCONFIGURATION