Religious Holiday Adjustments

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

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.

Workflow notification configuration

Configure workflow notifications to support the Religious Holiday Adjustments business process.

See the Configure Notifications for Business Processes topic.

  1. Go to Application Setup > Event/Notification > Workflow Notifications.

  2. Click Tap New.

  3. From the Notification Type, select Generic notification.

  4. Click Tap Ok.

  5. Complete the configuration for the workflow notification to support the business process.

  6. Click Tap Save.

Religious Holiday Adjustments Error

  • Name: Enter an appropriate name, such as Religious Holiday Adjustments Error.

  • Subject: Enter an appropriate subject, such as Religious Holiday Adjustments Error.

  • Long Message: Enter an appropriate long message, such as <Message1> <Error>.

  • Recipients: Select Recipient List will be supplied at runtime and Send to Employee.

  • Suppress Duplicate Alerts: Select Do not suppress duplicates.

  • Control center fields:
Field Label Value
1 Message <Message1>
2 Error <Error>

Religious Holiday Adjustments Employee Notification

  • Name: Enter an appropriate name, such as Religious Holiday Adjustments Employee Notification.

  • Subject: Enter an appropriate subject, such as Religious Holiday Adjustments Employee Notification.

  • Long Message: Enter an appropriate long message, such as Religious Holiday Adjustments Employee Notification.

  • Recipients: Select Recipient List will be supplied at runtime.

  • Trigger Business Process: Select checkbox.

  • Template: ReligiousHolidayAdjustments

  • Business Process will run as: System User

  • Suppress Duplicate Alerts: Select Do not suppress duplicates.

Control center notification mapping configuration

Configure Control center notification mapping to support the Religious Holiday Adjustments business process.

See the Control Center Notification Mapping topic.

  1. Go to Application Setup > Event/Notification > Control Center Notification Mapping.

  2. Click Tap Create.

  3. Enter Event Name, such as Religious Holiday Adjustments Notification.

  4. From Domain, select Scheduler.

  5. From Event Type, select Time Off.

  6. From Notification, select Religious Holiday Adjustments Employee Notification.

  7. From Navigation Page, select Schedule.

  8. From Icon, select the appropriate icon.

  9. Click Tap Save.

Comments

See the Comments topic.

  1. Go to Main Menu > Administration > Application Setup > Common Setup > Comments.

  2. Click Tap New.

  3. Enter Comment Text, such as Adjusted by Religious Holiday Adjustments Process.

  4. In the Categories area, select Pay Codes from the Available Categories box and move it to the Selected Categories box.

  5. Click Tap Save.

Request subtype

Configure the request subtype to initiate the business process.

See the Configure Request Subtypes topic.

  1. Go to Application Setup > Employee Self Service > Request Subtype.

  2. Edit, or create a new Time-off Request Subtype for use with Religious Holiday Adjustments.

  3. From Request Type, select Time-Off.

  4. From Employee Notification, select an option such as Religious Holiday Adjustments Employee Notification.

  5. Configure remaining fields as needed.

  6. Click Tap Save.

Migrate the business process model to the tenant

Migrate the ReligiousHolidayAdjustments_v1.1 process model to the customer tenant using Setup Data Manager (SDM).

  1. Log in to the appropriate tenant.

  2. Go to Main Menu > Administration > Setup Data Manager.

  3. Select the Source tenant where the Process Model resides, and select the template to copy. It is a .zip file. A message appears in the Source column: Source: Import from <filename>.zip.

  4. Click Tap Review and Publish. The Publish Summary panel appears.

  5. Review the Publish Summary panel. It lists the items that were extracted from the migration file. If you approve, click tap Publish with Comment or just Publish.

  6. Click Tap Go to Publish History at the bottom of the panel to view the status of the data transfer. The Publish History page contains a table that lists the items you have published. If there were errors during the transfer, the button under the Errors column for that row is black.

  7. To view details, click tap the appropriate row and click tap View Selected.

  8. On the History for publish run page, click tap Show all to view the setup data that you published, and the errors that occurred, if any, listed by item type and name.

