Chile Audit Reports

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 configure this integration, you must 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.

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.

Combined paycodes: Configure combined paycodes for each type of paycode represented in the reports. See the Combined Paycodes topic.

Integration List Parameters: Create integration list parameters that identify the report output types and audit reports. See the Configure Integration List Parameters topic.

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:

Version history

Audit reports

Change type	Process	Description
Initial release	ChileTimecardReport_v1	Configurable BIRT report which receives timecard data from the Boomi™ integration.
Enhancement	This enhancement includes multiple configurable BIRT reports that are generated by way of Boomi™ based on user-selected timeframe or date range, and Hyperfind or specific employees. Completed reports are retrieved from the Report Library.
	Chile-SundaysandHolidaysWorkingReport	Receives the Sundays and Holidays worked by an employee in the past.
	Chile-HistoricalScheduleReport	Receives the changes that a schedule underwent, the original schedule and who requested the change for an employee.
	Chile-DailyWorkingHoursReport	Receives the amount of worked hours, including breaks, in the past for an employee.
	Chile-AssistanceReport	Receives the employee’s past attendance.
	Chile-OvertimeHoursAgreement	Receives weekly detail for OT hours that will be paid to an employee in the past.

UKG Pro Workforce Management™ report configuration

Customize the report labels.

1. Unzip the shared .zip file.

2. Navigate to the properties folder, and then open the properties file.

3. Provide values for the report strings.

4. Save the changes, and then add the updated file to the .zip file.

Repeat these steps for each Chile Audit Report.

Localize the report strings.

1. Unzip the shared file.

2. 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

3. Copy each key and value data pair from the strings properties file, and then paste the content into the new file.

4. Replace all values after the "=" with required locale data, and then save the properties file.

5. Zip the file after completing and saving all localization.

Repeat these steps for each Chile Audit Report.

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).

1. Log in to the appropriate tenant.

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

3. 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.

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.

Repeat these steps for each Chile Audit Report.

Deploy the Chile Audit Reports

The BIRT reports must be redeployed every time changes are made to existing report objects. Re-deployment is not required for integration process changes.

1. Go to Main Menu > Administration > Application Setup > Common Setup > Manage Read-Only Report.

2. Click Tap Create, and then select Choose File.

3. Select a Chile Audit Report .zip file, and then click tap Upload.

4. Click Tap Save after the upload completes.

5. Go to Main Menu > Administration > Application Setup > Common Setup > Unpublished Reports.

6. Select the Chile Audit Report, and then click tap Publish.

7. Configure the report-specific fields:

   Report Name <Enter the name as it is configured in the integration list parameter, ChileAuditReports_v2_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.

8. Click Tap Save to publish the report. See the Unpublished Reports topic.

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

1. Login to UKG Pro WFM as a Support User.

2. Go to Main Menu > Administration > Application Setup > Common Setup > Manage Read-Only Report.

3. Select the Chile Audit Report file, and then click tap Review.

4. 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.

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.

Version history

Integration

Version	Process	Description
1	ChileTimecardReport_v1	An integration that generates the Chile Timecard Report.
2	ChileAuditReports_v2	An integration that generates audit compliance reports. Replaces the ChileTimecardReport_v1 integration.

1. Configure Access to Integrations.

2. Deploy the ChileAuditReports_v2 integration. See the Deploy Integrations topic.

3. Get the URL for the APIGatewayServer for the tenant.

Select the environment

1. Open the Integration Template Designer: Select Main Menu  > Administration > Application Setup > Integrations Setup > Design Integration Templates.

   Note: If prompted, enter your Username and Password. Click Tap Log in.

2. Select the Manage tab > Atom Management.
3. Select your environment.

Select environment extensions

1. In Administration, click tap Environment Extensions.
2. In Process Filter, click tap the magnifying glass . It can take several seconds before the button becomes active.
3. Scroll to and select the integration pack: ChileAuditReports > ChileAuditReports_v2.

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.

Configure connection settings

1. Select Connection Settings.

2. From the Connection dropdown list, select and configure the following:

   Connection Settings

   Setting	Required	Actions
   ChileAuditReports_v2_APIGatewayServer	Required	To change the default API gateway server: Clear Use Default. Enter the URL to the server. Example: <tenantURL>/api
   ChileAuditReports_v2_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.

Configure process properties

1. 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.

2. Select ChileAuditReports_v2_CRTConfigProperties.

3. For each process property, disable the Use Default option, and then provide the cross-reference table (CRT) column header value.

   Process properties

   Process property name	Column header value
   ChileAuditReports_v2_Locale_CRT	Parameter Name, Locale Policy, Value, Description

4. In the Cross Reference section, enable the override option for the CRT.

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.

1. Select Cross Reference.

2. From the Cross Reference dropdown list, select the Chile Audit Reports table.

3. Select Override, which allows you to:

• Download the table when you run the integration
• Edit the table cells in Extensions

4. When you finish, click tap OK.

ChileAuditReports_v2_Locale_CRT: Allows translation of messages and labels into different languages.

Custom tags available for use in messages and labels include: <Person Number>, <Report Value>, and <Report List>.

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.

1. Select Main Menu  > Administration > Application Setup > Integrations Setup > Install Integrations.
2. Click Tap Create .
3. In Integration Name enter a unique name, such as ChileAuditReports_v2.
4. (Optional) Enter a Description.

Note: Do not select API Integration.

5. In File Access, select None to not select a connection.

Note: Do not select Execute Integration with System Account.

6. (Optional) Select Re-Run to allow repeated runs of the integration with the same parameter values as the previous run.

7. Email Notifications

   (Optional)

   1. Select Yes to send email and control center notifications for integration runs.
   2. 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.

8. 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.

9. Integration template and parameters
   1. In Integration Template, select ChileAuditReports_v2.
   2. Click Tap Assign .
   3. In Integration Parameters, you can override default settings. Click Tap Create.
   4. Complete the configuration for each integration parameter value.

   5. Click Tap Save.

      Repeat this step for each integration parameter that supports the Chile Audit Reports process.

      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 period 1 = Current pay period 2 = Next pay period 3 = Previous schedule period 4 = Current schedule period 5 = Next schedule period 6 = Week to date 7 = Last week 8 = Yesterday 10 = Range of relative dates 11 = Specific date 12 = Relative specific date 13 = Today User 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_v2_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

10. Make sure that the generic data access profiles (GDAP) allow access by the people who need to run the installed integration. See Configure Access to Integrations.

Run integrations to test that the configuration is set up correctly.

Run the integration

1. Select the integration:
   1. Select Main Menu  > Maintenance > Integrations. 
   2. Click Tap Run an Integration . 
   3. Select the ChileAuditReports_v2 integration from the list. Click Tap Select. 
   4. (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.
2. 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.

3. 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.

4. Wait for the confirmation that the integration completed or failed. Close the panel.
5. Click Tap Refresh . 
6. To see details, select the integration run. Select Run Summary.

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:

1. Click Tap the tile for the integration run.
2. 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.
3. 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 topic.