AURTruckDespatch

Use the AURTruckDespatch adaptor to create truck despatches based on truck despatch templates or update truck despatches.

A truck despatch template contains the configuration for the truck route, service charges, and tab configuration for truck despatches created from the template.

A truck despatch template can specify a default loading process flow and stockpile, such that when a truck despatch is created using that truck despatch template, bulk material loading transactions can be created with one right-click menu option.

A truck despatch template can specify a default unloading process flow and stockpile, such that when a truck despatch is created using that train template, bulk material unloading transactions can be either created with one right-click menu option, or automatically created.

To use this AUR adaptor, you must be familiar with the route specified in the truck despatch template. The required rows for each truck in the CSV file depend on the number of route points in the truck route.

Note: Words in coloured text refer to column names in the CSV file. Words in bold refer to equivalent field names in MineMarket.

Class Name

The class name is AURAdaptor.AURTruckDespatch.

CSV File Format 

Object,Truck Despatch Name,Truck Despatch Alias,Truck Despatch Template,Route,Truck Alias,Intended Despatch,Intended Despatch Order,Despatch Number,Registration Number,Account Number,Transport Operator,[Extended],Extended1,Extended2 
[Truck],,,,,,,,,,,,,, 
[RoutePlan],Truck Despatch Alias,Route Point Alias,ETA,ETD,Planned Start Loading,Planned End Loading,Planned Start Unloading,Planned End Unloading,ATA,ATD,Actual Start Loading,Actual End Loading,Actual Start Unloading,Actual End Unloading 
[DespatchOrder],Truck Despatch Alias,Despatch Order Alias,,,,,,,,,,,,

CSV Columns

Column Header

Notes

Object

Object type in the CSV file.

Select from:

  • [Truck]—The header row for each truck to be created.
  • [RoutePlan]—The itinerary for a route point in the Route.
  • [DespatchOrder]—The Alias1 value for each despatch order to assign.

Truck Despatch Name

Only applicable to [Truck] rows.

Truck Despatch Alias

Only applicable to [Truck] rows.

Truck Despatch Template

Only applicable to [Truck] rows.

Route

Only applicable to [Truck] rows.

Truck Alias

Only applicable to [Truck] rows.

Intended Despatch

Only applicable to [Truck] rows.

Intended Despatch Order

Only applicable to [Truck] rows.

Despatch Number

Only applicable to [Truck] rows.

Registration Number

Only applicable to [Truck] rows.

Account Number

Only applicable to [Truck] rows.

Transport Operator

Only applicable to [Truck] rows.

[Extended],Extended1

Only applicable to [Truck] rows.

CSV Rows: [Truck]

The [Truck] rows are the only rows for which the column headers are visible in the CSV file.

At least one [Truck] row is mandatory in the CSV file.

Column

Notes

[Truck]

The row header for the truck despatch.

Mandatory.

Truck Despatch Name

The Truck Despatch Name.

Optional. If not specified for a new truck despatch, MineMarket generates a name. If not specified for an existing truck despatch, MineMarket keeps the existing name. If specified for an existing truck despatch, MineMarket updates the name if required.

Truck Despatch Alias

The Alias1 value for the truck despatch.

If the Alias 1 value does not already exist, the AUR adaptor creates a new truck despatch.

If the Alias1 value already exists, the AUR adaptor updates the existing truck despatch.

Mandatory.

Truck Despatch Template

The Alias1 value of an existing truck despatch template.

Mandatory for new truck despatches.

Optional if updating a truck despatch.

Route

The Alias1 value of an existing truck route.

Should be left blank if creating a truck despatch because the route is determined from the truck despatch template.

Optional if updating a truck despatch. However, if the truck despatch that is being updated was created from a template, the route must be the same as the route in the template.

Truck Alias

The Alias1 value of an existing truck.

If not specified, the truck assigned to the truck despatch template (if a truck is assigned) is used.

A truck is required if the truck despatch is to be loaded or unloaded, or if actual times are to be uploaded in a Route Plan row.

Intended Despatch

The Alias1 value of an existing shipment to be associated with the truck despatch.

Optional.

Intended Despatch Order

The Alias1 value of an existing despatch order.

Optional.

Despatch Number

The text string for the Despatch Number.

Optional.

Registration Number

The text string for the Registration Number.

Optional.

Account Number

The text string for the Account Number.

Optional.

Transport Operator

The Alias1 value of an existing transport operator.

Optional.

[Extended],Extended1

[Extended] is the group separator and must precede the other columns in the group.

For each of the other columns in the group:

  • Extended1 in the column header is the Field Caption of an existing extended data field for the truck despatch.
  • The column contents are the values for the extended data field.

You can have as many extended data columns as required.

CSV Rows: [RoutePlan]

The columns for the [RoutePlan] rows do not have visible column headers.

