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 設定のカスタマイズ

TLS を有効化するには、以下を設定します。

• URL：接続文字列の前にhttps:// を付加します。

この設定により、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
Attachments	Get information about an attachment in a page or blogpost.
Blogposts	Get information about a blogpost within a space.
Groups	Get information about a specific group.
Pages	Get information about a page within a space.
Spaces	Returns information about a number of spaces.

Get information about an attachment in a page or blogpost.

Table Specific Information

Select

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

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

For example, the following queries are processed server side:

SQL

SELECT * FROM Attachments WHERE Id = '1234'

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

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

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

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

SELECT * FROM Attachments ORDER BY Id DESC

SELECT * FROM Attachments ORDER BY CreatedByUserName ASC

CQL

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

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

Columns

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

Pseudo-Columns

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

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

Get information about a blogpost within a space.

Table Specific Information

Select

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

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

For example, the following queries are processed server side:

SQL

SELECT * FROM Blogposts WHERE Id = '1234'

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

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

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

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

SELECT * FROM Blogposts ORDER BY Id DESC

SELECT * FROM Blogposts ORDER BY CreatedByUserName ASC

CQL

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

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

Columns

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

Pseudo-Columns

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

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

Get information about a specific group.

Table Specific Information

Select

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

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

For example, the following queries are processed server side:

SELECT * FROM Groups WHERE Name = 'test'

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

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

Columns

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

Get information about a page within a space.

Table Specific Information

Select

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

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

For example, the following queries are processed server side:

SQL

SELECT * FROM Pages WHERE Id = '1234'

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

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

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

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

SELECT * FROM Pages ORDER BY Id DESC

SELECT * FROM Pages ORDER BY CreatedByUserName ASC

CQL

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

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

Columns

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

Pseudo-Columns

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

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

Returns information about a number of spaces.

Table Specific Information

Select

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

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

For example, the following queries are processed server side:

SQL

SELECT * FROM Spaces WHERE Key = 'abc'

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

SELECT * FROM Spaces WHERE Excerpt = 'driver development'

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

CQL

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

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

Columns

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

Pseudo-Columns

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

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

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

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

Confluence Connector for CData Sync ビュー

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

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

View-Specific Information

Select

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

• UserKey supports the = operator.

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

SELECT * FROM AllUsers WHERE UserKey = '1234567890abcdef'

The Sync App processes other filters client-side.

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

Columns

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

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

View-Specific Information

Select

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

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

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

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

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

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

The Sync App processes other filters client-side.

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

Columns

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

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

Table Specific Information

Select

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

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

For example, the following queries are processed server side:

SQL

SELECT * FROM Comments WHERE Id = '1234'

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

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

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

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

SELECT * FROM Comments ORDER BY Id DESC

SELECT * FROM Comments ORDER BY CreatedByUserName ASC

CQL

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

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

Columns

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

Pseudo-Columns

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

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

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

View-Specific Information

Select

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

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

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

SELECT * FROM Contributors WHERE ContentId = '1234'

SELECT * FROM Contributors WHERE ContentId != '1234'

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

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

SELECT * FROM Contributors WHERE AccountId = '12345678'

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

SELECT * FROM Contributors WHERE ContentType = 'page'

SELECT * FROM Contributors WHERE ContentType != 'page'

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

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

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

SELECT * FROM Contributors ORDER BY ContentId DESC

The Sync App processes other filters client-side.

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

Columns

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

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

Table Specific Information

Select

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

• Name supports the '=' comparisons.

For example, the following queries are processed server side:

SELECT * FROM GroupMembers WHERE Name = 'test1'

Columns

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

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

View-Specific Information

Select

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

• ContentId supports the = operator.

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

SELECT * FROM GroupsContentRestrictions WHERE ContentId = '123456789'

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

The Sync App processes other filters client-side.

Columns

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

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

View-Specific Information

Select

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

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

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

SELECT * FROM Labels WHERE ContentId = '1234'

