プリザンターのパラメータJSONファイルをCSV化してExcelの設定値一覧を作成する

概要

プリザンターのパラメータJSONファイルをCSV化するツールを作成してみました。変更管理などを目的としたExcelでのパラメータ設定値一覧を簡単に作成することができます。

本記事では、以下のようなExcelの設定値一覧を作成する手順を説明します。

Excelの設定値一覧は以下のような利用シーンを想定しています。

・既定値から変更を行ったパラメータの設定値を確認する。
・バージョンアップ前後のパラメータの設定値の差異を確認する。
・複数環境（開発環境と本番環境など）のパラメータの設定値の差異を確認する。

作成手順

1. パラメータJSONファイルをCSV化する

以下のリポジトリのREADMEを参考に、パラメータJSONファイルをCSV化します。

チェック用のスクリプトも上記リポジトリに置いていますので必要に応じてご利用ください。

このリポジトリの「PlstParamJsonToCsv.ps1」を実行すると、以下のようなJSONファイルが

Api.json

{
    "Version": 1.1,
    "Enabled": true,
    "PageSize": 200,
    "LimitPerSite": 0,
    "Compatibility_1_3_12": false
}

こんな感じに変換されます。

Output.csv（抜粋）

Api.json,Version,1.1
Api.json,Enabled,true
Api.json,PageSize,200
Api.json,LimitPerSite,0
Api.json,Compatibility_1_3_12,false

2. CSVファイルからExcelファイルを作成する

1. 変更前のパラメータJSONファイルをツールでCSV化します。（ファイルA）
2. Excelを起動します。
3. 左上のメニュー -> [データ] -> [テキストまたは CSV から] を選択します。
4. [データの取り込み] 画面でファイルAの「Output.csv」を選択し、[インポート] を押下します。
5. [インポート] の確認画面で [読み込み] を押下します。

1. 変更後のパラメータJSONファイルをツールでCSV化します。（ファイルB）
2. ファイルAと同様の手順でファイルBについてもデータのインポートを行います。
3. 1シートに必要な列をまとめます。
4. 罫線、ヘッダ、セルの色、関数、条件付き書式などを設定します。

作成イメージ

これで既定値から変更しているパラメータ設定値や2環境で設定が異なるパラメータ設定値をフィルタできるので、変更点に着目して確認することができますね。

補足
関数は以下のように設定しています。単純に2つのセルを比較しているだけです。

F3セルに設定するる関数

=IF(EXACT(C3,D3),"なし","あり")

変更有が「あり」の色付けは条件付き書式で設定しています。

おわりに

プリザンターはパラメータで柔軟な設定ができる一方で、パラメータファイルや設定値の数が多いため、手作業でJSONファイルをExcelに変換しようとするととても時間がかかってしまいます。自分だけが確認する場合はWinMergeなどの差分比較ツールで事足りる場面もありますが、上長やお客様など他者のレビューが必要な場合に一覧化した資料を提示しなければいけない場面もあると思います。パラメータ設定値を一覧形式でドキュメント管理しておきたい場合や、複数結果の差分確認をしたい場合に便利なので使ってみてください。

参考リンク

- implem-noro/PlstParamJsonToCsv
- tomnomnom/gron: Make JSON greppable!