How to display rates under the Additional Info section

Owned by Daria Chebotaieva
Last updated: Feb 08, 2024
4 min read

This article explains how to set up the personal/ pay-scale rates to be displayed under the Additional Info section in the Personal Details or Contracts datagroup.

Introduction

In APM there is a possibility to set up various rates (personal/ pay-scale) to be displayed under the Personal Details > Seniority > Additional Info section.

It is a very convenient way to view a person's salary rates without actually opening the Payscales or Personal Rates section, especially if the user doesn't have access to do this.

Setup and Configuration

The configuration of the Additional Info section is performed under the Setup → Global options → Seniority section.

Here the administrator can define various rates (personal/ payscale) to be displayed under the Personal Details > Seniority > Additional Info section.

This section is especially designed to display Payscale Rates (e.g. Basic Wage etc.) that can increase based on the seniority years.

However, it is also possible to make it display Personal Rates, Global Rates, Company Rates, etc.

Fields setup

  1. Click "Add" to insert a new line for the additional field.

  2. Define the Text/Name for these fields (e.g. Basic Wage, Compensation).

  3. Add a formula for the amount to be displayed on that line.
    (e.g. @X1 – to pick up PayScale rate 1).

Adding formula

Here is the list of possible values you would probably like to display in the Additional Info section.

Field

Description

Example of use

PR

Personal rate

@PR2

X

PayScale rate.

XA, XB, XC can be used to display the exact rate for certain seniority period.

@X13

 

@XA8

GB

Global Rate

@GB4

CB

Company Rate

@CB1

VB

Vessel Rate

@VB22

The number after the field identifies which rate line you are using (e.g. PR1 – personal rate one, X10 – payscale rate 10).

 

To refer to a single field in the Formula column you need to use the @ sign in front of of it.

To refer to a payroll script handling various rates use the formula of the following pattern @@ADO:005 where:

Component

Description

@@

script package identifier

ADO

script package code

:

Separator (between script package code and order number of a script)

005

script number in the package PWSCRADO.DEF (always 3 digits)

! (optional component)

@@!ADO:005 is used to tell the script object to return a result as integer. If the result is in decimals, then the system truncates it to integer.

To read more about the payroll script check this article

Payscale and personal rates used together

Let's see how to set up a formula for handling both Personal Rate and Payscale Rate in one line at the same time. It is required in cases when we want the system to display either Personal Rate (if added) or Payscale Rate.

First, we need to create a new script pack under Payroll > Scripts Editor.
Let's call it "Additional fields scripts".

Then we need to add scripts for each Personal & Payscale rate pair that we want to use.
Let's use the name of the rate for each script: "Basic Wage (Rate 1)", and "Compensation (Rate 3)".




For each script, we need to input the formula of the following pattern:

IF PR1<>0 THEN
W0=PR1
ELSE
W0=X1
ENDIF

In most cases, the Personal & Payscale rates paid occupy the same lines (e.g. Basic Wage rate would be in the same line under both Personal & Payscale)

However, sometimes Personal Rates of the same pair may occupy different lines, so you need to be careful and check this before you create a script.

Currency handling options

Show amount in Payscale currency - when ON – amounts in Payscale section of Seniority tab are displayed being calculated in the same currency as the Payscale Table, ignoring currency that is set in Company properties (Org. structure -> Company -> Payroll -> General)

Show Person Rate in Specified Currency – when it is ON - amounts in the Payscale section of the Seniority tab are displayed as being calculated in the same currency as it is specified under Payroll > Rates.