SELECT * FROM Labels WHERE ContentId != '1234'

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

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

SELECT * FROM Labels WHERE LabelName = 'test'

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

SELECT * FROM Labels WHERE ContentType = 'page'

SELECT * FROM Labels WHERE ContentType != 'page'

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

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

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

SELECT * FROM Labels ORDER BY ContentId DESC

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

The Sync App processes other filters client-side.

Columns

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

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

Table Specific Information

Select

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

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

• PageId supports the '=' comparison.

For example, the following queries are processed server side:

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

Columns

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

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

Columns

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

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

Table Specific Information

Select

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

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

• PageId supports the '=' comparison.

For example, the following queries are processed server side:

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

Columns

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

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

Table Specific Information

Select

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

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

• PageId supports the '=' comparison.

For example, the following queries are processed server side:

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

Columns

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

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

View-Specific Information

Select

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

• SpaceId supports the = operator.

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

SELECT * FROM SpacePermissions WHERE SpaceId = '123456789'

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

The Sync App processes other filters client-side.

Columns

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

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

Columns

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

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

Table Specific Information

Select

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

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

For example, the following queries are processed server side:

SQL

SELECT * FROM Users WHERE AccountId = '1234'

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

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

CQL

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

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

Columns

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

Pseudo-Columns

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

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

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

View-Specific Information

Select

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

• ContentId supports the = operator.

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

SELECT * FROM UsersContentRestrictions WHERE ContentId = '123456789'

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

The Sync App processes other filters client-side.

Columns

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

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

Table Specific Information

Select

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

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

For example, the following queries are processed server side:

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

Columns

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

Pseudo-Columns

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

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

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

Table Specific Information

Select

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

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

For example, the following queries are processed server side:

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

Columns

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

Pseudo-Columns

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

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

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

Columns

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

Pseudo-Columns

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

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

ストアドプロシージャはファンクションライクなインターフェースで、Confluence の単純なSELECT/INSERT/UPDATE/DELETE 処理にとどまらずSync App の機能を拡張します。

ストアドプロシージャは、パラメータのリストを受け取り、目的の機能を実行し、プロシージャが成功したか失敗したかを示すとともにConfluence から関連するレスポンスデータを返します。

Confluence Connector for CData Sync ストアドプロシージャ

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

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

Input

Name	Type	Required	Description
Id	String	False	The unique identifier of the content item (such as a page or blog post) to which the attachment belongs.
AttachmentId	String	True	The unique identifier of the attachment to be downloaded.
Version	String	False	Specifies the version of the attachment to download. If not provided, the latest version is downloaded by default.
FileLocation	String	False	The absolute or relative path where the downloaded file will be saved.
Overwrite	String	False	If the value is 'true', existing files at the target location will be overwritten. If the value is 'false', the procedure preserves existing files. The default value is 'false'.
Encoding	String	False	Specifies the encoding type used for the file data, defining how the content is read or written. 使用できる値は次のとおりです。NONE, BASE64 デフォルト値はBASE64です。

Result Set Columns

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

Gets an authentication token from Confluence.

Input

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

Result Set Columns

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

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

Input

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

Result Set Columns

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

Refreshes the OAuth access token used for authentication with Confluence.

Input

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

Result Set Columns

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

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

Input

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

Result Set Columns

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

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

Input

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

Result Set Columns

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

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

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

Authentication

---

プロパティ	説明
AuthScheme	Specifies the authentication scheme that the provider uses when connecting to Confluence.
URL	Specifies the base URL of your Confluence site.
User	認証するユーザーのユーザーID を指定します。
Password	認証するユーザーのパスワードを指定します。
APIToken	Specifies the API token of the authenticated user.
PAT	Specifies the personal access token used to authenticate the user when the authentication scheme is set to PAT.
Timezone	Specifies the timezone of the Confluence instance so the provider can apply datetime filters correctly and return results in the correct local time.

