Brazil Rounding Rules

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 Brazil Rounding Rules integration encourages employees to minimize the deviations between their scheduled and actual punch times. Employee punches are rounded to match scheduled shifts when certain conditions are met; otherwise, punches remain in their original state.

This integration provides an automated way of managing punch rounding compliance for punches that adhere to specified shift and punch tolerance limits. The integration automatically rounds these punches, and then assigns comments and notes to explain the timecard adjustments.

Regulations require that Extra time and Lost time calculations be based on deviations between an employee’s scheduled time and actual punch time.

  • Extra time: Occurs when employees work more than their scheduled time. Timecard punches that result in Early Shift In, Late Break Out, Early Break In, or Late Shift Out exceptions are examples of Extra time. For example, if an employee punches at 7:49 for a scheduled shift time of 8:00, Extra time = 11 minutes.

  • Lost time: Occurs when employees work less than their scheduled time. Timecard punches that result in Late Shift Start, Early Break Out, Late Break In, or Early Shift Out exceptions are examples of Lost time. For example, if an employee punches in at 8:08 for a scheduled shift time of 8:00, Lost time = 8 minutes.

The Brazil Rounding Rule is based on two components: Shift and Punch Tolerances.

  • Shift Tolerance: This component, typically set at 10 minutes, applies to Extra and Lost times. When Lost or Extra minutes exceed the shift tolerance, actual shift times remain in their original state; otherwise, punches are rounded to the scheduled time.

  • Punch Tolerance: This component, typically set at 5 minutes, applies to each individual punch. When punch deviation (actual minus scheduled) exceeds the punch tolerance, actual punches remain in their original state; otherwise, punches are rounded to the scheduled time.

For each shift, Shift Tolerance checks are evaluated first. These evaluations determine whether and how Punch Toleration applies to individual punches.

The system administrator configures the integration with Shift Tolerance = 10 minutes and Punch Tolerances = 5 minutes.

Use case 1 — Employee with meal break

Step 1 – Calculate lost and extra time

Determine Lost and Extra time by comparing scheduled and actual punches.

Calculate lost and extra time
  Shift In Break Out Break In Shift Out
Schedule 8:00 12:00 1:00 5:00
Actual punches 8:06 12:05 12:55 4:55
Lost and Extra time (in minutes) Lost = 6 Extra = 5 Extra = 5 Lost = 5

  • Total Lost time: 6 + 5 = 11

  • Total Extra time: 5 + 5 = 10

Step 2 – Evaluate Shift Tolerance limit using the total lost and total extra time calculations.

  • Total Lost time = 11 minutes, exceeding Shift Tolerance.

  • Total Extra time = 10 minutes, falling below Shift Tolerance.

Step 3 — Evaluate Punch Tolerance limit

Determine which shifts will be adjusted by comparing each punch with the 5-minute punch tolerance and 10-minute shift tolerance.

Evaluate Punch Tolerance limit
Punch type Punch time Evaluation
Shift In 8:06 No adjustment because the Shift Tolerance limit was exceeded for Lost minutes.
Break Out 12:05 Adjust to 12:00 because the Punch Tolerance limit was not exceeded.
Break In 12:55 Adjust to 1:00 because the Punch Tolerance limit was not exceeded.
Shift Out 4:55 No adjustment because the Shift Tolerance limit was exceeded for Lost minutes.

After the integration executes, the timecard displays punches rounded to the employee’s schedule. Comments and notes attached to the rounded punches explain the adjustments; these are visible in Punch Actions.

Adjusted timecard
Schedule In Out
8:00 – 5:00 8:06 12:00*
  1:00** 4:55
Punch Actions

*Comments and Notes:

Adjusted by Brazil Rounding Rules

Actual Punch: 12:05, Adjusted Punch: 12:00

Total Lost: 11, Total Extra: 10

Shift Tolerance: 10, Punch Tolerance: 05, Pay Rule: <Employee’s Pay Rule>

**Comments and Notes:

Adjusted by Brazil Rounding Rules

Actual Punch: 12:55, Adjusted Punch: 1:00

Total Lost: 11, Total Extra: 10

Shift Tolerance: 10, Punch Tolerance: 05, Pay Rule: <Employee’s Pay Rule>

 

Use case 2 — Employee without meal break

Step 1 – Calculate lost and extra time

Determine Lost and Extra time by comparing scheduled and actual punches.

