Meal confirmation prompt configuration for the clock

The clock contains an out-of-the-box configuration for the meal prompt confirmation that is suitable for most use cases and business requirements.

This topic outlines some basic configuration and behaviour that has been built into the prompt framework.

The clock.xml file contains this XML for the configuration of the meal confirmation prompt:


<prompt id="MEAL_CONFIRM" code="MEAL" type="options"  >
	<trigger punch="OUT" />
	<option id="NO" order="1" acceptSwipe="true" data="N" />
	<option id="YES" order="2" acceptSwipe="true" data="Y"/>
	<cancel allowed="true" acceptSwipe="false" data="C" message="MEAL_CONFIRM_REQUIRED" 
	swipeRejectedReason="MEAL_CONFIRM_CANCELLED"  />
	<timeout seconds="10" acceptSwipe="false" data="T" swipeRejectedReason="MEAL_CONFIRM_TIMEDOUT"  />
</prompt>

The information presented here will be explained in the context of the above out-of-the-box configuration. Further configuration changes are possible to suit your business requirements.

Timeout configuration for the meal confirmation prompt

As per the configuration above, if the meal confirmation prompt times out:

  • The employee is not clocked out. See acceptSwipe="false" in this part of the syntax above:
    
    <timeout seconds="10" acceptSwipe="false" data="T" 
    swipeRejectedReason="MEAL_CONFIRM_TIMEDOUT" />
  • The clock journal records a rejected message of MEAL_CONFIRM_TIMEDOUT. This message can be localized in the clock.properties file of your clock configuration.
  • The employee is returned to the badge entry screen without a message.
  • A code of MEAL=T is captured in the EXTRADATA of the clock transaction. This is determined by code="MEAL" and data="T" syntax in the XML configuration above.

Cancelling the meal confirmation prompt

If the employee selects the ESC button during a meal confirmation prompt:

  • The employee is not clocked out. See acceptSwipe="false" in this part of the syntax above:
    
    <cancel allowed="true" acceptSwipe="false" data="C" 
    message="MEAL_CONFIRM_REQUIRED" swipeRejectedReason="MEAL_CONFIRM_CANCELLED" />
  • The employee is shown a message of MEAL_CONFIRM_REQUIRED and a rejected message of MEAL_CONFIRM_CANCELLED is recorded in the clock journal. These messages can be localized in the clock.properties file of your clock configuration.
  • A code of MEAL=C is captured in the EXTRADATA of the clock transaction. This is determined by code="MEAL" and data="C" syntax in the XML configuration.

UI configuration for default meal confirmation prompt

As per the above configuration in the XML file, the option IDs of option id="NO" order="1" and option id="YES" order="2" mean that the function key options for the user on the clock of No and Yes will display in horizontal positions 1 and 2 on the clock. This corresponds to function keys F1 and F2 of four possible horizontal function keys on the clock.