Configure the decision tables

Configure the Religious Holiday Adjustments decision tables.

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

  2. Select the ReligiousHolidayAdjustments_v1.1 process and click Edit. The process model enters edit mode.

  3. Select the Decision Tables tab.

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

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

  6. Click Save and close.

Edit the decision table: ReligiousHolidayAdjustments_v1_1_Variables

The ReligiousHolidayAdjustments_v1_1_Variables decision table holds process parameters.

Religious Holiday Adjustments Variables decision table
Variable name Description Default value
Start Date Religious holiday start date.  
End Date Religious holiday end date.  
Date Format Start and end dates format. yyyy-MM-dd
Shift Comment Comment added to shift by integration. Adjusted by Religious Holiday Adjustments
Paycode Comment Comment added to paycode edit by integration. Adjusted by Religious Holiday Adjustments
Paycode Comment Note

Note added to paycode edit by integration.

#requestId# is a mandatory tag used by cancellation requests.

 #requestId#
Locale Locale used to display error. English
Error Notification Notification name that is initiated on error. Religious Holiday Adjustments error
Admin Internal user; do not change. SERVICES-LEVEL1
Duration Format Duration format used in the Time Off Type decision table. HH:mm
Approved Status Comma-separated list of system status names representing approved time-off requests. Approved
Canceled Status Comma-separated list of system status names representing canceled time-off requests. CancelApproved,Canceled

Edit the decision table: ReligiousHolidayAdjustments_v1_1_TimeOffType

The ReligiousHolidayAdjustments_v1_1_TimeOffType decision table holds parameter values that modify time-off request durations.

Religious Holiday Adjustments Time-off Type decision table
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.
TimeOff Type Indicates the type of time off, such as Fixed, Original Shift, or 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 employee is assigned to an employment term, the pay rule assigned to the employment term is always given priority.

  • The TimeOffType value determines the paycode edit made by the time-off request. For example, when the TimeOffType value contains:

    • Fixed: The paycode edit matches the duration provided in the Full Day Value column.
    • Original Shift: The paycode edit matches the duration of the original shift.
    • No adjustments: A paycode edit is not created.

  • Wildcard entries are not allowed.

Edit the decision table: ReligiousHolidayAdjustments_v1_1_Locale

The ReligiousHolidayAdjustments_v1_1_Locale decision table allows translation of business process messages into different languages.

Religious Holiday Adjustments Locale decision table
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.

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

Deploy the updated 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.

Model deployment steps:

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

  2. Select the ReligiousHolidayAdjustments_v1.1 model.

  3. Click Tap Edit, and then configure the required parameters and deployment dates. Select Notifications Templates from the Template Categories list.

  4. Click Tap Save, and then select Return to deploy.

API details
API name Section Type Resource path Location Description
Retrieve timeoff request Scheduling GET /v1/scheduling/timeoff/{timeOffRequestID}?include_overridden_shifts=true Retrieve TOR API Retrieve time-off request status and time.
Retrieve employee paycode edits Scheduling POST /v1/scheduling/schedule/multi_read Retrieve Schedule API Retrieve paycode edits from the schedule.
Delete paycode edits Scheduling POST /v1/scheduling/schedule/pay_code_edits/multi_delete Delete Pay Code Edit API Delete paycode edits using paycode edit ID.
Retrieve schedule audit Scheduling POST /v1/scheduling/audits/multi_read Retrieve Schedule Audits API Retrieve employee schedule audit.
Retrieve employee information Commons POST /v1/commons/persons/extensions/multi_read Person Extensions API Retrieve employee information.
Update paycode edits Scheduling POST /v1/scheduling/schedule/pay_code_edits/multi_update Update Paycode Edit API Update paycode edit.
  1. Configure Access to Integrations.
  2. Create a comment with the shifts category, such as Adjusted by Religious Holiday Adjustments; see the Comments topic.
  3. Configure integration list parameters to define ReligiousHolidayAdjustmentsAction and ReligiousHolidayAdjustmentsAdjustType; see the Configure Integration List Parameters.

For example:

Name = ReligiousHolidayAdjustmentsAction

Parameter Values:

  • Adjust Breaks

  • Adjust Shift Length

  • Initiate Overtime Approval

  • Initiate Overtime Paid as Hours

Name = ReligiousHolidayAdjustmentsAdjustType

Parameter values:

  • Individual Actions

  • Shift Template (default value)

Note: When updating the integration list parameters, detach the integration list parameters from Install Integration > Integration, and then reattach them after completing the updates.

  1. Deploy the Religious Holiday Adjustments_v1 integration; see the Deploy Integrations topic.
  2. Get the URL for the APIGatewayServer for the tenant.

Select the environment

  1. Open the Integration Template Designer: Select Main Menu  > Administration > Application Setup > Integrations Setup > Design Integration Templates.

    Note: If prompted, enter your Username and Password. Click Tap Log in.

  2. Select the Manage tab > Atom Management.
  3. Select your environment.

Select environment extensions

  1. In Administration, click tap Environment Extensions.
  2. In Process Filter, click tap the magnifying glass Search button. It can take several seconds before the button becomes active.
  3. Select the integration pack: Religious Holiday Adjustment > Religious Holiday Adjustments_v1.

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

Configure connection settings

  1. Select Connection Settings.

  2. From the Connection list, select and configure the following:

    Connection Settings
    Setting Required Actions
    APIGatewayServer Required

    To change the default API gateway server:

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

      Example: <tenantURL>/api

Configure process properties

  1. Select Process Properties.

Caution: Do not edit the default values of the AuthenticationProperties. By default, cookies are enabled and set the values for authentication properties.

  1. Select ReligiousHolidayAdjustments_v1_CRTConfig to set to set general configurations, which are required before the integration can run.

  • Search for _ReligiousHolidayAdjustments_v1_Locale_CRT, and then provide column values as Parameter Name, Locale Policy, Message, Description.

  • Search for _ReligiousHolidayAdjustments_v1_AdjustShift_CRT, and then provide column values as Person Number, EmploymentTerm, Payrule, Location, Shortening type, Value, Minimum Shift.

  • Search for _ReligiousHolidayAdjustments_v1_OverrideTemplate_CRT, and then provide column values as Person Number, EmploymentTerm, Payrule, Location, Original Shift Template, Ramadan Shift Template.

  • Search for _ReligiousHolidayAdjustments_v1_NightShift_CRT, and then provide column values as Location, Night Zone Start Time, Night Zone End Time, % of Shift Falling in Night Zone

  • Search for _ReligiousHolidayAdjustments_v1_OverrideWorkRule_CRT, and then provide column values as Action, Override Workrule Suffix.

  1. Select ReligiousHolidayAdjustments_v1_Control to confirm the existence of all the parameters, and that "Use Default" is checked for all the values before the integration runs.

Religious Holiday Adjustments - Control Properties
Parameter name Description Template parameter Parameter type Default value User prompt
Hyperfind Hyperfind or location for which this integration will run. Hyperfind Hyperfind All Home — H(1)

true
Individual Employee ID Comma- separated employee numbers. (Overrides Hyperfind.) Individual Employee ID Text   true
Start Date Start date of the religious holiday. Start Date Date   true
End Date End date of the religious holiday. End Date Date   true
Comment Comment added to the schedule rule transfer. Comment Text   false
Comment Note Note added to the schedule rule transfer. Comment Note Text   false
Choose Actions A limited list of actions that are performed on scheduled shifts. Choose Actions List   true
Adjustment Type Drop-down list containing adjustment types. Adjustment Type Dropdown Individual Actions true
Exclude Night Shift Determines whether the Adjust Breaks action is performed on night shifts. Exclude Night Shift Boolean false true
Output Directory SFTP directory path to which the religious holiday adjustments file is exported. Output Directory Text /Outbound false
File Name Output file name. File Name Text   false
Duration Format Shift duration format used in CRTs. Duration Format Text HH:mm false
Caution: Choose Actions entries must match variables entered in the Locale_CRT.