Calculate lost and extra time
  Shift In Break Out Break In Shift Out
Schedule 8:00 N/A N/A 5:00
Actual punches 8:03 N/A N/A 5:05
Calculate Lost and Extra time (in minutes) Lost = 3 N/A N/A Extra = 5

  • Total Lost time: 3

  • Total Extra time: 5

Step 2 – Evaluate Shift Tolerance limit

  • Total Lost time = 3 minutes, falling below Shift Tolerance.

  • Total Extra time = 5 minutes, falling below Shift Tolerance.

Step 3 — Evaluate Punch Tolerance limit

Determine which shifts will be adjusted by comparing each punch with the 5-minute punch tolerance and 10-minute shift tolerance.

Evaluate Punch Tolerance limit
Punch type Punch time Evaluation
Shift In 8:03 Adjust to 8:00 because the Punch Tolerance limit was not exceeded.
Shift Out 5:05 Adjust to 5:00 because the Punch Tolerance limit was not exceeded.

After the integration executes, the Timecard displays punches rounded to the employee’s schedule. Comments and notes attached to the rounded punches explain the adjustments; these are visible in Punch Actions.

Schedule In Out
8:00 – 5:00 8:00* 5:00**

*Comments and Notes:

Adjusted by Brazil Rounding Rules

Actual Punch: 8:03, Adjusted Punch: 8:00

Total Lost: 03, Total Extra: 05

Shift Tolerance: 10, Punch Tolerance: 05, Pay Rule: <Employee’s Pay Rule>

**Comments and Notes:

Adjusted by Brazil Rounding Rules

Actual Punch: 5:05, Adjusted Punch: 5:00

Total Lost: 03, Total Extra: 05

Shift Tolerance: 10, Punch Tolerance: 05, Pay Rule: <Employee’s Pay Rule>

Brazil Rounding Rules considerations

  • Employees are assigned a single shift in a day that includes shifts which cross the day divide.

  • At a maximum, one scheduled break is scheduled during a shift.

  • When break punches are missing or a break has not been scheduled, only the shift In and Out punches are processed.

  • Managers must edit missing punches in the timecard.

  1. Configure Access to Integrations.
  2. Configure, or confirm the existence of pay rules that are assigned to employees who will be processed by the integration; see the Pay Rules topic.
Note:

  • The pay rule assignment can be made directly in People Information or indirectly through an Employment Term assigned to the employee.

  • If the pay rule contains a work rule assignment, the integration expects that the work rule configuration has a Round value = <None.>

  1. Configure a Comment, such as Adjusted by Brazil Rounding Rules, to identify rounded punches; see the Comments topic.
