General principles of working with ROBIN OCR

1. To send a document for recognition, at least 2 requests must be made. First, a request to create a package is sent, the only image of the package or the first image of the package is passed to the request. The request returns the GUID of the package. If there are several images in the package, then in subsequent requests these images are added to the package (one by one). The final request is to start the package for processing. The GUID of the created package is passed to the second and subsequent requests.

2. The format of the result is customized in advance, in the script.

3. The user will receive the result as a collection of json objects or xml-contexts. Studio actions can work with the obtained results.

4. The list of package classes the user needs to know before running the action.

5. Package classes will be configured in the system by the engineer, you need to select a class suitable for image processing. Package class name is the name of the customized project. Package class name must be specified when creating a package (mandatory). Package name must be specified in the request. 

6. When the robot finalizes an error, the error text will display the reason for the error. 

7. If the status of the document is not "export", the robot will not be able to get the result and will skip the document. The user himself will have to move the document to the "export" status on the server. It is necessary to validate the file manually and send it for export by making and accepting changes in it.

8. Statuses: 

   1. import - wait for status change
   2. recognize - wait for status change
   3. validation - manually change status in the Soika system
   4. export - ready for upload
   5. deleted - the package has been deleted 
   6. inaccessible - the package is unavailable
   7. quality control - if the user has sent by wrong script, manually change the status in the Soika system.
9. If the timeout expires before we get the recognized text an empty result will be obtained, the action will not terminate with an error.
   
   
   

Soika interface. 

Authentication

1. When connecting for the first time, you must log in through your browser, chrome is preferred. admin, admin.

2. To access rest-service functions, authentication is required - BasicHttpAuth, login and password are passed in the http header, with the login in plaintext and the password encrypted MD5.

3. You can save the account in the browser. the user only has access to certain actions, this is set during registration.

4. Two tabs open 2 modules at once. Administrator module: http://localhost/administrator. Validation module: http://localhost/validation. 

Authentication when connecting via browser is a mandatory procedure for each user. User personal login and password are linked to personal customized scripts.

Document review and validation

In default view with the Shift key held down, you can select an area to make edits to it. 

When the edits are applied, the changes are reflected in the system. 

When the user saved the changes, the document package was accepted by the user, the status of the document changed from "validation" to "export".

The file was validated manually. 

The file has been given the status "Export".

Ways of processing the result

Built-in studio actions to work with JSON - files.

An example of a composed chain of actions for processing the result. You can use Queues to parallelize image recognition processes. 

The package classes presented for the current user.

The default recognition profile is -default. Recognition profile configuration interface.

Example of a source file. 

Example of the resulting file.

Make a sequence of actions to save the file to the computer.

The result is in the form of a json file. There is no need to save the resulting file. It can be immediately processed by studio actions.

Studio actions if the result is received as an xml file. Then you can use the "Get items by XPath" action to get the values necessary for further work.

Send files for recognition action

The action sends the file to an external Soica application for recognition.

The first action in the Send+Receive bundle. Send file for recognition and Receive recognition result is split into 2 actions for cases when the system will take a long time to process a large input file. 

Settings

Login

Special conditions of use

1. You need to get the authentication details in advance from the Soika service.
2. If the server has not sent a response in 120 seconds, the server is unavailable.
3. The robot will return an error if:
   1. an incorrect format is entered in the "File" field.
   2. incorrect login or password for the connection, link -403
   3. wrong path, link - 404

Get recognition result action

Extract text from an image file using a pre-configured recognition profile.

Settings

Login

Special conditions of use

1. It is necessary to run the "Send for recognition" action before the "Get recognition result" action.
2. To get the result, the file must be recognized by the system and set to the "export" status. If the robot has received any status other than "export" when checking the document status, the robot will return the received document status and an empty recognition result file.
3. If the server has not sent a response in 120 seconds, the server is unavailable.
4. The robot will return an error if:
   1. wrong path, link - 404
   2. Incorrect login or password for connection, link -403
   3. the selected processing script is not suitable, link -401
   4. internal server error, link -500.
   5. personal data and document ID do not belong to the same user.

Login

1. The robot will return an error if:
   1. wrong path, link - 404
   2. Incorrect login or password for connection, link -403
   3. the selected processing script is not suitable, link -401
   4. internal server error, link -500.
   5. personal data and document ID do not belong to the same user
2. If no timeout is specified, 1 status request is called. If a timeout is specified and no result is received at the end of the timeout, the last known status and an empty result will be returned.

Examples of use

Send + receive

Task 

Recognize the text on the document and retain the ability to perform any other actions while the input document is being processed.

Solution

Use the actions "Send for recognition", "Get the result of the recognition". 

Implementation

1. Sequentially set the "Send for recognition" and "Get the result of the recognition" actions to the workspace.
2. Fill in the action parameters with the correct data:
   1. "Send for recognition" parameters; 
      
       
   2. "Get the result of the recognition" parameters. 
      
   
   
3. Launch the robot using the "Start" button in the top panel.
   

Result

The robot will return the processed files. The result is represented as a collection with json objects or xml contexts. Export status.

Recognize

Task

Recognize text in a document.

Solution

Use the action "Recognize". 

Implementation

1. Set the "Recognize" action to the workspace.

2. Fill the action parameters with correct data. 
   

3. Launch the robot using the "Start" button in the top panel.
   

Result

The robot returned the processed files. The result is represented as a collection with json objects or xml contexts. Export status.