Mexico 3x3 Overtime

An employee is scheduled to work Monday—Friday, 7:00 AM—4:30 PM, with a 30-minute meal break. The employee works overtime during the week.

In the first use case, double overtime reaches 9 hours on Wednesday, satisfying condition 2. All overtime above 9 hours is considered triple time. The Totals tab displays regular, overtime, double time and triple time hours.

Use case 1

	Monday	Tuesday	Wednesday	Thursday	Friday	Saturday	Sunday	Totals
In punch The entries on a timecard that mark the beginning (in-punch) or end (out-punch) of a work interval, such as the beginning of a shift or transfer.	7:00 AM	7:00 AM	7:00 AM	7:00 AM	7:00 AM	7:00 AM
Out punch	7:30 PM	9:30 PM	9:30 PM	8:30 PM	6:30 PM	11:30 AM
Lunch break	00:30	00:30	00:30	00:30	00:30
Regular time	9:00	9:00	9:00	9:00	9:00			45:00
Overtime	3:00	5:00	5:00	4:00	2:00	4:30		23:30
Double time	3:00	3:00	3:00					09:00
Triple time		2:00	2:00	4:00	2:00	4:30		14:30

In the second use case, overtime occurrences fall on the first 3 days of the week, satisfying condition 3. All overtime, regardless of daily or weekly limits, is considered triple time. The Totals tab displays regular, overtime, double time and triple time hours.

Use case 2

	Monday	Tuesday	Wednesday	Thursday	Friday	Saturday	Sunday	Totals
In punch	7:00 AM	7:00 AM	7:00 AM	7:00 AM	7:00 AM	7:00 AM
Out punch	9:30 PM	5:30 PM	8:30 PM	8:30 PM	6:30 PM	11:30 AM
Lunch break	00:30	00:30	00:30	00:30	00:30
Regular time	9:00	9:00	9:00	9:00	9:00			45:00
Overtime	5:00	1:00	4:00	4:00	2:00	4:30		20:30
Double time	3:00	1:00	3:00					07:00
Triple time	2:00		1:00	4:00	2:00	4:30		13:30

Deploy the Mexico 3x3 Overtime integration

For more information, see the Deploy Integrations topic.

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. Make sure that the Account is correct. If not, select the right account.

3. Select the Deploy tab > Integration Packs.

1. From the list in the left column, search for and select the Pro WFM Mexico 3x3 Overtime Extension integration.

Note: If the integration does not display, select Browse Integration Packs to search for and select the iPack.

2. Click Tap Install.

3. 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 Mexico 3x3 Overtime integration settings

Select the environment

1. Select the Manage tab > Atom Management.
2. 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: Pro WFM Mexico 3x3 Overtime Extension > Mexico3x3Overtime Extension_iPack_v2.

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.

1. Select Connection Settings.

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

   Connection Settings

   Setting	Required	Actions
   Mexico3x3Overtime_iPack_v2_APIGatewayServer	Required	To change the default API gateway server: Clear Use Default. Enter the URL to the server. Example: <tenantURL>/api
   Mexico3x3Overtime_iPack_v2_Locale_CRT	Required	Enable Override.

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 Mexico3x3Overtime_iPack_v2_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 property name	Column header value
_Mexico3x3Overtime_iPack_v2_Locale_CRT	Parameter Name,Locale Policy,Value,Description

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

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

Mexico 3x3 Overtime — Locale CRT

Column header	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. Example: Eligibility criteria not met
Description	The description that is shown in Additional Details. Example: The employee is not assigned a shift.

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 Mexico3x3Overtime_iPack_v2.
4. (Optional) Enter a Description.

Note: Do not select API Integration.

5. In File Access, select None to not select a connection.
6. If the person who runs the integration does not have full access to integrations, select Execute Integration with System Account. This allows the integration access to all APIs in the FAP, and the relevant permissions and data, regardless of the FAP and GDAP of the person who runs the integration.

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

8. 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 A sequence of integrations that can be run on-demand or be scheduled., the integration set stops.

      Completed with Errors — The integration run has errors or could not run.

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

