Confluence Connection Details¶

Introduction¶

Connector Version

This documentation is based on version 23.0.8895 of the connector.

Get Started¶

Confluence Version Support

The connector leverages the Confluence API v2 to enable bidirectional access to Confluence.

Establish a Connection¶

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

Authenticate to Confluence¶

Confluence supports the following authentication methods: Basic Authentication, standard OAuth2.0 Authentication and SSO.

Basic Authentication¶

Confluence Cloud Account¶

Aquire a Token

An API token is necessary for account authentication. To generate one, login 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 Basic.
• 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 Jira endpoint. For example, https://yoursitename.atlassian.net.

Confluence Server Instance¶

To authenticate to a Server instance, specify the following:

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

OAuth¶

In all cases, you must set AuthScheme to OAuth and Scope to to the value obtained from your application settings. In all the flows described below, it is assumed that you have done so.

Desktop Applications¶

This section describes desktop authentication using the credentials for your custom OAuth app. See Creating a Custom OAuth App for more information.

Get an OAuth Access Token

After setting the following, you are ready to connect:

• OAuthClientId: Set to the client ID in your app settings.
• OAuthClientSecret: Set to the client secret in your app settings.
• CallbackURL: Set to the Redirect URL in your app settings.
• OAuthVersion: Set to 2.0.
• URL: The URL to your Confluence endpoint; for example, https://yoursitename.atlassian.net.
• InitiateOAuth: Set to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.

When you connect, the connector opens the OAuth endpoint in your default browser. Log in and grant permissions to the application. The connector then completes the following OAuth process:

1. Extracts the access token from the callback URL and authenticates requests.
2. Obtains a new access token when the old one expires.
3. Saves OAuth values in OAuthSettingsLocation. These values persist across connections.

Crowd¶

Set the AuthScheme to Crowd. The following connection properties are used to connect to Crowd:

• 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

The following is an 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 connector 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 connector 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;

Create a Custom OAuth App¶

If you do not have access to the user name and API token or do not wish to require them, you can use OAuth authentication. Confluence uses the OAuth authentication standard, which requires the authenticating user to interact with Confluence via the browser. Please note OAuth 2.0 only is supported for Confluence Cloud.

Create an OAuth App¶

To obtain the OAuth client credentials, consumer key, and consumer secret:

1. Log in to your Confluence Cloud site.
2. Navigate to your application management (https://developer.atlassian.com/apps/).
3. Select Create new app, then name the application. The application is created.
4. If missing, add OAuth 2.0 functionality to your application by navigating to APIS AND FEATURES > + Add > Add OAuth 2.0 (3LO).
5. From APIS AND FEATURES > + Add, add the Confluence platform REST API to your application. Please note that you also need to add the Confluence application to get all of the functionalities of the driver.
6. From APIS AND FEATURES > + Confluence platform REST API, add the desired scopes to your application.
7. You also need to set your Callback URL. Navigate to APIS AND FEATURES > OAuth 2.0 (3LO). Enter a URL that is accessible to your applicationand save the changes.

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.

Important Notes¶

Configuration Files and Their Paths¶

• All references to adding configuration files and their paths refer to files and locations on the Harmony Agent where the connector is installed. These paths are to be adjusted as appropriate depending on the agent and the operating system. If multiple agents are used in an agent group, identical files will be required on each agent.

Advanced Features¶

This section details a selection of advanced features of the Confluence connector.

User Defined Views

The connector allows you to define virtual tables, called user defined views, whose contents are decided by a pre-configured query. These views are useful when you cannot directly control queries being issued to the drivers. See User Defined Views for an overview of creating and configuring custom views.

SSL Configuration

Use SSL Configuration to adjust how connector handles TLS/SSL certificate negotiations. You can choose from various certificate formats; see the SSLServerCert property under "Connection String Options" for more information.

Proxy

To configure the connector using private agent proxy settings, select the Use Proxy Settings checkbox on the connection configuration screen.

Query Processing

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

See Query Processing for more information.

User Defined Views¶

The Confluence connector allows you to define a virtual table whose contents are decided by a pre-configured query. These are called User Defined Views, which are useful in situations where you cannot directly control the query being issued to the driver, e.g. when using the driver from Jitterbit. The User Defined Views can be used to define predicates that are always applied. If you specify additional predicates in the query to the view, they are combined with the query already defined as part of the view.

There are two ways to create user defined views:

• Create a JSON-formatted configuration file defining the views you want.
• DDL statements.

Define Views Using a Configuration File¶

User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The connector automatically detects the views specified in this file.

You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the connector.

This User Defined View configuration file is formatted as follows:

• Each root element defines the name of a view.
• Each root element contains a child element, called query, which contains the custom 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)"
    }
}

Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:

