Documents — Upload

Tipo: documents-upload  ·  Paquete: Documents Activities v1.4.5  ·  Salida: object

Sube un documento —con sus páginas renderizadas y su extracción— a Zoan Cloud, para que una persona lo abra en la estación de validación. En el Designer en español aparece como Documentos — Subir.

Casi nunca hace falta

IDP — Extract ya guarda el documento y su extracción, y Zoan Cloud muestra sus páginas por su cuenta. Esta actividad es para pipelines montados a mano (con IDP — Ground) o casos en los que tú renderizas y subes las páginas.

Documents — Upload   path       = contenido["path"]
                     reference  = item.Reference
                     pages      = paginas
                     dpi        = 200
                     extraction = res

Cómo funciona

1. Sube el archivo de path con su reference y los metadatos que indiques (tipo, proyecto, formato, segmento, retención).
2. Sube cada imagen de pages, en orden, con su número de página, su tamaño (leído del propio PNG) y el dpi. Con cada página viaja el total de páginas, así que si no caben todas en el cupo de páginas del plan, Zoan Cloud rechaza desde la primera y no queda un documento a medio subir.
3. Si pasaste extraction, la guarda junto al documento y lo deja listo para revisar.

Subir dos veces con la misma reference reemplaza el documento en vez de duplicarlo. Sin pages, el documento se sube pero el log advierte que la estación no tendrá dónde mostrar los campos; sin extraction, advierte que no hay nada que revisar. Necesita el contexto de ejecución de Zoan Cloud (ejecución desde Zoan Cloud o desde el Designer con sesión).

Parámetros requeridos

Parámetro	Tipo	Por defecto	Descripción
path	string	—	Ruta del documento a subir: PDF, PNG, JPEG, TIFF o BMP. El mismo archivo que leíste con IDP.
reference	string	—	La clave del documento. Usa la misma que el item de la cola y desde el item se llega a su documento. Subir de nuevo con la misma reference lo reemplaza.

Parámetros opcionales

Parámetro	Tipo	Por defecto	Descripción
pages	List	—	Las páginas renderizadas, en orden: lo que devolvió PDF To Images. Deben ser PNG. Sin ellas la estación no tiene dónde dibujar las cajas.
dpi	int	200	El dpi al que se renderizaron las páginas. Rango: 36 a 1200. Debe coincidir con el de la lectura del documento: si no, no falla, pero las cajas caen en el sitio equivocado.
extraction	Dictionary	—	Lo que devolvió IDP — Ground o IDP — Extract. Pásalo entero, no solo values: las cajas permiten resaltar cada campo y las confianzas explican por qué necesita revisión.
documentType	string	—	El tipo de documento que decidió el clasificador. Permite filtrar por tipo en la estación.
project	string	—	El nombre del proyecto de extracción contra el que se extrajo. Enlaza el documento con su proyecto para listarlo y revisarlo por proyecto.
format	string	—	El perfil de formato al que enrutó IDP — Extract (su salida format).
sourceGroupId	string	—	Solo al partir un bundle: el id que comparten todos los documentos que salieron del mismo archivo (usa la reference del item). Permite mostrar el archivo partido como un grupo. Desde la versión 1.1.0.
pageStart	int	—	Primera página (desde 1) que ocupa este documento en el archivo original. Sale del segmento. Desde la versión 1.1.0.
pageEnd	int	—	Última página (desde 1, incluida) que ocupa este documento en el archivo original. Desde la versión 1.1.0.
retentionDays	int	—	Cuántos días conservar el documento (entero positivo). Vacío usa el valor por defecto del ambiente. Vale la pena fijarlo a propósito: puedes conservar un registro validado 90 días y uno regulatorio varios años, en el mismo lote.

Cupo de páginas del plan

Cada página que se guarda cuenta en el cupo mensual de páginas de tu plan. La actividad le dice a Zoan Cloud cuántas páginas tiene el documento, así que si no caben todas en lo que queda del cupo se rechaza desde la primera —con las cifras— y no queda un documento a medio subir. Volver a subir una página que ya estaba no consume cupo. Lo que consumes aparece en Consumo de IA.

Salida

Devuelve un object con:

Campo	Tipo	Qué es
id	string	El id del documento en Zoan Cloud.
reference	string	La reference con la que se subió.
pageCount	int	Cuántas páginas se subieron (0 si no pasaste pages).

Ejemplo

Un pipeline montado a mano que renderiza las páginas y sube el resultado del grounding:

IDP — Ground         document = doc   extraction = extraccion   taxonomy = taxonomia
                     → output: res
PDF To Images        path = rutaDoc   dpi = 200   outputDir = carpetaTemporal   → output: paginas
Documents — Upload   path         = rutaDoc
                     reference    = item.Reference
                     pages        = paginas
                     dpi          = 200
                     extraction   = res
                     documentType = res["documentType"]
                     → output: subido
Queue Set Transaction Status   item = item   status = "successful"
                               output = { "documentId": subido["id"] }

Errores comunes

Mensaje	Causa y solución
'path' es obligatorio. / 'reference' es obligatorio.	Falta un parámetro requerido.
No se encontró el archivo.	La ruta de path no existe en la máquina del robot.
No se puede subir un archivo '…': los tipos admitidos son PDF, PNG, JPEG, TIFF y BMP.	Formato de archivo no admitido.
No se encontró la imagen de la página N.	Una ruta de pages está vacía o no existe.
Una imagen de página no es PNG. Genera las páginas con «Convertir PDF en imágenes», que produce PNG.	Las páginas deben ser PNG. Renderízalas con PDF To Images.
'dpi' debe estar entre 36 y 1200. Se recibió: … / 'pageStart' debe ser un número de página de 1 o más. Se recibió: … / 'retentionDays' debe ser un entero positivo. Se recibió: …	Parámetro fuera de rango o no entero.
A este documento le faltan N páginas y quedan M en el cupo de páginas de tu plan este mes, así que no se subieron sus páginas. Sube menos páginas o amplía el plan.	Las páginas no caben en el cupo que queda.
Se alcanzaron las páginas de documentos incluidas en tu plan este mes, así que no se subieron las páginas. Amplía el plan o espera al próximo mes.	Se agotó el cupo de páginas del mes.
Las actividades de documentos necesitan el contexto de ejecución de Zoan Cloud, que el Runner aporta al lanzar el playbook. Falta: …. …	La ejecución no tiene Zoan Cloud (por ejemplo, desde la línea de comandos). Ejecútala desde Zoan Cloud o desde el Designer con sesión.
Zoan Cloud rechazó la subida (…): … / Zoan Cloud rechazó la solicitud (…): …	Zoan Cloud no aceptó el archivo, una página o la extracción. El detalle trae el código; reintenta.

Actividades relacionadas

• IDP — Extract — extrae y guarda; el camino normal.
• IDP — Ground — lo que va en extraction en un pipeline a mano.
• PDF To Images — renderizar las páginas.