Location and general characteristics

All the scripts are located under Payroll > Scripts Editor.

Image Added

Here you can:

• Add new Packages and Scripts;

• Export/Import existing Script Packages;

• Add content to the newly created Payroll Scripts or edit the existing ones etc.

Script Package Description

All payroll scripts are logically grouped into packages and you can add as many script packages into the system as you need. Each package consists of a maximum of 999 scripts.

Image Added

Script package is a text file containing small sentences written in Basic, normally used for Payroll calculations.

Each package has (.DEF) file format and can be exported/ imported out/into the system. The DEF file can be freely opened and adjusted with the help of Windows Notepad.

Commonly we have one package for all the Entry Code scripts and one for the sub-scripts.

The structure of the script package file

Let’s take PWSCRADO.DEF package as an example.

1) PWSCRADO.DEF – is a file name where PWSCR is used to identify that this is a package, the following text before the dot is script package Code (ADO in this case) and (.DEF) is definition of the file format.

2) The inside of the package is as follows:

Image Modified

#####001þ???????? Is the structure for the first line of a script.

#####001 means the number of the script, while þ???????? is the name (e.g. #####001þBasic Wages)

Components & Operators

Each payroll script should follow certain system rules and have a specific structure. There is also a limited number of operators and fields that can be used in the script.

To view all the fields that can be used in the payroll scripts, use the following URL:
Fields Overview available for Payroll Scripts

½ Simple arithmetical conditions

The Payroll script works with basic arithmetic operations such as addition, subtraction, multiplication, and division.

The below table will give you an overview of all the operators that are supported in the APM script, along with an example of its usage.

If-clause

A simple script may contain lines where one value equals another, without special conditions applied.

However, such an approach doesn’t always help to solve complex calculation problems. 

For this purpose, we use an “if-clause”.

“If-clause” is a conditional statement that, if proved true, performs a calculation function within the script. It consists of a conditional clause and the consequence.

Let’s take a closer look at the below table to get more understanding:

Reference to a sub-script

In APM it is possible to include one script within another.

When the subscript is added, it will be calculated based on its position within the main script and affect the result of the calculation.

The sub-scripts are usually added when some part of the script should be repeated in several main scripts, making it easier to modify it. An example of a sub-script can be a script for department, nationality, rank, employer calculation, etc.

Functions used in scripts

Application and usage

The main purpose of a script is to be used for payroll calculations.

The script thus needs to be linked to a corresponding Entry Code under the Entry Code Maintenance

> Calculation tab.

The script can also be used in other places within APM, but

to do this it is necessary to input the formula of the following pattern @@ADO:005 where:

We can refer to a script with the above formula in:

1. Leave factor field at any level (Individual, Payscale Table/Code, Company, Activity).
   

1. Image Added

2. In any field under Entry Code Maintenance -> Entry code details -

1. > Input, Calculation, Pay slip, Accumulators tab.
   

1. Image Added

2. Inside one payroll script to refer to another script (so-called sub-script).

1. Image Added