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 A shift that is scheduled for a job, but no employee is assigned to work it. 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 A repeating span of days in the schedule that is defined for administrative purposes, such as pay periods. into different tiers, or optionally, zones. 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 or zone.
Manager discretion to adjust the incentive for certain shifts.
Control over incentives using an open-shifts-to-required-shifts ratio.

For customers who want more detailed control when rewarding incentives, the integration accommodates the timing of some open shifts. This includes:

Time of day
Day of week
Public holiday

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 periods - Zones

Incentive periods can be based on schedule zones A span of time that repeats on a 24-hour cycle, used to measure coverage. Examples include Day, Evening, and Night zones., shift sets Contains a collection of shifts used to define workload (staffing) requirements for locations. Example: An organization has shifts that the majority of employees work: 7 AM-3 PM and 3 PM-11 PM., or custom zones. Combining zones is allowed. For example, an open shift that falls on a Friday during the Late 15-23 zone can be configured to reward an employee with an incentive of $5.00 for each shift hour. You have the option to reward incentives by solely utilizing zones, however, at least one 365-day tier with zero amount incentives must first be configured.

Incentive allocation

It is possible that open shifts do not always align with Time of day zones. For example, the night shift is configured from 11:00PM - 7:00AM, but an ad-hoc open shift is created for 9:00PM - 5:00AM. Incentive allocations allow you to choose how the calculation handles these occurrences:

Zone with shift start — The zone where the shift time started determines the incentive.
Zone with majority hours — The zone where the majority of the shift hours are located determines the incentive.
Corresponding zone — The respective zone for each shift hour determines the corresponding incentive. This option is only supported when incentives are configured with custom zones.

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 prevent incentive awards from being offered when the calculated open shift ratio equals or falls below the threshold. Only when the calculated open shift ratio exceeds the threshold is the incentive awarded.

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 Replaces start and end times in the schedule with a compact, easier-to-read label. Example: Shift times are 4PM-12:30AM, and the shift label is Evening. 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.

User experience

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 A container that provides navigation or action from its summary view. 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 An organized flow of activities or tasks that achieves a business goal. An automated business process minimizes the amount of paperwork and manual tasks to complete that process by way of automatic actions, online forms, and automatically generated messages. 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 Creates or assigns shifts based on the workload, shift templates or profiles, employee and organizational rules, and engine settings. 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 Employees can exchange their scheduled shift with a shift scheduled for another qualified employee. — Shift is swapped with another employee.
Time-Off Request Request subtypes that employees use to request time off for vacation, illness or recovery, appointments, personal time, or other absences. Time-off requests can be configured to support many different employment scenarios. — 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.

Configure the Open Shift Pay Incentive integration

Version history — Open Shift Pay Incentive integration

Version	Process	Description
1	OpenShiftPayIncentive_v1	Initial release.
2	OpenShiftPayIncentive_v2	Enhancement: Calculates the incentive based on net or gross hours.
iPack_v3	OpenShiftPayIncentive_iPack_v3	Enhancements: Provides granular control of the open shift incentive — time of day, day of week, and public holiday. Staffing level validation. Prevents incentives for previous open shifts. The Open Shift Pay Incentive integration delivery is now by way of an iPack.
iPack_v3 Update 1	OpenShiftPayIncentive_iPack_v3	Resolves an issue related to effective version date formatting.

Deploy the Open Shift Pay Incentive integration
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 Open Shift Pay Incentive Extension integration.
  Note: If the integration does not display, select Browse Integration Packs to search for and select the iPack.
  1. Click Tap Install.
  2. From Unattached Environments, select the environment in which to deploy the integration process for the selected integration. Click Tap the double-left arrows button .
For more information, see the Deploy Integrations topic.
Configure the Open Shift Pay Incentive integration settings A sequence of integrations that can be run on-demand or be scheduled.
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 . It can take several seconds before the button becomes active.
  3. Scroll to and select the integration pack: Open Shift Pay Incentive > OpenShiftPayIncentive_iPack_v3.

Configure connection settings

Caution: If you select Use Default for the connection settings and process properties, ensure that Value is blank. If Value is not blank, that value overrides the default value whether or not Use Default is selected or cleared. Example: If the default value is abc, but Value shows xyz, the integration uses xyz regardless of the setting of Use Default.

Select Connection Settings.

From the Connection list, select and configure the following:

Connection Settings
Setting	Required	Actions
OpenShiftPayIncentive_iPack_v3_APIGatewayServer	Required	To change the default API gateway server: Clear Use Default. Enter the URL to the server. Example: <tenantURL>/api
OpenShiftPayIncentive_iPack_v3_Locale_CRT	Required	Enable Override.
OpenShiftPayIncentive_iPack_v3_CurrencyFormat_CRT	Required	Enable Override.

Configure process properties

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.
Select OpenShiftPayIncentive_iPack_v3_CRTConfig to set process properties that must be configured before the integration can run. This main process starts the integration process and handles errors.

Process Properties
Process property name	Column header value
_OpenShiftPayIncentive_iPack_v3_ZonesBasedIncentives_CRT	Location,Iteration,Effective From,Effective To, Staffing Level Threshold (in Percentage),Tier,Tier Day Range,Tier Value,Day of Week,Zone Type,Time of Day,Time of Day Value,Day of Week Value,Public Holiday Value,Time of Day and Day of Week Value,Day of Week and Public Holiday Value,Time of Day and Public Holiday Value,Time of Day and Day of Week and Public Holiday Value,Incentive Allocation
_OpenShiftPayIncentive_iPack_v3_CurrencyFormat_CRT	Location,Currency,Currency Format
_OpenShiftPayIncentive_iPack_v3_Locale_CRT	Parameter Name,Locale Policy,Message,Description

