Attribute Name

Type

Field Size

Description

Required

ScheduleID

int

4

Unique Identifier of the Schedule record.

Required

ScheduleKey

nvarchar

50

Business key to identify the activity this Schedule refers to.

Required

ScheduleTemplateKey

nvarchar

50

Business key to identify the Schedule template this Schedule refers to.

Required

RoutingParameterKey

nvarchar

50

Business key to identify the Routing parameter this Schedule refers to. Must exist on the FWRoutingParm table.

ModifiedBy

int

4

See ModifiedBy.

ModifyDate

datetime

8

See ModifyDate.

CreatedBy

int

4

See CreatedBy.

CreatedDate

datetime

8

See CreatedDate.

Comment

nvarchar

500

See Comment.

Name

nvarchar

50

Schedule Name

Type

tinyint

1

Schedule Type. Values:

·        1 = Reservations

·        2 = Planning

·        3 = Execution (important for AVL and execution type of schedules. If type 3, then GPS and Status messages will apply to schedules of this type only)

·        4 = Simulation

State

tinyint

1

Valid Values: (default = active when created - Inactive when copied)

·     1 = Active &endash; An active schedule could have active, test, and cancelled routes and stops.

·     2 = Test &endash; A test schedule cannot have any active routes or stops. This is strictly used for temporary optimizations.

Required

Status

tinyint

1

The value in the Schedule template record can be copied over here unless it’s set explicitly by a user. Valid Values:

·        0 = Open

·        1 = Closed

·        2 = Reservation Open

·        3 = Reservation Closed

·        4 = Planning Open

·        5 = Planning Closed

·        6 = Dispatch Open

·        7 = Dispatch Closed

ScheduleStartDate

datetime

8

The format of the date is yy:mm:dd:hh:mm:ss. This date is used to restrict any routes and stops that are not after the schedule start date.

Required

ScheduleEndDate

datetime

8

When specified must be in yy:mm:dd:hh:mm:ss. This date is used to restrict the inclusion of all routes and stops if their end dates are not within the schedule date. If not specified, all future routes and stops is accepted.

ConsolidateStops

smallint

2

This attribute provides the ability to check time windows for the first stop only when there are multiple stops at the same location with identical time windows. If the first stop meets its time windows, then all of the subsequent stops will also meet their time windows.

Note―  Only stops with identical time windows can be consolidated. Stops with different time windows, even if they overlap, will always be evaluated independently.

Current values are:

·     0 - Do not consolidate any jobs. All stop time windows are checked individually regardless of the AllowConsolidation (stop) attribute value.

·     1 - Consolidate all stops. All stop time windows are consolidated regardless of the AllowConsolidation (Job) attribute value.

·     2 - Only consolidate stops with the AllowConsolidation (stop) attribute set to True (1).

CountStops

smallint

2

This attribute is used to enforce the MaxStops attribute functionality on the route record.

Currently the CountStop attribute supports two possible values as follows:

·     0 - False - Ignores the MaxStops attribute on the route table and continues to assign stops past the maximum setting.

·     1 - True (default) - Uses the MaxStops attribute on the route table to flag the route and affected stops as being in violation when the MaxStops value is exceeded.

Note―  For more information about how Scheduler determines a new stop, please reference the NewStop (Scheduler) definition.

IgnoreTerritoryInd

bit

1

This attribute is used to disable the Territory attributes on the route and stop records. When this attribute is enabled, the route and stop territories is ignored.

NewStop

smallint

2

The NewStop attribute determines what constitutes a new stop. Each activity is associated with one or more stops, and each stop has a location. It is worth noting that starting and ending depot locations are not considered Stops.

Valid values for the same location:

·     0 - Every stop is always a new stop.

·     1 - Every stop for a different location key is a new stop. Stops for the same location key are assigned the same Stop number.

·  2 - Every stop for the same latitude and longitude, even for different location keys, is assigned the same stop number.

·     3 - Stops for locations within the route’s MinTravelDistance (in meters) setting are considered the same stop regardless of location key values.

NumberOfMeasures

smallint

2

Determines the maximum number of measures used for capacity violation calculations.

Maximum allowed is 9.

Required

PreferredResourceWarningInd

smallint

2

Determines whether the PreferredResource attribute on the stop table triggers warnings or violations. If false (0) &endash; all stops must be assigned to their preferred resource or not serviced at all. If true (1) &endash; The preferred resource setting on the stop is considered but is not limited to that resource and can be serviced by other resources.

