Adding a Connection to Confluence

To add a connection to Confluence:

1. In the application console, navigate to the Connections page.
2. At the Add Connections panel, select the icon for the connection you want to add.
3. If the Confluence icon is not available, click the Add More icon to download and install the Confluence connector from the CData site.

For required properties, see the Settings tab.

For connection properties that are not typically required, see the Advanced tab.

Connecting to Confluence

You can establish a connection to any Confluence Cloud account or Confluence Server instance. To connect set the URL connection property. For example, https://yoursitename.atlassian.net.

Authenticating to Confluence

Confluence supports the following authentication methods: API token, Basic authentication, OAuth 2.0, and SSO.

API Token

Confluence Cloud Account

Acquire a Token

An API token is necessary for account authentication. To generate one, log in to your Atlassian account and select API tokens > Create API token. The generated token is displayed.

Authenticate Using the Token

To authenticate to a Cloud account, provide the following (Note: Password has been deprecated for connecting to a Cloud Account and is now used only to connect to a Server Instance.):

• AuthScheme: Set this to APIToken.
• User: The user to be used to authenticate with the Confluence server.
• APIToken: The API Token associated with the currently authenticated user.
• URL: The URL associated with your Confluence endpoint. For example, https://yoursitename.atlassian.net.

Basic Authentication

Confluence Server Instance

To authenticate to a Server instance, specify the following:

• AuthScheme: Set this to Basic.
• User: The user to authenticate with the Confluence instance.
• Password: The password which is used to authenticate with the Confluence server.
• URL: The URL associated with your Confluence endpoint. For example, https://yoursitename.atlassian.net.

OAuth

In all cases, you must set AuthScheme to OAuth and Scope to the value obtained from your application settings. In all the flows described below, it is assumed that you have done so. Note: OAuth 1.0 is deprecated in Confluence Cloud and should only be used by hosted Confluence users.

Crowd

Set the AuthScheme to Crowd, then configure these connection properties:

• User: The CROWD user account.
• Password: The password associated with the Crowd account.
• SSOLoginURL: The login URL associated with the Crowd account. You can find the IDP URL by navigating to your application > SSO > SSO information > Identity provider single sign-on URL.
• SSOAppName: The name of the application in which SSO is enabled.
• SSOAppPassword: The password of the application in which SSO is enabled.
• SSOExchangeURL: The URL used used to exchange the SAML token for Confluence cookies. This URL may have the following formats:
  • https://<authority of Confluence instance>/plugins/servlet/samlconsumer
  • https://<authority of Confluence instance>/plugins/servlet/samlsso

Example connection string:

AuthScheme=Crowd;Url=https://yoursitename.atlassian.net;SSOLoginURL='https://<authority>/crowd/console/secure/saml/sso.action';User=crowdUserName;Password=crowdPassword;SSOExchangeUrl=https://<authority of Confluence instance>/plugins/servlet/samlconsumer;SSOAppName=CrowdAppName;SSOAppPassword=CrowdAppPassword;

Okta

To connect to Okta, set these properties:

• AuthScheme: Okta.
• User: The authentiating Okta user.
• Password: The password of the authenticating Okta user.
• SSOLoginURL: The SSO provider's login URL.
• SSOExchangeURL: The URL used used to exchange the SAML token for Confluence cookies. This URL may have the following formats:
  • https://<authority of Confluence instance>/plugins/servlet/samlconsumer
  • https://<authority of Confluence instance>/plugins/servlet/samlsso

If you are either using a trusted application or proxy that overrides the Okta client request OR configuring MFA, you must use combinations of SSOProperties to authenticate using Okta. Set any of the following, as applicable:

• APIToken: When authenticating a user via a trusted application or proxy that overrides the Okta client request context, set this to the API Token the customer created from the Okta organization.
• MFAType: If you have configured the MFA flow, set this to one of the following supported types: OktaVerify, Email, or SMS.
• MFAPassCode: If you have configured the MFA flow, set this to a valid passcode.
  If you set this to empty or an invalid value, the Sync App issues a one-time password challenge to your device or email. After the passcode is received, reopen the connection where the retrieved one-time password value is set to the MFAPassCode connection property.
• MFARememberDevice: True by default. Okta supports remembering devices when MFA is required. If remembering devices is allowed according to the configured authentication policies, the Sync App sends a device token to extend MFA authentication lifetime. If you do not want MFA to be remembered, set this variable to False.

Example connection string:

AuthScheme=Okta;Url=https://yoursitename.atlassian.net;SSOLoginURL='https://example.okta.com/home/appType/0bg4ivz6cJRZgCz5d6/46';User=oktaUserName;Password=oktaPassword;SSOExchangeUrl=https://<authority of Confluence instance>/plugins/servlet/samlconsumer;

Fine Tuning Data Access

You can use the following properties to gain more control over the data returned from Confluence:

• IncludeArchivedSpaces: Include content from archived spaces in the result. This defaults to false.
• SpaceKey: Search results will only display contents from the specified space.
• Timezone: The timezone of the Confluence instance. The appropriate datetime filters will be used to retrieve results in accordance with the specified timezone.

This section details a selection of advanced features of the Confluence Sync App.

User Defined Views

The Sync App supports the use of user defined views, virtual tables whose contents are decided by a pre-configured user defined query. These views are useful when you cannot directly control queries being issued to the drivers. For an overview of creating and configuring custom views, see User Defined Views .

SSL Configuration

Use SSL Configuration to adjust how Sync App handles TLS/SSL certificate negotiations. You can choose from various certificate formats;. For further information, see the SSLServerCert property under "Connection String Options" .

Firewall and Proxy

Configure the Sync App for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.

Query Processing

The Sync App offloads as much of the SELECT statement processing as possible to Confluence and then processes the rest of the query in memory (client-side).

For further information, see Query Processing.

Logging

For an overview of configuration settings that can be used to refine CData logging, see Logging. Only two connection properties are required for basic logging, but there are numerous features that support more refined logging, which enables you to use the LogModules connection property to specify subsets of information to be logged.

Customizing the SSL Configuration

To enable TLS, set the following:

• URL: Prefix the connection string with https://

With this configuration, the Sync App attempts to negotiate TLS with the server. The server certificate is validated against the default system trusted certificate store. You can override how the certificate gets validated using the SSLServerCert connection property.

To specify another certificate, see the SSLServerCert connection property.

Client SSL Certificates

The Confluence Sync App also supports setting client certificates. Set the following to connect using a client certificate.

• SSLClientCert: The name of the certificate store for the client certificate.
• SSLClientCertType: The type of key store containing the TLS/SSL client certificate.
• SSLClientCertPassword: The password for the TLS/SSL client certificate.
• SSLClientCertSubject: The subject of the TLS/SSL client certificate.

Connecting Through a Firewall or Proxy

HTTP Proxies

To authenticate to an HTTP proxy, set the following:

• ProxyServer: the hostname or IP address of the proxy server that you want to route HTTP traffic through.
• ProxyPort: the TCP port that the proxy server is running on.
• ProxyAuthScheme: the authentication method the Sync App uses when authenticating to the proxy server.
• ProxyUser: the username of a user account registered with the proxy server.
• ProxyPassword: the password associated with the ProxyUser.

Other Proxies

Set the following properties:

• To use a proxy-based firewall, set FirewallType, FirewallServer, and FirewallPort.
• To tunnel the connection, set FirewallType to TUNNEL.
• To authenticate, specify FirewallUser and FirewallPassword.
• To authenticate to a SOCKS proxy, additionally set FirewallType to SOCKS5.

Overview

This section shows the available API objects and provides more information on executing SQL to Confluence APIs.

Key Features

• The Sync App models Confluence entities like pages, blogposts, comments, attachments, spaces, audit records and users as relational views, allowing you to write SQL to query Confluence data.
• Live connectivity to these objects means any changes to your Confluence account are immediately reflected when using the Sync App.

Views

Views describes the available views. Views are statically defined to model AuditRecords, Pages, Blogposts, Comments, Attachments, Contributors, Labels, Spaces and Users.

The Sync App models the data in Confluence as a list of tables in a relational database that can be queried using standard SQL statements.

Confluence Connector for CData Sync Tables

Name	Description
Attachments	Get information about an attachment in a page or blogpost.
Blogposts	Get information about a blogpost within a space.
Groups	Get information about a specific group.
Pages	Get information about a page within a space.
Spaces	Returns information about a number of spaces.

Get information about an attachment in a page or blogpost.

Table Specific Information

Select

The Sync App will use the Confluence API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App. You can also search for Attachments using CQL (Confluence Query Language).

• Id supports the '=,!=,IN,NOT IN' comparisons.
• Type supports the '=,!=,IN,NOT IN' comparisons.
• Title supports the '=,!=,IN,NOT IN' comparisons.
• SpaceKey supports the '=,!=,IN,NOT IN' comparisons.
• SpaceType supports the '=,!=,IN,NOT IN' comparisons.
• CreatedByUserName supports the '=,!=,IN,NOT IN' comparisons.
• CreatedDate supports the '=,!=,>,>=,<,<=' comparisons.
• LastUpdatedDatetime supports the '=,!=,>,>=,<,<=' comparisons.

For example, the following queries are processed server side:

SQL

SELECT * FROM Attachments WHERE Id = '1234'

SELECT * FROM Attachments WHERE Id IN ('1234', '2345')

SELECT * FROM Attachments WHERE Id = '294922' OR Type = 'attachment'

SELECT * FROM Attachments WHERE CreatedDate <= '2019/03/29 15:00' AND Id IN ('1234', '2345')

Additionally Id, Type, Title, CreatedDate, CreatedByUserName, AND LastUpdatedDatetime columns can be used in the ORDER BY clause, as following:

SELECT * FROM Attachments ORDER BY Id DESC

SELECT * FROM Attachments ORDER BY CreatedByUserName ASC

CQL

Note: Filtering with CQL has the highest priority and all the other filters except "Excerpt" will be ignored when CQL filter is present in the query.

SELECT * FROM Attachments WHERE CQL = 'creator = currentUser() AND content = "1234" OR space.type = "global"'

Columns

Name	Type	ReadOnly	References	SupportedOperators	Description
Id [KEY]	String	True		=,!=,IN,NOT_IN	Id of the content.
Type	String	True			Type of the content.
Title	String	True		=,!=,IN,NOT_IN	Title of the content.
Status	String	True			Status of the content.
SpaceKey	String	True	Spaces.Key	=,!=,IN,NOT_IN	The key of the space that the content belongs to.
SpaceType	String	True	Spaces.Type	=,!=,IN,NOT_IN	The type of the space that the content belongs to.
Position	String	True			Position of the content.
URL	String	True			URL of the content.
Excerpt	String	True			Excerpt of the content.
IsLatest	Boolean	True			Indicator if this is the latest version of the content.
CreatedByUserName	String	True		=,!=,IN,NOT_IN	Username of the user who created the content.
CreatedByUserType	String	True			Type of the user who created the content.
CreatedDate	Datetime	True		=,>,>=,<,<=	Datetime for the creation of the content.
LastUpdatedDatetime	Datetime	True		=,>,>=,<,<=	Datetime of the last updated version of the content.
LastUpdatedMessage	String	True			Message of the last updated version.
LastUpdatedNumber	Integer	True			Number of the last updated version.
LastUpdatedUserName	String	True			Username of the user who updated the latest version.
LastUpdatedUserType	String	True			Type of the user who updated the latest version.
LastUpdatedIsMinorEdit	Boolean	True			Indicator if this version is a minor edit.
LastUpdatedIsHidden	Boolean	True			Indicator if the last updated version is hidden or not.
PreviousVersionUserName	String	True			Username of the user who updated the previous version.
PreviousVersionUserType	String	True			Type of the user who updated the previous version.
PreviousVersionDatetime	Datetime	True			Datetime when the previous version was edited.
PreviousVersionMessage	String	True			Message for the previously edited version.
PreviousVersionNumber	String	True			Number of the previously edited version.
PreviousVersionIsMinorEdit	Boolean	True			Indicator if the previous version was a minor edit.
PreviousVersionIsHidden	Boolean	True			Indicator if the previous version was hidden or not.
LinksEditui	String	True			The LinksEditui of the page content.
LinksSelf	String	True			The LinksSelf of the content.
LinksTinyui	String	True			The LinksTinyui of the content.
LinksWebui	String	True			The LinksWebui of the content.
ItemURL	String	True			The URL reference of the element in UI.
ContainerId	String	True			The Id of the container of the content.
MediaType	String	True			Media Type of the attachment.
DownloadLink	String	True			The download link of the attachment.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
CQL	String	CQL (Confluence Query Language) allows you to build structured queries.

Get information about a blogpost within a space.

Table Specific Information

Select

The Sync App will use the Confluence API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App. You can also search for Attachments using CQL (Confluence Query Language).

• Id supports the '=,!=,IN,NOT IN' comparisons.
• Type supports the '=,!=,IN,NOT IN' comparisons.
• Title supports the '=,!=,IN,NOT IN' comparisons.
• SpaceKey supports the '=,!=,IN,NOT IN' comparisons.
• SpaceType supports the '=,!=,IN,NOT IN' comparisons.
• CreatedByUserName supports the '=,!=,IN,NOT IN' comparisons.
• CreatedDate supports the '=,!=,>,>=,<,<=' comparisons.
• LastUpdatedDatetime supports the '=,!=,>,>=,<,<=' comparisons.

For example, the following queries are processed server side:

SQL

SELECT * FROM Blogposts WHERE Id = '1234'

SELECT * FROM Blogposts WHERE Id IN ('1234', '2345')

SELECT * FROM Blogposts WHERE Id = '123458' AND Type = 'blogpost'

SELECT * FROM Blogposts WHERE CreatedDate <= '2019/03/29 15:00' AND Id IN ('1234', '2345')

Additionally Id, Type, Title, CreatedDate, CreatedByUserName, AND LastUpdatedDatetime columns can be used in the ORDER BY clause, as following:

SELECT * FROM Blogposts ORDER BY Id DESC

