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"

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 アカウントへの認証を行うには、以下を入力します。

• 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 です。

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

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日間無償トライアルをダウンロードして、シンプルかつパワフルなデータ連携をお試しください。