System

Clocks Guide

Version
R2024.2.0
System

This section controls which mode (standalone or online) the clock operates in, the length of employee badges, PINs, and transfer codes, and whether the clock accepts directionless clock entries or uses biometric verification.

The <system> section contains the tags described below.

<local_punch_validations>

Controls whether the clock operates in standalone or online mode.

When this tag is set to yes, the clock operates in standalone mode. This means that the clock performs its own validations, as described in the Validations section. See Validations.

When this tag is set to no, the clock operates in online mode. This means that the Dayforce Touch Clock accepts clock entries and transmits them to the application. The application then performs the validations configured in System AdminClocking Sequence Validation.

<badgelength>

Controls the number of digits stored in the badges employees use with the clock. Enter the number of digits employees use to identify themselves on the clock.

The <badgelength> tag has the following additional attributes:

  • prefix and suffix: These attributes allow you to append a prefix or suffix to employees’ badge numbers. This is useful in cases where two employees have the same badge number and perform clock entries on different devices. For example, two organizations merge, and each organization has an employee with a badge number "123”, who work at different locations and clock in on different devices. By configuring one of the clocks to append a prefix or suffix to employees’ badge numbers, administrators can differentiate between the two employees without having to reissue their employee badges.
  • Note: For this functionality to work, you must also update the badge numbers (in the main application, in People in the Work > Badge screen) for the employees who clock in on the device so that they include the specified prefix or suffix. Continuing the example above, the employee who works at that location and has the badge number “123” would then be assigned the badge number “A10123b20”.
  • After configuration is complete, when employees clock in on that device using their old badge number (by entering it in or using the scanner), the clock automatically appends the new prefix and suffix to their badge number.

<transfer_code_length>

Controls the number of digits in the codes used to identify locations, job assignments, and dockets. This length must match the Clock Code values configured in the application.

<qty_decimal_places>

Controls how many decimal places the clock expects when users record quantities. For example, when set to 1, users would have to enter 540 to enter a quantity of 54, as the application is actually processing it as “54.0”.

<tip_decimal_places>

Controls how many decimal places the clock expects when users record tips. For example, when set to 2, users would have to enter 10000 to enter a $100 tip, because the application is actually processing it as “100.00”.

<ess_pin>

Controls whether employees are prompted to enter a PIN when logging in to employee self-service. When set to yes, employees must enter their PIN before they can access self-service features.

<employee_pin>

Controls whether employees are prompted to enter a PIN when clocking in and out. When set to yes, the clock prompts employees to enter their PIN when clocking in and out.

<supervisor_pin>

Controls whether supervisors are prompted to enter a PIN when clocking in and out. When set to yes, the clock prompts supervisors to enter their PIN when clocking in and out.

<pin_length>

Controls the number of digits in employee PINs.

<directionless>

Controls whether employees can perform directionless (“fast”) clock entries. When directionless clock entries are enabled, validation at the clock is limited. Instead, the application determines what type of clock entry the employees was performing based on the order in which the clock entries were performed.

The following attribute is available for the <directionless> tag:

  • default: Controls which screen (the keypad or functions screen) is shown on the clock by default. Users can toggle between these screens using the Functions and Keypad buttons, but the default attribute allows you to specify which screen appears by default. When default="keypad", the Keypad screen is shown. When default="functions", the Functions screen is shown.

<watchdog>

Controls “watchdog” functionality that automatically restarts the clock if it becomes unresponsive.

<biometric>

Controls whether biometric verification is enabled on the clock. When set to yes, the clock prompts users to scan their finger before their clock entry is accepted.

