# Connecting Confluence (Server/Data Center) to Amazon Q Business Atlassian Confluence is a collaborative work-management tool designed for sharing, storing, and working on project planning, software development, and product management. You can connect Confluence (Server/Data Center) instance to Amazon Q Business—using either the AWS Management Console or the [https://docs.aws.amazon.com/amazonq/latest/api-reference/API_CreateDataSource.html](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_CreateDataSource.html) API—and create an Amazon Q web experience. **Topics** + [Known limitations for the Amazon Q Business Confluence (Server/Data Center) connector](confluence-server-limitations.md) + [Confluence (Server/Data Center) connector overview](confluence-server-overview.md) + [Prerequisites for connecting Amazon Q to Confluence (Server/Data Center)](confluence-server-prereqs.md) + [Checking Confluence (Server/Data Center) connectivity](confluence-server-connection-check.md) + [Connecting Amazon Q Business to Confluence (Server/Data Center) using the console](confluence-server-console.md) + [Connecting Amazon Q Business to Confluence (Server/Data Center) using APIs](confluence-server-api.md) + [Connecting Amazon Q Business to Confluence (Server/Data Center) using AWS CloudFormation](confluence-server-cfn.md) + [How Amazon Q Business connector crawls Confluence (Server/Data Center) ACLs](confluence-server-user-management.md) + [Amazon Q Business Confluence (Server/Data Center) data source connector field mappings](confluence-server-field-mappings.md) + [IAM role for Amazon Q Confluence (Server/Data Center) connector](confluence-server-iam-role.md) + [Understand error codes in the Amazon Q Business Confluence (Server/Data Center) connector](confluence-server-error-codes.md) **Learn more** + For an overview of the Amazon Q web experience creation process using IAM Identity Center, see [Configuring an application using IAM Identity Center](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/create-application.html). + For an overview of the Amazon Q web experience creation process using AWS Identity and Access Management, see [Configuring an application using IAM](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/create-application-iam.html). + For an overview of connector features, see [Data source connector concepts](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/connector-concepts.html). + For information about connector configuration best practices, see [Connector configuration best practices](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/connector-best-practices.html). # Known limitations for the Amazon Q Business Confluence (Server/Data Center) connector The Amazon Q Confluence (Server/Data Center) connector has the following known limitation: + Because Amazon Q Business uses email addresses as unique identifiers, each user must have a unique email address. + The Confluence (Server/Data Center) connector may not accurately differentiate between Confluence users with duplicate email addresses when mapping access control lists (ACLs). This can lead to inconsistent search results, in which a user might be able to see restricted content intended for one Confluence user with a shared email, but not other restricted content intended for a different Confluence user with the same email. # Confluence (Server/Data Center) connector overview The following table gives an overview of the Amazon Q Business Confluence (Server/Data Center) connector and its supported features. **** [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/confluence-server-overview.html) # Prerequisites for connecting Amazon Q to Confluence (Server/Data Center) Before you begin, make sure that you have completed the following prerequisites. **In Confluence Server/Data Center, make sure you have:** + Copied your Confluence instance URL. For example: *https://example.confluence.com*. You need your Confluence instance URL to connect to Amazon Q. + Configured basic authentication credentials containing a username (username used to log into Confluence) and password (Confluence Server/Data Center password) to allow Amazon Q to connect to your Confluence Server/Data Center instance. + **Optional:** Configured OAuth 2.0 credentials containing a Confluence app key, Confluence app secret, Confluence access token, and Confluence refresh token to allow Amazon Q to connect to your Confluence instance. If your access token expires, you can either use the refresh token to regenerate your access token and refresh token pair, or you can repeat the authorization process. + **Optional:** Configured a Personal Access Token (PAT) containing a Confluence token to allow Amazon Q to connect to your Confluence Server/Data Center instance. For information about how to create a PAT token, see [Using Personal Access Tokens](https://confluence.atlassian.com/enterprise/using-personal-access-tokens-1026032365.html) on the Atlassian website. **In your AWS account, make sure you have:** + Created a Amazon Q Business application. + Created a [Amazon Q Business retriever and added an index](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/select-retriever.html). + Created an [IAM role](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/iam-roles.html#iam-roles-ds) for your data source and, if using the Amazon Q API, noted the ARN of the IAM role. + If you want to have Amazon Q automatically rotate your secret, ensure that your IAM role includes the `secretsmanager:PutSecretValue` and `secretsmanager:UpdateSecret` permissions. + Stored your Confluence (Server/Data Center) authentication credentials in an AWS Secrets Manager secret and, if using the Amazon Q API, noted the ARN of the secret. **Note** If you’re a console user, you can create the IAM role and Secrets Manager secret as part of configuring your Amazon Q application on the console. For a list of things to consider while configuring your data source, see [ Data source connector configuration best practices](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/connector-best-practices.html). # Checking Confluence (Server/Data Center) connectivity Before you sync your Confluence (Server/Data Center) data source connector after [configuring it](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/confluence-server-console.html), we recommend you check the connection between Amazon Q Business and Confluence (Server/Data Center). The following are the cURL commands you need to check Confluence (Server/Data Center) connectivity. **Topics** + [Checking basic authentication connectivity](#confluence-server-connection-check-basic) + [Checking personal access token connectivity](#confluence-server-connection-check-pat) ## Checking basic authentication connectivity To check connectivity for a Confluence (Server/Data Center) data source connector using basic authentication, use the following cURL command: ``` curl --location 'https:///wiki/rest/api/user/current' --header 'Authorization: Basic ' ``` If your data source is connected as expected, the JSON response should resemble the following: ``` { "type": "known", "accountId": "accountId", "accountType": "atlassian", "email": "email", "publicName": "Administrator", "profilePicture": { "path": "/wiki/aa-avatar/", "width": 48, "height": 48, "isDefault": false }, "displayName": "Administrator", "isExternalCollaborator": false, "_expandable": { "operations": "", "personalSpace": "" }, "_links": { "self": "https:///wiki/rest/api/user?accountId=", "base": "https:///wiki", "context": "/wiki" } } ``` If your Confluence (Server/Data Center) connector is not connected correctly, you will see the following error: + CNF-5123: The profile value is invalid. Try again after sometime. To troubleshoot the issue, check your Confluence (Server/Data Center) URL and make sure it's correct. ## Checking personal access token connectivity To check connectivity for a Confluence (Server/Data Center) data source connector using personal access token authentication, use the following cURL command: ``` curl --location 'https:///rest/api/user/current' --header 'Authorization: Bearer ' ``` If your data source is connected as expected, the JSON response should resemble the following: ``` { "type": "known", "accountId": "accountId", "accountType": "atlassian", "email": "email", "publicName": "Administrator", "profilePicture": { "path": "/wiki/aa-avatar/", "width": 48, "height": 48, "isDefault": false }, "displayName": "Administrator", "isExternalCollaborator": false, "_expandable": { "operations": "", "personalSpace": "" }, "_links": { "self": "https:///wiki/rest/api/user?accountId=", "base": "https:///wiki", "context": "/wiki" } } ``` If your Confluence (Server/Data Center) connector is not connected correctly, you will see the following error: + CNF-5123: The profile value is invalid. Try again after sometime. To troubleshoot the issue, check your Confluence (Server/Data Center) URL and make sure it's correct. # Connecting Amazon Q Business to Confluence (Server/Data Center) using the console On the ** Confluence ** page, enter the following information: 1. **Name and description**, do the following: + For **Data source name** – Name your data source for easy tracking. **Note** You can include hyphens (-) but not spaces. Maximum of 1,000 alphanumeric characters. + **Description – *optional*** – Add an optional description for your data source. This text is viewed only by Amazon Q Business administrators and can be edited later. 1. In **Source**, enter the following information: 1. In **Source**, for **Hosting Method** – Choose ** Confluence Server/Data Center**. 1. ** Confluence URL** – Enter the Confluence host URLs. The format for the host URL that you enter is *https://example.confluence.com*. **Important** If you change or update your Confluence (Server/Data Center) data source URL, you also need to update your Secrets Manager secret to ensure a secure connection. 1. **SSL certificate location** – Enter the file path to an SSL certificate stored in an Amazon S3 bucket. 1. **Web proxy – *optional***, enter the following information: 1. **Host name** – Host name for your Confluence account. 1. **Port number** – Port used by the host URL transport protocol. 1. **Authorization** – Amazon Q Business crawls ACL information by default to ensure responses are generated only from documents your end users have access to. If supported for your connector, you can manage ACLs by selecting ** Enable ACLs ** to enable ACLs or **Disable ACLs** to disable them. To manage ACLs, you need specific IAM permissions. See [Grant permission to create data sources with ACLs disabled](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/setting-up.html#DisableAclOnDataSource) for more details. See [Authorization](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/connector-concepts.html#connector-authorization) for more details. 1. For **Authentication** – Choose between **Basic authentication**, **Oauth 2.0 authentication**, and **Personal Access Token authentication** based on your use case. 1. **AWS Secrets Manager secret** – Choose an existing secret or create a Secrets Manager secret to store your Confluence authentication credentials. If you choose to create a secret, an AWS Secrets Manager secret window opens. Enter the following information in the window: 1. **Secret name** – A name for your secret. 1. If using **Basic Authentication** – Enter the **Secret name** **Username**, and **Password** ( Confluence Server/Data Center password) that you generated and downloaded from your Confluence account. If using **OAuth2.0 Authentication** – Enter the **Secret name**, **App key**, **App secret**, **Access token**, and **Refresh token** you created in your Confluence account. If using **Personal Access Token authentication** – Enter the **Secret name** and the ** Confluence Server PAT token** that you created in your Confluence Server account. **Note** Select **Rotate secret** if you want Amazon Q to rotate the secret automatically so that you don’t have to manually update the secret every time you sync. 1. Choose **Save and add secret**. 1. **Configure VPC and security group – *optional*** – Choose whether you want to use a VPC. If you do, enter the following information: 1. **Subnets** – Select up to 6 repository subnets that define the subnets and IP ranges the repository instance uses in the selected VPC. 1. **VPC security groups** – Choose up to 10 security groups that allow access to your data source. Ensure that the security group allows incoming traffic from Amazon EC2 instances and devices outside your VPC. For databases, security group instances are required. For more information, see [VPC](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/connector-concepts.html#connector-vpc). 1. **IAM role** – Choose an existing IAM role or create an IAM role to access your repository credentials and index content. **Note** Creating a new service IAM role is recommended. For more information, see [IAM role](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/confluence-server-connector.html#confluence-server-iam). 1. In **Sync scope**, choose from the following options: 1. In **Sync scope**, for **sync contents**, choose to sync from the following entity types: **Pages**, **Page comments**, **Page attachments**, **Blogs**, **Blog comments**, **Blog attachments**, **Personal spaces**, and **Archived spaces**. **Note** **Page comments** and **Page attachments** can only be selected if you choose to sync **Pages**. **Blog comments** and **Blog attachments** can only be selected if you choose to sync **Blogs**. **Important** You can crawl **Pages** and **Blogs** from one of more specific **Spaces**. If you don't specify a **Space key** regex pattern in **Additional configuration**, all **Pages** and **Blogs** will be crawled by default. If no **Space** is specified in the filter, all spaces will be crawled. 1. For **Maximum file size** – Specify the file size limit in MBs that Amazon Q will crawl. Amazon Q will crawl only the files within the size limit you define. The default file size is 50MB. The maximum file size should be greater than 0MB and less than or equal to 50MB. 1. In **Additional configuration – *optional***, for **Space and regex patterns**, specify whether to include or exclude specific spaces, URLs, or file types in your index using the following: + **Space key** – For example, *my-space-123*. Select **Add** after entering each space key you want to add. **Note** If you don't specify a **Space key** regex pattern in **Additional configuration**, all **Pages** and **Blogs** will be crawled by default. If no **Space** is specified in the filter, all spaces will be crawled. + **URL** – For example, *.\$1/MySite/MyDocuments/*. Select **Add** after entering each URL you want to add. + **File type** – For example, *.\$1\$1.pdf* or *.\$1\$1.txt*. Select **Add** after entering each file type you want to add. + For **Entity title regex patterns** – Specify regular expression patterns to include or exclude certain **Blogs**, **Pages**, **Comments**, and **Attachments** by titles. **Note** If you want to crawl a specific page or subpage, you can use page title regex patterns to either include or exclude this page. 1. **Multi-media content configuration – optional** – To enable content extraction from embedded images and visuals in documents, choose **Visual content in documents**. To extract audio transcriptions and video content, enable processing for the following file types: 1. **Advanced settings** **Document deletion safeguard** - *optional*–To safeguard your documents from deletion during a sync job, select **On** and enter an integer between 0 - 100. If the percentage of documents to be deleted in your sync job exceeds the percentage you selected, the delete phase will be skipped and no documents from this data source will be deleted from your index. For more information, see [Document deletion safeguard](connector-concepts.md#document-deletion-safeguard). 1. For **Sync mode**, choose how you want to update your index when your data source content changes. When you sync your data source with Amazon Q for the first time, all content is synced by default. + **Full sync** – Sync all content regardless of the previous sync status. + **New, modified, or deleted content sync** – Sync only new, modified, and deleted documents. 1. In **Sync run schedule**, for **Frequency** – Choose how often Amazon Q will sync with your data source. For more details, see [Sync run schedule](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/connector-concepts.html#connector-sync-run). To learn how to start a data sync job, see [Starting data source connector sync jobs](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/supported-datasource-actions.html#start-datasource-sync-jobs). 1. **Tags - *optional*** – Add tags to search and filter your resources or track your AWS costs. See [Tags](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/tagging.html) for more details. 1. **Field mappings** – A list of data source document attributes to map to your index fields. **Note** Add or update the fields from the **Data source details** page after you finish adding your data source. You can choose from two types of fields: 1. **Default** – Automatically created by Amazon Q on your behalf based on common fields in your data source. You can't edit these. 1. **Custom** – Automatically created by Amazon Q on your behalf based on common fields in your data source. You can edit these. You can also create and add new custom fields. **Note** Support for adding custom fields varies by connector. You won't see the **Add field** option if your connector doesn't support adding custom fields. For more information, see [Field mappings](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/connector-concepts.html#connector-field-mappings). 1. In **Data source details**, choose **Sync now** to allow Amazon Q to begin syncing (crawling and ingesting) data from your data source. When the sync job finishes, your data source is ready to use. **Note** View CloudWatch logs for your data source sync job by selecting **View CloudWatch logs**. If you encounter a `Resource not found exception` error, wait and try again as logs may not be available immediately. You can also view a detailed document-level report by selecting **View Report**. This report shows the status of each document during the crawl, sync, and index stages, including any errors. If the report is empty for an in-progress job, check back later as data is emitted to the report as events occur during the sync process. For more information, see [Troubleshooting data source connectors](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/troubleshooting-data-sources.html#troubleshooting-data-sources-not-indexed). # Connecting Amazon Q Business to Confluence (Server/Data Center) using APIs You use the [CreateDataSource](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_CreateDataSource.html) action to connect a data source to your Amazon Q application. You can also use the [UpdateDataSource](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_UpdateDataSource.html) action to modify an existing data source configuration. Then, you use the `configuration` parameter to provide a JSON blob that conforms the AWS-defined JSON schema. For an example of the API request, see [CreateDataSource](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_CreateDataSource.html) and [UpdateDataSource](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_UpdateDataSource.html) in the Amazon Q API Reference. **Topics** + [Confluence (Server/Data Center) configuration properties](#confluence-server-configuration-keys) + [Confluence (Server/Data Center) JSON schema](#confluence-server-json) + [Confluence (Server/Data Center) JSON schema example](#confluence-server-api-json-example) ## Confluence (Server/Data Center) configuration properties The following provides information about important configuration properties required in the schema. | Configuration | Description | Type | Required | | --- | --- | --- | --- | | `connectionConfiguration` | Configuration information for the endpoint for the data source. | `object` This property has the following sub-property: `repositoryEndpointMetadata`. | Yes | | `repositoryEndpointMetadata` | The endpoint information for the data source. | `object` This property has the following sub-properties: `hostUrl`, `type`, and `authType`. | Yes | | `hostUrl` | The URL for your Confluence instance. For example, https://example.confluence.com. If you change or update your Confluence (Server/Data Center) data source URL, you also need to update your Secrets Manager secret to ensure a secure connection. | `string` Specify the URL in the pattern `https://*` | Yes | | `type` | The hosting method for your Confluence instance. | `string` The allowed values are `SAAS` or `ON_PREM`. | Yes | | `authType` | The authentication method for your Confluence instance. | `string` The allowed values are `Basic`, `OAuth2`, or `Personal-token`. | Yes | | `repositoryConfigurations` | Configuration information for the content of the data source. For example, configuring specific types of content and field mappings. | `object` This property has the following sub-properties: `space`, `page`, `blog`, `comment`, and `attachment`. | Yes | | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/confluence-server-api.html) | A list of objects that map the attributes or field names of your Confluence spaces, pages, blogs, comments, and attachments to Amazon Q index field names. | `object` These properties have the following sub-properties. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/confluence-server-api.html) | No | | `indexFieldName` | The field name of your Confluence spaces, pages, blogs, comments, or attachments. | `string` | Yes | | `indexFieldType` | The field type of your Confluence spaces, pages, blogs, comments, or attachments. | `string` The allowed values are `STRING`, `STRING_LIST`, and `DATE`. | Yes | | `dataSourceFieldName` | The data source field name of your Confluence spaces, pages, blogs, comments, or attachments. | `string` | Yes | | `dateFieldFormat` | The date format of your Confluence spaces, pages, blogs, comments, or attachments. | `string` Specify the date format in the form `yyyy-MM-dd'T'HH:mm:ss'Z'` | No | | `additionalProperties` | Additional configuration options for your content in your data source. | `object` This property has the following sub-properties. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/confluence-server-api.html) | Yes | | `isCrawlAcl` | Specify true to crawl access control information from documents. Amazon Q Business crawls ACL information to ensure responses are generated only from documents your end users have access to by default. See [Authorization](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/connector-concepts.html#connector-authorization) for more details. | `boolean` | No | | `isRotateSecret` | Specify true if you want to automatically rotate the secret. | `boolean` | No | | `fieldForUserId` | Specify field to use for UserId for ACL crawling. | `string` | No | | `proxyHost` | The host where the web proxy is required. The host name should be without protocol (http:// or https://). | `string` | No | | `proxyPort` | Port used by the host URL transport protocol. The port number should be a numeric value between 0 and 65535. | `string` | No | | `maxFileSizeInMegaBytes` | Specify the file size limit in MBs that Amazon Q will crawl. Amazon Q will crawl only the files within the size limit you define. The default file size is 50MB. The maximum file size should be greater than 0MB and less than or equal to 50MB. | `string` | No | | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/confluence-server-api.html) | A list of regular expression patterns to include and/or exclude certain files in your Confluence 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 and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index. | `array (string)` | No | | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/confluence-server-api.html) | `true` to index files in your Confluence personal spaces, pages, blogs, page comments, page attachments, blog comments, and blog attachments. | `boolean` | No | | `type` | The type of data source. We recommend that you use CONFLUENCEV2 as your data source type. | `string` The allowed values are `CONFLUENCEV2` and `CONFLUENCE`. | Yes | | `enableIdentityCrawler` | `true` to activate identity crawler. Identity crawler is activated by default. Amazon Q Business crawls identity information from your data source to ensure responses are generated only from documents end users have access to by default. For more information, see [Identity crawler](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/connector-concepts.html#connector-identity-crawler). | `boolean` | Yes | | `syncMode` | Specify whether Amazon Q should update your index by syncing all documents or only new, modified, and deleted documents. | `string` Valid values are `FORCED_FULL_CRAWL` and `FULL_CRAWL`. You can choose between the following options: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/confluence-server-api.html) | Yes | | `secretARN` | The Amazon Resource Name (ARN) of a Secrets Manager secret that contains the key-value pairs required to connect to your Confluence instance. | `string` If you use OAuth 2.0 authentication, the secret must contain a JSON structure with the following keys: 
{
    "confluenceAppKey": "client ID for your Confluence account",
    "confluenceAppSecret": "client secret from your Confluence token",
    "confluenceAccessToken": "access token created in Confluence",
    "confluenceRefreshToken": "refresh token created in Confluence"
}
(For Confluence Server/Data Center only) If you use basic authentication, the secret is stored in a JSON structure with the following keys: 
{
    "username": "Confluence Server/Data Center username",
    "password": "Confluence Server/Data Center password"
}
(For Confluence Server/Data Center only) If you use Personal Access Token authentication, the secret is stored in a JSON structure with the following keys: 
{
    "hostUrl": " Confluence  Server/Data Center host URL",
    "patToken": " Confluence  token"
}
| Yes | | `version` | The version of this template that's currently supported. | `string` | No | ## Confluence (Server/Data Center) JSON schema The following is the Confluence (Server/Data Center) JSON schema: ``` { "type": "object", "properties": { "type": { "type": "string", "enum": ["CONFLUENCEV2", "CONFLUENCE"] }, "syncMode": { "type": "string", "enum": ["FULL_CRAWL", "FORCED_FULL_CRAWL"] }, "secretArn": { "type": "string", "minLength": 20, "maxLength": 2048 }, "enableIdentityCrawler": { "anyOf": [ { "type": "boolean" }, { "type": "string", "enum": ["true", "false"] } ] }, "sslCertificatePath": { "type": "object", "properties": { "bucket": { "type": "string", "pattern": "^[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]$", "minLength": 3, "maxLength": 63 }, "key": { "type": "string", "minLength": 1, "maxLength": 10240 } }, "required": ["bucket", "key"] }, "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { "hostUrl": { "type": "string", "pattern": "https:.*" }, "type": { "type": "string", "enum": ["ON_PREM"] }, "authType": { "type": "string", "enum": ["Basic", "OAuth2", "Personal-token"] } }, "required": ["hostUrl", "type", "authType"] } }, "required": ["repositoryEndpointMetadata"] }, "repositoryConfigurations": { "type": "object", "properties": { "space": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": ["STRING", "STRING_LIST", "DATE"] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": ["fieldMappings"] }, "page": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": ["STRING", "STRING_LIST", "DATE", "LONG"] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": ["fieldMappings"] }, "blog": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": ["STRING", "STRING_LIST", "DATE", "LONG"] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": ["fieldMappings"] }, "comment": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": ["STRING", "STRING_LIST", "DATE", "LONG"] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": ["fieldMappings"] }, "attachment": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": ["STRING", "STRING_LIST", "DATE", "LONG"] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": ["fieldMappings"] } } }, "additionalProperties": { "type": "object", "properties": { "isCrawlAcl": { "anyOf": [ { "type": "boolean" }, { "type": "string", "enum": ["true", "false"] } ] }, "fieldForUserId": { "type": "string" }, "inclusionSpaceKeyFilter": { "type": "array", "items": { "type": "string" } }, "exclusionSpaceKeyFilter": { "type": "array", "items": { "type": "string" } }, "pageTitleRegEX": { "type": "array", "items": { "type": "string" } }, "blogTitleRegEX": { "type": "array", "items": { "type": "string" } }, "commentTitleRegEX": { "type": "array", "items": { "type": "string" } }, "attachmentTitleRegEX": { "type": "array", "items": { "type": "string" } }, "isCrawlPersonalSpace": { "anyOf": [ { "type": "boolean" }, { "type": "string", "enum": ["true", "false"] } ] }, "isCrawlArchivedSpace": { "anyOf": [ { "type": "boolean" }, { "type": "string", "enum": ["true", "false"] } ] }, "isCrawlArchivedPage": { "anyOf": [ { "type": "boolean" }, { "type": "string", "enum": ["true", "false"] } ] }, "isCrawlPage": { "anyOf": [ { "type": "boolean" }, { "type": "string", "enum": ["true", "false"] } ] }, "isCrawlBlog": { "anyOf": [ { "type": "boolean" }, { "type": "string", "enum": ["true", "false"] } ] }, "isCrawlPageComment": { "anyOf": [ { "type": "boolean" }, { "type": "string", "enum": ["true", "false"] } ] }, "isCrawlPageAttachment": { "anyOf": [ { "type": "boolean" }, { "type": "string", "enum": ["true", "false"] } ] }, "isCrawlBlogComment": { "anyOf": [ { "type": "boolean" }, { "type": "string", "enum": ["true", "false"] } ] }, "isCrawlBlogAttachment": { "anyOf": [ { "type": "boolean" }, { "type": "string", "enum": ["true", "false"] } ] }, "maxFileSizeInMegaBytes": { "type": "string" }, "inclusionFileTypePatterns": { "type": "array", "items": { "type": "string" } }, "exclusionFileTypePatterns": { "type": "array", "items": { "type": "string" } }, "inclusionUrlPatterns": { "type": "array", "items": { "type": "string" } }, "exclusionUrlPatterns": { "type": "array", "items": { "type": "string" } }, "enableDeletionProtection": { "anyOf": [ { "type": "boolean" }, { "type": "string", "enum": ["true", "false"] } ], "default": false }, "deletionProtectionThreshold": { "type": "string", "default": "15" } }, "required": [] } }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] }, "required": [ "type", "syncMode", "secretArn", "connectionConfiguration", "repositoryConfigurations", "additionalProperties" ] } ``` ## Confluence (Server/Data Center) JSON schema example The following is the Confluence (Server/Data Center) JSON schema example: ``` { "type": "CONFLUENCEV2", "syncMode": "FULL_CRAWL", "secretArn": "arn:aws:secretsmanager:us-west-2:123456789012:secret:my-confluence-secret", "enableIdentityCrawler": "true", "connectionConfiguration": { "repositoryEndpointMetadata": { "hostUrl": "https://mycompany.atlassian.net", "type": "ON_PREM", "authType": "OAuth2" } }, "repositoryConfigurations": { "space": { "fieldMappings": [ { "indexFieldName": "space_id", "indexFieldType": "STRING", "dataSourceFieldName": "id", "dateFieldFormat": "yyyy-MM-dd'T'HH:mm:ss'Z'" } ] }, "page": { "fieldMappings": [ { "indexFieldName": "page_id", "indexFieldType": "STRING", "dataSourceFieldName": "id", "dateFieldFormat": "yyyy-MM-dd'T'HH:mm:ss'Z'" } ] }, "blog": { "fieldMappings": [ { "indexFieldName": "blog_id", "indexFieldType": "STRING", "dataSourceFieldName": "id", "dateFieldFormat": "yyyy-MM-dd'T'HH:mm:ss'Z'" } ] }, "comment": { "fieldMappings": [ { "indexFieldName": "comment_id", "indexFieldType": "STRING", "dataSourceFieldName": "id", "dateFieldFormat": "yyyy-MM-dd'T'HH:mm:ss'Z'" } ] }, "attachment": { "fieldMappings": [ { "indexFieldName": "attachment_id", "indexFieldType": "STRING", "dataSourceFieldName": "id", "dateFieldFormat": "yyyy-MM-dd'T'HH:mm:ss'Z'" } ] } }, "additionalProperties": { "isCrawlAcl": "true", "fieldForUserId": "user_id", "inclusionSpaceKeyFilter": ["SPACE1", "SPACE2"], "exclusionSpaceKeyFilter": ["SPACE3"], "pageTitleRegEX": ["^.*$"], "blogTitleRegEX": ["^.*$"], "commentTitleRegEX": ["^.*$"], "attachmentTitleRegEX": ["^.*$"], "isCrawlPersonalSpace": "false", "isCrawlArchivedSpace": "false", "isCrawlArchivedPage": "true", "isCrawlPage": "true", "isCrawlBlog": "true", "isCrawlPageComment": "false", "isCrawlPageAttachment": "false", "isCrawlBlogComment": "true", "isCrawlBlogAttachment": "true", "maxFileSizeInMegaBytes": "50", "inclusionFileTypePatterns": ["*.pdf", "*.docx"], "exclusionFileTypePatterns": ["*.tmp"], "inclusionUrlPatterns": ["*"], "exclusionUrlPatterns": ["*.tmp"], "enableDeletionProtection": "false", "deletionProtectionThreshold": "15" } } ``` # Connecting Amazon Q Business to Confluence (Server/Data Center) using AWS CloudFormation You use the [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-datasource.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-datasource.html) resource to connect a data source to your Amazon Q application. Use the [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-datasource.html#cfn-qbusiness-datasource-applicationid](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-datasource.html#cfn-qbusiness-datasource-applicationid) property to provide a JSON or YAML schema with the necessary configuration details specific to your data source connector. To learn more about AWS CloudFormation, see [What is AWS CloudFormation?](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html) in the *CloudFormation User Guide*. **Topics** + [Confluence (Server/Data Center) configuration properties](#confluence-server-configuration-keys) + [Confluence (Server/Data Center) JSON schema for using the configuration property with AWS CloudFormation](#confluence-server-cfn-json) + [Confluence (Server/Data Center) YAML schema for using the configuration property with AWS CloudFormation](#confluence-server-cfn-yaml) ## Confluence (Server/Data Center) configuration properties The following provides information about important configuration properties required in the schema. | Configuration | Description | Type | Required | | --- | --- | --- | --- | | `connectionConfiguration` | Configuration information for the endpoint for the data source. | `object` This property has the following sub-property: `repositoryEndpointMetadata`. | Yes | | `repositoryEndpointMetadata` | The endpoint information for the data source. | `object` This property has the following sub-properties: `hostUrl`, `type`, and `authType`. | Yes | | `hostUrl` | The URL for your Confluence instance. For example, https://example.confluence.com. If you change or update your Confluence (Server/Data Center) data source URL, you also need to update your Secrets Manager secret to ensure a secure connection. | `string` Specify the URL in the pattern `https://*` | Yes | | `type` | The hosting method for your Confluence instance. | `string` The allowed values are `SAAS` or `ON_PREM`. | Yes | | `authType` | The authentication method for your Confluence instance. | `string` The allowed values are `Basic`, `OAuth2`, or `Personal-token`. | Yes | | `repositoryConfigurations` | Configuration information for the content of the data source. For example, configuring specific types of content and field mappings. | `object` This property has the following sub-properties: `space`, `page`, `blog`, `comment`, and `attachment`. | Yes | | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/confluence-server-cfn.html) | A list of objects that map the attributes or field names of your Confluence spaces, pages, blogs, comments, and attachments to Amazon Q index field names. | `object` These properties have the following sub-properties. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/confluence-server-cfn.html) | No | | `indexFieldName` | The field name of your Confluence spaces, pages, blogs, comments, or attachments. | `string` | Yes | | `indexFieldType` | The field type of your Confluence spaces, pages, blogs, comments, or attachments. | `string` The allowed values are `STRING`, `STRING_LIST`, and `DATE`. | Yes | | `dataSourceFieldName` | The data source field name of your Confluence spaces, pages, blogs, comments, or attachments. | `string` | Yes | | `dateFieldFormat` | The date format of your Confluence spaces, pages, blogs, comments, or attachments. | `string` Specify the date format in the form `yyyy-MM-dd'T'HH:mm:ss'Z'` | No | | `additionalProperties` | Additional configuration options for your content in your data source. | `object` This property has the following sub-properties. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/confluence-server-cfn.html) | Yes | | `isCrawlAcl` | Specify true to crawl access control information from documents. Amazon Q Business crawls ACL information to ensure responses are generated only from documents your end users have access to by default. See [Authorization](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/connector-concepts.html#connector-authorization) for more details. | `boolean` | No | | `isRotateSecret` | Specify true if you want to automatically rotate the secret. | `boolean` | No | | `fieldForUserId` | Specify field to use for UserId for ACL crawling. | `string` | No | | `proxyHost` | The host where the web proxy is required. The host name should be without protocol (http:// or https://). | `string` | No | | `proxyPort` | Port used by the host URL transport protocol. The port number should be a numeric value between 0 and 65535. | `string` | No | | `maxFileSizeInMegaBytes` | Specify the file size limit in MBs that Amazon Q will crawl. Amazon Q will crawl only the files within the size limit you define. The default file size is 50MB. The maximum file size should be greater than 0MB and less than or equal to 50MB. | `string` | No | | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/confluence-server-cfn.html) | A list of regular expression patterns to include and/or exclude certain files in your Confluence 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 and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index. | `array (string)` | No | | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/confluence-server-cfn.html) | `true` to index files in your Confluence personal spaces, pages, blogs, page comments, page attachments, blog comments, and blog attachments. | `boolean` | No | | `type` | The type of data source. We recommend that you use CONFLUENCEV2 as your data source type. | `string` The allowed values are `CONFLUENCEV2` and `CONFLUENCE`. | Yes | | `enableIdentityCrawler` | `true` to activate identity crawler. Identity crawler is activated by default. Amazon Q Business crawls identity information from your data source to ensure responses are generated only from documents end users have access to by default. For more information, see [Identity crawler](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/connector-concepts.html#connector-identity-crawler). | `boolean` | Yes | | `syncMode` | Specify whether Amazon Q should update your index by syncing all documents or only new, modified, and deleted documents. | `string` Valid values are `FORCED_FULL_CRAWL` and `FULL_CRAWL`. You can choose between the following options: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/confluence-server-cfn.html) | Yes | | `secretARN` | The Amazon Resource Name (ARN) of a Secrets Manager secret that contains the key-value pairs required to connect to your Confluence instance. | `string` If you use OAuth 2.0 authentication, the secret must contain a JSON structure with the following keys: 
{
    "confluenceAppKey": "client ID for your Confluence account",
    "confluenceAppSecret": "client secret from your Confluence token",
    "confluenceAccessToken": "access token created in Confluence",
    "confluenceRefreshToken": "refresh token created in Confluence"
}
(For Confluence Server/Data Center only) If you use basic authentication, the secret is stored in a JSON structure with the following keys: 
{
    "username": "Confluence Server/Data Center username",
    "password": "Confluence Server/Data Center password"
}
(For Confluence Server/Data Center only) If you use Personal Access Token authentication, the secret is stored in a JSON structure with the following keys: 
{
    "hostUrl": " Confluence  Server/Data Center host URL",
    "patToken": " Confluence  token"
}
| Yes | | `version` | The version of this template that's currently supported. | `string` | No | ## Confluence (Server/Data Center) JSON schema for using the configuration property with AWS CloudFormation The following is the Confluence (Server/Data Center) JSON schema and examples for the configuration property for AWS CloudFormation. **Topics** + [Confluence (Server/Data Center) JSON schema for using the configuration property with AWS CloudFormation](#confluence-server-cfn-json-schema) + [Confluence (Server/Data Center) JSON schema example for using the configuration property with AWS CloudFormation](#confluence-server-cfn-json-example) ### Confluence (Server/Data Center) JSON schema for using the configuration property with AWS CloudFormation The following is the Confluence (Server/Data Center) JSON schema for the configuration property for CloudFormation ``` { "type": "object", "properties": { "type": { "type": "string", "enum": ["CONFLUENCEV2", "CONFLUENCE"] }, "syncMode": { "type": "string", "enum": ["FULL_CRAWL", "FORCED_FULL_CRAWL"] }, "secretArn": { "type": "string", "minLength": 20, "maxLength": 2048 }, "enableIdentityCrawler": { "anyOf": [ { "type": "boolean" }, { "type": "string", "enum": ["true", "false"] } ] }, "sslCertificatePath": { "type": "object", "properties": { "bucket": { "type": "string", "pattern": "^[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]$", "minLength": 3, "maxLength": 63 }, "key": { "type": "string", "minLength": 1, "maxLength": 10240 } }, "required": ["bucket", "key"] }, "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { "hostUrl": { "type": "string", "pattern": "https:.*" }, "type": { "type": "string", "enum": ["ON_PREM"] }, "authType": { "type": "string", "enum": ["Basic", "OAuth2", "Personal-token"] } }, "required": ["hostUrl", "type", "authType"] } }, "required": ["repositoryEndpointMetadata"] }, "repositoryConfigurations": { "type": "object", "properties": { "space": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": ["STRING", "STRING_LIST", "DATE"] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": ["fieldMappings"] }, "page": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": ["STRING", "STRING_LIST", "DATE", "LONG"] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": ["fieldMappings"] }, "blog": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": ["STRING", "STRING_LIST", "DATE", "LONG"] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": ["fieldMappings"] }, "comment": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": ["STRING", "STRING_LIST", "DATE", "LONG"] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": ["fieldMappings"] }, "attachment": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": ["STRING", "STRING_LIST", "DATE", "LONG"] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": ["fieldMappings"] } } }, "additionalProperties": { "type": "object", "properties": { "isCrawlAcl": { "anyOf": [ { "type": "boolean" }, { "type": "string", "enum": ["true", "false"] } ] }, "fieldForUserId": { "type": "string" }, "inclusionSpaceKeyFilter": { "type": "array", "items": { "type": "string" } }, "exclusionSpaceKeyFilter": { "type": "array", "items": { "type": "string" } }, "pageTitleRegEX": { "type": "array", "items": { "type": "string" } }, "blogTitleRegEX": { "type": "array", "items": { "type": "string" } }, "commentTitleRegEX": { "type": "array", "items": { "type": "string" } }, "attachmentTitleRegEX": { "type": "array", "items": { "type": "string" } }, "isCrawlPersonalSpace": { "anyOf": [ { "type": "boolean" }, { "type": "string", "enum": ["true", "false"] } ] }, "isCrawlArchivedSpace": { "anyOf": [ { "type": "boolean" }, { "type": "string", "enum": ["true", "false"] } ] }, "isCrawlArchivedPage": { "anyOf": [ { "type": "boolean" }, { "type": "string", "enum": ["true", "false"] } ] }, "isCrawlPage": { "anyOf": [ { "type": "boolean" }, { "type": "string", "enum": ["true", "false"] } ] }, "isCrawlBlog": { "anyOf": [ { "type": "boolean" }, { "type": "string", "enum": ["true", "false"] } ] }, "isCrawlPageComment": { "anyOf": [ { "type": "boolean" }, { "type": "string", "enum": ["true", "false"] } ] }, "isCrawlPageAttachment": { "anyOf": [ { "type": "boolean" }, { "type": "string", "enum": ["true", "false"] } ] }, "isCrawlBlogComment": { "anyOf": [ { "type": "boolean" }, { "type": "string", "enum": ["true", "false"] } ] }, "isCrawlBlogAttachment": { "anyOf": [ { "type": "boolean" }, { "type": "string", "enum": ["true", "false"] } ] }, "maxFileSizeInMegaBytes": { "type": "string" }, "inclusionFileTypePatterns": { "type": "array", "items": { "type": "string" } }, "exclusionFileTypePatterns": { "type": "array", "items": { "type": "string" } }, "inclusionUrlPatterns": { "type": "array", "items": { "type": "string" } }, "exclusionUrlPatterns": { "type": "array", "items": { "type": "string" } }, "enableDeletionProtection": { "anyOf": [ { "type": "boolean" }, { "type": "string", "enum": ["true", "false"] } ], "default": false }, "deletionProtectionThreshold": { "type": "string", "default": "15" } }, "required": [] } }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] }, "required": [ "type", "syncMode", "secretArn", "connectionConfiguration", "repositoryConfigurations", "additionalProperties" ] } ``` ### Confluence (Server/Data Center) JSON schema example for using the configuration property with AWS CloudFormation The following is the Confluence (Server/Data Center) JSON schema example for the configuration property for CloudFormation ``` { "AWSTemplateFormatVersion": "2010-09-09", "Description": "CloudFormation CONFLUENCE Data Source Template", "Resources": { "DataSourceConfluence": { "Type": "AWS::QBusiness::DataSource", "Properties": { "ApplicationId": "app12345-1234-1234-1234-123456789012", "IndexId": "indx1234-1234-1234-1234-123456789012", "DisplayName": "MyConfluenceDataSource", "RoleArn": "arn:aws:iam::123456789012:role/qbusiness-data-source-role", "Configuration": { "type": "CONFLUENCEV2", "syncMode": "FULL_CRAWL", "secretArn": "arn:aws:secretsmanager:us-west-2:123456789012:secret:my-confluence-secret", "enableIdentityCrawler": "true", "sslCertificatePath": { "bucket": "my-confluence-bucket", "key": "path/to/certificate.pem" }, "connectionConfiguration": { "repositoryEndpointMetadata": { "hostUrl": "https://mycompany.atlassian.net", "type": "ON_PREM", "authType": "Personal-token" } }, "repositoryConfigurations": { "space": { "fieldMappings": [ { "indexFieldName": "space_id", "indexFieldType": "STRING", "dataSourceFieldName": "id", "dateFieldFormat": "yyyy-MM-dd'T'HH:mm:ss'Z'" } ] }, "page": { "fieldMappings": [ { "indexFieldName": "page_id", "indexFieldType": "STRING", "dataSourceFieldName": "id", "dateFieldFormat": "yyyy-MM-dd'T'HH:mm:ss'Z'" } ] }, "blog": { "fieldMappings": [ { "indexFieldName": "blog_id", "indexFieldType": "STRING", "dataSourceFieldName": "id", "dateFieldFormat": "yyyy-MM-dd'T'HH:mm:ss'Z'" } ] }, "comment": { "fieldMappings": [ { "indexFieldName": "comment_id", "indexFieldType": "STRING", "dataSourceFieldName": "id", "dateFieldFormat": "yyyy-MM-dd'T'HH:mm:ss'Z'" } ] }, "attachment": { "fieldMappings": [ { "indexFieldName": "attachment_id", "indexFieldType": "STRING", "dataSourceFieldName": "id", "dateFieldFormat": "yyyy-MM-dd'T'HH:mm:ss'Z'" } ] } }, "additionalProperties": { "isCrawlAcl": "true", "fieldForUserId": "user_id", "inclusionSpaceKeyFilter": ["SPACE1", "SPACE2"], "exclusionSpaceKeyFilter": ["SPACE3"], "pageTitleRegEX": ["^.*$"], "blogTitleRegEX": ["^.*$"], "commentTitleRegEX": ["^.*$"], "attachmentTitleRegEX": ["^.*$"], "isCrawlPersonalSpace": "false", "isCrawlArchivedSpace": "false", "isCrawlArchivedPage": "true", "isCrawlPage": "true", "isCrawlBlog": "true", "isCrawlPageComment": "false", "isCrawlPageAttachment": "false", "isCrawlBlogComment": "true", "isCrawlBlogAttachment": "true", "maxFileSizeInMegaBytes": "50", "inclusionFileTypePatterns": ["*.pdf", "*.docx"], "exclusionFileTypePatterns": ["*.tmp"], "inclusionUrlPatterns": ["*"], "exclusionUrlPatterns": ["*.tmp"], "enableDeletionProtection": "false", "deletionProtectionThreshold": "15" } } } } } } ``` ## Confluence (Server/Data Center) YAML schema for using the configuration property with AWS CloudFormation The following is the Confluence (Server/Data Center) YAML schema and examples for the configuration property for AWS CloudFormation: **Topics** + [Confluence (Server/Data Center) YAML schema for using the configuration property with AWS CloudFormation](#confluence-server-cfn-yaml-schema) + [Confluence (Server/Data Center) YAML schema example for using the configuration property with AWS CloudFormation](#confluence-server-cfn-yaml-example) ### Confluence (Server/Data Center) YAML schema for using the configuration property with AWS CloudFormation The following is the Confluence (Server/Data Center) YAML schema for the configuration property for CloudFormation. ``` AWSTemplateFormatVersion: "2010-09-09" Description: CloudFormation CONFLUENCE Data Source Template Resources: DataSourceConfluence: Type: AWS::QBusiness::DataSource Properties: ApplicationId: app12345-1234-1234-1234-123456789012 IndexId: indx1234-1234-1234-1234-123456789012 DisplayName: MyConfluenceDataSource RoleArn: arn:aws:iam::123456789012:role/qbusiness-data-source-role Configuration: type: CONFLUENCEV2 syncMode: FULL_CRAWL secretArn: arn:aws:secretsmanager:us-west-2:123456789012:secret:my-confluence-secret enableIdentityCrawler: "true" sslCertificatePath: bucket: my-confluence-bucket key: path/to/certificate.pem connectionConfiguration: repositoryEndpointMetadata: hostUrl: https://mycompany.atlassian.net type: ON_PREM authType: Personal-token repositoryConfigurations: space: fieldMappings: - indexFieldName: space_id indexFieldType: STRING dataSourceFieldName: id dateFieldFormat: yyyy-MM-dd'T'HH:mm:ss'Z' page: fieldMappings: - indexFieldName: page_id indexFieldType: STRING dataSourceFieldName: id dateFieldFormat: yyyy-MM-dd'T'HH:mm:ss'Z' blog: fieldMappings: - indexFieldName: blog_id indexFieldType: STRING dataSourceFieldName: id dateFieldFormat: yyyy-MM-dd'T'HH:mm:ss'Z' comment: fieldMappings: - indexFieldName: comment_id indexFieldType: STRING dataSourceFieldName: id dateFieldFormat: yyyy-MM-dd'T'HH:mm:ss'Z' attachment: fieldMappings: - indexFieldName: attachment_id indexFieldType: STRING dataSourceFieldName: id dateFieldFormat: yyyy-MM-dd'T'HH:mm:ss'Z' additionalProperties: isCrawlAcl: "true" fieldForUserId: user_id inclusionSpaceKeyFilter: - SPACE1 - SPACE2 exclusionSpaceKeyFilter: - SPACE3 pageTitleRegEX: - "^.*$" blogTitleRegEX: - "^.*$" commentTitleRegEX: - "^.*$" attachmentTitleRegEX: - "^.*$" isCrawlPersonalSpace: "false" isCrawlArchivedSpace: "false" isCrawlArchivedPage: "true" isCrawlPage: "true" isCrawlBlog: "true" isCrawlPageComment: "false" isCrawlPageAttachment: "false" isCrawlBlogComment: "true" isCrawlBlogAttachment: "true" maxFileSizeInMegaBytes: "50" inclusionFileTypePatterns: - "*.pdf" - "*.docx" exclusionFileTypePatterns: - "*.tmp" inclusionUrlPatterns: - "*" exclusionUrlPatterns: - "*.tmp" enableDeletionProtection: "false" deletionProtectionThreshold: "15" ``` ### Confluence (Server/Data Center) YAML schema example for using the configuration property with AWS CloudFormation The following is the Confluence (Server/Data Center) YAML example for the Configuration property for CloudFormation: ``` AWSTemplateFormatVersion: "2010-09-09" Description: CloudFormation CONFLUENCE Data Source Template Resources: DataSourceConfluence: Type: AWS::QBusiness::DataSource Properties: ApplicationId: app12345-1234-1234-1234-123456789012 IndexId: indx1234-1234-1234-1234-123456789012 DisplayName: MyConfluenceDataSource RoleArn: arn:aws:iam::123456789012:role/qbusiness-data-source-role Configuration: type: CONFLUENCEV2 syncMode: FULL_CRAWL secretArn: arn:aws:secretsmanager:us-west-2:123456789012:secret:my-confluence-secret enableIdentityCrawler: "true" sslCertificatePath: bucket: my-confluence-bucket key: path/to/certificate.pem connectionConfiguration: repositoryEndpointMetadata: hostUrl: https://mycompany.atlassian.net type: ON_PREM authType: Personal-token repositoryConfigurations: space: fieldMappings: - indexFieldName: space_id indexFieldType: STRING dataSourceFieldName: id dateFieldFormat: yyyy-MM-dd'T'HH:mm:ss'Z' page: fieldMappings: - indexFieldName: page_id indexFieldType: STRING dataSourceFieldName: id dateFieldFormat: yyyy-MM-dd'T'HH:mm:ss'Z' blog: fieldMappings: - indexFieldName: blog_id indexFieldType: STRING dataSourceFieldName: id dateFieldFormat: yyyy-MM-dd'T'HH:mm:ss'Z' comment: fieldMappings: - indexFieldName: comment_id indexFieldType: STRING dataSourceFieldName: id dateFieldFormat: yyyy-MM-dd'T'HH:mm:ss'Z' attachment: fieldMappings: - indexFieldName: attachment_id indexFieldType: STRING dataSourceFieldName: id dateFieldFormat: yyyy-MM-dd'T'HH:mm:ss'Z' additionalProperties: isCrawlAcl: "true" fieldForUserId: user_id inclusionSpaceKeyFilter: - SPACE1 - SPACE2 exclusionSpaceKeyFilter: - SPACE3 pageTitleRegEX: - "^.*$" blogTitleRegEX: - "^.*$" commentTitleRegEX: - "^.*$" attachmentTitleRegEX: - "^.*$" isCrawlPersonalSpace: "false" isCrawlArchivedSpace: "false" isCrawlArchivedPage: "true" isCrawlPage: "true" isCrawlBlog: "true" isCrawlPageComment: "false" isCrawlPageAttachment: "false" isCrawlBlogComment: "true" isCrawlBlogAttachment: "true" maxFileSizeInMegaBytes: "50" inclusionFileTypePatterns: - "*.pdf" - "*.docx" exclusionFileTypePatterns: - "*.tmp" inclusionUrlPatterns: - "*" exclusionUrlPatterns: - "*.tmp" enableDeletionProtection: "false" deletionProtectionThreshold: "15" ``` # How Amazon Q Business connector crawls Confluence (Server/Data Center) ACLs Connectors support crawling ACL and identity information where applicable based on the data source. If you index documents without ACLs, all documents are considered public. Indexing documents with ACLs ensures data security. Amazon Q Business supports crawling ACLs for document security by default. When you connect a Confluence (Server/Data Center) data source to Amazon Q Business, Amazon Q crawls ACL information attached to a document (user and group information) from your Confluence (Server/Data Center) instance. If you choose to activate ACL crawling, the information can be used to filter chat responses based on your end users' document access level. The connector crawls the following Confluence resources: + **Spaces** – A collection of related pages, blogs, and attachments. Space permissions apply to all documents in the space by default. + **Pages** – Documents in a space where users create and manage content. Pages can contain text, images, tables, and multimedia elements, and can have nested pages. Each page is considered a single document. Pages can be restricted to specific users and groups in the space. A nested page inherits restrictions from the parent page, and can have its own restrictions. + **Blogs** – Content similar to pages, typically used for updates or announcements. Each blog post is considered as a single document. Blogs can be restricted to specific users and groups in the space. + **Comments** – Feedback and discussions on pages or blog post content. Comments are visible to viewers of the page or post. + **Attachments** – Files uploaded to pages or blog posts, such as images and documents. The connector also crawls user principal information (local user alias, local group and federated group identity configurations) and its permissions for each configured space. The Confluence (Server/Data Center) connector does not support crawling macros, whiteboards, or databases. The connector updates ACL changes each time it crawls your data source content. To ensure that the correct users have access to the correct content, regularly re-sync your data source to capture any ACL updates. You configure user and group access to spaces using the space permissions page. For pages and blogs, you use the restrictions page. For more information about space permissions, see [Space Permissions Overview](https://confluence.atlassian.com/doc/space-permissions-overview-139521.html) on the Confluence Support website. For more information about page and blog restrictions, see [ Page Restrictions ](https://confluence.atlassian.com/doc/page-restrictions-139414.html) on the Confluence Support website. **Important** For user context filtering to work correctly, users' visibility must be set to **Anyone**. For more information, see [Set your email visibility](https://support.atlassian.com/confluence-cloud/docs/configure-user-email-visibility/) in Atlassian Developer Documentation. The group and user IDs are mapped as follows: + `_group_ids` – Group names are present on spaces, pages, and blogs where there are restrictions. They're mapped from the name of the group in Confluence . Group names are always lower case. + `_user_id` – User names are present on the space, page, or blog where there are restrictions. They're mapped depending on the type of Confluence instance that you are using. + For Confluence (Server/Data Center) – The `_user_id` is the user key of the user. **Important** To maintain secure access control for Amazon Q Business, each user must have a unique email address across all connected data sources. In Confluence Data Center users can share an email address while having a different application-specific unique identifier. However, in Amazon Q Business email addresses act as unique identifiers. This means that if a document is shared with a particular user (for example, arnav\$1desai@example.com who is part of pentesters@example.com) on the basis of an application-specific unique ID, every other user who shares pentesters@example.com (for example, xiulan\$1wang@example.com and efua\$1owusu@example.com, both of whom are part of pentesters@example.com) can receive Amazon Q Business responses with content from a document that was shared only with Arnav. Similarly, content created by Arnav that only he should be able to access via Amazon Q Business chat responses, could also be part of Amazon Q Business chat responses for Xiulan and Efua, because they share the same email address. For more information, see: + [Authorization](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/connector-concepts.html#connector-authorization) + [Identity crawler](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/connector-concepts.html#connector-identity-crawler) + [Understanding User Store](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/connector-principal-store.html) # Amazon Q Business Confluence (Server/Data Center) data source connector field mappings To improve retrieved results and customize the end user chat experience, Amazon Q Business enables you to map document attributes from your data sources to fields in your Amazon Q index. Amazon Q offers two kinds of attributes to map to index fields: + **Reserved or default** – Reserved attributes are based on document attributes that commonly occur in most data. You can use reserved attributes to map commonly occurring document attributes in your data source to Amazon Q index fields. + **Custom** – You can create custom attributes to map document attributes that are unique to your data to Amazon Q index fields. When you connect Amazon Q to a data source, Amazon Q automatically maps specific data source document attributes to fields within an Amazon Q index. If a document attribute in your data source doesn't have a attribute mapping already available, or if you want to map additional document attributes to index fields, use the custom field mappings to specify how a data source attribute maps to an Amazon Q index field. You create field mappings by editing your data source after your application environment and retriever are created. To learn more about document attributes and how they work in Amazon Q, see [Document attributes and types in Amazon Q](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/doc-attributes-types.html). **Important** Filtering using document attributes in chat is only supported through the API. The Amazon Q Confluence connector supports the following entities and the associated reserved and custom attributes. **Important** If you map any Confluence (Server/Data Center) field to Amazon Q document title and document body fields, Amazon Q will generate responses from data in the document title and body. **Topics** + [Space](#confluence-field-mappings-space) + [Page](#confluence-field-mappings-page) + [Blog](#confluence-field-mappings-blog) + [Comment](#confluence-field-mappings-comment) + [Attachment](#confluence-field-mappings-attachment) ## Space | Confluence field name | Index field name | Description | Data type | | --- | --- | --- | --- | | spaceName | cf\$1sp\$1document\$1title | Custom | String | | itemType | \$1category | Default | String | | url | \$1source\$1uri | Default | String | | spaceKey | cf\$1space\$1key | Custom | String | | description | cf\$1description | Custom | String | | spaceType | cf\$1type | Custom | String | ## Page | Confluence field name | Index field name | Description | Data type | | --- | --- | --- | --- | | title | \$1cf\$1page\$1document\$1title | Custom | String | | authors | \$1authors | Default | String list | | createdDate | \$1created\$1at | Default | Date | | modifiedDate | \$1last\$1updated\$1at | Default | Date | | labels | cf\$1labels | Custom | String list | | version | cf\$1version | Custom | Long (numeric) | | itemType | \$1category | Default | String | | spaceKey | cf\$1space\$1key | Custom | String | | spaceName | cf\$1space\$1name | Custom | String | | url | \$1source\$1uri | Default | String | | status | cf\$1status | Custom | String | | parentId | cf\$1parent\$1id | Custom | String | ## Blog | Confluence field name | Index field name | Description | Data type | | --- | --- | --- | --- | | title | cf\$1bg\$1document\$1title | Custom | String | | author | \$1authors | Default | String list | | publishedDate | \$1created\$1at | Default | Date | | labels | \$1source\$1uri | Default | String | | version | cf\$1version | Custom | Long (numeric) | | itemType | \$1category | Custom | String | | spaceKey | cf\$1space\$1key | Custom | String | | modifiedDate | \$1last\$1updated\$1at | Default | Date | | spaceName | cf\$1space\$1name | Custom | String | | status | cf\$1status | Custom | String | | url | \$1source\$1uri | Default | String | | parentId | cf\$1parent\$1id | Custom | String | ## Comment | Confluence field name | Index field name | Description | Data type | | --- | --- | --- | --- | | title | cf\$1cmt\$1document\$1title | Custom | String | | author | \$1authors | Default | String list | | createdDate | \$1created\$1at | Default | Date | | version | cf\$1version | Custom | Long (numeric) | | itemType | \$1category | Default | String | | spaceKey | cf\$1space\$1key | Custom | String | | spaceName | cf\$1space\$1name | Custom | String | | contentType | cf\$1content\$1type | Custom | String | | url | \$1source\$1uri | Default | String | | parentId | cf\$1parent\$1id | Custom | String | | status | cf\$1status | Custom | String | ## Attachment | Confluence field name | Index field name | Description | Data type | | --- | --- | --- | --- | | fileName | cf\$1attachment\$1document\$1title | Custom | String | | author | \$1authors | Default | String list | | createdDate | \$1created\$1at | Default | Date | | labels | cf\$1labels | Custom | String list | | version | cf\$1version | Custom | Long (numeric) | | itemType | \$1category | Default | String | | spaceKey | cf\$1space\$1key | Custom | String | | contentType | cf\$1content\$1type | Custom | String | | modifiedDate | \$1last\$1updated\$1at | Default | Date | | fileSize | cf\$1file\$1size | Custom | Long (numeric) | | fileType | cf\$1attachment\$1file\$1type | Custom | String | | spaceName | cf\$1space\$1name | Custom | String | | documentId | \$1document\$1id | Default | String list | | url | \$1source\$1uri | Default | String | | parentId | cf\$1parent\$1id | Custom | String | | attachmentComment | cf\$1attachment\$1comment | Custom | String | | status | cf\$1status | Custom | String | # IAM role for Amazon Q Confluence (Server/Data Center) connector If you use the AWS CLI or an AWS SDK, you must create an AWS Identity and Access Management (IAM) policy before you create an Amazon Q resource. When you call the [CreateDataSource](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_CreateDataSource.html) operation, you provide the Amazon Resource Name (ARN) role with the policy attached. If you use the AWS Management Console, you can create a new IAM role in the Amazon Q console or use an existing IAM role. To learn more about IAM roles, see [IAM roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html) in the *AWS Identity and Access Management User Guide*. To connect your data source connector to Amazon Q, you must give Amazon Q an IAM role that has the following permissions: + Permission to access the `BatchPutDocument` and `BatchDeleteDocument` operations to ingest documents. + Permission to access the [User Store](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/connector-principal-store.html) API operations to ingest user and group access control information from documents. + Permission to access your AWS Secrets Manager secret to authenticate your data source connector instance. + Permission to access the SSL certificate stored in your Amazon S3 bucket. + **(Optional)** If you're using Amazon VPC, permission to access your Amazon VPC. ``` { "Version": "2012-10-17", , "Statement": [{ "Sid": "AllowsAmazonQToGetS3Objects", "Action": [ "s3:GetObject" ], "Resource": [ "arn:aws:s3:::{{input_bucket_name}}/*" ], "Effect": "Allow", "Condition": { "StringEquals": { "aws:ResourceAccount": "{{account_id}}" } } }, { "Sid": "AllowsAmazonQToGetSecret", "Effect": "Allow", "Action": [ "secretsmanager:GetSecretValue" ], "Resource": [ "arn:aws:secretsmanager:{{region}}:{{account_id}}:secret:[[secret_id]]" ] }, { "Sid": "AllowsAmazonQToDecryptSecret", "Effect": "Allow", "Action": [ "kms:Decrypt" ], "Resource": [ "arn:aws:kms:{{region}}:{{account_id}}:key/[[key_id]]" ], "Condition": { "StringLike": { "kms:ViaService": [ "secretsmanager.*.amazonaws.com" ] } } }, { "Sid": "AllowsAmazonQToIngestDocuments", "Effect": "Allow", "Action": [ "qbusiness:BatchPutDocument", "qbusiness:BatchDeleteDocument" ], "Resource": [ "arn:aws:qbusiness:{{region}}:{{source_account}}:application/{{application_id}}", "arn:aws:qbusiness:{{region}}:{{source_account}}:application/{{application_id}}/index/{{index_id}}" ] }, { "Sid": "AllowsAmazonQToIngestPrincipalMapping", "Effect": "Allow", "Action": [ "qbusiness:PutGroup", "qbusiness:CreateUser", "qbusiness:DeleteGroup", "qbusiness:UpdateUser", "qbusiness:ListGroups" ], "Resource": [ "arn:aws:qbusiness:{{region}}:{{account_id}}:application/{{application_id}}", "arn:aws:qbusiness:{{region}}:{{account_id}}:application/{{application_id}}/index/{{index_id}}", "arn:aws:qbusiness:{{region}}:{{account_id}}:application/{{application_id}}/index/{{index_id}}/data-source/*" ] }, { "Sid": "AllowsAmazonQToCreateAndDeleteNI", "Effect": "Allow", "Action": [ "ec2:CreateNetworkInterface", "ec2:DeleteNetworkInterface" ], "Resource": [ "arn:aws:ec2:{{region}}:{{account_id}}:subnet/[[subnet_ids]]", "arn:aws:ec2:{{region}}:{{account_id}}:security-group/[[security_group]]" ] }, { "Sid": "AllowsAmazonQToCreateAndDeleteNIForSpecificTag", "Effect": "Allow", "Action": [ "ec2:CreateNetworkInterface", "ec2:DeleteNetworkInterface" ], "Resource": "arn:aws:ec2:{{region}}:{{account_id}}:network-interface/*", "Condition": { "StringLike": { "aws:RequestTag/AMAZON_Q": "qbusiness_{{account_id}}_{{application_id}}_*" }, "ForAllValues:StringEquals": { "aws:TagKeys": [ "AMAZON_Q" ] } } }, { "Sid": "AllowsAmazonQToCreateTags", "Effect": "Allow", "Action": [ "ec2:CreateTags" ], "Resource": "arn:aws:ec2:{{region}}:{{account_id}}:network-interface/*", "Condition": { "StringEquals": { "ec2:CreateAction": "CreateNetworkInterface" } } }, { "Sid": "AllowsAmazonQToCreateNetworkInterfacePermission", "Effect": "Allow", "Action": [ "ec2:CreateNetworkInterfacePermission" ], "Resource": "arn:aws:ec2:{{region}}:{{account_id}}:network-interface/*", "Condition": { "StringLike": { "aws:ResourceTag/AMAZON_Q": "qbusiness_{{account_id}}_{{application_id}}_*" } } }, { "Sid": "AllowsAmazonQToDescribeResourcesForVPC", "Effect": "Allow", "Action": [ "ec2:DescribeNetworkInterfaces", "ec2:DescribeAvailabilityZones", "ec2:DescribeNetworkInterfaceAttribute", "ec2:DescribeVpcs", "ec2:DescribeRegions", "ec2:DescribeNetworkInterfacePermissions", "ec2:DescribeSubnets" ], "Resource": "*" } ] } ``` **To allow Amazon Q to assume a role, you must also use the following trust policy:** ``` { "Version": "2012-10-17", , "Statement": [ { "Sid": "AllowsAmazonQToAssumeRoleForServicePrincipal", "Effect": "Allow", "Principal": { "Service": "qbusiness.amazonaws.com" }, "Action": "sts:AssumeRole", "Condition": { "StringEquals": { "aws:SourceAccount": "{{source_account}}" }, "ArnLike": { "aws:SourceArn": "arn:aws:qbusiness:{{region}}:{{source_account}}:application/{{application_id}}" } } } ] } ``` For more information on Amazon Q data source connector IAM roles, see [IAM roles for Amazon Q data source connectors](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/iam-roles.html#iam-roles-ds). # Understand error codes in the Amazon Q Business Confluence (Server/Data Center) connector The following table provides information about error codes you may see for the Confluence (Server/Data Center) connector and suggested resolutions. | Error code | Error message | Suggested resolution | | --- | --- | --- | | CNF-5500 | Null/empty username. | Provide username. | | CNF-5501 | Error validating credentials due to Invalid username or password. | Provide valid username/password | | CNF-5502 | Null/empty confluence AppKey. | Provide confluence AppKey. | | CNF-5503 | Null/empty confluence Secret. | Provide confluence Secret. | | CNF-5504 | Null/empty Client Access Token. | Provide Client Access Token. | | CNF-5505 | Null/empty Client Refresh Token | Provide Client Refresh Token | | CNF-5506 | Incorrect auth type. | Auth type should be Basic or OAuth2 or Personal-token. | | CNF-5507 | Null/empty auth type. | Auth Type should not be null or empty value. | | CNF-5508 | Empty/null host URL. | Host Url should not be null or empty value. | | CNF-5509 | Null/empty crawl type. | Crawl Type should not be null or empty value. | | CNF-5510 | Null/empty Repository Configurations. | Repository Configurations should not be null or empty value. | | CNF-5511 | Incorrect type. | type should be SAAS or ON\$1PREM. | | CNF-5512 | Invalid inclusion file type patterns. | Provide the correct inclusion patterns. | | CNF-5513 | Invalid exclusion file type patterns. | Provide the correct exclusion patterns. | | CNF-5514 | Invalid regex patterns. | Provide the correct regex patterns. | | CNF-5515 | Error validating credentials due to invalid username or password. | Provide valid username and password. | | CNF-5516 | Error validating credentials due to invalid client id or client secret. | Provide valid client id and client secret. | | CNF-5517 | Error validating crawl type. | Provide valid crawl type. | | CNF-5518 | Invalid URI. | Provide valid URI. | | CNF-5519 | Null/empty DataSourceFieldName in Space Entity. | Provide value for DataSourceFieldName in Space Entity. | | CNF-5520 | Null/empty IndexFieldName in Blog Entity. | Provide value for IndexFieldName in Blog Entity. | | CNF-5521 | Null/empty IndexFieldType in Space Entity. | Provide value for IndexFieldType in Space Entity. | | CNF-5522 | Null/empty password. | Provide password. | | CNF-5523 | Incorrect auth type. | Auth type should be Basic or OAuth2. | | CNF-5524 | Null/empty DataSourceFieldName in Page Entity. | Provide value for DataSourceFieldName in Page Entity. | | CNF-5525 | Null/empty DataSourceFieldName in Blog Entity | Please provide value for DataSourceFieldName in Blog Entity | | CNF-5526 | Null/empty DataSourceFieldName in Comment Entity. | Provide value for DataSourceFieldName in Comment Entity. | | CNF-5527 | Null/empty DataSourceFieldName in Attachment Entity. | Provide value for DataSourceFieldName in Attachment Entity. | | CNF-5528 | Null/empty IndexFieldName. | IndexFieldName field can't be null or empty value. | | CNF-5529 | Null/empty IndexFieldName in Space Entity. | Provide value for IndexFieldName in Space Entity. | | CNF-5530 | Null/empty IndexFieldName in Page Entity | Please provide value for IndexFieldName in Page Entity | | CNF-5531 | Invalid isCrawlPersonalSpace value. | isCrawlPersonalSpace should be a boolean value true or false. | | CNF-5532 | Invalid isCrawlArchivedSpace value. | isCrawlArchivedSpace should be a boolean value true or false. | | CNF-5533 | Invalid isCrawlArchivedPage value. | isCrawlArchivedPage should be a boolean value true or false. | | CNF-5534 | Invalid isCrawlPage value. | isCrawlPage should be a boolean value true or false. | | CNF-5535 | Invalid isCrawlBlogComment value. | isCrawlBlogComment should be a boolean value true or false. | | CNF-5536 | Invalid isCrawlBlogComment value. | isCrawlBlogComment should be a boolean value true or false. | | CNF-5537 | Invalid isCrawlBlogAttachment value. | isCrawlBlogAttachment should be a boolean value true or false. | | CNF-5538 | Error validating on protocol. | Provide valid protocol. | | CNF-5539 | Null/empty IndexFieldName in Comment Entity. | Provide value for IndexFieldName in Comment Entity. | | CNF-5540 | Null/empty Personal Access Token. | Provide Personal Access Token. | | CNF-5541 | Invalid OAuth value. | Give a valid OAuth URL. | | CNF-5542 | Invalid Space value. | Give a valid Space URL. | | CNF-5543 | Archived Space Exception. | Check Archived Space. | | CNF-5544 | JSON Exception for Space. | Check Space. | | CNF-5545 | JSON Exception for Comment. | Check Comment. | | CNF-5546 | JSON Exception for Comment. | Check Comment. | | CNF-5547 | JSON Exception for Comment. | Check Comment. | | CNF-5548 | JSON Exception for Attachment. | Check Attachment. | | CNF-5549 | JSON Exception for Blog. | Check Blog. | | CNF-5550 | JSON Exception for Page. | Check Page. | | CNF-5551 | JSON Exception for Label. | Check Label. | | CNF-5552 | JSON Exception for ACL. | Check ACL. | | CNF-5553 | JSON Exception for Groups. | Check Groups. | | CNF-5554 | JSON Exception for Group Members. | Check Group Members. | | CNF-5555 | JSON Exception for Space Group. | Check Space Group. | | CNF-5556 | Exception in CommentItem. | Check the CommentItem class. | | CNF-5557 | Invalid isCrawlPageComment value. | isCrawlPageComment should be a boolean value true or false. | | CNF-5558 | Invalid isCrawlPageAttachment value. | isCrawlPageAttachment should be a boolean value true or false. | | CNF-5559 | Null/empty Repository Configurations. | Repository Configurations should not be null or empty value. | | CNF-5560 | Null/empty IndexFieldName in Attachment. | Please provide value for IndexFieldName in Attachment Entity. | | CNF-5561 | Invalid proxy url. | Proxy url should not contain http: or https. | | CNF-5562 | Null/Empty proxy port. | Provide a valid proxy port. | | CNF-5563 | Invalid Host URL. | Provide valid Host URL. | | CNF-5564 | Invalid proxy port value. | Provide a valid proxy port. | | CNF-5565 | Confluence server not reachable. | Provide a valid proxy and server details. | | CNF-5566 | Null/empty IndexFieldType in Page Entity. | Provide value for IndexFieldType in Page Entity. | | CNF-5567 | Null/empty IndexFieldType in Blog Entity. | Provide value for IndexFieldType in Blog Entity. | | CNF-5568 | Null/empty IndexFieldType in Comment Entity. | Provide value for IndexFieldType in Comment Entity. | | CNF-5569 | Null/empty IndexFieldType in Attachment. | Provide value for IndexFieldType in Attachment. Entity | | CNF-5570 | JSON Exception for Content Ancestors. | Check your Ancestors. | | CNF-5571 | Invalid Host URL Pattern. | Provide valid Host URL Pattern. | | CNF-5572 | Error validating credentials due to Invalid access or refresh token. | Invalid AccessToken/RefreshToken. |