10. Integration template and parameters
    1. In Integration Template, select Mexico3x3Overtime_iPack_v2.
    2. Click Tap Assign .
    3. In Integration Parameters, you can override default settings. Click Tap Create .

    4. Complete the configuration for each parameter value.

    5. Click Tap Save.

       Repeat this step for each integration parameter that supports the Mexico 3x3 Overtime process.

       Integration parameters

       Parameter name	Description / User prompt / Mandatory	Template parameter	Parameter type
       Time Period	Time period for the integration run. Default = Previous_Payperiod. User prompt = Yes Mandatory = Yes	TimePeriod	Time period
       Individual Employee IDs	A comma-separated list of specific employees for whom the integration is run. When no value is entered, the integration defaults to the Hyperfind A search engine that filters and selects groups of employees through queries that specify conditions or locations (criteria). 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 = No	IndividualEmployeeIDs	Text
       HyperfindID	The default Hyperfind or Location query that contains the employees for whom the integration is run. Default = 1 (All Home A query that returns a list of employees associated with a manager's employee group. All Home finds people who are active employees or active users as of today.) Note: Ad-hoc Hyperfinds are not supported. All Home does not include terminated and inactive employees even if they have totals during the period. To include these totals, configure a Hyperfind that includes terminated and inactive employees, and select that Hyperfind in this process property. The maximum number of employees in a Hyperfind is 3500. To process more employees, divide the population into smaller Hyperfinds to run sequentially. User prompt = Yes Mandatory = Yes	Hyperfind	Hyperfind
       Edit Sign Off Period	Determines whether to include the signed-off period during processing: True = the integration processes the time period provided by the user, even if it includes a signed-off period. False (default) = the integration processes only the unsigned-off period. User prompt = No Mandatory = Yes	EditSignOffPeriod	Boolean
       Double Overtime Pay Code	The paycode that the integration assigns in the timecard with the double overtime hours. User prompt = No Mandatory = Yes	DoubleOvertimePayCode	Text
       Triple Overtime Pay Code	The paycode that the integration assigns in the timecard with the triple overtime hours. User prompt = No Mandatory = Yes	TripleOvertimePayCode	Text
       Include Occurrences Per Week	Determines which conditions to include when calculating double and triple overtime. True = include Conditions 1, 2, and 3 when calculating double and triple overtime hours. False (default) = include only Conditions 1 and 2 when calculating double and triple overtime hours. User prompt = No Mandatory = Yes	IncludeOccurrencesPerWeek	Boolean
       Generic Overtime Pay Code	The generic overtime paycode. Use a comma-separated list when multiple paycodes exist. User prompt = No Mandatory = Yes	GenericOvertimePayCode	Text
       Week First Day	The start day of the week. Select from Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, or Sunday. User prompt = No Mandatory = Yes	WeekStartDay	Text
       Process Default Period	Determines the time period that the integration processes. True (default) = the integration processes the time period provided by the user even if it contains the signed-off period. False = the integration processes only the unsigned-off period. User prompt = No Mandatory = Yes	DefaultProcessingPeriod	Boolean

11. Make sure that the generic data access profiles (GDAP) allow access by the people who need to run the installed integrations. 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 Mexico3x3Overtime_iPack_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:
   • Time Period: Select a pay period.
   • 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

   • Hyperfind: Select a Hyperfind query of employees.

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 Corrects transaction errors in integrations without the need to resubmit entire projects..

To check the results in more detail:

1. Click Tap the tile A container that provides navigation or action from its summary view. 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 Schedule Integrations topic.

API details

API name	Section	Type	Resource path	Location	Description
Retrieve Paycodes	Timekeeping	POST	v1/timekeeping/setup/pay_codes/multi_read	_ValidatePayCodes	Retrieve paycodes.
Update Integration Execution Details	Platform	POST	v1/platform/integrations/update_status	_WFD Callback	Provide summary of integration run.
Execute Hyperfind Query	Commons	POST	/v1/commons/hyperfind/execute	_ExecuteHyperfind	Retrieve employee by Hyperfind.
Retrieve Signoffs as Manager	Timekeeping	GET	/v1/timekeeping/timecard_signoffs	_RetrieveDefaultTimePeriodSpan	Retrieve timecard signoffs as a Manager.
Retrieve Timecard Data for Multiple Employees	Timekeeping	POST	v1/timekeeping/timecard_metrics Measures and tracks workforce performance by comparing planned with actual workload or coverage, or by showing variances at any organizational level./multi_read?partial_success=true	_RetrieveTimecardData	Retrieve timecard actual totals without corrections.
Bulk Enable Edits	Timekeeping	POST	v1/timekeeping/enable_edits/import	_BulkEnableEdits	Enable timecard editing for signed-off timecard.
Update Timecard as Manager	Timekeeping	POST	v1/timekeeping/timecard	_UpdateTimecardData	Add or update timecard paycode.