CWT User Interface Design Handbook

Some Click function are able to read several InputTextBoxes but will only pick the först one the find.

E.g., OnCodeInputDone

Priority:

1.UserIdentifierInput

2.CodeInput

3.ExternalPayUnitUserIdentifierInput

4.GetExternalInformationInput

 

OnAccept

Executes an acceptance of all pay units and finalizes the purchase. If the system is configured to print a ticket, the ticket will be printed.

The KeyValue property can be used to force the system to use a specific pay unit when the purchase is accepted. This option can be used if several external pay units are connected to a terminal and the customer shall be able to select which pay unit that shall be used for the payment. If KeyValue is set to “EXT0”, the system will try to debit the external pay unit with id 0. If it is set to “EXT1”, the system will try to debit the external pay unit with id 1. This is only usable for payment service setups with active step function (Prepay Easy Step and Prepay Code Step).

OnAcceptWithBalanceCheck

Checks external pay unit balance. If the balance is sufficient the system proceeds as with OnAccept.

If balance is less than the purchase amount, then the pop-up BalanceInsuffucinetPopup is shown.  When the user presses the Accept button again the system proceeds as with OnAccept.

OnAccessControlCode

Used to accept a code input in the access control code panel. The code data must be inserted in a text box with Name=”CodeInput” in the same panel as where the button is defined.

This click action is only used in the access control code panel.

The customer can use the piezo keyboard or on-screen keyboard to write the access control code input into the text box and then press a button with click action “OnAccessControlCode” to accept the code input and allow the system to check if the access control code is valid and if access is granted to the terminal.

OnAccessControlCodeInputCancel

Aborts the input of access control code and cancels the login attempt.

OnAccessControlUser

Used to enter a user name in the access control user panel. The user data must be inserted in a text box with Name=CodeInput in the same panel as where the button is defined.

This click action is only used in the access control user panel.

The customer can use the full piezo keyboard of the CWT 2115 to write the access control user input into the text box and then press a button with click action “OnAccessControlUser” to enter the user name and allow the system to check if the user is a registered access control user.

OnActivateCardReaderForAccess

This function will activate a card reader so an access control card can be swiped for opening the cabinet doors. The KeyValue property is used to identify the pay unit to activate for card reading.

Possible values for the KeyValue are:

“Ext0”, “Ext1”, “Ext2”, “Ext3”, “Ext4”, “Ext5”, “Ext6”.

It is assumed that 2 values are used by a card reader and the first must be specified as the KeyValue.

NOTE: This function is currently intended for the GLOBALCOM card reader and is possibly not supported for other brands

OnAddAdditionalFeeArticleInPurchase

Used to add an additional fee article to the purchase. Additional fee will be recalculated.
The keyValue shall be the articleId of the additional fee article.

OnAddValue

OnAddValue is used for card value buttons in terminal setups that do not use the step property. OnAddValue will increase or decrease the value to be paid by card depending on the value defined in the KeyValue property (see Section 0).

The KeyValue property is used to define the step height, that is, the number of ticks used to increase or decrease the amount to be paid using the internal card pay unit (credit card or petrol card). If KeyValue is a positive integer, the amount to be paid by card will be increased by that number of ticks. If it is negative, the amount to be paid will be decreased instead.

OnAddValueUntilEndOfInterval

This is used to add value until the end of the current interval. If KeyValue is set to a positive integer x the current button add value for x intervals into future. If IndexValue is set to a positive integer x the current button ignores the first x intervals if they are free intervals.

OnAmountStep

Used for stepwise increase or decrease of the amount to be paid. This action can only be used for the payment services PrePay Easy Step, Prepay Code Step and PostPay Step and provided the step property has been activated for the service.

The KeyValue property of the button control is used to specify the step height as a number of ticks. If the KeyValue property is positive, the value will be added to the amount to pay. If the KeyValue property value is negative, the value will be decreased from the amount to be paid. The amount to be paid can be 0, but not negative.

If KeyValue is set to “100” this will increase the amount to be paid with 100 ticks, while “-50” will decrease the amount with 50 ticks. See CWT Software Configuration Handbook regarding ticks and conversion of ticks to amount (tickFactor).

If step button values are defined on the selected tariff package (to get dynamic step values depending on selected tariff) the defined values will override the value set in KeyValue of the button.

Dynamic mapping of step values from cwtconfig.xml require that the button Name property is set to StepButton1, StepButton2 and StepButton3 to get corresponding value from the configuration file.

OnArticleByNameSelectAndConfirm

Uses the content of a text box to select an article based on the name string. This allows the customer to input the article name using the CWT 2115 full piezo keyboard and then select and confirm the article based on the input.

The “OnArticleByNameSelectAndConfirm” click action requires a TextBox control with Name=”ArticleNameInput” to be defined in the same panel (ArticlePanel) as the button.

This is a convenient way to select articles in set-ups that have a lot of articles with logical names like zones or blocks in a city.

OnArticleConfirm

Used to allow the customer to confirm the selection of an article to proceed to the next step in a purchase (the next step depends on the terminal setup). This confirms the current selection of an article. This action is usually combined with other buttons that has “OnArticleSelect” as click action.

OnArticleSelect

