Chile Audit Reports
In compliance with legislation in Chile, the Chile Audits Report extension generates multiple reports that employers provide to local authorities.
This extension relies on two component types to produce the reports:
-
BIRT reports — Pre-configured reports which adhere to the government-defined formats.
-
Boomi™ integration — This part of the extension retrieves timecard data that matches the selected Hyperfind and time period. It then calls the appropriate Report API which passes data to the corresponding BIRT report.
When the Boomi™ integration completes, the report is available in the completed section of the Report Library.
Each report is designed with a fixed layout, but labels can be edited in the report properties file. Default branding capabilities in UKG Pro Workforce Management( UKG Pro WFM) provide the mechanism for adding the company logo in the report header.
Reports available in this extension include:
-
Sundays and Holidays Working Report— Contains Sundays and holidays worked by the employee.
-
Historical Schedule Report— Contains the original and modified schedules associated with the employee.
-
Daily Working Hours Report— Contains employee worked hours, including breaks.
-
Assistance Report— Contains employee attendance.
-
Overtime Hours Agreement— Contains details of weekly overtime hours paid to the employee.
-
Chile Timecard Report— Contains employee timecard information.
Considerations and limitations
-
The report formats limit the maximum combination of employees and days that a report generates.
Report limitations
Report limitations
Report format
Maximum number of employees selected in the location
Maximum number of days
PDF
<=10,000
365
PDF
>10,000 <=25,000
15
Excel (XLSX)
<=10,000
365
-
The integration supports a maximum of:
-
30 overtime paycodes
-
30 absence paycodes
-
15 exceptions.
-
-
You can run the Historical Schedule and Chile Timecard reports for previous and future time periods. However, the Sundays and Holiday Working, Daily Working Hours, Assistance, and Overtime Agreement reports can be run only for previous time periods.
-
Data in the Overtime Agreement report is based on paycodes that are configured with the Requires Approval option enabled.
-
Tip: Data in the Historical Schedule report relies on shift labels that are used to create the employee schedules. You can apply the shift labels in schedule templates or directly in the Scheduler. Each label must contain a suffix that represents the shift type, such as _Daily, _Weekly, or _Monthly. When a scheduled shift is created without an appropriately configured shift label, a blank displays in the Type( Tipo) column in the Historical Schedule report.
-
For organizations that employ the Chile Punch Receipt extension, the paycode configured in the Chile Punch Receipt parameter PayCode must match the Chile Audit Report integration parameter Pay Code - Punch Receipt Pay Code.
User experience
Run the Chile Audit Reports integration
After navigating to the integration, the user selects an audit report, Hyperfind, time period, report format, and then generates the report.
View the status
When the integration completes, view the additional information.
Go to the Report Library
The user navigates to the Report Library and retrieves the report from the Completed section.
Before you start
Before you configure the Chile Audit Reports integration, you must do the following:
- Configure the following:
-
Function Access Profiles (FAP): The Retrieve Hidden Paycode Edits via API access control point must be set to
Allowed
in the FAP assigned to individuals who run the report. See the Function Access Profiles topic. -
Tip: Shift Labels: Configure shift labels that include a suffix, such as
_Daily
,_Weekly
, or_Monthly
. Use these shift labels in schedule templates or the Scheduler when you create employee schedules. The suffix indicates the shift type, and is referenced by the Historical Schedule Report when populating the Type( Tipo) column.Examples:
9amTo11pm_Daily
,9amTo6pm_Weekly
,7amTo5pm_Monthly
. -
Combined paycodes: Configure combined paycodes for each type of paycode represented in the reports. See the Combined Paycodes topic.
AbsencePayCode
ApprovedDaysPayCode
ApprovedHoursPayCode
CombinedOvertimePayCode
FullOvertimePayCode
HalfOvertimePayCode
OvertimePayCode
RestPayCode
UnauthorizedPayCode
VacationPayCode
WorkedHoursPayCode
-
Integration List Parameters: Create integration list parameters that identify the report output types and audit reports. See the Configure Integration List Parameters topic.
Name:
ChileAuditReports_iPack_v3_ReportOutputFormat
Description:
Output formats applicable to the Chile Audit Reports.
Parameter values:
PDF
(default),XLSX
.Name:
ChileAuditReports_iPack_v3_ReportList
Description:
Contains a list of all report names from which a selection is made to run a report.
Parameter values:
Parameter values
Name
Value
Sundays and Holidays Report
Chile-SundaysandHolidaysWorkingReport
Historical Schedule Report
Chile-HistoricalScheduleReport
Daily Working Report
Chile-DailyWorkingHoursReport
Assistance Report
Chile-AssistanceReport
Overtime Hours Agreement
Chile-OvertimeHoursAgreement
Timecard Report
Chile-TimecardReport
Caution: Parameter values configured in theChileAuditReports_iPack_v3_ReportList
integration list parameter must match the example. -
Extensions Tables: Configure the Chile Timecard Report and Chile Audit Report extension tables. See the Extension Tables topic.
Enter the following in the Commands for execution field for each extension table definition:
CREATE TABLE chiletimecardreport ( ApplyDate VARCHAR(255), TypeOfEntry VARCHAR(255), EmployeeNumber VARCHAR(255), EmployeeName VARCHAR(255), ScheduleStartTime VARCHAR(255), ScheduleEndTime VARCHAR(255), Exceptions VARCHAR(255), InPunch VARCHAR(255), AmountOfTimeLateIn VARCHAR(255), OutPunch VARCHAR(255), AmountOfTimeEarlyOut VARCHAR(255), ApprovedHours VARCHAR(255), ApprovedDays VARCHAR(255), Vacation VARCHAR(255), DailyTotals VARCHAR(255), UnauthorizedHours VARCHAR(255), OvertimePayCode VARCHAR(max), OvertimeHours VARCHAR(255), UniqueCode VARCHAR(255), ExecutionDate VARCHAR(255), SumDailyTotals VARCHAR(255), SumApprovedHours VARCHAR(255), SumApprovedDays VARCHAR(255), SumVacation VARCHAR(255), SumUnAuth VARCHAR(255), SumOvertime VARCHAR(255), SumLateIn VARCHAR(255), SumLateOut VARCHAR(255) ;
CREATE TABLE chileAuditReport_v2 ( EmployeeID VARCHAR(255), EmployeeNumber VARCHAR(255), CostCenter VARCHAR(255), Location VARCHAR(255), LaborType VARCHAR(255), AdditonalInfo VARCHAR(255), ManagerNmae VARCHAR(255), FullName VARCHAR(255), HSAttendance VARCHAR(255), HSAbsence VARCHAR(255), HSComments VARCHAR(max), HSWorked VARCHAR(255), HSJustify VARCHAR(255), HSLegend varchar(255), HSMonth VARCHAR(255), HSMonthWiseData VARCHAR(255), HSTotalPeriodData VARCHAR(255), HSDayofweek VARCHAR(255), HSDate VARCHAR(255), HSchOriginalShift VARCHAR(255), HSchTypeofShift VARCHAR(255), HSchModifiedShift VARCHAR(255), HSchChangedby VARCHAR(255), HSchComments VARCHAR(max), HSchLegend VARCHAR(255), HSchShift VARCHAR(255), HSchDayOfWeek VARCHAR(255), HSchDate VARCHAR(255), DWHShift VARCHAR(255), DWHPunchout VARCHAR(255), DWHScheduledbreak VARCHAR(255), DWHPunchoutforbreak VARCHAR(255), DWHPunchinafterbreak VARCHAR(255), DWHLatepunchin VARCHAR(255), DWHEarlypunchout VARCHAR(255), DWHEarlypunchoutbreak VARCHAR(255), DWHLatepunchinbreak VARCHAR(255), DWHOvertimehours VARCHAR(255), DWHComments VARCHAR(max), DWHWeeklyTotalOvertimehours VARCHAR(255), DWHWeeklyTotalLateIn VARCHAR(255), DWHWeeklyTotalEarlyOut VARCHAR(255), DWHWeeklyTotalEarlyPunchOutBreak VARCHAR(255), DWHWeeklyTotalLatePunchInBreak VARCHAR(255), DWHMonthlyTotalOvertimehours VARCHAR(255), DWHMonthlyTotalLateIn VARCHAR(255), DWHMonthlyTotalEarlyOut VARCHAR(255), DWHMonthlyTotalEarlyPunchOutBreak VARCHAR(255), DWHMonthlyTotalLatePunchInBreak VARCHAR(255), DWHMonth VARCHAR(255), DWHWeekNumber VARCHAR(255), DWHDayofWeek VARCHAR(255), DWHDate VARCHAR(255), ASAttendance VARCHAR(255), ASAbsence VARCHAR(255), ASComments VARCHAR(max), ASDayofWeek VARCHAR(255), ASDate VARCHAR(255), OHAFrom VARCHAR(255), OHAUntil VARCHAR(255), OHAOvertimeType1 VARCHAR(255), OHAOvertimeType2 VARCHAR(255), reportID VARCHAR(255), UniqueCode VARCHAR(255), ExecutionDate VARCHAR(255), month_number VARCHAR(255), ottabledescone VARCHAR(max), ottabledesctwo VARCHAR(max), ottabledescthree VARCHAR(max), ottabledescfour VARCHAR(max) ;
-
-
Get the URL, User, and Password for the APIGatewayServer.
Configure the Chile Audit Reports
- UKG Pro Workforce Management report configuration
- Customize the report labels.
-
Unzip the shared .zip file.
-
Navigate to the properties folder, and then open the properties file.
-
Provide values for the report strings.
-
Save the changes, and then add the updated file to the .zip file.
- Repeat these steps for each Chile Audit Report.
Chile Sundays and Holidays Working Report
Chile Sundays and Holidays Working Report - report labels
.zip file
Chile-SundaysandHolidaysReport.zip
Properties folder
Report1SundaysandHolidaysReport_v2 -> Properties
Properties file
report_com.kronos.report.data.design.Report1SundaysandHolidaysReport_v2_strings
Report strings
Report Title Name of Employee RUT Worker Type Day Date Absence Attendance Comments Report Footer Page number Printed by Hyperfind Timestamp Total Period From and To
Chile Historical Schedule Report
Chile Historical Schedule Report - report labels
.zip file
Chile-HistoricalScheduleReportEmployee.zip
Properties folder
Report2HistoricalScheduleReportEmployee_v2 -> Properties
Properties file
report_com.kronos.report.data.design.Report2HistoricalScheduleReportEmployee_v2_strings
Report strings
Report Title Name of Employee RUT Original shift: shift time Type of shift Change requested by Day of the Week Date Modified shift: shift time Comments Report Footer Page number Printed by Hyperfind Timestamp Total Period From and To
Chile Daily Working Hours Report
Chile Daily Working Hours Report - report labels
.zip file
Chile-DailyWorkingHoursReport.zip
Properties folder
Report3DailyWorkingHoursReport_v2-> Properties
Properties file
report_com.kronos.report.data.design.Report3DailyWorkingHoursReport_v2_strings
Report strings
Report Title Name of Employee RUT Schedule Shift Punch-in Punch-out Day of the Week Date Scheduled break Punch out for break Punch-in after break Late punch-in Early punch-out Early punch-out break Late punch-in break Overtime Comments Weekly Total Total Report Report Footer Page number Printed by Hyperfind Timestamp Total Period From and To
Chile Assistance Report
Chile Assistance Report - report labels
.zip file
Chile-AssistanceReport.zip
Properties folder
Report4AssistanceReport_v2-> Properties
Properties file
report_com.kronos.report.data.design.Report4AssistanceReport_v2_strings
Report strings
Report Title Name of Employee RUT Worker Name Day of the Week Calendar date Absence Attendance Comments Report Footer Page number Printed by Hyperfind Timestamp Total Period From and To
Chile Overtime Hours Agreement Report
Overtime Hours Agreement Report - report labels
.zip file
Chile-OvertimeHoursAgreementReport.zip
Properties folder
OvertimeHoursAgreementReport_v2 -> Properties
Properties file
report_com.kronos.report.data.design.OvertimeHoursAgreementReport_v2_strings
Report strings
Report Title Name of Employee RUT Cost Center Location Manager Name Day of the Week Date Job (Cargo) From Until Column for Overtime type1 Column for Overtime type2 Report Footer Page number Printed by Hyperfind Timestamp Total Period From and To
Chile Timecard Report
Chile Timecard Report - report labels
.zip file
Chile-TimecardReport.zip
Properties folder
ChileTimecardReport_v1 -> Properties
Properties file
report_com.kronos.report.data.design.ChileTimecardReport_v1_strings.properties
Report strings
Company Name Address Line1 Address Line2 Address Line3 Report Title Report Footer
-
- Localize the report strings.
-
Unzip the shared file.
-
Create a new properties file that adheres to the following naming convention:
report_com.kronos.report.data.design.<reportName>_v<versionNumber>_strings_<languageCode>_<countryCode>.properties
Example:
report_com.kronos.report.data.design.ChileTimecardReport_v1_strings_fr_FR.properties
-
Copy each key and value data pair from the strings properties file, and then paste the content into the new file.
-
Replace all values after the "
=
" with required locale data, and then save the properties file. -
Zip the file after completing and saving all localization.
-
- Repeat these steps for each Chile Audit Report.
Chile Sundays and Holidays Working Report
Chile Sundays and Holidays Working Report - localized report strings
.zip file
Chile-SundaysandHolidaysReport.zip
Properties folder
Report1SundaysandHolidaysReport_v2 -> Properties
Localized properties file
report_com.kronos.report.data.design.Report1SundaysandHolidaysReport_v2_strings_<languageCode>_<countryCode>
Chile Historical Schedule Report
Chile Historical Schedule Report - localized report strings
.zip file
Chile-HistoricalScheduleReportEmployee.zip
Properties folder
Report2HistoricalScheduleReportEmployee_v2 -> Properties
Localized properties file
report_com.kronos.report.data.design. Report2HistoricalScheduleReportEmployee_v2_strings_<languageCode>_<countryCode>
Chile Daily Working Hours Report
Daily Working Hours Chile - localized report strings
.zip file
Chile-DailyWorkingHoursReport.zip
Properties folder
Report3DailyWorkingHoursReport_v2-> Properties
Localized properties file
report_com.kronos.report.data.design.ChileTimecardReport_v1_strings_<languageCode>_<countryCode>
Chile Assistance Report
Chile Assistance Report - localized report strings
.zip file
Chile-AssistanceReport.zip
Properties folder
Report4AssistanceReport_v2-> Properties
Localized properties file
report_com.kronos.report.data.design. Report4AssistanceReport_v2_strings_<languageCode>_<countryCode>
Chile Overtime Hours Agreement Report
Chile Overtime Hours Agreement Report - localized report strings
.zip file
Chile-OvertimeHoursAgreementReport.zip
Properties folder
OvertimeHoursAgreementReport_v2 -> Properties
Localized properties file
report_com.kronos.report.data.design. OvertimeHoursAgreementReport_v2_strings_<languageCode>_<countryCode>
Chile Timecard Report
Chile Timecard Report - localized report strings
.zip file
ChileTimecardReport.zip
Properties folder
ChileTimecardReport_v1 -> Properties
Localized properties file
report_com.kronos.report.data.design.ChileTimecardReport_v1_strings_<languageCode>_<countryCode>
Note:Refer to the table for appropriate character sequences to use in the properties file.
Character sequence
Properties file character sequence
Character
Character Sequence
Space
\
Colon
\:
Semicolon
\;
Blank
\t
Note:-
If you plan to test the report in your non-production (NPR) environment before implementation in your production (PRD) environment, you must complete each of the following UKG Pro WFM report configuration steps in both NPR and PRD environments.
-
Manage Read Only Reports must be enabled on the tenant in the NPR environment.
-
- Customize the report labels.
- Migrate the report data objects (RDO) configuration to the tenant Migrate each Chile Audit Report RDO .zip file to the customer tenant using Setup Data Manager (SDM).
-
Log in to the appropriate tenant.
-
Go to
. -
Select the Source tenant where the RDO configuration 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.
- Repeat these steps for each Chile Audit Report.
-
SDM_SundaysHolidaysWorkingReport_RDO.zip
-
SDM_HistoricalScheduleReport_RDO.zip
-
SDM_DailyWorkHours_RDO.zip
-
SDM_AssistanceReport_RDO.zip
-
SDM_OvertimeAgreementReport_RDO.zip
-
SDM_ChileTimecardReport_RDO.zip
-
-
- Deploy the Chile Audit Reports
Note: The BIRT reports must be redeployed every time changes are made to existing report objects. Re-deployment is not required for integration process changes.
-
Go to
. -
Click Tap Create, and then select Choose File.
-
Select a Chile Audit Report .zip file, and then click tap Upload.
-
Click Tap Save after the upload completes.
-
Go to
. -
Select the Chile Audit Report, and then click tap Publish.
-
Configure the report-specific fields:
Report Name<Enter the name as it is configured in the integration list parameter,
ChileAuditReports_iPack_v3_ReportList
.> Default Output Type:pdf
Output formats Category:Custom Reports
Note: The value entered in Report Name must match the report name configured in the Report List integration control parameter. -
Click Tap Save to publish the report. See the Unpublished Reports topic.
Chile Audit Reports
Chile Audit Reports
Chile Audit Report .zip file
Output formats
Chile-SundaysandHolidaysReport.zip
PDF
Chile-HistoricalScheduleReportEmployee.zip
PDF
Chile-DailyWorkingHoursReport.zip
PDF
Chile-AssistanceReport.zip
PDF
Chile-OvertimeHoursAgreementReport.zip
PDF
ChileTimecardReport.zip
PDF, XLSX
-
- Configure the logo
Configure the branding logo that appears in the report header. After choosing the file, select Use this logo for all reports regardless of the active theme. Report logos are displayed on a white background. See the Themes topic.
Note: By default, the system uses the logo specified in the active theme for reports. If you wish, you can designate that the logo specified in a different theme be used for all reports, even if that theme is not active. - Approve the Chile Audit Reports
-
Login to UKG Pro WFM as a Support User.
-
Go to
. -
Select the Chile Audit Report file, and then click tap Review.
-
Select Approve, and then click tap Apply. This action changes the Approval Status from Pending to Approved.
- Repeat these steps for each Chile Audit Report.
-
Chile-SundaysAndHolidaysWorkingReport
-
Chile-HistoricalScheduleReport
-
Chile-DailyWorkHoursReport
-
Chile-AssistanceReport
-
Chile-OvertimeAgreementReport
-
Chile-TimecardReport
-
-
- Configure access to the Chile Audit Reports
Add each Chile Audit Report to the Report Data Access Profile assigned to individuals who run the report. See the Report Data Access Profiles topic.
Configure the Chile Audit Reports integration
- Deploy the Chile Audit Reports integration
Note: For more information, see the Deploy Integration Packs to your Atom topic.
-
Open the Integration Template Designer: Select Main Menu
. Note: If prompted, enter your Username and Password. Click Tap Log in. -
Make sure that the Account is correct. If not, select the right account.
- Select the Deploy tab > Integration Packs.
- From the list in the left column, search for and select the Pro WFM Chile Audit Reports Extension integration. Note: If the integration does not display, select Browse Integration Packs to search for and select the iPack.
-
Click Tap Install.
-
From Unattached Environments, select the environment in which to deploy the integration process for the selected integration. Click Tap the double-left arrows button
.
-
- Configure the Chile Audit Reports integration settings
- Select the environment
- Select the Manage tab > Atom Management.
- Select your environment.
- Select environment extensions
- In Administration, click tap Environment Extensions.
- In Process Filter, click tap the magnifying glass
. It can take several seconds before the button becomes active. - Scroll to and select the integration pack: .
- Select the environment
- Configure connection settings
Caution: If you select Use Default for the connection settings and process properties, ensure that Value is blank. If Value is not blank, that value overrides the default value whether or not Use Default is selected or cleared. Example: If the default value is abc, but Value shows xyz, the integration uses xyz regardless of the setting of Use Default.
- Select Connection Settings.
-
From the Connection dropdown list, select and configure the following:
Connection Settings
Connection Settings for the integration
Setting
Required
Actions
ChileAuditReports_iPack_v3_APIGatewayServer
Required
To change the default API gateway server:
- Clear Use Default.
- Enter the URL to the server.
Example:
<tenantURL>/api
ChileAuditReports_iPack_v3_DatabaseServer
Required
The database server setting defines the connection to the file that contains the records.
To change the default server parameters:
- For each field, clear Use Default.
- Enter the following values:
In User, enter the username for the server.
In Password, select <Encrypted>. Enter the password for the server. Click Tap Apply.
Enter the Class Name.
Enter the Connection URL for the database server.
ChileAuditReports_iPack_v3_Locale_CRT
Required
Enable Override.
- Configure process properties
- Select Process Properties. Caution: Do not edit the default values of the AuthenticationProperties. By default, cookies are enabled and set the values for authentication properties.
-
Select ChileAuditReports_iPack_v3_CRTConfig to set process properties that must be configured before the integration can run. This main process starts the integration process and handles errors.
Process properties
Process properties
Process property name
Column header value
ChileAuditReports_iPack_v3_Locale_CRT
Parameter Name,Locale Policy,Value,Description
- Select Process Properties.
- Configure cross-reference tables
Cross-reference tables (CRT) are the look-up tables that the integrations use to translate parameter values. One or more data values from the source system can be used to assign one or more parameters in the destination system.
- If more than one row matches a reference value, the first match is the output value.
- If no match is found, the output value can be null, or the integration can produce errors.
- Select Cross Reference.
-
From the Cross Reference dropdown list, select the ChileAuditReports_iPack_v3 table.
-
Select Override, which allows you to:
- Download the table when you run the integration
- Edit the table cells in Extensions
- When you finish, click tap OK.
ChileAuditReports_iPack_v3_Locale_CRT: Allows translation of messages and labels into different languages.
Column name |
Description |
---|---|
Parameter Name |
Key for which localization is defined. |
Locale Policy |
Locale Policy. You can use an asterisk (*) as a wildcard, but put the less-restrictive locale policy names at the bottom of the table because the integration scans cross-reference tables from the top.
|
Value |
Message shown in Additional Details, or value of the label defined in the Run Summary section. |
Description |
The description that is shown in Additional Details. |
-
Localization of integration extensions remains optional, but is supported.
-
The cross-reference table (CRT) 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 CRT.
-
Names of the parameters in the CRT 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 CRT with the appropriate Locale Policy, and then add the localized values in the Message (or Value) and Description CRT columns.
-
Do not enter values in the CRT column "Description" if it is blank.
-
Do not modify placeholders (<>) or the configurable values that are included in the CRT column "Message" (or "Value").
Exception_
to the exception name. If the exception name contains spaces, replace each space with " _
".Do not change or localize the following parameter names in the Locale_CRT:
-
Report1_HolidayAndSundaysName
-
Report2_HistoricalScheduleReportName
-
Report3_DailyWorkingHoursReportName
-
Report4_AssistanceReportName
-
Report5_OvertimeHoursAgreementReportName
-
Report6_TimecardReportName
Parameter name |
Locale |
Value |
Description |
---|---|---|---|
DaysOfWeek_Sunday |
Spanish |
Domingo | |
DaysOfWeek_Monday |
Spanish |
Lunes | |
DaysOfWeek_Tuesday |
Spanish |
Martes | |
DaysOfWeek_Wednesday |
Spanish |
Miércoles | |
DaysOfWeek_Thursday |
Spanish |
Jueves | |
DaysOfWeek_Friday |
Spanish |
Viernes | |
DaysOfWeek_Saturday |
Spanish |
Sábado | |
Regular_Entry |
* |
Prog. Trab. |
Value in the Type report field when a scheduled shift exists. |
Crt_Blank_Code |
* |
Omitted |
Value in the Punch-In and Punch-Out report fields when punches do not exist for the shift. |
DaysOfWeek_Sunday |
* |
Sunday | |
DaysOfWeek_Monday |
* |
Monday | |
DaysOfWeek_Tuesday |
* |
Tuesday | |
DaysOfWeek_Wednesday |
* |
Wednesday | |
DaysOfWeek_Thursday |
* |
Thursday | |
DaysOfWeek_Friday |
* |
Friday | |
DaysOfWeek_Saturday |
* |
Saturday | |
Error_AbsencePayCode |
* |
Absence paycode integration parameter is not configured. |
Error displayed in the Run Summary when the Paycode - Absence Pay Code integration parameter is not configured. |
Error_ApprovedDaysPayCode |
* |
Approved days paycode not provided. |
Error displayed in the Run Summary when the Pay Code - Approved Days Pay Code integration parameter is not configured. |
Error_ApprovedHoursPayCode |
* |
Approved hours paycode not provided. |
Error displayed in the Run Summary when the Pay Code - Approved Hours Pay Code integration parameter is not configured. |
Error_DisplayBreak |
* |
Display break integration parameter is not configured. |
Error displayed in the Run Summary when the Display Break integration parameter is not configured. |
Error_EmployeeIDExecution |
* |
Timecard Report cannot be run for individual Employee IDs. Please select a Hyperfind or Location. | |
Error_FullOverTimePayCode |
* |
Full overtime paycode integration parameter is not configured. |
Error displayed in the Run Summary when the Paycode - Full Overtime Pay Code integration parameter is not configured. |
Error_GenericFailureMessage |
* |
Integration has failed to complete due to an API error. Please go to process reporting to check the error. | |
Error_HalfOvertimePayCode_Description |
* |
Half Overtime Integration parameter is not configured. |
Error displayed in Run Summary when the Paycode – Half Overtime Pay Code integration parameter is not configured. |
Error_HalfOvertimePayCode_Message |
* |
Paycode not provided. | |
Error_HyperfindAndLocationSelector |
* |
Hyperfind or Location not provided. |
Error displayed in the Run Summary when a Hyperfind or location is not selected during runtime. |
Error_HyperfindAndLocationSelectorType |
* |
Hyperfind or location integration parameter is not configured. |
Error displayed in the Run Summary when the Locations & Hyperfind integration parameter is not configured. |
Error_NoEmployee |
* |
Selected Hyperfind is blank. No employee returned. |
Error displayed in the Run Summary when the selected Hyperfind or location does not return employees. |
Error_InvalidPayCode |
* |
Invalid paycodes |
Paycodes cannot be found in the application. |
Error_messageFutureDateValidation |
* |
Only previous time periods can be selected. | |
Error_messageInvalidEndDate |
* |
Invalid end date format provided. | |
Error_OrgPathLevelsToDisplay |
* |
Org path levels integration parameter is not configured. |
Error displayed in the Run Summary when the Org Path Levels integration parameter is not configured. |
Error_OvertimePayCode |
* |
Overtime paycode integration parameter is not configured. |
Error displayed in the Run Summary when the Paycode - Overtime Pay Code Combined integration parameter is not configured. |
Error_PunchPayCode |
* |
Punch paycode integration parameter is not configured. |
Error displayed in the Run Summary when the Pay Code - Punch Receipt Pay Code integration parameter is not configured. |
Error_ReportAssistanceReport |
* |
Assistance Report did not run. |
Error displayed when a mandatory parameter is missing during the report run. |
Error_ReportCommonMessage |
* |
Report could not be run. | |
Error_ReportCommonValue |
* |
Invalid parameters. | |
Error_ReportDailyWorkingHoursReport |
* |
Daily Working Hours Report did not run. |
Error displayed when a mandatory parameter is missing during the report run. |
Error_ReportHistoricalScheduleReport |
* |
Historical Schedule Report did not run. |
Error displayed when a mandatory parameter is missing during the report run. |
Error_ReportList |
* |
Report list cannot be blank. |
Error displayed in the Run Summary when a report is not selected from the Report List parameter during runtime. |
Error_ReportOfSundaysAndHolidays |
* |
Sundays and Holidays Report did not run. |
Error displayed when a mandatory parameter is missing during the report run. |
Error_ReportOvertimeHoursAgreement |
* |
Overtime Hours Agreement Report did not run. |
Error displayed when a mandatory parameter is missing during the report run. |
Error_ReportOutputFormatIncorrect |
* |
Incorrect report output format. Accepted values: pdf, xlsx. |
Error displayed in the Run Summary when an incorrect report output format is configured. |
Error_ReportOutputFormatMissing |
* |
Report output format not provided. |
Error displayed in the Run Summary when the Report - Output Format integration parameter is not configured. |
Error_ReportStatus |
* |
Report run failed. |
Error displayed in the run summary when the integration fails to complete the report. |
Error_RestPayCode |
* |
Rest paycode not provided. |
Error displayed in the Run Summary when the Pay Code - Rest Pay Code integration parameter is not configured. |
Error_TimecardReport |
* |
Timecard Report failed to qualify the validation. | |
Error_TimePeriod |
* |
Time period not provided. |
Error displayed in the Run Summary when a time period is not selected during runtime. |
Error_VacationDaysPayCode |
* |
Vacation days paycode not provided. |
Error displayed in the Run Summary when the Pay Code - Vacation Pay Code integration parameter is not configured. |
Error_UnauthorizedHoursPayCode |
* |
Unauthorized paycode not provided. |
Error displayed in the Run Summary when the Pay Code - Unauthorized Pay Code integration parameter is not configured. |
Error_WorkedHoursPayCode |
* |
Worked hours paycode integration parameter is not configured. |
Error displayed in the Run Summary when the Paycode - Worked Hours Pay Code integration parameter is not configured. |
Exception_bonus_applied |
* |
BA |
Bonus applied exception |
Exception_cancelled_Deduction |
* |
CD |
Canceled deduction exception |
Exception_core_hours_violation |
* |
CHV |
Core hours violation exception |
Exception_early_in |
* |
EI |
Early in exception |
Exception_early_out |
* |
EO |
Early out exception |
Exception_excused_absence |
* |
EA |
Excused absence exception |
Exception_late_in |
* |
LI |
Late in exception |
Exception_late_out |
* |
LO |
Late out exception |
Exception_long_break |
* |
LB |
Long break exception |
Exception_long_shift |
* |
LS |
Long shift exception |
Exception_long_total_break |
* |
LTB |
Long total break exception |
Exception_missed_in_punch |
* |
MIP |
Missed In-punch exception |
Exception_missed_out_punch |
* |
MOP |
Missed Out-punch exception |
Exception_short_break |
* |
SB |
Short break exception |
Exception_short_shift |
* |
SS |
Short shift exception |
Exception_short_total_break |
* |
STB |
Short total break exception |
Exception_unexcused_absence |
* |
UA |
Unexcused absence exception |
Exception_unscheduled |
* |
USCH |
Unscheduled exception |
Exception_very_Late_out |
* |
VLO |
Very late out exception |
Exception_very_early_in |
* |
VEI |
Very early in exception |
Failed_Report_Status |
* |
Report did not complete. | |
Holiday |
* |
Holiday | |
Holiday_Comment |
* |
Rest | |
Holiday_Justify |
* |
Justified | |
Holiday_MonthWiseData |
* |
Monthly data | |
Holiday_TotalPeriod |
* |
Total Period | |
Holiday_Worked_No |
* |
No | |
Holiday_Worked_Yes |
* |
Yes | |
Label_AllPartialFailedMessage |
* |
Selected reports failed to complete. | |
Label_CompletedAddMessage |
* |
Integration completed without errors. Additional details, such as disqualifications, may be accessible using the button below. | |
Label_CompletedMessage |
* |
Integration completed without errors. Please go to the Report Library to view the report. | |
Label_HalfPartialSuccessMessage |
* |
Some of the employees are invalid. | |
Label_PartialFailedMessage |
* |
Selected employees are not valid. | |
Label_PartialSuccessAddMessage |
* |
Process completed with record-level errors. Additional details, such as disqualifications, may be accessible using the button below. | |
Label_PartialSuccessMessage |
* |
Process completed with record-level errors. Please go to the Report Library to view the reports. | |
Label_SummaryMessage |
* |
<Report Value> out of <Report List>. | |
Label_SummaryMessageZero |
* |
0 out of <Report List>. | |
Label_SummaryStatusFailed |
* |
Report did not complete. | |
Label_SummaryStatusPartialSuccess |
* |
Some reports failed to complete. For additional information click on Additional details. | |
Label_SummaryStatusSuccess |
* |
Report completed successfully. | |
Labour |
* |
Labor | |
Legend_HistoricalScheduleReport |
* |
No shift changes during the select time period. | |
Legend_SundaysandHolidaysWorkingReport |
* |
The schedule for this employee does not include Sundays or Holidays. | |
Message_BlankReport |
* |
No data found to generate the report. |
Message displayed in the run summary when the integration does not generate report data. |
Message_Deleted |
* |
Deleted | |
Message_Employee |
* |
Employee | |
Message_Employer |
* |
Employer | |
Message_Insert |
* |
Insert | |
Message_InvalidEmployeeIds |
* |
Invalid employees. | |
Message_InvalidEmployeeIdsDesc |
* |
Employee with ID <Person Number> does not exist. | |
Message_SuccessReportStatus |
* |
Please navigate to Report Library page to fetch the report. |
Message displayed in the run summary when the integration completes successfully. |
Message_UnplannedComment |
* |
Unplanned. | |
Message_Update |
* |
Update | |
MonthName_January |
* |
January | |
MonthName_Feburary |
* |
February | |
MonthName_March |
* |
March | |
MonthName_April |
* |
April | |
MonthName_May |
* |
May | |
MonthName_June |
* |
June | |
MonthName_July |
* |
July | |
MonthName_August |
* |
August | |
MonthName_September |
* |
September | |
MonthName_October |
* |
October | |
MonthName_November |
* |
November | |
MonthName_December |
* |
December | |
OvertimeAgreementValue |
* |
The parties agree that all hours worked by the employee outside their regular working hours shall be compensated as overtime, with a limit of two overtime hours per day, on the dates specified. | |
OvertimeRegulationValue |
* |
If the total hours worked in a given week result in a number of hours less than 45 hours or the agreed upon hours if they are fewer, then the employee will not have fulfilled their contractual commitment, giving the employer the right to deduct from the remunerations paid, the hours that were lacking to meet the legally required working hours for the respective week. Additionally, it is worth noting that for the purpose of determining the existence of delays subject to deduction, hours not worked in a week due to delays and absences may be offset against hours worked in excess of the daily working hours within the same week. The act of punching in before the scheduled time as stipulated in the internal regulations, and with the full knowledge of the employee, shall not be considered as overtime, and therefore, no payment shall be generated. Employees may, in accordance with their interests and the needs of the establishment where they work, agree to compensatory days off in relation to the Sundays and/or holidays they have worked within the calendar month. | |
Partial_Report_Status |
* |
Some reports failed to complete. Click on Additional Details for information. | |
Regular_Entry |
* |
Sched. Work |
Value in the Type report field when a scheduled shift exists. |
Report1_HolidayAndSundaysName |
* |
Report1-SundaysandHolidaysWorkingReport | |
Report2_HistoricalScheduleReportName |
* |
Report2-HistoricalScheduleReport | |
Report3_DailyWorkingHoursReportName |
* |
Report3-DailyWorkingHoursReport | |
Report4_AssistanceReportName |
* |
Report4-AssistanceReport | |
Report5_OvertimeHoursAgreementReportName |
* |
Report5-OvertimeHoursAgreement | |
Report6_TimecardReportName |
* |
ChileTimecardReport_v1 | |
Rest_Entry |
* |
Rest |
Value in the Type report field when a rest day entry exists. |
Success_Report_Status |
* |
Report completed successfully. | |
Total |
* |
Total |
Custom tags available for use in messages and labels include: < Person Number
>, < Report Value
>, and < Report List
>.
Install the Chile Audit Reports integration
After the integrations are deployed and the connection settings and process properties are configured, install the integrations to make them available for running or scheduling.
-
An integration template is the configured integration that you deploy to an Atom and then install to make available for running or scheduling.
- An installed integration is a single instance of an integration that is based on an integration template. When you install an integration, you can define parameters or set parameters to be defined when the integration is run.
- Select Main Menu
. - Click Tap Create
. - In Integration Name enter a unique name, such as
ChileAuditReports_iPack_v3
. - (Optional) Enter a Description.
Note: Do not select API Integration.
- In File Access, select None to not select a connection.
Note: Do not select Execute Integration with System Account.
-
(Optional) Select Re-Run to allow repeated runs of the integration with the same parameter values as the previous run.
-
Email Notifications
(Optional)
- Select Yes to send email and control center notifications for integration runs.
- Enter the email addresses of the recipients for the following types of run status. For multiple recipients, separate the addresses by a comma, but no spaces:
In Progress — The integration run started and has not finished.
Completed — The integration ran successfully without errors.
Failed — The integration ran successfully, but one or more records have errors. The integration run is treated as failed. If Abort on Failure is configured in an integration set, the integration set stops.
Completed with Errors — The integration run has errors or could not run.
- In Skip Configuration, select None(default) to allow multiple integrations to run at the same time or with the same data without restrictions.
Note: Do not select Allow Minute Interval.
- Integration template and parameters
- In Integration Template, select ChileAuditReports_iPack_v3.
- Click Tap Assign
. - In Integration Parameters, you can override default settings. Click Tap Create.
- Complete the configuration for each integration parameter value.
-
Click Tap Save.
Repeat this step for each integration parameter that supports the Chile Audit Reports process.
Integration Parameters
Integration Parameters
Parameter name
Description / User prompt / Mandatory
Template parameter
Parameter type
Locations & Hyperfind
The default Hyperfind or Location query that contains the employees for whom the integration is run.
User prompt = Yes
Mandatory = Yes
HyperfindAndLocationSelector
Hyperfind
TimePeriod
The date range or symbolic time period for which the report is run.
Supported values include:
0
= Previous pay period1
= Current pay period2
= Next pay period3
= Previous schedule period4
= Current schedule period5
= Next schedule period6
= Week to date7
= Last week8
= Yesterday10
= Range of relative dates11
= Specific date12
= Relative specific date13
= TodayUser prompt = Yes
Mandatory = Yes
TimePeriod
Time Period
Display Break
Determines whether break-related columns are displayed in the Daily Work Hours Report.
true
(default): break-related columns are displayed.false
: break-related columns are not displayed.User prompt = No
Mandatory = Yes
Display Break
Boolean
CustomWorkerType
Defines the value that represents CL-Jornada Excepcional in the Additional Details section of People Information.
User prompt = No
Mandatory = Yes
CustomWorkerType
Text
Report - Output Format
Identifies the integration list parameter that defines the audit report output formats.
User prompt = Yes
Mandatory = Yes
ReportOutputFormat
Dropdown
Locale
Determines the locale of the output file.
User prompt = No
Mandatory = No
Locale
Text
Pay Code - Approved Days Pay Code
The combined paycode that contains approved days.
User prompt = No
Mandatory = Yes
ApprovedDaysPayCode
Text
Pay Code - Approved Hours Pay Code
The combined paycode that contains approved hours.
User prompt = No
Mandatory = Yes
ApprovedHoursPayCode
Text
Pay Code - Overtime Pay Code
Semicolon-separated (;) list of overtime hours paycodes.
User prompt = No
Mandatory = Yes
OvertimePayCode
Text
Pay Code - Punch Receipt Pay Code
Identifies the paycode to which an attached comment stores the punch time in hh:mm:ss format.
User prompt = No
Mandatory = No
Note: If the organization also uses the Chile Punch Receipt extension, this value must match the PayCode parameter value in the Chile Punch Receipt Parameters decision table.PunchPayCode
Text
Pay Code - Rest Pay Code
The combined paycode that contains rest days.
User prompt = No
Mandatory = Yes
RestPayCode
Text
Paycode - Overtime Pay Code Combined
The combined paycode that contains all overtime hours.
User prompt = No
Mandatory = Yes
CombinedOvertimePayCode
Text
Paycode - Half Overtime Pay Code
The combined paycode that contains 50% overtime hours.
User prompt = No
Mandatory = Yes
HalfOvertimePayCode
Text
Paycode - Full Overtime Pay Code
The combined paycode that contains 100% overtime hours.
User prompt = No
Mandatory = Yes
FullOvertimePayCode
Text
Paycode - Absence Pay Code
Semicolon-separated list of absence paycodes.
User prompt = No
Mandatory = Yes
AbsencePayCode
Text
Paycode - Worked Hours Pay Code
The combined paycode that contains all worked hours.
User prompt = No
Mandatory = Yes
WorkedHoursPayCode
Text
Pay Code - Unauthorized Pay Code
The combined paycode that contains unauthorized hours.
User prompt = No
Mandatory = Yes
UnauthorizedPayCode
Text
Pay Code - Vacation Pay Code
The combined paycode that contains vacation days.
User prompt = No
Mandatory = Yes
VacationDaysPayCode
Text
Org Path Levels
Determines the number of business structure levels to display.
Default =
2
User prompt = No
Mandatory = Yes
Note: Org Path Levels do not support text, negative or decimal values.OrgPathLevelsToDisplay
Number
Report List
Identifies the integration list parameter that defines the audit report list.
Default =
ChileAuditReports_iPack_v3_ReportList
User prompt = Yes
Mandatory = Yes
ReportList
List
RUT
Defines the value that represents RUT in the Additional Details section of the People Information.
Default =
RUT
User prompt = No
Mandatory = Yes
CustomDataType
Text
Employee Number
A comma-separated list of specific employees for whom the integration is run.
When no value is entered, the integration defaults to the Locations & Hyperfind parameter.
To process the integration for only a limited group of employees, enter the person numbers as defined in the source system, each separated by a comma (,) but not spaces.
User prompt = Yes
Mandatory = Yes
Employee IDs
Text
- Make sure that the generic data access profiles (GDAP) allow access by the people who need to run the installed integration.
Run and test the Chile Audit Reports integration
Run integrations to test that the configuration is set up correctly.
-
Run the integration
- Select the integration:
- Select
Main Menu
. -
Click Tap
Run an Integration
. - Select the ChileAuditReports_iPack_v3 integration from the list. Click Tap Select.
- (Optional) Enter a unique Integration Run Name to make it easier to identify the run of the integration. Otherwise, the system assigns a default name, which ends with a date and time stamp.
- Select
Main Menu
-
Set parameters as follows:
- Report List: Select a report.
- Hyperfind: Select a Hyperfind query of employees.
-
Employee ID: To process data for only a limited group of employees, enter the person numbers, as defined in the source system, each separated by a comma (,) but no spaces.
For 3 employees:
13997,15556,20012
- Time Period: Select a date range or symbolic period.
- Report Output Format: Select PDF.
-
Select the following:
- Run Integration : If this is the first time this integration is being run.
- Re-Run: If this integration has been run before, and the status is not In-Progress, you can run the integration again without entering the parameter values again. Click Tap Yes to continue, or No to not run the integration and to return to the parameter settings.
- Wait for the confirmation that the integration completed or failed. Close the panel.
-
Click Tap
Refresh
. - To see details, select the integration run. Select Run Summary.
- Select the integration:
-
Check the results
Status indicators
-
In-Progress: The run of this integration has not yet completed. -
Completed: The integration ran successfully without errors. -
Scheduled: This integration is scheduled to run later or repeatedly. - (Grayed out) Scheduled but Deleted: This integration is scheduled to run, but the integration template has been deleted. When it runs, it will generate an error. To prevent this error, delete the scheduled integration run.
-
Completed with Errors: The integration ran successfully, but one or more records have errors. The integration run is treated as failed. If Abort on Failure is configured in an integration set, the integration set stops. -
Failed: The integration run has errors or could not run. - To troubleshoot and resolve errors, do the following:
Check the Run Summary for details.
- To troubleshoot all types of errors, or if the Run Summary shows a large number of errors, click tap Go to Additional Details (if available), or click tap the Source File to open and examine the input source file.
- (Only for import integrations) To troubleshoot and resubmit integrations that have transactional or data errors, click tap Go to Transaction Assistant.
To check the results in more detail:
- Click Tap the tile for the integration run.
-
Click Tap
Run Summary to see the results of the integration run.
Example Run Summary details
Note: The available details vary by integration and configuration.- Integration Run Name: Name of this run of the integration.
- Process Name: Name of any integration set that includes this integration.
- Integration Name: Name of the installed integration.
- Integration Reference ID: Unique identifier for this integration run (to help in troubleshooting errors).
- User: The person or user account that ran the integration.
- Integration Type: Import, Export, or None
- Start Date: Date and time when the integration run started.
- End Date: Date and time when the integration run finished.
- Status: In-Progress, Completed, Completed with Errors, or Failed.
- Records Processed: Number of records that were processed.
- Records Created: Number of records that were created.
- Errors: Number of records that failed.
- Source Files, Output File, and Error Files: For file-based import integrations, use Manage SFTP to access the source and output files on the inbound (source) and outbound (destination) SFTP folders. See the Manage SFTP topic.
- Log in to the destination system and ensure that the data has been correctly updated.
Note: You can schedule integrations and integration sets to run once later or at a recurring frequency. See the Schedule Integrations topic. -
APIs
API name |
Type |
Resource path |
Description |
---|---|---|---|
POST |
/v1/commons/persons/extensions/multi_read |
Retrieves multiple person records based on search criteria. | |
POST |
/v1/commons/hyperfind/execute |
Executes a Hyperfind query by ID or qualifier, and then returns the result. | |
GET |
/v1/commons/user_preferences/locale_policy |
Retrieves tenant default locale details or the locale details associated with the current user. | |
POST |
/v1/commons/data/multi_read |
Retrieves records based on the keys provided in the request and the filter criteria. | |
POST |
/v1/timekeeping/timecard/multi_read |
Retrieves a list of timecards based on the selected employee or Hyperfind details. Required parameters include employee ID or person number, and a date range or symbolic period ID. | |
POST |
/v1/timekeeping/setup/pay_codes/multi_read |
Retrieves one or more paycodes available to the logged-in manager by object references. | |
POST |
/v1/platform/reports/{name}/execute |
Runs a report by name. | |
GET |
/v1/platform/report_executions/{id}/file |
Retrieves an executed report by ID as an attachment. | |
GET |
/v1/timekeeping/exception_types |
Retrieves all exception types. | |
POST |
/v1/timekeeping/timecard_metrics/multi_read |
Retrieves combined paycode details. | |
POST |
/v1/scheduling/audits/multi_read |
Retrieves schedule audit details. | |
POST |
/v1/scheduling/schedule/multi_read |
Retrieves schedule details and holidays assigned to the employee. |