Predictive Scheduling Attestation — In and Out Punch

Note: This business process An organized flow of activities or tasks that achieves a business goal. An automated business process minimizes the amount of paperwork and manual tasks to complete that process by way of automatic actions, online forms, and automatically generated messages. is an extension model that is developed outside the normal release schedule to meet specific customer needs. To request one of these models, you must submit a Salesforce Service Request to UKG. After the model is delivered to your tenant, you can edit it to meet your needs.

The Predictive Scheduling Attestation The act of confirming or attesting that something is true. For example, when punching out, users may need to attest that they took their meal breaks. – In and Out Punch The entries on a timecard that mark the beginning (in-punch) or end (out-punch) of a work interval, such as the beginning of a shift or transfer. workflow complements predictive scheduling functionality by prompting the employee to confirm if In or Out punches that deviate from the scheduled shift are in response to the manager’s request to adjust their shift.

This workflow ensures compliance with predictive scheduling legislation which requires employers to compensate employees for late scheduling changes.

The employee initiates the workflow in the following ways:

When the employee’s In or Out punch violates the predictive scheduling rule Defines restrictions and requirements to ensure that a schedule meets certain criteria., the attestation form captures the reason why worked hours deviate from the schedule.

In each case, the comment and note that the workflow adds to the punch capture the employee's attestation response.

The Predictive Scheduling Attestation workflow supports three workflow notifications Informs people to run business processes or integrations, complete forms, or respond to events in business processes. Example: Approve a time-off request. that generate under specific conditions.

  • Initiates the workflow that verifies punch details and adds the predictive bonus to the Timecard, as required.

  • Notifies the recipient when an error occurs in the workflow.

  • (Optional) Initiates the workflow after the manager approves the employee’s Timecard changes.

    Note: This workflow depends upon whether timecard approval requires manager approval.

  • The Predictive Attestation — In and Out Punch workflow requires that established predictive scheduling configurations exist on the customer tenant.

  • When the employee punches In for an unscheduled shift, the workflow retrieves the Unscheduled Shift Length configured in the punch interpretation rule to calculate the predictive bonus.

  • The predictive bonus is not awarded if multiple overlapping shifts exist on a day.

  • The workflow adds the predictive bonus to the Timecard only when predictive scheduling criteria are met.

To illustrate workflow functionality, let us look at the behavior of multiple scenarios.

Employee punch deviates from schedule – manager request

To accommodate the labor shortage that exists in Company A, the manager requests an employee to report to work earlier than originally scheduled. The employee complies with the manager’s request and punches in at 10:00AM instead of their scheduled 1:00PM shift start.

Because the In-Punch deviates from the original schedule, the attestation form displays and the employee attests that the difference is in response to the manager’s request. The system records the 10:00AM In punch.

Since the manager impacts the 10:00AM punch, the workflow places a tag in the schedule which contains scheduling condition details. The Timecard inherits the schedule tag information and then adds the predictive paycode, and corresponding comment and note containing the employee’s response in the Timecard.

While this scenario focuses on behavior specific to the In-Punch, predictive pay easily applies to Out-Punch or In- and Out-Punch scenarios.

Employee punches on nonscheduled day

To accommodate the labor shortage that exists in Company A, the manager requests an employee to report to work on a non-scheduled day. The employee complies with the manager’s request and punches in at 9:45AM.

Because no associated schedule exists for the In-Punch, the attestation form displays and the employee attests that the difference is in response to the manager’s request. The system records the 9:45AM In punch.

Since the manager impacts the 10:00AM punch, the workflow places a tag in the schedule which contains scheduling details retrieved from the Unscheduled Shift Length configured in the employee’s punch interpretation rule. The Timecard inherits the schedule tag information and then adds the predictive paycode, and corresponding comment and note containing the employee’s response in the Timecard.

Employee punch deviates from schedule – no manager request

An employee at Company A chooses to start their work day earlier than originally scheduled and punches In at 6:00AM instead of their 8:00AM scheduled shift start.