Note:

  • The comment must be configured with the Punches Category value.

  • The comment is assigned to Punch Comment Name in Integration Parameters.

  1. Deploy the BrazilRoundingRules_v1 integration.
  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: BrazilRoundingRules > BrazilRoundingRules_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.

  2. Select BrazilRoundingRules_v1_ProcessProperties to set process properties that must be configured before the integration can run.

    Brazil Rounding Rules — Control Properties
    Parameter Name Description Template parameter Parameter type Default value User prompt
    Hyperfind Name

    Employees for whom this integration will run.

    Only active employees are included for the selected time period.

    		 HyperfindName Hyperfind 1 True
    Person Number Comma-separated employee numbers to include for processing. Persons Numbers Text   True
    Processed SignedOff Data

    When true, the entire time period provided by the user is processed, regardless of signed-off status.

    When false, only the unsigned-off period is processed.

    		 Processed SignedOffData Boolean false True
    Punch Comment Name Comment applied to punch which identifies it as being rounded by the process. Punch Comment Name Text Adjusted by Brazil Rounding Rules False
    Run Integration for Default Timeframe

    When true, the integration processes the default time period.

    When false, the integration processes the period of time as defined in the Time frame property.

    		 Run Integration for default timeframe Boolean true True
    Shift Detection Range The range, in minutes, that the integration uses to detect Shift In and Shift Out punches. Shift Detection Range (in Minutes) Text 30 False
    Break Detection Range The range, in minutes, that the integration uses to detect Break In and Break Out punches. Break Detection Range (in Minutes) Text 15 False
    Time frame Identifies the date range or symbolic period for which the integration runs. Timeframe Time period   True
    Note:

    • If the parameter Run Integration for Default Timeframe is true, then this integration processes timecard data from the employee Signed-off Date +1 to the current date; otherwise, processing is based on the selected Time frame.

    • The suggested date range difference for the Time frame parameter is less than or equal to 90 days.

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:

    BrazilRoundingRules_v1_ToleranceConfig_CRT: Maps effective-dated Shift and Punch Tolerance values with their respective pay rules.

    Column headers and definitions:

    PayRule, Version, StartDate(dd/MM/yyyy), EndDate(dd/MM/yyyy), ShiftTolerance(h:mm), PunchTolerance(h:mm).

    • PayRule = Pay rule for which the integration executes.

    • Version = Allows the configuration of different effective-dated versions, so the rounding rules can be adjusted.

    • StartDate(dd/MM/yyyy) and EndDate(dd/MM/yyyy) = Date range during which the version applies.

    • ShiftTolerance(h:mm) = Shift tolerance threshold for the corresponding pay rule and date range.

    • PunchTolerance(h:mm) = Punch tolerance threshold for the corresponding pay rule and date range.

    Note:

    • The "PayRule" column supports the use of wildcards, which allow the integration to handle any pay rule not specifically listed in the CRT.

    • When the wildcard character (*) is used, it must appear in the last row of the table.

    • Date values entered in the StartDate(dd/MM/yyyy) and EndDate(dd/MM/yyyy) columms must adhere to the dd/MM/yyyy format.

    • Time values entered in the ShiftTolerance(h:mm) and PunchTolerance(h:mm) columns must adhere to the h:mm format.

    • The date and time tolerance columns must contain appropriate values for the integration to process.

    Brazil Rounding Rules ToleranceConfig_CRT — Sample
    PayRule Version StartDate(dd/MM/yyyy) EndDate(dd/MM/yyyy) ShiftTolerance(h:mm) PunchTolerance(h:mm)
    Full Time - Assembly 1 01/01/2022 31/12/2022 00:10 00:05
    Full Time - Assembly 2 01/01/2023 31/12/2023 00:12 00:05
    Full Time - Calibration 1 01/01/2022 31/12/2023 00:15 00:05

     

    BrazilRoundingRules_v1_Localization_CRT: Allows localization of messages in different languages.

    Column headers and definitions:

    Parameter Name, Locale Policy, Value, Description.

    • Parameter Name = Parameters defined in BrazilRoundingRules_v1_Localization_CRT process property.

    • Locale Policy = Locale Policy.

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

    • Description = Description shown in Additional Details; (optional) allows configuration of dynamic values.

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

    Brazil Rounding Rules - Localization_CRT — Sample
    Parameter Name Locale Policy Value Description
    CommentName_Invalid * Comment Name is required in PUNCHES category. Comment provided in control properties; should have PUNCH category.
    CommentNote_AdjustmentInfo * Actual Punch: <ActualPunch>, Adjusted Punch: <AdjustedPunch>

    Format to represent commentNote after adjustment of punches:

    <ActualPunch>: Punch time before adjustment.

    <AdjustedPunch>: Punch time after adjustment.

    Limit: 200 characters (optional field).
    CommentNote_TotalInfo * Total Lost: <TotalLost>, Total Extra: <TotalExtra>

    Format to represent commentNote after adjustment of punches:

    <TotalLost>: Total lost time calculated for the shift.

    <TotalExtra>: Total extra time calculated for the shift.

    Limit: 200 characters (optional field).
    Brazil Rounding Rules - Localization_CRT — Default values
    Parameter Name Default value Description

    CommentName_Invalid

    Comment Name is required in PUNCHES category.

    		 Displays when the comment defined in control properties does not have a category configuration.

    CommentNote_AdjustmentInfo

    Actual Punch: <ActualPunch>, Adjusted Punch: <AdjustedPunch>.

    (Optional)

    Identifies the format to use in the commentNote after punch adjustment.

    <ActualPunch> = Punch time before adjustment.

    <AdjustedPunch> = Punch time after adjustment.

    Limit: 200 characters.

    CommentNote_TotalInfo

    Total Lost: <TotalLost>, Total Extra: <TotalExtra>

    (Optional)

    Identifies the format to use in the commentNote after punch adjustment.

    <TotalLost> = Total lost time calculated for the shift.

    <TotalExtra> = Total extra time calculated for the shift.

    Llimit: 200 characters.

    CommentNote_ToleranceInfo

    Shift Tolerance: <ShiftTolerance>,

    Punch Tolerance: <PunchTolerance>,

    PayRule: <PayRule>

    (Optional)

    Identifies the format to use in the commentNote after punch adjustment.

    <ShiftTolerance>= Shift Tolerance defined in ToleranceConfig_CRT

    <PunchTolerance>= Punch Tolerance defined in ToleranceConfig_CRT

    <PayRule>= Employee's effective pay rule.

    Limit: 200 characters.
    DateRange_Invalid The selected date range cannot be the future date or more than 365 days or before the signed-off date. Displays when the date range selected for the integration is invalid.
    Disqualify_AdjustmentNotRequired

    <PunchDTM>: Punch Tolerance Limit exceeded or no adjustment required.

    		 Displays when the punch tolerance limit is exceeded.
    Disqualify_NoExtraTotal Total Extra(<totalExtra>): Shift Tolerance Limit Exceeded or no adjustment required for <punchDetails>

    Displays when total gain hours exceed the shift tolerance defined in ToleranceConfig_CRT.

    Punch details are separated by a semicolon (;).
    Disqualify_NoLossTotal Total Lost(<totalLost>): Shift Tolerance Limit Exceeded or no adjustment required for <punchDetails>

    Displays when total lost hours exceed the shift tolerance defined in ToleranceConfig_CRT.

    Punch details are separated by a semicolon (;).
    Disqualify_ToleranceNotFound Tolerance not found in CRT Displays when the punch date does not fall within the effective date range of an employee's pay rule.
    Disqualify_NoMinimumPunches Minimum Punch Not Found Displays when In and Out punches are not found on a date.
    Disqualify_InconsistentPunch Inconsistent or Minimum Punch Not Found Displays when a punch exception or punch override exists for any punch in a shift.
    Disqualify_NoShiftInOut Shift In/Out Not Found Displays when In and Out punches are not found within the respective shift range.
    Disqualify_PunchShiftNotFound Shift Or Punch Not Found Displays when no shift or punches are present.
    Disqualify_CRTInvalidRow Invalid Row Entry Found in CRT Displays when incorrect or missing values exist in the ToleranceConfig_CRT for Start Date, End Date, Shift Tolerance, or Punch Tolerance
    Disqualify_PeoplePayRuleNotInCRT Effective pay rule entry not found in CRT Displays when the effective pay rule is not defined in the ToleranceConfig_CRT.
    AdditionalDetails_PersonKeyName Person Number Identifies the appearance of the employee name in additional details when an error occurs.
    AdditionalDetails_PersonKeyValue <PersonNumber> Displays the employee for which the error occurs.
    AdditionalDetails_ShiftWithPersonKeyName Person Number (Shift Start - Shift End) Identifies the appearance of the employee's shift in additional details when an error occurs.
    AdditionalDetails_ShiftWithPersonKeyValue

    <PersonNumber>

    (<ShiftStartDate>

    <ShiftStartTime> - <ShiftEndDate>

    <ShiftEndTime>)

    Identifies the appearance of the employee's shift in additional details when an error occurs.

    <ShiftStartDate> = Shift start date

    <ShiftStartTime> = Shift start time

    <ShiftEndDate> = Shift end date

    <ShiftEndTime> = Shift end time
    AdditionalDetails_CRTInvalidRowKeyName CRT Pay Rule Name: version Identifies the appearance of the pay rule in additional details when an invalid row exists in the ToleranceConfig_CRT.
    AdditionalDetails_CRTInvalidRowKeyValue <CrtPayRuleName>:<CrtVersion> Displays when an invalid row exists in the ToleranceConfig_CRT.
    Error_DefaultMessage Error encountered during integration run. Refer to Process Reporting for more details. Displays when an error occurs during the integration run.
    Error_APIErrorMessage Unsuccessful response code received from API Displays when the API returns an unsuccessful response code.
    IntegrationStatus_SuccessMessage Integration has completed without errors. Displays when the integration completes without error.
    IntegrationStatus_SuccessWithDisqualify Integration has completed without errors. Additional details, such as disqualifications, may be accessible using the button below. Displays when the integration completes with partial success.
    IntegrationStatus_FailedMessage Process completed with record level errors. Displays when the integration fails or encounters errors.
    IntegrationStatus_FailedWithDisqualify Process completed with record level errors. Additional details, such as disqualifications, may be accessible using the button below. Displays when the integration contains disqualified records.
    RunSummary_IntegrationTypeName Integration Type Identifies the integration type label.
    RunSummary_FailedTransactions Failed Transactions Displays the number of failed transactions.
    RunSummary_DisqualifiedTransactions Disqualified Transactions Displays the number of disqualified transactions.
    RunSummary_SuccessfulTransactions Successful Transactions Displays the number of successful Transactions.
    RunSummary_ProcessedEmployees Processed Employees Displays the number of processed employees.
    RunSummary_InvalidEmployees Invalid Employees Displays count of invalid employees.
    RunSummary_IntegrationTypeValue Import Displays the type of integration: import or export.
    ValidationError_InvalidParameters Validation Error: <parameterName> Displays a list of parameters that caused the integration to stop processing.

  3. Select Override to:

    • Download the tables when you run the integration
    • Edit the table cells in Extensions
  4. Click Tap OK.

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

  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, 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 BrazilRoundingRules_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 for each Integration Parameter that supports the Brazil rounding rules process.

       

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

      Hyperfind Name
      Parameter Name(Required) Enter Hyperfind Name.
      Description(Optional)
      Template Parameter(Required) Select Hyperfind Name.
      Parameter Type(Required) Select Hyperfind.
      Default Value(Optional) Enter 1 = All Home.
      User Prompted

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

       

      (Required) Specify the Person Number that the Brazil Rounding Rule will process.

      Person Number
      Parameter Name(Required) Enter Person Number.
      Description(Optional)
      Template Parameter

      (Required) Enter Person Number.

      Parameter Type

      (Required) Select Text.

      Default Value(Optional) Enter Person Number.
      User Prompted

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

       

      (Required) Specify whether signed-off data is processed.

      Processed SignedOff Data
      Parameter Name(Required) Enter Processed SignedOff Data.
      Description(Optional)
      Template Parameter

      (Required) Select Processed SignedOff Data.

      Parameter Type

      (Required) Select Boolean.

      Default Value

      (Required)

      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.

       

      (Required) Specify whether the integration will process the default time frame.

      Run Integration for Default Timeframe
      Parameter Name(Required) Enter Run Integration for Default Timeframe.
      Description(Optional)
      Template Parameter

      (Required) Select Run Integration for Default Timeframe.

      Parameter Type

      (Required) Select Boolean.

      Default Value

      (Required)

      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.

       

      (Required) Specify whether the integration will process for a date range or symbolic time frame.

      Time Frame
      Parameter Name(Required) Enter Time Frame.
      Description(Optional)
      Template Parameter

      (Required) Select Time Frame.

      Parameter Type

      (Required) Select Time Period.

      Default Value(Optional) Enter a time frame.
      User Prompted

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

  13. Click Tap Save.
  14. 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 BrazilRoundingRules_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 Name: (Required) Select a hyperfind query of employees.
    • Person Number: (Optional) 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

    • Process SignedOff Data: (Required) Specify whether signed-off data is processed.
    • Run Integration for Default Timeframe: (Required) Specify whether the integration will process the default time frame.
    • Time Frame: (Required) Select a time frame.

  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
