WebSphere brand IBM WebSphere Telecom Web Services Server, Version 7.1

Usage records for Parlay X Terminal Location over MLP

The Parlay X Terminal Location over MLP uses the Usage Record component Web service to record events related to a service request.

Parlay X Terminal Location over MLP service record

Usage records for Parlay X Terminal Location over MLP are created by calling the Usage Record component Web service, which creates entries in the USAGERECORDS table.

The following table lists part names and service attributes used by Usage Record component Web service.
Table 1. Usage record 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 When 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 getLocation, getTerminalDistance and getLocationForGroup operations

The following table lists part names and service attributes used by getLocation, getTerminalDistance, and getLocationForGroup.
Table 2. getLocation, getTerminalDistance, and getLocationForGroup service attributes and descriptions
Attribute Description
START_TIME Time the operation began
REQUEST_ACCEPTABLE_ACCURACY Lowest accuracy acceptable to requester
IS_ALTITUDE_REQUESTED Determines whether altitude information should be requested when location requests are made. Has to be one of the following:

Yes
No

REQUESTED_DELAY_TOLERANCE Priority of response time versus accuracy. Has to be one of the following:

DELAY_TOLERANT
LOW_DELAY

REQUESTER Requester name requesting this operation
RESULT_ACCURACY Accuracy of the resulting location
REQUESTED_RESPONSE_TIME Maximum time that the application can accept to wait for a response
IS_USING_EXTENDED_REQUEST Whether extended location requests should be made. Has to be one of the following:

Yes
No

REQUESTED_MAXIMUM_AGE_OF_RESPONSE Maximum acceptable age of the location information that is returned
TARGET Formatted target address
RESPONSE_TIME Amount of time to take for the response
REQUESTED_ACCURACY Accuracy of location information requested
LOCATION_TYPE Parlay gateway location type strings. Has to be one of the following:

CURRENT_OR_LAST
CURRENT
INITIAL
LAST

REQUEST_PRIORITY Location priority parameter passed to the MLP location server. Has to be one of the following:

NORMAL
HIGH

Service data for startGeographicalNotification operation

The following table lists part names and service attributes used by startGeographicalNotification. One usage record is written per target.
Table 3. startGeographicalNotification service attributes and descriptions
Attribute Description
REQUESTER Requester name requesting this operation
FREQUENCY Minimum time between notifications
DURATION Maximum duration of a notification request
NOTIFICATION_EXPIRES_AT Expiration time of the notification
TARGET Formatted target address
NOTIFICATION_CRITERIA Indicates whether the notification should occur when the terminal enters or leaves the target area. Has to be one of the following:

LEAVING
ENTERING

LOCATION_TYPE MLP location type strings. Has to be one of the following:

CURRENT_OR_LAST
CURRENT
INITIAL
LAST

REQUEST_PRIORITY Location priority parameter passed to the MLP Location server. Has to be one of the following:

NORMAL
HIGH

START_TIME Time the operation began
NOTIFICATION_TRIGGER_RADIUS Requested triggered radius
NOTIFICATION_ENDPOINT Endpoint URL that will receive the notifications
CORRELATOR Correlation information from the end point. Used to communicate with endpoint for callbacks, this information must be unique for this service and requester.
IS_ALTITUDE_REQUESTED Determines whether altitude information should be requested when location requests are made. Has to be one of the following:

Yes
No

RESPONSE_TIME Amount of time it take for the response
NOTIFICATION_COUNT Number of notifications requested
REQUEST_IDENTIFIER Unique identifier generated by the MLP Location Server corresponding to a notification

Service data for startPeriodicNotification operation

The following table lists part names and service attributes used by startPeriodicNotification. One usage record is written per target.
Table 4. startPeriodicNotifications service attributes and descriptions
Attribute Description
CORRELATOR Correlation information from the end point. Used to communicate with endpoint for callbacks, this information must be unique for this service and requester.
FREQUENCY Frequency of a notification request
REQUEST_PRIORITY Location priority parameter passed to the MLP location server. Has to be one of the following:

NORMAL
HIGH

TARGET Formatted target address
REQUESTER Requester name requesting this operation
NOTIFICATION_EXPIRES_AT Expiration time of the notification
START_TIME Time the operation began
RESPONSE_TIME Amount of time to take for the response
DURATION Maximum duration of a notification request
NOTIFICATION_ENDPOINT Endpoint URL that will receive the notifications
LOCATION_TYPE Location type strings sent to the MLP Location server. Has to be one of the following:

CURRENT_OR_LAST
CURRENT
INITIAL
LAST

IS_ALTITUDE_REQUESTED Determines whether altitude information should be requested when location requests are made. Has to be one of the following:

Yes
No

Service data for endNotification operation

The following table lists part names and service attributes used by endNotification. One usage record is written per operation.
Table 5. endNotification service attributes and descriptions
Attribute Description
REQUESTER Requester name requesting this operation
RESPONSE_TIME Amount of time to take for the response
START_TIME Time the operation began
CORRELATOR Correlation information from the end point. Used to communicate with endpoint for callbacks, this information must be unique for this service and requester.
TRANSACTIONID Unique for the transaction
REQUESTID Unique for the request

Service data for service exceptions: All operations

The following table lists part names and service attributes used for service exceptions.
Table 6. Exception 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

Service data for locationNotification, locationError, locationEnd

Usage records are not generated for the locationNotification, locationError, and locationEnd operations.




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