Userout File Guide v1 Optimiser Userout File Guide.pdfUserout File Guide v1.2 Page 5 UserOut File...

Userout File Guide v1.2

Page 2 Userout File Guide v1.2

Contents

Introduction 4

Conventions 4

UserOut File 5

The PL.Ini File 5

Userout Headers 8

Order/Task Level 8

Schedule Level 9

Schedule level warnings 10

Trip Level 12

Trip level warnings 13

Route/Summary Level 13

Summary level warnings 15

Parameter Level 16

Resources 16

Route Optimiser PL.INI output section 18

Output field definition 20

Output field explanation 21

Sequence 21

Calltype 21

Order 22

Arr_day 22

Arr_time 22

Dep_day 22

Dep _time 22

Duration 22

Trav_time 22

Trav_Dist 22

Route 23

Description 23

Start_dep 23

Finish_dep 23

Name 23

Userout File Guide v1.2 Page 3

StemKMS 23

StemSec 23

First_Wkno, Last_Wkno 23

Trip_Start_Wkno, Trip_End_Wkno 23

User_Wkno 23

Start_Wkno 24

Example CSV output 25

Example output 25


Revision Control

Revision Date By Details

1.0 05/10/15 Mohammad

Arif

Initial version

1.1 25/07/16 Mohammad

Arif

MVLoad description updated

ProdA-Z can be output so 25 was incorrect

it’s now 26

1.2 26/06/17 Mohammad

Arif

CALL_DESC added as a Schedule field

TASK_DESC added as a Task field

Introduction

To prevent duplication, this document has been written to be used in conjunction

with your Route Optimiser training notes.

The Userout mechanism provides a customer configurable mechanism for producing

bespoke CSV type files. The output definition is defined via the PL.INI file, and

therefore can be work area dependent.

Conventions

Defining the goal or identifying the reason why an action or activity should take place

Throughout the document, this type of highlight identifies key notes.

Impact points identify where caution needs to be used. It may seem a great idea to run

the top level of detail and the most detailed set of requirements, however if this is taken

too far then there may be a negative IMPACT on the result.

Where possible we will make a recommendation

INI settings


UserOut File

This is a CSV file that can be set up to output once the scheduling process has

completed. By default the file saves to the folder of the current active profile. The

advantage of the UserOut file over the Profile reports is that you can choose what

field headers and data are included. This section therefore looks at how you can

manually configure the UserOut file. A list of all the available data fields is listed in the

Appendix.

The UserOut file can’t be configured from within Route Optimiser itself, instead it

requires you to access a file stored within the active profile.

The PL.Ini File

This is a Configuration Settings file that you need to edit to setup the UserOut file. It’s

located in the C:\Carp\Workarea\<Profile Name> folder so browse to this location

using Windows Explorer and open it with Notepad. The file will look similar to this:

There are four different types of report available. To define which type(s) to include

you need to add an additional line in the [Plan LogiX] section of the PL.Ini shown

above. Add the line ‘ UserCSV=nn ’ where ‘nn’ is the unique number of the report

type you want to include. The report types and their numbers are as follows:

1=Route Summary

2=Trip Summary

4=Scheduled Orders

8=Unallocated Orders

To include more than one type of report add the numbers together and use the sum

as the ‘nn’ number. For example, to include Scheduled and Unallocated Orders in

the UserOut file the new line to input would be ‘ UserCSV=12’ . The example is

shown in the screenshot below:


When using a mix of lines, each line starts with the line type i.e. “8,” or “4,” in the above

example. In this example, the output file would contain two header lines again each line

starting with the line type. If the USERCSV setting does not result in multiple row types,

then the line type is omitted.

The separator can be change from a comma by using the PL.INI setting

USERCSVSEPARATOR=

Date fields can be formatted using the PL.INI setting UserCSVDateFormat

Time fields can be formatted using the PL.INI setting UserCSVTimeFormat

Distance can be formatted using the PL.ini setting UserCSVDistanceFormat

With the report types defined you must now choose what data to include in each

report. To do this a new section must be created for each report you include. The

section titles are as follows:

[CSVSummary] for the Route Summary report

[CSVTrip] for the Trip summary report

[CSVSchedule] for the Scheduled and Unallocated Orders reports

Each report type has a number of different data fields and you must define which to

include by listing the field headers under the relevant section titles in the PL.Ini. The

format of the entry is as follows:

‘Field Name=Column Number, Custom Column Name’

