アプリケーションのリポジトリ(設計情報)を Excel 形式のファイルで出力する機能です。印刷してお使いいただくことを意図しています。
本ツールが出力するExcelファイルの例を図1〜図4に示します。
ここでは Windows OS での利用方法を説明します。Linux/Mac OS Xで操作される場合はコンソールをお使いください。
「スタートメニュー>プログラムとファイルの検索」欄に、"cmd" と入力して実行します。(図5,図6)
図7に示すような、コマンドプロンプトが表示されます。
コマンドプロンプトが起動したら、cd コマンドでカレントフォルダを移動します。移動先は Wagbyインストールフォルダ\wagbydesigner\bin です。(インストール先フォルダは適切に読み替えてください。)
同フォルダに含まれる Spec.jar を java コマンドで実行します。
java -jar Spec.jar
設計書が出力されます。(図10, 図11)
wagbydesigner\bin\spec フォルダ内に、ファイルが生成されます。(図12)
次のドキュメントが自動生成されます。
すべてのドキュメントは Excel 形式で出力されます。テンプレートとなるファイルを修正することで、レイアウトをカスタマイズすることができます。
テンプレートファイルはwagbydesigner\bin\spec\templateフォルダ以下に用意されています。
Wagby出荷時は、モデル項目の出力は100項目までとなっています。次の手順でこれを増やすことができます。
modelitem_list.xls で利用できます。次のプレースホルダを含めてください。(標準では含まれていません)
${modelitem[番号]/autocalc}
modelitem_list.xls で利用できます。次のプレースホルダを含めてください。(標準では含まれていません)
${modelitem[番号]/generic_check[1-5]}
${modelitem[番号]/generic_check/errormsg[1-5]}
${modelitem[番号]/generic_check/@warning[1-5]}
generic_check1からgeneric_check5までを指定できます。
generic_check/errormsgは、エラーメッセージ文字列です。
generic_check/@warningは、警告として利用するかどうかを表します。
「各モデル項目毎の定義(テンプレートファイル modelitem_list.xls)」では、モデル項目に関するすべてのリポジトリキーの値を出力できます。
書式は次のとおりです。
${modelitem[番号]/リポジトリキー}
${modelitem[番号]/model/modelitem/limit}
${modelitem[番号]/model/modelitem/defaultValue[@action=select]_2}
型情報の後ろに最大入力文字数と単位(全角/半角) を加える例を紹介します。次の入力制限の内容を出力するようにします。
具体的には "string(20) 全角" という出力を想定します。
bin/spec/template/modelitem_list.xlsの「項目の型」を次のようにします。
${modelitem[0]/@type} ${modelitem[0]/model/modelitem/limit} (${modelitem[0]/model/modelitem/limit_2})
0,1,2,... という項目すべてにこのようなプレースホルダを埋めていきます。
先の例を題材に説明します。次の2点を改良することを検討します。
この問題を解決するために、JavaScript言語を使って、出力文字列を加工するプログラムを自作することができます。この方法を説明します。
mapという変数が利用できます。これはキーがプレースホルダで、値に出力文字列が格納されたマップです。この関数内で、このマップを加工します。wagbydesigner/bin/spec/js/modelitem_list.js ファイルを用意します。次の内容とします。
function process() {
/*var stdout = java.lang.System.out;*/
var size = map.get("__maxmodelitem");
for (i=0; i<size; i++) {
var s = map.get("${modelitem["+i+"]/model/modelitem/limit}");
if (s != "" && s != null) {
s = " (" + s + ")";
var s2 = map.get("${modelitem["+i+"]/model/modelitem/limit_2}");
if (s2 != "" && s2 != null) {
if (s2 == "char") {
s = s + " 全角";
} else {
s = s + " 半角";
}
}
var type = map.get("${modelitem["+i+"]/@type}");
map.put("${modelitem["+i+"]/@type}", type+s);/* override */
/*var ret = map.get("${modelitem["+i+"]/@type}");
stdout.println(i+":type="+ret);*/
}
}
}
設計書出力時に、このスクリプトが実行されます。これによって modelitem[N]/@type という値が書き換えられます。具体的には、標準では "string" だった出力値が "string(10) 全角" などとなります。
既存のプレースホルダをそのままに値を再セットするため、テンプレートファイルを修正する手間を減らすこともできます。その他の説明は次のとおりです。
格納数は "__" ではじまる変数で取得できます。
| ファイル名 | 説明 | キー名 |
|---|---|---|
| list_screen.js | 画面定義一覧 - 一覧画面系 | __maxcondition : 検索条件の数。condition[N]/@name など。 __maxlist : 一覧表示の数。list[N]/@name など。 |
| menu_list.js | メニュー一覧 | __maxmenu : メニューの数。menu[N]/@desc など。 |
| modelitem_list.js | モデル項目一覧 | __maxmodelitem : モデル項目の数。modelitem[N]/@name など。 |
| model_list.js | モデル名一覧 | __maxmodel : モデルの数。model[N]/@modelId など。 |
| report_list.js | 帳票一覧 | __maxprintlayout : 帳票の数。printlayout[N]/@filename など。 |
| show_screen.js | 画面定義一覧 - 詳細画面系 | __maxmodelitem : モデル項目の数。modelitem[N]/@name など。 |
起動時のオプションは次のとおりです。
利用例: java -jar Spec.jar -help
| オプション | 説明 |
|---|---|
| -help | 指定できるオプション一覧を表示します。 |
| -debug | デバッグモードで起動します。 |
| -renumbersort | 画面定義一覧の設計書ページ内の「一覧表示 > ソート」を Wagby R6 と同じ形式で出力する。 (Designerで入力した数値を元にソート項目を並び替え、これを 1,2,.. の順にリナンバリングする形式) |
| -x2aj | (Wagby R6 形式の) appschema.xml を出力する。設計書そのものは出力しない。 |
「リポジトリダウンロードサービス > 販売管理」で公開しているリポジトリに、本ツールを適用して得られた設計情報をダウンロードできます。出力結果のサンプルとしてご確認ください。