SELECT * FROM Blogposts ORDER BY CreatedByUserName ASC

CQL

Note: Filtering with CQL has the highest priority and all the other filters except "Excerpt" will be ignored when CQL filter is present in the query.

SELECT * FROM Blogposts WHERE CQL = 'creator = currentUser() AND content = "1234" OR space.type = "global"'

Columns

Name	Type	ReadOnly	References	SupportedOperators	Description
Id [KEY]	String	True		=,!=,IN,NOT_IN	Id of the content.
Type	String	True			Type of the content.
Title	String	False		=,!=,IN,NOT_IN	Title of the content.
Status	String	False			Status of the content.
SpaceKey	String	True	Spaces.Key	=,!=,IN,NOT_IN	The key of the space that the content belongs to.
SpaceType	String	True	Spaces.Type	=,!=,IN,NOT_IN	The type of the space that the content belongs to.
Position	String	True			Position of the content.
URL	String	True			URL of the content.
Excerpt	String	True			Excerpt of the content.
IsLatest	Boolean	True			Indicator if this is the latest version of the content.
CreatedByUserName	String	True		=,!=,IN,NOT_IN	Username of the user who created the content.
CreatedByUserType	String	True			Type of the user who created the content.
CreatedDate	Datetime	False		=,>,>=,<,<=	Datetime for the creation of the content.
LastUpdatedDatetime	Datetime	True		=,>,>=,<,<=	Datetime of the last updated version of the content.
LastUpdatedMessage	String	True			Message of the last updated version.
LastUpdatedNumber	Integer	True			Number of the last updated version.
LastUpdatedUserName	String	True			Username of the user who updated the latest version.
LastUpdatedUserType	String	True			Type of the user who updated the latest version.
LastUpdatedIsMinorEdit	Boolean	True			Indicator if this version is a minor edit.
LastUpdatedIsHidden	Boolean	True			Indicator if the last updated version is hidden or not.
PreviousVersionUserName	String	True			Username of the user who updated the previous version.
PreviousVersionUserType	String	True			Type of the user who updated the previous version.
PreviousVersionDatetime	Datetime	True			Datetime when the previous version was edited.
PreviousVersionMessage	String	True			Message for the previously edited version.
PreviousVersionNumber	String	True			Number of the previously edited version.
PreviousVersionIsMinorEdit	Boolean	True			Indicator if the previous version was a minor edit.
PreviousVersionIsHidden	Boolean	True			Indicator if the previous version was hidden or not.
LinksEditui	String	True			The LinksEditui of the page content.
LinksSelf	String	True			The LinksSelf of the content.
LinksTinyui	String	True			The LinksTinyui of the content.
LinksWebui	String	True			The LinksWebui of the content.
ItemURL	String	True			The URL reference of the element in UI.
ContainerId	String	True			The Id of the container of the content.
StorageBody	String	False			The body content storage.
AtlasDocFormatBody	String	False			The body content in atlas doc format.
SpaceId	String	False			The body content in atlas doc format.
VersionNumber	String	False			The body content in atlas doc format.
VersionMessage	String	False			The body content in atlas doc format.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
CQL	String	CQL (Confluence Query Language) allows you to build structured queries.

Get information about a specific group.

Table Specific Information

Select

The Sync App will use the Confluence API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

• Name supports the '=,IN' comparisons.
• Id supports the '=' comparisons.

For example, the following queries are processed server side:

SELECT * FROM Groups WHERE Name = 'test'

SELECT * FROM Groups WHERE Name IN ('test1', 'test2')

SELECT * FROM Groups WHERE Id = 'ef75d879-6b69-4260-942a-ff5231e08be0'

Columns

Name	Type	ReadOnly	References	SupportedOperators	Description
Id [KEY]	String	True		=	Id of the group.
Name [KEY]	String	False		=,LIKE	Name of the group.
Type	String	True			Type of the group.

Get information about a page within a space.

Table Specific Information

Select

The Sync App will use the Confluence API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App. You can also search for Attachments using CQL (Confluence Query Language).

• Id supports the '=,!=,IN,NOT IN' comparisons.
• Type supports the '=,!=,IN,NOT IN' comparisons.
• Title supports the '=,!=,IN,NOT IN' comparisons.
• SpaceKey supports the '=,!=,IN,NOT IN' comparisons.
• SpaceType supports the '=,!=,IN,NOT IN' comparisons.
• CreatedByUserName supports the '=,!=,IN,NOT IN' comparisons.
• CreatedDate supports the '=,!=,>,>=,<,<=' comparisons.
• LastUpdatedDatetime supports the '=,!=,>,>=,<,<=' comparisons.

For example, the following queries are processed server side:

SQL

SELECT * FROM Pages WHERE Id = '1234'

SELECT * FROM Pages WHERE Id IN ('1234', '2345')

SELECT * FROM Pages WHERE Id = '294922' OR Type = 'page'

SELECT * FROM Pages WHERE CreatedDate <= '2019/03/29 15:00' AND Id IN ('1234', '2345')

Additionally Id, Type, Title, CreatedDate, CreatedByUserName, AND LastUpdatedDatetime columns can be used in the ORDER BY clause, as following:

SELECT * FROM Pages ORDER BY Id DESC

SELECT * FROM Pages ORDER BY CreatedByUserName ASC

CQL

Note: Filtering with CQL has the highest priority and all the other filters except "Excerpt" will be ignored when CQL filter is present in the query.

SELECT * FROM Pages WHERE CQL = 'creator = currentUser() AND content = "1234" OR space.type = "global"'

Columns

Name	Type	ReadOnly	References	SupportedOperators	Description
Id [KEY]	String	False		=,!=,IN,NOT_IN	Id of the content.
Type	String	True		=,!=,IN,NOT_IN	Type of the content.
Title	String	False		=,!=,IN,NOT_IN	Title of the content.
Status	String	False		=	Status of the content.
Storage	String	False			The body content storage of the page..
AtlasDocFormat	String	False			The body content in atlas doc format of the page.
Position	String	True			Position of the content.
OwnerId	String	False			Id of the owner of the page.
ParentId	Long	False			The Id of the parent page.
SpaceId	String	False			The Id of the space the page rests.
SpaceKey	String	True	Spaces.Key	=,!=,IN,NOT_IN	The key of the space that the content belongs to.
SpaceType	String	True	Spaces.Type	=,!=,IN,NOT_IN	The type of the space that the content belongs to.
URL	String	True			URL of the content.
Excerpt	String	True			Excerpt of the content.
IsLatest	Boolean	True			Indicator if this is the latest version of the content.
CreatedByUserName	String	True		=,!=,IN,NOT_IN	Username of the user who created the content.
CreatedByUserType	String	True			Type of the user who created the content.
CreatedDate	Datetime	True		=,>,>=,<,<=	Datetime for the creation of the content.
LastUpdatedDatetime	Datetime	True		=,>,>=,<,<=	Datetime of the last updated version of the content.
LastUpdatedMessage	String	True			Message of the last updated version.
LastUpdatedNumber	Integer	True			Number of the last updated version.
LastUpdatedUserName	String	True			Username of the user who updated the latest version.
LastUpdatedUserType	String	True			Type of the user who updated the latest version.
LastUpdatedIsMinorEdit	Boolean	True			Indicator if this version is a minor edit.
LastUpdatedIsHidden	Boolean	True			Indicator if the last updated version is hidden or not.
PreviousVersionUserName	String	True			Username of the user who updated the previous version.
PreviousVersionUserType	String	True			Type of the user who updated the previous version.
PreviousVersionDatetime	Datetime	True			Datetime when the previous version was edited.
PreviousVersionMessage	String	True			Message for the previously edited version.
PreviousVersionNumber	String	True			Number of the previously edited version.
PreviousVersionIsMinorEdit	Boolean	True			Indicator if the previous version was a minor edit.
PreviousVersionIsHidden	Boolean	True			Indicator if the previous version was hidden or not.
VersionUserName	String	True			Username of the user who updated the previous version.
VersionUserType	String	True			Type of the user who updated the previous version.
VersionDatetime	Datetime	True			Datetime when the previous version was edited.
VersionMessage	String	False			Message for the previously edited version.
VersionNumber	Integer	False			Number of the previously edited version.
VersionIsMinorEdit	Boolean	True			Indicator if the previous version was a minor edit.
VersionIsHidden	Boolean	True			Indicator if the previous version was hidden or not.
LinksEditui	String	True			The LinksEditui of the page content.
LinksSelf	String	True			The LinksSelf of the content.
LinksTinyui	String	True			The LinksTinyui of the content.
LinksWebui	String	True			The LinksWebui of the content.
ItemURL	String	True			The URL reference of the element in UI.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
CQL	String	CQL (Confluence Query Language) allows you to build structured queries.

Returns information about a number of spaces.

Table Specific Information

Select

The Sync App will use the Confluence API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App. You can also search for Attachments using CQL (Confluence Query Language).

• Key supports the '=,!=,IN,NOT IN' comparisons.
• Name supports the '=,LIKE,NOT LIKE' comparisons.
• Type supports the '=,!=,IN,NOT IN' comparisons.
• Excerpt supports the '=' comparisons.

For example, the following queries are processed server side:

SQL

SELECT * FROM Spaces WHERE Key = 'abc'

SELECT * FROM Spaces WHERE Name IN ('name1', 'name2')

SELECT * FROM Spaces WHERE Excerpt = 'driver development'

SELECT * FROM Spaces WHERE Key = 'abc' AND Type = 'global'

CQL

Note: Filtering with CQL has the highest priority and all the other filters except "Excerpt" will be ignored when CQL filter is present in the query.

SELECT * FROM Spaces WHERE CQL = 'type = space AND space.title~"Driver Development"' AND Excerpt = 'indexed'

Columns

Name	Type	ReadOnly	References	SupportedOperators	Description
Id	String	True			Id of the space.
Key [KEY]	String	False		=,!=,IN,NOT_IN	Unique key of the space.
Name	String	False		=,!=	Name of the space.
IconPath	String	True			Path of the space icon.
IconWidth	Integer	True			Width of the space icon.
IconHeight	Integer	True			Height of the space icon.
IsIconDefault	Boolean	True			Indicator if the icon is default.
Excerpt	String	True			Excerpt of the space.
Type	String	False		=,!=,IN,NOT_IN	Type of the space.
Url	String	True			Url of the space.
LastModified	Datetime	True			Last modified datetime.
ItemURL	String	True			The URL reference of the element in UI.
Description	String	False			Description of the space.
CreatedDate	Datetime	True		=,>,>=,<,<=	Datetime for the creation of the content.
Alias	String	False			Identifier for the space in confluence page URLs.
Status	String	False			Status of the space.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
CQL	String	CQL (Confluence Query Language) allows you to build structured queries.

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

Confluence Connector for CData Sync Views

Name	Description
AllUsers	Returns a complete list of all registered users in the Confluence instance, including both active and disabled accounts. This view is only available for server deployments.
AuditRecords	Provides a paginated list of audit records detailing user and system activities performed since a specified time period.
Comments	Returns information about comments made on pages, blog posts, or other content, including author details and timestamps.
Contributors	Lists the users who have contributed to a specific page or space, providing insight into collaboration and content ownership.
GroupMembers	Retrieves all users belonging to a specified group, including their display names and account details.
GroupsContentRestrictions	Retrieves restrictions applied to specific content items that limit access to certain user groups. Requires ContentId and supports up to 200 restrictions per operation.
Labels	Returns the labels associated with a specific piece of content, helping categorize and organize information within Confluence.
PageAncestors	Displays the parent hierarchy of a page, showing how the current page is positioned within the overall content structure.
PageChildren	Displays the child hierarchy of a page, showing which subpages are nested under a given parent page.
PageComments	Retrieves all comments made on a particular page, including text content, authors, and creation dates.
PageContents	Provides access to the textual and metadata content of a Confluence page, including version and author information.
SpacePermissions	Returns detailed permission settings for one or more spaces, specifying which users and groups have access or administrative rights.
Tasks	Provides information on tasks assigned or created within Confluence, including assignees, due dates, and completion status.
Users	Returns details for a specific user, such as username, display name, email address, and account status.
UsersContentRestrictions	Retrieves restrictions applied to specific content that limit access for individual users. Requires ContentId and supports up to 200 restrictions per operation.
ViewersAnalytics	Shows analytics data on unique viewers of a specific content item, helping track audience engagement.
ViewsAnalytics	Shows analytics data on total views of a specific content item, including repeated visits by the same user.
Whiteboards	Retrieves details about collaborative whiteboards created within Confluence, including titles, owners, and associated spaces.

Returns a complete list of all registered users in the Confluence instance, including both active and disabled accounts. This view is only available for server deployments.

View-Specific Information

Select

The Sync App uses the Confluence API to process WHERE clause conditions built with the following column and operator:

• UserKey supports the = operator.

For example, the following query is processed server-side:

SELECT * FROM AllUsers WHERE UserKey = '1234567890abcdef'

The Sync App processes other filters client-side.

Note: This view is only available for Confluence Server deployments. Queries against this view fail in Confluence Cloud.

Columns

Name	Type	References	SupportedOperators	Description
UserKey [KEY]	String		=	Unique identifier that distinguishes each user within the Confluence instance. Used to reference the user across related tables and views.
UserName	String			The username associated with the user account, typically used for login and identification purposes.
Status	String			Indicates whether the user account is active, disabled, or pending activation.
Type	String			Specifies the user account type, such as internal or external, depending on how the user was created or synchronized.
ProfilePicturePath	String			The file path or URL that points to the user's profile picture stored in Confluence.
ProfilePictureWidth	Integer			The width, in pixels, of the user's profile picture.
ProfilePictureHeight	Integer			The height, in pixels, of the user's profile picture.
IsDefaultPicture	Boolean			If the value is 'true', the profile picture has never been changed and remains the system default. If the value is 'false', the user has uploaded a custom image.
DisplayName	String			The display name shown for the user throughout Confluence, such as in comments, mentions, or activity feeds.

Provides a paginated list of audit records detailing user and system activities performed since a specified time period.

