Right to Rest

The Right to Rest integration ensures that a premium amount is paid when the employee agrees to work a scheduled shift which violates their right to rest.

Note: This integration is an extension that is developed outside the normal release schedule to meet specific customer needs; it must be installed by an Integration Consultant. To request one of these extensions, you must submit a request by way of the Gateway Request Portal for BITS, accompanied by a change order.

In the city of Chicago, the Fair Workweek Ordinance guarantees rights for employees in specific industries, including healthcare, manufacturing, restaurants, and retail.

One right, known as the Right to Rest, gives employees the option to accept or decline shifts that are scheduled to start within a certain period of time which follows the end of the previous day’s scheduled shift. Typically, the minimum span of rest time between scheduled shifts is 10 hours.

Organizations configure the type of Right to Rest premium – money or hours – by way of the Right to Rest Premium Type integration parameter.

When the type is configured as Hours, the integration calculates only the number of hours that are eligible for Right to Rest premium. The hours are then added to the timecard as a paycode edit. Comments and notes provide analysis of the calculation and identify the corresponding shift.

When the type is configured as Money, the integration calculates a premium amount by multiplying the employee’s regular rate of pay with the Right to Rest multiplier, which is normally1.25.

This integration allows organizations to remain compliant with the Ordinance by paying the right amount of compensation for the infringing shift and capturing the employee’s attestation to the exception.

To achieve full compliance with the Ordinance, organizations can opt to use this integration in conjunction with existing workflows:

  • Schedule Post Acknowledgment

  • Schedule Change Attestation

After one of the workflows captures the employee’s acceptance of the posted or changed schedule, the integration checks for shifts that violate Right to Rest. It then calculates and pays out the appropriate premium amount corresponding to the worked shift.

For organizations that opt for the money-based calculation, the premium amount is calculated as follows:

Regular Hourly Rate of Pay = ((Total Earnings) / (Total Worked Hours))

Right to Rest Premium = (Right to Rest Multiplier) * (Regular Hourly Rate of Pay) * (Number of regular hours worked in the shift)

The Regular Hourly Rate of Pay calculation is based on the integration parameter Regular Rate of Pay Calculation Period, which can be configured as either weekly or biweekly. The scheduled shift evaluation, however, relies on the period selected for the integration run.

Note:

  • Regular hourly rate of pay is calculated on a weekly basis.

  • The number of regular hours worked in the shift is calculated using timecard punches; overtime hours are excluded.

The Right to Rest integration can be initiated on-demand or automatically scheduled.

Considerations and limitations

  • The Right to Rest integration runs for all employees regardless of employment status — Active, Inactive, and Terminated.

  • When the time difference between the last shift of the first day and the first shift of the second day is less than the configured threshold, the shifts violate of the employee's right to rest. Yet, when the time difference is equal to or greater than the threshold, the shifts do not infringe on the employee's right to rest.

  • The comment note that contains the premium amount information is populated using the employee's locale policy.

  • When the Right to Rest integration is used in conjunction with other extensions, only specific process models are supported:

    • Schedule Post Acknowledgment, version 2 or higher.

    • Schedule Change Attestation, version 4.1 or higher.

Use cases

Right to Rest Premium Type = Money

A Chicago hotel adheres to the Fair Workweek Ordinance and configures the Right to Rest integration parameters as:

  • Right To Rest Premium Type= Money

  • Right To Rest Multiplier= 1.25

  • Regular Rate of Pay Calculation Period= Weekly

  • Week Start Day= Monday

Use case 1: Schedule Post Acknowledgment + Right to Rest Premium

A hotel employee usually works the 7:00PM—11:30PM shift on Monday—Saturday of each week.

While creating next week’s schedule, the employee’s manager replaces Wednesday's shift with a 7:00AM—12:00PM shift, and then posts the schedule. A schedule post acknowledgment task immediately generates and displays in the employee's control center.

Upon viewing the task, the employee observes that one day’s shift is flagged with a Right to Rest violation.

