> ## Documentation Index > Fetch the complete documentation index at: https://docs.abbyy.com/llms.txt > Use this file to discover all available pages before exploring further. # Objetos > Modelo de objetos para scripts personalizados de la estación web de verificación: funciones para campos, conjuntos de datos y el formulario del documento, además de commandArgs y las propiedades de los campos. A continuación, se presenta una lista de las funciones disponibles para crear scripts personalizados. Para acceder a las instancias de objeto, use la variable commandArgs. Todas las variables de esta sección son globales y están disponibles en todo el programa.

Función

Descripción

getCurrentField()

Devuelve un vínculo al objeto Field que usa el script personalizado actual.

getFieldByName(namesPath) (\*)

Devuelve un enlace al campo para el que se abrió el script personalizado.

Ejemplo:
\['Document Section 1', 'Group\[10]','Field3'],
donde \[10] es el número de la instancia del grupo repetido.

  • namesPath es un array que contiene los nombres de campos y grupos que forman la ruta hasta el campo o un enlace a un objeto de campo.

getFieldValue(namesPath) (\*)

Devuelve:

  • una cadena para un campo TextField;
  • un valor de marca de verificación para un campo Checkmark;
  • un array de cadenas para un campo Checkmark Group.

namesPath | fieldObject:

  • un array que contiene nombres de campos y grupos que forman la ruta al campo,
  • o un enlace al objeto de campo.

setCurrentFieldValue(value, forced, onSaved)

Modifica el valor del campo para el que está abierto el script personalizado.

Parámetros:

  • value – el valor del campo.
  • forced – actualiza el valor del campo y guarda los datos nuevos. Este parámetro es opcional.
    • false – el valor del campo en la Definición de Document se actualizará solo después de llamar a la función save() .
    • true – el valor del campo en la Definición de Document se actualizará inmediatamente.

      En un script personalizado, la actualización se realizará independientemente del modo.
      De forma predeterminada, este parámetro está establecido en false.
  • onSaved – función de callback. Se llama si el parámetro forced está establecido en true. Este parámetro es opcional.

setFieldValue(namesPath | field, value, forced, onSaved) (\*)

Modifica el valor del campo.

Parámetros:

  • namesPath | fieldObject:
    • un array que contiene nombres de campos y grupos que forman la ruta al campo,
    • o una referencia al objeto de campo.
  • value – valor del campo correspondiente.
  • forced – actualiza el valor del campo y registra los nuevos datos. Este parámetro es opcional.
    • false – el valor del campo en la Definición de Document se actualizará solo después de llamar a la función save() .
    • true – el valor del campo en la Definición de Document se actualizará inmediatamente.

      En un script personalizado, la actualización se producirá independientemente del modo.
      De forma predeterminada, este parámetro se establece en false.
  • onSaved – una función de callback. Se llama si el parámetro forced se establece en true. Este parámetro es opcional.

save()

Cierra la ventana en la que se ejecuta el script personalizado y guarda los cambios.

cancel()

Cierra la ventana en la que se ejecuta el script personalizado sin guardar los cambios.

(\*) Para algunas de las funciones enumeradas arriba, la ruta al campo se especifica como un parámetro de entrada. Incluye el nombre del campo y los nombres de los elementos padre (grupo de campos, sección). Para tablas, tablas repetidas y grupos repetidos, debe especificar el número de instancia comenzando por 0 (cero).

Ejemplo:
\['Document Section 1', 'Group\[10]','Field3'],

donde \[10] es el número de instancia del grupo repetido.

Función

Descripción

addEntity(entityInfo: \{cacheName, columns, values}, onResult(newId))

Añade una entrada al conjunto de datos.

Parámetros:

  • entityInfo – un objeto:
    • cacheName – un nombre para el conjunto de datos.
    • columns – nombres de las columnas donde se registrarán los datos. Array de cadenas.
    • values – los valores de las columnas correspondientes. Array de cadenas.
  • onResult – una función callback que recibe el ID del registro creado en el conjunto de datos.

editEntity(entityInfo: \{cacheName, columns, values}, onResult())

Edita una entrada en la base de datos.

Parámetros:

  • entityInfo – un objeto:
    • cacheName – un nombre para el conjunto de datos.
    • columns – nombres de las columnas en las que se registrarán los datos. array de cadenas.
    • values – los valores de las columnas correspondientes. array de cadenas.
  • onResult – una función de callback.

