Copyright © NTT COMWARE 2014 NTT COMWARE CONFIDENTIAL PROPRIETARY OSS-EAI ドキュメント生成ツール 利用マニュアル NTT コムウェア 品質生産性技術本部 技術 SE 部 OSS ・ AP 技術担当
Copyright © NTT COMWARE 2014 NTT COMWARE CONFIDENTIAL PROPRIETARY 改定履歴 2 項番版数ページ章/節章/節内容変更年月日修正者 初版制定 2014/6/16 曽我部誠司
Copyright © NTT COMWARE 2014 NTT COMWARE CONFIDENTIAL PROPRIETARY 1. ドキュメント生成ツールとは? 3 ドキュメント生成ツールは、 OSS-EAI モデラーで作成したモデルの情報から、 ID 工程で の成果物の1つであるモデル仕様書を生成するツールです。 OSS-EAI モデラー ドキュメント生成ツール モデル情報 プロジェクト情報 XML モデル仕様書 モデル仕様書には、以下の仕様書が含まれます。 プロジェクト情報 モデル概要 コンポーネント仕様書
Copyright © NTT COMWARE 2014 NTT COMWARE CONFIDENTIAL PROPRIETARY 4 2. ドキュメント生成ツールのインストール 1. ドキュメント生成ツール (OSS-EAI_DocumentTools-bin.zip) を OSS-EAI サイトよりダウ ンロードします。 2. 適当なディレクトリに展開すると、以下のファイルが展開されます。 3.document-builder.jar と project.xml を適当なディレクトリにコピーします。 document—builder.jar - ドキュメント生成ツール pugininfo-builder.jar - プラグイン情報生成ツール project.xml - プロジェクト情報 XML の雛形 ドキュメント生成ツール利用マニュアル.ppt - このマニュアル sample\ - サンプルディレクトリ FileToDB.png - モデラーが生成するモデルの画像ファイル FileToDB.txt - モデラーが生成するモデルの XML project.xml - プロジェクト情報 XML モデル仕様書.xls - 上記情報から生成したモデル仕様書
Copyright © NTT COMWARE 2014 NTT COMWARE CONFIDENTIAL PROPRIETARY 5 3. ドキュメント生成ツールの実行 (1/3) 1. ドキュメント生成ツールをコピーしたディレクトリに、 OSS-EAI モデラーが生成したモデル XML と画 像ファイルをコピーします。 コピー
Copyright © NTT COMWARE 2014 NTT COMWARE CONFIDENTIAL PROPRIETARY 6 3. ドキュメント生成ツールの実行 (2/3) 2. プロジェクト情報 XML を修正します。 <!-- モデラーが生成したモデルを設定します。 --> FileToDB.png 説明 <!-- ドキュメントの改訂履歴を定義します。 --> 新規作成 コム太郎 プロジェクト名(表紙に出力されます) モデル名 OSS-EAI が生成したモデルの画像ファイル名 版数(改訂履歴等に出力されます)
Copyright © NTT COMWARE 2014 NTT COMWARE CONFIDENTIAL PROPRIETARY 7 3. ドキュメント生成ツールの実行 (3/3) 3. コマンドラインでドキュメント生成ツールを実行すると、モデル仕様書が生成されます。 使用方法がわからない場合は、 ”-h” オプションを指定します。 c:\tools> java –jar document-builder.jar –p project.xml FileToDB.txt $ java -jar document-builder.jar -h document-builder ver ( ) 使用方法 : OSS-EAI モデラーが生成したモデルからプロパティの仕様書 (Excel) を生成します。 java -jar document-builder.jar [options] model.txt model.txt : モデラーが生成する XML ファイルを指定します。 -h (--help) : 使用方法を表示します。 -o (--output) VAL : 出力するプロパティ仕様書 (Excel) を指定します。 -p (--project) VAL : プロジェクト情報 XML を指定します。 -t (--template) VAL : プロパティ仕様書 (Excel) のテンプレートを指定します。指定しない場合は、デフォルトのテンプレートを使用します。 -v (--version) : バージョンを表示します。 ドキュメント生成ツールのバージョン
Copyright © NTT COMWARE 2014 NTT COMWARE CONFIDENTIAL PROPRIETARY 8 4. 注意事項 ドキュメント生成ツールは、 OSS-EAI モデラーのバージョンに依存しています。 ドキュメント生成ツール は、 OSS-EAI モデラー に対応しています。 OS-EAI モデラーで、コンポーネントのプロパティに ”$_{xxx}”( 外部プロパティに切り出し)を使用 した場合、ドキュメント生成ツールでは、 ”${xxx}” と出力されます。 モデルに条件分岐がある場合、条件分岐はモデル仕様書に出力されません。モデルにコメントで条件 を記載するようにしてください。
Copyright © NTT COMWARE 2014 NTT COMWARE CONFIDENTIAL PROPRIETARY 問い合わせ先 9 本書および OSS-EAI についてのお問い合わせは、下記までお願い致します。 品質生産性技術本部 技術 SE 部 OSS ・ AP 技術担当 電話: メール: