Religious Holiday Adjustments
The Religious Holiday Adjustments extension increases efficiency and maintains compliance for organizations during religious periods, by eliminating the need for manual adjustments to labor-related activities.
During specific periods of religious holiday observance, organizations make common adjustments to the working hours of employees. This framework handles adjustments automatically.
The Religious Holiday Adjustments integration automatically:
-
Adjusts shift lengths by reducing the duration, using a fixed or specific number of hours.
-
Adjusts breaks by canceling meal breaks or adjusting break times. Night shift employees can be excluded from this action.
-
Initiates overtime, with manager approval, for any hours worked outside of the shift.
-
Initiates overtime paid as hours for any hours worked outside of the shift, and approved by a manager.
For organizations that already use this feature to handle adjustments during the religious observance period, the integration offers the option to apply shift templates.
Employee time-off requests initiate the Religious Holiday Adjustments work flow. This real-time process automatically adjusts the time-off duration to reflect original shift lengths, rather than reduced shift lengths previously adjusted by the integration. When time-off requests are canceled, the work flow restores the reduced 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.
User experience
Employee time-off request
An employee’s regularly scheduled shift is 10a-6p. During the religious period observance, the shift end time is reduced by 2 hours, resulting in an adjusted shift of 10a-4p.
The employee submits a time-off request for a single day. After the approval, the employee observes a paycode edit, with an 8-hour duration, in the timecard. A comment and note attached to the paycode edit identify the business process and the request ID.
Manager runs the integration – individual actions
Before the religious period observance begins, the department’s shift lengths, breaks, and overtime rules must be adjusted.
The manager navigates to the Integrations option in UKG Pro Workforce Management, and then launches Religious Holiday Adjustments. After selecting the appropriate Hyperfind, the manager:
-
Enters the observance period Start and End Dates.
-
Selects Individual Actions from the Adjustment Type drop-down list.
-
Selects appropriate checkboxes from the Choose Actions list.
-
Selects Run Integration.
When the integration completes the adjustments, the timecard contains adjusted shifts and work rule transfers for each employee selected by the Hyperfind. A file, containing all run parameters, is generated for future reference.
Manager runs the integration – shift template
Alternatively, managers who create shift templates containing adjusted shift lengths, breaks, and overtime rules, can run the same integration by selecting Shift Template from the Adjustment Type dropdown.
Religious Holiday Adjustments integration
Before you start — Religious Holiday Adjustments integration
Before you configure the Religious Holiday Adjustments integration, you must do the following:
- Configure the following:
-
Comments: Create a comment, such as
Adjusted by Religious Holiday Adjustments
. The shifts category must be selected during configuration. This comment must be used exclusively by the Religious Holiday Adjustments integration. See the Comments topic. -
Integration list parameters: Configure integration list parameters to define
ReligiousHolidayAdjustmentsAction
andReligiousHolidayAdjustmentsAdjustType
. See the Configure Integration List Parameters topic.Examples:
Name=
ReligiousHolidayAdjustmentsAdjustType
Parameter values:
Parameter values
Name
Value
Individual Action(s)
Individual Action(s)
Shift Template
Shift Template (default value)
Name=
ReligiousHolidayAdjustmentsAction
Parameter Values:
Parameter Values
Name
Description
Value
Adjust Breaks
Updating the scheduled shifts with an override workrule having no break deductions. This rule does not apply for night shifts qualified as per CRT.
Adjust Breaks
Adjust Shift Length
Shortening the scheduled shifts based on the shortening values configured in CRT.
Adjust Shift Length
Initiate Overtime Approval
Updating the scheduled shifts with an override workrule requiring overtime approvals.
Initiate Overtime Approval
Initiate Overtime Paid as Hours
Updating the scheduled shifts with an override workrule with overtime being paid as compensatory hours instead of monetary bonus.
Initiate Overtime Paid as Hours
Caution:Make sure that the Parameter Values used to configure
ReligiousHolidayAdjustmentsAction
match content entered in:-
the Action column when defining override work rules in ReligiousHolidayAdjustments_iPack_v2_OverrideWorkRule_CRT.
-
the Message column when defining the following labels in ReligiousHolidayAdjustments_iPack_v2_Locale_CRT:
-
Label_AdjustmentTypeAdjustBreaks
-
Label_AdjustmentTypeAdjustShiftLength
-
Label_AdjustmentTypeInitiateOvertimeApproval
-
Label_AdjustmentTypeInitiateOvertimePaidAsHours
-
Note: When updating the integration list parameters, detach the integration list parameters from , and then reattach them after completing the updates. -
-
Get the URL, User, and Password for the APIGatewayServer.
Configure the Religious Holiday Adjustments integration
- Deploy the Religious Holiday Adjustments integration
Note: For more information, see the Deploy Integration Packs to your Atom topic.
-
Open the Integration Template Designer: Select Main Menu
. Note: If prompted, enter your Username and Password. Click Tap Log in. -
Make sure that the Account is correct. If not, select the right account.
- Select the Deploy tab > Integration Packs.
- From the list in the left column, search for and select the Pro WFM Religious Holiday Adjustments Extension integration. Note: If the integration does not display, select Browse Integration Packs to search for and select the iPack.
-
Click Tap Install.
-
From Unattached Environments, select the environment in which to deploy the integration process for the selected integration. Click Tap the double-left arrows button
.
-
- Configure the Religious Holiday Adjustments integration settings
- Select the environment
- Select the Manage tab > Atom Management.
- Select your environment.
- Select environment extensions
- In Administration, click tap Environment Extensions.
- In Process Filter, click tap the magnifying glass
. It can take several seconds before the button becomes active. - Scroll to and select the integration pack: .
- Select the environment
- 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 dropdown list, select and configure the following:
Connection Settings
Connection Settings for the integration
Setting
Required
Actions
ReligiousHolidayAdjustments_iPack_v2_APIGatewayServer
Required
To change the default API gateway server:
- Clear Use Default.
- Enter the URL to the server.
Example:
<tenantURL>/api
ReligiousHolidayAdjustments_iPack_v2_SFTPServer
Required
The SFTP server setting defines the connection to the file that contains the records. Integrations access only the internal SFTP account.
To change the default SFTP server parameters:
- For each field, clear Use Default.
- Enter the following values:
-
Enter the name of the internal Host.
-
Enter the number of the Port for the internal SFTP account.
-
In User, enter the username for the internal SFTP account.
-
In Password, select <Encrypted>. Enter the new password for the internal SFTP account.
-
Click Tap Apply.
-
ReligiousHolidayAdjustments_iPack_v2_AdjustShift_CRT
Required
Enable Override.
ReligiousHolidayAdjustments_iPack_v2_OverrideTemplate_CRT
Required
Enable Override.
ReligiousHolidayAdjustments_iPack_v2_NightShift_CRT
Required
Enable Override.
ReligiousHolidayAdjustments_iPack_v2_OverrideWorkRule_CRT
Required
Enable Override.
ReligiousHolidayAdjustments_iPack_v2_Locale_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 ReligiousHolidayAdjustments_iPack_v2_CRTConfig to set process properties that must be configured before the integration can run. This main process starts the integration process and handles errors.
Process properties
Process properties
Process property name
Column header value
_ReligiousHolidayAdjustments_iPack_v2_AdjustShift_CRT
Person Number,EmploymentTerm,Payrule,Location,ShorteningType,Value,MinimumShift
_ReligiousHolidayAdjustments_iPack_v2_OverrideTemplate_CRT
Person Number,EmploymentTerm,Payrule,Location,Original Shift Template,Ramadan Shift Template
_ReligiousHolidayAdjustments_iPack_v2_NightShift_CRT
Location,NightZoneStartTime,NightZoneEndTime,%Of ShiftFallingInNightZone
_ReligiousHolidayAdjustments_iPack_v2_OverrideWorkRule_CRT
Action,Override Workrule Suffix
_ReligiousHolidayAdjustments_iPack_v2_Locale_CRT
Parameter Name,Locale Policy,Message Description
- Select Process Properties.
- 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 the ReligiousHolidayAdjustments_iPack_v2 table.
-
Select Override, which allows you to:
- Download the tables when you run the integration
- Edit the table cells in Extensions
- When you finish, click tap OK.
- Repeat the steps for each of the ReligiousHolidayAdjustments tables.
- ReligiousHolidayAdjustments_iPack_v2_AdjustShift_CRT— Identifies how a shift is adjusted based on prioritized parameters that an employee must match.
Religious Holiday Adjustments — Adjust Shift CRT structure
Religious Holiday Adjustments — Adjust Shift CRT structure
Column name
Description
Person Number
Person number for whom the time-off request duration will be modified.
EmploymentTerm
The employment term for which the shift will be shortened.
Payrule
The pay rule for which the shift will be shortened.
Location
The location for which the shift will be shortened.
ShorteningType
Identifies how the shift is shortened, such as
Fixed
orReduceBy
.Note:When ShorteningType=
Fixed
:-
If the shift length is less than or equal to the length in the Value column, no action is performed.
-
If the shift length is greater than the length in the Value column, the shift length is shortened to match the Value column.
When ShorteningType=
ReduceBy
:-
If the shift length is less than or equal to the length in the MinimumShift column, no action is performed.
-
If the shift length is greater than the length in the MinimumShift column, the shift length is shortened by Value. This ensures that the minimum shift adheres to the MinimumShift value.
Value
Contains the amount by which the shift will be shortened.
MinimumShift
Minimum shift length.
Note:- All shift adjustments are performed using the end time of the original shift.
-
The integration utilizes the first non-empty lookup column in AdjustShift_CRT. Columns are prioritized in the following order:
-
PersonNumber
-
EmploymentTerm
-
Payrule
-
Location
-
-
When an employment term is assigned to an employee, the pay rule assigned to the employment term is always given priority.
-
Wildcard entries must be located at the bottom of the AdjustShift_CRT.
-
- ReligiousHolidayAdjustments_iPack_v2_OverrideTemplate_CRT— Identifies which shift template is used for the holiday period based on prioritized parameters that an employee must match.
Religious Holiday Adjustments — Override Template CRT structure
Religious Holiday Adjustments — Override Template CRT structure
Column name
Description
PersonNumber
Person number for whom the time-off request duration will be modified.
EmploymentTerm
The employment term for which the shift will be shortened.
Payrule
The pay rule for which the shift will be shortened.
Location
The location for which the shift will be shortened.
OriginalShiftTemplate
Identifies the original shift template for which the holiday shift template override applies.
RamadanShiftTemplate
Contains the holiday shift template override.
Note:-
The integration utilizes the first non-empty lookup column in OverrideTemplate_CRT. Columns are prioritized in the following order:
-
PersonNumber
-
EmploymentTerm
-
Payrule
-
Location
-
-
When an employment term is assigned to an employee, the pay rule assigned to the employment term is always given priority.
-
Wildcard entries must be located at the bottom of the OverrideTemplate_CRT.
-
- ReligiousHolidayAdjustments_iPack_v2_NightShift_CRT— Identifies whether a night-shift employee is excluded from break adjustments by mapping the percentage of shift hours that must fall within the location's night shift time span.
Religious Holiday Adjustments — Night Shift CRT structure
Religious Holiday Adjustments — Night Shift CRT structure
Column name
Description
PersonNumber
Person number for whom the time-off request duration will be modified.
NightZoneStartTime
Identifies the start time of the night shift.
Caution:Must be entered using 12-hour format (
HH:mma
).NightZoneEndTime
Identifies the end time of the night shift.
Caution:Must be entered using 12-hour format (
HH:mma
).%OfShiftFallingInNightZone
Identifies the percentage of a shift's hours that must fall between the NightZoneStartTime and NightZoneEndTime.
Note: Wildcard entries must be located at the bottom of the NightShift_CRT. - ReligiousHolidayAdjustments_iPack_v2_OverrideWorkRule_CRT— Identifies which suffix to use when searching for the work rule override defined in the system.
Religious Holiday Adjustments — Override Work Rule structure
Religious Holiday Adjustments — Override Work Rule structure
Column name
Description
Action
Semicolon-separated actions performed by the integration.
Caution:Action column entries must match Names configured in the
ReligiousHolidayAdjustmentsAction
Integration list parameters. For example,-
Adjust Breaks
-
Initiate Overtime Approval
-
Initiate Overtime Paid as Hours
-
Adjust Breaks;Initiate Overtime Approval
-
Adjust Breaks;Initiate Overtime Paid as Hours
-
Adjust Breaks;Initiate Overtime Approval;Initiate Overtime Paid as Hours
OverrideWorkruleSuffix
Identifies the suffix assigned to work rules defined in the system.
Caution: The work rule must be configured in the system.Note:-
When the integration parameter ExcludeNightShift=
true
and the CRT's Action parameter contains Adjust Breaks, the integration checks whether the employee's shift qualifies as a night shift:-
If yes, the integration selects an OverrideWorkruleSuffix that excludes the Adjust Breaks action.
-
If no, the integration selects an OverrideWorkrule Suffix that includes the Adjust Breaks action.
-
-
- ReligiousHolidayAdjustments_iPack_v2_Locale_CRT— Allows translation of messages and labels into different languages.
Religious Holiday Adjustments — Locale CRT structure
Religious Holiday Adjustments — Locale CRT structure
Column name
Description
Parameter Name
Key for which localization is defined.
Locale Policy
Locale Policy.
You can use an asterisk (
*
) as a wildcard, but put the less-restrictive locale policy names at the bottom of the table because the integration scans cross-reference tables from the top.Message
Message shown in Additional Details, or value of the label defined in the Run Summary section.
Example:
Comment was not provided.
Description
The description that is shown in Additional Details.
Example:
The employee is not assigned a shift.
Note:-
Localization of integration extensions remains optional, but is supported.
-
The cross-reference table (CRT) holds all messages represented with standard English labels; these apply to all locales when the Locale is set to a wildcard (*).
-
Some or all messages can be translated by adding lines to the table in their preferred translation for specific locales. Messages for the most commonly used Locale Policy should be defined at the top of the CRT.
-
Names of the parameters in the CRT column "Parameter Name" must be used as is. If any parameter value needs to be localized for a different Locale Policy, copy the "Parameter Name" with the * Locale Policy, add a new row to the CRT with the appropriate Locale Policy, and then add the localized values in the Message (or Value) and Description CRT columns.
-
Do not enter values in the CRT column "Description" if it is blank.
-
Do not modify placeholders (<>) or the configurable values that are included in the CRT column "Message" (or "Value").
Sample Locale CRT content
Sample Locale CRT content
Parameter Name
Locale Policy
Message
Description
Error_BlankComment
*
Comment must be configured.
Error_BlankEndDate
*
End Date must be configured.
Error_BlankOutputDirectory
*
Output Directory must be configured.
Error_InvalidCommentCategory
*
Comment is not configured with the shifts category.
Error_StartEndDateError
*
Start Date must be earlier than End Date.
Label_AdjustmentType
*
Adjustment Type
Label_AdjustmentTypeAdjustBreaks
*
Adjust Breaks
Label_AdjustmentTypeAdjustShiftLength
*
Adjust Shift Length
Label_AdjustmentTypeInitiateOvertimeApproval
*
Initiate Overtime Approval
Label_AdjustmentTypeInitiateOvertimePaidAsHours
*
Initiate Overtime Paid as Hours
Label_BoomiExecutionId
*
Integration Execution ID
Label_ChooseAction(s)
*
Choose Action(s)
Label_Comment
*
Comment
Label_CommentNote
*
Comment Note
Label_DurationFormat
*
Duration Format
Label_EndDate
*
End Date
Label_ExcludeNightShift
*
Exclude Night Shift
Label_FileName
*
FileName
Label_Hyperfind
*
Hyperfind\Location
Label_IndividualEmployeeID
*
PersonNumber
Label_IntegrationType
*
Integration Type
Label_Locale
*
Locale
Label_OutputDirectory
*
OutputDirectory
Label_ProcessedEmployees
*
Processed Employees
Label_StartDate
*
Start Date
Label_UpdatedShifts
*
Updated Shifts
Message_BlankStartDate
*
Start date must be completed.
Message_InvalidComment
*
Comment '<Comment Name>' not found.
Message_InvalidCommentNoteLength
*
Comment Note cannot exceed 250 characters.
Message_InvalidDurationFormat
*
Invalid shift duration format.
Message_InvalidDurationFormatData
*
Invalid duration format configured.
Message_InvalidPersonNumber
*
Invalid Person Number.
PersonNumber '<Person Number>' does not exist in the system.
Message_InvalidWorkruleSuffixInCRT
*
Invalid work rule.
Work rule '<Work rule>' does not exist in the system.
Message_ValidateChooseAction(s)
*
Select at least one Action.
Message_ValidateCRTShiftLength
*
Adjust Shift Length is not configured.
Corresponding shift length is not configured in CRT for Date '<Shift Date>'.
Message_ValidateDateRange
*
Date range cannot exceed 365 days.
Message_ValidateOriginalShiftLabel
*
Shift label is not configured.
Shift label is not configured for Date '<Shift Date>'.
Message_ValidateOriginalShiftTemplate
*
Invalid Shift Label.
Shift Label '<Shift Label>' is not a valid shift template for Date '<Shift Date>.
Message_ValidateOverrideShiftLabel
*
Shift Template is not configured in CRT.
Corresponding shift template is not configured in CRT for '<Shift Template>' and Date '<Shift Date>'.
Message_ValidateOverrideShiftTemplate
*
Invalid Shift Template.
Shift Template '<Shift Template>' does not exist in the system for Date '<Shift Date>'.
Message_ValidateShiftTemplate
*
Choose Action(s) cannot be selected when the Adjustment Type is a shift template.
Message_WithErrors
*
Integration completed with errors.
Message_WithZeroProcessedEmployees
*
Integration completed with errors. No employees processed.
Message_WithoutErrors
*
Integration completed without errors.
Caution:When defining the following labels, make sure that the Message content matches the corresponding Parameter Values in the
ReligiousHolidayAdjustmentsAction
Integration List Parameter:-
Label_AdjustmentTypeAdjustBreaks
-
Label_AdjustmentTypeAdjustShiftLength
-
Label_AdjustmentTypeInitiateOvertimeApproval
-
Label_AdjustmentTypeInitiateOvertimePaidAsHours
-
- ReligiousHolidayAdjustments_iPack_v2_AdjustShift_CRT— Identifies how a shift is adjusted based on prioritized parameters that an employee must match.
Install the Religious Holiday Adjustments 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.
-
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
. -
Click Tap
Create
. - In
Integration Name enter a unique name, such as
ReligiousHolidayAdjustments_iPack_v2
. - (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)
- Select Yes to send email and control center notifications for integration runs.
- 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 ReligiousHolidayAdjustments_iPack_v2.
-
Click Tap
Assign
. - In Integration Parameters, you can override default settings.
- Complete the configuration for each integration control parameter value.
-
Click Tap Save.
Repeat this step for each integration control parameter that supports the Religious Holiday Adjustments process.
Integration Parameters
Hours and Dollars Allocation - Control Properties
Parameter name
Description / Default value / User prompt
Template parameter
Parameter type
Hyperfind And Location
The default Hyperfind or Location query that contains the active employees for whom the integration is run.
User prompt = Yes
Mandatory = Yes
HyperfindAndLocation
Hyperfind
Employee IDs
A comma-separated list of specific employees for whom the integration is run.
When no value is entered, the integration defaults to the Hyperfind And Location parameter.
To process the integration for only a limited group of employees, enter the person numbers as defined in the source system, each separated by a comma (,) but not spaces.
User prompt = Yes
Mandatory = Yes
EmployeeIDs
Text
Start Date
Start date of the religious holiday.
User prompt = Yes
Mandatory = Yes
StartDate
Date
End Date
End date of the religious holiday.
User prompt = Yes
Mandatory = Yes
EndDate
Date
Comment
Comment added to the schedule rule transfer.
User prompt = No
Mandatory = Yes
Comment
Text
Comment Note
Note added to the schedule rule transfer.
User prompt = No
Mandatory = Yes
CommentNote
Text
Choose Action(s)
A limited list of actions that are performed on scheduled shifts.
User prompt = Yes
Mandatory = Yes
Caution:Choose Action(s) values must match:
-
Parameters selected during configuration of Integration List Parameters.
-
Labels configured in the Locale_CRT.
ChooseAction(s)
List
Adjustment Type
Drop-down list containing adjustment types.
Supported values include:
Individual Action(s)
Shift template
User prompt = Yes
Mandatory = Yes
AdjustmentType
Dropdown
Exclude NightShift
Determines whether the Adjust Breaks action is performed on night shifts.
Default =
false
User prompt = Yes
Mandatory = Yes
ExcludeNightShift
Boolean
Output Directory
SFTP directory path to which the religious holiday adjustments file is exported.
Default =
/Outbound
User prompt = No
Mandatory = Yes
OutputDirectory
Text
FileName
Output file name.
FileName
Text
Duration Format
Shift duration format used in CRTs.
Default =
HH:mm
User prompt = No
Mandatory = Yes
DurationFormat
Text
-
- Make sure that the generic data access profiles (GDAP) allow access by the people who need to run the installed integrations.
Run and test the Religious Holiday Adjustments integration
Run integrations to test that the configuration is set up correctly.
- Run the integration
- Select the integration:
- Select
Main Menu
. -
Click Tap
Run an Integration
. - Select the ReligiousHolidayAdjustments_iPack_v2 integration from the list. Click Tap Select.
- (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.
- Select
Main Menu
-
Set parameters as follows:
- Hyperfind And Location: Select a Hyperfind query of employees.
-
Employee IDs: To process data for only a limited group of employees, enter the person numbers, as defined in the source system, each separated by a comma, but no spaces.
For 3 employees:
13997,15556,20012
- Start Date: Specify the start date of the religious holiday period.
- End Date: Specify the end date of the religious holiday period.
- Choose Action(s): Select the actions that will be performed on the scheduled shift.
- Adjustment Type: Select checkbox-based options.
- Exclude NightShift: Specify whether night shifts are excluded from the break adjust action.
-
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.
- Wait for the confirmation that the integration completed or failed. Close the panel.
-
Click Tap
Refresh
. - To see details, select the integration run. Select Run Summary.
- Select the integration:
- 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:
- Click Tap the tile for the integration run.
-
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.
- 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 - Religious Holiday Adjustments integration
API name |
Type |
Resource path |
Description |
---|---|---|---|
GET |
/v1/commons/comments |
Retrieve a filtered list of comments. | |
POST |
/v1/commons/hyperfind/execute |
Execute Hyperfind by ID or qualifier and return the results. | |
GET |
/v1/commons/user_preferences/locale_policy |
Retrieve locale for user or tenant. | |
GET |
/v1/platform/integration_executions |
Retrieve details of on-demand and scheduled integration runs. | |
POST |
/v1/platform/integrations/update_status |
Submit integration execution details. | |
GET |
/v1/timekeeping/setup/full_work_rules |
Retrieve all work rules. | |
POST |
/v1/scheduling/shift_templates/multi_read |
Retrieve all shift templates. | |
POST |
/v1/commons/persons/extensions/multi_read |
Retrieve multiple person records based on search criteria. | |
POST |
/v1/scheduling/schedule/multi_read |
Retrieve employee schedule data. | |
GET |
/v1/commons/hyperfind/{id} |
Retrieve Hyperfind by ID. | |
GET |
/v1/commons/locations/{id} |
Retrieve location by ID. | |
POST |
/v1/scheduling/schedule/shifts/multi_update |
Update multiple shifts. |
Religious Holiday Adjustments business process
Before you start — Religious Holiday Adjustments business process
Before you configure the Religious Holiday Adjustments process model, you must configure the following:
-
Comments: Create a comment, such as
Adjusted by Religious Holiday Adjustments Paycode
. The pay codes category must be selected during configuration. This comment must be used exclusively by the Religious Holiday Adjustments workflow. See the Comments topic. -
Workflow notifications: Configure generic workflow notifications to support the Religious Holiday Adjustments business process. See the Configure Notifications for Business Processes topic.
Workflow notification examples include:
Name:
Religious Holiday Adjustments Error
.Subject:
Religious Holiday Adjustments Error
Long Message: <
Message1
> <Error
>Select Recipient List will be supplied at runtime and Send to Employee.
Control center fields
Control center fields
Field
Label
Value
1
Message
<Message1>
2
Error
<Error>
Name:
Religious Holiday Adjustments Employee Notification
.Subject:
Religious Holiday Adjustments Employee Notification
Long Message:
Religious Holiday Adjustments Employee Notification
Select Recipient List will be supplied at runtime.
Select Trigger Business Process.
Template: ReligiousHolidayAdjustments_v1.1
Business Process will run as: System User
Select Do not suppress duplicates.
- Control center notification mapping: Configure Control center notification mapping to support the Religious Holiday Adjustments business process.
See the Control Center Notification Mapping topic.
Event Name:
Religious Holiday Adjustments Notification
.Domain: Scheduler
Long Message:
Religious Holiday Adjustments Employee Notification
Event Type: Time Off
Notification:
Religious Holiday Adjustments Notification
.Template: ReligiousHolidayAdjustments_v1.1
Navigation Page: Schedule
Select the appropriate Icon.
- Request subtype: Configure the time-off request subtype to initiate the business process. Select the previously created employee notification, and then configure remaining fields as needed.
See the Configure Request Subtypes topic.
Configure the Religious Holiday Adjustments business process
- Migrate the Religious Holiday Adjustments business process model to the tenant Migrate the Religious Holiday Adjustments process model to the customer tenant using Setup Data Manager (SDM).
-
Log in to the appropriate tenant.
-
Go to Main Menu > Administration > Setup Data Manager.
-
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.
-
Click Tap Review and Publish. The Publish Summary panel appears.
-
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.
-
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.
-
To view details, click tap the appropriate row and click tap View Selected.
-
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 Religious Holiday Adjustments decision tables
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.
-
Go to Main Menu > Administration > Application Setup > Business Process setup > Process Models.
-
Select the ReligiousHolidayAdjustments_v1.1 process and click tap Edit. The process model enters edit mode.
-
Select the Decision Tables tab.
-
Click Tap Everyone's, and then select the 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.
- ReligiousHolidayAdjustments_v1_1_Variables— holds process parameters.
Religious Holiday Adjustments — Variables decision table structure
Religious Holiday Adjustments Variables decision table structure
Variable name
Description
StartDate
Religious holiday start date.
EndDate
Religious holiday end date.
DateFormat
Start and end dates format.
Default =
yyyy-MM-dd
ShiftComment
Comment added to shift by integration.
Default =
Adjusted by Religious Holiday Adjustments
PaycodeComment
Comment added to paycode edit by integration.
Default =
Adjusted by Religious Holiday Adjustments Paycode
PaycodeCommen Note
Note added to paycode edit by integration.
Default =
#requestId#
Caution: #requestId# is a mandatory tag used by cancellation requests.Locale
Locale used to display error.
Default =
English
ErrorNotification
Notification name that is initiated on error.
Default =
Religious Holiday Adjustments error
Admin
Internal user; do not change.
Default =
SERVICES-LEVEL3
DurationFormat
Duration format used in the Time Off Type decision table.
Default =
HH:mm
ApprovedStatus
Comma-separated list of system status names representing approved time-off requests.
Default =
Approved
CancelledStatus
Comma-separated list of system status names representing canceled time-off requests.
Default =
CancelApproved,Cancelled
- ReligiousHolidayAdjustments_v1_1_TimeOffType— holds parameter values that modify time-off request durations.
Religious Holiday Adjustments — Time-off Type decision table structure
Religious Holiday Adjustments Time-off Type decision table structure
Variable name
Description
Person Number
Person number for whom the time-off request duration will be modified.
Employment Term
Employment term for which the time-off request duration will be modified.
Payrule
Pay rule for which the time-off request duration will be modified.
Location
Location for which the time-off request duration will be modified.
TimeOffType
Indicates the type of time off, such as
Fixed
,Original Shift
, orNo Adjustments
.Note:The TimeOffType value determines the paycode edit made by the time-off request. For example, when the TimeOffType value contains:
-
Fixed
-
Original Shift
-
No adjustments
Full Day Value
Contains the full day value duration.
Note:-
The business process utilizes the first non-empty lookup column in the _TimeOffType decision table. Columns are prioritized in the following order:
- PersonNumber
- EmploymentTerm
- Payrule
- Location
-
When an employment term is assigned to an employee, the pay rule assigned to the employment term is always given priority.
-
Wildcard entries are not allowed.
-
- ReligiousHolidayAdjustments_v1_1_Locale— allows translation of business process messages into different languages.
Religious Holiday Adjustments — Locale decision table structure
Religious Holiday Adjustments — Locale decision table structure
Variable name
Description
Default value
Locale Parameter Name
Internal name that identifies a message.
Locale Policy
Locale policy.
!=empty
Message
Message shown as the result of a processing error.
Note:- Localization of business process workflows remains optional, but is supported.
- You can translate some or all messages by adding lines to the table in their preferred translation for specific locales. Decision tables are scanned from top to bottom; therefore, place messages for the most commonly used Locale Policy at the top of the decision table and less-restrictive locale policies at the bottom.
- Text within tags ("<>") must not be changed.
- The decision table holds all messages represented with standard English labels; these apply to all locales when the Locale Policy is set to !=empty.
- 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 !=empty Locale Policy, add a new row to the decision table with the appropriate Locale Policy, and then add the localized value in the Message column.
- Decision tables support operators like "Contains," "Starts with," "Ends with," and "Is Not Empty." You can achieve your preferred results by following these examples:
- To match any non-empty or any string (like *), use the "Is Not Empty" operator.
- To match a string starting with "ABC" (like "ABC*"), use the "Starts with" operator and set the value to "ABC".
- To match a string containing "English" as substring, use the "Contains" operator with the value "English".
- The last row in the decision table must remain empty ("!=empty".)
Sample Locale content
Sample Locale content
Parameter name
Locale Policy
Message
_Message
!=empty
Contact the system administrator.
_MessageAPIError
!=empty
API Error: #APIError#
_MessageBlankDateFormat
!=empty
Date format cannot be blank.
_MessageBlankEndDate
!=empty
End date cannot be blank.
_MessageBlankPaycodeComment
!=empty
Paycode comment cannot be blank.
_MessageBlankPaycodeCommentNote
!=empty
Paycode comment note cannot be blank.
_MessageBlankShiftComment
!=empty
Shift comment cannot be blank.
_MessageBlankStartDate
!=empty
Start date cannot be blank.
_MessageInvalidDurationFormat
!=empty
Invalid shift duration format.
_MessageScriptError
!=empty
Script failure in #error_Component# Script Task in Line Number #error_line#. Error Message: #error_message#
-
-
- Deploy the updated Religious Holiday Adjustments business 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 model. For detailed information, see the online help topic Deploy Business Process Models .
-
Go to Main Menu > Administration > Application Setup > Business Process Setup > Process Models.
-
Select the ReligiousHolidayAdjustments_v1_1 model.
-
Click Tap Edit, and then configure the required parameters and deployment dates. Select Notification Templates from the Template Categories list.
-
Click Tap Save, and then select Return to deploy.
-
APIs — Religious Holiday Adjustments business process
API name |
Type |
Resource path |
Description |
---|---|---|---|
GET |
/v1/scheduling/employee_timeoff/{timeOffRequestId} |
Retrieve time-off request from status and time. | |
POST |
/v1/scheduling/schedule/multi_read |
Retrieve paycode edits from the schedule. | |
Bulk Delete Paycode Edits |
POST |
/v1/scheduling/schedule/pay_code_edits/multi_delete |
Delete paycode edit using paycode edit ID. |
POST |
/v1/scheduling/audits/multi_read |
Retrieve employee schedule audit. | |
POST |
/v1/commons/persons/extensions/multi_read |
Retrieve employee information. | |
POST |
/v1/scheduling/schedule/pay_code_edits/multi_update |
Update paycode edit. |
Output file
Output file specifications
- File name:
<FileNameCurrentDate.csv>
- File extension:
.csv
- Format: Comma-delimited
- Frequency: On-demand or scheduled
- Header row: Yes, 1 row
- Footer row: No
- Output folder:
/Outbound
Field |
Comments or examples |
---|---|
Hyperfind\Location |
Hyperfind or location selected to run the integration. |
PersonNumber |
The employee ID selected to run the integration. |
Start Date |
The start date of the integration run. |
End Date |
The end date of the integration run. |
Comment |
The comment added to the schedule adjustment. |
Comment Note |
The note added to the schedule adjustment. |
Locale |
The locale assigned to person who ran the integration. |
Choose Action(s) |
The actions applicable to the integration run. |
Adjustment Type |
The adjustment type used by the integration. |
Exclude Night Shift |
The exclude night shift option used by the integration. |
Output Directory |
The output directory where the integration created the file. |
FileName |
The filename assigned to the integration run. |
Duration Format |
The duration format used by the integration run. |
Version history
Version |
Description |
---|---|
1 |
Initial release. |
iPack_v2 |
The Religious Holiday Adjustment integration delivery is now by way of an iPack. |
Version |
Description |
---|---|
1 |
Initial release. |
1.1 |
The approved time-off request is updated according to the time-off type configured in the decision table. |