Zum Hauptinhalt springen
Context ist ein globales Objekt, das Zugriff auf das verarbeitete Dokument, seine Felder und die Parameter des übergeordneten Vorgangs bietet. Legen Sie CheckSucceeded fest, um anzugeben, ob die Regel erfolgreich war.

Verwendung

Eine Regel liest Felder über Context, prüft sie und meldet das Ergebnis, indem sie CheckSucceeded und ErrorMessage setzt. Sie können die Regel beispielsweise mit einer benutzerdefinierten Meldung fehlschlagen lassen, wenn das Feld Total fehlt oder leer ist:
var field = Context.GetField("Total");

if (!field || !field.Value) {
  Context.CheckSucceeded = false;
  Context.ErrorMessage = "Total field is empty";
}
Weitere Beispiele für numerische Vergleiche, bedingte Anforderungen und Tabellenvalidierung finden Sie unter Beispielskripte.

Eigenschaften

CheckSucceeded

Type: boolZugriff: Lese-/Schreibzugriff Gibt an, ob die Regelbedingung erfüllt ist. Der Standardwert ist true. Setzen Sie ihn auf false, wenn die Bedingung nicht erfüllt ist. In diesem Fall wird dem Operator standardmäßig die Fehlermeldung Error in the rule <rule_name>: <field_name> angezeigt. Um die Meldung anzupassen, setzen Sie die Eigenschaft ErrorMessage.
Ein Fehler wird nur erzeugt, wenn Ihr Skript CheckSucceeded auf false setzt. Wenn das Skript diesen Wert nicht explizit setzt, wird kein Fehler angezeigt — auch wenn die Regelbedingungen nicht erfüllt sind.

CurrentField

Typ: FieldZugriff: Schreibgeschützt Das Feld, das von der Regel geprüft wird. Bei Wiederholungsfeldern in Wiederholungsregeln ist dies die konkrete Instanz, die im aktuellen Aufruf geprüft wird. Gibt null zurück, wenn sich die Regel auf das Dokument als Ganzes bezieht.

Document

Typ: DocumentZugriff: Schreibgeschützt Das Dokument, für das die Regel ausgeführt wird.

ErrorMessage

Typ: stringZugriff: Lese-/Schreibzugriff Benutzerdefinierte Meldung, die angezeigt wird, wenn das Skript CheckSucceeded auf false setzt. Wenn sie nicht festgelegt ist, lautet die Standardmeldung Error in the rule <rule_name>: <field_name>.

Vorgang

Typ: TransactionZugriff: Schreibgeschützt Die aktuelle Vorgang.

Methoden

Ein Skript kann nur Felder lesen, die zum Lesen aufgeführt sind, und nur in Felder schreiben, die beim Einrichten der Regel als bearbeitbar aufgeführt sind. Die Referenzierung eines anderen Feldes führt dazu, dass die Regel mit einem Zugriffsfehler fehlschlägt (Attempt to read data from inaccessible field oder Attempt to write data to read-only field). Siehe Automatisierung von Geschäftsregeln.

GetField

Field GetField(string fieldName);
Ruft ein Field anhand seines Namens oder seiner Kennung ab. Gibt null zurück, wenn kein Feld mit diesem Namen existiert. Verwenden Sie den vollständigen Pfad, um Felder innerhalb einer Gruppe zu referenzieren — zum Beispiel BusinessUnit/Address. Wird GetField in einer Wiederholungsregel verwendet, gibt die Methode nacheinander jede verarbeitete Feldinstanz zurück. Andernfalls gibt sie die erste Instanz eines Wiederholungsfelds zurück.
Übergeben Sie den Feldnamen als string-Literal, nicht als Variable. Der Skript-Präprozessor ersetzt den literalen Namen vor der Ausführung durch die Kennung des Felds — Variablen werden nicht verarbeitet.

GetFields

Field[] GetFields(string fieldName);
Gibt alle Field-Objekte mit dem angegebenen Namen zurück — nützlich, um jede Instanz eines Wiederholungsfelds zu durchlaufen, einschließlich aller Zellen in einer Tabellenspalte. Gibt null zurück, wenn kein Feld mit diesem Namen vorhanden ist.
Dieselbe Präprozessor-Einschränkung wie bei GetField: Übergeben Sie ein string-Literal, keine Variable.

GetCatalogRecord

Record GetCatalogRecord(string catalogId, string externalId);
Ruft einen Record aus einem Datenkatalog (einer externen Datenbank) ab. Verwenden Sie diese Methode, um Feldwerte im Dokument mit Feldwerten im Katalog zu vergleichen.
Nur verfügbar, wenn für den Katalog eine Datensatzkennung konfiguriert ist (z. B. eine Vendor-ID).

SkillParameter

SkillParameter SkillParameter(string ParameterName);
Ruft einen SkillParameter nach Namen ab. Lesen Sie den Wert aus der Value-Eigenschaft des zurückgegebenen Objekts — zum Beispiel Context.SkillParameter("Threshold").Value.
Nur verfügbar, wenn der Document-Skill mindestens einen Parameter hat.

Objektmodell

Vollständige JavaScript-Objektreferenz zur Verwendung in erweiterten Skriptregeln.

Automatisierung von Geschäftsregeln

Fügen Sie einem Document-Skill Skriptregeln hinzu, konfigurieren Sie les- und schreibbare Felder und referenzieren Sie Tabellenspalten.

Field

Das Field-Objekt — prüfen und ändern Sie ein Dokumentfeld während der Regelausführung.

Beispielskripte

Funktionsfähige JavaScript-Beispiele für gängige Szenarien mit erweiterten Skriptregeln.