RechargeInd

bit

1

This attribute is used to disable the recharge capability of all depots that have recharge capability.

ServiceViolations

int

4

Valid values: 0, 1 and 2.

Determines rmpi handling of time, capacity, and distance when representing Schedule Violations.

·     0=Resources will ignore stops that cannot be served, driving from the last servable stop directly to the next servable stop. There is no impact to capacity or the number of stops.

·     1=Resource will drive to the location of the task or job that cannot be served, but will not spend time there. There is no impact to capacity or the number of stops.

·     2=Resource will drive to the location of the task or job and spend the time that would be required to serve the stop. Capacity is consumed and the number of stops is increased as if the stop had been served.

UseHardWindows

smallint

2

Valid values: 0, 1 and 2.

Determines rmpi handling of Jobs’ WindowLatestTime values.

·     0=Job must be started by WindowLatestTime

·     1=Job must be completed by WindowLatestTime

·     2=Handling is determined by Job. WindowType value (field determines Job-specific settings for UseHardWindows on individual basis, if applied)

·     3=Handling is determined by the job’s location time and order date

UsePreferredResource

smallint

2

Valid values: 0, 1 and 2.

Determines how rmpi uses Job.PreferredRoute and Job.RestrictPreferredRoute values during optimization.

·     0=Ignores Job.PreferredRoute attributes and overrides Jobs.RestrictPreferredRoute attributes. Equivalent to selecting all jobs and setting RestrictPreferredRoute to false (0).

·     1=Uses Job.PreferredRoute attributes and overrides Job.RestrictPreferredRoute attributes. Equivalent to selecting all jobs and setting RestrictPreferredRoute to true (1).

·     2=Use Job.PreferredRoute attributes on jobs that have Job.RestrictPreferredRoute set to true (1).

UseRoadDistance

smallint

2

Valid values: 0 and 1.

Determines if Router uses along-road distances or approximate distances when evaluating the schedule.

·     0=Use straight-line distances.

·     1=Use along-road distances.

UseRoutePosition

smallint

2

Valid values: 0, 1, and 2.

Determines how rmpi uses Job. [Type]RoutePosition and Job.RestrictRoutePosition values during Optimization.

·     0=Ignores Job. [Type]RoutePosition attributes and overrides Job.RestrictRoutePosition attributes. Equivalent to selecting all jobs and setting RestrictRoutePosition to false (0).

·     1=Uses Job. [Type]RoutePosition attributes and overrides Job.RestrictRoutePosition attributes. Equivalent to selecting all jobs and setting RestrictRoutePosition to true (1).

·     2=Uses Job. [Type]RoutePosition attributes on jobs that have RestrictRoutePosition set to true (1).

UseTimeWindows

smallint

2

Valid values 0, 1, and 2.

Determines how rmpi respects Window EarliestTime or LatestTime values.

·     0=Apply any job time windows. Otherwise use customer/depot time windows.

·     1=Apply customer/depot time windows only. Ignore any job time windows.

·     2=Ignore all Job or Customer.Window[X] settings. Only apply Resource.Earliest/LatestStartingTime or Earliest/LatestServiceTime values.

AutoAssignCloseOrderInd

bit

1

Valid values: 0 and 1.

Determines if close jobs are automatically assigned to a single resource.

·     True (1) = When Optimizer assigns a job, it automatically assigns all jobs at that stop to the same resource regardless of violations. What constitutes a new stop is determined by the NewStop schedule setting. This can speed up the Optimizer run time, but there can be a noticeable delay before Optimizer begins assigning jobs.

·     False (0) = Optimizer will assign one job at a time. If there are multiple jobs for the same customer, Optimizer will usually, but not always, put all of these jobs on the same resource.

AssignUnassignedOrdersInd

bit

1

Valid values: 0 and 1.

·     True (1) = Optimizer will run the Assignment Process and attempt to put unassigned jobs onto resources.

·     False (0) = Optimizer will not run the Assignment Process. Useful when you are running the Improvement Process only and do not want to assign any of the remaining unassigned jobs.

DistanceAssessmentInd

int

4

Valid values: 0, 1, and 3.

Determines whether Router uses along-road distances or approximations.

·     0 = Always use Router setting; Use schedule's UseRoadDistance setting.

·     1 = Use "straight line" for entire run; Always use straight-line approximations.

