PowerShell からJira Service Desk データに接続してデータの取得・更新・挿入・削除・CSV エクスポートを実行する方法

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

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

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

Jira Service Desk への接続を設定

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

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

    Import-Module JiraServiceDeskCmdlets;

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

    $conn = Connect-JiraServiceDesk  -ApiKey "$ApiKey" -User "$User"

Jira Service Management 接続プロパティの取得・設定方法

任意のJira Service Management Cloud またはJira Service Management Server インスタンスへの接続を確立できます。接続するにはURL プロパティを設定します。

• URL（例：https://yoursitename.atlassian.net）

カスタムフィールドへのアクセス

デフォルトでは、CData 製品はシステムフィールドのみを表示します。Issues のカスタムフィールドにアクセスするには、IncludeCustomFields を設定します。

Jira Service Management への認証

ベーシック認証

ローカルサーバーアカウントで認証するためには、次の接続プロパティを指定します。

• AuthScheme：Basic に設定。
• User：認証ユーザーのユーザー名に設定。
• Password：認証ユーザーのパスワードに設定。

API トークン

Cloud アカウントに接続するには、APIToken を取得する必要があります。API トークンを生成するには、Atlassian アカウントにログインして「API トークン」 -> 「API トークンの作成」をクリックします。生成されたトークンが表示されます。

データに接続するには以下を設定します。

• AuthScheme：APIToken に設定。
• User：認証ユーザーのユーザー名に設定。
• APIToken：作成したAPI トークンに設定。

ちなみに、Cloud アカウントへの接続でパスワード認証を使うことも可能ですが、非推奨となっています。

OAuth 2.0

この場合、AuthSchemeをすべてのOAuth フローでOAuth に設定する必要があります。また、すべてのシナリオでカスタムOAuth アプリケーションを作成して構成する必要があります。詳しくは、ヘルプドキュメントの「OAuth」セクションを参照してください。

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

Jira Service Desk データを取得してCSV にパイプライン

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

Select-JiraServiceDesk -Connection $conn -Table Requests | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myRequestsData.csv -NoTypeInformation

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

それでは、続いてデータの削除や挿入・更新を実行してみます。

データの削除

以下のように、フィルタリングで合致するレコードを削除することができます。

Select-JiraServiceDesk -Connection $conn -Table Requests -Where "CurrentStatus = Open" | Remove-JiraServiceDesk

データの挿入と更新

データの挿入や更新を使って、加工やクレンジングも行えます。以下の手順では、CSV ファイルのデータを読み込んで挿入対象のオブジェクトに同じレコードが存在するかを確認した上で、存在する場合にはデータを更新、存在しない場合にはデータの挿入を行います。

Import-Csv -Path C:\MyRequestsUpdates.csv | %{
  $record = Select-JiraServiceDesk -Connection $JiraServiceDesk -Table Requests -Where ("Id = `'"+$_.Id+"`'")
  if($record){
    Update-JiraServiceDesk -Connection $jiraservicedesk -Table Requests -Columns ("RequestId","ReporterName") -Values ($_.RequestId, $_.ReporterName) -Where ("Id = `'"+$_.Id+"`'")
  }else{
    Add-JiraServiceDesk -Connection $jiraservicedesk -Table Requests -Columns ("RequestId","ReporterName") -Values ($_.RequestId, $_.ReporterName)
  }
}

おわりに

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