Strukturieren des Regelwerkes

IT Projekte enthalten üblicherweise mehr als nur eine Validierungsregel. Je nach Projektgröße kann ein Projekt mehrere 1000 Regeln enthalten. Auch die Komplexität der Regeln muss im Zaum gehalten werden. Eine gute Möglichkeit die Komplexität zu reduzieren ist ein vernünftiges Modularisierungskonzept. Es geht darum etwas Großes in kleine, modulare Bestandteile aufzuteilen.

Zum Strukturieren des gesamten Regelwerks gibt es folgende Richtlinien. Einige davon sind verpflichtend und gehören somit zum festen Bestandteil der Grammatik. Die anderen sind optional und dienen als Empfehlung.

Die erste Empfehlung ist, dass man das gesamte Regelwerk in einer Datei mit der Extension *.ov ablegt.

Globale Elemente

Ein Regelwerk kann aus mehreren Regeln bestehen:

der Vertrag MUSS Unterschrieben sein
das Alter des Bewerbers MUSS MINDESTENS 18 sein

Regeln, Variablen und Kommentare bezeichnen wir als globale Elemente. Diese müssen stets durch einen Paragraphen voneinander separiert sein, wobei Paragraphen aus mindestens zwei Zeilenumbrüchen ohne Inhalt bestehen.

das Alter des Bewerbers ist KLEINER 18
ALS Minderjährig
WENN der Bewerber Minderjährig ist
UND sein Wohnort ist NICHT Dortmund
DANN Sie müssen mindestens 18 Jahre alt sein und aus Dortmund kommen
KOMMENTAR Über mir ist ein mehrzeiliger Paragraph

Das obere Regelwerk besteht aus zwei globalen Elementen:

  • Einer Variablen

  • Einer Validierungsregel

  • Und einem Kommentar

Die Trennung der Globalen Elemente durch einen Paragraphen ist verpflichtend und ist somit ein Teil der Grammatik. Auf diese Weise kann man beliebig viele Regeln, Variablen und Kommentare untereinander verfassen. Es wird empfohlen alle Variablen im oberen Teil des Regelwerks zu notieren.

Formatierung komplexer Regeln

Damit eine komplexe WENN/DANN Regel lesbar bleibt sollte diese folgendermaßen formatiert werden:

WENN der Bewerber Minderjährig ist
UND sein Wohnort NICHT Dortmund
DANN Sie müssen mindestens 18 Jahre alt sein
und aus Dortmund kommen

  • Innerhalb einer Regel sollen die Bedingungen und die Fehlermeldung durch einen Zeilenumbruch separiert werden.

  • Die Schlüsselwörter, wie WENN, UND und DANN sollen rechtsbündig an dem längsten Schlüsselwort ausgerichtet werden.

  • Nach dem ersten Schlüsselwort der jeweiligen Zeile kommen mindestens zwei Leerzeichen (Die Anzahl kann dabei variieren. Wichtig ist dabei die Konsistenz).

  • Lange Bedingungen oder Fehlermeldung können nochmal mit einem Zeilenumbruch formatiert werden. Wichtig ist, dass die nächste Zeile bündig mit dem Anfang der Vorherigen Zeile ist, wie es im Fall der Fehlermeldung ist, die nach dem DANN Schlüsselwort kommt und einen Zeilenumbruch enthält.

Formatierung von Variablen

das Alter des Bewerbers ist KLEINER 18
ALS Minderjährig

Das Schlüsselwort ALS und der Name sollten mit einem Zeilenumbruch von dem eigentlichen Wert der Variable getrennt werden. Der Wert der Variable sollte bündig mit dem Namen der Variablen sein. Diese Formatierung ist optional und dient lediglich der besseren Lesbarkeit.

Aufteilen des Regelwerks in mehrere Dateien

Es besteht die Möglichkeit das gesamte Regelwerk in mehrere Dateien aufzuteilen. So kann man beispielsweise Variablen in einer separaten Datei auslagern und mit Hilfe des Schlüsselwortes IMPORTIERE, externe Dateien hinzufügen:

Variablen.ov
das Alter des Bewerbers ist KLEINER 18
ALS Minderjährig
Regeln.ov
IMPORTIERE ./Variablen.ov
WENN der Bewerber Minderjährig ist
UND sein Wohnort ist NICHT Dortmund
DANN Sie müssen mindestens 18 Jahre alt sein und aus Dortmund kommen