View-Specific Information

Select

The Sync App uses the Confluence API to process WHERE clause conditions built with the following columns and operator:

• SearchString supports the = operator.
• StartDate supports the = operator.
• EndDate supports the = operator.

For example, the following queries are processed server-side:

SELECT * FROM AuditRecords WHERE SearchString = 'your search string'

SELECT * FROM AuditRecords WHERE StartDate = '2019-08-12'

SELECT * FROM AuditRecords WHERE EndDate = '2019-08-15'

The Sync App processes other filters client-side.

Note: This view requires a Confluence Standard or Premium subscription. Queries against this view fail on the Free subscription.

Columns

Name	Type	References	SupportedOperators	Description
AffectedObjectName	String			The name of the Confluence object that was modified during the audited action, such as a page, space, or attachment.
AffectedObjectType	String			Specifies the type of object affected by the change, such as page, comment, or configuration item.
AuthorDisplayName	String			The display name of the user who performed the action recorded in the audit log.
AuthorType	String			Indicates the type of account that executed the action, such as internal user, external user, or automated system.
UserKey	String			The unique key that identifies the user who initiated the audited action within Confluence.
UserName	String			The username of the user responsible for the audited event.
Category	String			Defines the functional category of the audited event, such as content management, permissions, or configuration.
CreationDate	Datetime			The date and time when the audited event occurred and was recorded in the system.
Description	String			A detailed description of the change or event, providing context for what was modified or triggered.
RemoteAddress	String			The IP address or network origin from which the action was performed.
Summary	String			A concise summary of the audit event, highlighting the main change or activity.
IsSysAdmin	Boolean			If the value is 'true', the action was performed by a system administrator. If the value is 'false', it was performed by a standard user.
SearchString	String		=	The search term or keyword entered by the user when querying audit records or related data.
StartDate	Datetime		=	The beginning timestamp that defines the start of the audit period for retrieved records.
EndDate	Datetime		=	The ending timestamp that defines the end of the audit period for retrieved records.

Returns information about comments made on pages, blog posts, or other content, including author details and timestamps.

Table Specific Information

Select

The Sync App uses the Confluence API to process WHERE clause conditions built with the following columns and operators. Conditions that use other supported operators are processed client-side by the Sync App. You can also search for Attachments using CQL (Confluence Query Language).

• Id supports the '=,!=,IN,NOT IN' comparisons.
• Type supports the '=,!=,IN,NOT IN' comparisons.
• Title supports the '=,!=,LIKE,NOT LIKE,IN,NOT IN' comparisons.
  Note: Only LIKE and NOT LIKE comparisons on Title are processed server-side, while all other operators (=,!=,IN,NOT IN) are processed on the client-side.
• SpaceKey supports the '=,!=,IN,NOT IN' comparisons.
• SpaceType supports the '=,!=,IN,NOT IN' comparisons.
• CreatedByUserName supports the '=,!=,IN,NOT IN' comparisons.
• CreatedDate supports the '=,!=,>,>=,<,<=' comparisons.
• LastUpdatedDatetime supports the '=,!=,>,>=,<,<=' comparisons.

For example, the following queries are processed server side:

SQL

SELECT * FROM Comments WHERE Id = '1234'

SELECT * FROM Comments WHERE Id IN ('1234', '2345')

SELECT * FROM Comments WHERE Id = '294922' OR Type = 'comment'

SELECT * FROM Comments WHERE CreatedDate <= '2019/03/29 15:00' AND Id IN ('1234', '2345')

Additionally Id, Type, Title, CreatedDate, CreatedByUserName, AND LastUpdatedDatetime columns can be used in the ORDER BY clause, as following:

SELECT * FROM Comments ORDER BY Id DESC

SELECT * FROM Comments ORDER BY CreatedByUserName ASC

CQL

Note: Filtering with CQL has the highest priority and all the other filters except "Excerpt" will be ignored when CQL filter is present in the query.

SELECT * FROM Comments WHERE CQL = 'creator = currentUser() AND content = "1234" OR space.type = "global"'

Columns

Name	Type	References	SupportedOperators	Description
Id [KEY]	String		=,!=,IN,NOT_IN	Unique identifier of the comment within Confluence. Used to reference the comment in related tables or operations.
Type	String		=,!=,IN,NOT_IN	Specifies the content type, indicating that this record represents a comment.
Title	String			The title or short reference for the comment, which may appear as the first line of text or a system-generated identifier.
Status	String			Indicates the current state of the comment, such as active, deleted, or archived.
SpaceKey	String	Spaces.Key	=,!=,IN,NOT_IN	The unique key of the space that contains the content to which the comment belongs.
SpaceType	String	Spaces.Type	=,!=,IN,NOT_IN	Specifies the type of space where the comment was made, such as global, personal, or team space.
Position	String			Defines the comment's position within the discussion thread or its relationship to the parent content.
URL	String			The full URL that provides direct access to the comment within the Confluence interface or API.
Excerpt	String			A short snippet of the comment's text content, used for previews or summaries.
IsLatest	Boolean			If the value is 'true', this comment represents the latest version of the text. If the value is 'false', it refers to an earlier revision.
CreatedByUserName	String		=,!=,IN,NOT_IN	The username of the user who originally posted the comment.
CreatedByUserType	String			Specifies the type of user who created the comment, such as internal user, external collaborator, or system account.
CreatedDate	Datetime		=,>,>=,<,<=	The date and time when the comment was first posted.
LastUpdatedDatetime	Datetime		=,>,>=,<,<=	The date and time when the comment was most recently edited.
LastUpdatedMessage	String			The revision note or message entered by the user when updating the comment.
LastUpdatedNumber	Integer			The version number corresponding to the latest update of the comment.
LastUpdatedUserName	String			The username of the user who performed the most recent update on the comment.
LastUpdatedUserType	String			Indicates the type of user who made the latest update, such as internal, external, or automated.
LastUpdatedIsMinorEdit	Boolean			If the value is 'true', the last modification was a minor edit that did not significantly change the content. If the value is 'false', it was a major edit.
LastUpdatedIsHidden	Boolean			If the value is 'true', the most recent version of the comment is hidden from regular users. If the value is 'false', it is visible.
PreviousVersionUserName	String			The username of the user who created or edited the previous version of the comment.
PreviousVersionUserType	String			Specifies the type of user who updated the previous version, such as internal user or automated process.
PreviousVersionDatetime	Datetime			The date and time when the previous version of the comment was modified.
PreviousVersionMessage	String			The user's revision note or message associated with the previous version of the comment.
PreviousVersionNumber	String			The version number assigned to the previous iteration of the comment.
PreviousVersionIsMinorEdit	Boolean			If the value is 'true', the previous version was marked as a minor edit. If the value is 'false', it represented a major revision.
PreviousVersionIsHidden	Boolean			If the value is 'true', the previous version of the comment is hidden from visibility. If the value is 'false', it remains visible.
LinksEditui	String			The URL of the edit interface (EditUI) for the comment, allowing users to modify or reply within the Confluence editor.
LinksSelf	String			The self-referential API endpoint (Self link) for the comment, used for programmatic retrieval.
LinksTinyui	String			The short link (TinyUI) URL of the comment, providing a concise version for quick sharing.
LinksWebui	String			The standard web interface URL (WebUI) of the comment as viewed within Confluence.
ItemURL	String			The complete URL reference to the comment as displayed in the user interface.
ContainerId	String			The unique identifier of the container, such as the page or blog post, that the comment belongs to.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
CQL	String		Represents a Confluence Query Language (CQL) expression used to construct structured queries for retrieving or filtering comments.

Lists the users who have contributed to a specific page or space, providing insight into collaboration and content ownership.

View-Specific Information

Select

The Sync App uses the Confluence API to process WHERE clause conditions that are built with the following columns and operators:

• ContentId supports the =, !=, IN, NOT IN operators.
• AccountId supports the =, IN operators.
• ContentType supports the =, !=, IN, NOT IN operators.

For example, the following queries are processed server-side:

SELECT * FROM Contributors WHERE ContentId = '1234'

SELECT * FROM Contributors WHERE ContentId != '1234'

SELECT * FROM Contributors WHERE ContentId IN ('1234', '2345')

SELECT * FROM Contributors WHERE ContentId NOT IN ('1234', '2345')

SELECT * FROM Contributors WHERE AccountId = '12345678'

SELECT * FROM Contributors WHERE AccountId IN ('12345678', '23456789')

SELECT * FROM Contributors WHERE ContentType = 'page'

SELECT * FROM Contributors WHERE ContentType != 'page'

SELECT * FROM Contributors WHERE ContentType IN ('page', 'attachment')

SELECT * FROM Contributors WHERE ContentType NOT IN ('page', 'attachment')

The ContentId column can also be used in the ORDER BY clause. For example:

SELECT * FROM Contributors ORDER BY ContentId DESC

The Sync App processes other filters client-side.

Note: To query the Contributors view, you must specify either ContentId, AccountId, or ContentType.

Columns

Name	Type	References	SupportedOperators	Description
ContentId [KEY]	String		=,!=,IN,NOT_IN	The unique identifier of the content item that supports contributions, such as a page, blog post, comment, or attachment. This value corresponds to the 'Id' field in related tables like Attachments, Pages, Comments, or Blogposts.
ContentType	String		=,!=,IN,NOT_IN	Specifies the type of content to which the contributor has added input, for example page, comment, or blog post.
UserType	String			Indicates the type of user who contributed, such as internal user, external collaborator, or system account.
AccountId [KEY]	String		=,IN	The unique account identifier of the contributor, used to link the user to their contributions across Confluence content.

Retrieves all users belonging to a specified group, including their display names and account details.

Table Specific Information

Select

The Sync App will use the Confluence API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

• Name supports the '=' comparisons.

For example, the following queries are processed server side:

SELECT * FROM GroupMembers WHERE Name = 'test1'

Columns

Name	Type	References	SupportedOperators	Description
AccountId	String			The unique account identifier of the user who is a member of the group.
AccountType	String			Specifies the type of user account, such as internal, external, or system.
DisplayName	String			The display name of the user as it appears in Confluence: in mentions, comments, or activity feeds.
Email	String			The email address associated with the user's Confluence account.
PublicName	String			The public name or nickname of the user, shown in areas where privacy settings restrict full display names.
ProfilePicturePath	String			The file path or URL that points to the user's profile picture within Confluence.
ProfilePictureWidth	Int			The width, in pixels, of the user's profile picture.
ProfilePictureHeight	Int			The height, in pixels, of the user's profile picture.
ProfilePictureIsDefault	Boolean			If the value is 'true', the profile picture is the default system image and has not been changed by the user. If the value is 'false', the user has uploaded a custom profile picture.
Operations	String			Describes available operations and the target entities they apply to, indicating possible actions for the user within the group context.
Type	String			Defines the type of user, such as standard user, administrator, or external collaborator.
GroupId	String		=	The unique identifier of the Confluence group that the user belongs to.
Name	String		=	The name of the group to which these members are assigned.

Retrieves restrictions applied to specific content items that limit access to certain user groups. Requires ContentId and supports up to 200 restrictions per operation.

View-Specific Information

Select

The Sync App uses the Confluence API to process WHERE clause conditions built with the following column and operator:

• ContentId supports the = operator.

For example, the following query is processed server-side:

SELECT * FROM GroupsContentRestrictions WHERE ContentId = '123456789'

Note: ContentId must be included in the WHERE clause to retrieve data from the GroupsContentRestrictions view.

The Sync App processes other filters client-side.

Columns

Name	Type	References	SupportedOperators	Description
Operation	String			Specifies the type of operation that the restriction governs, such as read or update access.
Name	String			The name of the group to which the content restriction applies, defining which members are affected.
Type	String			Indicates the type of group, such as internal or external, based on how it is managed or synchronized.
ContentId	String		=	The unique identifier of the content item (such as a page or blog post) where the restriction is applied.

Returns the labels associated with a specific piece of content, helping categorize and organize information within Confluence.

View-Specific Information

Select

The Sync App uses the Confluence API to process WHERE clause conditions built with the following columns and operators:

• ContentId supports the =, !=, IN, NOT IN operators.
• LabelName supports the =, IN operators.
• ContentType supports the =, !=, IN, NOT IN operators.

For example, the following queries are processed server-side:

SELECT * FROM Labels WHERE ContentId = '1234'

SELECT * FROM Labels WHERE ContentId != '1234'

SELECT * FROM Labels WHERE ContentId IN ('1234', '2345')

SELECT * FROM Labels WHERE ContentId NOT IN ('1234', '2345')

SELECT * FROM Labels WHERE LabelName = 'test'

SELECT * FROM Labels WHERE LabelName IN ('test1', 'test2')

SELECT * FROM Labels WHERE ContentType = 'page'

SELECT * FROM Labels WHERE ContentType != 'page'

SELECT * FROM Labels WHERE ContentType IN ('page', 'attachment')

SELECT * FROM Labels WHERE ContentType NOT IN ('page', 'attachment')

The ContentId column can be used in the ORDER BY clause. For example:

SELECT * FROM Labels ORDER BY ContentId DESC

Note: At least one of the following must be included in the WHERE clause to retrieve data from the Labels view: ContentId, LabelName, or ContentType.

The Sync App processes other filters client-side.

Columns

Name	Type	References	SupportedOperators	Description
ContentId [KEY]	String		=,!=,IN,NOT_IN	The unique identifier of the content item that supports labels, such as a page, attachment, or blog post. This value corresponds to the 'Id' field in related tables like Attachments, Pages, or Blogposts.
ContentType	String		=,!=,IN,NOT_IN	Specifies the type of content associated with the label, such as page, attachment, or blog post.
LabelId [KEY]	String			The unique identifier of the label assigned to the content.
LabelName	String		=,IN	The name of the label applied to the content, used for categorization and search filtering.
LabelPrefix	String			Defines the prefix associated with the label, which indicates its scope or origin, such as global or team-specific.

Displays the parent hierarchy of a page, showing how the current page is positioned within the overall content structure.

Table Specific Information

Select

