Library Configuration

In Compas, this feature can be found through: Admin | General | Library Configuration.

Libraries are a key feature of COMPAS to enable the maintenance of data quality by facilitating standardisation of data entry and minimizing free text wherever possible.

The Library configuration can be found in the Admin Section → General → Library Configuration.

Note: Permission Required: Admin → Grant

Each Library is the key to creating standardized entries for drop down menus and fixed field choices through out the application. Many libraries create groups and populate specific features with the application which have additional pieces of information that system utilized to perform specific functions.

The list of libraries itself is maintained by the Library Keywords. This can be found by following selecting the Library Keywords in the Type drop down menu from the Library Configuration list. This is a searchable list.

Every Library entry has a main section and details section with some key features. Some special libraries have additional values included like Certificate Group.

A new entry or record on any given library can be created by clicking the symbol.

Main

• The Type is the main system code for a library type. For example Languages = LANG, Certificates = CERTI. This utilised throughout the system by SQL queries which drive the various features within the application. This is set at system level and cannot be defined by users.
• The Code is unique identifier used by system to identify the library entry. This must be unique for each library type and once created cannot be changed. There is a character limit of 30.
• The Seq is sequencing number for the record. This number defines where in a drop down list the record will be placed in a descending order. Ie 1 will be placed above 2 etc.
• The Description is how the record will be displayed throughout the system. This can be changed by users with admin level permissions. There is a character limit of 150.
• The Correspondent is an alternative expression of the record. This can be used for various functions for example as an alternative description, to link to another set of library records or to group library records. This value can be used in SQL queries to create various effects within Compas. An example is any Status with a corresponding value of Y will reflect as any given crew member being classed as ‘Active’ within the system.

Details

• Applicable Vessels - Some library entries which are related to features where they are created and used in the onboard module (Slopchest Product Categories for example) have an option the the product category that can be used on ALL vessels or can be created and used individually on a vessel by vessel bases. Proliferation of these codes can be controlled by Rank permission settings and restricting the ability to add such items if is desired to have a ‘fleet’ wide set of such records.
• Parameter values - The various parameter values can be used as additional indicators and correspondent values that can be utilised by SQL queries within the system. An example is for use with look up of records for custom alerts or templates.

Standard Ranks library needs to have Correspondent populated with DECK, ENGINE or OFFICE for each rank in the list. If this is missing, Limitation on Licence cannot be edited and also Compliance check gives red flag as being non-compliant.

Seq (Sequencing) in practice

An example of a record with vessel applicability.