This article explains how Crew List By/ Crew List By vessel options affects the display of people in the Crew List View based on the current client.

1)     Purpose and location

Crew List module always shows a list of persons based on the organization unit that is opened as current client. Currently selected client is displayed in the main window caption (the very top-middle part of the screen).

In order to open certain org. unit as current client it is necessary to click Open Client button in the quick access menu. You can do the same from Crew List Module → Open Client.

The display of people in Crew List greatly depends on the options in the Organization properties called Crew List By/ Crew List By vessel.

Crew List By Vessel is located under Company Properties → Misc section.

Crew List By is located under the Vessel Properties → Payroll → General section.

2)     Workflow

2.1) Crew List By/ Crew List By vessel logic

1. When Crew List By (vessel) is OFF, crew list views display people who belong to the current opened unit and the subordinate organizations. The belonging of a person to certain organization is defined by the employment company in Personal Details → Employment → Organization.
   
   
2. When Crew List By (vessel) is ON, crew list views also show people based on the current client, but at the same time it allows you to add extra limitation to this selection. It obliges you to select the additional principle, according to which persons should be shown in Crew List.
   

   There are in total 5 options for limitation of people’s selection:
   
   

   •   By Payroll Period

   •   By Payroll Year

   •   By Activities and payroll vessel

   •   By Payroll Vessel

   •   By User Defined Period
   
   

3. Payroll Enabled & Crew List By options for the vessel unit
   
   
   • If Payroll Enabled option is selected for the vessel, Crew List By option is selected automatically too.
   • If Crew list By option is cleared, Payroll Enabled option is automatically cleared.
   • If both options are not checked, it is impossible to open a vessel as a current client.
   • Despite the above it is not obligatory to have both options ON and you can set one of them OFF is you need.
     
     
4. Payroll By Vessel & Crew List By Vessel options for the company unit.
   
   
   • If the Payroll By Vessel option is selected for a company, Crew List By Vessel option is selected automatically too.
   •  If Crew List By Vessel is cleared, Payroll By Vessel is cleared automatically too.

   • Despite the above it is not obligatory to have both options ON and you can set one of them OFF is you need.
     
     

     Payroll By Vessel option is located Organization Structure → Company Properties → General. If this option is set and the current client below this company is a vessel, then there are the persons in the Crew List who have or had an onboard activity on this vessel during the current payroll period. When the option is not set, the Crew List shows the persons who are directly linked to the vessel in Personal Details. For more details please Click Here.

     
     

2.1) Options description

Here's how each of the options work:

1. Payroll Period - when you select a vessel as a current client you will see all the persons who have onboard activity intersecting current payroll period.
   
   In other words, it works for sea-service activities where:
   
   
   • Date From <=Payroll Period End
   • Date To >= Payroll Period From or Date To is empty
     
     
2. Payroll Year - crew list will show all employees who have been onboard during the current payroll year.
   
   In other words, it works for sea-service activities where:
   
   
   • Date From <=Payroll Year End (yyyy-12-31)

   • Date To >= Payroll Year Start (yyyy-01-01) or Date To is empty.
     
     

     
     

     Additional:  Payroll Period and Payroll Year options. -   Are always available for selection for Vessel as organization unit. -   For Company unit those options can only be enabled when Organization Structure → Company Properties     → General → Payroll By Vessel is ON . -   Both options are also disabled when Payroll is not enabled for the selected vessel.

     
     
     

3. Activities and Payroll Vessel - when this option is selected and Payroll By Vessel option is selected for the mother company (e.g. vessel pool) and a user opens vessel as a client, people who have at least one activity on this vessel crossing current payroll period or who have this vessel set as a payroll vessel under Datagroups → Personal Details are shown.
   
   In other words, it works for those people that have Personal Employment → Payroll Vessel equal to vessel in activity,
   or for any type of activity (Leave, Training, Sailing etc.). where:
   
   

   • Date From <=Payroll Period End

   • Date To >= Payroll Period From or Date To Is empty
     
     

     
     

4. By Payroll Vessel – shows people who have Personal Employment → Payroll Vessel equal to the vessel in activity.
   
   

   
   

5. User defined period - all employees who have activity intersecting with a user defined period. Activities without Date To also are included to this selection.
   
   In other words, it works for sea-service activities where:
   
   
   • Date From <= Today
   • Date To >= (Today - number of days) or Date To is empty

2.2) Important points to consider

If Crew List By Vessel option is set for a vessel and an organization is opened as a current client, system ignores settings of a vessel, just considering the settings of organization. Meaning that if a vessel should display crew list based on Payroll Year, the system will use settings of the selected organization, which can be by Payroll Period.

 This text is invisible, this section should be here