The Sync App will use the Confluence API to process WHERE clause conditions built with the following column and operator.

Note: PageId is required in order to query the PageAncestors view.

• PageId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM PageAncestors WHERE PageId = '33106'
SELECT * FROM PageAncestors WHERE PageId IN ('163902', '33106')

Columns

Name	Type	References	SupportedOperators	Description
Id [KEY]	String			The unique identifier of the ancestor page within the Confluence hierarchy.
ExpandableAncestors	String			Provides a reference to additional ancestor pages that can be expanded to view the full hierarchy above the current page.
ExpandableBody	String			Links to the expandable section containing the page's body content, allowing access to detailed text data when requested.
ExpandableChildren	String			Links to the expandable section listing the direct child pages of the ancestor, enabling traversal down the hierarchy.
ExpandableChildTypes	String			Specifies the available types of child content that can be expanded under the ancestor page, such as page or comment.
ExpandableContainer	String			Provides a reference to the container element, such as a space, that holds the ancestor page.
ExpandableDescendants	String			Links to a list of all descendant pages that can be expanded from this ancestor, showing the entire subpage structure.
ExpandableHistory	String			Links to historical data about the ancestor page, including previous versions and edits.
ExpandableMetadata	String			Links to the expandable section containing metadata for the ancestor page, such as labels and properties.
ExpandableOperations	String			Lists available operations that can be performed on the ancestor page, such as view or edit.
ExpandableRestrictions	String			Links to the access restrictions applied to the ancestor page, including view and edit permissions.
ExpandableSchedulePublishDate	Datetime			Specifies the scheduled date and time when the ancestor page is set to be published, if applicable.
ExpandableSpace	String			Provides a link to the space that contains the ancestor page, allowing retrieval of related space information.
ExpandableVersion	String			Links to version details of the ancestor page, including version number and author information.
LinksEditui	String			The URL of the edit interface (EditUI) for the ancestor page, allowing users to modify its content.
LinksSelf	String			The self-referential API link (Self link) for the ancestor page, used to retrieve its data programmatically.
LinksTinyui	String			The short link (TinyUI) version of the ancestor page's URL, providing a compact link for easy sharing.
LinksWebui	String			The standard web interface URL (WebUI) of the ancestor page, used for navigation in Confluence.
ExtensionsPosition	String			Indicates the page's position within its parent hierarchy, defining its placement order among sibling pages.
Status	String			Indicates the publication status of the ancestor page, such as current, draft, or archived.
Title	String			The title of the ancestor page as displayed in Confluence.
Type	String			Specifies the content type, indicating that this record represents a page ancestor.
PageId [KEY]	String	Pages.Id	=,!=,IN,NOT_IN	The unique identifier of the current page whose ancestor information is being retrieved.

Displays the child hierarchy of a page, showing which subpages are nested under a given parent page.

Columns

Name	Type	References	SupportedOperators	Description
Id [KEY]	String			The unique identifier of the child page within the Confluence hierarchy.
ExpandableAncestors	String			Provides a link to the expandable list of ancestor pages for the child, showing its position in the overall hierarchy.
ExpandableBody	String			Links to the expandable section containing the full body content of the child page, available when explicitly requested.
ExpandableChildren	String			Links to additional nested child pages under this page, allowing deeper traversal through the hierarchy.
ExpandableChildTypes	String			Specifies the available content types that can exist as children of this page, such as page or comment.
ExpandableContainer	String			Provides a link to the container that holds this child page, typically its parent page or associated space.
ExpandableDescendants	String			Links to the list of all descendant pages that can be expanded under this child, showing its complete subpage structure.
ExpandableHistory	String			Links to the historical versions of the child page, including revision data and previous authors.
ExpandableMetadata	String			Links to the expandable section containing metadata for the child page, such as labels and custom properties.
ExpandableOperations	String			Lists the available operations that can be performed on the child page, such as view, edit, or delete.
ExpandableRestrictions	String			Links to the restrictions that define who can view or edit the child page.
ExpandableSchedulePublishDate	Datetime			Specifies the date and time when the child page is scheduled to be published, if applicable.
ExpandableSpace	String			Provides a link to the space in which the child page resides, enabling retrieval of related space information.
ExpandableVersion	String			Links to the version details of the child page, including the version number and author metadata.
LinksEditui	String			The URL of the edit interface (EditUI) for the child page, allowing direct editing in Confluence.
LinksSelf	String			The self-referential API endpoint (Self link) for the child page, used for programmatic access.
LinksTinyui	String			The short link (TinyUI) version of the child page's URL, providing a compact format for easy sharing.
LinksWebui	String			The standard web interface URL (WebUI) for the child page as viewed within Confluence.
ExtensionsPosition	String			Indicates the position of the child page within its parent's hierarchy, defining its order among sibling pages.
Status	String			Indicates the publication status of the child page, such as current, draft, or archived.
Title	String			The title of the child page as displayed in Confluence.
Type	String			Specifies the content type, indicating that this record represents a child page.
PageId	String	Pages.Id	=,!=,IN,NOT IN	The unique identifier of the current page whose child pages are being retrieved.

Retrieves all comments made on a particular page, including text content, authors, and creation dates.

Table Specific Information

Select

The Sync App will use the Confluence API to process WHERE clause conditions built with the following column and operator.

Note: PageId is required in order to query the PageComments view.

• PageId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM PageComments WHERE PageId = '163902' 
SELECT * FROM PageComments WHERE PageId IN ('163902', '33106')

Columns

Name	Type	References	SupportedOperators	Description
Id [KEY]	String			The unique identifier of the comment associated with the specified page.
ExpandableAncestors	String			Provides a link to ancestor elements in the hierarchy, such as the parent page or higher-level comments.
ExpandableChildren	String			Links to any nested replies or child comments related to the current comment.
ExpandableContainer	String			Provides a reference to the container element, typically the page that holds this comment.
ExpandableDescendants	String			Links to all descendant comments that can be expanded under this comment, displaying the full discussion thread.
ExpandableHistory	String			Links to the revision history of the comment, showing previous edits and versions.
ExpandableMetadata	String			Links to the expandable metadata for the comment, such as labels, properties, or custom fields.
ExpandableOperations	String			Lists the operations that can be performed on the comment, such as edit, delete, or reply.
ExpandableRestrictions	String			Links to the access restrictions applied to the comment, specifying who can view or edit it.
ExpandableSpace	String			Provides a link to the space in which the comment's parent page is located.
ExpandableVersion	String			Links to version information for the comment, including details about the latest edit and author.
LinksSelf	String			The self-referential API endpoint (Self link) for the comment, used to retrieve its data programmatically.
LinksWebui	String			The standard web interface URL (WebUI) for the comment as viewed in the Confluence page.
BodyExpandableAnonymousExportView	String			Provides access to the anonymous export view of the comment body, which can be expanded to show public exportable content.
BodyExpandableEditor	String			Links to the editor view of the comment body, allowing access to the content in an editable format.
BodyExpandableExportView	String			Provides a link to the export view representation of the comment body, used when exporting or rendering content externally.
BodyExpandableStorage	String			Links to the storage representation of the comment body, which contains the raw data in Confluence Storage Format.
BodyExpandableStyledView	String			Provides access to the styled view of the comment body, showing formatted content as rendered in the Confluence interface.
BodyViewExpandableContent	String			Links to the view representation of the comment's main content, used for display purposes.
BodyViewExpandableWebresource	String			Links to associated web resources, such as embedded media or macros, included in the comment body.
BodyViewRepresentation	String			Specifies the current representation type of the comment body, such as view or storage.
BodyViewValue	String			Contains the actual text content of the comment in its rendered form.
ExtensionsExpandableResolution	String			Provides a link to additional resolution-related extensions, such as comment status or resolution metadata.
ExtensionsLocation	String			Indicates the location context of the comment within the page, such as inline or section-based placement.
Status	String			Indicates the current status of the comment, such as active, resolved, or deleted.
Title	String			The title or first line of the comment, often used as a summary or identifier in lists.
Type	String			Specifies the content type, indicating that this record represents a comment.
PageId	String	Pages.Id	=,!=,IN,NOT_IN	The unique identifier of the page that contains this comment.

Provides access to the textual and metadata content of a Confluence page, including version and author information.

Table Specific Information

Select

The Sync App will use the Confluence API to process WHERE clause conditions built with the following column and operator.

Note: PageId is required in order to query the PageContents view.

• PageId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM PageContents WHERE PageId = '163902'
SELECT * FROM PageContents WHERE PageId IN ('163902', '33106')

Columns

Name	Type	References	SupportedOperators	Description
Id [KEY]	String			The unique identifier of the page content within Confluence.
ExpandableAncestors	String			Provides a link to the expandable list of ancestor pages, allowing retrieval of hierarchical context above the current page.
ExpandableChildren	String			Links to child content items associated with the page, such as subpages or embedded components.
ExpandableChildTypes	String			Specifies the types of child content that can exist under this page, for example page, comment, or attachment.
ExpandableContainer	String			Provides a link to the container element that holds this page, typically a space or parent page.
ExpandableDescendants	String			Links to all descendant content items that can be expanded from this page, showing the complete hierarchy below it.
ExpandableHistory	String			Links to the historical versions of the page, allowing retrieval of revision data, authors, and timestamps.
ExpandableMetadata	String			Links to the expandable metadata section, which includes labels, properties, and other contextual information.
ExpandableOperations	String			Lists available operations that can be performed on the page, such as view, edit, or delete.
ExpandableRestrictions	String			Links to the access restrictions applied to the page, defining user and group permissions.
ExpandableSchedulePublishDate	Datetime			Specifies the date and time when the page is scheduled for publication, if applicable.
ExpandableSpace	String			Provides a link to the space containing the page, allowing retrieval of related space-level details.
ExpandableVersion	String			Links to version information for the page, including version numbers, authors, and modification data.
LinksBase	String			The base API URL used as a reference point for the page's linked resources.
LinksCollection	String			Provides a link to the collection of related content items, such as pages within the same space.
LinksContext	String			Defines the contextual relationship of the page within Confluence, including references to its environment or parent container.
LinksEditui	String			The URL of the edit interface (EditUI) for the page, allowing direct access to the page editor.
LinksSelf	String			The self-referential API endpoint (Self link) for the page, used for direct retrieval via the Confluence API.
LinksTinyui	String			The short link (TinyUI) version of the page's URL, providing a compact, shareable format.
LinksWebui	String			The standard web interface URL (WebUI) of the page as accessed through the Confluence site.
BodyExpandableAnonymousExportView	String			Provides access to the anonymous export view of the page body, allowing public export without authentication.
BodyExpandableAtlasDocFormat	String			Links to the Atlas Document Format (ADF) representation of the page body, used for rich text and structured data rendering.
BodyExpandableDynamic	String			Provides a link to dynamically rendered sections of the page body, allowing runtime expansion of embedded content.
BodyExpandableEditor	String			Links to the editable representation of the page body as used in the Confluence editor.
BodyExpandableEditor2	String			Provides a link to an alternate editor format of the page body, typically used for newer Confluence editor versions.
BodyExpandableExportView	String			Links to the export view of the page body, suitable for use in external formats or exports.
BodyExpandableStyledView	String			Provides access to the styled view of the page body, displaying formatted content as seen in the Confluence UI.
BodyExpandableView	String			Links to the view representation of the page body used for display in standard Confluence views.
BodyStorageExpandableContent	String			Provides access to the underlying storage content of the page body, including macros and embedded objects.
BodyStorageEmbeddedContent	String			Links to any embedded resources or files within the page's storage format.
BodyStorageRepresentation	String			Specifies the format used to represent the page body in storage, such as storage or view.
BodyStorageValue	String			Contains the actual content of the page body in Confluence Storage Format, including rich text and markup.
ExtensionsPosition	String			Indicates the position of the page within its parent hierarchy, defining its order among sibling content.
Status	String			Indicates the current status of the page, such as current, draft, or archived.
Title	String			The title of the page as displayed in Confluence.
Type	String			Specifies the content type, indicating that this record represents a page.
PageId	String	Pages.Id	=,!=,IN,NOT_IN	The unique identifier of the page whose content is being retrieved.

Returns detailed permission settings for one or more spaces, specifying which users and groups have access or administrative rights.

View-Specific Information

Select

The Sync App uses the Confluence API to process WHERE clause conditions built with the following column and operator:

• SpaceId supports the = operator.

For example, the following query is processed server-side:

SELECT * FROM SpacePermissions WHERE SpaceId = '123456789'

Note: SpaceId must be included in the WHERE clause to retrieve any data from the SpacePermissions view.

The Sync App processes other filters client-side.

Columns

Name	Type	References	SupportedOperators	Description
Id [KEY]	String			The unique identifier of the space permission record within Confluence.
OperationKey	String			Specifies the type of operation the permission applies to, such as view, edit, delete, or administer.
OperationTargetType	String			Indicates the type of entity that the operation targets, such as space, page, or content.
PrincipalId	String			The unique identifier of the user or group to whom the permission applies.
PrincipalType	String			Specifies whether the permission applies to a user, a group, or an anonymous role.
SpaceId	String	Spaces.Id	=	The unique identifier of the space to which this permission record belongs.

Provides information on tasks assigned or created within Confluence, including assignees, due dates, and completion status.

Columns

Name	Type	References	SupportedOperators	Description
Id [KEY]	String		=	The unique identifier of the task within Confluence.
AssignedTo	String		=	The account ID of the user to whom the task is currently assigned.
AtlasDoc	String			Contains the task content in Atlas Document Format (ADF), used for structured text and formatting within Confluence.
BlogPostId	String		=	The identifier of the blog post associated with the task, if the task is linked to one.
CompletedAt	Datetime			The date and time when the task was marked as completed.
CompletedBy	String		=	The account ID of the user who completed the task.
CreatedAt	Datetime			The date and time when the task was initially created.
CreatedBy	String		=	The account ID of the user who created the task.
DueAt	Datetime			The date and time by which the task is due for completion.
LocalId	String			The local identifier of the task, used for referencing within the context of a specific page or space.
PageId	String		=	The unique identifier of the page associated with the task.
SpaceId	String		=	The unique identifier of the space in which the task resides.
Status	String		=	Indicates the current state of the task, such as open, in progress, or completed.
Storage	String			Contains the body content of the task in Confluence Storage Format, including text and macros.
UpdatedAt	Datetime			The date and time when the task was last modified.

