General Features
M-SHIP general features and system designs are described here.
General Design
The system user interface is split into 3 portions:
- Top navigation bar
- Left navigation menu
- Main Content
Top Navigation Bar
Basic information of the logged in user account is displayed:
UsernameTenantInterCompany
M-SHIP is designed for multilingual and i18n support. You can easily switch the localisation by clicking on the globe icon and select the country of your choice.
Left Navigation Menu
The various M-SHIP system modules are listed on the left navigation menu. Depending on the context of the function, some functions may have nested options. Simply click on the item to navigate to that function.
Main Content
This is where the main content is displayed.
In general, most modules’ landing pages list the entity(s) by default. In the various sections of this documentation, we will provide the Sorting and Filtering criteria as each module’s landing page business logic is different.
Mobile-Friendly Design
Being mobile-friendly means that M-SHIP displays different versions of the website depending on the devices that you use. For example, viewing M-SHIP on a mobile device adjusts the layout of the content according to the size of your screen resolution.
While this option is available, it is recommended to use a laptop or desktop for ease of data input.
Soft Deleting
M-SHIP uses only soft deletes for most of its system design. This means that attempting to delete a record marks the record as inactive in the database. This helps to improve performance and allows “deleted” records to be recovered, upon request.
Data Format and Validation
All fields marked with * are mandatory. Various business rules and data validation will be applied on the different forms across M-SHIP. Refer to the individual documentation for more information.
Audit Trail
Audit Trail allows privileged users to perform tracing of changes that are made to the database. M-SHIP provides an easy-to-read timeline view to assist privileged users in their investigations.
The following entities are logged for every changes made to the database:
Entity Type- Which type of record was amended? e.g. Commodity CodeEntity Value- Which record was amended? e.g. ISOPENTANELast Amended By- Who was the last user to amend this record?Last Amended On- When was this record last amended?IP Address- IP Address of the user who amended this recordSnapshots- Snapshots before and after the amendment will be taken
Audit Trail is enabled for New, Edit and Delete actions.
Forms and Tabs
As certain forms require a large number of fields, the fields have been logically structured into various tabs in these forms. These tabs can be navigated freely during the form input (subject to access control).
System Notifications
(placeholder)
File Management
(placeholder)