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

必須プロパティは［設定］タブにリストされています。［Advanced］タブには、通常は必要ない接続プロパティが表示されます。

Connecting to Confluence

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

Authenticating to Confluence

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

Basic Authentication

Confluence Cloud Account

Aquire a Token

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

Authenticate Using the Token

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

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

Confluence Server Instance

To authenticate to a Server instance, specify the following:

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

OAuth

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

Web Applications

When connecting via a web application, you need to register a custom OAuth app with Confluence. See カスタムOAuth アプリの作成 for more information. You can then use the Sync App to get and manage the OAuth token values.

Get an OAuth Access Token

Set the following connection properties to obtain the OAuthAccessToken:

• OAuthClientId: Set to the client Id in your app settings.
• OAuthClientSecret: Set to the client secret in your app settings.
• OAuthVersion: Set to 2.0.
• Url: The URL to your Confluence endpoint; for example, https://yoursitename.atlassian.net.

Then call stored procedures to complete the OAuth exchange:

1. Call the GetOAuthAuthorizationURL stored procedure. Set the AuthMode input to WEB and set the CallbackURL input to the Redirect URI you specified in your app settings. If necessary, set the Permissions parameter to request custom permissions. The stored procedure returns the URL to the OAuth endpoint.
2. Open the URL, log in, and authorize the application. You are redirected back to the callback URL.
3. Call the GetOAuthAccessToken stored procedure. Set the AuthMode input to WEB. Set the Verifier input to the "code" parameter in the query string of the callback URL. If necessary, set the Permissions parameter to request custom permissions.

To connect to data, set the OAuthAccessToken connection property to the access token returned by the stored procedure. When the access token expires after ExpiresIn seconds, call the GetOAuthAccessToken stored procedure again to obtain a new access token.

Crowd

AuthScheme をCrowd に設定します。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

AuthScheme をOkta に設定します。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 入力パラメータの組み合わせを使用する必要があります。それ以外の場合、これらの値を設定する必要はありません。

SSOProperties に、必要に応じて以下の入力パラメータを設定します。

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

接続文字列の例：

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

Fine Tuning Data Access

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

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

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

ユーザー定義ビュー

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

SSL の設定

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

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

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

クエリ処理

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

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

ログ

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

SSL 設定のカスタマイズ

デフォルトでは、Sync App はサーバーの証明書をシステムの信頼できる証明書ストアと照合してSSL / TLS のネゴシエーションを試みます。

別の証明書を指定するには、利用可能なフォーマットについてSSLServerCert プロパティを参照してください。

クライアントSSL 証明書

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

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

Firewall またはProxy 経由の接続

HTTP プロキシ

Windows のシステムプロキシ経由の接続では、接続プロパティを追加で設定する必要はありません。他のプロキシに接続するには、ProxyAutoDetect をfalse に設定します。

さらにHTTP プロキシへの認証には、ProxyServer とProxyPort に加えてProxyAuthScheme、ProxyUser、およびProxyPassword を設定します。

その他のプロキシ

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

• プロキシベースのファイヤーウォールを使用するには、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.

ビューは、カラムと疑似カラムで構成されます。ビューは、データを示すという点でテーブルに似ていますが、ビューでは更新はサポートされません。通常、ビューとして表されるエンティティは、読み取り専用のエンティティです。多くの場合、これらのデータはストアドプロシージャを使用することで更新できます（その機能がデータソースに適用できる場合）。

ビューに対しては、通常のテーブルと同じようにクエリを実行でき、このときに返されるデータも同様です。

ビューとして公開されるクエリなどの動的ビューや、project_team ワークアイテムの特定の組み合わせを検索するためのビューがサポートされています。

Confluence Connector for CData Sync ビュー

Name	Description
Attachments	Get information about a specific attachment.
AuditRecords	Fetch a paginated list of AuditRecord instances dating back to a certain time.
Blogposts	Get information about a specific blogpost.
Comments	Get information about a specific comment.
Contributors	Get information about the users who have contributed to the content.
GroupMembers	Get users of a specific group.
Groups	Get information about a specific group.
Labels	Get information about the labels that a specific content has.
PageAncestors	To look at a page hierarchy including who is the parent page.
PageChildrens	To look at a page hierarchy including who is the child page.
PageComments	Get comments specific to a page.
PageContents	Get content from the page.
Pages	Get information about a specific page.
Spaces	Returns information about a number of spaces.
Users	Get information about a user identified.
ViewersAnalytics	Get the total number of distinct viewers a piece of content has.
ViewsAnalytics	Get the total number of views a piece of content has.

Get information about a specific attachment.

Table Specific Information

Select

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

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

For example, the following queries are processed server side:

SQL

SELECT * FROM Attachments WHERE Id = '1234'

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

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

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

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

SELECT * FROM Attachments ORDER BY Id DESC

SELECT * FROM Attachments ORDER BY CreatedByUserName ASC

CQL

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

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

Columns