Returns details for a specific user, such as username, display name, email address, and account status.

Table Specific Information

Select

The Sync App will use the Confluence API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App. You can also search for Attachments using CQL (Confluence Query Language).

• AccountId supports the '=,!=,IN,NOT IN' comparisons.
• PublicName supports the 'LIKE' comparisons.

For example, the following queries are processed server side:

SQL

SELECT * FROM Users WHERE AccountId = '1234'

SELECT * FROM Users WHERE AccountId IN ('1234', '2345')

SELECT * FROM Users WHERE PublicName LIKE 'confluence user%'

CQL

Note: Filtering with CQL has the highest priority and all the other filters except "Excerpt" will be ignored when CQL filter is present in the query.

SELECT * FROM Users WHERE CQL = 'user.userKey = "4028d6096b696826016b696960860000" AND type = user' AND UserName = 'currentUser()'

Columns

Name	Type	References	SupportedOperators	Description
AccountId [KEY]	String		=,IN	The unique account identifier of the user. This column is available only for Confluence Cloud.
AccountType	String			Specifies the type of user account, such as standard or external. This column is available only for Confluence Cloud.
PublicName	String		LIKE	The full public name of the user as displayed in Confluence. This column is available only for Confluence Cloud.
Email	String			The email address associated with the user's Confluence account. This column is available only for Confluence Cloud.
UserKey [KEY]	String		=,!=,IN,NOT_IN	The unique key identifying the user in Confluence Server. This column is available only for Confluence Server.
UserName	String		=	The username used for login and identification in Confluence Server. This column is available only for Confluence Server.
Status	String			Indicates the account status of the user, such as active, disabled, or pending. This column is available only for Confluence Server.
Type	String			Specifies the user type, such as internal user, external collaborator, or system account.
Excerpt	String			A short text summary or snippet of information related to the user.
ProfilePicturePath	String			The file path or URL to the user's profile picture.
ProfilePictureWidth	Integer			The width, in pixels, of the user's profile picture.
ProfilePictureHeight	Integer			The height, in pixels, of the user's profile picture.
IsDefaultPicture	Boolean			If the value is 'true', the profile picture has never been changed and remains the default system image. If the value is 'false', the user has uploaded a custom image.
DisplayName	String			The display name of the user as shown throughout Confluence, for example in comments, mentions, and activity streams.
Url	String			The URL to the user's profile page in Confluence.
LastModified	Datetime			The date and time when the user's profile information was last updated.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
CQL	String		Represents a Confluence Query Language (CQL) expression used to build structured queries for retrieving or filtering users.

Retrieves restrictions applied to specific content that limit access for individual users. Requires ContentId and supports up to 200 restrictions per operation.

View-Specific Information

Select

The Sync App uses the Confluence API to process WHERE clause conditions built with the following column and operator:

• ContentId supports the = operator.

For example, the following query is processed server-side:

SELECT * FROM UsersContentRestrictions WHERE ContentId = '123456789'

Note: ContentId must be included in the WHERE clause to retrieve any data from the UsersContentRestrictions view.

The Sync App processes other filters client-side.

Columns

Name	Type	References	SupportedOperators	Description
Operation	String			Specifies the type of operation that the restriction controls, such as read or update access.
UserKey	String			The unique user key identifying the user to whom the restriction applies.
DisplayName	String			The display name of the user who is subject to the restriction.
Username	String			The username of the user associated with the content restriction.
Type	String			Indicates the type of user, such as known, anonymous, or external.
ContentId	String		=	The unique identifier of the content item (such as a page or blog post) where the restriction is applied.

Shows analytics data on unique viewers of a specific content item, helping track audience engagement.

Table Specific Information

Select

The Sync App will use the Confluence API to process WHERE clause conditions built with the following column and operator.

• FromDate supports the '=' comparison.
• ContentId supports the '=,IN' comparisons.

For example, the following queries are processed server side:

SELECT * FROM ViewersAnalytics WHERE FromDate = '2023-01-02'

Columns

Name	Type	References	SupportedOperators	Description
ContentId [KEY]	String		=	The unique identifier of the page or content item for which viewer analytics are recorded.
NumberOfDistinctViewers	String			The total number of unique users who have viewed the content.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
FromDate	Date		Specifies the start date from which viewer activity is counted when retrieving analytics data.

Shows analytics data on total views of a specific content item, including repeated visits by the same user.

Table Specific Information

Select

The Sync App will use the Confluence API to process WHERE clause conditions built with the following column and operator.

• FromDate supports the '=' comparison.
• ContentId supports the '=,IN' comparisons.

For example, the following queries are processed server side:

SELECT * FROM ViewsAnalytics WHERE FromDate = '2023-01-02'

Columns

Name	Type	References	SupportedOperators	Description
ContentId [KEY]	String		=	The unique identifier of the page or content item for which view analytics are recorded.
NumberOfViews	String			The total number of times the content has been viewed, including repeated views by the same user.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
FromDate	Date		Specifies the start date from which view activity is counted when retrieving analytics data.

Retrieves details about collaborative whiteboards created within Confluence, including titles, owners, and associated spaces.

Columns

Name	Type	References	SupportedOperators	Description
Id [KEY]	String		=,!=,IN,NOT_IN	The unique identifier of the whiteboard within Confluence.
Title	String		=,!=,IN,NOT_IN	The title of the whiteboard as displayed in Confluence.
Status	String			Indicates the current status of the whiteboard, such as active, draft, or archived.
SpaceKey	String	Spaces.Key	=,!=,IN,NOT_IN	The unique key of the space that contains the whiteboard.
SpaceType	String	Spaces.Type	=,!=,IN,NOT_IN	Specifies the type of space the whiteboard belongs to, such as global, personal, or team space.
Position	String			Defines the whiteboard's position or order within its parent space or container.
URL	String			The full URL used to access the whiteboard through the Confluence interface or API.
Excerpt	String			A short summary or snippet of the whiteboard content, typically used for previews or search results.
IsLatest	Boolean			If the value is 'true', this record represents the most recent version of the whiteboard. If the value is 'false', it refers to a previous version.
CreatedByUserName	String		=,!=,IN,NOT_IN	The username of the user who originally created the whiteboard.
CreatedByUserType	String			Specifies the type of user who created the whiteboard, such as internal, external, or system account.
CreatedDate	Datetime		=,>,>=,<,<=	The date and time when the whiteboard was created.
LastUpdatedDatetime	Datetime		=,>,>=,<,<=	The date and time when the whiteboard was last modified.
LastUpdatedMessage	String			The revision message or note entered when the whiteboard was last updated.
LastUpdatedNumber	Integer			The version number associated with the most recent update of the whiteboard.
LastUpdatedUserName	String			The username of the user who performed the most recent update.
LastUpdatedUserType	String			Indicates the type of user who made the latest update, such as internal user or automated process.
LastUpdatedIsMinorEdit	Boolean			If the value is 'true', the latest change was a minor edit. If the value is 'false', it represents a major update.
LastUpdatedIsHidden	Boolean			If the value is 'true', the most recent version of the whiteboard is hidden from general visibility. If the value is 'false', it is visible.
PreviousVersionUserName	String			The username of the user who modified the previous version of the whiteboard.
PreviousVersionUserType	String			Specifies the type of user who updated the previous version, such as internal user or system account.
PreviousVersionDatetime	Datetime			The date and time when the previous version of the whiteboard was edited.
PreviousVersionMessage	String			The revision message or comment provided for the previous version.
PreviousVersionNumber	String			The version number assigned to the previous revision of the whiteboard.
PreviousVersionIsMinorEdit	Boolean			If the value is 'true', the previous version was a minor edit. If the value is 'false', it represented a major change.
PreviousVersionIsHidden	Boolean			If the value is 'true', the previous version of the whiteboard is hidden from users. If the value is 'false', it is visible.
LinksEditui	String			The URL of the edit interface (EditUI) for the whiteboard, allowing direct editing in Confluence.
LinksSelf	String			The self-referential API endpoint (Self link) for the whiteboard, used for retrieving its data programmatically.
LinksTinyui	String			The short link (TinyUI) version of the whiteboard's URL, providing a compact format for sharing.
LinksWebui	String			The standard web interface URL (WebUI) of the whiteboard as viewed in Confluence.
ItemURL	String			The complete URL reference to the whiteboard as displayed in the user interface.
ContainerId	String			The unique identifier of the container, such as the page or space, that holds the whiteboard.
AnonymousExportViewBody	String			Contains the whiteboard body in anonymous export view format, allowing public export without authentication.
AtlasDocFormatBody	String			Contains the whiteboard body in Atlas Document Format (ADF), supporting structured and rich content.
BodyViewBody	String			Contains the rendered view representation of the whiteboard content as displayed in Confluence.
DynamicBody	String			Contains the dynamic representation of the whiteboard body, used for interactive or real-time updates.
ExportViewBody	String			Contains the whiteboard body in export view format, suitable for use in external exports.
EditorBody	String			Contains the whiteboard body in the editor format used in the Confluence editor.
Editor2Body	String			Contains the whiteboard body in the Editor2 format, used by newer Confluence editor versions.
StorageBody	String			Contains the whiteboard content in Confluence Storage Format, preserving text, drawings, and formatting.
StyledViewBody	String			Contains the whiteboard body in styled view format, showing the rendered version with formatting and layout.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
CQL	String		Represents a Confluence Query Language (CQL) expression used to build structured queries for retrieving or filtering whiteboards.

Stored procedures are function-like interfaces that extend the functionality of the Sync App beyond simple SELECT/INSERT/UPDATE/DELETE operations with Confluence.

Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Confluence, along with an indication of whether the procedure succeeded or failed.

Confluence Connector for CData Sync Stored Procedures

Name	Description
Search	Executes a global search in Confluence returning contents that match the specified search term.

Downloads an attachment from Confluence by specifying its unique attachment ID.

Input

Name	Type	Required	Description
Id	String	False	The unique identifier of the content item (such as a page or blog post) to which the attachment belongs.
AttachmentId	String	True	The unique identifier of the attachment to be downloaded.
Version	String	False	Specifies the version of the attachment to download. If not provided, the latest version is downloaded by default.
FileLocation	String	False	The absolute or relative path where the downloaded file will be saved.
Overwrite	String	False	If the value is 'true', existing files at the target location will be overwritten. If the value is 'false', the procedure preserves existing files. The default value is 'false'.
Encoding	String	False	Specifies the encoding type used for the file data, defining how the content is read or written. The allowed values are NONE, BASE64. The default value is BASE64.

Result Set Columns

Name	Type	Description
Success	String	If the value is 'true', the download operation completed successfully. If the value is 'false', the operation failed.
FileData	String	If neither FileLocation nor FileStream is specified, this output contains the raw file content, typically in Base64-encoded format.

Gets an authentication token from Confluence.

Input

Name	Type	Required	Description
AuthMode	String	False	Enter either APP or WEB. The type of authentication mode to use. Set to APP to get authentication tokens via a desktop app. Set to WEB to get authentication tokens via a Web app. The default value is APP.
Verifier	String	False	The verifier token returned by Confluence after using the URL obtained with GetOAuthAuthorizationURL. Required for only the Web AuthMode.
Scope	String	False	A comma-separated list of permissions to request from the user. Please check the Confluence API for a list of available permissions.
CallbackUrl	String	False	The URL the user will be redirected to after authorizing your application. This value must match the Redirect URL in the Confluence app settings.
AuthToken	String	False	The request token returned by GetOAuthAuthorizationURL. Required for only the Web AuthMode. Used for OAuth 1.0.
AuthKey	String	False	The request token secret returned by GetOAuthAuthorizationURL. Required for only the Web AuthMode. Used for OAuth 1.0.

Result Set Columns

Name	Type	Description
OAuthAccessToken	String	The access token used for communication with Confluence.
OAuthAccessTokenSecret	String	The access token secret used for communication with Confluence.
OAuthRefreshToken	String	A token that may be used to obtain a new access token.
CloudId	String	The Cloud Id for the Atlassian site that was authorized.
ExpiresIn	String	The remaining lifetime on the access token. A -1 denotes that it will not expire.

Gets the authorization URL that must be opened separately by the user to grant access to your application. Only needed when developing Web apps. You will request the auth token from this URL.

Input

Name	Type	Required	Description
CallbackUrl	String	False	The URL the user will be redirected to after authorizing your application.
Scope	String	False	A comma-separated list of permissions to request from the user. Please check the Confluence API for a list of available permissions.
State	String	False	Indicates any state which may be useful to your application upon receipt of the response. Your application receives the same value it sent, as this parameter makes a round-trip to the Confluence authorization server and back. Uses include redirecting the user to the correct resource in your site, using nonces, and mitigating cross-site request forgery.

Result Set Columns

Name	Type	Description
URL	String	The authorization URL, entered into a Web browser to obtain the verifier token and authorize your app.
AuthToken	String	A token used as input for the GetOAuthAccessToken stored procedure to verify the request and get the access token.
AuthKey	String	A key used as input for the GetOAuthAccessToken stored procedure to verify the request and get the secret key.

Refreshes the OAuth access token used for authentication with Confluence.

Input

Name	Type	Required	Description
OAuthRefreshToken	String	True	Set this to the token value that expired.

Result Set Columns

Name	Type	Description
OAuthAccessToken	String	The authentication token returned from Confluence. This can be used in subsequent calls to other operations for this particular service.
OAuthRefreshToken	String	This is the same as the access token.
ExpiresIn	String	The remaining lifetime on the access token.

Executes a global search in Confluence returning contents that match the specified search term.

Input

Name	Type	Required	Description
SearchTerm	String	True	The keyword or phrase to use when performing a global search.

Result Set Columns

