Check the document Version 1 (Net)
Group "Robin AI", subgroup "Document verification"
Description
Action through Preferentum library checks the document against the specified rule. The user can select a rule with default parameters from the dropdown list, or specify a config file that specifies personal parameters for the supported rule.
Action icon
Parameters and their settings
Property | Description | Type | Example | Mandatory field |
Parameters | ||||
Document | Path to the document file to be checked. Valid formats: doc, docx, xls, xlsx, csv, ppt, pptx, txt, rtf, pdf, html, odf, odt, ods, wps, wpd, xml | File Path | file.docx | |
Rule | Rule by which the specified document will be checked. If "User settings" is specified, the "User settings" field should be filled in Options:
| String |
| Yes |
User settings | Path to a cfg file that contains personalized parameters for the rule. Only one of the supported rules can be specified in the file. The file is considered only if " User settings" is selected in the "Rule" field | File path | file.cfg | No |
Folder path | Path to the folder where a new file will be created containing the source document with the comments received during its verification | Folder path | Yes | |
File name | The name of the file (without extension) to which the original document with the comments received during its verification will be written | String | result | Yes |
Overwrite | If the value is "true" and a file with the same name and extension exists in the specified folder, the new file will overwrite it. If "false", the file will not be overwritten and the action will return an error | Boolean | yes | No |
Timeout, ms | Limit time to wait for the check result. It is specified in milliseconds | Numeric | 10000 | No |
Results | ||||
Document with notes | Path to the file containing the source document with the comments received during its verification. If the format of the source document is "docx", the file "docx" will be created. If the format is "xlsx", the file "xlsx" will be created. If the format of the source document is different, the file "html" will be created | File path | ||
Notes | Table with a list of comments received during document verification. The first column is the beginning of the range of text to which the remark refers. The second column is the end of the range. The third column is a description of the remark | Table |
Special conditions of use
Path to the file where the document with the rule notes is written. The name of the file is taken from the "File name" parameter. The extension of the new file depends on the extension of the submitted document:
If a docx extension file is specified in "Document", a docx extension file will be created
If an xlsx extension file is specified in "Document", an xlsx extension file will be created
If files of other valid extensions are specified in "Document", a file of extension html will be created
Examples of documents: result.html, rs.xlsx, res.docx
If a 2003 version docx/xlsx extension file is specified in "Document", an htm extension file will be created.
"Notes" is a table where the first column is the beginning of the range of text to which the note applies, the second column is the end of the range, and the third column is a description of the note
Example:13 78 Probably meant "order". 525 543 The word "BLECK" contains an error or it is an un-dictionaried word.
If there are no notes in the document, a file without notes is created (source document). The action will return the path to this file and an empty table
Example of use
Task
It is necessary to check the document for spelling.
Solution
Use the "Validate document" action
Implementation
- Move the "Check the document" action to the workspace.
- Set the parameters with the correct data.
- Click on the "Start" button in the top panel.
Result
The program robot completed successfully. A file with remarks was saved in the specified folder. The action also created a table with remarks.