Name	Type	References	SupportedOperators	Description
Id [KEY]	String		=,!=,IN,NOT IN	Id of the attachment.
Type	String		=,!=,IN,NOT IN	Type of the content.
Title	String		=,!=,LIKE,NOT LIKE,IN,NOT IN	Title of the attachment.
Status	String			Status of the attachment.
SpaceKey	String	Spaces.Key	=,!=,IN,NOT IN	The key of the space that the attachment belongs to.
SpaceType	String	Spaces.Type	=,!=,IN,NOT IN	The type of the space that the attachment belongs to.
Position	String			Position of the attachment.
URL	String			URL of the attachment.
Excerpt	String			Excerpt of the attachment.
IsLatest	Boolean			Indicator if this is the latest version of the attachment.
CreatedByUserName	String		=,!=,IN,NOT IN	Username of the user who created the attachment.
CreatedByUserType	String			Type of the user who created the attachment.
CreatedDate	Datetime		=,!=,>,>=,<,<=	Datetime for the creation of the attachment.
LastUpdatedDatetime	Datetime		=,!=,>,>=,<,<=	Datetime of the last updated version of the attachment.
LastUpdatedMessage	String			Message of the last updated version.
LastUpdatedNumber	Integer			Number of the last updated version.
LastUpdatedUserName	String			Username of the user who updated the latest version.
LastUpdatedUserType	String			Type of the user who updated the latest version.
LastUpdatedIsMinorEdit	Boolean			Indicator if this version is a minor edit.
LastUpdatedIsHidden	Boolean			Indicator if the last updated version is hidden or not.
PreviousVersionUserName	String			Username of the user who updated the previous version.
PreviousVersionUserType	String			Type of the user who updated the previous version.
PreviousVersionDatetime	Datetime			Datetime when the previous version was edited.
PreviousVersionMessage	String			Message for the previously edited version.
PreviousVersionNumber	String			Number of the previously edited version.
PreviousVersionIsMinorEdit	Boolean			Indicator if the previous version was a minor edit.
PreviousVersionIsHidden	Boolean			Indicator if the previous version was hidden or not.

Pseudo-Columns

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

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

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

Table Specific Information

Select

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

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

For example, the following queries are processed server side:

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

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

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

Columns

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

Get information about a specific blogpost.

Table Specific Information

Select

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

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

For example, the following queries are processed server side:

SQL

SELECT * FROM Blogposts WHERE Id = '1234'

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

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

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

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

SELECT * FROM Blogposts ORDER BY Id DESC

SELECT * FROM Blogposts ORDER BY CreatedByUserName ASC

CQL

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

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

Columns

Name	Type	References	SupportedOperators	Description
Id [KEY]	String		=,!=,IN,NOT IN	Id of the blogpost.
Type	String		=,!=,IN,NOT IN	Type of the content.
Title	String		=,!=,LIKE,NOT LIKE,IN,NOT IN	Title of the blogpost.
Status	String			Status of the blogpost.
SpaceKey	String	Spaces.Key	=,!=,IN,NOT IN	The key of the space that the blogpost belongs to.
SpaceType	String	Spaces.Type	=,!=,IN,NOT IN	The type of the space that the blogpost belongs to.
Position	String			Position of the blogpost.
URL	String			URL of the blogpost.
Excerpt	String			Excerpt of the blogpost.
IsLatest	Boolean			Indicator if this is the latest version of the blogpost.
CreatedByUserName	String		=,!=,IN,NOT IN	Username of the user who created the blogpost.
CreatedByUserType	String			Type of the user who created the blogpost.
CreatedDate	Datetime		=,!=,>,>=,<,<=	Datetime for the creation of the blogpost.
LastUpdatedDatetime	Datetime		=,!=,>,>=,<,<=	Datetime of the last updated version of the blogpost.
LastUpdatedMessage	String			Message of the last updated version.
LastUpdatedNumber	Integer			Number of the last updated version.
LastUpdatedUserName	String			Username of the user who updated the latest version.
LastUpdatedUserType	String			Type of the user who updated the latest version.
LastUpdatedIsMinorEdit	Boolean			Indicator if this version is a minor edit.
LastUpdatedIsHidden	Boolean			Indicator if the last updated version is hidden or not.
PreviousVersionUserName	String			Username of the user who updated the previous version.
PreviousVersionUserType	String			Type of the user who updated the previous version.
PreviousVersionDatetime	Datetime			Datetime when the previous version was edited.
PreviousVersionMessage	String			Message for the previously edited version.
PreviousVersionNumber	String			Number of the previously edited version.
PreviousVersionIsMinorEdit	Boolean			Indicator if the previous version was a minor edit.
PreviousVersionIsHidden	Boolean			Indicator if the previous version was hidden or not.

Pseudo-Columns

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

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

Get information about a specific comment.

Table Specific Information

Select

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

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

For example, the following queries are processed server side:

SQL

SELECT * FROM Comments WHERE Id = '1234'

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

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

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

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

SELECT * FROM Comments ORDER BY Id DESC

SELECT * FROM Comments ORDER BY CreatedByUserName ASC

CQL

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

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

Columns