·     3 = Use "straight line" for entire run, then final pass with "road distance". Use straight-line approximations throughout. After optimization is complete, if the schedule's UseRoadDistance setting is true (1) and the IntraRouteOptimization setting is true (1), then runs a final intra-route pass with full road distances.

Note&emdash;  Leave at 0 unless instructed by Descartes.

DynamicZoningInd

bit

1

Valid values: 0 and 1

Allows Optimizer to make appropriate geographic decisions based on the current set of orders in the system. Unlike "static" zones (which must be pre-determined in the data set using the "Zone" attributes), Dynamic Zoning allows the set of Resources/Jobs allowed for any given optimization to change over time based on the current assignment of jobs.

·     True (1) = Enable Dynamic Zoning.

·     False (0) = Disable Dynamic Zoning.

ExchangeRouteInd

bit

1

Valid values: 0 and 1

Determines if Optimizer will attempt to swap entire routes between resources.

·     True (1) = Optimizer will attempt to swap entire routes between any pair of eligible resources (in accordance with zone files, capabilities, etc.). Useful when resources have different cost structures (such as different driver pay) or are based at different depots.

·     False (0) = Optimizer will not attempt to swap entire routes.

IgnoreEmptyRoutesInd

bit

1

Valid values: 0 and 1.

Determines if resources without assigned jobs are considered during inter-route swapping. 

·     True (1) = Optimizer will only consider resources that already have jobs assigned.

·     False (0) = Optimizer will consider all resources.

InterRouteChainSize

int

4

Maximum number of jobs Optimizer can move as a group within a route during InterRoute Optimization. Recommend setting of at least 10% of the average number of stops per route, and at least 20% if the jobs are double-ended.

Note― Larger values give longer running times, and often, but not always, better results. Larger values are recommended if the jobs are double-ended, or the routes are large.

InterRouteOptimizationInd

bit

1

Valid values: 0 and1

Determines if Improvement Process attempts to optimize each route individually by running InterRoute Optimization (swapping between available routes, based upon swapping settings).

·     True (1) = Runs InterRoute Optimization.

·     False (0) = Does not run InterRoute Optimization.

IntraRouteChainSize

int

4

Maximum number of jobs Optimizer can move as a group within a route during IntraRoute Optimization. Recommend setting of at least 10% of the average number of stops per route, and at least 20% if the jobs are double-ended.

Note― Larger values give longer running times, and often, but not always, better results. Larger values are recommended if the jobs are double-ended, or the routes are large.

IntraRouteOptimization

bit

1

Valid values: 0 and 1

Determines if Improvement Process attempts to optimize each route individually by running IntraRoute Optimization (swapping within a route, based upon swapping settings).

·  True (1) = Runs IntraRoute Optimization.

·  False (0) = Does not run IntraRoute Optimization.

MaxAssignedBetweenIntra

int

4

When non-zero, during the Assignment Process, Optimizer runs an IntraRoute Optimization pass every time the specified number of jobs is assigned to a route.

For example: If setting is 10, IntraRoute Optimization runs after Optimizer has assigned 10 jobs, 20 jobs, 30 jobs, etc.

If you have a tightly constrained problem, such as narrow time windows or capacity constraints, using this setting can help generate better assignment answers. Slows down Assignment Process.

MaxTimeWindowWait

int

4

This attribute is used determine how long a resource will wait for the time window to open at a given stop. It is set in seconds.

MaxUnservedOrders

int

4

Maximum number of unserved jobs that can be assigned. A value of -1 places no restriction on unserved jobs. This is an approximate setting. Under certain conditions generally related to cost structure, the Optimizer can assign more unserved jobs.

Merges

smallint

2

Valid values: 0 and 1

Determines if Optimizer attempts to merge routes to create a single route.

·     True (1) = Optimizer will attempt to merge two routes if the resulting route would have a total length less than the MergeThreshold (see below).

·     False (0) = Optimizer will not attempt to merge routes.

Note―  Merging should only be used when routes are small.

MergeThreshold

int

4

Maximum route length that can be created by merging two routes. See Optimization.Merges (above).

Note― When set to 0, Optimizer will not attempt to merge routes. Merging should only be used when routes are small.

PreferredResource

smallint

2

Valid values: 0, 1, and 2.

Determines how rmpi uses Job.PreferredRoute and Job.RestrictPreferredRoute values during optimization.

·     0=Ignores Job.PreferredRoute attributes and overrides Jobs.RestrictPreferredRoute attributes. Equivalent to selecting all jobs and setting RestrictPreferredRoute to false (0).