Configure cross-reference tables

Cross-reference tables (CRT) are the look-up tables that the integrations use to translate parameter values. One or more data values from the source system can be used to assign one or more parameters in the destination system.

If more than one row matches a reference value, the first match is the output value.
If no match is found, the output value can be null, or the integration can produce errors.

Select Cross Reference.
From the Cross Reference dropdown list, select an OpenShiftPayIncentive_iPack_v3 table.
Select Override, which allows you to:
- Download the table when you run the integration
- Edit the table cells in Extensions
When you finish, click tap OK.

Repeat the steps for each of the OpenShiftPayIncentive tables.

OpenShiftPayIncentive_iPack_v3_ZonesBasedIncentives_CRT: Defines the eligibility criteria that specifies conditions for different incentives.

Note: When Tier-only incentives are offered to employees, Zone Type and Incentive Allocation must be set as none; and all remaining incentive fields must remain blank.

Open Shift Pay Incentive - Zones Based Incentives CRT structure
Column name	Description
Location	Allows granular control over which location receives which incentive.. Note: You can use an asterisk (*) as a wildcard, but put the less-restrictive location at the bottom of the table because the integration scans cross-reference tables from the top.
Iteration	Incremental number associated with the Location. Caution: You must configure at least one Iteration value. Iteration values must be maintained in sequential order for the respective Location; otherwise, the extension stops at the first Location match without scanning the remaining combinations.
Effective From	Effective start date of the incentive. Caution: The value must adhere to the date format defined by integration parameter Effective Date Format.
Effective To	Effective end date of the incentive. Caution: The value must adhere to the date format defined by integration parameter Effective Date Format.
Staffing Level Threshold (in Percentage)	Minimum percentage of staffing level that must be present to initiate the incentive calculation. Caution: The Staffing Level must remain blank when Zone Type is configured as `Custom Zone`.
Tier	Identifies the rolling period in which the open shift falls. Caution: You must configure at least one tier. 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 Day Range	Duration in days, beginning with the Extension run date, that determines the tiers. Caution: You must configure at least one tier day range.
Tier Value	Incentive value to be provided for the tier. Caution: You must configure at least one tier value. Tier Value amounts must use the separator format defined by integration parameter Fraction Separator.
Day of Week	Day of week for which the open shift incentive calculation occurs. Supported values include a unique day name, a semicolon-separated list of specific day names, or `All Days`. Examples: `Monday` `Thursday;Friday;Saturday;Sunday` `All Days` Caution: You must configure Day of Week when Staffing Level Threshold is configured.
Zone Type	Identifies the type of zone. This column aligns with the Time of Day column. Supported values include: `Custom Zone` — Customer-defined zone. `Schedule Zone` — Schedule zone defined in the application. `Shift Set` — Shift set defined in the application. Caution: Each Location must be configured with a unique Zone Type. For example, do not mix Shift Set with Schedule Zone or Custom Zone when multiple rows exist for the same Location. When Zone Type = `Custom Zone`, incentives must adhere to an hourly format, such as `50.00/Hour`. Otherwise, incentives must adhere to an hourly, fixed or work rule format, such as `50.00/Hour`, `500.00/Fixed`, or `_T3/Work Rule`.
Time of Day	Identifies the specific custom zone, schedule zone, or shift set that initiates the calculation. Caution: Configure only a single value for each row. You must configure Time of Day when Staffing Level Threshold is configured. The Time of Day value must align with the configured Zone Type. Prevent calculation discrepancies by NOT configuring overlapping Time of Day values for the same location. For example, do NOT configure 09:00—18:00 and 16:00—22:00.
Time of Day Value	Incentive value associated with the schedule zone within the tier.
Day of Week Value	Incentive value associated with the day of week within the tier.
Public Holiday Value	Incentive value associated with the public holiday within the tier.
Time of Day and Day of Week Value	Incentive value associated with the combination of schedule zone and day of week within the tier.
Day of Week and Public Holiday Value	Incentive value associated with the combination of day of week and public holiday within the tier.
Time of Day and Public Holiday Value	Incentive value associated with the combination of time of day and public holiday within the tier.
Time of Day and Day of Week and Public Holiday Value	Incentive value associated with the combination of schedule zone, day of week, and public holiday within the tier.
Incentive Allocation	Determines the incentive hours allocation when an open shift spans multiple zones. Supported values include: `Zone with Shift Start` — The incentive is determined by the zone in which the shift starts. Note: This option is only supported when Zone Type is configured as `Schedule Zone` or `Shift Set`. `Zone with Majority Hours` — The incentive is determined by the zone in which the majority of the shift hours fall. Note: This option is only supported when Zone Type is configured as `Schedule Zone` or `Shift Set`. `Corresponding Zones` — When the shift crosses two zones, then the incentive is based on hours in the corresponding zones. Note: This option is only supported when Zone Type is configured as `Custom Zone`. Caution: Incentive Allocation must be configured and must contain a unique value for each Location.

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

