Short Description
The Trade Administration module allows users to define an unlimited number of trades (or 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, that 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 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 > Trade Administration
Chapter Contents:
Long Description
To Add a Trade (or Route)
- Go to
Modules > Master Data > Trade Administration.
The Trade Administration window will open: Click Create New Route... A separate pop-up will open:
- Enter the route code under Route Code and click OK.
- The pop-up will close and another open:
- Enter a route descriptive name the under Route Description and click OK. The pop-up will close and the new route will display in the left-hand menu tree and to the right, its fields will display.
Example:
Route PAC/FEWC (Pacific/Far East West Coast) - Enter the route year (if applicable) under Route Year.
- Enter the vessel type (if applicable) under Vessel Type.
- 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).
- Add a leg either by
creating a new leg
- Click Create New Leg... A separate pop-up will open:
- Enter the leg code under Leg Code and click OK.
- The pop-up will close and another will open:
- Enter a leg descriptive name the under Leg Description and click OK.
- The pop-up will close and the Create New Leg dialog box will open:
Example:
Leg FEWC-BC/USWC 5 (Far East West Coast-British Columbia/United States West Coast) - Enter default operator (if applicable) under Operator.
- 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. - To create a pattern:
- Click Create New Pattern... A separate pop-up will open:
- Enter the pattern code under Pattern Code (max. eight characters).
- The pop-up will close and another will open:
- Enter a pattern descriptive name the under Pattern Description and click OK. The pop-up will close and the new pattern will display 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) - 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. - Click Edit Pattern... and the Edit Pattern dialog box will open (the Create New Leg dialog box remains open).
Example: - Enter either
- the default agent (if applicable) under Default Agent or
- click the Triple Dot Selector next to the field. A pop-up with a list of input values will open. Select field and click OK.
- Enter default DO Price (if applicable) under DO Price.
- Enter default FO Price (if applicable) under FO Price.
- Click Create New Trade Port... to add ports. A separate pop-up will open:
- Enter the port sequence number under Sequence No. and click OK. The pop-up will close and an empty port row except for its sequence number will display in the Edit Pattern dialog box.
- Click the Port Name field of the row and either
- enter the port name or
- click the Triple Dot Selector next to the field. A pop-up with a list of ports will open. Select port and click OK.
- Repeat process entering relevant data in each respective row field (as applicable) except the Sequence No. field.
Example: - 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.
- 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 will open asking to confirm adding the newly created leg to the route.
- Click Yes. The pop-up will close and and another will open:
- Enter the leg's sequence number under Sequence No and click OK. The pop-up will close and the leg display as a row in the route's lower right-hand field.
- Click Refresh. The module will refresh and the entered leg and patterns will also be visible in the left-hand menu tree.
- Click Create New Pattern... A separate pop-up will open:
or by adding an exisiting leg
- Click Add Leg... A pop-up with a list of legs will open. Select field and click OK.
Example: - The pop-up will close and another open:
- Enter the leg's sequence number under Sequence No and click OK. The pop-up will close and the added leg display as a row in the route's lower right-hand field. The added leg will already have patterns (with) which were added when the leg was initially created.
- Add a leg either by
To Edit a Route/Leg/Pattern (and Ports)
- To edit a route:
Go to
Modules > Master Data > Trade Administration.
The Trade Administration window will open.Click the route to be edited in the left-hand menu tree. Its fields will display to the right.
Edit as appropriate the fields displayed in the upper right-hand field.
Click Refresh.
- To edit a leg:
- Go to
Modules > Master Data > Trade Administration.
The Trade Administration window will open. - Click the leg to be edited in the left-hand menu tree. Its fields will display to the right.
- Edit as appropriate the fields displayed in the upper right-hand field.
- Click Refresh.
- Go to
- To edit a pattern (and ports):
- Go to
Modules > Master Data > Trade Administration.
The Trade Administration window will open. - Click the leg with the pattern to be edited in the left-hand menu tree. Its fields will display to the right.
- Click the pattern to edited in the lower left-hand field - it will highlight.
- Click Edit Pattern... The Edit Pattern dialog box will open.
- Edit as appropriate the fields and ports displayed.
- Click Close.
To Delete/Undelete/Remove a Route/Leg/Pattern/Port
- To soft-delete a route:
- Go to
Modules > Master Data > Trade Administration.
The Trade Administration window will open. - Click the route to be soft-deleted in the left-hand menu tree. Its fields will display to the right.
- Click Delete Route. A pop-up will open asking to confirm deletion.
- Click Yes. The pop-up will close and the selected route soft-deleted only - and moved to the Deleted tab.
- Go to
- To remove a leg:
- Go to
Modules > Master Data > Trade Administration.
The Trade Administration window will open. - Click the route of the leg to be removed in the left-hand menu tree. Its fields will display to the right.
- Click the leg to be removed in the lower left-hand field - it will highlight.
- Click Remove Leg. A pop-up will open asking to confirm removal.
- Click Yes. The leg will close from the route.
- Go to
- To soft-delete a pattern:
- Go to
Modules > Master Data > Trade Administration.
The Trade Administration window will open. - Click the leg of the pattern to be removed in the left-hand menu tree. Its fields will display to the right.
- Click the pattern to be soft-deleted in the lower left-hand field - it will highlight.
- Click Delete Pattern. A pop-up will open asking to confirm deletion.
- Click Yes. The pattern will close from the leg but is soft-deleted only - and moved to the Deleted tab.
- Go to
- To delete a port:
- Go to
Modules > Master Data > Trade Administration.
The Trade Administration window will open. - Click the leg of the pattern with the port to be removed in the left-hand menu tree. Its fields will display to the right.
- Click the pattern with the port to be deleted in the lower left-hand field - it will highlight.
- Click Edit Pattern... The Edit Pattern dialog box will open.
- Click the port to be deleted - it will highlight.
- Click Delete Trade Port. A pop-up will open asking to confirm deletion.
- Click Yes. The pop-up will close and the port delete.
- Go to
- To undelete route/pattern:
- Go to
Modules > Master Data > Trade Administration.
The Trade Administration window will open. - Go to the Deleted tab.
- Click the soft-deleted route/pattern to be restored.
- Click Undelete. The row is removed from the Deleted tab.
- Go to
- To permanently delete a role:
- Go to
Modules > Master Data > Trade Administration.
The Trade Administration window will open. - Click route to be deleted in the left-hand menu tree. Its fields will display to the right.
- Remove all legs and patterns from the route that might be in use elsewhere.
- Soft-delete the route to be permanently deleted.
- Click the Deleted tab. All soft-deleted routes will be displayed.
- Click the route to be deleted - it will highlight.
- Click Delete Route Permanently. A pop-up will open asking to confirm deletion.
- Click Yes. The pop-up will close and selected row/s delete.