Prüfregeln
Fachlich/inhaltliche Beschreibung
Die Perspektive Prüfregeln, Abfragen… umfasst die ASYS-Repositoryobjekte der Prüfregeln und Abfragen sowie der Fehlertexte und Abhilfetexte. Die beiden erstgenannten Objektklassen werden in dieser Perspektive definiert, aber größtenteils in den Konfigurationsoptionen der anderen Perspektiven zur Verwendung referenziert. Die beiden Textbausteinobjektklassen sind Hilfsobjekte für die Prüfregeln. Die genannten Objektklassen sind global für alle Repository-Standorte gültig und nutzbar.
Die in dieser Perspektive konfigurierbaren Repository-Objekte sind:
- Prüfregeln: Prüfregeln sind durch den Admin definierbare logische Ausdrücke oder 'Miniprogramme' in JavaScript. Sie können auf Inhalte von Maskenattributen, Abfragen und auf Datenfelder von Nachrichten zugreifen. Sie werden gebraucht, um Regelmengen für Masken und Nachrichten zusammenzustellen und Bearbeitungsfilter zu definieren.
Jede Prüfregel liefert als Ergebnis einen logischen Wert, also entweder true (Wahr) oder false (Falsch). Das Ergebnis true bedeutet dabei immer, dass die in der Prüfregel formulierte Prüfung erfolgreich absolviert wurde. Das Ergebnis false stellt den Fehlerfall dar. Dieser ist mit einer Fehlerstufe verbunden, welche die Schwere des Fehlerfalls darstellt (von 0 = Steuerregel für den Ablauf bis 4 = Datensatz kann/darf nicht gespeichert werden). Für den Fehlerfall können der Prüfregel ein Fehlertextbaustein und ein Abhilfetextbaustein zugeordnet werden, die im Fehlerprotokoll des geprüften Datensatzes abgelegt werden und ggf. einem Nachrichtenabsender übermittelt werden. Prüfregeln können als 'Sofortprüfregel' einem Maskenattribut zugeordnet werden. Sie werden dann sofort nach Eingabe eines Wertes in das Maskenfeld ausgeführt und nicht erst im Rahmen eines Prüfplan beim Speichern des Datensatzes. Zur Auslieferungsausstattung von ASYS gehören umfangreiche ASYS-Standardprüfpläne, die aus Standardprüfregeln bestehen. Für diese Standardprüfregeln gilt ein weitgehender Schutz vor Veränderungen durch den Admin. - Abfragen: Abfragen sind durch den Admin definierbare Abfrage-Anweisungen an die ASYS-Datenbank. In Abfragen lassen sich alle Datenverknüpfungen formulieren, die das ASYS-Datenmodell (FOM) hergibt. Abfragen gibt es in zwei Hauptvarianten, den freien Abfragen und den internen Abfragen.
Freie Abfragen können den ASYS-Nutzern über die Nutzerprofile zur Ausführung freigegeben werden. Sie lassen sich Masken zuordnen, damit sie im Kontext dieser Masken für die Nutzer bereitgestellt werden und aus den Masken mit Parametern versorgt werden können. Freie Abfragen gibt es darüber hinaus in den speziellen Ausprägungen der QS-Abfragen1) und der Auswertungsabfragen.
Interne Abfragen sind, wie ihre Bezeichnung bereits andeutet, nicht für die Verwendung durch die ASYS-Nutzer gedacht. Interne Abfragen dienen vielmehr als Mechanismus zur Ermittlung von Informationen aus dem Datenbestand für andere Repository-Objekte. Interne Abfragen sind bedeutsamt für Prüfregeln, die Empfängerermittlung von Nachrichten bei der ASYS-internen Kommunikation, für Textformulardefinitionen, für die Vorgangssteuerung und den Webservice. - Fehlertexte: Fehlertexte sind Textbaustein-Objekte, die den Prüfregeln zugeordnet werden. Fehlertextbausteine lassen sich den Prüfregeln auf zwei Arten zuordnen: Als Standardfehlertextbaustein in der Definition der Prüfregel und als individueller Fehlertext in der Zuordnung einer Prüfregel zu einer Regelmenge.
- Abhilfetexte: Abhilfetexte sind Textbaustein-Objekte, die den Prüfregeln zugeordnet werden. Abhilfetextbausteine lassen sich den Prüfregeln auf zwei Arten zuordnen: Als Standardabhilfetextbaustein in der Definition der Prüfregel und als individueller Abhilfetext in der Zuordnung einer Prüfregel zu einer Regelmenge.
Bedienung
Zuoberst befinden sich auf dem Tab-Reiter eine Zeile mit zwei Buttons und der Möglichkeit, eine Maske temporär zuzuordnen:
Der Button Tochteranwendung startet die Administrator-Tochteranwendung und übergibt ihr die Prüfregel für einen Test mit Daten aus der ASYS-Datenbank. Je nach Einstellung der Eigenschaften der aktuellen Prüfregel wird sie entweder als Oberflächen- bzw. Bearbeitungsfilterprüfregel oder als Nachrichtenprüfregel getestet.- Das Feld Maske dient der temporären2) Zuordnung einer Maske/eines Aufgabenbereichs zur Prüfregel. Durch diese Zuordnung können im Regelcode kontextsensitive Hilfestellungen für den Zugriff auf Datensatzfelder gegeben werden. Die Zuordnung in diesem Feld erfolgt per Drag&Drop aus der Auswahlliste der Masken oder über den Button Maskenauswahl (
), welcher einen Dialog 'Auswahl Maske' öffnet.
Der darunter befindliche Berech des Tab-Reiters einer Prüfregeldefinition im Bearbeitungsbereich des Administrators gliedert sich in vier Abschnitte:
Prüfregel
- Name: Die erste Zeile in diesem Abschnitt enthält den Namen der Prüfregel. Dieser wurde bei der Erstellung der Prüfregel vom Admin vergeben und kann nachträglich nicht mehr verändert werden.
Der Name einer Prüfregel darf nur Zeichen enthalten, die in der BMU-Schnittstelle zugelassen sind. Seit November 2022 dürfen neue BMU-Dokumente nur noch Zeichen enthalten, die im Datentyp C der DIN SPEC 91379 aufgeführt sind. Zeichen, die nicht in diesem Datentyp enthalten sind, werden vom Programm für Prüfregelnamen mit einer Fehlermeldung zurückgewiesen.
Fehlerbehandlung
Alle Konfigurationsoptionen in diesem Bereich dienen der Einstellung des Programmverhaltens, wenn die Prüfregel false als Ergebnis zurückliefert. Sie sind wirkungslos, wenn die Prüfregel true zum Ergebnis hat.
Fehlerstufe
Die Fehlerstufe dient der Einordnung, als wie schwer der Fehlerfall false eingeschätzt werden muss. Fünf Fehlerstufen sind definiert und können aus einer Drop-Down-Liste ausgewählt werden:
| Stufe | Bedeutung, Verwendung | Anzeige im Prüfplan | entspricht der BMU-Fehlerstufe |
|---|---|---|---|
| 0 | kein Fehler: Steuerregel zur Ablaufkontrolle des Prüfplans |  | INFO |
| 1 | Hinweis |  | INFO |
| 2 | Warnung |  | WARNUNG |
| 3 | Fehler |  | FEHLER |
| 4 | Fataler Fehler: schwerwiegender Fehler, der die Abspeicherung des Datensatzes verhindert, z.B. eine Datumsangabe liegt außerhalb des durch die Datenbanken verarbeitbaren Wertebereichs. |  | FATAL |
Bei Prüfregeln, die in Bearbeitungsfiltern verwendet werden, führt jede fehlgeschlagenen Regel mit den Stufen 1-4 dazu, dass der Datensatz nicht bearbeitet werden darf.
Fehlerklasse (BMU)
Sollen die mit der Prüfregel verbundenen Fehler- und Abhilfetexte nicht nur in das Fehlerprotokoll des Datensatzes geschrieben werden, sondern beim Empfang einer BMU-Nachricht zusätzlich auch mit der BMU-Quittungsnachricht an den Absender zurückgemeldet werden, so muss die Prüfregel mit einer Fehlerklasse (BMU) gesetzt werden. Die Fehlerklassen sind vordefiniert und können aus einer Drop-Down-Liste ausgewählt werden:
| Fehlerklasse (BMU) | Bedeutung gemäß BMU-Doku3) | zugehörige Fehlerstufe4) |
|---|---|---|
| KEINFEHLER | Die Meldung ist kein Fehler (dient dem Transport von Hinweistexten oder Zuordnungsinformationen - z.B. einer Begleitscheinnummer - in der BMU-Quittung) | INFO |
| KEINXML | Das Dokument konnte nicht als XML-Dokument interpretiert/geparst werden | FATAL |
| KEINSCHEMA | Zu dem Dokument konnte kein passendes XMLSchema gefunden werden bzw. die Validierung des Dokumentes gegen jedes in Frage kommende Schema ist fehlgeschlagen | FATAL oder FEHLER |
| SIGNATURFEHLER | Eine Signatur in dem Dokument konnte nicht validiert werden | FEHLER |
| INHALTFEHLT | Ein durch das Schema nicht zwingend vorgeschriebener Inhalt, der aber fachlich verpflichtend benötigt wird, ist im Dokument nicht vorhanden | FEHLER oder WARNUNG |
| INHALTFALSCH | Im Dokument befindet sich Inhalt, der bei der Prüfung z.B. gegen bereits vorhandene Daten des Empfängers als falsch angesehen wird | FEHLER oder WARNUNG oder INFO |
| ANHANG | Die Verarbeitung eines Dateianhangs konnte nicht einwandfrei erfolgen. Dies kann auch bedeuten, dass der Dateianhang durch einen Virenscanner als infiziert eingestuft wurde | FEHLER oder WARNUNG oder INFO |
| SONSTIGES | Die Meldung passt in keine der zuvor genannten Klassen | jede Stufe möglich |
Damit die Zuordnung einer Fehlerklasse der BMU-Quittung zurückgenommen werden kann, beginnt die Auswahl in der Drop-Down-Liste mit einem Leereintrag.
Wird die Prüfregel im Rahmen eines Prüfplans einer Maske der ASYS-Oberfläche verwendet, hat die Fehlerklasse (BMU) keine Bedeutung.
Es genügt nicht, an dieser Stelle die Fehlerklasse einzutragen, damit die Fehlermeldung in die BMU-Quittung geschrieben wird. Gleichzeitig muss auch das Ankreuzfeld Fehlerschreiben (s.u.) gesetzt sein!
Fehlercode
Das Feld Fehlercode kann ein frei vergebbaren Code für einen Fehler, eine Fehlerart oder eine Gruppe von Fehlern sein. Der Fehlercode wird mit in das Fehlerprotokoll zum jeweiligen Datensatz in die ASYS-Nutzdatenbank geschrieben.
Beispiel: Mit Hilfe von Fehlercodes kann z.B. die Vorgangssteuerung entscheiden, ob bestimmte Arbeitsschritte angelegt werden sollen:
Alle Fehler, die einen bestimmten Arbeitsschritt zu Folge haben - 'Erstellung eines Fehlerschreibens' oder 'Einleitung eines OWi-Verfahrens' - werden mit dem gleichen Code ausgestattet, welcher frei gewählt werden kann. Die Vorgangssteuerung kann in einem Skript eine Abfrage aufrufen, mit der sich die Anzahl der Datensätze im Fehlerprotokoll abfragen lässt. Ist die Anzahl der Fehlerprotokolleinträge mit dem besagten Code größer als 0, so wird der Arbeitsschritt angelegt, ist die Anzahl gleich 0, wird der Arbeitsschritt nicht angelegt.
Der Fehlercode kann in die BMU-Quittung eingefügt werden. Aktuell wird dies aber nicht von ASYS praktiziert.
Fehlertext
Mit dem Fehlertext wird dem Absender einer Nachricht oder dem Bearbeiter eines Datensatzes mitgeteilt, welcher Fehler durch die Prüfregel ermittelt wurde. Der Fehlertext ist ein Textbaustein, der ebenfalls in dieser Perspektive erstellt und gepflegt wird. Mehrere Prüfregeln können den gleichen Fehlertextbaustein verwenden.
Ist der Prüfregel ein Fehlertextbaustein zugeordnet, so erscheint der Name des Textbausteins in dem mit 'Fehlertext' beschrifteten Feld des Bearbeitungsbereichs. Der Name des Textbausteins ist ein Link, d.h. die Textbausteindefinition wird im Bearbeitungsfenster als neuer Tab-Reiter geöffnet oder nach vorne geholt, wenn der Link mit Strg+Linksklick aktiviert wird.
Ist ein Textbaustein zugeordnet, so erscheint links am Feld mit dem Textbausteinnamen ein kleines Notizzettel-Icon (
). Lässt man den Mauszeiger wenige Augenblicke über dem Icon stehen, so erscheint der Text des Textbausteins in einer Sprechblase.
Einen Fehlertext neu erstellen
Im Bearbeitungsbereich einer Prüfregel können Sie keinen neuen Fehlertext erstellen. Dies findet im Kontext des Objektbaums der Perspektive 'Prüfregeln, Abfragen...' statt und ist dort beschrieben.
Einen Fehlertext zuordnen
Für die Zuordnung eines Fehlertextes zur Prüfregel gibt es zwei mögliche Wege:
- Aus der Auswahlliste der Fehlertexte wird ein zuvor markierter Fehlertext per Drag&Drop in das Feld 'Fehlertext' im Bearbeitungsbereich gezogen. Eine bereits vorhandene Zuordnung wird dabei ersetzt.
- Über den Button Fehlertext hinzufügen () öffnet sich ein Auswahldialog für Fehlertexte:
Es kann ein Fehlertext für die Übernahme markiert werden. In der Zeile über der Tabelle kann ein Namensfilter eingetragen werden (Nutzung und Wirkung wie in den Auswahllisten). Der Button Übernehmen übernimmt den markierten Fehlertext in das Feld 'Fehlertext' der Prüfregel. Eine bereits vorhandene Zuordnung wird dabei ersetzt.
Einen Fehlertext ändern
Der Text des Fehlertextbausteins kann nicht im Bearbeitungsbereich der Prüfregel geändert werden. Der Textbaustein lässt sich aber mittels Strg+Linksklick auf den Textbausteinnamen im Feld 'Fehlertext' im Bearbeitungsbereich zur Bearbeitung öffnen (s. Fehlertexte).
Einen Fehlertext von der Prüfregel lösen
Um einen Fehlertext von der Prüfregel zu lösen, muss der Button Fehlertext entfernen (
) rechts neben dem Feld angeklickt werden. Nach einer Sicherheitsabfrage wird die Zuordnung des Fehlertextes zur Prüfregel gelöscht - der Textbaustein bleibt unverändert erhalten.
Abhilfetext
Mit dem Abhilfetext wird dem Absender einer Nachricht oder dem Bearbeiter eines Datensatzes mitgeteilt, welche Maßnahme ergriffen werden muss, um den gemeldeten Fehler zu beheben. Der Abhilfetext ist ein Textbaustein, der ebenfalls in dieser Perspektive erstellt und gepflegt wird. Mehrere Prüfregeln können den gleichen Abhilfetextbaustein verwenden. Die Zuordnung eines Abhilfetextbausteins ist nur bei den Prüfregeln sinnvoll, die auch einen Fehlertextbaustein zugeordnet bekommen haben!
Ist der Prüfregel ein Abhilfetextbaustein zugeordnet, so erscheint der Name des Textbausteins in dem mit 'Abhilfetext' beschrifteten Feld des Bearbeitungsbereichs. Der Name des Textbausteins ist ein Link, d.h. die Textbausteindefinition wird im Bearbeitungsfenster als neuer Tab-Reiter geöffnet oder nach vorne geholt, wenn der Link mit Strg+Linksklick aktiviert wird.
Ist ein Textbaustein zugeordnet, so erscheint links am Feld mit dem Textbausteinnamen ein kleines Notizzettel-Icon (). Lässt man den Mauszeiger wenige Augenblicke über dem Icon stehen, so erscheint der Text des Textbausteins in einer Sprechblase.
Einen Abhilfetext neu erstellen
Im Bearbeitungsbereich einer Prüfregel können Sie keinen neuen Abhilfetext erstellen. Dies findet im Kontext des Objektbaums der Perspektive 'Prüfregeln, Abfragen...' statt und ist dort beschrieben.
Einen Abhilfetext zuordnen
Für die Zuordnung eines Abhilfetextes zur Prüfregel gibt es zwei mögliche Wege:
- Aus der Auswahlliste der Abhilfetexte wird ein zuvor markierter Abhilfetext per Drag&Drop in das Feld 'Abhilfetext' im Bearbeitungsbereich gezogen. Eine bereits vorhandene Zuordnung wird dabei ersetzt.
- Über den Button Abhilfetext hinzufügen () öffnet sich ein Auswahldialog für Abhilfetexte:
Es kann ein Abhilfetext für die Übernahme markiert werden. In der Zeile über der Tabelle kann ein Namensfilter eingetragen werden (Nutzung und Wirkung wie in den Auswahllisten). Der Button Übernehmen übernimmt den markierten Abhilfetext in das Feld 'Abhilfetext' der Prüfregel. Eine bereits vorhandene Zuordnung wird dabei ersetzt.
Einen Abhilfetext ändern
Der Text des Abhilfetextbausteins kann nicht im Bearbeitungsbereich der Prüfregel geändert werden. Der Textbaustein lässt sich aber mittels Strg+Linksklick auf den Textbausteinnamen im Feld 'Abhilfetext' im Bearbeitungsbereich zur Bearbeitung öffnen (s. Abhilfetexte).
Einen Abhilfetext von der Prüfregel lösen
Um einen Abhilfetext von der Prüfregel zu lösen, muss der Button Abhilfetext entfernen () rechts neben dem Feld angeklickt werden. Nach einer Sicherheitsabfrage wird die Zuordnung des Abhilfetextes zur Prüfregel gelöscht - der Textbaustein bleibt unverändert erhalten.
Maske/Aufgabe bei Nachrichtenregel
Prüfregeln, die in Nachrichtenprüfplänen eingesetzt werden sollen, sind nicht automatisch im Kontext der passenden Maske/dem passenden Aufgabenbereich, da die Nachrichten als Ganzes geprüft werden, inklusive der Daten, die auf der ASYS-Oberfläche erst in Tochtermasken/Aufgabenbereichen bearbeitet und geprüft werden. Die Prüfpläne für Nachrichten umfassen daher ggf. Prüfungen, die für die Oberfläche auf mehrere Prüfpläne verteilt sind.
Beispiel: Im Nachrichtenprüfplan für einen Entsorgungsnachweis sind Prüfungen für das Deckblatt, die Verantwortliche Erklärung VE und die Annahmeerklärung AE enthalten, da die Nachricht alle diese Dokumentbestandteile in einer Datenstruktur vereinigt.
In der ASYS-Oberfläche werden die VE und die AE in eigenen Masken/Aufgabenbereichen bearbeitet und besitzen daher eigene Prüfpläne. Ergänzend können im Oberflächenprüfplan des Deckblattes - anders als im Nachrichtenprüfplan - nicht alle Prüfungen für die VE und die AE ausgeführt werden, da deren Daten dort nicht vollständig zugänglich sind.
Wird in der ASYS-Oberfläche ein Prüfplan bei der Speicherung eines Datensatzes ausgeführt, werden die Fehlermeldungen im gemeinsamen Fehlerprotokoll der Hauptmaske gespeichert. Fehlermeldungen vorangegangener Speichervorgänge werden dabei überschrieben. Damit nur die jeweiligen Fehlermeldungen eines Prüfplans ersetzt werden, enthalten diese eine Kontextinformation (z.B. 'Annahmeerklärung'). Fehlermeldungen mit anderen Kontextinformationen bleiben erhalten. Diese Kontextinformationen liegen bei Fehlermeldungen aus Nachrichtenprüfplänen nicht automatisch vor. Alle Nachrichtenfehlermeldungen würden der Hauptmaske zugeordnet, auch wenn eine gleichartige Prüfung in der ASYS-Oberfläche nur im Rahmen des Prüfplans einer Tochtermaske ausgeführt werden kann. Daraus ergeben sich die Probleme
- dass gleiche Fehlermeldungen aus Nachricht und Oberfläche mit unterschiedlichem Kontext im Fehlerprotokoll erscheinen und
- dass die Behebung eines Fehlers auf einer Tochtermaske über die Oberfläche nicht die zugehörige Nachrichtenfehlermeldung (Kontext: Hauptmaske) überschreibt, wodurch der Anschein entsteht, der Fehler sei noch vorhanden.
Aus diesem Grund kann einer Prüfregel eine Maske/Aufgabe bei Nachrichtenregel zugeordnet werden, wenn sie im Rahmen eines Nachrichtenprüfplans eingesetzt wird und Daten geprüft werden, die in der Oberfläche nur im Kontext einer Tochtermaske geprüft werden können. Wird keine Maske zugeordnet, erhält eine Fehlermeldung den Kontext der Hauptmaske, in der die Nachricht abgespeichert wird.
Die Zuordnung einer Maske zu einer Nachrichtenprüfregel dient nur der ordentlichen Verwaltung der Prüfregelfehlermeldungen im Fehlerprotokoll des Datensatzes zur Nachricht! Die Prüfregel wird in einem Prüfplan - ob für Nachrichten oder die Oberfläche - mit oder ohne Zuordnung in gleicher Weise ausgeführt.
Eine Maske zuordnen
Für die Zuordnung einer Maske zur Prüfregel gibt es zwei mögliche Wege:
- Aus der Auswahlliste der Masken wird eine zuvor markierte Maske per Drag&Drop in das Feld 'Maske/Aufgabe…' im Bearbeitungsbereich gezogen. Eine bereits vorhandene Zuordnung wird dabei ersetzt.
- Über den Button Maske hinzufügen () öffnet sich ein Auswahldialog für Masken:
Es kann eine Maske für die Übernahme markiert werden. In der Zeile über der Tabelle kann ein Namensfilter eingetragen werden (Nutzung und Wirkung wie in den Auswahllisten). Der Button Übernehmen übernimmt den markierte Maske in das Feld 'Maske/Aufgabe…' der Prüfregel. Eine bereits vorhandene Zuordnung wird dabei ersetzt.
Eine Maske von der Prüfregel lösen
Um eine Maske von der Prüfregel zu lösen, muss der Button Maske entfernen () rechts neben dem Feld angeklickt werden. Nach einer Sicherheitsabfrage wird die Zuordnung der Maske zur Prüfregel gelöscht - die Maske bleibt unverändert erhalten.
Fehlerschreiben, Adressat und Lfd-Nr. Beförderer
Das Ankreuzfeld Fehlerschreiben kennzeichnet eine Prüfregel als fehlerschreibenrelevant. Mit diesem Feld wird gesteuert, ob die Fehlermeldung einer Prüfregel in einen Behördenlayer (für Begleitscheine) eingetragen wird oder zur Übernahme in die 'Mängel, Hinweise' diverser Bereiche angeboten wird.
Die Fehlermeldung landet
- bei einem Begleitschein im Behördenlayer.
Die Fehlermeldung wird zur Übernahme in die Mängel, Hinweise angeboten
- bei einem Entsorgungsnachweis oder Sammelentsorgungsnachweis im Grundverfahren für die Eingangsbestätigung,
- bei einem Entsorgungsnachweis oder Sammelentsorgungsnachweis im privilegierten Verfahren für die Nachforderung,
- bei einer Anzeige für die Nachforderung,
- bei einer Erlaubnis für die Eingangsbestätigung und
- bei einem Formblatt Benehmensangaben und einem Entsorgungsfachbetriebezertifikat.
Diese Fehlermeldungen in den Behördenlayern müssen mit einem Adressaten versehen werden, also der Rolle eines Beteiligten innerhalb des durch das jeweilige Dokument abgebildeten Vorgangs. Die Adressatenrolle wird aus einer Drop-Down-Liste ausgewählt. Definiert sind die Rollen:
| Code | Rolle | Bemerkung |
|---|---|---|
| ERZ | Erzeuger | |
| BEF | Beförderer | ausschließlich für Beförderer muss eine Lfd-Nr. Beförderer, also 1, 2 oder 3 aus der Drop-Down-Auswahlliste des Feldes ausgewählt werden. Gibt es in einem Vorgang nur einen Beförderer, ist die 1 auszuwählen |
| ENT | Entsorger | |
| ZWL | Umschlag/Lagerung | Nur im Begleitschein sinnvoll nutzbar |
Beide Auswahllisten enthalten zuoberst einen Leereintrag, um eine Zuordnung auch wieder zurücknehmen zu können.
Soll die Fehlermeldung außerdem zusätzlich in einer BMU-Quittung beim Nachrichteneingang an den Adressaten zurückgeschickt werden, muss auch die Fehlerklasse (BMU) definiert sein!
Regelcode
Der Abschnitt Regelcode enthält die eigentliche Prüfregel als JavaScript-Code. Das Ergebnis der Ausführung des JavaScript-Codes wird in jedem Falle als logische Aussage betrachtet, d.h. das Ergebnis ist entweder true (WAHR) oder false (FALSCH). Eine Prüfregel gilt als bestanden, wenn das Ergebnis true ist; das Gegenteil false ist entsprechend der Fehlerfall.
Auf die Bestandteile des Prüfregelcodes wird an dieser Stelle nicht eingegangen, hierzu gibt es eine gesonderte Seite über den Prüfregelcode.
inverse Logik
Das Ankreuzfeld inverse Logik kann dazu genutzt werden, dass Ergebnis des Prüfregelcodes immer in sein Gegenteil zu verwandeln (aus true wird false und umgekehrt). Hintergrund ist, dass immer wieder einmal vorkommt, dass sich das Gegenteil einer Aussage leichter als Prüfung formulieren lässt bzw. dass ein positives Ergebnis auf eine durch die Prüfregel formulierte Frage der Fehlerfall ist, welcher aber nur durch false ausgedrückt sein kann.
Beispiel: Bei einer positiv formulierten Frage führt das richtige Ergebnis, d.h. die Erfüllung einer Bedingung zum Ergebnis true und damit wie gewünscht zu keiner Fehlermeldung, z.B. die Frage: Ist die Begleitscheinnummer richtig eingetragen worden?
Bei einer negativ formulierten Frage stellt ein positives Ergebnis aber den Fehlerfall dar, z.B. die Frage: Ist die Begleitscheinnummer unvollständig eingetragen worden? Wird diese Frage mit true beantwortet, so soll eine Fehlermeldung erfolgen, nicht hingegen, wenn die Frage mit false beantwortet wird. In diesem Fall handelt es sich um eine inverse Logik. Dementsprechend muss für alle Regeldefinitionen mit inverser Logik des Regelcodes bei diesem Ankreuzfeld ein Häkchen gesetzt werden.
keine automatische Vorprüfung der Feldinhalte auf NULL
Ist das Ankreuzfeld keine automatische Vorprüfung der Feldinhalte auf NULL nicht gesetzt so werden alle Datensatz- bzw. Nachrichtenfelder, die in einer Regel verwendet werden, vor der Ausführung der eigentlichen Regel daraufhin überprüft, ob der Inhalt leer (NULL) ist. Ist ein Feld leer, liefert die Regel false zurück. Das Verhalten ist dann so, als würde die Prüfregel nicht erfüllt und es wird auch die entsprechende Fehlermeldung im Fehlerprotokoll angelegt. Allerdings wurde der Prüfregelcode gar nicht ausgeführt!
Durch setzen diese Flags wird diese Vorprüfung unterbunden. Insbesondere ist es damit dann auch möglich, den Zustand 'leer' eines Datenfeldes explizit im Regelcode abzufragen und für Fallunterscheidungen im Regelcode auszunutzen.
Schriftgröße
Das Feld Schriftgröße ist ein Drop-Down-Auswahlliste, die keinen Einfluss auf das Verhalten der Prüfregel hat, sondern ausschließlich die Größe der Textdarstellung des Regelcodes beeinflusst.
Das Textfeld mit dem Regelcode
Die nachfolgenden Abbildungen zu den Eingabehilfen stellen nur das Prinzip dar. Welche Eingabehilfen angeboten werden, ist abhängig von der jeweils eingesetzten Programmversion des Repository-Administrators. Der Umfang der auswählbaren Funktionen kann sich daher mit der Zeit ändern, weshalb die Abbildungen einen älteren Versionsstand wiedergeben können.
Im Textfeld des Regelcodes wird mit Syntaxhighlighting gearbeitet, d.h. bestimmte für die Formulierung ausführbaren Codes wichtige Sonderzeichen werden im Fenster in roter Schrift angezeigt (z.B. Klammern, Anführungszeichen, Prozentzeichen, Zeichen für logische Operatoren). Die beiden von der ASYS-Mittelschicht bereitgestellten Systemklassenobjekte Sessionkontext (sc.) und Datenkontext (dc.) werden in Magenta angezeigt.
Wird eine dieser beiden Zeichenketten gefolgt von einem Punkt eingegeben, öffnen sich Auswahlfenster mit einer Liste der zum jeweiligen Objekt verfügbaren Funktionen (die Auswahl aus allen nachfolgenden kontextsensitiven Auswahlfenstern erfolgt per Doppelklick):
Gibt es keinen Kontext, so wird mit Strg+Leerzeichen eine Auswahlliste allgemeiner Funktionen geöffnet (die nachfolgenden Abbildung zeigt nur einen Teil der angebotenen Funktionen):
Ist im Feld Maske ganz oben im Bearbeitungsbereich der Prüfregel eine Maske eingetragen, so kennt der Administrator den Kontext, in dem die Prüfregel eingesetzt werden soll. Sobald im Textfenster die Zeichenkette {% eingetragen wird öffnet sich eine Auswahlliste aller Datenfelder der Maske:
Wird unter den gleichen Voraussetzungen die eingegebene Zeichenkette zu {%* verlängert, so erscheint eine Auswahlliste der Abfragen, die als 'Interne Abfrage' für 'Prüfregeln' gekennzeichnet sind und der zuoberst ausgewählten Maske zugeordnet sind:
Ist ein Datenfeld einer Maske ausgewählt (s. zuvor), so kann das Ergebnis als JavaScript-Objekt mit weiteren Funktionen verarbeitet werden. Wird hinter dem Maskenfeldplatzhalter ein Punkt eingegeben, öffnet sich eine Auswahlliste möglicher JavaScript-Funktionen:
Nach Auswahl eines Eintrags schließen sich die Auswahlfenster und der Code wird passend vervollständigt. Bei der Auswahl von Funktionen werden häufig aber noch weitere Inhalte in die übernommenen Codebestandteile als Übergabeparameter eingetragen werden müssen, um den Code funktionstüchtig zu machen.
Bei der Auswahl einer Abfrage (via {%* ) erscheint der Name der Abfrage anschließend unterstrichen und in blauer Schrift als Link. Mittels Strg+Linksklick kann die Abfrage im Bearbeitungsbereich auf einem eigenen Tab-Reiter geöffnet oder nach vorne geholt werden, um sie dort zu bearbeiten. Kann unter dem eingegebenen Namen keine Abfrage gefunden werden (weil z.B. bei manueller Eingabe des Abfragenames ein Tippfehler übersehen wurde) passiert nichts.
Rechts neben den Auswahlfenstern öffnet sich i.d.R. ein weiteres Fenster mit einem Erklärungstext zum jeweils links in der Auswahlliste markierten Eintrag (falls vorhanden). Die beiden Fenster lassen sich auch ohne Auswahl mit der Esc-Taste schließen. Sie können wieder geöffnet werden, wenn sich die Schreibmarke im Code unmittelbar hinter der Zeichenkette befindet, die den Kontext festlegt (also z.B. hinter dc. oder {%) und Strg+Leertaste gedrückt wird.
Sie können den Prüfregelcode natürlich auch vollständig manuell eingeben und auf die Unterstützung durch die Hilfsfunktionen verzichten. Das Syntaxhighlighting wird unabhängig davon ausgeführt.
Listenbereich
Den unteren Teil des Bearbeitungsbereichs nimmt ein Abschnitt mit zwei Tab-Reitern ein. Hier werden Konfigurationselemente angezeigt, die der Prüfregel zugeordnet sind.
Eigenschaften
Auf dem Tab-Reiter Eigenschaften lassen sich weitere Angaben zur Prüfregel eintragen:
Standardregel: Das Ankreuzfeld wird für alle Prüfregeln gesetzt, die zum Standard-Auslieferungsumfang von ASYS gehören. Diese Eigenschaft kann nicht verändert werden und schränkt die Möglichkeiten zur Anpassung einer Prüfregel weitgehend ein.
Steuerregel: Die Prüfregel dient nicht als Regel zur Prüfung eines Datensatzes oder einer Nachricht, sondern zur Steuerung des weiteren Ablaufes eines Prüfplans. Meist haben diese Regeln eine Fehlerstufe 0 und weder Fehlertext noch Abhilfetext.
Prüfregel: Die Prüfregel dient der fachlich-inhaltlichen Prüfung eines Datensatzes oder einer Nachricht. Meist haben die Regeln eine Fehlerstufe 1, 2 oder 3 und einen Fehlertext sowie einen Abhilfetext zugeordnet.
Oberfläche: Die Prüfregel wird in einem Prüfplan für eine Maske der ASYS-Oberfläche eingesetzt. Ein Test der Prüfregel in der Tochteranwendung wird als 'Test von Oberflächen- und Filterprüfregeln' ausgeführt.
Nachricht: Die Prüfregel wird in einem Prüfplan für eine Nachricht eingesetzt. Ein Test der Prüfregel in der Tochteranwendung wird als 'Test von Nachrichtenprüfregeln' ausgeführt.
Bearbeitungsfilter: Die Prüfregel wird in einem Prüfplan für einen Bearbeitungsfilter einer Maske der ASYS-Oberfläche eingesetzt. Ein Test der Prüfregel in der Tochteranwendung wird als 'Test von Oberflächen- und Filterprüfregeln' ausgeführt.
Diese Ankreuzfelder können kombiniert werden. Sie dienen vor allem der Kategorisierung und Filterung der Prüfregeln innerhalb des Administrators.
Feldregel für nimmt den vollständigen Modellnamen (Datenbankklassenname.Attributname - ohne {%…%}-Notation) eines Feldes der Maske auf, in der die Prüfregel als Sofortprüfregel ausgeführt werden soll. Sobald das Feld der Maske in der ASYS-Oberfläche durch den Benutzer verlassen wird, wird diese Prüfregel ausgeführt (um z.B. sofort darauf hinzuweisen, dass der Inhalt des Feldes nicht bestimmten Anforderungen genügt). Wird im Feld Maske ganz oben im Bearbeitungsbereich der Prüfregel eine Maske zugeordnet, so kann das Maskenattribut hier aus einer Auswahlliste gewählt werden. Wichtig: Die Prüfregel muss auch im Prüfplan der Masken enthalten sein!
Das Info-Feld ist ein Textfeld für Freitext und kann für eine interne Dokumentation genutzt werden.
Prüfpläne
In der Tabelle der Prüfpläne werden alle Prüfplane und ihre Regelgruppen angezeigt, denen die Prüfregel zugeordnet ist. Die Prüfregelzuordnung kann hier nicht bearbeitet werden. Die Zuordnung von Prüfregeln zu Prüfplänen erfolgt auf der Perspektive Maske, Prüfpläne... in den Prüfregelmengen bei den Masken.
Die Tabelle besteht aus den Spalten
- Prüfplan: Name des Prüfplans.
- Regelgruppe: Name der Regelgruppe im Prüfplan.
- Info: Das Freitextfeld mit einer internen Dokumentation der Prüfregelzuordnung zum Prüfplan.
Alle Spalten der Tabelle entsprechen gleichnamigen Feldern im Bearbeitungsbereich der Prüfpläne.
Ein Doppelklick auf einen Eintrag in der Liste wechselt zur Perspektive Maske, Prüfpläne... und öffnet die entsprechende Regelmenge im Bearbeitungsbereich. Dort können Änderungen an der Prüfregelzuordnung vorgenommen werden.
| Weitere Informationen zu dieser Maske | ||||||||||||||||
| Ausdrücke in Prüfregeln | ||||||||||||||||
| landesspezifische Zusatzinformationen: | SH | HH | NI | HB | NW | HE | RP | BW | BY | SL | BE | MV | ST | BB | TH | SN |