getDict(\{cacheName, filters: \[\{FieldName, FieldValue}], cursorPos, allowMultipleColumnResults}, onResult (param: \{ FieldName, FieldValue, BoldMask}\[]\[]) )

Realiza una búsqueda en un conjunto de datos de un valor especificado o de una parte de este. Devuelve las cadenas coincidentes en el siguiente formato:

\[\{FieldName
FieldValue
BoldMask}].

Parámetros:

  • cacheName – el nombre del conjunto de datos.
  • filters – parámetros de búsqueda:
    • FieldName – el nombre del campo. Déjelo vacío para buscar en todos los campos.
    • FieldValue – el valor del campo.
  • cursorPos – la posición del cursor en el campo de entrada.
    • Si se introdujo un valor de forma parcial y el cursor está situado después de los símbolos escritos, estos se considerarán como un prefijo del valor que se está buscando.
    • Si el cursor está situado antes de una palabra escrita parcialmente, esos símbolos se considerarán como la parte final del valor que se está buscando.

      Por ejemplo, si, al buscar el nombre de una empresa, escribe "ADO" y el cursor está situado después, se seleccionará el valor "AVOCADO".
      Si escribe "ADO" y el cursor está situado delante, se seleccionará el valor "ADONIS".
  • allowMultipleColumnResults – devuelve los valores de los campos encontrados.
    El conjunto de datos puede contener entradas en las que un nombre de campo (FieldName) corresponda a varios valores de campo (FieldValue). Por ejemplo, se pueden especificar dos o más variantes del nombre de una empresa en la columna CompanyName.

    En este caso:
    • true – devuelve y registra todos los valores de campo que cumplen las condiciones de búsqueda,
    • false – devuelve y registra un único resultado que mejor se ajusta a las condiciones de búsqueda.
  • onResult – una función callback que devuelve un array con los resultados de la búsqueda. Cada resultado es una única cadena del conjunto de datos; en conjunto, forman un array de cadenas. Cada cadena incluye el nombre del campo, su valor y el parámetro BoldMask .

    BoldMask – una cadena de ‘0’ y ‘1’ con la misma longitud que el valor encontrado durante la búsqueda. ‘1’ representa un símbolo del valor encontrado que coincide con el símbolo correspondiente en el campo de búsqueda, y ‘0’ representa un símbolo que no coincide.

Si, por ejemplo, en un conjunto de datos está presente lo siguiente:

CompanyName: ABBYY

Supongamos que se realiza una búsqueda de los símbolos "ABB".

Entonces, se devolverá lo siguiente:

\[

\[

\{

FieldName: ‘CompanyName’,

FieldValue: ‘ABBYY’,

BoldMask: ‘11100’

},

]

]

Nota: El array devuelto puede contener varios valores, incluidos aquellos que inicialmente no cumplían las condiciones de búsqueda. Los resultados de búsqueda del array se ordenarán por el valor del parámetro BoldMask en orden descendente (es decir, empezando por las cadenas que mejor coincidan con las condiciones de búsqueda).

getDictAll(\{cacheName, filters: \{FieldName, FieldValue}}, }, onResult (param: \{ FieldName, FieldValue, BoldMask}\[]\[]))

Realiza una búsqueda en la base de datos del valor completo especificado. Devuelve los valores de todos los campos encontrados.

Parámetros:

  • cacheName – el nombre del conjunto de datos.
  • Filters – un array de objetos:
    • FieldName – el nombre del campo. Para buscar en todos los campos, debe dejarse en blanco.
    • FieldValue – el valor del campo.
  • onResult – una función de devolución de llamada que devuelve un array de resultados de búsqueda. Cada resultado es una única cadena del conjunto de datos, que a su vez es un array de cadenas. Cada cadena incluye el nombre del campo, su valor y el parámetro BoldMask .

    BoldMask – una cadena de ‘0’ y ‘1’ con la misma longitud que el valor encontrado durante la búsqueda. '1' representa un símbolo del valor encontrado que coincide con el símbolo correspondiente en el campo de búsqueda, y '0' representa un símbolo que no coincide.


    Si, por ejemplo, en un conjunto de datos aparece lo siguiente:

    CompanyName: ABBYY

    Supongamos que se realiza una búsqueda de los símbolos "ABB".

    Entonces, se devolverá lo siguiente:

