Mondayisation

To determine the "normal' work days for employees, the system looks back at the employees' work histories for the previous Saturdays or Sundays. When it finds a minimum number of work occurrences, the system considers these days as normal work days whether or not holidays fall on these days.​

You can configure the following parameters:

• Look-back period by week or fortnight as follows:,​
  • Number of periods to look back; examples: 5 weeks, 2 fortnights​.
  • Minimum number of worked days each period to qualify; example: must have worked 3 out of the last 5 Saturdays.​
• The system uses two combined paycodes to capture hours that count as worked which supports hourly and daily paycodes.​
• The eligible hours are not limited to worked hours, and assimilated absences can also qualify. Example: Training on a previous Saturday.

Only the following public, statutory holidays are eligible to be Mondayised or Tuesdayised, when they fall on Saturday or Sunday:​​

• New Year’s Day​
• Day after New Year’s Day​
• Waitangi Day​
• Anzac Day​
• Christmas Day ​
• Boxing Day

• Only employees who normally do no work on Saturday or Sunday.​
• When the integration’s Check if Scheduled control parameters are set to true, the following conditions must also be satisfied:​
  • All segments in the day’s shift assignment must contain a work rule transfer matching a work rule transfer listed in the Mondayisation_iPack_v4_WorkRuleToExcludeFromSchedule_CRT.​
  • Paycode edits in the schedule must not match a paycode assigned to the Paycode Data Access Profile defined in the integration’s Leave Paycode to count to Schedule control parameter.​
  • When the integration’s Count Hours from Previous Night_Holiday control parameter is also set to true, the integration checks the scheduled hours crossing the day divide. None of the segments can contain paycodes which are part of the Paycode Data Access Profile passed as a parameter for Leave Paycode to count to Schedule; or the entire segment must belong to any of the work rules listed in Mondayisation_iPack_v4_WorkRuleToExcludeFromSchedule_CRT; or the hours that fall after the day divide must not exceed the value defined in the integration’s control parameter Previous Night Minimum Hours.​

When changes are made to the employee's timecard after Mondayisation or Tuesdayisation of a public holiday, rerunning the integration has no impact on the Mondayised or Tuesdayised holiday.

1. Employees are assigned employment terms with a holiday profile that defines all statutory holidays for the calendar year.​

2. The integration looks up each holiday listed in the Holidays cross-reference table, and then qualifies them for Mondayisation based on conditions that determine a normal work day.

3. If holidays fall on both Saturday and Sunday, the Saturday holiday moves to Monday, and the Sunday holiday moves to Tuesday. Alternatively, alignment of both Saturday and Sunday holidays can enforce Mondayisation of Saturday and Tuesdayisation of Sunday. If holidays fall on Sunday and Monday, the Sunday holiday moves to Tuesday​.
4. When employees qualify for Mondayisation:​
   1. A copy of the employment terms with an alternative holiday profile is created and assigned.​ This copy defines all parameters of the active employment terms including overtime, work hours definition.​
   2. This alternative employment terms is assigned effective on the holiday date minus one day, and ending on the day to which the holiday is moved. When consecutive holidays exist, Holiday Profiles are required for each possible outcome.​
   3. The employees' original employment terms are reassigned after the Mondayisation ends.​
5. Public holiday credit moves from the weekend to the Monday or Tuesday.​
6. (Optional) For the timecard, you can configure a paycode and comment.​

Anzac Day falls on a Saturday, and an employee who is not scheduled to work that day qualifies for Mondayisation.

• The organization has a policy that over the previous 5 weeks, 3 Saturdays have to be worked to consider Saturday a normal work day.
• When the integration looks back at the previous weeks, it does not consider Saturday to be a normal work day because the employee normally does not work on Saturdays. So, the employee qualifies for Mondayisation.
• The employee's employment terms that are active on Saturday are copied with the alternative holiday profile, the Mondayisation Saturday profile. The appropriate suffix is added to the name of the copied employment terms. After the Mondayisation date, the original employment terms is reassigned automatically.

Anzac Day falls on a Saturday, and an employee who is scheduled to work that day does not qualify for Mondayisation.

