Flexible Break Adjustment

Note: This integration is an extension that 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 Flexible Break Adjustment integration adjusts breaks to allow employees flexibility when they take breaks and improve compliance with local rules.

  • Work rules no longer include standard break and deduction rules; instead, the integration imports those rules.
  • If an employee does not take a required break, the integration inserts a break adjustment with a work-rule transfer. This symbolic work rule does not affect the configuration, while the transfer stops the time for the calculated duration. The transfer is inserted in the shift so that it adjusts for premium or overtime zones, or transfers that are in effect. The system inserts a break or extends an existing break for the calculated duration.
  • The integration inserts an exception and comment to indicate and explain the adjustment.
  • After the break adjustment, the previously worked transfer string is restored: work rule > labor category > cost center > job.

The Flexible Break Adjustment integration adjusts breaks to allow employees flexibility when they take breaks and improve compliance with local rules.

This integration compares the actual worked hours (worked hours — all punched breaks) to the shift segments Parts of shifts that are assigned to a job in the business structure, either primary or transfer jobs. for breaks and the minimum-break threshold in the cross-reference table.

This topic describes how to configure the Flexible Break Adjustment integration.

Before you start

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

  1. Configure Access to Integrations.
  2. Hyperfind A search engine that filters and selects groups of employees through queries that specify conditions or locations (criteria).: Configure a hyperfind query for the employees as follows:
    • See the Hyperfind queries topic.
    • Example: FlexibleBreaksEmployees
    • In Ad Hoc, select No.
    • In Visibility, select Public.
  3. Work rule: Create a Break Adjustment work rule as follows:

    Note: This work rule is used for the adjustment and will be visible in the Timecard.

    1. Select Main Menu  > Administration > Application Setup> Pay Policies > Work Rule Building Blocks > Work Rules — see the Work Rules topic.
    2. Click Tap Create.
    3. In Name, enter Break Adjustment.
    4. In Version Effective Dates, select Beginning of time - forever and Create New Version Effective. Select the date.
    5. Select the General tab.
    6. In Pay Code for Unapproved Overtime, select Unapproved Overtime.
    7. In Pay Code for Denied Overtime, select Overtime to be Approved.
    8. Leave the rest of the options at the default settings of <None>.
    9. Assign the symbolic break rule to the work rule as follows:

      In Breaks, move Total Break Rule to Selected Breaks.

    10. Assign the deduction rule to the work rule as follows:

      In Bonuses/Deductions, move Total Break Deduction to Selected Bonuses/Deductions.

    11. Leave the Core Hours blank.
    12. Click Tap Save.
    13. In Maintenance > People, assign the Break Adjustment work rule to the employees who are in the hyperfind query.
  4. Break rule: Create a Total Break segment break rule as follows:
    1. Select Main Menu  > Administration > Application Setup > Pay Policies > Work Rule Building Blocks > Breaks — see the Breaks topic.
    2. In Name, enter Total Break segment.
    3. In Break Lengths, enter the following:

      Normal Length = 0:15.

      Medium Length = 0:00.

      Max Length = 2:00.

    4. In Break Settings, enter the following:

      In Relative to, select Scheduled Start.

    5. Leave the rest of the options at the default settings.
    6. Click Tap Save.
  5. Pay rule: Create the Flexible Breaks pay rule and assign the Break Adjustment work rule as follows:
    1. Select Main Menu  > Administration > Application Setup> Pay Policies > Pay Rules — see the Pay Rules topic.
    2. Click Tap Create.
    3. In Name, enter Flexible Breaks.
    4. In Version Effective Dates, select Beginning of time - forever and Create New Version Effective. Select the date.
    5. Select the Pay Rule tab.
    6. In Fixed Rule, select Weekly Mon - Scheduled in-day.
    7. In Processing Order, select <None>.
    8. In Punch Interpretation Rule, select Standard.
    9. Assign the work rule to this pay rule: In Default Work Rule, select Flexible Breaks.
    10. In Pay From Schedule, select Apply Pay Code Edits from employee's schedule.
    11. In Edits After Sign-off, select Enable edits manually or by payroll interface.
    12. Leave the rest of the options at the default settings of <None>.
    13. Click Tap Save.
  6. Fixed rule: Create and assign a fixed rule as follows:
    1. Select Main Menu  > Administration > Application Setup> Pay Policies > Pay Rule Building Blocks > Fixed Rules — see the Fixed Rules topic.
    2. Click Tap Create.
    3. In Name, enter Weekly Mon - Scheduled in-day.
    4. In Pay period type, select Days and enter 7. Select the Reference Date.
    5. In Hours belong to, select Scheduled in-day.
    6. Leave the rest of the options at the default settings.
    7. Click Tap Save.
  7. Punch interpretation rule: Create a punch interpretation rule as follows:
    1. Select Main Menu  > Administration > Application Setup> Pay Policies > Pay Rule Building Blocks > Punch Interpretation Rules — see the Punch Interpretation Rules topic.
    2. Click Tap Create.
    3. In Name, enter Standard.
    4. In Punch Restrictions, select Full.
    5. In Allow Overrides, select Yes.
    6. In Schedule Start, enter the following:

      Early Start Margin = 4:00.

      Early Start Restriction = 24:00.

      Late Start Restriction = 24:00.

      Late Start Margin = 4:00.

    7. In Missed In, enter the following:

      End Margin = 1:00.

    8. In Breaks, enter the following:

      Maximum Out = 0:30.

      Minimum Meal = 0:30.

      Enforce Breaks: Select No.

      Early Start Break Margin = 0:15.

      Late Start Break Margin = 0:15.

      Late End Break Margin = 0:15.

    9. In Schedule End, enter the following:

      Begin Early End Restriction = 24:00.

      Lift Early End Restriction = 24:00.

      Late End Restriction = 24:00.

    10. In Missed Out, enter the following:

      Missed Out Margin = 16:30.

    11. In Unscheduled, enter the following:

      Restrict unscheduled in-punches: Select No.

      Unscheduled Shift Length = 8:00.

    12. Click Tap Save.
  8. In Maintenance > People, assign the Flexible Breaks pay rule to the employees who are in the hyperfind query.
  9. Work rule: Create a Break Adjustment work rule to apply the adjustments or exceptions as follows:

    Note: This work rule will be visible in the Timecard.

    1. Select Main Menu  > Administration > Application Setup> Pay Policies > Work Rule Building Blocks > Work Rules — see the Work Rules topic.
    2. Click Tap Create.
    3. In Name, enter Break Adjustment.
    4. In Version Effective Dates, select Beginning of time - forever and Create New Version Effective. Select the date.
    5. Leave the rest of the options at the default settings of <None>.
    6. Assign the symbolic break rule to the work rule as follows:

      In Breaks, move Total Break Rule to Selected Breaks.

    7. Assign the deduction rule to the work rule as follows:

      In Bonuses/Deductions, move Total Break Deduction to Selected Bonuses/Deductions.

    8. Leave the Core Hours blank.
    9. Click Tap Save.
  10. Break rule: Create a break rule for the Exception work rule as follows:
    1. Select Main Menu  > Administration > Application Setup > Pay Policies > Work Rule Building Blocks > Breaks — see the Breaks topic.
    2. Click Tap Create.
    3. In Name, enter Total Break Rule.
    4. In Break Lengths, enter the following:

      Normal Length = 0:00.

      Medium Length = 0:00.

      Max Length = 1:30.

      5. Caution: Use one amount for the entire organization; that is, the maximum amount of breaks as specified in the legislation.​

    5. In Break Settings, enter the following:

      In Relative to, select 12 Midnight.

    6. Click Tap Save.
  11. Deduction rule: Create a deduction rule that includes the deduction amount for the Exception work rule as follows:
    1. Select Main Menu  > Administration > Application Setup > Work Rule Building Blocks > Bonus/Deductions — see the Bonus and Deductions topic.
    2. Click Tap Create.
    3. In Name, enter Total Break Deduction.
    4. In Amount, enter —1:30.

      Caution: Use one amount for the entire organization; that is, the maximum amount of breaks as specified in the legislation.​

    5. In Applies on, select all of the days.
    6. Select Is Exception to generate a break exception when adjustments occur.
    7. Leave Pay code and Cancel if break taken at the default settings.
    8. In Allow cancellation in timecard, select Yes.
    9. In Shift Restriction, select Do not use shift restriction.
    10. In Trigger, select the following:

      Use rounded shift boundary times: Select Yes.

      Short break exception disqualifies break: Select No.

    11. Leave the rest of the options at the default settings.
    12. Click Tap Save.
  12. Comments: Configure comments as follows:
    1. Select Main Menu  > Administration > Application Setup > Common Setup > Comments — see the Comments topic.
    2. Click Tap Create.
    3. In Comment Text, enter Adjustment by Integration.
    4. Leave the rest of the options at the default settings.
    5. In Categories, move Break Exceptions, Pay Codes, and Punches to Selected Categories.
    6. Click Tap Save.

  13. Combined paycode A category of time or money that employees earn, for example, Regular Hours, Bonus, or Sick.: Create a combined paycode that includes all paycodes that this integration excludes as follows:

    1. Select Main Menu  > Administration > Application Setup > Pay Policies > Paycodes > Combined Paycodes — see the Combined Paycodes topic.
    2. Click Tap Create.
    3. In Name, enter Break Adjustment Override.
    4. In Apply As Of, select the effective date.
    5. In Summarize in, select Hours.
    6. Select Visible in Report Options and Report Totals.
    7. Select Visible on Totals tab in Timecard.
    8. In Available Paycodes, select the ANNUAL LEAVE, PERSONAL LEAVE UNPAID, and Sick paycodes, and click the right arrow to move them to Selected Paycodes.
    9. Click Tap Save.
  14. Get the URL, User, and Password for the APIGatewayServer.
  15. Deploy the FlexibleBreakAdjustment integration pack; see the Deploy Integrations topic.

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. Scroll to and select the integration pack: Flexible Break Adjustment > FlexibleBreakAdjustment-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 dropdown list, select and configure the following:

    Connection Settings
    Setting Required Actions
    APIGatewayServer Required

    (Optional) To change the default API gateway server:

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

      Example: <tenantURL>/api
    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:

    1. For each field, clear Use Default.
    2. 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.

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

    Process Properties
    Property Required Actions
    Hyperfind ID Required

    Default = 1 (shown as blank) which indicates All Home A query that returns a list of employees associated with a manager's employee group. All Home finds people who are active employees or active users as of today. and includes all active employees.

    To use a Hyperfind query for another group of employees:

    1. Clear Use Default.
    2. Enter the ID of the Hyperfind.
      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.
    Symbolic Period Required

    Symbolic name for the pay period or date range:

    1. Clear Use Default. 
    2. Enter one of the following symbolic values for the pay period:
      • 1 (Default) = Current Pay Period
      • 0 = Previous Pay Period
    Break Segment Min Amount Required

    Define the minimum length of time that qualifies as a break:

    Default = 00:01.

    1. Clear Use Default.
    2. Enter a duration; use the format hh:mm.
    Break Adjustment Override — Paycode Not required

    Select the combined paycode to exclude when the integration runs:

    Default = blank, no paycode is excluded.

    1. Clear Use Default.
    2. Select the Break Adjustment Override combined paycode.
    Break Adjustment — Execution Not required

    Specify the method to run the integration:

    1. Clear Use Default.
    2. Select one of the following:
      • Immediate (default)
      • Increment
    Break Adjustment Override — Paycode Min Amount Not required

    Define the minimum length of break to exclude the Break Adjustment Override paycode:

    Caution: Break Adjustment Override — Paycode must not be blank.

    Default = 00:01.

    1. Clear Use Default.
    2. Enter a duration; use the format hh:mm.
    Break Exception Work Rule Not required

    The work rule that is used for exceptions:

    1. Clear Use Default.
    2. Select the Exception or Break Adjustment Override work rule.
    Break Placement — No Break Taken Not required

    Define the position in the shift of the Exception work rule when no break is taken:

    Default = Threshold+Previous.
    Break Placement — Short Total Break Not required

    Default = Last Break Segments.
    Break Adjustment — Comment Selection Not required

    The comment that the Timecard displays when punches are updated:

    Default = blank.

    1. Clear Use Default.
    2. Select one of the following comments:
      • Break Exceptions
      • Paycodes
      • Punches
    Break Adjustment — Include Prior Deductions in Totals Not required

    Select whether to consider prior deductions in totals:

    1. Clear Use Default.
    2. Select one of the following:
      • true
      • false (default)
    Break Adjustment — Back Tracking Notes Not required

    Specify notes to separate backtrack punches from normal punches:

    Default = blank.

    1. Clear Use Default.
    2. Enter a note.
    Translate Source Codes Via CRT Required

    Default = false.

    Set this property to use the ThresholdRules_CRT cross-reference table to get the accrual policy Defines how and when balances for accrual codes are credited and debited. details for employees:

    1. Clear Use Default.
    2. Select true.
    Overtime Approval Not required

    Select whether unapproved time will not count towards the total hours worked calculation:

    1. Clear Use Default.
    2. Select one of the following:
      • true (default)
      • false
    Rounded Punches Not required

    Select whether the rounded punch time will be used to calculate the total hours worked:

    1. Clear Use Default.
    2. Select one of the following:
      • true (default)
      • false

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 dropdown list, select the _ThresholdRules_CRT cross-reference table to get the accrual policy details for employees:

    • ThresholdRules_CRT

      Column headers:

      Work Rule, Worked Hours, Paid Amount, Total Break, Break No.

  3. Select Override to:

    • Download the tables when you run the integration
    • Edit the table cells in Extensions
  4. When you finish, click tap OK.
