Get recognition status Version 1 (Net)
Action group: Robin OCR Subgroup Soica
Description
The action retrieves from the SOICA service the recognition status of sent documents, as well as the IDs of packages ready for export.
Action icon
Settings of parameters
Property | Description | Type | Filling example | Mandatory field |
Parameters | ||||
URL | Link for authentication on the SOICA service. | Robin.String | Yes | |
Login | Login ID. | Robin.String | Yes | |
Password | Password to log in. | Robin.Password | Yes | |
Starting date | The date from which the documents were sent for recognition. If the field is not filled in, the starting date will be the date of sending the very first document to the server. | Robin.DateTime | No | |
Deadline date | The date by which the documents were sent for recognition. If the field is not filled in, the deadline date will be the current date. | Robin.DateTime | No | |
Timeout, ms | The time in milliseconds that the action will wait for a response from the server. | Robin.Numeric | No | |
Results | ||||
ID of finished documents | A collection of document identification numbers that are ready for export. | Robin.Collection | ||
Status table | A table containing data on documents sent for recognition within a specified time range. | Robin.DataTable |
Special conditions of use
It is necessary to get authentication data in advance in the SOICA service.
The action will give:
error 403 "Invalid connection login or password" if an invalid connection login or password is specified;
error 404 "Invalid address for authentication on the server" if the path or link is specified incorrectly.
General principles of SOICA operation can be viewed here: General principles of SOICA operation
Statuses:
- import - wait for status change to allow further processing;
- recognize - wait for status change;
- validation - manually change the status;
- export - you can launch the "Get the result of recognition" action;
- deleted - wait for status change;
- inaccessible - wait for status change;
- quality control - the file may hang here, if the user has sent the file according to the wrong script, it is necessary to manually check it.
Example of use
Task
Send a document for recognition and then get its recognition status and save these statuses in a CSV table.
Solution
Use the actions "Send for recognition", "Get recognition status", "Save table to CSV".
Implementation
Sequentially set the actions "Send to recognition", "Get recognition status" and "Table to CSV" to the workspace.
Set the action parameters with the correct data:
the parameters of the "Send for recognition" action;
parameters of the "Get recognition status" action.
parameters of the "Table to CSV" action.
Result
The robot completed successfully.
The robot will return a CSV file with the recognition statuses.