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:

Section
border true
Column width 50% Company unit: Crew List By Vessel is located under Company/ Organization Properties → Misc section. Column width 50% Vessel unit: Crew List By is located under the Vessel Properties → Payroll → General section.

2)     Workflow

2.1) Crew List By/ Crew List By vessel logic

2.2) Vessel & Company setup:

2.3) Description of 5 limitation options when Crew List By/ Crew List By vessel is ON

Previously we learned that, when Crew List By/ Crew List By vessel is ON, there are 5 options for limitation of peoples selection in the Crew List that we can choose from.

Here's how each of the options work:

1. Payroll Period - when selected, crew list views shows all the persons who have an activity intersecting current payroll period.
   
   In other words, it works for any activities where:
   
   
   • Date From <=Payroll Period End
   • Date To >= Payroll Period From or Date To is empty
     
     
2. Payroll Year - when selected, crew list views show all the employees who have an activity intersecting current payroll year.
   
   In other words, it works for any activities where:
   
   
   • Date From <=Payroll Year End (yyyy-12-31)

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

     Info
     Additional:  Payroll Period and Payroll Year options. -   Are always available for selection for vessel units. -   For company units 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 Crew List By Payroll 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 that selected vessel set under Employment → Payroll Vessel in Personal Details.
   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 – when selected, crew list views show all the people who have selected vessel set under Employment → Payroll Vessel in Personal Details.
   
   

5. User defined period - when selected, crew list views show all the employees who have activity intersecting with a user defined period. Activities without Date To also are included to this selection. If the option is set for the vessel, you need to also activate it for the organization above it (e.g. vessel pool).
   In other words, it works for any activities where:
   
   
   • Date From <= Today
   • Date To >= (Today - number of days) or Date To is empty
     
     

NOTE: Those options don't consider Estimated End Date in activity (EED). As described above they take into account only the Date To.

2.4) 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.