OpenBots Studio Commands
OpenBots Studio contains multiple commands that allows users to create an automation that can interact with OpenBots Documents. These commands are included as part of the OpenBots.Commands.Documents Package. This package is not included in newly created projects by default and must be manually included by utilizing the Package Manager. Once installed, all the currently available commands will be made available to use by the user.
Here is a list of all of the commands currently available in OpenBots Studios for interacting with OpenBots Documents.
| Change Status | This command allows the automation to change the status of a document/task in OpenBots Documents. The TaskId of the task being updated must be provided and the following statuses are available for selection: Created In Progress Processed Awaiting Verification Verified Completed MarkedForDeletion Error Abandoned |
| Compare Tables | Allows automation to compare 2 tables cell-by-cell and reports on any mismatches that exist. Using this command, a user can specify which columns should be compared while performing the comparison as well as which ones should be ignored. A user can also provide the automation with a DataTable that contains the values that are expected and a DataTable where the search will be performed. This command will generate a DataTable containing the mismatched entries. |
| Get Document Status | This command allows automation to extract the current status of the specified task. This command also contains parameters that allows users to instruct the automation to wait for the status of the specified task to be changed to completed. When used in this manner, the automation will query OpenBots Documents every 10 seconds until either the status is set to completed or the timeout has been reached. |
| Mark Document As Verified | Marks the specified document in the task as ‘Verified’ status. Both the TaskId and the DocumentId must be provided. All other documents in the specified task will be marked for ‘Human Review’. |
| Save Document Results | Extracts and saves the results of a processed file system folder. This command will output the resulting status for the specified TaskId as well as the folder path where resulting text and documents are saved to. Contains options for instructing automation to wait for completion and whether the automation should page images and/or page text. |
| Submit Document | Command used to submit a file for processing by creating a new task in OpenBots Documents. |