·     1=Uses Job.PreferredRoute attributes and overrides Job.RestrictPreferredRoute attributes. Equivalent to selecting all jobs and setting RestrictPreferredRoute to true (1).

·     2=Use Job.PreferredRoute attributes on jobs that have Job.RestrictPreferredRoute set to true (1).

PreRouteInd

bit

1

Valid values: 0, 1, and 2.

·     True (1) = Optimizer uses pre-routing.

·     False (0) = Optimizer does not use pre-routing.

Note― Requires Version 7 maps and a valid file specified in the DistanceCacheFile setting. Should only be set to false (0) when the cache file contains all (or the vast majority) of the required road distances. In this case, pre-routing slows optimization slightly by wasting time determining that no routings are needed.

SeedDesiredAreaInd

bit

1

Valid values: 0 and 1.

Enables improved handling for seeding with multiple depots.

·     True (1) = Prevents usable seeds from being assigned to the wrong area.

·     False (0) = Does not affect assignment.

Note&emdash;  Especially useful in multi-depot settings where seed jobs might otherwise get assigned to a route with an inappropriate depot. Generally should be set to true (1) unless Assignment Process is producing bad answers.

SeedRouteInd

bit

1

Valid values: 0 and 1.

Seeding routes is the process of identifying the difficult jobs (jobs with tight constraints), and assigning these jobs ahead of easier jobs. The Optimizer can then try to fill in around the difficult jobs.

·     True (1) = Optimizer seeds routes.

·     False (0) = Optimizer does not seed routes.

SeedZonedOrdersInd

bit

1

Valid values: 0 and 1.

Determines if seeding is restricted to zoned jobs.

·     True (1) = Restrict seeding to zoned jobs. Un-zoned jobs are never used as seeds.

·     False (0) = Allow seeding with un-zoned jobs. Optimizer will never seed with more than one un-zoned job in a single pass.

Note― Should be set to true if all jobs are expected to be zoned. Should be set to false if there is a mix of zoned and un-zoned jobs.

SwapsToNeighborsInd

bit

1

Valid values: 0 and 1.

Limits InterRoute Optimization to swapping between Routes that are in close proximity. Can improve Optimizer performance.

·     True (1) = Optimizer will only examine pairs of routes that are close together.

·     False (0) = Optimizer will examine all pairs of routes, subject to zone definitions.

Note― Should be set to true (1) if zones are not well-defined. May miss swap opportunities if capacities are included.

SwapsToNeighborsPointsInd

bit

1

Valid values: 0 and 1.

Limits InterRoute Optimization to swapping Jobs that are in close proximity. Can improve Optimizer performance. Only used if RestrictSwapsToNeighbors is set to true (1).

·     True (1) = Optimizer will only examine pairs of jobs that are close together and on neighboring routes.

·     False (0) = Optimizer will examine all pairs of jobs.

Note― May miss swap opportunities if capacities are included.

SwapsWithinZoneInd

bit

1

Valid values: 0 and 1.

·     True (1) = Job swapping is limited to same zone only.

·     False (0) = Job swapping is controlled by the [Swaps] section of the zone file. If no Zone file, or no [Swaps], [NoSwaps] section defined in Zone file, all jobs are open for swapping between all capable available Resources.

UnassignUnservicedOrdersInd

bit

1

Valid values: 0 and 1.

Determines if jobs that cannot be serviced are removed from routes.

·     True (1) = After optimization is complete, Optimizer will remove jobs that cannot be serviced, leaving such jobs unassigned.

·     False (0) = Optimizer will not remove jobs that cannot be serviced. A non-serviced job is violation (visible in RoutePlanner in Red). Allows user to judge if the Optimizer's estimates are accurate.

UseCluster

smallint

2

Valid values: 0 and 1.

Turns clustering on and off. Clustering encourages the Optimizer to assign jobs that are near each other to the same route. Nearness is decided by a number of factors. Two jobs for the same client at the same location are usually near, as are two jobs for clients across the street from each other. Using clustering can speed up the Assignment Process. 

·     True (1) = Optimizer attempts to keep jobs that are near to each other on the same route.

·     False (0) = Optimizer does not cluster nearby jobs.

Note― Clusters can be used only if there are no more than 65,535 jobs. Clustering is known to cause issues with routing the following "genres" of Jobs, and should not be used for: Double-ended Job scenarios (JOB.JobType=1), Recharge scenarios, Redispatch Scenarios, Multi-Task Job scenarios. Use AutoAssignCloseJobs to put all jobs for a single customer on the same route regardless of whether they are served.

