PL.ini Settings v4.7
PL.INI settings Version 4.8
PL.ini Settings v4.7
Contents PL.INI settings Version 4.3 ........................................................................................... 1 Revision Control ............................................................................................................ 1 Introduction .................................................................................................................... 5
Conventions ............................................................................................................... 5 [Plan-LogiX] .................................................................................................................. 6
General ....................................................................................................................... 6 Auto only ................................................................................................................. 14
[Alias] .......................................................................................................................... 27
[AllColumns] ............................................................................................................... 27 [Auto32] ....................................................................................................................... 27
[Auto_Import] .............................................................................................................. 29
[AllColumnsWidths] .................................................................................................... 31 [Assistant] .................................................................................................................... 31 [Catchment].................................................................................................................. 31 [Centres] ....................................................................................................................... 32 [DataTables] ................................................................................................................. 32
[Depot-Zone]................................................................................................................ 32
[DepotSatellites] .......................................................................................................... 33 [Depot2Depot] ............................................................................................................. 33 [eLogiX] ....................................................................................................................... 33
[Fields] ......................................................................................................................... 34 [Import32] .................................................................................................................... 34
FrequencyFormat ..................................................................................................... 37 Pre/post import ......................................................................................................... 38
[LXC] ........................................................................................................................... 39 [LXProfile] ................................................................................................................... 39
[Maps] .......................................................................................................................... 39 [NoGoProducts] ........................................................................................................... 39 [PlanGrid] .................................................................................................................... 39
[PlanGridWidths] ......................................................................................................... 39 [Reports] ...................................................................................................................... 40
[RouteList] ................................................................................................................... 40 [RouteReport] .............................................................................................................. 40
[Routes] ........................................................................................................................ 41
[RouteListWidths]........................................................................................................ 41
[Row totals] .................................................................................................................. 41 [SelectedRouteList]...................................................................................................... 41 [SelectedRouteListWidths] .......................................................................................... 41 [Site] ............................................................................................................................. 41 [Tables] ........................................................................................................................ 42
[Tabs] ........................................................................................................................... 42 [Tankers] ...................................................................................................................... 42 [TaskListWidths] ......................................................................................................... 42 [TaskList] ..................................................................................................................... 43 [TomTomConfig] ......................................................................................................... 43
[XLocateConfig] .......................................................................................................... 46
[VehicleOvernight] ...................................................................................................... 48
UserOut CSV ............................................................................................................... 48
PL.ini Settings v4.7
[CSVSummary]........................................................................................................ 49 [CSVTrip] ................................................................................................................ 49 [CSVSchedule] ........................................................................................................ 49
Long Name format string ............................................................................................. 49 Fixed Text Output ........................................................................................................ 49
Formatting ................................................................................................................ 50 Start time .............................................................................................................. 50 Start dates ............................................................................................................. 50
Function dependencies ................................................................................................. 51 Chaining ................................................................................................................... 51
Acceptable warnings created by auto .......................................................................... 51 Waiting time warning .............................................................................................. 51
Parameter dependencies ............................................................................................... 52 Parameter relationships ................................................................................................ 52 Parameter incompatibility ............................................................................................ 53
Document : PLINI settings 48.doc Page 1 Dated : 16/03/2020
Revision Control
Revision Date By Details
1.0 12/10/04 Nick Cobbett Initial version
1.3 9/11/04 Nick Cobbett Updated definition for
Substitution
Added PreserveTimes
1.4 05/01/05 Nick Cobbett Updated with new settings
1.5 11/11/05 Nick Cobbett Addition of tidal flow
1.6 23/02/06 Nick Cobbett Added UseRecordOrder
1.7 6/04/06 Nick Cobbett Added Auto32 section
Display defaults.
Added detail to Import32
section
Added GroupFrequency
1.8 23/03/07 Nick Cobbett Added PositionAsFB trailer
control,
Added UseTankFiles
ResourceReportLevel
ForceCompleteOrders,
makes WLIError importable
Functional definition for
chaining
Extended deviation settings
Parameters added for import
triggered local matrix
building
1.9 20/07/07 Nick Cobbett Addition of HTML itinerary
section [RouteReport]
LongNameFormat
2.0 29/05/08 Nick Cobbett Added Territory
Column widths
BookPeriods
ALMapQDetail
ReOrderInterval
2.1 02/09/08 Nick Cobbett Additional information
regarding, ShelfLife
2.2 22/12/08 Nick Cobbett
2.3 15/01/10 Gary Sharpe Added Recursion Limit,
ObeyLiFo and SiteWeighting
Added fixed text output
facility to Userout content
Amended ExclusiveZones to
reflect new values
2.4 09/02/11 Mohammad Arif WaitingTimeMode
FixedRouteStart
AllCSVFiles
2.5 06/09/13 Mohammad Arif RunType 32 and 33 added
Document : PLINI settings 48.doc Page 2 Dated : 16/03/2020
Revision Date By Details
DeviationScoring added as a
replacement for
DeviationScore
OptimiseLevel rule change
TrampingSwop added
Optimise 2 modes defined
IncludeWaiting added
UserCSVDistanceFormat
added
FixedShiftStartTimes added
EndDepot = DepotName
added
AutoDescription added
SynchronisedOrders added
ServiceMode added
UnionLimit renamed to
ServiceLimit
BreakGroups added
2.6 29/10/13 Mohammad Arif SynchronisedOrders
incompatible with Extend
opening
2.7 16/04/2014 Mohammad Arif LowUtilisationMode added
2.8 27/05/2014 Mohammad Arif ProductLoadingMode added
2.9 14/10/2014 Mohammad Arif BalanceMode, Balance,
Loop and Moves added
YFile
[Maps]
GBE=UKT
3.0 14/11/14 Mohammad Arif MatrixNodeType updated
MatrixBuildOption updated
3.1 18/11/14 Mohammad Arif [TomTomConfig] section
added
GroupFrequency = 2 added
PerformanceScale added
TourOptimiser added
AutomaticRouteOptimisation
added
ProductLoadThrough added
Loop added
GlobalLMSMatQ added
CurrencyHTML added
TestFlag added
TestModeFlags added
DeviationTolerance added
Textn added
Balancemode added
Balance added
LocationMethod added
NoDepots added
Document : PLINI settings 48.doc Page 3 Dated : 16/03/2020
Revision Date By Details
RetainDepots added
ReportFileName added
ReportType added
DetailLevel added
DepotPrefix added
RunAutoOnExit added
ReadCollectionFields added
[LXC] added
TomTomGeoOn added
ProcessMode added
Language added
ImportCMD added
MatrixRestrictionFile added
RestrictionsFileType added
3.2 27/03/15 Mohammad Arif UseZoneSequence added
3.3 15/06/15 Mohammad Arif FrequencyFormat added
TimeRounding added
KmsRounding definition
added
3.4 05/11/15 Mohammad Arif ForceTomTom added
3.5 23/11/15 Mohammad Arif ImportMode options added
to
GroupFrequency
incompatibility added
YFile changed to YDatabase
3.6 17/12/15 Mohammad Arif ChainByDepotGroup default
changed
ChainByVehicle default
changed
ChainByPriority default
changed
Accessiblepointsonly added
to [Import32]
3.7 07/04/16 Mohammad Arif PairSpanning definition
added
DynamicTramping greyed
out
3.8 27/06/16 Mohammad Arif ConverseInsertion default
changed from No to Yes
3.9 25/07/16 Mohammad Arif BreakMode setting added
4.0 29/09/16 Mohammad Arif EndAtDepotMode added
AddToExistingMode added
4.1 22/11/16 Mohammad Arif OptimiseExisting added
TextFileAsList added
ReCalculateOutputData
added
4.2 16/03/17 Mohammad Arif TrampCostingMode added
StartAtDepot
Document : PLINI settings 48.doc Page 4 Dated : 16/03/2020
Revision Date By Details
StartAtDepotMode
4.3 30/11/17 Mo [XLocateConfig] section
added
4.4 16/04/18 Mo CherryPick setting added
4.5 10/09/18 Mo FirstDayStartCheck added
4.6 04/10/18 Mo Extra MatrixBuildModes
added for xDima calls
4.7 02/10/19 Mo TimeBasedAvailability
added
FreqConsolidation added
ChainByFrequency added
SameDayPatternsOnly added
OldClusterSequence added
4.8 02/12/19 Mo TripReductionCosting added
ChainByFrequency modified
BreakChains modified
MaxLunchWindow added
Document : PLINI settings 48.doc Page 5 Dated : 16/03/2020
Introduction
This document explains the underlying Plan LogiX settings held within the PL.INI
file.
Conventions
Defining the goal or identifying the reason why an action or activity should take places.
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
Document : PLINI settings 48.doc Page 6 Dated : 16/03/2020
[Plan-LogiX]
General Setting Default Options Usage
AllCSVFiles No Y/N A series of new ini file directives have been added
to allow all Auto to optionally output LogiXIE
style csv files. LogiXIE forces this value to be
true. This setting will produce all the CSV files
AutomaticRouteOptimisat
ion
No Y/N Everytime an order is added or removed from a
route, it’s automatically optimised
ScheduleCSV No Y/N This will produce a Schedule.csv file
SummaryCSV No Y/N This will produce a Summary.csv file
TripCSV No Y/N This will produce a Trip.csv file
TaskCSV No Y/N This will produce a Task.csv file
TaskSizeCSV No Y/N This will produce a TaskSize.csv file
AutoDescription 0 0/1 Sets the description to the Address line 2 of the
largest order on the route
BookTolerance 5 Booked calls can be very restrictive since Auto
insists on service within 5 minutes after the stated
time. This value is now under user control. The
default is 5 minutes but any other number
including 0 is allowable.
BreaksInDriving No Breaks will not normally be taken within driving
legs, unless the driving leg itself is to long as
determined in parameters. If ‘yes’, then driving
legs may be interrupted.
BreaksInWork No Breaks will not normally interrupt the unloading of
the vehicle. If yes, then work may be interrupted.
Breaks in work No means that auto will not
interrupt the work with a break. If however, the
work is greater than the continuous duty, then we
have a conflicting requirement as you simply can’t
do 6 hours work without taking a break if the
continuous duty is 5 hours. The legal requirement
of taking a break takes precedence over the
operational preference. If the work is exactly the
same length as the duty, then there is a way of
complying with both; arrive at the call and take a
break, start (ie get onto the dock) and complete the
work, leave (ie get off the dock) and immediately
take a break. This is what Auto will therefore do. If
the work exceeds the duty by any amount, then the
work has to be split anyway, so Auto will arrive,
start work, take a break, complete the work and
depart. If work is one minute less with
BreaksInWork=No it will not be split but will it
split if BreaksInWork=Yes will it then split. BreakMode 0 Previous behaviour which allows 15+15+15 or
30+15 break to be taken where the minimum of a
45 min break is 15 minutes.
1 If a minimum break is specified, the legal
requirement is that only one such break may be
taken e.g. a 45-minute break with a 15-minute
minimum must be 15 + 30. After the minimum is
taken the remaining break, all must be taken.
CherryPick 0 Off
1 A single new routine, known as CherryPick, is
Document : PLINI settings 48.doc Page 7 Dated : 16/03/2020
used to convert the routes to reflect these values by
setting all journeys with non-own fleet vehicles to
be initially frozen, and setting the EndAtDepot
correctly.
2 vehicle attributes MUST be created and these
MUST be
Attribute 1 indicates Own Fleet Vehicle
Attribute 2 indicates No End At Depot
The routine then performs 2 prescheduling passes.
The first defines those orders which ought to be
served by own fleet vehicles, and the second then
schedules only these orders.
Finally, it marks these scheduled orders as
requiring an own fleet and marked as frozen. The
Contractor journeys are then released and control
returned to the standard scheduling procedure.
This behaviour ONLY applies to a ReSchedule run
type 1, IF the INI file directive CherryPick=1
exists within the PlanLogix section of PL.INI
CollectionsAfterDeliveries No If set to ‘Yes’ then all collections will be taken
after, deliveries have completed.
Constraint Index 0 This entry sets the password that controls access to
parameter maintenance. It is created by LogiX
parameters itself and should not be changed
manually
CurrencyHTML HTML entity, default if empty is the currency
symbol for the current lingo (i.e. £, which would
be £). Set in Parameters > General.
Database GBX Geographical database to use. Once data has been
set up THIS MUST NOT BE CHANGED
DynamicTramping 0 DynamicTramping allows calls specified as having
a preferred depot, to be split into a tramped pair,
scheduled and re-presented back as a preferred
depot call. There is much copying of master files
in order of achieve the result. Unknown how this
works with 'continue' type scheduling and/or re-
evaluation or optimising from within Plan. What
would happen if scheduling were interrupted etc.
1 Only the unallocated orders are converted to
tramped pairs and tried as split pairs.
2 2 is the standard method. Orders with a status in
excess of 2 (i.e. frozen which for some customers
means pre-allocated) will be converted and
rescheduled. That is the DynamicDepot pass is
used only to determine the location of the
collection.
EarlyBookTolerance 5 Booked calls can be very restrictive since Auto
insists on service within 5 minutes before the
stated time. This value is now under user control.
The default is 5 minutes but any other number
including 0 is allowable.
EndAtDepot Yes The journey will return to the base depot. If set to
'No' the journey will terminate at the last call.
EndDepot Depot
name
Name of depot where all routes must end, this is
the new fixed end depot
Extend Opening No Work must be completed within specified times.
If set 'Yes', then only the arrival need comply; i.e.
Document : PLINI settings 48.doc Page 8 Dated : 16/03/2020
the opening time
Exit 0 (default value) feature disabled
1 The user is prompted for exit if no insertion has
been made in the last 2 mins
2 The program automatically exists if no insertion
has been made in the last 2 mins
-1 Exits following the first route building operation
has tried all orders
-2 Exits before journey swapping only for fixed
routes, will not exit if running in other modes
-3 Exits following the first Optimisation but before
depot overrides
-4 Exits just before substitution checks
-5 Exits following substitution checks
-6 Exits following combination of trips
N Where exits following n minutes since the last
insertion of an order.
FirstDayStartCheck N
Y When you have a 00:00 – 00:00 shift and an
unlimited fleet, routes that span multiple shifts
could lead to longer than needed off duty times, in
this case another pass will be made to see if we
can move the start time later in the first day only.
FreqConsolidation 0 No consolidation of like frequencies at the same
call
1 Ensure that all visits are scheduled using the same
vehicle. Only works in GroupFrequency=2 mode.
2 Ensure that all visits are scheduled using the same
shift. Only works in GroupFrequency=2 mode.
3 Ensure that all visits are scheduled using the same
vehicle and shift. Only works in
GroupFrequency=2 mode.
IgnoreWindow 0 LogiX may be instructed to ignore all opening
windows corresponding to the given number as
defined above
JourneyMode Awaiting definition
Load Rounding 1
Load Rounding 2
0 These entries specify the way in which the total
size of each order is calculated. The exact order
size is built using the number of items of each
product type multiplied by the size of the product
type. The result is then rounded to the number of
decimal places specified in the parameters. By
default, standard rounding is used (.4 rounded
down, 5 rounded up), but the rounding can also be
forced up or down as required.
0 Standard rounding
+1 Round up
-1 Round down
LowUtilisation
0 Percentage fill at which a route is seen as being
under used, for the purposes of “Empty running”
LowUtilisationMode 2 LowUtilisationMode is a Bit pattern that allows
you to define how low/empty running is
calculated. By adding the following values
together you can control the calculation
1 Adding the value 1 changes the mode such that if
any unit is low utilisation if any of the three load
units is low
2 Primary unit
4 Secondary unit
Document : PLINI settings 48.doc Page 9 Dated : 16/03/2020
8 Tertiary unit
MainProduct Controls which icons are displayed when tagging
from the map. If Main product is No, then the
“normal” icon is displayed. If set to Yes, then the
“Alloc” icon is used where applicable
Displays the product type with the largest value
i.e. 10Kgs would be used as the product type over
5 Pallets
Max Call Points 1500 (up to 99) maximum Call Points
Max Depots 20 (up to 99) maximum Depots
MaxLunchWindow 7200 Added new feature PL.INI setting. This replaces
constant MAXLUNCH=7200 in ETA2
'WhichSlot()', so it can be set to zero to prevent
work being split across two time windows.
MaxLunchWindow=0 (Default = 7200)
Previously, if the first time window of two
windows was shorter than the work to do, it would
split the work across the two windows. This
ignored the setting 'BreaksInWork', because it was
not deemed to be splitting the work, as the work
could not be done in the time window provided.
This was not controllable, and a request from
Sweden to allow this feature to be disabled led to
making this customisable. Essentially, setting this
to zero will disable splitting the work across the
lunch break (two time windows).
Max Orders 1500 maximum Orders
Max Products 10 (up to 25) maximum Product Types
Max Route Size 99 maximum Orders per Route
Max Routes 1024 maximum Routes
Max Shifts 10 (up to 99) maximum Shift Types
Max Vehicles 10 (up to 99) maximum Vehicle Types
Max Wait 300 Maximum duration of an individual period of
waiting time. A warning will be posted if this
limit is exceeded.
When both depot opening times and task opening times are used, it is possible for auto to build routes with warnings, i.e. in must be possible to insert a priority 1 job forming a new route, regardless of the waiting time.
Menu Background Awaiting definition
Menu Background
ObeyBookings Yes If set to ‘NO’ it enables all book times on orders to
be ignored upon scheduling.
ObeyBookDays Yes Switches on/off book days
ObeyBookTimes Yes Switches on/off book times
ObeyDayBans Yes If set to ‘NO’ it enables all day bans set on orders
to be ignored upon scheduling.
Document : PLINI settings 48.doc Page 10 Dated : 16/03/2020
ObeyLiFo No Yes/No Applies Last In First Out logic to route sequence.
Only functions when tramping and applies to all
routes, also see ProductLoadThrough
ObeyWindows Yes If set to ‘NO’ it enables open and close windows
on orders to be ignored. This will also correspond
with IgnoreWindows and SoftWindows being
ignored.
Optimise 2 r-optimal level used by Auto-LogiX to finally re-
sequence routes.
0 no additional optimisation
1 Order strings of contiguous calls will be tried in all
positions on the route which do not beak other
such strings. Order strings of lengths upto a maximum of OptimiseLevel will
be tried, both forward and reversed in the current position
only. The entire trip will also be considered reversed.
Individual calls will also be tried in all positions.
2 Order strings of lengths up to the maximum of
OptimiseLevel, will be tried reversed in the current
position only. Order strings of ALL lengths will be tried, both forward and
reversed in the current position only. Strings of only one unique position will be tried in all positions. Individual calls
will also be tried in all position.
3 Will attempt to re-locate all order strings up to a
maximum of OptimiseLevel, both forward (ie
current sequence) and reversed. in all positions.
Will attempt to re-locate all ordrer strings upto a maximum of
OptimiseLevel, both forward (ie current sequence) and
reversed. Strings longer than OptimiseLevel, upto and including the whole trip, will be tried reversed in the current
position only. Strings of only one unique position will be tried
in all positions. Individual calls will also be tried.
As per Optimise 2 but works with 2 chains, where chain 1 and 2
are tried in all 6 combinations in relationship to each other both forwards and reversed.
Chain 1 and 2 do not have to be next to each other in the route.
OptimiseLevel 5 Minimum 2
Not applicable to optimise 1 or 2.
When set to 3, the default is 5.
If set to 0 each block from 1 to the route length is
considered.
Number of contiguous blocks considered when
optimising. A contiguous block is defined as a
series of tasks with no gaps, or driving time
between them.
OptimiseLimit 15 During optimisation, the program will not consider
any change, which increases the driving time by
more than this limit, even though it is possible that
waiting time will be decreased. In normal
practice, this is unlikely and serves only to cause
the program to evaluate many unnecessary
changes.
OptimTDC 1 1,2,3Optimisation on Time/ Distance/ Cost,
switched on by an INI file setting.
1 Time
2 Distance
3 Cost
Order Key Awaiting definition
OutputFile It has been made more flexible such that each
Document : PLINI settings 48.doc Page 11 Dated : 16/03/2020
section (Summary,Trip,Schedule) may be written
to a separate file. Within each section there is a
new ini key OutputFile = Filename
Output_Jasper Awaiting definition
Paid Breaks Yes Specifies whether drivers' rest breaks and waiting
times are regarded as paid work. This will have an
effect on costs displayed in the Route Evaluation
screen
PairSpanning No Yes/No PairSpan could insert a call and consequently
change a depot, if the other half did not get
allocated, then removing the odd half did not
restore the route to its previous state. This could
cause an infinite loop. In order to fix certain
limitations have been included.
PairSpanning cannot cause a JnySwop, and we can
therefore copy the route sequence and restore it,
rather than zapping the order.
PerformanceScale 4 0 Custom Scale
• Cluster Mode: What the user last saved
• Substitution: What the user last saved
• Optimise: What the user last saved
• Recursion Limit: What the user last saved
1 Basic Scale
• Cluster Mode: Call Point
• Substitution: 0
• Optimise: 0
• Recursion Limit: 1
2 Scale 2
• Cluster Mode: Map Reference
• Substitution: 1
• Optimise: 1
• Recursion Limit: 3
3 Scale 3
• Cluster Mode: Radius
• Substitution: 2
• Optimise: 2
• Recursion Limit: 6
4 Default Scale
• Cluster Mode: Radius
• Substitution: 3
• Optimise: 2
• Recursion Limit: 6
5 Optimal Scale
• Cluster Mode: Radius
• Substitution: 3
• Optimise: 3
• Recursion Limit: 9
Point Key Awaiting definition
PreBreakLimit 50 If a vehicle has to wait for a call to open, it will
consider using this time as a break, rather than
attempting a later start, if it has exceeded this
limit. The limit is specified as a percentage of the
maximum period. The default is 50%.
PreserveTimes Yes When extending a route auto is not allowed to
move the arrival or departure times of any order on
the route. If set to No the arrival and departure
times can be adjusted, within the available time
window, the route sequence remains unchanged,
Document : PLINI settings 48.doc Page 12 Dated : 16/03/2020
and no orders can be added into rest breaks or
waiting time.
PreserveVehicles No Enables routes carries forward to retain the
original vehicle and shift.
ProductLoadingMode 0 Off
1 Compartments mode i.e. Chilled, Frozen and
Ambient
2 Configuration mode, measures against the
products
3 Configuration mode i.e. SMS
Re-allocate Yes Controls whether orders already allocated to a
route may be selected for inclusion in another
route
ReCalculateOutputData N Y/N It’s been the case that many of the CSV files were
created essentially by re-formatting the data
directly from the dbf records. In order to reduce
the latency as above, where possible the values
may be re-calculated rather than looked up.
ResourceReportLevel 1 Controls the vehicle data output by the reports.
When set to level 1, Vehicle types are output
2 Trailer type is output, if blank, Vehicle type
3 Vehicle asset is output, if blank, Vehicle type
4 Trailer asset is output, if blank, Trailer type.
If the trailer type is blank, the Vehicle Asset is
used
If the Vehicle asset is blank, Vehicle type is used
5 Driver name is output, if blank vehicle type
RetainAllocations Enable Site to retain imposed PrefDep settings.
RLPeakTimes Awaiting definition
Route Screen Awaiting definition
Show_CP Callpoint display toggle
Show_MCP Master callpoint display toggle
SoftWindow 0 If a call has both opening windows set, it will be
first attempted with the 'soft' window closed.
When the schedule is complete, if un-allocated
orders remain, the soft window will be opened and
the schedule continued.
1 Morning window only
2 Afternoon window only
3 The lunch break can also be forced open
StartAtDepot Y N Similar to End At Depot
StartAtDepotMode 0 If StartAtDepot = No, then the route will never
start at the depot
1 Start at the depot if there are deliveries on the first
trip.
SynchronisedOrders N Y/N This allows order to be served at the same time by
2 (or 3) different vehicles. The orders are specified
as positional list of Order numbers in CustInfo4.
The main order no. must start in position 1
The front synchronisided order must start in
position 14
The back synchronisided order must start in
position 27
All 3 will have the identical CustInfo4 's
TextFileAsList N Y/N All text output files may now be written directly as
has been standard practice hither to, or written to a
list and committed to disk in a single operation.
This considerably reduces disk latency on
networked systems. This can also be set in
Document : PLINI settings 48.doc Page 13 Dated : 16/03/2020
logix.ini which makes it system based.
Textn A facility to include fixed text fields in
UserOut.Csv
ThirdLoadUnit False Switches third load unit capability on/off in Plan
LogiX
TimeRounding -1
0
1
Round down to the nearest whole minute
Round to the nearest whole minute
Round up the nearest whole minute
TimeZones No Allows the use of defined settings for the Peak
Period times. Otherwise vehicle speeds will be
taken as constant throughout the day. The speed
variations and the peak periods are set in
parameters.
StreetLevel No Optional module. If purchased enables/disables
street level itinerary
TidalFlow No Works with centres to define a tidal slow down
within Auto
TimedMatrix Awaiting definition
TrafficSheet No Enables output to TrafficSheet application
TrampCostingMode Attempt to handle Tramped pairs which have
many calls from some locations poeple (in this
case Prisoners) on a Grand Tour when they could
have been dropped off much earlier. Much of this
is down to Tidal Flow/ Time of Day speed
variation, so it can be advantageous to push work
out of peak times. In order to take some account of
this, new costings have been introduced.
Traditionally a TrampedCost was used as a tie
breaker between insertions of equal Scheduling
Cost. This took account of the quantties (in the
above case number of people) and the the time
they were on board. This is dimensionally
inconsistent with the Scheduling. Thus a new
measure is needed. This is based solely on time -
and ought to be enhanced to cater for TDC
optimisation - and uses a further %age factor to
influence its importance with the SchedulingCost.
0 Used only as the tie breake and is always applied
1 The time on board used in scheduling
TrampCostingFactor 0 A percentage weighting for use in the scheduling
cost
TourOptimiser 0 TourOptimiser off
1 Ignore the start depot
2 Ignore the end depot
3 Ignore start and end depot
TrailerSwapping No ‘Yes’ to enable the changing of trailers, at a depot
call on a route
Tramping No 'Yes' to enable Tramping. In Plan-LogiX, it is
assumed that collections are onward delivered in
terms of vehicle loading. Tramping module must
be purchased for this option to work
UseMapIconLayers No Switches on the advanced icon drawing
functionality
UsePlanningDates No
Yes The interface in Plan will change to the date picker
for orders and scheduling. NOTE:
UsePlanningDates and BookPeriods work
differently in LXC and RO-Cloud
Document : PLINI settings 48.doc Page 14 Dated : 16/03/2020
VehicleOvernight No Vehicles are not able to be used on overnight
routes, however when set to “yes” The vehicles
can be used to run 2 or more day routes where an
overnight off duty period is allowed.
WorkTimePlaces 0 Governs the accuracy to which LogiX calculates
work time
0 1 minute
1 1/10 of a minute (6 seconds)
2 1/100 of a minute (0.6 of a second)
WorkTimeRounding 0 Used in conjunction with WorkTimePlaces.
-1 Round Down
0 Standard rounding (Nearest)
1 Round up
YDatabase YDatabase= over-rules x2ymap.ini i.e.
YDatabase=UKT would over-rule X2YMap of
GBE=UKA
ClusterMode as far as Auto is concerned is always read from PlanLogix but if you put the
performance scale to custom (PerformanceScale=0) the ClusterMode in RO-OP (RO-
Cloud not allowed to have this concept) is read from [Auto32] and saved to both [Plan-
Logix] and [Auto32] sections.
Auto only
Although these settings are part of the [Plan-Logix] section, they predominantly effect
the way the routes are formed.
Setting Default Options Usage
Access Factor 0 Auto-LogiX weighting of restricted-access calls.
This increases a call's priority in line with the
difficulty of access. The Access Factor does not
use any time windows, only vehicle/resource
restrictions.
A factor applied to VehScore
Where VehScore = (1.0 – (% of ‘Available’
Resources able to access call) )²
Note: This is the ‘squared’ value of available
resources to make less available resources have
more impact.
AddToExistingMode 0 AddToExisting historically would preserve the
original calls on a route in the same relative
sequence to each other.
1 Allows the original orders on the route to change
their relative sequence (default)
AllRouteSequence No Sequence numbers normally apply only within a
trip. This setting forces sequence number to be
honoured across the whole route.
ALMapQDetail 0 Build standard ALMapQ
1 No wiggle factor. Orders are scheduled based on
the closest matrix nodes location. Depots are
calculated using a wiggle factor.
This mode has been introduced to cater for
profiles with larger numbers of unique locations.
The maximum size for an ALMapQ is 4GB,
however the limit is set at 16,394 rows.
AutoControl 1 Governs how the available resources are
controlled.
Document : PLINI settings 48.doc Page 15 Dated : 16/03/2020
Setting Default Options Usage
1 Run.Log mode (standard Plan LogiX)
2 LogiXIE mode
3 Asset mode
Auto Shift No If set to 'Yes' vehicles will use the corresponding
shift category. Otherwise all routes will use the
first shift category
AutoShift No Used to relate Shifts to vehicle definitions. i.e.
Shiff1 goes with VehicleType, Shift2 goes with
VehicleType2 etc
BookPeriods 0 If set to 0, Book day fields are dominant. If
greater than 0, Day of Plan (DOP) fields are
dominant.
BreakChains No 0 Modified 'BreakChains' PL.INI setting to be a
numeric value instead of Boolean. It will still
operate as before with the Boolean settings, but
can also now use a new 'BreakChains=2' value.
This new value will mean that it is allowed to
break chains, but only if the Frequency Patterns
don't match. Otherwise, no chains can be broken.
Normally a chain will either be allocated in its
entirety or else wholly unallocated.
1 By setting this to ‘Yes/1’, the chain will be
initially attempted as an entity, but if this proves
infeasible it will be split into its components and
re-tried
2 Only mixed frequency chains can be unbroken
BreakGroups Y Y/N Groups are now tried on many more routes and,
if they cannot be allocated on a single route, then
none of them are allocated.
This may well involve many more attempts and
therefore could be much longer in run time.
The default remains that Groups may be broken.
ChainByDepotGroup Y By default orders in a chain must all have the
same depot group
ChainByFrequency 0 0 Do not chain orders with frequency > 1.
This enable you to Chain orders in
GroupFrequency=2 mode, which didn't work
before. The orders Must have the same
Frequency to be able to be in a Chain. This can
then be used with BreakChains=NO to force
same place and/or customer or dont schedule at
all.
1 Include same frequency orders in chains
2 Include mixed frequency orders in chains - e.g.
Frequency 1, 2, 3 etc. will be included with
higher frequencies 6, 9, 12, etc
ChainByVehicle Y By default orders in a chain must all have the
vehicle restrictions
ChainByPriority Y By default orders in a chain must all have the
same priority
N All priorities can be mixed together in the chain
and remain the same. Since the standard
scheduling sequence will still be followed, and
the first priority orders scheduled first, if one of
these priority orders is in a chain, then it will
Document : PLINI settings 48.doc Page 16 Dated : 16/03/2020
Setting Default Options Usage
schedule the whole chain together regardless of
the other priorities in the chain.
ChainCapacity1 0 Where n is the max size in terms of loading
factor 1
ChainCapacity2 0 Where n is the maximum size in terms of loading
factor 2
ChainCapacity3 0 Where n is the maximum size in terms of loading
factor 3
ChainsReport No Broken Chain report controlled by and INI file
setting. For this to be meaningful DoChains and
BreakChains must both be enabled. A file
Chains.Rep is produced; this is mainly a
debugging aid.
Cluster Control n Clustering is automatically disabled if the
scheduling performance falls below a given
number (default 0). It is re-activated once
performance reaches the desired level, where n is
the desired threshold. Typically 10-20
Cluster Mode 2 Auto-LogiX clustering
-1 Switched off
0 by call point
1 by map reference
2 by centroid (default 20km)
Cluster Radius 20 Radius, in km, used by Cluster Mode 2
Cluster Report Yes An extra report showing split clusters in the
Cluster.REP report file
Consolidation 0 Controls when two orders are counted as being
for the same Call Point. The rule is:
0 must have same Grid Reference (GR)
1 must have same GR and Template (Call Point)
number
2 must have same GR and Customer Name
3 must have same GR, Template and Name
ConverseInsertion Yes Yes/No Effects the way that the deviation rule is applied.
In ConverseInsertion, if an insertion is rejected
based on adding the order to the existing route, it
might be valid if the “new” order is put on the
route first. For example if there is an order
added to a route, that is close to the depot,
deviation rules may prevent the route from being
extended, however if the order that is close to the
depot is added afterwards the deviation might be
within the deviation
DepotCosts Yes Indicates that the effective transport costs of
differing depots is to be taken into account by
Auto when determining its initial Depot
allocation
DepotUtilisation 100 Used control how depot patches are built.
In multi-depot mode auto assess the amount of
work that a depot can do by using the depot
throughput. If depot throughput is not set, then
70% of the total vehicle capacity for the depot is
used. The Depot Utilisation percentage, is then
applied.
DepotSwapFactor 0 0-200% If running in Territory mode, used to control
orders considered for swapping when choosing
the parent depot for an order.
If an order is not allocated to the “best” depot in
initial data load, it can be considered for
Document : PLINI settings 48.doc Page 17 Dated : 16/03/2020
Setting Default Options Usage
swapping with all other orders to find a better
depot. However, with the percentage set, the
order will only be swapped with orders that are
within a square of, 2*the percentage of Territory,
centred on the order.
See Territory and ZoneByParentDepot
The “Parent depot” is only used in
initial route building
DepotZones No If set to ‘Yes’ it automatically sets the Depot
equal to the zone.
If, the zone is not found in the DepotZone
section, the zone number is looked up as a record
number in the file, i.e. zone 3 equals the third
record (not deleted) in the file.
0 Zone number is used to link to the depot number
1 Use the Depot-Zone list
Deviation 20 1-100 A percentage value
Auto-LogiX route deviation: the smaller the
number, the narrower the route envelope. Values
up to 100 are permitted
DeviationMaximum 2*
Deviation
Deviation –
100% A percentage value
If in adding the order to a route the deviation
exceeds the defined percentage the order is not
considered for insertion
DeviationScore 3 It is possible to control how hard it is for the
system to place an order on a route that is taken
outside the deviation limits.
1 Deviation turned off
4 New trip within expected will be done
6 Any possible new trip will be done first
9 Never exceed deviation limit
DeviationScoring 0 New Route prefered
1 Extending into an extra day is preferred
DeviationThreshold 2*
Deviation
Deviation –
Deviation
Maximum
A percentage value
The order will by preference start a new route,
however if a new route cannot be created the
order can be added to an existing route providing
the deviation is less than Deviation Maximum.
DeviationTolerance 7 The tolerance on Deviation was hitherto
hardcoded. It is now capable of being overriden
by an ini file setting DeviationTolerance = 7.0 to
set the value in minutes. If the line is not present,
then the old 7 minute default is applied.
Distance Factor 100 Auto-LogiX weighting of distance from depots.
A value of –100 may be used to change the
weighting of those closest to the depot to be the
most important. This a more flexible version of
the Reverse = Yes setting described above
DoChains No If set to ‘Yes’ chains of orders at the same map
reference will be allocated as a single entity. It is
similar to consolidated orders
See Functional dependencies
DoubleShift No Multi-shifting of vehicles
Document : PLINI settings 48.doc Page 18 Dated : 16/03/2020
Setting Default Options Usage
DynamicDepots No If set to ‘Yes’ the intermediate depots can be
determined by the program, i.e. the vehicle need
not turn round at the start or end depot. Multi-
Depots must be set to ‘Yes’ and the Dynamic
Depots option must be installed
EarliestRouteStart No Normally a route will start as late as possible on
day 1 if the 1st call is on day 2. By setting this to
‘Yes’, the route will start early on day 1
EndAtDepotMode 0 EndatDepot=no would be obeyed even if the last
trip had collections.
1 Will force a return if collections exist on the last
trip.
ExclusiveZones 0 0, 1, 2 0 = zone values ignored unless the pre-allocated
option is elected
1 = zones will not be mixed within trips
2 = zones will not be mixed within whole routes
(Before version 4.2.6.20 this setting was Yes /
No where Yes = new value 2 and No = new
value 0)
Execution Limit 0 It is possible to limit the execution time of a
workarea for debugging and with great care and
understanding in a live environment. The system
will stop what it is doing when the limit is
reached and create the output files as if it were
fully scheduled. This may leave the workarea in
an un-optimised state. n = the number of
minutes before breakout. If Execution Limit is
set to 0, then no restriction is applied.
ExpectedTrips 0 If set, allows the user to tell Auto how many trips
it should expect to build. This affects the way in
which the deviation rules are interpreted. Once
the Expected trips limit has been reached.
ExpertUser No Enables additional scheduling options. These
appear on the sub-menu displayed when the user
starts the Schedule routine
ExtendTrips Yes In Extend schedule mode, any extension of a
route takes place in the last trip. If set to ‘No’,
extension will start a new trip
FixedShiftStartTimes No Y/N Routes will start at the shift start time that is
attached to the vehicle
FixedShifts No Alternate shift usage mechanism
FixedRouteStart -1 hhmm
hh:mm
All routes will take this as the fixed start time (on
the start appropriate day) Second and subsequent
days of the route
GroupFrequency No/0 1 When enabled the group field within a task
record is used to link tasks together. Such that
for one order in a group to be added to the plan,
all orders for the group must be added. The,
orders could be for different days, locations
depots etc.
Expected usage is for frequency modelling where
the visit data is created in advance, i.e. three
visits in a week one on Monday, one on
Wednesday and one on Friday. Another usage
could be to model a process flow i.e. end of lease
cars, collect car and take to depot, store car, then
take to auction.
2 This uses Frequency from the import file to
Document : PLINI settings 48.doc Page 19 Dated : 16/03/2020
Setting Default Options Usage
construct an internal multi-phase Order for
scheduling based on the individual schedule
orders which exist in the Task file. Once
scheduling is completed, the files are updated to
use the original single phased orders.
In addition, the scheduling has been updated to
ensure that all phases will be served using the
same resource. The frequency patterns are now
written out to a csv file Patterns.Csv, which may
be manually edited to create or remove patterns
to the users own specification. The WorkingDays
entry in this file is not currently implemented.
Note: User imported groups will be ignored in
this mode.
KmsRounding -1
0
1
Round down to the nearest whole kilometre
Round to the nearest whole kilometre
Round up to the nearest whole kilometre
Load Factor 0 Auto-LogiX weighting of large loads. This
increases a call's priority in line with the ratio of
the load size to the largest suitable vehicle
Loading Bays No When not switched on any number of vehicles
can enter a call simultaneously however, If set to
“yes” The number of bays is defined by the first
digit of the CUSTINFO4 field of an order. This
can be imported (or edited from within LogiX)
and will limit the number of vehicles allowed
into a location at any one time when auto
scheduling.
Loading bays can also be used in conjunction
with Shadow times, for a full description please
see interfacing documentation.
LocalAccess Yes A setting which forces the matrix access to be
additive. The default is ‘No’, which treats access
as proportional
LongNameFormat The long name can be built from various fields
held at the Summary level. The format is
outlined later in this document
By default the long name is populated with the
standard LogiX short name.
MaxEtaLoop 128 Loop limiting factor when trying to calculate the
best start time or a route
Metered Flow Yes If set to ‘Yes’ it allows each vehicle
compartment to be filled with more than one
order of the same product type. If this option is
not turned on. LogiX assumes only one order can
fill each vehicle compartment.
Multi Depot No 'Yes' to enable Multi depots (Multi-Depot
module must be installed for this option to work)
MultipleRouteEvaluatio
n
Yes Re-Evaluate all routes, to check for conflicts
such as depot throughput
Night Penalty 20 Auto-LogiX weighting of overnight breaks. This
is used in costing the insertion and not in the
scheduling sequence
NightsInDriving Yes Can an overnight be taken during driving time
NightsInWork No Can an overnight be taken during work time
(Similar to breaks)
ObeySequence Yes If set to ‘No’ specified sequence will be ignored
Document : PLINI settings 48.doc Page 20 Dated : 16/03/2020
Setting Default Options Usage
ObeyVehicleBans Yes If set to ‘No’ preferred vehicle and access
restrictions will be ignored
OldClusterSequence Yes No Change the scheduling sequence so that orders
within the cluster are sorted in scheduling
sequence.
OptimiseExisting F
T A feature to allow optimisation of existing routes
prior to run types
• Add to Existing
• Continue
• New Routes only etc
PositionAsFB No Changes the usage of the position flag on an
order.
By default the position flag relates to the position
on a trip
With PositionAsFB=Yes position controls if the
order must be on the front unit or rear unit of a
truck and trailer.
PreferedGarage False No details available
PreserveShifts No If set to ‘Yes’ allows an existing route to keep its
shift length when being re-evaluated
ProductLoadThrough 0 There was/is the idea that in some
compartmentalised vehicle you can’t get to the
load in compartment 1 if the is any product in
compartment 2. However, this may too
restrictive if it’s only a small amount you can
work round it. For this there is another setting
with default as ProductLoadThrough = 0
Saying you can’t load through a compartment
with more than 0 load in it. There is a question as
to what units this should in. The code expects
this to be in Unit1, but the user may not always
see it that way.
ProductTypes No If set to ‘Yes’ it allows you to access a product
compatibility option within the product tab in
parameters. You can then specify which products
are incompatible on the same vehicle. This
subsequently writes out a section in the pl.ini
called [nogoproducts] Under which the
incompatible products will be specified.
Also controls Depot Stock, and
products per vehicle
RecursionLimit 6 Controls the maximum number of times
‘continue scheduling improvement’ is tried.
Continue scheduling will be tried until the set
number of re-tries OR until there is no
improvement.
ReOrderInterval 100 When a route's shift usage exceeds the give
percentage, a Re-order of the route is performed.
The default setting of 100% means that it is
never done. By changing the setting to, say, 25 a
route could be re-ordered 3 times during initial
route building.
The goal is to improve the sequence of routes
during initial route building, i.e. if orders have
tight time windows.
ReUseOnEmpty No Allows tanks to be reused without a return to
Document : PLINI settings 48.doc Page 21 Dated : 16/03/2020
Setting Default Options Usage
depot.
Reverse No If set to ‘Yes’ calls will be scheduled outwards
from the depot. Normal procedure is to schedule
inwards from the most outlying point
SameDayPatternsOnly No Yes When Auto creates a new patterns file, they will
always use the same week day. This might be
useful to prevent unwanted patterns spread over
the planning period.
For example:
Period,28
Frequency,3
Pattern=M,_,_,_,_,_,_,M,_,_,_,_,_,_,M,_,_,_,_,_,
_,_,_,_,_,_,_,_
Pattern=_,_,_,_,F,_,_,_,_,_,_,F,_,_,_,_,_,_,F,_,_,_
,_,_,_,_,_,_
Pattern=_,_,_,_,_,_,_,M,_,_,_,_,_,_,M,_,_,_,_,_,_
,M,_,_,_,_,_,_
Pattern=_,_,_,_,_,_,_,_,_,_,_,F,_,_,_,_,_,_,F,_,_,_
,_,_,_,F,_,_
Rather than:
Pattern=M,_,_,_,_,_,_,_,_,_,_,F,_,_,_,_,_,_,_,_,_,
_,_,W,_,_,_,_
ServiceMode 0 ServiceLimit ignored
1 ServiceLimit excludes first leg
2 ServiceLimit excludes last leg
3 ServiceLimit excludes first and last legs
SetAccess 0 -99 Forces Local Matrix accessing
SetRouteZones No Allows auto to allocate zones to particular
vehicle types. This is defined using a rec_type 3
record in the zone. The vehicle name should be
entered into the Zone name.
For this option to work, you must use a fixed
fleet.
When setting the data within the ZoneName in
the Zone.DBF, the first two characters are used
to indicate the “day”, the remaining characters
define the vehicle name.
ServiceLimit 540 This applies to all routes from whichever depot
in addition to the standard shift limit to force an
overnight break after this period of working. If
Return to depot is OFF, the ServiceLimit is
deemed to apply from the start of work at the
first call to the completion of work at the last i.e.
the return leg is excluded from both the shift and
service limits
ShelfAsHours No If set to ‘Yes’ the shelf life is taken to be a
maximum number of hours that the order can be
on the vehicle. The default is to be a maximum
number of shifts
See notes below
Document : PLINI settings 48.doc Page 22 Dated : 16/03/2020
Setting Default Options Usage
ShelfLifeMultiplier 60 If ShelfAsHours is Yes, then the user may
optionally specify a multiplier. In fact
ShelfLifeMultiplier which is actually the number
on mins which each ShelfLife unit represents. It
defaults to 60 so that previous behaviour is
unchanged. This granularity can now be a little
as 1 (i.e. shelf life is denoted in mins) but can be
as large as is required.
See notes below
Shutdown 32767 Used to tell Auto at what part of processing it
should stop. Only for Debug usage.
Based on the order score, it is the number of
orders attempted
Specifictanks No No details available.
Squeeze Yes The program will attempt to combine trips on to
a single route and remove the depot call if
possible. No prevents it removing the depot call
StandardEvaluation False Speed up setting for time evaluation. When
calculating the start time for a route, auto can
either work in “Day evaluation” mode, or
original mode. For some work areas
StandardEvaluation may be quicker, but might
not pick the best start time for the route.
Substitution 3 The numeric setting replaced the Boolean option.
0 Off – No substitution
1 Less aggressive - consider moving calls which
are at least 16 mins from predecessor/successor
2 More aggressive - consider moving calls which
are at least 4 mins from predecessor/successor
3 Fully on - consider moving calls which are at
least 1 mins from predecessor/successor
SubstitutionCosting 0 No details available
Tankers No If set to ‘Yes’ the user can specify up to 16
compartments or tanks within the vehicle. When
calculating vehicle usage LogiX takes this into
account by considering each compartment can
only hold a single product The Tankers option
must be installed for this function to run.
Territory Off Defines the maximum distance that an order can
be from the serving to be considered for insertion
onto a route. Values are in kilometres to 1
decimal place i.e. Territory = 99.3.
If territory is not set, any order will be
considered for insertion on to any route.
TestFlag 1 No longer used
2 Turns ConverseInsertion ON to match v 5.11t
4 Turns Local Isolation OFF to macth v 5.11t
8 The idea is to look ahead to pick the best order to
insert, rather than just the best insertion for the
next order. This has been coded such that by
setting TestFlags = 8 in Pl.ini, the new method is
used, otherwise previous behaviour is
maintained.
TestModeFlags 1 Turns Cluster Scoring ON
2 Turns Converse Insertion OFF
3 Turns Cluster Scoring ON AND turns Converse
Insertion OFF
TimeBasedAvailability No Yes This disables day based method, with a new
PL.INI setting: 'TimeBasedAvailability=YES' In
Document : PLINI settings 48.doc Page 23 Dated : 16/03/2020
Setting Default Options Usage
'Fixed-Fleet' mode, this allows routes to span
midnight, but also allow the vehicles and drivers
to still be available after the next 'Off-Duty'
period. Previously, the resource was marked as
unavailable for both days over midnight.
Also, and just as importantly, enables 'unlimited
24h shift' to have more shifts than days.
Previously, Avail[] array only allowed routes to
operate between StartDoP and EndDoP, but these
were physical days, not shifts. So 7 shifts
operating over a 5 day period would fail. This
new time-based method will enable 7 shifts to be
used even if a 5 day period is set.
Time Factor 50 Auto-LogiX weighting of delivery windows. A
calls load and/or unload time within the
open/close windows, book time, ban days or
order date range is uplifted in scheduling priority
by this factor.
A factor applied to WinScore
Where WinScore = ((% of work to time window)
+ ((DefaultShiftEndTime - Open2) /
DefaultShiftEndTime) ) x (1.5 -
OrderUnbannedDays / OrderPlanningDays)
Notes:
- If BookTime exists, then % of work to time
window is 1.0
- If Work >= Window, then % of work to time
window is 1.0
- DefaultShiftEndTime is the finish time for the
first shift record (I guess this is the default shift)
- OrderUnbannedDays is the number of days that
are not banned, where half days are 0.5
- OrderPlanningDays is the number of days the
order is plannable (e.g. LastDoP – FirstDoP for
this order)
TrailerField 5 Defines which CustInfo field is loaded with
trailer swapping details
TrampingSwop Y Y/N This allows tramped pairs which start a new
route to consider combining with existing routes,
but on a different resource
Document : PLINI settings 48.doc Page 24 Dated : 16/03/2020
Setting Default Options Usage
Trip Reduction Yes The scheduler will attempt to combine any short
routes together to form a smaller number of
routes, but with potentially the same number of
trips. If Squeeze is on (the default) these multi-
trip routes may be further improved by removing
the additional depots calls and re-sequencing
where possible
TripReductionCosting 1 Added a new setting in PL.INI to allow some
possible alternate methods when combining trips.
TripReductionCosting=1 (Default=1)
Note: It only works in 'FirstDayStartCheck=YES'
mode. It is like optimisation and
substitution costing setting in that it can be based
on Time, Scheduling-Cost (DEFAULT) or
Distance
0 Time - Only allow multi-day trips to combine if
new overall time is less.
1 Scheduled Route Cost - Only allow multi-day
trips to combine if new overall cost is less
2 Distance - Only allow multi-day trips to combine
if new overall distance is less
Turn Depot <Depot
1>
Special entry FOR BRAMBLES VERSION
ONLY. Name of depot at which vehicles turn
around
UnAttendedWorking NO Allows breaks to be taken within time at
premises. (Could be related to taking loading
and unloading time as part of break time?)
UseRecordOrder No It is common when trying to calibrate the model
to require Auto build the manual routes by
setting Zone and Sequence. This often does not
give the result the user wanted when working
with dynamic depots and preferred depots. This
mainly stems from cases where Dynamic Depots
requires two trips to be added, not just one.
It is possible that the sequence in which the
orders are added to the route can affect the end
result. For example if the orders were added in
strict “run” sequence then all orders may be
possible, however if the orders were added in
reverse “run” sequence, due to the complexity of
restructuring the route and calculating new depot
insertion points, it can be the case that some
orders are left unallocated.
Import should add orders to the Task DBF in the
sequence that they are found in the import file
(please note depots etc will be searched for
within the import file and added first), this may
not always be the case. Therefore, if the import
file is sorted by route and sequence, auto will add
the orders to the route in the correct sequence
producing a route closer to that run by the
vehicle.
An alternative approach would be to use the
journey and schedule upload.
UserCSV 0 Controls the level and type of data output, the
default value is no output. Separate PL.INI file
settings control which fields are output
The following settings can be applied in
Document : PLINI settings 48.doc Page 25 Dated : 16/03/2020
Setting Default Options Usage
combination i.e. USERCSV = 5
1 Route Summary
2 Trip Summary
4 Scheduled Orders
8 Unallocated Orders
UserCSVDateFormat Allows the user to configure the date format used
by the CSV file.
Work area and system must be configured for
date usage.
UserCSVDistanceForm
at
k Allows the user to chose the distance unit,
default would be just the distance
K Kms 100.000 Kms
M 62.137
M Miles 62.137 Miles
UserCSVIni PL.INI All the UserCSV options can now be held in a
separate INI file, (which has the same sections
etc as Pl.ini). This is in turn set by a new
directive in PL.INI. For a definition please see
the data import guide
UserCSVName UserOu
t.CSV
UserOut file name.
UserCSVSeparator “,” Default separator used by UserOut mechanism
UserCSVTextDelimiter “ Delimiter for text fields
UserCSVTimeFormat hh:mm Allows the user to configure the time format
used by the CSV file
UseTankFiles No When running with tanks, the time taken to
generate the combinations can be excessive when
compared to the speed of scheduling. If this
option is set to yes, auto creates tank
combination files, based on the vehicle and
trailer type names.
UseZoneSequence N
Y
Enures that the routes are constructed using this
as the major sort (within Prioriy) in the
construction of the scheduling sequence.
ObeySequence and AllRouteSequence must be
Yes.
UseZoneSequence is a method of creating the
SchedulingSequence and if on trumps the usual
scorings. If however the sequence nos are zero,
then the orders are sorted according to the
scores. The scheduling sequence applies to all
modes.
Document : PLINI settings 48.doc Page 26 Dated : 16/03/2020
Setting Default Options Usage
Wait Penalty 20 Auto-LogiX weighting of waiting time. This is
used in costing the insertion and not in the
scheduling sequence
WaitingTimeMode 0 An insertion will be consider worth evaluating if;
The extra travel less the weighted waiting time
and the minimum travel time is better than the
current best
1 The extra travel and work time less the
minimum travel time is better than the current
best
2 The extra travel less the Optimise Limit is better
than the current best
3 If in scheduling use mode 0, but in Optimise use
mode 2
WrapDays Yes If you plan for seven days from Thursday should
the Monday of the second week be a 1 or an 8. If
WrapDays = YES then the Monday will be a 1 if
WrapDays = NO then the Monday will be an 8.
The start of a 7-day period is defined by the
Planning day set within the [Auto32] section of
PL.INI. This is set when you save your
Scheduling Parameters as “Default”. If you
require days greater than 7, we recommend that
you use the setting within the Advanced
parameters “Display default options”.
ZoneByCluster 0 If set to 1, zones are overwritten with cluster
number. Allows you to see what clusters were
formed by Auto
ZoneByParentDepot 0 0 Off
1 Orders which were allocated to any depot are
Zone 1
Unallocated orders are given a zone of 2
2 The zone field is populated with a number
representing Auto’s initial first pass depot
ownership of an order.
Unallocated orders are given a zone number of
(number of depots +1)
ZoneSpanning No Forces both routes in a DoubleShifted Pair to be
constrained to the same Zone.
ShelfLife for tramped orders is calculated as being from the arrival time of the collection
to the departure time of the delivery.
For deliveries, the time is calculate as the arrival time at the depot, to the departure time
of the order.
For collections, the time is calculated at the arrival time at the order, to the departure
time at the depot.
Where order is stated in the above it means the arrival/departure time for the given
order, not the call.
Document : PLINI settings 48.doc Page 27 Dated : 16/03/2020
[Alias]
The alias section allows for the separation of a local matrix from the work area. If
local matrix files are used it is common to leave them located in the master work area.
This way local matrix files are copied each time a new work is created based on the
master. In cases where the local matrix is large, this would not be applicable.
Therefore, the RoadmapQ setting can be used to indicate that the local matrix is
located at a specific position i.e.
\carp\data-GBE\London
If the RoadmapQ setting is used, then the local matrix must be accessible at
the same location on all machines that will use the work area. Setting Default Options Usage
DisabledLMSmatQ Path to the location of the metre second accuracy
local matrix. Only present if the matrix is
currently disabled
DisabledRoadmapQ Path to the location of the 10th metre accuracy
local matrix. Only present if the matrix is
currently disabled
GlobalLMSMatQ GlobalLMSMatQ =<daily matrix file>
Which looks for <path to RoadData>\DATA-
<ymapext>\DAILYMATQ\<daily matrix file>
LMSmatQ Path to the location of the metre second accuracy
local matrix
RoadmapQ Path to the location of the 10th metre accuracy
local matrix
[AllColumns]
[Auto32] Most of these settings are overruled by Run.Log
Setting Default Options Usage
AutoCalibration No Enables the autocalibration button within Auto.
Auto calibration allows the user to tune their work
area by producing a report of plan efficiency based
on a range of parameters.
DeleteExistingRoutes No
DisplayDefaults No When the “AutoLogiX scheduling parameters”
window is opened, this setting governs if the
settings from the Auto32 section of PL.INI or
those from Run.Log are used.
If the save as default setting is ticked, then the values are written to the PL.INI file, if not they are only written to the run.log file.
FixedFleet -1 No fixed fleet set-up therefore auto scheduling
allows an unlimited number of vehicles, of the
vehicle types set within the vehicles tab in
parameters. If set to ‘0’ then you can specify how
the fleet available at each depot.
LongDateFotmat Windows formatting string to define how long
dates are displayed
Work area and system must be configured for date
usage.
Document : PLINI settings 48.doc Page 28 Dated : 16/03/2020
Setting Default Options Usage
MaxNightsAway 0 Where the number coincides with the number of
nights away from depot that any particular route
can have. If numerous nights away are required
then the PlanningDays must be set accordingly as
you cant have a route going overnight in to 2 days
without the planningdays set to 2.
MaxNightsAway can be set from 0 – 6.
MaxTripsPerRoute 1 If set to > than 1 then numerous trips per route are
allowed. LogiX perceives more than one trip as the
number of times it does a return to depot within its
particular route. (When using DynamicDepots then
a higher number will generally be needed) Set
from 1 – 15
PlanningDate Used to define a date in the format yyyymmdd,
which corresponds to the.
Work area and system must be configured for date
usage.
RoutePrefiX AUTO Upon running the auto schedule, the name of the
route created will be prefixed with Auto. However,
this can be modified as desired by the user, with up
to 4 characters.
RunType 1 Upon running auto, it views the run type and
schedules accordingly.
1 Re-schedule
2 Pre-allocated routes
3 Continue Schedule
4 Add to Existing
5 New Routes Only Preserve All
6 Re- Optimise routes
7 Extend
8
31
Spread
Vehicle by trip (trailer swapping) not in use.
32 Pre-allocated followed by levelling
33 Depot time and distance calculation
ScheduleImportFile Full path and name of CSV file
SchedulingPeriod 1 Where the number of planning days set is used for
the number of days over which your auto schedule
will create routes. For example, if the startday is
set to 1 and the planningdays also set to 1, routes
would be created for a Monday only. The
planningdays can be set from 1-7, allowing up to a
full weeks schedule.
ShortDateFormat Windows formatting string to define how short
dates are displayed in grids and reports.
Work area and system must be configured for date
usage.
StartDay 1 The startday constitutes the day for which your
auto schedule plan begins.
1 Monday
2 Tuesday
3 Wednesday
4 Thursday
5 Friday
6 Saturday
7 Sunday
SummaryImportFile PL.INI Full path and name of CSV file
Document : PLINI settings 48.doc Page 29 Dated : 16/03/2020
ClusterMode as far as Auto is concerned is always read from PlanLogix but if you put the performance scale to custom (PerformanceScale=0) the ClusterMode in RO-OP (RO-Cloud not allowed to have this concept) is read from [Auto32] and saved to both [Plan-Logix] and [Auto32] sections.
RunType 32 which performs a Schedule to pre-allocated routes and makes a copy of
the result, and automatically runs the Leveling process from Schedule Assistant to
give the final result. Initial state and intermediate Summary and Schedule are written
with DB0 and DB1 extensions respectively.
RunType 33 which sets the DirectFields. Addditon of time and distance from 'serving
depot'. For Allocated orders the Serving depot is as recorded in schedule. For non-
allocated orders it is the initial Auto assigned depot. Initially it only needs be on
TASK, but is updated per Auto run. It is now ONLY set by a run of this type.
[Auto_Import] Only applicable LogiXIE
Setting Default Options Usage
SetRouteZones YES Journey has an Imposed Zone field, which is not
currently implemented. However, Recalc set this field.
In an allocate to pre-defined routes with priorities, at
the end of the first priority we entered Recalc, which
set the Journey Zones and thereby prevented vehicle
swapping. Recalc no longer sets this field. The
previous (bizarre) behaviour which meant that once a
Route had been assigned any call with a Zone, it
retained that Zone even if the call was subsequently
removed, can be restored by an INI file setting
ZoneControl 0 Zones can now be set by postcode records. Only
applicable to LogiXIE
0 No auto Zoning
1 Zone by centroid
2 Zone by postcode
When using this feature the postcode is defined in the
zonename of the zone.dbf, the record type must be 2
This feature is under development and may change. Setting Default Options Usage
SCHEDULEFILE See above
SUMMARYFILE If the files names are present, AND the Summary and
Schedule files are EMPTY, then Importing Journeys
will be attempted. The summary records have to be
processed before the schedule records. The Summary
CSV file can take two forms, both are CSV files but
may be called anything valid. The first form has a
Header record and can therefore be in any order of
columns. Only columns corresponding to the following
names will be processed.
If the files names are present, AND the Summary and Schedule files are EMPTY,
then Importing Journeys will be attempted. The summary records have to be
processed before the schedule records. The Summary CSV file can take two forms,
both are CSV files but may be called anything valid. The first form has a Header
record and can therefore be in any order of columns. Only columns corresponding to
the following names will be processed.
Document : PLINI settings 48.doc Page 30 Dated : 16/03/2020
If the file names are present, AND the Summary and Schedule files are EMPTY, then
Importing Journeys will be attempted. The summary records have to be processed
before the schedule records.
The Summary CSV file can take two forms, both are CSV files but may be called
anything valid. The first form has a Header record and can therefore be in any order
of columns. Only columns corresponding to the following names will be processed.
{"ROUTE", 1},
{"ROUTENAME", 1},
{"STARTDEPOTNAME", 2},
{"STARTDEPOT", 2},
{"DEPOTNAME", 2},
{"DEPOT", 2},
{"TURNDEPOTNAME", 3},
{"TURNDEPOT", 3},
{"FINISHDEPOTNAME",4},
{"FINISHDEPOT", 4},
{"ENDDEPOTNAME", 4},
{"ENDDEPOT", 4},
{"SHIFTNAME", 5},
{"SHIFT", 5},
{"VEHICLENAME" , 6},
{"VEHICLE", 6},
{"VEHNAME" , 6},
{"USERDAY" , 7},
{"SHIFTSTARTDAY", 7},
{"USERTIME" , 8},
{"SHIFTSTARTTIME", 8},
{"STATUS", 9},
{"DESCRIPTION", 10},
The above includes the synonyms for the various fields. As each record is processed,
it will be added to SUMMARY.DBF. On completion, the SCHEDULECSV file
entries are processed. In this case the valid fields are
{"ROUTENAME", 1},
{"ROUTE", 1},
{"SEQUENCE", 2},
{"TYPE", 3}, corresponds to Type in Schedule.dbf
{"REFERENCE", 4},
{"ORDER", 4},
{"DURATION", 5},
When both files have been processed, Auto will read the Summary and Schedule dbf's
just as though they had been passed from Plan. The routes will be evaluated, the
records completed and the files updated.
The SECOND Summary file format has no HEADER and may contain both Summary
and Schedule records which are distinguished by the first field. This is J in the case of
Summary (Journey) and S in the case of Schedule. The J record must precede the S
Document : PLINI settings 48.doc Page 31 Dated : 16/03/2020
records, which refer to it. All fields must be present (even if empty) and must be in
the following order.
J
RouteName
StartDepot
TurnDepot
EndDepot
Shift
Vehicle
UserDay
UserTime
Status
Description
S
RouteName
Sequence
Type
Reference
Duration
[AllColumnsWidths] This section holds the widths for the columns when viewing the Route list in “All
Columns”
[Assistant] Setting Default Options Usage
IncludeWaiting Y/N This controls the Levelling function, which takes a
minimum shift time. This parameter indicates whether
the shift time should or should not include waiting
time, which is in a sense, wasted shift time. The default
is Yes, which reflects previous behaviour.
[Catchment]
Section heading for Depot Catchments
The section consists of a list of depot names followed by the percentage adjustment
for its catchments area. In multi-depot mode auto assess the amount of work that a
depot can do by using the depot throughput. If depot throughput is not set, then 70%
of the total vehicle capacity for the depot is used. The Depot Utilisation percentage,
is then applied.
The user may then factor this value by the stated percentage
Avonmouth = 120
Enfield = 90
Depots are identified by name as used in Plan-LogiX
The percentage can be from 0 to 32000
Document : PLINI settings 48.doc Page 32 Dated : 16/03/2020
Remember to check you have quantities set for the primary unit
[Centres]
This section is used to set the Priority and Group of all Orders within a specified
radius of a given central point.
There are two permitted formats:
Label = DPSEast, DPSNorth, Radius kms allowing decimals, Priority
or
Label = DPSEast, DPSNorth, Radius kms allowing decimals, FieldName = Value,
(FieldName = Value)
Valid field Names at present are Priority and Group.
The label has no significance to the program.
Examples:
Rotterdam=9166,16052,50,Priority=2,Group =9
Amsterdam=10028,17862,90,3
For tidal flow the definition is extended as follows
You must set TidalFlow=yes LondonA=51:23:32 00:09:37,10.0,Period=A,SpeedIn= 60,SpeedOut = 50,
LondonP=51:23:32 00:09:37.10.0,Period=P,SpeedIn= 60,SpeedOut = 50,
LondonD=51:23:32 00:09:37,10.0,Period=D,SpeedIn= 60,SpeedOut = 50,
LondonN=51:23:32 00:09:37,10.0,Period=N,SpeedIn= 60,SpeedOut = 50,
For each line period can be:-
A AM peak
P PM peak
D Day
N Night
SpeedIn and SpeedOut are the percentage effect applied to the travel speed.
[DataTables] Setting Default Options Usage
Output_MDB Maintain MS-Access database
Output_NMEA False Produce NMEA files
Output_SQL False Allow output via SQL
[Depot-Zone] For this section to take effect the DepotZone flag must be set to yes.
Document : PLINI settings 48.doc Page 33 Dated : 16/03/2020
The section consists of a list of depot names followed by the Zone numbers each will
attract. This is best demonstrated by example:
Avonmouth = 1
Warrington = 2, 3, 4-6
Depots are identified by name as used in Plan-LogiX
Zones are a string of digits. Any non-numeric separator can be used but "-" as in "4-
6" signifies a range. A depot can appear many times in the section if need be
[DepotSatellites] Only applicable when running in Dynamic depot mode.
When allocating orders to routes, the scheduling engine has to check if there are better
start and end depots for the trip. If the work area contained 100 depots each
combination would have to be considered for the start and end depot, for the given
trip. This could result in 10,000 combinations being checked.
In reality it is likely that only a small subset of the depots are applicable to a route
based on it’s start depot. The DepotSatellites section has been added to allow the user
greater control as to which depots are considered. For each Garage a line can be
added to the PL.INI file.
Garage_depot = Depot1,Depot2,Depot3
Where Garage_depot is the name of depot that can use the following list of depots
named.
The depot itself is added to the list by the scheduling engine. There are a maximum of 32 depots that can be assigned in this
manner, including the depot itself. Any extra depots are ignored, i.e. 31 + itself.
To stop a depot using other depots, the depots name can be used as the sole entry i.e. Depot1 = Depot1
If the garage depot does appear in the DepotSatellites section, it can use any depot.
[Depot2Depot]
[eLogiX] Setting Default Options Usage
AutoVersion
ClientVersion
DateTime
HypervisorVersion
ImportVersion
JobNumber 0
WorkAreaName
WorkstationName
Document : PLINI settings 48.doc Page 34 Dated : 16/03/2020
[Fields]
This section allows the user to map the field headings of an import file, to the fields
used within LogiX. For more details, see the separate Import Documentation.
[Import32] Setting Default Options Usage
AccessiblePointsOnly 0 No
1 Yes
ASCII Yes Yes Requested by the Danish office, if Yes
imported text is assumed to be ASCII
No If No assumed to be ANSI
AutoAfterImport 0 Only applies to Control Centre
Disabled
1 Enabled, when Wli32 has finished it’s
import run Auto is executed
AutoAt 0 Only applies to Control Centre
AutoEvery 0 Only applies to Control Centre
AutoFlagFile RunAuto.Dat Only applies to Control Centre
AutoImport No No Normal operation, the user must choose
to start importing.
Yes When import is started it tries to
automatically import the current import
file.
If there are any un-cleared errors then
import engine will pause on start-up.
AutomaticZoning 0 No auto zoning
1 Zones calculated by centroid
2 Zones calculated by postcode
3 Zones calculated by vehicle type
ClearConfirmed No
ClearErrors No
CpointFile No
CpointPath
DateSeparator When importing DOP (Day of Plan)
fields as date strings, this key defines the
separator.
See ShortDateFormat
DeleteImportFile No
Dripfeed 0 Only applies to Control Centre
DripFeedDemo No Yes Only applies to Control Centre
Controls how often control centre polls
for order. The default is no and therefore
polls every n minutes. If
DripFeedDemo=yes is set Control Centre
polls every n seconds
EastLimit
ErrorsFile WLIERROR.CSV
ExtendedStatistics No If set to Yes the totals for the extended
import types are displayed in Import
FileExtension LIM Awaiting details
FileName Orders.csv
FilePath
FilesList Overrides the import file name.
This entry is a full path to a file that can
contain a list of import files. For
example, if a “Central System” outputs an
Document : PLINI settings 48.doc Page 35 Dated : 16/03/2020
Setting Default Options Usage
update file every 10 minutes, if should
append the new files full path to the
FilesList file. Import will then at next
run, rename the FilesList file, and read all
the files pointed to, by the FilesList file.
The data is then imported in one block as
per the import sequence rules.
FileType 0 Awaiting details
ForceCompleteOrders 0 Standard WLIError.csv file is created
1 Forces “T” type records to be written out
as “B”, therefore making the error file
importable.
Import does not attempt to recreate the initial file, therefore column names etc are changed.
FrequencyFormat [O]-[F]-[S] This is the format you would like the
import engine to give for your order
references, see section FrequencyFormat
for more details.
ImportCMD The full command line for the last import
run, only applies to RO-Cloud
ImportEvery 0
ImportJourneys No Is required to instruct Auto to perform the
importation Import will only write such a
setting if there is and corresponding entry
ImportMode 2 Update and correct errors
0 No update only report errors
1 Files updated and errors reported
3 Confirmation every time
ImportOption 0 Choose import file
1 Import file with prefix + “.LIM”
2 Import any files with extension
LastScheduleDate Awaiting details
MatrixBuildOption 0 Do not maintain existing points and build
a new matrix
1 Maintain existing points and incremental
build if possible
2 Maintain existing points but recalculate
the existing matrix
3 Single Point
16 PTV Normal mode
17 PTV Add To Existing
18 PTV Rebuild
19 PTV Single Point
MatrixBuildRequired No Only applicable when working with a Y
cache database.
Enables disables Matrix building when
import is closed.
A MatrixTargetPath must be supplied
A MatrixWorkingPath must be supplied. This path is used to hold temporary data
MatrixGeoPath Full path to the GEOY file, or the
database name i.e. UKA
MatrixIncludeDepots Yes Should depots be included in the matrix.
Document : PLINI settings 48.doc Page 36 Dated : 16/03/2020
Setting Default Options Usage
Always include depots
MatrixNodeType 3 Include callpoints or orders
0 No callpoints and No orders
1 Orders only
2 Callpoints only
MatrixRestrictionFile Name of restrictions file used to build the
local matrix via Import blackbox
MatrixShutDown Maximum runtime in seconds, before a
matrix builder shutdown is triggered
MatrixShutDownDelay After the shutdown period is reached, the
process is allowed this many seconds to
perform a graceful shutdown
MatrixStatusFrequency 5 Time in seconds between output of status
information.
Only outputs if a status file is defined
MatrixStatusPath Location for output of status information
MatrixTargetPath Mandatory data.
Full path to where the matrix file should
be created
Must include the file name
MatrixVehiclePath Full path to the vehicle definition file
MatrixWorkingPath Mandatory data.
This path is used to hold temporary data
MessageLevel 1 Awaiting details
MinConfidence 4 Minimum confidence level that an
address must reach to be automatically
imported
NorthLimit
OverwriteZones No
PostImport Allows the definition of a process to be
run upon completion of an import.
For options, see following notes.
MatrixRestrictionsFileType Type of restrictions file used to build the
local matrix via Import blackbox
PreImport Allows the definition of a process to be
run at the start of importing data. The
program is not run upon opening the
import engine, but on the commencement
of reading the import file i.e. pressing the
“Play” button to import your data
PreImport=Program,args,execute,hidden
In the above Pre-import would run the
program with the specified arguments,
these should be separated by }. Execute
can have a value of 1 or 0, where 1 is
execute and 0 is do not run the command.
If hidden is set to one the program is run
in hidden mode, if 0, when the program is
run it will be visible.
c:\carp\loxix32\a.exe,/A}/B},1,0
The above would run program a.exe, with
command line parameters /A and /B, in
visible mode.
PositionalProducts Awaiting details
ReadCollectionFields 0 1 If the value is 1 then for records of Order
Type 'C' the engine will expect to find the
data for records in the 'C' header columns
Document : PLINI settings 48.doc Page 37 Dated : 16/03/2020
Setting Default Options Usage
(eg ADDRESS1C, CUSTINFO2C etc).
The references will NOT have a 'C' suffix
appended as would be the case for 'B'
order type records.
ReportDuplicates No Awaiting details
ScheduleMode 0 Auto Schedule
1 Schedule Assistant
ScheduleType 0 Auto every x hr and y mins
1 Auto at time
2 Auto when flag file exists
ShortDateFormat When importing DOP (Day of Plan)
fields as date strings, this key defines the
data format i.e. yyyymmdd
See DateSeparator
SouthLimit
TextDelimiter “
TextSeparator , For tab use <TAB>
UnallocatedInterval 100 Awaiting details
WestLimit
Writetotalsini Yes This will write out a file called
WLSRITOT.ini in the workarea. Under
the section [row totals] the six working
grid columns are written out to keys call
point totals, order totals, depot totals, and
MCP totals. If not an MCP workarea then
MCP totals are –1.
FrequencyFormat
When you are running with “GroupFrequency=2” switched on, then you can import a
single order, and based on the value entered in the Frequency field, the import engine
will replicate your order to make required number.
Of course each order/visit must have a unique Order reference, which the import
engine will create for you based and the defined mask. Note that if you require the
group size and the instance number within the group to form part of the Order
Reference, then of course the base Order reference must be kept short.
The PL.INI setting “FrequencyFormat” is used to define the format under the
[Import32] setion. The following tokens are used:-
• [O] the Order Reference from the master order
• [F] the frequency group size i.e. the number of orders in the group
• [FF] the same as [F] but includes a leading zero if required for sorting
• [S] the order sequence within the group, i.e. 1 to the frequency group size inclusive.
• [SS] the same as [S] but includes a leading zero if required for sorting
So given an Order Reference of “ABC123 of Frequency 4 the mask FrequencyFormat=[O]-[FF]-[SS]
Would result in the following orders note that an Order Reference cannot exceed 12
characters
Document : PLINI settings 48.doc Page 38 Dated : 16/03/2020
• ABC123-04-01
• ABC123-04-02
• ABC123-04-03
• ABC123-04-04
Note in the above example we have put the Frequency number first, in case the order
number used is a customer reference, where the customer has several frequency
patterns i.e. for a vending machine a weekly restock, a one a month merchandising
check by a manager, and clean and service every three weeks. This way all the orders
for the frequency 4 group can be sorted together, in the User Interface.
ChainByFrequency
ChainByFrequency=1 enable you to Chain orders in GroupFrequency=2 mode, which
didn't work before. The orders must have the same Frequency to be able to be in a
Chain. This can then be used with BreakChains=NO to force same place and/or
customer or don't schedule at all.
ChainByFrequency=2 allows the mixing of different frequency values in the Chain.
This means that on the first allocation, the mixed frequencies are all tried on every
planning day, with the best pattern of the highest/largest Frequency visit Pattern.
When the visits are actually added/inserted to the routes, the correct pattern is applied
to the respective Frequency Patterns. This only works if the Patterns for the different
Frequencies match (e.g. bi-weekly pattern matches a weekly pattern). If you want to
allow mixed frequency patterns that don't match, then use the new 'BreakChains=2'.
Pre/post import
The Plan LogiX import engine gives you the option of defining processes that can be
run before and after import. The programs are not run upon opening the import
engine, but on the commencement of reading the import file i.e. pressing the “Play”
button to import your data
PreImport=Program,args,execute,hidden
In the above Pre-import would run the program with the specified arguments, these
should be separated by }. Execute can have a value of 1 or 0, where 1 is execute and
0 is do not run the command. If hidden is set to 1 the program is run in hidden mode,
if hidden is set to 0 then the program is run in visible mode.
For example
c:\carp\loxix32\Z.exe,/A}/B},1,0
The above would run program Z.exe, with command line parameters /A and /B, in
visible mode.
Key points when running a pre-import process are:-
• That the selected import file must exist before the “Play” button will be enabled
• Import will have copied the import file to WLI_TEMP.CSV prior to running the
process. Therefore, any changes / data creation must be performed on
WLI_TEMP.CSV within the active work area.
Document : PLINI settings 48.doc Page 39 Dated : 16/03/2020
[LXC] Setting Default Options Usage
TomTomGeoOn False True/Fale Records whether the user checked the TomTom geocoding
option on starting Import
ProcessMode False True/Fale True/false, is 'Run Auto on complete' enabled on Import
Language ENG 3 letter RO lingo identifier from the last user who opened this
profile, eg ENG
[LXProfile] Setting Default Options Usage
HTML
XLS
[Maps] Setting Default Options Usage
GBE=UKT This section over-rules x2ymap.ini. i.e. GBE=UKA would over-
rule X2YMap of GBE=UKT
[NoGoProducts]
This section stores the product compatibility data as set from within Parameters.
[PlanGrid]
This section is used by Parameters to indicate which columns will be displayed by the
route display. A “1” next to the field name indicates that the field is set to be visible.
Addr1
Addr2
Addr3
Addr4
Zipcode
Phonenum
Info1
Info2
Info3
Info4
Info5
Location
ProdIcon
[PlanGridWidths] Holds the column widths for the Route detail grid.
Document : PLINI settings 48.doc Page 40 Dated : 16/03/2020
[Reports] Setting Default Options Usage
AccessTable
CCAddress
EmailAddress
Goup6
Group1
Group2
Group3
Group4
Group5
JobPassword :00:
UserName :00:
UserPassword :00:
[RouteList] User selected columns to be displayed in the Route List.
[RouteReport] Only applicable if running with a Y-cache map database. The HTML page contains Java script
The HTML itinerary report works with the following settings:- Setting Default Options Usage
SubMapRadius1 0 Numeric Controls the area covered by sub map 1 (left).
Metres from the calls lat long.
SubMapRadius2 500 Numeric Controls the area covered by sub map 2 (centre).
Metres from the calls lat long.
SubMapRadius3 0 Numeric Controls the area covered by sub map 3 (right).
Metres from the calls lat long.
SubMapWidth 200 Numeric Image size in pixels
SubMapHeight 150 Numeric Image size in pixels
ShowViaPoints Yes Boolean Sets the default value for the checkbox on the
HTML page
ShowRouteMap Yes Boolean Sets if sub maps should be calculated and
displayed on the web page.
ShowSubMaps Yes Boolean Sets if sub maps should be calculated and
displayed on the web page
ShowItinerary Yes Boolean Sets if itinerary should be displayed on the web
page
ShowRouteTotals Yes Boolean Sets if route totals are displayed on the web page
ShowCountryTotals Yes Boolean Sets if country totals are displayed on the web
page
ShowTollRoadTotals Yes Boolean Sets if toll road distances and totals are displayed
on the web page
Document : PLINI settings 48.doc Page 41 Dated : 16/03/2020
[Routes]
[RouteListWidths]
[Row totals]
[SelectedRouteList]
[SelectedRouteListWidths]
[Site] A value of Balance MUST be set. It defaults to zero which is simply a way of turning the mod off. Loop is really a catch all debug setting which is there to prevent in finite loops. Moves is a crude attempt to limit how many calls can change form the initial allocation. This is will need refinement before it is a user ready setting. Do we mean number of Orders, or Number of Customers, or Number of locations. Does it measure the changes from the exiting (if any) pref-dep) or is it a count of those NOT served by the nearest (ideal) depot.
Setting Default Options Usage
Balance Max travel time in mins from any depot.
Balancemode 0 Will check throughputs only, but is different from
the previous Auto method
1 New "balance work evenly" mode
DepotPrefix Depot The prefix for any new depots generated by the
auto engine
DetailLevel 2 1 Corresponds to the Detail Level box radio buttons.
Detailed: Includes Order Details
2 Standard: Lists order allocation
3 Summary: Totals for each depot
4 Depot Volume Report
LocationMethod 1 Locate Anywhere
2 Locate At Depot
3 Locate At Order
4 Locate From Site List
Loop Max number of iterations
NoDepots Number of depots required
Moves Max number of locations which will be moved
ReportFileName Name of the report file if required. Left blank if
not. This was to create a Quick Reports saved file
but it’s always been a bit iffy and so the code is
commented out. It has no effect at the moment
ReportType 1 1 Corresponds to the Report Options box radio
buttons. Report on All Orders
2 Report on Allocated Orders Only
3 Report on Unallocated Orders Only
RetainDepots Yes Yes/No says whether you want to throw any existing
depots away or not
RunAutoOnExit No Yes/No Is true if the Auto front end is automatically
started up when the program is closed
SiteWeighting 0 0 to 3 Weighting method. The value is a bit mapped field
where:
0 = Load size
1 = Fixed Time
2 = Variable Time
3 = Fixed + Variable Time
Document : PLINI settings 48.doc Page 42 Dated : 16/03/2020
Setting Default Options Usage
[Tables] Used to tell auto which tables to update.
[Tabs]
[Tankers]
Used to store tank sizes against vehicles
The following example shows a vehicle with two 12 primary unit compartments.
Twin_compart=12.,12.,0.,0.,0.,0.,0.,0.,0.,0.,0.,0.,0.,0.,0.,0.
[TaskListWidths] Order list column widths
Document : PLINI settings 48.doc Page 43 Dated : 16/03/2020
[TaskList]
[TomTomConfig] Setting Default Options Usage
AccuracyThreshold 7 Applies to both MaxResults = 1 and MaxResults >
1.
If any result has a Geocoding Accuracy Level
(GAL) less than the, then it will be ignored.
1 Country
2 Region (state, province, county, etc.)
3 Town (city, village)
4 Post area/zone (zip code, UK 'B5')
5 Suburb (innercity district)
6 Post sector (USA ZIP+2, UK 'B5 7')
7 Street
8 Full postcode (USA ZIP+4)
9 Intersection
10 Address (house number)
11 Premise/POI (building name, property name,
shopping centre)
12 Address point (exact lat-long)
ConsolidationFlags 2 Only used when MaxResults is greater than 1.
The Consolidation Flags sets the rules for how the
other threshold settings are used. DPS uses the
GAL as an Accuracy Threshold and status code as
a Match Threshold.
0 Only return unique locations
1 Remove locations less than acc. threshold, Return
if unique
2 Multiple good accuracy, all within dist. tolerance,
return first
3 Multiple, but one at higher accuracy, return that
4 Multiple at same high accuracy, all within dist.
tolerance, return midpoint
DistanceThreshold 99 Only used when MaxResults is greater than 1.
Only used when consolidation flag is set to 2 or 4.
It will ignore results that are more than the set
distance from the current best result in the list.
Value is in metres. ForceTomTom 0 It may be a requirement that for certain customers
we use TomTom for UK addresses regardless of
whether the address contains a valid grid reference
or full british post code. To this end, we have
added an extra setting to the TomTomConfig
called ForceTomTom. Default value = 0.
This means that we test both for a grid reference
and a full british postcode prior to calling
TomTom. This is the current situation.
1 Add 1 to the setting and the address will not be
scanned for a valid full british postcode prior to
calling TomTom.
2 Add 2 to the setting and the address will not be
scanned for a grid reference prior to calling
TomTom.
Document : PLINI settings 48.doc Page 44 Dated : 16/03/2020
Language en/ENG Optional setting to override the default of English.
Language code used to localise returns: either ISO
639-1 (2-character) or ISO 639-2/B (3-character)
values can be used.
de/GER
es/SPA
fr/FRE
it/ITA
nl/DUT
pl/POL
pt/POR
sv/SWE
MatchThreshold 0 NOT CURRENTLY OPERATIONAL
This is the integer value of a 2 character
hexadecimal value based on the combination of
both status code return values from TomTom
geocoding.
The first value (least significant hex. value) is one
of the following:
0=No action (Default)
1=Ignore ambiguous results that are too general
2=Ignore ambiguous results when MaxResults=1
and there are more top results found (NOTE:
Redundant as MaxResults>1)
3=Ignore results that are less accurate than the
search criteria request (structure search only)
4=Ignore results that have a slight variation in
adjunct type (e.g. Street vs. Avenue)
5=Ignore results that report a common misspelling
in the search criteria (e.g. abbreviations)
6=Ignore standardised results (e.g. street type
abbreviations)
7=Ignore results where the postal code is more
accurate
0 The second value is either:
0=No action (Default)
1=Ignore results where no postal information was
found
2=Ignore results where postcode format does not
match country's postal code system
• Default is 0.
• Example ‘17’ = ‘0x11’ = ‘Ignore
ambiguous results that are too general’
and ‘Ignore results where no postal
information was found’.
• Example ‘19’ = ‘0x13’ = ‘Ignore results
that are less accurate than the search
criteria request (structure search only)’
and ‘Ignore results where no postal
information was found’.
Document : PLINI settings 48.doc Page 45 Dated : 16/03/2020
MaxResults 1 Used for getting TomTom geocoding to return
multiple results, so that the DPS consolidation
code can attempt to find the best match, discarding
the others. Occasionally, the best match is not first
match returned in the results list:
Limits the number of results returned.
Note that if the results are ambiguous (more than
one result has the same matching score) and
maxResults=1, then no result will be returned at
all.
TomTom geocoding default is 20.
SearchCountry GBR Required to narrow the results to a specific
country. The aims to prevent ambiguous results
for streets that are very similar, but in different
countries.
ISO 3166 alpha-3 country code
UseTomTomGeocoding No
Yes Switch on TomTom Geocoding
UseStructuredSearch Yes Structured parameters indicate the nature of the
address elements of the query. Those values will
then only be checked against specific data in the
geo index. There are specific structured parameters
to indicate POI queries.
Queries using structured parameters will generally
yield more accurate results, and should be used
when possible.
No The freetext parameter takes in anything, either
address elements or a POI name, and attempts to
parse it. Inputs are matched on a best-guess basis
against the geo-index. The more that the data in
the freetext parameter resembles a structured
address or POI name, the better chance it has of
being well-matched.
Document : PLINI settings 48.doc Page 46 Dated : 16/03/2020
[XLocateConfig] Setting Default Options Usage
AccuracyThreshold 7 Applies to both MaxResults = 1 and MaxResults >
1.
If any result has a Geocoding Accuracy Level
(GAL) less than the, then it will be ignored.
1 Country
2 Region (state, province, county, etc.)
3 Town (city, village)
4 Post area/zone (zip code, UK 'B5')
5 Suburb (innercity district)
6 Post sector (USA ZIP+2, UK 'B5 7')
7 Street
8 Full postcode (USA ZIP+4)
9 Intersection
10 Address (house number)
11 Premise/POI (building name, property name,
shopping centre)
12 Address point (exact lat-long)
ConsolidationFlags 2 Only used when MaxResults is greater than 1.
The Consolidation Flags sets the rules for how the
other threshold settings are used. DPS uses the
GAL as an Accuracy Threshold and status code as
a Match Threshold.
0 Only return unique locations
1 Remove locations less than acc. threshold, Return
if unique
2 Multiple good accuracy, all within dist. tolerance,
return first
3 Multiple, but one at higher accuracy, return that
4 Multiple at same high accuracy, all within dist.
tolerance, return midpoint
DistanceThreshold 99 Only used when MaxResults is greater than 1.
Only used when consolidation flag is set to 2 or 4.
It will ignore results that are more than the set
distance from the current best result in the list.
Value is in metres. ForcePTVGeocoding 0 It may be a requirement that for certain customers
we use XLocate for UK addresses regardless of
whether the address contains a valid grid reference
or full british post code. To this end, we have
added an extra setting to the XLocateConfig called
ForcePTVGeocoding. Default value = 0.
This means that we test both for a grid reference
and a full british postcode prior to calling
TomTom. This is the current situation.
1 Add 1 to the setting and the address will not be
scanned for a valid full british postcode prior to
calling TomTom.
2 Add 2 to the setting and the address will not be
scanned for a grid reference prior to calling
XLocate.
Language en/ENG Optional setting to override the default of English.
Language code used to localise returns: either ISO
639-1 (2-character) or ISO 639-2/B (3-character)
values can be used.
de/GER
Document : PLINI settings 48.doc Page 47 Dated : 16/03/2020
Setting Default Options Usage
es/SPA
fr/FRE
it/ITA
nl/DUT
pl/POL
pt/POR
sv/SWE
MatchThreshold 0 NOT CURRENTLY OPERATIONAL
This is the integer value of a 2 character
hexadecimal value based on the combination of
both status code return values from TomTom
geocoding.
The first value (least significant hex. value) is one
of the following:
0=No action (Default)
1=Ignore ambiguous results that are too general
2=Ignore ambiguous results when MaxResults=1
and there are more top results found (NOTE:
Redundant as MaxResults>1)
3=Ignore results that are less accurate than the
search criteria request (structure search only)
4=Ignore results that have a slight variation in
adjunct type (e.g. Street vs. Avenue)
5=Ignore results that report a common misspelling
in the search criteria (e.g. abbreviations)
6=Ignore standardised results (e.g. street type
abbreviations)
7=Ignore results where the postal code is more
accurate
0 The second value is either:
0=No action (Default)
1=Ignore results where no postal information was
found
2=Ignore results where postcode format does not
match country's postal code system
• Default is 0.
• Example ‘17’ = ‘0x11’ = ‘Ignore
ambiguous results that are too general’
and ‘Ignore results where no postal
information was found’.
• Example ‘19’ = ‘0x13’ = ‘Ignore results
that are less accurate than the search
criteria request (structure search only)’
and ‘Ignore results where no postal
information was found’.
MaxResults 1 Used for getting TomTom geocoding to return
multiple results, so that the DPS consolidation
code can attempt to find the best match, discarding
the others. Occasionally, the best match is not first
match returned in the results list:
Limits the number of results returned.
Note that if the results are ambiguous (more than
one result has the same matching score) and
maxResults=1, then no result will be returned at
all.
TomTom geocoding default is 20.
SearchCountry Required to narrow the results to a specific
country. The aims to prevent ambiguous results
Document : PLINI settings 48.doc Page 48 Dated : 16/03/2020
Setting Default Options Usage
for streets that are very similar, but in different
countries.
ISO 3166 alpha-3 country code
UsePTVGeocoding No
Yes Switch on PTV Geocoding
UseStructuredSearch Yes Structured parameters indicate the nature of the
address elements of the query. Those values will
then only be checked against specific data in the
geo index. There are specific structured parameters
to indicate POI queries.
Queries using structured parameters will generally
yield more accurate results, and should be used
when possible.
No The freetext parameter takes in anything, either
address elements or a POI name, and attempts to
parse it. Inputs are matched on a best-guess basis
against the geo-index. The more that the data in
the freetext parameter resembles a structured
address or POI name, the better chance it has of
being well-matched.
[VehicleOvernight]
Used to define which vehicles can do overnight routes
UserOut CSV
LogiX provides a common output mechanism built into the Auto scheduling engine.
The Auto scheduler has many uses, and in fact is called to evaluate any manual
changes made. The UserOut mechanism provides a way of creating user configured
output files, a full explanation can be found in the LogiX interfacing documentation.
For the purposes of this document we will only look at the PL.INI sections.
For these settings to take effect the User out mechanism must be set see above.
A typical example being
[CSVSCHEDULE]
ORDER = 1, Job,
CUST_NAME = 2, Cust,
ADDRESS_1 = 3, Addr1,
ADDRESS_2 = 4, Addr2,
ADDRESS_3 = 5, Addr3,
ADDRESS_4 = 6, Addr4
ZIPCODE = 7, PostCode,
ROUTE = 8, Run,
SEQUENCE = 9, Seq
TASK_TYPE = 10, Action,
In the above example the first column list the LogiX fields, then the output sequence
number and finally the column heading for the output file. The same data format,
although not field names applies to all three sections.
A full explanation can be found in the “Interface suggestions” document
Document : PLINI settings 48.doc Page 49 Dated : 16/03/2020
[CSVSummary]
This section allows the user to select fields at the summary level.
[CSVTrip]
This section allows the user to select fields at the trip level.
[CSVSchedule]
This section allows the user to select fields at the schedule level.
Long Name format string
The routes long name is defined by the LongNameFormat key in the PL.INI
To work with dates, the work area and system must be configured for date usage.
Where token is one of the following
• Depot – Depot name
• Hours – Hours name
• Shift – Shift name
• Workarea – work area folder name
• Project – Project name from Parameters
• Vtype – Vehicle type name
• Vasset – Vehicle asset name
• Ttype – Trailer type name
• Tasset – Trailer asset name
• Avail – Availability name
• Driver – Driver name (when applicable)
• ZoneNum – Zone number
• Zone – Zone name
• RouteNum – New unique route number
• Route – Short route name (not applicable to short route name itself)
• Descrip – Route description
• StartTime – Route start time (see notes)
• StartDay – Route start day as generated by LogiX
• StartDate – Route start date offset based on start of plan date (see notes)
• AvailID – ID for the applied availability record (where applicable, blank if not
applicable)
• CreateDate – Date the route was created (taken from the machine)
• CreateTime - Time the route was created (taken from the machine)
• Driver – Driver name if/when applicable
Fixed Text Output
Fixed text can be included in the Userout file as follows:
Textn = column number, heading, fixed text
Document : PLINI settings 48.doc Page 50 Dated : 16/03/2020
N is a number 1 to 9 inclusive
If the heading is left blank the default is the Textn label
e. g.
Text1 = 23,Company,Test Company
Formatting
The expected format of a token would be
<token>
However, if should also be possible to apply formatting rules
<token(000)> - numeric field to be truncated to a maximum of 3 digits, with
leading 0’s etc
<token{yyyMMdd}> - Standard date / time formatting etc
<token[1,2]> - Start at character 1, and take maximum of two character
It should be possible to [] formatting with any other type i.e.
<token(0000)[3,2]>
Therefore.
LongNameFormat=DPS-<Depot>-<StartDate{yyyyMMdd}>-<RouteNum>
Would output a route name similar to the following
DPS-Depot1-20070724-1
Start time
Should accept standard formats specified by the user to control the output format
Start dates
Should accept standard formats specified by the user to control the output format
To format week numbers use:-
<StartDate{WW}>
Document : PLINI settings 48.doc Page 51 Dated : 16/03/2020
Function dependencies
Chaining
The following is an explanation of the rules governing chaining.
• A call will not be chained if:-
• It’s tramped
• In a group (unless it is a frequency group and ChainByFrequency=YES)
• Has an attached sequence number
• Is part of a frequency chain (unless ChainByFrequency=YES)
Orders in a chain must have the same values
• Priority (can be overridden with ChainByPriority)
• Task type (i.e. collection / delivery), in some versions this is not the case
• Same time windows
• Book day/time
• Zone
• Vehicle bans or preferences (can be overridden with ChainByVehicle)
• Depot group bans or preferences (can be overridden with
ChainByDepotGroup)
• Specific depot i.e. PrefDep
• Same trip Position value, i.e. first, last, anywhere
• Same Frequency value (only if ChainByFrequency=YES)
Acceptable warnings created by auto
Waiting time warning
The rule Max waiting time value is only a warning. It is possible for auto to create a
route, where waiting time must exceed the maximum. For example, the depot closes
at 08:00 and doesn’t reopen until 16:30, there is a single order to be delivered 14:00,
the travel time t the order is 30 minutes, Max wait is at it’s default 300 minutes.
The vehicle leaves the depot at 08:00, travels for 30 minutes, and cannot get into the
call for 330 minutes. This has to be allowable as Priority jobs often have strict time
windows. The insertion of the lower / subsequent jobs may utilise this waiting time.
In a scenario where the warning is not breakable, Priority jobs will be rejected in
preference to lower priority, but more flexible orders.
Document : PLINI settings 48.doc Page 52 Dated : 16/03/2020
Parameter dependencies
Within LogiX, certain settings are dependant on other settings, the following are
examples
Date display AutoControl 3
Depot Satellites Dynamic Depots
Depot Stock ProductTypes
Depot throughput Multiple Route Evaluation
Import based Matrix building Usage of a Y cache database
Loading Bays Multiple Route Evaluation
ObeyLiFo Tramping
Resourcing AutoControl 3
UsePlanningDates Resourcing
UserTankFiles Tankers
DepotSwapFactor Territory
Parameter relationships Within LogiX certain settings force others to specific values
ALMapQDetail Consolidation at least 2 (user can set it higher)
Loading bays Extend opening = no
SynchronisedOrders Extend opening = no
Tankers Product types = yes
Tankers Reuse on empty = no
Unattended working Breaks in work on
Unlimited Chains BreakChains = no
Document : PLINI settings 48.doc Page 53 Dated : 16/03/2020
Parameter incompatibility
Within LogiX, certain settings are mutually exclusive, the following are examples
AutoControl mode 3 Free fleet
Break chains Unlimited chains
Dynamic Depots Vehicles by Trip (trailer swapping)
Group Deviation
GroupFrequency Standard Grouping
GroupFrequency Chaining
GroupFrequency Obey Sequence
Loading Bays Extend Opening
SynchronisedOrders Extend Opening
Position on trip Position on vehicle
SetRouteZones Free fleet scheduling
SetRouteZones Vehicle swapping
Time Zones Tidal Flow
Tramping Tankers