Name	Type	References	SupportedOperators	Description
Id [KEY]	String		=,!=,IN,NOT IN	Id of the comment.
Type	String		=,!=,IN,NOT IN	Type of the content.
Title	String		=,!=,LIKE,NOT LIKE,IN,NOT IN	Title of the comment.
Status	String			Status of the comment.
SpaceKey	String	Spaces.Key	=,!=,IN,NOT IN	The key of the space that the comment belongs to.
SpaceType	String	Spaces.Type	=,!=,IN,NOT IN	The type of the space that the comment belongs to.
Position	String			Position of the comment.
URL	String			URL of the comment.
Excerpt	String			Excerpt of the comment.
IsLatest	Boolean			Indicator if this is the latest version of the comment.
CreatedByUserName	String		=,!=,IN,NOT IN	Username of the user who created the comment.
CreatedByUserType	String			Type of the user who created the comment.
CreatedDate	Datetime		=,!=,>,>=,<,<=	Datetime for the creation of the comment.
LastUpdatedDatetime	Datetime		=,!=,>,>=,<,<=	Datetime of the last updated version of the comment.
LastUpdatedMessage	String			Message of the last updated version.
LastUpdatedNumber	Integer			Number of the last updated version.
LastUpdatedUserName	String			Username of the user who updated the latest version.
LastUpdatedUserType	String			Type of the user who updated the latest version.
LastUpdatedIsMinorEdit	Boolean			Indicator if this version is a minor edit.
LastUpdatedIsHidden	Boolean			Indicator if the last updated version is hidden or not.
PreviousVersionUserName	String			Username of the user who updated the previous version.
PreviousVersionUserType	String			Type of the user who updated the previous version.
PreviousVersionDatetime	Datetime			Datetime when the previous version was edited.
PreviousVersionMessage	String			Message for the previously edited version.
PreviousVersionNumber	String			Number of the previously edited version.
PreviousVersionIsMinorEdit	Boolean			Indicator if the previous version was a minor edit.
PreviousVersionIsHidden	Boolean			Indicator if the previous version was hidden or not.

Pseudo-Columns

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

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

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

Table Specific Information

Select

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

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

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

For example, the following queries are processed server side:

SELECT * FROM Contributors WHERE ContentId = '1234'

SELECT * FROM Contributors WHERE ContentId! = '1234'

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

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

SELECT * FROM Contributors WHERE AccountId = '12345678'

SELECT * FROM Contributors WHERE AccountId! = '12345678'

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

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

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

SELECT * FROM Contributors ORDER BY ContentId DESC

Columns

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

Get users of a specific group.

Table Specific Information

Select

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

• Name supports the '=' comparisons.

For example, the following queries are processed server side:

SELECT * FROM GroupMembers WHERE Name = 'test1'

Columns

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

Pseudo-Columns

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

Name	Type	Description
Name	String		Name of the Group to which these members belong to

Get information about a specific group.

Table Specific Information

Select

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

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

For example, the following queries are processed server side:

SELECT * FROM Groups WHERE Name = 'test'

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

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

Columns

Name	Type	References	SupportedOperators	Description
Id [KEY]	String		=	Id of the group.
Name [KEY]	String		=,IN	Name of the group.
Type	String			Type of the group.

Get information about the labels that a specific content has.

Table Specific Information

Select

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

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

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

For example, the following queries are processed server side:

SELECT * FROM Labels WHERE ContentId = '1234'

SELECT * FROM Labels WHERE ContentId! = '1234'

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

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

SELECT * FROM Labels WHERE LabelName = 'test'

SELECT * FROM Labels WHERE LabelName != 'test'

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

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

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

SELECT * FROM Labels ORDER BY ContentId DESC

Columns

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

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

Table Specific Information

Select

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

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

• PageId supports the '=' comparison.

For example, the following queries are processed server side:

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

Columns

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

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

Table Specific Information

Select

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

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

• PageId supports the '=' comparison.

For example, the following queries are processed server side:

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

Columns

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

Get comments specific to a page.

Table Specific Information

Select

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

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

• PageId supports the '=' comparison.

For example, the following queries are processed server side:

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

Columns

Name	Type	References	SupportedOperators	Description
Id [KEY]	String			The Id of the comments mentioned in the Page.
ExpandableAncestors	String			The ExpandableAncestors of the page comments.
ExpandableChildren	String			The ExpandableChildren of the page comments.
ExpandableContainer	String			The ExpandableContainer of the page comments.
ExpandableDescendants	String			The ExpandableDescendants of the page comments.
ExpandableHistory	String			The ExpandableHistory of the page comments.
ExpandableMetadata	String			The ExpandableMetadata of the page comments.
ExpandableOperations	String			The ExpandableOperations of the page comments.
ExpandableRestrictions	String			The ExpandableRestrictions of the page comments.
ExpandableSpace	String			The ExpandableSpace of the page comments.
ExpandableVersion	String			The ExpandableVersion of the page comments.
LinksSelf	String			The LinksSelf of the page comments.
LinksWebui	String			The LinksWebui of the page comments.
BodyExpandableAnonymousExportView	String			The BodyExpandableAnonymousExportView of the page comments.
BodyExpandableEditor	String			The BodyExpandableEditor of the page comments.
BodyExpandableExportView	String			The BodyExpandableExportView of the page comments.
BodyExpandableStorage	String			The BodyExpandableStorage of the page comments.
BodyExpandableStyledView	String			The BodyExpandableStyledView of the page comments.
BodyViewExpandableContent	String			The BodyViewExpandableContent of the page comments.
BodyViewExpandableWebresource	String			The BodyViewExpandableWebresource of the page comments.
BodyViewRepresentation	String			The BodyViewRepresentation of the page comments.
BodyViewValue	String			The BodyViewValue of the page comments.
ExtensionsExpandableResolution	String			The ExtensionsExpandableResolution of the page comments.
ExtensionsLocation	String			The ExtensionsLocation of the page comments.
Status	String			The Status of the page comments.
Title	String			The Title of the page comments.
Type	String			The Type of the page comments.
PageId	String	Pages.Id	=,IN	Pseudo column: The Id of the page.