Because the In-Punch deviates from the original schedule, the attestation form displays and the employee attests that the difference is not in response to the manager’s request. The system records the 6:00AM In punch.

Since the employee impacts the 6:00AM punch, the workflow adds a comment and note that contains the employee’s response to the punch in the Timecard. No changes are made to the schedule and no predictive paycode generates in the Timecard.

Employee manually adjusts Timecard

An employee at Company A punches In by way of the Timestamp every weekday to work their 9:00AM-6:00PM scheduled shift. The employee views their Timecard and notices a missed In-punch on a day when the manager requested that they arrive two hours earlier than the normal scheduled shift start.

The employee adds the missing 7:00AM In-punch in the Timecard.

Because the In-Punch deviates from the original schedule, the attestation form displays and the employee attests that the difference is in response to the manager’s request. The Timecard submits the 7:00AM In-punch for manager approval.

Upon manager approval, the system adds 7:00AM In-punch to the Timecard. The workflow places a tag in the schedule which contains scheduling condition details. The Timecard inherits the schedule tag information and then adds the predictive paycode, and corresponding comment and note containing the employee’s response in the Timecard.

While this scenario focuses on behavior specific to a missing In-Punch, predictive pay easily applies to a missing Out-Punch or missing In- and Out-Punch scenarios.

Before you configure this business process, you must configure the following:

  • Predictive Scheduling configurations — See the Configure Predictive Scheduling topic.

    • System Settings: On the System Settings Global Values tab, set the global.PredictiveScheduling.enabled key to True.

    • Function Access Profiles (FAP): Edit the manager's FAP assignment to allow Predictive Scheduling Setup.

    • Tag Definitions: Define a tag that displays predictive scheduling rule violations in the Schedule.

    • Schedule Change Criteria: Specify schedule actions that the system monitors and acts upon. For example, create criteria that detects when shifts are moved out in the future by 30 or more days.

    • Predictive Scheduling Bonus: Create one or more predictive scheduling bonus rules that define bonus calculations.

    • Predictive Scheduling Rules: Create predictive scheduling rules using a combination of the schedule change criteria and the predictive scheduling bonus rules.

    • Location Profiles: Use a location profile to apply the predictive scheduling rule to a location in the business structure .

  • Common Setup configurations:

    • Comments: Create two comments that the workflow adds to the timecard to identify manager and employee-impacted punches. Select the Punches category during configuration. See the Comments topic.

  • Attestation configurations — See the Configure Attestation topic.

    • Attestation Conditions: Create two attestation conditions that determine if the workflow displays attestation forms. A scheduled shifts condition asks relevant questions when In or Out punches deviate from the planned shift. A missing punches condition asks the employee to confirm whether manually entered punches in the Timecard are due to a management request.

    • Attestation Buttons: Create or edit multiple attestation buttons, such as:

      • Punch: Determines the punch type by referencing the punch interpretation rule when the employee activates the Punch button.

      • Punch In: Records the punch-in time.

      • Punch Out: Records the punch-out time.

      • Timecard Action: Establishes the timeframe for addressing missing punches in manual timecard entry workflows.

    • Attestation Assignment: Create Punch In and Out and Timecard Save attestation assignments.

      For each assignment, select at least one button, condition, and PredictiveSchedulingAttestation_v1 from Punch Button Workflow.

      Optionally, in the punch attestation assignments, if you want to initiate the workflow for missing punches in manual timecard entry workflows, select PredictiveSchedulingAttestation_v1 from Manual Time Entry Workflow.

    • Attestation Profile: Create or edit an existing attestation profile. Add the attestation assignments applicable to the Predictive Scheduling workflow in the order in which the buttons associated with the assignments appear on the Punch tile and on the Select Punch Type slider on My Timecard. Assign the attestation profile to the appropriate employees.

  • Events/Notifications configurations

    • Workflow Notifications: Create generic notifications that are sent when the business process workflow initiates or generates an error.

      Optionally, create a workflow notification that notifies the recipient after the manager approves a change to the Timecard.

      Combine free text with available labels and custom tags when designing the notifications. See the Generic notifications topic.

    Name: PredictiveSchedulingAttestation Self Trigger Notification

    Select Recipient List will be suppled at runtime and Send to employee.

    Select Trigger Business Process.

    Template: PredictiveSchedulingAttestation_v1

    Select Trigger Business Process only.

    Business Process will run as: Notification Recipient List

    Select Do not suppress duplicates.

    Name: PredictiveSchedulingAttestation Error Notification

    Select Send to employee.

    Select Do not suppress duplicates.

    Use custom tags, such as <Employee Person Number>, <DateTimeOfCurrentPunch>, and <Error> in the Subject, Long Message and Control Center fields, as needed.

    Name: Timecard Request Change Notification

    Select Recipient List will be suppled at runtime.

    Select Do not suppress duplicates.

    Select Trigger Business Process.

    Template: PredictiveSchedulingAttestation_v1

    Note: When timecard approval is required, you must configure this notification.

    • (Optional) Control center notification mappings: If you configured a workflow notification that notifies after the manager approves a change to the employee’s Timecard, you must also ensure that a mapping exists for the Timekeeper domain and Timecard Change Request event type. See the Control Center Notification Mapping topic.