• The organization has a policy that over the previous 5 weeks, 3 Saturdays have to be worked to consider Saturday a normal work day.
• When the integration looks back at the previous weeks, it considers Saturday to be a normal work day because the employee normally works on Saturdays. So, the employee does not qualify for Mondayisation, and the Saturday hours are paid according to the company’s policy with Holiday Premium pay. The holiday is not moved.

Christmas falls on a Sunday, and Boxing Day falls on the following Monday. Treatment of these consecutive holidays is controlled by Enforce MonTue Alignment. When set to true, Christmas is not moved, and when set to false, the integration Tuesdayises Christmas by moving it to Tuesday.

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

1. Configure Access to Integrations.
2. Configure the following:

• Hyperfind: Configure a public Hyperfind query for the employees whose holidays can be Mondayised or Tuesdayised. See the Hyperfind queries topic.

• Comment: Configure a comment that the integration adds to the timecard along with the Moved Holiday paycode. The pay codes category must be selected during configuration. See the Comments topic.

• Paycodes: Create the paycodes that support the Mondayisation integration process. See the Paycode definition topic.

Example: An hours-based Moved Holiday paycode that gives a 0 (zero) amount paycode edit and comment to the time card.

• Combined paycodes: Create hours- and days-based combined paycodes that are used by the lookback calculation. See the Combined Paycodes topic.

• Zone rule: Add all of the standard, Mondayised, and Tuesdayised holidays to Holidays zone rules that are used to configure combination rules and work rules. See the Zones topic.

• Combination rules: Group the work rules into a combination rule. See the Combination Rules topic.

• Work rule: Edit existing work rules. Add the holiday zone on the pay code distribution tab. See the Work Rules topic.

• Holidays: Configure the holiday list that includes all of the standard (default) and Mondayised and Tuesdayised holidays. See the Configure holidays topic.

  Depending on the year and which day of the week each statutory holiday falls, add the required holidays to the list. Based on the employees' eligibility criteria, the integration applies the standard or the Mondayised holiday, but never both.

Example: In 2020, you had to enter all of the following:

Anzac Day and Anzac Day — Mondayised

Boxing Day and Boxing Day — Mondayised

• Holiday credit rule: Create a holiday credit rule for holidays and assign it to all holiday profiles used by the extension. See the Holiday Credit Rules topic.

• Holiday profiles: Configure the standard and alternative holiday profiles. See the Holiday Profiles topic.

Note: Each alternative holiday profile applies to a different calendar year according to which days of the week the holidays fall. Examples: In 2020, only 2 holidays qualify for Mondayisation, and both are on Saturdays. In 2021, holidays are Mondayised or Tuesdayised, and some are on Saturday and others on Sunday.

For a year that has holidays that are Mondayised or Tuesdayised, some on Saturday and others on Sunday, create the following profiles:

For standard holidays:

In Name, enter New Zealand Holidays.

In Version Effective Dates, select the calendar year.

In Holiday Credit Rule, select Hours from Schedule.

In Zone Rule, select Public Holiday.

In Holidays, add the standard holidays.

For holidays that fall on Saturdays and can be moved to Monday:

In Name, enter Mondayisation Saturday.

In Version Effective Dates, select the calendar year.

In Holiday Credit Rule, select Hours from Schedule.

In Zone Rule, select Public Holiday.

In Holidays, add the Mondayised holidays.

Example for 2021: Add Christmas — Mondayised, Day after New Year's Day — Mondayised, and Waitangi Day — Mondayised.

For holidays that fall on Saturdays and can be moved to Tuesday:

In Name, enter Tuesdayisation Saturday.

In Version Effective Dates, select the calendar year.

In Holiday Credit Rule, select Hours from Schedule.

In Zone Rule, select Public Holiday.

In Holidays, add the Mondayised holidays.

For holidays that fall on Sundays and can be moved to Monday:

In Name, enter Mondayisation Sunday.

In Version Effective Dates, select the calendar year.

In Holiday Credit Rule, select Hours from Schedule.

In Zone Rule, select Public Holiday.

In Holidays, add the Mondayised holidays.