Get content from the page.

Table Specific Information

Select

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

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

• PageId supports the '=' comparison.

For example, the following queries are processed server side:

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

Columns

Name	Type	References	SupportedOperators	Description
Id [KEY]	String			The Id of the page content.
ExpandableAncestors	String			The ExpandableAncestors of the page content.
ExpandableChildren	String			The ExpandableChildren of the page content.
ExpandableChildTypes	String			The ExpandableChildTypes of the page content.
ExpandableContainer	String			The ExpandableContainer of the page content.
ExpandableDescendants	String			The ExpandableDescendants of the page content.
ExpandableHistory	String			The ExpandableHistory of the page content.
ExpandableMetadata	String			The ExpandableMetadata of the page content.
ExpandableOperations	String			The ExpandableOperations of the page content.
ExpandableRestrictions	String			The ExpandableRestrictions of the page content.
ExpandableSchedulePublishDate	Datetime			The ExpandableSchedulePublishDate of the page content.
ExpandableSpace	String			The ExpandableSpace of the page content.
ExpandableVersion	String			The ExpandableVersion of the page content.
LinksBase	String			The LinksBase of the page content.
LinksCollection	String			The LinksCollection of the page content.
LinksContext	String			The LinksContext of the page content.
LinksEditui	String			The LinksEditui of the page content.
LinksSelf	String			The LinksSelf of the page content.
LinksTinyui	String			The LinksTinyui of the page content.
LinksWebui	String			The LinksWebui of the page content.
BodyExpandableAnonymousExportView	String			The BodyExpandableAnonymousExportView of the page content.
BodyExpandableAtlasDocFormat	String			The BodyExpandableAtlasDocFormat of the page content.
BodyExpandableDynamic	String			The BodyExpandableDynamic of the page content.
BodyExpandableEditor	String			The BodyExpandableEditor of the page content.
BodyExpandableEditor2	String			The BodyExpandableEditor2 of the page content.
BodyExpandableExportView	String			The BodyExpandableExportView of the page content.
BodyExpandableStyledView	String			The BodyExpandableStyledView of the page content.
BodyExpandableView	String			The BodyExpandableView of the page content.
BodyStorageExpandableContent	String			The BodyStorageExpandableContent of the page content.
BodyStorageEmbeddedContent	String			The BodyStorageEmbeddedContent of the page content.
BodyStorageRepresentation	String			The BodyStorageRepresentation of the page content.
BodyStorageValue	String			The BodyStorageValue of the page content.
ExtensionsPosition	String			The ExtensionsPosition of the page content.
Status	String			The Status of the page content.
Title	String			The Title of the page content.
Type	String			The Type of the page content.
PageId	String	Pages.Id	=,IN	Pseudo column: The Id of the page.

Get information about a specific page.

Table Specific Information

Select

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

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

For example, the following queries are processed server side:

SQL

SELECT * FROM Pages WHERE Id = '1234'

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

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

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

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

SELECT * FROM Pages ORDER BY Id DESC

SELECT * FROM Pages ORDER BY CreatedByUserName ASC

CQL

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

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

Columns

Name	Type	References	SupportedOperators	Description
Id [KEY]	String		=,!=,IN,NOT IN	Id of the page.
Type	String		=,!=,IN,NOT IN	Type of the content.
Title	String		=,!=,LIKE,NOT LIKE,IN,NOT IN	Title of the page.
Status	String			Status of the page.
SpaceKey	String	Spaces.Key	=,!=,IN,NOT IN	The key of the space that the page belongs to.
SpaceType	String	Spaces.Type	=,!=,IN,NOT IN	The type of the space that the page belongs to.
Position	String			Position of the page.
URL	String			URL of the page.
Excerpt	String			Excerpt of the page.
IsLatest	Boolean			Indicator if this is the latest version of the page.
CreatedByUserName	String		=,!=,IN,NOT IN	Username of the user who created the page.
CreatedByUserType	String			Type of the user who created the page.
CreatedDate	Datetime		=,!=,>,>=,<,<=	Datetime for the creation of the page.
LastUpdatedDatetime	Datetime		=,!=,>,>=,<,<=	Datetime of the last updated version of the page.
LastUpdatedMessage	String			Message of the last updated version.
LastUpdatedNumber	Integer			Number of the last updated version.
LastUpdatedUserName	String			Username of the user who updated the latest version.
LastUpdatedUserType	String			Type of the user who updated the latest version.
LastUpdatedIsMinorEdit	Boolean			Indicator if this version is a minor edit.
LastUpdatedIsHidden	Boolean			Indicator if the last updated version is hidden or not.
PreviousVersionUserName	String			Username of the user who updated the previous version.
PreviousVersionUserType	String			Type of the user who updated the previous version.
PreviousVersionDatetime	Datetime			Datetime when the previous version was edited.
PreviousVersionMessage	String			Message for the previously edited version.
PreviousVersionNumber	String			Number of the previously edited version.
PreviousVersionIsMinorEdit	Boolean			Indicator if the previous version was a minor edit.
PreviousVersionIsHidden	Boolean			Indicator if the previous version was hidden or not.

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

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 user identified.