SSO

---

プロパティ	説明
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 認可サーバーに対してアプリケーションを認証するために使用されます。（カスタムOAuth アプリケーションのみ）
Scope	Specifies the OAuth scopes that provider requests when authenticating with Confluence.
CertificateStore	Specifies the certificate store that provider uses for OAuth 1.0 authentication.
CertificateStorePassword	Specifies the password used to open the certificate store for OAuth 1.0 authentication.
CertificateSubject	Specifies the subject of the certificate used with Confluence Private Application authentication.
CertificateStoreType	Specifies the type of certificate store used with Confluence Private Application authentication.

SSL

---

プロパティ	説明
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 トラフィックをルーティングするために予約された、指定されたプロキシサーバーの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

---

プロパティ	説明
FullOrderByPushDown	Specifies whether provider pushes ORDER BY operations on the server-side for datetime columns that only support second-level precision.
IgnoreErrorsOnPagination	Specifies which server errors the provider should ignore when paging through Data Center tables that use client-side pagination.
IncludeArchivedSpaces	Specifies whether provider includes content from archived spaces in query results.
MaxRows	集計やGROUP BY を含まないクエリで返される最大行数を指定します。
Other	特定の問題に対処するため、特殊なシナリオ向けの高度な接続プロパティを指定します。このプロパティは、サポートチームの指示がある場合にのみ使用してください。
Pagesize	provider がConfluence にデータをリクエストするときに返す、ページあたりの最大レコード数を指定します。
PseudoColumns	テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。
SpaceKey	Specifies the Confluence space key that provider uses to limit results to a single space.
Timeout	provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。
UserDefinedViews	カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。

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

---

プロパティ	説明
AuthScheme	Specifies the authentication scheme that the provider uses when connecting to Confluence.
URL	Specifies the base URL of your Confluence site.
User	認証するユーザーのユーザーID を指定します。
Password	認証するユーザーのパスワードを指定します。
APIToken	Specifies the API token of the authenticated user.
PAT	Specifies the personal access token used to authenticate the user when the authentication scheme is set to PAT.
Timezone	Specifies the timezone of the Confluence instance so the provider can apply datetime filters correctly and return results in the correct local time.

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

解説

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

Confluence supports the following authentication schemes:

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

Specifies the base URL of your Confluence site.

解説

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

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

This property is required when establishing any connection to Confluence.

認証するユーザーのユーザーID を指定します。

解説

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

認証するユーザーのパスワードを指定します。

解説

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

Specifies the API token of the authenticated user.

解説

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

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

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

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

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

解説

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

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

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

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

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

解説

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

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

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

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

このセクションでは、本プロバイダーの接続文字列で設定可能な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 認可サーバーに対してアプリケーションを認証するために使用されます。（カスタムOAuth アプリケーションのみ）
Scope	Specifies the OAuth scopes that provider requests when authenticating with Confluence.
CertificateStore	Specifies the certificate store that provider uses for OAuth 1.0 authentication.
CertificateStorePassword	Specifies the password used to open the certificate store for OAuth 1.0 authentication.
CertificateSubject	Specifies the subject of the certificate used with Confluence Private Application authentication.
CertificateStoreType	Specifies the type of certificate store used with Confluence Private Application authentication.

使われているOAuth のバージョンを指定します。

解説

有効な入力値は次のとおりです：1.0,2.0

カスタムOAuth アプリケーションに割り当てられたクライアントID（コンシューマーキーとも呼ばれます）を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。

解説

このプロパティは2つのケースで必要となります：

• カスタムOAuth アプリケーションを使用する場合。たとえば、Web ベースの認証フロー、サービスベースの認証、またはアプリケーションの登録が必要な証明書ベースのフローなどが該当します。
• ドライバーが埋め込みOAuth 資格情報を提供しない場合。

（ドライバーが埋め込みOAuth 資格情報を提供する場合、この値はすでにSync App によって設定されており、手動で入力する必要がないことがあります。）