ViableOrdersInd

bit

1

Valid values: 0 and 1.

·     True (1) = Jobs will not be assigned if they cannot be served by any resource.

For example: a job is excluded from assignment if (a) its time window cannot be met by any resource; (b) its volume is greater than the capacity of any resource; (c) no resource can drive directly from the pickup to the delivery and still meet the delivery time window; or (d) none of the resources have the capabilities required for the job.

·     False (0) = Optimizer will assign jobs even if they violate rules. You may want to assign such jobs if you do not completely trust the data, or if the constraints in the problem were not absolute.

ZonableOrdersInd

bit

1

Valid values: 0 and 1.

·     True (1) = Jobs that have a zone that cannot be served by any resource will not be assigned.

· False (0) = All jobs are assigned, even in violation of zoning rules. 

Note― If true (1), jobs with blank zones will not be assigned to any resource. If any resource has a wildcard zone (*), then every job can be served by that resource, so this setting is effectively ignored. If false, zones are still preserved as much as possible.

ZoneFile

nvarchar

255

Entry should contain path and filename of rmpi Zone file (.LZA file) that contains any or all Zone definitions and/or [Swaps][NoSwaps] rules. Can be left blank or omitted if not used.

UseCandidateList

smallint

2

Determines if the Optimizer uses candidate lists, which can speed up the Assignment Process.

·    True (1) = Optimizer uses candidate lists.

·    False (0) = Optimizer does not use candidate lists.

Note&emdash;  Candidate lists introduce an element of randomness into the Assignment Process. Re-running optimization on the same data set can yield different answers.

DynamicZoningDistance

float

8

Radius (in meters) around Job or Route (See DynamicZoningEntireRoute below) that determines distance threshold for inclusion in DynamicZoning.

DispatchMode

bit

1

Determines a new schedule’s DispatchMode setting.

Required

UseRmpiAdvise

bit

1

This field will determine what advise engine to use. Valid values:

·        0 = false, use adapi

·        1 = true, use rmpi

Rmpi advise is slower when higher volume of orders are required.

Default value is 0.

ImprovementThreshold

float

8

During the Improvement Process, Optimizer will not consider any route change if the net profitability improvement is smaller than this number. Default setting of approximately 0.1 allows Optimizer to find improvements that save miles while ignoring changes that save feet.

Note&emdash;  Smaller numbers may mean longer run times.

UseTerritoryAssignment

int

4

This field is used to determine when a schedule should use the Territory polygon definition.

·        0 - Will not use territory polygon assignment/definition

·        1 - Will always use territory assignment. Use when data is imported using business documents, this value will allow data imported into this schedule to be assigned a territory based on the Territory Definition

·        2 - Assign territory only if territory is null. This value will assign a territory to orders imported into this schedule only when their territory field value is null

MaxSuggestions

int

4

Maximum number of suggestions returned in suggest calls

MaxSuggestPerRoute

int

4

Maximum number of suggestions returned per route

MaxOptRunTime

int

4

Maximum optimization time. This field limits the optimization running time.

MinAssignmentProfit

float

8

Minimum incremental profit that a job must provide in order to be assigned. Number set too small may allow for job violations to be assigned. Number set too high will run longer and may lose potential negative net Job profit assignments, even when net Route profit is positive.

Note&emdash;  A value of zero (0) will usually, but not always, keep all unserved jobs from being assigned.

Default value is -10000

LowLevelReroute

int

4

Valid values:

·    0 = Never use Low-Level Rerouting

·    1 = Use Low-Level Rerouting when normal routing fails

·    2 = Always use Low-Level Rerouting.

Low-Level refers to the layers (or levels) of Road Classifications within the .LMB Map File Road Networks.

ThirdPartyDistanceEngine

int

4

Engine to use for distance calculation.

StartRouteWGPS

bit

1

Valid values:

·        1 - any GPS message that arrives first for a route is marked as dispatched.

·        0 - a route is marked as dispatched ONLY when the first status message with explicit status code 5 (DISPATCHED) is received.

UseAutoPublish

bit

1

This field will allow users to set this schedule to use the Autopublish routes functionality defined in the AVL parameters for this schedule.

0 &endash; Do not use Autopublish

1 &endash; Use Autopublish

AccountName

nvarchar

1

