Functions

Clocks Guide

Version
R2024.2.0
Functions

This section describes the functions that are available on the clock, and where they are shown on the clock.

Unless otherwise noted in the descriptions below, all functions in this section have the following attributes:

  • key: Allows you to specify the order in which buttons are shown on the home screen. The keys are shown in the following order on the home screen:
  • Grid showing F1 to F10 placement.
  • For example, to specify that the Start Shift button is shown in the top left corner, assign it to the F1 key. Similarly, to show the End Shift button at the bottom right corner, assign it to the F10 key.
  • If necessary, you can configure the clock to show two pages of buttons. Functions assigned keys F1 - F10 are shown on the first page, and functions assigned keys F11 - F20 are shown on the second page. For example, to show the Supervisor button in the top left corner of the second page of the home screen assign it the F11 key.
  • Note: Although you can configure ten buttons per page, a maximum of eight is recommended to ensure that the text associated with buttons is shown correctly in all languages.
  • rc: Sets which functions can open or close relays. To specify that a function opens or closes a relay, specify rc="yes".
  • camera: Sets the functions for which the clock captures employees’ pictures. To specify that the clock should capture an employee’s picture, specify camera="yes".
  • submit_bio_failure: Sets whether the clock submits clock entries for the function if the clock entries fail biometric verification. When these clock entries are submitted into Dayforce, managers (or other users with necessary access) can review them in the Clock Data panel in Timesheets.
  • To specify that clock entries for a function should be submitted to the application, even when they fail biometric verification, specify submit_bio_failure="yes".
  • show_next_shift: Controls whether the clock shows an employee’s next scheduled shift when they clock in and out.
  • Note: This is typically used when clocking out, when using functions such as "out" or "out_tip".
  • bio_off: Determines if biometric verification is required for the function, for clocks that support biometrics. Enter bio_off="yes" to bypass biometric validation for a function, or enter bio_off="no" to require biometric validation for a function.

The functions available are described below:

"in"

Enables the Start Shift button on the home screen, which employees use to clock in for their shifts.

"out"

Enables the End Shift button on the home screen, which employees use to clock out from their shifts.

"start_meal"

Enables the Start Meal button on the home screen, which employees use to start their meals.

"end_meal"

Enables the End Meal button on the home screen, which employees use to end their meals.

"start_break"

Enables the Start Break button on the home screen, which employees use to start their breaks.

"end_break"

Enables the End Break button on the home screen, which employees use to end their breaks.

"employee_transfer"

Enables the Transfer button on the home screen, which employees use to initiate transfers.

"supervisor"

Enables the Supervisor button on the home screen, which supervisors use to access supervisor mode.

"in_with_position_transfer"

Enables the Start Shift button that employees can use to clock in at locations where they don’t already have a work assignment. When their clock entry is submitted, the application automatically creates the necessary work assignment.

For more information about this functionality, see Enable Clocking Without a Work Assignment.

"in_with_multi_transfer"

Enables the Start Shift button that employees can use to clock in and record multiple transfers.

See Enable Clock In with Multiple Transfers.

"meal_subsidy"

Enables the Meal Subsidy button that employees can use to record meal subsidies.

"self_service"

Enables the Self Service button on the home screen, which employees use to access self-service functionality such as requesting time away from work and checking their schedules.

Unlike other functions, the self_service function doesn’t contain the rc, camera, submit_bio_failure, or submit_photo_failure attributes.

Instead, the self-service function has the following attribute:

  • <show_in_toolbar>: By default, the clock shows the Self Service button in the toolbar. If necessary, you can show it with the other buttons in the grid on the home screen by setting this attribute to "no".

"combined_transfer"

Enables the Work Transfer button on the Employee Transfer screen, which employees use to transfer between work assignments.

The combined_transfer function has the following attribute:

  • <scroll_list>: Controls whether employees can select location and job assignment from a list, or whether they have to enter the transfer codes.

"directionless"

Enables directionless clock entry functionality on the clock.

