UML-Modellberichte mit Ant-Scripts generieren

Sie können Apache Ant-Scripts zum Generieren von UML-Modellberichten verwenden. Sie können die Scripts so einrichten, dass die Berichte automatisch generiert werden, wenn Sie Änderungen an den Modellen vornehmen.

Apache Ant ist ein Java-basiertes Open-Source-Erstellungstool. Sie können Ant-Builddateien über die Workbench erstellen und ausführen. Die Ant-Builddateien können auf Ressourcen im Dateisystem und auf Ressourcen im Arbeitsbereich operieren.

Die vorliegenden Anweisungen beziehen sich auf die Verwendung von Ant-Builddateien zur Generierung von Berichten für Modelle in der Workbench. Weitere Informationen zum Ant-Erstellungstool finden Sie auf der Apache Ant-Website und in den Übersichtsabschnitten der Workbench.

Das Ant-Scriptelement, das die Berichterstellung verarbeitet, ist das angepasste Element com.ibm.ccl.erf.rsa.report.ic.ant.UMLBirtReportPublish. Ein Script kann mehrere solcher Elemente enthalten, wenn Sie mehrere Berichte generieren müssen.

Gehen Sie wie folgt vor, um einen Bericht mithilfe eines Ant-Scripts zu generieren:

  1. Erstellen Sie in der Sicht 'Projektexplorer' in einem Projekt eine neue Datei mit der Erweiterung XML.
  2. Legen Sie den Ant-Editor als Standardeditor für diese Datei fest:
    1. Klicken Sie auf Fenster > Einstellungen.
    2. Erweitern Sie Allgemein, erweitern Sie und Editoren, und klicken Sie anschließend auf Dateizuordnungen.
    3. Klicken Sie rechts neben der Liste Dateitypen auf Hinzufügen, geben Sie einen Namen für die XML-Datei ein, und klicken Sie auf OK.
    4. Wählen Sie in der Liste Dateitypen die XML-Datei aus.
    5. Wählen Sie in der Liste Zugeordnete Editoren die Option Ant-Editor aus, und klicken Sie auf Standard. Klicken Sie anschließend auf OK. Wenn der Ant-Editor in der Liste nicht enthalten ist, klicken Sie auf Hinzufügen, um ihn hinzuzufügen.
    6. Wenn die XML-Datei geöffnet ist, schließen Sie sie. Klicken Sie anschließend doppelt auf die Datei, um sie im Ant-Editor als Standardeditor zu öffnen.
  3. Geben Sie in der XML-Datei <pr ein, und klicken Sie im Fenster zur Vervollständigung von Elementen doppelt auf das Element <project>.
  4. Ordnen Sie im Element <project> ein Standardziel zu. Beispiel: <project default = MeinZiel>/
  5. Erstellen Sie zwischen dem öffnenden und dem schließenden Tag des <project>-Elements ein Ziel. Beispiel: <project default=MeinZiel><target name="MeinZiel></target></project>/
  6. Geben Sie zwischen dem öffnenden und dem schließenden Tag des <target>-Elements die Zeichenfolge <pu ein, und wählen Sie PublishBIRTUMLReport in der Vervollständigungsliste aus. Dadurch wird das Element UMLBirtReportPublish in Ihr Ant-Script eingefügt.
  7. Geben Sie Werte für die Taskparameter ein, und klicken Sie auf Datei > Speichern.
    Anmerkung: Informationen zur Syntax finden Sie im Abschnitt "Ant-Syntax für die Berichterstellung mit BIRT-Berichtsentwürfen".
    Das Script sollte in etwa wie im folgenden Beispiel aussehen:
    <project default="foo"><target name="foo">
       <!-- ===================================================================
          modelPath: erforderlicher Parameter, vollständig qualifizierter Pfad (FQP) zum zu publizierenden Modell
          targetOutputFolder: erforderlicher Parameter, vollständig qualif. Pfad (FQP) zum zu publizierenden Ordner
          targetOutputFile: erforderlicher Parameter, Dateiname des Berichts
       reportDesignFile: erforderlicher Parameter, ein URL zu einem auszuführenden Berichtsentwurf; siehe Anmerkung oben
       =================================================================== -->             
          <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"
    </target></project>
  8. Klicken Sie in der Sicht 'Projektexplorer' mit der rechten Maustaste auf die XML-Datei, und klicken Sie anschließend auf Ausführen als > Ant-Build.... Stellen Sie sicher, dass Sie auf Ant-Build ... und nicht auf Ant-Build klicken.
  9. Klicken Sie auf der Seite 'JRE' des Diaglogfensters unter Laufzeit-JRE auf In derselben JRE als Arbeitsbereich ausführen.
  10. Klicken Sie auf Anwenden und Ausführen, um das Script auszuführen und den Bericht zu generieren.
Sie können das Ant-Script auch als Builddatei einrichten, die automatisch ausgeführt wird, wenn ein Modell geändert wird. Weitere Informationen erhalten Sie, wenn Sie das Lernprogramm mit dem Namen "Veröffentlichung und Berichterstellung mit Apache Ant automatisieren" durcharbeiten.

Wenn Sie Ant-Scripts zur Generierung von Berichten unter Verwendung einer XSLT-Schablone verwenden wollen, wählen Sie PublishReport anstelle von PublishBIRTUMLReport in der Vervollständigungsliste aus und geben die Werte für die Task com.ibm.xtools.publish.CLLegacyXSLTReportPublish an. Informationen zur Syntax finden Sie im Abschnitt "Ant-Syntax für die Berichterstellung mit XSLT-Schablonen".

Zugehörige Informationen
Lernprogramm: Veröffentlichung und Berichterstellung mit Apache Ant automatisieren
Apache Ant-Website

Feedback