Name	Type	Description
Results	String	The raw JSON response containing the results of the global search, including matching items and their details.

Uploads a new attachment to a specified page in Confluence, linking the file to the target content.

Input

Name	Type	Required	Description
ContentId	String	True	The unique identifier of the content item (such as a page or blog post) to which the attachment will be uploaded.
FileLocation	String	False	The full path, including the file name and extension, of the file to be uploaded.
FileName	String	False	The name of the file to be uploaded. If not specified, the system uses the original file name.
Status	String	False	Specifies the status of the attachment's content container. The allowed values are current, draft.
AllowDuplicates	Boolean	False	If the value is 'true', allows uploading an attachment with a file name that already exists. If the value is 'false', duplicates are not permitted. The default value is 'false'.

Result Set Columns

Name	Type	Description
Success	String	If the value is 'true', the upload operation completed successfully. If the value is 'false', the upload failed.
AttachmentId	String	The unique identifier assigned to the attachment after a successful upload.

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.

For more information on establishing a connection, see Establishing a Connection.

Authentication

---

Property	Description
AuthScheme	Specifies the authentication scheme that the provider uses when connecting to Confluence.
URL	Specifies the base URL of your Confluence site.
User	Specifies the authenticating user's user ID.
Password	Specifies the authenticating user's password.
APIToken	Specifies the API token of the authenticated user.
PAT	Specifies the personal access token used to authenticate the user when the authentication scheme is set to PAT.
Timezone	Specifies the timezone of the Confluence instance so the provider can apply datetime filters correctly and return results in the correct local time.

SSO

---

Property	Description
SSOLoginURL	The identity provider's login URL.
SSOProperties	Additional properties required to connect to the identity provider, formatted as a semicolon-separated list.
SSOExchangeURL	The URL used for consuming the SAML response and exchanging it for service specific credentials.
SSOAppName	App Name used with SSO for IdPs that require it.
SSOAppPassword	App Password used with SSO for IdPs that require it.

OAuth

---

Property	Description
OAuthVersion	Identifies the version of OAuth being used.
OAuthClientId	Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
OAuthClientSecret	Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).
Scope	Specifies the OAuth scopes that provider requests when authenticating with Confluence.
CertificateStore	Specifies the certificate store that provider uses for OAuth 1.0 authentication.
CertificateStorePassword	Specifies the password used to open the certificate store for OAuth 1.0 authentication.
CertificateSubject	Specifies the subject of the certificate used with Confluence Private Application authentication.
CertificateStoreType	Specifies the type of certificate store used with Confluence Private Application authentication.

SSL

---

Property	Description
SSLClientCert	Specifies the TLS/SSL client certificate store for SSL Client Authentication (2-way SSL). This property works in conjunction with other SSL-related properties to establish a secure connection.
SSLClientCertType	Specifies the type of key store containing the TLS/SSL client certificate for SSL Client Authentication. Choose from a variety of key store formats depending on your platform and certificate source.
SSLClientCertPassword	Specifes the password required to access the TLS/SSL client certificate store. Use this property if the selected certificate store type requires a password for access.
SSLClientCertSubject	Specifes the subject of the TLS/SSL client certificate to locate it in the certificate store. Use a comma-separated list of distinguished name fields, such as CN=www.server.com, C=US. The wildcard * selects the first certificate in the store.
SSLServerCert	Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

Firewall

---

Property	Description
FirewallType	Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
FirewallServer	Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
FirewallPort	Specifies the TCP port to be used for a proxy-based firewall.
FirewallUser	Identifies the user ID of the account authenticating to a proxy-based firewall.
FirewallPassword	Specifies the password of the user account authenticating to a proxy-based firewall.

Proxy

---

Property	Description
ProxyAutoDetect	Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
ProxyServer	Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic.
ProxyPort	Identifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client.
ProxyAuthScheme	Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
ProxyUser	Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property.
ProxyPassword	Specifies the password of the user specified in the ProxyUser connection property.
ProxySSLType	Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
ProxyExceptions	Specifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

Logging

---

Property	Description
LogModules	Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.

Schema

---

Property	Description
Location	Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
BrowsableSchemas	Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
Tables	Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
Views	Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .

Miscellaneous

---

Property	Description
FullOrderByPushDown	Specifies whether provider pushes ORDER BY operations on the server-side for datetime columns that only support second-level precision.
IgnoreErrorsOnPagination	Specifies which server errors the provider should ignore when paging through Data Center tables that use client-side pagination.
IncludeArchivedSpaces	Specifies whether provider includes content from archived spaces in query results.
MaxRows	Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
Other	Specifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues.
Pagesize	Specifies the maximum number of records per page the provider returns when requesting data from Confluence.
PseudoColumns	Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
SpaceKey	Specifies the Confluence space key that provider uses to limit results to a single space.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
UserDefinedViews	Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file.

This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.

---

Property	Description
AuthScheme	Specifies the authentication scheme that the provider uses when connecting to Confluence.
URL	Specifies the base URL of your Confluence site.
User	Specifies the authenticating user's user ID.
Password	Specifies the authenticating user's password.
APIToken	Specifies the API token of the authenticated user.
PAT	Specifies the personal access token used to authenticate the user when the authentication scheme is set to PAT.
Timezone	Specifies the timezone of the Confluence instance so the provider can apply datetime filters correctly and return results in the correct local time.

Specifies the authentication scheme that the provider uses when connecting to Confluence.

Remarks

This property determines how Sync App authenticates to Confluence and must match the authentication method supported by your Confluence environment.

Confluence supports the following authentication schemes:

• OAuth: Uses OAuth to authenticate through your Atlassian account.
• Basic: Uses a username and password for Server instances.
• APIToken: Uses a username and API token for Cloud instances.
• Crowdd: Uses Crowd SSO to authenticate through an external identity provider.
• OKTA: Uses OKTA SSO to authenticate through your OKTA tenant.
• PAT: Uses a personal access token for Server instances running Confluence 7.9 or later.

Specifies the base URL of your Confluence site.

Remarks

Set this property to the base URL of your Confluence Cloud or Server site. For example: https://yoursitename.atlassian.net.

The Sync App uses this value to construct API requests and determine the correct Confluence instance for authentication.

This property is required when establishing any connection to Confluence.

Specifies the authenticating user's user ID.

Remarks

The authenticating server requires both User and Password to validate the user's identity.

Specifies the authenticating user's password.

Remarks

The authenticating server requires both User and Password to validate the user's identity.

Specifies the API token of the authenticated user.

Remarks

Set this property to the API token that you generated in your Atlassian account under Security > Create and manage API tokens.

The token is required when you select the APIToken AuthScheme and enables the Sync App to authenticate directly to the Confluence REST API.

The token replaces a traditional password and must belong to the user associated with the connection configuration.

This property is useful when you want a simple, passwordless authentication method that works across Atlassian Cloud services.

Specifies the personal access token used to authenticate the user when the authentication scheme is set to PAT.

Remarks

Set this property to the personal access token generated in your Atlassian account. The token must belong to the user associated with the connection configuration.

PAT authentication is supported for Confluence Server sites that allow token-based access without OAuth or passwords.

PAT values grant the same access as the user who created them, so they should be stored securely and rotated as needed.

This property is useful when you prefer token-based authentication for Server or Data Center deployments that support Personal Access Tokens.

Specifies the timezone of the Confluence instance so the provider can apply datetime filters correctly and return results in the correct local time.

Remarks

Set this property to a standard timezone identifier such as America/New_York. The Sync App uses this value to interpret timestamps and apply datetime filters consistently with your Confluence environment.

For Confluence Server, the site timezone is shown in the System Information section of the administration settings.

For Confluence Cloud, the timezone is defined in your user profile settings and reflects the timezone selected for your account.

This property is useful when the Confluence site operates in a different timezone than the client or when queries depend on accurate time comparisons.

This section provides a complete list of the SSO properties you can configure in the connection string for this provider.

---

Property	Description
SSOLoginURL	The identity provider's login URL.
SSOProperties	Additional properties required to connect to the identity provider, formatted as a semicolon-separated list.
SSOExchangeURL	The URL used for consuming the SAML response and exchanging it for service specific credentials.
SSOAppName	App Name used with SSO for IdPs that require it.
SSOAppPassword	App Password used with SSO for IdPs that require it.

The identity provider's login URL.

Remarks

The identity provider's login URL.

Additional properties required to connect to the identity provider, formatted as a semicolon-separated list.

Remarks

Additional properties required to connect to the identity provider, formatted as a semicolon-separated list.

This is used with the SSOLoginURL.

SSO configuration is discussed further in .

The URL used for consuming the SAML response and exchanging it for service specific credentials.

Remarks

The CData Sync App will use the URL specified here to consume a SAML response and exchange it for service specific credentials. The retrieved credentials are the final piece during the SSO connection that are used to communicate with Confluence.

App Name used with SSO for IdPs that require it.

Remarks

Along with SSOAppPassword, may be be specified to identify and authenticate to your app configured in the SSO IdP. Currently only Crowd supports it.

App Password used with SSO for IdPs that require it.

Remarks

Along with SSOAppName, may be be specified to identify and authenticate to your app configured in the SSO IdP. Currently only Crowd supports it.

This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.

---

Property	Description
OAuthVersion	Identifies the version of OAuth being used.
OAuthClientId	Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
OAuthClientSecret	Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).
Scope	Specifies the OAuth scopes that provider requests when authenticating with Confluence.
CertificateStore	Specifies the certificate store that provider uses for OAuth 1.0 authentication.
CertificateStorePassword	Specifies the password used to open the certificate store for OAuth 1.0 authentication.
CertificateSubject	Specifies the subject of the certificate used with Confluence Private Application authentication.
CertificateStoreType	Specifies the type of certificate store used with Confluence Private Application authentication.

Identifies the version of OAuth being used.

Remarks

Accepted entries are: 1.0,2.0

Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.

Remarks

This property is required in two cases:

• When using a custom OAuth application, such as in web-based authentication flows, service-based authentication, or certificate-based flows that require application registration.
• If the driver does not provide embedded OAuth credentials.

(When the driver provides embedded OAuth credentials, this value may already be provided by the Sync App and thus not require manual entry.)

OAuthClientId is generally used alongside other OAuth-related properties such as OAuthClientSecret and OAuthSettingsLocation when configuring an authenticated connection.

OAuthClientId is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can usually find this value in your identity provider’s application registration settings. Look for a field labeled Client ID, Application ID, or Consumer Key.

While the client ID is not considered a confidential value like a client secret, it is still part of your application's identity and should be handled carefully. Avoid exposing it in public repositories or shared configuration files.

For more information on how this property is used when configuring a connection, see Establishing a Connection.

Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).

Remarks

This property (sometimes called the application secret or consumer secret) is required when using a custom OAuth application in any flow that requires secure client authentication, such as web-based OAuth, service-based connections, or certificate-based authorization flows. It is not required when using an embedded OAuth application.

The client secret is used during the token exchange step of the OAuth flow, when the driver requests an access token from the authorization server. If this value is missing or incorrect, authentication fails with either an invalid_client or an unauthorized_client error.

OAuthClientSecret is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can obtain this value from your identity provider when registering the OAuth application.

Notes:

• This value should be stored securely and never exposed in public repositories, scripts, or unsecured environments.
• Client secrets may also expire after a set period. Be sure to monitor expiration dates and rotate secrets as needed to maintain uninterrupted access.

For more information on how this property is used when configuring a connection, see Establishing a Connection

Specifies the OAuth scopes that provider requests when authenticating with Confluence.

Remarks

Scopes are set to define what kind of access the authenticating user will have; for example, read, read and write, restricted access to sensitive information. System administrators can use scopes to selectively enable access by functionality or security clearance.

When InitiateOAuth is set to GETANDREFRESH, you must use this property if you want to change which scopes are requested.

When InitiateOAuth is set to either REFRESH or OFF, you can change which scopes are requested using either this property or the Scope input.

By default, the Sync App requests all scopes required to access Confluence content and metadata. You can override this behavior by setting a space-separated list of scopes.

If you override the scopes, the OAuth app configured in Atlassian must also include the same scopes to prevent authorization failures.

For Cloud instances, the default scopes are: read:content:confluence read:content-details:confluence read:space-details:confluence read:analytics.content:confluence read:audit-log:confluence read:configuration:confluence read:page:confluence read:blogpost:confluence read:custom-content:confluence read:attachment:confluence read:comment:confluence read:template:confluence read:label:confluence read:content.permission:confluence read:content.property:confluence read:content.restriction:confluence read:content.metadata:confluence read:watcher:confluence read:group:confluence read:inlinetask:confluence read:relation:confluence read:space:confluence read:space.permission:confluence read:space.property:confluence read:space.setting:confluence read:user:confluence offline_access.

For Server instances, the default scopes are: READ WRITE

This property is useful when you want to restrict or customize the permissions granted to your OAuth application.

Specifies the certificate store that provider uses for OAuth 1.0 authentication.

Remarks

This property is only used when OAuthVersion is set to 1.0.

Set this property to the location of the certificate store that contains the client certificate used for OAuth application authentication with Confluence.

The certificate store must include the private key associated with the consumer key configured for your Confluence application link.

This property is useful when you need to authenticate with OAuth using signed requests instead of browser-based OAuth flows.

Specifies the password used to open the certificate store for OAuth 1.0 authentication.

Remarks

This property is only used when OAuthVersion is set to 1.0.

Set this property to the password required to unlock the certificate store that contains the client certificate used for OAuth 1.0 application authentication with Confluence.

This value is only required when the certificate store format enforces password protection.

Use this property when your OAuth 1.0 configuration requires access to a secured certificate store for signing requests.

Specifies the subject of the certificate used with Confluence Private Application authentication.

Remarks

The subject of the client certificate used in Confluence private application authentication.

About the Confluence Client SSL Auth Flow

Confluence private application authentication uses SSL client authentication with digital certificates.

Loading a Certificate

When loading a certificate the subject is used to locate the certificate in the store.

• If an exact match is not found, the store is searched for subjects containing the value of the property.
• If a match is still not found, no certificate is selected.
• The special value "*" picks the first certificate in the certificate store.

