Get Document Status Steps
- 05 Oct 2023
- 1 Minute to read
- Print
- DarkLight
Get Document Status Steps
- Updated on 05 Oct 2023
- 1 Minute to read
- Print
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
| Step Details | |
| Introduced in Version | 8.15 |
| Last Modified in Version | -- |
| Location | Integration > TruCap+ > Document |
Currently, there are four Steps to retrieve the current document status from the TruCap+ application. Each step uses a unique parameter. The following table describes all the four steps.
Prerequisites
- This step requires the TruCap+ Module to be installed before it will be available in the toolbox.
- The TruCap+ application must be configured with an active license to run the TruCap+ Steps.
| Step Name | Description |
|---|---|
| Get Document Status By Client Transaction Number | Retrieves the current status of the document based on the Client Transaction Number |
| Get Document Status By Document ID | Retrieves the current status of the document based on document ID |
| Get Document Status By Label | Retrieves the current status of the document based on the document label |
| Get Document Status By Reference Number | Retrieves the current status of the document based on the reference number |
Properties
Inputs
| Property | Description | Data Type |
|---|---|---|
| Authentication** | When the user is Logged in to the TruCap+ application, the application will return a response that includes the Security Identifier (SID) and Token. Users need to pass the received SID and Token in this field. | TruCapAuthentication |
| Client Transaction Number* | Client transaction number associated with the file | String |
| Document ID* | Document ID associated with the file | String |
| Label* | Label associated with the file | String |
| Reference Number* | Reference Number of the document | String |
**This is a common input field across all four steps.
*These are unique input fields across each of the four steps.
Settings
| Property | Description | Data Type |
|---|---|---|
| Override Base URL | URL to override the Base URL configured in Settings. This can be used if you want to use multiple instances of the TruCap+ application. | String |
Outputs
| Property | Description | Data Type |
|---|---|---|
| Done > Output | This will retrieve the current Status of the document. | DocumentDataResponse |
Related Articles:
TruCap+: This article gives a detailed overview of the Module.
Was this article helpful?