Executes a selection of an article and causes the software to switch to that article. The user interface is updated to reflect the last selection, but the article selection needs to be confirmed before the application continues with the next step in the purchase. The ArticlePanel is presented until the customer confirms the selection with the click action “OnArticleConfirm”, which causes the software to move on to the next step in the purchase.

Which article a button selects is controlled by IndexValue property.

OnArticleSelectAndConfirm

This click action is a combination of the “OnArticleSelect” and “OnArticleConfirm” click actions and allows the customer to select an article and confirm the selection at the same time with a single button press.

See “OnArticleSelect” and “OnArticleConfirm” above for details on their functionality.

OnArticleSelectById

Executes a selection of an article and causes the software to switch to that article. The user interface is updated to reflect the last selection, but the article selection needs to be confirmed before the application continues with the next step in the purchase. The ArticlePanel is presented until the customer confirms the selection with the click action “OnArticleConfirm”, which causes the software to move on to the next step in the purchase.

Which article id a button selects is controlled by KeyValue property.

OnArticleSelectByIdAndConfirm

This click action is a combination of the “OnArticleSelectById” and “OnArticleConfirm” click actions and allows the customer to select an article and confirm the selection at the same time with a single button press. Which article id a button selects is controlled by KeyValue property.

See “OnIdArticleSelectById” and “OnArticleConfirm” above for details on their functionality.

OnArticleSelectInListView

Used to select paymentservice in a ListView control in PaymentServicePanel. Remember that this cannot be used after payment is started.

OnArticleStep

Step between the available articles. This will not affect the PAT selection. Use OnArticleConfirm to move to the next step in PAT selection. Typically used to switch between available articles. Remember that this cannot be used after payment is started.

OnAutoCheckoutTimeStep

Used to step auto checkout time in the current checkin phase. Value to step up and down is specified in KeyValue property on the button. To step up 5 minutes, set KeyValue="+5", to step down 10 minutes set KeyValue="-10".

OnBarcodeReaderStartScanning

This is used to turn the barcode reader on

OnBarcodeReaderStopScanning

This is used to turn the barcode reader off

OnCabinetDoorOpen

The “OnCabinetDoorOpen” click action is used to open one of the terminal's doors. This is typically used from the AccessControlXXXDoorPopup. See Appendix B .

The AccessControlSelectDoorPopup is displayed when the user is allowed to open both the upper and lower doors. The OnCabinetDoorOpen click action is normally only used within that popup panel.

The KeyValue property is used to decide if the upper or lower door shall be opened.

To open upper door set KeyValue="UPPER"

To open lower set KeyValue="LOWER".

To open both doors set KeyValue="BOTH".

OnCheckInOrOut

Function to be used for buttons in CheckInOrCheckOutPopup. IndexValue = 0 means CheckIn, IndexValue = 1, means CheckOut

OnCheckInOrOutTimout

Click function to be used as timeoutEvent in CheckInOrCheckOutPopup. Selection is CheckOut

OnCheckOut

Same as OnCheckInOrOut with IndexValue = 1. The function also includes support for aimed pay unit, e.g. KeyValue = “archipel_gc.dll”.
Used to trigger checkout in single tap post payment.

OnClearArticleNameInput

Used to clear article name input text

OnClearCurrentCard

Clears the data variables of the currently inserted card. Could be used in a purchase scenario when a first card is used for identification and next card is used for payment. The first card is cleared before inserting the second.

OnClearCurrentCardAndAccept

Same as OnClearCurrentCard but with an additional Accept (OnAccept)

OnCloseCurrentPopup

Closes the currently displayed popup

OnCloseCurrentPopupAndAccept

Closes the currently visible popup and executes a “OnAccept”-Click action.

OnCloseCurrentPopupAndPanelOpen

Closes the currently visible popup and executes OnPanelOpen which shows the panel defined by KeyValue.

OnCloseCurrentPopupAndReject

Closes the currently visible popup and executes a “OnReject”-Click action.

OnCloseCurrentPopupAndUpdatePanels

Closes the currently visible popup and executes a panel update.

OnCodeAndExternalPayUnitCreateUserIdentifierInputDone

Used to create external pay unit user identifier code.

The KeyValue of the label must be set to the corresponding external pay unit. It is recommended to use filename of the External Pay Unit dll. But “Ext0”, “Ext1”,...,”Ext7” also works.

Example

KeyValue=” extpu_WPP.dll”

OnCodeAndExternalPayUnitUserIdentifierInputDone

A combination of OnCodeInputDone and OnExternalPayUnitUserIdentifierInputDone. Used to to accept a code input during the purchase and to accept external pay unit user identifier input in the same code input. From CodeInput textbox in the current panel.

The KeyValue of the label must be set to the corresponding external pay unit. It is recommended to use the filename of the External Pay Unit dll. But “Ext0”, “Ext1”,...,”Ext7” also works.

Example:

KeyValue=”extpu_WPP.dll”.

OnCodeInputAndCountrySelectionDone

This function is used to confirm the current selection of a country list and code input. This can be used in configurations where country selection must be done after code input.

OnCodeInputCancel

This is used to cancel the current identification code input. If a input code already is accepted that code is still used even after cancel.

OnCodeInputClear

TFT only

