Chile Punch Receipt

Note: This business process 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.

In compliance with legislation in Chile, the Chile Punch Receipt extension generates a digital punch receipt as proof that a punch was performed.

An attestation time entry workflow, that does not require user interaction, is hooked to the punch button. When the employee punches in and out, the receipt is automatically sent with a notification. Because the standard notification framework is utilized, the receipt is also available in the Control Center.

Note: This same workflow can be used in organizations that use clocks but prefer to not install the custom print relay that require physical printer connections.

Three receipt types can be sent to accommodate different situations; each contains predefined information in the notification subject and body. A unique checksum, or hash code, is included in the receipt associating it with the punch for audit purposes.

  • Punch Success — Sent when the punch is successfully added to the timecard.

  • Punch Failure — Sent when the punch is not accepted, such as with a duplicate punch.

  • Missing Punch (Late In) — Sent when the employee does not punch inside a configurable time frame from the schedule shift start.

Punch Success

When the employee punches in or out, the business process inserts a hidden paycode in the timecard. A comment and note assignment stores the punch details.

The workflow waits for the totalization to complete, reads the punch data from the comment and note, and then generates the punch receipt notification. As required by law, the receipt displays the punch time in HH:MM:SS format.

When the punch originates from a clock, the Nombre Reloj field displays the device name; otherwise, this field remains blank.

Punch Failure

The punch tile already prevents duplicate punches. However, a workflow notification is still sent to alert the employee that a failed punch attempt occurred.

Missing Punch (Late In)

When the employee is scheduled to work, but fails to punch in the expected time frame, the Late In exception initiates the workflow notification action.

  1. Comment: Configure a comment with the Paycodes category to which the process adds the checksum value and punch time, in seconds.
    See theComments topic.

  2. Paycode: Create a paycode to which the checksum value and punch time comment is added. To prevent confusion, do not select any of the Visible options in the paycode definition.
    See thePaycode definition topic.

  3. Process Profile: Create a process profile containing the Chile Punch Receipt process. Assign the process profile to employees who punch using a timeclock or timestamp.
    See the Process Profiles setup page topic.

  4. Attestation Conditions: Create a condition with a type of Always.
    See the Attestation Conditions topic.

  5. Attestation Buttons: Create two buttons, Punch In and Punch Out; assign each with the Web and Clock display type.
    See the Attestation Buttons topic.

  6. Attestation Assignments: Create two attestation assignments, one for the Punch In button and the other for the Punch Out button. Assign the ChilePunchReceipt process and the Always condition to each attestation assignment.
    See the Attestation Assignments topic.

  7. Attestation Profile: Create an attestation profile and select each of the attestation assignments. Assign the attestation profile to employees who punch using a timeclock or timestamp.
    See the Attestation Profiles topic.

  8. Workflow notifications: Configure generic workflow notifications that facilitate the Chile Punch Receipt process. Design the notifications by combining free text with available custom tags. See the Generic notifications topic.
    Examples include:

Name: Punch Success Workflow Notification

Custom Tag options:
Tag Description
<C_EmpLastName> Employee last name.
<C_EmpFirstName> Employee first name.
<C_RUT> Employee national identification number (RUT).
<C_DeviceID> Device ID defined in UKG Pro Workforce Management™.
<C_DeviceName> Device name defined in UKG Pro Workforce Management™.
<C_PunchType> Punch type.
<C_PunchDate> Punch date.
<C_PunchTime> Punch time.
<C_Checksum> Unique generated value that associates the punch with the notification.

Name: Punch Failure Workflow Notification

Custom Tag options:
Tag Description
<C_EmpLastName> Employee last name.
<C_EmpFirstName> Employee first name.
<C_RUT> Employee RUT.
<C_DeviceID> Device ID defined in UKG Pro Workforce Management™.
<C_DeviceName> Device name defined in UKG Pro Workforce Management™.
<C_PunchDate> Punch date.
<C_PunchTime> Punch time.
<C_Checksum> Unique generated value that associates the punch with the notification.

Name: Missed Punch (Late In) Workflow Notification

Custom Tag options:
Tag Description
<C_EmpLastName> Employee last name.
<C_EmpFirstName> Employee first name.
<C_RUT> Employee RUT.
<C_PunchDate> Punch date.
<C_PunchTime> Punch time.
<C_ScheduledShiftStart> Schedule shift start time.
<C_ScheduledShiftEnd> Schedule shift end time.
<C_Checksum> Unique generated value that associates the punch with the notification.

Name: Punch Verification Workflow Notification

Select Trigger Business Process.

Template: ChilePunchReceipt_v1

Select Trigger Business Process Only.

Business process will run as System User.

Custom Tag option:
Tag Description
<PunchVerificationData> Contains punch information.

Name: Error Workflow Notification

