Confluence への接続を追加

Confluence への接続を追加するには：

1. アプリケーションコンソールで、接続ページに移動します。
2. 接続の追加パネルで、追加したい接続のアイコンを選択します。
3. Confluence アイコンが利用できない場合は、Add More アイコンをクリックしてCData サイトからConfluence コネクタをダウンロードおよびインストールします。

必須プロパティについては、設定タブを参照してください。

通常必須ではない接続プロパティについては、高度な設定タブを参照してください。

Confluence への接続

任意のConfluence Cloud またはConfluence Server インスタンスへの接続を確立できます。接続するにはURL 接続プロパティを設定します。例えば、https://yoursitename.atlassian.net です。

Confluence への認証

Confluence は、次の認証メソッドをサポートしています：API トークン、Basic 認証、OAuth 2.0、SSO。

API トークン

Confluence Cloud アカウント

トークンの取得

アカウント認証にはAPI トークンが必要です。API トークンを生成するには、Atlassian アカウントにログインしてAPI トークン -> API トークンの作成を選択します。生成されたトークンが表示されます。

トークンを使用する認証

Cloud アカウントへの認証を行うには、以下を入力します（Note：Password はCloud アカウントへの接続には非推奨となり、Server インスタンスへの接続にのみ使用されるようになりました）。

• AuthScheme：APIToken に設定。
• User：Confluence サーバーに認証する際に使用されるユーザー。
• APIToken：現在認証されているユーザーに紐づくAPI トークン。
• Url：Confluence エンドポイントに紐づくURL。例えば、https://yoursitename.atlassian.net です。

Basic 認証

Confluence Server インスタンス

Server インスタンスへの認証を行うには、以下のように指定します。

• AuthScheme：Basic に設定。
• User：Confluence インスタンスに認証する際に使用されるユーザー。
• Password：Confluence サーバーに認証する際に使われるパスワード。
• Url：Confluence エンドポイントに紐づくURL。例えば、https://yoursitename.atlassian.net です。

OAuth

すべての場合で、AuthScheme をOAuth に、Scope をアプリケーション設定で取得した値に設定する必要があります。以下に説明するすべてのフローは、すでに設定済みであることを前提として書かれています。 Note： Confluence Cloud では OAuth 1.0 は非推奨です。ホストされているConfluence ユーザーのみが使用するようにしてください。

Crowd

AuthScheme をCrowd に設定し、次の接続プロパティを設定します。

• User：Crowd ユーザーアカウント。
• Password：Crowd アカウントに関連付けられたパスワード。
• SSOLoginURL：Crowd アカウントに関連付けられたログインURL。IDP URL は、自身のアプリケーション->［SSO］->［SSO information］->［Identity provider single sign-on URL］にあります。
• SSOAppName：SSO を有効にするアプリケーション名。
• SSOAppPassword：SSO を有効にするアプリケーションのパスワード。
• 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

接続文字列の例：

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

Okta に接続するには、AuthScheme をOkta に設定し、次のプロパティを設定します。

• User：Okta ユーザー。
• Password：Okta ユーザーのパスワード。
• SSOLoginURL：SSO プロバイダーのログイン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

Okta クライアントリクエストコンテキストをオーバーライドする信頼されたアプリケーションまたはプロキシを使用する場合、またはMFA を設定している場合は、Okta を使用して認証するためにSSOProperties を組み合わせて使用する必要があります。必要に応じて、以下のいずれかを設定します。

• APIToken：Okta クライアントリクエストコンテキストをオーバーライドする、信頼されたアプリケーションまたはプロキシ経由でユーザーを認証する場合、これを顧客がOkta 組織で作成したAPI Token に設定します。
• MFAType：MFA フローを設定した場合、次の対応するタイプのいずれかに設定します：OktaVerify、Email、またはSMS。
• MFAPassCode：MFA フローを設定した場合は、有効なパスコードに設定します。
  これを空欄または無効な値に設定した場合、Sync App はユーザーのデバイスまたはE メールにワンタイムパスワードチャレンジを発行します。パスコードを受信後、取得したワンタイムパスワードをMFAPassCode 接続プロパティに設定する接続を再度開きます。
• MFARememberDevice：デフォルトはTrue です。Okta は、MFA が必要な場合にデバイスを記憶させることをサポートします。設定された認証ポリシーに従ってデバイスの記憶が許可されている場合、Sync App はMFA 認証の有効期間を延長するデバイストークンを送信します。MFA を記憶させない場合は、この 変数をFalse に設定してください。

接続文字列の例：

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

Fine Tuning Data Access

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

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

このセクションでは、Confluence Sync App の高度な機能を厳選して説明します。

ユーザー定義ビュー

Sync App はユーザー定義ビューの使用をサポートします。これは事前設定されたユーザー定義クエリによって内容が決定される仮想テーブルです。 このビューは、ドライバーに発行されるクエリを直接制御できない場合に有効です。 カスタムビューの作成と設定の概要については、ユーザー定義ビュー を参照してください。

