Zum Hauptinhalt springen
Ein globales Objekt, das Zugriff auf das Dokument, seine Felder und die Parameter des Vorgangs bietet, in dem das Dokument verarbeitet wird. Weisen Sie das Ergebnis der Prüfung der Eigenschaft CheckSucceeded zu.

Eigenschaften

NameTypZugriffsebeneBeschreibung
CheckSucceededboolLese-/SchreibzugriffGibt an, ob die Regelbedingung erfüllt ist. Der Standardwert ist true. Ihr Skript sollte ihn auf false setzen, wenn die Bedingung nicht erfüllt ist. In diesem Fall wird dem Operator die Standardfehlermeldung angezeigt: „Error in the rule <rule_name>: <field_name>“. Wenn Sie eine andere Meldung bevorzugen, legen Sie diese über die Eigenschaft ErrorMessage fest. Wichtig: Ein Fehler wird nur erzeugt, wenn CheckSucceeded auf false gesetzt ist. Wenn das Skript den Wert von CheckSucceeded nicht auf false geändert hat, wird keine Fehlermeldung angezeigt, selbst wenn die Bedingungen nicht erfüllt sind.
CurrentFieldFieldnur lesbarDas Feld, das von der Regel geprüft wird. Bei wiederholten Feldern, die von wiederholten Regeln geprüft werden: die konkrete Instanz des Feldes, die beim aktuellen Aufruf geprüft wird. Bezieht sich die Regel auf das gesamte Dokument, wird ein Nullwert zurückgegeben.
DocumentDocumentnur lesbarDas Dokument, für das die Regel ausgeführt wird.
ErrorMessagestringLese-/SchreibzugriffBenutzerdefinierte Meldung, die angezeigt wird, wenn das Skript CheckSucceeded auf false gesetzt hat. Wenn Sie diese Eigenschaft nicht festlegen, wird bei einem Fehler die Meldung „Error in the rule <rule_name>: <field_name>“ angezeigt.
TransactionTransactionnur lesbarDie aktuelle Transaction.

Methoden

NameBeschreibung
Field GetField(string fieldName);Ruft das Feld anhand von Name oder Bezeichner ab. Wichtig! Übergeben Sie den string-Namen des Felds direkt an diese Methode: Eine Variable mit demselben string-Wert funktioniert nicht. Der Präprozessor, der den Skriptcode vor der Ausführung analysiert, ersetzt den Namen des Felds durch seinen Bezeichner, kann jedoch keine Variable verarbeiten. Verwenden Sie den vollständigen Pfad, um Felder innerhalb einer Feldgruppe anzusprechen, zum Beispiel BusinessUnit/Address. In einer wiederholenden Regel gibt diese Methode der Reihe nach jede verarbeitete Feldinstanz zurück. Andernfalls gibt diese Methode beim Verweis auf ein wiederholtes Feld dessen erste Instanz zurück.
Field[] GetFields(string fieldName);Gibt eine Liste von Feldern mit dem angegebenen Namen zurück. Mit dieser Methode lassen sich alle Instanzen eines wiederholten Felds abrufen, einschließlich aller Zellen in einer Tabellenspalte. Sie erleichtert den Zugriff auf wiederholte Felder bei der Verwendung von Schleifen. Wichtig! Übergeben Sie den string-Namen des Felds direkt an diese Methode: Eine Variable mit demselben string-Wert funktioniert nicht. Der Präprozessor, der den Skriptcode vor der Ausführung analysiert, ersetzt den Namen des Felds durch seinen Bezeichner, kann jedoch keine Variable verarbeiten.
Record GetCatalogRecord(string catalogId, string externalId);Ruft einen Datensatz aus einem Katalog (externe Datenbank) ab. Verwenden Sie diese Methode, um Informationen aus einem Katalog abzurufen und die Feldwerte im Dokument mit den Feldwerten im Katalog zu vergleichen. Der Katalogname (catalogId) und die Kennung des Katalogdatensatzes (externalId) werden als Argumente übergeben. Diese Methode kann nur verwendet werden, wenn die entsprechende Kennung im Katalog eingerichtet wurde (z. B. die Vendor-Kennung).
SkillParameter SkillParameter(string ParameterName);Ruft einen Wert aus dem Skill-Parameter ab. Diese Methode kann nur verwendet werden, wenn der Document-Skill mindestens einen Parameter hat.