IDocument

AddFileToExportResults( sourceFile : string, destinationName : string, replaceIfExists : bool ) *

Ajoute un fichier utilisateur aux résultats d’export du document.

Dans le paramètre sourceFile , indiquez le chemin du fichier utilisateur à ajouter.

Remarque : Veillez à spécifier le chemin d’export racine dans les paramètres du projet. Sinon, le fichier utilisateur sera placé dans le dossier du lot à l’emplacement de stockage des fichiers.

Dans le paramètre destinationName , indiquez une destination d’export.

Définissez le paramètre replaceIfExists sur true si vous souhaitez écraser tout fichier existant portant le même nom dans la destination. Définissez le paramètre replaceIfExists sur false si vous souhaitez conserver tout fichier existant portant le même nom dans la destination et ajouter un message d’erreur au Log.

CheckRules( ) *

Vérifie toutes les règles du document. Des droits d’écriture sur le document sont requis.

Field( name : string ) : IField *

Permet d’accéder à un champ de document à l’aide du chemin complet vers le champ. Des chemins complets sont utilisés.

Il s’agit d’un champ interne**. Ne peut pas être utilisé dans les règles.

HasField( name : string ) : bool *

Vérifie si un champ existe au chemin spécifié. Des chemins relatifs sont utilisés.

Il s’agit d’un champ interne**. Il ne peut pas être utilisé dans les règles.

IndexedItemValue( name : string ) : VARIANT *

Récupère la valeur du champ à partir de son nom ou de son chemin d’accès. Disponible pour les champs externes des documents et des pages. Le nom du champ comme son chemin complet peuvent être utilisés. Ne peut pas être utilisé dans les règles.

IndexedItemValues( name : string ) : IVARIANTArray *

Récupère un ensemble de valeurs d’index correspondant à un champ dans la définition de document, à partir du nom ou du chemin du champ. Si un champ est marqué comme champ d’index dans la section répétée, la méthode renvoie toutes les valeurs du champ de toutes les sections. Disponible pour les champs externes des documents et des pages. Le nom du champ ou son chemin complet peuvent être utilisés. Ne peut pas être utilisé dans les règles.

Property( name : string ) : VARIANT

Récupère la valeur d’une propriété spécifiée par son nom. La valeur renvoyée peut être de type string, numérique ou horaire.

Noms des propriétés et valeurs renvoyées :

• Exported - date d’exportation du document
• ExportedBy - utilisateur ayant exporté le document
• Created - date de création du document
• CreatedBy - utilisateur ayant créé le document
• Recognized - date de reconnaissance du document
• RecognizedBy - utilisateur ayant reconnu le document
• Modified - date de la dernière modification du document
• ModifiedBy - utilisateur ayant modifié le document
• TotalSymbolsCount - nombre total de symboles
• UncertainSymbolsCount - nombre total de symboles incertains
• RecognizedSymbolsCount - nombre de symboles reconnus
• Comment - commentaire du document
• ProcessingErrors - erreurs de traitement du document
• ProcessingWarnings - avertissements de traitement du document

• Verified - heure de la dernière modification manuelle des champs du document
• VerifiedBy - utilisateur ayant effectué les dernières modifications manuelles des champs du document (n’enregistre pas les informations des Processing Stations)

SaveAs( filename : string, [optional] options : IExportImageSavingOptions ) *

Enregistre l’image d’un document d’une seule page ou de plusieurs pages. Si aucun format d’enregistrement n’est spécifié dans les options d’enregistrement, l’image est enregistrée dans un fichier *.tif. Il s’agit d’un ** champ interne.

SaveAsStream( [optional] options: IExportImageSavingOptions) : byte[] *

Enregistre le document dans un flux en mémoire et le renvoie sous forme de tableau d’octets (COM SafeArray).

Remarque : JScript et VBScript ne prennent pas en charge l’itération dans ce tableau.

SaveXmlToFile( filename : string ) *

Enregistre à l’emplacement spécifié le fichier XML décrivant le document sans prétraitement, en vue de son utilisation dans Web Verification Station.

SaveXmlToFileStorage() *

Enregistre dans le stockage de fichiers le fichier XML contenant la description du document sans prétraitement, afin qu’il puisse être utilisé dans Web Verification Station.

Action *

IActionResult

Lecture seule

N’est disponible que dans les scripts d’Export et de post-export.

AsBatchItem *

IBatchItem

Lecture seule

Convertit le document en objet IBatchItem.

AssemblingErrors

IAssemblingErrors

Lecture seule