SSL の設定

SSL の設定 を使用して、Sync App が証明書のネゴシエーションをどのように扱うかを調整します。さまざまな証明書形式を選択できます。詳しくは、「接続文字列オプション」にあるSSLServerCert プロパティを参照してください。

ファイアウォールとプロキシ

Windows プロキシとHTTP プロキシを含むファイアウォールとプロキシ に合致するようSync App を設定します。トンネル接続を設定することもできます。

クエリ処理

Sync App は、Confluence にできるだけ多くのSELECT ステートメント処理をオフロードし、残りのクエリをクライアント側のインメモリで処理します。

詳しくは、クエリ処理 を参照してください。

ログ

CData ログを調整するために使用可能な設定の概要については、ログ を参照してください。基本的なロギングに必要なのは2つの接続プロパティだけですが、より詳細なロギングをサポートする多くの機能があり、LogModules 接続プロパティを使用してロギングする情報のサブセットを指定することができます。

SSL 設定のカスタマイズ

デフォルトでは、Sync App はサーバーとのTLS のネゴシエーションを試みます。サーバー証明書は、デフォルトのシステム信頼済み証明書ストアで検証されます。SSLServerCert 接続プロパティを使用して、証明書の検証方法をオーバーライドできます。

別の証明書を指定するには、SSLServerCert 接続プロパティを参照してください。

クライアントSSL 証明書

Confluence Sync App はクライアント証明書の設定もサポートしています。次を設定すれば、クライアント証明書を使って接続できます。

• SSLClientCert：クライアント証明書のための証明書ストア名。
• SSLClientCertType：TLS / SSL クライアント証明書を格納するキーストアの種類。
• SSLClientCertPassword：TLS / SSL クライアント証明書のパスワード。
• SSLClientCertSubject：TLS / SSL クライアント証明書のサブジェクト。

Firewall またはProxy 経由の接続

HTTP プロキシ

HTTP プロキシへの認証には、以下のように設定します。

• ProxyServer：HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。
• ProxyPort：プロキシサーバーが起動しているTCP ポート。
• ProxyAuthScheme：プロキシサーバーに対して認証する際にSync App が使用する認証方法。
• ProxyUser：プロキシサーバーに登録されているユーザーアカウントのユーザー名。
• ProxyPassword：ProxyUser に紐付けられたパスワード。

その他のプロキシ

次のプロパティを設定します。

• プロキシベースのファイヤーウォールを使用するには、FirewallType、FirewallServer、およびFirewallPort を設定します。
• 接続をトンネルするには、FirewallType をTUNNEL に設定します。
• 認証するには、FirewallUser とFirewallPassword を設定します。
• SOCKS プロキシへの認証には、さらにFirewallType をSOCKS5 に設定します。

Overview

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

Key Features

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

Views

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

Sync App はConfluence のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。

Confluence Connector for CData Sync テーブル

Name	Description
Pages	Generated schema file.

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.

ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。

クエリは、ビューに対して通常のテーブルと同様に実行することができます。

Confluence Connector for CData Sync ビュー

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.

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.

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.

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.

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.

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.

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

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

接続文字列プロパティは、接続を確立するために使用できるさまざまなオプションです。このセクションでは、本プロバイダーの接続文字列で設定できるオプションの一覧を示します。詳細については各リンクをクリックしてください。

接続を確立する方法について詳しくは、接続の確立を参照してください。

Authentication

---

プロパティ	説明
AuthScheme	The type of authentication to use when connecting to Confluence.
URL	The URL to your JIRA endpoint.
User	認証するConfluence ユーザーアカウントのユーザーID を指定します。
Password	認証するユーザーアカウントのパスワードを指定します。
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

---

プロパティ	説明
SSOLoginURL	ID プロバイダーのログインURL。
SSOProperties	ID プロバイダーへの接続に必要な追加プロパティを、セミコロンで区切ったリスト形式で指定します。
SSOExchangeUrl	SAML 応答を処理してサービスの資格情報と交換するために使用するURL。
SSOAppName	アプリ名を必要とするSSO のIdP で使用されるアプリ名.
SSOAppPassword	アプリパスワードを必要とするSSO のIdP で使用されるアプリパスワード。

OAuth

---

プロパティ	説明
OAuthVersion	使われているOAuth のバージョン。
OAuthClientId	カスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。（コンシューマーキーとも呼ばれます。）このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。
OAuthClientSecret	カスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。（ コンシューマーシークレット とも呼ばれます。）このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。
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

---

プロパティ	説明
SSLClientCert	SSL クライアント認証（2-way SSL）のためのTLS/SSL クライアント証明書ストアを指定します。このプロパティは、他のSSL 関連プロパティと連動して、セキュアな接続を確立します。
SSLClientCertType	SSL クライアント認証用のTLS/SSL クライアント証明書を格納するキーストアの種類を指定します。プラットフォームや証明書のソースに応じて、さまざまなキーストア形式から選択できます。
SSLClientCertPassword	TLS/SSL クライアント証明書ストアにアクセスするために必要なパスワードを指定します。選択した証明書ストアの種類がアクセスにパスワードを必要とする場合、このプロパティを使用します。
SSLClientCertSubject	TLS/SSL クライアント証明書のサブジェクトを指定し、証明書ストアで場所を検索します。 CN=www.server.com, C=US のように、識別名フィールドのカンマ区切りのリストを使用します。ワイルドカード * は、ストアの先頭の証明書を選択します。
SSLServerCert	TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。

