Split Shift Premium and Spread of Hours Pay

Note: This integration is an extension that is developed outside the normal release schedule to meet specific customer needs. To request one of these extensions, you must submit a Salesforce Service Request to UKG. After the extension is delivered to your tenant, you can edit it accordingly.

This integration adjusts an employee timecard by inserting a money-type paycode with either a Split Shift Premium or Spread of Hours Pay.

The premium is calculated using the difference between the employee's actual earnings and the minimum wage baseline.

You can configure the following:

  • Minimum wage rate for the location​
  • Minimum gap between shifts (Split Shift Delta)
  • Spread of hours pay threshold​
  • Whether to consider actual earnings or pay the full premium

A split shift is a shift in a work schedule that is interrupted by non-paid and non-working time periods, as required by the employer. The time period between shift segments must be longer than a normal meal period and fall on the same work day. Employers must pay a wage premium for each split shift for each day. The premium is calculated using the difference between the minimum wage baseline and the actual employee earnings.

If employees request a gap as a break for personal reasons, the shift is not considered a split shift and does not qualify for a premium.

Spread of hours pay is an additional compensation provided to an employee whose workday extends beyond a configured hours threshold, which is calculated from the start of the first shift to the end of the last shift. A common threshold is 10 hours. All working and non-working time during the same work day is included in the calculation. Employers must provide spread of hours pay on each qualifying day. This compensation, which is excluded from overtime calculations, must equal or exceed the minimum wage in the area where the employee works.

If an employee requests a gap as a break for personal reasons, the shift does not qualify for spread of hours pay.

Use Case 1 — Split Shift Premium

An employee works as a server in a hotel and has the following schedule:

Example split shifts
  Monday Tuesday Wednesday Thursday Friday Saturday Sunday
First shift 11:00—14:00 11:00—14:00 11:00—14:00 11:00—14:00 11:00—14:00 11:00—14:00 Off
Second shift 19:00—22:00 14:30—17:30 19:00—22:00 Leave Leave Leave Off

The employee punches as scheduled.

The integration calculates eligibility from the schedule as follows:

  • The employee is eligible for a split-shift premium on Monday and Wednesday because:
    • These shifts are assigned by the manager and not chosen by the employee.
    • The gaps between the shifts (delta) are more than 2 hours.
  • The gap between the shifts on Tuesday is less than 2 hours, so the employee is not eligible for the split-shift premium.
  • The employee is not eligible for the split-shift premium on Thursday, Friday, and Saturday because the employee is on leave for the second half of the day.

For the Monday and Wednesday shifts, the premium is calculated as follows:

  • The employee’s base wage is $10/hour, and the minimum wage is $12/hour.
  • The split-shift premium is equal to an hour of the employee’s minimum wage.
  • The premium, when added to the earnings, cannot exceed the minimum wage.
  • The baseline minimum wage is: (6 worked hours X $12/hour) + (1 hour X $12 split-shift premium) = $72 + $12 = $84.
  • The employee's earnings for the shifts are: 6 worked hours X $10/hour = $60.
  • So, the employee is eligible for the full premium of $12 because the earnings ($60) are less than the baseline minimum wage ($84).
  • The same calculation applies to the Monday and Wednesday shifts.

The timecard shows a money paycode for each premium amount. Comments and notes provide more details.

Use Case 2 — Split Shift Premium

An employee works as a head waiter in a hotel and has the following schedule:

Example split shifts
  Monday Tuesday Wednesday Thursday Friday Saturday Sunday
First shift 10:00—13:00 10:00—13:00 10:00—13:00 10:00—13:00 10:00—13:00 10:00—13:00 Off
Second shift 19:00—22:00 19:00—22:00 19:00—22:00 19:00—22:00 19:00—22:00 19:00—22:00 Off

The employee punches as scheduled.

The integration calculates eligibility from the schedule as follows:

  • The employee is eligible for a split-shift premium on each day from Monday to Saturday because:
    • These shifts are assigned by the manager and not chosen by the employee.
    • The gaps between the shifts (delta) are more than 2 hours.