Table Specific Information

Select

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

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

For example, the following queries are processed server side:

SQL

SELECT * FROM Users WHERE AccountId = '1234'

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

SELECT * FROM Users WHERE PublicName = 'confluenceuser'

CQL

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

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

Columns

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

Pseudo-Columns

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

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

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

Table Specific Information

Select

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

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

For example, the following queries are processed server side:

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

Columns

Name	Type	References	SupportedOperators	Description
ContentId	String		=,IN	The Id of the page content.
NumberOfDistinctViewers	String			the total number of distinct viewers a piece of content has.

Pseudo-Columns

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

Name	Type	Description
FromDate	Date		The number of views for the content from the date.

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

Table Specific Information

Select

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

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

For example, the following queries are processed server side:

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

Columns

Name	Type	References	SupportedOperators	Description
ContentId	String		=,IN	The Id of the page content.
NumberOfViews	String			the total number of views a piece of content has.

Pseudo-Columns

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

Name	Type	Description
FromDate	Date		The number of views for the content from the date.

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

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

Authentication

---

プロパティ	説明
AuthScheme	The type of authentication to use when connecting to Confluence.
URL	The URL to your JIRA endpoint.
User	認証で使用されるConfluence ユーザーアカウント。
Password	ユーザーの認証で使用されるパスワード。
APIToken	APIToken of the currently authenticated user.
Timezone	Specify the timezone of the Confluence instance in order to use the datetime filters accordingly and retrieve the results according to your timezone. An example of a timezone would be America/New_York.

SSO

---

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

OAuth

---

プロパティ	説明
OAuthVersion	使われているOAuth のバージョン。
OAuthClientId	OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。
OAuthClientSecret	OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。
Scope	This determines the scopes that the OAuth application requests from Confluence.
CertificateStore	The certificate store used for Confluence authentication.
CertificateStorePassword	The password of the certificate store used with Confluence authentication.
CertificateSubject	The subject of the certificate used with Confluence Private Application authentication.
CertificateStoreType	The type of certificate store used with Confluence Private Application authentication.

SSL

---

プロパティ	説明
SSLClientCert	SSL クライアント認証（2-way SSL）のためのTLS/SSL クライアント証明書ストア。
SSLClientCertType	TLS/SSL クライアント証明書を格納するキーストアの種類。
SSLClientCertPassword	TLS/SSL クライアント証明書のパスワード。
SSLClientCertSubject	TLS/SSL クライアント証明書のサブジェクト。
SSLServerCert	TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。

Firewall

---

プロパティ	説明
FirewallType	プロキシベースのファイアウォールで使われるプロトコル。
FirewallServer	プロキシベースのファイアウォールの名前もしくはIP アドレス。
FirewallPort	プロキシベースのファイアウォールのTCP ポート。
FirewallUser	プロキシベースのファイアウォールに認証するために使うユーザー名。
FirewallPassword	プロキシベースのファイアウォールへの認証に使われるパスワード。

Proxy

---

プロパティ	説明
ProxyAutoDetect	これは、システムプロキシ設定を使用するかどうかを示します。これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。
ProxyServer	HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。
ProxyPort	ProxyServer プロキシが起動しているTCP ポート。
ProxyAuthScheme	ProxyServer プロキシへの認証で使われる認証タイプ。
ProxyUser	ProxyServer プロキシへの認証に使われるユーザー名。
ProxyPassword	ProxyServer プロキシへの認証に使われるパスワード。
ProxySSLType	ProxyServer プロキシへの接続時に使用するSSL タイプ。
ProxyExceptions	ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

Logging

---

プロパティ	説明
LogModules	ログファイルに含めるコアモジュール。

Schema

---

プロパティ	説明
Location	テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。
BrowsableSchemas	このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
Tables	このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。
Views	使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。

Miscellaneous

---

プロパティ	説明
IncludeArchivedSpaces	Whether to include content from archived spaces in the result. This defaults to false.
MaxRows	クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。
Other	これらの隠しプロパティは特定のユースケースでのみ使用されます。
Pagesize	Confluence から返されるページあたりの結果の最大数。
PseudoColumns	このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
SpaceKey	By specifying the SpaceKey, the search results will only display contents from this specific space.
Timeout	タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
UserDefinedViews	カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。

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

---

プロパティ	説明
AuthScheme	The type of authentication to use when connecting to Confluence.
URL	The URL to your JIRA endpoint.
User	認証で使用されるConfluence ユーザーアカウント。
Password	ユーザーの認証で使用されるパスワード。
APIToken	APIToken of the currently authenticated user.
Timezone	Specify the timezone of the Confluence instance in order to use the datetime filters accordingly and retrieve the results according to your timezone. An example of a timezone would be America/New_York.

The type of authentication to use when connecting to Confluence.

解説

• Auto: Lets the driver decide automatically based on the other connection properties you have set.
• OAuth: Set to this to perform OAuth authentication.
• Basic: Set this to use BASIC user / password or user / ApiToken authentication.
• Crowd: Set this to perform Crowd SSO authentication.
• OKTA: Set this to perform OKTA SSO authentication.

The URL to your JIRA endpoint.

解説

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

認証で使用されるConfluence ユーザーアカウント。

解説