Firewall

---

プロパティ	説明
FirewallType	provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。
FirewallServer	ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。
FirewallPort	プロキシベースのファイアウォールで使用するTCP ポートを指定します。
FirewallUser	プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。
FirewallPassword	プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。

Proxy

---

プロパティ	説明
ProxyAutoDetect	provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。
ProxyServer	HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。
ProxyPort	クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバー（ProxyServer 接続プロパティで設定）のTCP ポート。
ProxyAuthScheme	ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。
ProxyUser	ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名。
ProxyPassword	ProxyUser 接続プロパティで指定されたユーザーに紐付けられたパスワード。
ProxySSLType	ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプ。
ProxyExceptions	ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

Logging

---

プロパティ	説明
LogModules	ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。

Schema

---

プロパティ	説明
Location	テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。
BrowsableSchemas	レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
Tables	レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。
Views	レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。

Miscellaneous

---

プロパティ	説明
IncludeArchivedSpaces	Whether to include content from archived spaces in the result. This defaults to false.
MaxRows	集計やGROUP BY を使用しないクエリで返される最大行数を指定します。
Other	特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。
Pagesize	Confluence から返される、1ページあたりの結果の最大数を指定します。この設定は、ほとんどのユースケースに最適化されている、データソースによって設定されたデフォルトのページサイズをオーバーライドします。
PseudoColumns	テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。
SpaceKey	By specifying the SpaceKey, the search results will only display contents from this specific space.
Timeout	provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。
UserDefinedViews	カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。

このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。

---

プロパティ	説明
AuthScheme	The type of authentication to use when connecting to Confluence.
URL	The URL to your JIRA endpoint.
User	認証するConfluence ユーザーアカウントのユーザーID を指定します。
Password	認証するユーザーアカウントのパスワードを指定します。
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.

The type of authentication to use when connecting to Confluence.

解説

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

The URL to your JIRA endpoint.

解説

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

認証するConfluence ユーザーアカウントのユーザーID を指定します。

解説

認証サーバーは、ユーザーのID を検証するためにUser とPassword の両方を必要とします。

認証するユーザーアカウントのパスワードを指定します。

解説

認証サーバーは、ユーザーのID を検証するためにUser とPassword の両方を必要とします。

APIToken of the currently authenticated user.

解説

APIToken of the currently authenticated user.

Personal Access Token of the currently authenticated user.

解説

Personal Access Token of the currently authenticated user.

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.

解説

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 プロパティの全リストを提供します。

---

プロパティ	説明
SSOLoginURL	ID プロバイダーのログインURL。
SSOProperties	ID プロバイダーへの接続に必要な追加プロパティを、セミコロンで区切ったリスト形式で指定します。
SSOExchangeUrl	SAML 応答を処理してサービスの資格情報と交換するために使用するURL。
SSOAppName	アプリ名を必要とするSSO のIdP で使用されるアプリ名.
SSOAppPassword	アプリパスワードを必要とするSSO のIdP で使用されるアプリパスワード。

ID プロバイダーのログインURL。

解説

ID プロバイダーのログインURL。

ID プロバイダーへの接続に必要な追加プロパティを、セミコロンで区切ったリスト形式で指定します。

解説

ID プロバイダーへの接続に必要な追加プロパティを、セミコロンで区切ったリスト形式で指定します。SSOLoginURL と一緒に使用します。

SSO 設定については、 で詳しく説明します。

SAML 応答を処理してサービスの資格情報と交換するために使用するURL。

解説

CData Sync App はここで指定されたURL を使用してSAML 応答を処理し、サービスの資格情報と交換します。 取得した資格情報はSSO 接続時の最後の情報であり、Confluence との通信に使用されます。

アプリ名を必要とするSSO のIdP で使用されるアプリ名.

解説

SSOAppPassword とともに、SSO IdP で設定されたアプリを識別して認証するために指定できます。 現在、クラウドのみサポートしています。

アプリパスワードを必要とするSSO のIdP で使用されるアプリパスワード。

解説

SSOAppName とともに、SSO IdP で設定されたアプリを識別して認証するために指定できます。 現在、クラウドのみサポートしています。

このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。

---

プロパティ	説明
OAuthVersion	使われているOAuth のバージョン。
OAuthClientId	カスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。（コンシューマーキーとも呼ばれます。）このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。
OAuthClientSecret	カスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。（ コンシューマーシークレット とも呼ばれます。）このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。
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.

使われているOAuth のバージョン。

解説