Even though the flagged shift begins less than 10 hours after the end of the previous evening’s scheduled shift, the employee enters a comment in the acknowledgment form and accepts the posted scheduled. The comment is recorded for reporting purposes.

Over the course of the week, the employee works 27.5 hours and earns USD $137.50.

At the end of the week in which the employee works the morning shift, the integration calculates the right to rest premium as follows:

Regular Hourly Rate of Pay = ((137.50) / (27.5)) = USD $5.00

Right to Rest Premium = (1.25) * (5) * (5) = USD $31.25

The integration adds a money paycode edit of USD $31.25, comment, and note to the timecard describing the Right to Rest details.

Use case 2: Schedule Change Attestation + Right to Rest Premium

A hotel employee usually works the 3:00PM—11:00PM shift on Monday—Saturday of each week. The hotel’s policy requires that employees attest to any schedule changes made after the schedule is posted.

An operational requirement causes the employee’s manager to change the Wednesday's shift to a 7:00AM—2:00PM shift.

The employee launches the schedule change attestation business process and observes that the schedule change is flagged with a Right to Rest violation.

Even though the flagged shift begins less than 10 hours after the end of the previous evening’s scheduled shift, the employee enters a comment in the acknowledgment form and accepts the changed scheduled. The comment is recorded for reporting purposes.

Over the course of the week, the employee works 47 hours and earns USD $235.

At the end of the week in which the employee works the morning shift, the integration calculates the right to rest premium as follows:

Regular Hourly Rate of Pay = ((235) / (47)) = USD $5.00

Right to Rest Premium = (1.25) * (5) * (7) = USD $43.75

The integration adds a money paycode edit of USD $43.75, comment, and note to the timecard describing the Right to Rest details.

Right to Rest Premium Type = Hours

A second Chicago hotel that adheres to the Fair Workweek Ordinance, configures the Right to Rest integration parameters as:

  • Right To Rest Premium Type= Hours

  • Regular Rate of Pay Calculation Period= Weekly

  • Week Start Day= Monday

Use case 3: Schedule Post Acknowledgment + Right to Rest Premium

A hotel employee usually works the 6:00PM—12:00AM shift on Monday—Friday of each week.

While creating next week’s schedule, the employee’s manager replaces Wednesday's shift with a 9:00AM—3:00PM shift, and then posts the schedule. A schedule post acknowledgment task immediately generates and displays in the employee's control center.

Upon viewing the task, the employee observes that one day’s shift is flagged with a Right to Rest violation.

Even though the flagged shift begins less than 10 hours after the end of the previous evening’s scheduled shift, the employee enters a comment in the acknowledgment form and accepts the posted scheduled. The comment is recorded for reporting purposes.

When Wednesday arrives, the employee works 9:00AM—4:00PM.

At the end of the week in which the employee works the day shift, the integration calculates the right to rest premium as follows:

Total Worked Hours = (9:00AM—4:00PM) = 7:00

Regular Worked Hours = (9:00AM—3:00PM) = 6:00

The integration adds an hours paycode edit of 6:00, comment, and note to the timecard describing the Right to Rest details.

Before you start

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

  1. Configure Access to Integrations.
  2. Configure the following:
    • Comment: Configure a comment, such as Adjusted by RTR Integration, that the integration adds to the timecard along with the employee's premium adjustment information. The pay codes category must be selected during configuration. This comment must be used exclusively by the Right to Rest extension.

      See the Comments topic.

    • Paycode: Configure either a money-type or hours-type paycode, such as RTR Premium, that the integration adds to the timecard to store the employee's premium adjustment amount. The paycode must be used exclusively by the Right to Rest (RTR) extension.

      See the Paycode definition topic.

    • Combined Paycode: Configure three combined paycodes. One combined paycode summarizes all money-based paycodes used for the premium payout. The remaining two combined paycodes summarize regular worked and total worked hours, respectively.

      See the Combined Paycodes topic.

      Examples:

      • RTR Earning Combined Paycode

      • RTR Regular Worked Hours Combined Paycode

      • RTR Worked Hours Combined Paycode

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