The “OnCodeInputClear” click action clears the text entered in a text box with Name=”CodeInput” in the same panel as the button. Nothing will happen if no text box with Name=“CodeInput” is defined in the same panel.

OnCodeInputDone

The “OnCodeInputDone” click action is used to accept a code input during the purchase. The code data must be inserted in a text box with Name=”UserIdentifierInput” in the same panel as where the button is defined.

This is used in setups with payment services that have userIdentifier=”code” defined in the configuration. See CWT Software Configuration Handbook.

The customer can use the full piezo keyboard of the CWT 2115 to write the code in the text box and then press a button with click action “OnCodeInputDone” to accept the code and move to the next step in the purchase.

OnCodeInputDoneAndAccept

Click-function that combines OnCodeInputDone and OnAccept

OnCodeInputOpen

TFT only

The “OnCodeInputOpen” click action displays the code input panel to allow the customer to enter a code during the purchase.

OnCodeInputPostAccept

Used in CodeInputPostNotOkPopup to continue anyway, even though the entered text is not valid against PostRegEx.

OnCodeInputPostReject

Used in CodeInputPostNotOkPopup to abort when entered text is not valid against PostRegEx.

OnCodeOk

Sets the input code to ok. This click function can be used as an additional click-function in CodeDone-buttons to enable a more quickly hide of CodeInputPanel.

OnConfirmOverpaymentPopupAccept

The “OnConfirmOverpaymentPopupAccept” click action is used to accept a purchase in the popup panel with Name= “ConfirmOverpaymentPopup”. The popup panel “ConfirmOverpaymentPopup” is displayed if the terminal configuration is set to allow the customer to confirm an overpayment before the purchase is accepted. The “OnConfirmOverpaymentPopupAccept” click action is then used to accept the purchase when the popup panel is displayed.

OnConfirmOverpaymentPopupReject

The “OnConfirmOverpaymentPopupReject” click action is used to reject a purchase in the popup panel with Name= “ConfirmOverpaymentPopup”. The popup panel “ConfirmOverpaymentPopup” is displayed if the terminal configuration is set to allow the customer to confirm an overpayment before the purchase is accepted. The “OnConfirmOverpaymentPopupReject” click action is then used to reject the purchase when the popup panel is displayed.

OnConfirmOverpaymentPopupTimeout

This cancels overpayment confirm. Typically used as eventhandler for TimeoutEvent on ConfirmOverpaymentPopup.

OnConfirmPurchasePopup

Closes the ConfirmPurchasePopup and continue with the purchase

OnConfirmTicketPopupTimeout

This click action will force a printout of the ticket. Used in the ConfirmPurchasePopup as timeout event if the user never clicks the button with the OnConfirmPurchasePopup click action.

OnCountryInitialsInputDone

Closes the CountryInitialsInputPanel if it finds at least one matching element in COUNTRYLIST from cwtconfig.xml.  It then automatically opens panel CountrySelectionPanel by calling OnCountrySelectionOpen.

OnCountrySelectionDefaultOpen

Opens CountrySelectionDefaultPanel and populates with COUNTRYLIST from cwtconfig.xml. The number of items shown is determined by Key IndexValue (e.g. if IndexValue = ‘3’ then first tree items from the list are shown)

OnCountrySelectionDone

Used to confirm the current selection of a country list. Used with CountrySelectionPanel.

OnCountrySelectionOpen

Opens CountrySelectionPanel and populates with COUNTRYLIST from cwtconfig.xml.  If called from OnCountryInitialsInputDone, then the list is filtered by input initials

OnCreateAuxGuid

Create Aux Guid separate from purchase

OnDispatchDeliverables

Executes a deliverables in the active article with triggerAction="TriggerFromUI"

OnDisplayBalance

The “OnDisplayBalance” click action executes a general function in the external pay unit application programming interface (API) to display the balance in the external pay unit popup. This feature can only be used if it is implemented in the external pay unit.

OnDoActions

Using this function you can have a button with several click functions with dedicated KeyValues and IndexValues.

The clickfunctions are executed in the order they are listed.

<TFT:Button Click="OnDoActions" >
  <TFT:Action Click="<clickfunction>" KeyValue="<keyValue>" IndexValue="<indexValue>"/>
  <TFT:Action Click="<clickfunction>" KeyValue="<keyValue>" IndexValue="<indexValue>"/>
  ...
</TFT:Button>

OnEnforcementListCancel

Used to cancel the enforcement list

OnEnforcementListDone

Used to print an enforcement list

OnEnforcementListPaybySpaceRangeStepDown

Used to select the Pay By Space Range

OnEnforcementListPaybySpaceRangeStepUp

Used to select the Pay By Space Range

OnEnforcementListPaybySpaceTypeStepDown

Used to select the Pay By Space Range

OnEnforcementListPaybySpaceTypeStepUp

Used to select the Pay By Space Range

OnEnforcementListSpaceRangeSelect

Used to select enforcement list payby space type(paid or unpaid)

OnEnforcementListSpaceTypeSelect

Used to select enforcement list payby space type(paid or unpaid)

OnEnforcementListStepDown

Used to select enforcement list type

OnEnforcementListStepUp

Used to select enforcement list type

OnEnforcementListTypeSelect

Used to select enforcement list type