"UserDefinedViews", "C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json"

Define Views Using DDL Statements¶

The connector is also capable of creating and altering the schema via DDL Statements such as CREATE LOCAL VIEW, ALTER LOCAL VIEW, and DROP LOCAL VIEW.

Create a View¶

To create a new view using DDL statements, provide the view name and query as follows:

CREATE LOCAL VIEW [MyViewName] AS SELECT * FROM Customers LIMIT 20;

If no JSON file exists, the above code creates one. The view is then created in the JSON configuration file and is now discoverable. The JSON file location is specified by the UserDefinedViews connection property.

Alter a View¶

To alter an existing view, provide the name of an existing view alongside the new query you would like to use instead:

ALTER LOCAL VIEW [MyViewName] AS SELECT * FROM Customers WHERE TimeModified > '3/1/2020';

The view is then updated in the JSON configuration file.

Drop a View¶

To drop an existing view, provide the name of an existing schema alongside the new query you would like to use instead.

DROP LOCAL VIEW [MyViewName]

This removes the view from the JSON configuration file. It can no longer be queried.

Schema for User Defined Views¶

User Defined Views are exposed in the UserViews schema by default. This is done to avoid the view's name clashing with an actual entity in the data model. You can change the name of the schema used for UserViews by setting the UserViewsSchemaName property.

Work with User Defined Views¶

For example, a SQL statement with a User Defined View called UserViews.RCustomers only lists customers in Raleigh:

SELECT * FROM Customers WHERE City = 'Raleigh';

An example of a query to the driver:

SELECT * FROM UserViews.RCustomers WHERE Status = 'Active';

Resulting in the effective query to the source:

SELECT * FROM Customers WHERE City = 'Raleigh' AND Status = 'Active';

That is a very simple example of a query to a User Defined View that is effectively a combination of the view query and the view definition. It is possible to compose these queries in much more complex patterns. All SQL operations are allowed in both queries and are combined when appropriate.

SSL Configuration¶

Customize the SSL Configuration¶

By default, the connector attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store.

To specify another certificate, see the SSLServerCert property for the available formats to do so.

Client SSL Certificates¶

The Confluence connector 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.

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

Views

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

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 Views¶

Attachments¶

Get information about a specific attachment.

Table Specific Information¶

Select¶

The connector 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 connector. 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¶

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.

AuditRecords¶

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

Table Specific Information¶

Select¶

The connector 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 connector.

• 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¶

Blogposts¶

Get information about a specific blogpost.

Table Specific Information¶

Select¶

The connector 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 connector. 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¶

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.

Comments¶

Get information about a specific comment.

Table Specific Information¶

Select¶

The connector 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 connector. 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¶

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.

Contributors¶

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

Table Specific Information¶

Select¶

The connector 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 connector.

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¶

GroupMembers¶

Get users of a specific group.

Table Specific Information¶

Select¶

The connector 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 connector.

• Name supports the '=' comparisons.

For example, the following queries are processed server side:

SELECT * FROM GroupMembers WHERE Name = 'test1'

Columns¶

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.

Groups¶

Get information about a specific group.

Table Specific Information¶

Select¶

The connector 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 connector.

• 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¶

Labels¶

Get information about the labels that a specific content has.

Table Specific Information¶

Select¶

The connector 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 connector.

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¶

PageAncestors¶

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

Table Specific Information¶

Select¶

The connector 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¶

PageChildrens¶

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

Table Specific Information¶

Select¶

The connector 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¶

PageComments¶

Get comments specific to a page.

Table Specific Information¶

Select¶

The connector 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¶

PageContents¶

Get content from the page.

Table Specific Information¶

Select¶

The connector 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¶

Pages¶

Get information about a specific page.

Table Specific Information¶

Select¶

The connector 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 connector. 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¶

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.

Spaces¶

Returns information about a number of spaces.

Table Specific Information¶

Select¶

The connector 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 connector. 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¶

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.