For each shift from Monday to Saturday, the premium is calculated as follows:

  • The employee’s base wage is $13/hour, and the minimum wage is $12/hour.
  • The split-shift premium is equal to an hour of the employee’s minimum wage.
  • The premium, when added to the earnings, cannot exceed the minimum wage.
  • The baseline minimum wage is: (6 worked hours X $12/hour) + (1 hour X $12 split-shift premium) = $72 + $12 = $84.
  • The employee's earnings for the shifts are: 6 worked hours X $13/hour = $78.
  • So, the employee is eligible for a partial premium of $6 because the earnings ($78) are less than the baseline minimum wage ($84) but cannot exceed that minimum wage. Only the difference is paid: baseline minimum wage ($84) — earnings ($78) = $6 split-shift premium.

The timecard shows a money paycode for each partial premium amount. Comments and notes provide more details.

Use Case 3 — Spread of Hours Pay

An employee works in the hospitality sector and has the following schedule on a particular day:

9:00—12:00 and 17:00—20:00

The employee punches as scheduled.

The integration calculates eligibility from the schedule as follows:

  • These shifts are assigned by the manager and not chosen by the employee.
  • Actual earnings are not considered in the spread of hours pay calculation.
  • The total spread of hours from 9:00—20:00 is 11 hours.

Spread of hours pay calculations are performed as follows:

  • The employee’s base wage is $12/hour, and the minimum wage is $15/hour.
  • The spread of hours pay is equal to an hour of the employee’s minimum wage.
  • The premium, when added to the earnings, cannot exceed the minimum wage.
  • The baseline minimum wage is: (6 worked hours X $15/hour) + (1 hour X $15 spread of hours pay) = $90 + $15 = $105.
  • The employee's earnings for the shifts are: 6 worked hours X $12/hour = $72.
  • So, the employee is eligible for a full premium of $15 because the earnings ($72) are less than the baseline minimum wage ($105) but cannot exceed the minimum wage.

The timecard shows a money paycode for the spread of hours pay amount. A comment and note provide more details.

Use Case 4 — Spread of Hours Pay

An employee works in a healthcare facility and has the following schedule on a particular day:

8:00—12:00 and 16:00—20:00

The employee punches as scheduled.

The integration calculates eligibility from the schedule as follows:

  • These shifts are assigned by the manager and not chosen by the employee.
  • Actual earnings are considered in the spread of hours pay calculation.
  • The total spread of hours from 8:00—20:00 is 12 hours.

Spread of hours pay calculations are done from the punches as follows:

  • The employee’s base wage is $16/hour, and the minimum wage is $15/hour.
  • The spread of hours pay is equal to an hour of the employee’s minimum wage.
  • The premium, when added to the earnings, cannot exceed the minimum wage.
  • The baseline minimum wage is: (8 worked hours X $15/hour) + (1 hour X $15 spread of hours pay) = $120 + $15 = $135.
  • The employee's earnings for the shifts are: 8 worked hours X $16/hour = $128.
  • So, the employee is eligible for a partial premium of $7 because the earnings ($128) are less than the baseline minimum wage ($135) but cannot exceed the minimum wage.

The timecard shows a money paycode for the spread of hours pay amount. A comment and note provide more details.

  • Split-shift premiums can be applied only to shifts in the actual schedule and not to a contract schedule.
  • This integration cannot make changes to signed-off time and cannot create historical corrections.
  • This integration checks for eligibility based on the employee's schedule, including time off. Time-off requests must be configured with shift override so that the shifts are removed from the schedule when the requests are approved.
  • This integration supports calculations through the current date only. It does not provide support for future date calculations.
  • Adhere to the default tenant locale policy during configuration of component names in decision tables and integration parameters. Decision tables and integration parameters must use translated values when the default tenant local profile uses translated values for comments and paycodes.

