Batch Switches and Descriptions

Batch switches are found in the Trace Options dialog box.

Batch Switches

The following Batch switches are located in the Schedule Server application. Click View > Switches; in the Switches tab, expand Switches > PASS > SchedSrv > Batch folder.
Table 1. Batch Switches and Descriptions
Switch Description Default
Batch Time Slice Specifies the number of bookings to be scheduled before yielding control to the next batch request at the same priority. The Schedule Server will service batch requests at the same priority for the same schedule in a round robin style. Requests at higher priority can interrupt the current batch request immediately. 100
CapType Swapping Before Match

Specifies whether the capacity swapping algorithm will be applied prior to matching.

Runs that exist in both the template schedule (source for the match) and the live schedule (target for the match) and have no capacity type in the live schedule may be assigned a capacity type/vehicle type prior to the matching algorithm commencing for that run. (Note that runs that are only in the live schedule are ignored during matching).

For more information about capacity type swapping, see Capacity Type Swapping Switches.

Specify one of the following options:
  • OFF - The capacity swapping algorithm will be not applied before matching.
  • ON - The capacity swapping algorithm is applied before matching.
ON
Consider Partial Groups When switched ON, the group optimizer will be in effect, and partial groups will also be considered. Partial groups of bookings will have either a common origin or a common destination, and are within 30 minutes in time.

The group optimizer will attempt to minimize the number of runs required to service each partial group. This feature can require significantly more computational time, however, depending on the number of partial groups.

OFF
CRC Log Mode

Specifies whether cyclic redundancy checking (CRC) logging is enabled for detecting, analyzing, and debugging unexpected deviations in batch scheduling results. Specifically, if you run a batch schedule, return all trips to the state they were in before the batch (for example, unschedule all trips), and then run the batch again with the exact same parameters, one would expect the second batch to produce the exact same result as the first batch, assuming no other changes were made to the trips.

However, sometimes a batch may produce a different result than expected. Using CRC logging during batch scheduling records a CRC number for each booking in the batch that represents the solution chosen for that booking. The batch can then be re-run so that Schedule Server reads the CRC log, instead of writing to it, and compares the recorded CRC to the CRC calculated for each booking solution in the new batch. If the CRC numbers are different, it means that a different booking solution was chosen than the last time, which causes the batching process to stop, thereby leaving the offending booking unscheduled, and the offending booking details are traced to the log. These traces are used by a Trapeze developer to analyze or debug the solutions suggested for that booking.

Specify a CRC log mode:
  • 0 - OFF
  • 1 - Record
  • 2 - Read and Compare
0
CRC Log Options When CRC Log Mode is set to 2, this switch determines which comparison criteria will be used:
  • 0 - Log all solutions set differences.
  • 1 - Log change in top insert’s run or position on run.
0
CRC Log Stop on BookingId

When the CRC Log Mode is set to 2, the batch will stop after it has scheduled this bookingId and this booking's solutions will be displayed in the log.

To log all booking IDs, set this value to 0 (default).

0
Dump Batch Sort Order

Specifies whether the sort order of the trips in the batch are dumped to a text file called batchorder.txt and located in the application's startup directory.

Specify one of the following options:
  • OFF - The sort order of the trips in the batch will not be dumped to a text file.
  • ON - The sort order of the trips in the batch will be dumped to a text file called batchorder.txt located in the application’s startup directory.
OFF
Dump Batch Sort Order to DB

Specifies whether the alternate group optimizer sort order will be dumped to the log.

Specify one of the following options:
  • OFF - The alternate group optimizer sort order will not be dumped into the log.
  • ON - The alternate group optimizer sort order will be dumped into the log.
OFF
Group Optimizer Run Cutoff Threshold

Specifies the maximum of number of bookings in a row that fail to be scheduled to the current run before the Group Optimizer moves on to the next run. This feature is useful for saving time when scheduling very large groups that cannot all fit on to one vehicle anyway. To disable this switch, set the value to 0.

10
Match driver and vehicle assignments If ON then the driver and vehicle assignments will be copied over during matching for runs. OFF
Match Trips by Validity Dates

Specifies whether the InfoFromDate and InfoToDate will be cross-checked against the schedule’s live date when matching from template schedules to live schedules. If the dates do not match, the match will fail for the trip and it will remain unscheduled.

Specify one of the following options:
  • OFF - The InfoFromDate and InfoToDate fields will not be cross-checked.
  • ON - The InfoFromDate and InfoToDates will be cross-checked against the schedule’s live date.
OFF
Output All to PassAgentLog If ON then all batch statistics are output to the PassAgentLog table, even those batches not started from the Batch Schedule Agent. OFF
Periodic Save Cycle

Specifies how often the batch will save its results to the database each time it modifies this many runs since the last save. The default value is zero.

To allow the schedule server to auto-select the cycle size, set the value to 0 (default).

To disable this switch, set the “Periodic Save Rule” switch to 0.

0
Periodic Save Rule

Specifies how often to save batch results to the database.

Specify one of the following options:

  • 0 - Off
  • 1 - Always on
  • 2 - Always on for same and future days
  • 3 - Auto on. Same as (2), plus turns on for other schedules whenever their batch is interrupted.

To define the cycle size, see the “Periodic Save Cycle” switch.

