Brazil Rounding Rules

• Comments: Configure a Comment, such as Adjusted by Brazil Rounding Rules, to identify rounded punches. Select the Punches category.

  See the Comments topic.

  Note: The comment is assigned to Punch Comment Name in Integration Parameters.
• Pay rules: 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.>

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

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

Click Tap Install.

1. Select the environment
   1. Select the Manage tab > Atom Management.
   2. Select your environment.
2. 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: Brazil Rounding Rules > BrazilRoundingRules_iPack_v2.

1. Select Connection Settings.

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

   Connection Settings

   Connection Settings for the integration

   Setting	Required	Actions
   BrazilRoundingRules_iPack_v2_APIGatewayServer	Required	To change the default API gateway server: Clear Use Default. Enter the URL to the server. Example: <tenantURL>/api
   BrazilRoundingRules_iPack_v2_ToleranceConfig_CRT	Required	Enable Override.
   BrazilRoundingRules_iPack_v2_Locale_CRT	Required	Enable Override.

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 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_iPack_v2_CRTConfig to set process properties that must be configured before the integration can run. This main process starts the integration process and handles errors.

1. Select Cross Reference.
2. From the Cross Reference list, select a BrazilRoundingRules_iPack_v2 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.
5. Repeat the steps for each of the BrazilRoundingRules tables.
   • BrazilRoundingRules_iPack_v2_ToleranceConfig_CRT: Maps effective-dated Shift and Punch Tolerance values with their respective pay rules.

     Brazil Rounding Rules — Tolerance Config CRT structure

     Brazil Rounding Rules— Tolerance Config CRT

     Column name	Description
     PayRule	Pay rule for which the integration executes. Note: 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.
     Version	Allows the configuration of different effective-dated versions, so the rounding rules can be adjusted.
     StartDate(dd/MM/yyyy)	Start of the pay rule version date range. Caution: The value must adhere to the dd/MM/yyyy format.
     EndDate(dd/MM/yyyy)	End of the pay rule version date range. Caution: The value must adhere to the dd/MM/yyyy format.
     Shift Tolerance(h:mm)	Shift tolerance threshold for the corresponding pay rule and date range. Caution: The value must adhere to the h:mm format.
     Punch Tolerance(h:mm)	Punch tolerance threshold for the corresponding pay rule and date range. Caution: The value must adhere to the h:mm format.

     Note:

     The shift and punch tolerance columns must contain appropriate values for the integration to process.

   • BrazilRoundingRules_iPack_v2_Locale_CRT: Allows translation of messages into different languages.

     Brazil Rounding Rules — Locale CRT structure

     Absence-Based Accrual Adjustment — Locale CRT structure

     Column name	Description
     Parameter Name	Key for which localization is defined.
     Locale Policy	Locale Policy. You can use an asterisk ( *) as a wildcard, but put the less-restrictive locale policy names at the bottom of the table because the integration scans cross-reference tables from the top.
     Value	Message shown in Additional Details, or value of the label defined in the Run Summary section. Example: Comment was not provided.
     Description	The description that is shown in Additional Details. Example: The employee is not assigned a shift.

     Note:

     • Localization of integration extensions remains optional, but is supported.

     • The cross-reference table (CRT) holds all messages represented with standard English labels; these apply to all locales when the Locale is set to a wildcard (*).

     • Some or all messages can be translated by adding lines to the table in their preferred translation for specific locales. Messages for the most commonly used Locale Policy should be defined at the top of the CRT.

     • Names of the parameters in the CRT column "Parameter Name" must be used as is. If any parameter value needs to be localized for a different Locale Policy, copy the "Parameter Name" with the * Locale Policy, add a new row to the CRT with the appropriate Locale Policy, and then add the localized values in the Message (or Value) and Description CRT columns.

     • Do not enter values in the CRT column "Description" if it is blank.

     • Do not modify placeholders (<>) or the configurable values that are included in the CRT column "Message" (or "Value").

     Sample Locale CRT content

     Sample Locale CRT content

     Parameter Name	Locale Policy	Value	Description
     Error_CommentNameInvalid	*	The Comment must be configured with the Punches category.	Comment entered in control properties must be configured with the Punches category.
     Error_DateRangeInvalid	*	The selected date range cannot exceed 365 days, be a future date or fall before the signed-off date.	When date range selected for the integration is invalid. For example, exceeds 365 days, or occurs in the future, or falls before the signed-off date when sign-off data is false.
     Error_DefaultMessage	*	Error encountered during integration run. Refer to Process Reporting for more details.	Default error message.
     Error_InvalidParameters	*	Validation Error : <parameterName>	Shows all incorrectly configured parameters that caused the integration to stop.
     Label_DisqualifiedTransactions	*	Disqualified Transactions	Label that displays count of disqualified transactions.
     Label_FailedMessage	*	Process completed with record level errors.	Label that displays due to failure or errors.
     Label_FailedWithDisqualify	*	Process completed with record level errors. Additional details, such as disqualifications, may be accessible using the button below.	Label that displays when records are disqualified.
     Label_FailedTransactions	*	Failed Transactions	Label that displays count of failed transactions.
     Label_IntegrationTypeName	*	Integration Type	Label that displays integration type whether import or export
     Label_IntegrationTypeValue	*	Import	Displays either import or export integration type.
     Label_InvalidEmployees	*	Invalid Employees	Label that displays count of invalid employees.
     Label_ProcessedEmployees	*	Processed Employees	Label that displays count of processed employees.
     Label_SuccessfulTransactions	*	Successful Transactions	Label that displays count of successful transactions.
     Label_SuccessMessage	*	Integration completed without errors.	Success message when Integration completes without error.
     Label_SuccessWithDisqualify	*	Integration completed without errors. Additional details, such as disqualifications, may be accessible using the button below.	Message shown when Integration completes with partial success.
     Message_AdjustmentNotRequired	*	<PunchDTM>: Punch Tolerance Limit exceeded or no adjustment required.	If punch tolerance limit is exceeded for any punch then no adjustment will take Place. <PunchDTM>: punch Date and time
     Message_CommentNoteAdjustmentInfo	*	Actual Punch : <ActualPunch> , Adjusted Punch : <AdjustedPunch>	Format that represents commentNote after adjustment of punches. <ActualPunch>: Punch time before adjustment <AdjustedPunch>: Punch time after adjustment Max Limit: 200 Characters, this is an optional field.
     Message_CommentNoteToleranceInfo	*	Shift Tolerance: <ShiftTolerance>, Punch Tolerance: <PunchTolerance>, PayRule: <PayRule>	Format that represents commentNote after adjustment of punches. <ShiftTolerance>: Shift Tolerance that was selected from CRT <PunchTolerance>: Punch Tolerance which was selected from CRT <PayRule>: PayRule name of person Max Limit: 200 Characters, this is an optional field
     Message_CommentNoteTotalInfo	*	Total Lost: <TotalLost>, Total Extra: <TotalExtra>	Format that represents commentNote after adjustment of punches. <TotalLost>: Total lost time calculated for that shift <TotalExtra>: Total extra time calculated for that shift Max Limit: 200 Characters, this is an optional field
     Message_CRTInvalidRow	*	Invalid row entry found in CRT.	Occurs when the format (Date, ShiftTolerance,PunchTolerance) is wrong or the value was not entered in CRT.
     Message_CRTInvalidRowKeyName	*	Process completed with errors. Click additional details for more info.	Message that displays when records are disqualified.
     Message_CRTInvalidRowKeyValue	*	<CrtPayRuleName>: <CrtVersion>	<CrtPayRuleName>: Payrule name associated with an invalid row. <CrtVersion>: Payrule version number associated with an invalid row in the CRT.
     Message_InconsistentPunch	*	Inconsistent or Minimum Punch not found.	Message that displays when an exception or punch override exists in the shift.
     Message_NoExtraTotal	*	Total Extra (<totalExtra>): Shift Tolerance Limit exceeded or no adjustment required for <punchDetails>	When total gain exceeds shift tolerance provided in CRT for the specific payrule. <totalExtra>: Extra time <punchDetails>: List of punches that contribute to the shift tolerance limit excess (separated by ";").
     Message_NoLossTotal	*	Total Lost (<totalLost>): Shift Tolerance Limit was exceeded or no adjustment is required for <punchDetails>.	When total loss exceeds shift tolerance provided in CRT for the specific payrule. <totalExtra>: Extra time <punchDetails>: List of punches that contribute to the shift tolerance limit excess (separated by ";").
     Message_NoMinimumPunches	*	Minimum punch not found.	Message that displays if the shift is disqualified when one or no punches are found.
     Message_NoShiftInOut	*	Shift In/Out not found.	Message that displays when the first In punch or the last out Punch is not found within the shift range bracket.
     Message_PersonKeyName	*	Person Number	Format for data represented in additional details when an error occurs.
     Message_PersonKeyValue	*	<PersonNumber>	<PersonNumber>: PersonNumber that generated the error.
     Message_PeoplePayRuleNotInCRT	*	Effective pay rule entry not found in CRT.	Message that displays when effective payrule is not found in CRT.
     Message_PunchShiftNotFound	*	Shift Or Punch not found.	Message that displays when shift or punches are not present.
     Message_ShiftWithPersonKeyName	*	Person Number (Shift Start - Shift End)	Format for data represented in additional details that defines the shift where error occurred.
     Message_ShiftWithPersonKeyValue	*	<PersonNumber> (<ShiftStartDate> <ShiftStartTime> - <ShiftEndDate> <ShiftEndTime>)	<PersonNumber>: Person Number that generated an error <ShiftStartDate>: Shift start date for shift identification <ShiftStartTime>: Extra information for shift start time <ShiftEndDate>: Shift End date for shift identification <ShiftEndTime>: Extra information for shift end time
     Message_ToleranceNotFound	*	Tolerance not found in CRT.	Message that displays when the provided date does not align with effective pay rules in the CRT.

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.

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

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.

