Gratuities plug-in
Description | Plug-in allows processing the total amount of the shares owed to crew members |
Latest Version | 2023.30.2.1 |
Release Date | Mar 15, 2024 |
Download Path | |
Type | APM Plugin |
Introduction
The Gratuities plug-in allows processing the total amount of the shares owed to crew members. The shares are calculated based on the sales made during the day.
Change Log:
Version | Date | Description |
|---|---|---|
2023.30.2.1 | Mar 15, 2024 | APMPI-865 The vessel name is fetched into the DIM2 field while transferring Gratuity entries to Payroll:   |
Functionality
The section will teach you how to import gratuity documents from Adonis Crew Portal as well as transfer them to payroll for further processing.
Get Started
To access the plug-in, log into APM and follow the steps below:
Switch to the Tools ribbon tab and click the Import button:
From the drop-down list, select Gratuities. The Gratuities main screen then appears:
Import Gratuity Documents
On accessing the plug-in, you can now import the gratuity documents from Adonis Crew Portal. To do this, first, set the data on the toolbar:
Vessel. From the drop-down list, select the vessel for which you want to view the gratuity documents.
Date From. Set the start date of the period to be considered.
Date To. Set the end date of the period to be considered.
Click Refresh to view the gratuity document(s) available within the defined date range:
When the gratuity document(s) becomes available in the grid, you can see the basic document information:
Date is the date when the document was created.
Vessel is the vessel name.
Currency is the currency in which the payment will be made.
Total Sales is the total amount of sales made within one day.
Gratuity % is an overall percentage defined per vessel.
Total Gratuity is a value received at the result of multiplying the Total Sales value and the Gratuity Percent value.
Total Shares is the sum of all the shares due to crew members.
Number of Persons is the number of crew members linked to the document.
Status is the status of the gratuity document.
To get more information on the document, click the expand button located next to the document. On clicking, you can see the list of crew members linked to the document:
In the expanded list, the following data is available:
Pin is an ID number of a crew member.
Name is a name of a crew member.
Position is a position that a crew member holds.
Sign On Date is the date when a crew member comes to the vessel.
Sign Off Date is the date when a crew member leaves the vessel.
Activity specifies the onboard activity of a crew member.
Shares is a portion of shares which a crew member is entitled to.
Total Amt of Shares is the amount owned to a crew member.
Comment may optionally contain any related comment.
Transfer to Payroll
After verifying a gratuity document, you can send it to the Payroll module for further processing. To do this, first, make sure you are on the main page of the plug-in and proceed with the following steps:
Select the document you want to be affected:
Click the Transfer To Payroll button.
Enter the comment you want to add to each crew member's record and click OK to proceed:
The system then fetches the data for each crew member and checks the Create Entry condition defined in Gratuities plug-in#Configure Payroll Settings. In case the valid condition exists, the transaction is created in accordance with the properties defined in the Gratuities plug-in#Field Assignments dialog.Then appears the Log dialog showing the transferring to payroll in progress:
When finished, click Close.
Check Logs
While operating the plug-in, the system records all the events that may occur. To check the logs, first, make sure you are on the main page of the plug-in and click Log at the bottom of the page. This opens the Log dialog:
On checking the logs, click Close.
Housekeeping
The section allows you to perform a one-time setup of the plug-in.
To configure the plug-in, first, click Setup at the bottom of the plug-in main screen. This opens the Setup dialog:
Set Up Connection
To set up the connection to the service, click Setup at the bottom of the plug-in main screen and make sure you are on the Connection tab:
Within the dialog, fill in the fields:
Service URL. Enter the URL of the service which you want to get connected to.
Adonis_API Password. Enter the password to the service.
When finished, click Test to verify whether the connection is successfully established. In case the connection is successful, the following message appears:
Configure Payroll Settings
You can define the settings necessary for processing gratuities transactions to payroll. To do this, first switch to the Mapping tab in the Setup dialog:
On the Mapping tab, click Add at the bottom of the dialog. This enables the fields to be filled out:
Entry Code. From the drop-down menu, select the entry code according to which the gratuity payment is to be calculated.
Method. It is a predefined field.
Create Entry when. Define the condition for creating an entry. For example, enter PIN=10. In this case, gratuities documents for PIN10 will be considered for processing to payroll.
Always create. The checkbox is preselected by default.
When done, click Close to close the dialog.
To remove an added field, click Remove at the bottom of the dialog.
Now, proceed to the field mapping to define the relations between the payroll and method fields. For this, click Field Assignments at the bottom of the dialog. Clicking the command opens the following dialog:
Within the dialog, click Add at the bottom of the Field Assignments dialog to enable the fields in the columns:
Payroll Field. From the drop-down list, select the field used for payroll transaction.
Method Field. From the drop-down list, select the correspondent field used in the service.
When finished, click Close.
To remove an added field, click Remove.