OAuthClientId は、認証付きの接続を構成する際に、OAuthClientSecret やOAuthSettingsLocation などの他のOAuth 関連プロパティと一緒に使用されるのが一般的です。

OAuthClientId は、ユーザーがOAuth 経由で認証を行う前に設定する必要がある、主要な接続パラメータの1つです。 この値は、通常、ID プロバイダーのアプリケーション登録設定で確認できます。 Client ID、Application ID、Consumer Key などとラベル付けされた項目を探してください。

クライアントID は、クライアントシークレットのような機密情報とは見なされませんが、アプリケーションの識別情報の一部であるため、慎重に取り扱う必要があります。公開リポジトリや共有設定ファイルでこの値を露出させないようにしてください。

接続設定時にこのプロパティを使用する方法の詳細については、接続の確立 を参照してください。

カスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。（カスタムOAuth アプリケーションのみ）

解説

このプロパティ（アプリケーションシークレットまたはコンシューマシークレットとも呼ばれます）は、安全なクライアント認証を必要とするすべてのフローでカスタムOAuth アプリケーションを使用する場合に必要です。たとえば、Web ベースのOAuth、サービスベースの接続、証明書ベースの認可フローなどが該当します。 組み込みOAuth アプリケーションを使用する場合は必要ありません。

クライアントシークレットは、OAuth フローのトークン交換ステップで使用されます。このステップでは、ドライバーが認可サーバーにアクセストークンを要求します。 この値が欠落しているか正しくない場合、認証はinvalid_client またはunauthorized_client エラーで失敗します。

OAuthClientSecret は、ユーザーがOAuth 経由で認証を行う前に設定する必要がある、主要な接続パラメータの1つです。この値は、OAuth アプリケーションを登録する際にID プロバイダーから取得できます。

Notes：

• この値は安全に保管し、公開リポジトリやスクリプト、安全でない環境では決して公開しないようにしてください。
• クライアントシークレットは、一定期間が経過すると有効期限が切れる場合もあります。 アクセスを中断させないために、有効期限を常に監視し、必要に応じてシークレットをローテーションするようにしてください。

接続設定時にこのプロパティを使用する方法の詳細については、接続の確立 を参照してください。

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

解説

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

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

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

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

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

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

For Server instances, the default scopes are: READ WRITE

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

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

解説

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

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

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

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

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

解説

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

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

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

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

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

解説

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

About the Confluence Client SSL Auth Flow

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

Loading a Certificate

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

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

Specifying the Subject

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

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

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

Additional Connection Properties

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

• CertificateStore
• CertificateStoreType
• CertificateStorePassword

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

解説

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

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

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

Specifying the Certificate Store Type

The CertificateStoreType property can take one of the following values:

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

Related Connection Properties

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

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

このセクションでは、本プロバイダーの接続文字列で設定可能な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

Note：'*' を使用してすべての証明書を受け入れるように指定することも可能ですが、セキュリティ上の懸念があるため推奨されません。

このセクションでは、本プロバイダーの接続文字列で設定可能な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 トラフィックをルーティングするために予約された、指定されたプロキシサーバーのTCP ポートを指定します。
ProxyAuthScheme	ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。
ProxyUser	ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名を提供します。
ProxyPassword	ProxyUser 接続プロパティで指定されたユーザーのパスワードを指定します。
ProxySSLType	ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプを指定します。
ProxyExceptions	ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリストを指定します。

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

解説

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

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

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

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

解説

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

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

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

解説

ProxyAutoDetect がFalse に設定されている場合、Sync App はこの接続プロパティで指定されたProxyServer ポートを通じてのみHTTP トラフィックをルーティングします。

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

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

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

解説

サポートされる認証の種類：

• BASIC：Sync App はHTTP Basic 認証を行います。
• DIGEST：Sync App はHTTP ダイジェスト認証を行います。
• 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 接続プロパティは設定しないでください。