使われているOAuth のバージョン。次のオプションが利用可能です：1.0,2.0

カスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。（コンシューマーキーとも呼ばれます。）このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。

解説

OAuthClientId は、ユーザーがOAuth 経由で認証を行う前に設定する必要があるいくつかの接続パラメータの1つです。詳細は接続の確立を参照してください。

カスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。（ コンシューマーシークレット とも呼ばれます。）このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。

解説

OAuthClientSecret は、ユーザーがOAuth 経由で認証を行う前に設定する必要があるいくつかの接続パラメータの1つです。詳細は接続の確立を参照してください。

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

解説

スコープは、認証ユーザーがどのようなアクセス権を持つかを定義するために設定されます。例えば、読み取り、読み取りと書き込み、機密情報への制限付きアクセスなどです。システム管理者は、スコープを使用して機能またはセキュリティクリアランスによるアクセスを選択的に有効化できます。

InitiateOAuth がGETANDREFRESH に設定されている場合、要求するスコープを変更したい場合はこのプロパティを使用する必要があります。 InitiateOAuth がREFRESH またはOFF のいずれかに設定されている場合、要求するスコープを変更したい場合は、このプロパティまたはScope 入力を使用する必要があります。

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

The certificate store used for Confluence authentication.

解説

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

The password of the certificate store used with Confluence authentication.

解説

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.

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

解説

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

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

解説

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 プロパティの全リストを提供します。

---

プロパティ	説明
SSLClientCert	SSL クライアント認証（2-way SSL）のためのTLS/SSL クライアント証明書ストアを指定します。このプロパティは、他のSSL 関連プロパティと連動して、セキュアな接続を確立します。
SSLClientCertType	SSL クライアント認証用のTLS/SSL クライアント証明書を格納するキーストアの種類を指定します。プラットフォームや証明書のソースに応じて、さまざまなキーストア形式から選択できます。
SSLClientCertPassword	TLS/SSL クライアント証明書ストアにアクセスするために必要なパスワードを指定します。選択した証明書ストアの種類がアクセスにパスワードを必要とする場合、このプロパティを使用します。
SSLClientCertSubject	TLS/SSL クライアント証明書のサブジェクトを指定し、証明書ストアで場所を検索します。 CN=www.server.com, C=US のように、識別名フィールドのカンマ区切りのリストを使用します。ワイルドカード * は、ストアの先頭の証明書を選択します。
SSLServerCert	TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。

SSL クライアント認証（2-way SSL）のためのTLS/SSL クライアント証明書ストアを指定します。このプロパティは、他のSSL 関連プロパティと連動して、セキュアな接続を確立します。

解説

このプロパティは、SSL クライアント認証のためのクライアント証明書ストアを指定します。 このプロパティは、証明書ストアの種類を定義するSSLClientCertType、およびパスワードで保護されたストア用のパスワードを指定するSSLClientCertPassword と一緒に使用します。 SSLClientCert が設定され、SSLClientCertSubject が設定されている場合、ドライバーは指定されたサブジェクトに一致する証明書を検索します。

証明書ストアの指定はプラットフォームによって異なります。 Windowsでは、証明書ストアはMY（個人証明書）などの名前で識別されますが、Java では、証明書ストアは通常、証明書とオプションの秘密キーを含むファイルです。

Windows の共通のユーザとシステム証明書ストアの指定は以下のとおりです。

MY	個人証明書と関連付けられた秘密キーを格納している証明書ストア。
CA	証明機関の証明書。
ROOT	ルート証明書。
SPC	ソフトウェア発行元証明書。

PFXFile タイプの場合、このプロパティをファイル名に設定します。PFXBlob タイプの場合は、このプロパティをPKCS12 形式のファイルのバイナリコンテンツに設定します。

SSL クライアント認証用のTLS/SSL クライアント証明書を格納するキーストアの種類を指定します。プラットフォームや証明書のソースに応じて、さまざまなキーストア形式から選択できます。

解説

このプロパティは、クライアント証明書を指定するために使用されるキーストアの形式と場所を決定します。 サポートされている値には、プラットフォーム固有およびユニバーサルなキーストア形式があります。 有効な値と使用方法は以下のとおりです。