OnExternalAdditionalUserIdentifierSelectAndStoreAsPurchasePreRequisitesIdentifier

Takes the input from text box AdditionalUserIdentifierInput.

It also populates the purchasePreRequisitesIdentifier if it is not already set.

So, the user does not have to enter an input twice if both UserIdentifierSelect and PurchasePre-Requisites are used.

OnFraudAttempt

Opens the FraudAttemptPanel if it exist, otherwise it opens the FraudAttemptPopup if it exist.

OnExternalAdditionalUserIdentifierSelect

This attribute is used to send the AdditionalUserIdentifier to the ExternalUserIdentifierSelections DLL.

The AdditionalUserIdentifierSelect is populated from GetExternalInformationDonePopup, add KeyValue="AdditionalUserIdentifier" & FormattedText="@GEICO2@json:co2” to the  GetExternalInformationDonePopup.

Example:

<TFT:Label Name="GetExternalInformationLabel4" FormattedText="@GEICO2@json:co2" KeyValue="AdditionalUserIdentifier" MxStyle="{PopupTextGEILabelStyle}"/>

See GetExternalInformation

OnExternalPayUnitUserIdentifierInputDone.

Used to accept a code input during the purchase and to accept external pay unit user identifier input in the same code input. From CodeInput textbox in the current panel.

The KeyValue of the label must be set to the corresponding external pay unit. It is recommended to use filename of the External Pay Unit dll. But “Ext0”, “Ext1”,...,”Ext7” also works.

Example

KeyValue=” extpu_WPP.dll”.

OnGetExternalInformationInputDone

Send a request to WebOffice with code/license-plate or via the current article.

It also populates data for "OnPurchasePreRequisitesIdentifierInputDone", which can be used afterwards without any new code input.

OnExternalPayUnitButton

This click action is used together with UI buttons named ExternalPayUnitButtonN to let an External Pay Unit know which button was pressed. N is the button index that is sent to the External Pay Unit dll.

KeyValue shall be the filename of the External Pay Unit dll.

OnExternalPayUnitGeneralFunction

Used to reject the current buy. It sends a message to Core which resets the purchase.

OnExternalPayUnitPopupTimeout

Event handler for CdsPopupPanel Timeout.

OnExternalPayUnitQuestionAnswer

Used to answer PayUnit questions.

OnExternalPayUnitQuestionAnswerWithoutHide

Eventhandler for Button Click to Answer to PayUnit user text input (like phone number).

Hiding of this popup is done by External Pay Unit when the next popup is shown.

OnExternalPayUnitTextInputDone

Eventhandler for Button Click to Answer to PayUnit user text input (like password).

OnExternalPayUnitTextInputWithoutHidePopupDone

Eventhandler for Button Click to Answer to PayUnit user text input (like password).

The popup remain open until the External Pay Unit hides it.

OnExternalPayUnitUserIdentifierInputDone

Used to accept external pay unit user identifier input. From CodeInput textbox in the current panel.

OnForceValidPurchasePreRequisites

Forces the purchase requisites to be valid to make the system not waiting for a purchase prerequisites identifier and locking pay units. Used when purchase prerequisites is configured but not needed in this (top-up) purchase.

OnFraudAttempt

Opens the FraudAttemptPanel if it exist, otherwise it opens the FraudAttemptPopup if it exist

OnGeneralInputDone

Used with GeneralInputTextBox. The click function stores a key-value pair as General Input. The key is defined in GeneralInputTextBox and the value is the entered text in the textbox.

OnGetExternalPayUnitUserIdentifier

This is used to get external pay unit user identifier code.

The KeyValue of the label must be set to the corresponding external pay unit. It is recommended to use filename of the External Pay Unit dll. But “Ext0”, “Ext1”,...,”Ext7” also works.

Example

KeyValue=” extpu_WPP.dll”

OnGetTariffDescriptionalSteps

Used to trigger calculation of Tariff Descriptional Steps and show the result in the TariffDescriptionalStepsPopup

OnHelpOpen

Used to open the HelpPanel to display user help for the terminal.

OnHelpPanelClose

Used to close the HelpPanel.

This is used to open the HelpPanel to display user help for the terminal.

OnHelpPanelSelectItem

Used to select which label to show in the help panel. Set KeyValue to the label name of the label to display on key press. The label must be defined in the same panel as the button. To display HelpTextLabel set KeyValue="helpTextLabel".

Hides Idle panel. typically used for a start button to exit from idle panel.

OnInfoOpen

This is used to open the InfoPanel to display user info for the terminal.

OnInfoPanelClose

This is used to close the InfoPanel.

OnInfoPanelOpen

This is used to open the InfoPanel.

OnInfoPanelSelectItem

Used to select which label to show in the info panel. Set KeyValue to the label name of the label to display on key press. The label must be defined in the same panel as the button. To display InfoTextLabel set KeyValue="infoTextLabel".

OnKeyAddText

STN only

OnKeyAddText click action is primarily used for text input with the KeyboardButton control that is used to map all keys in the alpha-numeric keyboard of a CWT-C or CWT 2115 to text inputs.

The click action can, however, be used by a regular button control for using the 4 dynamic buttons on the CWT-C or the 8 dynamic buttons on both sides of the  CWT 2115 display for very basic character inputs in a TextBox control with the name set to “CodeInput”. The KeyValue property of the button is used to define what character (single character only) that shall be the input from the button definition.