Account name for Autopublish functionality. This value will be included in the published xml

ConnectionType

nvarchar

255

Type of connection to publish data from FW.

Supported Connection Types

- FTP

- HTTP

- Local Path

LocalPublishPath

nvarchar

255

Type of connection to publish data If the connection type is Local Path, this field will store the directory path where files will be published.

SenderID

nvarchar

255

This field holds the SenderID value to publish in the xml. Normally used to identify where the data is sent from.

ReceiverID

nvarchar

255

This field holds the ReceiverID value to publish in the xml. Normally used to identify where the data is sent to.

FTPURL

nvarchar

255

This field stores the ftp address for publishing data

FTPUserName

nvarchar

255

This field stores the User name for the ftp connection

FTPPassword

nvarchar

255

This field stores the Password for the ftp connection

HttpURL

nvarchar

255

This field stores the HTTP url used to publish data

CalculateProfileCost

bit

1

This field allows FW to calculate costs of routes based on Cost Profiles.

0 &endash; Off

1 &endash; On

TerritorySwapKey

nvarchar

50

This field stores the name of the Territory Swap logic in FW

MaxRechargeDepotsToTry

int

4

This field stores the maximum number of recharging locations to try when evaluating recharges

InfeasibilityTaggedConstraints

int

4

This field will allow Rmpi to impose a large penalty whenever any of the supported constraints gets violated.

• The following character codes will apply InfeasiblePenalty for:

• C - for Capacity

• D - for Maximum Distance

• S - for Maximum Stops

• R - for Requirements

• T - for Resource Time Window

• W - for Task Time Window

• Q &endash; for Route Position Violation

• M &endash; for Commodity Constraints

SkipInitialLoadTime

bit

1

Whenever users have double ended jobs where pickups take place at the initial station of the resource and do not want to consider either the location or order service durations just for the pickup portion, then this flag needs to be set to 1.

0 &endash; Default Value. It will consider service durations of pickup portion taking place at initial station of resource of Double ended orders

1 &endash; Will skip service durations of the pickup portion of a double ended order when it takes place at the initial station of the Resource.

RtePosWithLockInd

bit

1

This field indicates if a Route Postion should be set to the order when a route is locked.

0 &endash; Do not set Route Position when locking

1 &endash; Set the Route position when locking

ReschePartialComplOrd

int

4

This field indicates whether or not to allow rescheduling of multi-task orders (double or multi task job orders) when only a portion of this order has been completed.

No &endash; Do not allow rescheduling on partially completed orders

Yes &endash; Allow rescheduling of orders that have been partially completed

InfeasibilityPenalty

nvarchar

Penalty only used in combination with the Infeasible constraints checked on in this section.

UseSchedPublishingSettings

bit

1

Enable or disable publishing at the schedule level.

• If turned on in the schedule and null for the resource, initial load time skipped for the resource.

• If turned on in the schedule and off for the resource, initial load time will not be skipped for the resource.

• If turned off in the schedule and turned on for the resource, initial load time will not be skipped at all.

• If the schedule setting is null, SkipInitialLoadTime is off for the entire schedule.

AllowEmptyStart

bit

1

Enables Resources to start empty and allows them to load at their home or remote location. To activate this functionality on a schedule, the AllowEmptyStart property must be set to ”r;1”.

ForceEndRouteInd

bit

1

Force the end of route even if pending stops are still present in the route.

SameStopSlots

int

4

Encourages the return of the same slots if there is already a stop in the same location as the requested advise

TurboAdvise

bit

1

Indicator for turbo advise is used when it is true

TurboAdviseMaxRoutesPerDay

int

4

Maximum number of routes per day to be considered for turbo advise

TurboAdviseStemDistance

float

8

Radius from the order where available routes will be considered for turbo advise

UseSchPublishingSettings

bit

1

Use schedule publishing settings instead of application publishing settings

AllowEarlyRecharge

bit

1

Enables opportunistic recharge

RequirementsMatchBonusFactor

float

8

Multiplier ranging between 0 and 1 which, when multiplied to an order’s profit, produces a bonus profit to be added to a route profit. The bonus gets effective only when the order’s requirements are met by the resource’s capabilities. Default is 0.01.

UpdateDropoffQtyWActualPUQty

bit

1

Update dropoff measures with actual pickup measures

DefRescheduleKey

nvarchar

50

Default scheduleKey when a reschedule is called without a destination scheduleKey

SetStatRechOnDisp

bit

1