\[

\[

\{

FieldName: ‘CompanyName’,

FieldValue: ‘ABBYY’,

BoldMask: ‘11100’

},

]

]

Nota: El array devuelto puede contener varios valores, incluidos algunos que inicialmente no cumplían las condiciones de búsqueda. Los resultados de búsqueda del array se ordenarán por el valor del parámetro BoldMask en orden descendente (es decir, comenzando por las cadenas que mejor coincidan con las condiciones de búsqueda).

Script de ejemplo para buscar en la base de datos

Función

Descripción

selectRow(tablePath, rowNumber) (\*)

Marca como seleccionada una fila de la tabla.

  • tablePath | fieldObject:
    • un array de nombres de campos y grupos que forman la ruta al campo de tabla,
    • o un enlace a un objeto de tabla.
  • rowNumber – el número de la fila que se va a seleccionar, con índice basado en cero.

deselectRow(tablePath, rowNumber?) (\*)

Quita la selección de una fila de la tabla.

  • tablePath | fieldObject:
    • un array de nombres de campos y grupos que forman la ruta al campo de tabla,
    • o un enlace a un objeto de tabla.
  • rowNumber – el número de la fila cuya selección se va a quitar, con índice basado en cero; si se omite, se quita la selección de todas las filas de la tabla.

scrollFormToField(namesPath) (\*)

Desplaza el editor de formularios hasta que el campo quede visible.

  • namesPath | fieldObject:
    • un array de nombres de campos y grupos que forman la ruta al campo de tabla,
    • o un enlace a un objeto de tabla.

getDomElementPosition(domId, onResult: (result?: \{width, height, top, left, right, bottom}))

Obtiene la posición de un elemento en la ventana del editor de formularios y devuelve el resultado de una función de callback.

  • domId – ID del elemento en formato DOM.
  • onResult – una función de callback que recibe el objeto con las coordenadas DOM del elemento (width, height, top, left, right, bottom) relativas a la esquina superior izquierda de la ventana del navegador.

setStyles(styles, callback)

Agrega estilos CSS a la ventana del marco de la acción personalizada.

  • styles – un objeto con nombres y valores de propiedades CSS.

    ejemplo:
    \{
    display: 'block',
    position: 'absolute',
    top: '0px',
    bottom: '0px',
    left: '0px',
    right: '0px',
    width: '100%',
    height: '100%',
    border: '0',
    overflow: 'hidden',
    'overflow-x': 'hidden',
    'overflow-y': 'hidden',
    'z-index': '10000'
    }
  • callback – una función de callback.

(\*) En algunas de las funciones indicadas arriba, la ruta al campo se especifica como un parámetro de entrada. Incluye el nombre del campo y los nombres de los elementos primarios (grupo de campos, sección). Para tablas, tablas repetidas y grupos repetidos, debe especificar el número de instancia comenzando en cero.

Ejemplo:
\['Document Section 1', 'Group\[10]','Field3'],

donde \[10] es el número de la instancia del grupo repetido.
**Variables**

Variable

Tipo

Descripción

commandArgs.params.document

Document

Almacena una copia del objeto de un documento abierto. Puede usarse para acceder a cualquier error, campo o región del documento actual.

commandArgs.params.currentField

(Picture | Checkmark | Checkmark Groups | FieldsGroup | Table | TextField)

Devuelve una referencia a un objeto de campo que refleja el estado del campo en el momento en que se llama al script. Forma parte del documento indicado anteriormente.

Nota: Si el valor del campo se modificó después de que se inicializó el script, los cambios no se aplicarán.

commandArgs.params.appPath

cadena

El nombre de dominio del servidor.

commandArgs.params.coordinates

Object
\[\{X1,X2,Y1,Y2}]

Las coordenadas del elemento DOM que llamó al script personalizado.

commandArgs.params.currentElementDomId

cadena

El ID del elemento DOM que llamó al script personalizado.
**Funciones** | **Función** | **Descripción** | | ------------------------------------- | --------------------------------------------------------------------------------- | | commandArgs.events.addEventHandler | Agrega un controlador de eventos en el contexto global del script personalizado. | | commandArgs.events.triggerHandlers | Desencadena un evento en el contexto global del script personalizado. | | commandArgs.events.removeEventHandler | Elimina un controlador de eventos en el contexto global del script personalizado. |