OnKeyboardHit

TFT only

OnKeyboardHit click action is used for text input from an alpha-numeric keyboard presented on the display.

This click action inputs the character defined in the KeyValue property to a TextBox control with the name set to “CodeInput” in the same panel as the button.

The KeyValue property of the button is used to define what character (single character only) that shall be the input from the button definition. This allows multiple buttons in a software keyboard to use OnKeyboardHit click action with different KeyValue properties for the corresponding character for the button.

OnKeyCurrentPanelButton

Handler for external buttons or inputs, e.g.  piezo buttons, Wakeup button or  Top Hat sensor.

KeyValue is the ButtonLocationName used in button in a panel or popup.

Id Is the Key value created by the application, when an external button is pressed.

When an external button is pressed the handler runs the Click function for button in current panel or popup, where the ButtonLocationName is the same as the KeyValue defined when calling OnKeyCurrentPanelButtonEvent.

Example:

<TFT:Form ...>
 ...
 </Controls>
 ...
 <Keyboard>
   <!-- J23-Pin3 Low -->
   <TFT:PiezoButton Id="1000" KeyValue="WakeUpButton" Click="OnKeyCurrentPanelButton"/>
   ...
 </Keyboard>
</TFT:Form>

Please see Soft Buttons and Colour TFT Display with Soft Buttons for more information"

OnKeyShiftToggle

Toggle shift functionality of the keyboard.

OnKillPopupTimer

The click-function kills the current popup event timer

OnLanguageSelectionCancel

The “OnLanguageSelectionCancel” click action closes the language selection popup (if presented) and does not change the current language in the user interface.

This click action is normally used in the language selection popup only.

OnLanguageSelectionDone

The “OnLanguageSelectionDone” click action is used to confirm the current selection of a language. This applies the selected language to the user interface and closes the language selection popup.  

This click action is normally used in the language selection popup only.

OnLanguageSelectionOpen

“OnLanguageSelectionOpen” click action opens the language selection popup if it is defined in the user interface file.

This click action is used for all buttons that shall display the popup for selection of the user interface language. If no popup panel with Name=”LanguageSelectionPopup” is defined in the user interface file, nothing will happen when a button with OnLanguageSelectionOpen click action is pressed.

OnLanguageStepDown

STN only

The “OnLanguageStepDown” click action is used to step down in the language selection list view.

In the language selection popup, a ListView control must be defined (see Section 6.11) with Name=”LanguageSelectionListView”. This control displays the pre-defined languages from the terminal configuration (see CWT Software Configuration Handbook).

The “OnLanguageStepDown” click action steps the selection bar in the list downward one step for each button press. This click action is normally used in the language selection popup only.

OnLanguageStepToggle

Used to step down in the language selection listview control in LanguageSelectionPopup. When the last item has been reached the first one is chosen

OnLanguageStepUp

STN only

The “OnLanguageStepUp” click action is used to step upwards in the language selection list view.

In the language selection popup, a ListView control must be defined (see Section 6.11) with Name=”LanguageSelectionListView”. This control displays the pre-defined languages from the terminal configuration (see CWT Software Configuration Handbook).

The “OnLanguageStepUp” click action steps the selection bar in the list upward one step for each button press. This click action is normally used in the language selection popup only.

OnNoTicketConfirm

Used to confirm ticket print out when CdsCore is setup with Ticket=Confirm. This is typically used in ConfirmNoTicketPopup to get a ticket printout.

OnNoTicketDecline

Click function to be used for deny button in ConfirmNoTicketPopup

OnOnlineAccessControl

Used to show the  OnlineAccessControlUserPanel.

A hidden button that can be placed in the idle panel.

This click function is only used if a terminal access authorization is performed online by back office.

OnOnlineAccessControlCode

Used to accept a code input in the OnlineAccessControlCodePanel. The code data must be inserted in a text box with Name=”CodeInput” in the same panel.

This click function is only used if a terminal access authorization is performed online by back office.

OnOnlineAccessControlUser

Used to accept a user name input in the OnlineAccessControlUserPanel. The user data must be inserted in a text box with Name=CodeInput in the same panel.

This click function is only used if a terminal access authorization is performed online by back office.

OnOpenGetExternalPayUnitUserIdentifier

The “OnOpenGetExternalPayUnitUserIdentifier” click action open the “ExternalPayUnitUserIdentifierInputPanel“ for entering the used identifier. Enter 0-8 characters.

OnPanelOpen

Navigates to a new panel.

OnPanelOpenAndCloseCurrentPopup

The click-function displays a panel defined by KeyValue and closes current Popup

OnPanelOpenGetCode

Navigates to a new panel.

OnPayBySpaceSelectionPrintOutDone

This is used to select a space print out from a list

OnPaymentServiceConfirm

OnPaymentServiceConfirm click action allows the customer to confirm the selection of a payment service and then proceed to the next step in a purchase (the next step depends on the terminal setup). This action is usually combined with other buttons that have “OnPaymentServiceSelect” as click actions.

OnPaymentServiceSelect

