UML モデル・レポートを生成する Ant スクリプトの使用

Apache Ant スクリプトを使用して、UML モデル・レポートの生成ができます。モデルへの変更を行う場合、レポートを自動的に生成するようにスクリプトを設定することができます。
このタスクについて

Apache Ant は、オープン・ソースで Java ベースのビルド・ツールです。ワークベンチから Ant ビルド・ファイルを作成して実行することができます。Ant ビルド・ファイルは、ワークスペース内のリソースだけでなくファイル・システム内のリソースでも 動作します。

これらの説明は、Ant ビルド・ファイルを使用してワークベンチ内からモデルのレポートを生成するためのものです。Ant ビルド・ツールの詳細については、 Apache Ant の Web サイトとワークベンチの概要トピックを参照してください。

レポートの生成を処理する Ant スクリプト要素は、カスタム要素 com.ibm.ccl.erf.rsa.report.ic.ant.UMLBirtReportPublish です。 スクリプトにより複数のレポートを生成する必要がある場合、スクリプトにこれらの要素を複数含めることができます。

Ant スクリプトを使用してレポートを生成する手順は次のとおりです。

  1. 「プロジェクト・エクスプローラー」ビューで、XML 拡張子を持つ新規ファイルをプロジェクトに作成します。
  2. Ant エディターをこのファイルのデフォルト・エディターとして設定します。
    1. 「ウィンドウ」 > 「設定」の順にクリックします。
    2. 「一般」を展開し、「エディター」を展開して、 「ファイルの関連付け」をクリックします。
    3. 「ファイル・タイプ」リストの右にある「追加」をクリックし、XML ファイルの名前を入力して、「OK」をクリックします。
    4. 「ファイル・タイプ」リストから、XML ファイルを選択します。
    5. 「関連付けられたエディター」リストから、 「Ant エディター」を選択し、「デフォルト」をクリックしてから、 「OK」をクリックします。 Ant エディターがリストにない場合、「追加」をクリックして追加します。
    6. XML ファイルが開いている場合、XML ファイルを閉じます。次に、ファイルをダブルクリックしてデフォルトの Ant エディターで開きます。
  3. XML ファイルで、<pr と入力し、「要素完成 (element completion)」ウィンドウで、<project> 要素をダブルクリックします。
  4. <project> 要素のデフォルト・ターゲットを例えば、 <project default="MyTarget"> のように割り当てます。
  5. <project> 要素タグを開いて、例えば <project default="MyTarget"><target name="MyTarget"></target></project> のようにターゲットを作成し、要素タグを閉じます。
  6. <target> 要素タグを開いて、<pu と入力し、完成リストから PublishUMLBIRTReport を選択して、要素タグを閉じます。 これにより、UMLBirtReportPublish 要素が、Ant スクリプトに追加されます。
  7. タスク・パラメーターの値を指定し、「ファイル」 > 「保存」とクリックします。
    注: 構文について詳しくは、『BIRT レポート設計を使用した UML レポート生成の Ant 構文』のトピックを参照してください。
    スクリプトは、以下の例と同様になります。
    <project default="MyTarget"><target name="MyTarget">
          <com.ibm.ccl.erf.rsa.report.ic.ant.UMLBirtReportPublish 
             modelPath="C:¥workspace¥MyModel.emx" 
             targetOutputFolder="c:¥temp¥pubweb" 
             targetOutputFile="MyReport.html" 
             reportDesignFile="file:/C:/<product location>/plugins/com.ibm.ccl.erf.rsa.report.data/designs/modelSummary.rptdesign" 
             overwriteExisting="true" 
             autoShowPublishedOutput="true" 
             errorHandling="ignore" 
             outputType="html"
             transform=""/>
    </target></project>
  8. 「プロジェクト・エクスプローラー」ビューで、XML ファイルを右クリックし、「実行」 > 「Ant ビルド...」とクリックします。 「Ant ビルド」ではなく、「Ant ビルド...」をクリックするようにしてください。
  9. ダイアログ・ボックスの「JRE」ページの「ランタイム JRE」の下で、 「ワークスペースと同じ JRE で実行 (Run in the same JRE as workspace)」をクリックします。
  10. スクリプトを実行し、レポートを生成するには、「適用」をクリックし、次に「実行」をクリックします。
タスクの結果
Ant スクリプトを モデルが変更されるたびに自動的に実行されるビルド・ファイルとして設定することもできます。詳しくは、チュートリアルの『Apache Ant による公開とレポート作成の自動化』に従ってください。

XSLT テンプレートを使用して、レポートを生成するのに Ant スクリプトを使用するには、完成リストから PublishBIRTUMLReport ではなく PublishReport を選択し、com.ibm.xtools.publish.CLLegacyXSLTReportPublish タスクの値を指定します。 構文について詳しくは、『XSLT テンプレートを使用した UML レポート生成の Ant 構文』のトピックを参照してください。

関連情報
チュートリアル: Apache Ant による公開とレポート作成の自動化
Apache Ant Web サイト

フィードバック