Open Shift Pay Incentive - Currency Format CRT structure
Column name	Description
Location	Allows granular control over which currency is associated with a job. Note: You can use an asterisk (*) as a wildcard, but put the less-restrictive location at the bottom of the table because the integration scans cross-reference tables from the top.
Currency	Currency used by the integration. 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.
Currency Format	Description of the format used for currency rendering. Supported values include: CURRENCY_LEFT_WITH_SPACE CURRENCY_LEFT_NO_SPACE CURRENCY_RIGHT_WITH_SPACE CURRENCY_RIGHT_NO_SPACE

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

Open Shift Pay Incentive - Locale CRT structure
Column name	Description
Parameter Name	Key for which localization is defined.
Locale Policy	Locale Policy. Note: 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	Description shown in Additional Details; set to blank for labels, messages for run integrations, and notes. `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
Parameter Name	Locale Policy	Message	Description
Error_MessageInvalidLocation	*	Invalid locations.
Error_MessageInvalidLocationDesc	*	Invalid location IDs for selected date range or location ids do not exist.
Label_DisqualifiedLocations	*	Disqualified locations
Label_DisqualifiedTransactions	*	Disqualified transactions
Label_FailedTransactions	*	Failed transactions
Label_ImportedSuccessful	*	Successful transactions
Label_IntegrationType	*	Integration type
Label_LocationErrorKey	*	Location
Label_OpenShiftErrorKey	*	Open Shift
Label_ProcessedRecords	*	Processed source records
Message_AdditionalDetails	*	Process completed with transaction errors. Additional details, such as disqualifications, may be accessible using the button below.
Message_customZone	*	Eligibility criteria not met.	Custom zone majority does not fall within a zone.
Message_CustomZoneTimeFormat	*	Eligibility criteria not met.	Invalid time of day configured. Custom zone time of day must adhere to hh:mm-hh:mm format.
Message_DateRangeLessthenCurrentDate	*	Eligibility criteria not met.	Update not required. Incentive not calculated because the start date does not fall in the tier.
Message_DeletedComment	*	Open shift incentive updated.	Comment added by integration in previous execution is deleted.
Message_DiscreationCommentPresent	*	Eligibility criteria not met.	Manager discretion comment exists.
Message_DisqualifiedOpenShift	*	Eligibility criteria not met.	Disqualified open shift.
Message_DisqualifyTag	*	Eligibility criteria not met.	Manager discretion comment exists. Incentive not calculated.
Message_HifenCheck	*	Incorrect format.	The provided format is invalid.
Message_IncentiveAllocationMethod	*	Eligibility criteria not met.	For Zone Type in a mandatory column Incentive Allocation is not provided.
Message_IncorrectDateFormat	*	Effective Start or End date not in correct format.	Selected Date format does not match CRT Date format.
Message_IncorrectSeparatorValue	*	Incorrect format.	Selected separator does not match with CRT min wage value.
Message_IntegrationType	*	Import
Message_InvalidComment	*	Invalid comment definition.
Message_InvalidLocation	*	Eligibility criteria not met.	Location not found.
Message_InvalidZoneShift	*	Invalid zone or shift.
Message_InvalidZoneShiftDesc	*	OrgNode(s) or OrgObjectRef could not be found, or you do not have access rights.
Message_LabelNoteError	*	Label not found.
Message_LocationWithNoEmployee	*	No employees in the Llocation.	Employees not found in the location.
Message_MultipleZoneIncentiveAllocationforsameLocation	*	Eligibility criteria not met.	Zone Type or Incentive Allocation: Multiple entries configured for a specific location.
Message_NoChangeRequired	*	No change required.	Open Shift already updated.
Message_NoIncentive	*	Eligibility criteria not met.	Location not found/Shift ratio is below threshold/Comment name not specified.
Message_NoIncentiveAvailable	*	Eligibility criteria not met.	No update required, incentive is not configured in the CRT.
Message_NoLocation	*	Location not found.	Location does not match a location defined in the CRT.
Message_NoOpenShiftsAvailable	*	Eligibility criteria not met.	Open shifts do not exist for the selected location.
Message_NoOverlapping	*	Tier values overlap.	Tier values overlap.
Message_OpenShiftDoesNotLieInTierRange	*	Eligibility criteria not met.	No update required, Open shift does not fall in tier range.
Message_OpenShiftDoesNotLieInTierRange&Threshold	*	Eligibility criteria not met.	No update required, Open shift does not fall in tier range and threshold is not met.
Message_OpenShiftStarted	*	No change required.	Open Shift already started.
Message_OverlappingCustomZone	*	Eligibility criteria not met.	Overlapping Custom Zones are not supported.
Message_OverlappingScheduleZone	*	Eligibility criteria not met.	Overlapping Schedule Zones are not supported.
Message_OverlappingShiftSet	*	Eligibility criteria not met.	Overlapping Shift Sets are not supported.
Message_scheduleMatching	*	Eligibility criteria not met.	Schedule zone assigned majority does not fall within a zone.
Message_scheduleOpenMajorityMatching	*	Eligibility criteria not met.	Schedule zone open shift majority does not fall within a zone.
Message_shiftMatching	*	Eligibility criteria not met.	Shift set assigned majority does not fall within a zone.
Message_shiftOpenMajorityMatching	*	Eligibility criteria not met.	Shift set open shift majority does not fall within a zone.
Message_ThresholdNotMet	*	Eligibility criteria not met.	Staffing level is below threshold, or Day of Week, and Time of Day combination does not exist.
Message_TierValue	*	Eligibility criteria not met.	Tier value is not provided for Zone Type in a mandatory column.
Message_TierValueCheck	*	Eligibility criteria not met.	Tier Value must be configured.
Message_TransactionEnabled	*	Process completed with transaction errors. If Transaction Assistant Corrects transaction errors in integrations without the need to resubmit entire projects. is enabled, failed records can be re-submitted through Transaction Assistant.
Message_ValidateDuration	*	Duration (in days) is incorrect. It must be configured with a positive integer.
Message_ValidateEffectiveDateFormat	*	Effective Date format is incorrect. Supported date formats include: yyyy-MM-dd, dd-MM-yyyy, dd/MM/yyyy, yyyy/MM/dd, MM-dd-yyyy, MM/dd/yyyy.
Message_ValidateFractionSeparator	*	Fraction Separator is incorrect. Supported fraction separator formats include: Comma (,) and period (.)
Message_ValidateLocationNullCheck	*	Location not defined.
Message_ValidateLocationType	*	Selected Location type is incorrect. Supported location type - (Location).
Message_WithoutErrors	*	Integration completed without errors.
Message_WithoutTransactionErrors	*	Integration completed without transaction errors. Additional details, such as disqualifications, may be accessible using the button below.
Message_ZoneType	*	Eligibility criteria not met.	The provided Zone Type is incorrect.
Message_ZoneTypeInvalid	*	Eligibility criteria not met.	CRT parameters (Zone Type/Incentive Allocation/Tier/Staffing Level for Custom Zone) are missing or invalid.
Message_ZoneTypenotProvided	*	Eligibility criteria not met.	Zone Type must be configured.

Install the Open Shift Pay Incentive 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.

Select Main Menu > Administration > Application Setup > Integrations Setup > Install Integrations.
Click Tap Create .
In Integration Name enter a unique name, such as OpenShiftPayIncentive_iPack_v3.
(Optional) Enter a Description.
Note: Do not select API Integration.
In File Access, select None to not select a connection.
(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.
(Optional) Select Re-Run to allow repeated runs of the integration with the same parameter values as the previous run.
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.
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.

Integration template and parameters

In Integration Template, select OpenShiftPayIncentive_iPack_v3.
Click Tap Assign .
In Integration Parameters, you can override default settings. Click Tap Create.
Complete the configuration for each parameter value.

Click Tap Save.

Repeat for each Integration Parameter that supports the open shift pay incentive process.

Integration parameters
Parameter name	Description / User prompt / Mandatory	Template parameter	Parameter type
Open Shift Comment — Fixed	Unique identifier that marks the Open Shift as an incentive Open Shift for fixed incentive type. Default = `Open Shift Incentive — Fixed` User prompt = No Mandatory = Optional	OpenShiftComment—Fixed	Text
Open Shift Comment — Per Hour	Unique identifier that marks the Open Shift as an incentive Open Shift for each Hour incentive type. Default = `Open Shift Incentive — Per Hour` User prompt = No Mandatory = Optional	OpenShiftComment—PerHour	Text
Open Shift Comment — Work Rule	Unique identifier that marks the Open Shift as an incentive Open Shift for work rule incentive type. Default = `Open Shift Incentive — Work Rule` User prompt = No Mandatory = Optional	OpenShiftComment—WorkRule	Text
Incentive Type Fixed Definition	Defines the CRT value, such as Fixed. Default = `Fixed` User prompt = No Mandatory = Optional	IncentiveTypeFixedDefinition	Text
Incentive Type Per Hour Definition	Defines the CRT value, such as Hour. Default = `Hour` User prompt = No Mandatory = Optional	IncentiveTypePerHourDefinition	Text
Incentive Type Work Rule Definition	Defines the CRT value, such as Work Rule. Default = `Work Rule` User prompt = No Mandatory = Optional	IncentiveTypeWorkRuleDefinition	Text
Manager Discretion Comment	Override comment to disqualify the Open Shift from receiving incentive. Default = `Manager Discretion Comment` User prompt = No Mandatory = Optional	ManagerDiscretionComment	Text
Location	The default Location query that contains the employees for whom the integration is run. Default = `All Home A query that returns a list of employees associated with a manager's employee group. All Home finds people who are active employees or active users as of today. Locations` User prompt = Yes Mandatory = Yes	Location	Hyperfind A search engine that filters and selects groups of employees through queries that specify conditions or locations (criteria).
Effective Date Format	Defines date format for dates entered in CRT. Supported formats include: `dd-MM-yyyy` (default) `dd/MM/yyyy` `yyyy-MM-dd` `yyyy/MM/dd` `MM-dd-yyyy` `MM/dd/yyyy` User prompt = Yes Mandatory = Yes	EffectiveDateFormat	Text
Duration (in Days)	Specifies the number of days, starting from integration run date, for which open shifts should be marked as incentive open shifts. Default = `14` User prompt = Yes Mandatory = Yes	Duration(InDays)	Number
Fraction Separator	Identifies decimal value delimiter. Supported formats include: Period (`.`) — (default) Comma (`,`) User prompt = No Mandatory = Yes	FractionSeparator	Text
Incentive Shift Label	Defines text displayed in label of an open shift for user visibility. Default = `Incentive Provided — <value>` User prompt = No Mandatory = Yes	IncentiveShiftLabel	Text
Calculate Net Hours	Identifies how the incentive is calculated. `True` (default) — The calculation excludes scheduled breaks, and then uses the net shift length. `False` — The calculation is based on gross shift length. User prompt = Yes Mandatory = Yes	CalculateNetHours	Boolean
Incentive WorkRule Qualifier	Defines work rule value displayed in label. Default = `Workrule` User prompt = No Mandatory = Yes	IncentiveWorkRuleQualifier

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

