Localize the Clock

This section describes how to override the standard messaging on the clock. For example, you can override the message that is shown after employees clock in to start their shift.

To localize text on the clock:

1. Go to Site Setup > Clock Configuration.
2. In the Clock Configuration Group drop-down list, select a clock config group.
3. Click the Localization tab.
4. In the Culture / Language drop-down list, select the language you want to edit text for.
5. The application shows the default text for the language you selected in the Dayforce Touch Localization File section.
5. In the Dayforce Touch Localization Override File section, update the necessary prompts and messages. You only need to include the parts of the file you want to override; the clock configuration automatically includes the other parts of the default localization file (that is, the configuration specified in the Dayforce Touch Localization File section).
6. When you are finished editing the custom localization file, click Validate.
7. The application validates the localizations you specified. If it finds errors, edit the configuration and then validate it again.
7. When validation completes successfully, click Publish to push the updates to the clock.

Note: Changes that you make to the localization file aren’t reflected on the clock until the software has been updated. The clock updates its software automatically at the interval or time specified in the config file, but you can also update the clock software manually. See Maintenance.

Localization Keys

The clock messaging contains several entries or “keys” that describe a message, prompt, or menu item that can be shown on the clock. You can override these entries by copying the entire entry from the Dayforce Touch Localization File section to the Dayforce Touch Localization Override File, and then updating the necessary parts.

The available keys are described in the sections below.

<validations>

This section controls the messages when the various validations the clock performs either pass or fail. For example, if configured, the "Meal End Validation" is performed when employees clock back in from their meal break. The clock shows the accepted message when the clock entry is accepted, and shows the rejected message when the validation fails. In this case, the validation fails when employees attempt to end their meal break too late or early.

Each entry has the following attributes: 

• validation name: The name of the validation. Don’t alter the validation names themselves.
• For a full list of the validations available in config files, see Clock Program Library.
• accepted: The message shown when the validation passes.
• rejected: The message shown when the validation fails.

The following is an example of a full "Meal End Validation" entry:

<validation name="Meal End Validation" accepted="" rejected="Meal end not scheduled. Next meal end: {MEAL_END}" warning="Note: You punched in too {PUNCH_EXCEPTION}" />

Each message can use a variety of “tokens” that are updated with a specific value when the message is shown. The following tokens can be used:

• {FIRST_NAME}: The first name of the employee who performed the clock entry.
• {LAST_NAME}: The last name of the employee who performed the clock entry.
• {DISPLAY_NAME}: The name of the employee who performed the clock entry based on your organization’s Name Display Format client property setting.
• {BADGE}: The badge number of the employee who performed the clock entry.
• {PUNCH_TYPE}: The type of clock entry being performed, such as Meal Start or Meal End.
• {PUNCH_TIME}: The time when the clock entry was performed.
• {NEXT_SHIFT}: The scheduled start time of the employee’s next shift.
• {NEXT_MEAL}: The scheduled start time of the employee’s next meal.
• {NEXT_BREAK}: The scheduled start time of the employee’s next break.
• {BREAK_END}: The scheduled end time of the employee’s break.
• {NEXT_SHIFT}: The scheduled end time of the employee’s meal.
• {PUNCH_EXCEPTION}: This token is used only with validations that check against an employee’s schedule. It shows whether the employee performed a clock entry early or late, when a validation is rejected.
• {ORG_UNIT_NAME}: The location the employee has transferred to.
• {DEPT_JOB_NAME}: The job assignment the employee has transferred to.
• {DOCKET_NAME}: The docket the employee has transferred to.

<functions>, <supervisor_functions>, <employee_transfer_functions>, <multi_transfer_functions>, <admin_functions>, <admin_datasync_functions>, <biometric_functions>, <photo_functions>, and <relay_control_functions>

Each of these function sections control what is shown when a specific function button or menu is accessed. Each entry controls what is shown when the corresponding button is pressed and the prompt or instruction shown underneath.

Each entry has the following attributes:

• function id: The name of the function. Don’t alter this text.
• For a full list of the available functions, see Clock Program Library.
• name: The name shown when the corresponding function button is shown.
• instruction: The prompt shown underneath the 'name=' text, providing information or prompting the user to perform some action.

<labels>

This section defines the different labels that are shown when menus are accessed on the clock. There are labels for the supervisor mode, admin mode, biometric functions, picture capture, and employee transfers.

In addition, the label id="PunchType" entries define the text that is substituted for the {PUNCH_TYPE} token in the validation messages, while the label id="Validation." entries define the text that can be substituted for the {PUNCH_EXCEPTION} token for rejected validations.

Each of these entries have the following attributes:

• label id: The name of the label. Don’t alter this text.
• name: The name shown when the corresponding menu or validation token is accessed.

<datetimeformat>

This section defines the formats in which dates and times are shown on the clock.

The clock uses the date and time formats listed here: http://developer.android.com/reference/java/text/SimpleDateFormat.html.