Open Shift Pay Incentive

Note: This extension, a combined integration and workflow model, 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.

The Open Shift Pay Incentive integration extension automatically offers incentives to employees for working open shifts. Incentive premiums, which range from monetary amounts to overtime pay, are based on how early a shift is accepted. Early acceptance results in higher incentive values, which automatically decrease as the date of the open shift approaches. By encouraging employees to accept open shifts as soon as possible, the schedule is fully staffed more rapidly.

The integration extension allows organizations to divide future schedule periods into different tiers. Each tier is configured with one of three incentive types:

  • Fixed money

  • Variable money

  • Overtime

The extension allows:

  • Configuration of different incentives for each tier.

  • Manager discretion to adjust the incentive for certain shifts.

  • Control over incentives using an open-shifts-to-required-shifts ratio.

Incentive periods - Tiers

This integration allows users to divide future incentive periods into as many as 6 tiers. Tiers can be one week, two weeks, or any range of dates. The start of the incentive period begins on the current date, and automatically rolls forward each day.

Note:

  • The current date is always part of tier 1. Future periods, falling outside the tier range, are not part of the incentive process.

  • Although not required, the best practice is to configure adjacent tiers. Open shifts found in gaps between tiers cannot receive incentives.

Incentive types

After completing tier configuration, incentive types are assigned by Location and Job, and by Tier. This flexibility with incentive payment allows you to associate harder-to-fill jobs with higher incentives and to configure different incentive types for each tier. By configuring each consecutive tier with a different amount, the incentive can be adjusted as the date of the open shift approaches. For example, a money incentive could be offered in the first week with the incentive changing to an overtime offer as the shift date approaches.

Incentive types include:

  • Fixed money: Employee receives a fixed amount for the entire open shift.

  • Variable money: Employee receives an amount that varies with the length of the open shift. For example, an hourly amount. Organizations have the option to exclude scheduled breaks when calculating the shift length.

  • Overtime, which is handled with a work rule transfer: Employee receives a work rule transfer that determines the award value, such as higher overtime rates or paid breaks, for the open shift.

Open-shifts-to-required-shifts ratio

Users can configure a ratio of open to required shifts. By setting a minimum threshold, customers can prevent incentive awards from being offered when not required. For example, an incentive threshold ratio of 50% is established. The schedule contains 10 required shifts, one of which is open. The open shift ratio, calculated as 10%, is lower than the threshold; no incentive is offered for the open shift. If, however, five of the required shifts are open, the 50% threshold is met, and the incentive is offered for all five open shifts.

Manager Discretion

Managers can override the incentive offered for an open shift by increasing or decreasing the amount. They can also cancel the incentive for any open shift.

  • Override the incentive amount

The incentive amount is controlled with a Comment Note attached to the open shift; it can be adjusted manually at any time. The Shift Label must also be changed, since it serves as the visual clue in Self Service. This is a calculated amount and must be updated with the correct value.

  • Cancel the incentive

To prevent a new incentive from being added to the next run, attach a special purpose comment, such as “No Incentive,” to the open shift. When the process finds this comment, the open shift is skipped and no longer receives an incentive.

Pickup up Open Shifts

In Employee Self-Service, differences between regular and open shifts are indicated using the shift label, comment, and comment note. When an employee logs on to Self-Service and requests an open shift, a visual clue indicates which open shifts contain incentives. For example, open shifts exist on two days in a schedule period, but only one shift merits a fixed amount incentive. When the Request Open Shift tile launches, the incentive shift label appears to the left of the shift. Upon expanding the open shift details, the comment and comment note provide further details about the calculated incentive.

After the open shift is assigned to the employee, both the shift and incentive money pay code are visible in the Schedule Planner. If the incentive had been an overtime incentive rather than a monetary incentive, a work rule transfer would display in the Schedule Planner.

Note:

  • The business process does not delete shift labels. Instead, it concatenates the shift and incentive labels and displays both in front of the shift.

  • customers who use the schedule generator will see only the incentive label in front of the shift.

Canceling incentive shifts

Incentives are removed when open shifts that earned the incentive are unassigned from the original employee. This process occurs automatically under these conditions:

  • Request to Cover —

    • Shift is offered to the open market.

    • Shift is offered to another employee.

  • Shift Swap Request — Shift is swapped with another employee.

  • Time-Off Request — Shift is removed and returned as an open shift.

Note:

  • If a shift that earned an incentive is manually removed from an employee by a manager in the Schedule Planner, the incentive must also be removed manually.

  • Market shifts remain assigned to an employee until they are picked up by someone else. Incentives remain with the original employee, who will end up working the shift.

Users of this business process can take advantage of the enhanced cancellation request states.

Organizations that have enabled the UseNewRequestCancelSubmittedStatuses feature switch will see new states:

  • Cancel Approved — the employee's request to cancel a previously approved request is approved.

  • Cancel Refused — the employee's request to cancel a previously approved request is refused.

