Configuring Acoustic Signals

Configuration files
  • ..\parameter\client\flow\signalConfigs.properties
  • ..\parameter\client\flow\decisionDialogConfigs.properties
  • ..\parameter\client\flow\messageDialogConfigs.properties
  • ..\parameter\client\flow\promptUserDialogConfigs.properties

Acoustic signals can be defined for various dialog types. These include:

  • Confirmation dialogs
  • Warning dialogs
  • Decision dialogs
  • Entry fields

The following two steps are necessary to configure an acoustic signal:

  1. Adding the signal in the file signalConfigs.properties
  2. Assigning the signal to the desired dialog

Adding the signal in the file signalConfigs.properties

Add the signal in the file signalConfigs.properties . The entry may look as follows:

SignalConfigs.paymentcancel=include\:SignalConfigs.Default
SignalConfigs.paymentcancel.id=paymentcancel

The following has to be indicated:

  • the default configuration
  • an ID

Additionally, different signals for the desired dialog may also be entered. This may look as follows:

SignalConfigs.paymentcancel.signalType=SoundFile
 SignalConfigs.paymentcancel.soundFile=${pos.root.dir}/config/standard/parameter/client/media/test.wav

The following has to be indicated:

  • signal type: signalType=SoundFile and
  • path to the stored sound file in the parameter soundFile

The signal is played via the PC loudspeaker by default (signalType=PCSpeake. In addition to playing via a sound file (signalType=SoundFile), the signal may also be played via the scanner (signalType=ScannerBeep).

Adding the respective signal to the desired dialog

In the next step, assign the respective signal to the desired dialog. The assignment is possible for dialogs that are referenced in the following files:

  • decisionDialogConfigs.properties
  • messageDialogConfigs.properties
  • promptUserDialogConfigs.properties

Add the signalConfigId to the respective file { ...} DialogConfigs.properties.

The signalConfigId corresponds to the entry in the file signalConfigs.properties that appears in front of the =include.

It does not necessarily have to correspond to the ID in the file signalConfigs.properties . This ID is only for logging purposes. An example of an entry in the file messageDialogConfigs.properties looks as follows:

 MessageDialogConfigs.ConfirmCancelPayment.messageKey=payment.cancel.confirm.message
 MessageDialogConfigs.ConfirmCancelPayment.signalConfigId=SignalConfigs.paymentcancel

In this example, for the dialog Do you want to enter more items?, the signal with

id=SignalConfigs.paymentcancel

is played.

The translation key is stored in the file ui-translation_{language_country}.properties :
payment.cancel.confirm.message=M\u00F6chten Sie weitere Positionen erfassen?