Set up a Shipment Template

Security Note: You need the Allow shipment template maintenance security right in the Shipments domain security rights group for this activity.

Activity Steps

Select the Transport panel in the Solution Explorer.
Expand the Vessels » Shipment Templates node.
Right-click a shipment template group and select New » Shipment Template from the menu.
The Shipment Template displays.
Complete the following fields as required.
- Name
- Default UOM—Select from the Mass units defined in the Unit Conversion Editor.
- Despatch Dates—Whether despatch dates are entered with times. See Set Date and Time Formats for the impact of this setting. Select from:
  - Use Global Setting (default)—Use the Enter Times With Despatch Dates setting defined on the Options screen.
  - Include Times
  - Do Not Include Times
- Vessel—Select from the vessels defined on the Transport node of the Solution Explorer.
- Transport Operators—Select from the vessel operators defined on the Transport Operators screen.
Specify the shipment route:
1. Select the Details tab.
2. Perform one of the following steps to select a route defined on the Transport panel of the Solution Explorer.
  1. Select a shipment route from the Route drop-down list.
  2. Expand the Routes node and drag a shipment route into the Route field.
Note: The route must be specified and the shipment template must be saved before the template can be used to create shipments.
To allow the shipment route for a shipment created using this template to be changed, check Allow Route Change.
If checked, the shipment template cannot be configured to allow a default unloading process flow or unloading stockpile, or to allow a shipment created from this template to be automatically unloaded.
To allow shipment created with this template to be changed to a different shipment template, check Allow Template Modification.
If checked, the template may be able to be changed. Changing the template of a shipment can change its route because the route is defined in the template. The template may define default loading or unloading information, and transport event templates specific to route points. The template may also define service charges. The impact of changing the template, or even if changing the template is possible, depends on how much information has already been entered for the shipment. If unchecked, the Shipment Template field on the Shipment cannot be modified for any shipment based on this template. See Change the Template of a Shipment.
To specify loading and unloading defaults:
1. To specify default loading transaction details when only one Loading Only and one Unloading Only route point exist in the selected shipment route:
  1. Select the loading route point.
  2. Select the Default Loading Process Flow from the process flows and movement flows that have the loading location as a destination location.
  3. Select the Default Loading Stockpile from the stockpiles at the source location of the selected Default Loading Process Flow. For a movement flow, select the source location or a sub-location.
2. To specify default unloading transaction details when only one Loading Only and one Unloading Only route point exist in the selected shipment route:
  1. Select the unloading route point.
  2. Select the Default Unloading Process Flow from the process flows and movement flows that have the unloading location as a source location.
  3. Select the Default Unloading Stockpile from the stockpiles at the destination location for the selected Default Unloading Process Flow. For a movement flow, select the destination location or a sub-location.
  4. Select whether to Auto Unload when the actual departure date is set for the shipment on the loading route point.
    Automatic unloading is only possible if the route has two route points, and the first route point is a Loading Only route point and the second route point is an Unloading Only route point, and the second route point is selected, and a Default Unloading Process Flow has been selected and a Default Unloading Stockpile has been selected. The route must also have the travel time estimate and duration time estimate specified for the unloading route point.
To specify event templates for each route point in the shipment template:
1. Select the route point.
2. Select the Default Transport Event Template from the transport event templates defined on the Transport panel of the Solution Explorer.
To specify default draft parameters for each route point in the shipment template.
1. Select the route point.
2. Select the Default Draft Parameters from the draft parameters configured on the Shipment Draft Parameters screen.
To add allowed contributors to the shipment template:
1. Select a contributor group in Show Contributors.
2. Right-click in the Contributors table and select Contributor Search from the menu.
  The Contributor Search screen displays.
3. Double-click each required contributor in the Available Contributors field group to move it to the Selected Contributors field group.
4. Click Accept.
To limit the allowable stockpiles for loading and unloading:
1. Select the Allowable Loading/Unloading Stockpiles tab.
  Note: If a default loading or unloading process flow has already been specified, it displays in the Allowable Loading Stockpiles or Allowable Unloading Stockpiles table.
2. To add a process flow, right-click in the applicable table and select New from the menu.
3. Select the Process Flow.
4. Select whether to Allow All Stockpiles.
5. If Allow All Stockpiles is unchecked, select the Allowable Stockpiles.
To add costs or service charges:
1. Select the Service Charges tab.
2. Add costs as described in Enter Costs for a Despatch.
3. Search for, select and edit service charges as described in Enter a Service Charge for a Despatch.
  When shipments are created using this shipment template, these costs and service charges are automatically added.
To override tab configuration for all shipments created from this template, instead of using the tab configuration defined for the user group:
1. Select the Tab Configuration tab.
2. Click the notification to override the tab configuration.
3. Check Override User Group Settings.
4. Check Is Hidden for the tabs that are to be hidden.
5. To reorder the tabs, right-click the Tab Page Name and select Move Tab Up or Move Tab Down from the menu as required.
To add an opening survey:
1. Select the Default Opening Survey tab.
2. Check Automate Opening Survey.
3. Select the At Route Point where the survey should be created.
4. Check Automatically Calculate Opening Survey Date if required.
  If loading or unloading transactions are present at the route point, then the date of the earliest transaction is used, minus one second. If no transactions are present at the route point, then the earliest route point date is used (ETA, ATA, and so on). This ensures that the opening survey date is prior to any transactions. If any of the transactions or route point dates are modified (for example, dates are changed or transactions are added or removed), then the opening survey date is automatically recalculated.
5. Select the Contributor Groups that will be contributor sources for the despatch stockpiles.
  If checked, the contributor value from the survey will not be overridden with any contributor values inherited from later transactions.
6. To specify default contributor values:
  1. Right-click in the Default Contributor Values table and select Add Contributor Group from the menu.
  2. Expand the Contributor Groups in the tree and select each required contributor group.
  3. Enter the default contribution Value as a percentage for the survey, for each predefined Contributor in the contributor groups.
  Note: Default contributor values are not required; however, if specified, the total for each contributor group must equal 100%.
Note: Opening surveys are specific to a despatch stockpile at a route point. Opening surveys can only be created automatically if the Vessel is specified in the shipment template. This is because the hold structure is defined for each vessel, and each hold is considered to be a stockpile. An opening survey cannot be created automatically if the vessel is changed after the shipment created from the shipment template.
Click Save.