USER - デフォルト	Windows の場合、現在のユーザーにより所有された証明書ストアであることを指定します。この種類はJava では利用できませんので注意してください。
MACHINE	Windows の場合、この証明書ストアがシステムストアであることを指定します。この種類はJava では利用できませんので注意してください。
PFXFILE	この証明書ストアは、証明書を含むPFX（PKCS12）ファイルの名前です。
PFXBLOB	この証明書ストアは、PFX（PKCS12）形式の証明書ストアを表すBase-64でエンコードされた文字列です。
JKSFILE	この証明書ストアは、証明書を含むJava key store（JKS）ファイルの名前です。この種類はJava でのみ利用できますので注意してください。
JKSBLOB	この証明書ストアは、Java key store（JKS）形式の証明書ストアを表すBase-64でエンコードされた文字列です。この種類はJava でのみ利用できますので注意してください。
PEMKEY_FILE	この証明書ストアは、秘密キーと任意の証明書を含むPEM でエンコードされたファイルの名前です。
PEMKEY_BLOB	この証明書ストアは、秘密キーと任意の証明書を含むBase-64でエンコードされた文字列です。
PUBLIC_KEY_FILE	この証明書ストアは、PEM またはDER でエンコードされた公開キーの証明書を含むファイルの名前です。
PUBLIC_KEY_BLOB	この証明書ストアは、PEM またはDER でエンコードされた公開キーの証明書を含むBase-64でエンコードされた文字列です。
SSHPUBLIC_KEY_FILE	この証明書ストアは、SSH 公開キーを含むファイルの名前です。
SSHPUBLIC_KEY_BLOB	この証明書ストアは、SSH 公開キーを含むBase-64でエンコードされた文字列です。
P7BFILE	この証明書ストアは、証明書を含むPKCS7 ファイルの名前です。
PPKFILE	この証明書ストアは、PuTTY 秘密キー（PPK）を含むファイルの名前です。
XMLFILE	この証明書ストアは、XML 形式の証明書を含むファイルの名前です。
XMLBLOB	この証明書ストアは、XML 形式の証明書を含む文字列の名前です。
BCFKSFILE	この証明書ストアは、Bouncy Castle キーストアを含むファイルの名前です。
BCFKSBLOB	この証明書ストアは、Bouncy Castle キーストアを含む文字列（Base-64エンコード）です。

TLS/SSL クライアント証明書ストアにアクセスするために必要なパスワードを指定します。選択した証明書ストアの種類がアクセスにパスワードを必要とする場合、このプロパティを使用します。

解説

このプロパティは、パスワードで保護された証明書ストアを開くために必要なパスワードを指定します。 このプロパティは、PFX やJKS タイプのストアによく推奨されるように、復号化のためにパスワードを必要とする証明書ストアを使用する場合に必要です。

証明書ストアの種類がパスワードを必要としない場合（Windows のUSER やMACHINE など）、このプロパティは空白のままにできます。 認証エラーを回避するため、パスワードが指定された証明書ストアに関連付けられたものと一致していることを確認してください。

TLS/SSL クライアント証明書のサブジェクトを指定し、証明書ストアで場所を検索します。 CN=www.server.com, C=US のように、識別名フィールドのカンマ区切りのリストを使用します。ワイルドカード * は、ストアの先頭の証明書を選択します。

解説

このプロパティは、サブジェクトに基づいてロードするクライアント証明書を決定します。Sync App は、指定されたサブジェクトに完全に一致する証明書を検索します。 完全に一致するものが見つからない場合、Sync App はサブジェクトの値を含む証明書を検索します。 一致する証明書がない場合、証明書は選択されません。

サブジェクトは、識別名フィールドと値のカンマ区切りリストという標準の形式に従うべきです。 例えば、CN=www.server.com, OU=Test, C=US です。一般的なフィールドには以下のものが含まれます。

フィールド	説明
CN	共通名。一般的には、www.server.com のようなホスト名です。
O	法人名
OU	法人の部署名
L	法人の住所（市町村名）
S	法人の住所（都道府県）
C	国名
E	E メールアドレス

Note： フィールドにカンマなどの特殊文字が含まれている場合は、値を引用符で囲む必要があります。例：CN="Example, Inc.", C=US。

TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。

解説

TLS/SSL 接続を使用する場合は、このプロパティを使用して、サーバーが受け入れるTLS/SSL 証明書を指定できます。コンピュータによって信頼されていない他の証明書はすべて拒否されます。

このプロパティは、次のフォームを取ります：

説明	例
フルPEM 証明書（例では省略されています）	-----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
証明書を保有するローカルファイルへのパス。	C:\cert.cer
公開鍵（例では省略されています）	-----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
MD5 Thumbprint （hex 値はスペースおよびコロン区切り）	ecadbdda5a1529c58a1e9e09828d70e4
SHA1 Thumbprint （hex 値はスペースおよびコロン区切り）	34a929226ae0819f2ec14b4a3d904f801cbb150d

これを指定しない場合は、マシンが信用するすべての証明書が受け入れられます。

すべての証明書の受け入れを示すには、'*'を使用します。セキュリティ上の理由から、これはお勧めできません。

このセクションでは、本プロバイダーの接続文字列で設定可能なFirewall プロパティの全リストを提供します。

---

プロパティ	説明
FirewallType	provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。
FirewallServer	ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。
FirewallPort	プロキシベースのファイアウォールで使用するTCP ポートを指定します。
FirewallUser	プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。
FirewallPassword	プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。

provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。

解説

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

Note：デフォルトでは、Sync App はシステムプロキシに接続します。この動作を無効化し、次のプロキシタイプのいずれかに接続するには、ProxyAutoDetect をfalse に設定します。

次の表は、サポートされている各プロトコルのポート番号情報です。