Run and test the Open Shift Pay Incentive integration

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_iPack_v3 integration from the list. Click Tap Select.
  4. (Optional) Enter a unique Integration Run Name to make it easier to identify the run of the integration. Otherwise, the 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.
  - Effective Date Format: Select the date format.
  - Duration (in Days): Enter the duration (in days) for which open shifts should be marked with incentive.
  - Calculate Net Hours: Select whether the integration will be calculated on Gross or Net Hours.
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 Schedule Integrations topic.

APIs — Open Shift Pay Incentive integration

API details
API name	Type	Resource path	Description
Execute Hyperfind query	POST	/v1/commons/hyperfind/execute	Executes a Hyperfind query by ID or qualifier and returns the result.
Retrieve shift details	POST	/v1/scheduling/schedule/multi_read	Returns shift details.
Update shift	POST	/v1/scheduling/schedule/shifts/multi_update	Returns a list of updated shifts.
Tenant default locale	GET	/v1/commons/user_preferences/locale_policy?tenantDefault=true	Returns user preferences for the tenant.
Locale of employee and manager	POST	/v1/commons/persons/extensions/multi_read	Returns person extensions details.
Retrieve Timecards as manager	POST	/v1/timekeeping/timecard/multi_read	Retrieves Timecard details.
Retrieve schedule zone	POST	/v1/scheduling/schedule_zone sets Contains non-overlapping schedule zones that together comprise a full day based on hours of operation for a location./assignments/multi_read	Retrieves schedule zones details.
Retrieve shift sets	POST	/v1/scheduling/standard_shift_sets/assignments/multi_read	Retrieves shift set details.
Retrieve staffing details from Workload Planner	POST	/v1/scheduling/workload_coverage/workload/multi_read	Retrieves staffing details from Workload Planner.
Retrieve location from person extensions	POST	/v1/commons/persons/extensions/multi_read?partial_success='true'	Retrieves Person Extension location details.

