Erweiterungsfunktion „Create Reviews“
Diese Erweiterungsfunktion dient der automatischen Errzeugung von Reviews für Elemente innerhalb eines Packages. Für jedes Element, das die definierten Bedingungen (Konfiguration) erfüllt, wird ein Review erstellt, wenn für das Element noch kein Review erstellt wurde.
Setzen Sie die Erweiterungsfunktion ein, wenn mehrere Elemente in einen Review-Prozess überführt werden sollen, bspw. alle bewerteten Anforderungen.
Statt Reviews manuell anzulegen, werden sie für alle passenden Elemente automatisch erzeugt.
Die Erweiterungsfunktion kann aus der Amazon-Cloud heruntergeladen und in einem Projekt über eine Zustandsaktion oder über einen Kontextmenübefehl verwendet werden.
Hinweis
Stellen Sie sicher, dass im Service-Manager für den Service Node.js aktiviert ist, da sonst die Erweiterungsfunktion nicht ausgeführt werden kann.
Funktionsweise
Die Erweiterungsfunktion wird auf einem Package ausgeführt.
Vor der Erstellung von Reviews prüft das System, ob der ausführende Benutzer mindestens Leserechte für das Package besitzt. Sind die erforderlichen Rechte nicht vorhanden, wird die Funktion nicht ausgeführt.
Bei der Ausführung durchsucht das System das ausgewählte Package nach Elementen, die die konfigurierten Bedingungen erfüllen.
Ein Element wird berücksichtigt, wenn:
- es dem definierten Stereotyp entspricht,
- es sich in einem der angegebenen Zustände befindet,
- und noch kein Review zu diesem Element existiert.
Für jedes gefundene Element wird dann ein eigenes Review erzeugt.
Das Review wird als Kindelement direkt unterhalb des jeweiligen Elements angelegt und erhält standardmäßig den Namen Review von {Name des Elements}. Das Review wird im Startzustand des mitgelieferten Review-Workflows angelegt.
Bereits vorhandene Reviews bleiben unverändert. Elemente mit bestehendem Review werden bei der Ausführung übersprungen. Wird die Funktion erneut ausgeführt, werden nur die Elemente berücksichtigt, für die noch kein Review existiert. Wenn keine passenden Elemente vorhanden sind, gibt das System eine entsprechende Meldung aus.
Erweiterungsfunktion konfigurieren
Parameter
In der Erweiterungsfunktion sind drei Parameter enthalten, die Sie anpassen können.
- Stereotyp (isStereoType) Definiert, für welche Elementtypen ein Review angelegt werden soll.
- Inklusive Substereotypen (checkSubStereoType) Legt fest, ob Substereotypen des angegebenen Stereotyps beachtet werden sollen.
Markiert (Standard) Substereotypen werden ebenfalls beachtet.
Nicht markiert Nur der angegebene Stereotyp wird berücksichtigt. - Zustand (hasCurrentState) Definiert, in welchem Zustand sich das jeweilige Element befinden muss, damit ein Review angelegt wird. Hier können Sie aus den verschiedenen Zustandsautomaten die Zustandsnamen kommasepariert eintragen. Achten Sie auf:
- korrekte Schreibweise
- Es ist mindestens ein gültiger Zustand einzutragen, damit die Erweiterungsfunktion ausgeführt werden kann.
- Zustände müssen in den jeweiligen Zustandsautomaten existieren. Existiert ein definierter Zustand nicht, wird eine entsprechende Meldung ausgegeben und es werden keine Reviews für diese Elemente erstellt.
- identische Zustandsnamen müssen nur einmal angegeben werden
Die Option Dynamisch ist standardmäßig für alle Parameter markiert. Sie ist nur von Bedeutung, wenn die Erweiterungsfunktion über einen Befehl ausgeführt wird. Ist die Option markiert, können die Parameter bei der Ausführung über einen Befehl in einem Dialog überschrieben oder erweitert werden.
Parameter konfigurieren
- Gehen Sie zu dem Package, in das die Erweiterungsfunktion importiert wurde.
- Über das Kontextmenü der Erweiterungsfunktion wählen Sie Bearbeiten.
- Wechseln Sie in die Registerkarte Parameter.
- Konfigurieren Sie die Parameter gemäß Ihren Bedürfnissen.
- Schließen Sie den Dialog mit OK.
Die Erweiterungsfunktion ist nun einsatzbereit und kann manuell über einen Befehl, per Task oder als Zustandsaktion ausgeführt werden. Wenn Sie eine Zustandsaktion verwenden möchten, müssen Sie die Aktion im Zustandsautomaten von Packages oder einem untergeordneten Stereotypen definieren.
Erweiterungsfunktion ausführen
Manuelle Ausführung über einen Befehl
Die Erweiterungsfunktion wird über den konfigurierten Befehl gestartet,
Ist für mindestens einen Parameter die Option Dynamisch markiert, …
… erscheint beim Ausführen ein Dialog. In diesem Dialog können die hinterlegten Parameter überschrieben oder erweitert werden.
Sind die Parameter nicht dynamisch konfiguriert, wird die Funktion direkt mit den gespeicherten Einstellungen ausgeführt.
Automatische Ausführung über Zustandsaktion oder Task
Wird die Funktion im Rahmen einer Zustandsaktion oder über einen Task ausgeführt, erfolgt die Ausführung im Hintergrund.
Ein Dialog wird in diesem Fall nicht angezeigt.
Erweiterungsfunktion löschen
Wird die Erweiterungsfunktion in einer Aktion oder als Kontextmenübefehl verwendet, müssen diese Verknüpfungen zunächst entfernt werden. Löschen Sie dazu die entsprechende Aktion und/oder den Befehl.
Anschließend kann die Erweiterungsfunktion über ihr Kontextmenü mit dem Befehl Löschen aus dem Projekt entfernt werden. Dabei wird nur die Erweiterungsfunktion gelöscht. Das zugehörige Erweiterungsschema bleibt erhalten, da es auch von anderen Erweiterungsfunktionen verwendet werden kann.