The service usage database is used by all services, including Parlay X Presence over SIP/IMS, to record events related to a service request. Parlay X Presence over SIP/IMS creates a Presence service usage record by calling the Usage Record component Web service
The following table lists part names and service attributes used for subscribePresence.
Attribute | Description |
---|---|
REQUESTER | Copied from Access Gateway - supplied headers |
APPLICATION_OF_SERVICE | The data which describes the application of the watcher |
CORRELATOR | Used to communicate with endpoint for callbacks |
NOTIFICATION_ENDPOINT | Web service endpoint used for callbacks |
PRESENCE_ATTRIBUTES | Lists all PresenceAttributeTypes if subscribePresenceRequest. The attributes are empty which indicates a wildcard value. |
TARGETS | Pulled from notifySubscriptionRequest.Presentity part |
EXPANDED_TARGETS | Group List Management Server - Targets can have group URIs, EXPANDED_TARGETS list containing single entries for each user/terminal |
EXPANDED_TARGETS_COUNT | Total number of targets for which status has to be queried |
RESULT | Contains status information in the case of a successful operation, otherwise it contains an exception type |
ROOT_CAUSE | Only present if an exception occurred because of unrecoverable internal error |
The following table lists part names and service attributes used for getUserPresence.
Attribute | Description |
---|---|
REQUESTER | Copied from Access Gateway-supplied headers |
TARGETS | URI Addresses of the terminal(s) whose status have to be retrieved |
PRESENCE_ACTIVITY | Not present if the Activity is not requested in the getUserPresenceRequest.Attributes. Not present if an exception is returned to the requester |
PRESENCE_PLACE | Not present if the Place is not requested in the getUserPresenceRequest.Attributes. Not present if an exception is returned to the requester |
PRESENCE_PRIVACY | Not present if the Privacy is not requested in the getUserPresenceRequest.Attributes. Not present if an exception is returned to the requester |
PRESENCE_SPHERE | Not present if the Sphere is not requested in the getUserPresenceRequest.Attributes. Not present if an exception is returned to the requester |
PRESENCE_CONTACTS | Not present if the Communication is not requested in the getUserPresenceRequest.Attributes. Not present if an exception is returned to the requester |
PRESENCE_CONTACT_PRIORITIES | Not present if the Communication is not requested in the getUserPresenceRequest.Attributes. Corresponds to the values in ResultContacts. Not present if an exception is returned to the requester |
RESULT | Only present if an exception is returned for the requester |
ROOT_CAUSE | Only present if an exception occurred due to an unrecoverable internal error |
The following table lists part names and service attributes used for startPresenceNotification.
Attribute | Description |
---|---|
REQUESTOR | Copied from Access Gateway-supplied headers |
CORRELATOR | Used to communicate with endpoint for callbacks |
NOTIFICATION_ENDPOINT | Web service endpoint used for callbacks |
PRESENCE_ATTRIBUTES | Lists all of the PresenceAttributeTypes if subscribePresenceRequest .Attributes was empty (indicating a wildcard value) |
TARGETS | URI Addresses of the terminal(s) whose status have to be retrieved |
EXPANDED_TARGETS | Group List Management server - TARGETS can have group URIs, EXPANDED_TARGETS list which contains a single entry for each user/terminal |
EXPANDED_TARGETS_COUNT | Total number of targets for which status has to be queried |
FREQUENCY | Copied from incoming request; in milliseconds |
NOTIFICATION_EXPIRES_AT | Copied from incoming request, converted to milliseconds since the epoch |
NOTIFICATION_COUNT | Identifies maximum number of notifications to deliver |
CHECK_IMMEDIATE | Indicates that the service is being asked that notification be given immediately after the subscription setup completes |
RESULT | The comma separated list of presentity addresses for which the subscriber could not subscribe to the requested attributes, or the returned an exception |
ROOT_CAUSE | Only present if the exception occurred because of an unrecoverable internal error |
The following table lists part names and service attributes used for endPresenceNotification.
Attribute | Description |
---|---|
REQUESTOR | Identifies the application that issues the service request |
CORRELATOR | Used to communicate with endpoint for callbacks |
RESULT | Only present if an exception was returned to the requester |
ROOT_CAUSE | Only present if the exception occurred because of an unrecoverable internal error |
The following table lists part names and service attributes used for notifySubscription_DeliveryAttempted.
Attribute | Description |
---|---|
CORRELATOR | Used to communicate with endpoint for callbacks |
TARGET | Pulled from the notifySubscriptionRequest.Presentity part |
PRESENCE_PERMISSIONS | An xsd:Boolean indicating if the requester was authorized to access the Presentity in Address |
APP_CORRELATION_ID | Used to match this DeliveryAttempted record with a DeliveryResult |
The following table lists part names and service attributes used for notifySubscription_DeliveryResult.
Attribute | Description |
---|---|
FAILURE_REASON | Empty if the DeliveryStatus = Success |
FAILURE_DETAIL | Empty if the DeliveryStatus = Success |
APP_CORRELATION_ID | Used to match this DeliveryResult record with a DeliveryAttempted |
The following table lists part names and service attributes used for subscriptionEnded_DeliveryAttempted.
Attribute | Description |
---|---|
TARGET | Pulled from notifySubscriptionRequest.Presentity part |
REASON | Describes why the subscription has ended - For example; Timeout or Blocked |
APP_CORRELATION_ID | Used to match this DeliveryAttempted record with a DeliveryResult |
The following table lists part names and service attributes used for subscriptionEnded_DeliveryResult.
Attribute | Description |
---|---|
FAILURE_REASON | Empty if the DeliveryStatus = Success |
FAILURE_DETAIL | Empty if the DeliveryStatus = Success |
APP_CORRELATION_ID | Used to match this DeliveryResult record with a DeliveryAttempted |
The following table lists part names and service attributes used for publish.
Attribute | Description |
---|---|
REQUESTER | Identifies the application that issues the service request |
PRESENCE_ACTIVITY | Activity value, obtained from publishReq.getAttribute |
PRESENCE_PLACE | Obtained from publishRequest.Attributes; if not specified, the value is PlaceNone |
PRESENCE_PRIVACY | Obtained from publishRequest.Attributes; if not specified, the value is PrivacyNone |
PRESENCE_SPHERE | Obtained from publishRequest.Attributes; if not specified, the value is SphereNone |
PRESENCE_CONTACTS | Comma separated list of the Communication Means Contact values obtained from publishReq.getAttribute |
PRESENCE_CONTACT_PRIORITIES | Comma separated list of the Communication Means Priority values obtained from publishReq.getAttribute |
RESULT | Present if an exception is returned to the requester |
ROOT_CAUSE | Present if an exception occurs due to an unrecoverable internal error |