Tasks¶

Get information regarding tasks.

Columns¶

Users¶

Get information about a user identified.

Table Specific Information¶

Select¶

The connector 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 connector. 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¶

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.

ViewersAnalytics¶

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

Table Specific Information¶

Select¶

The connector 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¶

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.

ViewsAnalytics¶

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

Table Specific Information¶

Select¶

The connector 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¶

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.

Stored Procedures¶

Stored procedures are function-like interfaces that extend the functionality of the connector beyond simple SELECT operations with Confluence.

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

Confluence Connector Stored Procedures¶

DownloadAttachment¶

Download attachment by specifying its Id.

Input¶

Result Set Columns¶

GetOAuthAccessToken¶

Gets an authentication token from Confluence.

Input¶

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

Result Set Columns¶

GetOAuthAuthorizationURL¶

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

Input¶

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

Result Set Columns¶

RefreshOAuthAccessToken¶

Refreshes the OAuth access token used for authentication with Confluence.

Input¶

Result Set Columns¶

System Tables¶

You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.

Schema Tables¶

The following tables return database metadata for Confluence:

• sys_catalogs: Lists the available databases.
• sys_schemas: Lists the available schemas.
• sys_tables: Lists the available tables and views.
• sys_tablecolumns: Describes the columns of the available tables and views.
• sys_procedures: Describes the available stored procedures.
• sys_procedureparameters: Describes stored procedure parameters.
• sys_keycolumns: Describes the primary and foreign keys.
• sys_indexes: Describes the available indexes.

Data Source Tables¶

The following tables return information about how to connect to and query the data source:

• sys_connection_props: Returns information on the available connection properties.
• sys_sqlinfo: Describes the SELECT queries that the connector can offload to the data source.

Query Information Tables¶

The following table returns query statistics for data modification queries:

• sys_identity: Returns information about batch operations or single updates.

sys_catalogs¶

Lists the available databases.

The following query retrieves all databases determined by the connection string:

SELECT * FROM sys_catalogs

Columns¶

sys_schemas¶

Lists the available schemas.

The following query retrieves all available schemas:

SELECT * FROM sys_schemas

Columns¶

sys_tables¶

Lists the available tables.

The following query retrieves the available tables and views:

SELECT * FROM sys_tables

Columns¶

sys_tablecolumns¶

Describes the columns of the available tables and views.

The following query returns the columns and data types for the Pages table:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Pages'

Columns¶

sys_procedures¶

Lists the available stored procedures.

The following query retrieves the available stored procedures:

SELECT * FROM sys_procedures

Columns¶

sys_procedureparameters¶

Describes stored procedure parameters.

The following query returns information about all of the input parameters for the SelectEntries stored procedure:

SELECT * FROM sys_procedureparameters WHERE ProcedureName='SelectEntries' AND Direction=1 OR Direction=2

Columns¶

sys_keycolumns¶

Describes the primary and foreign keys.

The following query retrieves the primary key for the Pages table:

SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Pages'

Columns¶

sys_foreignkeys¶

Describes the foreign keys.

The following query retrieves all foreign keys which refer to other tables:

SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'

Columns¶

sys_primarykeys¶

Describes the primary keys.

The following query retrieves the primary keys from all tables and views:

SELECT * FROM sys_primarykeys

Columns¶

sys_indexes¶

Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.

The following query retrieves all indexes that are not primary keys:

SELECT * FROM sys_indexes WHERE IsPrimary='false'

Columns¶

sys_connection_props¶

Returns information on the available connection properties and those set in the connection string.

When querying this table, the config connection string should be used:

jdbc:cdata:confluence:config:

This connection string enables you to query this table without a valid connection.

The following query retrieves all connection properties that have been set in the connection string or set through a default value:

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns¶

sys_sqlinfo¶

Describes the SELECT query processing that the connector can offload to the data source.

Discover the Data Source's SELECT Capabilities¶

Below is an example data set of SQL capabilities. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.

The following query retrieves the operators that can be used in the WHERE clause:

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'

Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Confluence Cloud Data Model section for more information.

Columns¶

sys_identity¶

Returns information about attempted modifications.

The following query retrieves the Ids of the modified rows in a batch operation:

SELECT * FROM sys_identity

Columns¶

sys_information¶

Describes the available system information.

The following query retrieves all columns:

