OSS-EAI ドキュメント生成ツール 利用マニュアル

Presentation on theme: "OSS-EAI ドキュメント生成ツール 利用マニュアル"— Presentation transcript:

1 OSS-EAI ドキュメント生成ツール 利用マニュアル
NTTコムウェア 品質生産性技術本部 技術SE部 OSS・AP技術担当

2 改定履歴 項番 版数 ページ 章/節 内容 変更年月日 修正者 1 1.1.0 - 初版制定 2014/6/16 曽我部誠司 2 1.3.0
6,7 複数モデル対応 2015/02/13

3 1. ドキュメント生成ツールとは？ ドキュメント生成ツールは、OSS-EAIモデラーで作成したモデルの情報から、ID工程での成果物の１つであるモデル仕様書を生成するツールです。 OSS-EAI　モデラー モデル情報 モデル仕様書 ドキュメント生成ツール プロジェクト情報XML モデル仕様書には、以下の仕様書が含まれます。 プロジェクト情報 モデル概要 コンポーネント仕様書 3

4 2. ドキュメント生成ツールのインストール ドキュメント生成ツール(OSS-EAI_DocumentTools-bin.zip)をOSS-EAIサイトよりダウンロードします。 適当なディレクトリに展開すると、以下のファイルが展開されます。 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 上記情報から生成したモデル仕様書

5 3. ドキュメント生成ツールの実行 (1/3) コピー
3. ドキュメント生成ツールの実行　(1/3) ドキュメント生成ツールをコピーしたディレクトリに、OSS-EAIモデラーが生成したモデルXMLと画像ファイルをコピーします。 コピー

6 3. ドキュメント生成ツールの実行 (2/3) プロジェクト情報XMLを修正します。 プロジェクト名（表紙に出力されます） モデル名
3. ドキュメント生成ツールの実行　(2/3) プロジェクト情報XMLを修正します。 プロジェクト名（表紙に出力されます） <?xml version="1.0" encoding="UTF-8"?> <project id="FileToDBプロジェクト"> <!-- モデラーが生成したモデルを設定します。 --> <models> <model id=“FileToDB"> <image>FileToDB.png</image> <description>説明</description> </model> <model id=“DBToDB"> <image>DBToDB.png</image> </models> ドキュメントの改訂履歴を定義します。 <changelogs> <changelog id=“1.0"> <date> </date> <description>新規作成</description> <author>コム太郎</author> </changelog> </changelogs> </project> モデル名 OSS-EAIが生成したモデルの画像ファイル名 複数モデルの場合 版数（改訂履歴等に出力されます） 複数記載できます。

7 3. ドキュメント生成ツールの実行 (3/3) c:\tools> java –jar document-builder.jar
3. ドキュメント生成ツールの実行　(3/3) コマンドラインでドキュメント生成ツールを実行すると、モデル仕様書が生成されます。 使用方法がわからない場合は、”-h”オプションを指定します。 c:\tools> java –jar document-builder.jar $ java -jar document-builder.jar -h document-builder ver ( ) 使用方法: OSS-EAIモデラーが生成したモデルからプロパティの仕様書(Excel)を生成します。 java -jar document-builder.jar [options] model.txt -h (--help) : 使用方法を表示します。 -o (--output) モデル仕様書.xls : 出力するプロパティ仕様書(Excel)を指定します。 -p (--project) project.xml : プロジェクト情報XMLを指定します。 -t (--template) template.xls : プロパティ仕様書(Excel)のテンプレートを指定します。指定しない場合は、デフォルトのテンプレートを使用します。 -v (--version) : バージョンを表示します。 ドキュメント生成ツールのバージョン

8 4. 注意事項 ドキュメント生成ツールは、OSS-EAIモデラーのバージョンに依存しています。
OS-EAIモデラーで、コンポーネントのプロパティに”$_{xxx}”(外部プロパティに切り出し）を使用した場合、ドキュメント生成ツールでは、”${xxx}”と出力されます。 モデルに条件分岐がある場合、条件分岐はモデル仕様書に出力されません。モデルにコメントで条件を記載するようにしてください。

9 問い合わせ先 品質生産性技術本部 技術SE部 OSS・AP技術担当 電話：043-211-3576 メール：soa@nttcom.co.jp
本書およびOSS-EAIについてのお問い合わせは、下記までお願い致します。 品質生産性技術本部　技術SE部　OSS・AP技術担当 　　電話： 9