Get Document Monitor List By Document Header ID/Name/Parent ID
- 05 Oct 2023
- 1 Minute to read
- Print
- DarkLight
Get Document Monitor List By Document Header ID/Name/Parent ID
- 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 Monitor |
This article covers 3 steps users can use to retrieve the Document Monitor List. Each step uses a unique parameter. The following table describes all the three 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 Monitor List By Document Header Id | Retrieves the list of documents based on its Document ID from the document monitor |
| Get Document Monitor List By Document Name | Retrieves the list of documents based on its Document Name from the document monitor |
| Get Document Monitor List By Parent Id | Retrieves the list of documents based on its Parent ID from the document monitor |
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 |
| Document ID* | Enter the Document ID | Int32 |
| Document Name* | Enter the Name of the Document | String |
| Parent ID* | Enter the Parent ID of the Document | Int32 |
**This is a common input field across all three steps.
*These are unique input fields across each of the three 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 following list of document details:DocumentID, Category, Project, Subtype, DocumentName, ParentID, CurrentStage, Duration, DateReceived, Prioritized, UserAllocated, ReadabilityScore, NextAction, and CurrentStageCode. | List of DocumentMonitorResponse |
Related Articles:
TruCap+: This article gives a detailed overview of the Module.
Was this article helpful?