このフィールドは、Password とともに、Confluence サーバーに対して認証をするために使われます。

ユーザーの認証で使用されるパスワード。

解説

User およびPassword を一緒に使用してサーバーで認証を行います。

APIToken of the currently authenticated user.

解説

APIToken of the currently authenticated user.

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

解説

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

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

---

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

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

解説

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

セミコロンで区切られたID プロバイダーへの接続に必要な追加プロパティ。

解説

セミコロンで区切られたID プロバイダーへの接続に必要な追加プロパティ。SSOLoginURL と一緒に使われます。

SSO configuration is discussed further in .

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

解説

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

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

解説

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

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

解説

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

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

---

プロパティ	説明
OAuthVersion	使われているOAuth のバージョン。
OAuthClientId	OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。
OAuthClientSecret	OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。
Scope	This determines the scopes that the OAuth application requests from Confluence.
CertificateStore	The certificate store used for Confluence authentication.
CertificateStorePassword	The password of the certificate store used with Confluence authentication.
CertificateSubject	The subject of the certificate used with Confluence Private Application authentication.
CertificateStoreType	The type of certificate store used with Confluence Private Application authentication.

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

解説

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

OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。

解説

OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId 値、およびクライアントシークレットOAuthClientSecret が提供されます。

OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。

解説

OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId が提供されます。また、コンシューマーシークレットと呼ばれるクライアントシークレットも提供されます。クライアントシークレットをOAuthClientSecret プロパティに設定します。

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

解説

初期アクセストークンとリフレッシュトークンを取得するスコープを指定します。

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

The certificate store used for Confluence authentication.

解説

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

The password of the certificate store used with Confluence authentication.

解説

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

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

解説

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

About the Confluence Client SSL Auth Flow

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

Loading a Certificate

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

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

Specifying the Subject

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

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

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

Additional Connection Properties

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

• CertificateStore
• CertificateStoreType
• CertificateStorePassword

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

解説

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

Specifying the Certificate Store Type

The CertificateStoreType property can take one of the following values:

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

Related Connection Properties

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

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

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

---

プロパティ	説明
SSLClientCert	SSL クライアント認証（2-way SSL）のためのTLS/SSL クライアント証明書ストア。
SSLClientCertType	TLS/SSL クライアント証明書を格納するキーストアの種類。
SSLClientCertPassword	TLS/SSL クライアント証明書のパスワード。
SSLClientCertSubject	TLS/SSL クライアント証明書のサブジェクト。
SSLServerCert	TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。

SSL クライアント認証（2-way SSL）のためのTLS/SSL クライアント証明書ストア。

解説

クライアント証明書のための証明書ストア名。

SSLClientCertType フィールドは、SSLClientCert により指定された証明書ストアの種類を指定します。ストアがパスワードで保護されている場合は、SSLClientCertPassword でパスワードを指定します。

SSLClientCert は、SSLClientCertSubject フィールドとともにクライアント証明書を指定するために使われます。SSLClientCert に値がある場合で、SSLClientCertSubject が設定されている場合は、証明書の検索が始まります。詳しくは、SSLClientCertSubject を参照してください。

証明書ストアの指定はプラットフォームに依存します。

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

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

Javaでは、証明書ストアは通常、証明書および任意の秘密キーを含むファイルです。

証明書ストアの種類がPFXFile の場合は、このプロパティにファイル名を設定します。PFXBlob の場合は、このプロパティをPFX ファイルのバイナリコンテンツ（例えば、PKCS12証明書ストア）に設定する必要があります。

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 形式の証明書を含む文字列の名前です。

TLS/SSL クライアント証明書のパスワード。

解説

証明書ストアでパスワードが必要である場合、このプロパティを使用してパスワードを指定し、証明書ストアにアクセスできます。

TLS/SSL クライアント証明書のサブジェクト。

解説

証明書のサブジェクトは、証明書をロードするときにストア内の証明書を検索するために使用されます。

完全に一致するものが見つからない場合、ストアはプロパティの値を含むサブジェクトを検索します。それでも一致するものが見つからない場合、プロパティは空白で設定され、証明書は選択されません。

"*" に設定すると、証明書ストアの1番目の証明書が選択されます。

証明書のサブジェクトは識別の名前フィールドおよび値のカンマ区切りのリストです。例えば、"CN=www.server.com, OU=test, C=US, [email protected]" です。共通のフィールドとその説明は以下のとおりです。

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

フィールド値にカンマが含まれている場合は、それを引用符で囲む必要があります。

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

解説

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

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

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

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

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

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

---

プロパティ	説明
FirewallType	プロキシベースのファイアウォールで使われるプロトコル。
FirewallServer	プロキシベースのファイアウォールの名前もしくはIP アドレス。
FirewallPort	プロキシベースのファイアウォールのTCP ポート。
FirewallUser	プロキシベースのファイアウォールに認証するために使うユーザー名。
FirewallPassword	プロキシベースのファイアウォールへの認証に使われるパスワード。

プロキシベースのファイアウォールで使われるプロトコル。

解説

このプロパティは、Sync App がFirewallServer プロキシ経由でトンネルトラフィックを使うためのプロトコルを指定します。デフォルトでは、Sync App はシステムプロキシに接続します。この動作を無効化し次のプロキシタイプのどれかで接続するには、ProxyAutoDetect をfalse に設定します。

