Establishing a Connection

Adding a Connection to Confluence

To add a connection to Confluence:

In the application console, navigate to the Connections page.
At the Add Connections panel, select the icon for the connection you want to add.
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 the AuthScheme to Okta, and set these properties:

User: The Okta user.
Password: The Okta user's password.
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 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

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.

Advanced Features

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.

SSL Configuration

Customizing the SSL Configuration

By default, 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.

Firewall and Proxy

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.

Confluence Cloud Data Model

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.

Tables

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
Pages	Generated schema file.

Pages

Generated schema file.

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 '=,!=,LIKE,NOT LIKE,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,LIKE	Title of the content.
Status	String	False		=,IN	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	Integer	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		=,!=,IN,NOT IN	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.
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.
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.

Views

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
Attachments	Get information about a specific attachment.
AuditRecords	Fetch a paginated list of AuditRecord instances dating back to a certain time.
Blogposts	Get information about a specific blogpost.
Comments	Get information about a specific comment.
Contributors	Get information about the users who have contributed to the content.
GroupMembers	Get users of a specific group.
Groups	Get information about a specific group.
GroupsContentRestrictions	Retrieve information related to the groups restrictions applied to a certain content. The maximum number of restrictions per operation is limited to 200. ContentId is required.
Labels	Get information about the labels that a specific content has.
PageAncestors	To look at a page hierarchy including who is the parent page.
PageChildrens	To look at a page hierarchy including who is the child page.
PageComments	Get comments specific to a page.
PageContents	Get content from the page.
SpacePermissions	Returns space permissions for the specified space(s).
Spaces	Returns information about a number of spaces.
Tasks	Get information regarding tasks.
Users	Get information about a user identified.
UsersContentRestrictions	Retrieve information related to the users restrictions applied to a certain content. The maximum number of restrictions per operation is limited to 200. ContentId is required.
ViewersAnalytics	Get the total number of distinct viewers a piece of content has.
ViewsAnalytics	Get the total number of views a piece of content has.

Attachments

Get information about a specific attachment.

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

AuditRecords

Fetch a paginated list of AuditRecord instances dating back to a certain time.

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.

SearchString supports the '=' comparisons.
StartDate supports the '=' comparisons.
EndDate supports the '=' comparisons.

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'

Columns


Name	Type	References	SupportedOperators	Description
AffectedObjectName	String			Name of the object that was affected by changes.
AffectedObjectType	String			Type of the object that was affected by changes.
AuthorDisplayName	String			Display name of the person who made the changes.
AuthorType	String			Type of the author who made the changes.
UserKey	String			Unique identifier of the author.
UserName	String			User name of the author.
Category	String			Category of the object.
CreationDate	Datetime			Date when the object was created.
Description	String			Description of the object.
RemoteAddress	String			Remote address of the object.
Summary	String			Summary of the object.
IsSysAdmin	Boolean			Identifier whether object is system administered or not.
SearchString	String		=	Text that is inserted by the user to search for a specific object.
StartDate	Datetime		=	Start date of the audit.
EndDate	Datetime		=	End date of the audit.

Blogposts

Get information about a specific 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 '=,!=,LIKE,NOT LIKE,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	References	SupportedOperators	Description
Id [KEY]	String		=,!=,IN,NOT IN	Id of the blogpost.
Type	String		=,!=,IN,NOT IN	Type of the content.
Title	String		=,!=,LIKE,IN,NOT IN	Title of the blogpost.
Status	String			Status of the blogpost.
SpaceKey	String	Spaces.Key	=,!=,IN,NOT IN	The key of the space that the blogpost belongs to.
SpaceType	String	Spaces.Type	=,!=,IN,NOT IN	The type of the space that the blogpost belongs to.
Position	String			Position of the blogpost.
URL	String			URL of the blogpost.
Excerpt	String			Excerpt of the blogpost.
IsLatest	Boolean			Indicator if this is the latest version of the blogpost.
CreatedByUserName	String		=,!=,IN,NOT IN	Username of the user who created the blogpost.
CreatedByUserType	String			Type of the user who created the blogpost.
CreatedDate	Datetime		=,>,>=,<,<=	Datetime for the creation of the blogpost.
LastUpdatedDatetime	Datetime		=,>,>=,<,<=	Datetime of the last updated version of the blogpost.
LastUpdatedMessage	String			Message of the last updated version.
LastUpdatedNumber	Integer			Number of the last updated version.
LastUpdatedUserName	String			Username of the user who updated the latest version.
LastUpdatedUserType	String			Type of the user who updated the latest version.
LastUpdatedIsMinorEdit	Boolean			Indicator if this version is a minor edit.
LastUpdatedIsHidden	Boolean			Indicator if the last updated version is hidden or not.
PreviousVersionUserName	String			Username of the user who updated the previous version.
PreviousVersionUserType	String			Type of the user who updated the previous version.
PreviousVersionDatetime	Datetime			Datetime when the previous version was edited.
PreviousVersionMessage	String			Message for the previously edited version.
PreviousVersionNumber	String			Number of the previously edited version.
PreviousVersionIsMinorEdit	Boolean			Indicator if the previous version was a minor edit.
PreviousVersionIsHidden	Boolean			Indicator if the previous version was hidden or not.
LinksEditui	String			The LinksEditui of the page content.
LinksSelf	String			The LinksSelf of the content.
LinksTinyui	String			The LinksTinyui of the content.
LinksWebui	String			The LinksWebui of the content.
ItemURL	String			The URL reference of the element in UI.
ContainerId	String			The Id of the container of 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
CQL	String		CQL (Confluence Query Language) allows you to build structured queries.

