Confluenceをデータパイプラインソースとして設定する ​

Confluenceをデータパイプラインソースとして設定し、Confluenceからスペース、ページ、ブログ投稿、コメント、および関連コンテンツを抽出して同期先に同期します。 このガイドを使用して、Confluenceの認証情報を準備し、ConfluenceをWorkatoに接続し、パイプラインを設定して、サポートされるオブジェクト、同期モード、および制限事項を理解します。

サポートされている機能 ​

Confluenceをパイプラインソースとして使用する場合、次の機能がサポートされます:

• Confluence Cloudの接続: https経由でConfluence Cloudサイトに接続します。
• 完全同期と増分同期: ページ、ブログ投稿、コメント、および添付ファイルでは、最終更新タイムスタンプに基づく増分同期がサポートされます。 監査ログは、イベント作成時刻に基づいて増分同期されます。 その他のオブジェクトでは、各実行時に完全同期が使用されます。
• オブジェクトレベルの選択: パイプラインに含めるConfluenceオブジェクトを選択します。
• 削除追跡: Confluenceでごみ箱に移動された、または削除されたページ、ブログ投稿、および添付ファイルは、同期先で削除済みとしてマークされます。 詳細については、削除追跡を参照してください。
• スキーマドリフト処理: ソースで新しく追加されたフィールドを自動同期するかブロックするかを選択します。
• フィールドレベルのデータ保護: 同期先に同期する前に機密フィールドをマスクします。
• 設定可能な同期頻度: 時間ベースまたはcronベースのスケジュールで同期をスケジュールします。 最小間隔は15分です。

前提条件 ​

Confluenceをデータパイプラインソースとして設定する前に、次の要件を完了します。

• yourcompany.atlassian.netなどのConfluence Cloudサイト
• 選択した認証方法の認証情報:
  • APIトークン: AtlassianアカウントのメールアドレスとAPIトークン。
  • OAuth 2.0: Atlassian Developer Consoleに登録されたOAuth 2.0アプリのクライアントIDとクライアントシークレット。

サポートされるコネクションタイプ ​

Confluenceデータパイプラインでは、次の認証方式がサポートされます:

• APIトークン: AtlassianアカウントのメールアドレスとAPIトークンで認証します。 これはConfluence Cloudで推奨される方式です。 設定手順については、APIトークン認証を参照してください。
• OAuth 2.0: Atlassian Developer Consoleに登録されたアプリを使用して、OAuth 2.0認可コードグラントで認証します。 設定手順については、OAuth 2.0認証を参照してください。

Confluenceに接続する ​

Confluenceに接続するには、次の手順を実行します。

パイプラインの設定 ​

Confluenceをデータパイプラインソースとして設定するには、次の手順を実行します。

[minute] [hour] [day of month] [month] [day of week]

0 8 * * *

サポートされるオブジェクト ​

Confluenceデータパイプラインは、Confluence Cloud REST APIからデータを同期します。 次の表は、サポートされているオブジェクトをカテゴリ別に示しています。 各オブジェクトは、宛先内の個別のテーブルとして同期されます。

コンテンツ ​

Confluence APIではタスクの変更時刻に対するフィルターが提供されないため、Tasksは増分同期をサポートしていません。 タスクは編集と完了を取得できるように、実行のたびに完全同期を使用します。

コメントとラベル ​

Confluenceのラベルは、ページとブログ投稿全体で共有されるグローバルタグです。 Labelsオブジェクトは、ページごとのラベル割り当てではなく、サイトの完全なラベルカタログを同期します。

ユーザーとグループ ​

Usersオブジェクトでは、_workato_is_deleted列は削除されたレコードではなく、無効化されたアカウントなど、Atlassianでアクティブでなくなったアカウントをマークします。

管理とプロパティ ​

Audit Logsは、コネクションがConfluenceサイト管理者として認証されている場合にのみデータを返します。 サイト管理者アクセス権のないコネクションでは、このオブジェクトに対して権限エラーが発生します。

同期モード ​