Executes a selection of a specific payment service. The user interface is updated to reflect the last selection, but the selection of payment service needs to be confirmed before the application continues with the next step in the purchase. The software keeps presenting the payment service panel until the customer confirms the selection by pressing a button (click action “OnPaymentServiceConfirm”).

Which payment service a button selects is controlled by IndexValue property.

OnPaymentServiceSelectAndConfirm

This click action is a combination of the “OnPaymentServiceSelect” and “OnPaymentServiceConfirm” click actions. It allows the customer to select a payment service and confirm the selection at the same time with a single button press.

See “OnPaymentServiceSelect” and “OnPaymentServiceConfirm” above for details on their functionality.

OnPaymentServiceSelectById

Executes a selection of a specific payment service. The user interface is updated to reflect the last selection, but the selection of payment service needs to be confirmed before the application continues with the next step in the purchase. The software keeps presenting the payment service panel until the customer confirms the selection by pressing a button (click action “OnPaymentServiceConfirm”).

Which payment service id a button selects is controlled by KeyValue property.

OnPaymentServiceSelectByIdAndConfirm

This click action is a combination of the “OnPaymentServiceSelectById” and “OnPaymentServiceConfirm” click actions. It allows the customer to select a payment service and confirm the selection at the same time with a single button press.

See “OnPaymentServiceSelectById” and “OnPaymentServiceConfirm” above for details on their functionality. Which payment service id a button selects is controlled by KeyValue property.

OnPaymentServiceSelectInListView

Used to select paymentservice in a ListView control in PaymentServicePanel. Remember that this cannot be used after payment is started.

OnPayWithCardPopupDone

Closes the popup PayWithCardPopup and continues with the purchase.

OnPersonalAccountCodeSelectionDone

The “OnPersonalAccountCodeSelectionDone” click action is used to confirm the current selection of a code associated with an online account in the PersonalAccountCodeSelectionPopup.

Buttons that use this click function can be dynamically named ‘CodeButton1’ where the number can be changed for more more buttons. See examples for Payment Service, Article and Tariff at  section 7.5 or 8.4.

OnPersonalAccountIdentityInputDone

The “OnPersonalAccountIdentityInputDone” click action uses the text input in a text box with Name=”PersonalAccountIdentifierInput” in the same panel as the button and sets an account identifier. This allows the terminal to fetch a personal account.

This click action is used in the “PersonalAccountIdentifierInputPanel” to accept the entered PIN code string in the PersonalAccountPinInput text box.

OnPersonalAccountPinCodeInputDone

The “OnPersonalAccountPinCodeInputDone” click action uses the text input in a text box with Name=”PersonalAccountPinInput” in the same panel as the button and sets as PIN code for the currently selected personal account.

This click action is used in the “PersonalAccountPinCodeInputPanel” to accept the entered PIN code string in the text box PersonalAccountPinInput.

OnPopupPanelClose

TFT:

“OnPopupPanelClose” click action hides a popup panel. The name of a defined popup panel must be entered as KeyValue to allow the software to find and hide the popup panel. See Section 7.3 for details on how to define PopupPanels.

STN:

“OnPopupPanelClose” click action hides all open popup panels. No name is required as with TFT.

OnPopupPanelCloseAll

This is used to close a Popup Panel

OnPopupPanelOpen

“OnPopupPanelOpen” click action displays a popup panel. The name of a defined popup panel must be entered as KeyValue to allow the software to find and display the popup panel. See Sections 6.3 and 7.3 for details on how to define popup panels for the STN and TFT display type respectively.

OnPreviousPurchaseIdentifierInputDone

Click actions gets previous purchase data from WebOffice or local database and then displays the PreviousPurchaseDisaplyPopup

OnPurchasePreRequisitesDone

Forces the purchase requisites identifier to be valid to avoid presenting PurchasePreRequisitesIdentifierInputPanel after OnPurchasePreRequisitesIdentifierInputDone (instead of waiting for the identifier to be validated)

OnPurchasePreRequisitesIdentifierInputDone

Confirms the text input for purchase prerequisites in PurchasePreRequisitesIdentifierInputPanel and sends the request to backoffice.

OnPurchasePreRequisitesLoginAuthTokenInputDone

Confirms the text input for the purchase prerequisites login authorization code and opens the PurchasePreRequisitesCodeInputPanel

OnPurchasePreRequisitesLoginAuthTokenAndIdentifierInputDone

used when an Identifier is entered first.

OnReadInput

Read the state of the current inputs and re-trigger all events for the asserted inputs. Inputs currently supported are Wakeup button, STN button, Top hat sensor and Start button.

OnReject

Executes a rejection to abort the current purchase. The KeyValue or KeyIndex properties of the button control are not used for OnReject.

OnRemoveAdditionalFeeArticleFromPurchase

Used to remove additional fee articles from the purchase. The additional fee will be recalculated.
The KeyValue shall be the articleId of the additional fee article.

OnRemoveTicketForwardingEmailAddress

Used to remove previously entered ticket forwarding email address.

OnRemoveTicketForwardingPhoneNumber

Used to remove previously entered ticket forwarding phone number.

OnRemoveTicketForwardingPhoneNumberOrEmailAddress

Used to remove previously entered ticket forwarding phone number or email address.

OnRfidWakeUp