Before you configure this integration, you must do the following:

  1. Configure Access to Integrations.

  2. Make sure that the wage information and currency settings are configured for the employees.
  3. Configure the following:
  • Paycode: Create a money-type paycode which adds a top-up or premium amount to the employee timecard.

    See the Paycode definition topic.

  • Combined paycode: Create a combined paycode that contains all worked hours (actual hours) which will be used in the premium calculation.

    See the Combined Paycodes topic.

  • Comment: Configure a comment with the pay codes category that identifies the paycode adjustment in the timecard.

    See the Comments topic.

  • Schedule tag (optional): Configure a schedule tag that applies to the whole shift, and when added to the schedule, disqualifies an employee from split-shift premium and spread of hours pay calculations.

    See the Tag Definitions topic.

  1. Get the URL, User, and Password for the APIGatewayServer.

Version Description
1

Initial release.
2 Support for spread of hours pay feature.
Process name change from SplitShiftPremium to SplitShiftPremium_SpreadofHoursPay.
iPack_v3 The Split Shift Premium and Spread of Hours Pay integration delivery is now by way of an iPack.

Deploy the Split Shift Premium and Spread of Hours Pay 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 Split Shift Premium and Spread of Hours Pay Extension integration.

  1. From Unattached Environments, select the environment in which to deploy the integration process for the selected integration. Click Tap the double-left arrows button Select items.

Configure the Split Shift Premium and Spread of Hours Pay 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 Search button. It can take several seconds before the button becomes active.
  1. Scroll to and select the integration pack: Split Shift Premium and Spread of Hours Pay > SplitShiftPremiumandSpreadofHoursPay_iPack_v3.

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
    SplitShiftPremiumandSpreadofHoursPay_iPack_v3_APIGatewayServer Required

    To change the default API gateway server:

    1. Clear Use Default.
    2. Enter the URL to the server.

      Example: <tenantURL>/api
    SplitShiftPremiumandSpreadofHoursPay_iPack_v3_MinWage_CRT Required Enable Override.
    SplitShiftPremiumandSpreadofHoursPay_iPack_v3_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 SplitShiftPremiumandSpreadofHoursPay_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 property name Column header value
_SplitShiftPremiumandSpreadofHoursPay_iPack_v3_MinWage_CRT Location,Version Number,Minimum Wage,Effective Start,Effective End,Split Shift Premium(hh:mm),Shift Delta(hh:mm)
_SplitShiftPremiumandSpreadofHoursPay_iPack_v3_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.

  • 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.
  1. Select Cross Reference.
  2. From the Cross Reference dropdown list, select a SplitShiftPremiumandSpreadofHoursPay_iPack_v3 table.
  3. Select Override, which allows you to:
  • Download the tables when you run the integration.
  • Edit the table cells in Extensions.
  1. When you finish, click tap OK.

Repeat the steps for each of the SplitShiftPremiumandSpreadofHoursPay tables.

SplitShiftPremiumandSpreadofHoursPay_iPack_v3_MinWage_CRT: Maps the minimum wage, shift premium, effective date, and shift delta settings to a location.

Split Shift Premium and Spread of Hours Pay — MinWage_CRT
Column header Description
Location

The primary location that is assigned to the employees.

Note: You can use an asterisk (*) as a wildcard, but put the less-restrictive locations at the bottom of the table because the integration scans cross-reference tables from the top.
Version Number

A sequential numeric value, within a range of 1—20, that is used in combination with the Effective Start Date and Effective End Date.
Minimum Wage The minimum hourly wage rate for the Location.
The value must be formatted using the separator defined in the Minimum Wage Fraction Separator integration parameter.
Effective Start Date The effective start date for the Location and Minimum Wage.
The value must be formatted using the date format defined in the Date Format integration parameter.
Effective End Date The effective end date for the Location and Minimum Wage.
The value must be formatted using the date format defined in the Date Format integration parameter.
Split Shift Premium (hh:mm) The number of hours paid at the Minimum Wage rate for split shifts at the location.
The value must be formatted as hh:mm.
Split Shift Delta (hh:mm)

The minimum amount of time that must exist between the scheduled end of the first shift and scheduled beginning of the second shift in order to initiate split shift premium.
The value must be formatted as hh:mm.

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