Comments

Get information about a specific comment.

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 '=,!=,LIKE,NOT LIKE,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 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	Id of the comment.
Type	String		=,!=,IN,NOT IN	Type of the content.
Title	String			Title of the comment.
Status	String			Status of the comment.
SpaceKey	String	Spaces.Key	=,!=,IN,NOT IN	The key of the space that the comment belongs to.
SpaceType	String	Spaces.Type	=,!=,IN,NOT IN	The type of the space that the comment belongs to.
Position	String			Position of the comment.
URL	String			URL of the comment.
Excerpt	String			Excerpt of the comment.
IsLatest	Boolean			Indicator if this is the latest version of the comment.
CreatedByUserName	String		=,!=,IN,NOT IN	Username of the user who created the comment.
CreatedByUserType	String			Type of the user who created the comment.
CreatedDate	Datetime		=,>,>=,<,<=	Datetime for the creation of the comment.
LastUpdatedDatetime	Datetime		=,>,>=,<,<=	Datetime of the last updated version of the comment.
LastUpdatedMessage	String			Message of the last updated version.
LastUpdatedNumber	Integer			Number of the last updated version.
LastUpdatedUserName	String			Username of the user who updated the latest version.
LastUpdatedUserType	String			Type of the user who updated the latest version.
LastUpdatedIsMinorEdit	Boolean			Indicator if this version is a minor edit.
LastUpdatedIsHidden	Boolean			Indicator if the last updated version is hidden or not.
PreviousVersionUserName	String			Username of the user who updated the previous version.
PreviousVersionUserType	String			Type of the user who updated the previous version.
PreviousVersionDatetime	Datetime			Datetime when the previous version was edited.
PreviousVersionMessage	String			Message for the previously edited version.
PreviousVersionNumber	String			Number of the previously edited version.
PreviousVersionIsMinorEdit	Boolean			Indicator if the previous version was a minor edit.
PreviousVersionIsHidden	Boolean			Indicator if the previous version was hidden or not.
LinksEditui	String			The LinksEditui of the page content.
LinksSelf	String			The LinksSelf of the content.
LinksTinyui	String			The LinksTinyui of the content.
LinksWebui	String			The LinksWebui of the content.
ItemURL	String			The URL reference of the element in UI.
ContainerId	String			The Id of the container of 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
CQL	String		CQL (Confluence Query Language) allows you to build structured queries.

Contributors

Get information about the users who have contributed to the content.

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.

Note: ContentId is required in order to query the Contributors view.

ContentId supports the '=,!=,IN,NOT IN' comparisons.
AccountId supports the '=,!=,IN,NOT IN' comparisons.

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! = '12345678'

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

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

Additionally, ContentId column can be used in the ORDER BY clause, as following:

SELECT * FROM Contributors ORDER BY ContentId DESC

Columns


Name	Type	References	SupportedOperators	Description
ContentId [KEY]	String		=,!=,IN,NOT IN	This is the Id of the content that support labels. This can be referenced from Attachments.Id, Pages.Id, Comments.Id or Blogposts.Id.
UserType	String			Type of the contributor.
AccountId	String		=,!=,IN,NOT IN	Unique account Id of the contributor. NOTE: This column is exclusive to Confluence Cloud.
UserName	String		=,!=,IN,NOT IN	Unique user key of the contributor. NOTE: This column is exclusive to Confluence Server.