The following attributes are available for the <biometric> tag:

  • mode: The clock can operate in two biometric modes: "identify" and "verify".
    • When configured with mode="identify", the clock prompts users to scan their finger without first having to enter their badge number. The clock checks their scan against the ones saved in the database to find the appropriate match.
    • When configured with mode="verify", users must first enter their badge number. The clock then prompts the user to scan their finger, and compares that scan with the one saved in the system for that user.
  • threshold: Controls the sensitivity for fingerprint quality.
    • When the clock is configured with a lower sensitivity, it accepts lower quality fingerprints. This attribute can be configured with the values 1 - 4, corresponding to low, medium, high, and very high sensitivity. For example, threshold="3" would configure the clock for high sensitivity.
  • enrollment: Controls whether the clock prompts users for one or two fingers when enrolling them for biometric verification.
    • When configured with enrollment="normal", the clock prompts employees for two finger scans. When configured with enrollment="simple", the clock prompts employees for only one scan.
  • lift_finger_in_enroll: Controls whether the clock prompts users with an onscreen message to lift their finger from the fingerprint scanner when enrolling them for biometric verification. When configured with lift_finger_in_enroll="yes" (the default setting), the clock requires users to lift their finger between scans when enrolling them for biometric verification. When configured with lift_finger_in_enroll="no", the clock doesn’t prompt users to lift their fingers between scans.
  • verify_attempts: Controls the number of biometric verification attempts the clock allows. For example, with verify_attempts="3" specified, the clock allows three attempts. This means that if an employee fails their first attempt at biometric verification, the clock will allow them two more attempts without having to re-enter their badge number.
  • accept_on_hw_failure: Controls whether clock entries are accepted when biometric verification is enabled, but the biometric reader isn’t connected. When set to yes, the clock continues to accept clock entries, despite not being able to perform biometric verification. When set to no, clock entries are rejected if the reader isn’t connected.

<default_language_fallback>

Controls whether the clock returns to the default language when a user changes the language and then completes a function. When set to yes, the clock returns to the default language automatically. When set to no, the clock retains the language the user selected.

<camera>

Controls whether the camera is enabled on the clock. When set to yes, the clock prompts users to capture and submit their facial image to verify their identity when performing clock entries.

The Dayforce Touch Clock uses a “flat flash” when it captures employees’ pictures. This means that the LED lights up when the camera starts focusing the picture, and then stays lit until the picture has been captured (as opposed to a more traditional flash, which is lit only at the instant the picture is captured).

The following attributes are available for the <camera> tag:

  • mode: The camera can operate in the following modes on the Dayforce Touch Clock:
    • Note: The Dayforce Touch Clock supports all of the following camera modes when running in both standalone and online modes.
    • picture: The camera takes a picture of the employee in front of the camera. This is the least restrictive option.
    • picture_with_face_detection: The employee’s face must be in the correct position in front of the camera in order to be detected.
    • face_verification: The camera verifies the face against the enrollment photos associated with the employee. When operating in this mode, the clock also prompts employees to enter their badge number before the camera captures their image.
    • Note: Depending on your Dayforce configuration, this attribute might be unavailable or might not function.
    • face_verification_live: The camera verifies the face against the enrollment photos associated with the employee. The face must be a live face (that is, not a photo of a face). When operating in this mode, the clock also prompts employees to enter their badge number before the camera captures their image.
    • face_identification: The camera verifies the face against the enrollment photos associated with the employee. This mode is identical to face_verification mode but doesn’t prompt employees to enter their badge number on the clock before the camera captures their image.
    • face_identification_live: The camera verifies the face against the enrollment photos associated with the employee. The face must be a live face (that is, not a photo of a face). This mode is identical to face_verification_live mode but doesn’t prompt employees to enter their badge number on the clock before the camera captures their image.
  • torch_intensity: Allows you to control the intensity of the flash by editing a number that corresponds to the percentage of the LED’s brightness. For example, with torch_intensity="50" specified, the flash would be limited to 50% of the LED’s possible brightness.
  • submit_all_pics: With this attribute set to yes, the clock submits all clock pictures, regardless of whether they passed facial verification. When set to no, the clock submits only pictures that failed verification, so that managers can view them using the existing functionality in Timesheets and Clock Entry Audits.

<screen_brightness>

Controls the screen brightness for the clock.

