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

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

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

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

ServiceNow への接続を設定

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

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

    Import-Module ServiceNowCmdlets;

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

    $conn = Connect-ServiceNow  -OAuthClientId "$OAuthClientId" -OAuthClientSecret "$OAuthClientSecret" -Username "$Username" -Password "$Password" -Instance "$Instance"

ServiceNow はOAuth 2.0 認証標準を利用しています。OAuth を使って認証するには、ServiceNow にOAuth アプリを登録してOAuthClientId を取得しなければなりません。OAuth 値の他に、Instance、User、およびPassword の指定が必要です。

OAuth 認証を介した接続について詳しくは、ヘルプドキュメントの「OAuth 認証の使用」を参照してください。

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

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

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

Select-ServiceNow -Connection $conn -Table incident | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myincidentData.csv -NoTypeInformation

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

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

データの削除

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

Select-ServiceNow -Connection $conn -Table incident -Where "category = request" | Remove-ServiceNow

データの挿入と更新

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

Import-Csv -Path C:\MyincidentUpdates.csv | %{
  $record = Select-ServiceNow -Connection $ServiceNow -Table incident -Where ("sys_id = `'"+$_.sys_id+"`'")
  if($record){
    Update-ServiceNow -Connection $servicenow -Table incident -Columns ("sys_id","priority") -Values ($_.sys_id, $_.priority) -Where ("sys_id = `'"+$_.sys_id+"`'")
  }else{
    Add-ServiceNow -Connection $servicenow -Table incident -Columns ("sys_id","priority") -Values ($_.sys_id, $_.priority)
  }
}

おわりに

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