WorkflowService
The information in this section corresponds to the CMP
Converged Monetisation Platform. The MDS Global product that supports customer care and billing for digital service providers. Toolbox web services as specified in the workflowservice.wsdl.
The following web services are included:
- Create Workflow
- Query Workflow
- Query Workflows
- Update Workflow
- Query Worklists
- Query Worklist
- Create Sales Ledger Adjustment
- Delete Sales Ledger Adjustment
CreateSalesLedgerAdjustment
The CreateSalesLedgerAdjustment 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. enables an external client system to add a Sales Ledger Adjustment to an existing Workflow Event within CMP.
Sales Ledger Adjustments are created as follows:
- The Workflow Event is created.
- One or more credit and/or debits are added.
- The Workflow Event is processed.
- Processing the workflow event uses the credit/debit details to create pending invoices.
- Non-Subscription Invoice Production converts the pending invoices into normal invoices.
- Invoice posting updates the ledgers, which adjusts the Account
In the Cloud Monetisation Platform, a billing entity that can be used to manage payments on one or more subscriptions or payments for services. An account can hold details such as payments or invoices. Balance.
CreateSalesLedgerAdjustment Request
The CreateSalesLedgerAdjustment tag instructs the Workflow Service to create a Sales Ledger Adjustment. This tag 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 |
|
EventNumber |
Integer9 |
Unique number associated with the Workflow Event. |
Mandatory |
|
ServiceCode |
String6 |
This details the code attributed to the Service as it appears on the invoice. |
Mandatory |
|
SubscriptionNumber |
String8 |
The unique system generated reference number for the Subscription. |
|
|
ChargedStartDate |
date |
This displays the date that the charge started. YYYY-MM-DDZ |
Optional |
|
ChargedEndDate |
date |
This displays the date that the charge ended. YYYY-MM-DDZ |
Optional |
|
NetAmount |
Currency |
A positive amount indicates a Debit. A negative amount indicates a Credit. Cannot be zero |
Mandatory |
|
ChargeToNominalCode |
String29 |
If not supplied, this defaults to the Service Code's default Nominal Code. |
Optional |
|
TaxRateAtStart |
Boolean |
This is usually set to 'False'. |
Optional |
|
Comments |
String |
Any specific comments in relation to the credit/debit. |
Optional |
CreateSalesLedgerAdjustment Response
The CreateSalesLedgerAdjustment response is the response to the CreateSalesLedgerAdjustment 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 |
CreateWorkflow
The CreateWorkflow web service enables an external client system to create a Workflow Event on a CMP Subscription
A billing entity that incurs a charge. Examples include a network attached device whose usage you want to measure and charge for, or a monthly software subscription, Account, Corporate, Group or Agreement
In the Cloud Monetisation Platform, the entity that holds the instructions for generating the bills for one or more subscriptions. including the addresses and how often the bill is generated..
The user
A person with the capability to log in to the CMP GUI software, such as a customer service advisor or agent. must pass in a valid CMP workflow event type and code and the hierarchy level and reference number to add the Workflow Event. The web service automatically instructs CMP how to process the Workflow Event.
The user can submit additional Workflow Event parameters as part of the web service request.
The web service returns a Workflow Event Number.
Submission of invalid data for the above criteria results in an error message.
CreateWorkflow Request
The CreateWorkflow tag instructs the Workflow Service to create a Workflow Event. 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 |
|
WorkflowData |
Container |
See WorkflowData request container for details. |
Mandatory |
|
AuditRecord |
Container |
See AuditRecord request container for details. |
Optional |
WorkflowData Request Container
The WorkflowData request container has the following elements:
|
Element Name |
Content Type |
Description |
Required? |
|---|---|---|---|
|
TargetIdentifier |
Container - Choice |
Choice of one of the following elements:
|
Mandatory |
|
EventTypeCode |
String4 |
The specific Event Type configured in CMP associated to the Workflow Event to be raised. |
Mandatory |
|
EventCode |
String4 |
The specific Event Code configured in CMP associated to the Workflow Event to be raised. |
Mandatory |
|
ProcessCommand |
Container - Choice |
Choice of:
|
Mandatory |
|
ProcessDate |
Date |
The date on which the Workflow Event is processed. YYYY-MM-DD |
Optional |
| ProcessDateTime | Date Time |
The date and time on which the Workflow Event is processed. YYYY-MM-DDThh:mm:ss If a value is supllied, this overrides the value for ProcessDate. |
Optional |
|
ProcessBackdate |
Date |
YYYY-MM-DD |
Optional |
|
ContactInformation |
String |
The name of the person to be contacted in the event of queries in relation to the specific Workflow Event. If left blank and Workflow Event raised at Subscription level, the User Name held at this level is defaulted. If left blank and Workflow Event raised at any other level, the field remains blank. |
Optional |
|
TelephoneNumber |
String15 |
The telephone number of the person to be contacted in the event of queries. |
Optional |
|
ResolutionRequiredByDate |
Date |
The date by which the Workflow Event must be resolved or the date when the Workflow Event must be processed. YYYY-MM-DD |
Optional |
| ResolutionRequiredByDateTime | Date Time |
The date and time by which the Workflow Event must be resolved or the date and time when the Workflow Event must be processed. YYYY-MM-DDThh:mm:ss If no value is supplied, this defaults to midnight. If a value is supplied, it overrides the value for ResolutionRequiredByDate |
Optional |
|
ReasonCode |
String4 |
The reason the Workflow Event was raised. For example, customer request. |
Optional |
|
PassToUserId |
String |
The CMP user or department to whom the Workflow Event has been or is to be sent. |
Optional |
|
IncludeNotesDefault |
Boolean |
Set to 'true' if the notes are included on the workflow by default. |
Optional |
|
Notes |
String |
This displays any notes attached to the Workflow Event. |
Optional |
AuditRecord Request Container
The AuditRecord request container has the following elements:
|
Element Name |
Content Type |
Description |
Required? |
|---|---|---|---|
|
UserID |
String10 |
User ID associated with the profile. This is the ID which the calling program adds to the records that are created. |
Mandatory |
|
Program |
String10 |
The program name should be hard coded in the calling application to uniquely identify that application. |
Mandatory |
CreateWorkflow Response
CreateWorkflow response is the response to the CreateWorkflow 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 |
|
EventNumber |
Integer9 |
Unique number associated with the Workflow Event raised. |
Mandatory |
DeleteSalesLedgerAdjustment
The DeleteSalesLedgerAdjustment web service enables an external system to remove a Sales Ledger Adjustment from a Workflow Event within CMP.
DeleteSalesLedgerAdjustment Request
The DeleteSalesLedgerAdjustment tag instructs the Workflow Service to remove a Sales Ledger Adjustment. This tag 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 |
|
WorkflowEventNumber |
Integer9 |
Unique number associated with the Workflow Event. |
Mandatory |
|
LineNumber |
Integer5 |
Identifies the Sales Ledger Adjustment line to remove (can be identified via the QueryWorkflow request). |
Mandatory |
RemoveSalesLedgerAdjustment Response
The RemoveSalesLedgerAdjustment response is the response to the RemoveSalesLedgerAdjustment 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 |
QueryWorkflow
Every Workflow Event has a status associated with it. The QueryWorkflow web service enables an external client system to retrieve Workflow Event Summary details for an individual Workflow Event in order to check this status.
Every CMP Workflow Event has a unique Workflow Event Number, which is generated when the Workflow Event is created.
One or more datasets can be specified in the QueryWorkflow to retrieve different information about a Workflow Event.
It is possible to query and retrieve Linked Workflow Events
Manually or automatically created task items that drive and record activity within CMP. Sometimes referred to as Diary Events. which are triggered automatically by the successful completion of another Workflow Event. Linked Workflow Events are configured to be automatically processed in a defined sequence which is halted if any of the actions fail.
QueryWorkflow Request
The QueryWorkflow request tag instructs the Workflow Service to query CMP for the details of one specific Workflow Event. 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 |
|
EventNumber |
Integer9 |
Unique number associated with the Workflow Event. |
Mandatory |
|
Dataset |
Container - Choice |
1 or more repetitions of the following datasets can be specified:
|
Mandatory |
If the ADDRESS dataset is specified, the QueryWorkflow response only returns an address if the Delivery Address Override has been set on the Workflow Event record.
QueryWorkflow Response
The QueryWorkflow response is the response to the QueryWorkflow 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 |
|
WorkflowBasic |
Container |
See WorkflowBasicData response container for details. |
Optional |
|
ContactDetails |
Container |
See ContactDetails response container for details. |
Optional |
|
Address |
Container |
See Address response container for details. |
Optional |
|
Notes |
Container |
See Notes response container for details. |
Optional |
|
Adjustments |
Container |
See AdjustmentData response container for details. |
Optional |
|
LinkedEvents |
Container |
See LinkedEvents response container for details. |
Optional |
WorkflowBasic Response Container
The WorkflowBasic response container has the following elements:
|
Element Name |
Content Type |
Description |
Required? |
|---|---|---|---|
|
EventNumber |
Integer9 |
Unique number associated with the Workflow Event. |
Mandatory |
|
CustomerLevel |
String |
Valid values are:
|
Mandatory |
|
CustomerLevelReference |
String8 |
The appropriate unique reference for the CustomerLevel selected. For example: Subscription Number, Agreement Number, Corporate Code, Group Code or Account Number. |
Mandatory |
|
EventStatus |
String |
The current status of the Workflow Event. |
Mandatory |
|
CurrentUserId |
String |
The User ID of the last user who updated the Workflow Event. |
Optional |
|
EventType |
String4 |
The specific Event Type configured in CMP associated to the Workflow Event to be raised. |
Mandatory |
|
EventCode |
String4 |
The specific Event Code configured in CMP associated to the Workflow Event to be raised. |
Mandatory |
|
DeliveryAddressNumber |
Integer8 |
This details the Delivery Address Number which is one of the several Delivery Addresses available in the CMP. |
Mandatory |
|
ReasonCode |
String4 |
The reason the Workflow Event was raised. |
Optional |
|
ResolutionData |
Container |
See ResolutionData response container for details. |
Mandatory |
|
LastAmendedDate |
DateTime |
YYYY-MM-DDThh:mm:ssZ |
Optional |
|
CreatedDate |
DateTime |
Workflow Event creation date. YYYY-MM-DDThh:mm:ssZ |
Mandatory |
ResolutionData Response Container
The ResolutionData response container has the following elements:
|
Element Name |
Content Type |
Description |
Required? |
|---|---|---|---|
|
ResolvedByUserId |
String |
The ID of the user who resolved the workflow event. |
Optional |
|
ResolvedDate |
Date |
The date on which the workflow was resolved. YYYY-MM-DDZ |
Optional |
|
ResolvedDateTime |
DateTime |
The date and time on which the Workflow Event was resolved. YYYY-MM-DDThh:mm:ssZ |
Optional |
|
ResolutionReqByDate |
DateTime |
The date by which the event must be resolved or the date when the event must be processed. This field contains a drop-down calendar to aid date selection, if required. YYYY-MM-DDZ |
Optional |
|
ProcessedDate |
Date |
The date on which the workflow is processed. YYYY-MM-DDZ |
Optional |
|
OverrideActionDate |
Date |
If a network action has occurred which is mirrored in CMP the non-network action can be backdated in order that it matches with the network date. YYYY-MM-DDZ |
Optional |
ContactDetails Response Container
The ContactDetails response container has the following elements:
|
Element Name |
Content Type |
Description |
Required? |
|---|---|---|---|
|
ContactName |
String30 |
This contains details of the person within the customer's organisation who manages the account. The name of a person to be contacted in the event of queries |
Optional |
|
ContactTelephoneNumber |
String15 |
The contact's telephone number. |
Optional |
|
ContactExtension |
String15 |
The contact's telephone extension number, if any. |
Optional |
|
LastAmendedDate |
DateTime |
YYYY-MM-DDThh:mm:ssZ |
Optional |
Address Response Container
The Address response container has the following elements:
|
Element Name |
Content Type |
Description |
Required? |
|---|---|---|---|
|
AddressNumber |
Integer |
The Subscription level delivery address number. |
Optional |
|
PersonalAddress |
Container |
The PersonalAddress container is returned when populated in CMP. |
Optional |
|
BusinessAddress |
Container |
The BusinessAddress container is returned when populated in CMP. |
Optional |
|
Last Amended Date |
dateTime |
The date and time at which the Subscription was last amended. YYYY-MM-DDThh:mm:ssZ |
Optional |
Only one address type, personal or business, can be set up at any one time. Therefore only the address that is populated in CMP is returned when an Account is queried specifying the ADDRESS dataset.
PersonalAddress Response Container
|
Element Name |
Content Type |
Description |
Required? |
|---|---|---|---|
|
Title |
String10 |
The customer's appropriate title for example Mr, Mrs, Miss, Ms or Dr. This field is always mandatory but can be made optional via configuration if required. |
Mandatory |
|
Forename |
String50 |
Customer's first name. |
Optional |
|
MiddleName |
String20 |
Customer's middle name. |
Optional |
|
Surname |
String50 |
Customer's surname. |
Mandatory |
|
Address1 |
String60 |
Line one of the customer's address. |
Mandatory |
|
Address2 |
String60 |
Line one of the customer's address. |
Optional |
|
Address3 |
String60 |
Line one of the customer's address. |
Optional |
|
Address4 |
String60 |
Line one of the customer's address. |
Optional |
|
Address5 |
String60 |
Line one of the customer's address. |
Optional |
|
Postcode |
String10 |
Customer's post code. Must be entered without spaces. |
Optional |
|
DateOfBirth |
Date |
Customer's date of birth, in the format YYYY-MM-DD. |
Optional |
|
Gender |
String |
Choice of: Male, Female, Unknown or BLANK. |
Optional |
|
MaritalStatus |
String |
Choice of: Married, Single, Widowed, Divorced, Other, Seperated or BLANK. |
Optional |
|
DateOfResidence |
Date |
The date from which the customer has lived at the address specified, in the format YYYY-MM-DD. |
Optional |
|
CustomerType |
String10 |
Selected from one of the available Customer Types configured in CMP. |
Optional |
|
AddressType |
String10 |
Identifies if the customer is a home owner, renting, living with parents, council tenant etc. Configurable CMP list. |
Optional |
|
AddressCategory |
String10 |
Indicates property value. A category range relating to the address. Configurable CMP list. |
Optional |
|
Occupation |
String10 |
The customer's current occupation. Configurable CMP list. |
Optional |
|
IDType |
String10 |
The available type of ID used as proof of identity for example passport or driving license. Configurable CMP list. |
Optional |
|
IDNumber |
String30 |
The unique ID from the proof of identity. |
Optional |
|
TelephoneNumber |
String15 |
Customer's main contact telephone number. |
Optional |
|
EveningTelephoneNumber |
String15 |
Customer's additional telephone number they can be reached on. |
Optional |
|
FaxNumber |
String15 |
Customer's fax number. |
Optional |
CMP configuration controls which elements are mandatory and optional. Standard validation settings can be changed via setup: DISESETUP > 5. Subscriber Registration Set up > 15. Delivery Address Set Up > 8. Field Validation Maintenance. Enter 'P' for Personal Address.
BusinessAddress Response Container
|
Element Name |
Content Type |
Description |
Required? |
|---|---|---|---|
|
CompanyName |
String60 |
Name of company. |
Mandatory |
|
Address1 |
String40 |
Line one of the company's address. |
Mandatory |
|
Address2 |
String40 |
Line two of the company's address. |
Optional |
|
Address3 |
String40 |
Line three of the company's address. |
Optional |
|
Address4 |
String40 |
Line four of the company's address. |
Optional |
|
Address5 |
String40 |
Line five of the company's address. |
Optional |
|
Postcode |
String10 |
Company's postcode. Must be entered without spaces. |
Optional |
|
CompanyTelephoneNumber |
String15 |
Company's main contact telephone number. |
Optional |
|
ContactTelephoneNumber |
String15 |
The individual's contact telephone number. |
Optional |
|
FaxNumber |
String15 |
Company's fax number |
Optional |
|
CompanyType |
String10 |
Indicates the type of company. Configurable CMP list. |
Optional |
|
AddressType |
String10 |
Identifies the company's address. Configurable CMP list. |
Optional |
|
AddressCategory |
String10 |
Indicates property value. A category range relating to the address can be configured. Configurable CMP list. |
Optional |
|
IndustrialClassificationCode |
String10 |
Indicates the industry the company resides. |
Optional |
|
CompanyRegistration |
String25 |
Unique ID the company is registered to. |
Optional |
|
DateOfIncorporation |
Date |
The date the company register at the address specified, in the format YYYY-MM-DD. |
Optional |
|
Title |
String10 |
Company's contact title. |
Optional |
|
Forename |
String15 |
Company's contact first name. |
Optional |
|
MiddleName |
String10 |
Company's contact middle name. |
Optional |
|
Surname |
String25 |
Company's contact surname name. |
Optional |
|
JobTitle |
String30 |
Company's contact job title. |
Optional |
CMP configuration controls which elements are mandatory and optional. Standard validation settings can be changed via setup: DISESETUP > 5. Subscriber Registration Set up > 15. Delivery Address Set Up > 8. Field Validation Maintenance. Enter 'C' for Company Address.
Notes Response Container
The Notes response container has the following elements:
|
Element Name |
Content Type |
Description |
Required? |
|---|---|---|---|
|
Notes |
String |
Any notes that have been entered in the Notes section against the specific Workflow Event queried. |
Optional |
|
LastAmendedDate |
DateTime |
YYYY-MM-DDThh:mm:ssZ |
Optional |
Adjustments Response Container
The Adjustments response container has the following elements:
|
Element Name |
Content Type |
Description |
Required? |
|---|---|---|---|
|
Adjustment |
Container |
See Adjustment response container for details |
Optional |
Adjustments Response Container
The Adjustments response container has the following elements:
|
Element Name |
Content Type |
Description |
Required? |
|---|---|---|---|
|
LineNumber |
Integer5 |
This is the unique number of the individual Sales Ledger Adjustment invoice line record. |
Mandatory |
|
ServiceCode |
String6 |
This details the code attributed to the Service as it appears on the invoice. |
Mandatory |
|
SubscriptionNumber |
Integer8 |
The unique system generated reference number for the Subscription |
Optional |
|
PrimarySerialNumber |
String25 |
The Primary Serial Number of the Subscription |
Optional |
|
ChargeStartDate |
Date |
This displays the date that the charge started. YYYY-MM-DDZ |
Optional |
|
ChargeEndDate |
Date |
This displays the date that the charge ended. YYYY-MM-DDZ |
Optional |
|
NetAmount |
Currency |
This displays the amount of the Sales Ledger Adjustment to be credited or debited against the Account. |
Mandatory |
|
ChargeToNominalCode |
String29 |
This information relates to the Nominal Code. |
Optional |
|
TaxRateAtStart |
Boolean |
This is usually set to 'False'. |
Optional |
|
Comments |
String |
Any specific comments in relation to the credit/debit. |
Optional |
|
LastAmendedDate |
DateTime |
YYYY-MM-DDThh:mm:ssZ |
Optional |
The values match those presented in the CMP UI when a Sales Ledger Adjustment is viewed. However, this does not include the referenced data such as the Service, Tariff and Nominal Description.
LinkedEvent Response Container
The LinkedEvent response container has the following elements:
|
Element Name |
Content Type |
Description |
Required? |
|---|---|---|---|
|
EventNumber |
Integer9 |
Unique number associated with the Workflow Event. |
Optional |
|
SequenceNumber |
Integer3 |
This is the sequence number of the Workflow Event. |
Mandatory |
|
EventTypeCode |
String4 |
The specific Event Type configured in CMP associated to the Workflow Event to be raised. |
Mandatory |
|
EventCode |
String4 |
The specific Event Code configured in CMP associated to the Workflow Event to be raised. |
Mandatory |
|
EventStatus |
String |
The current status of the Workflow Event. |
Mandatory |
QueryWorkflows
The QueryWorkflows web service enables an external client system to retrieve a list of Workflow Events that have been raised against a particular Subscription, Account, Corporate or Group within CMP.
The user must pass in a valid CMP Subscription Number, Account Number, Corporate Code, Group Code, or Agreement Number in order to retrieve a list of Workflow Events for that entity. Basic information only is returned – this does not include Actions, Correspondence, Assignments and so on.
The most recent Workflow Events created are returned first. The order is as follows:
- Date Created - Descending.
- Time Created - Descending.
Filter options within the web service request enable 'open', 'resolved', or 'cancelled' Workflow Events to be selected, along with either the Type and Code or the Resolution Date.
A maximum is applied to the number of Workflow Events that can be returned in a single web service call. If this limit is exceeded, the maximum number of records is still returned but the user is notified that the limit has been reached.
Submission of invalid data for the above criteria results in an error message.
QueryWorkflow Request
The QueryWorkflows tag instructs the Workflow Service to query CMP for Workflow Events. 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 |
|
CustomerLevel |
String |
Choice of one of the following elements:
|
Mandatory |
|
CustomerLevelReference |
String8 |
The appropriate unique reference for the CustomerLevel selected. For example: Subscription Number, Agreement Number, Corporate Code, Group Code or Account Number. |
Mandatory |
|
StatusFilter |
String |
Choice of:
|
Mandatory |
|
DataFilter |
Container |
See DataFilter request container for details. |
Mandatory |
DataFilter Request Container
The DataFilter request container has the following elements:
|
Element Name |
Content Type |
Description |
Required? |
|---|---|---|---|
|
EventTypeCode |
String4 |
The specific event type associated with the event raised. |
Optional |
|
EventCode |
String4 |
The description generated by the event code. |
Optional |
|
ResolutionRequiredByDateOnOrBefore |
Date |
The date by which the event must be resolved or the date when the event must be processed. YYYY-MM-DDZ |
Optional |
QueryWorkflows Response
The QueryWorkflows response is the response to the QueryWorkflows 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 |
|
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 |
|
Workflows |
Container |
See Workflows response container for details. |
Mandatory |
Workflows Response Container
The Workflows response container has the following elements:
|
Element Name |
Content Type |
Description |
Required? |
|---|---|---|---|
|
Workflow |
Container |
See Workflow response container for details. |
Optional |
Workflow Response Container
The Workflow response container has the following elements:
|
Element Name |
Content Type |
Description |
Required? |
|---|---|---|---|
|
EventNumber |
Integer9 |
Unique number associated with the Workflow Event. |
Mandatory |
|
EventStatus |
String |
The current status of the Workflow Event. One of:
|
Optional |
|
EventType |
String4 |
The specific Event Type configured in CMP associated to the Workflow Event to be raised. |
Mandatory |
|
EventCode |
String4 |
The specific Event Code configured in CMP associated to the Workflow Event to be raised. |
Mandatory |
|
AdjustmentAmount |
Currency |
Returns the total Sales Ledger Adjustment amount for events created on an Account only.
|
Optional |
|
CurrentUserId |
String |
The User ID of the person who last updated the record. |
Optional |
|
CreatedDate |
DateTime |
Workflow Event creation date. YYYY-MM-DDThh:mm:ssZ |
Mandatory |
|
LastAmendedDate |
DateTime |
YYYY-MM-DDThh:mm:ssZ |
Optional |
QueryWorklist
The QueryWorklist web service accepts a CMP User ID and returns a list of all the open Workflow Events on that user's Worklist. Workflow Events are returned in ascending order of Resolve By Date/Time.
A query limit is configured for the web service as per standard CMP web service configuration.
QueryWorklist Request
The QueryWorklist tag instructs the Workflow Service to query CMP for a specific user's Worklist. 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 |
|
UserID |
String10 |
The CMP user or department to whom the Workflow Event has been or is to be sent. |
Mandatory |
QueryWorklist Response
The QueryWorklist response is the response to the QueryWorklist 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 |
|
WorklistItems |
Container |
See WorklistItem 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 |
WorklistItems Response Container
The WorklistItems response container has the following elements:
|
Element Name |
Content Type |
Description |
Required? |
|---|---|---|---|
|
WorklistItem |
Container |
See WorklistItem response container for details. |
Optional |
WorklistItem Response Container
The WorklistItem response container has the following elements:
|
Element Name |
Content Type |
Description |
Required? |
|---|---|---|---|
|
EventNumber |
Integer9 |
Unique number associated with the workflow event. |
Mandatory |
|
TargerIdentifier |
Container - Choice |
One of the following elements: Group Identifier (String6) Corporate Identifier (String6) Account Identifier (Integer8) Subscription Identifier (Integer8) Mobile Number (String25) |
Mandatory |
|
EventType |
String4 |
The specific Event Type configured in CMP associated to the Workflow Event to be raised. |
Mandatory |
|
EventCode |
String4 |
The specific Event Code configured in CMP associated to the Workflow Event to be raised. |
Mandatory |
|
EventStatus |
String |
The current status of the workflow event (e.g. 'Cancelled', etc.). |
Mandatory |
|
CreatedByUserId |
String10 |
The date on which the event was created by the user. |
Optional |
|
CreatedDate |
DateTime |
YYYY-MM-DDThh:mm:ssZ Workflow creation date |
Optional |
|
PassToUserId |
String10 |
Unique user ID for the Network Operator, Department or Customer Services Representative (CSR) to whom the event has been or is to be sent. |
Optional |
|
PassedToDate |
DateTime |
The date on which the event was passed to the current user. |
Optional |
|
ResolutionRequiredByDate |
DateTime |
The date by which the event must be resolved or the date when the event must be processed. This field contains a drop-down calendar to aid date selection, if required. |
Mandatory |
|
LastAmendedDate |
DateTime |
YYYY-MM-DDThh:mm:ssZ |
Optional |