Process Callback Platform POST /v1/platform/integrations/update_status _WFD CallBack Update integration details.
Retrieve Locale Policy Commons GET /v1/commons/user_preferences/locale_policy _Retrieve Locale Policy Retrieve locale policy.
Retrieve Comments Commons POST /v1/commons/comments _Retrieve Comments The number of employees at a location.
Retrieve All PayRules Timekeeping GET /v1/timekeeping/setup/payrules?all_details=false _Retrieve & Store Pay Rules Retrieve all the pay rules.
Execute Hyperfind Commons POST /v1/commons/hyperfind/execute _Execute - Hyperfind Retrieve all shift details of person in Hyperfinds.
Retrieve Persons Extensions Commons POST /v1/commons/persons/extensions/multi_read _Retrieve Person Extensions Retrieve all shift details by person ID.
Timecard Multi Read Timekeeping POST /v1/timekeeping/timecard/multi_read _Timecard Multi Read Retrieve all punch details.
Schedule Multi Read Scheduling POST /v1/scheduling/schedule/multi_read _Retrieve Schedule Retrieve all scheduled shift details.
Enable Timecard Edits Timekeeping POST /v1/timekeeping/enable_edits/import _Enable Timecard Edits To enable editing in a signed off period.
Timecard Punch Update Timekeeping POST /v1/timekeeping/timecard _Timecard Punch Update To update rounded punches in timecard.