API details
API name API section Type Resource path Location
Retrieve Timecards—Manager Timekeeping POST /v1/timekeeping/timecard/multi_read _Get TimeCard Data
Retrieve Comments Commons GET v1/commons/comments _Retrieve Comment
Add Timecard Timekeeping POST /v1/timekeeping/timecard _Timecard Edit
Update Timecard Timekeeping POST /v1/timekeeping/timecard _Timecard Edit
Status update Platform POST /v1/platform/integrations/update_status _WFD CallBack
Retrieve All Integration Executions Platform POST /v1/platform/integration_executions/ _Submit Integration Details
Retrieve Symbolic period Commons POST /v1/commons/symbolicperiod/read _GetPayperiodDates
Retrieve Signoff date Commons POST /v1/commons/persons/extensions/multi_read _GetSignoffDate
Get Timecard Data Timekeeping POST /v1/timekeeping/timecard_metrics Measures and tracks workforce performance by comparing planned with actual workload or coverage, or by showing variances at any organizational level./multi_read _Get TimeCard Metrics Data
Retrieve Employees from Hyperfind Commons POST /v1/commons/hyperfind/execute _Execute - Hyperfind
Get Symbolic Period Commons GET /v1/commons/symbolicperiod _GetPayperiodDates

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 an appropriate, unique, and descriptive Integration Name.
  4. (Optional) Enter a Description.
  5. Do not select API Integration.
  6. In File Access, select None to not select a connection.
  7. (Optional) If the person who runs the integration 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.

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

  9. Email Notifications

    (Optional)

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

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

      Completed — The integration ran successfully without errors.

      Failed — The integration ran successfully, but one or more records have errors. The integration run is treated as failed. If Abort on Failure is configured in an integration set A sequence of integrations that can be run on-demand or be scheduled., the integration set stops.

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

  10. In Skip Configuration, select None (default) to allow multiple integrations to run at the same time or with the same data without restrictions.
  11. Do not select Allow Minute Interval.
  12. Integration template and parameters
    1. In Integration Template, select FlexibleBreakAdjustment-v1.
    2. Click Tap Assign .
    3. (Optional) In Integration Parameters, you can override default settings.
    4. Specify the following parameters:

      (Required) Specify the default hyperfind query that contains the employees:

      Click Tap Create .

      Hyperfind ID
      Parameter Name(Required) Enter Hyperfind ID.
      Description(Optional)
      Template Parameter

      (Required) Select Hyperfind ID.

      Parameter Type

      (Required) Select Text.

      Default Value(Optional)
      User Prompted

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

      Click Tap Save.

      (Optional) Specify the symbolic name for the pay period or date range:

      Click Tap Create .

      Symbolic Period
      Parameter Name(Required) Enter Symbolic Period.
      Description(Optional)
      Template Parameter

      (Required) Select Symbolic Period.

      Parameter Type

      (Required) Select Text.

      Default Value

      (Optional)

      User Prompted

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

      Click Tap Save.

      (Optional) Specify the minimum length of time that qualifies as a break:

      Click Tap Create .

      Break Segment Min Amount
      Parameter Name(Required) Enter Break Segment Min Amount.
      Description(Optional)
      Template Parameter

      (Required) Select Break Segment Min Amount.

      Parameter Type

      (Required) Select Text.

      Default Value(Optional) Enter a duration; use the format hh:mm. Example: 00:01
      User Prompted

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

      Click Tap Save.

      (Optional) Specify the combined paycode to exclude when the integration runs:

      Click Tap Create .

      Break Adjustment Override — Paycode
      Parameter Name(Required) Enter Break Adjustment Override — Paycode.
      Description(Optional)
      Template Parameter

      (Required) Select Break Adjustment Override — Paycode.

      Parameter Type

      (Required) Select Text.

      Default Value(Optional) Enter the Break Adjustment Override combined paycode.
      User Prompted

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

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

      Click Tap Save.

      (Optional) Specify the method to run the integration:

      Click Tap Create .

      Break Adjustment — Execution
      Parameter Name(Required) Enter Break Adjustment — Execution.
      Description(Optional)
      Template Parameter

      (Required) Select Break Adjustment — Execution.

      Parameter Type

      (Required) Select Text.

      Default Value

      (Optional) Select one of the following:

      • Immediate (default)
      • Increment
      User Prompted

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

      Click Tap Save.

      (Optional) Specify the minimum length of break to exclude the Break Adjustment Override paycode:

      Click Tap Create .

      Break Adjustment Override — Paycode Min Amount
      Parameter Name(Required) Enter Break Adjustment Override — Paycode Min Amount.
      Description(Optional)
      Template Parameter

      (Required) Select Break Adjustment Override — Paycode Min Amount.

      Parameter Type

      (Required) Select Text.

      Default Value(Optional) Enter a duration; use the format hh:mm. Example: 00:01
      User Prompted

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

      Click Tap Save.

      (Optional) Specify the work rule that is used for exceptions:

      Click Tap Create .

      Break Exception Work Rule
      Parameter Name(Required) Enter Break Exception Work Rule.
      Description(Optional)
      Template Parameter

      (Required) Select Break Exception Work Rule.

      Parameter Type

      (Required) Select Text.

      Default Value(Optional) Enter the Exception or Break Adjustment Override work rule.
      User Prompted

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

      Click Tap Save.

      (Optional) Specify the position in the shift of the Exception work rule when no break is taken:

      Click Tap Create .

      Break Placement — No Break Taken
      Parameter Name(Required) Enter Break Placement — No Break Taken.
      Description(Optional)
      Template Parameter

      (Required) Select Break Placement — No Break Taken.

      Parameter Type

      (Required) Select Text.

      Default Value(Optional) Enter Threshold+Previous.
      User Prompted

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

      Click Tap Save.s

      (Optional) Specify the short total break:

      Click Tap Create .

      Break Placement — Short Total Break
      Parameter Name(Required) Enter Break Placement — Short Total Break.
      Description(Optional)
      Template Parameter

      (Required) Select Break Placement — Short Total Break.

      Parameter Type

      (Required) Select Text.

      Default Value(Optional) Enter Last Break Segments.
      User Prompted

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

      Click Tap Save.

      (Optional) Specify the comment that the Timecard displays when punches are updated:

      Click Tap Create .

      Break Adjustment — Comment Selection
      Parameter Name(Required) Enter Break Adjustment — Comment Selection.
      Description(Optional)
      Template Parameter

      (Required) Select Break Adjustment — Comment Selection.

      Parameter Type

      (Required) Select Text.

      Default Value

      (Optional) Enter one of the following comments:

      • Break Exceptions
      • Pay Codes
      • Punches
      User Prompted

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

      Click Tap Save.

      (Optional) Specify whether to consider prior deductions in totals:

      Click Tap Create .

      Break Adjustment — Include Prior Deductions in Totals
      Parameter Name(Required) Enter Break Adjustment — Include Prior Deductions in Totals.
      Description(Optional)
      Template Parameter

      (Required) Select Break Adjustment — Include Prior Deductions in Totals.

      Parameter Type

      (Required) Select Boolean.

      Default Value(Optional) Enter false.
      User Prompted

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

      Click Tap Save.

      (Optional) Specify notes to separate backtrack punches from normal punches:

      Click Tap Create .

      Break Adjustment — Back Tracking Notes
      Parameter Name(Required) Enter Break Adjustment — Back Tracking Notes.
      Description(Optional)
      Template Parameter

      (Required) Select Break Adjustment — Back Tracking Notes.

      Parameter Type

      (Required) Select Text.

      Default Value(Optional)
      User Prompted

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

      Click Tap Save.

      (Optional) Specify whether to use the ThresholdRules_CRT cross-reference table to get the accrual policy details employees:

      Click Tap Create .

      Translate Source Codes Via CRT
      Parameter Name(Required) Enter Translate Source Codes Via CRT.
      Description(Optional)
      Template Parameter

      (Required) Select Translate Source Codes Via CRT.

      Parameter Type

      (Required) Select Boolean.

      Default Value(Optional) Enter true.
      User Prompted

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

      Click Tap Save.

    (Optional) Select whether unapproved time will not count towards the total hours worked calculation:

    Click Tap Create .

    Overtime Approval
    Parameter Name (Required) Enter Overtime Approval.
    Description (Optional)
    Template Parameter

    (Required) Select FlexibleBreak Overtime.
    Parameter Type

    (Required) Select Boolean.
    Default Value (Optional) Enter true.
    User Prompted

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

    Click Tap Save.

    (Optional) Select whether the rounded punch time will be used to calculate the total hours worked:

    Click Tap Create .

    Rounded Punches
    Parameter Name (Required) Enter Rounded Punches.
    Description (Optional)
    Template Parameter

    (Required) Select Rounded Punches.
    Parameter Type

    (Required) Select Boolean.
    Default Value (Optional) Enter true.
    User Prompted

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

    Click Tap Save.

  13. Click Tap Save.
  14. Make sure that the generic data access profiles (GDAP) allow access by the people who need to run the installed integrations. Select Administration > Application Setup > Integrations Setup > Access Profiles; see Configure Access to Integrations.

