Integrar la etapa de escaneo - ABBYY Documentation

Estas instrucciones suponen que se utiliza la autenticación de Windows. También puede usar la autenticación de FlexiCapture o SAML. Para cargar la interfaz y la funcionalidad de Scanning Station, use el elemento <iframe>. La estación admite cuatro escenarios: crear un lote, abrir un lote, abrir o crear un lote y obtener una tarea de reescaneo.

Use codificación de URL para pasar como valores de parámetros en la URL caracteres que no sean del inglés, como los japoneses.

Crear un lote

Para crear y abrir un nuevo lote con determinados registration parameters, defina el atributo src como:

<stationUrl>/WinAuth/Manage/Create?projectId=[project ID]&batchTypeName=[batch type name]&batchName=[batch name]&regparam=[name:value]

Name	Required	Description
`<stationUrl>`	Sí	La dirección de la Scanning Station a la que accede el sistema de terceros. El valor predeterminado es `<serverName>/FlexiCapture12/Scanning`.
`WinAuth`	Sí	Parámetro de autenticación de Windows.
`Create`	Sí	El nombre del comando que crea un nuevo lote.
`projectId`	Sí	El ID del proyecto en el que se creará el lote.
`batchTypeName`	Sí	El tipo de lote que se creará.
`batchName`	No	Un nombre para el nuevo lote. Si no se indica ninguno, el programa asigna uno según la configuración del tipo de lote seleccionado.
`regparam`	No	Un registration parameter con el formato `nombre:valor`. El parámetro debe estar especificado en la configuración del tipo de lote `batchTypeName` en la estación web; de lo contrario, se ignora. Una varios parámetros con el símbolo `&`.

Abrir un lote

Para abrir un lote existente con determinados registration parameters, establezca el atributo src en:

<stationUrl>/WinAuth/Manage/Open?projectId=[project ID]&batchName=[new batch name]&regparam=[name:value]

Name	Required	Description
`<stationUrl>`	Sí	La dirección de la Scanning Station a la que accede el sistema de terceros. El valor predeterminado es `<serverName>/FlexiCapture12/Scanning`.
`WinAuth`	Sí	Parámetro de autenticación de Windows.
`Open`	Sí	El nombre del comando que abre un lote existente. Si el proyecto contiene más de un lote, el comando toma el primero en orden alfabético.
`projectId`	Sí	El ID del proyecto que contiene el lote que se desea abrir.
`batchName`	No	Un nuevo nombre para el lote. Utilice este parámetro para cambiar el nombre del lote.
`regparam`	No	Un registration parameter con el formato `nombre:valor`. El parámetro debe estar especificado en la configuración del tipo de lote `batchTypeName` en la estación web; de lo contrario, se ignora. Una varios parámetros con el símbolo `&`.

Solo puede abrir un lote que aún no se haya cargado al servidor.

Abrir o crear un lote

Para abrir un lote solicitado y crear uno nuevo si dicho lote no existe, establezca el atributo src en:

<stationUrl>/WinAuth/Manage/OpenOrCreate?projectId=[Project ID]&batchTypeName=[batch type name]&batchName=[batch name]&regparam=[name:value]

Name	Required	Description
`<stationUrl>`	Sí	La dirección de la Scanning Station a la que accede el sistema de terceros. El valor predeterminado es `<serverName>/FlexiCapture12/Scanning`.
`WinAuth`	Sí	Parámetro de autenticación de Windows.
`OpenOrCreate`	Sí	El nombre del comando que abre el lote solicitado o crea un lote nuevo si el solicitado no existe.
`projectId`	Sí	El ID del proyecto que contiene el lote que se va a abrir o crear.
`batchTypeName`	Sí	El tipo del lote que se va a abrir o crear.
`batchName`	No	Un nombre nuevo para el lote. Utilice este parámetro para cambiar el nombre de un lote existente o para asignar un nombre a uno nuevo. Si no se indica, el lote nuevo recibe un nombre según la configuración del tipo de lote seleccionado.
`regparam`	No	Un registration parameter con el formato `nombre:valor`. El parámetro debe estar especificado en la configuración del tipo de lote `batchTypeName` en la estación web; de lo contrario, se ignora. Una varios parámetros con el símbolo `&`.

Solo puede abrir un lote que aún no se haya cargado en el servidor.

Obtener una tarea de reescaneo

Para obtener una tarea de reescaneo, establezca el atributo src en:

<stationUrl>/WinAuth/Manage/GetRescan?projectId=[project ID]&batchName=[new batch name]&regparam=[name:value]

Name	Required	Description
`<stationUrl>`	Sí	La dirección de la Scanning Station a la que accede el sistema de terceros. El valor predeterminado es `<serverName>/FlexiCapture12/Scanning`.
`WinAuth`	Sí	Parámetro de autenticación de Windows.
`GetRescan`	Sí	El nombre del comando que obtiene una tarea de reescaneo existente. Si el Project contiene más de una tarea, el comando toma la primera en orden alfabético.
`projectId`	Sí	El ID de proyecto que contiene el lote que se va a reescanear.
`batchName`	No	Un nuevo nombre para el lote. Use este parámetro para cambiar el nombre del lote que se va a reescanear.
`regparam`	No	Un registration parameter con el formato `nombre:valor`. El parámetro debe estar especificado en la configuración del tipo de lote `batchTypeName` en la estación web; de lo contrario, se omite. Una varios parámetros con el símbolo `&`.

Volver al sistema de terceros

Cuando el usuario termina con el lote y sale de la Scanning Station integrada, el método postMessage pasa el mensaje FC_Scanning_TaskClosed al elemento padre y se abre la página final. El Developer debe redirigir al usuario desde esa página de vuelta al sistema de terceros.

​Crear un lote

​Abrir un lote

​Abrir o crear un lote

​Obtener una tarea de reescaneo

​Volver al sistema de terceros

Crear un lote

Abrir un lote

Abrir o crear un lote

Obtener una tarea de reescaneo

Volver al sistema de terceros