Configure the Right to Rest integration

  1. Deploy the Right to Rest integration
    Note: For more information, see the Deploy Integration Packs to your Atom 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.
    4. From the list in the left column, search for and select the Pro WFM Right to Rest Extension integration.
      Note: If the integration does not display, select Browse Integration Packs to search for and select the iPack.

    5. Click Tap Install.

    6. 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
      .
  2. Configure the Right to Rest integration settings
    1. Select the environment
      1. Select the Manage tab > Atom Management.
      2. Select your environment.
    2. 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.
      3. Scroll to and select the integration pack: Right To Rest > RightToRest_iPack_v2.
  3. 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

      Connection Settings for the integration

      Setting

      Required

      Actions

      RightToRest_iPack_v2_APIGatewayServer

      Required

      To change the default API gateway server:

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

        Example: <tenantURL>/api

      RightToRest_iPack_v2_Locale_CRT

      Required

      Enable Override.

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

    Property

    Required

    Actions

    RightToRest_iPack_v2_CRTConfig

    Required

    For RightToRest_iPack_v2_Locale_CRT:

    1. Clear Use Default.
    2. Enter Parameter Name, Locale Policy, Message, Description.
  5. 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 list, select the RightToRest_iPack_v2_Locale_CRT table.

    3. Select Override, which allows you to:

      • Download the tables when you run the integration
      • Edit the table cells in Extensions
    4. When you finish, click tap OK.

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

    Right to Rest - Locale CRT structure

    Right to Rest - Locale CRT structure

    Column name

    Description

    Parameter Name

    Parameters used in configurable messages and file headers.

    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.

    Message

    Message shown in Additional Details, or value of the label defined in the Run Summary section.

    Comment was not provided.

    Description

    The description that is shown in Additional Details.

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

    Sample Locale CRT content

    Sample Locale CRT content

    Parameter name

    Locale Policy

    Message

    Description

    Error_BlankEarningsCombinedPayCode

    *

    Earnings Combined Paycode was not configured.

    Error_BlankRegularWorkedHoursCombinedPayCode

    *

    Regular Worked Hours Combined Pay Code was not configured.

    Error_BlankRightToRestComment

    *

    Comment was not provided.

    Error_BlankRightToRestMultiplier

    *

    Provide correct value for Right To Rest Multiplier.

    Error_BlankRightToRestPayCalculationPeriod

    *

    Right To Rest pay calculation period was not configured.

    Error_BlankRightToRestPayCode

    *

    Right To Rest Paycode was not configured.

    Error_BlankRightToRestPremiumType

    *

    Right To Rest Premium Type was not configured.

    Error_BlankRightToRestThreshold

    *

    Right To Rest Threshold was not configured.

    Error_BlankWeekStartDay

    *

    Week Start Day was not configured.

    Error_BlankWorkedHoursCombinedPayCode

    *

    Worked Hours Combined Paycode was not configured.

    Error_CommentCategoryWrong

    *

    Comment '<Comment>' must be configured with the Pay Codes category.

    Error_EarningCombinedTypePaycode

    *

    Earnings Combined Pay Code '<Earnings Pay Code>' must be a combined paycode.

    Error_EarningsCombinedMoneyBasedPaycode

    *

    Earnings Combined Pay Code '<Earnings Pay Code>' must be money-based.

    Error_InvalidCommentNoteLength

    *

    Comment Note for locale '<Locale Name>' cannot exceed 250 characters.

    Error_NullHyperfind

    *

    Hyperfind or Location not provided.

    Error_PayCalculationPeriodValues

    *

    Only weekly and biweekly values are allowed.

    Error_RegularWorkedHourBasedPaycode

    *

    Regular Worked Hours Combined Pay Code ‘<Regular Worked Hours>’ must be hours-based.

    Error_RegularWorkedHoursCombinedTypePaycode

    *

    Regular Worked Hours Combined Pay Code ‘<Regular Worked Hours>’ must be a combined pay code.

    Error_RightToRestMoneyBasedPaycode

    *

    Right to Rest Pay Code '<Right to Rest Pay Code>' must be configured as a standard money-based paycode.

    Error_RightToRestPremiumType

    *

    Right to Rest Pay Code '<Right to Rest Pay Code>' must be configured as a standard hours-based paycode.

    Error_RightToRestPremiumTypePaycode

    *

    Enter a valid premium type, such as Money or Hours.

    Error_TimeFormatRightToRestThreshold

    *

    Right To Rest Threshold must be configured in HH:mm format.

    Error_TimePeriod

    *

    Time period in days exceeds 365 days.

    Error_WeekStartDayValues

    *

    Only week days are allowed.

    Error_WorkedHourBasedPaycode

    *

    Worked Hours Combined Pay Code '<Worked Hours>' must be an hours-based paycode.

    Error_WorkedHoursCombinedTypePaycode

    *

    Worked Hours Combined Pay Code '<Worked Hours>' must be a combined paycode.

    Error_WrongComment

    *

    Comment '<Comment>' not found.

    Error_WrongEarningsCombinedPayCode

    *

    Earnings Combined Pay Code '<Earnings Pay Code>' not found.

    Error_WrongRegularWorkedHoursCombinedPayCode

    *

    Regular Worked Hours Combined Pay Code ‘<Regular Worked Hours>’ not found.

    Error_WrongRightToRestPayCode

    *

    Right to Rest Pay Code '<Right to Rest Pay Code>' not found.

    Error_WrongWorkedHoursCombinedPayCode

    *

    Worked Hours Combined Pay Code '<Worked Hours>' not found.

    Label_BoomiExecutionId

    *

    Boomi Execution Id

    Label_DisqualifiedEmployees

    *

    Disqualified Employees

    Label_FailedEmployees

    *

    Failed Employees

    Label_IntegrationTypeValue

    *

    Import

    Label_InvalidEmployees

    *

    Invalid Employees

    Label_ProcessedEmployees

    *

    Processed Employees

    Label_SuccessfullyUpdatedEmployees

    *

    Successfully Updated Employees

    Message_AdditionalDetails

    *

    Process completed with transaction errors. Additional details, such as disqualifications, may be accessible using the button below.

    Message_EnableEditsFalse

    *

    Right to Rest payout date falls in signed-off period.

    Right to Rest pay-out date '<Pay-out date>' falls in signed-off period for employee '<Employee ID>'. Last sign-off date '<sign-off date>'.

    Message_ReferencePeriodCommentNote

    *

    Reference Period: <ReferencePeriod>

    Message_RegularRateOfPayCommentNote

    *

    Regular Rate Of Pay: <RegularRateOfPay>

    Message_RegularWorkedHoursCommentNote

    *

    Regular Worked Hours: <RegularWorkedHours>

    Message_ScheduleLabelCommentNote

    *

    Shift: <ScheduleLabelCommentNote>

    Message_TotalEarningsCommentNote

    *

    Total Earnings: <TotalEarnings>

    Message_TotalWorkedHoursCommentNote

    *

    Total Worked Hours: <TotalWorkedHours>

    Message_WhileRetrievingEmployeeDetails

    *

    Error encountered while retrieving employee details.

    Error encountered while retrieving the details for person number '<PersonNumber>'.

    Message_WhileRetrievingPaycode&WorkedShifts

    *

    Error encountered while retrieving the Paycode and WorkedShifts Details.

    Error encountered while retrieving the details for person number '<PersonNumber>'.

    Message_WithErrors

    *

    Integration completed with errors.

    Message_WithoutErrors

    *

    Integration completed without errors.

    Right to Rest payout date '<Pay-out date>' falls in signed-off period for employee '<Employee ID>'. Last sign-off date '<sign-off date>'.

    Message_WrongEmployeeId

    *

    Invalid Employees.

    Employee with ID ‘<PersonNumber>‘ does not exist.

    Custom tags available for use in messages and labels include: < Comment>, < Earnings Pay Code>, < Employee ID>, < Locale Name>, < Pay-out date>, < PersonNumber>, < ReferencePeriod>, < RegularRateOfPay>, < Regular Worked Hours>, < RegularWorkedHours>, < Right to Rest Pay Code>, < ScheduleLabelCommentNote>, < Sign-off date>, < TotalEarnings>, < TotalWorkedHours>, < Worked Hours>.

