Passer au contenu principal
Context est un objet global qui permet d’accéder au document en cours de traitement, à ses champs et aux paramètres de la transaction associée. Définissez CheckSucceeded pour indiquer si la règle est validée.

​
Utilisation

Une règle lit les champs via Context, les vérifie et indique le résultat en définissant CheckSucceeded et ErrorMessage. Par exemple, faites échouer la règle avec un message personnalisé si le champ Total est absent ou vide :
Pour d’autres exemples — comparaisons numériques, exigences conditionnelles et validation des tableaux — consultez Exemples de scripts.

​
Propriétés

​
CheckSucceeded

Type : bool — accès : Lecture/écriture Indique si la condition de la règle est satisfaite. La valeur par défaut est true. Définissez-la sur false si la condition n’est pas satisfaite. Dans ce cas, le message d’erreur par défaut affiché à l’opérateur est Error in the rule <rule_name>: <field_name>. Pour personnaliser le message, définissez la propriété ErrorMessage.
Une erreur est générée uniquement lorsque votre script définit CheckSucceeded sur false. Si le script ne le définit pas explicitement, aucune erreur n’est affichée, même si les conditions de la règle ne sont pas satisfaites.

​
CurrentField

Type: Field — Accès : Lecture seule Le champ vérifié par la règle. Pour les champs répétitifs dans des règles répétitives, il s’agit de l’instance précise vérifiée par l’appel en cours. Renvoie null si la règle porte sur le document dans son ensemble.

​
Document

Type: Document — Accès : Lecture seule Le document auquel la règle s’applique.

​
ErrorMessage

Type: string — accès: Lecture/écriture Message personnalisé affiché lorsque le script définit CheckSucceeded sur false. S’il n’est pas défini, le message par défaut est Error in the rule <rule_name>: <field_name>.

​
Transaction

Type: Transaction — accès: Lecture seule La transaction en cours.

​
Méthodes

Un script peut uniquement lire les champs autorisés en lecture et écrire dans les champs définis comme modifiables lors de la configuration de la règle. Toute référence à un autre champ entraîne l’échec de la règle avec une erreur d’accès (Attempt to read data from inaccessible field ou Attempt to write data to read-only field). Voir Automatisation des règles métier.

​
GetField

Récupère un Field par nom ou identifiant. Renvoie null si aucun champ portant ce nom n’existe. Utilisez le chemin complet pour référencer les champs à l’intérieur d’un groupe — par exemple, BusinessUnit/Address. Lorsqu’elle est utilisée dans une règle répétitive, GetField renvoie successivement chaque occurrence de champ traitée. Sinon, elle renvoie la première occurrence d’un champ répétitif.
Passez le nom du champ sous forme de chaîne littérale, et non comme variable. Le préprocesseur du script remplace le nom littéral par l’identifiant du champ avant l’exécution — les variables ne sont pas traitées.

​
GetFields

Renvoie tous les objets Field portant le nom spécifié — utile pour parcourir chaque occurrence d’un champ répétitif, y compris chaque cellule d’une colonne de tableau. Renvoie null si aucun champ de ce nom n’existe.
Même contrainte de préprocesseur que pour GetField : passez une chaîne littérale, pas une variable.

​
GetCatalogRecord

Récupère un Record à partir d’un catalogue de données (base de données externe). Utilisez cette méthode pour comparer les valeurs des champs du document à celles des champs du catalogue.
Disponible uniquement si un identifiant d’enregistrement est configuré pour le catalogue (par exemple, un identifiant de fournisseur).

​
SkillParameter

Récupère un SkillParameter à partir de son nom. Lisez sa valeur depuis la propriété Value de l’objet renvoyé — par exemple, Context.SkillParameter("Threshold").Value.
Disponible uniquement si la Compétence de document comporte au moins un paramètre.