Validaciones
Comprueba el resultado final de una plantilla de IDP con validaciones por código, por llamada a una API o por un robot: campos, regla de aprobación de cada tipo, asignación de entradas del robot y motivos de rechazo.
Validaciones
Las validaciones son comprobaciones que el resultado final de la plantilla tiene que superar. Forman una lista que se ejecuta de arriba abajo, con los controles de tarjeta descritos en Pipeline, y cada una aprueba o rechaza el resultado.
| Tipo | Qué hace |
|---|---|
| Código | Aprueba o rechaza el resultado con un script. |
| API | Envía el resultado a una API que responde si lo aprueba. |
| Robot (RPA) | Ejecuta un robot real, también en las pruebas, y usa su respuesta como veredicto. |
Toda validación tiene un Nombre, que aparece en la tarjeta y en los resultados, por ejemplo "El total coincide con los ítems" o "CIF activo".
Qué reciben las validaciones
Todas las validaciones reciben el mismo resultado final: la salida de la última etapa de posprocesamiento o, sin posprocesamiento, el resultado de la extracción.
Todas las validaciones activas se ejecutan, aunque una de ellas rechace el resultado. Un rechazo no detiene el pipeline ni hace que la ejecución falle: la ejecución termina como Concluida, y el resultado registra qué validaciones se aprobaron y, en las rechazadas, el motivo. En el Playground, la pestaña Validaciones muestra el marcador, por ejemplo "2/3 aprobadas". Las validaciones desactivadas no se ejecutan.
Sin ninguna validación, se acepta cualquier resultado.
Validación por código
La validación por Código ejecuta un script en Node.js (por defecto) o Python con el mismo contrato que las etapas de código del posprocesamiento: input contiene el resultado final, y el veredicto es el valor asignado a output. En Node.js, params trae los parámetros enviados en la llamada.
Valor de output | Veredicto |
|---|---|
true / True | Aprobada. |
false / False | Rechazada. |
{ passed, reason } (en Python, {"passed": bool, "reason": str}) | Aprobada o rechazada según passed; reason explica el rechazo. |
| Cualquier otro valor | Rechazada, con un motivo que muestra el valor recibido. |
Si el script lanza un error, la validación se rechaza con el mensaje del error. Una validación sin código siempre se rechaza. Los motivos de más de 500 caracteres se recortan.
const suma = input.itens.reduce((total, item) => total + Number(item.valor), 0);
output = suma === Number(input.total)
? true
: { passed: false, reason: "El total no coincide" };
Validación por API
La validación por API hace una petición HTTP a un endpoint tuyo, que decide si el resultado se aprueba.
| Campo | Por defecto | Descripción |
|---|---|---|
| Endpoint | POST | El método — GET, POST, PUT, PATCH o DELETE — y la URL llamada. |
| Encabezados | — | Pares de nombre y valor enviados en la petición, por ejemplo un token de autenticación. |
La petición se envía con Content-Type: application/json, y el resultado final va en el cuerpo, como JSON, salvo en GET y DELETE, que no tienen cuerpo.
Cualquier respuesta 2xx aprueba. Otro estado rechaza con el motivo "A API respondeu com status N" (la API respondió con el estado N); un fallo de conexión rechaza con el mensaje del error. La respuesta de la API queda registrada en el resultado de la validación.
Los encabezados se guardan en la plantilla y se incluyen al exportarla. Consulta General.
Validación por robot
La validación por Robot (RPA) dispara un robot del workspace y usa su respuesta como veredicto. El robot se ejecuta de verdad en todas las ejecuciones, también en el Playground, en Simular API y en los casos de prueba.
| Campo | Por defecto | Descripción |
|---|---|---|
| Robot | — | El robot que se ejecuta, buscado por nombre. |
| Entradas del robot | — | Para cada entrada que el robot declara, la ruta del valor que recibe. |
| Tiempo límite (segundos) | 300 | De 1 a 840. Si el robot no responde en este tiempo, la validación se rechaza. |
Entradas del robot
El robot recibe datos por las entradas que declara con la acción Obtiene entradas de un Webhook. Para cada entrada, indica una ruta a partir de:
payload— el resultado final, por ejemplopayload.cnpjopayload.emisor.nombre;params— los parámetros enviados en la llamada a la plantilla, por ejemploparams.cliente.
El campo sugiere rutas a partir de la última ejecución del Playground. Una entrada cuya ruta no existe en el resultado no se envía. Si el robot no declara entradas, no recibe datos del resultado.
Respuesta del robot
El robot debe responder con un objeto { passed, reason }, en el que passed es verdadero o falso y reason explica el rechazo, por ejemplo con la acción Responder Webhook. Sin esa respuesta, la validación siempre se rechaza. Cuando el robot elegido no tiene esa acción o su respuesta no declara el campo passed, la tarjeta muestra un aviso.
El tiempo límite nunca supera el tiempo que le queda a la ejecución de la plantilla; si quedan menos de 5 segundos, la validación se rechaza por tiempo agotado.
Motivos de rechazo
Además de passed: false, la validación por robot se rechaza en estos casos:
| Motivo | Cuándo ocurre |
|---|---|
| Robot no configurado | No se seleccionó ningún robot en la validación. |
| Robot no encontrado | El robot no existe, está inactivo o pertenece a otro workspace. |
| Dispositivo inaccesible | El dispositivo del robot está sin conexión o inaccesible. |
| Error del robot | El robot terminó con un error. |
| Sin veredicto | El robot terminó sin devolver un veredicto con passed. |
| Tiempo agotado | El robot no respondió dentro del tiempo límite. |
| Función fuera del plan | El plan del workspace no incluye la ejecución de robots por webhook. |