Functionality

The section will teach you how to operate the plugin.

To get started, first, open the plugin. For this, switch to the Tools ribbon tab and click the Import button. From the drop-down list, select Process Side Duties. The Process Side Duties main screen then appears:

Open

After processing the timesheets in Adonis Personnel Portal and selecting the side duties payroll entry(ies) to be involved (see Select Payroll Entry), the records containing the selected payroll entry(ies) are then displayed on the main screen:

Open

The transactions listed are the payroll transactions imported from the timesheets. The transactions are not yet paid.

Set Location

On defining the payroll field where you to display the location (see Assign Location to Payroll Field), you can now specify the location value. There are three hardcoded location values:

• Domestic Port is set if a crew change takes place in the US port.

• International Port is set if a crew change takes place in a port other than US.

• At Sea is set if a crew change does not take place.

To specify a location value, first, make sure you are in the Side Duties tab of the plugin window:

Within the window, select the crew member to be affected and follow the steps below:

1. At the bottom left-hand corner, click the arrow 

   to view the list:
   
   

2. From the appeared drop-down list, select Location. This opens the Set Location dialog:
   
   

3. In the drop-down list, select the location value you want to add.

4. Click Apply to save the selection.
   
   
   

As a result, the selected location appears in the Location column of the grid based on the selected crew member(s):

When done, click Apply at the bottom right-hand side corner of the plugin window.

Set Cost Group

After defining the cost group(s) (see Define Cost Group), you can set cost groups for crew members. For this, first, make sure you are in the Side Duties tab of the plugin window:

Within the window, select the crew member to be affected and follow the steps below:

1. At the bottom left-hand corner, click the arrow 

   to view the list:
   
   

2. From the appeared drop-down list, select Cost Group. This opens the Set Cost Group dialog:
   
   

3. In the drop-down list, select the location value you want to add.

4. Click Apply to save the selection.
   
   
   

As a result, the selected cost group appears in the Cost Group column of the grid based on the selected crew member(s):

Once completed, click Apply at the bottom right-hand side corner of the plugin window.

Housekeeping

The section will guide you through the configuration of the plugin. By following the guidelines, you will learn how to:

• Select the payroll entries identifying side duties. For more information, see Select Payroll Entry.

• Define the cost groups. For more information, see Define Cost Group.

• Define the payroll field that will contain the cost group value. For more information, see Assign Cost Group to Payroll Field.

• Define the payroll field that will contain the location value. For more information, see Assign Location to Payroll Field.

Install plugin

To install the plugin, navigate to Install APM Plugin and follow the step-by-step instructions carefully.

Select Payroll Entry

To specify the side duties payroll entries to be affected, first, make sure you are in the Configuration tab of the plugin interface:

In the grid, select the payroll entry(ies) you want to be involved. 

As a result, the records containing the selected payroll entry(ies) will appear in the Side Duties tab:

Define Cost Group

To define the cost group codes, go to the Setup ribbon tab > General Codes > Vessel > Cost Group and proceed with the following steps:

1. Click the New button in the Actions group of the Manage ribbon tab. The General Code Editor (Cost Group) dialog appears:
   
   
   

2. Within the dialog, create a new cost group record by filling in the fields below:

   • Enter a Code (mandatory field), a unique alpha-numeric APM code.

   • In the Text field, indicate the name of a cost group and its alternative name, if needed, in the Alternative field.

   • In the Sort field, define the order number of a record (where 0 means the first record in the list).

   • In the Is Passive field, specify whether the code is to be active or passive. Passive codes appear as disabled.

3. When completed, click OK to save the record.
   
   
   

As a result, a new record appears in the grid:

Assign Cost Group to Payroll Field

You can define the payroll field that will contain the cost group value. To do this, first, switch to the Configuration tab in the plugin interface:

In the Cost Group drop-down list, select the payroll field where you want to display the cost group value. 

Assign Location to Payroll Field

To define the payroll field that will contain the location value, first, switch to the Configuration tab in the plugin interface:

In the Location drop-down list, select the payroll field where you want to display the cost group value.