GroupMembers

Get users of 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 '=' comparisons.

For example, the following queries are processed server side:

SELECT * FROM GroupMembers WHERE Name = 'test1'

Columns


Name	Type	References	SupportedOperators	Description
AccountId	String			Account Id of the user.
AccountType	String			Account Type of the user.
DisplayName	String			Display name of the user.
Email	String			Email address of the user.
PublicName	String			Public name or nickname of the user.
ProfilePicturePath	String			Path of the profile picture of the user.
ProfilePictureWidth	Int			Width of the profile picture of the user.
ProfilePictureHeight	Int			Height of the profile picture of the user.
ProfilePictureIsDefault	Boolean			If isDefault of the profile picture of the user.
Operations	String			An operation and the target entity that it applies to
Type	String			Type of the user.
GroupId	String		=	The Id of the group.

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
Name	String		Name of the Group to which these members belong to

Groups

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	References	SupportedOperators	Description
Id [KEY]	String		=	Id of the group.
Name [KEY]	String			Name of the group.
Type	String			Type of the group.

GroupsContentRestrictions

Retrieve information related to the groups restrictions applied to a certain content. The maximum number of restrictions per operation is limited to 200. ContentId is required.

Columns


Name	Type	References	SupportedOperators	Description
Operation	String			Specifies the type of operation (read, update) that the restriction applies to.
Name	String			Stores the name of the group that the restriction applies to.
Type	String			Specifies the type of the group.
ContentId	String		=	The ID of the content where the restriction is applied.

Labels

Get information about the labels that a specific content has.

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.

Note: ContentId is required in order to query the Labels view.

ContentId supports the '=,!=,IN,NOT IN' comparisons.
LabelName supports the '=,!=,IN,NOT IN' comparisons.

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 != 'test'

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

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

Additionally, ContentId column can be used in the ORDER BY clause, as following:

SELECT * FROM Labels ORDER BY ContentId DESC

Columns


Name	Type	References	SupportedOperators	Description
ContentId [KEY]	String		=,!=,IN,NOT IN	This is the Id of the content that support labels. This can be referenced from Attachments.Id, Pages.Id, or Blogposts.Id.
LabelId	String			Id of the label.
LabelName	String		=,!=,IN,NOT IN	Name of the label.
LabelPrefix	String			Prefix of the label.

PageAncestors

To look at a page hierarchy including who is the parent page.

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 Id of the PageAncestors.
ExpandableAncestors	String			The ExpandableAncestors of the PageAncestors.
ExpandableBody	String			The ExpandableBody of the PageAncestors.
ExpandableChildren	String			The ExpandableChildren of the PageAncestors.
ExpandableChildTypes	String			The ExpandableChildTypes of the PageAncestors.
ExpandableContainer	String			The ExpandableContainer of the PageAncestors.
ExpandableDescendants	String			The ExpandableDescendants of the PageAncestors.
ExpandableHistory	String			The ExpandableHistory of the PageAncestors.
ExpandableMetadata	String			The ExpandableMetadata of the PageAncestors.
ExpandableOperations	String			The ExpandableOperations of the PageAncestors.
ExpandableRestrictions	String			The ExpandableRestrictions of the PageAncestors.
ExpandableSchedulePublishDate	Datetime			The ExpandableSchedulePublishDate of the PageAncestors.
ExpandableSpace	String			The ExpandableSpace of the PageAncestors.
ExpandableVersion	String			The ExpandableVersion of the PageAncestors.
LinksEditui	String			The LinksEditui of the PageAncestors.
LinksSelf	String			The LinksSelf of the PageAncestors.
LinksTinyui	String			The LinksTinyui of the PageAncestors.
LinksWebui	String			The LinksWebui of the PageAncestors.
ExtensionsPosition	String			The ExtensionsPosition of the PageAncestors.
Status	String			The Status of the PageAncestors.
Title	String			The Title of the PageAncestors.
Type	String			The Type of the PageAncestors.
PageId	String	Pages.Id	=,!=,IN,NOT IN	The Id of the page.

PageChildrens

To look at a page hierarchy including who is the child page.

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 PageChildrens view.

PageId supports the '=' comparison.

For example, the following queries are processed server side:

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

Columns


