Passer au contenu principal

Objectif

Identifie les champs dans le texte d’un document.
Ne peut être modifié que dans un script d’extraction.

Méthodes

ExtractRegularExpression( regularExpression : string, resultCollectionName : string )

Spécifie une expression régulière pour identifier des portions de texte.


Le paramètre resultCollectionName définit le nom de la collection d’objets obtenue. Le nom de la collection peut être utilisé dans les requêtes XML exécutées sur des documents. Vous pouvez également accéder à la collection obtenue par son nom.

ExtractNerObjects()

Indique au mécanisme d’identification de champs d’identifier les entités NER dans le texte d’un document. Une fois les objets identifiés, le mécanisme d’identification de champs disposera de collections portant les noms prédéfinis suivants : NerPerson, NerOrg, NerGeo, NerAddress, NerMoney et NerDate.

Remarque : Les objets NerMoney et NerDate sont utilisés uniquement dans les scripts d’extraction et ne sont pas disponibles dans ABBYY FlexiLayout Studio.

ExtractWordsFromUserDictionary( userDictionaryName : string, languageName : string )

Indique au mécanisme d’identification des champs d’identifier les mots d’un dictionnaire utilisateur dans le texte d’un document. Les mots peuvent apparaître dans le texte sous n’importe quelle forme fléchie. Un dictionnaire utilisateur peut être sélectionné dans l’onglet Properties de la règle de script. Le dictionnaire est référencé par son nom.


Le paramètre languageName spécifie la langue dans laquelle les formes fléchies des mots du dictionnaire utilisateur doivent être générées.

ParseAddress()

Analyse le texte d’un champ ou d’une section pour en extraire les composants d’adresse.

ParseAddressInPosition( resultCollectionNamePrefix : string, startPos : int, endPos : int )

Analyse le fragment de texte compris entre les positions de début et de fin spécifiées dans un champ ou une section afin d’en extraire les composants de l’adresse.

ParseAddressInSpan(resultCollectionNamePrefix : string, span : IInterval )

Analyse le fragment de texte compris dans un intervalle spécifié d’un champ ou d’une section pour en extraire les composants d’adresse.

PutSpanToField( startPos : int, endPos : int, fieldName : IField )

Enregistre dans un champ de document le fragment de texte correspondant à la plage spécifiée d’une sous-chaîne de texte.

PutTextToField( startPos : int, endPos : int, fieldName : IField )

Enregistre dans un champ du document le fragment de texte correspondant à la sous-chaîne définie par les positions de début et de fin spécifiées.

RunQuery( xmlQuery : string, queryName : string ) : IExtractedObjects

Exécute une requête XML sur le texte d’un document et les portions de texte identifiées. Renvoie une collection de résultats sous la forme d’un tableau de portions de texte contenant les string résultantes identifiées.

Le paramètre queryName spécifie un nom pour la requête, qui peut ensuite être utilisé pour récupérer la collection résultante à partir du mécanisme d’identification des champs.

RunQueryAndSaveToField( xmlQuery : string, queryName : string, fieldName : string )

Exécute une requête XML sur le texte d’un document ainsi que sur les portions de texte identifiées, puis enregistre les résultats dans un champ du document.

SaveSpanToField( span : IInterval, fieldName : string )

Enregistre le fragment de texte correspondant à l’intervalle spécifié pour une sous-chaîne de texte dans un champ du document.

Important ! Cette méthode est obsolète dans FlexiCapture Release 3 Update 4 et les versions ultérieures. Si cette méthode est utilisée dans de nouveaux projets avec FlexiCapture Release 3 Update 4 et les versions ultérieures, ces projets seront envoyés dans Exceptions.

SaveTextToField( startPos : int, endPos : int, fieldName : string )

Enregistre dans un champ du document le fragment de texte correspondant à la sous-chaîne définie par les positions de début et de fin spécifiées.

Important ! Cette méthode est obsolète dans FlexiCapture Release 3 Update 4 et les versions ultérieures. Si cette méthode est utilisée dans de nouveaux projets avec FlexiCapture Release 3 Update 4 et les versions ultérieures, ces projets seront envoyés vers Exceptions.

ExtractedObjects( collectionName : string, [optional] objectTypeName : VARIANT) : IExtractedObjects

Permet d’accéder à une collection d’objets identifiés à partir du nom de la collection.

Pour les collections d’objets NER identifiés comme composants d’adresse, effectuez l’une des opérations suivantes :

  • Pour collectionName, utilisez le nom passé en tant que resultCollectionNamePrefix aux méthodes ParseAddress… En outre, définissez objectTypeName sur le nom du type de la collection (par ex. “NerStreet” ou “NerCity”), ou
  • Spécifiez collectionName sous la forme [resultCollectionNamePrefix ]_[ objectTypeName] sans indiquer objectTypeName comme argument facultatif.

QueryResults( queryName : string ) : IExtractedObjects

Permet d’accéder au résultat d’une requête XML à l’aide du nom de la requête.

Propriétés

Nom

Type

Autorisations

Valeur

SourceText()

string

Lecture

Le texte du document ou du champ sur lequel s’applique le mécanisme d’identification du champ.

SourceNode()

IField

Lecture

Le champ ou la section sur lequel s’applique le mécanisme d’identification du champ.

SourceDocument()

IDocument

Lecture

Le document qui contient SourceNode.