Passer au contenu principal
Un objet global qui donne accès au document, à ses champs et aux paramètres de la transaction dans laquelle le document est en cours de traitement. Attribuez le résultat du contrôle à la propriété CheckSucceeded.

​
Propriétés

NomTypeNiveau d’accèsDescription
CheckSucceededboolLecture-écritureIndique si la condition de la règle est satisfaite. La valeur par défaut est true. Votre script doit la définir sur false si la condition n’est pas satisfaite. Dans ce cas, le message d’erreur par défaut sera affiché à l’opérateur : “Error in the rule <rule_name>: <field_name>”. Si vous souhaitez un autre message, définissez-le à l’aide de la propriété ErrorMessage. Important ! Une erreur n’est générée que si CheckSucceeded est défini sur false. Si le script n’a pas changé la valeur de CheckSucceeded en false, aucun message d’erreur ne sera affiché même si les conditions ne sont pas remplies.
CurrentFieldFieldLecture seuleLe champ vérifié par la règle. Pour les champs répétitifs vérifiés par des règles répétitives : l’instance précise du champ vérifiée par l’appel en cours. Si la règle fait référence au document dans son ensemble, retourne la valeur null.
DocumentDocumentLecture seuleLe document pour lequel la règle s’exécute.
ErrorMessagestringLecture-écritureMessage défini par l’utilisateur à afficher si le script a défini CheckSucceeded sur false. Si vous ne définissez pas cette propriété, le message affiché en cas d’erreur sera « Error in the rule <rule_name>: <field_name> ».
TransactionTransactionLecture seuleLa transaction en cours.

​
Méthodes

NomDescription
Field GetField(string fieldName);Récupère le champ par son nom ou son identifiant. Important ! Passez directement à cette méthode le nom du champ sous forme de string : une variable portant la même valeur string ne fonctionnera pas. Le préprocesseur qui analyse le code du script avant son exécution remplacera le nom du champ par son identifiant, mais ne pourra pas traiter une variable. Utilisez le chemin complet pour référencer les champs contenus dans un groupe de champs, par exemple BusinessUnit/Address. Lorsqu’elle est utilisée dans une règle répétée, cette méthode renvoie séquentiellement chaque instance de champ traitée. Sinon, elle renvoie la première instance d’un champ répétitif lorsqu’un tel champ est référencé.
Field[] GetFields(string fieldName);Renvoie une liste de champs portant le nom spécifié. Cette méthode peut être utilisée pour obtenir toutes les instances d’un champ répétitif, y compris toutes les cellules d’une colonne de tableau. Elle facilite l’accès aux champs répétitifs lors de l’utilisation de boucles. Important ! Passez directement à cette méthode le nom du champ sous forme de string : une variable portant la même valeur string ne fonctionnera pas. Le préprocesseur qui analyse le code du script avant son exécution remplacera le nom du champ par son identifiant, mais ne pourra pas traiter une variable.
Record GetCatalogRecord(string catalogId, string externalId);Récupère un enregistrement depuis un catalogue (base de données externe). Utilisez cette méthode pour obtenir des informations d’un catalogue et comparer les valeurs de champ du document à celles du catalogue. Le nom du catalogue (catalogId) et l’identifiant de l’enregistrement (externalId) sont passés en arguments. Cette méthode ne peut être utilisée que si l’identifiant approprié a été configuré dans le catalogue (p. ex. l’identifiant du Fournisseur).
SkillParameter SkillParameter(string ParameterName);Récupère une valeur depuis le paramètre de compétence. Cette méthode ne peut être utilisée que si la Compétence de document comporte au moins un paramètre.