SplitShiftPremium_SpreadofHoursPay — 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.
Note:

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

Parameter key names
Parameter key name Use
Message_NoShift The employee is not scheduled to work a shift during the date range. Additional Details shows Eligibility criteria not met.
Message_NotEligibleSplitShift

The employee does not have valid data in the schedule (Single shift, ESS, more than 3 shifts) for the selected date range. Additional Details shows Eligibility criteria not met.
Message_DeltaLimit

The gap between the segments of the shift is shorter than the Split Shift Delta value in _MinWage_CRT. Additional Details shows Eligibility criteria not met.
Error_NoLocation The location of the employee does not match the Location setting, or the date range does not match the start and end dates range in _MinWage_CRT. Additional Details shows the text of the message.
Error_Invalid The Hyperfind or Employee ID cannot be found or is not valid. Additional Details shows the text of the message.
Message_EmployeeNotFound The employee is not defined or cannot be found. Additional Details shows the text of the message.
Error_IncorrectMinWage The format of the minimum wage does not match the Minimum Wage Fraction Separator process property. Additional Details shows the text of the message.
Error_IncorrectDateFormat The format of the start or end dates does not match the Date Format process property. Additional Details shows the text of the message.
Message_NoChange No changes occurred since the last run of the integration. Additional Details shows the text of the message.
Message_NoPremium The employee is not eligible for the wage premium because the actual total or eligibility are not met. Additional Details shows the text of the message.
Label_WithoutErrors The integration completed without errors. Additional Details shows the text of the message.
Label_WithoutTransactionErrors The integration ran without errors. Additional Details shows the text of the message.
Label_TransactionEnabled The integration ran but with transactional errors. Additional Details shows the text of the message. You can resubmit the records from Transaction Assistant.
Label_AdditionalDetails The integration ran but with transactional errors. The Message section of the Integration Run Details shows the text of the message.
Label_IntegrationType The type of integration: Import or Export. Run Summary shows the text of the message.
Label_IntegrationType The type of integration: Import or Export. Integration Run Details shows the text of the message.
Label_ProcessedRecords The records that were processed by the integration. Run Summary shows the list of records.
Label_ImportedSuccessful The integration ran without errors. Run Summary shows the text of the message.
Label_FailedTransactions The integration run failed. Run Summary shows the text of the message.
Label_DisqualifiedTransactions The integration run was disqualified. Run Summary shows the text of the message.
Message_InvalidEmployee The employee is not valid. Integration Run Details shows the text of the message.
Message_DisqualifyTag The employee has a schedule tag and is disqualified from receiving split-shift premiums. Additional Details shows the eligibility criteria that were not met.
Message_FullPremiumNote The Note when the employee is granted the full premium. Default = Entitled to full split shift premium.
Message_PartialPremiumNote The Note when the employee is granted the partial premium. Default = Entitled to partial split shift premium. Reference = <REFERENCE>, Earnings = <EARNINGS>.
Message_NoPremiumNote The Note when the employee is not granted any premium. Default = Not entitled to split shift premium. Reference = <REFERENCE>, Earnings = <EARNINGS>.
Message_SignedOff The integration runs for a signed-off period. Additional Details shows The time period from <STARTDATE> to <ENDDATE> is signed-off.
Error_NoPersonNumber The Hyperfind is blank or contains invalid employees. The Message section of the Integration Run Detail shows Runtime validation.
Error_NoPaycodeName The paycode is not defined in the installed integration. The Message section of the Integration Run Detail shows Runtime validation.
Error_NoPaycodeComment The paycode comment is not defined in the installed integration. The Message section of the Integration Run Detail shows Runtime validation.
Error_NoCombinedPaycode The combined paycode is not defined in the installed integration. The Message section of the Integration Run Detail shows Runtime validation.
Error_InvalidTimeFrame An invalid time frame ID is defined in the installed integration. The Message section of the Integration Run Detail shows Runtime validation.
Error_InvalidComment An invalid comment is defined in the installed integration. The Message section of the Integration Run Detail shows Runtime validation.
Error_PayCodeNotAvailable The paycode is not defined in UKG Pro Workforce Management™. The Message section of the Integration Run Detail shows the text of the message.
Error_CommentNotAvailable The comment is not defined in UKG Pro Workforce Management™. The Message section of the Integration Run Detail shows the text of the message.
Error_NoThresholdValue The threshold is blank or is formatted incorrectly. The Message section of the Integration Run Detail shows the text of the message.
Message_NotEligibleSpreadHours The employee does not have valid data in the schedule (ESS, more than 3 shifts, spread below the defined threshold) for the selected date range. Additional details shows Eligibility criteria not met.
Message_CalculationNote The Note when the employee is granted the spread of hours pay. Default = Reference = <REFERENCE>, Earnings = <EARNINGS>.

