Ports Module

Owned by Halvard Meijer
Last updated: Mar 14, 2022 by Daria Chebotaieva

The Ports module represents a list of ports available in the application. It is primarily used to plan crew changes, specify contact persons as well as generate different documents and reports. 

Table of Contents

User Interface

The section is an overview of the Ports module interface, its commands, and its basic usage.

To get started, click the Ports button in the Modules ribbon or press the CTRL+Alt+J hotkey combination.

The Ports module becomes active and you can start managing it from the Manage ribbon tab.



The module functions are combined into categories as follows:

  • Views contain all the available ports listed alphabetically.

  • Details provide additional information on the selected port.

Switch to the category to access port-related details organized under the following tabs:

  • Port Details

  • Contacts

  • Documents

  • Reports

  • Required for Travel

Grid Layout

In this section, you will get to know how to You can customize the grid layout. The following options are available:

Columns Ordering

You can reorganize grid columns by moving columns so that they change the original order:

  1. Select a column by clicking its header.

  2. Hold down the mouse button and drag the cursor to the column before which you want to place the selected column.

  3. Drop the selected column when an insertion pointer appears.

Columns Sorting

You can sort column records using one of the following methods:

  • Right-click the header of the column in which you want to sort records. In the context menu, select the sorting order: Sort Ascending or Sort Descending.



Simply сlick a column header. Each click makes the switch between ascending and descending orders. Next to the column header, there appears an arrow up or an arrow down indicating ascending and descending sort orders, accordingly.
To revert to the order of the initial records in the column, select the Clear Sorting option from the context menu.

Columns Filtering

You can filter records to view only the data that you want to be displayed in a column. To do this:

  1. Hover the mouse cursor over the header of the column in which you want to filter records.

  2. Click the filter button

    to the right of the column header.

  3. In the drop-down list, check the option by which to filter the column data.


Besides, you can establish compound criteria for filtering:

  1. Select the (Custom…) option from the drop-down list to make the Custom Filter dialog appears:

  2. Select the filtering criteria from the drop-down lists and combine them using the AND/OR operators.

  3. Click OK to proceed.

Setting criteria for filtering is case-sensitive.

As a result, you will get the list of records meeting the preset criteria. The criteria for filtering appear at the bottom of the application window.
To clear filtering, select the (All) option from the drop-down list.

Columns Width

You can adjust the column width that is up to your needs. There are two ways to expand or reduce the column width:

  • Set the column width to automatically fit the content.

  • Adjust the width of a single column manually.

To auto-fit, follow the steps below:

  1. Right-click the header of the column you want to resize:

  2. From the context menu, select the Best fit option to autofit the current column or Best Fit (all columns) to make all the grid columns fit the content width.

To manually change the width of a single column:

  1. Select the column that you want to change.

  2. Drag the boundary of the selected column header.

The applied column width is preserved even after closing the application.

Columns Grouping

You can group the grid records to display them in a tree view for your convenience. To do this, follow the steps below:

  1. Right-click the column header by which to group the records:

  2. Select the Group By This Field option.

or

Simply drag and drop the column header by which you want to group the records to the area above the grid.
As a result, the grid records appear as combined into groups:

In the same way, you can reorganize grid records so that they are displayed in a tree view. Simply drag the column headers to the area above:

To collapse or expand the grid records one by one, click or accordingly.
To collapse or expand all the grid records, right-click the area next to the column header by which the grouping has been performed and select Full Expand or Full Collapse:

To revert to the standard grid layout, select the Clear Grouping command from the context menu.

Housekeeping

After the first-time APM installation, it is recommended to import a default set of ports. To do this, proceed as follows:

  1. In the Tools, the ribbon bar, click Execute ADS Script.

  2. In the dialog that appears, click

    and select the UN Ports. ads file (for file location, contact Adonis Help Desk). 

  3. Enter the AD_UPGRADE password, click OK to complete the import.

Besides, you can extend the list of ports by adding ports manually. To do this, refer to the Functionality section.
Before setting new ports, make the following setups: specify port and airport types, define a city where a specific port is located and create report groups.

Define Port Type

To define a port type:

  1. Go to the Setup ribbon tab and click the General Codes button.

  2. On the Structure pane, click the Travel code category to expand it and select Port.

  3. Click the New button in the Actions group of the Manage ribbon tab. The General Code Editor (Port) dialog appears:

     

  4. Enter a Code (mandatory field), a unique alphanumeric APM code.

  5. In the Text field, enter a name and an alternative name in the Alternative field.

  6. In the Sort field, define the order of port codes in the drop-down list (where 0 stands for the first record in the list).

  7. In the Is Passive field, specify whether the port code is to be active or passive. Passive codes appear unavailable.

  8. In the Options section, if necessary, check the Sea-days port used to register promotions at sea option.

  9. Use the XREF tab to synchronize data between the external database and APM.

  10. Click OK to save the records.

Define Airport Type

To define an airport type:

  1. Go to the Setup ribbon tab and click the General Codes button.

  2. On the Structure pane, click the Travel code category to expand it and select Airport.

  3. Click the New button in the Actions group of the Manage ribbon tab. The General Code Editor (Airport) dialog appears:

     

  4. Enter a Code (mandatory field), a unique alphanumeric APM code.

  5. In the Text field, identify the full name of the code and its alternative name, if needed, in the Alternative field.

  6. In the Sort field, define the order of airport codes in the drop-down list (where 0 means the first record in the list).

  7. In the Is Passive field, specify whether the port code is to be active or passive. Passive codes appear unavailable.

  8. In the Options section, precise the airport-related information:
    Airport Type (international, domestic, etc.).
    City Code associated with the airport location.
    Country where the airport is located.
    Latitude and Longitude coordinates of the airport.

  9. Use the XREF tab to synchronize data between the external database and APM.

  10. Click OK to save the records.