Configure cross-reference tables

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

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

  • Organizes data values into rows and columns:
    • Maximums = 20 columns, 10,000 rows.
  • Can combine values from multiple columns to determine a single output value.
  • If more than one row matches a reference value, the first match is the output value.
  • If no match is found, the output value can be null, or the integration can produce errors.
  1. Select Cross Reference.

  2. From the Cross Reference list, select the following tables:

     

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

    Column headers and definitions:

    Parameter Name, Locale Policy, Message, Description.

    • Parameter Name = Parameters defined in ReligiousPeriodAdjustments_v1_Localization_CRT process property.

    • Locale Policy = Locale Policy.

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

    • Description = Parameter description.

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

     

    ReligiousHolidayAdjustments_v1_ AdjustShift_CRT: Identifies how a shift is adjusted based on prioritized parameters that an employee must match.

    Column headers and definitions:

    Person Number, EmploymentTerm, Payrule, Location, Shortening type, Value, Minimum Shift.

    • Person Number = Identifies the person for whom the shift will be shortened.

    • EmploymentTerm = Identifies the employment term for which the shift will be shortened.

    • Payrule = Identifies the pay rule for which the shift will be shortened.

    • Location = Identifies the location for which the shift will be shortened.

    • Shortening type = Identifies how the shift is shortened, such as Fixed or ReduceBy.

    • Value = Contains the amount by which the shift will be shortened.

    • Minimum Shift = Minimum shift length.

      • Note:

      • When Shortening type = 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 Shortening type = ReduceBy:

        • If the shift length is less than or equal to the length in the Minimum Shift column, no action is performed.

        • If the shift length is greater than the length in the Minimum Shift column, the shift length is shortened by Value. This ensures that the minimum shift adheres to the Minimum Shift value.

      • 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 employee is assigned to an employment term, 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_v1_OverrideTemplate_CRT: Identifies which shift template is used for the holiday period based on prioritized parameters that an employee must match.

    Column headers and definitions:

    Person Number, EmploymentTerm, Payrule, Location, Original Shift Template, Ramadan Shift Template.

    • Person Number = Identifies the person for whom the holiday shift template override applies.

    • EmploymentTerm = Identifies the employment term for which the holiday shift template override applies.

    • Payrule = Identifies the pay rule for which the holiday shift template override applies.

    • Location = Identifies the location for which the holiday shift template override applies.

    • Original Shift Template = Identifies the original shift template for which the holiday shift template override applies.

    • Ramadan Shift Template = 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 employee is assigned to an employment term, 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_v1_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.

    Column headers and definitions:

    Location, Night Zone Start Time, Night Zone End Time, % of Shift Falling in Night Zone.

    • Location = Identifies the employee's primary location. A wildcard, if entered, must be located at the bottom of the CRT.

    • Night Zone Start Time = Identifies the start time of the night shift. Must be entered using 12-hour format (HH:mma).

    • Night Zone End Time = Identifies the end time of the night shift. Must be entered using 12-hour format (HH:mma).

    • % of Shift Falling in Night Zone = Identifies the percentage of a shift's hours that must fall between the Night Zone Start and End Times .

    Note:

    • Wildcard entries must be located at the bottom of the AdjustShift_CRT.

    ReligiousHolidayAdjustments_v1_OverrideWorkRule_CRT: Identifies which suffix to use when searching for the work rule override defined in UKG Pro Workforce Management™.

    Column headers and definitions:

    Action, Override Workrule Suffix.

    • Action = Semicolon-separated actions performed by the integration.

    • Override Workrule Suffix = Identifies the suffix assigned to work rules defined in UKG Pro Workforce Management™.

      • Note:

      • Action column entries must match values defined in the integration's Control Property Choose Actions parameter. 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

      • When the integration's Control Property Exclude Night Shift = 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 Override Workrule Suffix that excludes the Adjust Breaks action.

        • If no, the integration selects an Override Workrule Suffice that includes the Adjust Breaks action.

  3. Select Override to:

    • Download the tables when you run the integration
    • Edit the table cells in Extensions
  4. Click Tap OK.
  • File Name: <FileName_CurrentDate.csv>
  • Format: Comma delimited
  • Frequency: On-demand or scheduled
  • Header Row: Yes, 1 row
  • Output Folder: /Outbound