The Field Name is the name of the field you want to include. The Column Number is

what column within the UserOut you want the data to appear in. The comma is used

as a separator. The Custom Column Name is optional and allows you to change the

display name of the field header. If this is omitted the comma must still be added.

A full list of the available fields for each report type can be found in the Appendix.

Below is an example [CSVSchedule] section from the PL.Ini:


The ‘ UserCSV=12 ’ setting in the [Plan-LogiX] section coupled with the above

definition for the Scheduled and Unscheduled Orders report creates the following

UserOut file after Auto Schedule:

You should run MultipleRouteAnalysis when using the UserOut.CSV file. This will force a

complete file to be generated; otherwise, the file may only contain the details for the last

route(s), which were modified.

If you are intending to use the UserOut.CSV functionality with user `s then you should

consider changing/adding the following setting to the [Options] section of WLPLAN.ini

RecalcBeforeUserProgram=YES

This will force the UserOut.CSV file to be regenerated prior to running the script

associated to the user button.

If you need product quantity information (at product level as well as unit level) you need

to set ProductTypes=Yes in the PL.INI file

Fixed text fields can be added to the userout file by using the field headers Text1 to Text9

with the following format:

Field_Name = Field_sequence_no,Column_name,Text,

So the following would create a field called “Supplier” with the text “DPS” as the first field


for every record

Text1 = 1,Supplier,DPS,

Each section (Summary,Trip,Schedule) may be written to a separate file. Within each

section there is a new ini key OutputFile=FileName.CSV for example

[CSVSCHEDULE]

OutputFile = UserSchedule.Csv

RouteName=1,

Sequence=2,

[CSVSUMMARY]

OutputFile = UserSummary.Csv

Route_Num,=1,

There will now be two separate output files. If OutputFile = is blank or the key not

present, it defaults to the main userout , which itself defaults to UserOut.Csv. If two or

more Outputfile names are the same, then multiple reports within that file will be

generated according to existing practice. The feature defaults to existing behaviour.

Userout Headers

Order/Task Level

The following lists the field headers available at order level, these are duplications of

fields used in the import file:

Field Name Description

ADDRESS_1 First Line of Address

ADDRESS_2 Second Line of Address

ADDRESS_3 Third line of Address

ADDRESS_4 Fourth line of Address

BAYS Number of loading bays

BOOKDAY Bookday of Order

BOOKTIME Booktime of Order

CLOSE1 Time of first close window

CLOSE2 Time of second Close window

CONFIDENCE Confidence level at which the order was located

CUST_INFO1 Customer information 1

CUST_INFO2 Customer Information 2




CUST_NAME Customer Name

DIRECT_DEPOT Ideal depot the order is serviced from

DIRECT_KMS Distance from the ideal depot

DIRECT_RAD

DIRECT_SEC Seconds from the ideal depot

FIRST_DATE First Date of Plan



FIRST_DOP First Day of Plan

FIRST_WKNO First Week Number

FIXED_SECS Fixed number of Seconds

LATITUDE Latitude of Order

LAST_DATE First Date of Plan

LAST_DOP First Day of Plan

LAST_WKNO Last Week Number

LINKED_TO Call Point the order is linked to

LOCATION Location of Order in relation to nearest Town/City

LONGITUDE Longitude of Order

OPEN1 Time of first Open window

OPEN2 Time of second Open window

ORDER Order reference

PHONE Phone Number

PREF_DEP Preferred Depot

PROD_A to Y Quantities of Prod1 to Prod26 values

SHADOW Shadow time in minutes

TASK_DESC The type 1 & 3 will both be described as C, and 2 & 4 will be D

TASK_REVENUE Revenue this order generates

TASK_TYPE Type of Task: Address, Depot or Order

TASK_UNIT1 Load size for primary load unit

TASK_UNIT2 Load size for secondary load unit

TASK_UNT3 Load size for third load unit

TEMPLATE Call Reference

WORK_SECS Worktime in Seconds

ZIPCODE Postcode of Order

ZONE Zone number of Order

ZONENAME Zone name of Order

Schedule Level

The following headers are available at schedule level:


ARR_DATE Arrival Date

ARR_DAY Arrival Day

ARR_DAYNO Arrival Day Number (1-7)

ARR_DOP Arrival Day of Plan

ARR_TIME Arrival Time

ARR_WKNO Arrival Week Number

CALL_NO Call Number

CALL_TYPE

1=Collection, 2=Delivery, 3=Off Duty, 4=Depot Call, 5=Rest break,

6=Other Work, 7=Waiting Time

CALL_DESC Call types output as word descriptions

CLASS Class of Event

COST_ORDER Order cost

DEP_DATE Departure Date

DEP_DAY Departure Day

DEP_DAYNO Departure Day Number

DEP_DOP Departure Day of Plan

DEP_TIME Departure Time



DEPOT_NUM Depot Number

DEP_WKNO Departure Week Number

DROP_NO Drop Number on Route

DURATION Duration at Call

LOGIX

T=True for Route Optimiser insertions (Rest Break, Waiting, Off Duty),

F=False for Depots and Orders

LOW_UTIL Low Utilisation

ORDER Order Reference

PHASE 0=depot calls, waiting time. 1=orders, rest breaks

S_REVENUE Revenue of Order

S_DRV_KMS Driving distance in Kilometres to 2 decimal places

S_DRV_SECS Travelling time in seconds

S_DUR_SECS Duration in seconds

S_ETA_HMS Arrival Time in 24 hour clock format

S_LTD_HMS Departure Time in 24 hour clock format

SEQUENCE Sequence Number of Order on Route

SSTATUS Status

TRAV_DIST Travel Distance

TRAV_TIME Travel Time

UNIT_1 Primary Load Unit

UNIT_2 Secondary Load Unit

UNIT_3 Tertiary Load Unit weight

VLOAD_1

VLOAD_2

VLOAD_3

WAITSEC

WARNINGS Warnings against Order

Schedule level warnings

The Warning data is formatted as follows:-

Code Dec Hex On Order

0 (1) (0001) Depot Throughput Exceeded

1 (2) (0002) Incompatible Zones

2 (4) (0004) Incompatible Products

3 (8) (0008) Too Many Calls/Product Group Not Stocked At Depot

4 (16) (0010) Illegal Start Depot

5 (32) (0020) Illegal End Depot/Vehicle Type Error

6 (64) (0040) Vehicle Size Error

7 (128) (0080) Sequence Error

8 (256) (0100) Call Not Open

9 (512) (0200) Waiting Too Long In Order

10 (1024) (0400) Frequency Invalid

11 (2048) (0800) Shelf Life Exceeded



Trip Level

The following are available at trip summary level:


COL_PROD_A to Y Collection value for Prod1 to Prod26

DEL_PROD_A to Y Delivery value for Prod1 to Prod26

STEMKMS Stem KMS

STEMSEC Stem time in seconds

TANK1_PROD to

TANK16_PROD Product Type in the 16 Tank Compartments

TANK1_QTY TO

TANK16_QTY Quantity of Product in the 16 Tank Compartments

TRIP_CALLS Number of Calls on Trip

TRIP_COL_1 Collections for Primary Load Unit within a Trip

TRIP_COL_2 Collections for Secondary Load Unit within a Trip

TRIP_COL_3 Collections for Tertiary Load Unit within a Trip

TRIP_COLS Total number of Collections within a Trip

TRIP_DEL_1 Deliveries of Primary Load Unit within a Trip

TRIP_DEL_2 Deliveries of Secondary Load Unit within a Trip

TRIP_DEL_3 Deliveries of Tertiary Load Unit within a Trip

TRIP_DELS Total number of Deliveries within a Trip

TRIP_DIST Distance of Trip

TRIP_END_DAY Day the Trip ends on

TRIP_END_DAYNO Number of the Day the Trip ends on

TRIP_END_DEP Name of Depot the Trip ends on

TRIP_END_DOP Day of Plan the Trip ends on

TRIP_END_SECS Time the Trip ends (Arrival time at Depot)

TRIP_END_TIME Time the Trip ends at depot

TRIP_END_DATE Date the Trip ends (when using Planning Dates)

TRIP_END_WKNO Week number the Trip ends (when using Planning Dates)

TRIP_KMS Distance of Trip

TRIP_LOAD_1 Amount of Primary Load Unit within a Trip

TRIP_LOAD_2 Amount of Secondary Load Unit within a Trip

TRIP_LOAD_3 Amount of Tertiary Load Unit within a Trip

TRIP_MVLOAD_1

Maximum Primary Vehicle Loading – Where you have

collection and deliveries mixing, then the vehicle can be

filled up and empty as it goes, so the MVs can be different

from the normal load values. The MV gives the smallest

vehicle capacity required to operate the route.

TRIP_MVLOAD_2

Maximum Secondary Vehicle Loading – Where you have





TRIP_MVLOAD_3

Maximum Thirsty Vehicle Loading – Where you have





TRIP_NUM Number of Trips

TRIP_SECS Length of Trip in Seconds



TRIP_START_DATE Start date of Trip

TRIP_START_DAY Start Day of Trip

TRIP_START_DAYNO Start Day number of Trip

TRIP_START_DEP Start Depot of Trip

TRIP_START_DOP Day of Plan Trip starts on

TRIP_START_SECS Start time of Trip in seconds

TRIP_START_TIME Start Time of Trip

TRIP_START_WKNO Week number the Trip starts (when using Planning Dates)

TRIP_TIME Total Time of Trip

TRIP_UNLOAD_1 Amount of Primary Load Unit unloaded at the end of a Trip

TRIP_UNLOAD_2

Amount of Secondary Load Unit Unloaded at the end of a

Trip

TRIP_UNLOAD_3 Amount of Tertiary Load Unit Unloaded at the end of a Trip

TSTEMKMS

TSTEMSEC

TTANK1_PROD to

TTANK16_PROD Product quantity in each Tank Compartment

TTANK1_QTY to

TTANK16_QTY Capacity of each Tank Compartment

TWARNING Trip Warning Number

VTANK1_PROD to

VTANK16_PROD

Product Quantity in each Tank Compartment when using

Metered Flow

VTANK1_QTY to

VTANK16_QTY

Capacity of each Tank Compartment when using Metered

Flow

Trip level warnings

The warning data is formatted as follows:-

Code Dec Hex On Trip

0 ( 1) ( 1) Thruput

1 ( 2) ( 2) Zone

2 ( 4) ( 4) LoadType

3 ( 8) ( 8) Too Many Calls

5 ( 32) ( 20) Veh Type

6 ( 64) ( 40) Veh Size

7 ( 128) ( 80) Sequence

8 ( 256) ( 100) Times Fail

15 (8000) Orders Errs

Route/Summary Level

The following are available at route summary level:


AV_CAP_1 Average Capacity for Primary Load Unit

AV_CAP_2 Average Capacity for Secondary Load Unit

AV_CAP_3 Average Capacity for Tertiary Load Unit

AV_DRIVE Average Driving Time

AV_DUTY Average duty time

AVAILREF Resource reference number (Vehicle Resource Pack Mode)

CONDITION Condition of the route



DCOST_NITE Overnight Driving Cost

DCOST_NORM Normal Driving Cost

DCOST_OT Overtime Driving Cost

DESCRIPTION Route Description

DRIVER

EMPTY_KMS Distance on Empty Capacity

EMPTY_TIME Time Spent on Empty Capacity

FINISH_DEP Finishing Depot

LONGNAME Full Route Name

MODIFIED

RCOST_ORDER

RCOST_UNIT1 Cost for Unit 1



RMVLOAD_1

RMVLOAD_2

RMVLOAD_3

ROUTE_NUM Route Number

ROUTENAME Route Name

RSTEMKMS Route Stem KMS

RSTEMSEC Route Stem time in seconds

RWARNING list of Route Warnings

SEC_BREAK Number of Seconds on a Break

SEC_DRIVE Number of Seconds spent driving

SEC_DUTY Number of seconds spent on duty

SEC_NORM Number of Seconds spent on Normal duty

SEC_OFF Number of Seconds Off Duty

SEC_OT Number of seconds of overtime

SEC_OTHER Number of seconds of other work

SEC_TOTAL Total number of seconds of route

SHIFT_NAME Shift Name

SHIFT_NUM Shift Number

SOURCE Source of route: Auto Schedule Manual Plan/Zone

START_DATE Route Start Date

START_DAY Route Start Day

START_DAYNO Route Start Day Number (1-7)

START_DEP Starting Depot

START_DOP Starting Day of Plan

START_SEC Start Time of route in high precision (hh:mm:ss)

START_TIME Start Time of Route

START_WKNO Route Start Week Number

STATUS Status of Route

STEMKMS Stem KMS

STEMSEC Stem time in seconds

TOT_BREAK Total length of Break

TOT_CALLS Total Number of Calls on Route

TOT_CO2 Total CO2 Emissions

TOT_COL_1 Total number of Collections for Primary Load Unit



TOT_COL_2 Total number of Collections for Secondary Load Unit

TOT_COL_3 Total number of Collections for Tertiary Load Unit

TOT_COLS Total Number of Collections

TOT_COST Total Cost of Route

TOT_DEL_1 Total number of Deliveries for Primary Load Unit

TOT_DEL_2 Total number of Deliveries for Secondary Load Unit

TOT_DEL_3 Total number of Deliveries for Tertiary Load Unit

TOT_DELS Total number of Deliveries

TOT_DIST Total Distance of Route

TOT_DRIVE Total Driving Time

TOT_DUTY Total Duty Time

TOT_KMS Total distance of Route

TOT_NORM Total Basic Rate time

TOT_OFF Total Off Duty on Route

TOT_OT Total Overtime on Route

TOT_OTHER Total Other Work time

TOT_REV Total Revenue

TOT_SHIFTS Total number of shifts on Route

TOT_TIME Total time of Route

TOT_TRIPS Total Number of Trips

TRAILER Trailer used on Route

TRAILER_ID ID of Trailer used

TRAILER_TYPE Type of Trailer

UNIQUE_NUM Unique sequential journey number

USER_DATE User Date

USER_DAY User imposed day

USER_DOP User Day Of Plan

USER_SEC User

USER_WKNO User imposed week number

VCOST_DIST Vehicle Cost by distance

VCOST_TIME Vehicle Cost by time

VEHICLE_GROUP Vehicle Group

VEHICLE_ID Vehicle Identification

VEHICLE_NAME Name of Vehicle

VEH_NUM Vehicle number

VEHICLE_TYPE Vehicle Type used

WAITSEC Waiting time in seconds

Summary level warnings

Code Dec Hex On Jny

0. (1) (0001) Error on Trip

1. (2) (0002) Incompatible Zones

2. (4) (0004) Incompatible Zones

3. (8) (0008) Too Many Calls

4. (16) (0010) Start Depot Not Garage

5. (32) (0020) End Depot Not Garage


6. (64) (0040) No Resource Available

7. (128) (0080) Not used by Auto

8. (256) (0100) Infeasible Route

9. (512) (0200) Too Many Overnights

10. (1024) (0400) Too Many Trips (Depot Visits)

11. (2048) (0800) Not used by Auto

12. (4096) (1000) Shift Exceeds Legal Maximum

Parameter Level

The following headers are available at all levels:


PROD_NAME_A to PROD_NAME_Z Name of Product 1-26

SHIFT_NAME Shift Name

SHIFT_NUM Shift Number

UNIT_NAME_1 Name of Primary Load Unit

UNIT_NAME_2 Name of Secondary Load Unit

UNIT_NAME_3 Name of Third Load Unit

VEHICLE_GROUP Vehicle Group

VEHICLE_NAME Vehicle Name

VEHICLE_TYPE Vehicle Type

Resources

When running in AutoControl=3, Availability mode, extra output fields are enabled.


VEHICLE_TYPE The motive vehicles type

TRAILER_TYPE The trailers type

VEHICLE_ID The vehicles asset name, if set

TRAILER_ID The trailers asset name, if set

.

As Availability mode introduces the ability to define compartments on both the

motive vehicle and the trailer, additional tank output fields have been added.


VTank1_Prod..VTank16_Pro

d

Define the product number for each tank on the

vehicle

TTank1_Prod..TTank16_Prod

Define the product number for each tank on the

trailer

VTank1_Qty..VTank16_Qty Define the amount for each tank on the vehicle

TTank1_Qty..TTank16_Qty Define the amount for each tank on the trailer


It's important that it's understood that auto is only saying that the amount of product

could fit on the vehicle, and not that the vehicle should be loaded in a particular way.

It's also important to understand that, if you only have 1 litre of product on a vehicle, the

output will list the product as being "loadable" into all tanks. This is caused by the fact

that scheduling is based on combinations of tanks, and if it only needs 1 tank, that

combination is all tanks added together.

Also as when scheduling, the auto engine searches for a total tank combination size to

take the amount of product, if all tanks are the same size when it does it's output, it scans

the unit for tanks of the correct sizes to create the required combination.


Route Optimiser PL.INI output section

The following is an example output file structure, the source table (For DPS reference).

Where possible the same field names have been used in the export file and

database.

[CSVSCHEDULE]

ORDER = 1,

CUST_NAME = 2,

ADDRESS_1 = 3,

ADDRESS_2 = 4,

ADDRESS_3 = 5,

ADDRESS_4 = 6,

ZIPCODE = 7,

ROUTENAME = 8,

SEQUENCE = 9,

CALLTYPE = 10,

TASK_TYPE = 11,

UNIT_1 = 12,

UNIT_2 = 13,

CUST_INFO1 = 14,

CUST_INFO2 = 15,

CUST_INFO3 = 16,

CUST_INFO4 = 17,

CUST_INFO5 = 18,

LATITUDE = 19,

LONGITUDE = 20,

LOCATION = 21,

OPEN1 = 22,

CLOSE1 = 23,

OPEN2 = 24,

CLOSE2 = 25,

PROD_A = 26,

PROD_B = 27,

PROD_C = 28,

PROD_D = 29,

PROD_E = 30,

ARR_DAY = 31,

ARR_TIME = 32,

DEP_DAY = 33,

DEP_TIME = 34,

DURATION = 35,

TRAV_TIME = 36,

TRAV_DIST = 37,

REVENUE = 38,

STATUS = 39,

DESCRIP = 40,

START_DEP = 41,

FINISH_DEP = 42,

TOT_DIST = 43,

TOT_TIME = 44,

TOT_DUTY = 45,

TRAILER = 46,



Output field definition

Field name Table Type Width Standard

output

Comment

Order Task

Schedule

Char 12 Order See note in import section

This is the unique link back to the original

job or transport stage combination. This

could include a C or D suffix indicates if

this record related to the collection or

delivery part of a stage.

Cust_name Task Char 30 Name

Address_1 Task Char 30 Address_1




Zipcode Task Char 10 Postcode

RouteName Summary Char 8 The route name will not be unique over

days or work areas. It will include any

Zone reference that may have been

passed to Route Optimiser unless the user

has changed it.

Sequence Schedule Num 3 Drop Sequence of this event on the route.

Calltype Schedule Num 1 Defines the type of task, not all of the

records will be applicable to Sentinel Live.

Some of these will be ignored – e.g. rest

breaks.

Unit_1 Schedule Num 12 Amount in Unit 1 up to nnnnnnn.nnnnn

Unit_2 Schedule Num Amount in Unit 2 up to nnnnnnn.nnnnn

Cust_info1 Task Char 40 Customer information Field 1. See import

definition


definition


definition


definition


definition

Latitude Num 3:4 As a decimal i.e. 52.4584

Longitude Num 3:4 As a decimal i.e.-02.0433

Location Char 40 Location description text

Open1 Num 4 Opening time 1 HHMM

Close1 Num 4 Closing time 1 HHMM

Open2 Num 4 Opening time 2 HHMM

Close2 Num 4 Closing time 2 HHMM

Prod_a Num 5 Amount product 1, up to 26(Z)

Prod_b Num 5 Amount product 2, up to 26(Z)

Prod_c Num 5 Amount product 3, up to 26(Z)

Prod_d Num 5 Amount product 4, up to 26(Z)

Prod_e Num 5 Amount product 5, up to 26(Z)

Arr_dayNo Schedule Num 2 This gives us the planned day of the call

using the day number. The arrival day will

be in the range of 1 to 13. Route

Optimiser can plan for a complete week,

starting on any day of the week i.e.


Field name Table Type Width Standard

output

Comment

Wednesday for 7 days, Wednesday = 3

the next Monday = 8

Arr_time Schedule Char 4 hh:mm

Dep_DayNo Schedule Num 2 Day of departure from the point. See

Arr_Day

Dep_time Schedule Char 4 Time of departure from the point hh:mm

Duration Schedule Num 5 The duration of this part of the trip – this

may be another type other than a

collection or delivery.

Trav_time Schedule Num 5 Minutes

Trav_dist Schedule Num 8.2 Km

Revenue Schedule Num 11.4 Estimated cost of this part of the trip.

Status Summary Num 1 Route status open, pre-dispatched,

dispatched

SStatus Schedule Num 1 Trip status open, pre-dispatched,

dispatched

Descrip Summary Char 30 Route Description

Start_dep Summary Num 5 Starting depot

Finish_dep Summary Num 5 End Depot where applicable

Tot_dist Summary Num 8.2 Total distance of all the events which

occur on this route – can be used as the

route/manifest distance. This is in km’s.

Tot_time Summary Num 5 Total time in minutes including breaks, off

duty periods such as overnights etc.

Tot_duty Summary Num 5 Time spent on duty – excludes breaks.

Name Vehicle Char 12 Vehicle type name

Route Optimiser does not allocate

specific Vehicles to a route; this is the job

of the planner.

Output field explanation

The output file name and location can be configured at a work area level.

Therefore, it is possible to have the output file stored within the work area or written to

a given location. In a situation where multiple depots or copies of Route Optimiser

are used, the ability to define the output location and name at work area level would

allow each depot or plan type to be written to a different file (one per master work

area).

Sequence

The sequence number defines the “tasks” sequence within a route. Not all tasks are

orders, they can be waiting time, depot time, off duty time etc. (see CallType).

Sequence numbers are required if the plan is to be replanned

Calltype The call type defines the type of task

1 = collection

2 = delivery

3 = off-duty period

4 = depot call

5 = rest break

6 = other work

7 = waiting time


CALL_DESC & TASK_DESC UserCSV options to allow both Task and Schedule types to be displayed as text rather

than their numeric value. The new entries are CALL_DESC for the schedule entries and

TASK_DESC for the task.

To make the naming more consistent CALLTYPE is now deprecated and CALL_TYPE is

preferred, but both work.

Likewise, CALLDESC may be used though CALL_DESC is preferred.

In the case of Task, the type 1 & 3 will both be described as C, and 2 & 4 will be D.

The Call, more accurately Events, use the descriptions as used in the JNY files with the

addition of Collect and Deliver;

Event Description, "Collect"

Event Description, "Deliver"

Event Description, "Depot"

Event Description, "off-duty period"

Event Description, "rest break"

Event Description, "other work"

Event Description, "waiting time"

Event Description, "driving time"

Event Description, "off-duty period"

Event Description, "rest break"

Event Description, "other work"

Order

The “Order” field is the same as the “order ref” within the import file. Order is used by

Route Optimiser to identify orders, and therefore must be unique within a work area.

The “order” is 12 characters case insensitive i.e. “A12” is the same as “a12”.

Arr_day

The Arr_day field stores the vehicle arrival / task start day. This field is important as

Route Optimiser can plan for multiple days.

Arr_time

The Arr_time field stores the vehicle arrival / task start time.

Dep_day

The Dep_day field stores the vehicle departure / task end day. This field is important

as Route Optimiser can plan for multiple days.

Dep _time

The Dep_time field stores the vehicle departure / task end time.

Duration

Task duration, this could be the time to load/unload an order, waiting time etc.

Trav_time

Travel time can be allocated against any task type, and represents the calculated

time for the preceding journey.

Trav_Dist


Travel distance can be allocated against any task type, and represents the

calculated distance for the preceding journey in kms.

RouteName

Short route code generated by Route Optimiser, which can be changed by the user.

When the “Route” name is assigned by Route Optimiser, it is constructed from the

route prefix as defined within the master work area and either the sequential route

number or the fixed route number (if planning based on fixed zones). The “Route” will

be unique within a work area, however if a work area is modified by Route Optimiser

the sequence number can be reused. For example, if a plan already uses route

Man0008, this route is deleted, and Route Optimiser automatically generates extra

routes the identifier Man0008 could be reused, for a different route and set of orders.

Description

Route description, entered by the user. In the initial meeting discussions took place

regarding the creation of a unique route identifier, the Description field could be

used.

Start_dep

The routes starting depot, this is important if dynamic depots are used, whereby

vehicles from different depots can service the order.

Finish_dep

The depot at which the vehicle finishes, of use to tracking vehicle location

Name

The “Name” field stores the text of the Vehicle name. Each vehicle type within the

database is allocated a name, access group, dimensions and planning details. This

vehicle name would logically link up to the vehicle category within Sentinel Live.

StemKMS

This is the distance from the depot to the 1st call and from the last call back to the

depot. If requested at a trip level then the result will be based on each trip, if

requested at a summary level then it will be a total of all the stem distance on a multi

trip route.

StemSec

This is the time from the depot to the 1st call and from the last call back to the depot.

If requested at a trip level then the result will be based on each trip, if requested at a

summary level then it will be a total of all the stem time on a multi trip route.

First_Wkno, Last_Wkno

First and last service days on OrdersArr_Wkno, Dep_Wkno

Arrive and depart days on Orders

Trip_Start_Wkno, Trip_End_Wkno

Trip start and end days

User_Wkno


User imposed Route start day

Start_Wkno

Actual route start day


Example CSV output 3,ORDER,CUSTNAME,ADDRESS_1,ADDRESS_2,ADDRESS_3,ADDRESS_4,ZIPCODE,ROUTENAME,SEQUENCE,CALLTYPE,UNIT1,UNIT2,CUST_INFO1,CUST

_INFO2,CUST_INFO3,CUST_INFO4,CUST_INFO5,LATITUDE,LONGITUDE,LOCATION,OPEN1,CLOSE1,OPEN2,CLOSE2,PROD_A,PROD_B,PROD_C,PROD

_D,PROD_E,ARR_DAY,ARR_TIME,DEP_DAY,DEP_TIME,DURATION,TRAV_TIME,TRAV_DIST

3,,Halesowen,,,,,,AUTO0006,1,2,15,0,,,,,,52.4471,-2.0503,Central Halesowen,0,0,0,0,0,0,0,0,0,Mon,833,Mon,843,10,0,0

3,1801,Customer - B61 8EX,,,,,B61 8EX,AUTO0006,2,2,1,0,,,,,,52.3338,-2.06,Central Bromsgrove,900,1600,0,0,0,0,0,0,0,Mon,900,Mon,904,4,17,17

3,1802,Customer - B97 4QN,,,,,B97 4QN,AUTO0006,3,2,1,0,,,,,,52.3061,-1.9415,Central Redditch,900,1600,0,0,0,0,0,0,0,Mon,915,Mon,919,4,11,11

3,1824,Customer - WR11 4DB,,,,,WR11 4DB,AUTO0006,4,2,1,0,,,,,,52.093,-1.946,Central Evesham,900,1600,0,0,0,0,0,0,0,Mon,952,Mon,956,4,33,34

3,1304,Customer - CV37 6JG,,,,,CV37 6JG,AUTO0006,5,2,1,0,,,,,,52.1917,-1.7074,Central Stratford upon

Avon,900,1600,0,0,0,0,0,0,0,Mon,1023,Mon,1027,4,27,28

Example output

Some repeated columns i.e. Prod have been removed to make the table more readable

3

OR

DE

R

CU

ST

NA

ME

AD

DR

ES

S_

1

AD

DR

ES

S_

2

AD

DR

ES

S_

3

AD

DR

ES

S_

4

ZIP

CO

DE

RO

UT

E

SE

QU

EN

CE

CA

LL

TY

PE

UN

IT1

UN

IT2

CU

ST

_IN

FO

1

LA

TIT

UD

E

LO

NG

ITU

DE

LO

CA

TIO

N

OP

EN

1

CLO

SE

1

OP

EN

2

CLO

SE

2

PR

OD

_A

AR

R_

DA

Y

AR

R_

TIM

E

DE

P_

DA

Y

DE

P_

TIM

E

DU

RA

TIO

N

TR

AV

_T

IME

TR

AV

_D

IST

3 Halesowen AUTO0006 1 2 15 0 52.4471 -2.0503 Central Halesowen 0 0 0 0 0 Mon 833 Mon 843 10 0 0

3 1801 Customer - B61 8EX B61 8EX AUTO0006 2 2 1 0 52.3338 -2.06 Central Bromsgrove 900 1600 0 0 0 Mon 900 Mon 904 4 17 17

3 1802 Customer - B97 4QN B97 4QN AUTO0006 3 2 1 0 52.3061 -1.9415 Central Redditch 900 1600 0 0 0 Mon 915 Mon 919 4 11 11

3 1824 Customer - WR11 4DB WR11 4DB AUTO0006 4 2 1 0 52.093 -1.946 Central Evesham 900 1600 0 0 0 Mon 952 Mon 956 4 33 34

3 1304 Customer - CV37 6JG CV37 6JG AUTO0006 5 2 1 0 52.1917 -1.7074 Central Stratford upon Avon 900 1600 0 0 0 Mon 1023 Mon 1027 4 27 28

3 1305 Customer - CV8 1HN CV8 1HN AUTO0006 6 2 1 0 52.3406 -1.5769 6 kms NNW of Leamington Spa 900 1600 0 0 0 Mon 1045 Mon 1049 4 18 21

3 1303 Customer - CV32 4AQ CV32 4AQ AUTO0006 7 2 1 0 52.2892 -1.5349 S Leamington Spa 900 1600 0 0 0 Mon 1056 Mon 1100 4 7 8


Date post:	10-Nov-2020
Category:	Documents
Upload:	others
View:	8 times
Download:	0 times

Userout File Guide v1 Optimiser Userout File Guide.pdfUserout File Guide v1.2 Page 5 UserOut File...

Documents