Specifying the Subject

The certificate subject is a comma-separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, [email protected]". Common fields and their meanings are displayed below.

Field	Meaning
CN	Common Name. This is commonly a host name like www.server.com.
O	Organization
OU	Organizational Unit
L	Locality
S	State
C	Country
E	Email Address

Note: If a field value contains a comma it must be quoted.

Additional Connection Properties

To specify the private certificate, you need to set CertificateSubject and the following additional properties:

• CertificateStore
• CertificateStoreType
• CertificateStorePassword

Specifies the type of certificate store used with Confluence Private Application authentication.

Remarks

This property is only used when OAuthVersion is set to 1.0.

Set this property to the certificate store format that contains the client certificate used for OAuth 1.0 application authentication with Confluence.

The store type determines how Sync App loads the certificate and private key used to sign OAuth 1.0 requests.

Specifying the Certificate Store Type

The CertificateStoreType property can take one of the following values:

User	For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: This store type is not available in Java.
Machine	For Windows, this specifies that the certificate store is a machine store. Note: This store type is not available in Java.
PFXFile	The certificate store is the name of a PFX (PKCS12) file containing certificates.
PFXBlob	The certificate store is a string (base-64-encoded) representing a certificate store in PFX (PKCS12) format.
JKSFile	The certificate store is the name of a Java key store (JKS) file containing certificates. Note: This store type is only available in Java.
JKSBlob	The certificate store is a string (base-64-encoded) representing a certificate store in Java key store (JKS) format. Note: This store type is only available in Java.
PEMKeyFile	The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
PublicKeyFile	The certificate store is the name of a file that contains a PEM or DER-encoded public key certificate.
PublicKeyBlob	The certificate store is a string (base-64-encoded) that contains a PEM or DER-encoded public key certificate.
SSHPublicKeyBlob	The certificate store is a string (base-64-encoded) that contains an SSH-style public key.
P10BFile	The certificate store is the name of a PKCS10 file containing certificates.
SSHPublicKeyFile	The certificate store is the name of a file that contains an SSH-style public key.
PPKFile	The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
XMLFile	The certificate store is the name of a file that contains a certificate in XML format.
XMLBlob	The certificate store is a string that contains a certificate in XML format.

Related Connection Properties

To specify the private certificate, you may need to set the following properties in addition to CertificateStoreType:

• CertificateStore: Set this to the name of the certificate store. For example, "MY" for a Windows certificate store or the file name of a file store.
• CertificateStorePassword: If the store is password-protected, provide the password here.
• CertificateSubject: Set this to the subject of the certificate. To locate the certificate in the store, the Sync App executes a search based on the specified subject. Refer to the CertificateSubject field for details.

This section provides a complete list of the SSL properties you can configure in the connection string for this provider.

---

Property	Description
SSLClientCert	Specifies the TLS/SSL client certificate store for SSL Client Authentication (2-way SSL). This property works in conjunction with other SSL-related properties to establish a secure connection.
SSLClientCertType	Specifies the type of key store containing the TLS/SSL client certificate for SSL Client Authentication. Choose from a variety of key store formats depending on your platform and certificate source.
SSLClientCertPassword	Specifes the password required to access the TLS/SSL client certificate store. Use this property if the selected certificate store type requires a password for access.
SSLClientCertSubject	Specifes the subject of the TLS/SSL client certificate to locate it in the certificate store. Use a comma-separated list of distinguished name fields, such as CN=www.server.com, C=US. The wildcard * selects the first certificate in the store.
SSLServerCert	Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

Specifies the TLS/SSL client certificate store for SSL Client Authentication (2-way SSL). This property works in conjunction with other SSL-related properties to establish a secure connection.

Remarks

This property specifies the client certificate store for SSL Client Authentication. Use this property alongside SSLClientCertType, which defines the type of the certificate store, and SSLClientCertPassword, which specifies the password for password-protected stores. When SSLClientCert is set and SSLClientCertSubject is configured, the driver searches for a certificate matching the specified subject.

Certificate store designations vary by platform. On Windows, certificate stores are identified by names such as MY (personal certificates), while in Java, the certificate store is typically a file containing certificates and optional private keys.

The following are designations of the most common User and Machine certificate stores in Windows:

MY	A certificate store holding personal certificates with their associated private keys.
CA	Certifying authority certificates.
ROOT	Root certificates.
SPC	Software publisher certificates.

For PFXFile types, set this property to the filename. For PFXBlob types, set this property to the binary contents of the file in PKCS12 format.

Specifies the type of key store containing the TLS/SSL client certificate for SSL Client Authentication. Choose from a variety of key store formats depending on your platform and certificate source.

Remarks

This property determines the format and location of the key store used to provide the client certificate. Supported values include platform-specific and universal key store formats. The available values and their usage are:

USER - default	For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note that this store type is not available in Java.
MACHINE	For Windows, this specifies that the certificate store is a machine store. Note that this store type is not available in Java.
PFXFILE	The certificate store is the name of a PFX (PKCS12) file containing certificates.
PFXBLOB	The certificate store is a string (base-64-encoded) representing a certificate store in PFX (PKCS12) format.
JKSFILE	The certificate store is the name of a Java key store (JKS) file containing certificates. Note that this store type is only available in Java.
JKSBLOB	The certificate store is a string (base-64-encoded) representing a certificate store in JKS format. Note that this store type is only available in Java.
PEMKEY_FILE	The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
PEMKEY_BLOB	The certificate store is a string (base64-encoded) that contains a private key and an optional certificate.
PUBLIC_KEY_FILE	The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
PUBLIC_KEY_BLOB	The certificate store is a string (base-64-encoded) that contains a PEM- or DER-encoded public key certificate.
SSHPUBLIC_KEY_FILE	The certificate store is the name of a file that contains an SSH-style public key.
SSHPUBLIC_KEY_BLOB	The certificate store is a string (base-64-encoded) that contains an SSH-style public key.
P7BFILE	The certificate store is the name of a PKCS7 file containing certificates.
PPKFILE	The certificate store is the name of a file that contains a PuTTY Private Key (PPK).
XMLFILE	The certificate store is the name of a file that contains a certificate in XML format.
XMLBLOB	The certificate store is a string that contains a certificate in XML format.
BCFKSFILE	The certificate store is the name of a file that contains an Bouncy Castle keystore.
BCFKSBLOB	The certificate store is a string (base-64-encoded) that contains a Bouncy Castle keystore.

Specifes the password required to access the TLS/SSL client certificate store. Use this property if the selected certificate store type requires a password for access.

Remarks

This property provides the password needed to open a password-protected certificate store. This property is necessary when using certificate stores that require a password for decryption, as is often recommended for PFX or JKS type stores.

If the certificate store type does not require a password, for example USER or MACHINE on Windows, this property can be left blank. Ensure that the password matches the one associated with the specified certificate store to avoid authentication errors.

Specifes the subject of the TLS/SSL client certificate to locate it in the certificate store. Use a comma-separated list of distinguished name fields, such as CN=www.server.com, C=US. The wildcard * selects the first certificate in the store.

Remarks

This property determines which client certificate to load based on its subject. The Sync App searches for a certificate that exactly matches the specified subject. If no exact match is found, the Sync App looks for certificates containing the value of the subject. If no match is found, no certificate is selected.

The subject should follow the standard format of a comma-separated list of distinguished name fields and values. For example, CN=www.server.com, OU=Test, C=US. Common fields include the following:

Field	Meaning
CN	Common Name. This is commonly a host name like www.server.com.
O	Organization
OU	Organizational Unit
L	Locality
S	State
C	Country
E	Email Address

Note: If any field contains special characters, such as commas, the value must be quoted. For example: CN="Example, Inc.", C=US.

Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

Remarks

If you are using a TLS/SSL connection, use this property to specify the TLS/SSL certificate to be accepted from the server. If you specify a value for this property, all other certificates that are not trusted by the machine are rejected.

This property can take the following forms:

Description	Example
A full PEM Certificate (example shortened for brevity)	-----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
A path to a local file containing the certificate	C:\cert.cer
The public key (example shortened for brevity)	-----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
The MD5 Thumbprint (hex values can also be either space- or colon-separated)	ecadbdda5a1529c58a1e9e09828d70e4
The SHA1 Thumbprint (hex values can also be either space- or colon-separated)	34a929226ae0819f2ec14b4a3d904f801cbb150d

Note: It is possible to use '*' to signify that all certificates should be accepted, but due to security concerns this is not recommended.

This section provides a complete list of the Firewall properties you can configure in the connection string for this provider.

---

Property	Description
FirewallType	Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
FirewallServer	Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
FirewallPort	Specifies the TCP port to be used for a proxy-based firewall.
FirewallUser	Identifies the user ID of the account authenticating to a proxy-based firewall.
FirewallPassword	Specifies the password of the user account authenticating to a proxy-based firewall.

Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Note: By default, the Sync App connects to the system proxy. To disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.

The following table provides port number information for each of the supported protocols.

Protocol	Default Port	Description
TUNNEL	80	The port where the Sync App opens a connection to Confluence. Traffic flows back and forth via the proxy at this location.
SOCKS4	1080	The port where the Sync App opens a connection to Confluence. SOCKS 4 then passes theFirewallUser value to the proxy, which determines whether the connection request should be granted.
SOCKS5	1080	The port where the Sync App sends data to Confluence. If the SOCKS 5 proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes.

To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.

Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Specifies the TCP port to be used for a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Identifies the user ID of the account authenticating to a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Specifies the password of the user account authenticating to a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

This section provides a complete list of the Proxy properties you can configure in the connection string for this provider.

---

Property	Description
ProxyAutoDetect	Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
ProxyServer	Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic.
ProxyPort	Identifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client.
ProxyAuthScheme	Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
ProxyUser	Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property.
ProxyPassword	Specifies the password of the user specified in the ProxyUser connection property.
ProxySSLType	Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
ProxyExceptions	Specifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.

Remarks

When this connection property is set to True, the Sync App checks your system proxy settings for existing proxy server configurations (no need to manually supply proxy server details).

This connection property takes precedence over other proxy settings. If you want to configure the Sync App to connect to a specific proxy server, set ProxyAutoDetect to False.

To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.

Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic.

Remarks

The Sync App only routes HTTP traffic through the proxy server specified in this connection property when ProxyAutoDetect is set to False.

If ProxyAutoDetect is set to True (the default), the Sync App instead routes HTTP traffic through the proxy server specified in your system proxy settings.

Identifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client.

Remarks

The Sync App only routes HTTP traffic through the ProxyServer port specified in this connection property when ProxyAutoDetect is set to False.

If ProxyAutoDetect is set to True (the default), the Sync App instead routes HTTP traffic through the proxy server port specified in your system proxy settings.

For other proxy types, see FirewallType.

Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.

Remarks

Supported authentication types :

• BASIC: The Sync App performs HTTP basic authentication.
• DIGEST: The Sync App performs HTTP digest authentication.
• NTLM: The Sync App retrieves an NTLM token.
• NEGOTIATE: The Sync App retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
• NONE: Signifies that the ProxyServer does not require authentication.

For all values other than NONE, you must also set the ProxyUser and ProxyPassword connection properties.

If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.

Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property.

Remarks

The ProxyUser and ProxyPassword connection properties are used to connect and authenticate against the HTTP proxy specified in ProxyServer.

After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:

ProxyAuthScheme Value	Value to set for ProxyUser
BASIC	The username of a user registered with the proxy server.
DIGEST	The username of a user registered with the proxy server.
NEGOTIATE	The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format user@domain or domain\user.
NTLM	The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format user@domain or domain\user.
NONE	Do not set the ProxyPassword connection property.

Note: The Sync App only uses this username if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True (the default), the Sync App instead uses the username specified in your system proxy settings.

Specifies the password of the user specified in the ProxyUser connection property.

Remarks

The ProxyUser and ProxyPassword connection properties are used to connect and authenticate against the HTTP proxy specified in ProxyServer.

After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:

ProxyAuthScheme Value	Value to set for ProxyPassword
BASIC	The password associated with the proxy server user specified in ProxyUser.
DIGEST	The password associated with the proxy server user specified in ProxyUser.
NEGOTIATE	The password associated with the Windows user account specified in ProxyUser.
NTLM	The password associated with the Windows user account specified in ProxyUser.
NONE	Do not set the ProxyPassword connection property.

For SOCKS 5 authentication or tunneling, see FirewallType.

Note: The Sync App only uses this password if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True (the default), the Sync App instead uses the password specified in your system proxy settings.

Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.

Remarks

This property determines when to use SSL for the connection to the HTTP proxy specified by ProxyServer. You can set this connection property to the following values :

AUTO	Default setting. If ProxyServer is set to an HTTPS URL, the Sync App uses the TUNNEL option. If ProxyServer is set to an HTTP URL, the component uses the NEVER option.
ALWAYS	The connection is always SSL enabled.
NEVER	The connection is not SSL enabled.
TUNNEL	The connection is made through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy.

Specifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

Remarks

The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.

Note: The Sync App uses the system proxy settings by default, without further configuration needed. If you want to explicitly configure proxy exceptions for this connection, set ProxyAutoDetect to False.

This section provides a complete list of the Logging properties you can configure in the connection string for this provider.

---

Property	Description
LogModules	Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.

Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.

Remarks

The Sync App writes details about each operation it performs into the logfile specified by the Logfile connection property.

Each of these logged operations are assigned to a themed category called a module, and each module has a corresponding short code used to labels individual Sync App operations as belonging to that module.

When this connection property is set to a semicolon-separated list of module codes, only operations belonging to the specified modules are written to the logfile. Note that this only affects which operations are logged moving forward and doesn't retroactively alter the existing contents of the logfile. For example: INFO;EXEC;SSL;META;

By default, logged operations from all modules are included.

You can explicitly exclude a module by prefixing it with a "-". For example: -HTTP

To apply filters to submodules, identify them with the syntax <module name>.<submodule name>. For example, the following value causes the Sync App to only log actions belonging to the HTTP module, and further refines it to exclude actions belonging to the Res submodule of the HTTP module: HTTP;-HTTP.Res

