QueryWorklists
The QueryWorklists web service
XML- or JSON-based information exchange systems that use the Internet for direct application-to-application interaction. These systems can include programs, objects, messages, or documents. returns a list of the Worklists in CMP Converged Monetisation Platform. The MDS Global product that supports customer care and billing for digital service providers. to the client system, along with the number of open Workflow Events Manually or automatically created task items that drive and record activity within CMP. Sometimes referred to as Diary Events. in each Worklist and a count of breached or overdue Workflow Events (that is, those events whose Resolution Required By dates and times have passed). Open Workflow Events are those which require user A person with the capability to log in to the CMP GUI software, such as a customer service advisor or agent. intervention.
The Worklists are returned in ascending order of Department and User ID. If a user has no open Workflow Events then they are excluded from the results.
If there are no Worklists in the CMP database, then the web service returns no Worklists.
A query limit is configured for this web service. This must be set to a higher threshold than the number of users on the system so that the statistics on all users can be viewed.
QueryWorklists Request
The QueryWorklists tag instructs the Workflow Service to query the Worklists. This request contains the following elements:
|
Element Name |
Content Type |
Description |
Required? |
|
ExternalReference |
String69 |
The client may use this identifier to correlate the request and the response. |
Optional |
|
ResolutionRequiredByDate |
DateTime |
If supplied, this is used to determine if an Workflow Event is overdue. Defaults to the current date and time if not supplied. |
Optional |
|
Department |
String6 |
The Department Code, for example SYSTEM, associated with the user profile. |
Optional |
QueryWorklists Response
The QueryWorklists response is the response to the QueryWorklists request. This contains the following elements:
|
Element Name |
Content Type |
Description |
Required? |
|
ExternalReference |
String69 |
Returned unmodified in the response. The client may use this identifier to correlate the request and the response. |
Optional |
|
Worklists |
Container |
See Worklists response container for details. |
Mandatory |
|
QueryLimitExceeded |
Boolean |
The CMP query web services can impose a configurable limit on the amount of data that can be returned by a query. |
Mandatory |
If the number of Worklists in CMP exceeds the query limit for this web service, then the number of Worklists actually returned in the response should be equal to the query limit and the Query Limit Exceeded flag will be set to 'true'.
Worklists Response Container
The Worklists response container has the following elements:
|
Element Name |
Content Type |
Description |
Required? |
|
Worklist |
Container |
See Worklist response container for details. |
Optional |
Worklist Response Container
The Worklist response container has the following elements:
|
Element Name |
Content Type |
Description |
Required? |
|
Department |
String6 |
The Department Code associated with the user profile. |
Mandatory |
|
UserID |
String10 |
The CMP User ID associated with the profile. |
Mandatory |
|
OpenEvents |
Integer |
The number of open Workflow Events. |
Mandatory |
|
OverdueEvents |
Integer |
The number of overdue Workflow Events. |
Mandatory |