Name	Type	References	SupportedOperators	Description
Id [KEY]	String			The Id of the PageChildrens.
ExpandableAncestors	String			The ExpandableAncestors of the PageChildrens.
ExpandableBody	String			The ExpandableBody of the PageChildrens.
ExpandableChildren	String			The ExpandableChildren of the PageChildrens.
ExpandableChildTypes	String			The ExpandableChildTypes of the PageChildrens.
ExpandableContainer	String			The ExpandableContainer of the PageChildrens.
ExpandableDescendants	String			The ExpandableDescendants of the PageChildrens.
ExpandableHistory	String			The ExpandableHistory of the PageChildrens.
ExpandableMetadata	String			The ExpandableMetadata of the PageChildrens.
ExpandableOperations	String			The ExpandableOperations of the PageChildrens.
ExpandableRestrictions	String			The ExpandableRestrictions of the PageChildrens.
ExpandableSchedulePublishDate	Datetime			The ExpandableSchedulePublishDate of the PageChildrens.
ExpandableSpace	String			The ExpandableSpace of the PageChildrens.
ExpandableVersion	String			The ExpandableVersion of the PageChildrens.
LinksEditui	String			The LinksEditui of the PageChildrens.
LinksSelf	String			The LinksSelf of the PageChildrens.
LinksTinyui	String			The LinksTinyui of the PageChildrens.
LinksWebui	String			The LinksWebui of the PageChildrens.
ExtensionsPosition	String			The ExtensionsPosition of the PageChildrens.
Status	String			The Status of the PageChildrens.
Title	String			The Title of the PageChildrens.
Type	String			The Type of the PageChildrens.
PageId	String	Pages.Id	=,!=,IN,NOT IN	The Id of the page.

PageComments

Get comments specific to a page.

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 Id of the comments mentioned in the Page.
ExpandableAncestors	String			The ExpandableAncestors of the page comments.
ExpandableChildren	String			The ExpandableChildren of the page comments.
ExpandableContainer	String			The ExpandableContainer of the page comments.
ExpandableDescendants	String			The ExpandableDescendants of the page comments.
ExpandableHistory	String			The ExpandableHistory of the page comments.
ExpandableMetadata	String			The ExpandableMetadata of the page comments.
ExpandableOperations	String			The ExpandableOperations of the page comments.
ExpandableRestrictions	String			The ExpandableRestrictions of the page comments.
ExpandableSpace	String			The ExpandableSpace of the page comments.
ExpandableVersion	String			The ExpandableVersion of the page comments.
LinksSelf	String			The LinksSelf of the page comments.
LinksWebui	String			The LinksWebui of the page comments.
BodyExpandableAnonymousExportView	String			The BodyExpandableAnonymousExportView of the page comments.
BodyExpandableEditor	String			The BodyExpandableEditor of the page comments.
BodyExpandableExportView	String			The BodyExpandableExportView of the page comments.
BodyExpandableStorage	String			The BodyExpandableStorage of the page comments.
BodyExpandableStyledView	String			The BodyExpandableStyledView of the page comments.
BodyViewExpandableContent	String			The BodyViewExpandableContent of the page comments.
BodyViewExpandableWebresource	String			The BodyViewExpandableWebresource of the page comments.
BodyViewRepresentation	String			The BodyViewRepresentation of the page comments.
BodyViewValue	String			The BodyViewValue of the page comments.
ExtensionsExpandableResolution	String			The ExtensionsExpandableResolution of the page comments.
ExtensionsLocation	String			The ExtensionsLocation of the page comments.
Status	String			The Status of the page comments.
Title	String			The Title of the page comments.
Type	String			The Type of the page comments.
PageId	String	Pages.Id	=,!=,IN,NOT IN	The Id of the page.

PageContents