Note that the logfile filtering triggered by the Verbosity connection property takes precedence over the filtering imposed by this connection property. This means that operations of a higher verbosity level than the level specified in the Verbosity connection property are not printed in the logfile, even if they belong to one of the modules specified in this connection property.

The available modules and submodules are:

Module Name	Module Description	Submodules
INFO	General Information. Includes the connection string, product version (build number), and initial connection messages.	Connec – Information related to creating or destroying connections. Messag – Generic label for messages pertaining to connections, the connection string, and product version. These messages are typically specific to the Sync App, rather than being received and passed along directly from the service.
EXEC	Query Execution. Includes execution messages for user-written SQL queries, parsed SQL queries, and normalized SQL queries. Success/failure messages for queries and query pages appear here as well.	Messag – Messages pertaining to query execution. These messages are typically specific to the Sync App, rather than being received and passed along directly from the service. Normlz – Query normalization steps. Query normalization is when the product takes the user-submitted query and rewrites the query to get the same results with optimal performance. Origin – This label applies to any messages recording a user's original query (the exact, unaltered, non-normalized query executed by the user). Page – Messages related to query paging. Parsed – Query parsing steps. Parsing is the process of converting the user-submitted query into a standardized format for easier processing.
HTTP	HTTP protocol messages. Includes HTTP requests/responses (including POST messages), as well as Kerberos related messages.	KERB – HTTP requests related to Kerberos. Messag – Messages pertaining to HTTP protocols. These messages are typically specific to the Sync App, rather than being received and passed along directly from the service. Unpack – This label applies to messages about zipped data being returned from the service API and unpacked by the product. Res – Messages containing HTTP responses. Req – Messages containing HTTP requests.
WSDL	Messages pertaining to the generation of WSDL/XSD files.	—
SSL	SSL certificate messages.	Certif – Messages pertaining to SSL certificates.
AUTH	Authentication related failure/success messages.	Messag – Messages pertaining to authentication. These messages are typically specific to the Sync App, rather than being received and passed along directly from the service. OAuth – Messages related to OAuth authentication. Krbros – Kerberos-related authentication messages.
SQL	Includes SQL transactions, SQL bulk transfer messages, and SQL result set messages.	Bulk – Messages pertaining to bulk query execution. Cache – Messages related to reading row data from and writing row data to the product's cache for better performance. Messag – Messages pertaining to SQL transactions. These messages are typically specific to the Sync App, rather than being received and passed along directly from the service. ResSet – Query resultsets. Transc – Messages related to handling transactions, including information about the number of jobs executed and backup table handling.
META	Metadata cache and schema messages.	Cache – Messages related to reading from and modifying column and table definitions in the product's cache for better performance. Schema – Messages related to retrieving metadata from or modifying the service schema. MemSto – Messages related to writing to or reading from in-memory metadata cache. Storag – Messages relating to storing metadata on disk or in an external data store, rather than in memory.
FUNC	Information related to executing SQL functions.	Errmsg – Error messages related to executing SQL functions.
TCP	Incoming and outgoing raw bytes on TCP transport layer messages.	Send – Raw data sent via the TCP protocol. Receiv – Raw data received via the TCP protocol.
FTP	Messages pertaining to the File Transfer Protocol.	Info – Status messages related to communication in the FTP protocol. Client – Messages related to actions taken by the FTP client (the product) during FTP communication. Server – Messages related to actions taken by the FTP server during FTP communication.
SFTP	Messages pertaining to the Secure File Transfer Protocol.	Info – Status messages related to communication in the SFTP protocol. To_Server – Messages related to actions taken by the SFTP client (the product) during SFTP communication. From_Server – Messages related to actions taken by the SFTP server during SFTP communication.
POP	Messages pertaining to data transferred via the Post Office Protocol.	Client – Messages related to actions taken by the POP client (the product) during POP communication. Server – Messages related to actions taken by the POP server during POP communication. Status – Status messages related to communication in the POP protocol.
SMTP	Messages pertaining to data transferred via the Simple Mail Transfer Protocol.	Client – Messages related to actions taken by the SMTP client (the product) during SMTP communication. Server – Messages related to actions taken by the SMTP server during SMTP communication. Status – Status messages related to communication in the SMTP protocol.
CORE	Messages relating to various internal product operations not covered by other modules.	—
DEMN	Messages related to SQL remoting.	—
CLJB	Messages about bulk data uploads (cloud job).	Commit – Submissions for bulk data uploads.
SRCE	Miscellaneous messages produced by the product that don't belong in any other module.	—
TRANCE	Advanced messages concerning low-level product operations.	—

This section provides a complete list of the Schema properties you can configure in the connection string for this provider.

---

Property	Description
Location	Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
BrowsableSchemas	Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
Tables	Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
Views	Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .

Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.

Remarks

The Location property is only needed if you want to either customize definitions (for example, change a column name, ignore a column, etc.) or extend the data model with new tables, views, or stored procedures.

If left unspecified, the default location is %APPDATA%\\CData\\Confluence Data Provider\\Schema, where %APPDATA% is set to the user's configuration directory:

Platform	%APPDATA%
Windows	The value of the APPDATA environment variable
Linux	~/.config

Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .

Remarks

Listing all available database schemas can take extra time, thus degrading performance. Providing a list of schemas in the connection string saves time and improves performance.

Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .

Remarks

Listing all available tables from some databases can take extra time, thus degrading performance. Providing a list of tables in the connection string saves time and improves performance.

If there are lots of tables available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those tables. To do this, specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Note: If you are connecting to a data source with multiple schemas or catalogs, you must specify each table you want to view by its fully qualified name. This avoids ambiguity between tables that may exist in multiple catalogs or schemas.

Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .

Remarks

Listing all available views from some databases can take extra time, thus degrading performance. Providing a list of views in the connection string saves time and improves performance.

If there are lots of views available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those views. To do this, specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Note: If you are connecting to a data source with multiple schemas or catalogs, you must specify each view you want to examine by its fully qualified name. This avoids ambiguity between views that may exist in multiple catalogs or schemas.

This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.

---

Property	Description
FullOrderByPushDown	Specifies whether provider pushes ORDER BY operations on the server-side for datetime columns that only support second-level precision.
IgnoreErrorsOnPagination	Specifies which server errors the provider should ignore when paging through Data Center tables that use client-side pagination.
IncludeArchivedSpaces	Specifies whether provider includes content from archived spaces in query results.
MaxRows	Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
Other	Specifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues.
Pagesize	Specifies the maximum number of records per page the provider returns when requesting data from Confluence.
PseudoColumns	Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
SpaceKey	Specifies the Confluence space key that provider uses to limit results to a single space.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
UserDefinedViews	Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file.

Specifies whether provider pushes ORDER BY operations on the server-side for datetime columns that only support second-level precision.

Remarks

Some datetime columns in Confluence support ordering only at the second level, which can cause inconsistent results when milliseconds are present.

When set to false, ORDER BY for these columns is applied client-side to preserve millisecond precision.

When set to true, Sync App pushes ORDER BY for these columns to the server and trims milliseconds to match the server's precision. Millisecond values are removed even when the query does not include ORDER BY.

This property is useful when you require server-side ordering for limited-precision datetime columns and do not need millisecond accuracy.

Specifies which server errors the provider should ignore when paging through Data Center tables that use client-side pagination.

Remarks

This property applies only to Data Center tables that implement client-side paging. Some pages may return server errors, such as HTTP 5xx responses, during retrieval.

When set to None, the Sync App stops the query if any page returns a server error.

When set to *, the Sync App ignores all HTTP server error status codes during pagination and continues fetching remaining pages.

When set to a comma-separated list of HTTP status codes, Sync App ignores only the specified errors and skips pages that return those codes.

This property is useful when you want to retrieve all available pages even if some pages fail due to transient server errors.

Specifies whether provider includes content from archived spaces in query results.

Remarks

When set to false, the Sync App excludes content from archived spaces. Only active space content is returned.

When set to true, the Sync App includes content such as pages, blog posts, comments, attachments, and other space content from archived spaces.

This property is useful when you need to retrieve historical or legacy content that exists in archived Confluence spaces.

Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.

Remarks

The default value for this property, -1, means that no row limit is enforced unless the query explicitly includes a LIMIT clause. (When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting.)

Setting MaxRows to a whole number greater than 0 ensures that queries do not return excessively large result sets by default.

This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.

Specifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues.

Remarks

This property allows advanced users to configure hidden properties for specialized situations, with the advice of our Support team. These settings are not required for normal use cases but can address unique requirements or provide additional functionality. To define multiple properties, use a semicolon-separated list.

Note: It is strongly recommended to set these properties only when advised by the Support team to address specific scenarios or issues.

Integration and Formatting

Property	Description
DefaultColumnSize	Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000.
ConvertDateTimeToGMT=True	Converts date-time values to GMT, instead of the local time of the machine. The default value is False (use local time).
RecordToFile=filename	Records the underlying socket data transfer to the specified file.

Specifies the maximum number of records per page the provider returns when requesting data from Confluence.

Remarks

When processing a query, instead of requesting all of the queried data at once from Confluence, the Sync App can request the queried data in pieces called pages.

This connection property determines the maximum number of results that the Sync App requests per page.

Note: Setting large page sizes may improve overall query execution time, but doing so causes the Sync App to use more memory when executing queries and risks triggering a timeout.

Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.

Remarks

This property allows you to define which pseudocolumns the Sync App exposes as table columns.

To specify individual pseudocolumns, use the following format:

Table1=Column1;Table1=Column2;Table2=Column3

To include all pseudocolumns for all tables use:

*=*

Specifies the Confluence space key that provider uses to limit results to a single space.

Remarks

Set this property to return content only from the specified Confluence space. The value must match the key assigned to the target space in your Confluence instance.

If the SQL query also specifies a SpaceKey filter, the value in the SQL query overrides the connection property.

This property is useful when you want to restrict queries to a specific Confluence space without applying filters in every SQL statement.

Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.

Remarks

The timeout applies to each individual communication with the server rather than the entire query or operation. For example, a query could continue running beyond 60 seconds if each paging call completes within the timeout limit.

Timeout is set to 60 seconds by default. To disable timeouts, set this property to 0.

Disabling the timeout allows operations to run indefinitely until they succeed or fail due to other conditions such as server-side timeouts, network interruptions, or resource limits on the server.

Note: Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.

Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file.

Remarks

UserDefinedViews allows you to define and manage custom views through a JSON-formatted configuration file called UserDefinedViews.json. These views are automatically recognized by the Sync App and enable you to execute custom SQL queries as if they were standard database views. The JSON file defines each view as a root element with a child element called "query", which contains the SQL query for the view.

For example:

{
	"MyView": {
		"query": "SELECT * FROM Pages WHERE MyColumn = 'value'"
	},
	"MyView2": {
		"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
	}
}

You can use this property to define multiple views in a single file and specify the filepath. For example:

UserDefinedViews=C:\Path\To\UserDefinedViews.json

When you specify a view in UserDefinedViews, the Sync App only sees that view.

For further information, see User Defined Views.

LZMA from 7Zip LZMA SDK

LZMA SDK is placed in the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or distribute the original LZMA SDK code, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.

LZMA2 from XZ SDK

Version 1.9 and older are in the public domain.

Xamarin.Forms

Xamarin SDK

The MIT License (MIT)

Copyright (c) .NET Foundation Contributors

All rights reserved.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

NSIS 3.10

Copyright (C) 1999-2025 Contributors THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS COMMON PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.

1. DEFINITIONS

"Contribution" means:

a) in the case of the initial Contributor, the initial code and documentation distributed under this Agreement, and b) in the case of each subsequent Contributor:

i) changes to the Program, and

ii) additions to the Program;

where such changes and/or additions to the Program originate from and are distributed by that particular Contributor. A Contribution 'originates' from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include additions to the Program which: (i) are separate modules of software distributed in conjunction with the Program under their own license agreement, and (ii) are not derivative works of the Program.

"Contributor" means any person or entity that distributes the Program.

"Licensed Patents " mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program.

"Program" means the Contributions distributed in accordance with this Agreement.

"Recipient" means anyone who receives the Program under this Agreement, including all Contributors.

2. GRANT OF RIGHTS

a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, distribute and sublicense the Contribution of such Contributor, if any, and such derivative works, in source code and object code form.

b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in source code and object code form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder.

c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program.

d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement.

3. REQUIREMENTS

A Contributor may choose to distribute the Program in object code form under its own license agreement, provided that:

a) it complies with the terms and conditions of this Agreement; and

b) its license agreement:

i) effectively disclaims on behalf of all Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose;

ii) effectively excludes on behalf of all Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits;

iii) states that any provisions which differ from this Agreement are offered by that Contributor alone and not by any other party; and

iv) states that source code for the Program is available from such Contributor, and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange.

When the Program is made available in source code form:

a) it must be made available under this Agreement; and

b) a copy of this Agreement must be included with each copy of the Program.

Contributors may not remove or alter any copyright notices contained within the Program.

Each Contributor must identify itself as the originator of its Contribution, if any, in a manner that reasonably allows subsequent Recipients to identify the originator of the Contribution.

4. COMMERCIAL DISTRIBUTION

Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor ("Commercial Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified Contributor") against any losses, damages and costs (collectively "Losses") arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense.

For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages.

5. NO WARRANTY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations.

6. DISCLAIMER OF LIABILITY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

7. GENERAL

If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.

If Recipient institutes patent litigation against a Contributor with respect to a patent applicable to software (including a cross-claim or counterclaim in a lawsuit), then any patent licenses granted by that Contributor to such Recipient under this Agreement shall terminate as of the date such litigation is filed. In addition, if Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed.

All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive.

Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. IBM is the initial Agreement Steward. IBM may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to distribute the Program (including its Contributions) under the new version. Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved.

This Agreement is governed by the laws of the State of New York and the intellectual property laws of the United States of America. No party to this Agreement will bring a legal action under this Agreement more than one year after the cause of action arose. Each party waives its rights to a jury trial in any resulting litigation.