Example for 2021: Add Anzac Day — Mondayised.

For holidays that fall on Sunday and can be moved to Tuesday because another holiday falls on Saturday and is Mondayised:

In Name, enter Tuesdayisation Sunday.

In Version Effective Dates, select the calendar year.

In Holiday Credit Rule, select Hours from Schedule.

In Zone Rule, select Public Holiday.

In Holidays, add the Tuesdayised holidays.

Example for 2021: Add Boxing Day — Tuesdayised.

For consecutive holidays that fall on Saturday and Sunday, and can be moved to Monday and Tuesday:

In Name, enter Sat—Mon Sun—Tue.

In Version Effective Dates, select the calendar year.

In Holiday Credit Rule, select Hours from Schedule.

In Zone Rule, select Public Holiday.

In Holidays, add the Mondayised and Tuesdayised holidays.

Example for 2022: Add New Year's Day — Mondayised and Day after New Year's Day — Tuesdayised.

Note: For consecutive Saturday and Sunday holidays, circumstances could exist in which either holiday qualifies to be moved. For these cases, an alternate holiday profile must be created containing a Mondayised or Tuesdayised holiday, and a holiday that is not qualified to be moved.

For consecutive holidays that fall on Saturday and Sunday, and only the Saturday holiday can be moved to Monday:

In Name, enter Weekend Sat—Mon Sun.

In Version Effective Dates, select the calendar year.

In Holiday Credit Rule, select Hours from Schedule.

In Zone Rule, select Public Holiday.

In Holidays, add the Mondayised holidays.

For consecutive holidays that fall on Saturday and Sunday, and only the Sunday holiday can be moved to Tuesday:

In Name, enter Weekend SatSun—Tue.

In Version Effective Dates, select the calendar year.

In Holiday Credit Rule, select Hours from Schedule.

In Zone Rule, select Public Holiday.

In Holidays, add the Tuesdayised holidays.

• Employment terms: Assign all employees an employment term that contains the holiday profile; this ensures that employee holidays are derived from the holiday profile instead of the pay rule. See the Employment Terms topic.

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

Deploy the Mondayisation integration

For more information, see the Deploy Integrations topic.

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

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

2. Make sure that the Account is correct. If not, select the right account.

3. Select the Deploy tab > Integration Packs.

1. From the list in the left column, search for and select the Pro WFM Mondayisation Extension integration.

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 .

Configure the Mondayisation integration settings

Select the environment

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

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: Mondayisation > Mondayisation_iPack_v4.

Configure connection settings

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

1. Select Connection Settings.

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

   Connection Settings

   Setting	Required	Actions
   Mondayisation_iPack_v4_APIGatewayServer	Required	To change the default API gateway server: Clear Use Default. Enter the URL to the server. Example: <tenantURL>/api
   Mondayisation_iPack_v4_Holidays_CRT	Required	Enable Override.
   Mondayisation_iPack_v4_HolidayProfiles_CRT	Required	Enable Override.
   Mondayisation_iPack_v4_WorkRuleToExcludeFromSchedule_CRT	Required	Enable Override.

Configure process properties

1. Select Process Properties.

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

2. Select Mondayisation_iPack_v4_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
_Mondayisation_iPack_v4_Holidays_CRT	Serial No,Holiday,Date(dd/mm)
_Mondayisation_iPack_v4_HolidayProfiles_CRT	Purpose,Employment Terms Suffix,Holiday Profile,Temp Holiday Profile
_Mondayisation_iPack_v4_WorkRuleToExcludeFromSchedule_CRT	Serial No,Work Rule

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.

1. Select Cross Reference.
2. From the Cross Reference dropdown list, select a Mondayisation table.
3. Select Override, which allows you to:

• Download the tables when you run the integration.
• Edit the table cells in Extensions.

4. When you finish, click tap OK.

Repeat the steps for each of the Mondayisation tables.

Mondayisation_iPack_v4_Holidays_CRT: Holds only the standard holiday dates that are eligible for Mondayisation or Tuesdayisation. No Mondayised or Tuesdayised dates are ever entered in the table. This table is required and needs to be updated every calendar year using dd/mm date format.