SELECT * FROM sys_information

Columns¶

Advanced Configurations Properties¶

The advanced configurations 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. Click the links for further details.

Authentication

SSO

OAuth

SSL

Schema

Miscellaneous

Authentication¶

This section provides a complete list of authentication properties you can configure.

AuthScheme¶

The type of authentication to use when connecting to Confluence.

Possible Values¶

Auto, OAuth, Basic, APIToken, Crowd, OKTA

Data Type¶

string

Default Value¶

Auto

Remarks¶

• Auto: Lets the driver decide automatically based on the other connection properties you have set.
• OAuth: Set to 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.

URL¶

The URL to your JIRA endpoint.

Data Type¶

string

Default Value¶

""

Remarks¶

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

CloudId¶

The Cloud ID for the Atlassian site that was authorized.

Data Type¶

string

Default Value¶

""

Remarks¶

This will be determined automatically during OAuth 2.0 authentication and returned from the GetOAuthAccessToken stored procedure. Do not set a value for CloudId when using InitiateOAuth.

User¶

The Confluence user account used to authenticate.

Data Type¶

string

Default Value¶

""

Remarks¶

Together with Password, this field is used to authenticate against the Confluence server.

Password¶

The password used to authenticate the user.

Data Type¶

string

Default Value¶

""

Remarks¶

The User and Password are together used to authenticate with the server.

APIToken¶

APIToken of the currently authenticated user.

Data Type¶

string

Default Value¶

""

Remarks¶

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

Data Type¶

string

Default Value¶

""

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 SSO properties you can configure.

SSOLoginURL¶

The identity provider's login URL.

Data Type¶

string

Default Value¶

""

Remarks¶

The identity provider's login URL.

SSOProperties¶

Additional properties required to connect to the identity provider in a semicolon-separated list.

Data Type¶

string

Default Value¶

""

Remarks¶

Additional properties required to connect to the identity provider in a semicolon-separated list. is used in conjunction 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.

Data Type¶

string

Default Value¶

""

Remarks¶

The Confluence connector 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.

Data Type¶

string

Default Value¶

""

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.

Data Type¶

string

Default Value¶

""

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 OAuth properties you can configure.

InitiateOAuth¶

Set this property to initiate the process to obtain or refresh the OAuth access token when you connect.

Possible Values¶

OFF, GETANDREFRESH, REFRESH

Data Type¶

string

Default Value¶

OFF

Remarks¶

The following options are available:

1. OFF: Indicates that the OAuth flow will be handled entirely by the user. An OAuthAccessToken will be required to authenticate.
2. GETANDREFRESH: Indicates that the entire OAuth Flow will be handled by the connector. If no token currently exists, it will be obtained by prompting the user via the browser. If a token exists, it will be refreshed when applicable.
3. REFRESH: Indicates that the connector will only handle refreshing the OAuthAccessToken. The user will never be prompted by the connector to authenticate via the browser. The user must handle obtaining the OAuthAccessToken and OAuthRefreshToken initially.

OAuthVersion¶

The version of OAuth being used.

Possible Values¶

1.0, 2.0

Data Type¶

string

Default Value¶

2.0

Remarks¶

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

OAuthClientId¶

The client ID assigned when you register your application with an OAuth authorization server.

Data Type¶

string

Default Value¶

""

Remarks¶

As part of registering an OAuth application, you will receive the OAuthClientId value, sometimes also called a consumer key, and a client secret, the OAuthClientSecret.

OAuthClientSecret¶

The client secret assigned when you register your application with an OAuth authorization server.

Data Type¶

string

Default Value¶

""

Remarks¶

As part of registering an OAuth application, you will receive the OAuthClientId, also called a consumer key. You will also receive a client secret, also called a consumer secret. Set the client secret in the OAuthClientSecret property.

OAuthAccessToken¶

The access token for connecting using OAuth.

Data Type¶

string

Default Value¶

""

Remarks¶

The OAuthAccessToken property is used to connect using OAuth. The OAuthAccessToken is retrieved from the OAuth server as part of the authentication process. It has a server-dependent timeout and can be reused between requests.

The access token is used in place of your user name and password. The access token protects your credentials by keeping them on the server.

Scope¶

This determines the scopes that the OAuth application requests from Confluence.

Data Type¶

string

Default Value¶

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

Remarks¶