Caution: Do not change the <REFERENCE>, <EARNINGS>, <STARTDATE>, and <ENDDATE> in _MessagePartialPremiumNote, _MessageNoPremiumNote, _MessageNotEligibleSpreadHours, and _MessageSignedOff because these references are not configurable. You can customize the rest of the note.

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.

Note:
  • 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.
  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 SplitShiftPremiumandSpreadofHoursPay_iPack_v3.
  4. (Optional) Enter a Description.

Note: Do not select API Integration.

  1. In File Access, select None to not select a connection.
  2. 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.

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

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

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

  1. Integration template and parameters
    1. In Integration Template, select SplitShiftPremiumandSpreadofHoursPay_iPack_v3.
    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 control parameter that supports the Split Shift Premium and Spread of Hours Pay process.

      Integration parameters
      Parameter name Description / User prompt / Mandatory Template parameter Parameter type
      Hyperfind

      The default Hyperfind or Location query that contains the employees for whom the integration is run.

      Default = 1 (All Home)

      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 = No

      		 HyperfindOrLocations Hyperfind
      EmployeeIDs

      A comma-separated list of specific employees for whom the integration is run.

      When no value is entered, the integration defaults to the HyperfindOrLocations 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

      		 EmployeeIDs Text
      TimePeriod

      The date range or symbolic time period for which the integration 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

      Note: If Time Period is not specified, the integration runs from the last signed-off day to the run date of the integration.

      User prompt = Yes

      Mandatory = No

      		 TimePeriod Time period
      ConsiderEarnings

      Determines whether to consider the employee's actual earnings during the calculation.

      true = (Default) The integration considers the actual earnings, and the employee is eligible for the full or partial premium amount.

      false = The premium is defined in the cross-reference table, and the integration awards the full premium amount without considering the earnings.

      User prompt = No

      Mandatory = No

      		 ConsiderEarnings Boolean
      ConsiderUnpostedShifts

      Determines whether to consider posted and unposted schedules during the calculation.

      true = The integration considers shifts in unposted and posted schedules when it calculates the premium.

      false = (Default) The integration considers only shifts in posted schedules.

      User prompt = No

      Mandatory = No

      		 ConsiderUnpostedShifts Boolean
      IndicatePaycode

      The money paycode that the integration puts in the timecard with the premium amount.

      User prompt = No

      Mandatory = No

      		 IndicatePaycode Text
      IndicatePaycodeComment

      The comment that is assigned to the adjustment paycode.

      User prompt = No

      Mandatory = No

      		 IndicatePaycodeComment Text
      CombinedPaycode

      The combined paycode that holds all worked hours for the wage calculation.

      User prompt = No

      Mandatory = No

      		 CombinedPaycode Text
      InsertZeroPremiumPaycode

      Determines whether the integration puts a paycode edit with a zero amount in the timecard when the employee is eligible for a premium, but the amount is 0 (zero).

      true = (Default) Put a paycode edit with a zero amount in the timecard.

      false = Do not put a paycode edit with a zero amount in the timecard.

      User prompt = No

      Mandatory = No

      		 InsertZeroPremiumPaycode Boolean
      DateFormat

      The format of dates entered in the _MinWage_CRTcross-reference table.

      Supported values include:

      MM-dd-yyyy

      MM/dd/yyyy (Default)

      dd-MM-yyyy

      dd/MM/yyyy

      yyyy-MM-dd

      YYYY/MM/DD

      User prompt = No

      Mandatory = No

      		 DateFormat Text
      MinimumWageFractionSeparator

      The separator for fractional values of the minimum wage defined in the _MinWage_CRT cross-reference table.

      . = (Default) Use a period as the separator.

      , = Use a comma as the separator.

      User prompt = No

      Mandatory = No

      		 MinimumWageFractionSeparator Text
      DisqualifyDayTag

      The schedule tag that is assigned in the schedule to an employee who is disqualified from receiving the premium amount.

      User prompt = No

      Mandatory = No

      		 DisqualifyDayTag Text
      ShowDisqualifyForRerun

      Determines whether a disqualification message caused by a rerun shows in the Additional Details section of the Run Summary.

      true = (Default) Show a disqualification message in the Additional Details.

      false = Do not show a disqualification message in the Additional Details.

      User prompt = No

      Mandatory = No

      		 ShowDisqualifyForRerun Boolean
      ApplySpreadOfHoursPay

      Determines whether the integration processes Spread of Hours Pay or Split Shift Premium.

      true = The integration processes Spread of Hours Pay.

      false = (Default) The integration processes Split Shift Premium.

      User prompt = No

      Mandatory = No

      		 ApplySpreadOfHoursPay Boolean
      SpreadOfHoursThreshold

      Defines the threshold value for Spread of Hours Pay.

      Default = 10:00

      User prompt = No

      Mandatory = No

      		 SpreadOfHoursThreshold Text
      CheckSplitShiftForSpreadPay

      Determines whether the integration calculates a split shift premium when multiple shifts are scheduled and spread of hours falls below SpreadOfHoursThreshold.

      true = The integration considers multiple shifts that occur in a day.

      false = (Default) The integration does not consider multiple shifts that occur in a day.

      User prompt = No

      Mandatory = No

      		 CheckSplitShiftForSpreadPay Boolean
  2. 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 SplitShiftPremiumandSpreadofHoursPay_iPack_v3 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 default name ends with a date and time stamp.
  2. Set parameters as follows:
    • Hyperfind: Select a Hyperfind query of employees.
    • Person Numbers: 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 time period.

  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, do the following:

  1. To see detailed results, 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 make sure 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.