Configure the Open Shift Pay Incentive business models

Version history — Open Shift Pay Incentive business models

Open Shift — Request Type

Version	Process	Description
1	OpenShift_RequestType_v1	Initial release.
2	OpenShift_RequestType_v2	Enhancement: Calculates the incentive based on net or gross hours.
3	OpenShift_RequestType_v3	Enhancements: Dynamic extension supports updated status values for request subtypes Classifications of schedule requests from employees.. Process sends error message to manager and additional recipients. Replaces variable originator reference by using another API call to parse dates in the Cover, Swap, and Time-off request types.
3.1	OpenShift_RequestType_v3.1	Enhancement: Supports the upgraded Groovy version of Activiti v2.x.
4	OpenShift_RequestType_v4	Enhancement: Supports open shift incentives based on custom zones.

Cover — Request Type

Version	Process	Description
1	Cover_RequestType_v1	Initial release.
1.1	Cover_RequestType_v1.1	Enhancements: Dynamic extension supports updated status values for request subtypes. Process sends error message to manager and additional recipients. Replaces variable originator reference by using another API call to parse dates in the Cover, Swap, and Time-off request types.
1.2	Cover_RequestType_v1.2	Enhancement: Supports the upgraded Groovy version of Activiti v2.x.

Version

Process

Description

Cover_RequestType_v1

Initial release.

1.1

Cover_RequestType_v1.1

Enhancements:

Dynamic extension supports updated status values for request subtypes.
Process sends error message to manager and additional recipients.
Replaces variable originator reference by using another API call to parse dates in the Cover, Swap, and Time-off request types.

1.2

Cover_RequestType_v1.2

Enhancement:

Supports the upgraded Groovy version of Activiti v2.x.

Swap — Request Type

Version	Process	Description
1	Swap_RequestType_v1	Initial release.
1.1	Swap_RequestType_v1.1	Enhancements: Dynamic extension supports updated status values for request subtypes. Process sends error message to manager and additional recipients. Replaces variable originator reference by using another API call to parse dates in the Cover, Swap, and Time-off request types.
1.2	Swap_RequestType_v1.2	Enhancement: Supports the upgraded Groovy version of Activiti v2.x.

Version

Process

Description

Swap_RequestType_v1

Initial release.

1.1

Swap_RequestType_v1.1

Enhancements:

Dynamic extension supports updated status values for request subtypes.
Process sends error message to manager and additional recipients.
Replaces variable originator reference by using another API call to parse dates in the Cover, Swap, and Time-off request types.

1.2

Swap_RequestType_v1.2

Enhancement:

Supports the upgraded Groovy version of Activiti v2.x.

Time-Off — Request Type

Version	Process	Description
1	TimeOff_RequestType_v1	Initial release.
2	TimeOff__RequestType_v2	Enhancements: Dynamic extension supports updated status values for request subtypes. Process sends error message to manager and additional recipients. Replaces variable originator reference by using another API call to parse dates in the Cover, Swap, and Time-off request types.
2.1	TimeOff__RequestType_v2.1	Enhancement: Supports the upgraded Groovy version of Activiti v2.x.

Version

Process

Description

TimeOff_RequestType_v1

Initial release.

TimeOff__RequestType_v2

Enhancements:

Dynamic extension supports updated status values for request subtypes.
Process sends error message to manager and additional recipients.
Replaces variable originator reference by using another API call to parse dates in the Cover, Swap, and Time-off request types.