Output file layout
Field Comments or examples
Hyperfind Hyperfind or location selected to run the integration.
Individual Employee ID 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 Actions 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.

After the integrations are deployed and the connection settings and process properties are configured, install the integrations to make them available for running or scheduling.

Note:
  • An integration template is the configured integration that you deploy to an Atom and then install to make available for running or scheduling.
  • An installed integration is a single instance of an integration that is based on an integration template. When you install an integration, you can define parameters or set parameters to be defined when the integration is run.
  1. Select Main Menu  > Administration > Application Setup > Integrations Setup > Install Integrations.
  2. Click Tap Create .
  3. Enter a unique Integration Name.
  4. (Optional) Enter a Description.

Note: Do not select API Integration.

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

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

  4. Email Notifications

    (Optional)

    1. Select Yes to send email and control center notifications for integration runs.
    2. Enter the email addresses of the recipients for the following types of run status. For multiple recipients, separate the addresses by a comma, but no spaces:

      In Progress — The integration run started and has not finished.

      Completed — The integration ran successfully without errors.

      Failed — The integration ran successfully, but one or more records have errors. The integration run is treated as failed. If Abort on Failure is configured in an integration set, the integration set stops.

      Completed with Errors — The integration run has errors or could not run.

  5. In Skip Configuration, select None (default) to allow multiple integrations to run at the same time or with the same data without restrictions.