API details
API name Type Resource path Description
Execute Hyperfind POST /v1/commons/hyperfind/execute Get person records for the specified Hyperfind.
Retrieve Persons POST /v1/commons/persons/extensions/multi_read Get person data including hire date, seniority date, accrual profile.
Retrieve Timecard Actuals POST /v1/timekeeping/timecard_metrics/multi_read?partial_success=true Get person worked hours and days.

Retrieve Paycode Edit

POST /v1/timekeeping/timecard/multi_read?partial_success=true Get the paycode edit and date range by symbolic ID.
Timecard Paycode Edit POST /v1/timekeeping/timecard Add an indicative paycode to the employee’s Timecard.
Delete Paycode Edits POST /v1/timekeeping/pay_code_edits/multi_delete Remove the indicative paycode entry from the employee’s Timecard.
Retrieve Shifts POST /v1/scheduling/schedule/shifts/multi_read Get shift details and employee self-service (ESS) values.
Retrieve Locales POST /v1/commons/locale_policies/multi_read Get locale details.
Retrieve Tenant Default Locale GET /v1/commons/user_preferences/locale_policy?tenantDefault=true Get default locale details for the tenant.
Retrieve Current User Locale GET /v1/commons/user_preferences/locale_policy?userCurrent=true Get the locale for the current system user.
Retrieve Comments GET /v1/commons/comments Get the comments.
Retrieve Pay Code GET /v2/timekeeping/setup/pay_codes Get the paycodes.
Retrieve Tags GET /v1/scheduling/setup/tag_definitions Get the tags.