Note：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 を参照してください。

Note：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 は、このプロパティで定義されたアドレスを除くすべてのアドレスに使用されます。セミコロンを使用してエントリを区切ります。

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

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

---

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

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

解説

Sync App は、実行する各操作の詳細を Logfile 接続プロパティで指定されたログファイルに書き込みます。

ログに記録される各操作は、モジュールと呼ばれるカテゴリに分類されます。各モジュールには対応する短いコードがあり、個々の Sync App の操作がどのモジュールに属するかを示すラベルとして使用されます。

この接続プロパティにモジュールコードをセミコロン区切りのリストで設定すると、指定したモジュールに属する操作のみがログファイルに書き込まれます。この設定は今後のログ記録にのみ適用され、既存のログファイルの内容には影響しません。例: INFO;EXEC;SSL;META;

デフォルトでは、すべてのモジュールの操作がログに含まれます。

モジュールを明示的に除外するには、先頭に「-」を付けます。例: -HTTP

サブモジュールにフィルターを適用するには、<モジュール名>.<サブモジュール名> の構文で指定します。たとえば、次の値を設定すると、Sync App は HTTP モジュールに属するアクションのみをログに記録し、さらに HTTP モジュールの Res サブモジュールに属するアクションを除外します: HTTP;-HTTP.Res

Verbosity 接続プロパティによるログファイルのフィルタリングは、この接続プロパティによるフィルタリングよりも優先されます。そのため、Verbosity 接続プロパティで指定したレベルよりも高い詳細レベルの操作は、この接続プロパティで指定したモジュールに属していても、ログファイルには出力されません。

使用可能なモジュールとサブモジュールは次のとおりです。

