Get Status tool - ABBYY Documentation

The Get Status tool retrieves the processing status of transactions from ABBYY Vantage. Pass a data table containing one or more rows in the Input anchor. Each row should contain one transaction identifier. The tool returns the statuses of all transactions. To poll for status until a transaction is processed, include Get Status inside a macro. See the Sample process for an example.

Connection settings

The Get Status tool includes the connection settings described in Configure the connection.

Input anchor

Column	Type	Description
TransactionId	V_WString	The identifier of the transaction created by the Use Skill tool.

Input example:

Get Status input table showing five rows of TransactionId GUID values

Output anchor

Column	Type	Description
TransactionId	V_WString	The identifier of the transaction.
Status	V_WString	The status of the transaction. Possible values: `New`, `Processing`, `Processed`, `Failed`, `Canceled`.
ManualReviewLink	V_WString	A link to the ABBYY Vantage Manual Review Client where the transaction results can be reviewed. Available only if the Process Skill used contains a Review activity.
isSuccess	Bool	Indicates whether the status was successfully retrieved.
Error	V_WString	Specifies the error message that occurred while processing the transaction (when the transaction status is `Failed`).

Output example:

Get Status output table showing five transactions with varying Status values including Processed, Failed, Processing, and New

​Connection settings

​Input anchor

​Output anchor

​Related topics

Connection settings

Input anchor

Output anchor

Related topics