Nombre

Tipo

Permiso

Descripción

Fields

(Picture | Checkmark | Checkmark Groups | FieldsGroup | Table | TextField)\[]

De solo lectura

Array de campos

HasTableLayout

Boolean

De solo lectura

Especifica si la región del campo es una tabla.

Caption

cadena

De solo lectura

Nombre o título del campo personalizado

FieldType

Number

De solo lectura

Tipo de campo. Valor posible:

4 – grupo de campos

Id

Number

De solo lectura

ID del campo

IsReadOnly

Boolean

De solo lectura

Especifica si la edición de campos no está permitida.

IsVisible

Boolean

De solo lectura

Especifica si el campo es visible en el formulario de datos.

MaxRegions

Number

De solo lectura

Número máximo de regiones del campo. Si el valor es -1, se permite cualquier número de regiones.

Name

cadena

De solo lectura

Nombre interno del campo.

NamePath

cadena\[]

De solo lectura

Array de nombres de campos y grupos que forman la ruta al campo.

NeedRecognize

Boolean

Lectura/escritura

Especifica si se debe recuperar de la región el valor del campo cuando se vuelvan a comprobar las reglas.

Regions

\{
Id: number;
Status: number;
PageId: Number;
IsNew : Boolean;
Coordinates: Object
\[\{X1,X2,Y1,Y2}];
}\[]

De solo lectura

Array de regiones.

  • Id – ID de la región.
  • Status – estado de la región.
    • 0 – región no superpuesta (o eliminada)
    • 1 – la región no está reconocida
    • 2 – el valor de la región se inserta en el campo
  • PageId – ID de la página en la que se encuentra la región.
  • IsNew – indicador de regiones nuevas.
  • Coordinates – coordenadas de la región en la imagen.

Nombre

Tipo

Permisos

Descripción

Fields

(Picture | Checkmark | Checkmark Groups | FieldsGroup | Table | TextField)\[]

De solo lectura

Array de campos

Pageids

Number\[]

De solo lectura

Identificadores de las páginas en las que se encuentra la sección.

IsFlexible

Boolean

De solo lectura

Especifica si la sección es flexible.

Caption

cadena

De solo lectura

Nombre del campo personalizado, caption

FieldType

Number

De solo lectura

Tipo de campo. Valor posible:

6 – sección

Id

Number

De solo lectura

ID del campo

IsReadOnly

Boolean

De solo lectura

Especifica si la edición del campo no está permitida

IsVisible

Boolean

De solo lectura

Especifica si el campo es visible en el formulario de datos.

MaxRegions

Number

De solo lectura

Número máximo de regiones de campo. Si el valor es -1, se permite cualquier cantidad de regiones.

Name

cadena

De solo lectura

Nombre interno del campo

NamePath

cadena\[]

De solo lectura

Array de nombres de campos y grupos que forman la ruta hasta el campo.

NeedRecognize

Boolean

Lectura/escritura

Especifica si se debe recuperar el valor del campo desde la región cuando las reglas se vuelvan a comprobar.

Regions

\{
Id: number;
Status: number;
PageId: Number;
IsNew : Boolean;
Coordinates: Object
\[\{X1,X2,Y1,Y2}];
}\[]

De solo lectura

Array de regiones.

  • Id – ID de la región.
  • Status – estado de la región.
    • 0 – región no superpuesta (o la región se eliminó)
    • 1 – la región no se reconoce
    • 2 – el valor de la región se sustituye en el campo
  • PageId – ID de la página en la que se encuentra la región.
  • IsNew – indicador de regiones nuevas.
  • Coordinates – coordenadas de la región en la imagen.

Name

Tipo

Permisos

Descripción

Filas

\{
Id: number;
RowNumber: number;
HasColorImage: boolean;
TableBlockID: number\[];
Cells: (Picture | Checkmark | CheckmarkGroup | TextField)\[];
}\[]

De solo lectura

Lista de filas de la tabla.

Parámetros del objeto de fila de la tabla:

  • Id – ID de la fila.
  • RowNumber – número secuencial de la fila, empezando por cero.
  • TableBlockId – identificadores de secciones, tablas y bloques de la tabla que forman la ruta al bloque de la tabla.
  • Cells – campos de las celdas de la tabla. Los campos pueden ser de los siguientes tipos: imagen, marca de verificación, grupo de marcas de verificación, texto.