プロトコル	デフォルトポート	説明
TUNNEL	80	Sync App がConfluence への接続を開くポート。トラフィックはこの場所のプロキシを経由して行き来します。
SOCKS4	1080	Sync App がConfluence への接続を開くポート。SOCKS 4 は次にFirewallUser 値をプロキシに渡し、接続リクエストが許容されるかどうかを決定します。
SOCKS5	1080	Sync App がConfluence にデータを送信するポート。SOCKS 5 プロキシに認証が必要な場合には、FirewallUser およびFirewallPassword をプロキシが認識する認証情報に設定します。

HTTP プロキシへの接続には、ProxyServer およびProxyPort ポートを使ってください。HTTP プロキシへの認証には、ProxyAuthScheme、ProxyUser、およびProxyPassword を使ってください。

ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。

解説

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

プロキシベースのファイアウォールで使用するTCP ポートを指定します。

解説

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。

解説

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。

解説

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

このセクションでは、本プロバイダーの接続文字列で設定可能なProxy プロパティの全リストを提供します。

---

プロパティ	説明
ProxyAutoDetect	provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。
ProxyServer	HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。
ProxyPort	クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバー（ProxyServer 接続プロパティで設定）のTCP ポート。
ProxyAuthScheme	ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。
ProxyUser	ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名。
ProxyPassword	ProxyUser 接続プロパティで指定されたユーザーに紐付けられたパスワード。
ProxySSLType	ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプ。
ProxyExceptions	ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。

解説

この接続プロパティをTrue に設定すると、Sync App は既存のプロキシサーバー構成についてシステムプロキシ設定をチェックします（プロキシサーバーの詳細を手動で入力する必要はありません）。

この接続プロパティは他のプロキシ設定より優先されます。特定のプロキシサーバーに接続するためにSync App を手動で構成する場合は、False に設定します。

HTTP プロキシへの接続には、ProxyServer を参照してください。SOCKS やトンネリングなどの他のプロキシには、FirewallType を参照してください。

HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。

解説

ProxyAutoDetect がFalse に設定されている場合、Sync App はこの接続プロパティで指定されたプロキシサーバーを通じてのみHTTP トラフィックをルーティングします。ProxyAutoDetect がTrue に設定されている場合（デフォルト）、Sync App は代わりにシステムプロキシ設定で指定されたプロキシサーバーを介してHTTP トラフィックをルーティングします。

クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバー（ProxyServer 接続プロパティで設定）のTCP ポート。

解説

ProxyAutoDetect がFalse に設定されている場合、Sync App はこの接続プロパティで指定されたプロキシサーバーポートを通じてのみHTTP トラフィックをルーティングします。ProxyAutoDetect がTrue に設定されている場合（デフォルト）、Sync App は代わりにシステムプロキシ設定で指定されたプロキシサーバーポートを介してHTTP トラフィックをルーティングします。

その他のプロキシタイプについては、FirewallType を参照してください。

ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。

解説

認証タイプは次のいずれかです。

• BASIC：Sync App はHTTP BASIC 認証を行います。
• DIGEST：Sync App はHTTP DIGEST 認証を行います。
• NTLM：Sync App はNTLM トークンを取得します。
• NEGOTIATE：Sync App は認証において有効なプロトコルに応じて、NTLM もしくはKerberos トークンを取得します。
• NONE：ProxyServer が認証を必要としない場合に設定します。

"NONE" 以外のすべての値については、ProxyUser およびProxyPassword 接続プロパティも設定する必要があります。

SOCKS 5 認証のような他の認証タイプを使用するには、FirewallType を参照してください。

ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名。

解説

ProxyUser および ProxyPassword 接続プロパティは、ProxyServer で指定されたHTTP プロキシに対して接続よび認証するために使用されます。

ProxyAuthScheme で利用可能な認証タイプを1つ選択した後、このプロパティを以下のように設定します。

ProxyAuthScheme の値	ProxyUser に設定する値
BASIC	プロキシサーバーに登録されているユーザーのユーザー名。
DIGEST	プロキシサーバーに登録されているユーザーのユーザー名。
NEGOTIATE	プロキシサーバーが属するドメインまたは信頼されたドメイン内の有効なユーザーであるWindows ユーザーのユーザー名。user@domain またはdomain\user の形式で指定。
NTLM	プロキシサーバーが属するドメインまたは信頼されたドメイン内の有効なユーザーであるWindows ユーザーのユーザー名。user@domain またはdomain\user の形式で指定。
NONE	ProxyPassword 接続プロパティは設定しないでください。

Sync App は、ProxyAutoDetect がFalse に設定されている場合にのみ、このユーザー名を使用します。ProxyAutoDetect がTrue に設定されている場合（デフォルト）、Sync App は代わりにシステムのプロキシ設定で指定されているユーザー名を使用します。

ProxyUser 接続プロパティで指定されたユーザーに紐付けられたパスワード。

解説

ProxyUser および ProxyPassword 接続プロパティは、ProxyServer で指定されたHTTP プロキシに対して接続よび認証するために使用されます。