Used to wake up rfid. cwtconfig property <CORE rfid="ButtonControlled">

OnScreensaverPanelHide

This is used to hide the screensaver panel. It can be used on a button or on a panel (typically the screensaver panel so the screensaver is hidden when user touch the screen).

OnSelectNextItem

Step down the selection in the ListView if not at the last entry. If the last entry is selected nothing happens.

OnSelectNextItemWithWrapAround

Step down the selection in the ListView if not at the last entry. If the last entry is selected it will wrap around and select the top entry in the Listview.

OnSelectPreviousItem

Step up the selection in the ListView if not at the top entry. If the top entry is selected nothing happens.

OnSetStartDate

Used to set start date in the current purchase.

OnSetTftBacklight

OnSetTftBacklight is used to control the TFT Backlight brightness using buttons. The brightness can be controlled by percentage steps or by fixed percentage values.

The brightness level is restored after the purchase.

KeyValue defines increase or decrease steps or fixed values.

“+10” means add 10%, “-10” means decrease 10%.

A KeyValue without plus or minus sign is treated as fixed values.

When decreasing with steps the brightness does not go below the minimum value defined in <cwt><CORE><TFTBacklight><brightnessMin> in the configuration file.

The default value for this element is zero (0)

OnShowTariffMaxExceededOrPanelOpen

Shows the popup TariffMaxExceededPopup if some maximum tariff restriction (blocked, units, ticks) is exceeded. Otherwise OnPanelOpen is executed which shows the panel defined by KeyValue.

OnSilentReject

The click-function is the same as OnReject but "Purchase cancelled"-popup is not shown

OnSpaceInputClear

This is used to clear the code input textbox (name SpaceInput) in the current panel.

OnSpaceRangeEndSelectDone

used to select the end space for the enforcement list pay by space type(paid or unpaid)

OnSpaceRangeStartSelectDone

used to select the starting space for the enforcement list pay by space type(paid or unpaid)

OnStep

Works as OnAmountStep and OnTimeStep depending on the value of buttonType defined for the step button in cwtconfig. If no type is defined, Time is default.

OnStepTimeAmountDone

enables the pay units and payment can be done if Tabular Vat is in use for the current day type

OnStepToEndDate

Used to set end date in the current purchase.

If it does not find any datetimepicker, it will set the end time to now, and will step the amount according to the tariff.

Example:

Add an autoclick button to PrePay_Code_Step_Panel1

<TFT:Button MxStyle="{AcceptButtonVisualStyle}" Name="StepEndDate" Size="0,0" Click="OnStepToEndDate" AutoClick="true"/>

OnStepUntilEndOfInterval

This is used to add value until the end of the current interval. If KeyValue is set to a positive integer x the current button add value for x intervals into future. If IndexValue is set to a positive integer x the current button ignores the first x intervals if they are free intervals.

OnStepUntilMaxOrBlocked

Steps the amount until maximum or blocked restriction is reached

OnStepWantedEndDate

Used in EnDateSelectionPanel when stepping end date with time step buttons.

OnStoreCodeInput

Used to store code input so the UserIdentifierLabel can be used before OnCodeInputDone is called.  This should only be used in cases where code input is not immediately confirmed with OnCodeInputDone and it is instead postponed and confirmed later together with some other related parameter (e.g. OnCodeInputAndCountrySelectionDone).

OnStorePurchasePreRequisitesIdentifierAndOpenEndDateSelectionPanel

Used in PurchasePreRequisitesIdentifierInputPanel as done button click action to store the selected purchase pre-requisites identifier and open EndDateSelection panel.

OnStoreRecallUserSelection

click function for confirmation of Recall answers.

Click="OnStoreRecallUserSelection" KeyValue="Yes/No"

OnSystemCheckOutConfirm

Click function to be used for botton in CheckOutFailedSystemCheckOutConfirmPopup

OnSystemCheckOutConfirmTimeout

Click function to be used as timeoutEvent in CheckInOrCheckOutPopup

OnTariffConfirm / OnTariffPackageConfirm

Allows the customer to confirm the selection of a tariff package to proceed to the next step in a purchase. The next step depends on the terminal set-up. This action is usually combined with other buttons that have the click action “OnTariffSelect”.

OnTariffInfoClose

Used to close the TariffInfoPopup.

OnTariffInfoOpen

Used to display TariffInfoPopup to display the tariff info poup.

OnTariffSelect / OnTariffPackageSelect

Executes selection of a tariff package which causes the software to switch to that tariff package.

The software remains in the tariff package panel and the user interface is updated to reflect the last selection. When the customer confirms the selection with the click action “OnTariffConfirm”, the software moves on to the next step in the purchase.

The tariff package a button selects is controlled by the IndexValue property.

OnTariffSelectAndConfirm / OnTariffPackageSelectAndConfirm

This click action is a combination of the “OnTariffSelect” and “OnTariffConfirm” click actions and allows the customer to select and confirm a tariff package at the same time with a single press of a button. See “OnTariffSelect” and “OnTariffConfirm” above for details on the functionality.

Used to select the active tariff package and also confirm the selection in the application. Typically used on the tariffpackagepanel on tariff buttons. Remember that this can't be used after payment is started.

OnTariffSelectById / OnTariffPackageSelectById