Install the Right to Rest 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.

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 RightToRest_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. (Optional) 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, 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 RightToRest_iPack_v2.
    2. Click Tap Assign .
    3. In Integration Parameters, you can override default settings. Click Tap Create.
    4. Complete the configuration for each integration control parameter value.

    5. Click Tap Save.

      Repeat this step for each integration control parameter that supports the Right to Rest process.

      Integration Parameters

      Integration Parameters

      Parameter name

      Description

      Template parameter

      Parameter type

      Right To Rest Premium Type

      The paycode type that is added to the employee timecard for the premium:

      • Money(default)

      • Hours

      User prompt = No

      Mandatory = Yes

      RightToRestPremiumType

      Text

      Right to Rest Pay Code

      The paycode name used for the Right to Rest premium payout. The type of the configured paycode must match Right To Rest Premium Type.

      Default = RTR Premium

      User prompt = No

      Mandatory = Yes

      RightToRestPayCode

      Text

      Earnings Combined Pay Code

      The money-type combined paycode used to total all the earnings paycodes.

      Default = RTR Earning Combined Pay Code

      User prompt = No

      Mandatory = Yes

      EarningsCombinedPayCode

      Text

      Worked Hours Combined Pay Code

      The hours-type combined paycode used to track worked hours.

      Default = RTR Work Hours Combined Pay Code

      User prompt = No

      Mandatory = Yes

      WorkedHoursCombinedPayCode

      Text

      Right To Rest Comment

      The comment that the integration attaches to the Right to Rest Pay Code in the employee's timecard.

      Default = Adjusted by RTR Integration

      User prompt = No

      Mandatory = Yes

      RightToRestComment

      Text

      Regular Worked Hours Combined Pay Code

      The hours-type combined paycode used in Right to Rest pay calculation.

      Default = Regular Worked Hours Combined

      User prompt = No

      Mandatory = Yes

      RegularWorkedHoursCombinedPayCode

      Text

      Hyperfind and Location

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

      Default = 1(All Home Locations)

      User prompt = Yes

      Mandatory = Yes

      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.

      HyperfindandLocation

      Hyperfind

      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 Locations & Hyperfinds 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

      Enable Edits

      Determines the integration behavior during signed-off periods.

      Case-sensitive supported values include:

      • true: The integration automatically enables edits as part of the adjustment process.

      • false(default): When the signed-off period is not enabled for edits, the integration does not add the correction.

      User prompt = No

      Mandatory = Yes

      EnableEdits

      Boolean

      Time Period

      The date range or symbolic time period for which the integration is run.

      User prompt = Yes

      Mandatory = Yes

      TimePeriod

      Time Period

      Right To Rest Threshold

      The maximum number of hours that must exist between two shifts to be considered in violation of the employee's Right to Rest.

      Format = HH:mm

      Default = 10:00

      User prompt = No

      Mandatory = Yes

      RightToRestThreshold

      Text

      Right To Rest Multiplier

      The multiplier used to calculate the Right to Rest premium amount.

      Default = 1.25

      User prompt = No

      Mandatory =

      • Yes, if the Right to Rest Premium Type= Money.

      • No, if the Right to Rest Premium Type= Hours.

      RightToRestMultiplier

      Text

      Regular Rate of Pay Calculation Period

      The period for which the regular pay rate is calculated by the integration.

      Supported values include:

      • Weekly(default)

      • Biweekly

      User prompt = No

      Mandatory =

      • Yes, if the Right to Rest Premium Type= Money.

      • No, if the Right to Rest Premium Type= Hours.

      RegularRateOfPayCalculationPeriod

      Text

      Week Start Day

      The start day of the week from which to calculate the Right to Rest premium.

      Default = Monday

      User prompt = No

      Mandatory =

      • Yes, if the Right to Rest Premium Type= Money.

      • No, if the Right to Rest Premium Type= Hours.

      WeekStartDay

      Text

      Totalizer Wait Time

      The wait time in seconds between multiple historical correction premiums calculations for the same employee.

      Default = 10

      User prompt = No

      Mandatory = Yes

      TotalizerWaitTime

      Number

  11. Ensure that the generic data access profiles (GDAP) allow access Right to Rest integration for the people who need to run the installed integrations.

    See Configure Access to Integrations .