Note: Do not select Allow Minute Interval.

  1. Integration template and parameters
    1. In Integration Template, select ReligiousHolidayAdjustments_v1.
    2. Click Tap Assign .
    3. In Integration Parameters, you can override default settings. Click Tap Create.
    4. Complete the configuration for each parameter value.

    5. Click Tap Save.

       

      Repeat this step for each integration parameter that supports the Religious Holiday Adjustments process.

       

      Specify the default Hyperfind query that contains the employees for whom the integration will run:

      Hyperfind
      Parameter Name Enter Hyperfind.
      Description (Optional)
      Template Parameter Select Hyperfind.
      Parameter Type Select Hyperfind.
      Default Value (Optional) Enter a value, such as 1 (All Home).
      User Prompted

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

       

      Specify Individual Employee ID to override the Hyperfind option.

      Individual Employee ID
      Parameter Name Enter Individual Employee ID.
      Description (Optional) Enter a description, such as Provide comma-separated Employee IDs.
      Template Parameter

      Select Individual Employee ID.
      Parameter Type

      Select Text.
      Default Value  
      User Prompted

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

       

      Specify the start date of the religious holiday period.

      Start Date
      Parameter Name Enter Start Date.
      Description (Optional)
      Template Parameter

      Select Start Date.
      Parameter Type

      Select Date.
      Default Value  
      User Prompted

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

       

      Specify the end date of the religious holiday period.

      End Date
      Parameter Name Enter End Date.
      Description (Optional)
      Template Parameter

      Select End Date.
      Parameter Type

      Select Date.
      Default Value  
      User Prompted

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

       

      Specify the comment that will be added to the adjusted shift.

      Comment
      Parameter Name Enter Comment.
      Description (Optional)
      Template Parameter

      Select Comment.
      Parameter Type

      Select Text.
      Default Value
      User Prompted

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

       

      Specify the note that will be added to the adjusted shift.

      Comment Note
      Parameter Name Enter Comment Note.
      Description (Optional)
      Template Parameter

      Select Comment Note.
      Parameter Type

      Select Text.
      Default Value  
      User Prompted

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

       

      Select the actions that will be performed on the scheduled shift.

      Choose Actions
      Parameter Name Enter Choose Actions.
      Description (Optional)
      Template Parameter

      Select Choose Actions.
      Parameter Type

      Select List.
      Default Value Select checkbox-based options from a limited set of alternatives.
      User Prompted

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

       

      Specify the adjustment type that will be performed on the scheduled shift.

      Adjustment Type
      Parameter Name Enter Adjustment Type.
      Description (Optional)
      Template Parameter

      Select Adjustment Type.
      Parameter Type

      Select Dropdown.
      Default Value Enter dropdown options for selecting the adjustment type.
      User Prompted

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

       

      Specify whether night shifts are excluded from the break adjust action.

      Exclude Night Shift
      Parameter Name Enter Exclude Night Shift.
      Description (Optional)
      Template Parameter

      Select Exclude Night Shift.
      Parameter Type

      Select Boolean.
      Default Value

      Default = false.

      To use an alternative value:

      1. Clear Use Default.

      2. Enter true.
      User Prompted

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

       

      Specify the SFTP output directory where the religious holiday adjustments report will be written.

      OutputDirectory
      Parameter Name Enter OutputDirectory.
      Description (Optional)
      Template Parameter Enter OutputDirectory.
      Parameter Type Select Text.
      Default Value Enter the SFTP directory path, such as /Outbound.
      User Prompted

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

       

      Specify the file name of the religious holiday adjustments report.

      File Name
      Parameter Name Enter File Name.
      Description (Optional)
      Template Parameter Enter File name of dashboard data.
      Parameter Type Select Text.
      Default Value Enter a unique name for the exported file, such as ReligiousHolidayAdjustments. Do not include slashes (/).
      User Prompted

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

       

      Specify the shift duration format used in the CRTs.

      Duration Format
      Parameter Name Enter Duration Format.
      Description (Optional)
      Template Parameter

      Select Duration Format.
      Parameter Type

      Select Text.
      Default Value Enter HH:mm
      User Prompted

      If the value does not need to be changed when the integration runs, select No.
  2. Click Tap Save.
  3. Ensure that the generic data access profiles (GDAP) allow access by the people who need to run the installed integrations. Select Administration > Application Setup > Integrations Setup > Access Profiles; see Configure Access to Integrations.

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 ReligiousHolidayAdjustments_v1 integration from the list. Click Tap Select. 
    4. (Optional) Enter a unique Integration Run Name to make it easier to identify the run of the integration. Otherwise, the system assigns a default name, which ends with a date and time stamp.
  2. Set parameters as follows:
    • Hyperfind: Select a Hyperfind query of employees.
    • Individual Employee ID: To process data for only a limited group of employees, enter the person numbers, as defined in the source system, each separated by a 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 Actions: Select the actions that will be performed on the scheduled shift.
    • Adjustment Type: Select checkbox-based options.
    • Exclude Night Shift: Specify whether night shifts are excluded from the break adjust action.

  3. Select the following:

    • Run Integration: If this is the first time this integration is being run.
    • Re-Run: If this integration has been run before, and the status is not In-Progress, you can run the integration again without entering the parameter values again. Click Tap Yes to continue, or No to not run the integration and to return to the parameter settings.

  4. Wait for the confirmation that the integration completed or failed. Close the panel.
  5. Click Tap Refresh . 
  6. To see details, select the integration run. Select Run Summary.