Mondayisation — Holidays CRT

Column name	Description
Serial No	Index for referencing the holiday.
Holiday	Name of the holiday.
Date(dd/mm)	Holiday date.

Mondayisation_iPack_v4_HolidayProfiles_CRT: Controls the Holiday Profile that will be used for each type of move, and is used by the extension to define the name of the copied Employment Term. This table is configured only once.

Mondayisation — Holiday Profiles CRT

Column name	Description
Purpose	Move holiday day to Mondayised or Tuesdayised day.
Employment Terms Suffix	The suffix to add to the name of the employment terms used by the integration.
Holiday Profile	Name of the holiday profile.
Temp Holiday Profile	The name of the alternative Holiday Profile that is assigned when a holiday is Mondayised or Tuesdayised.

Note: To keep the number of employment terms to a strict minimum, the integration only creates a copy if the alternative version does not already exist.

Mondayisation_iPack_v4_WorkRuleToExcludeFromSchedule_CRT: Controls the list of work rules that exclude a shift from being counted as a scheduled day. Shifts, such as on-call or planned overtime, are excluded from processing. A shift will only count as a scheduled day if at least one segment of the shift has either no work rule transfer, or a work rule transfer to a work rule not included in this CRT.

Mondayisation — Work Rule To Exclude From Schedule CRT

Column name	Description
Serial No	Index for referencing the work rule.
Work Rule	Work rule for shift not to be considered as worked.

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.

1. Select Main Menu  > Administration > Application Setup > Integrations Setup > Install Integrations.
2. Click Tap Create .
3. In Integration Name, enter a unique name, such as Mondayisation_iPack_v4.
4. (Optional) Enter a Description.

Note: Do not select API Integration.

5. In File Access, select None to not select a connection.
6. If the person who runs the integration doesn't have full access to integrations, select Execute Integration with System Account. This allows the integration access to all APIs in the FAP, and the relevant permissions and data, regardless of the FAP and GDAP of the person who runs the integration.

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

8. Email Notifications

   (Optional)

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

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

      Completed — The integration ran successfully without errors.

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

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

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

