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
Input parameters
| Name | Description |
|---|---|
| Document | The document that will be checked by the rule. Valid extensions: doc, docx, xls, xlsx, csv, ppt, pptx, txt, rtf, pdf, html, odf, odt, ods, wps, wpd, xml |
| Rule | A dropdown list with rules for validating a document. List items: Special combinations, Dates, Money, Repetitions, Geography, Persons and organizations, Structure, Spelling, Custom parameters. If "Custom settings" is selected, you must fill in the "Custom settings" field |
| User settings | Path to the config file where the parameters for the rule are written. The rule must be in the list of supported rules. If the user needs to specify custom parameters, then in the "Rule" field it is necessary to select "Custom parameters". Config file must contain parameters of only one rule and must be in cfg format. The field will be ignored if the "Rule" specifies parameters other than "Custom parameters". |
| Folder path | The path to the folder where the new file will be written. The file will include the rule's annotation document |
| File name | The name for the new file to which the rule notes document will be written. The following characters are not allowed in the name \/:* ?"<>| + |
| Overwrite | Boolean parameter. If "true" and a file with the same name and extension exists in the specified folder, the new file will overwrite it. If "false", the document will not be overwritten and the action will return an error. |
| Timeout, ms | Limit time to wait for a response. Measured in milliseconds. It can be any number. Minus in negative numbers will be ignored. Timeout starts counting from the moment the Preferentum library is running |
Output parameters
| Name | Description | ||||||
|---|---|---|---|---|---|---|---|
| Document with notes | - 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:
|
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
None.
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.
Обзор
Инструменты контента