Run and test the Right to Rest integration

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

  1. Run the integration
    1. Select the integration:
      1. Select Main Menu Maintenance > Integrations.
      2. Click Tap Run an Integration .
      3. Select the RightToRest_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:
      • 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 semicolon (;) 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.
  2. 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 Schedule Integrations topic.

APIs

API Details

API Details

API title

URI

Method

Description

Update Integration Execution Details

/v1/platform/integrations/update_status

POST

Logs integration execution information.

Retrieve Integration Execution by ID

/v1/platform/integration_executions/{id}

POST

Retrieves the details of on-demand and scheduled integration runs.

Retrieve User Preferences for Current User

/v1/commons/user_preferences/locale_policy

GET

Accesses locale policy user preferences.

Retrieve Persons

/v1/commons/persons/extensions/multi_read

POST

Returns multiple person records based on search criteria.

Retrieve Comments as Manager

/v1/commons/comments

GET

Returns a filtered list of Comments.

Retrieve Timecard Data for Multiple Employees

/v1/timekeeping/timecard_metrics/multi_read

POST

Returns timecard data for a set of employees or locations.

Retrieve Paycodes as Manager

/v1/timekeeping/setup/pay_codes/multi_read

POST

Returns one or more paycodes available to the logged-in manager by object references.

Enable Edits Bulk Update