The clock shows a different default screen depending on whether or not the <numkeypad> attribute in the <cardreaders> section is enabled:

  • When it is enabled (that is, enabled="yes"), the clock shows the keypad on the home screen instead of the grid of buttons.
  • When it is disabled (that is, enabled="no"), the clock shows a message prompting employees to scan their badge or their finger (depending on which validations are enabled).

"admin"

Enables the administrator mode functionality. Unlike most other functions, this function doesn’t have a button associated with it. Instead, administrators can access administrator mode by touching and holding the Welcome to Dayforce message on the home screen.

"relay_control"

Enables the Relay Control button, which allows users to manually open and close relays.

"out_mb_prompt"

Enables the out with meal break functionality, where employees are prompted to record their meals and breaks when they clock out.

The out_mb_prompt function has the following attributes:

  • <breaks>: When set to yes, employees are prompted to record breaks with their end shift clock entry.
  • <meals>: When set to yes, employees are prompted to record meals along with their end shift clock entry.
  • <break_start_1> and <meal_start_1>: Sets the first “common” start time for breaks and meals that employees can select instead of entering a time. The common time is specified in the 24-hour time format.
  • By default, this is set to 10:00 for breaks and 13:00 for meals.
  • <break_start_2> and <meal_start_2>: Sets the second “common” start time for breaks and meals that employees can select instead of entering a time. The common time is specified in the 24-hour time format.
  • By default, this is set to 12:00 for breaks and 15:00 for meals.
  • <break_duration_1> and <meal_duration_1>. Sets the first “common” duration for breaks and meals that employees can select instead of entering the duration of the break or meal.
  • By default, this is set to 15 minutes for breaks and 30 minutes for meals.
  • <break_duration_2> and <meal_duration_2>: Sets the second “common” duration for breaks and meals that employees can select instead of entering the duration of the break or meal.
  • By default, this is set to 30 minutes for breaks and 45 minutes for meals.

"out_meal_waiver"

The clock can be configured so that employees record the number of meals that they waive during their shift when they clock out.

Typically, this is applicable only for employees who work in California (whose employers must pay a penalty premium if employees don’t receive their required meal breaks). This functionality allows employees to waive their right to meal breaks that they were entitled to, but didn’t take. The application can be configured so that employees aren’t paid premiums for missed meal breaks if they waived the meal.

"tip"

Enables the Tip Entry button on the home screen, which employees use to record their tips.

"out_tip"

Enables the Out with Tip button on the home screen, which employees use to record their tips when they clock out.

"transfer_project"

Enables the Project Transfer on the home screen, which employees use to transfer between projects.

The transfer_project function has the following attributes:

  • <scroll_list>: Controls whether employees can select projects from a list, or whether they have to enter the transfer code.
  • <sort_order>: Controls how projects are shown, either in ascending order (asc), descending order (desc), or without a specific order (none).
  • <project_hierarchy>: Enables the hierarchical view for projects when employees perform project transfers. Set this attribute to yes so that the clock shows only top-level parent projects in transfer screens. If employees need to select a child project for the transfer, they must first select its parent project and navigate their way down the hierarchy to make their final selection. Each time that an employee selects a project that contains child projects, the clock shows the child projects on a new screen.
  • <respect_clock_org_assignment>: Restricts projects based on the clock’s org unit assignment. Set to yes so that when employees perform project transfers, the clock shows only projects that are assigned to the same org unit that the clock is assigned to.

"out_with_attestation"

Enables the End Shift button that employees can use to clock out and attest (that is, report) a missed break. When employees clock out using this function, the clock prompts them with an attestation dialog box that they must complete before their clock entry is accepted.

