WebSphere brand IBM WebSphere Telecom Web Services Server, Version 7.1

Usage records for WAP Push over SMPP

The WAP Push over SMPP Web service implementation uses the Usage Record component Web service to record usage information which includes exception details. For the synchronous part of the Web service request, an error condition maps to an exception which is then returned to the caller.

WAP Push over SMPP service record

Usage records for WAP Push over SMPP are created by calling the Usage Record component Web service, which creates entries in the USAGERECORDS table.

The following table describes the information that is passed to the Usage Record component Web service for this Web service implementation.
Table 1. Usage record component service attributes and descriptions
Attribute Description
RECORDID A unique record identifier
SEGMENT Segment number used for subsequent truncated records. This number is incremented each time an overflow of the SERVICEDATA field is encountered and a subsequent record is added.

Used by the SMS-based service implementations; a value of 0 is written for all others.

GLOBALID Global transaction identifier
SERVICE Name of the service
HOST Name of the host on which the usage record is being recorded
EVENTTYPE Name of the operation being performed
RECORDTIME The time that the usage record was written
STATUSCODE One of the following:

0 = VALID
1 = FAILED_PRIVACY
2 = FAILED_ADDRESS_PLAN_VALIDATION
3 = EXCEEDED_MAX_TARGETS
4 = FAILED_PACER
5 = FAILED_CALL_LEVEL_PRIVACY
6 = FAILED_PROCESS_UP_TO_LIMIT
7 = FAILED_ADMISSION_CONTROL
8 = FAILED_SERVICE_NOT_RUNNING
9 = FAILED_JMS_ENQUEUE
10 = UNKNOWN_SCHEME
11 = FAILED_OPERATION
12 = FAILED_OTHER
13 = INVALID
14 = GROUPS_NOT_ALLOWED
15 = UNRESOLVED_GROUPS
16 = FAILED_TRAFFIC_SHAPING

SERVICEDATA Semicolon-delimited list of attributes described in the following tables, written in the format key=value;key=value...

Service data for WAP Push operation

The following table lists part names and service attributes used by the WAP Push operation.
Table 2. WAP Push service attributes and descriptions
Attribute Description
TARGET Formatted target address
MESSAGE_LENGTH Length of the message in bytes
CHARGE_CODE Optional: the contract to which a charge is applied
CORRELATOR Correlation information from the endpoint. Used to communicate with the endpoint for callbacks. Must be unique for this service and requester
REQUEST_IDENTIFIER Identifies a specific WAP Push delivery request
REGISTRATION_IDENTIFIER The registration identifier for the particular request
DELIVERY_STATUS The delivery result for the address. One of the following:
  • Successfully delivered to Terminal. (Final state)
  • Unsuccessful delivery. The message could not be delivered before it expired. (Final state)
  • Unable to provide delivery receipt notification. When this state is stored, a ServiceException is also returned. Therefore, this state must be set by the front end, and no queued request will take place. (Final state)
  • Successful delivery to network. (Not the final state)
  • Delivery status unknown because it was handed off to another network. The network has reported that it cannot deliver the message because the device is not available. (Not the final state)
  • The message is still queued for delivery. (A temporary state, pending transition to one of the other states)
SESSION_ID A session ID for the requester
ASSIGNMENT_ID The assignment ID associated with sending the message
SERVICE_ACTIVATION_NUMBER The target address; must be unique
REFERENCE The reference code from the input message - uniquely identifies the request
ENDPOINT Endpoint URI that will receive the notifications
INTERFACE_NAME Name of the WAP Push interface used for this request
REQUESTER Requester name requesting this operation
CONFIRM_DELIVERY A confirmation message returned when the message is delivered. Must be one of the following:

Yes
No

NETWORK_ID Name of the network

Service data for service exceptions

The following table lists part names and service attributes used by service exceptions.
Table 3. Exception data service attributes and descriptions
Attribute Description
FAILURE_REASON Error message identifier indicating the error
FAILURE_DETAIL A detailed error text message
ERROR_TYPE Type of error encountered

WAP Push over SMPP service record

The Usage Record component Web service create entries in the USAGERECORDS table. The following table describes the information that is passed to the Usage Record component Web service in order to create a service record for WAP Push over SMPP.

The following table lists part names and service attributes used by WAP Push.

Table 4. WAP Push service attributes and descriptions
Attribute Description
SOAM6002 An error occurred while creating the records in the WAPPUSHSENDDATA table
SOAM6003 An error occurred while reading the records in the WAPPUSHSENDDATA table
SOAM6004 A Database error occurred while creating the records in the WAPPUSHSENDDATA table
SOAM6005 No records were found in the WAPPUSHSENDDATA table for the transactionid
SOAM6006 The send message has failed due to the delivery confirmation request was not able to be setup
SOAM6007 The send message has failed due to a problem creating the notification record. Check the error string returned for more information
SOAM6020 The target address value is null
SOAM6021 One of targets address value is an empty string
SOAM6022 The message parameter is null
SOAM6023 The message parameter is an empty string
SOAM6025 Problem in the database layer of WAPPUSH.
SOAM6026 The request identifier parameter is null
SOAM6027 The request identifier parameter is an empty string
SOAM6028 The value of request identifier parameter is not known
SOAM6029 The value of delivery status return from the gateway - this error should never happen unless the gateway returns undefined type of delivery status
SOAM6030 Requester ID value in the TWSS context (MdsContext) is null
SOAM6031 TWSS context (MdsContext) value is null
SOAM6032 Error when creating notification record for sendWAPPushSI request
SOAM6055 This should never happen unless there is coding error
SOAM6059 The service enable MBean in the administration console is set to false
SOAM6060 The service policy service.standard.ChargingSupported is set to false and charging information is passed in as part of the parameter
SOAM6076 There is a problem with the database connection
SOAM6077 There is a unknown problem
SOAM6079 There is a problem with updating the status on sendWAPPushSI record
SOAM6080 A problem with finding the segment status for the transaction
SOAM6085 This happens after the Parlay call to startNotification on the gateway is successful and database update call is made
SOAM6086 This happens at the time that the notification from the gateway message has been received by the specified device
SOAM6090 This is a database problem which occurs during the purging process
SOAM6091 This is a database problem which occurs during the purging process
SOAM6100 Database service is not up and running or database authentication failed
SOAM6101 The href parameter is null.
SOAM6102 The href parameter is an empty string
SOAM6103 The action parameter is null
SOAM6104 The action parameter is an empty string or an incorrect value. Valid values are signal-none, signal-low, signal-medium, signal-high, delete.

Direct Connect (SMPP) service record

The Usage Record component Web service create entries in the USAGERECORDS table. The following table lists part names and service attributes used by Direct Connect (SMPP).
Table 5. Direct Connect (SMPP) service attributes and descriptions
Attribute Description
SOAM6150 The service policy service.common.messaging.target.Aliases is not in the TWSS context (MdsContext)
SOAM6151 The service policy service.config.ConfirmDelivery is not in the TWSS context (MdsContext)
SOAM6152 No alias names were defined in the administration console
SOAM6153 A problem with getting the MBean value that was set in the administration console
SOAM6154 Unable to connect to the specified SMSC Server
SOAM6155 Internal Error with the SmppSessionManager
SOAM6156 An error occurs while sending the message to the SMSC
SOAM6157 Failure to send the Enquire Link Response message
SOAM6158 Failure to send the Deliver SM Response message
SOAM6159 Failure to send the Generic Non-Acknowledge message



Terms of use
(C) Copyright IBM Corporation 2009. All Rights Reserved.