Note: AURRoutePlan is the recommended AUR adaptor to update route plan times because it has visible column headers.

See the notes about AUR Adaptor Data Entry for valid date and time formats.

The data for each route point itinerary must be entered in the following order in the row. All of the times are optional; however, every column must be in the CSV file. (Leave blank cells for times that are not needed.)

Logical validation applies; for example, the ETA must be earlier than the ETD and the ATA must be earlier than the ATD. However, the validation is only within the groups of planned times or actual times; for example, the ETA does not need to be earlier than the ATD. Only enter times that are applicable for the route point; for example, loading times for a loading route point.

For routes with more than one route point, all [RoutePlan] rows must be consecutive in the CSV file.

[RoutePlan] rows are optional. If [RoutePlan] rows are included, they must be straight after a [Truck] row in the CSV file.

Column

Notes

[RoutePlan]

The row header for the itinerary for a route point.

Mandatory.

Truck Despatch Alias

The Alias1 value of an existing truck despatch.

Mandatory.

Route Point Alias

The Alias1 of an existing route point that is on the specified Route. (This is the Alias1 value of the route point, as displayed via the Truck Route screen, not the Truck Despatch screen.)

Mandatory.

ETA

The estimated date and time of arrival at the route point.

If no ETA is entered, the current date and time is used for the ETA.

ETD

The estimated date and time of departure from the route point.

Planned Start Loading

The planned date and time of the start of loading at the route point.

Planned End Loading

The planned date and time of the end of loading at the route point.

Planned Start Unloading

The planned date and time of the start of unloading at the route point.

Planned End Unloading

The planned date and time of the end of unloading at the route point.

ATA

The actual date and time of arrival at the route point.

ATD

The actual date and time of departure from the route point.

Actual Start Loading

The actual date and time of the start of loading at the route point.

Actual End Loading

The actual date and time of the end of loading at the route point.

Actual Start Unloading

The actual date and time of the start of unloading at the route point.

Actual End Unloading

The actual date and time of the end of unloading at the route point.

CSV Rows: [DespatchOrder]

The columns for the [DespatchOrder] rows do not have visible column headers.

[DespatchOrder] rows are optional. If [DespatchOrder] rows are included, they must be after the [Truck] and [RoutePlan] rows in the CSV file.

Column

Notes

[DespatchOrder]

The row header for a despatch order.

Mandatory.

Truck Despatch Alias

The Alias1 value of an existing truck despatch.

Mandatory.

Despatch Order Alias

The Alias1 of an existing despatch order.

Mandatory.

Example

CSV file to create two truck despatches, each of which has a route with two route points (one loading and one unloading).

  1. The first truck despatch only has planned itinerary times entered.
  2. The second truck despatch has both planned and actual itinerary times entered, and a despatch order assigned.
Copy 
Object,Truck Despatch Name,Truck Despatch Alias,Truck Despatch Template,Route,Truck Alias,Intended Despatch,Intended Despatch Order,Despatch Number,Registration Number,Account Number,Transport Operator,[Extended],Extended1,,,, 
[Truck],T01,T01,TT01,R01,Truck-01,Shipment-01,Despatch Order-01,,,,,,,,,, 
[RoutePlan],T01,R01-Loading,1/01/2016 12:00,1/01/2016 15:00,1/01/2016 12:30,1/01/2016 14:30,,,,,,,, ,,,
[RoutePlan],T01,R01-Unloading,2/01/2016 12:00,2/01/2016 15:00,,,2/01/2016 12:30,2/01/2016 14:30,,,,,, ,,,
[Truck],T02,T02,TT02,R02,,,,,,,,,,,,, 
[RoutePlan],T02,R02-Loading,1/01/2016 12:00,1/01/2016 15:00,1/01/2016 12:30,1/01/2016 14:30,,,1/01/2016 12:10,1/01/2016 15:10,1/01/2016 12:40,1/01/2016 14:40,, ,,,
[RoutePlan],T02,R02-Unloading,2/01/2016 12:00,2/01/2016 15:00,,,2/01/2016 12:30,2/01/2016 14:30,2/01/2016 12:10,2/01/2016 15:10,,,2/01/2016 12:40,2/01/2016 14:40 ,,,
[DespatchOrder],T02,DO-0001,,,,,,,,,,,,,,,

Note: You can download this example as an Excel (XLSX) file with notes on the header row. For manual data entry, using a spreadsheet application makes it easier to align data with the correct column heading. After entering the data, save the file in CSV (UTF-8) format.

Notes and Troubleshooting

For notes, see the information above for each row type.

During processing, the AURTruckDespatch adaptor renames the CSV file as a LOG file and adds a Status column before the Object column. The Status column indicates whether the upload of each truck despatch was successful. If the upload was not successful, the Status column has an error message that describes the problem.