Check the results

Status indicators

  •  In-Progress: The run of this integration has not yet completed.
  •  Completed: The integration ran successfully without errors.
  •  Scheduled: This integration is scheduled to run later or repeatedly.
  • (Grayed out) Scheduled but Deleted: This integration is scheduled to run, but the integration template has been deleted. When it runs, it will generate an error. To prevent this error, delete the scheduled integration run.
  •  Completed with Errors: The integration ran successfully, but one or more records have errors. The integration run is treated as failed. If Abort on Failure is configured in an integration set, the integration set stops.
  •  Failed: The integration run has errors or could not run.
  • To troubleshoot and resolve errors, do the following:

    Check the Run Summary for details.

    • To troubleshoot all types of errors, or if the Run Summary shows a large number of errors, click tap Go to Additional Details (if available), or click tap the Source File to open and examine the input source file.
    • (Only for import integrations) To troubleshoot and resubmit integrations that have transactional or data errors, click tap Go to Transaction Assistant.

To check the results in more detail:

  1. Click Tap the tile for the integration run.
  2. Click Tap Run Summary to see the results of the integration run.

    Example Run Summary details

    Note: The available details vary by integration and configuration.

    • Integration Run Name: Name of this run of the integration.
    • Process Name: Name of any integration set that includes this integration.
    • Integration Name: Name of the installed integration.
    • Integration Reference ID: Unique identifier for this integration run (to help in troubleshooting errors).
    • User: The person or user account that ran the integration.
    • Integration Type: Import, Export, or None
    • Start Date: Date and time when the integration run started.
    • End Date: Date and time when the integration run finished.
    • Status: In-Progress, Completed, Completed with Errors, or Failed.
    • Records Processed: Number of records that were processed.
    • Records Created: Number of records that were created.
    • Errors: Number of records that failed.
    • Source Files, Output File, and Error Files: For file-based import integrations, use Manage SFTP to access the source and output files on the inbound (source) and outbound (destination) SFTP folders. See the Manage SFTP topic.
  3. Log in to the destination system and ensure that the data has been correctly updated.

Note: You can schedule integrations and integration sets to run once later or at a recurring frequency. See the topic.

API details
API name Section Type Resource path Location Description
Retrieve comments Commons GET /v1/commons/comments _RetrieveComment Retrieve comments.
Execute Hyperfind Commons POST /v1/commons/hyperfind/execute _Execute Hyperfind Execute Hyperfind.
Retrieve user locale Commons GET /v1/commons/user_preferences/locale_policy? userCurrent=true _RetrieveLocale Retrieve locale.
Submit integration details Platform POST /v1/platform/integration_executions/ _Submit Integration Details Submit integration details.
Process callback Platform POST /v1/platform/integrations/update_status _WFD Callback Process callback.
Retrieve tenant locale Commons GET /v1/commons/user_preferences/locale_policy?tenantDefault=true _RetrieveLocale Retrieve locale.
Retrieve all work rules Timekeeping GET /v1/timekeeping/setup/full_work_rules _NonDynamicCache Retrieve all work rules.
Retrieve all shift templates Scheduling POST /v1/scheduling/shift_templates/multi_read/ _NonDynamicCache Retrieve all shift templates.
Retrieve person extension Commons POST /v1/commons/persons/extensions/multi_read _RetrievePersonExtensionData Retrieve person extension data.
Retrieve schedule Scheduling POST /v1/scheduling/schedule/multi_read _RetrieveSchedule Retrieve employee schedule data.
Get Hyperfind by ID Commons GET /v1/commons/hyperfind _ExecuteHyperfind Retrieve Hyperfind by ID.
Get Location by ID Commons GET /v1/commons/locations _ExecuteHyperfind Retrieve location by ID.
Update shifts Scheduling POST /v1/scheduling/schedule/shifts/multi_update _UpdateShifts Update multiple shifts.