モジュール名	モジュールの説明	サブモジュール
INFO	一般情報。接続文字列、製品バージョン（ビルド番号）、および初期接続メッセージが含まれます。	Connec — 接続の作成または破棄に関連する情報。 Messag — 接続、接続文字列、製品バージョンに関するメッセージの汎用ラベル。これらのメッセージは通常、サービスから直接受信して転送されるものではなく、Sync App 固有のものです。
EXEC	クエリ実行。ユーザーが記述した SQL クエリ、解析済み SQL クエリ、正規化済み SQL クエリの実行メッセージが含まれます。クエリおよびクエリページの成功/失敗メッセージもここに表示されます。	Messag — クエリ実行に関するメッセージ。これらのメッセージは通常、サービスから直接受信して転送されるものではなく、Sync App 固有のものです。 Normlz — クエリの正規化ステップ。クエリの正規化とは、ユーザーが送信したクエリを、最適なパフォーマンスで同じ結果を得られるように書き換える処理です。 Origin — ユーザーの元のクエリ（ユーザーが実行した正確で未変更の非正規化クエリ）を記録するメッセージに適用されるラベル。 Page — クエリのページングに関連するメッセージ。 Parsed — クエリの解析ステップ。解析とは、ユーザーが送信したクエリを、処理しやすい標準化された形式に変換するプロセスです。
HTTP	HTTP プロトコルメッセージ。HTTP リクエスト/レスポンス（POST メッセージを含む）、および Kerberos 関連のメッセージが含まれます。	KERB — Kerberos に関連する HTTP リクエスト。 Messag — HTTP プロトコルに関するメッセージ。これらのメッセージは通常、サービスから直接受信して転送されるものではなく、Sync App 固有のものです。 Unpack — サービス API から返された圧縮データを製品が解凍する際のメッセージに適用されるラベル。 Res — HTTP レスポンスを含むメッセージ。 Req — HTTP リクエストを含むメッセージ。
WSDL	WSDL/XSD ファイルの生成に関するメッセージ。	—
SSL	SSL 証明書メッセージ。	Certif — SSL 証明書に関するメッセージ。
AUTH	認証関連の失敗/成功メッセージ。	Messag — 認証に関するメッセージ。これらのメッセージは通常、サービスから直接受信して転送されるものではなく、Sync App 固有のものです。 OAuth — OAuth 認証に関連するメッセージ。 Krbros — Kerberos 関連の認証メッセージ。
SQL	SQL トランザクション、SQL 一括転送メッセージ、および SQL 結果セットメッセージが含まれます。	Bulk — 一括クエリ実行に関するメッセージ。 Cache — パフォーマンス向上のため、製品のキャッシュへの行データの読み書きに関連するメッセージ。 Messag — SQL トランザクションに関するメッセージ。これらのメッセージは通常、サービスから直接受信して転送されるものではなく、Sync App 固有のものです。 ResSet — クエリの結果セット。 Transc — 実行されたジョブ数やバックアップテーブルの処理に関する情報を含む、トランザクション処理に関連するメッセージ。
META	メタデータキャッシュとスキーマメッセージ。	Cache — パフォーマンス向上のため、製品のキャッシュ内のカラムおよびテーブル定義の読み取りと変更に関連するメッセージ。 Schema — サービススキーマからのメタデータの取得またはサービススキーマの変更に関連するメッセージ。 MemSto — インメモリメタデータキャッシュへの書き込みまたは読み取りに関連するメッセージ。 Storag — メモリ内ではなく、ディスクまたは外部データストアへのメタデータの保存に関連するメッセージ。
FUNC	SQL 関数の実行に関連する情報。	Errmsg — SQL 関数の実行に関連するエラーメッセージ。
TCP	TCP トランスポートレイヤーメッセージでの送受信生バイト。	Send — TCP プロトコル経由で送信された生データ。 Receiv — TCP プロトコル経由で受信した生データ。
FTP	File Transfer Protocol に関するメッセージ。	Info — FTP プロトコルでの通信に関連するステータスメッセージ。 Client — FTP 通信中に FTP クライアント（製品）が実行したアクションに関連するメッセージ。 Server — FTP 通信中に FTP サーバーが実行したアクションに関連するメッセージ。
SFTP	Secure File Transfer Protocol に関するメッセージ。	Info — SFTP プロトコルでの通信に関連するステータスメッセージ。 To_Server — SFTP 通信中に SFTP クライアント（製品）が実行したアクションに関連するメッセージ。 From_Server — SFTP 通信中に SFTP サーバーが実行したアクションに関連するメッセージ。
POP	Post Office Protocol 経由で転送されるデータに関するメッセージ。	Client — POP 通信中に POP クライアント（製品）が実行したアクションに関連するメッセージ。 Server — POP 通信中に POP サーバーが実行したアクションに関連するメッセージ。 Status — POP プロトコルでの通信に関連するステータスメッセージ。
SMTP	Simple Mail Transfer Protocol 経由で転送されるデータに関するメッセージ。	Client — SMTP 通信中に SMTP クライアント（製品）が実行したアクションに関連するメッセージ。 Server — SMTP 通信中に SMTP サーバーが実行したアクションに関連するメッセージ。 Status — SMTP プロトコルでの通信に関連するステータスメッセージ。
CORE	他のモジュールでカバーされていない、さまざまな製品内部操作に関連するメッセージ。	—
DEMN	SQL リモーティングに関連するメッセージ。	—
CLJB	一括データアップロード（クラウドジョブ）に関するメッセージ。	Commit — 一括データアップロードの送信。
SRCE	他のモジュールに属さない、製品が生成するその他のメッセージ。	—
TRANCE	低レベルの製品操作に関する高度なメッセージ。	—

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

---