Get content from the page.

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 Id of the page content.
ExpandableAncestors	String			The ExpandableAncestors of the page content.
ExpandableChildren	String			The ExpandableChildren of the page content.
ExpandableChildTypes	String			The ExpandableChildTypes of the page content.
ExpandableContainer	String			The ExpandableContainer of the page content.
ExpandableDescendants	String			The ExpandableDescendants of the page content.
ExpandableHistory	String			The ExpandableHistory of the page content.
ExpandableMetadata	String			The ExpandableMetadata of the page content.
ExpandableOperations	String			The ExpandableOperations of the page content.
ExpandableRestrictions	String			The ExpandableRestrictions of the page content.
ExpandableSchedulePublishDate	Datetime			The ExpandableSchedulePublishDate of the page content.
ExpandableSpace	String			The ExpandableSpace of the page content.
ExpandableVersion	String			The ExpandableVersion of the page content.
LinksBase	String			The LinksBase of the page content.
LinksCollection	String			The LinksCollection of the page content.
LinksContext	String			The LinksContext of the page content.
LinksEditui	String			The LinksEditui of the page content.
LinksSelf	String			The LinksSelf of the page content.
LinksTinyui	String			The LinksTinyui of the page content.
LinksWebui	String			The LinksWebui of the page content.
BodyExpandableAnonymousExportView	String			The BodyExpandableAnonymousExportView of the page content.
BodyExpandableAtlasDocFormat	String			The BodyExpandableAtlasDocFormat of the page content.
BodyExpandableDynamic	String			The BodyExpandableDynamic of the page content.
BodyExpandableEditor	String			The BodyExpandableEditor of the page content.
BodyExpandableEditor2	String			The BodyExpandableEditor2 of the page content.
BodyExpandableExportView	String			The BodyExpandableExportView of the page content.
BodyExpandableStyledView	String			The BodyExpandableStyledView of the page content.
BodyExpandableView	String			The BodyExpandableView of the page content.
BodyStorageExpandableContent	String			The BodyStorageExpandableContent of the page content.
BodyStorageEmbeddedContent	String			The BodyStorageEmbeddedContent of the page content.
BodyStorageRepresentation	String			The BodyStorageRepresentation of the page content.
BodyStorageValue	String			The BodyStorageValue of the page content.
ExtensionsPosition	String			The ExtensionsPosition of the page content.
Status	String			The Status of the page content.
Title	String			The Title of the page content.
Type	String			The Type of the page content.
PageId	String	Pages.Id	=,!=,IN,NOT IN	The Id of the page.

SpacePermissions

Returns space permissions for the specified space(s).

Columns


Name	Type	References	SupportedOperators	Description
Id [KEY]	String			The ID of the space permission.
OperationKey	String			The type of operation that the space permission corresponds to.
OperationTargetType	String			The type of entity the operation type targets.
PrincipalId	String			The ID of the entity the space permissions corresponds to.
PrincipalType	String			The type of the entity the space permissions corresponds to.
SpaceId	String	Spaces.Id	=	The ID of the space that the permission is associated with.

Spaces

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	References	SupportedOperators	Description
Id	String			Id of the space.
Key [KEY]	String		=,!=,IN,NOT IN	Unique key of the space.
Name	String		=,!=	Name of the space.
IconPath	String			Path of the space icon.
IconWidth	Integer			Width of the space icon.
IconHeight	Integer			Height of the space icon.
IsIconDefault	Boolean			Indicator if the icon is default.
Excerpt	String			Excerpt of the space.
Type	String		=,!=,IN,NOT IN	Type of the space.
Url	String			Url of the space.
LastModified	Datetime			Last modified datetime.
ItemURL	String			The URL reference of the element in UI.
Description	String			Description 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.

Tasks

Get information regarding tasks.

Columns


Name	Type	References	SupportedOperators	Description
Id [KEY]	String		=	The ID of the task.
AssignedTo	String		=	Account ID of the user to whom this task is assigned.
AtlasDoc	String			The atlas doc format.
BlogPostId	String		=	The blog post ID of the task.
CompletedAt	Datetime			Time when task is completed.
CompletedBy	String		=	Account ID of the user who completed this task.
CreatedAt	Datetime			Time when task is created.
CreatedBy	String		=	Account ID of the user who created this task.
DueAt	Datetime			Time when task is due.
LocalId	String			The local ID.
PageId	String		=	The page ID of the task.
SpaceId	String		=	The space ID of the task.
Status	String		=	The status of the task.
Storage	String			The body storage of the task.
UpdatedAt	Datetime			Time when task is updated.

Users

Get information about a user identified.

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,NOT 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 = 'confluenceuser'

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,NOT IN	Unique account id for the specific user. NOTE: This column is exclusive to Confluence Cloud.
AccountType	String			Type of the account for the specific user. NOTE: This column is exclusive to Confluence Cloud.
PublicName	String		=,LIKE	Full name of the specific user. NOTE: This column is exclusive to Confluence Cloud.
Email	String			Email of the specific user. NOTE: This column is exclusive to Confluence Cloud.
UserKey [KEY]	String		=,!=,IN,NOT IN	Unique key for the specific user. NOTE: This column is exclusive to Confluence Server.
UserName	String		=	User name of the specific user. NOTE: This column is exclusive to Confluence Server.
Status	String			Status of the specific user. NOTE: This column is exclusive to Confluence Server.
Type	String			Type of the specific user.
Excerpt	String			Excerpt of the user.
ProfilePicturePath	String			Path of the profile picture file.
ProfilePictureWidth	Integer			Profile picture width.
ProfilePictureHeight	Integer			Profile picture height.
IsDefaultPicture	Boolean			Indicator showing if the profile picture is never changed.
DisplayName	String			Display name of the specific user.
Url	String			Url of the user profile.
LastModified	Datetime			Last modified timestamp of the user information.

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.