/v1/timekeeping/enable_edits/import

POST

Returns a list of employees with enabled edits.

Execute Hyperfind Query

/v1/commons/hyperfind/execute

POST

Executes a Hyperfind query by ID or qualifier and returns the result.

Retrieve Timecards as Manager

/v1/timekeeping/timecard/multi_read

POST

Returns a list of timecards based on the employees or Hyperfind details provided.

Retrieve Schedule

/v1/scheduling/schedule/multi_read

POST

Returns a schedule pertaining to a set of employees or locations within a specified date range.

Update Timecard as Manager

/v1/timekeeping/timecard

POST

Updates a timecard for an employee as a manager.

Bulk Delete Paycode Edits

/v1/timekeeping/pay_code_edits/multi_delete

POST

Performs a bulk delete of paycode edits for multiple employees using a list of paycode edit IDs.

Bulk Import Paycode Edits

/v1/timekeeping/pay_code_edits/import

POST

Imports paycode edits in bulk.

Retrieve All Display Profiles

/v1/commons/display_profiles

GET

Returns a list of all display profiles.

Retrieve Locales

/v1/commons/locale_policies/multi_read

POST

Returns locales according to the provided request.

Retrieve Symbolic Periods

/v1/commons/symbolicperiod

POST

Returns all symbolic periods in the system.

Retrieve Locale Date Span

/v1/commons/symbolicperiod/read

POST

Returns a locale date span, or symbolic period, according to the data provided.

Version history

Version history

Version

Description

1

Initial release.

This integration calculates a Right to Rest premium amount if a rest violation occurs between end of the previous day's scheduled shift and the start of the current day's scheduled shift. It then adds a paycode edit to the employee's timecard on the shift violation date.

2

A new integration parameter, Right to Rest Premium Type, allows organizations to configure which type of paycode is added to the employee's timecard with the premium amount — hours or money.

iPack_v2

The Right to Rest integration delivery is now by way of an iPack.