Version Description
1

Initial release.

Migrate the process model to the tenant

Migrate the Predictive Scheduling Attestation process model to the customer tenant using Setup Data Manager (SDM) Moves and manages configuration data across software and hardware environments. (SDM Setup Data Manager moves and manages configuration data across software and hardware environments.).

  1. Log in to the appropriate tenant.

  2. Go to Main Menu > Administration > Setup Data Manager.

  3. Select the Source tenant where the Process Model resides, and select the template to copy. It is a .zip file. A message appears in the Source column: Source: Import from <filename>.zip.

  4. Click Tap Review and Publish. The Publish Summary panel appears.

  5. Review the Publish Summary panel. It lists the items that were extracted from the migration file. If you approve, click tap Publish with Comment or just Publish.

  6. Click Tap Go to Publish History at the bottom of the panel to view the status of the data transfer. The Publish History page contains a table that lists the items you have published. If there were errors during the transfer, the button under the Errors column for that row is black.

  7. To view details, click tap the appropriate row and click tap View Selected.

  8. On the History for publish run page, click tap Show all to view the setup data that you published, and the errors that occurred, if any, listed by item type and name.

Configure the Predictive Scheduling Attestation decision tables

Note: Decision tables are configurable based on user requirements and can be changed accordingly. These tables are dynamic and can be updated at any time without redeployment of the process model.

  1. Go to Main Menu > Administration > Application Setup > Business Process setup > Process Models.

  2. Select the PredictiveSchedulingAttestation_v1 process and click tap Edit. The process model enters edit mode.

  3. Select the Decision Tables tab.

  4. Click Tap Everyone's, and then select the decision table to edit.

  5. Click Tap Decision Table Editor to add or update the rows in the table.

  6. Click Tap Save and close.

Caution:

  • Values entered in the decision tables are case-sensitive, and must match configured values in the system.

  • Do not remove variables, variable names, or variable types from any decision table.

Edit the following decision tables:

PredictiveSchedulingAttestation_v1_InternalParameters — Controls internal Predictive Scheduling Attestation configuration variables that optimize workflow system performance. The default values are preconfigured.

Predictive Scheduling Attestation — Internal Parameters decision table structure
Parameter name Description Default value
Admin Admin user for GET API calls. SERVICES-LEVEL3
TotalizationWaitTime Identifies the wait time, in seconds, before a punch is available in the timecard. 10
InternalEmployeePunch Key that identifies employee punch time for direct punches from the tile. estimatedPunchTimeInEmployeeTimezone
InternalEmployeeManualPunch Key that identifies employee punch time for manual timecard entry. manualPunchTime

PredictiveSchedulingAttestation_v1_Parameters — Allows configuration of the parameters used in the workflow. The default values are preconfigured.

