AURRoutePlan

Use the AURRoutePlan adaptor to update the route plan times of an existing despatch, and berthing dates of an existing service trip or shipment, and berthing and sailing organisation and contact details of an existing shipment.

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.AURRoutePlan.

CSV File Format

Object,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,Planned Berth Date,Planned Unberth Date,Actual Berth Date,Actual Unberth Date,Planned Berth,Actual Berth,Vessel NOR Tendered,Vessel NOR Tendered Acceptance,Berthing Pilot Organisation,Berthing Pilot Contact,Berthing Commercial Officer Organisation,Berthing Commercial Officer Contact,Berthing Shipping Agent Organisation,Berthing Shipping Agent Contact,Berthing Notes,Sailing Pilot Organisation,Sailing Pilot Contact,Sailing Commercial Officer Organisation,Sailing Commercial Officer Contact,Sailing Shipping Agent Organisation,Sailing Shipping Agent Contact,Sailing Notes

CSV Columns

Column Header	Notes
Object	Object type in the CSV file. Select from: [Train]—The row header for a train to be updated. [Truck]—The row header for a truck despatch to be updated. [Barge]—The row header for a service trip to be updated. [Shipment]—The row header for a shipment to be updated. Mandatory.
Alias	The Alias1 value for an existing despatch of the specified Object type. Mandatory.
Route Point Alias	The Alias1 value for an existing route point on the route assigned to the despatch. Mandatory.
ETA	The estimated date and time of arrival at the route point. Optional. Applicable to all despatch types.
ETD	The estimated date and time of departure from the route point. Optional. Applicable to all despatch types.
Planned Start Loading	The planned date and time of the start of loading at the route point. Optional. Applicable to all despatch types.
Planned End Loading	The planned date and time of the end of loading at the route point. Optional. Applicable to all despatch types.
Planned Start Unloading	The planned date and time of the start of unloading at the route point. Optional. Applicable to all despatch types.
Planned End Unloading	The planned date and time of the end of unloading at the route point. Optional. Applicable to all despatch types.
ATA	The actual date and time of arrival at the route point. Optional. Applicable to all despatch types.
ATD	The actual date and time of departure from the route point. Optional. Applicable to all despatch types.
Actual Start Loading	The actual date and time of the start of loading at the route point. Optional. Applicable to all despatch types.
Actual End Loading	The actual date and time of the end of loading at the route point. Optional. Applicable to all despatch types.
Actual Start Unloading	The actual date and time of the start of unloading at the route point. Optional. Applicable to all despatch types.
Actual End Unloading	The actual date and time of the end of unloading at the route point. Optional. Applicable to all despatch types.
Planned Berth Date	The planned berthing date and time at the route point. Optional. Only applicable to service trips and shipments.
Planned Unberth Date	The planned unberthing date and time at the route point. Optional. Only applicable to service trips and shipments.
Actual Berth Date	The actual berthing date and time at the route point. Optional. Only applicable to service trips and shipments.
Actual Unberth Date	The actual unberthing date and time at the route point. Optional. Only applicable to service trips and shipments.
Planned Berth	The Alias1 of the planned berth for the shipment. Optional. Only applicable to shipments.
Actual Berth	The Alias1 of the actual berth for the shipment. Optional. Only applicable to shipments.
Vessel NOR Tendered	The date on which the note of readiness for the shipment was tendered. Optional. Only applicable to shipments.
Vessel NOR Tendered Acceptance	The date on which the note of readiness for the shipment was accepted Optional. Only applicable to shipments.
Berthing Pilot Organisation	The Alias1 of the organisation used to provide a pilot for the shipment during berthing. Optional. Only applicable to shipments.
Berthing Pilot Contact	The Alias1 of a contact within the berthing pilot organisation. Optional. Only applicable to shipments.
Berthing Commercial Officer Organisation	The Alias1 of the organisation used to provide a commercial officer for the shipment during berthing. Optional. Only applicable to shipments.
Berthing Commercial Officer Contact	The Alias1 of a contact within the berthing commercial officer organisation. Optional. Only applicable to shipments.
Berthing Shipping Agent Organisation	The Alias1 of the organisation used to provide a shipping agent for the shipment during berthing. Optional. Only applicable to shipments.
Berthing Shipping Agent Contact	The Alias1 of a contact within the berthing shipping agent organisation. Optional. Only applicable to shipments.
Berthing Notes	Notes on the berthing. Optional. Only applicable to shipments.
Sailing Pilot Organisation	The Alias1 of the organisation used to provide a pilot for the shipment during sailing. Optional. Only applicable to shipments.
Sailing Pilot Contact	The Alias1 of a contact within the sailing pilot organisation. Optional. Only applicable to shipments.
Sailing Commercial Officer Organisation	The Alias1 of the organisation used to provide a commercial officer for the shipment during sailing. Optional. Only applicable to shipments.
Sailing Commercial Officer Contact	The Alias1 of a contact within the sailing commercial officer organisation. Optional. Only applicable to shipments.
Sailing Shipping Agent Organisation	The Alias1 of the organisation used to provide a shipping agent for the shipment during sailing. Optional. Only applicable to shipments.
Sailing Shipping Agent Contact	The Alias1 of a contact within the sailing shipping agent organisation. Optional. Only applicable to shipments.
Sailing Notes	Notes on the sailing. Optional. Only applicable to shipments.

Example

CSV file to update the planned itinerary of a train and the sailing details of a shipment.

Copy

Object,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,Planned Berth Date,Planned Unberth Date,Actual Berth Date,Actual Unberth Date,Planned Berth,Actual Berth,Vessel NOR Tendered,Vessel NOR Tendered Acceptance,Berthing Pilot Organisation,Berthing Pilot Contact,Berthing Commercial Officer Organisation,Berthing Commercial Officer Contact,Berthing Shipping Agent Organisation,Berthing Shipping Agent Contact,Berthing Notes,Sailing Pilot Organisation,Sailing Pilot Contact,Sailing Commercial Officer Organisation,Sailing Commercial Officer Contact,Sailing Shipping Agent Organisation,Sailing Shipping Agent Contact,Sailing Notes
[Train],Train01,RP1,12/01/2016 12:34,12/01/2016 23:45,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,
[Shipment],Shipment01,RP1,,,,,,,,,,,,,,,,,,,,,,,,,,,,PilotOrganisation01,PilotContact01,CommercialOfficerOrganisation01,CommercialOfficerContact01,ShippingAgentOrganisation01,ShippingAgentContact01,

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

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

The data for each route plan must be entered in order in the row. Optional columns do not have to be in the CSV file, but if included, leave blank cells for times, organisations and contacts that are not needed. Blank cells do not delete existing MineMarket data for the route plan. Every row must have the same number of columns as the header row.

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.

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