Note: Do not select Allow Minute Interval.

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

    Repeat this step for each integration control parameter that supports the Mondayisation process.

    Integration Parameters

    Parameter name / Template parameter	Description / User prompt / Mandatory	Template parameter	Parameter type
    Hyperfind Name	The default Hyperfind or Location query that contains the employees for whom the integration is run. Default = All Home User prompt = Yes Mandatory = Yes Note: Ad-hoc Hyperfinds are not supported. All Home does not include terminated and inactive employees even if they have totals during the period. To include these totals, configure a Hyperfind that includes terminated and inactive employees and select that Hyperfind in this process property. The maximum number of employees in a Hyperfind is 3500. To process more employee records, divide the population into smaller Hyperfinds to run sequentially.	HyperfindAndLocation	Hyperfind
    Individual Employee Id	A comma-separated list of specific employees for whom the integration is run. When no value is entered, the integration defaults to the Hyperfind Name parameter. To process the integration for only a limited group of employees, enter the person numbers as defined in the source system, each separated by a comma (,) but not spaces. User prompt = Yes Mandatory = No Example: 13997,15556,20012	EmployeeIDs	Text
    Lookback — Enabled_Holiday	Determines whether the integration looks back to previous weeks or fortnights to validate whether a day is a normal work day. User prompt = No Mandatory = No Supported values: true: Mondayisation applies if the day is normally worked. false (default): Mondayisation does not apply if the day is normally worked.	LookbackEnabledHoliday	Boolean
    Check if Scheduled_Holiday	Controls whether Mondayisation applies based on the employee’s schedule on the holiday. User prompt = No Mandatory = Yes Supported values: true: Mondayisation does not apply if the employee is scheduled. false (default): Mondayisation applies if the employee is scheduled to work.	CheckIfScheduledHoliday	Boolean
    Lookback — Enabled_Mon_Tue	Determines whether to enable look-back to check previous weeks or fortnights to validate whether Monday or Tuesday is a normal working day. User prompt = No Mandatory = No Supported values: true: Mondayisation applies if the day is normally worked. false (default): Mondayisation does not apply if the day is normally worked.	LookbackEnabledMonTue	Boolean
    Check if Scheduled_Mon_Tue	Controls whether Mondayisation applies when the employee is scheduled to work on Monday or Tuesday. User prompt = No Mandatory = No Supported values: true: Mondayisation applies if the employee is scheduled. false (default): Mondayisation does not apply if the employee is scheduled to work.	CheckIfScheduledMonTue	Boolean
    Lookback — Type	The type of period to look back to during validation. User prompt = No Mandatory = Yes, if Lookback is enabled. Supported values: Week: Look back through weekly periods. Fortnight: Look back through biweekly periods.	LookbackType	Text
    Lookback — Periods	The number of weeks or fortnights to look back to validate whether a day is a normal work day. User prompt = No Mandatory = Yes, if Lookback is enabled. Default = blank.	LookbackPeriods	Number
    Fortnight — Qualify Both Weeks	Controls whether to validate work days during one or both weeks of fortnightly periods. Note: For a description of the interaction of process properties and fortnights, with an example, see Fortnight Settings . User prompt = No Mandatory = Yes, if Lookback — Type = Fortnight. Supported values: true: Validate work days during both weeks. false: Validate work days during only one week.	FortnightQualifyBothWeeks	Boolean
    Normal Working Day — Occurrences	Minimum number of working days or fortnights to qualify as a normal working day. User prompt = No Mandatory = Yes, if Lookback is enabled. Default = blank. Example: 2	NormalWorkingDayOccurrences	Number
    Normal Working Day — Combined Hours	The hours-based combined paycode that defines a normal working day. User prompt = No Mandatory = Yes, if Lookback is enabled. Default = blank. Example: Actual combined hours	NormalWorkingDayCombinedHours	Text
    Normal Working Day — Minimum Hours	Minimum number of hours (hh:mm) that qualify a day as a normal working day. User prompt = No Mandatory = Yes, if Lookback is enabled. Default = 00:01. Example: 2:25	NormalWorkingDayMinimumHours	Text
    Normal Working Day — Combined Days	The day-based combined paycode that defines a normal working day. User prompt = No Mandatory = Yes, if Lookback is enabled. Default = blank. Example: Actual combined days	NormalWorkingDayCombinedDays	Text
    Normal Working Day — Minimum Days	Minimum number of days (d.d) that qualify for normal working day. User prompt = No Mandatory = Yes, if Lookback is enabled. Default = 0.1.	NormalWorkingDayMinimumDays	Text
    Moved Holiday — Paycode Edit	Determine whether to insert a paycode edit and comment for Mondayised days. User prompt = No Mandatory = No. Default = blank. Supported values: true: Insert a paycode edit and comment. false: Do not insert a paycode edit and comment.	MovedHolidayPaycodeEdit	Boolean
    Moved Holiday — Paycode	The paycode to enter on the original holiday after the Mondayisation integration runs. User prompt = No Mandatory = No. Default = blank. Example: Moved Holiday	MovedHolidayPaycode	Text
    Moved Holiday — Comment	The comment added to the Moved Holiday — Paycode on the original holiday after the Mondayisation integration runs. User prompt = No Mandatory = No. Default = blank. Example: Adjusted by integration	MovedHolidayComment	Text
    Moved Holiday — Note	The note added to the Moved Holiday — Comment on the original holiday after the Mondayisation integration runs. User prompt = No Mandatory = No. Default = #OriginalDate# holiday is shifted to #MondayisedDate#. Example: holiday is shifted to	MovedHolidayNote	Text
    Count Hours from Previous Night_Holiday	Controls whether the Check if Scheduled_Holiday parameter considers hours that fall after midnight from the previous day. User prompt = No Mandatory = Yes. Supported values: true: Consider hours that fall after midnight from the previous day. false (default): Do not consider hours that fall after midnight from the previous day.	CountHoursFromPreviousNightHoliday	Boolean
    Previous Night Minimum Hours	Minimum time in hours, to qualify hours from the previous night (hh:mm). User prompt = No Mandatory = Yes, if Count Hours from Previous Night_Holiday = true. Default = 00:01	PreviousNightMinimumHours	Text
    Future Days Count	Number of days in the future to look for holidays to Mondayise. User prompt = No Mandatory = Yes. Default = 0. Minimum value = 0. Maximum value = 5.	FutureDaysCount	Text
    Enforce MonTue Alignment	Controls whether to enforce Monday and Tuesday alignment for consecutive holidays. User prompt = No Mandatory = Yes. Supported values: true (default): When consecutive holidays fall on Saturday and Sunday, enforce Mondayisation of Saturday and Tuesdayisation of Sunday. false: When consecutive holidays fall on Saturday and Sunday, do not enforce Mondayisation of Saturday and Tuesdayisation of Sunday.	EnforceMonTueAlignment	Boolean
    Leave Paycode to count to Schedule	The paycode data access profile which contains leave paycodes that are considered as worked. User prompt = No Mandatory = Yes. Default = blank.	LeavePaycodeToCountToSchedule	Text

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