ProxyAuthScheme で利用可能な認証タイプを1つ選択した後、このプロパティを以下のように設定します。

ProxyAuthScheme の値	ProxyPassword に設定する値
BASIC	ProxyUser で指定したプロキシサーバーユーザーに紐付けられたパスワード。
DIGEST	ProxyUser で指定したプロキシサーバーユーザーに紐付けられたパスワード。
NEGOTIATE	ProxyUser で指定したWindows ユーザーアカウントに紐付けられたパスワード。
NTLM	ProxyUser で指定したWindows ユーザーアカウントに紐付けられたパスワード。
NONE	ProxyPassword 接続プロパティは設定しないでください。

SOCKS 5 認証もしくは、トンネリングは、FirewallType を参照してください。

Sync App は、ProxyAutoDetect がFalse に設定されている場合にのみ、このパスワードを使用します。ProxyAutoDetect がTrue に設定されている場合（デフォルト）、Sync App は代わりにシステムのプロキシ設定で指定されているパスワードを使用します。

ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプ。

解説

このプロパティは、ProxyServer で指定されたHTTP プロキシへの接続にSSL を使用するかどうかを決定します。この接続プロパティには、以下の値を設定できます。

AUTO	デフォルト設定。ProxyServer がHTTPS URL に設定されている場合、Sync App は、TUNNEL オプションを使用します。ProxyServer がHTTP URL に設定されている場合、コンポーネントはNEVER オプションを使用します。
ALWAYS	接続は、常にSSL 有効となります。
NEVER	接続は、SSL 有効になりません。
TUNNEL	接続はトンネリングプロキシ経由で行われます。プロキシサーバーがリモートホストへの接続を開き、プロキシを経由して通信が行われます。

ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

解説

ProxyServer は、このプロパティで定義されたアドレスを除くすべてのアドレスに使用されます。セミコロンを使用してエントリを区切ります。

Sync App はデフォルトでシステムプロキシ設定を使用するため、それ以上の設定は必要ありません。この接続にプロキシ例外を明示的に設定する場合は、ProxyAutoDetect をFalse に設定します。

このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。

---

プロパティ	説明
LogModules	ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。

ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。

解説

このプロパティは、含めるログモジュールを指定することでログファイルの内容をカスタマイズすることができます。 ログモジュールは、クエリ実行、メタデータ、SSL 通信などの異なる領域にログ情報を分類します。 各モジュールは4文字のコードで表され、文字の名前の場合は末尾にスペースが必要なものもあります。

例えば、EXEC はクエリ実行をログに記録し、INFO は一般的なプロバイダーメッセージをログに記録します。 複数のモジュールを含めるには、次のように名前をセミコロンで区切ります：INFO;EXEC;SSL。

Verbosity 接続プロパティは、このプロパティで指定されたモジュールベースのフィルタリングよりも優先されます。 Verbosity レベルを満たし、指定されたモジュールに属するログエントリのみが記録されます。 利用可能なすべてのモジュールをログファイルに含めるには、このプロパティを空白のままにします。

利用可能なモジュールの完全なリストとログの設定に関する詳細な手引きについては、ログ の「高度なログの記録」セクションを参照してください。

このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。

---

プロパティ	説明
Location	テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。
BrowsableSchemas	レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
Tables	レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。
Views	レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。

テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。

解説

Location プロパティは、定義をカスタマイズしたり（例えば、カラム名を変更する、カラムを無視するなど）、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。

指定しない場合、デフォルトの場所は%APPDATA%\\CData\\Confluence Data Provider\\Schema となり、%APPDATA%はユーザーのコンフィギュレーションディレクトリに設定されます：

プラットフォーム	%APPDATA%
Windows	APPDATA 環境変数の値
Linux	~/.config

レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

解説

利用可能なデータベーススキーマをすべてリストすると余分な時間がかかり、パフォーマンスが低下します。 接続文字列にスキーマのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。

レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。

解説

データベースによっては、利用可能なすべてのテーブルをリストするのに時間がかかり、パフォーマンスが低下する場合があります。 接続文字列にテーブルのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。

利用可能なテーブルがたくさんあり、すでに作業したいテーブルが決まっている場合、このプロパティを使用して対象のテーブルのみに表示を制限することができます。これを行うには、カンマ区切りのリストで使用したいテーブルを指定します。各テーブルは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space` です。

Note：複数のスキーマまたはカタログを持つデータソースに接続する場合は、表示する各テーブルを完全修飾名で指定する必要があります。これにより、複数のカタログやスキーマに存在するテーブルが混同されることを防ぎます。

レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。

解説

データベースによっては、利用可能なすべてのビューをリストするのに時間がかかり、パフォーマンスが低下する場合があります。 接続文字列にビューのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。

利用可能なビューがたくさんあり、すでに作業したいビューが決まっている場合、このプロパティを使用して対象のビューのみに表示を制限することができます。これを行うには、カンマ区切りのリストで使用したいビューを指定します。各ビューは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space` です。