UsersContentRestrictions

Retrieve information related to the users restrictions applied to a certain content. The maximum number of restrictions per operation is limited to 200. ContentId is required.

Columns


Name	Type	References	SupportedOperators	Description
Operation	String			Specifies the type of operation (read, update) that the restriction applies to.
UserKey	String			Specifies the UserKey, the unique identifier key for the user.
DisplayName	String			The display name of the user associated with the restriction.
Username	String			Specifies the Username of the user.
Type	String			Specifies the type of the user (for example, 'known').
ContentId	String		=	The ID of the content where the restriction is applied.

ViewersAnalytics

Get the total number of distinct viewers a piece of content has.

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	String		=	The Id of the page content.
NumberOfDistinctViewers	String			the total number of distinct viewers a piece of content has.

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		The number of views for the content from the date.

ViewsAnalytics

Get the total number of views a piece of content has.

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	String		=	The Id of the page content.
NumberOfViews	String			the total number of views a piece of content has.

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		The number of views for the content from the date.

Connection String Options

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	The type of authentication to use when connecting to Confluence.
URL	The URL to your JIRA endpoint.
User	Specifies the user ID of the authenticating Confluence user account.
Password	Specifies the password of the authenticating user account.
APIToken	APIToken of the currently authenticated user.
PAT	Personal Access Token of the currently authenticated user.
Timezone	Specify the timezone of the Confluence instance in order to use the datetime filters accordingly and retrieve the results according to your timezone. An example of a timezone would be America/New_York.

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	The version of OAuth being used.
OAuthClientId	Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.
OAuthClientSecret	Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.
Scope	This determines the scopes that the OAuth application requests from Confluence.
CertificateStore	The certificate store used for Confluence authentication.
CertificateStorePassword	The password of the certificate store used with Confluence authentication.
CertificateSubject	The subject of the certificate used with Confluence Private Application authentication.
CertificateStoreType	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	The hostname or IP address of the proxy server that you want to route HTTP traffic through.
ProxyPort	The TCP port on your specified proxy server (set in the ProxyServer connection property) 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	The username of a user account registered with the proxy server specified in the ProxyServer connection property.
ProxyPassword	The password associated with the user specified in the ProxyUser connection property.
ProxySSLType	The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
ProxyExceptions	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
IncludeArchivedSpaces	Whether to include content from archived spaces in the result. This defaults to false.
MaxRows	Specifies the maximum rows returned for queries without aggregation or GROUP BY.
Other	Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.
Pagesize	Specifies the maximum number of results to return from Confluence, per page. This setting overrides the default page size set by the datasource, which is optimized for most use cases.
PseudoColumns	Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
SpaceKey	By specifying the SpaceKey, the search results will only display contents from this specific space.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.
UserDefinedViews	Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.

Authentication

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

Property	Description
AuthScheme	The type of authentication to use when connecting to Confluence.
URL	The URL to your JIRA endpoint.
User	Specifies the user ID of the authenticating Confluence user account.
Password	Specifies the password of the authenticating user account.
APIToken	APIToken of the currently authenticated user.
PAT	Personal Access Token of the currently authenticated user.
Timezone	Specify the timezone of the Confluence instance in order to use the datetime filters accordingly and retrieve the results according to your timezone. An example of a timezone would be America/New_York.

AuthScheme

The type of authentication to use when connecting to Confluence.

Remarks

OAuth: Set this to perform OAuth authentication.
Basic: Set this to use basic User/Password authentication for Server instances.
APIToken: Set this to use basic User/APIToken authentication for Cloud instances.
Crowd: Set this to perform Crowd SSO authentication.
OKTA: Set this to perform OKTA SSO authentication.
PAT: Set this to use a Personal Access Token (PAT) for Server instances of Confluence 7.9 and later.

URL

The URL to your JIRA endpoint.

Remarks

The URL to your JIRA endpoint; for example, https://yoursitename.atlassian.net.

User

Specifies the user ID of the authenticating Confluence user account.

Remarks

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

Password

Specifies the password of the authenticating user account.

Remarks

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

APIToken

APIToken of the currently authenticated user.

Remarks

APIToken of the currently authenticated user.

PAT

Personal Access Token of the currently authenticated user.