Confluenceデータパイプラインは、完全同期と増分同期をサポートしています。 同期モードは、パイプラインに追加するときにオブジェクトごとに設定されます。 オブジェクトのタイムスタンプが検出されない場合、同期モードのデフォルトは完全同期になります。

フル同期 ​

完全同期では、選択したオブジェクトについてConfluenceから使用可能なすべてのレコードを読み取り、同期先テーブルを上書きします。 各実行時に完全なスナップショットが必要なオブジェクトには、完全同期を使用します。 各完全同期で同期先テーブルが置き換えられるため、Confluenceでの削除は、このモードで同期されるすべてのオブジェクトに反映されます。

増分同期 ​

増分同期では、最後に成功した実行以降に変更されたレコードのみが抽出されます。 Workatoは、ページ、ブログ投稿、コメント、添付ファイルなどのコンテンツオブジェクトでは最終更新タイムスタンプを増分カーソルとして使用し、Audit Logsではイベント作成時刻を使用します。

増分同期中の削除追跡は、Pages、Blog Posts、Page Attachments、およびBlog Post Attachmentsでサポートされます。 詳細については、削除追跡を参照してください。

各オブジェクトでサポートされる同期モードを確認するには、サポートされるオブジェクトの表を参照してください。

削除追跡 ​

Confluenceは削除の変更ストリームを提供しないため、パイプラインはごみ箱にあるコンテンツと削除済みコンテンツを直接一覧表示して削除を検出します。

Confluenceでごみ箱に移動された、または削除されたPages、Blog Posts、Page Attachments、およびBlog Post Attachmentsのレコードは、合成_workato_is_deleted列がtrueに設定された状態で同期先に同期されます。 アーカイブ済みコンテンツは削除済みとして扱われません。アーカイブ済みレコードでは_workato_is_deletedがfalseのまま保持され、status列にarchived値が含まれます。

削除追跡には、次の動作が適用されます:

• 削除済みレコードは増分実行ごとに再同期されます: Confluenceは削除タイムスタンプを公開しないため、各増分実行では、レコードが変更されていない場合でも、ごみ箱にあるレコードと削除済みレコードの完全なセットが再抽出されます。 ほとんどの実行では、抽出件数とロード件数は同じです。 変更日のパスと削除スイープの両方で同じレコードが検出される場合など、1回の実行で同じレコードが複数回表示されると、ロード件数がわずかに少なくなることがあります。 同期先では、これらのレコードがIDで重複排除されます。
• コメントの削除は検出されません: Confluence APIは削除済みコメントを公開しないため、コメントの削除は同期先に同期できません。
• 履歴削除は範囲指定された初期ロードから除外されます: 初回起動時に、このパイプラインは次からレコードを取得する必要がありますフィールドに開始日を設定すると、初期ロードにはその期間内に発生した削除のみが含まれます。 初期ロード後の削除は通常どおり追跡されます。

スキーマとデータ型の処理 ​

Confluenceデータを同期する場合は、次のスキーマ動作が適用されます。

ネストされたフィールド ​

バージョンメタデータなど、Confluence API応答内のネストされたオブジェクトは、JSONを含む文字列列として同期されます。 id、status、title、space_id、parent_id、created_atなどのトップレベルメタデータは、スカラー列として同期されます。

ページ階層 ​

Confluenceページは階層構造です。 各ページレコードには、その親ページを識別するparent_id列が含まれます。 同期先でparent_idのレコードを結合し、ページツリーを再構築します。

合成列 ​

Workatoは、特定のオブジェクトの同期先テーブルに次の合成列を追加します:

制限事項 ​

Confluenceをデータパイプラインソースとして使用する場合、次の制限事項が適用されます:

添付ファイルメタデータのみ ​

添付ファイルオブジェクトはメタデータのみを同期します。 パイプラインは、添付されたドキュメントや画像そのものなどのバイナリファイルコンテンツをダウンロードしません。

APIトークンの有効期限 ​

Atlassian APIトークンは作成から1年後に期限切れになります。 認証エラーを回避するには、有効期限が切れる前に新しいトークンを生成し、コネクションを更新します。

最小同期頻度 ​

サポートされる最小同期間隔は15分です。 これより高い頻度で同期をトリガーすることはできません。