Executes selection of a tariff package which causes the software to switch to that tariff package.

The software remains in the tariff package panel and the user interface is updated to reflect the last selection. When the customer confirms the selection with the click action “OnTariffConfirm”, the software moves on to the next step in the purchase.

The tariff package id a button selects is controlled by the KeyValue property.

OnTariffSelectByIdAndConfirm / OnTariffPackageSelectByIdAndConfirm

This click action is a combination of the “OnTariffSelectById” and “OnTariffConfirm” click actions and allows the customer to select and confirm a tariff package at the same time with a single press of a button. See “OnTariffSelectById” and “OnTariffConfirm” above for details on the functionality. The tariff package id a button selects is controlled by the KeyValue property.

OnTariffSelectInListView

Used to select paymentservice in a ListView control in TariffPackagePanel. Remember that this cannot be used after payment is started.

OnTerminalMeasurement

used to trigger battery voltage measurement or modem network status scan.

KeyValue BatteryVoltage  triggers terminal Battery voltage measurement and update BatteryVoltageLabel

KeyValue ModemNetworkStatus triggers modem network status scan and update the labels

OnTicketConfirm

The “OnTicketConfirm” is used for terminal setups that have the property ticket=”Confirm” defined in PAYMENTSERVICE (see CWT Software Configuration Handbook). The OnTicketConfirm click action confirms that a ticket will be printed. This makes it possible to let the customer choose to print a ticket by pressing a button that has OnTicketConfirm as click action.

OnTicketDecline

Click function to be used for deny button in ConfirmTicketPopup

OnTicketForwardingEmailAddressInputDone

The click-function sends the ticket forwarding email address from textbox with Name=TicketForwardingEmailAddressInput to application.

OnTicketForwardingPhoneNumberInputDone

The click-function sends the ticket forwarding phone number from textbox with Name=TicketForwardingPhoneNumberInput to application.

OnTicketForwardingPhoneNumberOrEmailAddressInputDone

The click-function sends the ticket forwarding phone number or email address from textbox with Name=TicketForwardingPhoneNumberOrEmailAddressInput to application. If the text contains a ‘@’ it is treated as an email address otherwise a phone number

OnTimeStep

Used for stepwise increase or decrease of the time to be purchased. This action can only be used for the payment services PrePay Easy Step, Prepay Code Step and PostPay step. The step property must have been activated for the service.

The KeyValue property of the button control is used to specify the step height as a number of minutes. If a positive integer value is set, the terminal will try to increase the time with the number of minutes defined in KeyValue. If a negative value is set, the terminal will try to decrease the time.

If the terminal reaches the defined maximum time from the tariff package, the stepped time may become truncated.

If step values are defined on the selected tariff package, (to get dynamic step values depending on selected tariff) the defined values will override the value set in KeyValue of the button.

Dynamic mapping of step values from the cwtconfig.xml require that the Name property of the button is set to StepButton1, StepButton2 and StepButton3 to get corresponding value from config file. This is used for stepwise increase or decrease of the time to be purchased. This action can only be used for the payment services PrePay Easy Step and Prepay Code Step. The step property must have been activated for the service.

Smart stepping. When stepping negative steps into a free interval the step length in minutes is adjusted to enable “landing” before the free interval. Also, for a too small step in time, i.e. less than the time for one tick, the step length in minutes is adjusted. These adjustments are called smart stepping and is turned on by default since IndexValue is 0 by default.

If You want to turn off smart stepping set the IndexValue to a figure larger than zero (0).

OnTriggerInfoEventDirect

Sends info event to WebOffice directly

OnTurnOutletOff

If an outlet is configured to be ButtonControlled the click-functions OnTurnOutletOn and OnTurnOutletOff controls the outlet.

OnTurnOutletOff will turn a given outlet OFF and if a timer is given the outlet will be turned ON when the timer fires.

KeyValue is the outlet name. Valid outlets see OnTurnOutletOn

IndexValue is timer value [s] when the outlet is turned ON. If IndexValue is 0 no timer is activated

OnTurnOutletOn

If an outlet is configured to be ButtonControlled the click-functions OnTurnOutletOn and OnTurnOutletOff controls the outlet.

OnTurnOutletOn will turn a given outlet ON and if a timer is given the outlet will be turned OFF when the timer fires.

KeyValue is the outlet name. Valid outlets "12V_1", "12V_2", "12V_MDB", "5V_COM_1", "5V_COM_3", "5V_COM_4", "5V_COM_8", "5V_COM_9", "IOPORT_OUT_0", "IOPORT_OUT_1", "IOPORT_OUT_2", "IOPORT_OUT_3", "IOPORT_OUT_4", "IOPORT_OUT_5", "IOPORT_OUT_6"

IndexValue is timer value [s] when the outlet is turned OFF. If IndexValue is 0 no timer is activated

OnUndoCodeInput

Button event handler used to regret the code input (clear code input done flag) which should display code input again for new input.

OnUndoLastPatConfirm

Button event handler used to cancel the last confirm in the PAT selection process. If article was confirmed as the last step this will cancel the article confirm which should display the article panel again.

OnZeroAmountStep

Starts the purchase, same as OnAmountStep(0). Can be used as Popup.TimeoutEvent function