2.1

TimeOff__RequestType_v2.1

Enhancement:

Supports the upgraded Groovy version of Activiti v2.x.

Note: The process for configuring and deploying this and other Business Process Extensions is the same as all Business Process models.

Migrate the business process models to the tenant Migrate the Open Shift Pay Incentive Business Process to the customer tenant using Setup Data Manager (SDM) Moves and manages configuration data across software and hardware environments. (SDM Setup Data Manager moves and manages configuration data across software and hardware environments.).
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.
Business processes in the Open Shift Pay Incentive template include:
- OpenShift_RequestType_v4 — 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.2 — 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.2 — 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.1 — 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.

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.

From the Main Menu, go to Administration > Application Setup > Business Process setup > Process Models.
Select the appropriate business process and click tap Edit. The process model enters edit mode.
Select the Decision Tables tab.
Click Tap Everyone's, and then select the appropriate decision table to edit.
Click Tap Decision Table Editor to add or update the rows in the table.
Click Tap Save and close.

Edit the following decision tables:

Caution:

Values entered in the decision tables are case-sensitive, and must match configured values in the application.
Do not remove variables, variable names, or variable types from any decision table.

OpenShift_RequestType_v4_Parameters — Controls open shift pay incentive functionality.

OpenShift_RequestType_v4_Parameters structure
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_v4_InternalParameters — Contains internal open shift parameters that are external to the business and functional requirements.

OpenShift_RequestType_v4_InternalParameters structure
Parameter name	Description	Default value
ApprovedStatus	A semicolon-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_v4_OpenShiftIncentive_Locale — Contains configurable messages to support multiple locales for the open shift request type.

OpenShift_RequestType_v4_OpenShiftIncentive_Locale structure
Parameter 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.

Note:

Localization of business process workflows remains optional, but is supported.
The decision table 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 decision table. Text within tags ("<>") must not be changed.
Names of the parameters in the decision table 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 decision table with the appropriate Locale Policy, and then add the localized values in the Message column.
The last row in the decision table must remain empty ("!=empty".)

OpenShift_RequestType_v4_OpenShiftIncentive_Locale — Sample content — validation types
Key	Description
Error_IncentiveFailure	Failure message content sent when the process fails.
Error_InvalidAmountFormat	Error generated when the amount is formatted incorrectly.
Error_InvalidOpenShiftCommentFixed	Error generated when the open shift fixed incentive comment is not configured in the application.
Error_InvalidOpenShiftCommentWorkRule	Error generated when the work rule comment is not configured in the application.
Error_InvalidPaycode	Error generated when the paycode is not configured in the application.
Error_InvalidPaycodeComment	Error generated when the paycode comment is not configured in the application.
Error_InvalidWorkRule	Error generated when the work rule is not configured in the application.
Message_FailureManager	Failure message content sent to the manager when the incentive is not rewarded for the open shift picked up by the employee.
Message_IncentiveWorkrule	Placeholder value for work rule.
Message_IncentiveWorkRuleQualifier	Placeholder value for work rule qualifier.
Message_successKey	Placeholder value for workflow success; internal use.
Message_StatusFail	Placeholder value for workflow failure.
Message_StatusSuccess	Placeholder value for workflow success.

OpenShift_RequestType_v4_OpenShiftIncentive_Parameters — Holds configurable parameters for open shift functionality.

OpenShift_RequestType_v4_OpenShiftIncentive_Parameters structure
Parameter name	Description	Parameter type	Default value
ParamOpenShiftCommentFixed	Comment that identifies a fixed amount incentive open shift. Caution: Must match the integration parameter Open Shift Comment — Fixed.	String	`Open Shift Incentive — Fixed`
ParamOpenShiftCommentPerHour	Comment that identifies an hourly amount incentive open shift. Caution: Must match the integration parameter Open Shift Comment — Per Hour.	String	`Open Shift Incentive — Per Hour`
ParamOpenShiftCommentWorkRule	Comment that identifies a work rule incentive open shift. Caution: Must match the integration parameter Open Shift Comment — Work Rule.	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. The notification also contains failure reason, when appropriate.	String	`Open Shift workflow notification Informs people to run business processes or integrations, complete forms, or respond to events in business processes. Example: Approve a time-off request. — Manager`
ScheduledIncentivePayCode	Determines where the incentive paycode is added. `Yes` — Added in the schedule. `No` — Added in the Timecard. Caution: This value must match the ScheduledIncentivePayCode parameter value in each of the decision tables.	String	`Yes`
IncentivePayCodeNote	(Optional) Note added to the IncentivePayCodeComment. Enter `NULL` when not used.	String	`NULL`
OpenShiftIncentiveSwitch	Enables the open shift incentive functionality.	String	`Yes`
AllowedWorkRuleSuffixes	Semi-colon-separated list of suffix values from which the process searches when rewarding a work rule transfer incentive. Caution: This value must: match the AllowedWorkRuleSuffixes parameter value in the TimeOff_RequestType_v2_1_OpenShiftIncentive_Parameters decision table. contain suffixes defined in the TierValue column of OpenShiftPayIncentive_iPack_v3_ZonesBasedIncentives_CRT.	String	`_T1;_ T2; _T3;_T4;_T5;_T6;_T9;_Incentive`
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_2_Parameters — Controls open shift pay incentive functionality for cover requests.