Note：複数のスキーマまたはカタログを持つデータソースに接続する場合は、確認する各ビューを完全修飾名で指定する必要があります。これにより、複数のカタログやスキーマに存在するビューが混同されることを防ぎます。

このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。

---

プロパティ	説明
IncludeArchivedSpaces	Whether to include content from archived spaces in the result. This defaults to false.
MaxRows	集計やGROUP BY を使用しないクエリで返される最大行数を指定します。
Other	特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。
Pagesize	Confluence から返される、1ページあたりの結果の最大数を指定します。この設定は、ほとんどのユースケースに最適化されている、データソースによって設定されたデフォルトのページサイズをオーバーライドします。
PseudoColumns	テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。
SpaceKey	By specifying the SpaceKey, the search results will only display contents from this specific space.
Timeout	provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。
UserDefinedViews	カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。

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

解説

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.

集計やGROUP BY を使用しないクエリで返される最大行数を指定します。

解説

このプロパティは、集計やGROUP BY 句を含まないクエリに対してSync App が返す行数の上限を設定します。 この制限により、クエリがデフォルトで過度に大きな結果セットを返さないようにします。

クエリにLIMIT 句が含まれている場合、クエリで指定された値がMaxRows 設定よりも優先されます。 MaxRows が"-1" に設定されている場合、LIMIT 句が明示的にクエリに含まれていない限り、行の制限は行われません。

このプロパティは、非常に大きなデータセットを返す可能性のあるクエリを実行する際に、パフォーマンスを最適化し過剰なリソース消費を防ぐのに役立ちます。

特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。

解説

このプロパティは、シニアユーザーが特定のシナリオに対して隠しプロパティを設定できるようにします。 これらの設定は通常のユースケースには必要ありませんが、特定の要件に対応したり、追加の機能を提供したりすることができます。 複数のプロパティをセミコロン区切りのリストで定義できます。

Note： 特定のシナリオや問題に対処するためにサポートチームから助言があった場合にのみ、これらのプロパティを設定することを強く推奨します。

複数のプロパティをセミコロン区切りリストで指定します。

統合およびフォーマット

DefaultColumnSize	データソースがメタデータにカラムの長さを提供しない場合に、文字列フィールドのデフォルトの長さを設定します。デフォルト値は2000です。
ConvertDateTimeToGMT	日時の値を、マシンのローカルタイムではなくGMT グリニッジ標準時に変換するかどうかを決定します。
RecordToFile=filename	基底のソケットデータ転送を指定のファイルに記録します。

Confluence から返される、1ページあたりの結果の最大数を指定します。この設定は、ほとんどのユースケースに最適化されている、データソースによって設定されたデフォルトのページサイズをオーバーライドします。

解説

クエリする特定のオブジェクトやサービスエンドポイントの結果を最適化するために、デフォルトのページサイズを調整したい場合があります。 ページサイズを大きくするとパフォーマンスが向上するかもしれませんが、ページあたりのメモリ消費量が増える可能性もあることに注意してください。

テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。

解説

このプロパティを使用すると、Sync App がテーブルカラムとして公開する擬似カラムを定義できます。

個々の擬似カラムを指定するには、以下の形式を使用します。"Table1=Column1;Table1=Column2;Table2=Column3"

すべてのテーブルのすべての擬似カラムを含めるには、次のようにします："*=*"

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

解説

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.

provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。

解説

このプロパティは、Sync App が操作をキャンセルする前に操作の完了を待機する最大時間を秒単位で制御します。 操作の完了前にタイムアウト時間が経過すると、Sync App は操作をキャンセルして例外をスローします。

タイムアウトは、クエリや操作全体ではなくサーバーとの個々の通信に適用されます。 例えば、各ページング呼び出しがタイムアウト制限内に完了する場合、クエリは60秒を超えて実行を続けることができます。

このプロパティを0に設定するとタイムアウトが無効になり、操作が成功するか、サーバー側のタイムアウト、ネットワークの中断、またはサーバーのリソース制限などの他の条件で失敗するまで無期限に実行されます。 このプロパティは慎重に使用してください。長時間実行される操作がパフォーマンスを低下させたり、応答しなくなる可能性があるためです。

カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。

解説

このプロパティを使用すると、UserDefinedViews.json というJSON 形式の構成ファイルを通じてカスタムビューを定義および管理できます。 これらのビューはSync App によって自動的に認識され、標準のデータベースビューのようにカスタムSQL クエリを実行できるようになります。 JSON ファイルは、各ビューをルート要素として定義し、その子要素として"query" を持ちます。この"query" にはビューのSQL クエリが含まれています。次に例を示します。

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

このプロパティを使用して、1つのファイルに複数のビューを定義し、ファイルパスを指定できます。 例：UserDefinedViews=C:\Path\To\UserDefinedViews.json。 このプロパティを使用すると、指定されたビューのみがSync App によって検知されます。

詳しくは、ユーザー定義ビュー を参照してください。