Existing Canceled and Approved states remain, and retain their original use.

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. Enter a unique Integration Name.
  4. (Optional) Enter a Description.
  5. Do not select API Integration.
  6. In File Access, select None to not select a connection.
  7. (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.

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

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

  10. In Skip Configuration, select None (default) to allow multiple integrations to run at the same time or with the same data without restrictions.
  11. Do not select Allow Minute Interval.
  12. Integration template and parameters
    1. In Integration Template, select OpenShiftPayIncentive_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 for each Integration Parameter that supports the open shift pay incentive process.

       

      (Optional) Specify the unique identifier that marks the Open Shift as an incentive Open Shift for fixed incentive type:

      Open Shift Comment — Fixed
      Parameter NameEnter Open Shift Comment — Fixed.
      Description(Optional)
      Template Parameter

      Select Open Shift Comment — Fixed.

      Parameter Type

      Select Text.

      Default Value(Optional) Enter a Comment.
      User Prompted

      If the value does not need to be changed when the integration runs, select No.

       

      (Optional) Specify the unique identifier that marks the Open Shift as an incentive Open Shift for hourly incentive type:

      Open Shift Comment — Per Hour
      Parameter NameEnter Open Shift Comment — Per Hour.
      Description(Optional)
      Template Parameter

      Select Open Shift Comment — Per Hour.

      Parameter Type

      Select Text.

      Default Value(Optional) Enter a Comment.
      User Prompted

      If the value does not need to be changed when the integration runs, select No.

       

      (Optional) Specify the unique identifier that marks the Open Shift as an incentive Open Shift for work rule incentive type:

      Open Shift Comment — Work Rule
      Parameter NameEnter Open Shift Comment — Work Rule
      Description(Optional)
      Template Parameter

      Select Open Shift Comment — Work Rule.

      Parameter Type

      Select Text.

      Default Value(Optional) Enter a Comment.
      User Prompted

      If the value does not need to be changed when the integration runs, select No.

       

      (Optional) Specify the Incentive Type Fixed Definition CRT value:

      Incentive Type Fixed Definition
      Parameter NameEnter Incentive Type Fixed Definition
      Description(Optional)
      Template Parameter

      Select Incentive Type Fixed Definition.

      Parameter Type

      Select Text.

      Default Value(Optional) Enter the Incentive Type Fixed Definition.
      User Prompted

      If the value does not need to be changed when the integration runs, select No.

       

      (Optional) Specify the Incentive Type Hourly Definition CRT value:

      Incentive Type Per Hour Definition
      Parameter Name Enter Incentive Type Per Hour Definition
      Description(Optional)
      Template Parameter

      Select Incentive Type Per Hour Definition.

      Parameter Type

      Select Text.

      Default Value(Optional) Enter the Incentive Type Per Hour Definition.
      User Prompted

      If the value does not need to be changed when the integration runs, select No.

       

      (Optional) Specify the Incentive Type Work Rule Definition CRT value:

      Incentive Type Work Rule Definition
      Parameter NameEnter Incentive Type Work Rule Definition
      Description(Optional)
      Template Parameter

      Select Incentive Type Work Rule Definition.

      Parameter Type

      Select Text.

      Default Value(Optional) Enter the Incentive Type Work Rule Definition.
      User Prompted

      If the value does not need to be changed when the integration runs, select No.

       

      (Optional) Specify the override comment to disqualify the Open Shift from receiving incentive:

      Manager Discretion Comment
      Parameter NameEnter Manager Discretion Comment.
      Description(Optional)
      Template Parameter

      Select Manager Discretion Comment.

      Parameter Type

      Select Text.

      Default Value(Optional) Enter a Comment.
      User Prompted

      If the value does not need to be changed when the integration runs, select No.

       

      Specify the default Location for which the integration will execute:

      Location
      Parameter NameEnter Location.
      Description(Optional)
      Template ParameterSelect Location.
      Parameter TypeSelect Hyperfind.
      Default Value(Optional) Enter 1 = All Home Locations.
      User Prompted

      To prompt the person who manually runs the integration to set this parameter, select Yes.

       

      Specify the Hyperfind type as location:

      Location Type
      Parameter Name Enter Location Type.
      Description(Optional)
      Template ParameterSelect Location Type.
      Parameter TypeSelect Text.
      Default ValueEnter 1 = All Home Locations.
      User Prompted

      If the value does not need to be changed when the integration runs, select No.

       

      Specify the date format of dates specified in the CRT:

      Effective Date Format
      Parameter NameEnter Effective Date Format.
      Description(Optional)
      Template Parameter

      Select Effective Date Format.

      Parameter Type

      Select Text .

      Default Value

      Default = dd/MM/YYYY

      To use an alternative date format:

      1. Clear Use Default.
      2. Enter a format, such as:

      dd-MM-yyyy

      yyyy-MM-dd

      yyyy/MM/dd

      MM-dd-yyyy

      MM/dd/yyyy

      User Prompted

      If the value does not need to be changed when the integration runs, select No.

       

      Specify number of days for which open-shift should be marked as incentive open shift, starting from integration run date:

      Duration (in Days)
      Parameter NameEnter Duration (in Days).
      Description(Optional)
      Template Parameter

      Select Duration (in Days).

      Parameter Type

      Select Number.

      Default Value

      Default = 45

      To use an alternative value:

      1. Clear Use Default.
      2. Enter a different numeric value.
      User Prompted

      If the value does not need to be changed when the integration runs, select No.

       

      Specify the decimal value delimiter:

      Fraction Separator
      Parameter NameEnter Fraction Separator.
      Description(Optional)
      Template Parameter

      Select Fraction Separator.

      Parameter Type

      Select Text.

      Default Value

      Default = Period (.)

      To use an alternative separator:

      1. Clear Use Default.
      2. Enter Comma (,).
      User Prompted

      If the value does not need to be changed when the integration runs, select No.

       

      Specify the threshold limit for schedule API:

      _ThresholdLimit
      Parameter NameEnter _ThresholdLimit.
      Description(Optional)
      Template Parameter

      Select _ThresholdLimit.

      Parameter Type

      Select Text.

      Default Value(Optional) Enter the Threshold Limit.
      User Prompted

      If the value does not need to be changed when the integration runs, select No.

       

      Specify the comment category:

      _CommentCategory
      Parameter NameEnter _CommentCategory.
      Description(Optional)
      Template Parameter

      Select _CommentCategory.

      Parameter Type

      Select Text.

      Default Value(Optional) Select a Comment Category.
      User Prompted

      If the value does not need to be changed when the integration runs, select No.

       

      Specify how the threshold is calculated:

      Total Threshold Ratio
      Parameter NameEnter Total Threshold Ratio.
      Description(Optional)
      Template Parameter

      Select Total Threshold Ratio.

      Parameter Type

      Select Boolean.

      Default Value

      Default = True

      To use an alternative value:

      1. Clear Use Default.
      2. Enter False.
      User Prompted

      If the value does not need to be changed when the integration runs, select No.

       

      Specify text displayed in the label of an open shift:

      Incentive Shift Label
      Parameter NameEnter Incentive Shift Label.
      Description(Optional)
      Template Parameter

      Select Incentive Shift Label.

      Parameter Type

      Select Text.

      Default Value(Optional) Enter an Incentive Shift Label.
      User Prompted

      If the value does not need to be changed when the integration runs, select No.

       

      (Optional) Specify the work rule value displayed in label:

      Workrule Incentive
      Parameter NameEnter Workrule Incentive.
      Description(Optional)
      Template Parameter

      Select Workrule Incentive.

      Parameter Type

      Select Text.

      Default Value(Optional) Enter a Work Rule Incentive Shift Label.
      User Prompted

      If the value does not need to be changed when the integration runs, select No.

    Specify whether the incentive is calculated using gross or net hours.

    Calculate Net Hours
    Parameter Name Enter Calculate Net Hours.
    Description (Optional)
    Template Parameter

    Select Calculate Net Hours.
    Parameter Type

    Select Boolean.
    Default Value

    Default = True

    To use an alternative value:

    1. Clear Use Default.
    2. Enter False.
    User Prompted

    If the value does not need to be changed when the integration runs, select No.

     

  13. Click Tap Save.
  14. Make sure that the generic data access profiles (GDAP) allow access by the people who need to run the installed integrations. Select Administration > Application Setup > Integrations Setup > Access Profiles; see Configure Access to Integrations.
  1. Configure Access to Integrations.
  2. Configure Comments identifying the incentive type provided to open shifts; see the Comments topic.

Examples:

Open Shift Incentive - Fixed

Open Shift Incentive - Per Hour

Open Shift Incentive - Work Rule

  1. Configure a Comment allowing manager discretion to override an incentive on an open shift; see the Comments topic.

Example: No Incentive

  1. Configure a paycode identifying the monetary open shift incentive; see the Paycode definition topic.

Example: Open Shift Incentive

  1. Deploy the OpenShiftPayIncentive_v2 integration.
  2. 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 Search button. It can take several seconds before the button becomes active.
  3. Select the integration template: OpenShiftPayIncentive > OpenShiftPayIncentive_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 list, select and configure the following:

    Connection Settings
    Setting Required Actions
    APIGatewayServer Required

    To change the default API gateway server:

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

      Example: <tenantURL>/api

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 OpenShiftPayIncentive_v2_ProcessProperties to set process properties that must be configured before the integration can run.

Open Shift Pay Incentive - Control Properties
Parameter name Description Template parameter Parameter type Default value User Prompt Install parameter required
Open Shift Comment — Fixed Unique identifier that marks the Open Shift as an incentive Open Shift for fixed incentive type. Open Shift Comment — Fixed Text   False Optional
Open Shift Comment — Per Hour Unique identifier that marks the Open Shift as an incentive Open Shift for each Hour incentive type. Open Shift Comment — Per Hour Text   False Optional
Open Shift Comment — Work Rule Unique identifier that marks the Open Shift as an incentive Open Shift for work rule incentive type. Open Shift Comment — Work Rule Text   False Optional
Incentive Type Fixed Definition Defines the CRT value, such as Fixed. Incentive Type Fixed Definition Text   False Optional
Incentive Type Per Hour Definition Defines the CRT value, such as Hourly. Incentive Type Per Hour Definition Text   False Optional
Incentive Type Work Rule Definition Defines the CRT value, such as Work Rule. Incentive Type Work Rule Definition Text   False Optional
Manager Discretion Comment Override comment to disqualify the Open Shift from receiving incentive. Manager Discretion Comment Text   False Optional
Location Used for executing the integration for specified location. Location Hyperfind   True Mandatory
Location Type Identifies the Hyperfind type as location. Location Type Text   False Mandatory
Effective Date Format

Defines date format specified in CRT.

Supported formats include:

  • dd-MM-yyyy

  • dd/MM/yyyy (default)

  • yyyy-MM-dd

  • yyyy/MM/dd

  • MM-dd-yyyy

  • mm/dd/yyyy

 Effective Date Format Text dd/MM/YYYY False Mandatory
Duration (in Days) Specifies number of days for which open-shift should be marked as incentive open shift, starting from integration run date. Duration (in Days) Number 45 False Mandatory
Fraction Separator

Identifies decimal value delimiter.

Supported formats include:

  • Period (.) — (default)

  • Comma (,)

 Fraction Separator Text Period (.) False Mandatory
_ThresholdLimit Threshold Limit for Schedule API. _ThresholdLimit Text   False Mandatory (Cannot be empty)
_CommentCategory Identifies comment category. _CommentCategory Text   False Mandatory
Total Threshold Ratio Defines how threshold should be calculated. Total Threshold Ratio Boolean True False Mandatory
Incentive Shift Label Defines text displayed in label of an Open shift for user visibility. Incentive Shift Label Text   False Mandatory
Workrule Incentive Defines work rule value displayed in label. Workrule Incentive Text   False Optional
Calculate Net Hours

Identifies how the incentive is calculated.

  • True — The calculation excludes scheduled breaks, and then uses the net shift length.

  • False — The calculation is based on gross shift length.

 Calculate Net Hours Boolean True False Mandatory

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.

A cross-reference table (CRT) translates parameter values in an integration as follows:

  • Organizes data values into rows and columns:
    • Maximums = 20 columns, 10,000 rows.
  • Can combine values from multiple columns to determine a single output value.
  • 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 following tables:

    OpenShiftPayIncentive_v2_Incentive_CRT: Maps locations with the appropriate tiers and incentive values.

    Column headers and definitions:

    Location, Version, Effective From, Effective To, Ratio, Tier, Tier Value/Type

    • Location = Allows granular control over which job receives which incentive. Wildcards are supported.

    • Version =Allows the configuration of different effective-dated versions, so the incentive can be adjusted.

    • Effective From and Effective To= Date range during which the version applies.

    • (Optional) Ratio = Threshold for Open Shift versus Assigned Shifts Ratio. Set to 0 when not used. Incentive will always be awarded.

    • Tier = Number of days for each tier. For example, one week = 01-07 where 01 represents current day. Up to 6 tiers can be configured. Always ensure that tiers are adjacent.

    • Tier Value/Type = Incentive value to be provided for the tier.

      • Value = Money amount or work rule suffix.

      • Type = Hour, Fixed or Work Rule.

    Note:

    • Location column supports the wildcard character, which allows matches between any selected location with the CRT location.

    • Version Number must be maintained in sequential order for the respective location.

    • Effective From and Effective To columns must use the date format defined by Effective Date Format in control properties.

    • While not required, the best practice is to define adjacent Tiers; this prevents open shifts found in a non-defined tier from being omitted by the incentive process.

    • Tier Value amounts must use the separator format defined by Fraction Separator in control properties.

    Open Shift Pay Incentive - Incentive_CRT Sample
    Location Version Effective From Effective To Ratio Tier 1 Tier 1 Value/Type Tier 2 Tier 2 Value/Type Tier 3 Tier 3 Value/Type Tier 4 Tier 4 Value/Type
    */Med Surge/RN 1 01/01/2022 12/31/2022 25 01-07 10.00/Hour 08-14 15.00/Hour 15-21 17.50/Hour 22-28 20.00/Hour
    */Med Surge/RN 2 01/01/2022 12/31/2023 25 01-07 11.00/Hour 08-14 16.00/Hour 15-21 18.50/Hour 22-28 21.00/Hour
    */Med Surge/CNA 1 01/01/2022 12/31/2050 50 01-07 25.00/Fixed 08-14 50.00/Fixed 15-21 75.00/Fixed 22-28 100.00/Fixed
    */Hospice 1 01/01/2022 12/31/2050 0 01-14 _OT1/Work Rule 15-28 _OT2/Work Rule        

    OpenShiftPayIncentive_v2_Localization_CRT: Allows localization of messages in different languages.

    Column headers and definitions:

    Parameter Name, Locale Policy, Text, Description.

    • Parameter Name = Parameters defined in OpenShiftPayIncentive_v1_Locale_CRT process property.

    • Locale Policy = Locale Policy.

    • Text = Message shown in Additional Details or value of the label defined in the Run Summary section.

    • Description = Description shown in Additional Details; set to blank for labels, messages for run integrations, and notes.

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

    OpenShiftPayIncentive_v2_CurrencyFormat_CRT: Maps how the currency displays in the Shift Label and notifications generated by the integration.

    Column headers and definitions:

    Location, Currency, Currency Format.

    • Location = Allows granular control over which currency is associated with a job.

    • Currency = Locale Policy.

    • Currency Format = Description of the format used for currency rendering.

    Note:

    • Three letter codes must be provided in the Currency column.

    • Best practice is to keep the currency column values synchronized with the Locale Policy values configured in the system.

    • Wildcards are supported with the least restrictive located at the bottom of the table.

    • Supported Currency Formats include:

    CURRENCY_LEFT_WITH_SPACE

    CURRENCY_LEFT_NO_SPACE

    CURRENCY_RIGHT_WITH_SPACE

    CURRENCY_RIGHT_NO_SPACE

    Open Shift Pay Incentive - CurrencyFormat_CRT Sample
    Location Currency Currency format
    Retail Inc.\Belgium\* EUR CURRENCY_RIGHT_WITH_SPACE
    Retail Inc.\Czech Republic\* CZK CURRENCY_RIGHT_NO_SPACE
    Retail Inc.\UK\* GBP CURRENCY_LEFT_WITH_SPACE
    Retail Inc.\USA\* USD CURRENCY_LEFT_NO_SPACE
    * USD CURRENCY_LEFT_NO_SPACE

  3. Select Override to:

    • Download the tables when you run the integration
    • Edit the table cells in Extensions
  4. Click Tap OK.

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 OpenShiftPayIncentive_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 parameter as follows:
    • Location: Select a location 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.

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.

Migrate the business process model to the tenant

Migrate the Open Shift Pay Incentive Business Process 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 Process Model 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.

Configure the decision tables in the process model

Note: Decision tables are configurable based on user requirements and can be changed accordingly. These tables are dynamic and can be updated at any time without redeployment of the process model.

Business processes in the Open Shift Pay Incentive template include:

  • OpenShift_RequestType_v3 — Initiated by the Manager Notification assigned in the Request Open Shift subtype. This process uses net or gross scheduled hours to calculate the incentive amount. It then inserts a money paycode edit or a work rule transfer in the Schedule Planner when the open shift is assigned to an employee.

  • Cover_RequestType_v1.1 — Initiated by the Manager Notification assigned in the Request to Cover subtype. This process removes the incentive when a shift is unassigned with a cover request.

  • Swap_RequestType_v1.1 — Initiated by the Manager Notification assigned in the Swap Request subtype. This process removes the incentive when a shift is unassigned with a swap request.

  • TimeOff_RequestType_v2 — Initiated by the Employee Notification assigned in the Time-Off Request subtype. This process removes the incentive when a shift is unassigned due to a time-off request.

  1. Go to Main Menu > Administration > Application Setup > Business Process setup > Process Models.

  2. Select the appropriate business process and click tap Edit. The process model enters edit mode.

  3. Select the Decision Tables tab.

  4. Click Tap Everyone's, and then select the appropriate decision table to edit.

  5. Click Tap Decision Table Editor to add or update the rows in the table.

  6. Click Tap Save and close.

Edit the following decision tables:

OpenShift_RequestType_v3_Parameters — Controls open shift pay incentive functionality.

OpenShift_RequestType_v3_Parameters
Parameter name Description Parameter type Default value
OpenShiftIncentiveSwitch

The switch parameter that enables the open shift pay incentive functionality.

Yes — enables the functionality.

No — does not enable the functionality.

 String Yes

 

OpenShift_RequestType_v3_InternalParameters — Contains internal open shift parameters that are external to the business and functional requirements.

OpenShift_RequestType_v3_InternalParameters
Parameter name Description Default value
ApprovedStatus A comma-separated list of potential open shift state values for a request during an approved scenario. Approved
Admin Internal user; do not change. Services-Level1
OpenShiftRequestStatusIdActivitiVariableKey Internal Key used to read the request status; do not change. OpenShiftRequestStatusId_1

 

OpenShift_RequestType_v3_OpenShiftIncentive_Locale — Contains configurable messages to support multiple locales for the open shift request type.

OpenShift_RequestType_v3_OpenShiftIncentive_Locale
Variable name Variable type Description
Key String Internal field label; do not change.
Locale String

Name of the locale policy for which the label applies.

When the label applies to all locales, retain the empty value.
Message String

Label displayed in the workflow form.
Description String (Optional) Additional information.

 

OpenShift_RequestType_v3_OpenShiftIncentive_Parameters — Holds configurable parameters for open shift functionality.

OpenShift_RequestType_v3_OpenShiftIncentive_Parameters
Parameter name Description Parameter type Default value
ParamOpenShiftCommentFixed Comment used to mark the open shift as a fixed amount incentive shift; must match the integration parameter. String Open Shift Incentive — Fixed
ParamOpenShiftCommentPerHour Comment used to mark the open shift as an hourly amount incentive shift; must match the integration parameter. String Open Shift Incentive — Per Hour
ParamOpenShiftCommentWorkRule Comment used to mark the open shift as a work rule incentive shift; must match the integration parameter. String Open Shift Incentive — Work Rule
IncentivePayCode Name of incentive paycode added for employee. String Open Shift Incentive
IncentivePayCodeComment Name of paycode comment added with the incentive paycode. String Adjusted by open shift workflow
EmployeeNotification Notification sent to employee when receiving a shift with incentive. String NULL
ManagerNotification Notification sent to (Reports To) manager when employee receives an incentive shift. String Open Shift workflow notification — Manager
ScheduledIncentivePayCode Determines whether the paycode is added as a scheduled paycode. When set to No, the paycode is added in the Timecard. String Yes
IncentivePayCodeNote (Optional) Note added to the comment. Enter NULL when not used. String NULL
OpenShiftIncentiveSwitch Enables this subprocess in the main process. String Yes
AllowedWorkRuleSuffixes Suffixes that the process searches for in case of a work rule transfer incentive. String _T1;_ T2; _T3;_T4;_T5;_T6
CalculateNetHours

Identifies whether the incentive is calculated based on gross or net hours.

Yes — Net shift length, excluding scheduled breaks.

No — Gross shift length.

 String No

 

Cover_RequestType _v1_1_Parameters — Controls open shift pay incentive functionality for cover requests.

Cover_RequestType_v1_1_Parameters
Parameter name Description Parameter type Default value
OpenShiftIncentiveSwitch

The switch parameter that enables the open shift pay incentive functionality.

Yes — enables the functionality.

No — does not enable the functionality.

 String Yes

 

Cover_RequestType_v1_1_InternalParameters — Contains internal request to cover parameters which are external to the business and functional requirements.

Cover_RequestType_v1_1_InternalParameters
Parameter name Description Default value
ApprovedStatus A comma-separated list of potential open shift state values for a request during an approved scenario. Approved
Admin Internal user; do not change. Services-Level1

 

Cover_RequestType_v1_1_OpenShiftIncentive_Parameters — Holds configurable parameters for request to cover functionality.

Cover_RequestType_v1_1_OpenShiftIncentive_Parameters
Parameter name Description Parameter type Default value
ParamOpenShiftCommentFixed Comment used to mark the open shift as a fixed amount incentive shift; must match the integration parameter. String Open Shift Incentive — Fixed
ParamOpenShiftCommentPerHour Comment used to mark the open shift as an hourly amount incentive shift; must match the integration parameter. String Open Shift Incentive — Per Hour
ParamOpenShiftCommentWorkRule Comment used to mark the open shift as a work rule incentive shift; must match the integration parameter. String Open Shift Incentive — Work Rule
IncentivePayCode Name of incentive paycode added for employee. String Open Shift Incentive
IncentivePayCodeComment Name of paycode comment added with the incentive paycode. String Adjusted by open shift workflow
ScheduledIncentivePayCode Determines whether the paycode is added as a scheduled paycode. When set to No, the paycode is added in the Timecard. String Yes

 

Swap_RequestType_v1_1_Parameters — Controls open shift pay incentive functionality for shift swap requests.

Swap_RequestType_v1_1_Parameters
Parameter name Description Parameter type Default value
OpenShiftIncentiveSwitch

The switch parameter that enables the open shift pay incentive functionality.

Yes — enables the functionality.

No — does not enable the functionality.

 String Yes

 

Swap_RequestType_v1_1_InternalParameters — Contains internal shift swap request parameters which are external to the business and functional requirements.

Swap_RequestType_v1_1_InternalParameters
Parameter name Description Default value
ApprovedStatus A comma-separated list of potential open shift state values for a request during an approved scenario. Approved
Admin Internal user; do not change. Services-Level1

 

Swap_RequestType_v1_1_OpenShiftIncentive_Parameters — Holds configurable parameters for shift swap request functionality.

Swap_RequestType_v1_1_OpenShiftIncentive_Parameters
Parameter name Description Parameter type Default value
ParamOpenShiftCommentFixed Comment used to mark the open shift as a fixed amount incentive shift; must match the integration parameter. String Open Shift Incentive — Fixed
ParamOpenShiftCommentPerHour Comment used to mark the open shift as an hourly amount incentive shift; must match the integration parameter. String Open Shift Incentive — Per Hour
ParamOpenShiftCommentWorkRule Comment used to mark the open shift as a work rule incentive shift; must match the integration parameter. String Open Shift Incentive — Work Rule
IncentivePayCode Name of incentive paycode added for employee. String Open Shift Incentive
IncentivePayCodeComment Name of paycode comment added with the incentive paycode. String Adjusted by open shift workflow
ScheduledIncentivePayCode Determines whether the paycode is added as a scheduled paycode. When set to No, the paycode is added in the Timecard. String Yes

 

TimeOff_RequestType_v2_Parameters — Controls open shift pay incentive functionality for time-off requests.

TimeOff_RequestType_v2_Parameters
Parameter name Description Parameter type Default value
OpenShiftIncentiveSwitch

The switch parameter that enables the open shift pay incentive functionality.

Yes — enables the functionality.

No — does not enable the functionality.

 String Yes

 

TimeOff_RequestType_v2_InternalParameters — Contains internal time-off request parameters which are external to the business and functional requirements.

TimeOff_RequestType_v2_InternalParameters
Parameter name Description Default value
ApprovedStatus A comma-separated list of potential open shift state values for a request during an approved scenario. Approved
CancelledStatus A comma-separated list of potential state values in the system during a canceled scenario. Canceled; CancelApproved
Admin Internal user; do not change. Services-Level1

 

TimeOff_RequestType_v2_OpenShiftIncentive_Parameters — Holds configurable parameters for time-off request functionality.

TimeOff_RequestType_v2_OpenShiftIncentive_Parameters
Parameter name Description Parameter type Default value
ParamOpenShiftCommentFixed Comment used to mark the open shift as a fixed amount incentive shift; must match the integration parameter. String Open Shift Incentive — Fixed
ParamOpenShiftCommentPerHour Comment used to mark the open shift as an hourly amount incentive shift; must match the integration parameter. String Open Shift Incentive — Per Hour
ParamOpenShiftCommentWorkRule Comment used to mark the open shift as a work rule incentive shift; must match the integration parameter. String Open Shift Incentive — Work Rule
IncentivePayCode Name of incentive paycode added for employee. String Open Shift Incentive
IncentivePayCodeComment Name of paycode comment added with the incentive paycode. String Adjusted by open shift workflow
IncentivePayCodeNote (Optional) Note added to the comment. Enter NULL when not used. String NULL
ScheduledIncentivePayCode Determines whether the paycode is added as a scheduled paycode. When set to No, the paycode is added in the Timecard. String Yes
AllowedWorkRuleSuffixes Suffixes that the process searches for in case of a work rule transfer incentive. String _T1;_ T2; _T3;_T4;_T5;_T6
ManagerNotification Notification sent to (Reports To) manager when employee receives an incentive shift. String Open Shift workflow notification — Manager

 

Note:

  • Values in decision tables are case sensitive, and must match values configured in UKG Pro Workforce Management™.

  • The Time-Off business process must be attached to the employee workflow notification.

  • The Open Shift, Cover, and Shift Swap business processes must be attached to the manager workflow notifications.

  • Process profiles assigned to employees must be configured with access to execute the business processes.

  • Notification profiles assigned to managers must be configured with the same priority as the priority configured in workflow notifications supporting the Open Shift Pay Incentive process.

  • The OpenShiftIncentiveSwitch parameter in each _Parameters decision tables must be set to 'Yes' to enable request functionality.

  • The ScheduleIncentivePaycode value must match across all _OpenShiftIncentive_Parameters decision tables.

  • Workflow notifications must be configured with the appropriate priority.

  • Because Activiti scans decision tables from top to bottom and stops when it finds a match, define rows containing the most-used conditions at the top of the table, and rows containing wildcard conditions at the bottom of the table.

  • Names of the parameters in the "Key" column of the Locale decision table must be used as is. If any parameter value needs to be localized for a different Locale Policy, copy the "Key" with the “not empty” Locale Policy, add a new row to the table with the appropriate Locale Policy, and then add the localized values in the Value and Description decision table columns.

  • All parameters in the Locale decision table with "not empty" Locale Policy values should be located at the bottom of the table; these are the default error messages.

Deploy the process model

Process models must be redeployed every time changes are made to an existing model. Re-deployment is not required for decision table changes.

Follow these steps to deploy the process models. For detailed information, see the online help topic Deploy Business Process Models

  1. From the Main Menu, go to Application Setup > Business Process Setup > Process Models.
  2. Select the appropriate process and click tap Deploy.
  3. On the Business Process page, configure the required parameters and deployment dates.
  4. Select Notification from the Template Categories.
  5. Click Tap Save, and then select Return to deploy.

Create comment

Create comment that is attached to the incentive paycode; see the Comments topic.

Example: Adjusted by open shift workflow

Create request workflow notifications

Create workflow notifications for each request type; see the Configure Notifications for Business Processes topic.

  1. From the Main Menu, go to Application Setup > Event/Notification > Workflow Notifications.
  2. Click Tap New.
  3. From the Notification Type, select Generic notification.
  4. Click Tap Ok.
  5. Complete the configuration for each employee, manager, and recipient notification.
  6. Click Tap Save.

Repeat for each workflow notification.

Open shift workflow notification — Employee

  • Enter an appropriate Name.

  • (Optional) Enter an appropriate Description.

  • Enter an appropriate Subject.

  • Enter an appropriate Long Message.

  • Select Recipient List will be supplied at runtime.

  • Select Do not suppress duplicates.

  • Control center fields:
Field Label Value
1 Request Status <Request Status>
2 Open Shift Date <Open Shift Date>
3 Open Shift Location <Open Shift Location>
4 Open Shift Start Time <Open Shift Start Time>
5 Open Shift End Time <Open Shift End Time>

Open shift workflow notification — Manager

  • Enter an appropriate Name.

  • (Optional) Enter an appropriate Description.

  • Enter an appropriate Subject.

  • Enter an appropriate Long Message.

  • Select Recipient List will be supplied at runtime.

  • Select Trigger Business Process.

  • Select OpenShiftRequestType_v3 from Template.

  • Select Do not suppress duplicates.

  • Control center fields:
Field Label Value
1 Request Status <Request Status>
2 Open Shift Date <Open Shift Date>
3 Open Shift Location <Open Shift Location>
4 Open Shift Start Time <Open Shift Start Time>
5 Open Shift End Time <Open Shift End Time>

Cover workflow notification — Employee

  • Enter an appropriate Name.

  • (Optional) Enter an appropriate Description.

  • Enter an appropriate Subject.

  • Enter an appropriate Long Message.

  • Select Recipient List will be supplied at runtime.

  • Select Do not suppress duplicates.

  • Control center fields:
Field Label Value
1 Current Approver <Cover Current Approver>
2 Request Status <Cover Request Status>

Cover workflow notification — Manager

  • Enter an appropriate Name.

  • (Optional) Enter an appropriate Description.

  • Enter an appropriate Subject.

  • Enter an appropriate Long Message.

  • Select Recipient List will be supplied at runtime.

  • Select Trigger Business Process.

  • Select Cover_RequestType_v1.1 from Template.

  • Select Do not suppress duplicates.

  • Control center fields:
Field Label Value
1 Requesting Employee <Cover Requesting Employee>
2 Requester Recipient <Cover Request Recipient>
3 Start Time <Cover Offered Start Time>
4 End Time <Cover Offered End Time>

Cover workflow notification — Recipient

  • Enter an appropriate Name.

  • (Optional) Enter an appropriate Description.

  • Enter an appropriate Subject.

  • Enter an appropriate Long Message.

  • Select Recipient List will be supplied at runtime.

  • Select Do not suppress duplicates.

  • Control center fields:
Field Label Value
1 Requesting Employee <Cover Requesting Employee>
2 Timing

Start Time <Cover Offered Start Time>

End Time <Cover Offered End Time>
3 Request Status <Cover Request Status>
4 Offered Date <Cover Offered Date>

Swap workflow notification — Employee

  • Enter an appropriate Name.

  • (Optional) Enter an appropriate Description.

  • Enter an appropriate Subject.

  • Enter an appropriate Long Message.

  • Select Recipient List will be supplied at runtime.

  • Select Do not suppress duplicates.

  • Control center fields:
Field Label Value
1 Current Approver <Swap Current Approver>
2 Request Status <Swap Request Status>

Swap workflow notification — Manager

  • Enter an appropriate Name.

  • (Optional) Enter an appropriate Description.

  • Enter an appropriate Subject.

  • Enter an appropriate Long Message.

  • Select Recipient List will be supplied at runtime.

  • Select Trigger Business Process .

  • Select Swap_RequestType_v1.1 from Template.

  • Select Do not suppress duplicates.

  • Control center fields:
Field Label Value
1 Requesting Employee <Requesting Employee>
2 Request Recipient <Request Recipient>
3 Offered Date <Offered Date>
4 Received Date <Received Date>

Swap workflow notification — Recipient

  • Enter an appropriate Name.

  • (Optional) Enter an appropriate Description.

  • Enter an appropriate Subject.

  • Enter an appropriate Long Message.

  • Select Recipient List will be supplied at runtime.

  • Select Do not suppress duplicates.

  • Control center fields:
Field Label Value
1 Requesting Employee <Requesting Employee>
2 Request Recipient <Request Recipient>
3 Offered Date <Offered Date>
4 Received Date <Received Date>

Time-off workflow notification — Employee

  • Enter an appropriate Name.

  • (Optional) Enter an appropriate Description.

  • Enter an appropriate Subject.

  • Enter an appropriate Long Message.

  • Select Recipient List will be supplied at runtime.

  • Select Trigger Business Process.

  • Select TimeOff_RequestType_v2 from Template.

  • Select Do not suppress duplicates.

  • Control center fields:
Field Label Value
1 Status <Approval Status>
2 Date <Start Date>

Create time-off workflow notification for manager (partial day)

Time-off workflow notification — Manager partial day

  • Enter an appropriate Name.

  • (Optional) Enter an appropriate Description.

  • Enter an appropriate Subject.

  • Enter Partial day time-off request for <employee name> on <timeoff_date> has a status of <timeoff_status>. Please review the open shift payout incentive given to the employee. in Long Message.

  • Select Recipient List will be supplied at runtime and Send to employee.

  • Select Trigger Business Process.

  • Select Do not suppress duplicates.

  • Control center fields:
Field Label Value
1 Employee <Employee Name>
2 Time-Off Status <timeoff_status>
3 Time-Off Date <timeoff_date>

Create incentive failure notification

Configure the incentive failure notification for the manager.

Open shift incentive failure notification — Manager

  • Enter an appropriate name, such as Open Shift incentive failure - Manager, in Name.

  • Enter an appropriate Subject.

  • Enter Open Shift incentive detail — <Employee Name>, Status <status> <statusMsg> in Long Message.

  • Select Recipient List will be supplied at runtime and Send to employee.

  • Select Do not suppress duplicates.

  • Control center fields:
Field Label Value
1 Employee <Employee Name>
2 Status <status>
3 Incentive <amount>

Create control center mappings for all notifications

Create control center notification mappings for all workflow notifications that support open shift pay incentive; see the Control Center Notification Mapping topic.

  1. From the Main Menu, go to Application Setup > Event/Notification > Control Center Notification Mapping.
  2. Click Tap New.
  3. Enter an Event Name.
  4. From Domain, select Scheduler.
  5. From Event Type, select the option corresponding to the Notification, such as:

    Open Shift

    Cover

    Swap

    Time-off.

  6. From Notification, select the appropriate value, such as:

    Open shift workflow notification — Employee

    Open shift notification — Manager

    Cover workflow notification — Employee

    Cover workflow notification — Manager

    Cover workflow notification — Recipient

    Swap workflow notification — Employee

    Swap workflow notification — Manager

    Swap workflow notification — Recipient

    Time-off workflow notification — Employee

    Time-off workflow notification — Manager partial day

    Open shift incentive failure notification — Manager

  7. From Navigation Page, select Schedule.
  8. From Icon, select an appropriate property.
  9. Click Tap Save.

Repeat for each workflow notification that supports the open shift pay incentive process.

Create request subtypes

Create request subtypes that support the open shift pay incentive process.

  1. From the Main Menu, go to Application Setup > Employee Self Service > Request Subtype.
  2. Click Tap New.
  3. Enter a Name.
  4. (Optional) Enter a Description.
  5. From Request Type, select the appropriate value, such as:

    Open Shift

    Cover

    Swap

    Time-Off

  6. Configure remaining fields as needed.
  7. Click Tap Save & Return.

Repeat for each request subtype that supports the open shift pay incentive process.

Open Shift request subtype

  • Select Open Shift from Request Type.

  • Select previously configured notification, such as Open shift workflow notification — Employee from Employee notification.

  • Select previously configured notification, such as Open shift workflow notification — Manager from Manager notification.

  • (Optional) Select Include Market Shifts.

Cover request subtype

  • Select Cover from Request Type.

  • Select previously configured notification, such as Cover workflow notification — Employee from Employee (Requester) Notification.

  • Select previously configured notification, such as Cover workflow notification — Recipient from Employee (Recipient) Notification.

  • Select previously configured notification, such as Cover workflow notification — Manager from Manager Notification.

  • (Optional) Select Both from Recipients of Request Offer.

  • (Optional) Select Show Other Employees in Shift Market.

Swap request subtype

  • Select Swap from Request Type.

  • Select previously configured notification, such as Swap workflow notification — Employee from Employee (Requester) Notification.

  • Select previously configured notification, such as Swap workflow notification — Recipient from Employee (Recipient) Notification.

  • Select previously configured notification, such as Swap workflow notification — Manager from Manager Notification.

Time-Off request subtype

  • Select Time-Off from Request Type.

  • Select previously configured notification, such as Time-Off workflow notification — Employee from Employee Notification.

  • Select previously configured paycode, such as Open Shift Incentive from Default Pay Code.

  • Select Full day, 1st half day, 2nd half day, Half day from Default Symbolic Amounts.

  • Select Allow Request Editing by Manager.

API details
API name Type Resource path Description
Retrieve Current User Tenant Locale GET /v1/commons/user_preferences/locale_policy?userCurrent=true Fetch locale for system user.
Retrieve Comments GET /v1/commons/comments Fetch all comments in system.
Execute Hyperfind POST v1/commons/hyperfind/execute Count number of employees in a location.
Retrieve Shifts POST v1/scheduling/schedule/multi_read Fetch all shift data.
Update Open Shift Comment POST v1/scheduling/schedule/shifts/multi_update Update open shift with new incentive if not already present or remove incentive.
Retrieve Timecards as Manager POST /v1/timekeeping/timecard/multi_read Fetch all the process segments and duration.
Time off Multi read POST /v1/scheduling/timeoff/multi_read Returns one or more time-off requests for a set of employees.
Retrieve overridden shifts from Time off Multi read POST /v1/scheduling/timeoff/{notificationid}?include_overridden_shifts=true Returns a time-off request by ID; includes overridden shifts.
GenericNotificationNotifyAPI POST Generic Notification Notify Sends notification to the recipient.
Retrieve open shift request details GET /v1/scheduling/employee_open_shift_requests/${notificationItemId} Returns an open shift request by ID.
Retrieve cover shift request details GET /v1/scheduling/employee_coverrequests/notificationItemId" Returns a cover shift request by ID.
Retrieve shift request details POST /v1/scheduling/schedule/shifts/multi_read Returns shift details.
Retrieve manager swap detail GET /v1/scheduling/manager_swap Returns a manager swap details.