RPAMódulos

Roberty

Roberty

El módulo Roberty es responsable de integrar el robot con otros recursos del workspace: plantillas del IDP y proyectos de Roberty Code. Sus métodos pueden accederse conforme al ejemplo abajo:

js

const idpResult = await Roberty.RunIdpTemplate["v1_0_0"]({
  templateId: "id-de-la-plantilla-idp",
  filePath: "C:\\Documentos\\factura.pdf",
  robotKey: robotKey,
  actionId: "leerFactura",
});

información

Ambos métodos exigen robotKey, la clave del robot en ejecución (disponible en la variable robotKey en el código del robot), y actionId, un identificador de la llamada. El actionId es exigido por la validación del método, pero no altera el resultado.

Métodos

RunIdpTemplate

Método responsable de enviar un archivo local a una plantilla IDP del workspace y esperar el resultado del procesamiento.

js

const idpResult = await Roberty.RunIdpTemplate["v1_0_0"]({
  templateId: "id-de-la-plantilla-idp",
  filePath: "C:\\Documentos\\factura.pdf",
  page: "1-2",
  params: { cliente: "ACME" },
  timeout: 600000,
  robotKey: robotKey,
  actionId: "leerFactura",
});

Parámetros obligatorios

• templateId:String - espera el ID de la plantilla IDP del workspace.
• filePath:String - espera la ruta del archivo que será procesado, en el dispositivo que ejecuta el robot: PDF o imagen (png, jpg, jpeg, webp, tiff, tif, bmp). Si el archivo no existe, el robot interrumpe la ejecución con el error FILE_NOT_FOUND.
• robotKey:String - espera la clave del robot en ejecución.
• actionId:String - espera un identificador de la llamada.

Parámetros opcionales

• page:String - páginas a procesar. Sustituye las páginas configuradas en la plantilla y solo se acepta cuando la plantilla permite elegir las páginas por la API.
• params:Object - objeto con los parámetros de la plantilla.
• timeout:Number - tiempo máximo de espera por el resultado, en milisegundos. 0 espera indefinidamente. Predeterminado: 600000 (10 minutos). Al alcanzar el límite, el robot interrumpe la ejecución con el error TIMEOUT.

Retorno

js

actions.idpResult.requestId // identificador de la ejecución en el IDP (String)
actions.idpResult.result // resultado completo del IDP: preprocesamiento, identificación, extracción, posprocesamiento y validaciones (Any)

Si el procesamiento termina con error, el robot interrumpe la ejecución con el mensaje de error del IDP; si la ejecución expira, con el error EXPIRED.

RunCodeProject

Método responsable de ejecutar un proyecto de Roberty Code del workspace con argumentos y esperar su salida.

js

const codeResult = await Roberty.RunCodeProject["v1_0_0"]({
  codeId: "id-del-proyecto-code",
  args: { x: 1 },
  deviceTarget: "leastBusy",
  timeout: 600000,
  robotKey: robotKey,
  actionId: "calcular",
});

Parámetros obligatorios

• codeId:String - espera el ID del proyecto de Roberty Code.
• robotKey:String - espera la clave del robot en ejecución.
• actionId:String - espera un identificador de la llamada.

Parámetros opcionales

• args:Object - objeto pasado al proyecto como argumentos. Predeterminado: {}.
• deviceTarget:String - espera "leastBusy" (el dispositivo menos ocupado del proyecto) o "currentDevice" (el dispositivo que ejecuta el robot, que debe formar parte del proyecto). Predeterminado: "leastBusy".
• timeout:Number - tiempo máximo de espera por la salida, en milisegundos. 0 espera indefinidamente. Predeterminado: 600000 (10 minutos). Al alcanzar el límite, el robot interrumpe la ejecución con el error TIMEOUT.

Retorno

js

actions.codeResult.requestId // identificador de la ejecución en Code (String)
actions.codeResult.response // salida del proyecto (Any)

Si la ejecución del proyecto falla, el robot interrumpe la ejecución con el mensaje de error del proyecto. Para proyectos que no se ejecutan en paralelo, la llamada se rechaza con CODE_PROJECT_BLOCKS_PARALLEL_ON_CURRENT_DEVICE (cuando deviceTarget es "currentDevice") o NO_OTHER_DEVICE_FOR_BLOCKING_CODE_PROJECT (cuando no hay otro dispositivo disponible).