3
Preempt Resume Delay Specifies how long, in milliseconds, the batch should pause for before resuming after it is preempted by another client request. A single client request for the same schedule can preempt the batch for the length of the client request. The resume delay is designed to keep the batch paused a bit longer after the client request finishes to allow any additional pending client requests to execute without having to re-pause the batch (pausing can take time because it requires the batch to save its current results to the database.) A good value for this switch would be between 1000 to 5000 milliseconds. 2000
Reschedule Bumped

Specifies whether trips that are bumped during the batching process will be automatically rescheduled. If they cannot be rescheduled, they will be unscheduled.

Specify one of the following options:
  • OFF - Do not automatically reschedule or unschedule bumped trips.
  • On - Automatically reschedule bumped trips, or unschedule them if they cannot be rescheduled.
ON
Sort Auto-Groups

Specifies whether trips that are bumped during a batch will be automatically rescheduled. Any trips that cannot be rescheduled will be unscheduled.

Auto-groups are those that are not tagged with a group code, but are a group of people who happen to be travelling to and from the same coordinates at the same time. When enabled, this switch will see to it that the auto-groups are included in the group sorting for the batch sort order irrespective of whether or not the Group Optimizer is enabled. Works in tandem with the “Consider Partial Groups” switch.

Specify one of the following options:
  • OFF - Disable this feature.
  • ON - Automatically reschedule trips that are bumped during a batch.
OFF
Sort10 - Merge Nearby Groups

Specifies whether a location, if within the Radius around group location setting, will be merged with the location with higher number of visits.

Specify one of the following options:
  • OFF - Disable this feature.
  • ON - Merge locations with other nearby locations that have a higher number of visits.
ON
Sort10 - Min Visits Per Group Specifies the minimum number of pick-ups/drop-offs at a particular geocode in order to consider them as a cluster of trips that are sorted contiguously by batch sort order 10. 5
Sort10 - Radius around group location Specifies the distance, in metres, around a group location that will encompass nearby non-group trips that get sorted after all group trips of that location by batch sort order 10. 500
SortPeakPeriodHistogramSize Specifies the size of the periods in minutes used by the batch sort to calculate a trip count histogram by time of day. Used to determine an AM and PM peak time period. 30
SortPeakPeriodSize Specifies the size of the periods in minutes used by the batch sort to calculate the relative distance of a trip's time period from either the AM or PM peak time period. 30
SortTimePeriodOffset Specifies the offset of the time period used by the batch sort (added to the hour in minutes). 30
SortTimePeriodSize Specifies the size of the time period used by the batch sort process in minutes. 60
SortTravelPeriodSize Specifies the size of the time period, in minutes, used by the batch sort. 60
Stop after n bookings

Specifies the size of the travel time period (in minutes) used by some of the batch sort orders.

To allow the batch to determine the ideal period size on its own, set this value to 0 (default).

0
Stop Batch At BookingId

Specifies whether to stop the batch after the specified number of bookings. For testing and analysis only.

To disable this switch, set the value to 0 (default).

0
Test Search Only

For analysis purposes, you may wish to stop the batch just prior to the scheduling of a particular booking. This way, you may then schedule it in the schedule booking wizard to ascertain why a particular solution is chosen.

To disable this switch, set the value to 0 (default).

0
Thread Priority Low

For testing only - the batch will search for solutions for each booking but not actually insert the solution. Can be used to identify bookings that cannot be scheduled.

Select one of the following:
  • OFF - Disable this feature.
  • ON - The batch will search for solutions for each booking but not insert the solution.
OFF
Trace Batching Specifies whether batch threads are run at 1 point below normal Win32 thread priority. This setting yields better performance for other applications running on the same machine during a lengthy batch. It is particularly useful when running single machine Trapeze installations (such as on a laptop.) Not recommended for live server installations.
Specify one of the following options:
  • OFF - Do not run batch threads at 1 point below normal Win32 thread priority.
  • ON - Run batch threads at 1 point below normal Win32 thread priority.
OFF
Trace Group Optimizer

Specifies whether to create a booking-by-booking performance output during a batch.

Specify one of the following options:
  • OFF - Do not create a performance output during a batch.
  • ON - Create a booking-by-booking performance output during a batch.
OFF
Trace Group Optimizer Report

Specifies the trace level if tracing is enabled for the Group Optimizer.

Specify one of the following options:
  • 0 - Disable tracing of the Group Optimizer.
  • 1 - Display error messages only.
  • 2 - Display only warning messages.
  • 3 - Display only messages.
  • 4 - Display verbose (detailed) messages.
1
Trace Matching

Switch specifies the trace level for the batch-matching algorithm. For details on a booking-by-booking basis, set this switch to “Verbose.”

Specify one of the following options:
  • 0 - Disable tracing of the batch process.
  • 1 - Display error messages only.
  • 2 - Display only warning messages.
  • 3 - Display only messages.
  • 4 - Display verbose (detailed) messages.
1
Trace Run Statistics

Specifies whether the statistics of each run at the end of the batch are also traced to the log file.

To use this switch, the “Trace Statistics” must also be set to “ON”.

Specify one of the following options:
  • OFF - Batch statistics will not be traced to the log file.
  • ON - Batch statistics will also be traced to the log file.
OFF
Trace Statistics

Specifies whether information about the current batch plus the batch results will be traced to the log.

Specify one of the following options:
  • OFF - Do not trace information about the current batch to the log file.
  • ON - Information about the current batch and its batch results will be traced to the log.
OFF