Predictive Scheduling Attestation — Internal Parameters decision table structure
Parameter name Description Default value
ManagerImpactedPunchComment Comment that is added to the timecard when the employee selects a positive response on the attestation form. Manager Impacted Punch
EmployeeImpactedPunchComment Comment that is added to the timecard when the employee selects a negative response on the attestation form. Employee Impacted Punch
ErrorNotification Notification that is sent when the workflow generates an error. PredictiveSchedulingAttestation Error Notification
PunchVerificationWorkflowNotification Notification that is used to verify punch details and add a predictive bonus when necessary. PredictiveSchedulingAttestation Self Trigger Notification
PredictiveScheduleTagName Tag that identifies the predictive bonus from the previous punch.. Predictive Scheduling Attestation

PredictiveSchedulingAttestation_v1_Locale — Allows customization and translation of business process labels, messages, and errors into different languages.

Predictive Scheduling Attestation— Locale decision table structure
Parameter name Description
Key Key for which localization is defined.
Locale Policy

Locale Policy.

Use the !=empty operator to mimic the asterisk (*) wildcard and place less-restrictive locale policies at the bottom because decision tables are checked from top to bottom.
Message Form label or message shown as the result of a processing error.
Note:

  • Localization of business process workflows remains optional, but is supported.

  • The decision table holds all messages represented with standard English labels; these apply to all locales when the Locale is set to a wildcard (*).

  • Some or all messages can be translated by adding lines to the table in their preferred translation for specific locales. Messages for the most commonly used Locale Policy should be defined at the top of the decision table. Text within tags ("<>") must not be changed.

  • Names of the parameters in the decision table column Parameter Name must be used as is. If any parameter value needs to be localized for a different Locale Policy, copy the Parameter Name with the * Locale Policy, add a new row to the decision table with the appropriate Locale Policy, and then add the localized values in the Message column.

Predictive Scheduling Attestation — Locale sample content
Key Locale Message
predictiveSchedulingQuestion != empty

Did your manager request that you work different hours?
predictiveSchedulingQuestionMTE != empty Did your manager request that you work different hours <MissedDateTime>?
predictiveSchedulingSubmitButton != empty

Submit
predictiveSchedulingPositive != empty Yes
predictiveSchedulingNegative != empty No
missingInPunchForOutPunch != empty Unable to find In-Punch for the employee entry.
multipleShiftsFoundForPunch !=empty

Multiple shifts were found for the punch.

Deploy the updated Predictive Scheduling Attestation business process model

Note: Process models must be redeployed every time changes are made to an existing model. Re-deployment is not required for decision table changes.

Follow these steps to deploy the process model. For detailed information, see the online help topic Deploy Business Process Models.

  1. Go to Main Menu > Administration > Application Setup > Business Process Setup > Process Models.

  2. Select the PredictiveSchedulingAttestation_v1 model and click tap Deploy .
  3. On the Business Process page, configure the required parameters and deployment dates.
    • (Optional) In Description, enter Predictive Scheduling Attestation.
    • In Display Name, enter PredictiveSchedulingAttestation_v1.
    • In Start Effective, select the effective start date.
    • In End Effective, select Forever to make the Business Process available indefinitely.
    • In Status, select Active.
    • In Action List, select Hide.
    • In Tile List, select Hide.
    • In GoTo List, select Hide.
    • From Template Categories, select Notification and Attestation.
  4. Click Tap Save and then Return.
API details
API name Type Resource path
Retrieve Timecard Data for Multiple Employees POST v1/timekeeping/timecard_metrics Measures and tracks workforce performance by comparing planned with actual workload or coverage, or by showing variances at any organizational level./multi_read
Retrieve Person Record GET /v1/commons/persons/extensions?person_number={EmpPersonNum}
Retrieve Employee Schedule POST v1/scheduling/schedule/multi_read
Retrieve Punch Interpretation Rules GET v1/commons/persons/punch_interpretation_rules?person_number=da01&snapshot_date=2023-11-14
Generic Notify Notification POST  
Retrieve Predictive Scheduling POST /v1/scheduling/predictive_scheduling/apply_read
Retrieve Locale Policy-currentuser GET v1/commons/user_preferences/locale_policy?userCurrent=true