The out_with_attestation function has the following attributes:

  • <break_attestation_default_value>: Sets which default response is selected for the “Have you taken all required breaks for this shift?” question, which appears after an employee ends their shift with an attestation. By default, the tag is set to none so that no response is selected. Set the tag to yes to configure the clock to select “Yes” as the default response. Set the tag to no to configure the clock to select “No” as the default response.
  • Note: Regardless of the default response selection, the employee can select a different response before confirming their attestation.
  • <meal_attestation_default_value>: Sets which default response is selected for the “Are you waiving a meal for this shift?” question, which appears after an employee ends their shift with an attestation. By default, the tag is set to none so that no response is selected. Set the tag to yes to configure the clock to select “Yes” as the default response. Set the tag to no to configure the clock to select “No” as the default response.
  • Note: Regardless of the default response selection, the employee can select a different response before confirming their attestation.
  • <break_attestation_enabled>: Enables the “missed breaks” question that appears on the clock when an employee ends their shift with an attestation. By default, the tag is set to yes to enable the missed breaks question. Set the tag to no to disable the missed breaks question.
  • <break_attestation_multiple_enabled>: Enables the “missed multiple breaks” question that appears on the clock when an employee ends their shift with an attestation. The clock shows the same question as it does when the break_attestation_enabled attribute is configured, but requires that employees confirm the number of breaks they took.
  • By default, the tag is set to no. Set the tag to yes to enable the missed multiple breaks question.
  • When enabled, after an employee clocks out and responds to the “Have you taken all required breaks for this shift?” question with “No,” the clock shows the “How many breaks did you take for this shift?” question. The employee must specify the number of breaks they took using the arrows next to the question.
  • <meal_attestation_enabled>: Enables the “waive meals” question that appears on the clock when an employee ends their shift with an attestation. By default, the tag is set to yes to enable the meal waiver question. Set the tag to no to disable the meal waiver question.

"transfer_docket"

Enables the Docket Transfer button on the home screen, which employees use to transfer between dockets.

The transfer_docket function has the following attributes:

  • <scroll_list>: Controls whether employees can select dockets from a list, or whether they have to enter the transfer code.
  • <quantity>: Controls whether or not a quantity must be entered.
  • <sort_order>: Controls how dockets are shown, either in ascending order (asc), descending order (desc), or without a specific order (none).

"transfer_quantity"

Enables the Docket Quantity button on home screen, which employees use record the quantity they produced working on a docket.

"employee_inquiry"

Enables the View Clock Entries and Schedules button on the home screen, which employees use to view their most recent clock entries and upcoming shifts.

By default, the clock shows the employee’s 25 most recent clock entries and their next 10 scheduled shifts, within the next two weeks. For example, if an employee has five shifts in the next two weeks, and five shifts the week after, the clock shows only the five shifts that occur in the next two weeks.

The employee_inquiry function has the following attributes:

  • <num_of_punches>: Sets how many clock entries are shown.
  • <num_of_schedules>: Sets how many shifts the clock shows.

"lock_screen"

Enables the Lock Screen button on home screen, which allows users to lock the screen so that it can be cleaned without accidentally tapping buttons. By default, the clock locks the screen for one minute. If necessary, users can unlock the screen before the timeout elapses by touching and holding the Unlock button for two seconds.

The lock_screen function has the following attribute:

  • <show_in_toolbar>: By default, the clock shows the Lock Screen button in the toolbar. If necessary, you can group it with the other buttons in the grid on the home screen by specifying no for this attribute.

"punch_authorization"

Enables the Clock Entry Authorization button on home screen, which allows users to authorize their clock entries using the Dayforce Touch Clock.

This function has the following attributes:

  • <number_of_weeks>: Sets how many weeks the clock shows in the Clock Entry Authorization feature.
  • <allow_unauthorize>: Sets whether or not the clock allows employees to revoke their authorization at the clock. When this attribute is set to no, the clock doesn’t show the Unauthorize button.
  • <show_raw_punch>: By default, the clock shows rounded clock entry times in the Clock Entry Authorization feature. With this attribute set to yes, the clock shows raw clock entry times instead.

"labor_metrics_transfer"

Enables the Labor Metrics Transfer button on the home screen, which employees use to record labor metric transfers.

The labor_metrics_transfer function has the following attribute:

  • <scroll_list>: Controls whether employees can select labor metrics from a list, or whether they have to enter the codes.
  • <sort_order>: Controls how labor metrics are shown, either in ascending order (asc), descending order (desc), or without a specific order (none).

"multi_transfer"

Enables the Multi Transfer button on the home screen, which employees use to record multiple transfers.

"schedule_transfer"

Enables the Schedule Transfer button on the home screen, which employees use to record schedule transfers.