The PaymentInstructionLabel is designed to present instructions to the customer on how to proceed with the purchase. The label can be placed in any panel and can be adapted to describe the next steps to be taken in a purchase. This can be accomplished with any label, but the unique feature of the PaymentInstructionLabel is that it can display different texts or sounds depending on the state of the terminal and the current purchase.
| Warning: This label will show the default text that no pay units are available when the purchase process is in a state that all available pay units are inhibited |
A typical text or sound can be to inform the end user to either insert a credit card to pay with card, or insert coins to pay with coins as the next step in a purchase. But if the coin pay unit is in partial error mode the customer shall be informed that card payment is the only option. This can be accomplished with the PaymentInstructionLabel. To use this feature the label name must begin with “PaymentInstructionLabel” and the label property “PartialErrorCheck” must be set to “true”. Different texts or sounds for different states can then be defined in sub-elements of the label.
Display Sound can be added to a FormattedTextItem to be played when an item is refreshed (painted).
If DisplaySound is added to a FormattedTextItem inside a Label with the name “PaymentInstructionLabel” it is only played one time when the parent panel is new. A panel is new when the previous panel is a different panel. I.e. when same panel is refreshed the sound is not played again.
The PaymentInstructionLabel now has four payment states:
PaymentStateName = {'NoPayUnits', 'MinNotReached', 'FreeUnits', 'Normal'}.
If several states are valid at the same time, the above order is the priority order, for example, if no pay units are available and minimum number of ticks has not been reached, the state of the PaymentInstructionLabel will be
PaymentStateName = 'NoPayUnits'
The state 'Normal' is the default state which is used if PaymentStateName is not stated.
Each payment state has an “available pay unit”-state:
PayUnitsName = {default, coin, card, coin_card, bill, coin_bill, card_bill, coin_card_bill, cardcollector, coin_cardcollector, card_cardcollector, coin_card_cardcollector, bill_cardcollector, coin_bill_cardcollector, card_bill_cardcollector, coin_card_bill_cardcollector, balanceaccount, coin_balanceaccount, card_balanceaccount, coin_card_balanceaccount, bill_balanceaccount, coin_bill_balanceaccount, card_bill_balanceaccount, coin_card_bill_balanceaccount, cardcollector_balanceaccount, coin_cardcollector_balanceaccount, card_cardcollector_balanceaccount, coin_card_cardcollector_balanceaccount, bill_cardcollector_balanceaccount, coin_bill_cardcollector_balanceaccount, card_bill_cardcollector_balanceaccount, coin_card_bill_cardcollector_balanceaccount, extpux, coin_extpux, card_extpux, coin_card_extpux, bill_extpux, coin_bill_extpux, card_bill_extpux, coin_card_bill_extpux, cardcollector_extpux, coin_cardcollector_extpux, card_cardcollector_extpux, coin_card_cardcollector_extpux, bill_cardcollector_extpux, coin_bill_cardcollector_extpux, card_bill_cardcollector_extpux, coin_card_bill_cardcollector_extpux, balanceaccount_extpux, coin_balanceaccount_extpux, card_balanceaccount_extpux, coin_card_balanceaccount_extpux, bill_balanceaccount_extpux, coin_bill_balanceaccount_extpux, card_bill_balanceaccount_extpux, coin_card_bill_balanceaccount_extpux, cardcollector_balanceaccount_extpux, coin_cardcollector_balanceaccount_extpux, card_cardcollector_balanceaccount_extpux, coin_card_cardcollector_balanceaccount_extpux, bill_cardcollector_balanceaccount_extpux, coin_bill_cardcollector_balanceaccount_extpux, card_bill_cardcollector_balanceaccount_extpux, coin_card_bill_cardcollector_balanceaccount_extpux, onlinepaymentprovider, coin_onlinepaymentprovider, card_onlinepaymentprovider, coin_card_onlinepaymentprovider, bill_onlinepaymentprovider, coin_bill_onlinepaymentprovider, card_bill_onlinepaymentprovider, coin_card_bill_onlinepaymentprovider, cardcollector_onlinepaymentprovider, coin_cardcollector_onlinepaymentprovider, card_cardcollector_onlinepaymentprovider, coin_card_cardcollector_onlinepaymentprovider, bill_cardcollector_onlinepaymentprovider, coin_bill_cardcollector_onlinepaymentprovider, card_bill_cardcollector_onlinepaymentprovider, coin_card_bill_cardcollector_onlinepaymentprovider, balanceaccount_onlinepaymentprovider, coin_balanceaccount_onlinepaymentprovider, card_balanceaccount_onlinepaymentprovider, coin_card_balanceaccount_onlinepaymentprovider, bill_balanceaccount_onlinepaymentprovider, coin_bill_balanceaccount_onlinepaymentprovider, card_bill_balanceaccount_onlinepaymentprovider, coin_card_bill_balanceaccount_onlinepaymentprovider, cardcollector_balanceaccount_onlinepaymentprovider, coin_cardcollector_balanceaccount_onlinepaymentprovider, card_cardcollector_balanceaccount_onlinepaymentprovider, coin_card_cardcollector_balanceaccount_onlinepaymentprovider, bill_cardcollector_balanceaccount_onlinepaymentprovider, coin_bill_cardcollector_balanceaccount_onlinepaymentprovider, card_bill_cardcollector_balanceaccount_onlinepaymentprovider, coin_card_bill_cardcollector_balanceaccount_onlinepaymentprovider, extpux_onlinepaymentprovider, coin_extpux_onlinepaymentprovider, card_extpux_onlinepaymentprovider, coin_card_extpux_onlinepaymentprovider, bill_extpux_onlinepaymentprovider, coin_bill_extpux_onlinepaymentprovider, card_bill_extpux_onlinepaymentprovider, coin_card_bill_extpux_onlinepaymentprovider, cardcollector_extpux_onlinepaymentprovider, coin_cardcollector_extpux_onlinepaymentprovider, card_cardcollector_extpux_onlinepaymentprovider, coin_card_cardcollector_extpux_onlinepaymentprovider, bill_cardcollector_extpux_onlinepaymentprovider, coin_bill_cardcollector_extpux_onlinepaymentprovider, card_bill_cardcollector_extpux_onlinepaymentprovider, coin_card_bill_cardcollector_extpux_onlinepaymentprovider, balanceaccount_extpux_onlinepaymentprovider, coin_balanceaccount_extpux_onlinepaymentprovider, card_balanceaccount_extpux_onlinepaymentprovider, coin_card_balanceaccount_extpux_onlinepaymentprovider, bill_balanceaccount_extpux_onlinepaymentprovider, coin_bill_balanceaccount_extpux_onlinepaymentprovider, card_bill_balanceaccount_extpux_onlinepaymentprovider, coin_card_bill_balanceaccount_extpux_onlinepaymentprovider, cardcollector_balanceaccount_extpux_onlinepaymentprovider, coin_cardcollector_balanceaccount_extpux_onlinepaymentprovider, card_cardcollector_balanceaccount_extpux_onlinepaymentprovider, coin_card_cardcollector_balanceaccount_extpux_onlinepaymentprovider, bill_cardcollector_balanceaccount_extpux_onlinepaymentprovider, coin_bill_cardcollector_balanceaccount_extpux_onlinepaymentprovider, card_bill_cardcollector_balanceaccount_extpux_onlinepaymentprovider, coin_card_bill_cardcollector_balanceaccount_extpux_onlinepaymentprovider}
So the actual state of PaymentInstructionLabels is actually a state matrix:
{PaymentStateName, PayUnitsName}
Some combinations are, of course, not applicable, for example:
{PaymentStateName='NoPayUnits' PayUnitsName ='Coin'}
| Note: The text selection will first try to match both PaymentStateName and PayUnitsName. If there is no such match, it will look for a matching PayUnitsName. If that doesn't match either, it will check for a matching PaymentStateName. If that also fails, it will use the default text as specified in the FormattedText property in the example below. |
An example of a typical payment instruction label is shown below. Assuming that only the bill and coin pay units are working, the text 'PayWithCoinBill' will be displayed. With a translation of 'PayWithCoinBill', the text might be “Please insert coin or bill”.
<TFT:Label Name='PaymentInstructionLabel' Size='400,80'
Location='40,215' PartialErrorCheck='true'
Font='Tahoma, 16pt, style=Bold' FormattedText='MoneyOrCardPay@.'>
<TFT:FormattedTexts>
<TFT:FormattedTextItem PayUnitsName='Bill' Text='PayWithBill'/>
<TFT:FormattedTextItem PayUnitsName='Coin' Text='PayWithCoin'/>
<TFT:FormattedTextItem PayUnitsName='Coin_Bill'
Text='PayWithCoinBill'/>
<TFT:FormattedTextItem PayUnitsName='Card' Text='PayWithCard'/>
<TFT:FormattedTextItem PayUnitsName='Bill_Card'
Text='PayWithBillCard'/>
<TFT:FormattedTextItem PayUnitsName='Coin_Card'
Text='PayWithCoinCard'/>
<TFT:FormattedTextItem PayUnitsName='Coin_Card_Bill'
Text='PayWithCoinCardBill'/>
<TFT:FormattedTextItem PaymentStateName='FreeUnits'
Text='FREE UNITS'/>
<TFT:FormattedTextItem PaymentStateName='FreeUnits'
PayUnitsName ='Coin' Text='FreeUnitsAndCoin'/>
<TFT:FormattedTextItem PaymentStateName='NoPayUnits'
Text='NoPayUnits'/>
<TFT:FormattedTextItem PaymentStateName='MinNotReached'
Text='MinNotReached'/>
</TFT:FormattedTexts>
</TFT:Panel>
Example when Display Sound can be used to play a sound when coin module is out of order and only card payment is available:
<FormattedTextItem PayUnitsName="Card" Text="PurchaseTimeWithCard"
DisplaySound="\Storage Card\media\sound\card_only.wav"/>