Une collection d’erreurs d’assemblage. L’accès à cette collection est toujours en lecture seule.

Pièces jointes

IUserAttachments

Lecture seule

Pièces jointes utilisateur

Lot

IBatch

Lecture seule

Le lot. Quelles que soient les autorisations du script pour le document, l’accès au lot est en lecture seule et les champs internes** des documents et des pages ne sont pas accessibles.

BatchName

string

Lecture seule

Nom du lot.

Enfants *

IFields

Lecture seule

Champs enfants (sections du document). Contrairement à la propriété Sections, l’ordre des sections correspond à celui défini dans la Document Definition. Les sections récurrentes sont représentées par un seul élément, et les instances sont accessibles via la méthode Items de cet élément.

Il s’agit d’un champ interne**. Il ne peut pas être utilisé dans les règles.

Commentaire

string

Lecture/écriture

Commentaire du document.

DefinitionName

string

Lecture seule

Le nom de la définition de document.

Pour les documents non traités et non reconnus, la propriété renvoie une chaîne vide.

DocumentDefinition

IDocumentDefinitionInfo

Lecture seule

Informations détaillées sur la définition de document associée au document.

HasErrors

bool

Lecture seule

Indique si le document contient des erreurs sur un seul champ ou sur plusieurs champs.

HasUnpreparedImages

bool

Lecture seule

Indique si le document contient des pages non prétraitées.

HasWarnings

bool

Lecture seule

Indique si le document comporte des avertissements liés aux règles ou au format.

ID

string

Lecture seule

Identifiant du document (ID externe). La valeur commence par 1 et n’est unique qu’au sein d’un lot.

Index

int

Lecture seule

L’indice du document dans le lot. La valeur commence à 0 et n’est unique que dans une même tâche.

IsAnalyzed

bool

Lecture seule

Indique si le document est analysé. Le document est considéré comme analysé si toutes les pages du document sont analysées.

IsAssembled

bool

Lecture seule

Indique si le document a été assemblé.

IsExcludedFromAutomaticAssembling

bool

Lecture/écriture

Indique si le document est inclus dans l’assemblage automatique.

IsExported

bool

Lecture seule

Indique si le document a été exporté.

IsRecognized

bool

Lecture seule

Indique si le document a été reconnu. Le document est considéré comme reconnu si chaque page du document est soit reconnue, soit une page annexe.

IsUsedForTraining

bool

Lecture/écriture

Indique si le document est utilisé pour l’entraînement.

IsVerified

bool

Lecture seule

Indique si le document est vérifié.

Pages

IPages

Lecture seule

Pages du document.

PreviousStageInfo *

IStageInfo

Lecture seule

Renvoie l’objet IStageInfo, c’est-à-dire l’étape de traitement précédente du document. Les champs TaskId et PrincipalId ne sont pas utilisés.

Priorité

TProcessingPriority

Lecture seule

Priorité du document.

ProcessingErrors *

string

Lecture seule

Erreurs de traitement séparées par des retours à la ligne.

ProcessingWarnings *

string

Lecture seule

Avertissements de traitement, séparés par des sauts de ligne.

ProhibitedUserId *

int

Lecture seule

Une tâche créée à partir du document ne sera pas accessible à l’utilisateur ayant l’identifiant indiqué. Par défaut, la valeur est “0”, ce qui signifie que la tâche est accessible à tous les utilisateurs.

Propriétés

IProperties

Lecture seule

Paramètres d’enregistrement du document.

RecognizedSymbolsCount *

int

Lecture seule

Le nombre de symboles reconnus.

RuleErrors *

IRuleErrors

Lecture seule

Collection d’erreurs de document (erreurs de format, erreurs de règle, erreurs liées à la fusion des résultats de la double vérification).

Remarque : Disponible uniquement pour les documents ouverts.

Sections *

IFields

Lecture seule

Une liste à plat des sections du document. S’il existe une section récurrente, la liste contient toutes les occurrences de cette section. Les sections de la liste suivent le même ordre que les premières pages des sections du document. Les sections sans pages figurent à la fin de la liste.

Il s’agit d’un champ interne**. Ne peut pas être utilisé dans les règles.

StageInfo

IStageInfo

Lecture seule

Informations sur l’étape de traitement du serveur d’applications.

SymbolsForVerificationCount

int

Lecture seule

Le nombre de symboles à vérifier.

TotalSymbolsCount

int

Lecture seule

Nombre total de symboles.

UncertainSymbolsCount

int

Lecture seule

Le nombre de symboles incertains.