Título

Cadena

De solo lectura

Nombre o título del campo personalizado

FieldType

Number

De solo lectura

Tipo de campo. Valor posible:

7 – tabla

ID

Número

De solo lectura

ID del campo

IsReadOnly

Boolean

De solo lectura

Indica si no se permite editar el campo.

IsVisible

Boolean

De solo lectura

Indica si el campo es visible en el formulario de datos.

MaxRegions

Number

De solo lectura

Especifica si el campo es visible en el formulario de datos; -1 permite cualquier número de regiones.

Name

Cadena

De solo lectura

Nombre de servicio del campo.

NamePath

String\[]

De solo lectura

Array con los nombres de los campos y grupos que forman la ruta hasta el campo.

NeedRecognize

Boolean

Lectura/escritura

Especifica si se recupera el valor del campo de la región cuando se vuelven a comprobar las reglas.

Regiones

\{
Id: number;
Status: number;
PageId: Number;
IsNew : Boolean;
Coordinates: Object
\[\{X1,X2,Y1,Y2}];
}\[]

De solo lectura

Array de regiones.

  • Id – ID de la región.
  • Status – estado de la región.
    • 0 – la región no está superpuesta (o la región se ha eliminado)
    • 1 – la región no se ha reconocido
    • 2 – el valor de la región se inserta en el campo
  • PageId – ID de la página en la que se encuentra la región.
  • IsNew – indicador para señalar regiones nuevas.
  • Coordinates – coordenadas de la región en la imagen.

Name

Tipo

Permisos

Descripción

Flags

Number\[]

Lectura/escritura

array de la misma longitud que el campo Value. Consta de 0 y 1.

0 – un carácter que está en Value en la misma posición que el 0 en Flags requiere verificación.

Sugerencias

String\[]

De solo lectura

Lista de valores de campo sugeridos

Value

String

Lectura y escritura

Valor del campo

TextType

Number

De solo lectura

Tipo de campo de texto. Posibles valores:

  • 0 – campo de texto.
  • 1 – campo numérico.
  • 2 – campos de monto en divisa.
  • 3 – campo de fecha y hora.
  • 4 – campo de fecha.
  • 5 – campo de hora.
  • 6 – campo de código.

Título

Cadena

De solo lectura

Nombre y título del campo personalizado

FieldType

Number

De solo lectura

Tipo de campo. Valor posible:

0 – campo de texto

ID

Número

De solo lectura

ID del campo

IsReadOnly

Boolean

De solo lectura

Especifica si no se permite editar el campo.

IsVisible

Boolean

De solo lectura

Especifica si el campo es visible en el formulario de datos.

MaxRegions

Number

De solo lectura

Número máximo de regiones de campo. Si el valor es -1, se permite cualquier cantidad de regiones.

Name

Cadena

De solo lectura

Nombre de servicio del campo.

NamePath

String\[]

De solo lectura

Array con nombres de campos y grupos que forman la ruta del campo.

NeedRecognize

Boolean

Lectura/escritura

Especifica si se debe recuperar el valor del campo de la región cuando se vuelvan a comprobar las reglas.

Regiones

\{
Id: number;
Status: number;
PageId: Number;
IsNew : Boolean;
Coordinates: Object
\[\{X1,X2,Y1,Y2}];
}\[]

De solo lectura

Array de regiones.

  • Id – ID de la región.
  • Status – estado de la región.
    • 0 – región no superpuesta (o la región se ha eliminado)
    • 1 – la región no está reconocida
    • 2 – el valor de la región se sustituye en el campo
  • PageId – ID de la página en la que se encuentra la región.
  • IsNew – indicador de regiones nuevas.
  • Coordinates – coordenadas de la región en la imagen.

IsVerified

Boolean

De lectura y escritura

Especifica si el campo se ha verificado.

NeedVerification

Boolean

De solo lectura

Indica si el campo requiere verificación.

NeedDoubleVerification

Booleano

De solo lectura

Indica si el campo requiere una doble verificación

IsSummary

Booleano

De solo lectura

Especifica si el campo se utiliza para formar el resumen de datos en el formulario de datos.

Nombre

Tipo

Permisos

Descripción

Value

Booleano

