スクリプトの差分が分かる!「バージョン比較レポート」の使い方

Avatar
dstn

(執筆者:dstn 土岐 拓未)

はじめに

DataSpider Servista v4.1の「開発支援フレームワーク」の1つとしてリリースされた機能が、「バージョン比較レポート」です。

DataSpiderのスクリプトを中・長期的に開発・管理する上でとても役に立つ機能です。

今回はこの機能についてご紹介します!

バージョン比較レポートとは

スクリプトの変更履歴のDIFF(差分)を見ることができる機能です。

 

DataSpiderでは、スクリプトの履歴を「バージョン」という名前で管理しています。この「バージョン」間の差分をレポートしてくれる機能、というわけです。

開発者ならばGitやSubversionなどのバージョン管理システムを使って、ファイルの比較して差分を見ながら開発・レビューすることよくありますよね。そのアレです。

そのアレがDataSpiderのスクリプトでもできるようになりました! というのがこの機能。

あれこれ説明するよりも、まずは早速バージョン比較レポートを見てみましょう!

バージョン比較レポートは、▼こんな感じのHTMLで出力され、ブラウザで見ることができます

 

左側が比較する前のバージョン、右側が後のバージョンというように並べて表示されます。

スクリプトの画像も表示されるので、どのように変わったかを一目で把握することができます。

▼この部分では、変更内容の概要が表示されます。

どの処理が追加されたか、変更されたか、また削除されたか、ということが色分けされて表示されていますね。

各コンポーネント内の設定の変更も、▼このように変更部分がハイライトされて表示されます。

Mapperも▼このような感じでバージョン間の設定の差分が画像と共に表示されるので、どのような修正を行ったのかを把握することができます。

 

という感じで、スクリプトでこの部分がこんな感じで変更されたよ! というレポートを出力する機能がバージョン比較レポートとなります。

 

どうやって使うののか

こんな感じです!

Version.gif

▲実際にバージョン比較レポートを見ている動画がこちら。

 

手順を簡単に説明すると、▼スクリプトを右クリックして「バージョン比較レポートの出力」を選択します。

▼開いたダイアログでCtrキーを押しながら比較したい2つのバージョンを選択します。

▼「完了」ボタンを押すとブラウザでバージョン比較レポートが開きます

以上、簡単ですね。

 

ブラウザですぐに開くので、すぐに比較結果を確認することができるので便利です。

もし「出力後にブラウザ開く」のボタンを外せばブラウザでは開かずにファイルを出力するのみの動作となります。

用途に応じて使い分けでください。

 

どんなときに使うのか

開発時の変更部分の確認や、不要な修正を行っていないかのチェック、納品時に提出するエビデンスなど幅広く利用できます。

 

例えばスクリプト開発をしていて、ひとまとまりの開発が完了した段階で、

修正が完了しました! レビューをお願いします。

 

 どの部分を変更したのか教えてください。

 という会話になることがあるかと思います。

 

そのようなとき、バージョン比較レポートでは自分で資料をまとめたり口頭で説明したりするよりもずっと早く正確に、変更部分を知らせることができます。

 

スクリプトを開発を試行錯誤しながらやっていく過程であれば、

修正したい箇所以外に不要な修正をしていないか・・・・

と不安になることもあるかと思います。そのようなとき、バージョン比較レポートで変更のあった箇所を確認すれば、どのような箇所に修正されたかを簡単に特定することができます。

 

また、中・長期のデータ連携開発プロジェクトが終わった際に、

今回ののプロジェクトでの開発部分をドキュメントとして提出してください。

 ということが求められることもあると思います。バージョン比較レポートは中・長期的な過去のバージョンとの差分をとることもできるため、エビデンスとして生成されたHTMLを使用することができます。

 

とこのように、開発プロジェクトのさまざまなシチュエーションで役立てることができます。

ぜひご活用ください。

 

おまけ:仕様書の出力もすぐにブラウザで開くことができます!

直接「バージョン比較レポート」とは関係ないですが、既存の機能である「仕様書の生成」もv4.1ですぐにブラウザで開く機能が追加されました!

 

これを待望していた方も多いはず・・・ぜひあわせてご活用ください!

 

コメント

ログインしてコメントを残してください。

Powered by Zendesk