Naming Convention for Delivered Elements
This section discusses:
Element names.
Functional area codes.
Element type codes (PIN_TYPE).
One of the keys to understanding how delivered payroll elements function in the system is to understand their names. Understanding the naming convention developed for PeopleSoft-delivered elements can help you determine how an element is used, the element type, and even the functional area it serves. Depending on whether the element is a primary element, a component of a primary element, or a supporting element, one of the following naming conventions applies.
Supporting Elements
For supporting elements, such as variables, formulas, dates, durations, and so on, PeopleSoft uses the following naming convention: FF TT NAME.
FF: Functional Area Code (see Functional Area Codes for more information).
TT: Type of Supporting Element (see List of Element Type Codes for more information).
NAME: The name is based on a term in Portuguese and provides a further means of identifying the element.
For example, in the tax array MD VR SUMA MED, MD represents the functional area, VR represents the element type, and SUMA MED (Soma a Médias) provides a further means of identifying the element.
Note: This naming convention applies to the following element types: arrays, brackets, counts, dates, durations, formulas, variables, historical rules, fictitious calculation rules, proration rules, rounding rules, writable arrays, and generation control conditions.
Primary Elements
Primary elements, such as earnings, deductions, accumulators, absence take, and absence entitlement elements generally do not contain functional area codes or element type codes in their names. This is because primary elements have names, based on Brazilian terms, that identify their function and element type without the use of additional codes. For example, the name of the earning element SALARIO MENS clearly identifies this element as an earning, and more specifically, as a base salary element.
Other Elements
Although there is no fixed naming convention for sections and element groups, Global Payroll for Brazil commonly uses the following naming convention: FF NAME.
FF: Functional Area Code (see Functional Area Codes for more information).
NAME: The name is based on a term in Portuguese and provides a further means of identifying the element.
For example, a section in a process list for Brazil might be named KR VENCIMENTOS, where KR is an identifier and VENCIMENTOS provides a means of uniquely identifying the element.
Additional Clues to the Use of Brazilian Elements
Many Brazilian elements contain abbreviations that provide clues (beyond those provided by the functional area codes or element type codes) to their use in the system. For example, consider the duration element FE DR DIAS AFA PER. While the functional area code FE indicates that this element is used for vacations, and the element type code DR identifies them as duration elements, the abbreviations AFA and PER provide additional clues to how the element is used. In this example, AFA stands for Afastamento (absences) and PER stands for Periodo (period). As you become more familiar with the payroll rules created for Brazil, these abbreviations will help you to further identify and understand the role played by each element.
The following table lists the most common abbreviations used in the names of Brazilian elements:
Abbreviations Used in Global Payroll for Brazil |
Portuguese |
English |
---|---|---|
NUM or QTD |
Número |
Number |
%, PERC |
Porcentagem |
Percentage |
ATU |
Atual |
Current |
ACUM |
Acumulado |
Balances |
13, 13º, 13S, 13 SAL |
Décimo Terceiro Salário |
Christmas Bonus |
INVE |
Investimentos |
Savings |
ALIM |
Alimenticia |
Alimony |
ANTIG |
Antiguidade |
Seniority |
ANU |
Anual |
Annual |
ANV or ANIV |
Aniversário |
Anniversary |
ASSO |
Associar |
Assign |
ASST |
Assistência |
Assistance |
CAL, CALEN |
Calendärio |
Calendar |
CALC |
Cálculo |
Calculation Process |
EMP, CIA |
Empresa ou Companhia |
Company |
COMP |
Compensar |
Compensate |
CRE or CRED |
Crédito |
Credit |
QUO, QUT |
Quota |
Quote or Fee |
DED, DE |
Dedução |
Deduction |
DES, DESP |
Desconto e Despesas |
Discount, Food, or Rest and Expenses |
ALIM |
Alimento |
Food |
DEV |
Devolução |
Return |
DF, DIF |
Diferença |
Difference |
DOBR |
Dobro |
Doubles |
DOM or DOMIN |
Domingo |
Sunday |
$$ |
Dinheiro |
Cash |
ESP |
Especial |
Special |
EX, EXTR |
Extra |
Non Taxable or Over |
EXC or EXCE |
Excedente |
In Excess |
ISEN |
Isento |
Non Taxable |
FAT, FATOR |
Fator |
Factor |
FED |
Federal |
Federal |
FEST |
Dia Festivo ou Feriado |
Holiday |
FIC or FICT |
Fictício |
Fictitious |
FIX |
Fixo |
Fix |
FRE or FREQ |
Freqüência |
Frequency |
TRIBUT, TRIB |
Tributável |
Taxable |
HOR |
Hora, Horista |
Hours |
IMP, IR |
Imposto ou Imposto de Renda |
Tax or Amount |
INC or INCAP |
Incapacidade |
Disability |
VEN |
Vencimentos |
Earnings |
LIM |
Limite |
Limit or Boundary |
QUIT, RESC |
Liquidação |
Lay off |
MIN |
Mínimo |
Minimum |
NEG |
Negativo |
Negative |
PER |
Período |
Period |
VENC |
Vencimentos |
Earnings |
PREM |
Prêmio |
Premium |
EMPR |
Empréstimo |
Loan |
ME |
Média |
Average |
PROD |
Produzidas |
Produced |
PROP |
Proporção ou Proporcional |
Proportion or Proportional |
PROV |
Provisão |
Provision |
PROJ |
Projetado |
Projected |
RETID |
Retido |
Withheld |
RETRO |
Retroativo |
Retroactive |
INT, INTER |
Intervalo |
Rank |
RIS, RISC |
Risco |
Risk |
SAL |
Salário |
Salary |
SEGM |
Segmento |
Segment |
SUB |
Subsídio |
Subsidy |
SUP |
Superior |
Top Limit |
TET |
Teto, topo |
Cap |
TOT |
Total |
Total |
TRA or TRAB |
Trabalhado |
Worked |
TRIP, TRIPL |
Triplo |
Triple |
ULT |
Último |
Last |
UNI or UNID |
Unidades |
Units |
FER , FERIAS |
Férias |
Vacations |
VAL |
Vales |
Coupons |
VAR or VARIAV |
Variável |
Variable |
/ |
Por |
Per |
Component Names (Suffixes)
In Global Payroll for Brazil, suffixes are used to name the components of earning and deduction elements. For example, when you create an earning, deduction, or absence element in PeopleSoft Global Payroll, you must define the components that make up the element, such as base, rate, unit, and percentage. The system automatically generates the components and accumulators for the element based on the calculation rule or accumulator periods that are used. The system also names the components and accumulators by appending a suffix to the element's name.
Note: To view all the suffixes defined for your country, use the Element Suffixes page in the core Global Payroll application.
For example, let's say you define the earning element named EARN1 with the following calculation rule:
EARN1 = Rate × Unit
The system automatically creates two additional elements for the components in the calculation rule: a rate element called EARN1_RATE and a unit element called EARN1_UNIT.
As you can see, the system creates suffixes to name the components of the element (_RATE and _UNIT). In Global Payroll all suffixes fall into one of the following types:
Separator.
Earnings/deductions component suffixes.
Earnings/deductions accumulator suffixes.
Deduction arrears component suffixes.
Absence entitlement component suffixes.
Absence entitlement accumulator suffixes.
In Global Payroll for Brazil, the following suffixes are pre-delivered.
Separator
The separator is defined as: _ (underscore)
Component Suffixes
The following table lists the component suffixes delivered for Brazil:
Component |
Suffix |
---|---|
Base |
BASE |
Percentage |
PERC |
Rate |
VRREF |
Unit |
UNID |
Accumulator Suffixes
The following table lists the accumulator suffixes delivered for Brazil:
Accumulator |
Suffix - Calendar Period: Amount |
Suffix - Calendar Period: Unit |
Suffix - Fiscal Period: Amount |
Suffix - Calendar Period: Unit |
---|---|---|---|---|
Calendar Period to Date |
VRPER |
UNPER |
VRPEF |
UNPEF |
Month to Date |
VRMEN |
UNMEN |
VRMEF |
UNMEF |
Quarter to Date |
VRTRI |
UNTRI |
VRTRF |
UNTRF |
Year to Date |
VRANU |
UNANU |
VRANF |
UNANF |
Deduction Arrears Component Suffixes
The following table lists the deduction arrears component suffixes delivered for Brazil:
Deduction Arrears Component |
Suffix |
---|---|
Payback |
DEVOL |
Amount not Taken |
NDES |
Add to Arrears |
ACINS |
Arrears Accumulator |
INSUF |
Absence Entitlements Suffixes
The following table lists the absence entitlement suffixes delivered for Brazil:
Absence Entitlement |
Component/Accumulator |
Suffix |
---|---|---|
Separator |
_ |
|
Component |
Unit Paid |
UNPAG |
Unit Adjustment |
UNAJU |
|
Accumulator |
Balance |
SALDO |
Adjustment |
AJUST |
|
Entitlement |
DIR |
|
Take |
AUSEN |
The following table contains the functional area codes used in the names of Brazilian elements:
Functional Area |
Description |
---|---|
FP |
General (Folha de Pago) |
RE |
Earnings (Remunerações) |
FA |
Absences (Faltas, Atrazos, Afastamentos e Licenças) |
MD |
Average salaries (Médias) |
RC |
Terminations (Rescisão Contratual) |
FE |
Vacations (Férias) |
13 |
13th salary (13o. Salário) |
CS |
Union contributions (Contribuições a Sindicatos) |
IN |
Social security (INSS) |
PA |
Alimony (Pensão Alimentícia) |
IR |
Income tax (Imposto de Renda) |
EP |
Loans (Empréstimos) |
VT |
Transportation tickets (Vale Transporte) |
AD |
Advance Payment (Adiantamento) |
SF |
Family Allowance (Salário Família) |
FG |
FGTS (Fundo de Garantia por Tempo de Serviço) |
The following table contains codes for all the element types. Because not all element types are delivered for Brazil, not all of these codes appear in the names of Brazilian elements.
Element Type |
Description |
---|---|
AE |
Absence Entitlement |
AT |
Absence Take |
AC |
Accumulator |
AR |
Array |
AA |
Auto Assigned |
BR |
Bracket |
CT |
Count |
DT |
Date |
DD |
Deduction |
DR |
Duration |
ER |
Earnings |
EG |
Element Group |
EM |
Error Message |
FC |
Fictitious Calculation |
FM |
Formula |
GC |
Generation Control |
HR |
Historical Rule |
PR |
Process List |
PO |
Proration Rule |
RC |
Rate Code |
RR |
Rounding Rule |
SE |
Section |
SY |
System Element |
VR |
Variable |
WA |
Writable Array |