Skip to main content
Docs
Go to the Studio
Roberty Studio
RPAMy robot

Run IDP template

Run IDP template

Sends a file from the device running the robot to an IDP template of the workspace, waits for the processing to finish and returns the full IDP result: pre-processing, identification, extraction, post-processing and validations.


Options​

IDP template​

IDP template of the workspace that will process the file.

File path​

Path of the file on the device running the robot, for example C:\Documents\invoice.pdf. The file must be a PDF or an image (png, jpg, jpeg, webp, tiff, tif, bmp). Accepts text, another action's output, a parameter or code.

Advanced options​

Pages to work on​

Pages of the file to be processed, for example 1-3, 5. Overrides the pages set in the template and is only accepted when the template allows choosing pages through the API. Optional field.

Parameters​

Object with the template's parameters, for example { "cliente": "ACME" }. Optional field.

Timeout​

Maximum time, in milliseconds, the action waits for the IDP result. The default value is 600000 (10 minutes). Use 0 to wait indefinitely.

Returns​

Javascript code​

js
actions["action-id"].requestId // run identifier in IDP (Text)
actions["action-id"].result    // full IDP result (Any)

Field selection​

  • requestId — run identifier in IDP (Text)
  • result — full IDP result: pre-processing, identification, extraction, post-processing and validations (Any)

Rules and conditions​

  • The IDP template, File path and Timeout fields are required.
  • If the file does not exist on the device, the action fails with the FILE_NOT_FOUND error; if the file upload fails, with the UPLOAD_FAILED error.
  • While waiting, the action checks the processing status every 2 seconds.
  • If the processing ends with an error, the action fails with the IDP error message. If the run expires, the action fails with the EXPIRED error.
  • If the Timeout is reached before the processing ends, the action fails with the TIMEOUT error.