SessionDoc

CER ermöglicht Ihnen die Ausgabe einer HTML-Dokumentation für eine Sitzung. Diese Dokumentation wird als "SessionDoc" bezeichnet.

Das SessionDoc enthält einen Datensatz für alle Regelobjekte, die während der Sitzung erstellt wurden, und kann im Rahmen von Tests wertvolle Dienste für das Debugging leisten.

Es kann hilfreich sein, den JUnit-Ankerpunkt tearDown zu verwenden, um durchzusetzen, dass das SessionDoc für alle Testmethoden in den Testklassen ausgegeben wird:

@Override
          protected void tearDown() throws Exception {
          /*
          * Write out SessionDoc, to a directory named after the test
          * method.
          */
          final File sessionDocOutputDirectory =
          new File("./gen/sessiondoc/" + this.getName());
          sessionDoc.write(sessionDocOutputDirectory);

          super.tearDown();
          }

Das folgende Beispiel zeit die SessionDoc-Hauptseite für einen Test testSelfMadeMillionaireScenario:

Abbildung 1. SessionDoc für Test testSelfMadeMillionaireScenario

Diese Seite enthält einige wichtige Details:

• Datum und Uhrzeit für die Erstellung des SessionDoc
• Strategien für die Erstellung der Sitzung
• Liste der Regelwerke, deren Regelobjekte im SessionDoc erfasst wurden
• Angabe, ob Links des Typs "Used by" enthalten sind

Wenn Sie auf den Link für das einzige Regelwerk FlexibleRetirementYearRuleSet klicken, werden dessen Regelobjekte angezeigt:

Abbildung 2. Regelobjekte für das Regelwerk FlexibleRetirementYearRuleSet

Auf dieser Seite ist Folgendes angegeben:

• "Externe" Regelobjekte (für Bootstrap), die während dieser Sitzung durch den Client-Code erstellt wurden (im Test wurde nur ein Objekt erstellt)
• "Interne" Regelobjekte, die während dieser Sitzung durch Regeln erstellt wurden (bei diesem Test nicht berechnet)

Wenn Sie auf den Link "details" für das einzige Regelobjekt FlexibleRetirementYear klicken, wird dessen SessionDoc angezeigt:

Abbildung 3. SessionDoc für Regelobjekt FlexibleRetirementYear

Am (hier nicht dargestellten) Beginn des SessionDoc sind Details für das Regelobjekt zusammengefasst. Anschließend ist jedes Regelattribut für das Regelobjekt mit den folgenden Details aufgeführt:

• Name

  Der Name des Regelattributs.

• Declared type

  Der Typ des Regelattributs, der im Regelwerk deklariert ist. Der tatsächliche Laufzeitwert kann aus einem Subtyp dieses deklarierten Typs stammen.

• State

  Der Status des Wertes. Mögliche Angaben:

  • CALCULATED

    Der Wert wurde durch Regeln berechnet.

  • SPECIFIED

    Der Wert wurde als Ersatz für eine definierte Berechnung explizit durch Client-Code angegeben oder im Rahmen eines Ausdrucks create initialisiert.¹

  • NOT_YET_CALCULATED

    Der Wert ist nicht explizit angegeben oder wird nicht während der Regelausführung berechnet (weil der Wert noch nie von anderen Berechnungen oder Tests angefordert wurde).

  • ERROR

    Während der Berechnung des Wertes trat ein Fehler auf (Details und den Berechnungsstack des Fehlers können Sie den Anwendungsprotokollen oder der Konsolenausgabe entnehmen).

• Value

  Eine Anzeigedarstellung des Wertes. Falls der Wert noch nie berechnet wurde (NOT_YET_CALCULATED) oder fehlerhaft ist (ERROR), wird "?" angezeigt. Handelt es sich bei dem Wert um ein Regelobjekt, wird der Wert als navigationsfähiger Hyperlink angezeigt, damit Sie die Details dieses Regelobjekts anzeigen können.

• Derivation

  Die RuleDoc-Ableitung des Attributs (ohne Links). Weitere Informationen zum RuleDoc finden Sie im Abschnitt RuleDoc.

• Depends on

  Hier sind die Links zu den Attributen angegeben, die zur Berechnung dieses Wertes verwendet wurden.

• Used by

  (Optional) Hier sind die Links zu den Attributen angegeben, die diesen Wert bei der Berechnung ihres eigenen Wertes verwendet haben.

Für Regelobjekte, die in den Datenbanktabellen von CER gespeichert sind, können Sie das SessionDoc erstellen, indem Sie die Klasse curam.creole.util.DumpOutRuleObjects mit einem einzigen Argument ausführen, für das Sie den Namen eines Verzeichnisses angeben, in dem das SessionDoc erstellt werden soll. Das Dienstprogramm "DumpOutRuleObjects" ruft alle Regelobjekte aus den Datenbanktabellen von CER ab. Die Aktion für jedes externe Regelobjekt lautet folglich "retrieved" (= abgerufen). Alle internen Regelobjekte werden erstellt (da sie nicht gespeichert sind). Für sie ist daher die Aktion "created" (= erstellt) angegeben.