PowerShell からConfluence のデータに接続してデータの取得・CSV エクスポートを実行する方法

こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。

CData Cmdlets for Confluence を使えば、PowerShell からConfluence に手軽に連携して、データのCRUD やエクスポートを実行できます。

本記事では、Confluence への接続方法からCSV エクスポート、データの操作までサンプルコード付きで解説していきます。

Confluence への接続を設定

それでは、まずはConfluence への接続設定からはじめていきましょう。接続設定にはCData Confluence Cmdlets が必要となります。右側のサイドバーから製品の全機能が使える30日間の無償トライアルがダウンロードできるので、ぜひご利用ください。

インストールが完了したら、プロファイルに以下の行を追加してください。次のPowerShell セッションでモジュールがロードされます。

    Import-Module ConfluenceCmdlets;

Connect-Confluence コマンドを使ってConfluence との接続を設定します。各接続プロパティの取得方法は次に説明します。

    $conn = Connect-Confluence  -User "$User" -APIToken "$APIToken" -Url "$Url" -Timezone "$Timezone"

API Token を取得する方法

API token は、アカウントへの認証に必須です。トークンの生成には、Atlassian アカウントでサービスにログインし、API tokens > Create API token に進みます。生成されたトークンが表示されます。

Confluence Cloud Account への接続

Cloud アカウントへの接続には、以下のプロパティを設定します（Password は、Server Instance への接続時のみ必要で、Cloud Account への接続には不要になりました。）:

• User: Confluence サーバーに認証するユーザー名。
• APIToken: 認証するユーザーに紐付けられたAPI Token。
• Url: JIRA エンドポイントのURL。例： https://yoursitename.atlassian.net

Confluence Server Instance への接続

Server instance への接続には以下を設定します:

• User: Confluence Instance に接続するユーザー名。
• Password: Confluence Instance に接続するユーザーのパスワード。
• Url: JIRA エンドポイントのURL。例： https://yoursitename.atlassian.net

これで接続設定は完了です。

Confluence のデータを取得してCSV にパイプライン

接続が完了したので、Pages テーブルデータを取得して結果をCSV ファイルにエクスポートします。

Select-Confluence -Connection $conn -Table Pages | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myPagesData.csv -NoTypeInformation

このコードでは、Select-Confluence から取得した結果をSelect-Object に流して、Export-Csv に渡す前にいくつかのプロパティを除外しています。これは、CData Cmdlets が接続情報、テーブル、およびカラム情報を結果セットのそれぞれの行に挿入するためです。それらの情報を表示したくない場合に、Export-Csv コマンドに渡す前に除外を先に行い、そのあとでCSV ファイルにエクスポートします。

おわりに

このように、CData Cmdlets を使えばPowerShell でのConfluence のデータへの連携をシンプルに実現できます。ぜひCData PowerShell Cmdlets の30日間無償トライアルをダウンロードして、シンプルかつパワフルなデータ連携をお試しください。