プロパティ	説明
FullOrderByPushDown	Specifies whether provider pushes ORDER BY operations on the server-side for datetime columns that only support second-level precision.
IgnoreErrorsOnPagination	Specifies which server errors the provider should ignore when paging through Data Center tables that use client-side pagination.
IncludeArchivedSpaces	Specifies whether provider includes content from archived spaces in query results.
MaxRows	集計やGROUP BY を含まないクエリで返される最大行数を指定します。
Other	特定の問題に対処するため、特殊なシナリオ向けの高度な接続プロパティを指定します。このプロパティは、サポートチームの指示がある場合にのみ使用してください。
Pagesize	provider がConfluence にデータをリクエストするときに返す、ページあたりの最大レコード数を指定します。
PseudoColumns	テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。
SpaceKey	Specifies the Confluence space key that provider uses to limit results to a single space.
Timeout	provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。
UserDefinedViews	カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。

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

解説

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

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

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

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

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

解説

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

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

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

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

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

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

解説

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

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

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

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

解説

このプロパティのデフォルト値である-1 は、クエリに明示的にLIMIT 句が含まれていない限り、行の制限が適用されないことを意味します。 （クエリにLIMIT 句が含まれている場合、クエリで指定された値がMaxRows 設定よりも優先されます。）

MaxRows を0より大きい整数に設定することで、クエリがデフォルトで過度に大きな結果セットを返さないようにします。

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

特定の問題に対処するため、特殊なシナリオ向けの高度な接続プロパティを指定します。このプロパティは、サポートチームの指示がある場合にのみ使用してください。

解説

このプロパティにより、シニアユーザーはサポートチームのアドバイスに基づいて、特定の状況に対応する隠しプロパティを設定できます。 これらの設定は通常のユースケースには必要ありませんが、特定の要件に対応したり、追加の機能を提供したりすることができます。 複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。

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

統合およびフォーマット

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

provider がConfluence にデータをリクエストするときに返す、ページあたりの最大レコード数を指定します。

解説

クエリを処理する際、Confluence でクエリされたデータすべてを一度にリクエストする代わりに、Sync App はクエリされたデータをページと呼ばれる部分ごとにリクエストすることができます。

この接続プロパティは、Sync App がページごとにリクエストする結果の最大数を決定します。

Note：大きなページサイズを設定すると全体的なクエリ実行時間が短縮される可能性がありますが、その場合、クエリ実行時にSync App がより多くのメモリを使用することになり、タイムアウトが発生するリスクがあります。

テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。

解説

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

個々の擬似カラムを指定するには、以下の形式を使用します。

Table1=Column1;Table1=Column2;Table2=Column3

すべてのテーブルのすべての擬似カラムを含めるには、次を使用してください：

*=*

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

解説

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

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

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

provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。

解説

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

タイムアウトはデフォルトで60秒に設定されています。タイムアウトを無効にするには、このプロパティを0に設定します。

タイムアウトを無効にすると、操作が成功するか、サーバー側のタイムアウト、ネットワークの中断、またはサーバーのリソース制限などの他の条件で失敗するまで無期限に実行されます。

Note： このプロパティは慎重に使用してください。長時間実行される操作がパフォーマンスを低下させたり、応答しなくなる可能性があるためです。

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

解説

UserDefinedViews を使用すると、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

UserDefinedViews でビューを指定すると、Sync App はそのビューだけを参照します。

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

LZMA from 7Zip LZMA SDK

LZMA SDK is placed in the public domain.

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

LZMA2 from XZ SDK

Version 1.9 and older are in the public domain.

Xamarin.Forms

Xamarin SDK

The MIT License (MIT)

Copyright (c) .NET Foundation Contributors

All rights reserved.

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

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

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

NSIS 3.10

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

1. DEFINITIONS

"Contribution" means:

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

i) changes to the Program, and

ii) additions to the Program;

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

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

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

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

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

2. GRANT OF RIGHTS

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

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

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

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

3. REQUIREMENTS

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

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

b) its license agreement:

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

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

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

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

When the Program is made available in source code form:

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

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

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

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

4. COMMERCIAL DISTRIBUTION

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

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

5. NO WARRANTY

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

6. DISCLAIMER OF LIABILITY

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

7. GENERAL

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

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

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

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

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