This section describes how to override the standard messaging on the Dayforce Clock Pro and Clock+. For example, you can override the message that’s shown after employees clock in to start their shift.
Note: Some default text on the clocks can’t be overridden.
To localize text on the clocks:
- Go to Site Setup > Clock Configuration.
- In the Device Type drop-down list, select Dayforce Touch / Pro or Clock+.
- In the second drop-down list, select Unified.
- In the Clock Configuration Group drop-down list, select a clock configuration group.
- Click the Localization tab.
- In the Culture / Language drop-down list, select the language that you want to edit text for.
- Dayforce shows the default text for the language that you selected in the localization file section.
- In the override file section, update the necessary prompts and messages. You only need to include the parts of the file that you want to override.
- When you’re finished editing the custom localization file, click Validate.
- Dayforce validates the localizations that you specified. If it finds errors, edit the configuration and then validate it again.
- When validation completes successfully, click Publish to push the updates to the clock.
The Dayforce Clock Pro won’t reflect the changes that you made to the localization file until you update the software. 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 Clock Maintenance (Dayforce Clock Pro Only).
Localization Keys
The Localization tab contains several entries or “keys” that represent a message, prompt, or menu item that’s shown on the clocks. You can override these entries by copying the entire entry from the localization file and pasting it in the localization override file, and then updating the necessary parts.
The available keys are described in the sections below.
<validations id="validations">
This section controls the messages that are shown when the various validations that the clock performs either pass or fail. For example, if configured, the clock runs "MealEndValidation" 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.
These entries have a combination of the following attributes:
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 Libraries.
Accepted: The message shown when the validation passes.Rejected: The message shown when the validation fails.Warning: The message shown
The following is an example of a full "MealEndValidation" entry:
<validation id="MealEndValidation" Name="Meal End Validation" Rejected="Meal end not scheduled. Next meal end: {MEAL_END}" Warning="Note: You clocked in too {PUNCH_EXCEPTION}" />Each message supports tokens that are updated with a specific value when the message is shown. The following tokens are supported:
{BADGE}: The badge number of the employee who performed the clock entry.{BREAK_END}: The scheduled end time of the employee’s break.{DEPT_JOB_NAME}: The job assignment the employee transferred to.{DISPLAY_NAME}: The name of the employee who performed the clock entry based on your organization’s Name Display Format client property setting.{DOCKET_NAME}: The docket that the employee has transferred to.{FIRST_NAME}: The first name of the employee who performed the clock entry.{LABOR_METRICS_CODE}: The labor metrics code that the employee transferred to.{LABOR_METRICS_TYPE}: The labor metrics type that the employee transferred to.{LAST_NAME}: The last name of the employee who performed the clock entry.{LAST_PUNCH_TYPE}: The last type of clock entry that was performed.{MEAL_END}: The scheduled end time of the employee’s meal.{NEXT_BREAK}: The scheduled start time of the employee’s next break.{NEXT_MEAL}: The scheduled start time of the employee’s next meal.{NEXT_SHIFT}: The scheduled start time of the employee’s next shift.{ORG_UNIT_NAME}: The location that the employee transferred to.{PROJECT_NAME}: The project that the employee transferred to.{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.{PUNCH_TIME}: The time when the clock entry was performed.{PUNCH_TYPE}: The type of clock entry being performed, such as Start Meal or End Meal.{QUANTITY}: The docket transfer’s quantity.{TIP_AMOUNT}: The employee’s tip amount.{TIP_NAME}: The employee’s tip type.
<functions>
The localization files contain several <functions> sections that control what the clock shows when users click a specific function button or open a menu. Each entry controls what’s shown when a user clicks the corresponding button and the prompt or instruction that’s shown on the clock.
| Section | Clock Pro Support | Clock+ Support |
|---|---|---|
| functions id="admin" | √ | √ |
| functions id="biometric" | √ | √ |
| functions id="datasync" | √ | |
| functions id="functions" | √ | √ |
| functions id="meal_waive" | √ | √ |
| functions id="multi_transfer_menu" | √ | √ |
| functions id="photo" | √ | |
| functions id="relay_control_menu" | √ | |
| functions id="supervisor_menu" | √ | √ |
| functions id="transfer" | √ | √ |
The <functions> entries have a combination of 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 Libraries.
name: The text that’s shown on the function’s button in the clock user interface.instruction: The prompt that’s shown after a user clicks the corresponding button. The instruction provides information or prompts the user to perform an action.
<labels id="labels">
This section controls the different labels that the clock shows when users open menus. The localization file contains labels for supervisor mode, admin mode, biometric functions, and employee transfers, among others.
Further, some of these labels correspond to the tokens that are supported in the <validations> section. For example, the label id="PunchType" entries control the text that’s substituted for the {PUNCH_TYPE} token in the validation messages. Another example: the label id="Validation" entries control the text that’s 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.value: The text that the clock shows when users open the corresponding menu or validation token.