When this is enabled, all dynamic recharge will be converted to static recharge when dispatched

MaxDistanceFromDepot

float

8

Maximum as-the-crow-flies distance away from initial depot of resource

PUComplexSeq

int

4

This field allows users to specify to RMPI the sequence of pickups for double-ended jobs at the same depot based on the delivery sequence:

null: Last in, first out (LIFO)

1: Last in, first out (LIFO)

2: First in, first out (FIFO)

SetBegunToArrived

int

4

Values:

null or 0: flag is ignored (default)

1: Set Begun = Arrived Timestamp

Disable AutAssign/Optimize All

int

1

This setting has two options.

• Disable Optimize/AutAssign All: When selected, the Optimize All and Auto Assign All options will be hidden from right-click menus.

• Disable Optimize/AutAssign All/Selected: When selected, the following options will be hidden from right-click menus:

• Optimize All

• Auto Assign All

• Optimize Selected on the Unassigned Stops quadrant

• Optimize Selected, when more than one non-frozen routes are selected on the Route Summary page or Route Detail quadrants

• Optimize Selected, when multiple unassigned stops are selected on the map or multiple non-frozen routes are selected on the Map quadrant

• Auto Assign on the Unassigned Stops quadrant or when multiple unassigned stops are selected on the Map quadrant

UseCallOutNotifyInd

int

4

This field will activate or deactivate Callouts/Notifications for this org

0: use the higher level setting

1: use the local setting

2: do not call

CallOutNotifyProfileId

int

4

This field will identify the primary key of the Callout/Notification Profile to use

UseAVLInd

bit

1

If it’s 0, the following steps are omitted from wireless message processing:

·        AVL status update

·        Actual distance/time update.

RouteAsCommercialTruck

bit

1

Supports integer entries as follows:

0: Passenger Vehicle

1: Straight Truck

2: Articulated Truck

MeasureLimitsOnLocations

bit

1

When enabled, performs a capacity check at each delivery location to ensure weight and security restrictions are met.

UseAutoPublish

bit

1

Enables autopublishing for the associated schedule.

ViolationPenaltyFromProfitFactor

float

8

(default value of 0.0) This field accepts a value between 0.0 and 1.0:

When set to 0.0, no additional penalty is incurred (missed time window violations, excessive number of stops and stop order will each have their own penalty factors)

When set to 1.0, all profit is added on as an additional penalty (missed time window violations, excessive number of stops or stop order will each have their own penalty factors)

When set to 0.5, all profit is added as an additional penalty equal to half the task profit. Essentially, the profit for that stop increases by (1 - 0.5), multiplied by the task_profit.

IgnoreServiceProfitOnViolation

bit

1

When enabled, regardless of the value of the Violation Penalty From Profit Factor field, violated stops will not contribute profit and no additional penalty is picked up other than missed time window violations, excessive number of stops or stop order issues. When disabled, the task profit is incurred completely for stops in violation.

MinInterstopTravelTime

int

4

This field allows Descartes Route Planner to handle ”r;Interstop” service time values from Descartes Route Planner RS.

ScheduleGroup

nvarchar

50

Each schedule group can be served by a dedicated instance of Descartes LNOS Pathing Service for best performance and utilization of computing resources.

OnEndRoute

int

1

• 0 or null: Do not apply

• 1: Set Missed to Pending Stops on End of Trip

• 2: Unassign Pending Stops on End of Trip. When set to 2, the system will unassign any pending or non-complete equivalent status stops of the route and then end the trip. This process will trigger a RMPI update.

ExternalRoadRouter

nvarchar

250

Map edit server URL used for RMPI routing.

AltExternalRoadRouter

nvarchar

250

Alternate map edit server URL used for RMPI routing.

BackhaulDynamicZoningDist

float

8

Provides distance entry for advise calls with LastNStopForDZ values. If Backhaul Dynamic Zoning Distance is not configured per schedule, the configured CtySysValue equivalent is used. If the distance value entered is zero or is not configured anywhere in the system, backhaul dynamic zoning logic is not included in advise filter.

SetTWtoGenTW

bit

1

When this setting is enabled, the system will replace existing time windows with generated time windows based on projected arrival and projected departure values.

LockGenTimeWindow

bit

1

Locks generated time windows in place so that, when this setting is enabled, the system will return a violation if users attempt to update time windows for a route that fall outside the initial values.

LockGenTimeWindow AllowanceX and LockGentimeWindow AllowanceY

