Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Short Description

Excerpt

The Area Trade Administration module allows users to define an unlimited number of various categories trades (or groupings) of user defined geographical areas for different purposes, for example War Risk areas, Bunker areas, Fleet areas, etc. The module is divided into three sections, Area Reports, Areas and Locations (or Geonames).

All subject groupings are entered and defined under Area Reports. Each grouping is identified by a unique code and name and can hold a number of areas. The unique code is used both as a short name and in report logic, i.e. once created, area report group codes should not be changed – it can break report logic. An Area is a user defined categorisation of main geographical areas, for example, continents, oceans, etc. Each area is identified by a unique code and can hold number of geographical locations.

A geographical location (or geonames) is a sub-category of Areas and the most detailed level of area categorisation. The locations are predefined, (i.e. “fixed, comes with the system), maintained by Dataloy and grouped by geographical areas, ocean and administrative area (or countries). The contents of each grouping is listed alphabetically. Some geographical areas listed under as locations, such as countries, continents and ocean areas, are hierarchical, for example, adding a country to the custom area will automatically add all ports and locations listed under the selected country. The module also allows for the exclusion of locations from an area, for example, if a country has been added but one of its ports is to be excluded, add the port separately and check the Exclude box.

...

routes). A trade route is a series of distances and stoppages used for commercial transport of cargo and form a basis (or template) for an actual voyage for cargo. Initially the Trade Administration module was created for round trips, but any type of route can now be entered.

A route in the VMS is defined by a unique code, name and description and is often fixed on an area. A route year can be defined as routes, whilst retaining the same name, can vary year from year. Vessel type can also be entered to indicate the type of vessel used for a specific route. A route consists of long- and/or short distance routings/segments (or legs). Each route can hold different routing alternatives for each leg and/or a series of different legs, sequenced one after the other. A leg can also hold a default operator. Voyages based on the leg will then automatically have the operator stated as default leg operator.

Legs are defined by patterns. A pattern contains of all port calls of a leg and can hold information about a default agent and default bunker prices for the pattern. Each leg can have a number of different patterns, for example, during summer a leg might consist of four port calls, in winter only two. The ports of a pattern are sorted by assigned sequence and hold typical port information, such as reason for call, default port cost, currency, terminal name and laytime data.

Once all route levels are entered into the VMS, the data can be utilised when creating voyages based on a trade. This is useful for cargo transport on fixed routes that follow a (more or less) fixed schedule, for example, a fleet of container vessel/s transporting cargo along the same route over and over. When creating a new voyage based on the trade in the Booking and Operations module all information of a route is copied into the voyage, simplifying creating the voyage. It is, however, possible to modify a voyage, even if it is based on a trade, adjusting it to the actual sailing route used.

Location: Modules > Master Data > Area Trade Administration

Image RemovedImage Added

 

Chapter Contents:

Table of Contents
minLevel6
absoluteURLtrue
typeflat

Long Description