Cover_RequestType_v1_2_Parameters structure
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_2_InternalParameters — Contains internal request to cover parameters which are external to the business and functional requirements.

Cover_RequestType_v1_2_InternalParameters structure
Parameter name	Description	Default value
ApprovedStatus	A semicolon-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_2_OpenShiftIncentive_Parameters — Holds configurable parameters for request to cover functionality.

Cover_RequestType_v1_2_OpenShiftIncentive_Parameters structure
Parameter name	Description	Parameter type	Default value
ParamOpenShiftCommentFixed	Comment that identifies a fixed amount incentive open shift. Caution: Must match the integration parameter Open Shift Comment — Fixed.	String	`Open Shift Incentive — Fixed`
ParamOpenShiftCommentPerHour	Comment that identifies an hourly amount incentive open shift. Caution: Must match the integration parameter Open Shift Comment — Per Hour.	String	`Open Shift Incentive — Per Hour`
ParamOpenShiftCommentWorkRule	Comment that identifies a work rule incentive open shift. Caution: Must match the integration parameter Open Shift Comment — Work Rule,	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 where the incentive paycode is added. `Yes` — Added in the schedule. `No` — Added in the Timecard. Caution: This value must match the ScheduledIncentivePayCode parameter value in each of the decision tables.	String	`Yes`

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

Swap_RequestType_v1_2_Parameters structure
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_2_InternalParameters — Contains internal shift swap request parameters which are external to the business and functional requirements.

Swap_RequestType_v1_2_InternalParameters structure
Parameter name	Description	Default value
ApprovedStatus	A semicolon-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_2_OpenShiftIncentive_Parameters — Holds configurable parameters for shift swap request functionality.

Swap_RequestType_v1_2_OpenShiftIncentive_Parameters structure
Parameter name	Description	Parameter type	`Default value`
ParamOpenShiftCommentFixed	Comment that identifies a fixed amount incentive open shift. Caution: Must match the integration parameter Open Shift Comment — Fixed.	String	`Open Shift Incentive — Fixed`
ParamOpenShiftCommentPerHour	Comment that identifies an hourly amount incentive open shift. Caution: Must match the integration parameter Open Shift Comment — Per Hour.	String	`Open Shift Incentive — Per Hour`
ParamOpenShiftCommentWorkRule	Comment that identifies a work rule incentive open shift. Caution: Must match the integration parameter Open Shift Comment — Work Rule.	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 where the incentive paycode is added. `Yes` — Added in the schedule. `No` — Added in the Timecard. Caution: This value must match the ScheduledIncentivePayCode parameter value in each of the decision tables.	String	`Yes`

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

TimeOff_RequestType_v2_1_Parameters structure
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`
StaffingLevelValidationSwitch	The switch parameter that enables the staffing level validation functionality. `Yes` — enables the functionality. `No` — does not enable the functionality.	Boolean	`No`

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

TimeOff_RequestType_v2_1_InternalParameters structure
Parameter name	Description	Default value
ApprovedStatus	A semicolon-separated list of potential open shift state values for a request during an approved scenario.	`Approved`
CancelledStatus	A semicolon-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_1_OpenShiftIncentive_Parameters — Holds configurable parameters for time-off request functionality.

TimeOff_RequestType_v2_1_OpenShiftIncentive_Parameters structure
Parameter name	Description	Parameter type	Default value
ParamOpenShiftCommentFixed	Comment that identifies a fixed amount incentive open shift. Caution: Must match the integration parameter Open Shift Comment — Fixed.	String	`Open Shift Incentive — Fixed`
ParamOpenShiftCommentPerHour	Comment that identifies an hourly amount incentive open shift. Caution: Must match the integration parameter Open Shift Comment — Per Hour.	String	`Open Shift Incentive — Per Hour`
ParamOpenShiftCommentWorkRule	Comment that identifies a work rule incentive open shift. Caution: Must match the integration parameter Open Shift Comment — Work Rule.	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 where the incentive paycode is added. `Yes` — Added in the schedule. `No` — Added in the Timecard. Caution: This value must match the ScheduledIncentivePayCode parameter value in each of the decision tables.	String	`Yes`
AllowedWorkRuleSuffixes	Semi-colon-separated list of suffix values from which the process searches when rewarding a work rule transfer incentive. Caution: This value must: match the AllowedWorkRuleSuffixes parameter value in the OpenShift_RequestType_v4_OpenShiftIncentive_Parameters decision table. contain suffixes defined in the TierValue column of OpenShiftPayIncentive_iPack_v3_ZonesBasedIncentives_CRT.	String	`_T1;_T2;_Incentive`
ManagerNotification	Notification sent to (Reports To) manager when employee receives an incentive shift. The notification also contains failure reason, when appropriate.	String	`Open Shift workflow notification — Manager`

Note:

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 and managers 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.

Deploy the updated process models
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 model. 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 model.
3. Click Tap Edit, and then configure the deployment dates, and required parameters.
  Note: Select Notifications from the Template Categories list.
4. Click Tap Save, and then select Return to deploy.
5. Add the process model to the required process profile. See the Process Profiles setup page topic.
6. Assign the process profile to employees by way of People Information.

Configure the following:

Comment: Create a comment that is attached to the incentive paycode. See the Comments topic.
Example: Adjusted by open shift workflow

Workflow Notifications: Create generic workflow notifications for each request type. During configuration, select Recipient List will be supplied at runtime, Notification Recipient List, and Do not suppress duplicates from Recipients, Business Process will Run as, and Suppress Duplicate Alerts, respectively. See the Configure Notifications for Business Processes topic.

Examples:

Open shift workflow notification — Employee

Name and Subject: Open shift workflow notification — Employee

Long or Short Message: Open shift workflow has been <Approval Status>.

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

Name and Subject: Open shift workflow notification — Employee

Long or Short Message: Open shift workflow has been <Approval Status>.

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>`