Fortnight settings

If the Lookback — Type process property is set to Fortnight, the integration checks previous fortnights to determine whether Saturdays or Sundays are normal work days.

If Lookback — Periods = 2, the integration checks 2 previous fortnights (4 weeks) to validate work days.

You can configure the integration to validate work days during one or both weeks of each fortnight as follows:

• If Fortnight — Qualify Both Weeks is true, validate work days if at least one occurrence during both weeks of each fortnight.
• If Fortnight — Qualify Both Weeks is false, validate work days if at least one occurrence during each fortnight.

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 Mondayisation_iPack_v4 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 default name 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

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, do the following:

1. To see detailed results, 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 make sure 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 name	Type	Resource path	Description
Retrieve Comments	GET	/v1/commons/comments	Returns a list of filtered comments.
Create Employment TermAssignment	POST	/v1/commons/persons/employment_terms	Creates and returns employment term assignments for one employee according to the specified parameters.
Update Integration Execution Details	POST	/v1/platform/integrations/update_status	Updates and returns the callback instance against the provided integration execution details.
Retrieve Persons	POST	v1/commons/persons/extensions/multi_read	Returns multiple person records based on search criteria.
Execute Hyperfind Query	POST	/v1/commons/hyperfind/execute	Executes a Hyperfind query by ID or qualifier and returns the result.
Update Timecard	POST	/v1/timekeeping/timecard	Updates a timecard for an employee as a manager.
Create Employment Terms	POST	/v1/timekeeping/setup/employment_terms	Creates an employment term.
Create Employment Term Schedule Pattern	POST	/v1/scheduling/employment_term_schedule_patterns/apply_create	Creates an Employment Term schedule pattern.
Retrieve Employment Term Assignments	GET	/v1/commons/persons/employment_terms/multi_read	Returns employment term memberships for multiple employees according to the specified parameters.
Retrieve Data	POST	/v1/commons/data/multi_read	Returns aggregated data by executing an ad hoc query.
Retrieve Employment Term	POST	/v1/timekeeping/setup/employment_terms	Returns Employment Terms.
Retrieve Schedule	POST	/v1/scheduling/schedule/multi_read	Returns a schedule pertaining to a set of employees or locations within a specified date range.
Submit Integration Execution Additional Details	POST	/v1/platform/integration_executions/{id}/additional_details	Submits all additional details related to an integration execution (API or batch) into system.
Retrieve Employment Term Schedule Pattern	POST	/v1/scheduling/employment_term_schedule_patterns/multi_read	Returns Employment Term schedule pattern entities based on the specified search criteria.
Retrieve Timecards as Manager	POST	v1/timekeeping/timecard/multi_read	Returns a list of timecards based on the employees or Hyperfind details provided.
Retrieve Paycode Data	POST	v1/timekeeping/setup/pay_codes/multi_read	Returns one or more paycodes available to the logged-in manager by object references.
Retrieve Paycode Data Access Profile	POST	v1/timekeeping/setup/pay_codes/data_access_profiles/multi_read	Returns a list of Paycode Data Access Profiles by object references.