To add an area grouping
To add a trade (or route)
  1. Go to Modules > Master Data > Area > Trade Administration. The Area Trade Administration window will open.:

    Image Added

  2. Click Create New Route... A

    new row will appear in the Area Reports field.
    Example:
    Image Removed
  3. Click the area report code field and enter the area grouping code (max. three characters) under Area Report Code (RED marking = required field).
  4. Tab to/click the area report name field and enter the area grouping name (max. three characters) under Area Report Name. A new area report group is created.
    Note: At least one area report group is required to activate the Area field.
    An area report grouping can hold a number user defined geographical areas. An area can be added either by creating a new or by adding an already existing one (areas defined in area report can be added to other area reports).Add either bycreating a new area:
  5. Click the area report to add an area to.
  6. Click Create New in the Area field. A new row will appear in the Area field.
    Example:
    Image Removed
  7. Click the area code field and enter the area code under Area Code.
  8. Tab to/click the area description field and enter the area name/description under Area Description. A new area is created.
  9. Go to Step 6.
  10. or by adding an exisiting area:
  11. Click the area report to add an area to.
  12. Click Add Area... in the Area

    separate pop-up appears:

    Image Added

  13. Enter the route code under Route Code and click OK.
  14. The pop-up will vanish and another appear:

    Image Added

  15. Enter a route descriptive name theunder Route Description and click OK. The pop-up will vanish and the new route will appear in the left-hand menu tree and to the right, its fields will display.

    Example: Route PAC/FEWC (Pacific/Far East West Coast)

    Image Added

  16. Enter the route year (if applicable) under Route Year.
  17. Enter the vessel type (if applicable) under Vessel Type.
  18. Click Refresh. A defined route can hold a number of legs (with patterns).A leg can be added to a route either by creating a new leg or adding an existing one (defined in another route).
    1. Add a leg either by
      1. creating a new leg

        1. Click Create New Leg... A separate pop-up appears:

          Image Added

        2. Enter the leg code under Leg Code and click OK.
        3. The pop-up will vanish and another will appear:

          Image Added

        4. Enter a leg descriptive name theunder Leg Description and click OK.
        5. The pop-up will vanish and the Create New Leg dialog box will appear:

          Example: Leg FEWC-BC/USWC 5 (Far East West Coast-British Columbia/United States West Coast) 

          Image Added

        6. Enter default operator (if applicable) under Operator.
        7. Enter the leg's pattern/s in the diaolgue box's lower field, i.e. enter the port calls one after the other to be made as part of the leg.
          Note: There can be several patterns for the same leg, for example, one for summer, one for winter, etc.
          1. To create a pattern:
            1. Click Create New Pattern... A separate pop-up appears:

              Image Added

            2. Enter the pattern code under Pattern Code (max. eight characters).
            3. The pop-up will vanish and another will appear:

              Image Added

            4. Enter a pattern descriptive name theunder Pattern Description and click OK. The pop-up will vanish and the new pattern will appear as a row in the Create New Leg dialog box.

              Example: Pattern FEWC-BC/USWC2 (Far East West Coast-British Columbia/United States West Coast)

              Image Added

            5. To create pattern trade ports, click the pattern to be edited in the Create New Leg dialog box - it will highlight.
              Note: This need not be done if there is only one pattern - it will automatically be highlighted.
            6. Click Edit Pattern... and the Edit Pattern dialog box will appear (the Create New Leg dialog box remains open).

              Example:

              Image Added

            7. Enter either
              1. the default agent (if applicable) under Default Agent or
              2. click the Triple Dot Selector next to the field. A pop-up with a list of
        areas will
              1. input values will appear. Select field and click OK
        .
        Example:
        Image Removed
      2. The selected input value will appear as a new row in the Area field. Go to Step 6.
    2. To edit an area: Click the row to be edited and edit.
    3. To remove an area:
      1. Click the area to be removed - it will highlight.
      2. Click Remove. A pop-up appears asking to confirm removal
              1. .
            1. Enter default DO Price (if applicable) under DO Price.
            2. Enter default FO Price (if applicable) under FO Price.
            3. Click Create New Trade Port... to add ports. A separate pop-up appears:

              Image Added

            4. Enter the port sequence number under Sequence No. and click OK. The pop-up will vanish and an empty port row except for its sequence number will appear in the Edit Pattern dialog box.
            5. Click the Port Name field of the row and either
              1. enter the port name or
              2. click the Triple Dot Selector next to the field. A pop-up with a list of ports will appear. Select port and click OK.
            6. Repeat process enterning relevant data in each respective row field (as applicable) except the Sequence No. field.

              Example:

              Image Added

            7. Click Close. The Edit Pattern dialog box will close and trade ports of the pattern have been saved. The Create New Leg dialog box is again available to create additional patterns and trade ports.
            8. In the Create New Leg dialog box, click Close once all patterns (with ports) have been entered. The dialog box will close and a separate pop-up appears asking to confim adding the newly created leg to the route.
            9. Click Yes. The pop-up will vanish and
        the selected row removed.
    An area can hold a number geographical locations. Add the appropriate locations to each area.
    1. To add a location:
      1. Click the area to add locations to.
      2. Click the selected location
            1. and another will appear:

              Image Added

            2. Enter the leg's sequence number under Sequence No and click OK. The pop-up will vanish and the leg appear as a row in the route's lower right-hand field.
            3. Click Refresh. The module will refresh and the entered leg and patterns will also be visible in the left-hand menu tree
        of the Locations section - it will highlight. The add-to-area arrow button next to the menu tree will activate.Click the add-to-area arrow button to add the selected location to the area. The location will
            1. .
          1. or by adding an exisiting leg

            1. Click Add Leg... A pop-up with a list of legs will appear. Select field and click OK.

              Example:

              Image Added

            2. The pop-up will vanish and another appear:

              Image Added

            3. Enter the leg's sequence number under Sequence No and click OK. The pop-up will vanish and the added leg appear as a row in the route's lower right-hand field. The
        field lists all locations added to a selected area.
        Example:
        Image Removed
      To exclude a location:
      Note: This option is open when a location area has been added containing a location to be excluded, for example, a country has been added but one (or more) of its port is to be excluded.
        Click the location to be excluded
            1. added leg will already have patterns (with) which were added when the leg was initially created.