Specify scope to obtain the initial access and refresh token.

By default the connector 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.

OAuthSettingsLocation¶

The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH . Alternatively, you can hold this location in memory by specifying a value starting with 'memory://'.

Data Type¶

string

Default Value¶

%APPDATA%\Confluence Data Provider\OAuthSettings.txt

Remarks¶

When InitiateOAuth is set to GETANDREFRESH or REFRESH, the connector saves OAuth values to avoid requiring the user to manually enter OAuth connection properties and to allow the credentials to be shared across connections or processes.

Instead of specifying a file path, you can use memory storage. Memory locations are specified by using a value starting with 'memory://' followed by a unique identifier for that set of credentials (for example, memory://user1). The identifier can be anything you choose but should be unique to the user. Unlike file-based storage, where credentials persist across connections, memory storage loads the credentials into static memory, and the credentials are shared between connections using the same identifier for the life of the process. To persist credentials outside the current process, you must manually store the credentials prior to closing the connection. This enables you to set them in the connection when the process is started again. You can retrieve OAuth property values with a query to the sys_connection_props system table. If there are multiple connections using the same credentials, the properties are read from the previously closed connection.

The default location is "%APPDATA%\Confluence Data Provider\OAuthSettings.txt" with %APPDATA% set to the user's configuration directory. The default values are

• Windows: "register://%DSN"
• Unix: "%AppData%..."
• Mac: "%AppData%..."

where DSN is the name of the current DSN used in the open connection.

The following table lists the value of %APPDATA% by OS:

CertificateStore¶

The certificate store used for Confluence authentication.

Data Type¶

string

Default Value¶

""

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.

Data Type¶

string

Default Value¶

""

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.

Data Type¶

string

Default Value¶

""

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, E=support@jitterbit.com". Common fields and their meanings are displayed below.

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.

Possible Values¶

USER, MACHINE, PFXFILE, PFXBLOB, JKSFILE, JKSBLOB, PEMKEY_FILE, PUBLIC_KEY_FILE, PUBLIC_KEY_BLOB, SSHPUBLIC_KEY_BLOB, P10BFILE, SSHPUBLIC_KEY_FILE, PPKFILE, XMLFILE, XMLBLOB

Data Type¶

string

Default Value¶

USER

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:

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 connector executes a search based on the specified subject. Refer to the CertificateSubject field for details.

OAuthVerifier¶

The verifier code returned from the OAuth authorization URL.

Data Type¶

string

Default Value¶

""

Remarks¶

The verifier code returned from the OAuth authorization URL. This can be used on systems where a browser cannot be launched such as headless systems.

Authentication on Headless Machines¶

See to obtain the OAuthVerifier value.

Set OAuthSettingsLocation along with OAuthVerifier. When you connect, the connector exchanges the OAuthVerifier for the OAuth authentication tokens and saves them, encrypted, to the specified location. Set InitiateOAuth to GETANDREFRESH to automate the exchange.

Once the OAuth settings file has been generated, you can remove OAuthVerifier from the connection properties and connect with OAuthSettingsLocation set.

To automatically refresh the OAuth token values, set OAuthSettingsLocation and additionally set InitiateOAuth to REFRESH.

OAuthRefreshToken¶

The OAuth refresh token for the corresponding OAuth access token.

Data Type¶

string

Default Value¶

""

Remarks¶

The OAuthRefreshToken property is used to refresh the OAuthAccessToken when using OAuth authentication.

OAuthExpiresIn¶

The lifetime in seconds of the OAuth AccessToken.

Data Type¶

string

Default Value¶

""

Remarks¶

Pair with OAuthTokenTimestamp to determine when the AccessToken will expire.

OAuthTokenTimestamp¶

The Unix epoch timestamp in milliseconds when the current Access Token was created.

Data Type¶

string

Default Value¶

""

Remarks¶

Pair with OAuthExpiresIn to determine when the AccessToken will expire.

SSL¶

This section provides a complete list of SSL properties you can configure.

SSLClientCert¶

The TLS/SSL client certificate store for SSL Client Authentication (2-way SSL).

Data Type¶

string

Default Value¶

""

Remarks¶

The name of the certificate store for the client certificate.

The SSLClientCertType field specifies the type of the certificate store specified by SSLClientCert. If the store is password protected, specify the password in SSLClientCertPassword.

SSLClientCert is used in conjunction with the SSLClientCertSubject field in order to specify client certificates. If SSLClientCert has a value, and SSLClientCertSubject is set, a search for a certificate is initiated. See SSLClientCertSubject for more information.

Designations of certificate stores are platform-dependent.

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

In Java, the certificate store normally is a file containing certificates and optional private keys.

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (for example, PKCS12 certificate store).

SSLClientCertType¶

The type of key store containing the TLS/SSL client certificate.

Possible Values¶

USER, MACHINE, PFXFILE, PFXBLOB, JKSFILE, JKSBLOB, PEMKEY_FILE, PEMKEY_BLOB, PUBLIC_KEY_FILE, PUBLIC_KEY_BLOB, SSHPUBLIC_KEY_FILE, SSHPUBLIC_KEY_BLOB, P7BFILE, PPKFILE, XMLFILE, XMLBLOB

Data Type¶

string

Default Value¶

USER

Remarks¶

This property can take one of the following values:

SSLClientCertPassword¶

The password for the TLS/SSL client certificate.

Data Type¶

string

Default Value¶

""

Remarks¶

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

SSLClientCertSubject¶

The subject of the TLS/SSL client certificate.

Data Type¶

string

Default Value¶

*

Remarks¶

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, the property is set to an empty string, and no certificate is selected.

The special value "*" picks the first certificate in the certificate store.

The certificate subject is a comma separated list of distinguished name fields and values. For example, "CN=www.server.com, OU=test, C=US, E=support@company.com". The common fields and their meanings are shown below.

If a field value contains a comma, it must be quoted.

SSLServerCert¶

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

Data Type¶

string

Default Value¶

""

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:

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

Certificates are validated as trusted by the machine based on the System's trust store. The trust store used is the 'javax.net.ssl.trustStore' value specified for the system. If no value is specified for this property, Java's default trust store is used (for example, JAVA_HOME\lib\security\cacerts).

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

Schema¶

This section provides a complete list of schema properties you can configure.

Location¶

A path to the directory that contains the schema files defining tables, views, and stored procedures.

Data Type¶

string

Default Value¶

%APPDATA%\Confluence Data Provider\Schema

Remarks¶

The path to a directory which contains the schema files for the connector (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) or extend the data model with new tables, views, or stored procedures.

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

BrowsableSchemas¶

This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Data Type¶

string

Default Value¶

""

Remarks¶

Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.

Tables¶

This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.

Data Type¶

string

Default Value¶

""

Remarks¶

Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the connector.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

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 that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Views¶

Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Data Type¶

string

Default Value¶

""

Remarks¶

Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the connector.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

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 that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Miscellaneous¶

This section provides a complete list of miscellaneous properties you can configure.

IncludeArchivedSpaces¶

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

Data Type¶

bool

Default Value¶

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¶

Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.

Data Type¶

int

Default Value¶

-1

Remarks¶

Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.

Other¶

These hidden properties are used only in specific use cases.

Data Type¶

string

Default Value¶

""

Remarks¶

The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.

Specify multiple properties in a semicolon-separated list.

Integration and Formatting¶

Pagesize¶

The maximum number of results to return per page from Confluence.

Data Type¶

int

Default Value¶

200

Remarks¶

The Pagesize property affects the maximum number of results to return per page from Confluence. Setting a higher value may result in better performance at the cost of additional memory allocated per page consumed.

PseudoColumns¶

This property indicates whether or not to include pseudo columns as columns to the table.

Data Type¶

string

Default Value¶

""

Remarks¶

This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".

SpaceKey¶

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

Data Type¶

string

Default Value¶

""

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¶

The value in seconds until the timeout error is thrown, canceling the operation.

Data Type¶

int

Default Value¶

60

Remarks¶

If Timeout = 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.

If Timeout expires and the operation is not yet complete, the connector throws an exception.

UserDefinedViews¶

A filepath pointing to the JSON configuration file containing your custom views.

Data Type¶

string

Default Value¶

""

Remarks¶

User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The connector automatically detects the views specified in this file.

You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the connector.

This User Defined View configuration file is formatted as follows:

• Each root element defines the name of a view.
• Each root element contains a child element, called query, which contains the custom 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)"
    }
}

Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:

"UserDefinedViews", C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json

Note that the specified path is not embedded in quotation marks.