Custom Tag option:
Tag Description
<C_ErrorMessage> Contains any error message captured during process execution.
Caution:

  • Custom tags are case-sensitive and must not be modified.

  • Each workflow notification should be configured with options: Recipient List will be supplied at runtime, Send to employee, and Do not suppress duplicates.

  1. Timekeeping Alert Profile: Create a Late In timekeeping alert profile and select the Late In Workflow Notification. Assign the timekeeping alert profile to the employee Display Profile.
    See the Configure a timekeeping alert profile topic.

Version history
Version Description
v1 Initial release.
A punch receipt notification is generated for employees who punch using the clock or timestamp.

Migrate the business process model to the tenant

Migrate the Chile Punch Receipt process model to the customer tenant using Setup Data Manager (SDM).

  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 decision tables

Configure the Chile Punch Receipt decision tables.

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

  2. Select the ChilePunchReceipt 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 UKG Pro Workforce Management™

ChilePunchReceipt_v1_InternalParameters — Controls internal punch receipt parameters.

Chile Punch Receipt Internal Parameters decision table structure
Column Description
Admin

Internal user; do not change.

Default value: SERVICES-LEVEL3
InternalEmployeePunch Employee punch time.
InternalAlertType Notification alert type.
InternalAlertTransactionDate Notification alert date.
InternalAlertEmployee Employee person number.
InternalUDMDeviceID Device ID.
InternalAttestationEmployee Attestation employee.
InternalPunchVerificatonData Punch data.
TotalizationWaitTime Totalization wait time.

ChilePunchReceipt_v1_Parameters — Controls the punch receipt process.

Chile Punch Receipt Parameters decision table structure
Parameter Description
PayCode

Paycode name used to capture the punch data.
PayCodeComment

Comment attached to the punch data paycode.
PunchVerificationWorkflowNotification

The secondary workflow notification that initiates the business process to send the punch receipt.
PunchSuccessWorkflowNotification

Punch success workflow notification.
PunchFailureWorkflowNotification Punch failure workflow notification.
MissPunchWorkflowNotification Missed punch workflow notification.
ErrorWorkflowNotification Error workflow notification.
RUTAdditionalInformationFieldName An additional field used to capture the employee national identification number

Note: If the organization also uses the Chile Timecard Report extension, the PayCode parameter value in the ChilePunchReceipt_v1_Parameters must match the Pay Code - Punch Receipt Pay Code integration control parameter.

ChilePunchReceipt_v1_Devices — Contains each device where punches are performed.

Chile Punch Receipt Devices decision table structure
Column Description
Device ID

The device ID where the employee punches.
Device Name

Device name.
Device Description Device description.

ChilePunchReceipt_v1_Locale — Allows customization of the text in the workflow form and notifications for different locales.

Chile Punch Receipt Locale decision table structure
Variable name Variable type Description
Key Text Internal field label; do not change.
Locale Policy Text

Name of the locale policy for which the text applies.

When the text applies to all locales, retain the empty value.
Message Text Text displayed in the workflow form or notification.
Description Text (Optional) Additional information.
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.

  • The last row in the decision table must remain empty ("!=empty".)

Sample Locale key parameters

Key parameter name value

Use

DEFAULT_ERROR

Process failure default error.

VAR_INERNAL_DT_ERROR

The internal parameter decision table contains an invalid value.

API_ERROR

The API call returns an error.

INCORRECT_TOTALIZATION_PARAM_ERROR

The totalization parameter value is incorrect.

VAR_PARAMETER_DT_ERROR

The parameter decision table contains an invalid value.

INVALID_COMMENT

The comment name is invalid.

PUNCH_IN

Contains the translation for the In Punch value defined by the PunchSuccessWorkflowNotification parameter in the Parameters decision table.

PUNCH_OUT

Contains the translation for the Out Punch value defined by the PunchSuccessWorkflowNotification parameter in the Parameters decision table.

Deploy the updated business process model

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

Model deployment steps:

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

  2. Select the ChilePunchReceipt_v1 model.

  3. Click Tap Edit, and then configure the required parameters and deployment dates. Select Notification Templates and Attestation from the Template Categories list.

  4. Click Tap Save, and then select Return to deploy.

API details
API Name Type Resource Path Description
Retrieve Person by ID GET /v1/commons/persons/employee?person_number=<emp_number> Returns a person record by ID.
Retrieve User Preferences for Current User GET /v1/commons/user_preferences/locale_policy?userCurrent=true Returns user preferences for the current user or tenant.
Retrieve Schedule with Criterion GET v1/scheduling/schedule?select=SHIFTS&start_date=<start date>&end_date=<end date>&person_number=<person number> Returns a schedule pertaining to one employee, Hyperfind, or location.
API Generic Notification Notify POST Generic Notification Notify  
API Workflow Attributes POST Attestation Workflow Attributes Passes the Attestation workflow attributes.
Update Timecard as Manager POST v1/timekeeping/timecard Updates a timecard for an employee as a manager.
Retrieve Data POST v1/commons/data/multi_read Returns aggregated data by executing an ad-hoc query.
Retrieve Timecards as Manager POST /v1/timekeeping/timecard/multi_read Returns a list of timecards based on the employees or Hyperfind details provided.