Beispiele¶
In dem Verzeichnis examples der Distribution von best4Automic befinden sich Dateien, die als Beispiele für die Nutzung der b4A Module dienen. Die Unterverzeichnisse sind nach den Modulen benannt. Im Folgenden wird der Inhalt der einzelnen Verzeichnisse beschrieben.
Wenn Beispielkommandos angegeben werden, dann wird davon ausgegangen, dass das aktuelle Arbeitsverzeichnis das bin-Verzeichnis der b4A Distribution ist.
pm.DocBuilder¶
In diesem Verzeichnis befinden sich Vorlagen für die Erzeugung von Dokumentationen im HTML-, SVG-, BPMN-, Confluence Storage- und Markdown-Format. Um die Dokumentation auf Basis dieser Vorlagen zu erzeugen können folgende Kommandos genutzt werden (UNIX):
HTML-Format
./b4A pm.DocBuilder -C <Verbindung> --template-dir ../examples/pm.DocBuilder/HTML --output-dir <Ausgabeverzeichnis> --extended-usage
cp ../examples/pm.DocBuilder/HTML/b4a.css <Ausgabeverzeichnis>
cp ../examples/pm.DocBuilder/HTML/b4a-logo.png <Ausgabeverzeichnis>
SVG-Format
Für die SVG-Vorlage ist zusätzlich der erweiterte Modus des b4A Moduls zu aktivieren. Außerdem ist es erforderlich ein b4A Expressions Attribute svg.resource.path anzugeben. Der Wert muss einen relativen Pfad vom Ausgabeverzeichnis zur Datei Svg-stylesheet.css enthalten.
./b4A pm.DocBuilder -C <Verbindung> --template-dir ../examples/pm.DocBuilder/SVG --output-dir <Ausgabeverzeichnis> --extended-workflow-attrs --custom-attributes svg.resource.path=<Pfad zu svg-stylesheet.css>
cp ../examples/pm.DocBuilder/SVG/svg-stylesheet.css <Ausgabeverzeichnis>
cp ../examples/pm.DocBuilder/SVG/task-*.SVG <Ausgabeverzeichnis>
BPMN
Auch für BPMN wird der erweiterte Modus benötigt. Bisher gibt es nur eine Beispiel-Vorlage für Standard Workflows.
./b4A pm.DocBuilder -C <Verbindung> --template-dir ../examples/pm.DocBuilder/BPMN --output-dir <Ausgabeverzeichnis> --extended-workflow-attrs
Confluence Storage Format
./b4A pm.DocBuilder -C <Verbindung> --template-dir "../examples/pm.DocBuilder/Confluence Storage Format" --output-dir <Ausgabeverzeichnis>
Markdown
Markdown ist eine weit verbreitete Markup-Sprache. Mit diesen Vorlagen kann die Dokumentation von Packages in diesem Format erstellt werden um diese beispielsweise in Wiki-Systemen zu integrieren.
./b4A pm.DocBuilder -C <Verbindung> --template-dir ../examples/pm.DocBuilder/Markdown --output-dir <Ausgabeverzeichnis> --extended-workflow-attrs --extended-usage-with-processes --extended-usage
pm.ImportBPMN¶
In diesem Verzeichnis befinden sich Beispieldateien für das Modul b4A pm.ImportBPMN. Die eine Kategorie von Dateien sind Beispiele für Konfigurationsdateien des Camunda Modeler und die anderen sind BPMN-Dateien, die mit Hilfe dieser Konfigurationen erzeugt worden sind.
Der Camunda Modeler Ein Programm zum Erstellen von BPMN-Prozessen. Mit den Konfigurationsdateien werden Vorlagen für (Service-)Tasks ausgeliefert, die das Erstellen von konformen BPMN-Prozessen für das b4A Modul pm.ImportBPMN vereinfachen. Die gewünschten Konfigurationsdateien müssen in das Unterverzeichnis resources/element-templates der Camunda Modeler Installation kopiert sein. Das Verzeichnis element-templates muss gegebenenfalls angelegt werden.
b4a.json: Eine Sammlung von Vorlagen um das einfache Erstellen von Prozessen auf Basis von vordefinierten Vorlangen zu demonstrieren. Beispielhaften wurden Vorlagen für das Ausführen eines SAP-Reports und das Transferieren von Dateien definiert.
testing.json und testing-actions.json: Diese beiden Konfigurationen definieren Vorlagen für das Erstellen und Test-Workflows. Einmal auf Basis von zu klonenden Objekten und einmal auf Basis von Actions (per PromptSet parametrisierbare Objekte)
Der Camunda Modeler kann unter der folgenden URL heruntergeladen werden: https://camunda.org/download/modeler/
Die ausgelieferten BPMN-Dateien sind auf Basis der Vorlagen erstellt worden und können mit dem Modul pm.ImportBPMN in Workflows umgesetzt werden. Dafür ist es nötig, dass das b4A Package PCK.BEST4AUTOMIC_BPMN installiert ist.
ta.Execute¶
Diese Beispiele enthalten Cucumber-Definitionen, die zeigen wie die Testfälle mit dieser Sprache beschrieben werden können. Diese Dateien müssen für die Nutzung mit den Modulen ta.Execute und ta.SaveTo zuvor in die Text-Dokumentation eines Objektes übertragen werden.
util.Mail¶
Die beiden Beispieldateien body-dependency-definition-verify.html und body-compliance-check.html sind Beispiele für den Hauptteil im HTML-Format. Dazu können die Beispiele für den Kopf (mail-header.html) und den Fuß (mail-footer.html) genutzt werden. Mit dem Hauptteil body-dependency-definition-verify.html wird einer Mail generiert, die die XML-Variable des Moduls pm.DependencyDefinitionVerify nutzt um einen Bericht zur Überprüfung der Abhängigkeitsdefinition eines b4A Package zu versenden. Die andere Beispieldatei body-compliance-check.html liest eine XML-Variable, die die Ergebnisse eines Compliance-Check enthält und erzeugt so einen Bericht über die Ergebnisse.
Mit dem folgenden Aufruf kann eine Mail gesendet werden, die einen Bericht zur Abhängigkeitsdefinitionsprüfung des b4A Package B4A.PM enthält.
./b4A-dev util.Mail -C <Verbindung> --subject "Dependency Definition Verification B4A.PM" --mail-recipients dev@beispiel.de,test@beispiel.de --mail-body ../examples/util.Mail/body-dependency-definition-verify.html --custom-attributes key=B4A.PM --mail-header ../examples/util.Mail/header.html --mail-footer ../examples/util.Mail/footer.html
Um einen Bericht zu einem Compliance Check von B4A.PM zu verschicken kann der folgende Aufruf genutzt werden.
./b4A-dev util.Mail -C <Verbindung> --subject "Compliance Check B4A.PM" --mail-recipients dev@beispiel.de,test@beispiel.de --mail-body ../examples/util.Mail/body-compliance-check.html --mail-header ../examples/util.Mail/header.html --mail-footer ../examples/util.Mail/footer.html