Element Path: <cwt><PAYMENT><purchaseFrequencyGuard>
Purchase Frequency Guard is a function that can send event codes to WebOffice if not enough purchases are made within a certain time interval.
One purpose is to detect if there is something wrong with the CWT, which cannot be detected otherwise, for instance a chewing gum stuck in the coin slot.
The purchase frequency guard counts the number of purchases made within the time interval specified by startTime and endTime and if dayType matches the current day. Free purchases are counted if ignoreFreePurchases is set to ”false”.
The counter is reset each day even if the day type is the same. When a period expires, an event is sent to WebOffice if the number of purchases is less than the given threshold. As long as the current event is not reset, no new event will be created. If in the Example: below, the first event is triggered at 14:00 no new event will be triggered at 18:00.
attributes
dayType
| Value: | 0–255 |
| Description: | Day type calendarRule. |
endTime
| Value: | 00:00 – 23:59 |
| Description: | End time of the interval. |
ignoreFreePurchases
| Value: | true / false |
| Default: | false |
| Description: | true = Purchases made with zero ticks are ignored (not counted). |
name
| Description: | Name of the specific purchase frequency guard. Shown in event string. |
startTime
| Value: | 00:00 – 23:59 |
| Description: | Start time of the interval. |
threshold
| Value: | 0-4294967295 |
| Description: | Number of purchases required unless a warning is issued. |
Example:
This Example shows two purchase frequency guards.
The first one, “pm”, requires 10 purchases between 10:00 and 14:00 on days with day type 0. Free purchases are ignored.
The second guard, “am”, requires 20 purchases between 12:00 and 18:00 on days with day type 0. Free purchases are counted.
<PAYMENT>
<purchaseFrequencyGuard name="pm" dayType="0" startTime="10:00"
endTime="14:00" threshold="10" ignoreFreePurchases="true"/>
<purchaseFrequencyGuard name="am" dayType="0" startTime="12:00"
endTime="18:00" threshold = "20" />
</PAYMENT>
