This chapter discusses how to:
Set up utilities in Global Payroll for Brazil.
Set up Global Payroll for Brazil data.
Use core functionality in Brazil.
View delivered sections and process lists.
To set up utilities in Global Payroll for Brazil, use the Define Variable Attributes BRA (GPBR_COMP_VARS) and the Map Elems to Comp/Rcd BRA (GPBR_ELEM_MAP) components.
This section provides an overview of element mapping and discusses how to:
Define component variables.
Define element mapping.
Note. This setup is optional and is designed to help technical people manipulate PIN numbers during development.
The element map plays a critical role when packaging and moving elements and data to other databases.
PIN numbers are used in PeopleCode, component interfaces, and reports to refer to global elements. The PIN number is a consecutive number so it can change between databases or releases; therefore, there is a need to create a utility during development so that the PIN number is not hard-coded. Using the utility also ensures consistency between the PIN number changes.
There are two ways to map an element:
By record
By component
Select record when you need to map a record field into a core Global Payroll element.
Select component when the mapping doesn't depend on a record field; instead, it depends on some behavior on the page, for example, the record is used in more than one place and must map to different core Global Payroll elements.
If you select to map an element by component, you may want to define your component variables on the Component Variables page before you define your element mapping.
PeopleCode Function Example
When you need to use a PIN number in the PeopleCode, use this function to obtain the corresponding PIN number.
Declare Function Get_Pin_Num PeopleCode GPBR_DERIVED_EM.PIN_NUM FieldFormula; &Record_Name = "GPBR_LOAN"; &Date_Pin_Num = Get_Pin_Num ("R", &Record_Name, "DATE");
Page Name |
Object Name |
Navigation |
Usage |
GPBR_COMP_VARS |
Set Up HRMS, Product Related, Global Payroll & Absence Mgmt, Elements, Define Variable Attributes BRA |
Define the variables for components to be used on the Element Mapping page to define the variable type. |
|
GPBR_ELEM_MAP |
Set Up HRMS, Product Related, Global Payroll & Absence Mgmt, Elements, Map Elems to Comp/Rcd BRA |
Set up the mapping to the fields and variables of an element which are used during development in the components interface objects. |
Access the Component Variables page.
Variable Name |
Enter the name of the variable. This can be any name you want to use during PeopleCode development. |
Variable Type |
Select the variable type. Values include Character, Date, and Numeric. Note. Once you've defined your component variables, you can map your elements on the Element Mapping page. |
Access the Element Mapping page.
If you choose to map your elements by component, you may want to define your component variables before you map your elements.
Type |
The key type that your mapping applies to appears here. Values include Other and Field. |
Map Value |
Select the field or value to which you want to map. If you selected Record as the key type, you can select the record fields. If you selected Component as the key type, then you can select the variables defined for the component. |
Entry Type |
Select the element type on which you want to transform your field or variable. Values are Accumulator, Bracket - Numeric, Count, Deduction, Earnings, Formula - Numeric, Rate Code, Rate Code - Amount, Variable - Numeric, Variable - Pointer, and Variable - Dec + Char + Date + Ptr. The values available depend on the map value type. For example, if you select a character map value, then you can select only character values. Note. Although you can see System Element - Numeric as a value, you can not select it. The entry type can not be a system element or a constant. |
Name |
Select the name of the element. |
The PeopleSoft system delivers a query that you can run to view the names of all delivered elements designed for Brazil. Instructions for running the query are provided in the PeopleSoft Enterprise Global Payroll 8.9 PeopleBook.
See Also
Viewing the Delivered Elements
To set up Global Payroll for Brazil data, use the Element Lists BRA (GPBR_PAYSLIP_FORMA), Sort IDs BRA (GPBR_SORTID), Service Takers BRA (GPBR_SERVICE_TAKER), Union Parameters BRA (GPBR_UNION_PARMS), and Position/JobCd Parameters BRA (GPBR_MIXED_PARM) components.
This section discusses the general setup pages and parameters you need to set up in Global Payroll for Brazil and discusses how to:
Enter earnings, deductions, and calculation bases eligible for printing for multiple reports.
Define the printing order selection for the payslip.
Set up service takers.
Set up union parameters.
Set up average salaries.
Define payee parameters.
Define termination parameters.
Define unhealthy and hazardous indicators for job codes and positions.
Page Name |
Object Name |
Navigation |
Usage |
GPBR_PAYSLIP_FORMA |
Set Up HRMS, Product Related, Global Payroll & Absence Mgmt, Reports, Element Lists BRA |
Enter earnings, deductions, and calculation bases eligible for printing for multiple reports, including payslip and payroll results register. |
|
GPBR_SORTID |
Set Up HRMS, Product Related, Global Payroll & Absence Mgmt, Payslips, Sort IDs BRA |
Define the printing order selection for the payslip. |
|
GPBR_SERVICE_TAKER |
Set Up HRMS, Product Related, Global Payroll & Absence Mgmt, Framework, Organizational, Service Takers BRA |
Set up service takers to use for data entry purposes. The SEFIP report uses service taker information. |
|
GPBR_UNION_PARM |
Set Up HRMS, Product Related, Global Payroll & Absence Mgmt, Framework, Organizational, Union Parameters BRA, General Parameters |
Set up union parameters. |
|
GPBR_AVERAGES |
Set Up HRMS, Product Related, Global Payroll & Absence Mgmt, Framework, Organizational, Union Parameters BRA, Averages Parameters |
Set up average salaries. |
|
GPBR_PAYEE_PARM |
Global Payroll & Absence Mgmt, Payee Data, Define Payee Parameters BRA, Payee Parameters |
Define payee parameters. |
|
GPBR_PYEST_PARM |
Global Payroll & Absence Mgmt, Payee Data, Define Payee Parameters BRA, Termination Parameters |
Define termination parameters. |
|
GPBR_MIXED_PARM |
Set Up HRMS, Product Related, Global Payroll & Absence Mgmt, Framework, Organizational, Position/JobCd Parameters BRA |
Define unhealthy and hazardous indicators for job codes and positions. |
Access the Element List page.
Note. The Element List page is used in the financial register and payroll results register reports as well as payslip generation.
Total Earnings |
Select the accumulator that contains the earnings total. The value of this accumulator prints as the total earnings on the report or payslip. |
Total Deductions |
Select the accumulator that contains the deductions total. The value of this accumulator prints as the total deductions on the report or payslip. |
Net Pay |
Select the accumulator that contains the net payment. The value of this accumulator prints as the difference between total earnings and total deductions on the report or payslip. |
Earnings, Deductions, and Accumulators
In these group boxes, indicate whether you want to include or exclude the earning or deduction elements you list. You decide if it is easier to define the elements by inclusion or exclusion.
Enter the accumulators you want to appear as informative data on the report or payslip.
Access the Sort ID page.
Sort by and Then by |
Enter the criteria you want the payslip to sort by first in the Sort by field. Enter additional criteria, in the order you want to sort by, using the Then by fields. Values include Company, Department, Employee ID, Employee Name, Employee Type, Establishment, Location, Pay Entity, Pay Group, and Supervisor Code. The order in which you define your sort criteria determines the order in which information is printed on the payslip. |
Desc (descending) |
Select if you want the sort order to be in descending order. The default is in ascending order, so if you want to print in descending order, you must select this check box. |
Access the Service Takers page.
Service takers are companies that buy services from your company. For example, if your company is a consulting company, you enter all the different companies where your employees work during a defined period of time as service takers.
S. Taker Inscription Type (service taker inscription type) and Service Taker Inscription |
Select the type of ID and enter the ID that identifies the service taker. |
Access the General Parameters page.
Union parameters enable you to enter the details of agreements between unions and companies.
The fields on this page are monthly percentages and amounts.
Min. Guaranteed Comissionists (minimum guaranteed comissionists) |
Enter the minimum guaranteed monthly allowance that an employee receives if the employee is one hundred percent commissioned and has no salary earnings assigned in a given month of work. |
Union Monthly Contribution Pct (union monthly contribution percent) |
Enter the percentage of the employee’s salary to contribute for monthly union dues. To have this contribution made, you must enter the union code in the Alternate Union Code field on the Job Information page. |
Max. Union Monthly Contribution (maximum union monthly contribution) |
Enter the maximum amount to contribute for monthly union dues. |
Confederative Contribution Pct (confederative contribution percent) |
(Optional) Enter the percentage of the employee’s salary to contribute as a confederation contribution. |
Max. Confederate Contribution (maximum confederate contribution) |
Enter the maximum amount for a confederation contribution. |
Attendance Contribution Pct (attendance contribution percent) |
(Optional) Enter the percentage for an attendance contribution. An employee can refuse to pay this contribution. |
Max. Attendance Contribution (maximum attendance contribution) |
Enter the maximum amount for an attendance contribution. |
Transport Coupons Pct (transport coupons percent) |
Enter the maximum percentage of an employee’s salary that can be used for transportation costs. By law, this amount cannot be more than 6 percent, but a union may have an agreement for a lower percentage. The company cannot purchase transportation tickets worth more than this percentage for the employee. |
Proration Hiring Monthly Empl (proration hiring monthly employees) |
Select how to pay the employee’s salary, on calendar days or on a 30-day month basis. For example, for an employee hired on February 28, the employee receives payment for:
|
Absence Parameters
INSS Agreement - Maternity |
Select if the company has an agreement with the INSS. |
13th Salary Prm (13th salary parameters)
Calc Average First Installment (calculate averages on first installment) |
Select to have the system base an employee's 13th salary (first partiality) on his or her average salary calculation rather than on the monthly salary. |
Recalc First Installment (recalculate first installment) |
Select to indicate the system should recalculate the 13th salary. Since the 13th salary payment is run in November, there may be salary changes that could cause some employees to receive an extra payment of 13th salary. The system needs to recalculate 13th salary to make sure that employees receive any extra payments they are due. |
Termination and Stability Parm
Count Days-13 sal/prior notif |
Enter the number of days notice required for dismissal. By law, you must provide at least 30 days notice. |
Allows Term. When Stability (allows termination when stability) |
Select to allow an employee to be terminated when he or she has tenure. |
Work Related Accident |
Select the absence take element for work related accidents. |
Access the Averages page.
The method used to calculate the average salary depends on the run type. Using this page, you can specify the method used to calculate average salary for each pay component and each run type.
Run Type |
Select the type of payroll process for which you want to define the average version of the pay component. For each run type, you can select a different set of earnings and deduction elements to calculate using the average salary calculation. |
Entry Type |
Select the type of element to consider in the average salary calculations: earnings or deduction. |
Element for Target Value |
Select the name of the earnings or deduction element. |
Average Version |
Select the name of the set of parameters you defined on the Average Version page. |
Access the Payee Parameters page.
The parameters you enter on this page insert a Supporting Element Override variable field at the payee level.
Begin Date |
Enter the effective date for these parameters. |
End Date |
Enter the date these parameters are no longer valid. |
SEFIP Risk Level |
Select the appropriate risk level for the employee's activities. The system uses this information to generate the SEFIP report and to determine the employee's retirement deduction. |
Unhealthy Indicator |
Select the appropriate health risk level for the employee's activities. The system uses this indicator to calculate an earning that compensates for this health risk factor. |
Risk Indicator |
Select the appropriate hazard level for the employee's activities. The system uses this indicator to calculate an earning that compensates for this hazardous factor. |
PIS/PASEP Payment |
Select to indicate that the employee will receive annual PIS payments through Global Payroll for Brazil. |
IR Ded Retirement (income tax retirement deduction) |
Select to indicate that the payee is an active retiree and entitled to a retirement deduction. |
Weekly Hours |
Enter the number of hours the employee works per week. Note. This information is required. The vacations process uses this information. |
Registration # (registration number) |
Enter the employee's registration number. This number acts as an alternate employee ID. Note. This information is required. The Employee Registry Report uses this information. |
FGTS Option and Date |
Select to indicate the employee participates in FGTS, and the date participation began. Used for historical tracking, as FGTS participation is now required. |
Advance Payment Option and Percentage |
Select to indicate the employee can receive payments in advance from their regular salary and then enter the percentage of the monthly salary the employee can receive in advance. |
Prior Notification Date |
Enter the date you notify the employee of his or her termination. |
Access the Termination Parameters page.
FGTS Code |
The code of operation for an FGTS employee's account. |
Calculate last months FGTS |
Select this check box to indicate that FGTS should be calculated for the employee's last month. |
Pregnant Date |
Enter the date the employee notifies you she is pregnant. |
Union Member, FGTS Board Member, CIPA's Titleholder/Substitute, CNPS Board Member, Cooperative Society Mgr. (cooperative society manager), and Prev.Settlement Committee Memb(previous settlement committee member) |
Select the appropriate check boxes to indicate any memberships or positions the employee holds. |
Access the Position/Jobcode Parms page.
Option |
Select whether you are assigning unhealthy/risk indicators to a Jobcode or a Position. |
Position, Business Unit, Location, and Job Code |
Select the position or job code you are assigning unhealthy/risk indicators to using these fields. |
Unhealthy |
Select the appropriate health risk level for the activities of the job code, position, or location. The system uses this indicator to calculate an earning that compensates for this health risk factor. |
SEFIP Risk |
Select the appropriate risk level for the activities of the job code, position, or location. The system uses this information to generate the SEFIP report and to determine the employee's retirement deduction. |
Risk |
Select the appropriate hazard level for the activities of the job code, position, or location. The system uses this indicator to calculate an earning that compensates for this hazardous factor. |
This section describes how to use the following core PeopleSoft Enterprise Global Payroll features in your Brazilian payroll system:
Retroactivity
Accumulators
Segmentation
Triggers
Rounding rules
Rate codes
Retroactivity is the process of going back in time and recalculating prior calendars because changes were made after the original calculation was run. When retroactive processing occurs for a payee, the system recalculates each element generated for the payee. The difference between these results is the retro delta.
In PeopleSoft Enterprise Global Payroll, there are two methods for calculating retro:
Corrective
Forwarding
Note. In Brazil, all retro is handled with the forwarding method to comply with Brazilian legislation that requires all retroactive payments to be taxed in the current period. This includes both the Default retro method and the On Conflict retro method.
With the forwarding method, payments are calculated in the respective periods, but balance accumulators for the period are not updated. Only the segment accumulators are updated. Deltas are created for each earning, deduction, and segment accumulator used in the process list. These deltas, which are identified on the Retro Process Override page, are forwarded to the current period.
The system generates a retro trigger every time you enter a change on the data described in the following sections.
Changes in the Employee's Data
Changes in employee data include compensation rate-related changes:
Status.
Compensation frequency.
Standard hours.
Pay system flag.
Action for retroactive hire.
Action for retroactive termination.
Changes in Other Data
Changes in other data include absence take-related changes:
Positive input
Pay group
Earnings and deductions are recalculated and a difference results.
Note. Not all earnings or deductions will have an adjustment for retro. Some of the earnings and deductions are forwarded to one earning or deduction, which then appears as a single adjustment in the current period.
See Also
Defining Retroactive Processing
In Brazil, the following types of accumulators are used:
Annual accumulators for annual reports and average salary (when average salary is based in the current year).
Monthly accumulators for tax calculation and social security fees.
Custom accumulators to store absences that affect the weekly days-off and holidays payments.
In PeopleSoft Enterprise Global Payroll, if there is a change to employee details within a pay period that might affect calculation, such as a pay rate increase, the calculation creates two slices. One slice uses the details before the change and the other slice uses the details after the change.
PeopleSoft Enterprise Global Payroll provides two types of segmentation: period segmentation or full segmentation and element segmentation or slice. Period segmentation occurs when more than one gross-to-net calculation is required. Element segmentation occurs when there is a change in the rate that affects the calculation of one or more elements. In other words, element segmentation occurs when you want to calculate a select set of earnings or deductions multiple times, but not the entire gross to net calculation.
Note. Global Payroll for Brazil does not utilize element segmentation.
In Global Payroll for Brazil, the following items produce a period segmentation:
Changes in eligibility group.
Changes in pay entity.
Changes in pay group.
Hirings and terminations held in the calendar.
Global Payroll for Brazil delivers some segmentation; however, you can alter the delivered segmentation events and add or delete segmentation events depending on your business needs.
Triggers are used to detect online changes to data that should result in some type of system action. Examples of common data changes that might use triggers include a new employee hire or a change in pay rate.
PeopleSoft Enterprise Global Payroll provides three types of triggers:
Iterative − tells the system to process an employee for the current period.
Segmentation − tells the system to segment a period or element.
Retro − tells the system to perform retro processing.
Note. You must first set up an iterative trigger to tell the system when an event occurs, it should perform the desired action. After that, you can use a trigger to process an employee, perform segmentation, or perform retro processing.
Global Payroll for Brazil delivers some triggers; however, you can alter the delivered triggers and add or delete trigger setups depending on your business needs.
Delivered Iterative Triggers
The following table lists the iterative trigger setups that are delivered with Global Payroll for Brazil:
Changes to: |
Trigger |
Employee's employment record |
EMPLOYMENT |
Employees job records |
JOB and JOB_JR |
Employee’s compensation record |
COMPENSATION |
Employee’s personal data record |
PERSONAL_DATA |
Employee’s contract data record |
CONTRACT_DATA |
Employee’s positive input records |
GP_PI_MNL_DATA |
Employee’s positive input supporting element override record |
GP_PI_MNL_SOVR |
Employee’s payee override record (earnings and deductions assignments) |
GP_PYE_OVRD |
Employee’s payee element assignment supporting element override record |
GP_PYE_OVR_SOVR |
Employee’s payee section detail record |
GP_PYE_SECT_DTL |
Employee’s personal data effective date record |
PERS_DATA_EFFDT |
Employee’s schedule calendar assignment record |
SCH_ASSIGN |
Employee’s workday overrides record |
SCH_MNG_SCH_TBL |
Employee’s workforce contract type record |
WKF_CNT_TYPE |
Employee’s absence records |
GP_ABS_EVENT, GP_ABS_OVRD, etc. |
See Also
In PeopleSoft Enterprise Global Payroll, you can apply rounding to any component of an earning or deduction, the resolved amount of an earning or deduction, or within a formula. Rounding is applied to each of the components first before the resolved amount is rounded. Rounding is applied after proration rules have been applied.
Global Payroll for Brazil does not deliver country-specific rounding rules.
Global Payroll for Brazil supports the following types of salaries:
Monthly
Weekly
Daily
Hourly
Global Payroll for Brazil delivers the following rate codes to support the listed salaries:
Rate Code |
Description |
KRH |
Hourly |
KRM |
Monthly |
Global Payroll for Brazil delivers the following sections and process lists.
Note. PeopleSoft delivers a query that you can run to view the names of all delivered elements that are designed for Brazil.
See Also
Viewing Delivered Elements and System Data
The following table lists the delivered sections for Brazil:
Section |
Description |
KR 13º SALARIO |
13th Salary |
KR ADIANTAMEN SEC |
Advance Payment Semimonthly |
KR AUSENCIAS AUS |
Absences - Absence Process |
KR AUSENCIAS FOL |
Absences - Payroll Process |
KR DESC ADIA QUINZ |
Advanced Payment Discount |
KR ENCARGOS LEGAIS |
Legal Deductions |
KR FERIAS |
Vacations |
KR FERIAS AUS |
Vacation Takes |
KR FERIAS FOL |
Vacation Section |
KR FINAL |
Finalization Section |
KR IMPOSTO RENDA |
Income Tax Calculation |
KR INICIAL |
Initialization Section |
KR INICIAL QUINZEN |
Initialization - Advance Payment |
KR IR DESC FER |
Vacation Taxes |
KR LICENÇAS |
Leave Absences - Paid |
KR OTROS DESCONTOS |
Other Deductions |
KR PENS ALIMENTIC |
Alimony |
KR PENS LIQUIDO |
Net-to-Gross Alimony Section |
KR PENS LIQUIDO 2 |
Alimony Gross-to-Net |
KR RECALCULA IR |
Income Tax Recalculation for Advance Pay |
KR REMUN MENSAL |
Base Remuneration - Monthly |
KR RESCISÃO |
Termination Payment |
KR SE FERIAS DER |
Vacation section |
KR SE INI FERIAS |
Vacation Init section |
KR VENCIMENTOS |
Earnings |
The following table lists the delivered process lists for Brazil:
Process List |
Description |
13 SALARIO |
13th Salary Calculation |
ADIANT QUINZENAL |
Advance Payment Process |
FERIAS TOMADAS |
Vacation Takes |
FOLHA PAGAMENTO |
Payroll Calculation Process |
AUSENCIAS |
Absences |
FERIAS |
Vacations Calculation |