Lectura/escritura

Valor del campo

Etiqueta

Cadena

De solo lectura

Nombre del campo personalizado, etiqueta

FieldType

Number

De solo lectura

Tipo de campo. Valor posible:

2 – marca de verificación

ID

Número

De solo lectura

ID del campo

IsReadOnly

Boolean

De solo lectura

Especifica si la edición del campo está deshabilitada.

IsVisible

Boolean

De solo lectura

Indica si el campo es visible en el formulario de datos.

MaxRegions

Number

De solo lectura

Número máximo de regiones de campo. Si el valor es -1, se permite cualquier cantidad de regiones.

Name

Cadena

De solo lectura

Nombre de servicio del campo.

NamePath

String\[]

De solo lectura

Array de nombres de campos y grupos que componen la ruta del campo.

NeedRecognize

Boolean

Lectura/escritura

Especifica si se debe obtener el valor del campo de la región cuando se vuelven a comprobar las reglas.

Regiones

\{
Id: number;
Status: number;
PageId: Number;
IsNew : Boolean;
Coordinates: Object
\[\{X1,X2,Y1,Y2}];
}\[]

De solo lectura

Array de regiones.

  • Id – ID de la región.
  • Status – estado de la región.
    • 0 – región no superpuesta (o la región se ha eliminado)
    • 1 – la región no está reconocida
    • 2 – el valor de la región se inserta en el campo
  • PageId – ID de la página en la que se encuentra la región.
  • IsNew – indicador para identificar regiones nuevas.
  • Coordinates – coordenadas de la región en la imagen.

IsVerified

Boolean

Lectura y escritura

Especifica si el campo ha sido verificado.

NeedVerification

Boolean

De solo lectura

Especifica si el campo requiere verificación.

NeedDoubleVerification

Boolean

De solo lectura

Especifica si el campo requiere una doble verificación.

IsSummary

Boolean

De solo lectura

Especifica si el campo se utiliza para generar el resumen de datos en el formulario de datos.

Name

Type

Permisos

Descripción

MaxSelectedCount

Número

De solo lectura

Número máximo de valores de campo seleccionados.

MinSelectedCount

Number

De solo lectura

Número mínimo de valores de campos seleccionados.

Valores

Number\[]

De lectura y escritura

Valor del campo. Un array de IDs de registros que conforman la lista de posibles valores del campo (Variantes).

Variantes

\{Id:number, Name:string}\[]

De solo lectura

Lista de posibles valores del campo:

  • Id – ID del registro
  • Name – nombre del registro

Etiqueta

Cadena

De solo lectura

Nombre del campo personalizado, etiqueta

FieldType

Number

De solo lectura

Tipo de campo. Posible valor:

3 – grupo de marcas de verificación

ID

Número

De solo lectura

ID del campo.

IsReadOnly

Boolean

De solo lectura

Especifica si no se permite editar el campo.

IsVisible

Booleano

De solo lectura

Indica si el campo es visible en el formulario de datos.

MaxRegions

Number

De solo lectura

Número máximo de regiones de campo. Si el valor es -1, se permite cualquier cantidad de regiones.

Name

Cadena

De solo lectura

Nombre de servicio del campo.

NamePath

String\[]

De solo lectura

Array de nombres de campos y grupos que forman la ruta del campo.

NeedRecognize

Booleano

Lectura y escritura

Especifica si se debe obtener el valor del campo de la región cuando se vuelvan a comprobar las reglas.

Regiones

\{
Id: number;
Status: number;
PageId: Number;
IsNew : Boolean;
Coordinates: Object
\[\{X1,X2,Y1,Y2}];
}\[]

De solo lectura

Array de regiones.

  • Id – ID de la región.
  • Status – estado de la región.
    • 0 – región no superpuesta (la región se ha eliminado)
    • 1 – la región no está reconocida
    • 2 – el valor de la región se sustituye en el campo
  • PageId – ID de la página en la que se encuentra la región.
  • IsNew – indicador de regiones nuevas.
  • Coordinates – coordenadas de la región en la imagen.

IsVerified

Boolean

Lectura y escritura

Indica si el campo se ha verificado.

NeedVerification

Booleano

De solo lectura

Indica si el campo requiere verificación.

NeedDoubleVerification

Boolean

De solo lectura

Especifica si el campo requiere una doble verificación.

