Saltar al contenido principal

Qué hace

Representa el lote. Nota. Algunos métodos y propiedades de este objeto no están disponibles en la estación web de verificación para comprobar reglas de forma local. Los métodos y propiedades que no se admiten están marcados con un asterisco (*).

Métodos

Los siguientes métodos requieren permisos para modificar la estructura del lote. Estos métodos solo pueden llamarse desde el script de procesamiento por lotes.

CleanRecognitionResults( document : IDocument ) *

Elimina los resultados del reconocimiento del documento.

CreateDocumentFromPage( targetPosition : int, page : IPage ): IDocument *

Toma una página del documento y crea un documento nuevo a partir de ella. En el parámetro targetPosition, especifique un índice para el documento nuevo en el batch. El índice debe ser un número entre 0 y N, donde N es el número total de documentos del batch.

Cuando se llama al método CreateDocumentFromPage :

  • Los documentos con índices comprendidos entre 0 y targetPosition – 1 permanecerán en sus posiciones originales.
  • Los documentos con índices comprendidos entre targetPosion y N avanzarán una posición.
  • El documento nuevo se colocará en la posición targetPosition que quedó vacante.

Nota: Si el documento queda vacío después de quitar la página, se eliminará.

CreatePageFromImage( page : IPictureObject, [optional] target : IDocument, [optional] position : int, [optional] sourceInfo : string ) : IPage *

Crea una página a partir del objeto IPictureObject y devuelve la página creada:

  • Si se especifica un documento de destino, la página se agrega a este documento. Para crear un documento de una sola página, especifique null como documento de destino.
  • Si se especifica una posición, la página se agrega en la posición indicada del documento (si se especifica un documento de destino). De lo contrario, se agrega un documento de una sola página en la posición indicada del lote (si se especifica null como documento de destino). La posición inicial corresponde a “0,” y el final del documento o lote corresponde a “-1.”
  • Si se especifica el parámetro sourceInfo, se guarda en la información sobre el origen de la página. De lo contrario, la información sobre el origen de la página se obtiene de IPictureObject.

DeleteDocument( document : IDocument ) *

Elimina el documento.

DeletePage( page : IPage ) *

Elimina la página.

MoveDocument( source : IDocument, targetPosition : int ) *

Mueve el documento a la posición especificada del lote.

MovePage( source : IDocument, target : IDocument, sourcePageIndex : int, int targetPageIndex : int ) *

Mueve la página con índice sourcePageIndex del documento de origen a la posición targetPageIndex del documento de destino.

Propiedades

AsBatchItem *

IBatchItem

De solo lectura

Convierte el batch en un objeto IBatchItem.

Archivos adjuntos

IUserAttachments

De solo lectura

Archivos adjuntos del usuario.

BatchTypeName

cadena

De solo lectura

El nombre del tipo de lote.

Comentario

string

Lectura/escritura

El comentario.

CreatedBy

IPrincipal

De solo lectura

El autor del lote que se acaba de crear.

En la versión independiente de FC, devuelve null.

CreationDate

DateTime

De solo lectura

La fecha y hora en que se creó el lote.

Documentos

IDocuments

De solo lectura

Documentos que componen el lote

Id

int

De solo lectura

El identificador del lote (único dentro del proyecto).

Name

cadena

Lectura y escritura

El nombre del batch.

Prioridad

TProcessingPriority

Lectura/escritura

La prioridad del lote.

Proyecto

IProject

De solo lectura

El proyecto que contiene el batch.

Propiedades

IProperties

De solo lectura

Parámetros con nombre del lote.

SLAExpirationDate

DateTime

Lectura y escritura

Fecha límite de procesamiento del lote.

SlaStartDate

DateTime

De solo lectura

La hora en que se inició el procesamiento del lote.

SlaWarningPeriod *

Int

Lectura/escritura

La hora de inicio del período durante el cual se mostrará una advertencia de que el plazo de la tarea está próximo a vencer. Se especifica en minutos restantes hasta el plazo.

StageInfo

IStageInfo

De solo lectura

Devuelve el objeto IStageInfo con información sobre la etapa de procesamiento del documento. Los campos TaskId y PrincipalId no se utilizan.