The following attributes are available for the <screen_brightness> tag:

  • low: Sets the screen brightness when the clock hasn’t been in use for a period of time. The number is a percentage of possible brightness. This means that with low="30" specified, the clock would dim its screen to 30% brightness after it hasn’t been in use for a period of time.
  • high: Sets the screen brightness when the clock is in use. The number is a percentage of possible brightness. This means that with high="100" specified, the clock shows its screen using full brightness when it’s in use.
  • on_battery_low: Sets the screen brightness when the clock hasn’t been in use for a period of time and is operating on battery power. The number is a percentage of possible brightness. This means that with on_battery_low="20" specified, the clock dims its screen to 20% brightness after it hasn’t been in use for a period of time and is on battery power.
  • on_battery_high: Sets the screen brightness when the clock is in use and on battery power. The number is a percentage of possible brightness. This means that with on_battery_high="80" specified, the clock shows its screen at 80% brightness when it’s in use and on battery power.
  • timeout: Sets the timeout (in seconds) after which the clock dims from the high brightness to low brightness. For example, with timeout="10" specified, the clock dims from high to low brightness after 10 seconds of inactivity.

<local_employee>

Controls whether the clock allows administrators to enroll employees who haven’t been onboarded yet in the main application. This is useful in cases where organizations need to rapidly onboard a large number of new employees, and need them perform clock entries before their employee records have been created in the main application.

Use the inactive_expire_days attribute to configure how many days an employee can be inactive (that is, not record any clock entries on the device) before their employee record expires. For example, with inactive_expire_days="7" specified, the clock automatically deletes the employee’s local clock entries if they don’t perform any new clock entries in seven days.

See Local Employee Enrollment.

<allow_firmware_downgrade>

Controls whether the clock allows firmware downgrades. By default, this tag is set to no to prevent the clock’s firmware from being downgraded when its firmware version is higher than the system firmware version.

<battery restart_percentage>

Controls when the Dayforce Touch Clock restarts when the battery falls below a specified level. The default value is 20. So, for example, if the value is set to 20, the clock restarts when the battery level falls below 20%. If the value is 0, the clock doesn’t restart at all when the battery is low. In this scenario, the battery will continue to run until it loses its charge.

Note: The clock only restarts when it’s operating on battery power. It doesn’t restart when it’s plugged in and charging.

<badge_enrollment>

Controls whether the clock allows administrators or supervisors to enroll employee badges at the clock. By default, this feature is disabled and the tag is set to no. When the tag is set to yes, the clock allows administrators and supervisors to enroll employee badges when the "enroll_raw_badge" function is assigned to a button in the <admin_functions> or <supervisor_functions> section of the clock’s config file.

Important: If you assign a button to the "enroll_raw_badge" function in either the <admin_functions> or <supervisor_functions> section and don’t set the <badge_enrollment> tag to yes, the Enroll Employee Badge button appears in the admin or supervisor menu, but it will be grayed out and unavailable.

See Badge Enrollment.

<legal_consent>

Controls whether the clock shows a legal consent agreement before employees enroll for biometric or facial verification. When the tag is set to yes, employees can’t enroll for biometric or facial verification until they review information about stored templates and agree to submit their fingerprint or facial image for verification purposes.

Important: You can’t edit the legal consent text that is contained in the <legal_consent> entry using the localization override file in Site SetupClock Configuration in the Localization tab. If you attempt to edit this text, the application generates an error and doesn’t save your changes. For more information on configuring and localizing the Dayforce Touch Clock, see Localize the Clock.

The following attribute is available for the <legal_consent> tag:

  • record: Controls whether the clock prompts users to review the legal consent text and agree to submit their biometric templates when performing a clock entry (if they haven’t previously consented to submit their biometric templates). When the user agrees, their confirmation is recorded in the database and they’re no longer prompted to view the legal disclaimer text when they perform clock entries. If they disagree, they must confirm that they don’t consent, which will result in their biometric templates being deleted.
  • This attribute is set to "no" by default. To enable it, set it to "yes" in the clock’s custom config file.