バージョン管理機能を利用する

 2017.05.09  株式会社システムインテグレータ

本連載では、設計書ジェネレータ「SI Object Browser Designer(以下、OBDZ)」を使ってソフトウェアの設計書(仕様書、基本設計書、詳細設計書)を作る講座です。

今回は「バージョン管理」機能についてご説明します。

操作方法を覚えるには、実際に製品を触りながら行うのが一番ですので、 OBDZをお持ちでない方はぜひ評価版をインストールの上、お読みください。 以下のURLよりお申込みいただくと、ログインに必要なアカウントを取得いただけます。
https://www.sint.co.jp/products/obdz/trial/trial.html

チェックイン・チェックアウト機能

バージョン管理についてご説明する前に「チェックイン/チェックアウト」機能についてご説明します。

チェックイン/チェックアウトとはデータの同時更新を防ぐ機能です。
OBDZは複数の設計者が接続して同時利用できますが、同時に他のユーザーが同じ設計データを編集すると データの不整合問題が発生してしまいます。OBDZではこのような2重更新を防止するために当機能が搭載されています。

なお、VSSやSVN、Gitなどのバージョン管理ソフトをご利用の方は、これらの製品に搭載されているチェックイン/チェックアウト機能と同じ機能と思っていただいて構いません。

最初は、画面、帳票などの各設計データは編集不可能な状態となっています。データを編集開始するにはチェックアウトを実施します。 システムエクスプローラにて対象の機能(画面や帳票等)の右側にある「…」をクリックし、ポップアップメニューより「チェックアウト」を選択することでチェックアウトできます。チェックアウトされたデータは赤色で表示されます。 

version

画面1.システムエクスプローラからチェックアウトする

また、画面や帳票などを開いた画面内の右上の「チェックイン中」の箇所をクリックし プルダウンメニューから「チェックアウト」を選択することでもチェックアウトが可能です。チェックアウトされたデータは「チェックアウト中」と表示されます。 

version2

画面2.画面を開いた状態でチェックアウトする場合

新規CTA

チェックアウト後はデータの編集が可能となります。チェックアウト状態の場合は、他のユーザーはチェックアウト操作ができないため、同時更新はできません。 この仕組みによって2重更新を防ぐことができます。

編集後は、チェックインを実施することで変更を確定します。 チェックアウト時と同様、システムエクスプローラの「…」をクリック>「チェックアウト」、または各画面を開いた状態で「チェックアウト中」をクリック>プルダウンメニューより 「チェックイン」を選択します。以下のようなダイアログが表示されます。

version3

画面3.チェックイン時のダイアログ

このダイアログでは、変更後のバージョンを「手動で設定」、「自動インクリメント」、「変更しない」のいずれかから選択します。また、あわせて「コメント」欄に 修正内容を記述します。「はい」ボタンを押すことで、変更内容が確定され、再度他のユーザーがチェックアウト可能な状態となります。

また、チェックアウトを取り消す場合はシステムエクスプローラの「…」をクリック>「チェックアウト取消」、または各画面を開いた状態で「チェックアウト中」をクリック>プルダウンメニューより 「チェックアウト取消」を選択します。取り消した場合は、チェックアウト前のデータの状態となり、 再度他のユーザーがチェックアウト可能な状態となります。

lights.png機能の新規作成時について
画面、帳票などの各設計データの新規作成時は自動でチェックアウト状態になります。
作成後はチェックインも忘れずに実施してください。
[RELATED_POSTS]

バージョン管理機能

バージョン管理画面では、上記チェックアウト・チェックインを繰り返して変更した内容を確認することができます。
システムエクスプローラの「…」をクリック>「機能バージョン履歴」を選択すると、下記のような画面が表示され、変更日時などの他、上記のチェックインダイアログで更新したバージョン、コメントなどの情報一覧表示されます。


version4

画面4.バージョン管理画面

lights.png修正コメントについて
なお、コメント内容についてはレポート出力画面で出力した基本設計書、詳細設計書の「表紙」の修正履歴一覧にも反映されます。

また、この画面で項目を2つ選択し、「比較」ボタンをクリックすることで、バージョン間の変更内容を確認することもできます。

version5

画面4.比較結果画面

この画面でどこを変更したのかが一目でわかります。

従来のWord/Excelで基本設計書、詳細設計書を作る運用でも、バージョン管理ソフトと併用することで「いつ」「誰が」変更したのか管理できるようになりますが、 「どこを」変更したのかを調べるのは難しいと思います。OBデザイナーではこのように変更内容までトレースできるのが特長となっています。 もし、変更内容を調べた結果、誤ってデータを変更していた場合は、バージョン管理一覧画面の「…」をクリック>「ロールバック」より前のバージョンに戻すことも可能です。

以上でバージョン管理機能についてご紹介しました。 OBDZではバージョンを管理機能が標準搭載されていますので、2重更新などの不整合問題を防止できること、 また、「いつ」「誰が」「どこを」まで調べられることが可能となっています。昨今では内部統制に力を入れられている企業も多いと思いますが、 設計書データの変更ログをシステム管理したい場合は、ぜひご検討いただければと思います。

新規CTA

RECENT POST「設計書の書き方講座」の最新記事


この記事が気に入ったらいいねしよう!
ブログ購読のお申込み

RANKING人気資料ランキング

RANKING人気記事ランキング

RECENT POST 最新記事

ITだけCAD使ってない不思議