Chile Punch Receipt
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.
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.
User experience
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.
UKG Pro Workforce Management configurations
Comment: Configure a comment with the Paycodes category to which the process adds the checksum value and punch time, in seconds. See the Comments topic.
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 the Paycode definition topic.
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.
Attestation Conditions: Create a condition with a type of Always. See the Attestation Conditions topic.
Attestation Buttons: Create two buttons, Punch In and Punch Out; assign each with the Web and Clock display type. See the Attestation Buttons topic.
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.
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.
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:
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:
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:
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:
Custom Tag option
Tag
Description
<
PunchVerificationData
>Contains punch information.
Name:
Error Workflow Notification
Custom Tag option:
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.
-
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.
Configure the Chile Punch Receipt process model
- Migrate the business process model to the tenant Migrate the Chile Punch Receipt process model to the customer tenant using Setup Data Manager (SDM).
-
Log in to the appropriate tenant.
-
Go to Main Menu > Administration > Setup Data Manager.
-
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.
-
Click Tap Review and Publish. The Publish Summary panel appears.
-
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.
-
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.
-
To view details, click tap the appropriate row and click tap View Selected.
-
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.
-
Go to Main Menu > Administration > Application Setup > Business Process setup > Process Models.
-
Select the ChilePunchReceipt process and click tap Edit. The process model enters edit mode.
-
Select the Decision Tables tab.
-
Click Tap Everyone's, and then select the decision table to edit.
-
Click Tap Decision Table Editor to add or update the rows in the table.
-
Click Tap Save and close.
Caution:-
Values entered in the decision tables are case-sensitive, and must match configured values in the application.
-
Do not remove variables, variable names, or variable types from any decision table.
-
- Repeat the steps for each of the ChilePunchRecipt tables.
- ChilePunchReceipt_v1_InternalParameters— Controls internal punch receipt parameters.
Chile Punch Receipt Internal Parameters decision table structure
Chile Punch Receipt Internal Parameters decision table
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
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
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
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.
- You can translate some or all messages by adding lines to the table in their preferred translation for specific locales. Decision tables are scanned from top to bottom; therefore, place messages for the most commonly used Locale Policy at the top of the decision table and less-restrictive locale policies at the bottom.
- Text within tags ("<>") must not be changed.
- The decision table holds all messages represented with standard English labels; these apply to all locales when the Locale Policy is set to !=empty.
- 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 !=empty Locale Policy, add a new row to the decision table with the appropriate Locale Policy, and then add the localized value in the Message column.
- Decision tables support operators like "Contains," "Starts with," "Ends with," and "Is Not Empty." You can achieve your preferred results by following these examples:
- To match any non-empty or any string (like *), use the "Is Not Empty" operator.
- To match a string starting with "ABC" (like "ABC*"), use the "Starts with" operator and set the value to "ABC".
- To match a string containing "English" as substring, use the "Contains" operator with the value "English".
- The last row in the decision table must remain empty ("!=empty".)
Sample Locale key parameters
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.
- ChilePunchReceipt_v1_InternalParameters— Controls internal punch receipt parameters.
-
- Deploy the updated 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.
-
Go to Main Menu > Administration > Application Setup > Business Process Setup > Process Models.
-
Select the ChilePunchReceipt_v1 model.
-
Click Tap Edit, and then configure the required parameters and deployment dates. Select Notification Templates and Attestation from the Template Categories list.
-
Click Tap Save, and then select Return to deploy.
-
APIs
API Name |
Type |
Resource Path |
Description |
---|---|---|---|
GET |
/v1/commons/persons/employee |
Returns a person record by ID. | |
GET |
/v1/commons/user_preferences/locale_policy |
Returns user preferences for the current user or tenant. | |
GET |
v1/scheduling/schedule |
Returns a schedule pertaining to one employee, Hyperfind, or location. | |
POST |
/v1/platform/messaging/generic_notifications/notify | Sends a generic notification according to the provided event type. | |
POST |
/v1/timekeeping/attestation_workflow_attributes/{id} |
Sets Attestation workflow attributes by ID. | |
POST |
v1/timekeeping/timecard |
Updates a timecard for an employee as a manager. | |
POST |
v1/commons/data/multi_read |
Returns aggregated data by executing an ad-hoc query. | |
POST |
/v1/timekeeping/timecard/multi_read |
Returns a list of timecards based on the employees or Hyperfind details provided. |
Version history
Version |
Description |
---|---|
v1 |
Initial release. A punch receipt notification is generated for employees who punch using the clock or timestamp. |