Worldsoft Documentation Search

How to create and configure a new earning code

Earning codes are created in the Earning Benefit Types code tables.

The code is defined on the top Earning Benefits Types grid.

Start by creating a new record on the top, using the ‘+’ button on the upper navigator bar.

In the Earning or Benefit Type column, choose ‘Earning’.

Earning Benefit Group is not mandatory but can be helpful for reporting purposes.

Earning Benefit Code is where you enter the name for the new earning.

Secondary Suffix should only be filled in if your site is using the column for secondary assignment purposes. If it is blank for other entries leave it blank.

Description is mandatory.

Calculation configuration is handled by the Earning Detail grid on the bottom.

When you create a new record on the bottom grid you need to start by specifying the Salary Budget Version for the definition.

Lookups are used to set matching criteria. For example, if you have an earning that has different rates for different employee organizations you’ll define a line in this grid for each contract. Likewise, an earning rate that changes depending on the employee type will have a line created to filter/match on that criteria.

Value Type for an Earning will typically be Amount, Each, or Hours. This basically determines if the resulting calculation will output to the Each, Amount, or Hours column on the Earnings tab.

Process Type will typically be Hours, Percent, or Not Coded. If it’s running off of the employee’s hourly rate choose ‘Hours’. If it’s an Each value, choose Not Coded. Otherwise, choose Percent.

Employee Organization is the only other mandatory Lookup. If the line is being created as a default or if the calculation doesn’t depend on contract choose ‘NOTCODED’ as the organization.

All other lookups are available for more precise matching to employees and should not be filled in unless needed.

Of note is this ‘Earning Benefit Accumulator Group’ column. If your earning is a percentage calculation/derives its amount from other earnings or benefits then you will need to pick an accumulator group from the list.

The Details columns to fill in depend on the Value Type. Times Rate is used for Hours calculations and acts as a multiplier to the employee’s hourly rate. Each Rate works for Each calculations. Percent Increase and Percent Increase Next Year are available as entry columns for when an earning requires a Calc Formula. Typically you will not have to use a Calc Formula but, if you need to, double click on the cell to pop up the formula editor.

Included Hours are a series of flags that determine how earning flow through for reporting and budgeting purposes.

Inc. FTE Hrs

Check if the earning is hours-based and the earning should generate FTE values.

Inc. Paid Hrs

Check if the earning is hours-based and the earning is considered part of an employee’s paid hours.

Inc. Worked Hrs

Check if the earning is hours-based and should be considered worked earnings for reporting purposes.

Inc. Earned Hrs

Check if the earning is hours-based and should be considered earned hours for reporting purposes.

Inc. Non-Earned Hrs

Check if the earning is hours-based and should not be considered earned hours for reporting purposes (eg: benefit hours).

Inc. Other Hrs

Check if the earning is hours-based and should be considered other hours for reporting purposes.

After the calculation details are defined, proceed to the AB: Counts Towards tab.

Any accumulator groups listed here will have the result of the earning calculation accumulated. Typically, earnings contribute to accumulator groups. It is important to never have an earning contribute to the same accumulator group that it uses for calculation; this is known as a circular reference and it will end up inflating the calculation for all earnings and benefits that use the same accumulator group, up to their mathematical limit. Instead of creating a circular reference create a new accumulator group instead that is specific to this earning and calculate on that instead.

After Counts Towards is configured, proceed to AC: Assignment.

If your site uses Secondary Suffix/Secondary End and the class Secondary Prefix nothing needs to be done in this tab. Most sites will need to specify the secondary account by Production Type.

Set the Budget Version, Production Type, and Secondary Account. All other columns are only used if a more precise match is required.