タイプ	デフォルトポート	説明
TUNNEL	80	これが設定されている場合、Sync App はConfluence への接続を開き、プロキシを経由して通信が行われます。
SOCKS4	1080	これが設定されている場合、Sync App はデータをFirewallServer およびFirewallPort で指定されたSOCS 4 プロキシ経由で送信し、接続リクエストが許容されるかどうかを決定します。
SOCKS5	1080	これが設定されている場合、Sync App はデータをFirewallServer およびFirewallPort で指定されたSOCS 5 プロキシ経由で送信します。プロキシに認証が必要な場合には、FirewallUser およびFirewallPassword をプロキシが認識する認証情報に設定します。

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

プロキシベースのファイアウォールの名前もしくはIP アドレス。

解説

ファイアウォールトラバーサルを許容するために設定するIP アドレス、DNS 名、もしくはプロキシホスト名を指定するプロパティです。プロトコルはFirewallType で指定されます。このプロパティとFirewallServer を使って、SOCKS 経由での接続、もしくはトンネリングが可能です。HTTP プロキシへの接続には、ProxyServer を使用します。

Sync App はデフォルトでシステムプロキシを使うので注意してください。他のプロキシを使う場合には、ProxyAutoDetect をfalse に設定してください。

プロキシベースのファイアウォールのTCP ポート。

解説

ファイアウォールトラバーサルを許容するために設定するプロキシベースのファイアウォールのTCP ポート。名前もしくはIP アドレスを指定するには、FirewallServer を使います。FirewallType でプロトコルを指定します。

プロキシベースのファイアウォールに認証するために使うユーザー名。

解説

FirewallUser およびFirewallPassword プロパティは、FirewallType により指定された認証方式に則り、FirewallServer、およびFirewallPort で指定されたプロキシに対しての認証に使われます。

プロキシベースのファイアウォールへの認証に使われるパスワード。

解説

このプロパティは、FirewallType により指定された認証メソッドに則り、FirewallServer およびFirewallPort で指定されたプロキシに渡されます。

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

---

プロパティ	説明
ProxyAutoDetect	これは、システムプロキシ設定を使用するかどうかを示します。これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。
ProxyServer	HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。
ProxyPort	ProxyServer プロキシが起動しているTCP ポート。
ProxyAuthScheme	ProxyServer プロキシへの認証で使われる認証タイプ。
ProxyUser	ProxyServer プロキシへの認証に使われるユーザー名。
ProxyPassword	ProxyServer プロキシへの認証に使われるパスワード。
ProxySSLType	ProxyServer プロキシへの接続時に使用するSSL タイプ。
ProxyExceptions	ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

これは、システムプロキシ設定を使用するかどうかを示します。これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。

解説

これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。

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

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

解説

HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。HTTP プロキシへの認証には、Sync App はHTTP、Windows(NTLM)、もしくはKerberos 認証タイプを使用することができます。

SOCKS プロキシを経由して接続する、もしくは接続をトンネルするには、FirewallType を参照してください。

デフォルトで、Sync App はsystem プロキシを使います。他のプロキシを使う場合には、ProxyAutoDetect をfalse に設定します。

ProxyServer プロキシが起動しているTCP ポート。

解説

HTTP トラフィックをリダイレクトするHTTP プロキシが実行されているポート。ProxyServer でHTTP プロキシを指定します。その他のプロキシタイプについては、FirewallType を参照してください。

ProxyServer プロキシへの認証で使われる認証タイプ。

解説

この値は、ProxyServer およびProxyPort で指定されるHTTP プロキシに認証するために使われる認証タイプを指定します。

Sync App は、デフォルトでsystem proxy settings を使い、追加での設定が不要です。他のプロキシへの接続をする場合には、ProxyServer およびProxyPort に加え、ProxyAutoDetect をfalse に設定します。認証するには、ProxyAuthScheme を設定し、必要な場合にはProxyUser およびProxyPassword を設定します。

認証タイプは、次のどれかになります。

• BASIC： Sync App はHTTP BASIC 認証を行います。
• DIGEST： Sync App はHTTP DIGEST 認証を行います。
• NEGOTIATE： Sync App は認証において有効なプロトコルに応じて、NTLM もしくはKereros トークンを取得します。
• PROPRIETARY： Sync App はNTLM もしくはKerberos トークンを発行しません。このトークンを、HTTP リクエストのAuthorization ヘッダーに含める必要があります。

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

ProxyServer プロキシへの認証に使われるユーザー名。

解説

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

ProxyAuthScheme で使用可能な認証タイプを選択することができます。HTTP 認証を使う場合、これをHTTP プロキシで識別可能なユーザーのユーザー名に設定します。Windows もしくはKerberos 認証を使用する場合、このプロパティを次の形式のどれかでユーザー名に設定します。

user@domain
domain\user

ProxyServer プロキシへの認証に使われるパスワード。

解説

このプロパティは、NTLM(Windows)、Kerberos、もしくはHTTP 認証をサポートするHTTP プロキシサーバーに認証するために使われます。HTTP プロキシを指定するためには、ProxyServer およびProxyPort を設定します。認証タイプを指定するためにはProxyAuthScheme を設定します。

HTTP 認証を使う場合、さらにHTTP プロキシにProxyUser およびProxyPassword を設定します。