1. In Integration Template, select BrazilRoundingRules_iPack_v2.
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.

   Integration parameters

   Integration parameters

   Parameter Name	Description / Default value / User prompt	Template parameter	Parameter type
   Hyperfind Name	Employees for whom this integration will run. Only active employees are included for the selected time period. Default = 1 User prompt = Yes Mandatory = Yes	HyperfindName	Hyperfind
   Person Number(s)	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 = Yes	PersonNumber(s)	Text
   Processed SignedOff Data	Determines whether signed-off data is process. true= The entire time period provided by the user is processed, regardless of signed-off status. false(default) = Only the unsigned-off period is processed. User prompt = No Mandatory = Yes	ProcessedSignedOffData	Boolean
   Run Integration for Default Timeframe	Determines the processing timeframe. true(default) = The integration processes the default time period. false= The integration processes the period of time as defined in the Time frame property. User prompt = No Mandatory = Yes 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.	RunIntegrationforDefaultTimeframe	Boolean
   Break Detection Range	The range, in minutes, that the integration uses to detect Break In and Break Out punches. Default = 15 User prompt = No Mandatory = Yes	BreakDetectionRange(in Minutes)	Text
   Punch Comment Name	Comment applied to punch which identifies it as being rounded by the process. Default = Adjusted by Brazil Rounding Rules User prompt = No Mandatory = No	PunchCommentName	Text
   Shift Detection Range	The range, in minutes, that the integration uses to detect Shift In and Shift Out punches. Default = 30 User prompt = No Mandatory = Yes	ShiftDetectionRange(in Minutes)	Text
   Time frame	Identifies the date range or symbolic period for which the integration runs. Default = Time period User prompt = Yes Mandatory = Yes Caution: The suggested date range difference for the Time frame parameter is less than or equal to 90 days.	Timeframe	Time period

See Configure Access to Integrations .

1. Select the integration:
   1. Select Main Menu Maintenance > Integrations.
   2. Click Tap Run an Integration .
   3. Select the BrazilRoundingRules_iPack_v2 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: 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

   • Time Frame: 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.

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.