IsSummary

Boolean

De solo lectura

Especifica si el campo se usa para generar el resumen de datos en el formulario de datos.

Nombre

Tipo

Permisos

Descripción

Caption

cadena

De solo lectura

Nombre del campo personalizado o etiqueta

FieldType

Number

De solo lectura

Tipo de campo. Valor posible:

1 – imagen

Id

Number

De solo lectura

ID del campo.

IsReadOnly

Boolean

De solo lectura

Especifica si no se permite editar el campo.

IsVisible

Boolean

De solo lectura

Especifica si el campo es visible en el formulario de datos.

MaxRegions

Number

De solo lectura

Número máximo de regiones del campo. Si el valor es -1, se permite cualquier número de regiones.

Name

cadena

De solo lectura

Nombre interno del campo.

NamePath

cadena\[]

De solo lectura

Array de nombres de campos y grupos que forman la ruta al campo.

Regions

\{
Id: number;
Status: number;
PageId: Number;
IsNew : Boolean;
Coordinates: Object
\[\{X1,X2,Y1,Y2}];
}\[]

De solo lectura

Array de regiones.

  • Id – ID de la región.
  • Status – estado de la región.
    • 0 – la región no se superpone (o se ha eliminado)
    • 1 – la región no se reconoce
    • 2 – el valor de la región se asigna al campo
  • PageId – ID de la página en la que se encuentra la región.
  • IsNew – indicador que señala regiones nuevas.
  • Coordinates – coordenadas de la región en la imagen.

Nombre

Tipo

Permisos

Descripción

Id

Number

De solo lectura

ID del campo

Name

cadena

De solo lectura

Nombre del campo

Sections

Section\[]

De solo lectura

array de campos de tipo Section

FieldType

Number

De solo lectura

Tipo de campo.

Valor posible:

8 – grupo repetido de secciones.

Name

Tipo

Permisos

Descripción

AssemblingErrors

\{
DocumentNodeRef: number\[]\[];
Description: string;
SectionName: string\[]
}\[]

De solo lectura

Errores de ensamblado en el documento, donde:

  • DocumentNodeRef – lista de vínculos en forma de un array de ID de campo a campos del formulario
  • Description – descripción del error
  • SectionName – lista de secciones implicadas en el error

BatchId

Número

De solo lectura

El ID del paquete

Errores

\{
DocumentNodeRef: number\[]\[];
Severity: number;
Message: string;
RuleName: string;
}\[]

De solo lectura

Errores en el documento, donde:

  • DocumentNodeRef – lista de vínculos como un array de ID de campos que apuntan a campos del formulario
  • Severity:
    • 1 – Error,
    • 0 – Advertencia
  • Message – texto del error
  • RuleName – nombre de la regla que causó el error

Fields

(Section | SectionsGroup)\[]

De solo lectura

Lista de secciones/secciones duplicadas

Id

Número

De solo lectura

Identificador del documento

Index

Number

De solo lectura

Índice del documento dentro del paquete

Pages

\{
Id: number;
Modification: number;
HasColorImage: boolean;
ImageResolution: number;
KeyValue: string;
SectionTemplateId: number;
SectionTemplateName: string;
FlexibleInstanceId: number;
SectionTemplatePageNumber: number;
Comment: string;
ImageWidth: number;
ImageHeight: number;
}\[]

De solo lectura

Lista de páginas de documento que contiene lo siguiente:

  • Id – ID de la página
  • Modification – el número de revisión de la página
  • HasColorImage – indica si la página es en color
  • ImageResolution – resolución de la imagen
  • KeyValue – el valor del campo clave de la página
  • SectionTemplateId – ID de la sección de la página
  • SectionTemplateName – nombre de la sección de la página
  • SectionTemplatePageNumber – el número de página dentro de la sección
  • Comment – comentario sobre la página
  • ImageWidth – ancho de la página de imagen
  • ImageHeight – altura de la imagen de la página

ProjectId

Número

De solo lectura

Identificador del proyecto

TaskId

Número

De solo lectura

ID de tarea

TemplateId

Número

De solo lectura

ID de la definición del documento

TemplateName

Cadena

De solo lectura

Nombre del documento de definiciones

TemplateVersion

Número

De solo lectura

Versión de la definición del documento

Versión

Número

De solo lectura

Versión del documento