Remarks

Personal Access Token of the currently authenticated user.

Timezone

Specify the timezone of the Confluence instance in order to use the datetime filters accordingly and retrieve the results according to your timezone. An example of a timezone would be America/New_York.

Remarks

Note: You can find the timezone in your Confluence Server by navigating to Settings -> General Configuration and then by clicking System Information on the left panel. On your Confluence Cloud, the timezone should be set. In order to set it, navigate to the User Profile icon on the bottom left corner and click Settings. In that section, you will be able to set the Timezone by clicking the Edit button.

SSO

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.

SSOLoginURL

The identity provider's login URL.

Remarks

The identity provider's login URL.

SSOProperties

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 .

SSOExchangeUrl

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.

SSOAppName

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.

SSOAppPassword

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.

OAuth

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

Property	Description
OAuthVersion	The version of OAuth being used.
OAuthClientId	Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.
OAuthClientSecret	Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.
Scope	This determines the scopes that the OAuth application requests from Confluence.
CertificateStore	The certificate store used for Confluence authentication.
CertificateStorePassword	The password of the certificate store used with Confluence authentication.
CertificateSubject	The subject of the certificate used with Confluence Private Application authentication.
CertificateStoreType	The type of certificate store used with Confluence Private Application authentication.

OAuthVersion

The version of OAuth being used.

Remarks

The version of OAuth being used. The following options are available: 1.0,2.0

OAuthClientId

Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.

Remarks

OAuthClientId is one of a handful of connection parameters that need to be set before users can authenticate via OAuth. For details, see Establishing a Connection.

OAuthClientSecret

Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.

Remarks

OAuthClientSecret is one of a handful of connection parameters that need to be set before users can authenticate via OAuth. For details, see Establishing a Connection.

Scope

This determines the scopes that the OAuth application requests from 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 use either this property or the Scope input to change which scopes are requested.

By default the Sync App will request that the user authorize all required scopes. If you want to override this, you can set this property to a space-separated list of OAuth scopes. Please make sure that OAuth App Settings also has these scopes.

The default scopes configured for Cloud instances 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".

The default scopes configured for Server instances are: “READ WRITE”.

CertificateStore

The certificate store used for Confluence authentication.

Remarks

The location of the certificate store for the client certificate used in Confluence application authentication.

CertificateStorePassword

The password of the certificate store used with Confluence authentication.

Remarks

If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.

CertificateSubject

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

CertificateStoreType

The type of certificate store used with Confluence Private Application authentication.

Remarks

The name of the certificate store for the client certificate used in Confluence private application authentication. Confluence private application authentication uses SSL client authentication with digital certificates.

Specifying the Certificate Store Type

The CertificateStoreType property can take one of the following values:


User - default	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.

SSL

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.

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.

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.

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.

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.

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.

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.

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.

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.

SSLServerCert

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

Remarks

If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is 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

If not specified, any certificate trusted by the machine is accepted.

Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.

Firewall

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.

FirewallType

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.

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.

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.

FirewallPort

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.

FirewallUser

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.

FirewallPassword

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.

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	The hostname or IP address of the proxy server that you want to route HTTP traffic through.
ProxyPort	The TCP port on your specified proxy server (set in the ProxyServer connection property) 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	The username of a user account registered with the proxy server specified in the ProxyServer connection property.
ProxyPassword	The password associated with the user specified in the ProxyUser connection property.
ProxySSLType	The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

ProxyAutoDetect

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. Set to False if you want to manually configure the Sync App to connect to a specific proxy server.

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

ProxyServer

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

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, which is the default, the Sync App instead routes HTTP traffic through the proxy server specified in your system proxy settings.

ProxyPort

The TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client.

Remarks

The Sync App only routes HTTP traffic through the proxy server port specified in this connection property when ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is 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.

ProxyAuthScheme

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

Remarks

The authentication type can be one of the following:

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: Set this when 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.

ProxyUser

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 user name of a user registered with the proxy server.
DIGEST	The user name 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.

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

ProxyPassword

The password associated with 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.

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

ProxySSLType

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.

ProxyExceptions

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 that 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.

Logging

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.

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.

Remarks

This property lets you customize the log file content by specifying the logging modules to include. Logging modules categorize logged information into distinct areas, such as query execution, metadata, or SSL communication. Each module is represented by a four-character code, with some requiring a trailing space for three-letter names.

For example, EXEC logs query execution, and INFO logs general provider messages. To include multiple modules, separate their names with semicolons as follows: INFO;EXEC;SSL.

