Doc extraction runs can only be queried by a user with access to the original document, started by the Start Doc Extraction Smart Service.
The Appian Document Extraction page walks you through how to use document extraction functionality together in a process model. See the following list for the other smart services and functions you need to use with the Doc Extraction Status Function:
a!docExtractionStatus( docExtractionId )
Retrieves the status of a doc extraction run started by the Start Doc Extraction Smart Service.
Keyword | Type | Description |
---|---|---|
|
Integer |
ID of the doc extraction run. In order to check the status, a run must first be started by the Start Doc Extraction smart service. |
The following statuses can be returned:
COMPLETE
: Analysis is done and Appian has downloaded the results, you can now proceed to extract results using a!docExtractionResult() or Reconcile Doc Extraction Smart Service.IN PROGRESS
: Analysis is still in progress. Appian recommends checking again in 60 seconds.INVALID ID
:
ERROR
: Internal evaluation error happened during processing.
a!docExtractionStatus(docExtractionId: 25)
Where 25 is a valid docExtractionId.
See the Appian Document Extraction page for a full end to end example.
The doc extraction status can only be accessed by a user who has permissions to the original document.
Appian will delete document extraction runs after 30 days, or when the total amount of data surpasses 10 GB. If you attempt to access a run that has been deleted, you will see INVALID ID
.
Feature | Compatibility | Note |
---|---|---|
Portals | Partially compatible | Can be used with Appian Portals if it is connected using an integration and web API. |
Offline Mobile | Partially compatible | Can be used with offline mobile if it is loaded at the top of the form. |
Sync-Time Custom Record Fields | Incompatible | |
Real-Time Custom Record Fields | Incompatible | Custom record fields that evaluate in real time must be configured using one or more Custom Field functions. |
Process Reports | Incompatible | Cannot be used to configure a process report. |
Process Events | Incompatible | Cannot be used to configure a process event node, such as a start event or timer event. |
docExtractionStatus() Function