Run integrations to test that the configuration is set up correctly.

  • Initial: For the initial run of the integration, process all historical pay statements.
  • Scheduled: For subsequent runs, schedule this integration to export the payroll data only for employees who had changes or corrections made to their timecard.

Run the integration

  1. Select the integration:
    1. Select Main Menu  > Maintenance > Integrations. 
    2. Click Tap Run an Integration . 
    3. Select the FlexibleBreakAdjustment-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 default name ends with a date and time stamp.
  2. Set parameters as follows:
    • Hyperfind ID: Default = All Home. (Not recommended) You can select a different hyperfind query.
    • Symbolic Period: (Optional)
    • Break Segment Min Amount: (Optional)
    • Break Adjustment Override — Paycode: (Optional)
    • Break Adjustment Override — Execution: (Optional)
    • Break Adjustment Override — Paycode Min Amount: (Optional)
    • Break Exception Work Rule: (Optional)
    • Break Placement — No Break Taken: (Optional)
    • Break Placement — Short Total Break: (Optional)
    • Break Placement — Include Prior Deductions in Totals: (Optional)
    • Break Placement — Back Tracking Notes: (Optional)
    • Translate Source Codes Via CRT: (Optional) Specify whether to use the ThresholdRules_CRT cross-reference table to get the accrual policy details for the employees.
    • Overtime Approval: (Optional)
    • Rounded Punches: (Optional)

  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 check the results in more detail, do the following:

  1. To see detailed results, click tap the tile A container that provides navigation or action from its summary view. 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 Schedule Integrations topic.