| aiDocuDroid |
|---|---|
Author Takeshi Iwashima Primary Features This plugin makes an API request to aidocudroid.
aiDDwithARGOS-support@konicaminolta.com) |
Version Control
Release Date:
September 29, 2022
Action Type
| Action type | Explanation | Return value |
|---|---|---|
| File Upload | Upload the specified file to aiDocuDroid and request OCR processing | Document Id or OCR result (JSON format) |
| Get Result | Get OCR result by specifying document ID | OCR result (JSON format) |
| File Delete | Delete OCR results by document ID | Processing result |
| Save Result | Overwrite and save OCR result by specifying document ID | Processing result |
| Custom Actions | Contact our support team for usage | |
| Custom Correction | Contact our support team for usage | |
| Custom Output | Contact our support team for usage | |
| Custom CsvConvert | Contact our support team for usage |
Parameters
| Parameters | Explanation |
|---|---|
| Action Type | Select action execution type |
| Host | aiDocuDroid server host name |
| Port | aiDocuDroid server port number |
| UserName | aiDocuDroid username |
| Password | Password for aiDocuDroid |
| Process Type | aiDocuDroid process type (floating or fixed) |
| Language | aiDocuDroid OCR language setting (en or jp) |
| From id List | Set the form ID registered in aiDocuDorid |
| Dictionaly Data | Set CSV file name for correcting OCR results |
| Action Flg | Set Whether to Use Special Processing Settings |
| Upload File(path) | Full path of the image file to OCR |
| Form ID | Form Id specified when performing OCR |
| Sync | OCR sync/async setting (True or False) |
| Document ID | Document ID of OCR file to be acquired or deleted or overwritten |
| Retry Count | Sets the maximum number of processing loops to obtain OCR results |
| Sleep Time | Set the loop processing wait time in seconds |
| Root Folder (path) | Folder name where OCR result folder exists |
| Result Folder (name) | OCR result folder name |
| Output Folder (name) | Folder name to store the processing result of the plug-in |
| Process ID | Subfolder name in which the target JSON is stored in the OCR result folder |
| Delimiter | CSV file separator setting (Comma or Tab) |
| Dictionaly Folder (name) | Folder name where files for correcting OCR results are stored |
| Log Folder | Full path of log file (txt format) |
Input (Required)
File Upload:
| Setting examples image | Parameters | Required |
|---|---|---|
| Action Type | * |
| Host | * | |
| Port | * | |
| UserName | * | |
| Password | * | |
| Process Type | * | |
| Language | * | |
| Upload File(path) | * | |
| Form ID | ||
| Sync | * | |
| Log Folder |
Get Result:
| Setting examples image | Parameters | Required |
|---|---|---|
| Action Type | * |
| Host | * | |
| Port | * | |
| UserName | * | |
| Password | * | |
| Process Type | * | |
| Language | * | |
| Document ID | * | |
| Retry Count | * | |
| Sleep Time | * | |
| Log Folder |
File Delete:
| Setting examples image | Parameters | Required |
|---|---|---|
| Action Type | * |
| Host | * | |
| Port | * | |
| UserName | * | |
| Password | * | |
| Process Type | * | |
| Language | * | |
| Document ID | * | |
| Log Folder |
Save Result:
| Setting examples image | Parameters | Required |
|---|---|---|
| Action Type | * |
| Host | * | |
| Port | * | |
| UserName | * | |
| Password | * | |
| Process Type | * | |
| Language | * | |
| Upload File(path) | * | |
| Document ID | * | |
| Root Folder (path) | * | |
| Result Folder (name) | * | |
| Process ID | * | |
| Log Folder |
Note:-
Form ID parameter can be optionally set when "File Upload" is selected for Action Type. If you uncheck the parameter or "auto" or blank in the text box, the form will be identified automatically and OCR will be executed. By entering the target Form ID in the text box, form identification is performed with that Form ID and OCR is executed.
Sync parameter is set when "File Upload" is selected for ActonType. When Sync is set to True, OCR of aiDocuDorid is executed synchronously and the OCR result (JSON format) is returned. When Sync is set to False, aiDocuDorid's OCR is executed asynchronously and the document ID of the target file is returned.
Set Retry Count parameter and Sleep Time parameter when "Get Result" is selected for Action Type. When executing OCR processing, aiDocuDroid may take a long time to process, so it is necessary to loop the processing inside the plug-in until OCR is completed. Retry Count sets the maximum number of loops for processing, and Sleep Time sets the waiting time before the next loop processing to reduce the processing load.
The path of the target JSON file set in "Save Result" of Action Type Paths are combined internally as shown "Root Folder (path)/Result Folder (name)/Process ID/Upload File(path)". Check the "Input (Required)" table for a description of each parameter.
Use the LogFolder parameter if you want to output logs for this plugin. Specify the full path of the txt file for this parameter.If you do not want to output logs, you do not need to set this parameter.
Return Value
Normal Case
Description of the output result
Return Code
| Code | Meaning |
|---|---|
| 0 | Success |
| 1 | Exceptional case |
Output Format
You may choose one of 3 output formats below,
- String (default)
- CSV (Not Support)
- File