int

4

Allows users to round down the Projected Arrival Time value to the closest hour within a configurable time interval (X) and round up to the closest hour within another configurable time interval (Y).

MaxDistanceFromCustomer

float

8

Maximum distance to path between any two customers. This setting only applies to customers using external pathing and is different from dynamic zoning. If both dynamic zoning and this setting are specified, the maximum distance between customers should be larger than the dynamic zoning distance; otherwise the optimizer will only plan routes for the lesser of the two.

OnEndRoute

int

4

• 0 or null: Do not apply

• 1: Set Missed to Pending Stops on End of Trip

• 2: Unassign Pending Stops on End of Trip. When set to 2, the system will unassign any pending or non-complete equivalent status stops of the route and then end the trip. This process will trigger a RMPI update.

AutoPublishLock

bit

1

When enabled, this setting will lock the route when the autopublish command XML is sent from Descartes wGLN. By default, the Use Auto Publish Lock setting is disabled.

DisplatchBGO_FreezeWindow

Size

int

4

Using the time value (N) entered in this field, any improvement that would assign an order within the next ’r;N’ minutes will be rejected so as to avoid infeasible routes being created when running an execution BGO

DispatchBGO_MinStopsToFreeze

int

4

Using the stops value (N) entered in this field, any improvement that would assign an order to the next ’r;N’ stops will be rejected so as to avoid infeasible routes being created when running an execution BGO

DispatchBGO_AllowDelivery

Swap

bit

1

When enabled, this setting allows the BGO to swap orders between routes in an execution schedule.

CreateReturnOnMiss

bit

1

With this setting is enabled, when a stop is marked as ”r;Missed”, the system creates a new order, which moves goods from the customer back to the depot

AllowPartialDelivery

bit

1

When enabled, allows multi-task orders to be delivered even if one of the pickups is missed

MaxEmptyRoutes

int

4

If Max Empty Routes is set, then the BGO can include up to this number of empty routes while searching for compatible used routes for batch assign.

SequenceSameStopShop

int

4

In cases where a customer has two orders at a stop, one pickup and one delivery, RMPI sequences the orders with the pickup first. With the SequenceSameStopJobs setting, users can modify the default behavior.

0: Disabled

1: Place Deliveries before Pickups by LocationKey

AMR_Enabled

bit

1

When enabled, the system will attempt to assign unassigned orders to routes generated from master routes before assignment to other routes.

TerritoryBase

int

4

TerritoryBase has the following options:

• Base Territory on Delivery

• Base Territory on Pickup

• Base Territory on Location: When this option is selected, an additional dropdown menu appears with a description field, allowing users to select a City, Country, LocationKey, Postal Code and various UDF fields to define the territory. Use the operators used in the filters to match the value.

MeasureToWeightFactor

float

8

Specifies a conversion ratio. The conversion needs to result in a weight in kilograms (kg).

MeasureForWeight

smallint

2

Specifies the measure to use for onboard weight calculations.

DynamicZoningEntireRouteInd

bit

1

When Dynamic Zoning Entire Route is enabled, all the stops on a route as determined by the DynamicZoningStrategy setting must be within the DynamicZoningDistance value of each other. So if DynamicZoningStrategy is set to include pickup and dropoff stops and not Initial and Final Depots (default setting) then all the pickups and dropoffs must be within the DynamicZoningDistance of each other calculated straight line.

When Dynamic Zoning Entire Route is disabled, each stop on a route, as determined by the DynamicZoningStrategy setting, must be within the DynamicZoningDistance value of one other stop on the route. So if DynamicZoningStrategy is set to include pickup and dropoff stops and not Initial and Final Depots (default setting) then all the pickups and dropoffs must be within the DynamicZoningDistance of at least one other pickup or dropoff, calculated straight line.

MaxNumberOfOrdersForOptAll

int

4

Allows users to set a maximum number of assigned and unassigned orders to be sent to RMPI via Optimize All. If a set of orders exceeds the set maximum, the system returns a warning message.

BulkRecharge

int

4

When enabled, RMPI will use incoming actual measures data from Descartes Mobile to calculate recharges forward for single-ended jobs.

MaxNumberOfRoutesForOptAll

int

4

Allows users to set a maximum number of routes to be sent to RMPI via Optimize All. If a set of routes exceeds the set maximum, the system returns a warning message.

StraightLineSpeed

bit

1

Used when RMPI cannot find a legal road to navigate from one point to another (m/s)