ARGOS
Space shortcuts
Skip to end of metadata
Go to start of metadata



aiDocuDroid


Author   Takeshi Iwashima


Primary Features


This plugin makes an API request to aidocudroid.

 

aiDDwithARGOS-support (aiDDwithARGOS-support@konicaminolta.com)

Need help?

Technical trouble contact to tech@argos-labs.com


May you search all operations,


Version Control



Action Type

Action typeExplanationReturn value
File UploadUpload the specified file to aiDocuDroid and request OCR processingDocument Id or OCR result (JSON format)
Get ResultGet OCR result by specifying document IDOCR result (JSON format)
File DeleteDelete OCR results by document IDProcessing result
Save ResultOverwrite and save OCR result by specifying document IDProcessing result
Custom ActionsContact our support team for usage
Custom CorrectionContact our support team for usage
Custom OutputContact our support team for usage
Custom CsvConvertContact our support team for usage

Parameters

ParametersExplanation
Action TypeSelect action execution type
HostaiDocuDroid server host name
PortaiDocuDroid server port number
UserNameaiDocuDroid username
PasswordPassword for aiDocuDroid
Process TypeaiDocuDroid process type (floating or fixed)
LanguageaiDocuDroid OCR language setting (en or jp)
From id ListSet the form ID registered in aiDocuDorid
Dictionaly DataSet CSV file name for correcting OCR results
Action FlgSet Whether to Use Special Processing Settings
Upload File(path)Full path of the image file to OCR
Form IDForm Id specified when performing OCR
SyncOCR sync/async setting (True or False)
Document IDDocument ID of OCR file to be acquired or deleted or overwritten
Retry CountSets the maximum number of processing loops to obtain OCR results
Sleep TimeSet 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 IDSubfolder name in which the target JSON is stored in the OCR result folder
DelimiterCSV file separator setting (Comma or Tab)
Dictionaly Folder (name)Folder name where files for correcting OCR results are stored
Log FolderFull path of log file (txt format)


Input (Required)

File Upload:

​

Setting examples imageParametersRequired

Action Type*
Host*
Port*
UserName*
Password*
Process Type*
Language*
Upload File(path)*
Form ID
Sync*
Log Folder

​

Get Result:

​

Setting examples imageParametersRequired

Action Type*
Host*
Port*
UserName*
Password*
Process Type*
Language*
Document ID*
Retry Count*
Sleep Time*
Log Folder

​

File Delete:

​

Setting examples imageParametersRequired

Action Type*
Host*
Port*
UserName*
Password*
Process Type*
Language*
Document ID*
Log Folder

​

Save Result:

​

Setting examples imageParametersRequired

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:-

  1. 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.

  2. 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.

  3. 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.

  4. 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.

  5. 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

CodeMeaning
0Success
1Exceptional case

Output Format

You may choose one of 3 output formats below,

  • String (default)
  • CSV (Not Support)
  • File



All Plugins