Passer au contenu principal

Description

Le type de données Document stocke des informations sur un document.

Fields

ID

int

ID d’un document.

La seule façon d’attribuer un ID à un document consiste à utiliser la méthode GetBatchIdsRange, qui permet de réserver des ID pour de nouveaux documents. Nous vous recommandons d’attribuer un ID à un document avant de l’ajouter à un lot.

Un ID de document sera généré automatiquement si vous définissez sa valeur sur -1.

BatchId

int

L’ID du lot

ParentId

int

L’ID du document parent du jeu.

Si un nouveau document doit faire partie d’un jeu, ce champ doit prendre la valeur du document parent du jeu.

Si un nouveau document ne doit faire partie d’aucun jeu, définissez la valeur du champ sur 0.

Important ! Le document parent doit être créé avant les documents enfants.

ChildrenOrder

ChildrenOrder []

Jeu de documents enfants permettant de trier les documents du jeu.

Lorsque les données sont lues à partir du serveur, le champ est renseigné automatiquement.

Si ce champ est vide, les documents du jeu seront classés dans l’ordre dans lequel ils ont été ajoutés.

DocIndex

int

Indice de document

TemplateName

string

Le nom de la définition de document

ProcessingStageType

int

Le type de l’étape de traitement ; les valeurs sont issues de ProcessingStageType

Commentaire

string

Commentaire

Pages

Page[]

L’ensemble des pages du document

IsProcessed

bool

Un indicateur précisant si le document a été traité ou non

HasProcessingErrors

bool

Un indicateur indiquant si des erreurs de traitement se sont produites

HasDocumentErrors

bool

Un indicateur qui indique s’il y a des erreurs dans le document (par ex. des erreurs de format, des erreurs liées aux règles, des erreurs d’assemblage)

ErrorText

string

Une description des erreurs survenues lors du traitement des documents

ExternalId

string

L’ID externe du document

Propriétés

RegistrationProperty[]

Les paramètres d’enregistrement du document

Priority

Priority[]

Priorité du document

FileVersion

int

La version du fichier du document sur le serveur

OwnerId

int

L’ID de l’utilisateur ou du Group auquel appartient le projet

StageExternalId

int

L’ID de l’étape de traitement dans laquelle la tâche a été créée (unique dans le type de lot)

TaskId

int

L’ID de la tâche à laquelle le document appartient

UncertainSymbols

int

Le nombre de caractères incertains

VerificationSymbols

int

Le nombre de caractères vérifiés

TotalSymbols

int

Le nombre total de caractères du document

HasErrors

bool

Un indicateur qui indique s’il existe des erreurs de règles de validation

HasWarnings

bool

Un indicateur indiquant s’il existe des avertissements liés aux règles de validation

HasAssemblingErrors

bool

Un indicateur indiquant s’il y a eu des erreurs d’assemblage

HasAttachments

bool

Un indicateur indiquant si le document contient des pièces jointes

Flags

int

Ensemble d’indicateurs décrivant l’état du document. La valeur d’un champ est une combinaison des valeurs des indicateurs, notamment :

  • BIF_IsAnalyzed = 0x100 indique que le document est analysé ;
  • BIF_IsRecognized = 0x200 indique que le document est reconnu ;
  • BIF_IsVerified = 0x400 indique que le document est vérifié ;
  • BIF_IsExported = 0x800 indique que le document est exporté ;
  • BIF_HasRuleErrors = 0x10000 indique que le document contient des erreurs d’exécution de règles ;
  • BIF_HasRuleWarnings = 0x20000 - indique que le document contient des avertissements liés à l’exécution des règles ;
  • BIF_HasMergeVersionErrors = 0x80000 - indique que le document contient des erreurs lors de la fusion des résultats de double vérification (les résultats de vérification ne correspondent pas) ;
  • BIF_HasUserAttachments = 0x100000 - indique que le document comporte des pièces jointes ;
  • BIF_HasUnmatchedFieldErrors = 0x200000 - indique que le document contient des champs non associés ;
  • BIF_NeedsPreprocessing = 0x800000 - indique que le document nécessite un prétraitement ;
  • BIF_IsManuallyCreated = 0x1000000 - indique que le document a été créé manuellement ;
  • BIF_IsExcludedFromAutomaticAssembling = 0x2000000 - indique que le document est exclu de l’assemblage automatique ;
  • BIF_IsSourceImageAttached = 0x4000000 - indique qu’un fichier image source est joint au document.

Remarque : Seuls les indicateurs utiles pour travailler avec les tâches et les méthodes de l’API Web Services sont répertoriés.