Define City

To define a city where a certain port is to be located:

  1. Go to the Setup ribbon tab and click the Tables button in the Application group.

  2. From the drop-down menu, select the Regions Editor option to view the list of available countries.

     

  3. Select the country where a specific city is to be located. You can use the Search the field at the bottom of the pane for a quick search.

    In case a required country is not available in the list, you can add it. For this, click Add Country on the ribbon and fill in the appropriate fields. 

  4. On selecting the country, switch to the Cities tab and click the Add City button on the ribbon bar to enable the required fields:

     

  5. Enter the data as follows:
    Code (mandatory field), a unique alphanumeric APM code.
    Type of the city.
    Full Name of the city.
    Latitude and Longitude coordinates of the city.
    Country code where the city is located. The field is automatically filled in based on the country selection.

  6. Choose to Save the records or to Revert the previous action.

Define Report Group

To create a group where all the customized reports relating to ports will be stored:

  1. Go to the Setup ribbon tab and click the General Codes button.

  2. On the Structure pane, click the Report Generator code category to expand it.

  3. Under the Report Generator code category, select Customized Report Groups.

  4. In the Manage ribbon tab, click the New button on the ribbon to display the dialog:

     

  5. In the General Code Editor (Customized Report Groups) dialog:
    Enter a Code (mandatory field), a unique numeric APM code.
    In the Text field, identify the full name of the report group and its alternative name, if needed, in the Alternative field.
    In the Sort field, define the order of report codes in the drop-down list (where 0 means the first record in the list).
    In the Is Passive field, specify whether the report code is to be active or passive. Passive codes appear unavailable.
    Check the Ports module in the Available in Module(s) and Datagroup(s) section of the Options tab.

  6. Click OK to proceed.

As a result, a new report group will be accessible from the Ports module.

Functionality

This section contains the description of the Ports module commands. By following the guidelines, you will be well on your way to working with the module: add new port records, edit existing port records as well as remove unnecessary records.

To access the module commands, go to Modules > Ports. The Ports module becomes active from the Manage ribbon tab.

Make sure the access rights to the 940 Ports routine are granted to you in Adonis Control Centre.

Add Port Records

To add a port record, switch to the Manage tab and click the New button. The Port Editor dialog appears:



Within the dialog, specify the fields as below:

  • Port Code (mandatory field) is a United Nations Code for Trade and Transport Locations. To ensure the code is correctly entered, go to http://www.unece.org/cefact/locode/service/location.html. On the website, select a country for the system to display the entire UN/LOCODE Code List of the Country.

  • Port Name is the full name of the port to be added.

  • Port Type is available in the drop-down list only in case it has been predefined in General Codes. For more information on how to set up a port type, refer to the Housekeeping section.

  • Country where the port is located.

  • The city of the port is available in the drop-down list only in case it has been predefined in Regions Editor. For more information on how to set up a city in the system, refer to the Housekeeping section.

  • Latitude and Longitude coordinates of the port.

  • *The nearest Airport is to be selected from the list of available airports.

  • Travel time. Indicate how much time it takes to get to the nearest airport.

  • Passive specifies whether the port code is to be active or passive. Passive codes appear as disabled.

  • Not a preferred crew change port. Select the option if the crew change is not supposed to take place in the port. Such port records become highlighted in yellow.

To access a list of airports, click on the Nearest Airport field. On clicking, the Select Airport a dialog appears where you can find an airport located near the port:



Once you are done, click OK. As a result, the port you have just added will appear in the Ports list.

Port Details

To continue adding records for the created port, switch to the Details category or just double-click the port.
In the Details category, you can get access to a variety of tabs where you can check additional port-related information:

  • Port Details

  • Contacts

  • Documents

  • Reports

  • Required For Travel

The Port Details tab displays general records of the port such as its code, name, type, country, city, etc.:



In the Contacts tab, you can import the contact information of a company for a quick reference. To do this, follow the steps:

  1. In the Manage ribbon tab, click the New button in the Actions group.

  2. In the Add Contacts to the port dialog, select the records you want to import to the ports contact list, or select Tag All to import all the records:

     

  3. Click Ok to proceed.

Once imported, the contact details appear in the list of port contacts:



In the Documents tab, you can import documents associated with the active port. To do this, follow the steps below:

  1. In the Manage ribbon tab, click the New button in the Actions group.

  2. In the Add documents to the port dialog, select the records you want to import to the ports document list, or select Tag All to import all the records:

     

  3. Click OK to proceed.

As a result, you will see the selected document in the Documents tab:



In the Reports tab, you can store reports relating to the active port. To do this, follow the steps below:

  1. In the Manage ribbon tab, click the New button in the Actions group.

  2. In the Add documents to the port dialog, select the reports you want to appear in the reports list, or select Tag All to display all the reports:

     

  3. Click OK to proceed.

As a result, you will see the selected report(s) in the Reports tab:



In the Required for Travel tab, you can add medical and/or travel documents required for the crew in the current port. To add the documents, do the following:

  1. In the Manage ribbon tab, click the Item List button to view the documents list:

     

  2. Select the appropriate documents from both Medical Document List and Travel Document List and move them to the respective Required Medical and Required Travel areas. Use arrows

    to move documents one by one or

    to move all the documents.

  3. Click OK to proceed.

As a result, the selected documents appear in the Required for Travel tab:

References

The section gives you access to additional sources relevant to the module.

Visit the website to check the port code:
http://www.unece.org/cefact/locode/service/location.html

Related Topics

Below you will find the list of manuals recommended for reading:

  • Contacts module

  • Documents module

  • Crew Change module