Overview

Within the use cases a UML sequence is provided against each. The UML sequence diagrams show the points at which a request & response is exchanged with TruService. All requests submitted to TruService must follow the published version of the schema being used. The UML sequence diagrams use a common set of command names, always shown between quotes (e.g. “GetQuestion” , “GetRating”). The tables below show how the command names used in the UML sequences map into the TruService schema.

NOTE: The tables below only show the first two or three levels of complex types from the schema. Please refer to the TruService schema for a complete reference.

GetQuestion

This command in the UML sequences indicates the point at which a request to TruService is submitted to retrieve a rating question. The request can provide TruService with runtime details around language support, device characteristics etc. The response from TruService will indicate if a question is available and if so will provide the question, the relevant acknowledgment text and the receipt text based on the data passed when the question was requested.

GetQuestion Request

tsi::Request  
tsi::RequestQuestion  
  tsi::RequestLanguage
  tsi::RequestDevice
  tsi::RequestServer

GetQuestion Response

tsi::Response    
tsi::ResponseDisplay    
  tsi::ResponseLanguage  
    tsi::ResponseQuestion
    tsi::ResponseScreen
    tsi::ResponseReceipt

GetRating

This command in the UML sequences indicates the point at which a rating or result of a rating question is sent to TruService.

GetRating Request

tsi::Request  
tsi::RequestRating  
  tsi::RequestTransaction
(This is optional and in use cases is shown as separate message)

GetRating Response

tsi::Response
tsi::ResponseEventClear

GetTransaction

This command in the UML sequences indicates the point at which the result of a transaction (for dwell time or dwell time extend) or card payment (payment request or card presentation) is submitted to TruService

GetTransaction Request

tsi::Request  
tsi::RequestTransaction  
  tsi::RequestTender

GetTransaction Response

tsi::Response
tsi::ResponseEventClear

POSEvent

This command in the UML sequences indicates one of the supported POS events being submitted to TruService. TruService can acknowledge this event, indicate an active question should be cleared or inform the caller that a question is available.

RequestPOSEvent

tsi::Request  
tsi::RequestPosEvent  
  tsi::RequestPosStartTransaction
  tsi::RequestPosStartTilling
  tsi::RequestPosItem
  tsi::RequestPosDiscount
  tsi::RequestCustomer
  tsi::RequestPosEndTilling
  tsi::RequestPosEndTransaction
  tsi::RequestPosReceiptData

NOTE: An alternative to sending multiple instances of tsi::RequestPOSEvent is to send a single tsi::RequestPosEventList that enables multiple POS events to be sent to TruService in a single delivery.

ResponseEvent

tsi::Response  
tsi::ResponseEvent  
  tsi::ResponseEventQuestion
  tsi::ResponseEventClear
Feedback