The Verbosity connection property takes precedence over the module-based filtering specified by this property. Only log entries that meet the verbosity level and belong to the specified modules are logged. Leave this property blank to include all available modules in the log file.

For a complete list of available modules and detailed guidance on configuring logging, refer to the Advanced Logging section in Logging.

Schema

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 .

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.

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

BrowsableSchemas

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.

Tables

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.

Views

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.

Miscellaneous

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

Property	Description
IncludeArchivedSpaces	Whether to include content from archived spaces in the result. This defaults to false.
MaxRows	Specifies the maximum rows returned for queries without aggregation or GROUP BY.
Other	Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.
Pagesize	Specifies the maximum number of results to return from Confluence, per page. This setting overrides the default page size set by the datasource, which is optimized for most use cases.
PseudoColumns	Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
SpaceKey	By specifying the SpaceKey, the search results will only display contents from this specific space.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.
UserDefinedViews	Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.

IncludeArchivedSpaces

Whether to include content from archived spaces in the result. This defaults to false.

Remarks

If this property is set to true, content such as comments, attachments, pages and blogspots belonging to an archived space will be included in the result.

MaxRows

Specifies the maximum rows returned for queries without aggregation or GROUP BY.

Remarks

This property sets an upper limit on the number of rows the Sync App returns for queries that do not include aggregation or GROUP BY clauses. This limit ensures that queries do not return excessively large result sets by default.

When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting. If MaxRows is set to "-1", no row limit is enforced unless a LIMIT clause is explicitly included in the query.

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

Other

Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.

Remarks

This property allows advanced users to configure hidden properties for specialized scenarios. These settings are not required for normal use cases but can address unique requirements or provide additional functionality. Multiple properties can be defined in 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.

Specify multiple properties in a semicolon-separated list.

Integration and Formatting


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	Determines whether to convert date-time values to GMT, instead of the local time of the machine.
RecordToFile=filename	Records the underlying socket data transfer to the specified file.

Pagesize

Specifies the maximum number of results to return from Confluence, per page. This setting overrides the default page size set by the datasource, which is optimized for most use cases.

Remarks

You may want to adjust the default pagesize to optimize results for a particular object or service endpoint you are querying. Be aware that increasing the page size may improve performance, but it could also result in higher memory consumption per page.

PseudoColumns

Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.

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: "*=*"

SpaceKey

By specifying the SpaceKey, the search results will only display contents from this specific space.

Remarks

If SpaceKey is specified both in the SQL query as well as a connection property, the value in the SQL query will take precedence over the connection property.

Timeout

Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.

Remarks

This property controls the maximum time, in seconds, that the Sync App waits for an operation to complete before canceling it. If the timeout period expires before the operation finishes, the Sync App cancels the operation and throws an exception.

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.

Setting this property to 0 disables the timeout, allowing 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. Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.

UserDefinedViews

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

Remarks

This property 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 define multiple views in a single file and specify the filepath using this property. For example: UserDefinedViews=C:\Path\To\UserDefinedViews.json. When you use this property, only the specified views are seen by the Sync App.

Refer to User Defined Views for more information.

Confluence Connector for CData Sync

Confluence Connector for CData Sync

Overview

Confluence Version Support

Establishing a Connection

Adding a Connection to Confluence

Connecting to Confluence

Authenticating to Confluence

API Token

Confluence Cloud Account

Basic Authentication

Confluence Server Instance

OAuth

Crowd

Okta

Fine-Tuning Data Access

Fine Tuning Data Access

Advanced Features

User Defined Views

SSL Configuration

Firewall and Proxy

Query Processing

Logging

SSL Configuration

Customizing the SSL Configuration

Client SSL Certificates

Firewall and Proxy

Connecting Through a Firewall or Proxy

HTTP Proxies

Other Proxies

Confluence Cloud Data Model

Overview

Key Features

Views

Tables

Confluence Connector for CData Sync Tables

Pages

Table Specific Information

Select

SQL

CQL

Columns

Pseudo-Columns

Views

Confluence Connector for CData Sync Views

Attachments

Table Specific Information

Select

SQL

CQL

Columns

Pseudo-Columns

AuditRecords

Table Specific Information

Select

Columns

Blogposts

Table Specific Information

Select

SQL

CQL

Columns

Pseudo-Columns

Comments

Table Specific Information

Select

SQL

CQL

Columns

Pseudo-Columns

Contributors

Table Specific Information

Select

Columns

GroupMembers

Table Specific Information

Select

Columns

Pseudo-Columns

Groups