To edit a route/leg/pattern (and ports)
  1. To edit a route:
    1. Go to Modules > Master Data > Trade Administration. The Trade Administration window will open.

    2. Click the route to be edited in the left-hand menu tree. Its fields will appear to the right.

    3. Edit as appropriate the fields displayed in the upper right-hand field.

    4. Click Refresh.

  2. To edit a leg:
    1. Go to Modules > Master Data > Trade Administration. The Trade Administration window will open.
    2. Click the leg to be edited in the left-hand menu tree. Its fields will appear to the right.
    3. Edit as appropriate the fields displayed in the upper right-hand field.
    4. Click Refresh.
  3. To edit a pattern (and ports):
    1. Go to Modules > Master Data > Trade Administration. The Trade Administration window will open.
    2. Click the leg with the pattern to be edited in the left-hand menu tree
    - it will highlight
    1. . Its fields will appear to the right.
    2. Click
    the add-to-area arrow button adding it separately to the area. It will appear - highlighted - as a row in the right-hand field.Check the Exclude box in the location's row. The location has been excluded from the area.
    Example:
    The country Nigeria (including all its ports and regions) has been added to the area, but the Nigerian port of Lagos has been excluded.
    Image Removed
    To remove a location:Click the location to be removed in the right
    1. the pattern to edited in the lower left-hand field - it will highlight.
    2. Click Edit Pattern... The Edit Pattern dialog box will appear.
    3. Edit as appropriate the fields and ports displayed.
    4. Click Close.
To delete/undelete/remove a route/leg/pattern/port
  1. To soft-delete a route:
    1. Go to Modules > Master Data > Trade Administration. The Trade Administration window will open.
    2. Click the route to be sofi-deleted in the left-hand menu tree. Its fields will appear to the right.
    3. Click Delete Route. A pop-up appears asking to confirm deletion.
    4. Click Yes. The pop-up will vanish and the selected route soft-deleted only - and moved to the Deleted tab.
  2. To remove a leg:
    1. Go to Modules > Master Data > Trade Administration. The Trade Administration window will open.
    2. Click the route of the leg to be removed in the left-hand menu tree. Its fields will appear to the right.
    3. Click the leg to be removed in the lower left-hand field - it will highlight.
    4. Click the remove (trashcan) button to the left. A Remove Leg. A pop-up appears asking to confirm removal.
      Example:
      Image Removed
    5. Click Yes. The pop-up leg will vanish and from the selected row removedroute.
  3. To

...

  1. soft-delete a pattern:
    1. Go to Modules > Master Data >
    Area
    1. Trade Administration. The
    Area
    1. Trade Administration window will open.
    2. Click
    area report row
    1. the leg of the pattern to be
    edited
    1. removed in the
    Area Report field - it will highlight
  2. To soft-delete an area report
    1. left-hand menu tree. Its fields will appear to the right.
    2. Click the
    row section to be edited and edit.
To delete/undelete an area report
    1. pattern to be soft-deleted in the lower left-hand field - it will highlight.
    2. Click Delete Pattern. A pop-up appears asking to confirm deletion.
    3. Click Yes. The pattern will vanish from the leg but is soft-deleted only - and moved to the Deleted tab.
  1. To delete a port:
    1. Go to Modules > Master Data > Area Trade Administration. The Area Trade Administration window will open.
    2. Click area report row the leg of the pattern with the port to be removed in the left-hand menu tree. Its fields will appear to the right.
    3. Click the pattern with the port to be deleted in the Area Report lower left-hand field - it will highlight.
    4. Click Delete Edit Pattern... The selected row will be soft-deleted only - and remains visible in the Area Report field.
    To undelete an area report
    1. Edit Pattern dialog box will appear.
    2. Click the port to be deleted - it will highlight.
    3. Click Delete Trade Port. A pop-up appears asking to confirm deletion.
    4. Click Yes. The pop-up will vanish and the port is deleted.
  2. To undelete route/pattern:
    1. Go to Modules > Master Data > Area Trade Administration. The Area Trade Administration window will open.
    2. Go to the Deleted tab.
    3. Click the soft-deleted area report row route/pattern to be restored.
    4. Click Undelete.  The The row will vanish from the Deleted tab.
      Example:
      Image Removed
      ,
  3. To permanently delete an area reporta role:
    1. Go to Modules > Master Data >
    Area
    1. Trade Administration. The
    Area
    1. Trade Administration window will open.
    2. Click route to be deleted in the left-hand menu tree. Its fields will appear to the right.
    3. Remove all legs and patterns from the route might be in use elsewhere.
    4. Soft-delete the
    area report
    1. route to be permanently deleted.
    2. Click the Deleted tab. It will display
    showing
    1. all soft-deleted
    area report rows
    1. routes.
    2. Click the
    area report row
    1. route to be deleted - it will highlight.

    Example:
    Image Removed
    1. Click Delete Route Permanently.
     A
    1. A pop-up appears asking to confirm deletion.
    2. Click Yes. The pop-up will vanish and the selected row deleted
    (in both the Active and Deleted tabs)
    1. .

Top
Back

Related Content

Expand to see related content

...