oracle€¦ · copyright © 2000, 2010, oracle. all rights reserved copyright © 2000, 2010,...

Oracle Real-Time Scheduler 1.13.2

Planner 10.5

System ManualRevision 1.0

July 2010

Oracle_logo.png

Copyright © 2000, 2010, Oracle. All rights reserved

Copyright © 2000, 2010, Oracle. All rights reserved.

The Programs (which include both the software and documentation) contain proprietary information; they are provided under a license agreement containing restrictions on use and disclosure and are also protected by copyright, patent, and other intellectual and industrial property laws. Reverse engineering, disassembly, or decompilation of the Pro-grams, except to the extent required to obtain interoperability with other independently created software or as specified by law, is prohibited.

The information contained in this document is subject to change without notice. If you find any problems in the documentation, please report them to us in writing. This document is not warranted to be error-free. Except as may be expressly permitted in your license agreement for these Programs, no part of these Programs may be reproduced or transmit-ted in any form or by any means, electronic or mechanical, for any purpose.

If the Programs are delivered to the United States Government or anyone licensing or using the Programs on behalf of the United States Government, the following notice is applicable:

U.S. GOVERNMENT RIGHTSPrograms, software, databases, and related documentation and technical data delivered to U.S. Government customers are “commercial computer software” or “commercial tech-nical data” pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication, disclosure, modification, and adapta-tion of the Programs, including documentation and technical data, shall be subject to the licensing restrictions set forth in the applicable Oracle license agreement, and, to the extent applicable, the additional rights set forth in FAR 52.227-19, Commercial Computer Software--Restricted Rights (June 1987). Oracle USA, Inc., 500 Oracle Parkway, Red-wood City, CA 94065.

The Programs are developed for general use in a variety of information management applications. They are not developed or intended for use in any inherently dangerous applications including applications which may create a risk of personal injury. If you use the Programs in dangerous applications, then you shall be responsible to take all appropri-ate fail-safe, backup, redundancy and other measures to ensure the safe use of the Pro-grams. Oracle disclaims any liability for any damages caused by use of the Programs in dangerous applications.

The Programs may provide links to Web sites and access to content, products, and ser-vices from third parties. Oracle is not responsible for the availability of, or any content pro-vided on, third-party Web sites. You bear all risks associated with the use of such content. If you choose to purchase any products or services from a third party, the relationship is directly between you and the third party. Oracle is not responsible for: (a) the quality of third-party products or services; or (b) fulfilling any of the terms of the agreement with the third party, including delivery of products or services and warranty obligations related to purchased products or services. Oracle is not responsible for any loss or damage of any sort that you may incur from dealing with any third party.

Oracle, JD Edwards, PeopleSoft, and Siebel are registered trademarks of Oracle Corpora-tion and/or its affiliates. Other names may be trademarks of their respective owners.

Table of Contents

Chapter 1: Introduction .................................................................... 1

1.1 How To Use This Manual........................................................... 3

1.2 Glossary........................................................................................ 41.2.1 System................................................................................... 4

1.2.1.1 Processes....................................................................... 41.2.1.2 Related Terms................................................................ 5

1.2.2 Data Storage and Transfer .................................................... 51.2.3 Planner Objects ..................................................................... 51.2.4 Operations ............................................................................. 71.2.5 Host system Processes ......................................................... 81.2.6 Miscellaneous Terms............................................................. 8

1.3 Hardware ...................................................................................... 91.3.1 Supported Architectures ........................................................ 91.3.2 Main Memory Requirements.................................................. 91.3.3 Disk Space Requirements ..................................................... 91.3.4 Display Requirements............................................................ 9

1.4 Typical Planner System Schematic.......................................... 101.4.1 Basic Planner architecture..................................................... 101.4.2 Planner Architecture for multiple regions............................... 111.4.3 Advanced Planner Architecture ............................................. 121.4.4 Planner Architecture with GuiServer...................................... 131.4.5 Planner Architecture with Switch ........................................... 13

Chapter 2: Setup................................................................................... 1

2.1 Setting Up the Users................................................................... 2

2.2 Maps.............................................................................................. 32.2.1 Using the New Map ............................................................... 32.2.2 Raster Map ............................................................................ 4

Copyright © 2000, 2010, Oracle. All rights reserved - i

Planner 10.5 System Manual

2.3 Adding Allocator Users ...............................................................52.3.1 Modify .cshrc File ...................................................................52.3.2 Copy Customized Layout .......................................................5

2.4 Planner Config files .....................................................................62.4.1 Typical settings in the dtmrc file with sample values..............62.4.2 Copy Planner Runtime Templates .........................................8

2.5 Setting up User access Control .................................................92.5.1 User Access Groups ..............................................................9

2.5.1.1 The UAG File Format......................................................92.5.2 User Access File ....................................................................11

2.5.2.1 Creating User Access File ..............................................112.5.2.2 User Access File format..................................................122.5.2.3 Useful arguments with the "plannerPasswd" utility .........122.5.2.4 Enforcing the change of temporary passwords at first logon13

2.6 Setting up GuiServer ...................................................................142.6.1 Configuring GuiServer............................................................142.6.2 GUI Server functions ..............................................................142.6.3 GUI Server operations............................................................142.6.4 plannerClient Request Handling.............................................15

2.6.4.1 plannerClient Connection Initiation .................................152.6.4.2 SYNC_PLAN Handling ...................................................16

2.7 Setting up Print Manifest Server................................................182.7.1 Configuring Print Manifest Server ..........................................18

2.7.1.1 General Configuration.....................................................182.7.1.2 Manifest Layout Configuration ........................................182.7.1.3 Data Input to the Print Manifest Server...........................192.7.1.4 Data Output from the Print Manifest Server....................192.7.1.5 Error Generation .............................................................19

2.7.2 Printed Manifests....................................................................202.4.1 Print Request Process............................................................20

Chapter 3: Running Planner ..........................................................1

3.1 The Planner 10.5 processes ......................................................2

3.2 Preparing the Planner Config Files ...........................................43.2.1 Set Planner Version ...............................................................4

3.2.1.1 What to Change? ............................................................43.2.2 Set PlannerClient/GUI Display ...............................................5

3.2.2.1 What to Change? ............................................................53.2.3 Set Planner Map Names ........................................................5

3.2.3.1 What to Change? ............................................................53.2.4 Set Planner GUI Layout Path .................................................5

3.2.4.1 What to Change/Add?.....................................................53.2.5 Set Planner User Access Control...........................................5

3.2.5.1 What to Change? ............................................................53.2.6 Set Planner Turn-by-Turn values ...........................................6

3.2.6.1 What to Change/Add?.....................................................63.2.7 Set Print Manifest Server parameters ....................................7

3.2.7.1 What to Change? ............................................................73.2.8 Set GuiServer parameters......................................................8

Copyright © 2000, 2010, Oracle. All rights reserved - ii

System Manual Planner 10.5

3.2.8.1 What to Change? ........................................................... 83.2.9 Set Planner system logging details........................................ 9

3.2.9.1 What to Change/Add? .................................................... 93.2.10 Set Planner Periodic Schedule Backups ............................. 11

3.2.10.1 What to Change/Add? .................................................. 113.2.11 Set Planner Runtime Configuration ..................................... 11

3.2.11.1 What to Change/Add? .................................................. 113.2.12 Set launchPlanner (nmcConfig) Runtime Configuration ...... 12

3.3 Starting Planner ........................................................................... 133.3.1 Starting smauto...................................................................... 133.3.2 Starting GUI ........................................................................... 133.3.3 Starting smauto and GUI at once .......................................... 133.3.4 Starting GuiServer ................................................................. 143.3.5 Starting the Print Manifest Server.......................................... 14

3.4 Stopping Planner ......................................................................... 153.4.1 Shut Down Planner GUI ........................................................ 153.4.2 Shut Down Other Planner Processes .................................... 15

Chapter 4: Running Planner with Switch .............................. 1

4.1 Planner System Architecture based on Switch ...................... 34.1.1 Functionalities supported by Planner Switch ......................... 34.1.2 Standard method of operating Planner with Switch............... 4

4.2 Preparing the Planner Config Files .......................................... 54.2.1 Set Planner/GUI Version ....................................................... 54.2.2 Set Planner Map Names........................................................ 54.2.3 Set Planner GUI Layout Path ................................................ 54.2.4 Set Planner User Access Control .......................................... 54.2.5 Set Planner Turn-by-Turn values........................................... 54.2.6 Set Planner Print Manifest Server parameters ...................... 54.2.7 Set Planner GuiServer parameters........................................ 64.2.8 Set Planner system logging details........................................ 64.2.9 Set Planner Periodic Schedule Backups ............................... 74.2.10 Set Planner Runtime Configuration ..................................... 7

4.2.10.1 What to Change/Add? .................................................. 74.2.11 Set launchPlanner (nmcConfig) Runtime Configuration ...... 8

4.3 Starting Planner ........................................................................... 94.3.1 Steps to execute Planner processes ..................................... 9

4.3.1.1 Running all Planner processes on a single machine...... 94.3.1.2 Running Planner processes on different machines ........ 11

4.4 Stopping Planner ......................................................................... 124.4.1 Shut Down Planner GUI ........................................................ 124.4.2 Shut Down Other Planner Processes .................................... 124.4.3 Shut Down Planner Switch .................................................... 12

4.5 Planner FailOver Technique...................................................... 134.5.0.1 A new Job will travel as follows: ..................................... 13

4.5.1 Planner FailOver Sequences................................................. 134.5.1.1 Slot-generator failure ...................................................... 134.5.1.2 Scheduler failure ............................................................ 14

- iii Copyright © 2000, 2010, Oracle. All rights reserved


4.5.1.3 Switch failure...................................................................144.5.1.4 Data Interface failure.......................................................154.5.1.5 Database backup process failure....................................154.5.1.6 Crash Recovery / initialisation.........................................16

Chapter 5: Running Planner from Launch Pad..................1

5.1 Introduction ...................................................................................2

5.2 Starting Planner from Launch Pad............................................35.2.1 Configuring LaunchPad to run GuiServer ..............................35.2.2 Main Display area...................................................................4

5.2.2.1 Configuration and Version selection ...............................45.2.2.2 Mode selection................................................................45.2.2.3 Process Start buttons......................................................5

5.2.3 Setup Mode ............................................................................55.2.4 Edit Mode ...............................................................................5

5.2.4.1 LaunchPad Configuration Categories .............................65.2.4.2 Control buttons................................................................7

5.2.5 Process Mode ........................................................................85.2.5.1 Stopping Planner from the LaunchPad ...........................8

5.3 Switch Configuration ...................................................................95.3.1 General Switch Configuration.................................................95.3.2 Switch to Switch .....................................................................95.3.3 Switch Connections................................................................9

5.4 Site Configuration ........................................................................115.4.1 General Site Configuration .....................................................115.4.2 Map ........................................................................................11

5.4.2.1 Advanced Mapping .........................................................11

5.5 Configuring Scheduling Parameters .........................................135.5.1 Slot Generation Controls ........................................................135.5.2 Schedule Costs ......................................................................13

5.5.2.1 Service Costs..................................................................135.5.2.2 Running Costs ................................................................175.5.2.3 Run Costs .......................................................................195.5.2.4 Round Costs ...................................................................205.5.2.5 Depot Costs ....................................................................215.5.2.6 Business Priorities ..........................................................225.5.2.7 Conditional Assignment ..................................................285.5.2.8 Attribute Conflicts............................................................315.5.2.9 Apex Costs......................................................................33

5.5.3 Real Time...............................................................................345.5.3.1 Reference Time ..............................................................355.5.3.2 Dispatch Message ..........................................................36

5.5.4 Optimiser Controls..................................................................365.5.4.1 TSP .................................................................................375.5.4.2 Shuffler Controls .............................................................375.5.4.3 POU Controls..................................................................415.5.4.4 Plan Init Controls.............................................................415.5.4.5 Performance Controls .....................................................425.5.4.6 Bound Jobs .....................................................................42

Copyright © 2000, 2010, Oracle. All rights reserved - iv


5.6 GuiServer Configuration............................................................. 435.6.1 GuiServer Connections.......................................................... 43

5.7 General Administration Configuration ...................................... 445.7.1 User Access Control .............................................................. 445.7.2 Logging .................................................................................. 44

5.7.2.1 Switch Log...................................................................... 455.7.2.2 Server Log...................................................................... 455.7.2.3 GuiServer Log ................................................................ 465.7.2.4 Client Log ....................................................................... 46

5.7.3 Connection............................................................................. 475.7.3.1 Server Controls............................................................... 475.7.3.2 Client Controls ................................................................ 48

5.7.4 Client Setup ........................................................................... 485.7.5 Auto Save .............................................................................. 495.7.6 Auto Direct ............................................................................. 49

5.8 Configuring the Display .............................................................. 515.8.1 Style....................................................................................... 515.8.2 Map Display ........................................................................... 51

5.8.2.1 Raster Map..................................................................... 515.8.2.2 Map Truncation .............................................................. 525.8.2.3 Microsoft MapPoint......................................................... 525.8.2.4 OracleAS MapViewer ..................................................... 52

5.8.3 Turn-by-Turn.......................................................................... 535.8.4 Icons ...................................................................................... 535.8.5 Display Options...................................................................... 54

Appendix A:Run-time Configuration ....................................... 1

A.1 Config File Keywords ................................................................. 2A.1.1 Keywords Common to multiple Processes............................ 2

A.1.1.1 Error Translation File...................................................... 3A.1.1.2 Map configuration .......................................................... 4A.1.1.3 Hidden Map configuration .............................................. 5A.1.1.4 Advanced Map configuration.......................................... 6A.1.1.5 smauto/Client Connection Configuration........................ 8A.1.1.6 Process Logging Configuration...................................... 11A.1.1.7 Socket Buffer Configuration ........................................... 12A.1.1.8 Configuration File Location ............................................ 13A.1.1.9 General Configuration.................................................... 13

A.1.2 Scheduler (smauto) Keywords .............................................. 16A.1.2.1 Scheduler Configuration................................................. 16A.1.2.2 Advanced Mapping Configuration.................................. 17A.1.2.3 Slot Generator Configuration ......................................... 18A.1.2.4 Service Cost Configurations........................................... 20A.1.2.5 Running Cost configurations .......................................... 28A.1.2.6 Run Cost configurations................................................. 33A.1.2.7 Run Separation Cost Configuration ............................... 33A.1.2.8 Round Cost configurations............................................. 34A.1.2.9 Depot Cost configurations.............................................. 36A.1.2.10 Business Priorities configurations ................................ 38A.1.2.11 Conditional Assignment configurations........................ 49A.1.2.12 Attribute Conflicts configuration ................................... 54A.1.2.13 Apex Costs configuration ............................................. 58A.1.2.14 Real Time configuration ............................................... 60

- v Copyright © 2000, 2010, Oracle. All rights reserved


A.1.2.15 Optimiser Controls configuration ..................................65A.1.3 NMC GUI Keywords...............................................................95

A.1.3.1 plannerClient New configuration.....................................95A.1.3.2 plannerClient Logging configuration ...............................96A.1.3.3 plannerClient Connection configuration..........................97A.1.3.4 plannerClient Setup configuration ..................................98A.1.3.5 plannerClient Display configuration ................................99A.1.3.6 plannerClient Turn-by-Turn Configuration ......................104

A.1.4 Switch (plannerSwitch) Configuration Parameters ................105A.1.4.1 General Switch configuration..........................................105A.1.4.2 Switch to Switch configuration........................................106A.1.4.3 Switch connections configuration ...................................106A.1.4.4 Switch Buffer configuration.............................................108A.1.4.5 Switch Logging configuration..........................................108A.1.4.6 Hidden Switch Configuration ..........................................110

A.1.5 Print Manifest Server (manifestServer) Keywords .................110A.1.5.1 Configuration parameters Common to manifestServer and plannerClient111

A.1.6 GuiServer (plannerGuiServer) Keywords ..............................113A.1.6.1 View Filtering configuration ............................................113A.1.6.2 GuiServer Connections configuration.............................114A.1.6.3 GuiServer Buffer configuration .......................................116A.1.6.4 GuiServer Logging configuration ....................................117

Appendix B:Dynamic Working Areas ......................................1

B.1 Definition of Dynamic Work Areas............................................2

B.2 Cost Calculations using Dynamic Work Areas .......................5

Appendix C:Time Dependent Cost ............................................1

C.1 How does TDC Work?................................................................2

C.2 TDC Function...............................................................................4

C.3 Sample applications of TDC......................................................6C.3.1 Shift Promotion Cost..............................................................6C.3.2 Reserve Capacity Cost ..........................................................6

Appendix D:Shift Promotion Cost .............................................1

Appendix E: Changes ........................................................................1

E.1 Planner Configuration Changes................................................2E.1.1 Parameter changes in 10.5 since 10.4 ..................................2

E.1.1.1 Modified Parameters in 10.5 since 10.4 .........................2E.1.1.2 10.4 Parameters that have been removed from 10.5 .....2E.1.1.3 New Parameters in 10.5 since 10.4................................2

E.1.2 Parameter changes in 10.4 since 10.3 ..................................2E.1.2.1 10.3 Parameters that have been removed from 10.4 .....2E.1.2.2 New Parameters in 10.4 since 10.3................................2

Copyright © 2000, 2010, Oracle. All rights reserved - vi


E.1.2.3 Modified Parameters in 10.4 since 10.3......................... 5E.1.3 Parameter changes in 10.3 since 10.2.................................. 5

E.1.3.1 10.2 Parameters that have been removed from 10.3..... 5E.1.3.2 New Parameters in 10.3 since 10.2 ............................... 5E.1.3.3 Modified Parameters in 10.3 since 10.2......................... 7

E.1.4 Parameter changes in 10.2 since 10.1.................................. 8E.1.4.1 10.1 Parameters that have been removed from 10.2..... 8E.1.4.2 New Parameters in 10.2 since 10.1 ............................... 9E.1.4.3 Modified Parameters in 10.2 since 10.1......................... 9

E.1.5 Parameter changes in 10.1 since 10.0.................................. 11E.1.5.1 10.0 Parameters that have been removed from 10.1..... 11E.1.5.2 New Parameters in 10.1 since 10.0 ............................... 11E.1.5.3 Modified Parameters in 10.1 since 10.0......................... 11

E.1.6 Parameter changes in 10.0 since 9.2.................................... 12E.1.6.1 9.2 Parameters that have been removed from 10.0....... 12E.1.6.2 New Parameters in 10.0 since 9.2 ................................. 12E.1.6.3 Modified Parameters in 10.0 since 9.2........................... 14

E.1.7 Parameter changes in 9.2 since 9.1...................................... 14E.1.7.1 Parameters from 9.1 that are removed from 9.2 ............ 14E.1.7.2 New/Modified Parameters in 9.2 since 9.1..................... 14



E.1.10 Parameter changes in 8.3 since 8.2.................................... 16E.1.10.1 Parameters from 8.2 that are removed from 8.3.......... 16E.1.10.2 New/Modified Parameters in 8.3 since 8.2................... 17



- vii Copyright © 2000, 2010, Oracle. All rights reserved

Chapter 1: Introduction

Planner is the name of a Oracle Corporation software product that can be used to assist an Allocator to efficiently allocate loads to a fleet of vehicles for delivery to or from a number of locations.

The Oracle Corporation product described in this manual, and its companion Planner User Manual, is an efficient Scheduler designed for the transportation industry. In particular, Planner has been designed to optimise the solutions to warehouse distribution problems, to handle the problems that can arise for “Less than Truck Load” (LTL) deliveries, and to schedule courier-type operations.

The Planner Scheduler is versatile and flexible, and will allow the scheduling of job deliveries that may be composed in many different ways and which require delivery at arbitrary times, and can readily handle (in real time) delivery variations caused by weather or customer uncertainty. Planner is able to make the best possible use of the vehicles available to deliver the loads, and will specify the most appropriate vehicles for the task at hand.

Planner may be set up to incorporate the “business rules” of the enterprise, and these rules will be considered by the Scheduler to create an operating schedule which is both efficient and practical.

Work schedule solutions can be created manually using Planner (if required), but Planner is a much more powerful tool when used in automatic or semi-automatic mode because it uses an optimising process to make the best use of time and resources while still implementing any business rules specified by the operator.

The goal of Planner is to produce an operating schedule of “least total cost”.

The Planner Scheduler is at all times under the control of the Allocator(s) who can monitor the state of the schedule on a large screen display, and control the operation using easy “point and click” movements of the hand-held mouse.

The Planner display makes good use of colour and shape to convey all the required information to the Allocator(s) who can see at a glance the status of entire jobs, individual loads and vehicles. The display indicates the progress of each load from the time it is

Copyright © 2000, 2010, Oracle. All rights reserved 1 - 1


ordered until the time of delivery, and shows all relevant time marks, either predicted or actual.

The layout of the Planner display can be configured to suit the individual requirements of each Allocator.

Geographic information is displayed on a map display window that allows the display of travel path and route information, some details of geography, and the current or predicted location of the vehicles. If it is available, GPS information from the vehicles can be used to periodically update the display of vehicle position.

The following chapters will describe how to run the Planner Scheduler, and how the Allocator uses its various functions to smoothly handle the assignment of jobs between vehicles and customers.



1.1 HOW TO USE THIS MANUAL

Chapter 1: Introduction - introduces the reader to Planner, explains the layout and content of the System Manual, defines some commonly used terminology specific to Planner, illustrates the Planner system architecture and specifies the hardware, software and licensing prerequisites for executing Planner

Appendix E: Changes - outlines the system and system manual changes in Planner 10.5

Chapter 2: Setup - describes how to obtain an archive, set up users, install/upgrade/remove a release of Planner, install Maps, add users and set the user access levels. This chapter also lists the configuration files supplied with Planner.

Chapter 3: Running Planner - describes how to set up the process configuration files, how to start Planner and how to stop Planner

Chapter 4: Running Planner with Switch - describes the Planner system architecture at STY and all features as in (Chapter 3: Running Planner) with Switch. This chapter also describes the Planner FailOver method

Chapter 5: Running Planner from Launch Pad - describes the GUI tool Launch Pad, configuring and maintaining Planner, starting and stopping Planner processes from Launch Pad

Appendix A: Run-time Configuration - lists the Planner run-time configuration keywords and the corresponding range and default values generic to all processes, specific to smauto, nmcGUI and plannerSwitch

Appendix B: Dynamic Working Areas - describes Dynamic Working Areas

Appendix C: Time Dependent Cost - describes Time Dependent Cost

Appendix D: Shift Promotion Cost - describes Shift Promotion Cost

1 - 3 Copyright © 2000, 2010, Oracle. All rights reserved


1.2 GLOSSARY

1.2.1 SystemPlanner - Oracle Corporation’s Oracle Real-Time Scheduler product

component that will perform the scheduling operation.

Central -Another name for Planner.

1.2.1.1 ProcessesScheduler, smauto- The names given to the Planner sub-component which maintains

and optimizes a Schedule. Scheduler creates a schedule by recommending Job-to vehicle allocations while specifying the order in which vehicles should complete Jobs. A Scheduler may receive updates on existing Vehicles and Stores from an Allocator Any changes received, from whichever source, are broadcast to all attached Clients.

Switch, Primary Switch, plannerSwitch- The names given to the Planner sub-component which interfaces between Planner on one side, and the host system applications on the other. The Switch receives Vehicles, depots and Orders from the host system. A switch has the following tasks: - Determine which process is Scheduler, which are Slot-generators. - If necessary, promote one of the Slot-generators to Scheduler. - Alternate Slot-requests between the available Slot-generators. - Ensure no data is lost during failover. - Ensure all appropriate connecting processes are kept up to date. -Reload new Scheduler or Slot-generator.

Secondary Switch, plannerSwitch- Same as the Primary Switch, except that it is started by Primary Switch, and is kept up-to-date with all data and status information from Primary Switch at all time. It promotes itself to Primary Switch upon Switch Failover)

Slot-generator, smauto- Is same as the Planner Scheduler sub-component, but with the exception that it does not create schedules. It uses updates from the Switch to maintain an up-to-date schedule. Receives Slot requests from StY App Server, to which it responds with a number of delivery Slots via the Switch.

GUI, nmcGUI, Client, plannerClient, Display- The name given to the Planner sub-component which controls the display screen at which the Allocator works.

Launch Pad, nmcConfig, launchPlanner- Launch Pad is a graphical interface which helps in configuring and maintaining Planner. It facilitates selection of configuration files to use, version of planner to run and



modification of the configuration files. It also runs and monitors all the planner sub-components.

Print Manifest Server, ManifestServer- Is a process independent from Planner which facilitates the creation of Driver Manifests for next day deliveries, without having to run a Planner Client remotely at Depot locations.

GuiServer, plannerGuiServer- The GuiServer is a sub-component which connects as a Client either to smauto or to another GuiServer while allowing multiple PlannerClient connections to itself.

1.2.1.2 Related TermsHost System - A computer system that controls the administration of the business

enterprise.

Operator, Allocator, human scheduler- A person who will control and adjust the operation of Planner through the “Planner GUI” while optionally overriding the decisions made by “Planner Scheduler”.

Viewer -A person who may examine, but not modify, the schedule.

Schedule, solution Plan- The solution created by Planner for the problem specified.

MDTs - Mobile Data Terminals used to transmit messages to and receive messages from the driver.

1.2.2 Data Storage and TransferDatabase Table - A Table in a Relational Database Management System (RDBMS)

maintained by the Host System. The Table will be a primary source of data to be scheduled and which can receive the scheduling solution(s) created by Planner.

Hip File - A file in ASCII format, local to Planner that can be used to store intermediate or temporary scheduling solutions. These files can be reloaded. (See HIP below)

HIP - Host Interface Protocol. An ASCII communications protocol between Planner sub-components.

IDB - Internal Database. A memory resident data repository within Planner containing the state of the schedule as presented to the user.

Plan - The data set to be scheduled.

1.2.3 Planner ObjectsDepot - A place where goods are stored in bulk.



Depot Time Window- One or more time intervals during which the depot allows access to resources.

Product_Depot -details the available product and its capacity (in units) for a depot

Resource - A combination of Driver and Vehicle that will be controlled by Planner.

Vehicle - A load-carrying transporter known to Planner.

Shift - A combination of a Resource and a time period of availability. Goods may remain on Resources between Shifts.

Haul - A number of consecutive shifts to be executed by the same resource. Consecutive Shifts are connected by a parameter which is carried forward from one Shift into the next shift.

Stop - A place to be visited by a Resource. The visit may involve a Collection or Distribution. Special types of Stop are Depot, Logon, Logoff, and Break.

Stop Time Window- One or more time intervals during which the stop should be completed.

Break - Breaks represent rest periods for the driver. They are inserted at a specified time for a specified interval within a tour based on the break information provided initially to the Planner Scheduler

Job - One or more Stops grouped for transportation purposes. All the Stops in the Job must be completed by the same Resource.

Object - A collection of data representing a “real” concept, e.g., Stop, Depot, Resource.

Group - A number of Jobs grouped into a larger unit. Once a number of Jobs have been grouped, Scheduler can manipulate all Jobs in the Group in a single operation. Any single Job that has not been explicitly grouped is considered to be the only member of its own Group, that is, all “group” operations will apply to this Job

Route - Another name for “Haul”.

Trip, Tour - Consists of all the work being done by a Resource between log-on and log-off.

Real Object - An object for which there exists a packet representing all attributes, for example, a Stop, a Resource.

Virtual Object - An object constructed from more than one “Real Object”, for example, a Run, Haul or Group.

Run -Loading at depot, departure and subsequent delivery of all Jobs loaded. In other words a Run consists of a Depot Stop and all Stops for which goods are either collected from or dropped at the Depot Stop.

Run Area -Run Area is the diagonal measure estimated by Planner for a Run.



Run End Area -Run End Area is the rectangular geographic area estimated by Planner with the last stop of a Run at its geographic centre. The diagonal of the Run End Area measures the same as the Run’s Run Area. See definition for Run Area on page 8.

Closed Run -A run on which only manual operations are possible, i.e. Scheduler cannot change the set of Jobs associated with the run, nor can a Slot-generator suggest Slots that require a Job to be inserted into this run.

run-duration -On-board time of the last delivery of a run.

on-board time -The time between departure from the depot and the latest of arrival at the delivery address or start of the delivery time-window.

Slot -A pre-determined time window during which a delivery/pick-up can take place. Generally a day is subdivided into a number of delivery slots.

Remaining Capacity-The number of deliveries that may still be booked for a depot/day before the maximum capacity is reached.

Region -The geographical area covered by StY is subdivided in a number (4) of independent regions for scheduling purposes. Each of these regions is defined by the Depots assigned to it.

Foreign Region - A Region which is not the Region handled by the sub-component or Allocator, performing the action.

depot capacity - The maximum capacity in terms of weight or volume that can be collected at or distributed from a Depot within a specific Depot Time Window.

Foreign depot - A depot which is not the depot handled by the sub-component or Allocator performing the action.

1.2.4 OperationsAllocate - A Job is Allocated when it has been scheduled for a Haul or a Shift,

and Planner has been restricted from removing this Job from the Haul or Shift.

Assign - A Job is Assigned when it has been scheduled for a Haul or a Shift, but Planner is not restricted from removing this Job from the Haul or Shift.

Close - A Run consisting of a number of Allocated Stops and a Depot Stop Run is Closed which implies Planner cannot insert, delete or reassign any of the Stops in the Run.



1.2.5 Host system ProcessesData Interface - Consists of one or more process which can do the following:

-handles interaction with the customer, and communicates with Planner through a GateWay. Provides Planner with Jobs and Slot-requests. Receives requested Slots from Planner. Blue Martini does not have a persistent data-repository. It is therefore of paramount importance that failover and crash recovery are 100% reliable. -maintains details about Vehicles and Depots. Provides Planner (through GateWay) with information about Vehicles and Depot, including real-time updates received from the field.

Gateway - An interface process between the host system and Planner.

Database backup processes- reloads Planner with the data needed within the operational window, either at initial start-up, or after a total failure. - loads Planner with data to define the next day available for Job slots/scheduling, i.e. today + 21 days. - acts as an interface to the non volatile storage system. Maintains all Jobs and the plan data associated with them. Receives updates to the current state of the schedule from Planner, storing them in a database, where it can be retrieved by other Database backup processes.

1.2.6 Miscellaneous TermsList - String containing a comma-separated set of object identifiers, e.g.

“RED,WHITE,BLUE”.

Partial Specification-Partly specifies a selection, with the expectation that the recipient will return a list of matching complete specifications.

Synchronized -Two processes are “synchronized” when they represent the same version of the contents of some “data repository”.

FailOver - The process of recovery from a partial failure. The system can be restored to its original functionality, without loss of data, with minimal downtime.

Crash Recovery - The process of recovering from a total failure. The system must be fully reloaded from stored back-up data. Loss of data is likely.

Catastrophic Failure- Any failure FailOver cannot reliably cope with. A Catastrophic Failure requires a complete re-initialisation of the system, followed by a complete reload of data by DBLoad.

Not Implemented -Not Implemented.



1.3 HARDWARE

The following minimum specifications are a general recommendation for the execution of Planner.The following minimum specifications are a general recommendation for the execution of Planner, however they may need to be varied depending on the nature and size of the scheduling problems to be solved, and the desired time period in which a solution must be achieved.

It is recommended that hardware specification is determined on a site specific basis. The hardware requirements depend on volumes of work, processing speed, scheduling area and many other factors. Please consult Oracle Corporation for a detailed hardware specification to meet the operating requirements.

1.3.1 Supported Architectures• Oracle Enterprise Linux 5 x86 (32/64 bit)• Red Hat Enterprise Linux 5 x86 (32/64 bit)• Solaris 9/10 SPARC• Solaris 10 x86 (64 bit)• Windows Server 2003 x86

1.3.2 Main Memory Requirements• 4Gb

1.3.3 Disk Space Requirements• 2Gb

1.3.4 Display Requirements• 20” ‘X Terminal’ display



1.4 TYPICAL PLANNER SYSTEM SCHEMATIC

1.4.1 Basic Planner architecturePlanner is made up of several independent software modules.

• Scheduler - process name smauto - compares the relative (notional) cost of all possible solutions.

• Display - process name GUI or nmcGUI - a Graphical User Interface that handles all screen display, keyboard and mouse activity.

• MDT’s - Mobile Data Terminals to send messages to and receive messages from drivers/vehicles.

These 3 processes communicate with the host system via• Gateway - a module that interfaces with a host system database.

MDT’s

Gateway

HostRDBMS

Scheduler

Display

Host System

Planner

(smauto)

(GUI, nmcGUI)



1.4.2 Planner Architecture for multiple regionsIf more than one geographical region is to be scheduled from the same installation and hardware, then the installation would be:

Gateway

HostRDBMS.

Scheduler

Scheduler

Display

(smauto)

(smauto)

(GUI, Client)

Display(GUI, Client)



1.4.3 Advanced Planner Architecture Other configurations are possible. They will depend on the capabilities of the Host and Planner computer systems, computer architecture requirements and differences. They will also be determined by factors such as total number of Stops to be scheduled, logical divisions that may exist within the scheduling task, the geographic distribution of the Planner installations, and many other such factors.

In implementations, where there are several Planner installations being serviced interactively from the same Host system database, it may be preferable to employ multiple Gateway interfaces to ensure that the rate of communication with Planner is not slowed down by the additional message processing that would be required if only one Gateway is used. This would need to be balanced against the additional software maintenance that would be required for the additional Gateway modules and database tables.

Multiple Gateway processes can also be used as a simple way to physically separate two different scheduling tasks for administrative reasons.

Gateway(optional)

HostRDBMS

e.g.ORACLE

Scheduler

Display

Scheduler

Display

Gateway(optional)

Planner

Planner

Host System

MDT



1.4.4 Planner Architecture with GuiServerIn situations where multiple PlannerClients require connection to smauto, a GuiServer is essential to minimise the network traffic across WAN’s and to reduce the load on smauto.

A GuiServer connects to smauto as a normal client and also accepts connections from Clients and essentially act as smauto. Messages are passed through from Clients to smauto and vice versa.

1.4.5 Planner Architecture with SwitchWhen more than one geographical region is to be scheduled from different installation and hardware, then another Planner process Switch comes into the scene.The Switch is the interface between Planner smauto processes on one side and the Host system on the other side. The processes involved in this type of architecture are:• Scheduler - process name smauto - compares the relative (notional) cost of all

possible solutions and creates the best solution. • Slot-generator - process name smauto - services slot requests.• Display - process name GUI or nmcGUI - a Graphical User Interface that

handles all screen display, keyboard and mouse activity.• Switch - process name plannerSwitch - acts as interface between Planner

smauto process and the host system. The Switch interacts with the host system optionally through a Gateway.

• Gateway - an optional module that interfaces with a Host System Database.

MDT’s

Gateway(optional)

HostRDBMS

Scheduler

Display

Host System Planner

(smauto)

(GUI, nmcGUI)

e.g.ORACLE

GUIServer



The Switch is the interface between all smauto processes and the Gateway.

GUI

smauto

Scheduler

Scheduler

primaryswitch-1

primaryswitch-2

secondaryswitch-1

secondaryswitch-2

Gateway

HostRDBMS

smauto

GUI

*S-g1

S-g2

S-g3

*S-g1

S-g2

S-g3

* S-g = Slot-generator

Host System Planner


Chapter 2: Setup

This chapter describes the steps for setting up Planner.



2.1 SETTING UP THE USERS

Before installing the ORS Component - Planner, the system administrator must set up some UNIX user accounts on all the computers that will participate in the execution of Planner.

The users for Planner will usually consist of two types of users:

1. Allocator UsersThe Allocator Users are the ones who run the Planner “Display” process, and sit at the display screens and control the scheduling.Because Planner may allow each user of the Display process (i.e. the Allocator’s screen display) to store individual preferences for the display configuration, these users may need their own separate home directories. In some cases they will each exist separately on different computers.

2. A Site-Manager User (usually called planner) The Site-Manager user controls the parameters of the background Planner processes.

Both the Site-Manager user and the Allocator user must be set up by the System Administrator to have the following properties: • a user name - must be unique. • a home directory - in any convenient location. • an environment - “C Shell” or equivalent.

Now, choose a suitable partition on which Planner will be installed, and install the initial release of Planner as described in the accompanying document ERS-1.11.0.0-Installation-Unix-v1.1.pdf.

After Planner is installed, the Allocator users that have just been created will need some information about the release before they can run and use Planner. Please see “2.3 Adding Allocator Users” on page 2 - 5.



2.2 MAPS

Maps are essential for the running of Planner sub-components. The name of the map file will indicate the geographical region covered by the map. For example, a map file called:

melbourne_suburbs.mal

indicates that it covers the CBD (Central Business District) and greater metropolis of Melbourne. The actual map file name will follow the format of:

<<Map Name>>.mal

The .mal files are generated using Oracle Real-Time Scheduler’s Map Editing Component Map Editor. Please refer to the associated Map Editor documentation for Map Editor operations.

If the "implementation team" does not install the map(s), or Oracle Corporation technical support is not available, the instructions that follow will allow the map(s) to be properly installed.

1. Go to the DATA directory of Planner. cd INSTALL_POINT/Planner/DATA <return>

2. If a map already exists in the directory, then you must move it to a backup that can be reused if the new map fails. mv <mapname>.<extension> <mapname>.<extension>.bak <return>

3. Procure the new map from the Map-provider and place it under: INSTALL_POINT/Planner/DATA

2.2.1 Using the New MapTo test the new map, and build the matrix:

1. Log-in as user planner. 2. Run Planner using the command:

runsmauto <return>

This will load and test the map, building the matrix at the same time. In the course of execution, the output may contain one error message that can be ignored:

“System Error 2 - No such file ....”

DATA

<mapname>.<extension> <mapname>.<extension>.bak



which just means that the matrix does not already exist (as we would expect). All other error messages must be regarded as failures.

When the matrix has been built, discard the smauto process by going to the shell window and type the command:

<Ctrl>-C

which means a) hold down the <Ctrl> key on the keyboardb) Strike the <C> keyc) release the <Ctrl> key.

The process will stop execution.

2.2.2 Raster MapRaster maps can be optionally used to create a graphical representation of the roads and streets on the plannerClient. Of the many files that are involved in raster maps, there are two that are required to create the raster maps:

<file name>.map & <file name>.tif

The number of total files required will depend on the area to be covered and the level of detail required/provided.

1. Create a new directory called RMAPS under the Planner installation tree to store the Raster maps. cd INSTALL_POINT/Planner/DATA/RMAPS <return>

2. Go to the RMAPS directory of Planner. cd INSTALL_POINT/Planner/DATA/RMAPS <return>

3. If Raster maps already exists in the directory, then these should be backed up using the raster map vendor’s recommendations. The backed up maps can be reused if the new raster maps fail.mv <mapname>.<extension> <mapname>.<extension>.bak <return>

4. Procure the new Raster maps from the Map-provider and place it under:

INSTALL_POINT/Planner/DATA/RMAPS

The RMAPS directory structure should now look like this:

RMAPS

<mapname>.<extension> <mapname>.<extension>.bak <mapname>.tgz



2.3 ADDING ALLOCATOR USERS

This task is performed by the Site-Manager user (usually called planner).

From time to time, new Allocator users will be added to the computer system(s) on which Planner is installed. These users must first be set up with UNIX user accounts as previously described. Also see “2.1 Setting Up the Users” on page 2 - 2.

If the users are to be Allocator users i.e. able to run Planner, they must know where Planner has been installed. This information is provided in a set of files that must reside in each Allocator user’s home directory, and must be set up for each user.

2.3.1 Modify .cshrc FileWhile logged-in as the Site-Manager user (usually called planner), use a text editor to add the following lines to the “.cshrc” file in the home directory of each new user, so that the application display is always set to the users host computer display and the System Variable “DTMPROD” is set to the disk location of the Oracle Corporation products:

setenv DISPLAY user_hostcomputername:0 setenv DTMPROD INSTALL_POINT/Planner source $DTMPROD/etc/dtmrc

Next time the user logs-on, the Planner software will be executable.

2.3.2 Copy Customized LayoutIf the system administrator has set up a customised screen layout that is different to the default layout set for Planner, then the file containing the layout must be copied by the site-manager to the new user’s home directory now.

For example, if a special screen layout has been devised for training purposes, and is stored in the site-manager’s home directory, then copy the file using the commands:

cd ~ <Return>

cp training.Layout <new user home directory>/.plannerLayout <Return>

When the new user logs on and runs Planner, the contents of the new file “.plannerLayout” will override the default screen layout values installed with Planner.

This layout is only applicable to the standard GUI.



2.4 PLANNER CONFIG FILES

All Planner configuration files are located under "INSTALL_POINT/Planner/RELEASES/PLANNER_VERSION/rsc" directory. Please see the accompanying document ERS-1.11.0.0-Installation-Unix-v1.1.pdf to be familiar with the Planner installation directory structure.

Oracle Corporation supplies the following configuration files with each Planner release:

1. dtmrc - specifies the Planner version being used and sets the PATH to the various files and directories under the installation directory.

2. config.Planner - contains the default system configuration parameters. See (Appendix A: Run-time Configuration) for a full listing of Planner configuration parameters.

3. site.config.Planner - has provision to include site/user specific configuration values which will override the default configuration values in config.Planner.

4. planner.config - contains the default configuration values specified by Oracle for use by processes originating from Launchpad.

5. default.lyt, default.realtime.lyt, default.LowRes.lyt,dmc_default.lyt - are layout files specified by Oracle Corporation for Planner GUI and DataManager displays. See companion Planner User Manual for creating and saving user specific Layout settings.

6. brit.tr, us.tr - are Language translation files supplied by Oracle Corporation for use with Planner.

7. user_access_groups - contains the default user access groups specified by Oracle Corporation. See the accompanying Planner host interface manual for more details on the default User Access Groups.

Note: Unless specified explicitly in the site.config.Planner file Planner will use the default Layout and translation files specified in the config.Planner or planner.config.

Warning: The contents of config.Planner, planner.config, user_access_groups, *.lyt and *.tr must not be tampered with. See “2.4.2 Copy Planner Runtime Templates” on page 2 - 8 before applying any changes to the dtmrc and site.config.Planner files.

2.4.1 Typical settings in the dtmrc file with sample valuesExtract from a sample dtmrc file is illustrated below. Lines beginning with ’#’ are comments and are ignored by all processes. Lines beginning with "setenv" assign values to environment variables used by Planner processes.

setenv PLANNER_VERSIONS 3

setenv PLANNER_1 planner-10.0.0





setenv CURRENT_PLANNER $PLANNER_3

#DTMPROD must be set in the user’s .cshrc file

set planner_current = $DTMPROD/RELEASES/$CURRENT_PLANNER

setenv PLAN_RSC $planner_current/rsc

setenv PLAN_BIN $planner_current/bin

setenv PLAN_ARCH_BIN $planner_current/bin/$ARCHITECTURE

setenv PLAN_LIB $planner_current/lib

setenv PLAN_ETC $DTMPROD/etc

setenv PLAN_DATA $DTMPROD/DATA

setenv PLAN_LOG $DTMPROD/LOG/smauto

setenv PLAN_GEN_CFG $PLAN_RSC/config.Planner

setenv PLAN_SITE_CFG $DTMPROD/etc/site.config.Planner

#

# maintain set-up:

# these pairs define the running processes and the correct host machine

#

#setenv PLAN_PROCS "smauto"

#setenv PLAN_HOSTS "none"

# Put $PLAN_BIN first in path to avoid old stray planner commands

setenv PATH ${PLAN_BIN}:${PLAN_ARCH_BIN}:$PATH



2.4.2 Copy Planner Runtime TemplatesBefore Planner can be executed, the runtime configuration of Planner must be set by adjusting the contents of the dtmrc and <site>.config.Planner files to show which computers will run which processes.

Copy the dtmrc and site.config.Planner file templates to the etc directory of the release.cd INSTALL_POINT/Planner <return> cp RELEASES/planner-10.2.0/rsc/dtmrc etc <return> cp RELEASES/planner-10.2.0/rsc/site.config.Planner etc <return> cd etc <return> chmod 664 dtmrc <return> chmod 664 site.config.Planner <return>

For information on setting up dtmrc and site.config.Planner see Chapter 3: Running Planner and Chapter 4: Running Planner with Switch.



2.5 SETTING UP USER ACCESS CONTROL

When Planner is installed, there are no restrictions placed on its functionality. The site manager can restrict the availability of specific Planner operations by setting up appropriate User Access levels for different users.

2.5.1 User Access GroupsThe User Access Group (UAG) file consists of user defined Access Groups. smauto identifies the UAG file from the PLAN_ACC_GROUP_FILE configuration parameter setting. This file is read at startup by smauto, once and only once. To acknowledge changes made to the UAG file after startup, smauto must be restarted. Oracle Corporation provides a default UAG file with every Planner release. Please refer the companion Planner Host Interface manual to view the contents of the default UAG file.

The default UAG file can be copied under the ’etc’ directory (see “2.4.1 Typical settings in the dtmrc file with sample values” on page 2 - 6) of the machine running the Planner server process. Any number of user defined groups can then be appended to this copied file.

2.5.1.1 The UAG File FormatThe UAG file can have multiple entries in the following format:

group <unique group name>

{

# One or more of inherit statements, such that the group being # inherited from must be defined before this group

inherit <name of already defined group, from which to inherit>

# One or more of allow/deny statements

allow <operation>

deny <operation>

}

2.5.1.1.1 Do and Don’ts of creating User Access GroupsThe User Access Groups file specifies the operations that are to be allowed, or denied, for each User Access Group.• Each operation has a unique name associated with it, which is used to explicitly allow or

deny the use of the operation for a User Access Group.• The configuration of a User Access Group can be inherited into another User Access

Group for further configuration.



• A special operation name ALL can be used in conjunction with either an allow or deny to shortcut the configuration of the User Access Groups.

• Only a single instance of ALL is allowed in any User Access Group, including any inherited Groups.

• Only a single instance of an operation is permitted in any User Access Group specification and multiple definitions will result in the operation being denied.

• User Access Groups which inherit from other Groups are allowed to override an entry in the inherited Group.

2.5.1.1.2 A sample UAG Configuration# ALLOCATOR is only allowed to Assign or Allocate Jobs and Close # Shifts

# all other operations are denied

group ALLOCATOR

{

deny ALL

allow JOB_ASSIGN,JOB_ALLOC

allow SHIFT_CLOSE

}

# SYS_ADMIN is allowed access to all operations, except Resetting # the Plan

group SYS_ADMIN

{

allow ALL

deny RESET_PLAN

}

# OPERATOR has the same permissions as ALLOCATOR with the

# addition of being allowed to start and stop the Optimiser

group OPERATOR

{

inherit ALLOCATOR

allow SCHED_START,SCHED_STOP

}

Warning: If the "allow ALL" is not used, an implicit "deny ALL" will be added to the user access group, so that any operation not explicit allowed in the specification will be denied. If "allow ALL" and "deny ALL" appears in the same User Access Group, the



group is inconsistent and an error message will be issued. The "deny ALL" will be used in this case. If an operation appears both in the "allow" and "deny" fields, then an error message will be issued. The operation will be denied in this case.

2.5.2 User Access FileTo implement different user access levels, a ’user access file’ with an appropriate name must be created in the ’etc’ directory (See $PLAN_ETC under “2.4.1 Typical settings in the dtmrc file with sample values” on page 2 - 6) of the machine running the Planner server process.

At run-time Planner validates the username/password and authorises appropriate access to the user. The contents of User Access Control file can be modified at run-time, so that all future Client connections can be effected with the new access levels. All existing connections retain their access levels till the termination of connection. Planner need not be restarted to incorporate changes made to the ’user access file’.

2.5.2.1 Creating User Access FileThe User Access File can be easily created by the System Administrator or site manager using the "Planner User Access File editor" utility plannerPasswd.

The following steps will illustrate the procedure to create a User Access File using plannerPasswd:1. Invoke the "Planner User Access File editor" utility by typing:

plannerPasswd -[option] [Argument]=[Argument Value] <return> For example: plannerPasswd -a accessGroupFile=<$PLAN_ETC/AccessGroup_File> passwdFile=<$PLAN_ETC/AccessPassword_File> <return>

The accessGroupFile argument is the path and name of the User Access Group file that defines the "Access Levels" and the passwdFile argument is the path and name of the password file to be created or edited. Both these arguments must be specified explicitly if not already specified in the run time configuration file (See “3.2.5 Set Planner User Access Control” on page 3 - 5). Also see “2.5.2.3 Useful arguments with the "plannerPasswd" utility” on page 2 - 12.2. At the resulting "Enter User Name:" prompt,

type a user name followed by <return>

3. At the resulting "Enter password:" prompt, type a valid password followed by <return>

The password must have minimum 8 alphanumeric characters to be accepted by the system.4. At the resulting "Repeat password:" prompt,

retype the password followed by <return>



On successful execution of steps one to five a list similar to the one below is displayed:

5. At the resulting "Access level:" prompt, type an Access Level number followed by <return>

6. Confirm if the User_Access_File has been created under "$PLAN_ETC"

2.5.2.2 User Access File formatThe Planner plannerPasswd utility writes a record with the following four fields separated by ":" for each user into the User Access Control File:• Username -is the case insensitive User name• Password -is an encrypted password for a User attempting to establish a

connection. • Password_Expiry_Date -is the date when password expires and User is required to

enter a new password.• Access_level -is the Access level granted to the Client based on one of the

User Access Groups specified within the UAG file. See “2.5.1 User Access Groups” on page 2 - 9.

All entries in the User Access Control File has the following format:

Username:Password:Password_Expiry_Date:Access_level

for example:fredda:e2N39kF/ttk:20031029:SYSTEM

2.5.2.3 Useful arguments with the "plannerPasswd" utilityThe Planner plannerPasswd utility can create a new password file, edit an existing user password and specify the time limit for password expiry. Listed below are a few options and arguments to be used with the Planner plannerPasswd utility:• -c - change existing user password.• -a - add a new user.

Enter Access Level VIEW_ONLY [1] PLANNING [2] REAL_TIME [3] DATA_MOD [4] SYSTEM [5]

numeric value assigned to default

USERDEFINED1 [6] USERDEFINED2 [7]..ACCESS LEVEL:

and user defined Access levels



• passwdFile= - specify the User Access Password File name to be used by the Planner plannerPasswd utility.

• accessGroupFile=-specify the User Access Groups File name to be used by the Planner plannerPasswd utility.

• expireDelay - argument used to specify the number of days from now, a password will expire. By default the password will expire at the end of 30 calendar days. Negative values can be specified.

2.5.2.4 Enforcing the change of temporary passwords at first logonThe System Administrator must ensure the existence of a valid encrypted password in the User Access Control file. The expiry date on the password should be set to some time in the past to ensure that Scheduler asks for a change in this initial password.

The Client prompts the User for an existing password and follows it with two more prompts for a new password.



2.6 SETTING UP GUISERVER

Minimised network traffic across WAN’s and reduced load on smauto when connecting multiple plannerClients are the major goals behind the design of Planner GuiServer.

The GuiServer attaches as a normal Client to smauto, accepts connections from Clients and essentially acts as smauto. Messages are passed through from Clients to smauto and vice versa. GuiServer interprets views and their use.

2.6.1 Configuring GuiServerThe GuiServer is configured using command line arguments supplied through configuration files (See “2.4 Planner Config files” on page 2 - 6).

Ensure that the following parameters are set appropriately within the GuiServer configuration file:

• GuiServer View -See GS_VIEW under “3.2.8.1.5 Specify the view restrictions for GuiServer” on page 3 - 8.

• GuiServer Logging-See “3.2.9.1.3 For GuiServer Logging” on page 3 - 10.• Hostname/port number -See PLAN_CENT_HOST and PLAN_CENT_AUTO_PORT

under “3.2.8 Set GuiServer parameters” on page 3 - 8.• ClientPort - See GS_CLIENT_PORT under “3.2.11.1.2 For connecting

plannerClient to GuiServer” on page 3 - 12.

2.6.2 GUI Server functionsThe GuiServer supports the following functions:• Multiple Planner Client connections.• A single smauto connection combined with the ability to search for an available smauto

from multiple host/port pairs. Please see PLAN_CENT_HOST in section “3.2.8 Set GuiServer parameters” on page 3 - 8.

• Provides the normal view functionality to connecting plannerClients.• Extracts and stores all Resource, Shift, Depot and Job information upon connecting to

the smauto process.• Passes on requests sent from plannerClients onto smauto.• Receives data embedded between BATCH_ON/OFF from plannerClient and passes it

onto smauto.• Routes errors generated by packets sent from a Planner Client back to the same Client.

2.6.3 GUI Server operationsOperationally the GuiServer has the following features:• The GuiServer must have a smauto connection before it can accept plannerClient

connections.• When the smauto connection is closed, GuiServer drops all plannerClient connections.



• GUI Server sends updates to Planner Clients only when the Client requests for updates (SYNC_PLAN). SYNC_PLAN’s are always handled by the GuiServer and not propigated on to smauto.

• A GuiServer can be connected to another GuiServer in a cascaded fashion.• GuiServer can be configured and run from LaunchPad. Please see “3.2.12 Set

launchPlanner (nmcConfig) Runtime Configuration” on page 3 - 12 and “5.6 GuiServer Configuration” on page 5 - 43 for more details.

• GuiServer can be run with a C-Shell run script. Please see • If 2 GuiServers with the same configuration are run on the same machine only one will

be able to open a port for Clients to connect to. • If 2 GuiServers are run on separate machines both could connect to smauto and also

handle client connections.• If 2 GuiServers are run on the same machine but listen on different ports both could

connect to smauto and also listen for Client connections.• GuiServer allows multiple logins for the same user via User Access Control.

2.6.4 plannerClient Request HandlingWhen a plannerClient makes a request it is passed through the GuiServer to smauto. Errors or responses (if any) are passed back to the originating plannerClient.

2.6.4.1 plannerClient Connection InitiationThe following tables depict the plannerClient connection initiation with and without User Access Control.

plannerClient Connection without UAC

plannerClient ⇔ GuiServer ⇔ smauto

Attempts to establish con-nection

⇒Accepts connection

Sends Client connection request

⇒Passes on Client con-nection request ⇒

Receives Client connection request

Enables Client. ⇐ Passes on Con-nec.tion authorisation ⇐ Sends Connection authorisation.

plannerClient Connection with UAC (Sheet 1 of 2)


Attempts to establish con-nection

⇒Accepts connection



2.6.4.2 SYNC_PLAN Handling

PlannerClient follows each request with a SYNC_PLAN so as to receive any resulting data changes. A request can be in the form of a single packet such as a JOB_ASSIGN operation or a batch of packets such as when an object is modified. The GuiServer identifies the situation and caches the packets that make up a request until an entire request has been received. Please refer the companion Planner Host interface manual for details on packets.

Sends Client connection request

⇒Passes on Client con-nection request ⇒

Receives Client connection request

Prompts User for Username/Password

⇐Passes on User authorisation request ⇐

Sends User authorisation request

Sends User Connection details

⇒Passes on User Con-nection details ⇒

Verifies Username/Password

Sets User Access level. ⇐ Passes on authorisa-

tion response. ⇐ Sends authorisation response.


Sends BATCH_ON ⇒ Caches packet

Sends STOP ⇒ Caches packet

Sends BATCH_OFF ⇒ Caches packet

Passes entire request through ⇒ Processes request

Sends SYNC_PLAN

Blocks all further reading of plannerClient connection

Direct responses, errors etc, are sent back to originating plannerClient

plannerClient Connection with UAC (Continued) (Sheet 2 of 2)




Sends SYNC_PLAN

⇒ Receives SYNC_PLAN

Updates IDB with changes ⇐ Sends changes in data

Unblocks plannerClient connec-tion

⇒ Receives SYNC_PLAN

Processes updates ⇐ Sends changes in data




2.7 SETTING UP PRINT MANIFEST SERVER

Planner’s Print Manifest Server is a centralised process which has been developed to facilitate the creation of Driver Manifests, for next day delivery, without having to run plannerClient at remote Depot/Store locations. The manifest files can be generated either in "plain text" or "postscript" format.

2.7.1 Configuring Print Manifest Server

2.7.1.1 General ConfigurationThe Print Manifest Server is configured using command line arguments supplied through con-figuration files (See “2.4 Planner Config files” on page 2 - 6). The arguments are predominantly a subset of those currently used by plannerClient.

Ensure that the following commandline arguments are set appropriately within the Print Mani-fest Server configuration file:

2.7.1.1.1 In the Print Manifest Server configuration file:• Layout file -See NMC_LAYOUT_FILE under “3.2.4 Set Planner GUI Layout Path”

on page 3 - 5.• Turn-by-Turn instructions -See all the command line arguments under “3.2.6 Set

Planner Turn-by-Turn values” on page 3 - 6.• Map used -See PLAN_MAP under “3.2.3 Set Planner Map Names” on

page 3 - 5.• Client Logging -See NMC_LOG_RECV under “3.2.9.1.2 For Client Logging” on

page 3 - 10.• Manifest Hip Version-See MANIFEST_HIP_VER under “3.2.7 Set Print Manifest Server

parameters” on page 3 - 7.• Manifest Output - See PLAN_PRINT_TEXT under “3.2.7 Set Print Manifest Server

parameters” on page 3 - 7.• Text Separator - See PLAN_TEXT_SEPARATOR under “3.2.7 Set Print Manifest

Server parameters” on page 3 - 7.

2.7.1.1.2 As an argument to the Print Manifest Server executable command:• Manifest Data -See manifestDataFile under “2.7.1.3 Data Input to the Print

Manifest Server” on page 2 - 19.

2.7.1.2 Manifest Layout ConfigurationConfiguration of the Print Manifest Server itself is through a layout file, referenced by a com-mand line argument, of the same format as the plannerClient layout file. Entries found in the layout file which are used by the plannerClient but not required for the Print Manifest Server are ignored.



2.7.1.2.1 Steps to create a Print Manifest Server Layout file:1 Load Print Manifest from the Tools menu on the plannerClient.2 Adjust the Print Manifest layout settings as desired. See accompanying Planner User

Manual for more details on Print Manifest.3 Save the layout file using plannerClient’s Save Layout. See accompanying Planner User

Manual for more details on GUI Layout.4Use the saved layout file in the Print Manifest Server configuration setup. See “3.2.4 Set

Planner GUI Layout Path” on page 3 - 5.

Note: Both Print Manifest Server and plannerClient use the same commandline argument to specify the layout file to be used.

2.7.1.3 Data Input to the Print Manifest ServerThe location of the HIP file which contains the Plan data followed by the Print Run Requests are referenced by the command line argument manifestDataFile.

The Data file is loaded after the Print Manifest Server initialises itself using the following command:manifestServer config=manifest.cfg manifestDataFile=Manifest.hip <return>

2.7.1.3.1 Preparing Print Manifest Server DataSteps to create the Data file:1. Save the scheduled data from the plannerClient. See accompanying Planner User

Manual for more details on Saving data from the GUI.2. Open the solution data file using a text editor and add the print run/shift request

packet(s) with the required runs/shifts and destination path and filename for the postscript file. See accompanying Planner Interface Manual for the PRINT_RUN/PRINT_SHIFT packet formats.

3. Save the File.

The data to be loaded into the Print Manifest Server need only contain data specific to the Runs/Shifts to be printed.

2.7.1.4 Data Output from the Print Manifest ServerThe destination location of the PostScript manifest files must be specified in each individual Print Run Request. See accompanying Planner Interface Manual for the PRINT_RUN packet format.

2.7.1.5 Error GenerationErrors generated during the processing of the Data packets and Request packets are logged to a file specified by a command line argument. The log messages can also be logged on to the originating terminal.



2.7.1.5.1 Error Conditions1 If a Run/Shift does not exist within the system a blank manifest will be printed.2 If printing fails due to access or configuration an error will be logged.

2.7.2 Printed ManifestsThe Printed Manifest from the Print Manifest Server is configured to include all the components that can be printed by the plannerClient such as:

1. Stop detail list (normal manifest page)

2. Configurable headers and footers

3. Map with route

4. Turn by turn directions

2.4.1 Print Request ProcessThe following table illustrates the process required to execute a Print Run Request

Print Manifest Server ⇔ Batch Process

Extract Data to be printed from Data Base.

Store Data in HIP file.Store print Run/Shift requests in HIP file.

Initialise. ⇐ Start up Print Manifest Server directing Server to load HIP file.

Load HIP data file.

Process print Run/Shift requests, creating postscript files.

Shutdown. ⇒ Convert postscript files into pdf.

Send to Stores for printing.


Chapter 3: Running Planner

There are two mandatory processes involved in running Planner. • DISPLAY - process name GUI or nmcGUI (the Graphical User Interface)• Scheduler - process name smauto (scheduler and message handler)

Please see section 3.1 “The Planner 10.5 processes” on page 3 - 2 for a listing of all the Planner processes.

In a typical setup nmcGUI is directly connected to smauto. Alternately a large number of Clients can connect to a GuiServer which is already connected to the smauto and thereby reduce the load on smauto.• GUI Server - process name plannerGuiServer (Client handler)

Each process loads and reads a configuration file at startup. The configuration file indirectly controls much of the behaviour of each process.

The configuration files are plain ASCII text, and must contain the parameter specifications specified as a keyword and its associated value. The keyword must be recognisable to the process and must be one of the allowable keywords listed in Appendix A: “Run-time Configuration” on page A - 1.

Changes made to the configuration files will not take effect until the process is restarted.

Oracle Corporation supplies a set of predefined configuration files (2.4 “Planner Config files” on page 2 - 6) with each installation.

Note: Planner can alternately be run with another Oracle Real-Time Scheduler sub-component named Switch. Please see Chapter 4: “Running Planner with Switch” on page 4 - 1for more details.



3.1 THE PLANNER 10.5 PROCESSES

The Planner 10.5 release consists of the processes listed in the following table:Planner 10.5 processes (Sheet 1 of 2)

ProcessRunscript (where available)

Type Description

smauto runsmauto Server/Client • Is the Planner engine• Operates as server to connecting

plannerClients and plannerGuiServers.• Operates as client while connected to

plannerSwitch.• Can switch behaviour between

Scheduler and Slot-generator when connected to plannerSwitch.

plannerSwitch runswitch Server • Interfaces between Planner and the host system applications.

• Can switch behaviour between primarySwitch and secondarySwitch.

• Capable of connecting multiple smautos at the same time.

plannerClient runnmc Client • Is the Planner GUI.• Always connects to smauto by default.• Can be optionally made to connect to a

plannerGuiServer.

plannerGuiServer runGuiServer Client • Connects to smauto as a GUI client and in turn grants connection to multiple plannerClients.

• Automatically drops all plannerClient connections, after loosing its connection to smauto.

• Reduces the bandwidth requirement when multiple Clients are running at a remote location.

manifestServer runManifest Independent • Generates printed manifest in postscript or text format using layout and hip data created from Planner without connecting to any Planner process.

plannerPasswd Independent • Creates/maintains the contents of the User Access Control File.

• Can create a new user record or edit an existing user’s details in the User Access Control File.



nmcConfig launchPlanner Independent • Presents a control panel from where planner processes can be run, their status monitored and their run-time parameters can be configured, saved and loaded.

• The enableSwitch and enableGuiServer must be set to TRUE to enable the respective process configuration from the nmcConfig control panel.

Planner 10.5 processes (Continued) (Sheet 2 of 2)

ProcessRunscript (where available)

Type Description



3.2 PREPARING THE PLANNER CONFIG FILES

Before Planner is executed, the system manager must ensure the following settings within the configuration files: • the Planner version,• the GuiServer setup (required only if GuiServer is connecting PlannerClients to smauto),• the GUI display,• the maps path/name,• the GUI layout file path/name,• the User Access Control settings• the Turn-by-Turn settings• the system logging setup,• the schedule backup procedure, and• the run-time control settings.

Note: The fields which may need to be adjusted are shown in bold type. Environment variables like $PLAN_DATA, $PLAN_ETC and &DTMPROD must be set in the dtmrc file at the time of installation. See “Typical settings in the dtmrc file with sample values” on page 2 - 6 for more details on environment variables.

3.2.1 Set Planner VersionThese versions are set in the file:

INSTALL_POINT/Planner/etc/dtmrc

Edit the dtmrc file (using any convenient text editor).

The dtmrc file sets up pointers to the particular release of Planner which will be used when Planner is next executed.

3.2.1.1 What to Change?For the initial release of Planner, there will be only one installed version of Planner. The actual version numbers of the release must be used in the dtmrc file.

There may be many lines in the file, but the lines of immediate interest are: setenv PLANNER_VERSIONS 1 setenv PLANNER_1 planner-10.0.0 setenv CURRENT_PLANNER $PLANNER_1

For subsequent product releases, several version of the products may exist simultaneously. The dtmrc file is used to list all the released versions and to select the one that will be executed.

setenv PLANNER_VERSIONS 2 setenv PLANNER_1 planner-10.0.0 setenv PLANNER_2 planner-10.1.0 setenv CURRENT_PLANNER $PLANNER_2



3.2.2 Set PlannerClient/GUI DisplaySee “Modify .cshrc File” on page 2 - 5 to set the system display within the user’s .cshrc file. The DISPLAY system variable can also be set within the dtmrc file.

3.2.2.1 What to Change?setenv DISPLAY user_host_computername:0

3.2.3 Set Planner Map NamesThe filenames of the maps used by Planner are set in the file:

INSTALL_POINT/Planner/etc/site.config.Planner

Edit the site.config.Planner file (using any convenient text editor).

3.2.3.1 What to Change?The site.config.Planner file sets up the site-specific information for Planner.

There may be many lines in the file, but the lines of immediate interest are: set PLAN_MAP =$PLAN_DATA/<mapname>.<extension>

If supplied:

set PLAN_COAST =$PLAN_DATA/<coastname>.coast.<extension>

3.2.4 Set Planner GUI Layout PathThe pathname to the customised layout file (see “Copy Customized Layout” on page 2 - 5) must be added to the site.config.Planner file (using any convenient text editor). The contents of this file will override the default screen layout values installed with Planner

3.2.4.1 What to Change/Add?set NMC_LAYOUT_FILE =<pathname to the layout file>

3.2.5 Set Planner User Access ControlIn order to enable User Access Control for a Planner session or to customise the duration in days for a password or to set the number of days prior to password expiry to generate a warning or to specify the number of unsuccessful access attempts before disabling a user include the following commandline arguments with appropriate values in the site.config.Planner file:

3.2.5.1 What to Change?set PLAN_ACC_GROUP_FILE =$PLAN_ETC/

<UserAccessGroups_Data_File>



set PLAN_ACCESS_FILE =$PLAN_ETC/<UserAccessPasswords_Data_File>

Note: smauto reads the PLAN_ACCESS_FILE only after successfully reading the Group file specified in PLAN_ACC_GROUP_FILE parameter. User Access Control is disabled as long as PLAN_ACC_GROUP_FILE is NULL.

set PLAN_WARN_DAYS_EXP =<number of days before password expiry to warn user>

set PLAN_MAX_PASS_ATMPTS =<number of unsuccessful attempts after which Client is disabled>

set PLAN_PASSWORD_EXP =<number of days after which password will expire>

3.2.6 Set Planner Turn-by-Turn valuesThe number of decision points to be generated as part of Turn-by-Turn navigation instruction can be varied by setting the "straight ahead" angle in degrees and the "short link" length in meters in the site.config.Planner file. See Print Manifest with Turn-by-Turn navigation Instructions in the accompanying Planner User Manual for more details.

Note: The higher the value for "straight ahead" angle and "short link" length, the lesser the number of decision points generated and vice versa.

3.2.6.1 What to Change/Add?set PLAN_TBT_STRAIGHT =<0degree to 180degree> Default

sector is 22.5 degree. No new decision point generated if direction changed lies within the straight sector.

set PLAN_TBT_BEAR =<default sector is 45 degree> New decision point for bear right/left is generated within <straight+bear> sector.



set PLAN_TBT_TURN =<default sector is 45 degree> New decision point for turn right/left is generated within <straight+bear+turn> sector.

set PLAN_TBT_SHARP =<default sector is 45 degree> New decision point for sharp right/left is generated within <straight+bear+turn+sharp> sector.

set PLAN_TBT_SHORT_LINK =<default length is 45 meters> Links shorter than short Link will not result in generation of new decision points. For e.g. round about.

Warning: <PLAN_TBT_STRAIGHT+PLAN_TBT_BEAR+PLAN_TBT_TURN+ PLAN_TBT_SHARP> must be less than 180.

Note: 180 minus <PLAN_TBT_STRAIGHT+PLAN_TBT_BEAR+PLAN_TBT_TURN+PLAN_TBT_SHARP> will define the segment within which decision points for "Double Back" will be generated.

3.2.7 Set Print Manifest Server parametersThe parameters required by Print Manifest Server can be set in the file:


Edit the site.config.Planner file (using any convenient text editor.

3.2.7.1 What to Change?

3.2.7.1.1 Specify the Manifest Hip VersionThe MANIFEST_HIP_VER parameter must be set before starting the ManifestServer process.

set MANIFEST_HIP_VER =<7_0,8_1,9_0,10_0> Is 10_0 by default. Interface version ManifestServer is to expect.

3.2.7.1.2 Specify the output file format that ManifestServer will generate

set PLAN_PRINT_TEXT =<TRUE/FALSE> Is FALSE by default and hence the output format is postscript. When TRUE the output is in Plain Text format.



3.2.7.1.3 Specify the field separator in ManifestServer printoutset PLAN_TEXT_SEPARATOR =<,> Specify the field

separator in the ManifestServer plain text output. That is when PLAN_PRINT_TEXT = TRUE.

3.2.8 Set GuiServer parametersThe parameters required by GuiServer can be set in the file:



3.2.8.1 What to Change?

3.2.8.1.1 Specify port clients will use to connect to GuiServerset GS_CLIENT_PORT = n <plannerClients and

cascaded GuiServers will connect to the GuiServer at this port number>

3.2.8.1.2 Specify the host where GuiServer will look for Serverset PLAN_CENT_HOST = <comma seperated list of

hostnames where Client processes including GuiServers will search for the server process.> Cascaded GuiServers will search for the original GuiServer process on these hosts.

3.2.8.1.3 Specify port number for smauto or GuiServer hostsset PLAN_CENT_AUTO_PORT = n <smauto grants connection

to GuiServer and plannerClients at this port number.>

3.2.8.1.4 Specify the interval between updates from smautoset GS_REQ_INTERVAL = <default interval is 5

seconds>

3.2.8.1.5 Specify the view restrictions for GuiServerThe GS_VIEW parameter specifies the data views that the GuiServer is to receive from smauto and then, to be made available to all PlannerClients connecting to the GuiServer.

set GS_VIEW = <comma seperated list of views, default is [ALL]>



3.2.9 Set Planner system logging detailsThe following commandline arguments must be set appropriately in the site.config.Planner file for managing Planner system logs effectively. These parameters can be set to specify the log type to be displayed or stored for smauto and nmcGUI processes, the log duration for each save, the number of log files to be retained, the log file path and prefix and the log compression utility to be used.

3.2.9.1 What to Change/Add?

3.2.9.1.1 For Server Loggingset PLAN_RX_HIP_LOGGING =<TRUE/FALSE> Must be set to

TRUE to enable logging of HIP packets received by smauto onto the screen.

set PLAN_TX_HIP_LOGGING =<TRUE/FALSE> Must be set to TRUE to enable logging of HIP packets sent from smauto onto the screen.

set PLAN_LOG_TO_FILE =<TRUE/FALSE> Must be set to TRUE to save all log messages generated by smauto to a file.

set PLAN_LOG_PREFIX =<path_and_prefix_for_smauto_log_message_file> If a common log directory is used for both smauto and Switch then specifying an appropriate prefix will facilitate in distinguishing the logs.

set PLAN_LOG_HOURS =<1hr to 24hrs> Specify the time span in hours for a log file save.

set PLAN_LOG_FILES =<1 to 168> Specify the number of log files to be saved and retained. Old files are deleted.

set PLAN_LOG_COMPRESS =<gzip> Specify the file compression method/utility to be used.

Note: Only log files generated at Planner’s Unix installations can be compressed using gzip. If your computer system does not recognise the “gzip” command, then the compression cannot proceed. Call Oracle Corporation for a copy of “gzip”.

set PLAN_LOG_PLAN =<TRUE/FALSE> Must be set to TRUE to enable logging of all scheduling activities.



3.2.9.1.2 For Client Loggingset NMC_LOG_RECV =<TRUE/FALSE> Must be set to

TRUE to enable logging of HIP packets received by plannerClient onto the screen.

set NMC_LOG_TRANS =<TRUE/FALSE> Must be set to TRUE to enable logging of HIP packets sent from plannerClient onto the screen.

3.2.9.1.3 For GuiServer Loggingset GS_LOG_RECV =<TRUE/FALSE> Must be set to

TRUE to enable logging of HIP packets received by GuiServer onto the screen.

set GS_LOG_TRANS =<TRUE/FALSE> Must be set to TRUE to enable logging of HIP packets sent from GuiServer onto the screen.

set GS_LOG_TO_FILE =<TRUE/FALSE> Must be set to TRUE to save all log messages generated by GuiServer to a file.

set GS_LOG_PREFIX =<path_and_prefix_for_GUI Server_log_message_file> If a common log directory is used for smauto, GuiServer and Switch then specifying an appropriate prefix will facilitate in distinguishing the logs.

set GS_LOG_HOURS =<1hr to 24hrs> Specify the time span in hours for a log file save.

set GS_LOG_FILES =<1 to 168> Specify the number of log files to be saved and retained. Old files are deleted.



3.2.10 Set Planner Periodic Schedule BackupsAuto Save enables the Scheduler to periodically save the current state of the schedule. The Scheduler will also save the current state before clearing it on receipt of a RESET packet. If the Scheduler is shutdown it will save the current state of the plan before exiting. If the Scheduler crashes for whatever reason, the last automatically saved file can be reloaded into the Scheduler manually.

Edit the site.config.Planner file (using any convenient text editor) to incorporate the following backup settings.

3.2.10.1 What to Change/Add?set PLAN_AUTOSAVE_INT =<0 to 2000mins> Specify the

time interval in minutes between backups. Zero will disable the auto save functionality.

set PLAN_AUTOSAVE_FILES =<1 to 1000> Specify the number of backups to be retained.

set PLAN_AUTOSAVE_DIR =<$PLAN_LOG> Specify the backup directory path.

Note: If running several instances of Planner, it would be recommended to have each instance write to a different auto save directory.

set PLAN_DUAL_AUTOSAVE =<second_autosave_directory_path > Specify the second simultaneous backup directory path preferably different to PLAN_AUTOSAVE_DIR, if two copies of the backup is to be maintained.

3.2.11 Set Planner Runtime ConfigurationThe run-time control parameters used by Planner are set in the file:



3.2.11.1 What to Change/Add?The site.config.Planner file sets up information about the hardware of the installation and the RDBMS (if any). This information will be used when Planner is next executed. The file must be edited to include the following information:

3.2.11.1.1 For hardware: set PLAN_CENT_HOST =<hostname> Is a comma separated

list of computer names on which smauto processes will run.



set PLAN_CENT_AUTO_PORT =<n> Is an unused IPC port number on the computer running smauto.

3.2.11.1.2 For connecting plannerClient to GuiServerset GS_CLIENT_PORT =<n> is an unused IPC port

number on the computer running GuiServer.

Note: plannerClients connect by default to smauto at the PLAN_CENT_AUTO_PORT and must be made to point to the GS_CLIENT_PORT to connect to the GuiServer.

3.2.11.1.3 For setting start-up Scheduling control:set PLAN_MAP_DIST_FACTOR = 1

set PLAN_MAP_TIME_FACTOR = 40

set PLAN_DIST_COST = 1.0

set PLAN_INTRANODALSPEED = 20

set PLAN_SCHED_MIN_TEMP = 400

set PLAN_SCHED_MAX_TEMP = 200000

set PLAN_SCHED_HEAT_RATE = 0.5

set PLAN_SCHED_DURATION = 600

3.2.12 Set launchPlanner (nmcConfig) Runtime ConfigurationAt run-time launchPlanner can be setup to enable the configuration and running of plannerSwitch and plannerGuiServer from the LaunchPad using the following parameters:

enableSwitch =TRUE Enable plannerSwitch configuration from the LaunchPad. [defaults to TRUE]

enableGuiServer =TRUE Enable plannerGuiServer configuration from the LaunchPad. [defaults to FALSE]



3.3 STARTING PLANNER

Planner can be run by any Allocator user whose environment has been set up as described in section 2.1 “Setting Up the Users” on page 2 - 2. Please refer section 3.1 “The Planner 10.5 processes” on page 3 - 2 to know the Planner processes.

3.3.1 Starting smautoTo start smauto: 1. Log on as an Allocator user.2. Invoke a shell and type the command -

runsmauto <return>ORsmauto config=smauto_config.cfg <return>

Note: Ensure that a smauto_config.cfg containing the parameters specified under 3.2 “Preparing the Planner Config Files” on page 3 - 4 already exists.

Messages relevant to smauto process will be displayed on the terminal.

3.3.2 Starting GUITo start plannerClient: 1. Invoke a terminal and type the command -

runnmc <return>ORplannerClient config=client_config.cfg <return>

Note: Ensure that a client_config.cfg containing the parameters specified under 3.2 “Preparing the Planner Config Files” on page 3 - 4 already exists.

Messages relevant to plannerClient process will be displayed on the terminal.

3.3.3 Starting smauto and GUI at onceTo start smauto and plannerClient with a single command: 1. Log on as an Allocator user.2. Ensure that all previous have been shut down to avoid errors that can be caused by

“leftover” processes. To avoid the possibility of errors that may be caused by leftover processes, ensure that all previous Planner sessions are shut down. Also see “Stopping Planner” on page 3 - 15.

3. Type the command - startPlanner <return>

The smauto and plannerClient processes will be started on independent terminals.



3.3.4 Starting GuiServerTo start GuiServer:

1. Ensure that a smauto process is already running.2. Ensure that a guiServer.cfg containing the parameters specified under 3.2.8 “Set

GuiServer parameters” on page 3 - 8 already exists. 3. Invoke a terminal and type in the command -

runGuiServer <return>

ORplannerGuiServer config=guiServer.cfg <return>

Messages relevant to GuiServer process will be displayed on the terminal. The GuiServer connects to smauto and then opens its Clientport for Client connection. To understand the GuiServer’s operational mechanism refer section 2.6.3 “GUI Server operations” on page 2 - 14.

3.3.5 Starting the Print Manifest ServerThe Print Manifest Server is an independent Planner process which executes the Print Run request and terminates itself.

To execute the Print Manifest Server process:

1. Open a new terminal window and Log in as a valid user2. Type the command -

runManifest Manifest.hip <return>

OR

ManifestServer config=manifest.cfg manifestDataFile=Manifest.hip <return>

This command will create a postscript file with the manifest details at the location specified in the Print Run request packet within the Manifest.hip file. See “Preparing Print Manifest Server Data” on page 2 - 19 for details on creating the "Manifest.hip" file.

Note: The Print Manifest Server process does not require an explicit shutdown as it terminates itself.



3.4 STOPPING PLANNER

It is essential that Planner is completely shut down at the end of the session. The GUI (or nmcGUI) process can be shut down using the mouse, but the other processes must be shut down individually.

This is important because any “leftover” processes can cause errors in the next Planner session.

3.4.1 Shut Down Planner GUIThe GUI is shut down from the "File->Quit->Yes" menu as shown in the companion “Planner User Manual”

3.4.2 Shut Down Other Planner ProcessesControl of the other Planner processes are available in the shell windows in which they are running. Each one must be shut down separately.

To shut down a Planner process, go to the shell window and type the command: Ctrl-Cwhich means a) hold down the Ctrl key on the keyboardb) Strike the C keyc) release the Ctrl key.

The process will stop execution.


Chapter 4: Running Planner with Switch

Planner’s Primary Switch is the main process involved in running Planner with Switch. See “Chapter 3: Running Planner” on page 3 - 1 for instructions on the standard method to run Planner and “3.1 The Planner 10.5 processes” on page 3 - 2 for a listing of the Planner processes.

The Switch interfaces between Planner on one side, and the external ’Data Interface’ and ’Non-volatile Database Backup’ applications on the other. The Primary Switch receives Vehicles, Stores and Orders from the external Application Server and.

Primary Switch performs the following tasks:• - Determines which process is Scheduler, which are Slot-generators.• - If necessary, promotes one of the Slot-generator to Scheduler.• - Alternates Slot-requests between the available Slot-generators.• - Ensures no data is lost during failover.• - Ensures all Clients (Scheduler, Slot-generators, Secondary Switch) are kept up to

date.• - Reloads new Scheduler or Slot-generator.

The following Planner processes are involved in executing Planner with Switch:• DISPLAY - process name GUI or plannerClient (is the Graphical User

Interface)• Scheduler - process name smauto (Scheduler and message handler)• Slot-generator(s) -process name smauto (receives slot requests and delivers

appropriate slots, maintains up-to-date schedule at any time but does not schedule)

• Secondary Switch - process name plannerSwitch (is started by Primary Switch, keeps up-to-date with all data and status information from Primary Switch at all time, promotes itself to Primary Switch on Primary Switch Failover)

• Switch (Primary Switch)- process name plannerSwitch (is the root process, nominates the Scheduler and Slot-generator processes, sends updates to Secondary Switch)



Each of these processes reads a configuration file which is loaded by the process each time it is started. The configuration file indirectly controls much of the behaviour of each of the processes.

The configuration files are plain ASCII text, and must contain the parameter specifications specified as a keyword and its associated value. The keyword must be recognisable to the process. Please see Appendix A: Run-time Configuration for a listing of the allowable keywords.

If any changes are made to the configuration files, they will not take effect until the process is restarted.

Oracle Corporation will supply a set of configuration files with each installation. Please see (Chapter 2: Setup) for more details on Planner configuration files.



4.1 PLANNER SYSTEM ARCHITECTURE BASED ON SWITCH

Planner system architecture centered around the Primary Switch is illustrated below.

4.1.1 Functionalities supported by Planner SwitchPlanner Primary Switch supports:1. Multiple Data Interface process connections external to Planner2. Database backup process connections external to Planner through batch-

processes3. A single Scheduler connection4. Multiple Slot-generator connections5. A single Secondary Switch connection (also named as FailOver Switch) to

maintain an up-to-date copy of all data so as to facilitate recovery in the event of Primary Switch failure.

6. The transfer of all schedule data to a failover Switch7. Ability to negotiate Primary Switch status8. Automatic failover unto Secondary Switch upon failure of Primary Switch9. The transfer of Jobs from Data Interface to Scheduler and Slot-generators

During normal operation Data Interface sends new Jobs to the Primary Switch. The Switch transfers the Jobs to the Secondary Switch, Scheduler and Slot-generators.

9.1.Confirm Job in secondary Switch In order to ensure that Jobs are not lost due to a Switch or network failure, the Switch acknowledges receipt of each Job to Data Interface only after it has confirmation that the Job has arrived in the Secondary Switch.

10. The transfer of Slot-requests from Data Interface to Slot-generators Slot-requests are distributed between Slot-generators in order to spread the load.

10.1.The return of Slot-replies from a Slot-generator to the originating Data Interface

11. The regular exchange of schedule information with Database backup process11.1.Synchronize

at an interval of n minutes. Database backup process connects to the Switch and gets updated with the latest set of changes to the schedule.

11.2.Re-synchronize at any time Database backup process can request the whole schedule from the Switch. The most likely trigger for such a request may be when Database backup process detects a transmission error.

11.3.Accept Jobs when Database backup process sends new Jobs to the Switch, or deletes existing Jobs from the Switch to accommodate the transfer of Jobs between schedules. On receipt of these Jobs the Scheduler assigns them to a Shift.



12. The transfer of all schedule data from Database backup process to the Switch so that the Switch can be loaded with all information required to initialize a schedule upon initial start-up, or fully restore it after a Catastrophic Failure

13. Automatic failover unto remaining Slot-generators upon failure of a Slot-generator When a Slot-generator fails, it is removed from the Slot-request rota, and all new requests are sent to the remaining Slot-generator(s)

14. Automatic failover unto Slot-generators upon failure of the Scheduler When the Scheduler fails, one of the Slot-generators is promoted to Scheduler and new Slot-requests are sent to the remaining Slot-generator(s)

15. Reliable confirmation that the Switch is active16. Reliable confirmation that a connected process is active

4.1.2 Standard method of operating Planner with Switch1. The system administrator manually starts Planner Primary Switch.2. Planner Primary Switch invokes a Secondary Switch after a predefined time on a

known machine.3. The Secondary Switch connects to the Primary Switch and awaits updates.

3.1.Promotes itself to Primary Switch and invokes a Secondary Switch in the event of Primary Switch failure.

4. The system administrator starts one or more Planner smauto processes, all with a single TCP/IP port number known to Primary Switch.

5. The Primary Switch designates the first connecting smauto process as Scheduler and the rest as Slot-generators.5.1.The Primary Switch nominates one of the Slot-generator as Scheduler in the event of the existing Scheduler failure.5.2.In the event of a Slot-generator failure, the Primary Switch redistributes the slot requests among the existing Slot-generators.

6. The Primary Switch passes on data received from external processes6.1. to Scheduler for validation6.2.to Secondary Switch for backup6.3.and send back confirmation to the external process.

7. Allocator invokes the required number of plannerClient processes which in turn connect to the Scheduler process.



4.2 PREPARING THE PLANNER CONFIG FILES

Before Planner is executed, the system manager must ensure the following settings within the configuration files: • the Planner version,• the GuiServer setup (required only if GuiServer is connecting PlannerClients to smauto),• the GUI display,• the maps path/name,• the GUI layout file path/name,• the User Access Control settings,• the Turn-by-Turn settings,• the Print Manifest Server settings,• the system logging setup,• the schedule backup procedure and• the run-time control settings.

Note: The fields which may need to be adjusted are shown in bold type. Environment variables like $PLAN_DATA, $PLAN_ETC and &DTMPROD must be set in the dtmrc file at the time of installation. See “2.4.1 Typical settings in the dtmrc file with sample values” on page 2 - 6 for more details on environment variable

4.2.1 Set Planner/GUI VersionSee “3.2.1 Set Planner Version” on page 3 - 4.

4.2.2 Set Planner Map NamesSee “3.2.3 Set Planner Map Names” on page 3 - 5.

4.2.3 Set Planner GUI Layout PathSee “3.2.4 Set Planner GUI Layout Path” on page 3 - 5.

4.2.4 Set Planner User Access ControlSee See “3.2.5 Set Planner User Access Control” on page 3 - 5.

4.2.5 Set Planner Turn-by-Turn valuesSee See “3.2.6 Set Planner Turn-by-Turn values” on page 3 - 6.

4.2.6 Set Planner Print Manifest Server parametersSee See “3.2.7 Set Print Manifest Server parameters” on page 3 - 7.



4.2.7 Set Planner GuiServer parametersSee See “3.2.8 Set GuiServer parameters” on page 3 - 8.

4.2.8 Set Planner system logging detailsThe following commandline arguments must be set appropriately in the site.config.Planner file for managing Planner system logs effectively. These parameters can be set to specify the log type to be displayed or stored for smauto, nmcGUI and Switch processes, the log duration for each save, the number of log files to be retained, the log file path and prefix and the log compression utility to be used.

4.2.8.0.1 For Server LoggingSee “3.2.9.1.1 For Server Logging” on page 3 - 9.

4.2.8.0.2 For Client LoggingSee “3.2.9.1.2 For Client Logging” on page 3 - 10.

4.2.8.0.3 For GuiServer LoggingSee “3.2.9.1.3 For GuiServer Logging” on page 3 - 10.

4.2.8.0.4 For Switch Loggingset SW_LOG_RECV =<TRUE/FALSE> Must be set to

TRUE to enable logging of HIP packets received by Switch onto the screen.

set SW_LOG_TRANS =<TRUE/FALSE> Must be set to TRUE to enable logging of HIP packets sent from Switch onto the screen.

set SW_LOG_TO_FILE =<TRUE/FALSE> Must be set to TRUE to save of all log messages generated by Switch to a file.

set SW_LOG_PREFIX =<path_and_prefix_for_switch_log_message_file> If a common log directory is used for both Switch and smauto then specifying an appropriate prefix will facilitate in distinguishing the logs.

set SW_LOG_HOURS =<1 to 24>Specify the time span in hours for a log file save.

set SW_LOG_FILES =<1 to 168>Specify the number of log files to be saved and retained. Old files are deleted.



set SW_LOG_COMPRESS =<gzip> See PLAN_LOG_COMPRESS on page 3 - 9.

4.2.9 Set Planner Periodic Schedule BackupsSee “Set Planner Periodic Schedule Backups” on page 3 - 11.

4.2.10 Set Planner Runtime ConfigurationThe run-time control parameters used by Planner are set in the file:



4.2.10.1 What to Change/Add?The site.config.Planner file sets up information about the hardware of the installation, smauto mode (Scheduler or Client), Schedule control factors at initial start-up, and the RDBMS (if any). This information will be used when Planner is next executed. The file must be edited to include the following information:

4.2.10.1.1 For hardware: set SW_HOST = <hostname> (is a comma separated list

of computer names on which Switch processes will run)

set SW_SM_PORT = m (is an unused IPC port number on which all the smauto processes will connect to the Switch)

set SW_APP_SRV_PORT = x (is an unused IPC port number on which all the host system application server processes will connect to the Switch)

set SW_DB_Port = y (is an unused IPC port number on which all the host system database processes will connect to the Switch)

set SW_DB_LOAD_Port = p (is an unused IPC port number on which the host system’s initial Data Loading process will connect to the Switch)

set SW_SEC_SW_HOST = <hostname> (is the name of the computer on which Switch will start the Secondary Switch)

set SW_SEC_SW_Port = z (is an unused IPC port number on which the Secondary Switch will connect to the Switch)

set SW_INTERFACE_VER = 7_0 or 10_0 (is the version of HIP interface which will be used for all communication with the switch)



set PLAN_CENT_HOST = <hostname> (is a comma separated list of computer names on which smauto (Scheduler and slot-generator) processes will run)

set PLAN_CENT_AUTO_PORT = n (is an unused IPC port number on which the plannerClient processes will connect to smauto(Scheduler))

Warning: Make sure that the PLAN_CENT_AUTO_PORT# is same for all smauto processes connecting to a single Planner Switch process. This is to ensure that the Planner Client can automatically pick up the next Scheduler connection after an existing Scheduler failure.

4.2.10.1.2 For setting Secondary Switch start-up modeset SW_SEC_SWITCH = <TRUE/FALSE>

4.2.10.1.3 For setting smauto mode (Client or Scheduler):set PLAN_SERVER_MODE = <TRUE/FALSE>

4.2.10.1.4 For connecting plannerClient to GuiServerSee “ set PLAN_CENT_AUTO_PORT =<n> Is an unused IPC port number on the

computer running smauto.” on page 3 - 12.

Note: plannerClients connect by default to smauto at the PLAN_CENT_AUTO_PORT and must be made to point to the GS_CLIENT_PORT to connect to the GuiServer.

4.2.10.1.5 For setting start-up Scheduling control:See “3.2.11.1.3 For setting start-up Scheduling control:” on page 3 - 12.

4.2.11 Set launchPlanner (nmcConfig) Runtime ConfigurationSee “3.2.12 Set launchPlanner (nmcConfig) Runtime Configuration” on page 3 - 12.



4.3 STARTING PLANNER

Planner can be run by the system administrator or any Allocator user whose environment has been set up as described in “2.1 Setting Up the Users” on page 2 - 2. See also the section “3.1 The Planner 10.5 processes” on page 3 - 2.

4.3.1 Steps to execute Planner processesThe Planner product has been designed to efficiently run all the interlinked processes from a single host machine or from multiple machines connected over a network setup.

In either case the Planner runtime configuration (see “4.2.10 Set Planner Runtime Configuration” on page 4 - 7) must be set to represent the correct hardware settings.

4.3.1.1 Running all Planner processes on a single machineAll Planner processes can be executed from a single computer which meets the required amount of internal memory and processing speed.

To execute Planner:

1. Log on as the system administrator.2. Make sure that all previous Planner sessions have been properly closed down.

This step is important because a “leftover” Planner process can cause errors in the current Planner session. Also see “4.4 Stopping Planner” on page 4 - 12.

Starting Switch3. Invoke a shell window and type the command -

runswitch <return>ORplannerSwitch config=switch_config.cfg <return>

Note: The switch_config.cfg must be created beforehand using parameters similar to those specified under “4.2 Preparing the Planner Config Files” on page 4 - 5

This command invokes Planner Primary Switch and subsequently the Secondary Switch processes. Messages relevant to each process will be displayed in the shell window.

Starting smauto4. Invoke another shell and type the command -

runsmauto <return>ORsmauto config=smauto_config.cfg <return>

Note: The smauto_config.cfg must be created beforehand using parameters similar to those specified under “4.2 Preparing the Planner Config Files” on page 4 - 5

Messages relevant to Planner Scheduler will be displayed in the shell window.



Starting Slot-generator5. Repeat step 4 to invoke the required number of Slot-generator processes.

Messages relevant to each instance of Planner Slot-generator process will be displayed in the respective shell window.

Starting GuiServer6. Ensure that a smauto process is already running.7. Ensure that a guiServer.cfg containing the parameters specified under 3.2.8 “Set

GuiServer parameters” on page 3 - 8 already exists. 8. From a new terminal type the command -

runGuiServer <return>

ORplannerGuiServer config=guiServer.cfg <return>

Note: GuiServer first connects to smauto and then accepts connection from multiple plannerClients. PlannerClients can be connected to smauto directly or through the GuiServer.

Starting GUI9. Invoke yet another shell and type the command -

runnmc <return>ORplannerClient config=client_config.cfg <return>

Note: The client_config.cfg must be created beforehand using parameters similar to those specified under “4.2 Preparing the Planner Config Files” on page 4 - 5.

Messages relevant to Planner nmcGUI will be displayed in the shell window and a Graphical User Interface will popup on screen. The Allocator user controls all Planner operations through this GUI. The companion manual “Planner User Manual” will show how Planner should look and behave.

Starting PrintManifestServer10. Invoke another shell and type the command -

runManifest Manifest.hip <return>

OR

ManifestServer config=manifest.cfg manifestDataFile=Manifest.hip <return>

Note: The manifest.cfg must be created beforehand. See “2.7.1 Configuring Print Manifest Server” on page 2 - 18.

This command will create a postscript file with the manifest details at the location specified in the Print Run request packet within the Manifest.hip file. See “2.7.1.3.1 Preparing Print Manifest Server Data” on page 2 - 19 for details on creating the "Manifest.hip" file.



Note: The Print Manifest Server process does not require an explicit shutdown as it terminates itself.

4.3.1.2 Running Planner processes on different machinesAll Planner processes can be run from different computers connected over a common network.

The system administrator must ensure runtime configuration setup in the site.config.Planner file similar to the sample listed below:SW_HOST = machine__name_running_switch

SW_SM_PORT = unique_port#_smauto_connects_to_switch_at

PLAN_CENT_HOST = machine_name_running_smauto_1, machine_name_running_smauto_2, machine_name_running_smauto_3, ......., machine_name_running_smauto_n

PLAN_CENT_AUTO_PORT= single_port#_to_connect_to_smauto_1_to_n

Note: PLAN_CENT_AUTO_PORT is always a single port number enabling a Client to connect to one of the smauto processes acting as Scheduler. This way the Client retains connection to one of the “n” smauto processes even through a Scheduler failure followed by a Slot-generator promotion to Scheduler.

Now execute the Planner processes from the specified machines by following the instructions under “4.3.1.1 Running all Planner processes on a single machine” on page 4 - 9



4.4 STOPPING PLANNER

It is essential that Planner is completely shut down at the end of the session. The GUI (or plannerClient) process can be shut down using the mouse, but the other processes must be shut down individually.

This is important because any “leftover” processes can cause errors in the next Planner session.

4.4.1 Shut Down Planner GUISee “Shut Down Planner GUI” on page 3 - 15.

4.4.2 Shut Down Other Planner ProcessesSee “Shut Down Other Planner Processes” on page 3 - 15.

4.4.3 Shut Down Planner SwitchThe plannerSwitch process is a self redundant process and hence must be terminated with a “kill” command.

To shut down all instances of plannerSwitch process on a Linux platform type the following command in the process shell window:1. kill ‘pidof plannerSwitch‘



4.5 PLANNER FAILOVER TECHNIQUE

When any single one of the GUI processes fails, it can simply be restarted without loss of data. Recovery from failure of any other single process requires some consideration:

Mostly the Database backup process is the only process in the host system with persistent data (i.e. data that will survive a power failure), hence it is imperative that Database backup process is updated with Jobs in real-time. These updates must be passed directly to Database backup process from Data Interface before being passed to the Switch.

4.5.0.1 A new Job will travel as follows:

Please see the “4.1 Planner System Architecture based on Switch” on page 4 - 3 to see the processes involved and “1.2 Glossary” on page 1 - 4 for a brief definition of the same.

4.5.1 Planner FailOver SequencesThis section describes the data-flow of Planner failover system for its various components.

4.5.1.1 Slot-generator failureUpon Slot-generator failure, the Switch redirects all subsequent Slot-requests to the remaining Slot-generator(s). Any requests being processed by the failed Slot-generator will remain unanswered.

Data Interface Switch ⇔ Database backup process ⇔ Scheduler/Slot-

generatorCreates a new Job.

⇒ . ⇒ Stores the Job.

⇐ ⇐ Confirms receipt of Job.

Passes Job to Switch. ⇒ Stores Job in cache.

Also passes the Job to the Scheduler and Slot-gener-ators.Requests updates from the Scheduler at regular intervals.Receives information about the run the Job has been scheduled to and passes on to Slot-genera-tors.

⇒ ⇒

Inserts the Job into the schedule. Scheduler updates Allocators and Viewers.



4.5.1.1.1 Data-flow for restarting/adding a Slot-generator:

4.5.1.2 Scheduler failureA Scheduler failure involves promoting one of the Slot-generators to Scheduler. After the initial failover sequence, a Slot-generator can be added to restore performance.

4.5.1.2.1 Data-flow for Scheduler failure recovery, immediately after the Scheduler has died

4.5.1.3 Switch failureSwitches contain all Vehicle, Store and Job data as well as the latest schedule data from the Scheduler. The secondary Switch receives all data sent to the Scheduler and Slot-generators at all time.

4.5.1.3.1 Data-flow for Switch failure recovery, immediately after the primary Switch has died

Slot-generator ⇔ SwitchInitializes.Connects to Switch. ⇒ Copies the schedule to the Slot-genera-

tor.Waits for Slot-generator to advise that it has been fully reloaded

Receives the current schedule.When complete, advises Switch. ⇐

⇒ Starts sending Slot-requests.

⇐

Slot-generator 1 ⇔ Switch ⇔ Slot-generator 2Disconnects from old Sched-uler.Appoints Slot-generator 1 the new Scheduler.

Switches to “Scheduler mode”. ⇐

Starts scheduling Jobs.Sends updated plan toSwitch.

⇒Stores changes in cache.UpdatesSlot-generators

⇒ Updates plan.

Scheduler/Slot-generators ⇔ Data Interface ⇔ Switch

Disconnects from old Switch. Repeatedly attempts to con-nect to new Switch.

Disconnects from old Switch. Repeatedly attempts to con-nect to new Switch.

Detects primary Switch has died. Starts listening for SmAuto connections.



4.5.1.4 Data Interface failureData recovery after a process failure is never free of loss. At the time of failure, any Jobs that have been received by the Switch will be processed. Any Jobs that have not yet been sent will be lost.

Note: When a Data Interface fails, it must be restarted and re-connect to the Switch.

4.5.1.5 Database backup process failureThe main consideration with Database backup process failure is that no Jobs will be lost. This is effected by the handshake process between Data Interface and Database backup process.

Note: When Database backup process fails, it must be restarted and reconnect to the Switch. Any changes for the down time will simply be sent (upon request).

4.5.1.5.1 Data-flow for Database backup process failure recovery, immediately after Database backup process has died:

Connects to new Switch. ⇒ Scheduler connected.Listens for Data Interfaces.

Connects to new Switch.Checks for any unconfirmed Jobs, and passes them to the Switch.

⇐

⇒ Data Interface connected.

⇒ Receives an Job,Forwards to Scheduler and Slot-generators.Inserts the Job into the

schedule. Updates Opera-tors and Viewers.

⇐

Data Interface ⇔ Switch ⇔ Database backup processRepeatedly resends unconfirmed Jobs.attempt 1... ⇒

⇐ Restarts.Connects to Switch

attempt n ⇒ . ⇒ Data Interface connects.

⇒ ⇒ Stores the Job.Returns a receipt.

Sends Order toSwitch. Removes the Job from the list of unconfirmed Jobs.

⇐ ⇐

⇒ Passes the Job onto the Scheduler and Slot-generators. Over time, the Scheduler, moves the Job to other Shifts to lower overall costs and updatesSwitch. Sends updated Vehicles, Stores and Jobs,

⇐ Requests updates.

⇒ Stores in non-volatile database.

Scheduler/Slot-generators ⇔ Data Interface ⇔ Switch



4.5.1.6 Crash Recovery / initialisationThis section describes the process for a full (re-)initialisation of the Planner for Host System, as is required after planned or unplanned downtime.

The system may be brought on-line by starting all processes active during normal operation (see “4.3 Starting Planner” on page 4 - 9), after which:1. Data Interface sends all Vehicle, Shift and Store information to the Switch.2. Database backup process sends all current Job information to the Switch.3. Switch sends all Vehicle, Shift, Store and Job information to all SmAutos, Scheduler

and Slot-generators.


Chapter 5: Running Planner from Launch Pad

This chapter illustrates the various features available on the Launch Pad and its operations.



5.1 INTRODUCTION

Launch Pad is a graphical interface which helps in configuring and maintaining Planner. It facilitates the creation and modification of configuration files and selection of the configuration file and version of Planner to run. It also runs and monitors all the Planner processes.

Oracle Corporation provides a master config file with the Planner installation. This file contains the defaults, limits and description of the arguments. Launch Pad uses this file to generate the Edit configuration window’s display. See “5.2.4 Edit Mode” on page 5 - 5.

On starting Launch Pad, it generates the following two files:The Current Config file -this file tells Launch Pad the name for the last config file used so that the same can be loaded for restarting.The Current Version file -this file tells Launch Pad the last Planner version run so that the same can be used for restarting.

The settings used when running Planner are stored in the config file. These settings are not influenced when a new version is installed.

When the edit config button is pressed Launch Pad loads the master config file for the current release and overrides any arguments found in the current config file. No change is made to the current config file unless it is explicitly saved.

Note: All configuration options available on the Launch Pad can also be set from the commandline as described in “Appendix A: Run-time Configuration” on page A - 1. All the Launch Pad options in this chapter are cross-referenced to the corresponding commandline parameter in “Appendix A: Run-time Configuration” on page A - 1.



5.2 STARTING PLANNER FROM LAUNCH PAD

Planner can be run by any Allocator user whose environment has been set up as described in “2.3 Adding Allocator Users” on page 2 - 5.

To start Planner processes from the LaunchPad:

1. Log on as an Allocator user.2. Make sure that all previous Planner sessions have been properly closed down. See

“Stopping Planner from the LaunchPad” on page 5 - 8.This step is important because any “leftover” processes can cause errors in the current Planner session.

3. At the command prompt enter the Launch Pad runscript name - launchPlanner <return>

This “Launch Pad” window will be displayed by default in the Setup Mode as illustrated in the figure below (see section “5.2.3 Setup Mode” on page 5 - 5 for more details):

5.2.1 Configuring LaunchPad to run GuiServer

The Start GuiServer button is not available by default on LaunchPad. To enable this, type the following at the command prompt:

lpad_6_0.png

Run buttons



nmcConfig -enableGuiServer

Where nmcConfig is the executable for LaunchPad.

The LaunchPad should now startup with the Start GuiServer button as illustrated in the following image.

5.2.2 Main Display areaThe Main Display area on Launch Pad consists of:• Config and Version selection• Mode selections and• Process Start Buttons.

5.2.2.1 Configuration and Version selectionUser Name -displays the logged in user’s name.(Not implemented.)Current Config -is blank the first time Planner is run. The subsequent Planner runs display the configuration file name from the last Planner session. If multiple configuration files are available then the desired file can be selected from a pull down list. See “Introduction” on page 5 - 2Active Version -displays a pull down menu listing the available Planner versions read from the file: INSTALL_POINT/Planner/etc/planner.version .

5.2.2.2 Mode selection

lpad_GuiServer_10.2.png



Setup -allows setting up of the configuration controls. See “Setup Mode” on page 5 - 5.Edit -allows creation and editing of configuration files. See “Edit Mode” on page 5 - 5.Processes -displays and monitors all the running processes. See “Process Mode” on page 5 - 8.

5.2.2.3 Process Start buttonsStart Client -It is used for running multiple Clients. All the Client processes logs are directed to the same session from which launchPlanner was initiated.Start Server -It is used for running multiple server processes. All the server processes logs are directed to the same session from which launchPlanner was initiated.Start Switch -Starts the Switch process.Start GuiServer -Starts the GuiServer process.

Note: See, “5.2.1 Configuring LaunchPad to run GuiServer” on page 5 - 3 to enable any missing process start buttons on LaunchPad. See, “3.1 The Planner 10.5 processes” on page 3 - 2 for a complete list of Planner processes.

To start a process, Left Click the corresponding Start button.

5.2.3 Setup ModeBefore Planner is executed, the system manager must make sure that the configuration files describe: • the version of Planner that will be used,• the layout of display GUI that will be used,• the pathname of the maps that will be used, and• the run-time control configuration.

Setup facilitates selection of the Current Configuration file and the Current Planner version file to be loaded. The map file/path name and the run-time control configuration are set using the Edit option. See “Edit Mode” on page 5 - 5.

5.2.4 Edit ModeThe behaviour of Planner processes can be altered with the help of user specific configuration setups. The configuration setups are stored in editable text files and can



either be manually edited using a text editing utility or automatically generated from the Launch Pad while in Edit mode.

5.2.4.1 LaunchPad Configuration CategoriesThe configuration parameters are categorised into groups based on their functionality:• Switch Configuration - Parameters to specify the plan update interval and Switch

interface version are grouped under this category.• Site -All site specific configuration details are grouped under this

category. Please refer “5.4 Site Configuration” on page 5 - 11 for further details.

• Scheduling -All parameters (such as costs, real time parameters, Scheduler Controls, Shuffler and Performance Controls) which can affect the scheduling process are grouped under this category.

• GuiServer Configuration -All parameters (such as logging and Connectivity) which can affect the GuiServer process are grouped under this category.

• General Administration -Parameters (such as logging levels and Connectivity) which facilitate the general administration of all running processes are grouped under this category.

lpad_edt_10.2.png



• Display -All parameters (such as Map objects, GUI icons and layout styles) which can change the appearance of the Planner Display are grouped under this category.

5.2.4.2 Control buttonsThe following control buttons provide file level operations on the configuration files: • Save -Saves all configuration changes into the currently active

configuration file.• New -Opens a window as illustrated below into which a new

configuration file name can be entered. The existing values of all configuration parameters are also saved into this new file.

• Default Config -loads the default Planner configuration settings.• Delete Config File -Opens a window as illustrated below in which a listing of all

existing configuration file names are displayed. A file name can be selected from the listing with a Left Click. The selected file can be deleted from the disk with a Left Click on the "Delete" button.

lpad_new_cfg_10.2.png

lpad_edt_del_cfg_10.2.png



5.2.5 Process ModeThe Process mode displays and monitors all the currently running processes under Planner. The monitoring of running processes is grouped by configuration, showing the version of the running process and adding the ability to shut down the process or process group. (Viewing of logs is not yet implemented)

5.2.5.1 Stopping Planner from the LaunchPadIt is essential that Planner is completely shut down at the end of each session. This is important as “leftover” processes can cause errors while executing subsequent Planner sessions.

5.2.5.1.1 Configuration Shut DownAll the running processes grouped by a configuration can be stopped at once by selecting the configuration name under Processes and executing a Left Click on the Shutdown button.

5.2.5.1.2 Process Shut DownAny desired process can be individually shut down by selecting its process name in the process window and executing a Left Click on the Shutdown button.

Note: To shut down Planner processes from the commandline see “4.4 Stopping Planner” on page 4 - 12

lpad_process_10.2.png



5.3 SWITCH CONFIGURATION

5.3.1 General Switch Configuration

5.3.2 Switch to Switch

5.3.3 Switch Connections

Switch Configuration

Launch Pad option Corresponding Commandline ParameterOptimiser sync. interval See, “ SW_MAST_SYNC_INT or schedulerSyncInterval”

on page A - 105

Slot Gen. update interval See, “ SW_SLAVE_SYNC_INT or slotGenSyncInterval” on page A - 105

HIP Version See, “ SW_INTERFACE_VER or interfaceVersion” on page A - 105

Database Timeout See, “ SW_DB_TIMEOUT or dbTimeout” on page A - 105

Switch Command See, “ SW_RESTART_CMD or secondarySwitchCommand” on page A - 105

Slave Regeneration Timeout See, “ or slaveRegenerationTime” on page A - 105

Switch Configuration->Switch to Switch

Launch Pad option Corresponding Commandline ParameterSwitch Host Name See, “ SW_SEC_SW_HOST or switchHost” on

page A - 106

Switch Port See, “ SW_SEC_SW_PORT or switchPort” on page A - 106

Switch Timeout See, “ SW_SEC_TIMEOUT or switchTimeout” on page A - 106

Switch Promotion Time See, “ SW_PROMOTION_TIME or slavePromotionTime” on page A - 106

Switch Configuration->Switch Connections

Launch Pad option Corresponding Commandline ParameterApp. Server Port See, “ SW_APP_SRV_PORT or appSvrPort” on

page A - 106



Database Port See, “ SW_DB_PORT or dbPort” on page A - 106

Database Load Port See, “ SW_DB_LOAD_PORT or dbLoadPort” on page A - 107

Socket poll interval See, “ SW_POLL_INT or pollTimeInterval” on page A - 107

Max packets See, “ SW_MAX_PACKETS or maxPackets” on page A - 107

New Connection Poll Interval See, “ SW_CONN_POLL_INT or newConnectionPollInterval” on page A - 107

Max Connections/poll See, “ SW_CONN_HOG_COUNT or maxConnectionHog” on page A - 107

Max Connection backlog See, “ SW_CONN_BACKLOG or maxSocketConnectBacklog” on page A - 107

Socket Buffer Size (kb) See, “ SW_SOCK_BUF_SIZE or socketBufferSize” on page A - 108

Kernel Socket Buffer Size (kb) See, “ PLAN_IO_BUF_SIZE or io_bufsize” on page A - 12

Max. Wait on Blocked Socket (sec) See, “ SW_MAX_WAIT_BLOCK or maxWaitBlock” on page A - 108

Secure key file See, “ SW_SECURE_KEYFILE or secureKeyfile” on page A - 89

Trust CA file See, “ SW_TRUSTED_CA or trustedCAlist” on page A - 89

Use client authentication See, “ SW_VERIFY_CLIENT or verifyClient” on page A - 90

Switch Configuration->Switch Connections

Launch Pad option Corresponding Commandline Parameter



5.4 SITE CONFIGURATION

5.4.1 General Site Configuration

5.4.2 MapBefore starting Planner it is mandatory to set the path and file name for the required connectivity map. See “Maps” on page 2 - 3. The Coast and Zone files are optional.

The “Browse” button facilitates the selection of files from the local storage device.

5.4.2.1 Advanced MappingThis option controls the use of the following dynamic mapping functionalities:

Site Configuration

Launch Pad option Corresponding Commandline ParameterError Translation File See, “ PLAN_ERROR_TRANS or errorTranslationFile”

on page A - 3

Default UTC Offset See, “ PLAN_DEF_UTC_OFFSET or hipDefaultUTCoffset” on page A - 14

Site->Map

Launch Pad option Corresponding Commandline ParameterMap Name See, “ PLAN_MAP or map” on page A - 4

Zone File See, “ PLAN_ZONEFILE or zoneFile” on page A - 4

Site->Map->Advanced Mapping

Launch Pad option Corresponding Commandline ParameterOff Map Speed See, “ PLAN_INTRANODALSPEED or offMapSpeed” on

page A - 6

Matrix Distance Factor See, “ PLAN_MAP_DIST_FACTOR or matrixDistFactor” on page A - 6

Matrix Time Factor See, “ PLAN_MAP_TIME_FACTOR or matrixTimeFactor” on page A - 6

Matrix Toll Factor See, “ PLAN_MAP_TOLL_FACTOR or matrixTollFactor” on page A - 7

Map route cache memory limit (MB) See, “ PLAN_MAP_MEM_CACHE or routeCacheMemoryLimit” on page A - 7



Matrix Segmentation See, “ PLAN_MTRX_SEG or matrixSegmentation” on page A - 17

Read Map Names See, “ PLAN_MAP_READ_NAMES or readLinkNames and readNodeNames” on page A - 7

Distance Warning in meters See, “ PLAN_WARN_DIST or warnDist” on page A - 17

Log Map/matrix See, “ PLAN_LOG_MAP or logMap” on page A - 8

Site->Map->Advanced Mapping




5.5 CONFIGURING SCHEDULING PARAMETERS

5.5.1 Slot Generation Controls

5.5.2 Schedule CostsThe “Schedule Costs” is a grouping of Service Costs, Running Costs, Run Costs, Round Costs, Depot Costs, Business Priorities, Booking Factors, Attribute Conflicts and Apex Costs.

5.5.2.1 Service Costs

Scheduling

Launch Pad option Corresponding Commandline ParameterImmediate Assignment See, “ PLAN_IMMED_ASSIGN or

immediateAssignment” on page A - 16

Number of jobs inserted by one plan slicer See, “ PLAN_NUM_JOBS_INS or nJobsInsert” on page A - 16

Scheduling->Slot Generation Controls

Launch Pad option Corresponding Commandline ParameterSlot Generator Termination See, “ PLAN_SLOT_GEN_TERM or

slotGenTermination” on page A - 18

Slot Generator Filter See, “ PLAN_SLOT_GEN_FILTER or slotGenWinFilter” on page A - 19

Enable Chronological Filter See, “ PLAN_SGC_FILTER or slotGenChronologicalFilter” on page A - 18

Chronological Filter Tolerance See, “ PLAN_SGC_FILTER_TOL or slotGenChronologicalFilterTolerance” on page A - 18

Scheduling->Schedule Costs->Service Costs

Launch Pad option Corresponding Commandline ParameterCost Curve Limit See, “ PLAN_MAX_EXPONENT or maxExponent” on

page A - 20

Allocation Cost See, “ PLAN_ALLOCATION_COST or allocationCost” on page A - 20

Load Level Cost See, “ PLAN_LOAD_LVL_COST or loadLevelCost” on page A - 20



5.5.2.1.1 SLA Stop Cost

5.5.2.1.2 SLA Depot Cost

Max Load Level Cost See, “ PLAN_LOAD_LVL_MAX or loadLevelMax” on page A - 20

Scheduling->Schedule Costs->Service Costs->SLA Stop Cost

Launch Pad option Corresponding Commandline ParameterLate SLA Stop cost See, “ PLAN_SLA_STOP_COST or slaLateStopCost” on

page A - 21

slaWindowStopCost_TDC A See, “ PLAN_SLA_STOP_TDC or slaWindowStopCost_TDC” on page A - 21

slaWindowStopCost_TDC B

slaWindowStopCost_TDC C

slaWindowStopCost_TDC D

slaWindowStopCost_TDC E

slaWindowStopCost_TDC F

Scheduling->Schedule Costs->Service Costs->SLA Depot Cost

Launch Pad option Corresponding Commandline ParameterLate SLA Depot cost See, “ PLAN_SLA_DEPOT_COST or slaLateDepotCost”

on page A - 22.

slaWindowDepotCost_TDC A See, “ PLAN_SLA_DEPOT_TDC or slaWindowDepotCost_TDC” on page A - 22

slaWindowDepotCost_TDC B

slaWindowDepotCost_TDC C

slaWindowDepotCost_TDC D

slaWindowDepotCost_TDC E

slaWindowDepotCost_TDC F

Scheduling->Schedule Costs->Service Costs




5.5.2.1.3 Shift Promotion Cost

5.5.2.1.4 Pick-up Service Cost

5.5.2.1.5 Late Stop Cost

Scheduling->Schedule Costs->Service Costs->Shift Promotion Cost

Launch Pad option Corresponding Commandline ParameterShift Promotion Cost See, “ SHIFT_PROMOTION_COST or shiftPromotion”

on page A - 22.

shiftPromotion_TDC A See, “ SHIFT_PROMOTION_TDC or shiftPromotion_TDC” on page A - 23

shiftPromotion_TDC B

shiftPromotion_TDC C

shiftPromotion_TDC D

shiftPromotion_TDC E

shiftPromotion_TDC F

Scheduling->Schedule Costs->Service Costs->Pick-up Service Cost

Launch Pad option Corresponding Commandline ParameterPick-Up Service Cost A See, “ PLAN_PKUP_SRVC_COST or pkupServiceCost”

on page A - 23Pick-Up Service Cost B

Pick-Up Service Cost C

pkupServiceCost_TDC A See, “ PLAN_PKUP_SRVC_TDC or pkupServiceCost_TDC” on page A - 23

pkupServiceCost_TDC B

pkupServiceCost_TDC C

pkupServiceCost_TDC D

pkupServiceCost_TDC E

pkupServiceCost_TDC F

Scheduling->Schedule Costs->Service Costs->Late Stop Cost

Launch Pad option Corresponding Commandline ParameterLate Stop cost A See, “ PLAN_LATE_STOP_COST or lateStopCost” on

page A - 25Late Stop cost B

Late Stop cost C



5.5.2.1.6 Late Logoff Cost

5.5.2.1.7 Late Depot Cost

lateStopCost_TDC A See, “ PLAN_LATE_STOP_TDC or lateStopCost_TDC” on page A - 25

lateStopCost_TDC B

lateStopCost_TDC C

lateStopCost_TDC D

lateStopCost_TDC E

lateStopCost_TDC F

Scheduling->Schedule Costs->Service Costs->Late Logoff Cost

Launch Pad option Corresponding Commandline ParameterLate Logoff cost A See, “ PLAN_LATE_OFF_COST or lateOffCost” on

page A - 26Late Logoff cost B

Late Logoff cost C

lateOffCost_TDC A See, “ PLAN_LATE_OFF_TDC or lateOffCost_TDC” on page A - 26

lateOffCost_TDC B

lateOffCost_TDC C

lateOffCost_TDC D

lateOffCost_TDC E

lateOffCost_TDC F

Scheduling->Schedule Costs->Service Costs->Late Depot Cost

Launch Pad option Corresponding Commandline ParameterLate Depot cost A See, “ PLAN_LATE_DEPOT_COST or lateDepotCost”

on page A - 27Late Depot cost B

Late Depot cost C

Scheduling->Schedule Costs->Service Costs->Late Stop Cost




5.5.2.1.8 Drop Service Cost

5.5.2.2 Running CostsRunning Cost is the cost applied for the use of shifts and vehicles to deliver the services. It includes:

lateDepotCost_TDC A See, “ PLAN_LATE_DEPOT_TDC or lateDepotCost_TDC” on page A - 27

lateDepotCost_TDC B

lateDepotCost_TDC C

lateDepotCost_TDC D

lateDepotCost_TDC E

lateDepotCost_TDC F

Scheduling->Schedule Costs->Service Costs->Drop Service Cost

Launch Pad option Corresponding Commandline ParameterDrop Service Cost A See, “ PLAN_DROP_SRVC_COST or dropServiceCost”

on page A - 24Drop Service Cost B

Drop Service Cost C

dropServiceCost_TDC A See, “ PLAN_DROP_SRVC_TDC or dropServiceCost_TDC” on page A - 24

dropServiceCost_TDC B

dropServiceCost_TDC C

dropServiceCost_TDC D

dropServiceCost_TDC E

dropServiceCost_TDC F

Scheduling->Schedule Costs->Running Costs

Launch Pad option Corresponding Commandline ParameterHaul Cost See, “ PLAN_HAUL_COST or haulCost” on page A - 28

Vehicle Cost See, “ PLAN_VEHICLE_COST or vehicleCost” on page A - 28

Scheduling->Schedule Costs->Service Costs->Late Depot Cost




5.5.2.2.1 Time Window Cost

5.5.2.2.2 Time Cost

Scheduling->Scheduling Costs->Running Costs->Time Window Cost

Launch Pad option Corresponding Commandline ParameterTime Window Cost See, “ PLAN_WINDOW_COST or windowCost” on

page A - 28

windowCost_TDC A See, “ PLAN_WINDOW_TDC or windowCost_TDC” on page A - 29

windowCost_TDC B

windowCost_TDC C

windowCost_TDC D

windowCost_TDC E

windowCost_TDC F

Scheduling->Scheduling Costs->Running Costs->Time Cost

Launch Pad option Corresponding Commandline ParameterTime Cost See, “ PLAN_TIME_COST or timeCost” on page A - 29

timeCost_TDC A See, “ PLAN_TIME_TDC or timeCost_TDC” on page A - 29

timeCost_TDC B

timeCost_TDC C

timeCost_TDC D

timeCost_TDC E

timeCost_TDC F

Cost Break Time See, “ PLAN_COST_BREAK_TIME or costBreakTime” on page A - 30



5.5.2.2.3 Idle Time cost

5.5.2.2.4 Distance cost

5.5.2.3 Run CostsRun Cost is the cost applied to runs in the solution.

Scheduling->Scheduling Costs->Running Costs->Idle Time cost

Launch Pad option Corresponding Commandline ParameterIdle Time Cost See, “ PLAN_IDLE_COST or idleCost” on page A - 31

idleCost_TDC A See, “ PLAN_IDLE_TDC or idleCost_TDC” on page A - 31

idleCost_TDC B

idleCost_TDC C

idleCost_TDC D

idleCost_TDC E

idleCost_TDC F

Scheduling->Scheduling Costs->Running Costs->Distance cost

Launch Pad option Corresponding Commandline ParameterDistance Cost See, “ PLAN_DIST_COST or distCost” on page A - 32

distCost_TDC A See, “ PLAN_DIST_TDC or distCost_TDC” on page A - 32

distCost_TDC B

distCost_TDC C

distCost_TDC D

distCost_TDC E

distCost_TDC F

First Job Distance Factor See, “ PLAN_FIRSTJOB_DIST_FACTOR or firstJobDistanceFactor” on page A - 32

POU Distance Factor See, “ PLAN_POU_DIST_FACTOR or POU_DistanceFactor” on page A - 32

Scheduling->Scheduling Costs->Run Costs

Launch Pad option Corresponding Commandline ParameterRun Cost See, “ PLAN_RUN_COST or runCost” on page A - 33



5.5.2.3.1 Run Separation Cost

5.5.2.4 Round Costs

5.5.2.4.1 Round Length Cost

Scheduling->Scheduling Costs->Run Costs->Run Separation Cost

Launch Pad option Corresponding Commandline ParameterRun Separation cost A See, “ PLAN_RUN_SEPARATION or

runSeparationCost” on page A - 33Run Separation cost B

Run Separation cost C

runSeparationCost_TDC A See, “ PLAN_RUN_SEP_TDC or runSeparationCost_TDC” on page A - 33

runSeparationCost_TDC B

runSeparationCost_TDC C

runSeparationCost_TDC D

runSeparationCost_TDC E

runSeparationCost_TDC F

Scheduling->Scheduling Costs->Round Costs

Launch Pad option Corresponding Commandline ParameterRound Overlap Cost See, “ PLAN_ROUND_OL_COST or roundOverlapCost”

on page A - 34

Round Variance Cost See, “ PLAN_ROUND_VAR_COST or roundVarianceCost” on page A - 34

Round End Overlap See, “ PLAN_END_OVRLAP_COST or roundEndOverlapCost” on page A - 34

Absolute Round Extension (km) See, “ PLAN_ROUND_EXTN_ABS or roundExtensionAbs” on page A - 34

Relative Round Extension See, “ PLAN_ROUND_EXTN_REL or roundExtensionRel” on page A - 34

Round Length Variance Cost See, “ PLAN_RD_LEN_VAR_COST or roundLengthVarianceCost” on page A - 34

Scheduling->Scheduling Costs->Round Costs->Round Length Cost

Launch Pad option Corresponding Commandline ParameterRound Length Cost See, “ PLAN_ROUND_LEN_COST or roundLengthCost”

on page A - 35



5.5.2.4.2 Round Cost

5.5.2.5 Depot Costs

All Depot Costs except the "Depot capacity function doubling interval" have a default value NULL. The Depot Costs are:

5.5.2.5.1 Product/Depot Cost

roundLengthCost_TDC A See, “ PLAN_ROUND_LEN_TDC or roundLengthCost_TDC” on page A - 35

roundLengthCost_TDC B

roundLengthCost_TDC C

roundLengthCost_TDC D

roundLengthCost_TDC E

roundLengthCost_TDC F

Scheduling->Scheduling Costs->Round Costs->Round Cost

Launch Pad option Corresponding Commandline ParameterRound Cost See, “ PLAN_AREA_ROUND_COST or roundCost” on

page A - 35

roundCost_TDC A See, “ PLAN_AREA_ROUND_TDC or roundCost_TDC” on page A - 36

roundCost_TDC B

roundCost_TDC C

roundCost_TDC D

roundCost_TDC E

roundCost_TDC F

Scheduling->Scheduling Costs->Depot Costs->Product/Depot Cost

Launch Pad option Corresponding Commandline ParameterCost for using products from the particular depot

See, “ PLAN_PRO_DEPOT_COST or productDepotCost” on page A - 36

Cost for zero depot capacity See, “ PLAN_ZERO_CAP_COST or zeroCap” on page A - 37

Cost for max depot capacity See, “ PLAN_MAX_CAP_COST or maxCap” on page A - 37

Scheduling->Scheduling Costs->Round Costs->Round Length Cost




5.5.2.5.2 Depot Time Window Costs

5.5.2.6 Business PrioritiesBusiness Priorities are the cost applied on the solution so that it adheres to the company’s business rules.

Cost for depot capacity below target See, “ PLAN_BELOW_TGT_COST or drBelowTgt” on page A - 37

Cost for depot capacity above target See, “ PLAN_ABOVE_TGT_COST or drAboveTgt” on page A - 37

Depot capacity function doubling interval

See, “ PLAN_DEPOT_DBL_INT or depotCapacDoubleIntvlCoeff” on page A - 37

Scheduling->Scheduling Costs->Depot Costs->Depot Time Window Costs

Launch Pad option Corresponding Commandline ParameterDepot Time Window cost (weight) A See, “ PLAN_WIN_CAP_WGT or depotWinCapWeight”

on page A - 37Depot Time Window cost (weight) B

Depot Time Window cost (weight) C

Depot Time Window cost (volume) A See, “ PLAN_WIN_CAP_VOL or depotWinCapVolume” on page A - 37

Depot Time Window cost (volume) B

Depot Time Window cost (volume) C

Scheduling->Scheduling Costs->Business Priorities

Launch Pad option Corresponding Commandline ParameterCost for separation of sites/stops See, “ PLAN_SITE_SEP_COST or siteSeparationCost” on

page A - 38

Time interval for site separation (seconds)

See, “ PLAN_TIME_SLOT_WIDTH or timeSlotWidth” on page A - 38

Scheduling->Scheduling Costs->Depot Costs->Product/Depot Cost




5.5.2.6.1 Weight Cost

5.5.2.6.2 Wait Time Cost

Scheduling->Scheduling Costs->Business Priorities->Weight Cost

Launch Pad option Corresponding Commandline ParameterWeight Cost A See, “ PLAN_WEIGHT_COST or weightCost” on

page A - 39Weight Cost B

Weight Cost C

weightCost_TDC A See, “ PLAN_WEIGHT_TDC or weightCost_TDC” on page A - 39

weightCost_TDC B

weightCost_TDC C

weightCost_TDC D

weightCost_TDC E

weightCost_TDC F

Scheduling->Scheduling Costs->Business Priorities->Wait Time Cost (Sheet 1 of 2)

Launch Pad option Corresponding Commandline ParameterWait Time Cost See, “ PLAN_WAIT_COST or waitCost” on page A - 40

Wait Time Past Cost See, “ PLAN_WAIT_PAST_COST or waitCostPast” on page A - 40

Cost Logged Off Shifts See, “ PLAN_COSTWAIT_FOROFF or CostWait_forOff” on page A - 40

Wait Cost Horizon (hours) See, “ PLAN_COSTWAIT_HRZON or waitHorizon” on page A - 40

Maximum Wait Time (hours) See, “ PLAN_COSTWAIT_MAX or maxWait” on page A - 41

Maximum Wait Time Past (hours) See, “ PLAN_COSTWAIT_P_MAX or maxWaitPast” on page A - 41

waitCost_TDC A See, “ PLAN_WAIT_TDC or waitCost_TDC” on page A - 41

waitCost_TDC B

waitCost_TDC C

waitCost_TDC D

waitCost_TDC E

waitCost_TDC F



5.5.2.6.3 Volume Cost

5.5.2.6.4 Site Cost

waitCostPast_TDC A See, “ PLAN_WAIT_PAST_TDC or waitCostPast_TDC” on page A - 42

waitCostPast_TDC B

waitCostPast_TDC C

waitCostPast_TDC D

waitCostPast_TDC E

waitCostPast_TDC F

Scheduling->Scheduling Costs->Business Priorities->Volume Cost

Launch Pad option Corresponding Commandline ParameterVolume Cost A See, “ PLAN_VOLUME_COST or volumeCost” on

page A - 42Volume Cost B

Volume Cost C

volumeCost_TDC A See, “ PLAN_VOLUME_TDC or volumeCost_TDC” on page A - 42

volumeCost_TDC B

volumeCost_TDC C

volumeCost_TDC D

volumeCost_TDC E

volumeCost_TDC F

Scheduling->Scheduling Costs->Business Priorities->Site Cost

Launch Pad option Corresponding Commandline ParameterSite Cost See, “ PLAN_SITE_COST or siteCost” on page A - 43

siteCost_TDC A See, “ PLAN_SITE_TDC or siteCost_TDC” on page A - 43

siteCost_TDC B

siteCost_TDC C

siteCost_TDC D

siteCost_TDC E

siteCost_TDC F

Scheduling->Scheduling Costs->Business Priorities->Wait Time Cost (Sheet 2 of 2)




5.5.2.6.5 Shift Cost

5.5.2.6.6 Reserve Capacity Cost

Scheduling->Scheduling Costs->Business Priorities->shift Cost

Launch Pad option Corresponding Commandline ParameterShift Cost See, “ PLAN_TRIP_COST or tripCost” on page A - 43

tripCost_TDC A See, “ PLAN_TRIP_TDC or tripCost_TDC” on page A - 44

tripCost_TDC B

tripCost_TDC C

tripCost_TDC D

tripCost_TDC E

tripCost_TDC F

Scheduling->Scheduling Costs->Business Priorities->Reserve Capacity Cost

Launch Pad option Corresponding Commandline ParameterReserve Capacity Cost A See, “ PLAN_RES_CAP_COST or reserveCapacity” on

page A - 44Reserve Capacity Cost B

Reserve Capacity Cost C

reserveCapacity_TDC A See, “ PLAN_RES_CAP_TDC or reserveCapacity_TDC” on page A - 44

reserveCapacity_TDC B

reserveCapacity_TDC C

reserveCapacity_TDC D

reserveCapacity_TDC E

reserveCapacity_TDC F



5.5.2.6.7 Long Haul Cost

5.5.2.6.8 Life Span Cost

5.5.2.6.9 Jobs Limit Cost

Scheduling->Scheduling Costs->Business Priorities->Long Haul Cost

Launch Pad option Corresponding Commandline ParameterLong Haul cost See, “ PLAN_LONG_HAUL_COST or longHaulCost” on

page A - 45

longHaulCost_TDC A See, “ PLAN_LONG_HAUL_TDC or longHaulCost_TDC” on page A - 45

longHaulCost_TDC B

longHaulCost_TDC C

longHaulCost_TDC D

longHaulCost_TDC E

longHaulCost_TDC F

Scheduling->Scheduling Costs->Business Priorities->Life Span Cost

Launch Pad option Corresponding Commandline ParameterLife Span Cost A See, “ PLAN_LIFESPAN_COST or lifeSpanCost” on

page A - 45Life Span Cost B

Life Span Cost C

lifeSpanCost_TDC A See, “ PLAN_LIFESPAN_TDC or lifeSpanCost_TDC” on page A - 46

lifeSpanCost_TDC B

lifeSpanCost_TDC C

lifeSpanCost_TDC D

lifeSpanCost_TDC E

lifeSpanCost_TDC F

Scheduling->Scheduling Costs->Business Priorities->Jobs Limit Cost (Sheet 1 of 2)

Launch Pad option Corresponding Commandline ParameterJobs Limit Cost A See, “ PLAN_JOBS_LIMIT_COST or jobsLimit” on

page A - 46Jobs Limit Cost B

Jobs Limit Cost C



5.5.2.6.10 Empty Travel Cost

5.5.2.6.11 Dynamic Working Area Cost

jobsLimitCost_TDC A See, “ PLAN_JOBS_LIMIT_TDC or jobsLimit_TDC” on page A - 47

jobsLimitCost_TDC B

jobsLimitCost_TDC C

jobsLimitCost_TDC D

jobsLimitCost_TDC E

jobsLimitCost_TDC F

Scheduling->Scheduling Costs->Business Priorities->Empty Travel Cost

Launch Pad option Corresponding Commandline ParameterEmpty Travel Cost A See, “ PLAN_EMPTY_TRVL_COST or emptyTravelCost”

on page A - 47Empty Travel Cost B

Empty Travel Cost C

emptyTravelCost_TDC A See, “ PLAN_EMPTY_TRVL_TDC or emptyTravelCost_TDC” on page A - 47

emptyTravelCost_TDC B

emptyTravelCost_TDC C

emptyTravelCost_TDC D

emptyTravelCost_TDC E

emptyTravelCost_TDC F

Scheduling->Scheduling Costs->Business Priorities->Dynamic Working Area Cost (Sheet 1 of 2)

Launch Pad option Corresponding Commandline ParameterDynamic Working Area Cost A See, “ PLAN_DNMK_WA_COST or

dnmkWorkingAreaCost” on page A - 48Dynamic Working Area Cost B

Dynamic Working Area Cost C

Scheduling->Scheduling Costs->Business Priorities->Jobs Limit Cost (Sheet 2 of 2)




5.5.2.6.12 Break Late Cost

5.5.2.7 Conditional Assignment During Conditional Booking each cost component (of the insertion cost) is multiplied by its corresponding factor. This value is then tested against the MAXCOST supplied in the JOB_ASSING_COND packet. If any of the factorised components exceed the MAXCOST the Job Assignment will fail. The first failed cost component name is printed together with the total cost of insertion and all component costs. The costs printed are not factorised, they are the actual cost differences. If none of the factorised components exceed the MAXCOST the Job Assignment is accepted.

The default value for all cost factors is 1 and the valid range is 0-1000.

The following examples will illustrate how individual costs are considered during conditional job booking/assignment bases on the corresponding cost factor values:

To exclude a cost (say distance cost) from the consideration (during booking) -

set "Distance Booking Factor" = 0

DynamicWorkingArea_TDC A See, “ PLAN_DNMK_WA_TDC or dnmkWorkingAreaCost_TDC” on page A - 48

DynamicWorkingArea_TDC B

DynamicWorkingArea_TDC C

DynamicWorkingArea_TDC D

DynamicWorkingArea_TDC E

DynamicWorkingArea_TDC F

Scheduling->Scheduling Costs->Business Priorities->Break Late Cost

Launch Pad option Corresponding Commandline ParameterBreak Late Cost A See, “ PLAN_BREAK_LATE_COST or breakLateCost” on

page A - 48Break Late Cost B

Break Late Cost C

breakLate_TDC A See, “ PLAN_BREAK_LATE_TDC or breakLate_TDC” on page A - 49

breakLate_TDC B

breakLate_TDC C

breakLate_TDC D

breakLate_TDC E

breakLate_TDC F

Scheduling->Scheduling Costs->Business Priorities->Dynamic Working Area Cost (Sheet 2 of 2)




To double a cost (say stop late cost) -

set "Stop Late Booking Factor" = 2

The Booking Factors are segregated into four groups within the launch Pad.

5.5.2.7.1 Violation Cost Factors

5.5.2.7.2 Travel Cost Factors

Scheduling->Scheduling Costs->Conditional Assignment

Launch Pad option Corresponding Commandline ParameterDelete Rejected Job See, “ PLAN_DEL_REJ_JOB or deleteRejectedJob” on

page A - 94

Scheduling->Scheduling Costs->Conditional Assignment->Violation Cost Factors

Launch Pad option Corresponding Commandline ParameterOverLoad Booking Factor See, “ PLAN_LOADCOST_FACTOR or load_factor” on

page A - 50

jobAttr Booking Factor See, “ PLAN_JOBATTR_FACTOR or jobAttr_factor” on page A - 50

singleLink Booking Factor See, “ PLAN_S_LINK_FACTOR or singleLink_factor” on page A - 50

singleItem Booking Factor See, “ PLAN_S_ITEM_FACTOR or singleItem_factor” on page A - 50

lifeSpan/runDuration Booking Factor

See, “ PLAN_LIFESPAN_FACTOR or lifeSpan_factor” on page A - 50

compat Booking Factor See, “ PLAN_COMPAT_FACTOR or compat_factor” on page A - 50

overSkill Booking Factor See, “ PLAN_OVERSKILL_FACTOR or overSkill_factor” on page A - 50

rsrcAttr Booking Factor See, “ PLAN_RSRCATTR_FACTOR or rsrcAttr_factor” on page A - 50

Zone Booking Factor See, “ PLAN_ZONE_FACTOR or zone_factor” on page A - 50

Maps Booking Factor See, “ PLAN_MAPS_FACTOR or maps_factor” on page A - 50



5.5.2.7.3 Time Violation Cost Factors

5.5.2.7.4 Service Cost Factors

Scheduling->Scheduling Costs->Conditional Assignment->Travel Cost Factors

Launch Pad option Corresponding Commandline ParameterDistance Booking Factor See, “ PLAN_DIST_FACTOR or dist_factor” on page A - 51

Travel Time Booking Factor See, “ PLAN_TRVLTIME_FACTOR or travelTime_factor” on page A - 51

Idle Time Booking Factor See, “ PLAN_IDLETIME_FACTOR or idleTime_factor” on page A - 51

longHaul Booking Factor See, “ PLAN_LONGHAUL_FACTOR or longHaul_factor” on page A - 51

Apex Booking Factor See, “ PLAN_APEX_FACTOR or apex_factor” on page A - 51

manyShift Booking Factor See, “ PLAN_MANYSHFT_FACTOR or manyShift_factor” on page A - 51

Wait Booking Factor See, “ PLAN_WAIT_FACTOR or wait_factor” on page A - 51

emptyTravel Booking Factor See, “ PLAN_EMP_TRVL_FACTOR or emptyTravel_factor” on page A - 51

Run Booking Factor See, “ PLAN_RUN_FACTOR or run_factor” on page A - 51

Scheduling->Scheduling Costs->Conditional Assignment->Time Violation Cost Factors

Launch Pad option Corresponding Commandline ParameterStop Late Booking Factor See, “ PLAN_STOPLATE_FACTOR or stopLate_factor” on

page A - 52

Depot Late Booking Factor See, “ PLAN_DEP_LATE_FACTOR or depotLate_factor” on page A - 52

Overtime Booking Factor See, “ PLAN_OFFLATE_FACTOR or offLate_factor” on page A - 52

haulExtend Booking Factor See, “ PLAN_HAULEXT_FACTOR or haulExtend_factor” on page A - 52

breakLate Booking Factor See, “ PLAN_BRKLATE_FACTOR or breakLate_factor” on page A - 52



5.5.2.8 Attribute ConflictsThis is the cost applied to the solution to minimize the following attribute mismatch:

5.5.2.8.1 Over Skill Cost

5.5.2.8.2 RSRC ATTR Cost

Scheduling->Scheduling Costs->Conditional Assignment->Service Cost Factors

Launch Pad option Corresponding Commandline ParameterWindow Booking Factor See, “ PLAN_WINDOW_FACTOR or window_factor” on

page A - 53

Site Booking Factor See, “ PLAN_SITE_FACTOR or site_factor” on page A - 53

pkupService Booking Factor See, “ PLAN_PKUPSRVC_FACTOR or pkupService_factor” on page A - 53

dropService Booking Factor See, “ PLAN_DROPSRVC_FACTOR or dropService_factor” on page A - 53

runSeparation Booking Factor See, “ PLAN_RUN_SEP_FACTOR or runSeparation_factor” on page A - 53

reserveCap Booking Factor See, “ PLAN_RES_CAP_FACTOR or reserveCap_factor” on page A - 53

depotProduct Booking Factor See, “ PLAN_DPT_PROD_FACTOR or depotProduct_factor” on page A - 53

Scheduling->Schedule Costs->Attribute Conflicts->Over Skill Cost

Launch Pad option Corresponding Commandline ParameterOVER SKILL Cost See, “ PLAN_OVER_SKILL_COST or overSkillCost” on

page A - 54

overSkillCost_TDC A See, “ PLAN_OVER_SKILL_TDC or overSkillCost_TDC” on page A - 54

overSkillCost_TDC B

overSkillCost_TDC C

overSkillCost_TDC D

overSkillCost_TDC E

overSkillCost_TDC F



5.5.2.8.3 JOb ATTR Cost

Scheduling->Schedule Costs->Attribute Conflicts->RSRC ATTR Cost

Launch Pad option Corresponding Commandline ParameterRSRC ATTR Cost See, “ PLAN_RSRC_ATTR_COST or rsrcAttrCost” on

page A - 56

rsrcAttrCost_TDC A See, “ PLAN_RSRC_ATTR_TDC or rsrcAttrCost_TDC” on page A - 56

rsrcAttrCost_TDC B

rsrcAttrCost_TDC C

rsrcAttrCost_TDC D

rsrcAttrCost_TDC E

rsrcAttrCost_TDC F

Scheduling->Schedule Costs->Attribute Conflicts->JOb ATTR Cost

Launch Pad option Corresponding Commandline ParameterJOb ATTR Cost See, “ PLAN_JOB_ATTR_COST or jobAttrCost” on

page A - 55

JObAttrCost_TDC A See, “ PLAN_JOB_ATTR_TDC or jobAttrCost_TDC” on page A - 55

JObAttrCost_TDC B

JObAttrCost_TDC C

JObAttrCost_TDC D

JObAttrCost_TDC E

JObAttrCost_TDC F



5.5.2.8.4 Round Zone Cost

5.5.2.8.5 Stop Zone Cost

5.5.2.9 Apex CostsApex Cost is the cost against the last stop in the ’run’ not being the furthest from the depot. The effect is to generate runs that terminate at the point furthest from the depot, in order to be able to cover the greatest area on the journey.

Scheduling->Schedule Costs->Attribute Conflicts->Round Zone Cost

Launch Pad option Corresponding Commandline ParameterRound Zone Cost See, “ PLAN_RND_ZONE_COST or roundZoneCost” on

page A - 57

roundZoneCost_TDC A See, “ PLAN_RND_ZONE_TDC or roundZoneCost_TDC” on page A - 57

roundZoneCost_TDC B

roundZoneCost_TDC C

roundZoneCost_TDC D

roundZoneCost_TDC E

roundZoneCost_TDC F

Scheduling->Schedule Costs->Attribute Conflicts->Stop Zone Cost

Launch Pad option Corresponding Commandline ParameterStop Zone Cost See, “ PLAN_STOP_ZONE_COST or stopZoneCost” on

page A - 57

stopZoneCost_TDC A See, “ PLAN_STOP_ZONE_TDC or stopZoneCost_TDC” on page A - 58

stopZoneCost_TDC B

stopZoneCost_TDC C

stopZoneCost_TDC D

stopZoneCost_TDC E

stopZoneCost_TDC F

Scheduling->Schedule Costs->Apex Costs (Sheet 1 of 2)

Launch Pad option Corresponding Commandline ParameterApex Cost See, “ PLAN_APEX_COST or apexCost” on page A - 58

Apex Round Distance (km) See, “ PLAN_APEX_RND_DIST or apexRoundDist” on page A - 58



5.5.3 Real TimeThese options control Planner’s real time functionality.

Apex Shift Ratio A See, “ PLAN_APEX_RATIO_A or apexShiftRatioA” on page A - 59

Apex Shift Ratio B See, “ PLAN_APEX_RATIO_B or apexShiftRatioB” on page A - 59

Cost by Round See, “ PLAN_COST_BY_ROUND or costByRound” on page A - 59

apexCost_TDC A See, “ PLAN_APEX_TDC or apexCost_TDC” on page A - 59

apexCost_TDC B

apexCost_TDC C

apexCost_TDC D

apexCost_TDC E

apexCost_TDC F

Scheduling->Real Time

Launch Pad option Corresponding Commandline ParameterSetting for dead-reckoning See, “ PLAN_REAL_TIME or realTime” on page A - 60

RSRC Relocation See, “ PLAN_DR_TIMEINTERVAL or timeInterval” on page A - 60

Auto Complete logon stops See, “ PLAN_DR_AUTOCOMPLGON or autoCompleteLogOn” on page A - 60

Only dead-reckon towards enroute Stop

See, “ PLAN_DR_WAIT_ENROUTE or waitForEnroute” on page A - 60

Process all stops at a site See, “ PLAN_DR_ALL_AT_SITE or processAllAtSite” on page A - 60

Automatic go_home See, “ PLAN_AUTO_GO_HOME or autoGoHome” on page A - 61

Idle time before going home See, “ PLAN_GO_HOME_TIME or goHomeTime” on page A - 61

Average vehicle time-to-active See, “ PLAN_TIME_TO_ACTIVE or vehicleTimeToActive” on page A - 62

Unexpected Event Compensator See, “ PLAN_UE_COMPENSATOR or bUEC” on page A - 62

UEC Cost Threshold See, “ PLAN_UEC_THRESHOLD or UEC_costThreshold” on page A - 62

Scheduling->Schedule Costs->Apex Costs (Sheet 2 of 2) (Continued)




Note: Please refer the companion Planner host interface manual for more details on the Shift packet format.

5.5.3.1 Reference Time

Complete Dist See, “ PLAN_COMPLETE_DIST or completeDist” on page A - 63

LaunchPad and Shift settings enable/disable sending of automatic Go_home instruction to Vehicles

Launch Pad Setting(Automatic go_home)

Shift Setting(AUTO_GO_HOME

Scheduler sends Vehiclehome automatically

Off YES NO

Off NO NO

On YES YES

On NO NO

All YES YES

All NO YES

Scheduling->Real Time->Reference Time

Launch Pad option Corresponding Commandline Parameterstart of Ref time updates See, “ PLAN_START_REF_TIME or startTimeRT” on

page A - 64

Interval of Ref Time updates See, “ PLAN_INTVAL_REF_TIME or intervalRT” on page A - 64

Scheduling->Real Time




5.5.3.2 Dispatch Message

Sets the optional stop info text field[1…8] for MDT. The required customer data fields can be selected from the pull down list associated with each of the 8 Dispatch Message option on the launchpad.

5.5.4 Optimiser Controls

Scheduling->Real Time->Dispatch Message

Launch Pad option Corresponding Commandline ParameterStop Text 1 See, “ PLAN_DESP_TEXT_1 or optStopText1” on

page A - 64

Stop Text 2 See, “ PLAN_DESP_TEXT_2 or optStopText2” on page A - 64







Scheduling->Optimiser Controls

Launch Pad option Corresponding Commandline ParameterShift Time Window Interval Extension

See, “ PLAN_SHIFT_TIME_EXT or ShiftWinExtension” on page A - 65

Minimum Inter-Stop Time See, “ PLAN_MIN_TRVL_TIME or minTravelTime” on page A - 65

Non-Job Minimum Inter-Stop Time See, “ PLAN_MIN_TRVL_NONJOB or applyMinTravelTimeToNonStop” on page A - 65

IDB Opt. Level See, “ PLAN_IDB_OPT_LEVEL or idbOptLevel” on page A - 65

Load Factor See, “ PLAN_LOAD_FACTOR or loadFactor” on page A - 66

Stop Late Arrival See, “ PLAN_ST_LATE_BY_ARR or stopLateByArrival” on page A - 66



5.5.4.1 TSP

5.5.4.2 Shuffler Controls

5.5.4.2.1 Shift Swap

Depot Late Arrival See, “ PLAN_DPT_LATE_BY_ARR or depotLateByArrival” on page A - 66

Fixed Logon Default See, “ PLAN_FIXED_LOGON or FixedLogonDefault” on page A - 67

Relative Over Capacity of Depots See, “ PLAN_REL_OVERCAP or relOverCap” on page A - 68

DepotCapacityTWRule See, “ PLAN_DEPOTCAPTWRULE or DepotCapacityTWRule” on page A - 69

Optional Assignment See, “ PLAN_OPT_ASSIGN_MODE or optAssignMode” on page A - 69

Arrival Margin (minutes) See, “ PLAN_ARRIVAL_MARGIN or arrivalMargin” on page A - 69

TW Segmentation (secs) See, “ PLAN_TWS_SEGMENTATION or timeWindowsSegmentation” on page A - 70

Scheduling->Optimiser Controls->TSP

Launch Pad option Corresponding Commandline ParameterTravel Radius Time See, “ PLAN_TSP_CLASS_TIME or tspClassTime” on

page A - 70

Scheduling->Optimiser Controls->Shuffler Controls

Launch Pad option Corresponding Commandline ParameterStops in search Area See, “ PLAN_SEARCH_AREA or stopsInSearchArea” on

page A - 71

Multiplier for number of stops in cluster

See, “ PLAN_REL_CLER_SIZE or relClusterSize” on page A - 71

Scheduling->Optimiser Controls->Shuffler Controls->Shift Swap

Launch Pad option Corresponding Commandline ParameterShift shuffler initial See, “ PLAN_SHIFT or shiftMove_initRelFreq” on

page A - 71

Scheduling->Optimiser Controls




5.5.4.2.2 Segment Move

5.5.4.2.3 Run Swap

5.5.4.2.4 Insert Move

5.5.4.2.5 Filling Shifts

Shift shuffler final See, “ PLAN_SHIFT_LAST or shiftMove_lastRelFreq” on page A - 71

Scheduling->Optimiser Controls->Shuffler Controls->Segment Move

Launch Pad option Corresponding Commandline ParameterSegment shuffler initial See, “ PLAN_SEGMENT or segmentMove_initRelFreq” on

page A - 72

Segment shuffler final See, “ PLAN_SEGMENT_LAST or segmentMove_lastRelFreq” on page A - 72

Scheduling->Optimiser Controls->Shuffler Controls->Run Swap

Launch Pad option Corresponding Commandline ParameterRun shuffler initial See, “ PLAN_RUN or runMove_initRelFreq” on

page A - 72

Run shuffler final See, “ PLAN_RUN_LAST or runMove_lastRelFreq” on page A - 72

Scheduling->Optimiser Controls->Shuffler Controls->Insert Move

Launch Pad option Corresponding Commandline ParameterInsert Move shuffler initial See, “ PLAN_INSERTMOVE or insertMove_initRelFreq”

on page A - 73

Insert Move shuffler final See, “ PLAN_INSERTMOVE_LAST or insertMove_lastRelFreq” on page A - 73

Scheduling->Optimiser Controls->Shuffler Controls->Shift Swap




Scheduling->Optimiser Controls->Shuffler Controls->Filling Shifts

Launch Pad option Corresponding Commandline ParameterFill Shift shuffler initial See, “ PLAN_FILLSHIFT or fillShift_initRelFreq” on

page A - 73

Fill Shift shuffler final See, “ PLAN_FILLSHIFT_LAST or fillShift_lastRelFreq” on page A - 73



5.5.4.2.6 Fill Idle Shift

5.5.4.2.7 Fill Gaps

5.5.4.2.8 Depot Move

5.5.4.2.9 Deallocation

Scheduling->Optimiser Controls->Shuffler Controls->Fill Idle Shift

Launch Pad option Corresponding Commandline ParameterFill Idle shuffler initial See, “ PLAN_FILL_IDLE or fillIdle_initRelFreq” on

page A - 74

Fill Idle shuffler final See, “ PLAN_FILL_IDLE_LAST or fillIdle_lastRelFreq” on page A - 74

Scheduling->Optimiser Controls->Shuffler Controls->Fill Gaps

Launch Pad option Corresponding Commandline ParameterFill Gap shuffler initial See, “ PLAN_FILLGAP or fillTheGap_initRelFreq” on

page A - 74

Fill Gap shuffler final See, “ PLAN_FILLGAP_LAST or fillTheGap_lastRelFreq” on page A - 74

Scheduling->Optimiser Controls->Shuffler Controls->Depot Move

Launch Pad option Corresponding Commandline ParameterDepot Move shuffler initial See, “ PLAN_DEPOTMOVE or depotMove_initRelFreq”

on page A - 74

Depot Move shuffler final See, “ PLAN_DEPOTMOVE_LAST or depotMove_lastRelFreq” on page A - 74

Scheduling->Optimiser Controls->Shuffler Controls->Deallocation

Launch Pad option Corresponding Commandline ParameterDeallocation shuffler initial See, “ PLAN_DEALLOC or deAllocMove_initRelFreq” on

page A - 75

Deallocation shuffler final See, “ PLAN_DEALLOC_LAST or deAllocMove_lastRelFreq” on page A - 75



5.5.4.2.10 Cluster Group

5.5.4.2.11 Allocation

Warning: - Do not change any default value under the Shuffler Controls option, unless advised by Oracle Corporation

5.5.4.3 POU Controls

5.5.4.4 Plan Init Controls

Scheduling->Optimiser Controls->Shuffler Controls->Cluster Group

Launch Pad option Corresponding Commandline ParameterCluster shuffler initial See, “ PLAN_CLUSTER or clusterMove_initRelFreq” on

page A - 75

Cluster shuffler final See, “ PLAN_CLUSTER_LAST or clusterMove_lastRelFreq” on page A - 75

Multiplier for ratio between sites and stops in a cluster

See, “ PLAN_SITE_RESTRICT or sameSiteRestrict” on page A - 75[

Scheduling->Optimiser Controls->Shuffler Controls->Allocation

Launch Pad option Corresponding Commandline ParameterAllocation shuffler initial See, “ PLAN_ALLOC or allocMove_initRelFreq” on

page A - 76

Allocation shuffler final See, “ PLAN_ALLOC_LAST or allocMove_lastRelFreq” on page A - 76

Scheduling->Optimiser Controls->POU Controls

Launch Pad option Corresponding Commandline ParameterPOU scheduling behaviour See, “ PLAN_TREAT_POU_AS or treatPouAs” on

page A - 76

Scheduling->Optimiser Controls->Plan Init Controls

Launch Pad option Corresponding Commandline ParameterINIT Travel Radius See, “ PLAN_INIT_CLASS_TIME or initClassTime” on

page A - 78

Max Late Time INIT See, “ PLAN_PI_MAX_LATE or piMaxLate” on page A - 78

Short Routes First See, “ PLAN_PI_SHORT_FIRST or piShortRoutesFirst” on page A - 78



5.5.4.5 Performance Controls

5.5.4.6 Bound Jobs

INIT Max. Tramp See, “ PLAN_INIT_MAX_TRAMP or initMaxTramp” on page A - 78

Scheduling->Optimiser Controls->Performance Controls

Launch Pad option Corresponding Commandline ParameterCascade Chance See, “ PLAN_PC_CASCADE or pcCascadeChance” on

page A - 79

Cost Limit See, “ PLAN_COST_LIMIT or costLimit” on page A - 79

Scheduler mode See, “ PLAN_SCHED_MODE or schedMode” on page A - 79

Lowest scheduling temperature See, “ PLAN_SCHED_MIN_TEMP or schedMinTemp” on page A - 79

Highest scheduling temperature See, “ PLAN_SCHED_MAX_TEMP or schedMaxTemp” on page A - 79

Minimum temperature/unit drop in cost

See, “ PLAN_SCHED_HEAT_RATE or schedHeatRate” on page A - 80

Fixed or intended duration See, “ PLAN_SCHED_DURATION or schedDuration” on page A - 80

Max number of polynomial terms See, “ PLAN_MAX_TERM or maxTerm” on page A - 80

Optimisation runs See, “ PLAN_OPT_RUNS or nOptRuns” on page A - 80

Scheduling->Optimiser Controls->Bound Jobs

Launch Pad option Corresponding Commandline ParameterSub-Window Width (mins) See, “ PLAN_SUB_WIN_WIDTH or

autoSubWindowWidth” on page A - 81

Scheduling->Optimiser Controls->Plan Init Controls




5.6 GUISERVER CONFIGURATION

GuiServer connects multiple plannerClients to smauto. View filtering is done only by the GuiServer process.

5.6.1 GuiServer Connections

GuiServer Configuration

Launch Pad option Corresponding Commandline ParameterGuiServer views See, “ GS_VIEW or guiServerView” on page A - 113

GuiServer dates See, “ GS_DATE or guiServerDate” on page A - 113

GuiServer Configuration->GuiServer Connections

Launch Pad option Corresponding Commandline ParameterClient Port See, “ GS_CLIENT_PORT or clientPort” on page A - 114

Plan update interval (GuiServer) See, “ GS_REQ_INTERVAL or requestInterval” on page A - 114

Socket poll interval See, “ GS_POLL_INT or pollTimeInterval” on page A - 114

Max packets See, “ GS_MAX_PACKETS or maxPackets” on page A - 115

New Connection Poll Interval See, “ GS_CONN_POLL_INT or newConnectionPollInterval” on page A - 115

Max Connections/poll See, “ GS_CONN_HOG_COUNT or maxConnectionHog” on page A - 115

Socket Buffer Size (kb) See, “ GS_SOCK_BUF_SIZE or socketBufferSize” on page A - 116


Max. Wait on Blocked Socket (sec) See, “ GS_MAX_WAIT_BLOCK or maxWaitBlock” on page A - 116

Secure key file See, “ GS_SECURE_KEYFILE or secureKeyfile” on page A - 115

Trust CA file See, “ GS_TRUSTED_CA or trustedCAlist” on page A - 115

Use client authentication See, “ GS_VERIFY_CLIENT or verifyClient” on page A - 115



5.7 GENERAL ADMINISTRATION CONFIGURATION

5.7.1 User Access Control

5.7.2 Logging

General Administration

Launch Pad option Corresponding Commandline ParameterEnable Exit See, “ PLAN_NO_EXIT or NoExit” on page A - 14

Test Level See, “ PLAN_TEST_LEVEL or testLevel” on page A - 15

Lock Directory See, “ PLAN_LOCK_DIR or lockDir” on page A - 94

Multiple Instances See, “ PLAN_NOLOCK or noLock” on page A - 94

General Administration->User Access Control

Launch Pad option Corresponding Commandline ParameterUser access control file See, “ PLAN_ACCESS_FILE or userAccessControlFile”

on page A - 81

User access group file See, “ PLAN_ACC_GROUP_FILE or userAccessGroupFile” on page A - 81

Warn Days to Expire See, “ PLAN_WARN_DAYS_EXP or warnDaysToExpired” on page A - 82

Max. logon attempts See, “ PLAN_MAX_PASS_ATMPTS or maxAttemptBeforeDisable” on page A - 82

Password Valid Days See, “ PLAN_PASSWORD_EXP or passwordValidDays” on page A - 82

General Administration->Logging

Launch Pad option Corresponding Commandline ParameterLog level See, “ PLAN_LOG_LEVEL or logLevel” on page A - 15

Process Duration Level See, “ PLAN_PROCESS_DURATION or processDurationLevel” on page A - 15



5.7.2.1 Switch Log

5.7.2.2 Server Log

General Administration->Logging->Switch Log

Launch Pad option Corresponding Commandline ParameterPacket receive log See, “ SW_LOG_RECV or rxHipLogging” on page A - 109

Packet transmit log See, “ SW_LOG_TRANS or txHipLogging” on page A - 109

Log to file See, “ SW_LOG_TO_FILE or logToFile_MSG” on page A - 108

Don’t log to stdout See, “ PLAN_NO_LOG_STDOUT or noLogStdOut” on page A - 11

Log file See, “ SW_LOG_PREFIX or logFilePrefix_MSG” on page A - 108

Log Hours See, “ SW_LOG_HOURS or logHours_MSG” on page A - 108

Number of stored Log files See, “ SW_LOG_FILES or numLogFiles_MSG” on page A - 109

Log compress command See, “ PLAN_LOG_COMPRESS or logCompress” on page A - 11

General Administration->Logging->Server Log

Launch Pad option Corresponding Commandline ParameterPacket receive log (smauto) See, “ PLAN_RX_HIP_LOGGING or rxHipLogging” on

page A - 83

Packet transmit log (smauto) See, “ PLAN_TX_HIP_LOGGING or txHipLogging” on page A - 83

Log to file See, “ PLAN_LOG_TO_FILE or logToFile_MSG” on page A - 83


Log file See, “ PLAN_LOG_PREFIX or logFilePrefix_MSG” on page A - 83

Log Hours See, “ PLAN_LOG_HOURS or logHours_MSG” on page A - 83

Number of stored Log files See, “ PLAN_LOG_FILES or numLogFiles_MSG” on page A - 84




5.7.2.3 GuiServer Log

5.7.2.4 Client Log

General Administration->Logging->GuiServer Log

Launch Pad option Corresponding Commandline ParameterPacket receive log See, “ GS_LOG_RECV or rxHipLogging” on page A - 117

Packet transmit log See, “ GS_LOG_TRANS or txHipLogging” on page A - 117

Log to file See, “ GS_LOG_TO_FILE or logToFile_MSG” on page A - 117


Log File See, “ GS_LOG_PREFIX or logFilePrefix_MSG” on page A - 117

Log Hours See, “ GS_LOG_HOURS or logHours_MSG” on page A - 117

Number of stored Log files See, “ GS_LOG_FILES or numLogFiles_MSG” on page A - 118


General Administration->Logging->Client Log

Launch Pad option Corresponding Commandline ParameterPacket receive log (client) See, “ NMC_LOG_RECV or rxHipLogging” on page A - 96

Packet transmit log (client) See, “ NMC_LOG_TRANS or txHipLogging” on page A - 96

Log to file See, “ NMC_LOG_TO_FILE or logToFile_MSG” on page A - 96


Log File See, “ NMC_LOG_PREFIX or logFilePrefix_MSG” on page A - 96

Log Hours See, “ NMC_LOG_HOURS or logHours_MSG” on page A - 96

Number of stored Log files See, “ NMC_LOG_FILES or numLogFiles_MSG” on page A - 96




5.7.3 Connection

5.7.3.1 Server Controls

5.7.3.1.1 Host Connection

General Administration->Connection

Launch Pad option Corresponding Commandline Parametersmauto Host Name See, “ PLAN_CENT_HOST or hostName” on page A - 8

Client Port See, “ PLAN_CENT_AUTO_PORT or serverPort” on page A - 85

Socket Buffer Size (kb) See, “ PLAN_USER_BUF_SIZE or socketBufferSize” on page A - 84


Max. Wait on Blocked Socket (sec) See, “ PLAN_USER_BUF_WAIT or maxWaitBlock” on page A - 84

Use secure socket communication

General Administration->Connection->Server Controls

Launch Pad option Corresponding Commandline ParameterPoll time interval See, “ PLAN_POLLTIME_INTRVL or pollTimeInterval” on

page A - 85

Max packets (smauto) See, “ PLAN_MAX_PACKETS or maxPackets” on page A - 85

New connection Poll Interval See, “ PLAN_NEW_POLL_INTRVL or newConnectionPollInterval” on page A - 85

Max Connections/poll See, “ PLAN_MAX_CONNECTIONS or maxConnectionHog” on page A - 85

Upload Interval See, “ PLAN_UPLOAD_INT or maxUpLoadInterval” on page A - 86

Secure key file See, “ PLAN_SECURE_KEYFILE or secureKeyfile” on page A - 85

Trust CA file See, “ PLAN_TRUSTED_CA or trustedCAlist” on page A - 86

Use client authentication See, “ PLAN_VERIFY_CLIENT or verifyClient” on page A - 86



5.7.3.2 Client Controls

5.7.4 Client Setup

General Administration->Connection->Server Controls->Host Connection

Launch Pad option Corresponding Commandline ParameterServer Mode See, “ PLAN_SERVER_MODE or serverMode” on

page A - 88

smauto Gateway Host See, “ SW_HOST or hostName” on page A - 88

smauto Gateway Port See, “ SW_SM_PORT or hostPort” on page A - 89

smauto Gateway Timeout See, “ SW_SM_TIMEOUT or serverTimeout” on page A - 89

General Administration->Connection->Client Controls

Launch Pad option Corresponding Commandline ParameterPoll Interval See, “ NMC_POLL_INT or pollTimeInterval” on

page A - 97

Max Packets (client) See, “ NMC_MAX_PACKETS or maxPackets” on page A - 97

Plan update interval (Client) See, “ NMC_REQ_INTERVAL or requestInterval” on page A - 97

Connection Timeout See, “ PLAN_CLI_TIMEOUT or clientTimeout” on page A - 90

Secure key file See, “ NMC_SECURE_KEYFILE or secureKeyfile” on page A - 97

Trust CA file See, “ NMC_TRUSTED_CA or trustedCAlist” on page A - 97

General Administration->Client Setup

Launch Pad option Corresponding Commandline ParameterNMC Layout See, “ NMC_LAYOUT or enableLayoutControl” on

page A - 98

Layout file path (NMC) See, “ NMC_LAYOUT_FILE or layoutFile” on page A - 98

Language Translator file See, “ NMC_APP_TRANS or appTranslationFile” on page A - 98

Cost control File See, “ NMC_COST_CONTROL or costControlFileName” on page A - 98

Speed time window file See, “ NMC_SPEED_TIME_WIN or speedTimeWindowFile” on page A - 98



5.7.5 Auto SaveAuto Save enables the Scheduler to periodically save the current state of the plan. The Scheduler will also save the current state before clearing on receipt of a RESET packet. If the Scheduler is shutdown it will save the current state of the plan before exiting. If the Scheduler for some reason crashes the last automatically saved file can be reloaded into the Scheduler manually.

5.7.6 Auto DirectAuto Direct is another Planner functionality which advises the driver of his next stop. In general, when a driver requires to know where to travel next, Planner will advise him of the next stop planned, and send details. This functionality takes over a greater extent of the despatch-effort from the Allocator. For more details on Auto Direct see the companion “Planner User manual”.

Preference file See, “ NMC_PREFERENCES or preferenceFile” on page A - 98[

Capacity Graph File See, “ NMC_MAX_CAP_FILE or maxCapFile” on page A - 99

Data Directory See, “ NMC_DATA_DIR or initialDataDir” on page A - 99

General Administration->Auto Save

Launch Pad option Corresponding Commandline ParameterAuto save interval (minutes) See, “ PLAN_AUTOSAVE_INT or autosaveInterval” on

page A - 87

Number of Auto save files See, “ PLAN_AUTOSAVE_FILES or autosaveFiles” on page A - 87

Auto save directory See, “ PLAN_AUTOSAVE_DIR or autosaveDirectory” on page A - 87

Dual Auto save directory See, “ PLAN_DUAL_AUTOSAVE or dualAutosaveDirectory” on page A - 87

General Administration->Auto Direct

Launch Pad option Corresponding Commandline ParameterAuto Direct See, “ PLAN_AUTODIR or enableAutoDirect” on

page A - 91

Auto Direct Interval See, “ PLAN_AUTODIR_INT or autoDirectInterval” on page A - 91

General Administration->Client Setup




Auto Direct Breaks See, “ PLAN_AUTODIR_BRKS or autoDirectInterval” on page A - 91

Auto Direct on Complete See, “ PLAN_AUTODIR_COMP or autoDirectOnComplete” on page A - 91

Close Distribution Runs See, “ PLAN_AUTODIR_CLOSE or closeDistributionRun” on page A - 92

Auto Direct Time Horizon (minutes) See, “ PLAN_AUTODIR_HRZN or autoDirectTimeHorizon” on page A - 92

Auto Despatch Rule See, “ PLAN_AD_RULE or AD_Rule” on page A - 92

Auto Despatch Stability (secs) See, “ PLAN_AD_STABILITYPRD or AD_StabilityPeriod” on page A - 92

Auto Despatch Min Load See, “ PLAN_AD_MINLOAD or AD_MinLoad” on page A - 93

Auto Despatch Max Load See, “ PLAN_AD_MAXLOAD or AD_MaxLoad” on page A - 93

Detour Distance (m) See, “ PLAN_AD_DETOURDIST or detourDistance” on page A - 93

General Administration->Auto Direct




5.8 CONFIGURING THE DISPLAY

5.8.1 Style

5.8.2 Map Display

5.8.2.1 Raster Map

Display

Launch Pad option Corresponding Commandline ParameterDistance in Miles See, “ NMC_DISPLAY_MILES or distInMiles” on

page A - 99

Display->Style

Launch Pad option Corresponding Commandline ParameterPlugin Directory See, “ pluginDir” on page A - 99

Application Style See, “ NMC_APP_STYLE or appStyle” on page A - 99

Display->Map Display

Launch Pad option Corresponding Commandline ParameterMax Map Objects See, “ PLAN_MAX_MAP_OBJ or maxMapObjects” on

page A - 100

Max Map Object types See, “ NMC_MAX_MAP_OBJ_TYPE or maxMapObjectTypes” on page A - 100

Map Colour Depth See, “ NMC_MAP_CLR_DEPTH or mapColorDepth” on page A - 100

Map Label Padding See, “ NMC_MAP_LABEL_PAD or mapLabelPadding” on page A - 100

Map Background Colour See, “ NMC_MAP_BG_CLR or mapBackgroundColor” on page A - 100

Display->Map Display->Raster Map (Sheet 1 of 2)

Launch Pad option Corresponding Commandline ParameterRaster map file See, “ NMC_RASTER_MAP or rmap” on page A - 100

Datum used by vector map See, “ NMC_MAP_DATUM or mapDatum” on page A - 101



5.8.2.2 Map Truncation

5.8.2.3 Microsoft MapPoint

5.8.2.4 OracleAS MapViewer

Map Offset See, “ NMC_MAP_OFFSET or mapOffset” on page A - 101

Raster Map x-Offset See, “ NMC_RMAP_XOFFSET or xOffset” on page A - 101

Raster Map y-Offset See, “ NMC_RMAP_YOFFSET or yOffset” on page A - 101

Display->Map Display->Map Truncation

Launch Pad option Corresponding Commandline ParameterMap Centre See, “ NMC_MAP_CENTRE or mapCenter” on

page A - 101

Map Radius See, “ NMC_MAP_RADIUS or mapRadius” on page A - 101

Display->Map Display->Microsoft MapPoint

Launch Pad option Corresponding Commandline ParameterMapPoint Region See, “ NMC_MAPPOINT_REGION or mapPointRegion”

on page A - 101

Display->Map Display->OracleAS MapViewer

Launch Pad option Corresponding Commandline ParameterMapViewer URL See, “ NMC_MV_URL or mapViewerURL” on

page A - 102

MapViewer DataSource See, “ NMC_MV_DATASOURCE or mapViewerDatasource” on page A - 102

MapViewer Basemap See, “ NMC_MV_BASEMAP or mapViewerBasemap” on page A - 102

Load MapViewer Image Direct See, “ NMC_MV_LOAD_DIRECT or loadMapViewerImageDirect” on page A - 102

Display->Map Display->Raster Map (Sheet 2 of 2) (Continued)




5.8.3 Turn-by-Turn

5.8.4 Icons

Display->Turn-by-Turn

Launch Pad option Corresponding Commandline Parameter straight See, “ See, “ PLAN_TBT_STRAIGHT or straight” on

page A - 104” on page A - 112

bear See, “ See, “ PLAN_TBT_BEAR or bear” on page A - 104” on page A - 112

turn See, “ See, “ PLAN_TBT_TURN or turn” on page A - 104” on page A - 112

sharp See, “ See, “ PLAN_TBT_SHARP or sharp” on page A - 104” on page A - 112

shortLink See, “ See, “ PLAN_TBT_SHORT_LINK or shortLink” on page A - 104” on page A - 112

Display->Icons

Launch Pad option Corresponding Commandline ParameterUnselected stop icon path See, “ NMC_STOP_ICON or stopIconName” on

page A - 102

Unselected depot icon See, “ NMC_DEPOT_ICON or depotIconName” on page A - 102

Selected stop icon path See, “ NMC_SEL_STOP_ICON or selectedStopIconName” on page A - 102

Selected depot icon See, “ NMC_SEL_DEPOT_ICON or selectedDepotIconName” on page A - 102



5.8.5 Display Options

Display->Display Options

Launch Pad option Corresponding Commandline ParameterNMC Title See, “ NMC_APP_TITLE or appTitle” on page A - 102

Cell Margin See, “ NMC_CELLMARGIN or cellMargin” on page A - 103

Highlight Margin See, “ NMC_HIGHLIGHT_MARGIN or highlightMargin” on page A - 103

Text Margin See, “ NMC_TEXT_MARGIN or textMargin” on page A - 103

Process ID See, “ NMC_ID or clientId” on page A - 103

Application Font Family See, “ appFontFamily” on page A - 103

Application Font Size See, “ appFontsize” on page A - 103

Show custom dialog when loading data from flagSHIP

See, “ NMC_FLAGSHIP_GWY or loadFromFlagship” on page A - 103

map projection config See, “ NMC_MAP_PROJECTION or projection” on page A - 103


Planner 10.5

System

Manual

C e Configuration

es are imported by Planner at run-time plates” described on page 2 - 8 for

e hardware, disk directories, and time there is a change to the installation.

ides an acceptable level of operation for

em Manager can override the default

ge and default values generic to all UIServer.

opyright © 2000, 2010, O

racle. All rights reserved

A - 1

Appendix A: Run-tim

The operation of Planner is controlled by various configuration data values. These valufrom INSTALL_POINT/Planner/etc/site.config.Planner. See “Copy Planner Runtime Temfurther details on Planner run-time files.

As already discussed in Chapter 1: Introduction, some data values are determined by thnetworking abilities provided at the installation site and therefore must be updated each

All the other configuration data values used by Planner will default to a value which provPlanner.

There will be some occasions when the default values are not appropriate, and the Systvalues by placing the required value in the site.config.Planner file.

This chapter lists the Planner run-time configuration keywords and the corresponding ranprocesses, specific to smauto, plannerClient, plannerSwitch, Print Manifest Server and G

Planner 10.5

System

Manual

C

ecified as a Keyword and its associated

their default value, and their acceptable

ber for all the Client processes.

ection. These need to be defined only

r file.

mer

92

Value

opyright © 2000, 2010, O


A - 2

A.1 CONFIG FILE KEYWORDS

The configuration file is plain ASCII text, and must contain the parameter specifications spValue. For example:

The following paragraphs describe the Keywords which apply to the Planner processes,range of values.

These Keywords can also be referred to by their explicit configuration name.

For example:

PLAN_CENT_HOST is the same as hostName for all the Client processes and

PLAN_CENT_AUTO_PORT is same as serverPort for the smauto process and portNum

A.1.1 Keywords Common to multiple ProcessesConfiguration parameters that are used by multiple processes are described under this sonce within the configuration file.

In a Linux installation these parameters are set within the user defined site.config.Planne

In a Windows installation these are set from the launchPad.

set PLAN_CENT_HOST = ho

set PLAN_CENT_AUTO_PORT = 81

Keyword

Planner 10.5

System

Manual

C A.1.1.1 Error Translation File

Recommendations / Comments

pecify the ror d by

smauto uses the Error codes in the Error Translation File to change the text in error messages at the time of initialisation. This functionality supports:

• different languages• user friendly terminology

and• context sensitive

contents, such as Shift Id, Resource Id, Stop Id etc.

opyright © 2000, 2010, O


A - 3

Error Translation File

Configuration Parameter Type Range default Description

PLAN_ERROR_TRANS or errorTranslationFile

string *.txt NONE This parameter is used to spath and filename of the ErTranslation file which is reasmauto at run time.

Planner 10.5

System

Manual

C A.1.1.2 Map configuration


ter, which of the the

A MAP consists of a list of NODES (geographical locations, suburbs etc.) and a list of inter-node LINKS (travel paths) whose direction, distance, and travel time are known.

This data is used by smauto to create the schedule and by plannerClient and manifestServer to display the map.

of the ed by the

A zone is defined as an imaginary polygon that is constructed of coordinates (usually Longitude/Latitude) within the map space known to Planner.

The polygons that make up the zones are described and named in the zone file. This file is read from the disk each time the smauto, plannerClient or manifestServer process is started, and can be used to automatically assign a geographic zone to incoming Stops.

opyright © 2000, 2010, O


A - 4

Map configuration


PLAN_MAP or map string *.mag *.meg *.mal *.mel

NONE This is a mandatory paramesets the path and filename connectivity map for use byfollowing processes:

• smauto• plannerClient• manifestServer

PLAN_ZONEFILE or zoneFile

string Zone File NONE Sets the location and namezones definition file to be usfollowing processes:


Planner 10.5

System

Manual

C A.1.1.3 Hidden Map configuration


able if this

Is TRUE by default for smauto process.

As client processes need not generate index table this parameter must always be set to FALSE.

By default in the runscripts this parameter value is set to TRUE for smauto and FALSE for plannerClient and manifestServer

Alternately if the processes are run using the executable, this parameter can be supplied as an optional argument.

opyright © 2000, 2010, O


A - 5

Hidden Map configuration


mapServerMode Hidden Calculates the map index tTRUE. Processes that useparameter are:


Planner 10.5

System

Manual

C A.1.1.4 Advanced Map configuration


ally proximate cations ap links.

travel links in

e of this

r for ards

e of this

Do not change unless advised by Oracle.

Used for computation of the “best” route.

If PLAN_MAP_DIST_FACTOR is set to zero, the routes calculated will be “fastest” routes. If PLAN_MAP_TIME_FACTOR is set to zero, the routes calculated will be “shortest” routes.

The contribution of distance and time are approximately equal when the ratio PLAN_MAP_TIME_FACTOR / PLAN_MAP_DIST_FACTOR is approximately 20.

r for time te finding.

e of this

opyright © 2000, 2010, O


A - 6

Advanced Map configuration (Sheet 1 of 3)


PLAN_INTRANODALSPEED or offMapSpeed

int_range

1 .. 200 20 Snap links are automaticcreated by smauto to aproutes to and from job lothat are not on existing mThis parameter sets the speed along these snapKilometers per hour.

Processes that make usparameter are:


PLAN_MAP_DIST_FACTOR or matrixDistFactor

int_range

0 .. 10 1 Sets the integer Multipliedistance contribution towroute finding.



PLAN_MAP_TIME_FACTOR or matrixTimeFactor

int_range

0 .. 100 40 Sets the integer multipliecontribution towards rou



Planner 10.5

System

Manual

C

r for Toll

e of this

If there are any links in the map file that have been disabled then this value should be greater than 0.

Setting this value to 1 should be sufficient to create the distinction between disabled and non-disabled map links.

ntation

nn,

k matrix 00]

ory used ytes.

e of this

A route is defined by the links between the Stop the resource is at and the next Stop. Setting this value too low will cause the optimiser to recalculate routes for use with dead Reckoning instead of optimising the schedule.

he map ames on indow.

e of this

When TRUE the map node and link names are displayed on the Map Window’s ’crosshair’ and "LatLong Coordinates" dialog.

Note: The node and link names must be supplied with the map data.

Advanced Map configuration (Sheet 2 of 3) (Continued)


opyright © 2000, 2010, O


A - 7

PLAN_MAP_TOLL_FACTOR or matrixTollFactor

int_range

0 .. 100 0 Sets the integer Multipliecontribution to route.



PLAN_MATIRX_VER or matrixVersion

int_range

LoConn Sets the matrix-implemeby TYPE (Full, Sparse, SparseNearSym) or by APPLICATION (HiCoLoConn)

PLAN_MATRIX_UPD_INT or matrixUpdateInterval

double_range

Sets the interval to checfor unused cells (sec) [9

PLAN_MAP_MEM_CACHE or routeCacheMemoryLimit

int_range

1 .. 100 10 Sets the maximum memby route cache in megab



PLAN_MAP_READ_NAMES or readLinkNames and readNodeNames

boolean

TRUE, FALSE

TRUE Set to TRUE to display tnode and link (or road) nthe plannerClient Map W


• plannerClient• manifestServer


Planner 10.5

System

Manual

C

nodes, t are

e of this


rated list multiple nning.

make use to

Client processes will search the machines in this list and connect to the first available smauto, at PLAN_CENT_AUTO_PORT.

Advanced Map configuration (Sheet 3 of 3) (Continued)


opyright © 2000, 2010, O


A - 8

A.1.1.5 smauto/Client Connection Configuration

PLAN_LOG_MAP or logMap boolean

TRUE, FALSE

FALSE Logs the number of maplinks and matrix rows thaloaded.



smauto/Client Connection Configuration (Sheet 1 of 2)


PLAN_CENT_HOST or hostName

string localhost Used to set the comma sepaof computer names on whichsmauto processes may be ru

The following client process of this parameter to connectsmauto:

• plannerClient• manifestServer• plannerGuiServer


Planner 10.5

System

Manual

C

ivity, after to smauto

Set to -1 to disable parameter.

Note: This parameter is used only by the following Client Processes connecting to smauto:


Note: The corresponding smauto parameter “PLAN_CLI_TIMEOUT or clientTimeout” described on page A - 90, copies this value from the appropriate Client process to simultaneously drop the connection from the smauto end.

re socket

this

smauto/Client Connection Configuration (Sheet 2 of 2) (Continued)


opyright © 2000, 2010, O


A - 9

PLAN_CLI_TIMEOUT or connectionTimeout

int_range

20 .. 10000 900 Interval in seconds of no actwhich the Client connection is dropped.

PLAN_SECURE_SOCKET or secureSocket

boolean

TRUE, FALSE

FALSE Must be enabled to use secucommunication.

Processes that make use ofparameter are:

• smauto• plannerClient• manifestServer• plannerGuiServer• plannerSwitch


Planner 10.5

System

Manual

C 1.1.1.5.1 Hidden plannerClient Configurationparameter settings made for other


t

This portNumber must be supplied as a mandatory argument on running plannerclient using the executable (plannerClient.exe) instead of the runscript (runnmc).

This parameter is set by default to always connect the Clients to smauto.

opyright © 2000, 2010, O


A - 10

The parameters in this section cannot be set explicitly as their values are inherited from processes.

Hidden plannerClient Configuration


PLAN_CENT_AUTO_PORT or portNumber

Hidden 9000 Port number at which Clienprocesses connect to the server process.

To connect plannerClient tosmauto, the ’portNumber’ should be the same as “PLAN_CENT_AUTO_PORT or serverPort” described on page A - 85. To connect plannerClient toplannerGuiServer, the ’portNumber’ should be thesame as “GS_CLIENT_PORT or clientPort” described on page A - 114.

Client processes that use this parameter are:


Planner 10.5

System

Manual

C A.1.1.6 Process Logging Configuration


ogging to In a Linux installation, PLAN_NO_LOG_STDOUT is set only once within the user defined site.config.Planner file and the value is passed on automatically to all the following process:

• smauto• plannerClient• plannerSwitch• plannerGuiServer

On the other hand in a Windows installation, this parameter must be set individually for each of the above process from the launchPad.

n method

e of this

Note: Compression of log files is available only for UNIX installations.

opyright © 2000, 2010, O


A - 11

Process Logging Configuration


PLAN_NO_LOG_STDOUT or noLogStdOut

boolean TRUE, FALSE

FALSE Set to TRUE to disable lstandard output.

PLAN_LOG_COMPRESS or logCompress

string gzip Sets the file compressiofor log files.


• smauto• plannerClient• plannerSwitch• plannerGuiServer

Planner 10.5

System

Manual

C A.1.1.7 Socket Buffer Configuration

n Recommendations / Comments

of the data for sending

o set a t wasting

f this

Used by Oracle only. Do not change.

uffer size for . Total amount hich can be ffering for to total

o wait on a ing the socket.

opyright © 2000, 2010, O


A - 12

socket Buffer Configuration

Configuration Parameter Type Range default Descriptio

PLAN_IO_BUF_SIZE or io_bufsize

int_range 1 .. 1024 128 Sets the size, in kilobytes, buffer used by IPC socketsand receiving data. Used tsufficient buffer size withoumemory resources.

Processes that make use oparameter are:

• smauto• plannerClient• manifestServer• plannerGuiServer• plannerSwitch

PLAN_USER_BUF_SIZE or socketBufferSize

int_range 0 .. 10000 10000 Limits the internal socket bsending data in (Kil0bytes)of memory in (kilobytes) wallocated to user socket busending data. Value relatesacross all sockets.

PLAN_USER_BUF_WAIT or maxWaitBlock

int_range 0 .. 86400 300 Maximum time (seconds) tblocked socket before clos

Planner 10.5

System

Manual

C A.1.1.8 Configuration File Location


ironment

This parameter can be set only within the site.config.Planner file.


zone the peed

d to

• Setting Vwarp = 10 will run the process clock a bit faster that the standard clock speed and likewise a bit slower when Vwarp=-10.

• Setting Vdate=15/01/1990 will start the process as if the current system date is the 15th of January 1990. This virtual date can be any date in the past or future.

• Setting Vtime=023514 will start the process at 02 hours 35 minutes and 14 seconds in the morning.

• Setting Vtimezone="Australia/Melbourne" will set the application’s default timezone to the local time in Melbourne, Australia.

opyright © 2000, 2010, O


A - 13

A.1.1.9 General Configuration

Configuration File Location


PLAN_CFG_DIR string [.] Defines the path to file containingcommandline arguments and envvariables required to run Planner.

General Configurations (Sheet 1 of 3)


PLAN_VWARP or Vwarp

double_range

NONE Vwarp, Vdate, Vtime and Vtimecan be used to respectively set virtual time and date, warping sof processes and the applicationdefault timezone.

These parameters can be applieall Planner processes.

PLAN_VDATE or Vdate

int_range

NONE

PLAN_VTIME or Vtime

int_range

NONE

PLAN_VTIMEZONE or Vtimezone

string NONE

Planner 10.5

System

Manual

C

ket

tion

smauto only deals with absolute times and never in abstract times. Using this parameter an optional UTC offset can be passed to smauto. smauto then includes this offset when exporting time data.

To ensure backward compatibility with Planner versions lesser than 10.4, if the UTC offset is not supplied in the input time then the local time Zone for smauto is used and no offset is included in the exported time.

ss to (or

o all


General Configurations (Sheet 2 of 3) (Continued)


opyright © 2000, 2010, O


A - 14

PLAN_DEF_UTC_OFFSET or hipDefaultUTCoffset

int_range

PLAN_VTIMEZONE or Vtimezone

Is the default UTC offset for pacfield in (-)HHMM or (-)hhmmss format. Default is to use applicadefault timezone

PLAN_NO_EXIT or NoExit

boolean

TRUE, FALSE

FALSE Set to TRUE to enable the procecontinue after test point failuresassertions).

This parameter can be applied tPlanner processes.


Planner 10.5

System

Manual

C

e

nner

Note: Ideally set to 0 and should not be set above level 5.

The log level and associated logging details are listed below:

0=No logging 1=Tracking realtime/operator events/status changes, vehicle/stop status changes etcetera. 2=Logs operation of automated processes impacting on schedule execution, deadreckoning, autodespatch. 3=Operation of optimiser. 4=Anything else. 5=Spare 6-9=As 1 to 4, but accompanied by performance penalties or excessive output.

en er

Note: This parameter will be effective only at Log Levels greater than or equal to 5

ll be test >0.

nner

The test level and associated testing scope are listed below:

0=No optional tests 1=Consistency tests that have a negligible impact on performance. 3=Consistency tests that may have some impact on performance. 5=Consistency tests that may significantly alter the system’s performance.

Note: Used by Oracle only. Do not change.

General Configurations (Sheet 3 of 3) (Continued)


opyright © 2000, 2010, O


A - 15

PLAN_LOG_LEVEL or logLevel

int_range

0 .. 9 0 Sets the level of detail that will blogged for the process.

This parameter is used by all Plaprocesses

PLAN_PROCESS_DURATION or processDurationLevel

int_range

0 .. 36000 100 milliseconds

The timing of processes that areinternal to Smauto is logged whtheir time exceeds this parametvalue in milliseconds.

PLAN_TEST_LEVEL or testLevel

int_range

0 .. 9 NONE Sets the depth of testing that wiperformed on the process in thecode. Must not be set to a value

This parameter is used by all Plaprocesses.


Planner 10.5

System

Manual

C


s will be ift or ertion by

When set to TRUE, the Optimiser immediately attempts to position new jobs into the plan.

ne Plan When there are multiple jobs on the Free list this is the maximum that will be included into the plan at any one time.

opyright © 2000, 2010, O


A - 16

A.1.2 Scheduler (smauto) Keywords

A.1.2.1 Scheduler Configuration

Scheduler configuration


PLAN_IMMED_ASSIGN or immediateAssignment

boolean TRUE, FALSE

TRUE Determines whether new jobimmediately assigned to a shplaced on the Free list for insthe plan slicer.

PLAN_NUM_JOBS_INS or nJobsInsert

int_range

0 .. 10000 10 Number of jobs inserted by oSlicer

Planner 10.5

System

Manual

C A.1.2.2 Advanced Mapping Configurationection. The remaining Advanced under section A.1.1.4 Advanced Map


Matrix segmentation is a method of reducing the time taken to generate the matrix by reducing the locations populated within the matrix to only those which we may need to access, ignoring those which we know we will never require.

Matrix segmentation is based on Stop/Shift Compatibility. Compatibility conditions that are taken into consideration include:

• Attribute Compatibility• Zone Compatibility• Time Window Compatibility• Distance Based Compatibility

The area of map that is required to be searched has the greatest impact on the matrix generation performance. This area can be reduced using Distance Compatibility.

opyright © 2000, 2010, O


A - 17

Two Advanced Mapping parameters that are used only by smauto are described in this sMapping parameters that smauto shares with the other Planner processes are describedconfiguration” on page A - 6.

Advanced Map configuration for smauto


PLAN_MTRX_SEG or matrixSegmentation

boolean TRUE, FALSE

TRUE When set to FALSE, matrix will be generated for all Stops in the system.

When set to TRUE, matrix is generated only for Stops that are compatible with the Shifts.

PLAN_WARN_DIST or warnDist

int_range 0 .. 1000000

5000 Sets the maximum distance that locations are allowed to be from the nearest map node after which the warning is issued.

Planner 10.5

System

Manual

C A.1.2.3 Slot Generator Configuration


didates the cost-during

During the slot generation process the slot generator may come across a group of slots that return a value greater than the MAX_UNITS specified in the CHS_SLOT message.

PLAN_SLOT_GEN_TERM sets the number of consecutive replies above MAX_UNITS that will be processed before the slot generator terminates.

g out of .

Used to configure the Slot Generator to not return higher cost Slots which are earlier than later less expensive Slots.

Some businesses sort the Slots returned by date and time and tend to select the earliest Slot, while disregarding the cost of the Slot. This results in less efficient schedules and tends to produce worse overall Key Performance Indicators.

Slots arlier than turned. A an OL hours est cost

opyright © 2000, 2010, O


A - 18

Slot Generator configuration (Sheet 1 of 2)


PLAN_SLOT_GEN_TERM or slotGenTermination

int_range

0 .. 10000 10 Sets the number of canthat will be costed after limit has been reached Slot Generation.

PLAN_SGC_FILTER or slotGenChronologicalFilter

boolean TRUE, FALSE

FALSE This switches the filterinnon-chronological Slots

PLAN_SGC_FILTER_TOL or slotGenChronologicalFilterTolerance

int_range 0 .. 1440 12 This allows higher cost which fall only slightly elower cost Slots to be reSlot which is no more thPLAN_SGC_FILTER_Tearlier than the next lowSlot is still returned.

Planner 10.5

System

Manual

C

ned slots der

requires t be

windowires that rt within

s that d within

ires that erlap the

ns apply tion E e at some is initial hicle and

lters out on the

The filters are explained in the following example:

A request was sent with 8am to 10pm time window and the slots are specified as 7-12, 14-19, 19-23.

• For filter (SG_CONTAINED_IN) 14-19 slot will be considered• For filter (SG_STARTS_IN) 14-19 and 19-23 slots will be considered• For filter (SG_ENDS_IN) 7-12, 14-19 slots will be considered• For filter (SG_OVERLAPS) 7-12, 14-19, 19-23 slots will be considered

Slot Generator configuration (Sheet 2 of 2) (Continued)
opyright © 2000, 2010, O

A - 19

PLAN_SLOT_GEN_FILTER or slotGenWinFilter

string One of:

• SG_CONTAINED_IN• SG_STARTS_IN• SG_ENDS_IN• SG_OVERLAPS

SG_CONTAINED_IN

Enables filtering of returon the time window borcondition.

• SG_CONTAINED_IN that successful slot muswithin the request time • SG_STARTS_IN requsuccessful slot must stathe request time window• SG_ENDS_IN requiresuccessful slot must enthe request time window• SG_OVERLAPS requsuccessful slot must ovrequest time window

Note: All these conditioon top of the initial seleccriteria that, stop CAN BSCHEDULED to be dontime during this slot. Thcriteria is defined by theavailability of suitable vestop’s time window. Thesuggested mode only ficertain slots depending border conditions.

Planner 10.5

System

Manual

C A.1.2.4 Service Cost Configurations


rn

Used to limit the rate of cost increase for extreme conditions.

All exponential costs are controlled by three fields x_A, x_B,and x_C. These fields represent an exponential function of x where x_A is the initial slope for x>=0 (at x=0) and x_B is the doubling rate. (The slope of the function doubles every x_B). x_C is a flat additional cost, creating an initial step.

The number of slope duplications is set by PLAN_MAX_EXPONENT.

The exponential cost curve becomes linear after reaching "the x_B value in cost control * PLAN_MAX_EXPONENT".

This cost is applied against each Stop that is not assigned, i.e. on the free list.

et-

opyright © 2000, 2010, O


A - 20

Service Cost configurations


PLAN_MAX_EXPONENT or maxExponent

int_range 0 .. 100 NONE Exponential costs will tuLinear when their x / B value becomes greaterthan the PLAN_MAX_EXPONENT.

PLAN_ALLOCATION_COST or allocationCost

double_range

-1000000.0 .. 1000000.0

0.0 Sets the cost of not scheduling a stop.

PLAN_LOAD_LVL_COST or loadLevelCost

double_range

0.0 .. 1000000.0

0.0 Cost of job-value to targvalue mismatches.

PLAN_LOAD_LVL_MAX or loadLevelMax

5 * PLAN_LOAD_LVL_COST

Load Level Cost when job-value == 0

Planner 10.5

System

Manual

C 1.1.2.4.1 SLA Stop Cost Configurations

cription Recommendations / Comments

linear cost of letion of a lation to SLA e Windows

Time nt Cost for “PLAN_P_COST or

opCost” on

21.

See, “Appendix C: Time Dependent Cost” on page C - 1 for more details.

opyright © 2000, 2010, O


A - 21

SLA Stop Cost configurations

Configuration Parameter Type Range default Des

PLAN_SLA_STOP_COST or slaLateStopCost

double_range

0.0 .. 1000000.0 NONE Sets the late compstop in reStop Tim

PLAN_SLA_STOP_TDC or slaWindowStopCost_TDC

double_range

A=0.0 .. 1000000.0

B=0.0 .. 1000.0

C=0 .1 .. 10.0

D=0.0 .. 1000.0

E=0.0 .. 1000000.0

F =-1000000.0 .. 1000000.0

A=1.0

B=0.0

C=1.0

D=0.0

E=1.0

F=0.0

Sets the DependeControls SLA_STOslaLateStdescribedpage A -

Planner 10.5

System

Manual

C 1.1.2.4.2 SLA Depot Cost Configurations


linear cost of letion of a elation to SLA e Windows

Time nt Cost for “PLAN_POT_COST or epotCost” on

22.


scription Recommendations / Comments

reference to be r Stops to be to earlier Shifts.

rticularly when making ests.

See, “Appendix D: Shift Promotion Cost” on page D - 1 for more details.

opyright © 2000, 2010, O


A - 22

1.1.2.4.3 Shift Promotion Cost Configurations

SLA Depot Cost configurations


PLAN_SLA_DEPOT_COST or slaLateDepotCost

double_range

0.0 .. 1000000.0 NONE Sets the late compdepot in rDepot Tim

PLAN_SLA_DEPOT_TDC or slaWindowDepotCost_TDC

double_range

A=0.0 .. 1000000.0

B=0.0 .. 1000.0

C=0 .1 .. 10.0

D=0.0 .. 1000.0

E=0.0 .. 1000000.0

F =-1000000.0 .. 1000000.0

A=1.0

B=0.0

C=1.0

D=0.0

E=1.0

F=0.0

Sets the DependeControls SLA_DEslaLateDdescribedpage A -

Shift Promotion Cost Configurations (Sheet 1 of 2)

Configuration Parameter Type Range default De

SHIFT_PROMOTION_COST or shiftPromotion

double_range

0.0 .. 1000000.0 0.0 Allows a papplied foscheduledThis is paapplicableSlot Requ

Planner 10.5

System

Manual

C

ime Dependent trols for “SHIFT_ION_COST or otion” described - 22.


ription Recommendations / Comments

exponential dvance the e at PKUP

stops.

A =Multiplier. Positive value encourages collection towards beginning of TW. Negative value encourages collection towards End of TW. B =The ratio of the time window at which the value that A is multiplied by is doubled. C =Initial step value applied only once at start.

Time nt Cost

for “PLAN_RVC_

r viceCost” d on 23.


Shift Promotion Cost Configurations (Sheet 2 of 2) (Continued)
opyright © 2000, 2010, O

A - 23

1.1.2.4.4 Pick-up Service Cost configurations

SHIFT_PROMOTION_TDC or shiftPromotion_TDC

double_range

A=0.0 .. 1000000.0

B=0.0 .. 1000.0

C=0 .1 .. 10.0

D=0.0 .. 1000.0

E=0.0 .. 1000000.0

F =-1000000.0 .. 1000000.0

A=1.0

B=0.0

C=1.0

D=0.0

E=1.0

F=0.0

Sets the TCost ConPROMOTshiftPromon page A

Pick-up Service Cost configurations

Configuration Parameter Type Range default Desc

PLAN_PKUP_SRVC_COST or pkupServiceCost

double_range

A= -1000000.0 .. 1000000.0,

B= 0.001 .. 1000000.0,

C= 0.0 .. 1000000.0

A=0.0, B=0.1, C=0.0

Sets thecost to aarrival timand PTP

PLAN_PKUP_SRVC_TDC or pkupServiceCost_TDC

double_range

A=0.0 .. 1000000.0

B=0.0 .. 1000.0

C=0 .1 .. 10.0

D=0.0 .. 1000.0

E=0.0 .. 1000000.0

F =-1000000.0 .. 1000000.0

A=1.0

B=0.0

C=1.0

D=0.0

E=1.0

F=0.0

Sets theDependeControlsPKUP_SCOST opkupSerdescribepage A -

Planner 10.5

System

Manual

C 1.1.2.4.5 Drop Service Cost configurations


xponential vance the e at DROP

A =Multiplier. Positive value encourages delivery towards beginning of TW. Negative values are not allowed to discourage late distribution. B =The ratio of the time window at which the value that A is multiplied by is doubled. C =Initial step value applied only once at start.

ime t Cost

or “PLAN_VC_COST

rviceCost” on 4.


opyright © 2000, 2010, O


A - 24

Drop Service Cost configurations


PLAN_DROP_SRVC_COST or dropServiceCost

double_range

A= 0.0 .. 1000000.0,

B= 0.001 .. 1000000.0,

C= 0.0 .. 1000000.0

A=0, B=0.1, C=0

Sets the ecost to adarrival timstops.

PLAN_DROP_SRVC_TDC or dropServiceCost_TDC

double_range

A=0.0 .. 1000000.0

B=0.0 .. 1000.0

C=0 .1 .. 10.0

D=0.0 .. 1000.0

E=0.0 .. 1000000.0

F =-1000000.0 .. 1000000.0

A=1.0

B=0.0

C=1.0

D=0.0

E=1.0

F=0.0

Sets the TDependenControls fDROP_SRor dropSedescribedpage A - 2

Planner 10.5

System

Manual

C 1.1.2.4.6 Late Stop Cost configurations


tial cost

late from LAN__BY_

ALSE

te at a AN_ST__ARR =

The PLAN_ST_LATE_BY_ARR value determines if the late arrival at stop will be costed or the late departure from stop.

This cost is controlled by three values: A = Multiplier against the Late Cost in Stop time window, costed per second the stop is late. B = Seconds after which A will be doubled. C = Instant penalty applied once.

Used to encourage the Scheduler to start or complete the stops within their specified time windows.

This value can be changed by altering the Stop Late Cost from the plannerClient Cost Control Editor.

Time nt Cost for ATE_OST or ost” on

25.


opyright © 2000, 2010, O


A - 25

Late Stop Cost configurations


PLAN_LATE_STOP_COST or lateStopCost

double_range

0.0 .. 1000000.0 2.0, 1800.0, 0.0

Sets the exponenof: departinga stop if PST_LATEARR = For arriving lastop if PLLATE_BYTRUE.

PLAN_LATE_STOP_TDC or lateStopCost_TDC

double_range

A=0.0 .. 1000000.0

B=0.0 .. 1000.0

C=0 .1 .. 10.0

D=0.0 .. 1000.0

E=0.0 .. 1000000.0

F =-1000000.0 .. 1000000.0

A=1.0

B=0.0

C=1.0

D=0.0

E=1.0

F=0.0

Sets the DependeControls “PLAN_LSTOP_ClateStopCdescribedpage A -

Planner 10.5

System

Manual

C 1.1.2.4.7 Late Logoff Cost configurations

ption Recommendations / Comments

onential ng off late ft.

This cost is controlled by three values: A = Multiplier against the Overtime Cost in Shift, costed per second the shift is in overtime. B = Seconds after which A will be doubled. C = Instant penalty applied once.

Used to encourage the Scheduler to minimise the occurrence of overtime in shifts.

This value can be changed by altering the Overtime Cost within the plannerClient Cost Control Editor.

e Cost “PLAN_COST or n .


opyright © 2000, 2010, O


A - 26

Late Logoff Cost configurations

Configuration Parameter Type Range default Descri

PLAN_LATE_OFF_COST or lateOffCost

double_range

0.0 .. 1000000.0 1.0, 3600.0, 0.0

Sets the expcost of loggifrom the shi

PLAN_LATE_OFF_TDC or lateOffCost_TDC

double_range

A=0.0 .. 1000000.0

B=0.0 .. 1000.0

C=0 .1 .. 10.0

D=0.0 .. 1000.0

E=0.0 .. 1000000.0

F =-1000000.0 .. 1000000.0

A=1.0

B=0.0

C=1.0

D=0.0

E=1.0

F=0.0

Sets the TimDependent Controls forLATE_OFF_lateOffCost”described opage A - 26

Planner 10.5

System

Manual

C 1.1.2.4.8 Late Depot Cost configurations


exponential

g late from a p if PLAN_

TE_BY_ALSE

ate at a p if PLAN_

TE_BY_RUE.

lting value lied by the of stops that ferred at t.

The PLAN_DPT_LATE_BY_ARR value determines if the late arrival at depot stop will be costed or the late departure from depot stop.

This cost is controlled by three values: A = Multiplier against Late cost in depot time window, costed per second the depot stop is late. B = Seconds after which A will be doubled. C = Instant penalty applied once.

Used to encourage the Scheduler to start or complete the depot stops within their specified time windows.

This value can be changed by altering the Depot Late Cost from the plannerClient Cost Control Editor.

Time nt Cost

for “PLAN_EPOT_r tCost” d on 27.


opyright © 2000, 2010, O


A - 27

Late Depot Cost configurations


PLAN_LATE_DEPOT_COST or lateDepotCost

double_range

0.0 .. 1000000.0 2.0, 1800.0, 0.0

Sets thecost of: departindepot stoDPT_LAARR = For arriving ldepot stoDPT_LAARR = T

The resuis multipnumber are transthe depo

PLAN_LATE_DEPOT_TDC or lateDepotCost_TDC

double_range

A=0.0 .. 1000000.0

B=0.0 .. 1000.0

C=0 .1 .. 10.0

D=0.0 .. 1000.0

E=0.0 .. 1000000.0

F =-1000000.0 .. 1000000.0

A=1.0

B=0.0

C=1.0

D=0.0

E=1.0

F=0.0

Sets theDependeControlsLATE_DCOST olateDepodescribepage A -

Planner 10.5

System

Manual

C A.1.2.5 Running Cost configurations


haul.

rce in the Changing Resource Cost from the plannerClient Cost Control Editor will alter this parameter value. Used to encourage the Scheduler to minimise the number of used Resources in the schedule.

tion Recommendations / Comments

or using a .

When there are multiple time windows associated with a stop, this value is multiplied with the window cost in each of the time window.

Used to encourage the use of the cheapest time window.

This value can be changed by altering the Preferred Window Cost from the plannerClient Cost Control Editor.

opyright © 2000, 2010, O


A - 28

1.1.2.5.1 Time Window Cost configurations

Running Cost configurations


PLAN_HAUL_COST or haulCost

double_range

-1000000.0 .. 1000000.0

1000.0 Sets the cost for activating a

PLAN_VEHICLE_COST or vehicleCost

double_range

-1000000.0 .. 1000000.0

1000.0 Sets the cost of using a resousolution.

Time Window Cost configurations (Sheet 1 of 2)

Configuration Parameter Type Range default Descrip

PLAN_WINDOW_COST or windowCost

double_range

0.0 .. 1000000.0 NONE Set the cost fTime Window

Planner 10.5

System

Manual

C

ost LAN_ST or

described 8.



t against avelling, e by job

te delay.

This is the multiplier against the Time Cost in Shift, costed for every second consumed on shift between Log On and Log Off, except Idle Time.

This value can be changed by altering the Time Cost from the plannerClient Cost Control Editor.

e ost

“PLAN_ or scribed 29.


Time Window Cost configurations (Sheet 2 of 2) (Continued)
opyright © 2000, 2010, O

A - 29

1.1.2.5.2 Time Cost configurations

PLAN_WINDOW_TDC or windowCost_TDC

double_range

A=0.0 .. 1000000.0

B=0.0 .. 1000.0

C=0 .1 .. 10.0

D=0.0 .. 1000.0

E=0.0 .. 1000000.0

F =-1000000.0 .. 1000000.0

A=1.0

B=0.0

C=1.0

D=0.0

E=1.0

F=0.0

Sets the TimeDependent CControls for “PWINDOW_COwindowCost” on page A - 2

Time Cost configurations (Sheet 1 of 2)


PLAN_TIME_COST or timeCost

double_range

0.0 .. 1000000.0 1.0 Sets the costime spent trincluding timcontributionsdelay and si

PLAN_TIME_TDC or timeCost_TDC

double_range

A=0.0 .. 1000000.0

B=0.0 .. 1000.0

C=0 .1 .. 10.0

D=0.0 .. 1000.0

E=0.0 .. 1000000.0

F =-1000000.0 .. 1000000.0

A=1.0

B=0.0

C=1.0

D=0.0

E=1.0

F=0.0

Sets the TimDependent CControls for TIME_COSTtimeCost” deon page A -

Planner 10.5

System

Manual

C

to cost s part of

E to k time el time

Time Cost configurations (Sheet 2 of 2) (Continued)
opyright © 2000, 2010, O

A - 30

PLAN_COST_BREAK_TIME or costBreakTime

boolean TRUE, FALSE TRUE Set to TRUEBreak time atravel time.

Set to FALSexclude Breafrom the travcosting.

Planner 10.5

System

Manual

C 1.1.2.5.3 Idle Time Cost configurations


n units per time spent

t is costed side the

This is the multiplier against the Time Cost in Shift, costed for every second that the shift is idle.

Idle time is accumulated when the shift arrives at the stop before the start of the stop time window.

This value can be changed by altering the Time Cost from the plannerClient Cost Control Editor.

Dependent for “PLAN_r idleCost” age A - 31.


opyright © 2000, 2010, O


A - 31

Idle Time Cost configurations


PLAN_IDLE_COST or idleCost

double_range

0.0 .. 1000000.0 1.0 Sets the cost iminute of any idle on a shift.

Idle Time Cosseparately outTime Cost.

PLAN_IDLE_TDC or idleCost_TDC

double_range

A=0.0 .. 1000000.0

B=0.0 .. 1000.0

C=0 .1 .. 10.0

D=0.0 .. 1000.0

E=0.0 .. 1000000.0

F =-1000000.0 .. 1000000.0

A=1.0

B=0.0

C=1.0

D=0.0

E=1.0

F=0.0

Sets the TimeCost Controls IDLE_COST odescribed on p

Planner 10.5

System

Manual

C 1.1.2.5.4 Distance Cost configurations


units per istance solution.

This is the multiplier against the Distance Cost in Shift, costed for every meter that is travelled.

This value can be changed by altering the Distance Cost from the plannerClient Cost Control Editor.

st LAN_r distCost”


nce-cost to the ift.

Is the multiplier of the distance for the first Stop on a Shift

nce-cost to POU

Is the multiplier of the distance for POU Stops

opyright © 2000, 2010, O


A - 32

Distance Cost configurations


PLAN_DIST_COST or distCost

double_range

0.0 .. 1000000.00 1.0 Sets the cost inmeter of total dtravelled by the

PLAN_DIST_TDC or distCost_TDC

double_range

A=0.0 .. 1000000.0

B=0.0 .. 1000.0

C=0 .1 .. 10.0

D=0.0 .. 1000.0

E=0.0 .. 1000000.0

F =-1000000.0 .. 1000000.0

A=1.0

B=0.0

C=1.0

D=0.0

E=1.0

F=0.0

Sets the Time Dependent CoControls for “PDIST_COST odescribed on page A - 32.

PLAN_FIRSTJOB_DIST_FACTOR or firstJobDistanceFactor

double_range

0.01 .. 100.0 1 Factor on distawhen travellingfirst job for a sh

PLAN_POU_DIST_FACTOR or POU_DistanceFactor

double_range

0.01 .. 100.0 1 Factor on distawhen travellingstop

Planner 10.5

System

Manual

C A.1.2.6 Run Cost configurations


Sets the flat cost for activating a run.


st against s o different e

Used to encourage the Scheduler to create separate runs in a resource’s trip without interspersing the stops of one task inside the run of a second task. For example, this cost will encourage the separation of Collection and Distribution tasks so that Depot stacking problems are minimised.

e Cost r “PLAN_RATION

ionCost” n .


opyright © 2000, 2010, O


A - 33

A.1.2.7 Run Separation Cost Configuration

Run Cost configurations


PLAN_RUN_COST or runCost

runCost double_range 0.0 .. 1000000.0

1000.0

Run Separation Cost configurations


PLAN_RUN_SEPARATION or runSeparationCost

string A= 0.0 .. 1000000.0,

B= 0.001 .. 000000.0,

C= 0.0 .. 1000000.0

Not set Sets the comixing stopbelonging ttasks, on thresource.

PLAN_RUN_SEP_TDC or runSeparationCost_TDC

double_range

A=0.0 .. 1000000.0

B=0.0 .. 1000.0

C=0 .1 .. 10.0

D=0.0 .. 1000.0

E=0.0 .. 1000000.0

F =-1000000.0 .. 1000000.0

A=1.0

B=0.0

C=1.0

D=0.0

E=1.0

F=0.0

Sets the TimDependentControls foRUN_SEPAor runSeparatdescribed opage A - 33

Planner 10.5

System

Manual

C A.1.2.8 Round Cost configurations


This Applies to the amount of overlap of the rectangles created for roundCost.

in the PLAN_ROUND_VAR_COST applies to the standard deviation in the size of the rounds and is applied per meter of variance. This cost is applied across the whole schedule and hence is of little use in a real-time multi-day schedule scenario where there is a large variance between the size of a round for today which is being executed and one in a weeks time which is still being built with incoming calls.

Helps to provide better coverage for jobs.

nsion rs.

Absolute amount by which the rectangle that forms a round is extended for calculating overlap when added to relative extension.

sion Relative amount by which the rectangle that forms a round is extended for calculating overlap when added to absolute extension.

shift

opyright © 2000, 2010, O


A - 34

Round Cost configurations


PLAN_ROUND_OL_COST or roundOverlapCost

double_range

0.0 .. 1000000.0

NULL Cost for overlapping rounds.

PLAN_ROUND_VAR_COST or roundVarianceCost

double_range

0.0 .. 1000000.0

NULL Cost for the variance size of rounds.

PLAN_END_OVRLAP_COST or roundEndOverlapCost

double_range

0.0 .. 1000000.0

NULL Cost against rounds finishing in the same region.

PLAN_ROUND_EXTN_ABS or roundExtensionAbs

double_range

0.0 .. 1000000.0

NONE Cost of absolute exteof Round in Kilomete

PLAN_ROUND_EXTN_REL or roundExtensionRel

double_range

0.0 .. 1000000.0

NONE Cost of relative extenof Round.

PLAN_RD_LEN_VAR_COST or roundLengthVarianceCost

double_range

0.0 .. 1000000.0

NULL Variation in total roundLength across a

Planner 10.5

System

Manual

C 1.1.2.8.1 Round Length Cost configurations


r the time rom first to last p of a round.

e Time dent Cost ls for “PLAN_D_LEN_COST dLengthCost” ed on - 35.



r phical round.

See, “ COST_UND or

Round” e A - 59.

In order to determine the size of a round smauto draws a rectangle encompassing all the stops associated with the round and then calculates the length of the diagonal. PLAN_AREA_ROUND_COST is applied, per meter of the length of this diagonal.

opyright © 2000, 2010, O


A - 35

1.1.2.8.2 Round Area Cost configurations

Round Length Cost configurations


PLAN_ROUND_LEN_COST or roundLengthCost

double_range

0.0 .. 1000000.0 NULL Cost fospent fjob-sto

PLAN_ROUND_LEN_TDC or roundLengthCost_TDC

double_range

A=0.0 .. 1000000.0

B=0.0 .. 1000.0

C=0 .1 .. 10.0

D=0.0 .. 1000.0

E=0.0 .. 1000000.0

F =-1000000.0 .. 1000000.0

A=1.0

B=0.0

C=1.0

D=0.0

E=1.0

F=0.0

Sets thDepenControROUNor roundescribpage A

Round Area Cost configurations (Sheet 1 of 2)


PLAN_AREA_ROUND_COST or roundCost

double_range

0.0 .. 1000000.0 NULL Cost fogeograsize of

Note: PLAN_BY_ROcostByon pag

Planner 10.5

System

Manual

C

e Time dent Cost ls for _AREA_D_COST dCost” ed on - 35.



products PRODUCT_COST is used to encourage or discourage the product being collected at the referenced Depot. TARGET_PRIORITY is used to obtain the most cost effective product depot relationship towards meeting the product target, whenever more than one depot is capable of collecting the product.

Round Area Cost configurations (Sheet 2 of 2) (Continued)
opyright © 2000, 2010, O

A - 36

A.1.2.9 Depot Cost configurations

1.1.2.9.1 Product Depot Cost configurations

PLAN_AREA_ROUND_TDC or roundCost_TDC

double_range

A=0.0 .. 1000000.0

B=0.0 .. 1000.0

C=0 .1 .. 10.0

D=0.0 .. 1000.0

E=0.0 .. 1000000.0

F =-1000000.0 .. 1000000.0

A=1.0

B=0.0

C=1.0

D=0.0

E=1.0

F=0.0

Sets thDepenContro“PLANROUNor roundescribpage A

Product Depot Cost configurations (Sheet 1 of 2)


PLAN_PRO_DEPOT_COST or productDepotCost

double_range

0.0 .. 1000000.0

NONE Sets the cost for using from a particular depot

Planner 10.5

System

Manual

C

acity See also PLAN_PRO_DEPOT_COST on page A - 36.

acity

below

above

doubling Capacity


exceeding in the Depot

exceeding in the ow.

Product Depot Cost configurations (Sheet 2 of 2) (Continued)
opyright © 2000, 2010, O

A - 37

1.1.2.9.2 Depot Time Window Cost configurations

PLAN_ZERO_CAP_COST or zeroCap

double_range

0.0 .. 1000000.0

NONE Cost for zero depot cap

PLAN_MAX_CAP_COST or maxCap

double_range

0.0 .. 1000000.0

NONE Cost for max depot cap

PLAN_BELOW_TGT_COST or drBelowTgt

double _range

0.5 .. 20.00 NONE Cost for depot capacitytarget

PLAN_ABOVE_TGT_COST or drAboveTgt

double_range

0.5 .. 20.00 NONE Cost for depot capacitytarget

PLAN_DEPOT_DBL_INT or depotCapacDoubleIntvlCoeff

double_range

0.0 .. 1000000.0

100 Depot capacity functioninterval for units > max

Depot Time Window Cost configurations


PLAN_WIN_CAP_WGT or depotWinCapWeight

double_range

A= 0.0 .. 1000000.0,

B= 0.001 .. 1000000.0,

C= 0.0 .. 1000000.0

0.0,0.001,0.0

Sets the cost for the depot weight Time Window.

PLAN_WIN_CAP_VOL or depotWinCapVolume

double_range

A= 0.0 .. 1000000.0,

B= 0.001 .. 1000000.0,

C= 0.0 .. 1000000.0

0.0,0.001,0.0

Sets the cost for the depot volumeDepot Time Wind

Planner 10.5

System

Manual

C A.1.2.10 Business Priorities configurations


sequent e within TIME.

There are many situations where a Site needs to be visited repeatedly after a certain interval of time. If the time interval between any two such visits is violated, then this cost is applied.

SITE_SEPARATION_ID identifies the Site to which visits need to be regulated and the SITE_SEPARATION_TIME identifies the delay between each visit to the Site.

ration in

opyright © 2000, 2010, O


A - 38

Site Separation configurations


PLAN_SITE_SEP_COST or siteSeparationCost

double_range

0.0 .. 1000000.0

0.0 Sets the cost for each subvisit made to the same sitthe SITE_SEPARATION_

PLAN_TIME_SLOT_WIDTH or timeSlotWidth

int_range 1 .. 1000000 1 second Time interval for site sepa(second)

Planner 10.5

System

Manual

C 1.1.2.10.1 Weight Cost configurations

iption Recommendations / Comments

t for he weight on shifts.

This cost is controlled by three values A, B and C.

The number of units over the weight limit for the shift is multiplied by value A which is doubled every B units. C is applied only once as soon as the shift becomes overweight.

This value can be changed by altering the Weight Cost from the plannerClient Cost Control Editor.

e Cost “PLAN_OST or described 39.


opyright © 2000, 2010, O


A - 39

Weight Cost configurations

Configuration Parameter Type Range default Descr

PLAN_WEIGHT_COST or weightCost

double_range

A= 0.0 .. 1000000.0,

B= 0.001 .. 1000000.0,

C= 0.0 .. 1000000.0

1.00e+04, 0.02, 0.0

Sets the cosexceeding trestrictions

PLAN_WEIGHT_TDC or weightCost_TDC

double_range

A=0.0 .. 1000000.0

B=0.0 .. 1000.0

C=0 .1 .. 10.0

D=0.0 .. 1000.0

E=0.0 .. 1000000.0

F =-1000000.0 .. 1000000.0

A=1.0

B=0.0

C=1.0

D=0.0

E=1.0

F=0.0

Sets the TimDependent Controls forWEIGHT_CweightCost”on page A -

Planner 10.5

System

Manual

C 1.1.2.10.2 Wait Time Cost configurations


st for the le.

Used to discourage the scheduling of Shifts with long periods of waiting at stops.

See also PLAN_COSTWAIT_MAX on page A - 41 and PLAN_COSTWAIT_HRZON on page A - 40.

st for the le in the

See also PLAN_COSTWAIT_P_MAX on page A - 41 and PLAN_COSTWAIT_HRZON on page A - 40.

f PLAN_ should r started for both ot-started

AIT_e A - 40.

Set to TRUE to apply wait cost to both started and not-started shifts.

Set to FALSE to apply wait cost to started only shifts.

interval ent time AN_ is

AIT_e A - 40.

PLAN_WAIT_COST tapers from 0 to 1 when waiting accrues within PLAN_COSTWAIT_HRZON from currentTime

opyright © 2000, 2010, O


A - 40

Wait Time Cost configurations (Sheet 1 of 3)


PLAN_WAIT_COST or waitCost

double_range

0.0 .. 1000000.0 0.0 Quadratic Coshift being id

PLAN_WAIT_PAST_COST or waitCostPast

double_range

0.0 .. 1000000.0 0.0 Quadratic Coshift being idpast.

PLAN_COSTWAIT_FOROFF or CostWait_forOff

boolean TRUE, FALSE TRUE Determines iWAIT_COSTbe applied foonly shifts orstarted and nshifts.

See PLAN_WCOST on pag

PLAN_COSTWAIT_HRZON or waitHorizon

double_range

0.0 .. 1000000.0 2.0 hours Sets the timefrom the currwhen the PLWAIT_COSTapplied.

See PLAN_WCOST on pag

Planner 10.5

System

Manual

C

aximum n the time is AN_MAX).

If PLAN_WAIT_COST is set, then it is applied for all active shifts.

If PLAN_COSTWAIT_HRZON and PLAN_COSTWAIT_MAX parameter values are > than 0, then PLAN_WAIT_COST is applied on all empty shifts also.

See also PLAN_WAIT_COST on page A - 40 and PLAN_COSTWAIT_HRZON on page A - 40.

aximum n the past is capped STWAIT_

Used to apply higher wait cost for drivers with longer waiting time in the past, when considering a driver for a job.

See also PLAN_WAIT_COST on page A - 40 and PLAN_COSTWAIT_HRZON on page A - 40.

e ost PLAN_ or cribed on


Wait Time Cost configurations (Sheet 2 of 3) (Continued)
opyright © 2000, 2010, O

A - 41

PLAN_COSTWAIT_MAX or maxWait

double_range

0.0 .. 1000000.0 2.0 Defines the mwaiting time ifuture(costedcapped to PLCOSTWAIT_

PLAN_COSTWAIT_P_MAX or maxWaitPast

double_range

0.0 .. 1000000.0 2.0 Defines the mwaiting time i(costed time to PLAN_COP_MAX).

PLAN_WAIT_TDC or waitCost_TDC

double_range

A=0.0 .. 1000000.0

B=0.0 .. 1000.0

C=0 .1 .. 10.0

D=0.0 .. 1000.0

E=0.0 .. 1000000.0

F =-1000000.0 .. 1000000.0

A=1.0

B=0.0

C=1.0

D=0.0

E=1.0

F=0.0

Sets the TimDependent CControls for “WAIT_COSTwaitCost” despage A - 40.

Planner 10.5

System

Manual

C

e ost PLAN__COST or t”



nential ding the n a shift.

This cost is controlled by three values A, B and C.

The number of units over the volume limit for the shift is multiplied by value A which is doubled every B units. C is applied only once as soon as the shift goes over the volume.

This value can be changed by altering the Weight Cost from the plannerClient Cost Control Editor.

ost LAN_ST or

described 2.


Wait Time Cost configurations (Sheet 3 of 3) (Continued)
opyright © 2000, 2010, O

A - 42

1.1.2.10.3 Volume Cost configurations

PLAN_WAIT_PAST_TDC or waitCostPast_TDC

double_range

A=0.0 .. 1000000.0

B=0.0 .. 1000.0

C=0 .1 .. 10.0

D=0.0 .. 1000.0

E=0.0 .. 1000000.0

F =-1000000.0 .. 1000000.0

A=1.0

B=0.0

C=1.0

D=0.0

E=1.0

F=0.0

Sets the TimDependent CControls for “WAIT_PASTwaitCostPasdescribed onpage A - 40.

Volume Cost configurations


PLAN_VOLUME_COST or volumeCost

double_range

0.0 .. 1000000.0 1.00e+04, 0.02, 0.0

Sets the expocost of exceevolume limit o

PLAN_VOLUME_TDC or volumeCost_TDC

double_range

A=0.0 .. 1000000.0

B=0.0 .. 1000.0

C=0 .1 .. 10.0

D=0.0 .. 1000.0

E=0.0 .. 1000000.0

F =-1000000.0 .. 1000000.0

A=1.0

B=0.0

C=1.0

D=0.0

E=1.0

F=0.0

Sets the TimeDependent CControls for “PVOLUME_COvolumeCost” on page A - 4

Planner 10.5

System

Manual

C 1.1.2.10.4 Site Cost configurations

ion Recommendations / Comments

ing a Site Site names are defined in the STOP and this cost applies to every vehicle that visits a site. Encourages same site stops to be placed on the same vehicle.

ependent r “PLAN_iteCost”

ge A - 43.



ost of in the

Changing Shift Cost from the plannerClient Cost Control Editor will alter this parameter value. Used to encourage the Scheduler to minimise the number of used shifts in the schedule.

opyright © 2000, 2010, O


A - 43

1.1.2.10.5 Shift Cost configurations

Site Cost configurations

Configuration Parameter Type Range default Descript

PLAN_SITE_COST or siteCost

double_range

0.0 .. 1000000.0 0.0 Flat cost for visit

PLAN_SITE_TDC or siteCost_TDC

double_range

A=0.0 .. 1000000.0

B=0.0 .. 1000.0

C=0 .1 .. 10.0

D=0.0 .. 1000.0

E=0.0 .. 1000000.0

F =-1000000.0 .. 1000000.0

A=1.0

B=0.0

C=1.0

D=0.0

E=1.0

F=0.0

Sets the Time DCost Controls foSITE_COST or sdescribed on pa

Shift Cost configurations (Sheet 1 of 2)


PLAN_TRIP_COST or tripCost

double_range

0.0 .. 1000000.00 1000.0 Sets the flat cusing a Shift solution.

Planner 10.5

System

Manual

C

e ost PLAN_ or cribed on



pacity is each second e capacity is he value the Shift’s _CAPACITY

me Dependent ols for “PLAN__COST or pacity” on 4.


Shift Cost configurations (Sheet 2 of 2) (Continued)
opyright © 2000, 2010, O

A - 44

1.1.2.10.6 Reserve Capacity Cost configurations

PLAN_TRIP_TDC or tripCost_TDC

double_range

A=0.0 .. 1000000.0

B=0.0 .. 1000.0

C=0 .1 .. 10.0

D=0.0 .. 1000.0

E=0.0 .. 1000000.0

F =-1000000.0 .. 1000000.0

A=1.0

B=0.0

C=1.0

D=0.0

E=1.0

F=0.0

Sets the TimDependent CControls for “TRIP_COSTtripCost” despage A - 43.

Reserve Capacity Cost configurations


PLAN_RES_CAP_COST or reserveCapacity

double_range

A= 0.0 .. 1000000.0,

B= 0.001 .. 1000000.0,

C= 0.0 .. 1000000.0

0.0,0.001,0.0

Reserve cacosted for that reservless than tspecified inRESERVEfield.

PLAN_RES_CAP_TDC or reserveCapacity_TDC

double_range

A=0.0 .. 1000000.0

B=0.0 .. 1000.0

C=0 .1 .. 10.0

D=0.0 .. 1000.0

E=0.0 .. 1000000.0

F =-1000000.0 .. 1000000.0

A=1.0

B=0.0

C=1.0

D=0.0

E=1.0

F=0.0

Sets the TiCost ContrRES_CAPreserveCadescribed page A - 4

Planner 10.5

System

Manual

C 1.1.2.10.7 Long Haul Cost configurations


st of the rmination of a

Cost when the gs off at a er than its log off

ONGHAUL

This cost is applied only when the shift type is LONGHAUL.

This value can be changed by altering the Longhaul Cost within the plannerClient Cost Control Editor.

me Dependent ols for “PLAN_UL_COST or ost” described - 45.



nential cost he length of ds will be left rce after being

This cost should be used when scheduling jobs with lifespan expiry restrictions.

opyright © 2000, 2010, O


A - 45

1.1.2.10.8 Life Span Cost configurations

Long Haul Cost configurations


PLAN_LONG_HAUL_COST or longHaulCost

double_range

0.0 .. 1000000.0 0.0 Sets the coimproper teLong haul.resource loposition othdesignatedposition. Lshifts only.

PLAN_LONG_HAUL_TDC or longHaulCost_TDC

double_range

A=0.0 .. 1000000.0

B=0.0 .. 1000.0

C=0 .1 .. 10.0

D=0.0 .. 1000.0

E=0.0 .. 1000000.0

F =-1000000.0 .. 1000000.0

A=1.0

B=0.0

C=1.0

D=0.0

E=1.0

F=0.0

Sets the TiCost ContrLONG_HAlongHaulCon page A

Life Span Cost configurations (Sheet 1 of 2)


PLAN_LIFESPAN_COST or lifeSpanCost

string A= 0.0 .. 1000000.0,

B= 1 .. 1000000.0,

C= 0.0 .. 1000000.0

NONE Sets the expofor reducing ttime that gooon the resouloaded.

Planner 10.5

System

Manual

C

e Dependent for “PLAN_OST or

” described on



limit on f all Jobs

on a Job has ted

aulting to h Shift imum Job ulting to is ty is via the IT cost

n al cost.

The input to the cost function is the absolute value that a Shift is over limit.

For example:

• A Shift with a Maximum Jobs Limit of 10 and a sum of all scheduled Jobs values of 12 results in a cost input of 2.• A Shift with a Maximum Jobs Limit of 100 and a sum of all scheduled Jobs values of 102 results in the same cost input of 2, and thus the same cost.

Life Span Cost configurations (Sheet 2 of 2) (Continued)
opyright © 2000, 2010, O

A - 46

1.1.2.10.9 Jobs Limit Cost configurations

PLAN_LIFESPAN_TDC or lifeSpanCost_TDC

double_range

A=0.0 .. 1000000.0

B=0.0 .. 1000.0

C=0 .1 .. 10.0

D=0.0 .. 1000.0

E=0.0 .. 1000000.0

F =-1000000.0 .. 1000000.0

A=1.0

B=0.0

C=1.0

D=0.0

E=1.0

F=0.0

Sets the TimCost ControlsLIFESPAN_ClifeSpanCostpage A - 45.

Jobs Limit Cost configurations (Sheet 1 of 2)


PLAN_JOBS_LIMIT_COST or jobsLimit

string A= 0.0 .. 1000000.0,

B= 0.001 .. 000000.0,

C= 0.0 .. 1000000.0

0.0,0.001,0.0

There is athe value oscheduledShift. Eachan associavalue, def1, and eachas a MaxLimit, defainfinite. ThfunctionalicontrolledJOBS_LIMwhich is aexponenti

Planner 10.5

System

Manual

C

ime t Cost r “PLAN_IT_

obsLimit” on 6.



e cost of ng with no -board

Typical example is when cabs need to travel empty to or from a passenger pick-up or drop-off.

e Time dent Cost ls for “PLAN__TRVL_

or ravelCost” ed on - 47.


Jobs Limit Cost configurations (Sheet 2 of 2) (Continued)
opyright © 2000, 2010, O

A - 47

1.1.2.10.10 Empty Travel Cost configurations

PLAN_JOBS_LIMIT_TDC or jobsLimit_TDC

double_range

A=0.0 .. 1000000.0

B=0.0 .. 1000.0

C=0 .1 .. 10.0

D=0.0 .. 1000.0

E=0.0 .. 1000000.0

F =-1000000.0 .. 1000000.0

A=1.0

B=0.0

C=1.0

D=0.0

E=1.0

F=0.0

Sets the TDependenControls foJOBS_LIMCOST or jdescribedpage A - 4

Empty Travel Cost configurations


PLAN_EMPTY_TRVL_COST or emptyTravelCost

double_range

A= -1000000.0 .. 1000000.0,

B= 0.0 .. 1000000.0,

C= -1000000.0 .. 1000000.0

NONE Sets thtravellijobs on

PLAN_EMPTY_TRVL_TDC or emptyTravelCost_TDC

double_range

A=0.0 .. 1000000.0

B=0.0 .. 1000.0

C=0 .1 .. 10.0

D=0.0 .. 1000.0

E=0.0 .. 1000000.0

F =-1000000.0 .. 1000000.0

A=1.0

B=0.0

C=1.0

D=0.0

E=1.0

F=0.0

Sets thDepenControEMPTYCOST emptyTdescribpage A

Planner 10.5

System

Manual

C 1.1.2.10.11 Dynamic Working Area Cost configurations


e cost against g the vehicle for here this

is based further e Job than an suitable vehicle

See, “Appendix B: Dynamic Working Areas” on page B - 1 for more details.

e Time ent Cost s for “PLAN_WA_COST or orkingAreaCost” ed on - 48.



exponential taking breaks

opyright © 2000, 2010, O


A - 48

1.1.2.10.12 Break Late Cost configurations

Dynamic Working Area Cost configurations


PLAN_DNMK_WA_COST or dnmkWorkingAreaCost

string A= 0.0 .. 1000000.0,

B= 0.001 .. 000000.0,

C= 0.0 .. 1000000.0

0.0,1.0,0.0

Sets thselectina Job, wvehiclefrom thequally

PLAN_DNMK_WA_TDC or dnmkWorkingAreaCost_TDC

double_range

A=0.0 .. 1000000.0

B=0.0 .. 1000.0

C=0 .1 .. 10.0

D=0.0 .. 1000.0

E=0.0 .. 1000000.0

F =-1000000.0 .. 1000000.0

A=1.0

B=0.0

C=1.0

D=0.0

E=1.0

F=0.0

Sets thDependControlDNMK_dnmkWdescribpage A

Break Late Cost configurations (Sheet 1 of 2)


PLAN_BREAK_LATE_COST or breakLateCost

double_range

A= 0.0 .. 1000000.0,

B= 1.0 .. 1000000.0,

C= 0.0 .. 1000000.0

NULL Sets thecost for late

Planner 10.5

System

Manual

C

order for this job to be included in the ooking, the part of the cost that each han the MAXCOST supplied in the JOB_ccepted only If none of the factorised

ctor should be set to zero and to give high multiplier.

Time ent Cost for “PLAN_

_LATE_COST LateCost” d on

- 48.


Break Late Cost configurations (Sheet 2 of 2) (Continued)
opyright © 2000, 2010, O

A - 49

A.1.2.11 Conditional Assignment configurationsAll parameters in this section are used for Conditionally booking the jobs.

After a slot is booked the job can be sent to smauto with an initial status of INACTIVE. Inschedule it must be followed by a JOB_ASSIGN_COND message. During Conditional Bfactor relates to is multiplied by the associated value and if the resulting value is greater tASSIGN_COND packet on its own then the job will be rejected. The job assignment is acomponents exceed the MAXCOST.

Note: To eliminate a cost from the conditional assignment costing, the corresponding famore importance to a particular cost, the corresponding factor should be set to a

The conditional assignment factors are grouped under the following categories:• Violation Cost Factors• Travel Cost Factors• Time violation Cost Factors• Service cost Factors

PLAN_BREAK_LATE_TDC or breakLate_TDC

double_range

A=0.0 .. 1000000.0

B=0.0 .. 1000.0

C=0 .1 .. 10.0

D=0.0 .. 1000.0

E=0.0 .. 1000000.0

F =-1000000.0 .. 1000000.0

A=1.0

B=0.0

C=1.0

D=0.0

E=1.0

F=0.0

Sets theDependControlsBREAKor breakdescribepage A

Planner 10.5

System

Manual

C 1.1.2.11.1 Violation Cost Factors


r slot booker cost: To eliminate a cost from the conditional assignment costing, the corresponding factor should be set to zero and to give more importance to a particular cost, the corresponding factor should be set to a high multiplier

r slot booker cost:

r slot booker cost:

r slot booker cost:

r slot booker cost:

r slot booker cost:

r slot booker cost:

r slot booker cost:

r slot booker cost:

r slot booker cost:

opyright © 2000, 2010, O


A - 50

Violation Cost Factors configuration


PLAN_LOADCOST_FACTOR or load_factor

double_range

0.0 .. 1000.0 1.0 Multiplying factor foload

PLAN_JOBATTR_FACTOR or jobAttr_factor

Multiplying factor fojobAttr

PLAN_S_LINK_FACTOR or singleLink_factor

Multiplying factor fosingleLink

PLAN_S_ITEM_FACTOR or singleItem_factor

Multiplying factor fosingleItem

PLAN_LIFESPAN_FACTOR or lifeSpan_factor

Multiplying factor folifespan

PLAN_COMPAT_FACTOR or compat_factor

Multiplying factor focompat

PLAN_OVERSKILL_FACTOR or overSkill_factor

Multiplying factor fooverSkill

PLAN_RSRCATTR_FACTOR or rsrcAttr_factor

Multiplying factor forsrcattr

PLAN_ZONE_FACTOR or zone_factor

Multiplying factor fozone

PLAN_MAPS_FACTOR or maps_factor

Multiplying factor fomaps

Planner 10.5

System

Manual

C 1.1.2.11.2 Travel Cost Factors


slot booker To eliminate a cost from the conditional assignment costing, the corresponding factor should be set to zero and to give more importance to a particular cost, the corresponding factor should be set to a high multiplier

slot booker

slot booker

slot booker

slot booker

slot booker

slot booker

slot booker

slot booker

opyright © 2000, 2010, O


A - 51

Travel Cost Factors configuration


PLAN_DIST_FACTOR or dist_factor

double_range

0.0 .. 1000.0 1.0 Multiplying factor forcost: dist

PLAN_TRVLTIME_FACTOR or travelTime_factor

Multiplying factor forcost: travelTime

PLAN_IDLETIME_FACTOR or idleTime_factor

Multiplying factor forcost: idleTime

PLAN_LONGHAUL_FACTOR or longHaul_factor

Multiplying factor forcost: longHaul

PLAN_APEX_FACTOR or apex_factor

Multiplying factor forcost: apex

PLAN_MANYSHFT_FACTOR or manyShift_factor

Multiplying factor forcost: manyShift

PLAN_WAIT_FACTOR or wait_factor

Multiplying factor forcost: wait

PLAN_EMP_TRVL_FACTOR or emptyTravel_factor

Multiplying factor forcost: emptyTravel

PLAN_RUN_FACTOR or run_factor

Multiplying factor forcost: run

Planner 10.5

System

Manual

C 1.1.2.11.3 Time Violation Cost Factors


slot To eliminate a cost from the conditional assignment costing, the corresponding factor should be set to zero and to give more importance to a particular cost, the corresponding factor should be set to a high multiplier

slot te

slot

slot end

slot te

opyright © 2000, 2010, O


A - 52

Time Violation Cost Factors configuration


PLAN_STOPLATE_FACTOR or stopLate_factor

double_range

0.0 .. 1000.0 1.0 Multiplying factor for booker cost: stopLate

PLAN_DEP_LATE_FACTOR or depotLate_factor

Multiplying factor for booker cost: depotLa

PLAN_OFFLATE_FACTOR or offLate_factor

Multiplying factor for booker cost: offLate

PLAN_HAULEXT_FACTOR or haulExtend_factor

Multiplying factor for booker cost: haulExt

PLAN_BRKLATE_FACTOR or breakLate_factor

Multiplying factor for booker cost: breakLa

Planner 10.5

System

Manual

C 1.1.2.11.4 Service Cost Factors


lot booker

lot booker

lot booker

lot booker

lot booker

lot booker

lot booker

opyright © 2000, 2010, O


A - 53

Service Cost Factors configuration


PLAN_WINDOW_FACTOR or window_factor

double_range

0.0 .. 1000.0 1.0 Multiplying factor for scost: window

PLAN_SITE_FACTOR or site_factor

Multiplying factor for scost: site

PLAN_PKUPSRVC_FACTOR or pkupService_factor

Multiplying factor for scost: pkupService

PLAN_DROPSRVC_FACTOR or dropService_factor

Multiplying factor for scost: dropService

PLAN_RUN_SEP_FACTOR or runSeparation_factor

Multiplying factor for scost: runSeparation

PLAN_RES_CAP_FACTOR or reserveCap_factor

Multiplying factor for scost: reserveCap

PLAN_DPT_PROD_FACTOR or depotProduct_factor

Multiplying factor for scost: depotProduct

Planner 10.5

System

Manual

C A.1.2.12 Attribute Conflicts configuration


meter should discourage

assigning d Crews

quality or in to Jobs. When parameter is rew with an f Skills is to a Job, a e applied to

duler’s function.

Time nt Cost for “PLAN_KILL_COST illCost” on

54.


opyright © 2000, 2010, O


A - 54

1.1.2.12.1 Over Skill Cost configuration

Over Skill Cost configuration


PLAN_OVER_SKILL_COST or overSkillCost

double_range

0.0 .. 1000000.0 0 This parabe set toORS fromoverskille(either inquantity)this cost set, if a Cexcess oassignedcost will bthe Scheobjective

PLAN_OVER_SKILL_TDC or overSkillCost_TDC

double_range

A=0.0 .. 1000000.0

B=0.0 .. 1000.0

C=0 .1 .. 10.0

D=0.0 .. 1000.0

E=0.0 .. 1000000.0

F =-1000000.0 .. 1000000.0

A=1.0

B=0.0

C=1.0

D=0.0

E=1.0

F=0.0

Sets the DependeControls OVER_Sor overSkdescribedpage A -

Planner 10.5

System

Manual

C 1.1.2.12.2 Job Attribute Cost configuration


for e stops shift.

This cost will be applied for each job having attributes that are in conflict with any attribute associated with the resource.

For example, if the Stop involves the transportation of reactive chemicals, then the J_PKUP and J_DROP fields for stops can be set to Hazardous. On visiting the stop with J_PKUP = Hazardous, the Resource temporarily acquires this Job attribute. Any following jobs with J_MUSTNOTHAVE=Hazardous or J_PREFNOTHAVE=Hazardous will incur this cost until a Job with J_DROP=Hazardous is serviced.

This value can be changed by altering the Job attribute violation Cost from the plannerClient Cost Control Editor.

st LAN_OST or


opyright © 2000, 2010, O


A - 55

Job Attribute Cost configuration


PLAN_JOB_ATTR_COST or jobAttrCost

double_range

0.0 .. 1000000.0 1.00e+04

Sets the cost having multiplwith conflictingattributes on a

PLAN_JOB_ATTR_TDC or jobAttrCost_TDC

double_range

A=0.0 .. 1000000.0

B=0.0 .. 1000.0

C=0 .1 .. 10.0

D=0.0 .. 1000.0

E=0.0 .. 1000000.0

F =-1000000.0 .. 1000000.0

A=1.0

B=0.0

C=1.0

D=0.0

E=1.0

F=0.0

Sets the TimeDependent CoControls for “PJOB_ATTR_CjobAttrCost” described on page A - 55.

Planner 10.5

System

Manual

C 1.1.2.12.3 Resource Attribute Cost configuration


cost for having a shift where

utes in the ot match

the shift.

The cost is applied once for each stop with conflicting attribute.

This value can be changed by altering the Resource attribute violation Cost from the plannerClient Cost Control Editor.

Time nt Cost for “PLAN_TTR_COST or ost” described A - 56.


opyright © 2000, 2010, O


A - 56

Resource Attribute Cost configuration


PLAN_RSRC_ATTR_COST or rsrcAttrCost

double_range

0.0 .. 1000000.0 1.00e+04 Sets the a Stop onthe attribstop do nthose on

PLAN_RSRC_ATTR_TDC or rsrcAttrCost_TDC

double_range

A=0.0 .. 1000000.0

B=0.0 .. 1000.0

C=0 .1 .. 10.0

D=0.0 .. 1000.0

E=0.0 .. 1000000.0

F =-1000000.0 .. 1000000.0

A=1.0

B=0.0

C=1.0

D=0.0

E=1.0

F=0.0

Sets the DependeControls RSRC_ArsrcAttrCon page

Planner 10.5

System

Manual

C 1.1.2.12.4 Round Zone Cost configuration


st for each ithout a single

thin the shift’s

e Time ent Cost s for “PLAN_ONE_COST dZoneCost” ed on - 57.



for each stop e shift’s zone.

Used to encourage vehicles to work in their preferred zones.

opyright © 2000, 2010, O


A - 57

1.1.2.12.5 Stop Zone Cost configuration

Round Zone Cost configuration


PLAN_RND_ZONE_COST or roundZoneCost

double_range

0.0 .. 1000000.0 0.0 Flat Coround wstop wizone.

PLAN_RND_ZONE_TDC or roundZoneCost_TDC

double_range

A=0.0 .. 1000000.0

B=0.0 .. 1000.0

C=0 .1 .. 10.0

D=0.0 .. 1000.0

E=0.0 .. 1000000.0

F =-1000000.0 .. 1000000.0

A=1.0

B=0.0

C=1.0

D=0.0

E=1.0

F=0.0

Sets thDependControlRND_Zor roundescribpage A

Stop Zone Cost configuration (Sheet 1 of 2)


PLAN_STOP_ZONE_COST or stopZoneCost

double_range

0.0 .. 1000000.0 0.0 Flat Cost outside th

Planner 10.5

System

Manual

C

ime t Cost

or “PLAN_NE_COST or

Cost” on 7.



not finishing a e Apex.

This is a cost against the last stop in the run not being the furthest from the depot. This promotes geographical clustering of stops in a run by applying a cost for finishing a run at the Apex.

PEX_COST plied for

closer than PEX_RND_

(kms).

Stop Zone Cost configuration (Sheet 2 of 2) (Continued)
opyright © 2000, 2010, O

A - 58

A.1.2.13 Apex Costs configuration

PLAN_STOP_ZONE_TDC or stopZoneCost_TDC

double_range

A=0.0 .. 1000000.0

B=0.0 .. 1000.0

C=0 .1 .. 10.0

D=0.0 .. 1000.0

E=0.0 .. 1000000.0

F =-1000000.0 .. 1000000.0

A=1.0

B=0.0

C=1.0

D=0.0

E=1.0

F=0.0

Sets the TDependenControls fSTOP_ZOstopZonedescribedpage A - 5

Apex Costs configuration (Sheet 1 of 2)


PLAN_APEX_COST or apexCost

double_range

0.0 .. 1000000.0 0.0 Cost of run at th

PLAN_APEX_RND_DIST or apexRoundDist

double_range

0.0 .. 1000000.0 10.0 km PLAN_Ais not aprounds PLAN_ADIST in

Planner 10.5

System

Manual

C

st tapers from 0 between and B.

nes the type of be included in for the ion of various ost values.

Set to TRUE to include only stops associated with a depot in the round calculations.

Set to FALSE to include all stops between logon and logoff in the round calculations.

Time ent Cost for “PLAN_OST or

st” described A - 58.


Apex Costs configuration (Sheet 2 of 2) (Continued)

Shift Length Split into10 segments

A = 0.3 B = 0.8

Attempt to hit round apexin this period

opyright © 2000, 2010, O


A - 59

PLAN_APEX_RATIO_A or apexShiftRatioA

double_range

0.0 .. 1.0 1.0 Apex CoMAX to ratio’s A

PLAN_APEX_RATIO_B or apexShiftRatioB

double_range

PLAN_APEX_RATIO_A .. 1.0

1.0

PLAN_COST_BY_ROUND or costByRound

boolean TRUE, FALSE TRUE Determistops toa roundcalculatround c

PLAN_APEX_TDC or apexCost_TDC

double_range

A=0.0 .. 1000000.0

B=0.0 .. 1000.0

C=0 .1 .. 10.0

D=0.0 .. 1000.0

E=0.0 .. 1000000.0

F =-1000000.0 .. 1000000.0

A=1.0

B=0.0

C=1.0

D=0.0

E=1.0

F=0.0

Sets theDependControlsAPEX_CapexCoon page

Planner 10.5

System

Manual

C A.1.2.14 Real Time configuration


s

ur.

The default value AUTO_POSITION gives the scheduler a concept of NOW, where no work can be planned before NOW and Resources are dead-reckoned towards despatched Stops.

in uto

The location of the fleet of resources is determined (in a real-time operation) by the process of “dead reckoning” and the occurrence of job and resource milestone events.

In a real-time operation, the dead-reckoning resource location mechanism can be used to substitute for some resource milestone events.

TE D/

Set to TRUE to only dead-reckon when the Stop is ENROUTE. Set to FALSE to only dead-reckon when the Stop is CLOSED/DESPATCHED.

he

r

opyright © 2000, 2010, O


A - 60

Real Time configuration (Sheet 1 of 4)


PLAN_REAL_TIME or realTime

string OFF,AUTO_POSITION,AUTO_COMPLETE

AUTO_POSITION

This parameter controlthe realTime and deadreckoning behavio

PLAN_DR_TIMEINTERVAL or timeInterval

int_range 1 .. 15 2 Sets the time interval, minutes, at which smashould relocate the resource.

PLAN_DR_AUTOCOMPLGON or autoCompleteLogOn

boolean TRUE, FALSE

TRUE Enables smauto to automatically completeLogon stops by dead-reckoning.

PLAN_DR_WAIT_ENROUTE or waitForEnroute

boolean TRUE, FALSE

FALSE Use this parameter to dead-reckon resourceseither towards ENROUstop or towards CLOSEDESPATCHED stops.

PLAN_DR_ALL_AT_SITE or processAllAtSite

boolean TRUE, FALSE

TRUE Arrives/starts stops at tsame site at once for DeadReckoning only.IfTRUE all consecutive stops at a site will be processed at once. If FALSE arrival at site fosame site stops will beprocessed one by one.

Planner 10.5

System

Manual

C

red

, to

The automatic sending of the Go Home message is controlled through two channels, the Optimiser’s command line configuration and the settings within each Shift. When PLAN_AUTO_GO_HOME parameter is:

• Off, then the autoGoHome function is not activated for any shift.

• On, then the autoGoHome function is activated and will further be based on the individual Shifts setting.

• All then the autoGoHome function is activated for all shifts irrespective of the individual Shifts setting.

ter d. s,

set be ge

Real Time configuration (Sheet 2 of 4) (Continued)
opyright © 2000, 2010, O

A - 61

PLAN_AUTO_GO_HOME or autoGoHome

string Off, On, All Off Using this parameter smauto can be configuto automatically send shifts without any worklogoff.

PLAN_GO_HOME_TIME or goHomeTime

double_range

0 .. 24*3600 sec

NULL Vehicle is sent home afbeing idle for this perioTime to wait, in secondafter finishing last job before automatically directing to logoff. By default the value is not meaning a Shift will notsent a Go Home messaearly if idle.

Planner 10.5

System

Manual

C

r

E. ed

_e

DELAYED indicates that the vehicle should not move or progress any work (started stop) or break until the specified time. Once the specified delay expires the system will either:

• Automatically "un-delay" the vehicle at the specified date/time if PLAN_TIME_TO_ACTIVE = 0. This type of delay is termed as FIXED delay (PLAN_TIME_TO_ACTIVE = 0) which is the default behaviour.

or

• Maintain the DELAYED status until an UNDELAY packet is received. This will take the form of a "minimum remaining delay", modeling uncertainty about the actual time the vehicle can resume its duties. This type of delay is termed as INDEFINITE delay and is defined using PLAN_TIME_TO_ACTIVE > 0seconds.

at

d

opyright © 2000, 2010, O

A - 62

PLAN_TIME_TO_ACTIVE or vehicleTimeToActive

int_range 0.0 .. 86400.0 0.0 Controls the time factoas to when smauto willrevert a DELAYED vehicle state to ACTIV The delay is calculatas (now + PLAN_TIMETO_ACTIVE) after thspecified date/time.

PLAN_UE_COMPENSATOR or bUEC

boolean TRUE, FALSE

TRUE Set to TRUE to fix the plan on receiving unexpected events

PLAN_UEC_THRESHOLD or UEC_costThreshold

double_range

0.0 .. 1e100 1e100 Is the cost threshold thmust be reached, to activate the UnexpecteEvent Compensator

Planner 10.5

System

Manual

C

en ed

If a job has been started and a GPS ping is received that places the vehicle more than the PLAN_COMPLETE_DIST distance from the stop then the stop will be Auto Completed.

opyright © 2000, 2010, O

A - 63

PLAN_COMPLETE_DIST or completeDist

double_range

0.0 .. 1000000.0

4000.0 Sets the minimum drivdistance from the startstop, by which the stopstatus can be changedfrom STARTED to COMPLETED.

Planner 10.5

System

Manual

C 1.1.2.14.1 Reference Time configuration

on Recommendations / Comments

(in mins) at d start the s

with which the ted.

Internally set to 2 hours, which should not be changed without consulting Oracle.


optional stop field.

Used to specify the STOP and PARAM_STOP fields to be included in the JOB_TO_MDT message from the scheduler to the driver.

opyright © 2000, 2010, O


A - 64

1.1.2.14.2 Dispatch Message configuration

Reference Time configuration

Configuration Parameter Type Range default Descripti

PLAN_START_REF_TIME or startTimeRT

int_range 0 .. 24 NONE Sets the time of the daywhich the system shoulReference Time update

PLAN_INTVAL_REF_TIME or intervalRT

double_range

0.001 .. 24 NONE Sets the interval (hours)Reference Time is upda

Dispatch Message configuration


PLAN_DESP_TEXT_1 or optStopText1 string_list

Stop fields NULL Sets theinfo text

PLAN_DESP_TEXT_2 or optStopText2







Planner 10.5

System

Manual

C A.1.2.15 Optimiser Controls configuration


tween time

This interval is used by the Scheduler to artificially extend the specified time windows of the shifts for the purpose of optimization. If set to zero, the shift and stop time windows must overlap for allocation to be possible. If set greater than zero, then a time window mismatch of the specified time will be acceptable to the Scheduler when making recommendations.

inimum tops, if is less

VL_

PLAN_MIN_TRVL_TIME > 600 seconds should never be used as it would have a huge adverse effect on the schedule.

PLAN_MIN_TRVL_TIME value set to > 10 minutes is automatically capped to10 minutes and a warning is issued.

AN_ould be nd non-) stops See L_

.

When TRUE - travel time between all Stops, excepting Breaks, is set to be equal to PLAN_MIN_TRVL_TIME.

When FALSE - PLAN_MIN_TRVL_TIME is applied only between Job Stops.

plied to

opyright © 2000, 2010, O


A - 65

Optimiser Controls configuration (Sheet 1 of 6)


PLAN_SHIFT_TIME_EXT or ShiftWinExtension

int_range 0 .. 60000 60 Sets in minutes, the mismatch allowed beshift window and stopwindows.

PLAN_MIN_TRVL_TIME or minTravelTime

double_range

0.0 .. 600.0 0.0 seconds

Used to adjust the mtravel time between scalculated travel timethan PLAN_MIN_TRTIME.

PLAN_MIN_TRVL_NONJOB or applyMinTravelTimeToNonStop

boolean TRUE, FALSE

FALSE Used to specify if PLMIN_TRVL_TIME shapplied for both job ajob (depot, log, breakor only for job stops. also PLAN_MIN_TRVTIME on page A - 65

PLAN_IDB_OPT_LEVEL or idbOptLevel

string One of:

• None• Standard• Thorough

Thorough Sets the level of touroptimisation to be apIDB

Planner 10.5

System

Manual

C

ich is

Determines the effort that smauto will put towards placing a single job with load value greater than the shift’s load limit on the shift.

For example:

If PLAN_LOAD_FACTOR=1 Any single job with load exceeding the shift load limit will not be scheduled

If PLAN_LOAD_FACTOR=1.1 Will try to schedule a single job with load a little over the shift load limit

st is d on altime. st is d on re time.

ure the ess on

RUE, ied to arison LSE ied to

ime.

Optimiser Controls configuration (Sheet 2 of 6) (Continued)
opyright © 2000, 2010, O

A - 66

PLAN_LOAD_FACTOR or loadFactor

double_range

0.0 .. 10.0 1.0 Sets the factor by whover-loading of shiftsallowed

PLAN_ST_LATE_BY_ARR or stopLateByArrival

boolean TRUE, FALSE

TRUE If TRUE, then late coapplied to stops basecomparison with arrivIf FALSE then late coapplied to Stops basethe predicted departu

PLAN_DPT_LATE_BY_ARR or depotLateByArrival

boolean TRUE, FALSE

TRUE Sets the switch to ensScheduler costs latenarrival at depots. If Tthen late cost is applstops based on compwith arrivaltime. If FAthen late cost is applStops based on the predicted departure t

Planner 10.5

System

Manual

C

logon indow.

heduler t the ow for IXED_ULT.

logon thin the all D_ULT.

The FIXED_LOGON field in Shifts can have three values: YES, NO and DEFAULT.

• YES: will force the shift to logon at the start of its time window. Scheduler cannot override this. Same as DEFAULT=TRUE.

• NO: will enable the Scheduler to find the optimal shift logon time within the shift time window. Normally Now. Same as DEFAULT=FALSE.

• DEFAULT: will take the value set within PLAN_FIXED_LOGON.

opyright © 2000, 2010, O

A - 67

PLAN_FIXED_LOGON or FixedLogonDefault

boolean TRUE, FALSE

FALSE Sets the default for determining the Shifttime within its time w

TRUE: Forces the Scto fix the shift logon astart of the time windall those shifts with FLOGON field = DEFA

FALSE: Optimal shifttime is determined wishift time window for those shifts with FIXELOGON field = DEFA

Planner 10.5

System

Manual

C

ts.

The PLAN_REL_OVERCAP parameter enables the "Depot Time Window Capacity Cost" to cost over capacity relative to the maximum capacity rather than absolute values. When using the original (default) method of costing over capacity a Depot Time Window with a maximum capacity of 10 and a supplied capacity of 11 would have the same cost as a Depot Time Window with a maximum capacity of 1000 and a supplied capacity of 1001. When using the relative over capacity setting the second Depot Time Window would have a cost 100 times less than the first. Or alternatively the second Depot Time Window would need to be supplied with 1100 units before having the same cost as the first Depot Time Window being supplied only 11 units. This functionality is most useful where there is a large variation in maximum capacity for various Depot Time Windows.

opyright © 2000, 2010, O

A - 68

PLAN_REL_OVERCAP or relOverCap

boolean TRUE, FALSE

FALSE To cost depot-windowcapacity on relative overcapacity of depo

Planner 10.5

System

Manual

C

data is he city TW e plied

• :If Legacy is selected then Planner selects the earliest DepotTW that overlaps the Shift in Appointment booking; Or the Arrival Depot Time Window in Scheduling

• If EarliestOverlappingShift is selected then Planner selects the earliest Depot Time Window that overlaps the Shift

• If EarliestOfDay is selected then Planner selects the earliest Depot Time Window that starts within the Day

l Jobs

s with of

be left hen a nment

and will a high

for r to the dow (in , for rt of a

opyright © 2000, 2010, O

A - 69

PLAN_DEPOTCAPTWRULE or DepotCapacityTWRule

string Legacy, EarliestOverlappingShift, EarliestOfDay

Legacy Enables selection of Capacity Depot TimeWindow for a shift

Note: If the availablenot compatible with tselected Depot Capaselection rule, then thLegacy rule will be apby default.

PLAN_OPT_ASSIGN_MODE or optAssignMode

string OFF,ON ON Sets the mode of jobassignment.

OFF indicates that almust be scheduled.

ON indicates that joban allocation priority anything but 0 (MANDATORY) can out of the schedule wnecessary to producebetter schedule.Assigof any job is optional not occur if it attractscost

PLAN_ARRIVAL_MARGIN or arrivalMargin

int_range 0 .. 1440 0 Sets the desired timearriving at a Stop priostart of the Time WinMinutes)., in minutesarrival before the statime window.

Planner 10.5

System

Manual

C

in time s to

cution, t. -1 le s.


ts the maximum radius for a stop-class, in onds, for stop grouping by the Scheduler. Scheduler will try and group similar stops

ether. If the stops have overlapping time dows and lie within the specified travel ius then the Scheduler will group them for cation to the same resource. Also see

AN_INIT_CLASS_TIME on page A - 78.

opyright © 2000, 2010, O

A - 70

1.1.2.15.1 TSP configuration

PLAN_TWS_SEGMENTATION or timeWindowsSegmentation

int_range -1 .. 1440 -1 Defines a boundary [seconds] to segmentbetween time windowcalculate time of exelate/idle time and cossplits time in the middbetween time window

TSP configuration


PLAN_TSP_CLASS_TIME or tspClassTime

int_range 0 .. 10000 NONE Determines how far apart stops can be before they are treated as one.

SesecThetogwinradalloPL

Planner 10.5

System

Manual

C 1.1.2.15.2 Shuffler Controls configuration

Freq" work within a similar time frame. es are used. This means that any one uler moves towards a final solution, the wards "_lastRelFreq". A shuffler with a

e frequency of 0.1.


hat The search area limits the maximum number of compatible stops that can be moved by a cluster at one time.

The PLAN_SEARCH_AREA default is set to 50 internally. This value should not be changed without consulting Oracle.

ps


This shuffler works in a similar manner to the PLAN_FILLSHIFT shuffler. Default is set to 0.1 internally, which should not be changed without consulting Oracle.

See also PLAN_FILLSHIFT

on page A - 73.

opyright © 2000, 2010, O


A - 71

Note: All parameters in the following sections that end with "_initRelFreq" and "_lastRelWhen the scheduler is in the earlier stages of optimisation the "_initRelFreq" valushuffler is used in relation to all the other shufflers at this frequency. As the schedfrequency at which an individual shuffler is used in relation to the others moves torelative frequency of 0.5 will be used five times more than a shuffler with a relativ

1.1.2.15.2.1 Shift Swap Shuffler configuration

Shuffler Controls configuration


PLAN_SEARCH_AREA or stopsInSearchArea

int_range 1 .. 10000 NONE Sets the number of stops twill determine the search area.

PLAN_REL_CLER_SIZE or relClusterSize

int_range 0 .. 20 1 Multiplier for number of stoin cluster

Shift Swap Shuffler configuration


PLAN_SHIFT or shiftMove_initRelFreq

double_range

0.0 .. 1.0 NONE Initial relative frequency for shiftMove shuffler

PLAN_SHIFT_LAST or shiftMove_lastRelFreq

Final relative frequency for shiftMove shuffler

Planner 10.5

System

Manual

C 1.1.2.15.2.2 Segment Move Shuffler configuration


y fler

This is a very important shuffler and should run with the highest frequency possible. It identifies clusters of stops on a shift and tries to move them all onto another shift.

Default is set to 1.0 internally, which should not be changed without consulting Oracle.

y fler


runMove shuffler Default is set to 0.1 internally, which should not be changed without consulting Oracle.unMove shuffler

opyright © 2000, 2010, O


A - 72

1.1.2.15.2.3 Run Swap Shuffler configuration

Segment Move Shuffler configuration


PLAN_SEGMENT or segmentMove_initRelFreq

double_range

0.0 .. 1.0 NONE Initial relative frequencfor segmentMove shuf

PLAN_SEGMENT_LAST or segmentMove_lastRelFreq

Final relative frequencfor segmentMove shuf

Run Swap Shuffler configuration


PLAN_RUN or runMove_initRelFreq

double_range

0.0 .. 1.0 NONE Initial relative frequency for

PLAN_RUN_LAST or runMove_lastRelFreq

Final relative frequency for r

Planner 10.5

System

Manual

C 1.1.2.15.2.4 Insert Move Shuffler configuration


for Default is set to 0.0 internally which should not be changed without consulting Oracle. for


or fillShift Moves all stop on a shift that are not fixed and try’s them on another shift. Default is set to 0.5 internally, which should not be changed without consulting Oracle.

or fillShift

opyright © 2000, 2010, O


A - 73

1.1.2.15.2.5 Filling Shifts Shuffler configuration

Insert Move Shuffler configuration


PLAN_INSERTMOVE or insertMove_initRelFreq

double_range

0.0 .. 1.0 NONE Initial relative frequencyinsertMove.

PLAN_INSERTMOVE_LAST or insertMove_lastRelFreq

Final relative frequencyinsertMove.

Filling Shifts Shuffler configuration


PLAN_FILLSHIFT or fillShift_initRelFreq

double_range

0.0 .. 1.0 NONE Initial relative frequency f

PLAN_FILLSHIFT_LAST or fillShift_lastRelFreq

Final relative frequency f

Planner 10.5

System

Manual

C 1.1.2.15.2.6 Fill Idle Shift Shuffler configuration


le shuffler Default is set to 0.0 internally, which should not be changed without consulting Oracle.

le shuffler


r This shuffler attempts to fill idle time after a completed stop. Default is set to 0.0 internally, which should not be changed without consulting Oracle.r


Moves all stops associated with a depot on a shift and try’s them on another shift. Default is set to 0.1 internally which should not be changed without consulting Oracle.

opyright © 2000, 2010, O


A - 74

1.1.2.15.2.7 Fill Gaps Shuffler configuration

1.1.2.15.2.8 Depot Move Shuffler configuration

Fill Idle Shift Shuffler configuration


PLAN_FILL_IDLE or fillIdle_initRelFreq

double_range

0.0 .. 1.0 NONE Initial relative frequency for fillId

PLAN_FILL_IDLE_LAST or fillIdle_lastRelFreq

Final relative frequency for fillId

Fill Gaps Shuffler configuration


PLAN_FILLGAP or fillTheGap_initRelFreq

double_range

0.0 .. 1.0 NONE Initial relative frequency fofillTheGap shuffler

PLAN_FILLGAP_LAST or fillTheGap_lastRelFreq

Final relative frequency fofillTheGap shuffler

Depot Move Shuffler configuration


PLAN_DEPOTMOVE or depotMove_initRelFreq

double_range

0.0 .. 1.0 NONE Initial relative frequency for depotMove.

PLAN_DEPOTMOVE_LAST or depotMove_lastRelFreq

Final relative frequency for depotMove.

Planner 10.5

System

Manual

C 1.1.2.15.2.9 Deallocation Shuffler configuration


or Looks to see which Allocation Priority jobs it would be cheaper not to schedule. Default is set to 0.1 internally, which should not be changed without consulting Oracle.

or


This is a very important shuffler and should run with the highest frequency possible. It picks a stop, draws a circle around the stop and then tries to move all stops within this circle to the same shift.

Default is set to 1.0 internally, which should not be changed without consulting Oracle.

r

Used to find suitable cluster of stops. If (Number of stops found) > ((Number of sites in find) * (PLAN_SITE_RESTRICT)) then the cluster is discarded, otherwise the cluster is used by the cluster shuffler that had initiated the find.

opyright © 2000, 2010, O


A - 75

1.1.2.15.2.10 Cluster Group Shuffler configuration

Deallocation Shuffler configuration


PLAN_DEALLOC or deAllocMove_initRelFreq

double_range

0.0 .. 1.0 NONE Initial relative frequency fdeAllocMove

PLAN_DEALLOC_LAST or deAllocMove_lastRelFreq

Final relative frequency fdeAllocMove

Cluster Group Shuffler configuration


PLAN_CLUSTER or clusterMove_initRelFreq

double_range

0.0 .. 1.0 NONE Initial relative frequency for clusterMove shuffler

PLAN_CLUSTER_LAST or clusterMove_lastRelFreq

Final relative frequency foclusterMove shuffler

PLAN_SITE_RESTRICT or sameSiteRestrict

double_range

1.0 .. 20.0 5.0 Multiplier to control allowed ratio between number of sites and number of stops in a cluster

Planner 10.5

System

Manual

C 1.1.2.15.2.11 Allocation Shuffler configuration


r Looks to see which Free Allocation Priority jobs it would be cheaper to schedule. Default is set to 0.1 internally, which should not be changed without consulting Oracle.

r


iods of e treated with

NT to treat pUP to ignore g purpose

When POUs are used to direct Drivers to Stock Pick-Up Points, they travel to the same location everyday. In these circumstances the POU should be ignored when determining clusters or rounds of Stop.

opyright © 2000, 2010, O


A - 76

1.1.2.15.3 POU Controls configuration

Allocation Shuffler configuration


PLAN_ALLOC or allocMove_initRelFreq

double_range

0.0 .. 1.0 NONE Initial relative frequency foallocMove shuffler

PLAN_ALLOC_LAST or allocMove_lastRelFreq

Final relative frequency foallocMove shuffler

POU Controls configuration


PLAN_TREAT_POU_AS or treatPouAs

string APPOINTMENT,

STOCKPICKUP

APPOINTMENT

Used to control how PerUnavailability (POUs) arregard to Round Costs.

• Set to APPOINTMEPOU as normal Sto

• Set to STOCKPICKPOU for most costin

Planner 10.5

System

Manual

C In the following illustration, the POU is included within the round Area when PLAN_TREAT_POU_AS=APPOINTMENT and is

round_no_pou.png

STOCKPICKUP not in round

opyright © 2000, 2010, O


A - 77

excluded from the Round Area when PLAN_TREAT_POU_AS=STOCKPICKUP.

round_inc_pou.png

POU as APPOINTMENT in Round POU as

Planner 10.5

System

Manual

C 1.1.2.15.4 Plan Init Controls configuration


in During the PLAN INIT phase of optimization, the Scheduler will try and group similar stops together. If the stops have overlapping time windows and lie within the specified travel radius then the Scheduler will group them for allocation to the same resource.

Also see, “ PLAN_TSP_CLASS_TIME or tspClassTime” on page A - 70.

n

te.

n

t

et

opyright © 2000, 2010, O


A - 78

Plan Init Controls configuration


PLAN_INIT_CLASS_TIME or initClassTime

int_range 0 .. 10000 NONE Sets the travel radius, in seconds, for stop groupingPLAN INIT.

PLAN_PI_MAX_LATE or piMaxLate

int_range -1000000.0 .. 1000000.0

NONE When building ROUTES iPLAN INIT, allow a maximum of X minutes la

PLAN_PI_SHORT_FIRST or piShortRoutesFirst

boolean TRUE, FALSE

FALSE When building ROUTES iPLAN INIT, construct the short ones first.

PLAN_INIT_MAX_TRAMP or initMaxTramp

int_range 0 .. 10000 NONE Sets the flexibility to selecanother vehicle when theclosest is not available during the PlanInit state. Sin seconds.

Planner 10.5

System

Manual

C 1.1.2.15.5 Performance Controls configuration


.

% chance of using multiple shufflers in a single plan cycle. Defaults to 0.2 internally, which should not be changed without consulting Oracle.

Used to allow the Scheduler to use a broader strategy when searching for cost improvements. If a particular solution appears stagnant, then some additional Scheduler sub-cycles may free the restriction.

e ill he ing

• FOREVER -Schedules into infinity, so progress is always 0

• VARIABLE - Find the remaining amount of time. It is linearly related to the log of the relative temperature

• FIXED_RT - Scheduling will terminate at the specified real-time.

• FIXED_CPU - Scheduling will terminate at the specified CPU-time.

See also PLAN_SCHED_MODE on page A - 80.2e

This is the amount by which the total cost of the schedule can increase while a cascade of shufflers attempt to find a better solution.

opyright © 2000, 2010, O


A - 79

Performance Controls configuration (Sheet 1 of 2)


PLAN_PC_CASCADE or pcCascadeChance

double_range

0.0 .. 1.0 NONE Sets the average number of additional Scheduler sub-cycles

PLAN_COST_LIMIT or costLimit

double _range

0.0 .. 1000000000.0

0.0 The Scheduler will besuspended when thesolution cost goes below the PLAN_COST_LIMIT.

PLAN_SCHED_MODE or schedMode

string One of:

• FOREVER• VARIABLE• FIXED_RT• FIXED_CPU

VARIABLE Sets the length of timthat the Scheduler wcontinue to improve tsolution before reachTERM.

PLAN_SCHED_MIN_TEMP or schedMinTemp

double _range

0.0 .. 1000000.0

4e2 Lowest scheduling temperature

PLAN_SCHED_MAX_TEMP or schedMaxTemp

double _range

0.0 .. 1000000.0

2e5 Highest scheduling temperature

Planner 10.5

System

Manual

C

e/ The resulting value can be seen in the smauto log as "t=nnnn". If this value does not rise on making large cost improvements, then PLAN_SCHED_HEAT_RATE may need to be increased.

PLAN_SCHED_DURATION is a mandatory parameter. It is used in all the PLAN_SCHED_MODES.

When running in the VARIABLE or FOREVER modes, PLAN_SCHED_DURATION is used to control the temperature.

When running in the FIXED_RT or FIXED_CPU modes, PLAN_SCHED_DURATION is used to limit optimization time to the required amount of CPU-time or realtime.

Optimization time is also limited by recalculating the temperature based on time left.

l

When the B value in exponential cost has been used PLAN_MAX_TERM times to double the A value the A value will no longer be doubled.

The default value ’0’ denotes True Exponential Costs.

t do al

Used when PLAN_SCHED_MODE=FIXED_RT or FIXED_CPU. The Optimiser will perform these many Optimisation runs getting itself out of local minima.

Default is set to 1 internally, which should not be changed without consulting Oracle.

Performance Controls configuration (Sheet 2 of 2) (Continued)
opyright © 2000, 2010, O

A - 80

PLAN_SCHED_HEAT_RATE or schedHeatRate

double_range

0.0 .. 1000000.0

0.5 Minimum temperaturunit drop in cost

PLAN_SCHED_DURATION or schedDuration

int_range 0 .. 1000000 seconds

600 Sets the number of seconds that smautoshould continue to optimise.

PLAN_MAX_TERM or maxTerm

int_range 0 .. 170 NULL Exponential costs wilnever rise faster thanx^maxTerm.

PLAN_OPT_RUNS or nOptRuns

int_range 0 .. 100 NONE Sets the number of optimisation runs thathe optimiser should to get itself out of locminima.

Planner 10.5

System

Manual

C 1.1.2.15.6 Bound Jobs configuration


indow

.

A sub time window is created for each stop in the bound job. The width of this window is set using the PLAN_SUB_WIN_WIDTH parameter. This time window is used instead of the stop’s actual time window to calculate the stop lateness.


oth PLAN_ACCESS_FILE and PLAN_CC_GROUP_FILE must be set to enable ser Access Control.

LAN_ACCESS_FILE lists all the users who an access smauto and their level of access.

LAN_ACC_GROUP_FILE lists the perations that are available at each Access evel.

hanges to the User Access Group File are ffective only after smauto is restarted.

opyright © 2000, 2010, O


A - 81

1.1.2.15.7 User Access Control configuration

Bound Jobs configuration


PLAN_SUB_WIN_WIDTH or autoSubWindowWidth

int_range 1 .. 120 10 Sets the width of sub-wthat is created for auto tightening of bound jobs

User Access Control configuration (Sheet 1 of 2)


PLAN_ACCESS_FILE or userAccessControlFile

string All Files (*) NONE Sets the location and name for the User Access Control File. Also see, “2.5.2 User Access File” on page 2 - 11 for more details.

BAU

Pc

PoL

Ce

PLAN_ACC_GROUP_FILE or userAccessGroupFile

string All Files (*) NONE Sets the location and name of the User Access Group File. Also see, “2.5.1 User Access Groups” on page 2 - 9 for more details.

Planner 10.5

System

Manual

C

his is displayed only at the time of logon if ser Access Control is enabled.

lso see, “ PLAN_ACCESS_FILE or serAccessControlFile” on page A - 81.

User Access Control configuration (Sheet 2 of 2) (Continued)
opyright © 2000, 2010, O

A - 82

PLAN_WARN_DAYS_EXP or warnDaysToExpired

int_range

1 .. 100 NULL Sets the number of days at which to warn users that their password will expire.

TU

Au

PLAN_MAX_PASS_ATMPTS or maxAttemptBeforeDisable

int_range

1 .. 100 NULL Sets the number of times that users can attempt to login using an invalid password before their account is disabled.

PLAN_PASSWORD_EXP or passwordValidDays

int_range

1 .. 1000 NULL Sets the number of days that the current password will be valid for before requiring to be changed again.

Planner 10.5

System

Manual

C 1.1.2.15.8 Logging configuration

commendations / Comments

ese parameters should be set to TRUE ting and implementation.

ceive these logs on the standard output set N_NO_LOG_STDOUT or noLogStdOut” ibed on page A - 11 to TRUE.cord these logs into disk files set “PLAN_TO_FILE or logToFile_MSG” described on

A - 83 to TRUE.e path and prefix for logging to disk using

N_LOG_PREFIX or logFilePrefix_MSG” ibed on page A - 83.e level of logging using “PLAN_LOG_L or logLevel” described on page A - 15.e number of log files to be maintained on sing “PLAN_LOG_FILES or numLogFiles_

” described on page A - 84.uration for file save using “PLAN_LOG_RS or logHours_MSG” described on A - 83.

ssential for tracking process related issues must always be logged to File.

be a valid and accessible location on the

re usually sent as email attachments. is value to 1 hour will keep these file size to

.

opyright © 2000, 2010, O


A - 83

smauto Logging configuration (Sheet 1 of 2)

Configuration Parameter Type Range default Description Re

PLAN_RX_HIP_LOGGING or rxHipLogging

boolean TRUE, FALSE

FALSE Set to TRUE to log all the HIP packets received by smauto.

Note: Thduring tes

• To re“PLAdescr

• To reLOG_page

• Set th“PLAdescr

• Set thLEVE

• Set thdisk uMSG

• Set dHOUpage

PLAN_TX_HIP_LOGGING or txHipLogging

boolean TRUE, FALSE

FALSE Set to TRUE to log all the HIP packets sent from smauto.

PLAN_LOG_TO_FILE or logToFile_MSG

boolean TRUE, FALSE

TRUE Used to save logs to disk file.

Logs are eand hence

PLAN_LOG_PREFIX or logFilePrefix_MSG

string $PLAN_LOG/smauto

Used to set the path and prefix for log file(s).

This mustdisk.

PLAN_LOG_HOURS or logHours_MSG

int_range

1 .. 24 1 Sets the time span between each log file.

Log files aSetting tha minimum

Planner 10.5

System

Manual

C

eduler to write data to the internal buffer ead lock and increases efficiency of the

s are deleted (only on UNIX installations). reated prior to a system restart are not

st be installed for this parameter to be n the Windows environment.

ssible, this value should be set large cover the operational window without g the system’s storage capacity.


This value should be set to at least twice the size of the schedule. The schedule size can be determined by saving to a ’.hip’ file.

The optimiser may either slow down or stop when smauto continues to pass more data out through a blocked socket. Hence this value is preferably set in the lower range of 300 to 600.

smauto Logging configuration (Sheet 2 of 2) (Continued)
opyright © 2000, 2010, O

A - 84

1.1.2.15.9 smauto Buffer configurationThe communication protocol allows the use of an internal send buffer. This allows the Schand continue optimising while the data is being transmitted. This reduces the chance of dScheduler.

PLAN_LOG_FILES or numLogFiles_MSG

int_range

1 .. 1000

168 Sets the number of latest smauto log files to be maintained on the disk.

Old log fileLog files cdeleted.

"Msys" mueffective o

Where poenough toexhaustin

smauto Buffer configuration


PLAN_USER_BUF_SIZE or socketBufferSize

int_range

0 .. 100000 10000 Sets the memory (in kilobyte) that can be allocated for use in bufferingeach socket.

PLAN_USER_BUF_WAIT or maxWaitBlock

int_range

0 .. 86400 0 This is the amount of time inseconds that smauto will keep a socket connection open, if the data it is passing out is not being read.

Planner 10.5

System

Manual

C 1.1.2.15.10 smauto Connection Configuration


When this port number is specified in the Client parameter “PLAN_CENT_AUTO_PORT or portNumber” described on page A - 10, the Client process will be able to connect to the smauto process.


Used to set the optimum rate of communication between processes. Also see, “ PLAN_MAX_PACKETS or maxPackets” on page A - 85.


Used to make sure that a socket poll does not last forever, and that all processes get a fair share of cpu time. The frequency at which smauto will poll the socket is determined by “PLAN_NEW_POLL_INTRVL or newConnectionPollInterval” described on page A - 85.



The frequency at which smauto will poll the socket is determined by “PLAN_NEW_POLL_INTRVL or newConnectionPollInterval” described on page A - 85.

Note: PLAN_SECURE_SOCKET should be enabled for PLAN_SECURE_KEYFILE to be effective

opyright © 2000, 2010, O


A - 85

smauto Connection Configuration (Sheet 1 of 2)


PLAN_CENT_AUTO_PORT or serverPort

int_range

0 .. 10000 9000 Sets the port number on which Clients may connect to smauto.

PLAN_POLLTIME_INTRVL or pollTimeInterval

double_range

0.0001 .. 60.0

0.01 second

Sets the time interval at which smauto polls sockets for incoming data.

PLAN_MAX_PACKETS or maxPackets

int_range

1 .. 100000 NONE Sets the maximum number of packets that will be read in one socket poll by smauto.

PLAN_NEW_POLL_INTRVL or newConnectionPollInterval

double_range

1.0 .. 60.0 5.0 seconds

This is the frequency at which smauto checks for new connections from GUI Servers or plannerClients.

PLAN_MAX_CONNECTIONS or maxConnectionHog

int_range

1 .. 500 10 Setting the maximum number of connections that will be accepted in one socket poll by smauto.

PLAN_SECURE_KEYFILE or secureKeyfile

string *.pem, *.PEM

Application private key and certificate file

Planner 10.5

System

Manual

C

Note: PLAN_SECURE_SOCKET should be enabled for PLAN_TRUSTED_CA parameter to be effective


d a g to the

Used to ensure that the Scheduler periodically saves the improvements to the current solution to the IDB so that it is available to other processes. If set to zero, every solution improvement is saved to the IDB immediately.

smauto Connection Configuration (Sheet 2 of 2) (Continued)


opyright © 2000, 2010, O


A - 86

1.1.2.15.11 smauto Save Configuration

PLAN_TRUSTED_CA or trustedCAlist

string *.pem, *.PEM

Trusted certificate authorities file

PLAN_VERIFY_CLIENT or verifyClient

boolean

TRUE, FALSE

TRUE Enable to enforce certificate-based client authentication

smauto Save Configuration (Sheet 1 of 2)


PLAN_UPLOAD_INT or maxUpLoadInterval

int_range

0 .. 30 seconds

2 Sets the maximum periobetween improvement tosolution and its uploadinIDB.


Planner 10.5

System

Manual

C

tes Set this value to 0 to disable autosave.

Autosave files are prefixed with either ’TERM’, ’RESET’ or ’AUTO’ to identify the event that had triggered the save.

Following a plan RESET operation a file with prefix "RESET" will be saved in both the Autosave directories.

When TERM or INT signal is received, a TERM file is created while all other auto files (RESET* and AUTO*) created during the latest smauto run are removed. Autosave files created by other smauto processes are retained in the directory.

save files

fix for

efix uto save

smauto Save Configuration (Sheet 2 of 2) (Continued)


opyright © 2000, 2010, O


A - 87

PLAN_AUTOSAVE_INT or autosaveInterval

int_range

0 .. 2000 0 autosave interval in minubetween each autosave.

PLAN_AUTOSAVE_FILES or autosaveFiles

int_range

1 .. 1000 1 Sets the number of autoto be retained.

PLAN_AUTOSAVE_DIR or autosaveDirectory

string Autosave Sets the location and preautosave files.

PLAN_DUAL_AUTOSAVE or dualAutosaveDirectory

string NONE Sets the Location and prDirectory in which dual afiles are stored.


Planner 10.5

System

Manual

C 1.1.2.15.12 smauto/Switch Connection Configuration


When FALSE, smauto first obtains connection from Switch (the server process) at SW_SM_PORT on SW_HOST and only then grants connection to all requesting clients at PLAN_CENT_AUTO_PORT on PLAN_CENT_HOST.

When TRUE, smauto immediately grants connection to all requesting clients at PLAN_CENT_AUTO_PORT on PLAN_CENT_HOST.

Also see, “ PLAN_CENT_AUTO_PORT or serverPort” on page A - 85, “ PLAN_CENT_HOST or hostName” on page A - 8, “ SW_SM_PORT or hostPort” on page A - 89 and “ SW_HOST or hostName” on page A - 88.

When PLAN_SERVER_MODE = FALSE, smauto will connect to Switch (the server process) that opens a connection at SW_SM_PORT on SW_HOST.

See also PLAN_SERVER_MODE on page A - 88 and SW_HOST on page A - 88.

opyright © 2000, 2010, O


A - 88

smauto/Switch Connection Configuration (Sheet 1 of 3)


PLAN_SERVER_MODE or serverMode

boolean

TRUE, FALSE

FALSE Sets the mode of operation for smauto to:

• Server and Client when FALSE

Or

• Server only when TRUE

SW_HOST or hostName string NULL Is the comma separated list of computer names on which alternate Switch processes may be running. smauto will search the machines in this list and connect to the first available Switch, at SW_SM_PORT.

Planner 10.5

System

Manual

C

This parameter defines the port number at which Switch opens connection for client processes (smauto) which is the same as the port at which smauto will connect to the server process (Switch) when not in the server mode.

See, “ PLAN_SERVER_MODE or serverMode” on page A - 88

Note: Although used by both smauto and Switch processes, this parameter can be set only for the smauto process, which is then automatically used by the Switch process.

See, “ SW_SM_PORT or smautoPort” on page A - 110.

This value is used by both (smauto and Switch) processes to simultaneously drop the connection that they are holding after the specified seconds of inactivity.

Note: Although used by both smauto and Switch processes, this parameter can be set only for the smauto process, which is then automatically used by the Switch process.

See also SW_SM_TIMEOUT on page A - 110.

Note: PLAN_SECURE_SOCKET should be enabled for SW_SECURE_KEYFILE to be effectiveNote: PLAN_SECURE_SOCKET should be enabled for SW_TRUSTED_CA parameter to be effective

smauto/Switch Connection Configuration (Sheet 2 of 3) (Continued)


opyright © 2000, 2010, O


A - 89

SW_SM_PORT or hostPort

int_range

0 .. 10000 9100 Port number on which smauto connects to the server process (Switch).

SW_SM_TIMEOUT or serverTimeout

int_range

20 .. 10000

900 Interval in seconds of no activity after which smauto will drop a connection to Host (Switch).

SW_SECURE_KEYFILE or secureKeyfile

string *.pem, *.PEM


SW_TRUSTED_CA or trustedCAlist

string *.pem, *.PEM



Planner 10.5

System

Manual

C

parameter settings made for other


ill . (-

Note: This parameter is used only by the smauto Process.r

Note: It derives its value from the corresponding Client parameter “PLAN_CLI_TIMEOUT or connectionTimeout” described on page A - 9.

smauto/Switch Connection Configuration (Sheet 3 of 3) (Continued)


opyright © 2000, 2010, O


A - 90

1.1.2.15.13 Hidden smauto ConfigurationThe parameter in this section cannot be set explicitly as it inherits the value from specificprocesses.

SW_VERIFY_CLIENT or verifyClient

boolean

TRUE, FALSE


Hidden smauto Configuration


PLAN_CLI_TIMEOUT or clientTimeout

Hidden 900 Interval in seconds of no activity after which smauto wdrop a connection to Client1 disable, 0 default, >0)


Planner 10.5

System

Manual

C 1.1.2.15.14 Auto Direct Configuration

ecommendations / Comments

o Direct automatically despatches the jobs rivers. It enables the Scheduler to, select next stop for a driver/MDT and send details ut the next job to the MDT.

en Auto Direct is turned on, the Allocator still perform all other real time manual rations such as stop despatched, stop ved and stop started. The stops are patched to the driver in the order that they assigned by the Scheduler within the shift..

N_AUTODIR_BRKS value is effective only en PLAN_AUTODIR is enabled.

TRUE, enables Auto Directing of Breaks. FALSE, disables Auto Directing of Breaks.

also PLAN_AUTODIR on page A - 91.

N_AUTODIR_COMP value is effective y when PLAN_AUTODIR is enabled.

If TRUE, then directs to next stop when previous is completed.

If FALSE, then directs to next stop when previous is started.


opyright © 2000, 2010, O


A - 91

Auto Direct Configuration (Sheet 1 of 3)

Configuration Parameter Type Range default Description R

PLAN_AUTODIR or enableAutoDirect

boolean TRUE, FALSE

TRUE Enables or disables the AutoDirecting of jobs/stops

Autto dtheabo

Whcanopearridesare

PLAN_AUTODIR_INT or autoDirectInterval

int_range

05 .. 600 60 seconds

Determines how often Auto Direct module checks for stop to direct.

PLAN_AUTODIR_BRKS or autoDirectInterval

boolean TRUE, FALSE

TRUE Enables smauto to auto direct breaks if Auto Direct Jobs is switched on.

PLAwh

••

See

PLAN_AUTODIR_COMP or autoDirectOnComplete

boolean TRUE, FALSE

FALSE Determines the Stop status change event that should trigger Auto Direct.

PLAonl

•

•

See

Planner 10.5

System

Manual

C

N_AUTODIR_CLOSE value is effective y when PLAN_AUTODIR is enabled.

TRUE stops additional work from being added to the run.

FALSE allows additional work to be added to the run.


N_AUTODIR_HRZN value is effective only en PLAN_AUTODIR is enabled.

e stop to be dispatched next will be arrived ore than x minutes before it can be started,

n it is Auto directed only after the interval cified by this parameter.


ecifies the rule for auto despatching ps.

rrently there are two rules:

ONE_AT_A_TIME, which allows despatch of single run only or PTP stops from the same job

COMBINED, which allows despatch of stops combined in a logical run, where a logical run is made up of a set of stops that start at the distribution depot and ends at a stop where the vehicle has no load on board.

tability period is applied for each stop that been nominated for auto despatching. A

p is considered as stable if it has not been nged in the IDB during the specified

bility period.

Auto Direct Configuration (Sheet 2 of 3) (Continued)


opyright © 2000, 2010, O


A - 92

PLAN_AUTODIR_CLOSE or closeDistributionRun

boolean TRUE, FALSE

FALSE Close run when Auto Directing Distribution depot stops.

PLAonl

•

•

See

PLAN_AUTODIR_HRZN or autoDirectTimeHorizon

int_range

0 .. 600 0 Sets the maximum allowed idle time in minutes, before automatically despatching a Job.

PLAwh

If that mthespe

See

PLAN_AD_RULE or AD_Rule string ONE_AT_A_TIME,COMBINED

ONE_AT_A_TIME

Defines how overlapping runs are despatched.

Spsto

Cu

•

•

PLAN_AD_STABILITYPRD or AD_StabilityPeriod

int_range

0 .. 36000 300 seconds

Minimum period of stability in seconds at a depot or at a stop before auto despatching.

A shasstochasta


Planner 10.5

System

Manual

C

re should be taken when using this ument as there is no active mechanism in the Optimiser using which it can attempt

ectify the situation.

100% of vehicle capacity).

N_AD_DETOURDIST is activated only en PLAN_AD_MINLOAD is > 0.0.

Auto Direct Configuration (Sheet 3 of 3) (Continued)


opyright © 2000, 2010, O


A - 93

PLAN_AD_MINLOAD or AD_MinLoad

double_range

0.0 .. 10.0 0.0 Sets the minimum load, as a ratio of a Vehicles capacity, that a Run must consume before the Run can be automatically despatched.

Caargwithto r

(1 =

PLAN_AD_MAXLOAD or AD_MaxLoad

double_range

0.0 .. 10.0 0.0 Sets the maximum load, as a ratio of a Vehicles capacity, that a Run must consume before the Run can be automatically despatched.

PLAN_AD_DETOURDIST or detourDistance

double_range

0.0 .. 1000000.0

0.0 meter Sets the additional travel distance in meters before commencing to auto despatch a run.

PLAwh


Planner 10.5

System

Manual

C


ps (.mel). This parameter is not required when unencrypted (.mal) maps are in use.

where ck files.

Process lock files are used to detect multiple instances of the same process running concurrently on the same computer.Set PLAN_NOLOCK=TRUE to allow multiple instances of smauto on the same machine.

multiple he same

planner lock-files.

ation.

ur

re.

ssociated al

ssociated al iving an

Note: Installations already using Conditional Assignment, and sending explicit deletes, will either need to disable this functionality or cease sending deletes.

opyright © 2000, 2010, O


A - 94

smauto Keywords


PLAN_MAP_KEY or mapKey

string NULL Used with encrypted ma

PLAN_LOCK_DIR or lockDir

string [.] Used to set the location smauto should create lo

PLAN_NOLOCK or noLock

boolean TRUE, FALSE

TRUE Used to allow or restrict instances of smauto on tcomputer.

When "noLock=TRUE", will not write or read any

PLAN_JOB_DIST_FACT double_range

0.0 .. 1000000.0

0.0 Used for jobValue calcul

PLAN_MIN_JOB_DIST 1.0

PLAN_DEL_REJ_JOB or deleteRejectedJob

boolean TRUE, FLASE

TRUE Controls smauto behaviofollowing a Conditional Assignment request failu

TRUE deletes the Job awith the failed ConditionAssignment.

FLASE deletes the Job awith the failed ConditionAssignment only on receexplicit delete request.

Planner 10.5

System

Manual

C


fies the process used by Planner to access s generated by Oracle’s BAM (Business y Monitor) system.

lanner Client initiates access to BAM via a in the toolbar.

or BAM is configured via the preferences uration.

opyright © 2000, 2010, O


A - 95

A.1.3 NMC GUI Keywords

A.1.3.1 plannerClient New configuration

plannerClient New configuration


NMC_BAM_HOST_PROCESS or bamHostProcess

string Default Windows browser [Start]

This parameter is used to configure the method for starting BAM. For example: running a Web Browser. This defaults to "start" which will use the default browser on Windows and hence need not be modified.

On linux it must be configured to the full path for the browser that is to be used. For example: /usr/bin/firefox

SpecireportActivit

The Pbutton

URL fconfig

Planner 10.5

System

Manual

C A.1.3.2 plannerClient Logging configuration


These parameters should be set to TRUE testing and implementation.

o receive these logs on the standard output et “PLAN_NO_LOG_STDOUT or oLogStdOut” described on page A - 11 to RUE.he level of logging is set using “PLAN_OG_LEVEL or logLevel” described on age A - 15.

Unlike for the other Planner processes is no provision to save plannerClient logs to

are essential for tracking process related and hence must always be logged to File.

ust be a valid and accessible location on sk.

les are usually sent as email attachments. g this value to 1 hour will keep these file a minimum.

g files are deleted (only on UNIX ations). Log files created prior to a system t are not deleted.

" must be installed for this parameter to be ive on the Windows environment.

possible, this value should be set large h to cover the operational window without sting the system’s storage capacity.

opyright © 2000, 2010, O


A - 96

plannerClient Logging configuration


NMC_LOG_RECV or rxHipLogging

boolean

TRUE, FALSE

FALSE Set to TRUE to log all the HIP packets received by plannerClient.

Note:during

• TsnT

• TLp

Note:there disk.

NMC_LOG_TRANS or txHipLogging

boolean

TRUE, FALSE

FALSE Set to TRUE to log all the HIP packets sent by plannerClient.

NMC_LOG_TO_FILE or logToFile_MSG

boolean

TRUE, FALSE


Logs issues

NMC_LOG_PREFIX or logFilePrefix_MSG

string $PLAN_LOG/plannerClient


This mthe di

NMC_LOG_HOURS or logHours_MSG

int_range


Log fiSettinsize to

NMC_LOG_FILES or numLogFiles_MSG

int_range

1 .. 1000 168 Sets the number of latest plannerClient log files to be maintained on the disk.

Old loinstallrestar

"Msyseffect

Whereenougexhau

Planner 10.5

System

Manual

C A.1.3.3 plannerClient Connection configuration


d to set the optimum rate of munication between processes. Also

, “ NMC_MAX_PACKETS or maxPackets” age A - 97

d to make sure that a socket poll does not forever, and that all processes get a fair re of cpu time. Also see, “ NMC_POLL_INT ollTimeInterval” on page A - 97.

e: PLAN_SECURE_SOCKET should be bled for NMC_SECURE_KEYFILE to be ctive

e: PLAN_SECURE_SOCKET should be bled for NMC_TRUSTED_CA parameter to ffective

opyright © 2000, 2010, O


A - 97

plannerClient Connection configuration


NMC_POLL_INT or pollTimeInterval

double_range

0.001 .. 5.0 0.001 Sets the time interval at which plannerClient polls the sockets for incoming data.

Usecomseeon p

NMC_MAX_PACKETS or maxPackets

int_range

1 .. 10000 10000 Sets the maximum number of packets to be read by plannerClient in a single socket poll.

Uselastshaor p

NMC_REQ_INTERVAL or requestInterval

int_range

1 .. 10000 5 Sets the interval, in seconds, at which plannerclient will send update requests to smauto.

NMC_SECURE_KEYFILE or secureKeyfile

string *.pem, *.PEM


Notenaeffe

NMC_TRUSTED_CA or trustedCAlist

string *.pem, *.PEM


Notenabe e

Planner 10.5

System

Manual

C A.1.3.4 plannerClient Setup configuration


Screen layout can be loaded from a previously saved layout, and changes can be saved to file for future use. If set FALSE, the layout specified by NMC_LAYOUT_FILE will be loaded at run-time, and it cannot be changed.

e This file is used to configure the nmcGUI’s main window layout. If not specified, the main window will be empty. Pop-up windows can still be created.

e le.

e

e le.

e

opyright © 2000, 2010, O


A - 98

plannerClient Setup configuration (Sheet 1 of 2)


NMC_LAYOUT or enableLayoutControl

boolean

TRUE, FALSE

TRUE Enables screen layout changes.

NMC_LAYOUT_FILE or layoutFile

string ayout files (*.lyt)

$PLAN_RSC/default.lyt

Sets the path and filenamof the file containing the default screen layout.

NMC_APP_TRANS or appTranslationFile

string Translation Files (*.tr)

$PLAN_RSC/us.tr

Sets the path and filenamof a language translator fiUsed to translate the internal mnemonics into meaningful text in the language of choice.

NMC_COST_CONTROL or costControlFileName

string All Files (*) $PLAN_ETC/costControl

Sets the path and filenamof a cost control file.

NMC_SPEED_TIME_WIN or speedTimeWindowFile

string All Files (*) $PLAN_ETC/speedTimeWindows

Sets the path and filenamof speed time windows fi

NMC_PREFERENCES or preferenceFile

string All Files (*) $PLAN_ETC/preferences

Sets the path and filenamof a preference file

Planner 10.5

System

Manual

C

e ile

lly


stance either eters.

n miles

in Kilometers

This parameter is also used by ManifestServer

plannerClient at assist with

abase drivers.

f the controls the nnerClient.

The default style is Windows on Linux installation and WindowsXP on Windows installation.

plannerClient Setup configuration (Sheet 2 of 2) (Continued)


opyright © 2000, 2010, O


A - 99

A.1.3.5 plannerClient Display configuration

NMC_MAX_CAP_FILE or maxCapFile

string All Files (*) $PLAN_ETC/maxCapValues

Sets the path and filenamof a capacity graph file. Fcontains the data values from capacity graph settings

NMC_DATA_DIR or initialDataDir

string $PLAN_DATA

Directory in which to initialook when loading/savingHIP files.

plannerClient Display configuration (Sheet 1 of 5)


NMC_DISPLAY_MILES or distInMiles

boolean TRUE, FALSE

FALSE Used to display diin miles or in kilom

TRUE = distance i

FALSE = distance

pluginDir String LIB Directory in whichlooks for Plugins thQT Styles and dat

NMC_APP_STYLE or appStyle string_range

WindowsXP,Windows

Windows Defines the style oapplication which look and feel of pla


Planner 10.5

System

Manual

C

number of at can be .

number of es displayed

th, in bits, of the map.

t margin, in ls displayed

ground color. May be in one of these formats:

• RGB (each of R, G and B is a single hex digit)

• RRGGBB• RRRGGGBBB• RRRRGGGGBBBB• A name from the X11

color database (rgb.txt) For example: ’steelblue’ or ’gainsboro’.

th and r map file or

master file aster map

plannerClient Display configuration (Sheet 2 of 5) (Continued)


opyright © 2000, 2010, O


A - 100

PLAN_MAX_MAP_OBJ or maxMapObjects

int_range

0 .. 16384 16384 Sets the maximumPlanner objects thdisplayed on map

NMC_MAX_MAP_OBJ_TYPE or maxMapObjectTypes

int_range

0 .. 10000 4 Sets the maximumPlanner object typon the map.

NMC_MAP_CLR_DEPTH or mapColorDepth

int_range

1 .. 32 8 Sets the color depicons displayed on

NMC_MAP_LABEL_PAD or mapLabelPadding

int_range

0 .. 100 3 Sets the label texpixels, around labeon the map.

NMC_MAP_BG_CLR or mapBackgroundColor

string AntiqueWhite Sets the Map back

NMC_RASTER_MAP or rmap string NULL Used to set the pafilename of a rastethe full path to thecontaining all the rdata


Planner 10.5

System

Manual

C

y vector map, tion when ata do not

direction by coordinates map

t in x direction These parameters are used to adjust the calibration of raster images. They are in meters and will adjust ALL image calibrations.

t in y direction

data set that n to

North AmericaEurope

Map Point allows fast access to street level maps, and address look-up. MapPoint maps can be displayed on the plannerClient.

nd longitude e map.

Used to reduce the map details that are read in and displayed on the plannerClient.the map to be

centre of the CENTRE).



opyright © 2000, 2010, O


A - 101

NMC_MAP_DATUM or mapDatum

string NONE Datum type used brequired for calibraraster and vector dmatch

NMC_MAP_OFFSET or mapOffset

string [+-]x.x,[+-]y.y

0.0,0.0 Offsets in x and y which vector map differs from raster

NMC_RMAP_XOFFSET or xOffset

double_range

0.0 .. 10000000.0

NONE Raster maps offsein meters.

NMC_RMAP_YOFFSET or yOffset

Raster maps offsein meters.

NMC_MAPPOINT_REGION or mapPointRegion

int_range

1,2 1 Used to specify therepresents a regioMapPoint.

• 1 represents • 2 represents

NMC_MAP_CENTRE or mapCenter

string Sets the latitude afor the center of th

NMC_MAP_RADIUS or mapRadius

double_range

0.00 .. 1000.00

0.00 Sets the radius of displayed from themap (NMC_MAP_


Planner 10.5

System

Manual

C

OracleAS Using "OracleAS MapViewer", you can request XML API to get images for display in PlannerClient. For example: mapViewerURL=http://sdolnx2.us.oracle.com:7777/mapviewer/omserver mapViewerDatasource=elocation mapViewerBasemap=world_map loadMapViewerImageDirect=TRUE

MapViewer sed

MapViewer ed

ted PNG

filename for p icon on map

filename for pot icon on

filename for a on map

filename for a p icon on map

for the Title Client main



opyright © 2000, 2010, O


A - 102

NMC_MV_URL or mapViewerURL

string Specify location ofMapViewer server

NMC_MV_DATASOURCE or mapViewerDatasource

string Specify OracleAS datasource to be u

NMC_MV_BASEMAP or mapViewerBasemap

string Specify OracleAS basemap to be us

NMC_MV_LOAD_DIRECT or loadMapViewerImageDirect

boolean TRUE, FALSE

TRUE Return the generaimage directly

NMC_STOP_ICON or stopIconName

string pixmap files (*.xpm)

NULL Sets the path and an un-selected stodisplay.

NMC_DEPOT_ICON or depotIconName

string pixmap files (*.xpm)

NULL Sets the path and an un-selected demap display.

NMC_SEL_STOP_ICON or selectedStopIconName

string NULL Sets the path and selected stop icondisplay.

NMC_SEL_DEPOT_ICON or selectedDepotIconName

string NULL Sets the path and selected depot stodisplay.

NMC_APP_TITLE or appTitle string Oracle Real-time Scheduler

Sets the text labelBar of the plannerwindow.


Planner 10.5

System

Manual

C

idth, in pixels, lls in table ata (or other rawn in this

It provides a blank area at the boundary of a data cell. Also see NMC_HIGHLIGHT_MARGIN and NMC_TEXT_MARGIN.

margin width, e NMC_

This margin is used exclusively for the display of a rectangle that will be drawn when the cell is selected or highlighted.

in width, in MC_GIN.

This margin is used to provide a blank area between the data text and the highlight margin. The data text characters of the cell will be drawn inside this margin.

ntifier string. This string is added to log messages to identify the process.

nt family for lay.

nt size for lay.

g to specify data from

Details such as Shift and Job dates can be specified using this dialog.

filename for definition file.



opyright © 2000, 2010, O


A - 103

NMC_CELLMARGIN or cellMargin

int_range

0 .. 10 1 Sets the margin waround the data cedisplays. No cell dmargins) can be dregion.

NMC_HIGHLIGHT_MARGIN or highlightMargin

int_range

0 .. 10 2 Sets the highlight in pixels, inside thCELLMARGIN.

NMC_TEXT_MARGIN or textMargin

int_range

0 .. 10 2 Sets the text margpixels, inside the NHIGHLIGHT_MAR

NMC_ID or clientId string NMC Sets a process ide

appFontFamily string Tahoma Sets the default foplannerClient disp

appFontsize int_range

1 .. 72 8 Sets the default foplannerClient disp

NMC_FLAGSHIP_GWY or loadFromFlagship

boolean TRUE, FALSE

FALSE Show special dialodetails for loading Gateway.

NMC_MAP_PROJECTION or projection

string $PLAN_RSC/map_projections.cfg

Sets the path and the map projection


Planner 10.5

System

Manual

C A.1.3.6 plannerClient Turn-by-Turn Configuration


r creating l direction

ed angle ving inate the n point for lity.

Warning: <PLAN_TBT_STRAIGHT+PLAN_TBT_BEAR+PLAN_TBT_TURN+PLAN_TBT_SHARP> must be less than 180.

oint within HT+PLAN_ to generate t or bear

oint within HT+PLAN_URN> ecision ht direction

point within HT+PLAN_TURN+tor. Used to r sharp left nge.

eters below ill be

opyright © 2000, 2010, O


A - 104

plannerClient Turn-by-Turn Configuration


PLAN_TBT_STRAIGHT or straight

double_range

0.00 .. 180.00

22.5 degree

Sets the basic segment fodecision points. If the travechanges within the specifithen it is considered as mostraight ahead and will elimneed to generate a decisiothe Turn-by-Turn functiona

PLAN_TBT_BEAR or bear double_range

45 degree Sets the <bear> decision pthe <PLAN_TBT_STRAIGTBT_BEAR> sector. Useddecision points for bear lefright direction change.

PLAN_TBT_TURN or turn double_range

45 degree Sets the <turn> decision pthe <PLAN_TBT_STRAIGTBT_BEAR+PLAN_TBT_Tsector. Used to generate dpoints for turn left or turn rigchange.

PLAN_TBT_SHARP or sharp double_range

45 degree Sets the <sharp> decisionthe <PLAN_TBT_STRAIGTBT_BEAR+ PLAN_TBT_PLAN_TBT_SHARP> secgenerate decision points foor sharp right direction cha

PLAN_TBT_SHORT_LINK or shortLink

double_range

45 degree Sets the link distance in mwhich no decision points wgenerated.

Planner 10.5

System

Manual

C


witch request scheduler

witch sends t Generators

sed for all witch. Switch he SW_eter to handle sions

any seconds ve DBLoad or

ed to start the

any seconds econdary

This functionality can be disabled by setting the slaveRegenerationTime to 0.

opyright © 2000, 2010, O


A - 105

A.1.4 Switch (plannerSwitch) Configuration Parameters

A.1.4.1 General Switch configuration

General Switch configuration


SW_MAST_SYNC_INT or schedulerSyncInterval

int_range 1 .. 10000 5 seconds Sets interval after which Supdates in the plan from

SW_SLAVE_SYNC_INT or slotGenSyncInterval

int_range 10 .. 10000 60 seconds Sets interval after which Supdates in the plan to Slo

SW_INTERFACE_VER or interfaceVersion

string 7_0, 8_1, 9_0, 10_0, 10_3

10_3 Version of HIP interface ucommunication with the scan be configured using tINTERFACE_VER parammultiple HIP interface ver

SW_DB_TIMEOUT or dbTimeout

int_range 60 .. 3600 900 seconds

Switch will wait for these mbefore dropping an inactiDBSync connection

SW_RESTART_CMD or secondarySwitchCommand

string rsh,tcsh rsh This command will be usSecondary Switch.

or slaveRegenerationTime int_range 60 .. 86400 3600 seconds

Switch will wait for these mbefore trying to restart a SSwitch

Planner 10.5

System

Manual

C A.1.4.2 Switch to Switch configuration


er on which un

Switch

hich if to respond to nnection is

fter which the be promoted


nly after the DBLoad process connects and uccessfully transfers the initial data to the witch process, can the AppSvr, DBSync or BPlanner process obtain connection to witch.


opyright © 2000, 2010, O


A - 106

A.1.4.3 Switch connections configuration

Switch to Switch Configuration


SW_SEC_SW_HOST or switchHost

string localhost Hostname of computalternate Switch will r

SW_SEC_SW_PORT or switchPort

int_range 0 .. 10000

9300 IPC port of alternate

SW_SEC_TIMEOUT or switchTimeout

int_range 60 .. 10000

900 seconds Sets the time within wsecondary switch failsprimary switch the codropped.

SW_PROMOTION_TIME or slavePromotionTime

int_range 0 .. 10000

60 seconds Sets the time period asecondary switch willto primary switch

Switch connections Configuration (Sheet 1 of 2)


SW_APP_SRV_PORT or appSvrPort

int_range 0 .. 10000 9200 IPC port on which AppSvr processes connect to Switch.

OsSDS

SW_DB_PORT or dbPort

int_range 0 .. 10000 9400 IPC port on which Data Base processes connect to Switch.

OsSDS

Planner 10.5

System

Manual

C


sed to make sure that a socket poll does ot last forever, and that all processes get a

air share of cpu time. Also see, “ SW_MAX_ACKETS or maxPackets” on page A - 107.

sed by Oracle only. Do not change.

sed to make sure that a socket poll does ot last forever, and that all processes get a

air share of cpu time. Also see, “ SW_OLL_INT or pollTimeInterval” on age A - 107.



he frequency at which Switch will poll the ocket is determined by “SW_CONN_OLL_INT or newConnectionPollInterval” escribed on page A - 107.

Switch connections Configuration (Sheet 2 of 2) (Continued)


opyright © 2000, 2010, O


A - 107

SW_DB_LOAD_PORT or dbLoadPort

int_range 0 .. 10000 9500 IPC port on which DBLoad processes connect to Switch.

OsSDS

SW_POLL_INT or pollTimeInterval

double_range

0.01 .. 60.0 0.01seconds

Sets the time interval at which Switch polls its socket for incoming data.

UnfP

SW_MAX_PACKETS or maxPackets

int_range 1 .. 10000 1000 Sets the maximum number of packets that will be read in one socket poll by switch.

U

UnfPp

SW_CONN_POLL_INT or newConnectionPollInterval

double_range

0.001 .. 60.0 0.01 seconds

This is the frequency at which Switch checks for new connections. These are remote connections from smauto, Web Service and Gateway.

U

SW_CONN_HOG_COUNT or maxConnectionHog

int_range 1 .. 500 10 Sets the maximum number of connections that Switch will accept in one socket poll.

U

TsPd

SW_CONN_BACKLOG or maxSocketConnectBacklog

int_range 1 .. 200 100 Sets the size of the pending socket backlog before the operating system rejects the connection


Planner 10.5

System

Manual

C A.1.4.4 Switch Buffer configuration


byte) that can lication level socket.

This value should be set to at least twice the size of the schedule. The schedule size can be determined by saving to a ’.hip’ file.

e in seconds ocket data it is read.


e essential for tracking process related nd hence must always be logged to File.

st be a valid and accessible location on the

are usually sent as email attachments. this value to 1 hour will keep these file size imum.

opyright © 2000, 2010, O


A - 108

A.1.4.5 Switch Logging configuration

Switch Buffer Configuration


SW_SOCK_BUF_SIZE or socketBufferSize

int_range 0 .. 100000 10000 Sets the memory (in kilobe allocated, at the appfor use in buffering each

SW_MAX_WAIT_BLOCK or maxWaitBlock

int_range 0 .. 86400 0 seconds This is the amount of timthat Switch will keep a sconnection open, if the passing out is not being

Switch logging Configuration (Sheet 1 of 2)


SW_LOG_TO_FILE or logToFile_MSG

boolean TRUE, FALSE


Logs arissues a

SW_LOG_PREFIX or logFilePrefix_MSG

string $PLAN_LOG/switch


This mudisk.

SW_LOG_HOURS or logHours_MSG

int_range 1 .. 24 1 hour Sets the time span between each log file.

Log filesSetting to a min

Planner 10.5

System

Manual

C

files are deleted (only on UNIX ions). Log files created prior to a system re not deleted.

must be installed for this parameter to be on the Windows environment.

ossible, this value should be set large to cover the operational window without ing the system’s storage capacity.

hese parameters should be set to TRUE esting and implementation.

receive these logs on the standard output “PLAN_NO_LOG_STDOUT or ogStdOut” described on page A - 11 to

UE.record these logs into disk files set “SW_G_TO_FILE or logToFile_MSG” described page A - 108 to TRUE. path and prefix for logging to disk must be

using “SW_LOG_PREFIX or logFilePrefix_G” described on page A - 108.e level of logging is set using “PLAN_LOG_

EL or logLevel” described on page A - 15.e “SW_LOG_FILES or numLogFiles_MSG” cribed on page A - 109 to set the number of files to be maintained on the disk at any e.ration for the saved log files can be set ng “SW_LOG_HOURS or logHours_MSG” cribed on page A - 108.

Switch logging Configuration (Sheet 2 of 2) (Continued)


opyright © 2000, 2010, O


A - 109

SW_LOG_FILES or numLogFiles_MSG

int_range 1 .. 1000 168 Sets the number of latest plannerSwitch log files to be maintained on the disk.

Old log installatrestart a

"Msys" effective

Where penoughexhaust

SW_LOG_RECV or rxHipLogging

boolean TRUE, FALSE

FALSE Set to TRUE to log all the HIP packets received by plannerSwitch.

Note: Tduring t

• To setnoLTR

• To LOon

• ThesetMS

• ThLEV

• Usdeslogtim

• Duusides

SW_LOG_TRANS or txHipLogging

boolean TRUE, FALSE

FALSE Set to TRUE to log all the HIP packets sent by plannerSwitch.


Planner 10.5

System

Manual

C A.1.4.6 Hidden Switch Configurationspecific parameter settings made for


pens

d from the hostPort”

Note: These parameter can be set only for the smauto process, which is then implicitly applied on the Switch process.

ity after which nnection.

d from the T or age A - 89.


t output to a

output to a

separator in ed by Print

opyright © 2000, 2010, O


A - 110

The parameters in this section cannot be set explicitly as their values are inherited from other processes.

A.1.5 Print Manifest Server (manifestServer) Keywords

Hidden Switch Configuration


SW_SM_PORT or smautoPort

Hidden Port number at which Switch oconnection for smauto.

This parameter value is deriveparameter “SW_SM_PORT ordescribed on page A - 89

SW_SM_TIMEOUT or smautoTimeout

Hidden 900 Interval in seconds of no activSwitch will drop an smauto co

This parameter value is deriveparameter “SW_SM_TIMEOUserverTimeout” described on p

manifestServer configuration (Sheet 1 of 2)


PLAN_PRINT_TEXT or printTextFile

boolean TRUE, FALSE

FALSE Set to FALSE to prinpostscript file.

Set to TRUE to printtext file.

PLAN_TEXT_SEPARATOR or textSeparator

string , Used to set the fieldthe text files generatManifest Server.

Planner 10.5

System

Manual

C

rClient

sion that the r is to expect.

ey and Note: PLAN_SECURE_SOCKET should be enabled for MS_SECURE_KEYFILE to be effective

thorities file Note: PLAN_SECURE_SOCKET should be enabled for MS_TRUSTED_CA parameter to be effective

heet 1 of 2)

criptionFile” on page A - 98

on page A - 100

ging” on page A - 96

MapObjects” on page A - 100

or maxMapObjectTypes” on page A - 100

apColorDepth” on page A - 100

apLabelPadding” on page A - 100

ackgroundColor” on page A - 100

Name” on page A - 102

conName” on page A - 102

manifestServer configuration (Sheet 2 of 2) (Continued)


opyright © 2000, 2010, O


A - 111

A.1.5.1 Configuration parameters Common to manifestServer and planne

MANIFEST_HIP_VER or hipVersion

string 7_0, 8_1, 9_0, 10_0

10_0 Set the interface verPrint Manifest Serve

MS_SECURE_KEYFILE or secureKeyfile

string *.pem, *.PEM

Application private kcertificate file

MS_TRUSTED_CA or trustedCAlist

string *.pem, *.PEM

Trusted certificate au

Configuration parameters common to manifestServer and plannerClient (S

Configuration Parameter DesNMC_LAYOUT_FILE or layoutFile See, “ NMC_LAYOUT_FILE or layout

NMC_RASTER_MAP or rmap See, “ NMC_RASTER_MAP or rmap”

NMC_LOG_RECV or rxHipLogging See, “ NMC_LOG_RECV or rxHipLog

NMC_MAX_MAP_OBJ or maxMapObjects See, “ PLAN_MAX_MAP_OBJ or max

NMC_MAX_MAP_OBJ_TYPE or maxMapObjectTypes See, “ NMC_MAX_MAP_OBJ_TYPE

NMC_MAP_CLR_DEPTH or mapColorDepth See, “ NMC_MAP_CLR_DEPTH or m

NMC_MAP_LABEL_PAD or mapLabelPadding See, “ NMC_MAP_LABEL_PAD or m

NMC_MAP_BG_CLR or mapBackgroundColor See, “ NMC_MAP_BG_CLR or mapB

NMC_STOP_ICON or stopIconName See, “ NMC_STOP_ICON or stopIcon

NMC_DEPOT_ICON or depotIconName See, “ NMC_DEPOT_ICON or depotI


Planner 10.5

System

Manual

C

slationFile” on page A - 98

erenceFile” on page A - 98

InMiles” on page A - 99

tum” on page A - 101

ffset” on page A - 101



enter” on page A - 101

adius” on page A - 101

RL” on page A - 102

apViewerDatasource” on page A - 102

iewerBasemap” on page A - 102

oadMapViewerImageDirect” on

ight” on page A - 104

page A - 104

page A - 104

on page A - 104

hortLink” on page A - 104

or bamHostProcess” on page A - 95

Configuration parameters common to manifestServer and plannerClient (Sheet 2 of 2) (Continued)

cription

opyright © 2000, 2010, O


A - 112

NMC_APP_TRANS or appTranslationFile See, “ NMC_APP_TRANS or appTran

NMC_PREFERENCES or preferenceFile See, “ NMC_PREFERENCES or pref

NMC_DISPLAY_MILES or distInMiles See, “ NMC_DISPLAY_MILES or dist

NMC_MAP_DATUM or mapDatum See, “ NMC_MAP_DATUM or mapDa

NMC_MAP_OFFSET or mapOffset See, “ NMC_MAP_OFFSET or mapO

NMC_RMAP_XOFFSET or xOffset See, “ NMC_RMAP_XOFFSET or xO

NMC_RMAP_YOFFSET or yOffset See, “ NMC_RMAP_YOFFSET or yO

NMC_MAP_CENTRE or mapCenter See, “ NMC_MAP_CENTRE or mapC

NMC_MAP_RADIUS or mapRadius See, “ NMC_MAP_RADIUS or mapR

NMC_MV_URL or mapViewerURL See, “ NMC_MV_URL or mapViewerU

NMC_MV_DATASOURCE or mapViewerDatasource See, “ NMC_MV_DATASOURCE or m

NMC_MV_BASEMAP or mapViewerBasemap See, “ NMC_MV_BASEMAP or mapV

NMC_MV_LOAD_DIRECT or loadMapViewerImageDirect

See, “ NMC_MV_LOAD_DIRECT or lpage A - 102

PLAN_TBT_STRAIGHT or straight See, “ PLAN_TBT_STRAIGHT or stra

PLAN_TBT_BEAR or bear See, “ PLAN_TBT_BEAR or bear” on

PLAN_TBT_TURN or turn See, “ PLAN_TBT_TURN or turn” on

PLAN_TBT_SHARP or sharp See, “ PLAN_TBT_SHARP or sharp”

PLAN_TBT_SHORT_LINK or shortLink See, “ PLAN_TBT_SHORT_LINK or s

NMC_BAM_HOST_PROCESS or banHostProcess See, “ NMC_BAM_HOST_PROCESS

Configuration Parameter Des

Planner 10.5

System

Manual

C


based view Attribute based View filtering and Date based filtering are applied together.

When the GuiServer only want a subset of objects from its server, ’guiServerDate’ can be used together with ’guiServerView’.

Note: These parameters are ineffective when the GuiServer is connected to smauto directly (as smauto always sends all objects to its clients without any filtering)

ed view

ply to actual fts (and operate on

fined as a e next two

e applied and e filter i.e. a lter will be

it must tribute filter

opyright © 2000, 2010, O


A - 113

A.1.6 GuiServer (plannerGuiServer) Keywords

A.1.6.1 View Filtering configuration

View Filtering configuration


GS_VIEW or guiServerView

string ALL Used to enable attributefiltering.

GS_DATE or guiServerDate

string ALL Used to enable date basfiltering.

The Date filtering can apdates i.e. show only Shiunassigned Stops) whichthe 2007-28-12.

The Date can also be derelative date i.e. show thdays of data.

Multiple Date filters can beach filter is a cumulativShift that matches any fishown.

For a Shift to be shown intersect with both an atAND a date filter.

Planner 10.5

System

Manual

C A.1.6.2 GuiServer Connections configuration


By default all clients (including GuiServer) connect to smauto directly at “PLAN_CENT_AUTO_PORT or serverPort” described on page A - 85.

Note: PlannerClients and cascaded GuiServers can be made to connect to the GuiServer by configuring their "PLAN_CENT_AUTO_PORT or serverPort’ to be the same as that defined by "GS_CLIENT_PORT or clientPort".

For example:

Assumption: In the GuiServer configuration file, PLAN_CENT_AUTO_PORT=9000(default to connect to smauto) and GS_CLIENT_PORT=9700

Then set PLAN_CENT_AUTO_PORT=9700 in the configuration file for plannerclient or cascaded GUiServer requiring direct connection to guiServer.

Used to set the optimum rate of communication between processes. Also see, “ GS_MAX_PACKETS or maxPackets” on page A - 115

opyright © 2000, 2010, O


A - 114

GuiServer Connections configuration (Sheet 1 of 2)


GS_CLIENT_PORT or clientPort

int_range 0 .. 10000 9700 Sets the port address at which Clients may connect to GuiServer

GS_REQ_INTERVAL or requestInterval

int_range

1 .. 10000 5 Sets the interval, in seconds, at which GuiServer will request smauto for data.

GS_POLL_INT or pollTimeInterval

double_range

0.01 .. 60.0 0.01 Sets the time interval at which GuiServer polls the sockets for incoming data.

Planner 10.5

System

Manual

C


Used to make sure that a socket poll does not last forever, and that all processes get a fair share of cpu time. Also see, “ GS_POLL_INT or pollTimeInterval” on page A - 114.



The frequency at which GuiServer will poll the socket is determined by “GS_CONN_POLL_INT or newConnectionPollInterval” described on page A - 115.

Note: PLAN_SECURE_SOCKET should be enabled for GS_SECURE_KEYFILE to be effectiveNote: PLAN_SECURE_SOCKET should be enabled for GS_TRUSTED_CA parameter to be effective

GuiServer Connections configuration (Sheet 2 of 2) (Continued)
opyright © 2000, 2010, O

A - 115

GS_MAX_PACKETS or maxPackets

int_range 1 .. 10000 1000 Sets the maximum number of packets that GuiServer will read in one socket poll.

GS_CONN_POLL_INT or newConnectionPollInterval

double_range

0.1 .. 60.0 0.1 This is the frequency at which GUI Server checks for new plannerClient (or cascaded GUI Server) connections.

GS_CONN_HOG_COUNT or maxConnectionHog

int_range 1 .. 500 5 Sets the maximum number of connections that GuiServer will accept in one socket poll.

GS_SECURE_KEYFILE or secureKeyfile

string *.pem, *.PEM Application private key and certificate file

GS_TRUSTED_CA or trustedCAlist

string *.pem, *.PEM Trusted certificate authorities file

GS_VERIFY_CLIENT or verifyClient

boolean TRUE, FALSE


Planner 10.5

System

Manual

C A.1.6.3 GuiServer Buffer configuration


byte) that can uffering each

This value should be set to at least twice the size of the schedule. The schedule size can be determined by saving to a ".hip" file.

e in seconds a socket ata it is read.

opyright © 2000, 2010, O


A - 116

GuiServer Buffer configuration


GS_SOCK_BUF_SIZE or socketBufferSize

int_range 1 .. 100000 10000 Sets the memory (in kilobe allocated for use in bsocket.

GS_MAX_WAIT_BLOCK or maxWaitBlock

int_range 0 .. 86400 0 This is the amount of timthat GuiServer will keepconnection open, if the dpassing out is not being

Planner 10.5

System

Manual

C A.1.6.4 GuiServer Logging configuration


These parameters should be set to TRUE testing and implementation.

o receive these logs on the standard output et “PLAN_NO_LOG_STDOUT or oLogStdOut” described on page A - 11 to RUE.o record these logs into disk files set “GS_OG_TO_FILE or logToFile_MSG” described n page A - 117 to TRUE.he path and prefix for logging to disk must e set using “GS_LOG_PREFIX or gFilePrefix_MSG” described on age A - 117.he level of logging is set using “PLAN_OG_LEVEL or logLevel” described on age A - 15.se “GS_LOG_FILES or numLogFiles_SG” described on page A - 118 to set the umber of log files to be maintained on the isk at any time.uration for the saved log files can be set sing “GS_LOG_HOURS or logHours_MSG” escribed on page A - 117.

are essential for tracking process related and hence must always be logged to File.

ust be a valid and accessible location on sk.

les are usually sent as email attachments. g this value to 1 hour will keep these file a minimum.

opyright © 2000, 2010, O


A - 117

GuiServer Logging configuration (Sheet 1 of 2)


GS_LOG_RECV or rxHipLogging

boolean

TRUE, FALSE

FALSE Set to TRUE to log all the HIP packets received by GuiServer.

Note:during

• TsnT

• TLo

• Tblop

• TLp

• UMnd

• Dud

GS_LOG_TRANS or txHipLogging

boolean

TRUE, FALSE

FALSE Set to TRUE to log all the HIP packets sent by GuiServer.

GS_LOG_TO_FILE or logToFile_MSG

boolean

TRUE, FALSE


Logs issues

GS_LOG_PREFIX or logFilePrefix_MSG

string $PLAN_LOG/guiServer


This mthe di

GS_LOG_HOURS or logHours_MSG

int_range


Log fiSettinsize to

Planner 10.5

System

Manual

C

g files are deleted (only on UNIX ations). Log files created prior to a system t are not deleted.

" must be installed for this parameter to be ive on the Windows environment.

possible, this value should be set large h to cover the operational window without sting the system’s storage capacity.

GuiServer Logging configuration (Sheet 2 of 2) (Continued)


opyright © 2000, 2010, O


A - 118

GS_LOG_FILES or numLogFiles_MSG

int_range

1 .. 1000 168 Sets the number of latest GuiServer log files to be maintained on the disk.

Old loinstallrestar

"Msyseffect

Whereenougexhau



Appendix B: Dynamic Working Areas

Dynamic Work Areas is a method of keeping Resources (Drivers/Engineers) working as close as possible to a central point. This is most of use where the Resources work areas are scattered across a large area. i.e. Resources starting work at home. The central point from which the Resources work from defaults to their log on location but can be independently configured through the DW_AREA_LAT and DW_AREA_LON fields within the Shift packet. The area in which a Resource is encouraged to work is determined by the spread of the other Resources. When there are many Resources working close together they will be encouraged to work in a smaller area than where the Resources are spread farther afield.

The encouragement to work close to their central location is controlled via the Dynamic Work Area Cost. This is a standard exponential cost, applied to every Stop, with the input parameter calculated in the following way:

i = [(ts / rs) - (tc/rc]

Where• ts = the travel time to and from the Stop location from the Shift’s

central work location.• tc = the travel time to and from the Stop location from the closest

Shift’s central work location.• rs = a relative factor applied to the travel time for the Shift, this

relative factor is configured via the RELATIVE_DW_AREA field in the Shift packet.

• rc = a relative factor applied to the travel time for the closest Shift.

The travel times used in the cost calculations are obtained from the matrix, as such they will take into consideration, rivers, lakes and other regions of inaccessibility based on the map connectivity. The Optimiser also considers only compatible Shifts when determining the closest Shift.

Note: All the following examples and explanations assume straight line travel and all Shifts are equally compatibile for all work for simplicity.

B - 1 Copyright © 2000, 2010, Oracle. All rights reserved


B.1 DEFINITION OF DYNAMIC WORK AREAS

In the following image four Resources are spaced equally apart, with the black dots representing the central location for the Resources and the red lines representing the dynamic work area boundaries. These boundaries represent an area of zero cost. If Stops falling within a Shift’s dynamic work area are assigned to that Shift, no cost is incurred. On the other hand a cost is applied when these Stops are assigned to any other Shift.

The relative dynamic work area value controls the size of a Shifts dynamic work area relative to the surrounding Shifts. In the image below the lower right Shift has a relative work area larger than the other three Shifts, as such its dynamic work area pushes back the work areas for the other Shifts.

Copyright © 2000, 2010, Oracle. All rights reserved B - 2


In the next image the lower right Shift has a relative work area smaller than the other three Shifts, hence the work areas for the other three Shifts push into the work area for the Shift with the lower work area.

Note: The work area for the upper left Shift is unchanged as the upper right and lower left Shifts are always closer to the lower right Shift’s work area.

The following image shows a spread of Resources across a region with their associated dynamic work areas.

This type of region definition is known as a Voronoi diagram.



Note: Even without relative factors the central location may not actually fall in the centre of a dynamic work area. The size and shape of the work area is defined by the surrounding Shifts.



B.2 COST CALCULATIONS USING DYNAMIC WORK AREAS

The dynamic work areas do not define hard boundaries between Shifts. When a Shift is assigned a Stop outside its dynamic work area the cost will depend on how far into another work area the Shift must travel and how close to the central locations of each Shift the Stop lies.

In the following example a Stop is represented by a black X. The time/distance units are abstract for simplicity. The Stop falls just inside the dynamic work area of the Shift on the right.

If the Stop is assigned to the right hand Shift no cost is incurred.

If the Stop is assigned to the left hand Shift the dynamic work area cost is applied and an input of 2 is used for the cost calculation (the difference between the closest and assigned Shift travel).

In the following example the Stop falls just inside the dynamic work area of the Shift on the right, as in the previous example, but much further away from the central locations.

If the Stop is assigned to the right hand Shift no cost is incurred.

If the Stop is assigned to the left hand Shift the dynamic work area cost is applied and an input of 0.8 is used for the cost calculation (the difference between the closest and assigned Shift travel). Although the left hand Shift encroaches just as much as in the previous example the cost is much lower as the Stop is further from the central location.

5 3



In the following example although the Shift on the far left must cross a significant portion of the central Shifts work area the cost is the same as for the far right Shift. The left and right Shifts are equal distance from the Stop, the fact that one Shift must travel more in another Shifts work area has no impact on the resultant cost.

It is only the difference between the closest Shift’s and the costed Shift which affects the cost.

14.8 14

7

2

7



Appendix C: Time Dependent Cost

When scheduling over multiple days it is desireable to apply different cost models on different days.

The reason is that when booking Jobs a number of days into the future, when Shifts appear relatively underutilised or indeed empty, the cost-model must promote combining those Jobs that are likely to be together in a "good" run. On the day of execuition however, the main objective is to try to add in as many jobs as possible in order to fully utilise Drivers time.

The Time Dependent Cost Factors allow the Optimiser to bias Jobs on early Shifts and choose days in advance, which combine tight runs.

C - 1 Copyright © 2000, 2010, Oracle. All rights reserved


C.1 HOW DOES TDC WORK?

Time Dependent Cost Factors (TDC) can adjust any Shift based cost based when in time a Shift begins. TDC does not apply to Shifts before the Wall Time.

TDCs cannot be just functions of "time from NOW", they must also incorporate any partial and non-working days between Wall Time and the Shift start time. For instance, without taking into account partial/non-working days a linear Shift Promotion would show the following pattern:

From the graph it can be seen that the promotion cost differential between Friday and Monday is 3 times the differential between adjacent days. This means, that when the Optimiser needs to make a decision betwwen placing a Job on the Friday or the Monday, it is much more likely to introduce lateness or overtime on Friday to get the Job in, because the excessive promotion costs assocaited with moving the Job to the Monday.

A much more equitable promotion cost pattern is obtain if the day-to-day differential cost is relative to the nex days transport capcity.

The transport capacity is taken to be the sum of all the Shift durations for each day.

mon tue wed thu fri sat sun mon tue wed thu fri

WallTime

sat

Copyright © 2000, 2010, Oracle. All rights reserved C - 2


This adjustment is automatically applied based on the transport capacity represented by the Shifts within the schedule. Changes to the transport capacity will cause the the various TDCs to be recalculated.

mon tue wed thu fri sat sun mon tue wed thu fri

WallTime

sat



C.2 TDC FUNCTION

The examples in the previous section assume a linear gradient for the TDC function. In fact the TDC function is rather complex as described in this section.

There are 6 independent variables A, B, C, D, E, and F that control the TDC function:A Controls the initial value for the TDC factor. This is the value which will be applied for

Shifts starting at or before wall time.B Controls for how long the initial A factor applies, in hours. So if the initial factor should

apply for all of the first day then this should be set to 24 (hours). C The C varibale controls the shape of the curve between the initial value and the final

slope, the transition curve.

Its value ranges from 0.1 to 10.• A value of 4 produces a curve similar to the solid line in the diagram• a value of 0.2 produces a curve similar to the dashed line• A value of 1 produces a straight, linear, gradient between the initial and final slope, and is a good starting point.

D The D variable controls the width of the transition curve. This variable is in hours. E The E variable controls the initial factor for the final curve and the final factor for the

transition curve.F The F variable controls the gradient of the final slope.

Note: TDC is not a cost function but only a multiplier on the cost for each Shift, based on the Shift start time.

Day 0 Day 1 Day 2 Day 3 Day 4 Day 5 Time

Fact

or

C1

C2

C3

A

BC

D

E

F



For example: To address a situation where the cost should remain the same for the first two days, then rise rapidly1 unit per day over the next two days and then increase by 0.2 for all the remaining days, TDC variables should be set as below:

• A = 1• B = 48 (hours)• C = 1• D = 48 (hours)• E = 3• F = 0.2/24 = .0083

When this TDC is applied to the Stop late cost, under the assumption that 5 minutes of late time is costed at 100 cost units, the resulting cost will be as listed below:

• For a Shift on day 1 the cost would be 100• For a Shift on day 2 the cost would be 100• For a Shift on day 3 the cost would be 200• For a Shift on day 4 the cost would be 300• For a Shift on day 5 the cost would be 320• For a Shift on day 6 the cost would be 340• For a Shift on day 7 the cost would be 360.



C.3 SAMPLE APPLICATIONS OF TDC

C.3.1 Shift Promotion CostShift Promotion Cost is used in conjuction with TDC to promote early completion of Jobs. This may be required due to customer service policy or to increase the operation’s efficiency.

The Optimiser has no innate preference to "do" Jobs as early as possible. Until other constraints are breached, Planner is mainly distance driven. This means it may schedule a Job for day5, even though there is still capacity (but requiring more additional travel) on day1 to do this Job. In the case where additional Jobs trickle in continously, this is obviously the wrong thing to do: If no additional Jobs are scheduled for day1, we are likely to end up with wasted capacity.

Shift Promotion Cost may be used trade off efficiency in completing the "known" set of Jobs (=distance) against ensuring that no transport capacity is wasted.

Ideally, Shift Promotion is tuned such that day1 fills up just before it becomes day0. If Shift Promotion is too weak, capacity is wasted. If too strong, days fill up well in advance, and the quality of routes suffers.

C.3.2 Reserve Capacity CostWhen providing appointments, Reserve Capacity can be used to limit the area covered for individual runs. This is done by invoking an additional (reserve capacity) cost when a vehicle exceeds (say) 50% of its available time.

The effect is that the first appointment determines the general direction of that day’s run, with the distance travelled for subsequent appointments being restricted through the reserve-capacity cost. The more distance is being covered, the stronger the restriction, causing Jobs that introduce excessive travel to be deferred to another day.

TDC is required to gradually relax the Reserve Capacity cost, enabling the system to fill day0, day1 and so on, in case the Reserve Capacity cost turns out to be too restrictive.



Appendix D: Shift Promotion Cost

The Shift Promotion Cost is meaningful only when used in conjunction with Time Dependent Cost Factors. It applies a cost for assigning a Stop to a Shift. The Stop has a relative factor with the Stop so the cost can be varied on a Stop by Stop basis but the cost for an individual Stop is the same for every Shift.

It would seem on the surface that this cost is then not very useful but when combined with the Time Dependent Cost Factors this cost becomes very useful. It can be used to make the cost of assigning a Stop today lower than assigning the same Stop to an identical Shift tomorrow.

For example if we have two Stops, Stop1 and Stop2.1 Stop1 has a Shift Promotion factor of 1.2 Stop2 has a Shift Promotion factor of 2.

If we use a Shift Promotion Cost of 1000 the cost of assigning Stop1 to any Shift would be 1000 while assigning Stop2 to any Shift would be 2000 cost units. Which doesn't really aid us in scheduling at all.

1 2 3 4 5 6

Days

Cos

t

1

2

3

Stop 1

Stop 2

D - 1 Copyright © 2000, 2010, Oracle. All rights reserved


If we introduce the Time Dependent Cost Factors to the Shift Promotion Cost then we can define three segments of a curve.

1 Firstly a zero factor on day 12 Secondly a factor rising from 0 to 1 from day 1 to 3.3 Thridly a factor rising 1 unit every 4 days from day 3. That is; The factor would reach 2

on day 7.

For the two Stops in our example the cost of assigning them to any Shift starting on day 1 would be zero. The cost of assigning Stop1 to a Shift on day 3 would be 1000 while Stop2 would be 2000, as seen in the graph below.

This allows the Optimiser, or the Slot Generator, to prefer earlier Shifts to later Shifts.

1 2 3 4 5 6

Days

Cos

t

1

2

3

4

Stop 1

Stop 2

Copyright © 2000, 2010, Oracle. All rights reserved D - 2

Appendix E: Changes

This chapter is intended as a quick reference for the changes introduced in Planner 10.5 Release.

The progressive "configuration parameter changes" since Planner release 7.4. have been outlined in the following sections.

Copyright © 2000, 2010, Oracle. All rights reserved E - 1


E.1 PLANNER CONFIGURATION CHANGES

E.1.1 Parameter changes in 10.5 since 10.4

E.1.1.1 Modified Parameters in 10.5 since 10.4

E.1.1.2 10.4 Parameters that have been removed from 10.5

None.

E.1.1.3 New Parameters in 10.5 since 10.4




Parameter Page CommentSW_INTERFACE_VER page 105 Interface version range has been increased to 10_3

New Parameters in 10.5 since 10.4

Parameter Page CommentPLAN_PROCESS_DURATION

page 15 The timing of the process will be logged only when it exceeds this parameter

Parameters in 10.3 that have been removed from 10.4

Parameter CommentPLAN_JOB_ATTR_COST These Parameters have been removed from Planner 10.4

PLAN_AUTODIR_MANDESP

New Parameters in 10.4 since 10.3 (Sheet 1 of 3)

Parameter Page CommentPLAN_ERROR_TRANS page 3 Identifies the Translatable Error Messages file



PLAN_FIRSTJOB_DIST_FACTOR

page 32 Multipler for distance to first stop in shift

PLAN_POU_DIST_FACTOR

page 32 Multiplier for distance to POU stop

PLAN_COST_BREAK_TIME

page 30 Flag to control inclusion of Break time in travel time costing

PLAN_UE_COMPENSATOR

page 62 Flag to fix plan on receiving unexpected events

PLAN_UEC_THRESHOLD page 62 Threshold to reach before UEC can be activated

PLAN _DEF_UTC_OFFSET page 14 Parameter to specify the Default UTC Offset

PLAN_VTIMEZONE page 13 Parameter to supply the Virtual Time Zone

PLAN_OVER_SKILL_COST page 54 Parameters to control OverSkill Costing

PLAN_OVER_SKILL_TDC page 54

PLAN_OVERSKILL_FACTOR

page 50

PLAN_MATRIX_VER page 7 Map Matrix Parameters introduced in 10.4

PLAN_MATRIX_UPD_INT page 7

PLAN_TWS_SEGMENTATION

page 70 Parameter to control TWS Segmentation

PLAN_SECURE_SOCKET page 9 Parameters to control SSL settings

PLAN_TRUSTED_CA page 86

PLAN_VERIFY_CLIENT page 86

PLAN_SECURE_KEYFILE page 85

SW_SECURE_KEYFILE page 89

SW_TRUSTED_CA page 89

SW_VERIFY_CLIENT page 90

GS_SECURE_KEYFILE page 115

GS_TRUSTED_CA page 115

GS_VERIFY_CLIENT page 115

MS_SECURE_KEYFILE page 111

MS_TRUSTED_CA page 111

NMC_SECURE_KEYFILE page 97

NMC_TRUSTED_CA page 97

NMC_BAM_HOST_PROCESS

page 95 Parameter to integrate ORS with Oracle’s BAM

New Parameters in 10.4 since 10.3 (Sheet 2 of 3) (Continued)

Parameter Page Comment

E - 3 Copyright © 2000, 2010, Oracle. All rights reserved


NMC_MV_URL page 102 OracleAs MapViewer parameters

NMC_MV_DATASOURCE page 102

NMC_MV_BASEMAP page 102

NMC_MV_LOAD_DIRECT page 102









Modified Parameters in 10.4 since 10.3

Parameter Page CommentPLAN_SLA_STOP_COST page 21 Corresponding configuration parameter name in

planner.config changed from slaWindowStopCost to slaLateStopCost.

PLAN_SLA_DEPOT_COST page 22 Corresponding configuration parameter name in planner.config changed from slaWindowDepotCost to slaLateDepotCost


Parameter CommentPLAN_ENA_AUTO_TIGHT These Parameters have been removed from Planner 10.3

PLAN_JOB_ATTR_TDC

NMC_APP_NAME

EX_REQ_INTERVAL

EX_PROFILES

EX_LOG_RECV

EX_LOG_TRANS

EX_LOG_TO_FILE

EX_LOG_PREFIX

EX_LOG_HOURS

EX_LOG_FILES




Parameter Page CommentNMC_LOG_TO_FILE page 96 These are the new parameters introduced in Planner

10.3NMC_LOG_PREFIX page 96

NMC_LOG_HOURS page 96

NMC_LOG_FILES page 96

NMC_LOG_COMPRESS page 11

NMC_MAP_PROJECTION page 103





Parameter Page CommentPLAN_AREA_ROUND_COST page 35 Default value has been changed to NULL

PLAN_ROUND_OL_COST page 34

PLAN_ROUND_VAR_COST page 34

PLAN_END_OVRLAP_COST page 34

PLAN_ROUND_LEN_COST page 35

PLAN_RD_LEN_VAR_COST page 34

PLAN_MAX_TERM page 80

PLAN_WARN_DAYS_EXP page 82

PLAN_MAX_PASS_ATMPTS page 82

PLAN_PASSWORD_EXP page 82

NMC_APP_TITLE page 102 Default value has been changed from "Planner NMC" to "Oracle Real-time Scheduler"






Parameter CommentPLAN_COAST These Parameters have been removed from Planner 10.2

PLAN_ROAD

PLAN_LICENCE

PLAN_LOG_PLAN

PLAN_COST_REDUCTION

PLAN_TOUR_ITERS_A

PLAN_TOUR_ITERS_X

PLAN_TOUR_TEMP_A

PLAN_TOUR_TEMP_X

PLAN_TOUR_REV_PROB

PLAN_TOUR_MOVE_PROB

PLAN_TOUR_CLER_PROB

PLAN_TOUR_SWAP_PROB

PLAN_TOUR_SEG_DEV

PLAN_LICENCE_EXP

NMC_WEBRASKA_URL NMC Parameters that were used for configuring Webraska has been removed from Planner 10.2.

NMC_WEBRASKA_USER

NMC_WEBRASKA_PASS

DMC_APP_TITLE DataManager has been retired in Planner 10.2. These parameters that were used exclusively for configuring DataManager have also been removed.DMC_APP_NAME

DMC_LAYOUT_FILE

DMC_ID

DMC_DATA_SLAVE

DMC_STOP_TEMPLT_FILE

DMC_GEO_HOST

DMC_GEO_PORT

DMC_REQ_INTERVAL






Parameter Page CommentPLAN_DEL_REJ_JOB page 94 These are the new parameters introduced in Planner

10.2NMC_RMAP_XOFFSET page 101

NMC_RMAP_YOFFSET page 101

Modified Parameters in 10.2 since 10.1 (Sheet 1 of 2)

Parameter Page CommentPLAN_CENT_AUTO_PORT page 10 Default value has been changed from NONE to 9000

PLAN_USER_BUF_SIZE page 12 Default value has been changed from 8 to 10000

PLAN_MTRX_SEG page 17 Original name PLAN_MTRX_SEGMENTATION has been shortened

PLAN_POLLTIME_INTRVL page 85 Default value has been changed from NULL to 0.01

PLAN_NEW_POLL_INTRVL

page 85 Default value has been changed from NULL to 5

PLAN_MAX_CONNECTIONS

page 85 Default value has been changed from NULL to 10

PLAN_SERVER_MODE page 88 Default value has been changed from TRUE to FALSE

PLAN_IMMED_ASSIGN page 16 Default value has been changed from FALSE to TRUE

PLAN_LOG_TO_FILE page 83 Default value has been changed from FALSE to TRUE

PLAN_LOG_HOURS page 83 Default value has been changed from 24 to 1

PLAN_LOG_FILES page 84 Default value has been changed from 60 to 168

PLAN_AUTOSAVE_DIR page 87 Default value has been changed from $PLAN_LOG to AutoSave

PLAN_AUTODIR page 91 Default value has been changed from FALSE to TRUE

PLAN_AUTODIR_BRKS page 91 Default value has been changed from FALSE to TRUE

PLAN_AD_DETOURDIST page 93 Original name PLAN_AD_DETOURDISTANCE has been shortened

PLAN_SCHED_DURATION page 80 Default value has been changed from 2400 to 600

PLAN_REAL_TIME page 60 Default value has been changed from NULL to AUTO_POSITION

PLAN_ENA_AUTO_TIGHT Removed in 10.3

PLAN_CLI_TIMEOUT page 90 Default value has been changed from -1 to 900



PLAN_INTVAL_REF_TIME page 64 Original name PLAN_INTERVAL_REF_TIME has been shortened

PLAN_RUN_SEP_TDC page 33 Original name PLAN_RUN_SEPARATION_TDC has been shortened

PLAN_DNMK_WA_TDC page 48 Original name PLAN_DNMK_WA_COST_TDC has been shortened

SW_CONN_POLL_INT page 107 Default value has been changed from 0.1 to 0.01

SW_CONN_HOG_COUNT page 107 Default value has been changed from 5 to 10

SW_CONN_BACKLOG page 107 Default value has been changed from 5 to 100

SW_MAX_WAIT_BLOCK page 108 Default value has been changed from 60 to 0

SW_SOCK_BUF_SIZE page 108 Default value has been changed from 2000 to 10000

SW_DB_TIMEOUT page 105 Default value has been changed from 3600 to 900

Modified Parameters in 10.2 since 10.1 (Sheet 2 of 2) (Continued)









Parameter CommentPLAN_ALLOCATION_TDC These smauto Parameters have been removed from Planner 10.1

PLAN_RADIUS_TO_LOFF

PLAN_TIME_TO_LOFF


Parameter Page CommentPLAN_MAP_DIST_FACTOR page 6 New smauto Parameter in 10.1

PLAN_MAP_TIME_FACTOR page 6

PLAN_DNMK_WA_COST page 48 New smauto Parameter in 10.1.

PLAN_DNMK_WA_COST_TDC page 48 New smauto Parameter in 10.1. This parameter name has been changed to PLAN_DNMK_WA_TDC in 10.2

SW_CONN_BACKLOG page 107 New Switch Parameter


Parameter Page CommentPLAN_OPT_ASSIGN_MODE page 69 The default value for this parameter has been

changed from OFF to ON.







Parameter CommentPLAN_STORE_IND_TBL All these 9.2 parameters have been removed from 10.0

PLAN_BREAK_EARLY_COST

PLAN_BREAK_EARLY_EXTD

PLAN_EARLY_SLOT_PROM

PLAN_BRKEARLY_FACTOR Removed from the 10.0 release

New Parameters in 10.0 since 9.2 (Sheet 1 of 2)

Parameter Page CommentPLAN_SLOT_GEN_FILTER page 19 New smauto parameter to return slot if slot

[SG_CONTAINED_IN, SG_STARTS_IN, SG_ENDS_IN , SG_OVERLAPS]

PLAN_SGC_FILTER page 18 New smauto parameter to filter non-chronological slots from the slot-generator output

PLAN_SGC_FILTER_TOL page 18 New smauto parameter to set chronological tolerance for slot-generator output

PLAN_SLA_DEPOT_COST page 22 New parameters to tune the SLA depot/stop costs

PLAN_SLA_STOP_COST page 21

PLAN_START_REF_TIME page 64 New parameters to configure the system Reference Time.

Note: The parameter name PLAN_INTERVAL_REF_TIME has been shortened to PLAN_INTVAL_REF_TIME in 10.2

PLAN_INTERVAL_REF_TIME page 64

SHIFT_PROMOTION_COST page 22

PLAN_JOBS_LIMIT_COST page 46

SHIFT_PROMOTION_TDC page 23 New parameters introducing TDC cost factors.

PLAN_TRIP_TDC page 44

PLAN_LONG_HAUL_TDC page 45

PLAN_DIST_TDC page 32

PLAN_TIME_TDC page 29

PLAN_IDLE_TDC page 31



PLAN_JOB_ATTR_TDC Removed in 10.3

PLAN_STOP_ZONE_TDC page 58 New parameters introducing TDC cost factors.

PLAN_RND_ZONE_TDC page 57

PLAN_WINDOW_TDC page 29

PLAN_VOLUME_TDC page 42

PLAN_RSRC_ATTR_TDC page 56

PLAN_AREA_ROUND_TDC page 36

PLAN_ALLOCATION_TDC This parameter has been removed from the latter release 10.1

PLAN_WAIT_PAST_TDC page 42 New parameters introducing TDC cost factors

PLAN_SLA_STOP_TDC page 21

PLAN_WAIT_TDC page 41

PLAN_SLA_DEPOT_TDC page 22

PLAN_LATE_OFF_TDC page 26 New parameters introducing TDC cost factors

PLAN_LATE_STOP_TDC page 25 New parameters introducing TDC cost factors

PLAN_LATE_DEPOT_TDC page 27

PLAN_WEIGHT_TDC page 39

PLAN_VOLUME_TDC page 42

PLAN_PKUP_SRVC_TDC page 23

PLAN_DROP_SRVC_TDC page 24

PLAN_RUN_SEPARATION_TDC Renamed as PLAN_RUN_SEP_TDC in latter release 10.2

PLAN_LIFESPAN_TDC page 46 New parameters introducing TDC cost factors

PLAN_EMPTY_TRVL_TDC page 47

PLAN_BREAK_LATE_TDC page 49

PLAN_RES_CAP_TDC page 44

PLAN_SITE_TDC page 43

PLAN_APEX_TDC page 59

PLAN_ROUND_LEN_TDC page 35

PLAN_JOBS_LIMIT_TDC page 47

PLAN_COSTWAIT_P_MAX page 41

PLAN_RADIUS_TO_LOFF These parameters have been removed from the latter release 10.1

PLAN_TIME_TO_LOFF

SW_DB_TIMEOUT page 105 New Switch parameter





E.1.6.3 Modified Parameters in 10.0 since 9.2None.


E.1.7.1 Parameters from 9.1 that are removed from 9.2None.

E.1.7.2 New/Modified Parameters in 9.2 since 9.1


E.1.8.1 Parameters from 9.0 that are removed from 9.1

New/Modified Parameters in 9.2 since 9.1

Parameter Page CommentPLAN_EARLY_SLOT_PROM

Removed from latter release 10.0

PLAN_AD_RULE page 92 New smauto parameter to define a run in terms of auto direct

PLAN_AD_STABILITYPRD page 92 New smauto parameter to define minimum period of stability at a depot or at a stop before auto despatching

PLAN_AD_MINLOAD page 93 New smauto parameter to define Min load as a ratio of vehicle capacity for AutoDespatch

PLAN_AD_MAXLOAD page 93 New smauto parameter to define Max load as a ratio of vehicle capacity for AutoDespatch

PLAN_AD_DETOURDISTANCE

Renamed to PLAN_AD_DETOURDIST in latter release 10.2

PLAN_DR_ALL_AT_SITE page 60 New smauto parameter to decide if dead reckoning arrives and completes all consecutive stops at a site at once or one by one

PLAN_TIME_TO_ACTIVE page 62 New smauto parameter to define the time factor required to undelay a delayed resource after a specified date/time

NMC_MAPPOINT_REGION page 101 New NMC parameter to define the data set option to represent a MapPoint region supported by Planner™

NMC_APP_STYLE page 99 New NMC parameter to define the default style using which the Planner Client should start

GS_DATE page 113 New GUISERVER parameter to define the date range when only a subset of objects are required by the GuiServer from its server



None.



Parameter Page CommentPLAN_SLOT_GEN_TERM page 18 New smauto/Slot-Generator parameter to replace the

previous fixed limit

PLAN_REL_OVERCAP page 68 New smauto parameter to enable the Depot Time Window Capacity Cost to cost over capacity relative to the maximum capacity rather than absolute values.








Parameters from 8.3 not in 9.0

Parameter CommentPLAN_JOB_DIST_FACT These Parameters have been removed from 9.0 and were used to

assign a "Job Value" to a Job, when not supplied by the host-system. "Job Value" is used for "load-levelling".PLAN_MIN_JOB_DIST


Parameter Page CommentPLAN_LICENCE_EXP Removed from latter release 10.2

GS_CLIENT_PORT page 114 New GuiServer Parameters to configure the GuiServer process introduced in Planner 9.0.

GS_REQ_INTERVAL

GS_POLL_INT

GS_VIEW page 113

GS_MAX_PACKETS page 115

GS_CONN_POLL_INT New GuiServer Parameters to configure the GuiServer process introduced in Planner 9.0.

GS_CONN_HOG_COUNT

GS_MAX_WAIT_BLOCK

GS_SOCK_BUF_SIZE

GS_LOG_RECV page 117

GS_LOG_TRANS

GS_LOG_TO_FILE

GS_LOG_PREFIX

GS_LOG_HOURS

GS_LOG_FILES page 118




New/Modified Parameters in 8.3 since 8.2 (Sheet 1 of 2)

Parameter Page CommentPLAN_IDLE_COST page 31 New smauto parameter to configure Idle Time costing.

PLAN_MIN_TRVL_NONJOB page 65 New smauto parameter to allow non-job stops, at the same location, to be considered as at the same site for the purpose of Inter-Stop Time calculations.

PLAN_TRVLTIME_FACTOR page 51 New smauto Parameters to configure the Conditional Booking Factors introduced in Planner 8.3.

PLAN_IDLETIME_FACTOR

PLAN_STOPLATE_FACTOR page 52

PLAN_DEP_LATE_FACTOR

PLAN_OFFLATE_FACTOR

PLAN_HAULEXT_FACTOR

PLAN_LOADCOST_FACTOR page 50

PLAN_JOBATTR_FACTOR page 50 New smauto Parameters to configure the Conditional Booking Factors introduced in Planner 8.3.

PLAN_S_LINK_FACTOR

PLAN_S_ITEM_FACTOR

PLAN_LONGHAUL_FACTOR page 51

PLAN_WINDOW_FACTOR page 53

PLAN_SITE_FACTOR

PLAN_PKUPSRVC_FACTOR

PLAN_DROPSRVC_FACTOR

PLAN_RUN_SEP_FACTOR

PLAN_APEX_FACTOR page 51

PLAN_LIFESPAN_FACTOR page 50

PLAN_MANYSHFT_FACTOR page 51

PLAN_COMPAT_FACTOR page 50

PLAN_RSRCATTR_FACTOR

PLAN_ZONE_FACTOR

PLAN_MAPS_FACTOR

PLAN_WAIT_FACTOR page 51

PLAN_EMP_TRVL_FACTOR

PLAN_BRKEARLY_FACTOR Removed from latter release 10.0

PLAN_BRKLATE_FACTOR page 52

PLAN_RES_CAP_FACTOR page 53






PLAN_RUN_FACTOR page 51

PLAN_DPT_PROD_FACTOR page 53

SW_INTERFACE_VER page 105

New Switch parameter to configure the HIP interface version.


Parameter Page CommentPLAN_ACC_GROUP_FILE page 81 New smauto parameter to configure the User Access

Group file.

PLAN_MIN_TRVL_TIME page 65 New smauto parameter to specify the Minimum travel time between Stops.

PLAN_CLI_TIMEOUT page 90 New smauto parameter to configure the allowable time of inactivity before dropping Client connection.

PLAN_TEXT_SEPARATOR page 110 New Manifest Server parameter to specify the text separator in manifest output.

PLAN_PRINT_TEXT New Manifest Server parameter to specify the manifest output format.

MANIFEST_HIP_VER New Manifest Server parameter to configure the expected interface version.

SW_SM_TIMEOUT page 89 New Switch parameter to configure the allowable time of inactivity before dropping connection.

New/Modified Parameters in 8.3 since 8.2 (Sheet 2 of 2) (Continued)







Parameters from 7.4 not in 8.1

Parameter CommentPLAN_AUTODIR_INT This parameter which controlled the activation of Autodirect until 7.4

has now been removed from 8.1 and replaced with an explicit flag to Enable Autodirect (See PLAN_AUTODIR on page 91.)

Note: The PLAN_AUTODIR_INT parameter in 7.4 is functionally different from the PLAN_AUTODIR_INT parameter in 8.1.

New/Modified Parameters in 8.1 since 7.4 (Sheet 1 of 2)

Parameter Page CommentPLAN_DR_WAIT_ENROUTE page 60 New smauto parameter to configure dead-reckoning

of ENROUTE stops.

PLAN_AUTO_GO_HOME page 61 New smauto parameter to configure the Auto Go Home functionality

PLAN_GO_HOME_TIME page 61 New smauto parameter to configure the wait time in seconds, after finishing last job before automatically directing to logoff

PLAN_AUTODIR page 91 New smauto parameter to enable/disable AutoDirect function.

PLAN_AUTODIR_INT page 91 New smauto parameter to control the frequency at which Autodirect function checks for Stops to direct.

Note: The PLAN_AUTODIR_INT parameter in 8.1 is functionally different from the PLAN_AUTODIR_INT parameter in 7.4.

PLAN_AUTODIR_MANDESP - Newsmauto parameter to enable/disable Autodirecting of messages to drivers when jobs are dispatched manually.

Note: This parameter has been removed in 10.4.

PLAN_WAIT_PAST_COST page 40 New smauto parameters to configure Wait Time Past costing.

PLAN_COSTWAIT_FOROFF page 40

PLAN_COSTWAIT_HRZON page 40

PLAN_COSTWAIT_MAX page 41

PLAN_RES_CAP_COST page 44 New smauto parameter to configure Reserved Shift Capacity cost.



EX_REQ_INTERVAL New dataExtract Parameters to configure the dataExtract process introduced in Planner 8.1.

Removed in 10.3

EX_PROFILES

EX_LOG_RECV

EX_LOG_TRANS

EX_LOG_TO_FILE

EX_LOG_PREFIX

EX_LOG_HOURS

New/Modified Parameters in 8.1 since 7.4 (Sheet 2 of 2) (Continued)



Index

AAdding Allocator Users ..................................................... 5

BBooking Factors ............................................................. 28

CConfig Files ................................................................. 4, 5Configuration .................................................................. 18connecting ................................................................. 12, 8Connection ..................................................................... 15Connections ................................................................... 43Copy Customized Layout ................................................. 5

EError Generation ............................................................ 19

FFailOver .......................................................................... 13

GGlossary

Data Storage and Transfer ...................................... 5GuiServer ....................................................................... 14GuiServer parameters ...................................................... 8

HHardware .......................................................................... 9

LlaunchPlanner ................................................................ 12Layout file ....................................................................... 19

MManifest Hip Version .........................................................7ManifestServer .........................................................14, 10Modify .cshrc File ..............................................................5

NnmcConfig .......................................................................12

Ppidof ................................................................................12Planner™/GUI Version ................................................4, 5plannerClient ...................................................................13plannerGuiServer ............................................................14plannerPasswd ...............................................................12plannerSwitch ..............................................................1, 9Print Manifest Server ......................................................18Print Manifest Server Data ..............................................19Process ...........................................................................20processes .........................................................................2

RrunGuiServer ..................................................................14runManifest ..............................................................14, 10runnmc ............................................................................13runsmauto .......................................................................13runswitch ...........................................................................9

SSecondary Switch .............................................................8Set User Level ..................................................................9Shut Down ......................................................................15smauto ............................................................................13startPlanner ....................................................................13SYNC_PLAN ..................................................................16

TTurn-by-Turn values .........................................................6

Copyright © 2000, 2010, Oracle. All rights reserved - 1


UUser Access Control ................................................. 5, 44User access Control ......................................................... 9User Access Groups ........................................................ 9Using the New Map .......................................................... 3

Copyright © 2000, 2010, Oracle. All rights reserved - 2

oracle€¦ · copyright © 2000, 2010, oracle. all rights reserved copyright © 2000, 2010,...

Documents