NTLM 認証を使う場合、Windows パスワードにProxyUser およびProxyPassword を設定します。Kerberos 認証には、これらを入力する必要があります。

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

デフォルトで、Sync App はsystem プロキシを使います。他のプロキシに接続する場合には、これをfalse に設定します。

ProxyServer プロキシへの接続時に使用するSSL タイプ。

解説

このプロパティは、ProxyServer で指定されたHTTP プロキシへの接続にSSL を使用するかどうかを決定します。この値は、AUTO、ALWAYS、NEVER、TUNNEL のいずれかです。有効な値は次のとおりです。

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

ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

解説

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

Sync App は、追加設定なしにデフォルトでシステムのプロキシ設定を使います。この接続のプロキシ例外を明示的に構成するには、ProxyAutoDetect をfalse に設定して、ProxyServer およびProxyPort を設定する必要があります。認証するには、ProxyAuthScheme を設定し、必要な場合にはProxyUser およびProxyPassword を設定します。

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

---

プロパティ	説明
LogModules	ログファイルに含めるコアモジュール。

ログファイルに含めるコアモジュール。

解説

指定された（';' で区切られた）モジュールのみがログファイルに含まれます。デフォルトではすべてのモジュールが含まれます。

概要はログ ページを参照してください。

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

---

プロパティ	説明
Location	テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。
BrowsableSchemas	このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
Tables	このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。
Views	使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。

テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。

解説

Sync App のスキーマファイル（テーブルとビューの場合は.rsd ファイル、ストアドプロシージャの場合は.rsb ファイル）を含むディレクトリへのパス。このフォルダの場所は、実行ファイルの場所からの相対パスにすることができます。Location プロパティは、定義をカスタマイズしたり（例えば、カラム名を変更する、カラムを無視するなど）、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。

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

このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

解説

スキーマをデータベースからリストすると、負荷がかかる可能性があります。接続文字列でスキーマのリストを提供すると、 パフォーマンスが向上します。

このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。

解説

テーブルを複数のデータベースからリストすると、負荷がかかる可能性があります。接続文字列でテーブルのリストを提供すると、Sync App のパフォーマンスが向上します。

このプロパティは、作業したいビューがすでにわかっていて、ビューが多すぎる場合に、ビューを自動的にリストする代わりに使用することもできます。

カンマ区切りのリストで使用したいテーブルを指定します。各テーブルは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space` です。

複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。

使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。

解説

ビューを複数のデータベースからリストすると、負荷がかかる可能性があります。接続文字列でビューのリストを提供すると、Sync App のパフォーマンスが向上します。

このプロパティは、作業したいビューがすでにわかっていて、ビューが多すぎる場合に、ビューを自動的にリストする代わりに使用することもできます。

カンマ区切りのリストで使用したいビューを指定します。各ビューは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space` です。

複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。

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

---

プロパティ	説明
IncludeArchivedSpaces	Whether to include content from archived spaces in the result. This defaults to false.
MaxRows	クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。
Other	これらの隠しプロパティは特定のユースケースでのみ使用されます。
Pagesize	Confluence から返されるページあたりの結果の最大数。
PseudoColumns	このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
SpaceKey	By specifying the SpaceKey, the search results will only display contents from this specific space.
Timeout	タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
UserDefinedViews	カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。

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

解説

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

クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。

解説

クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。

これらの隠しプロパティは特定のユースケースでのみ使用されます。

解説

以下にリストされているプロパティは、特定のユースケースで使用可能です。通常のドライバーのユースケースおよび機能では、これらのプロパティは必要ありません。

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

統合およびフォーマット

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

Confluence から返されるページあたりの結果の最大数。

解説

Pagesize プロパティは、Confluence から返されるページあたりの結果の最大数に影響を与えます。より大きい値を設定すると、1ページあたりの消費メモリが増える代わりに、パフォーマンスが向上する場合があります。

このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。

解説

Entity Framework ではテーブルカラムでない疑似カラムに値を設定できないため、この設定はEntity Framework で特に便利です。この接続設定の値は、"Table1=Column1, Table1=Column2, Table2=Column3" の形式です。"*=*" のように"*" 文字を使用して、すべてのテーブルとすべてのカラムを含めることができます。

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

解説

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

タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。

解説

Timeout が0に設定されている場合は、操作がタイムアウトしません。処理が正常に完了するか、エラー状態になるまで実行されます。

Timeout の有効期限が切れても処理が完了していない場合は、Sync App は例外をスローします。

カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。

解説

ユーザー定義ビューは、UserDefinedViews.json というJSON 形式のコンフィギュレーションファイルで定義されています。Sync App は、このファイルで指定されたビューを自動的に検出します。

また、複数のビュー定義を持ち、UserDefinedViews 接続プロパティを使用して制御することも可能です。このプロパティを使用すると、指定されたビューのみがSync App によって検知されます。

このユーザー定義ビューのコンフィギュレーションファイルは、次のようにフォーマットされています。

• 各ルートエレメントはビューの名前を定義します。
• 各ルートエレメントには、query と呼ばれる子エレメントが含まれており、この子エレメントにはビューのカスタムSQL クエリが含まれています。

次に例を示します。

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

UserDefinedViews 接続プロパティを使用して、JSON コンフィギュレーションファイルの場所を指定します。次に例を示します。

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