Select Trigger Business Process.

Template: OpenShiftRequestType_v4.

Cover workflow notification — Employee

Name and Subject: Cover workflow notification — Employee

Long or Short Message: Cover workflow has been <Approval Status>.

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

Cover workflow notification — Manager

Name and Subject: Cover workflow notification — Manager

Long or Short Message: Cover workflow has been <Approval Status>.

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>`

Select Trigger Business Process.

Template: Cover_RequestType_v1.2.

Cover workflow notification — Recipient

Name and Subject: Cover workflow notification — Recipient

Long or Short Message: Cover workflow has been <Approval Status>.

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>`

Select Trigger Business Process.

Template: Cover_RequestType_v1.2.

Swap shift workflow notification — Employee

Name and Subject: Swap shift workflow notification — Employee

Long or Short Message: Swap shift workflow has been <Approval Status>.

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

Swap shift workflow notification — Manager

Name and Subject: Swap shift workflow notification — Manager

Long or Short Message: Swap shift workflow has been <Approval Status>.

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>`

Select Trigger Business Process.

Template: Swap_RequestType_v1.2.

Swap shift workflow notification — Recipient

Name and Subject: Swap shift workflow notification — Recipient

Long or Short Message: Swap shift workflow has been <Approval Status>.

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

Name and Subject: Time-off workflow notification — Employee

Long or Short Message: Time-off workflow has been <Approval Status>.

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

Select Trigger Business Process.

Template: Time Off_RequestType_v2.1.

Time-off workflow notification — Manager (partial day)

Name and Subject: Time-off workflow notification — Manager

Short Message: Time-off workflow has been <Approval Status>.

Long Message: 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.

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

Open shift incentive failure notification — Manager

Name and Subject: Open Shift incentive failure - Manager

Short Message: Open Shift Incentive workflow has been <Approval Status>.

Long Message: Open Shift Incentive Detail - <Employee Name> Status: <status> <statusMsg>

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

Control center mappings: Create control center notification mappings for all workflow notifications that support open shift pay incentive. After entering an Event Name, select Scheduler and Schedule from Domain and Navigation Page, and then assign an appropriate icon. See the Control Center Notification Mapping topic.
Example selections:
Event Type, select the appropriate value, such as::
Open Shift
Cover
Swap
Time-off.
Notification, select the appropriate value, such as:
Open shift workflow notification — Employee
Open shift workflow 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
Request subtypes: Create Open Shift, Cover, Swap, and Time-Off request subtypes that support the open shift pay incentive process. See the Configure Request Subtypes topic.
Examples:
Open Shift request subtype
Request Type: Open Shift
Employee notification: Open shift workflow notification — Employee
Manager notification: Open shift workflow notification — Manager
(Optional) Select Show Other Employees in Shift Market.
Cover request subtype
Request Type: Cover
Employee (Requester) notification: Cover workflow notification — Employee
Employee (Recipient) notification: Cover workflow notification — Recipient
Manager notification: Cover workflow notification — Manager
(Optional) Recipients of Request Offer: Both
(Optional) Select Show Other Employees in Shift Market.
Swap subtype
Request Type: Swap
Employee (Requester) notification: Swap workflow notification — Employee
Employee (Recipient) notification: Swap workflow notification — Recipient
Manager notification: Swap workflow notification — Manager
(Optional) Select Show Other Employees in Shift Market.
Time-Off request subtype
Request Type: Time-Off
Employee notification: Time-Off workflow notification — Employee
Manager notification: Time-Off workflow notification — Manager
Default Pay Code: Open Shift Incentive
Default Symbolic Amounts Instead of entering a specific amount for a paycode, a symbolic amount lets users enter a value such as full day, which translates to the number of hours in your shift. Other default symbolic amounts include half day, 1st half day, and 2nd half day.: Full day, 1st half day, 2nd half day, Half day
Select Allow Request Editing by Manager.

APIs - Open Shift Pay Incentive business models

API details
API name	Type	Resource path	Description
Retrieve Current User Tenant Locale	GET	/v1/commons/user_preferences/locale_policy?userCurrent=true	Retrieves locale for system user.
Retrieve Comments	GET	/v1/commons/comments	Retrieves all comments in system.
Execute Hyperfind	POST	v1/commons/hyperfind/execute	Counts number of employees in a location.
Retrieve Shifts	POST	v1/scheduling/schedule/multi_read	Retrieves all shift data.
Update Open Shift Comment	POST	v1/scheduling/schedule/shifts/multi_update	Updates open shift with new incentive if not already present or removes incentive.
Retrieve Timecards as Manager	POST	/v1/timekeeping/timecard/multi_read	Retrieves all the process segments and duration.
Time off Multi read	POST	/v1/scheduling/timeoff/multi_read	Retrieves 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	Retrieves 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"	Retrieves a cover shift request by ID.
Retrieve shift request details	POST	/v1/scheduling/schedule/shifts/multi_read	Retrieves shift details.
Retrieve manager swap detail	GET	/v1/scheduling/manager_swap	Retrieves manager swap details.