FWStopTemplate

The FWStopTemplate table is used to introduce the different stop record routing settings. When a stop template is specified, it provides many of the default settings needed by the scheduling engine. The order import function may have certain attributed already set which will take precedence over the stop template value. This provides a level of flexibility to override certain setting for a specific order without having to create a different stop template record for every possible setting combination. Please keep in mind that certain attributes are cumulative as apposed to overrides values.

Attribute Name	Type	Field Size	Description	Required
StopTemplateID	int	4	Unique internal DB Identifier of the Stop Template record.	Required
StopTemplateKey	nvarchar	50	Business key to identify the activity this Stop template refers to. Defaults to the StopTemplateKey of the FWOrder. If this value is ever changed, the reset function needs to be performed so that the new template values are reflected on this activity.	Required
ScheduleKey	nvarchar	50	Business key to identify the Schedule this Stop template refers to. If entered, it must exist on the FWSchedule table. A selection list should be provided.
ModifiedBy	int	4	See ModifiedBy.
ModifyDate	datetime	8	See ModifyDate.
Comment	nvarchar	500	See Comment.
CreatedBy	int	4	See CreatedBy.
CreatedDate	datetime	8	See CreatedDate.
DeliveryRatio1-9	float	8	This attribute is used to reclaim capacity. A value of 1.0 will reclaim the full measure amount. A value of 0.5 will reclaim 50% of the amount, and a value of 0.0 will not reclaim any of the amounts. This setting is only applicable if it is a DROPOFF or PICKUP type stop.
InterspersableInd	bit	1	This Boolean attribute is used to set the Interspersable indicator for the related stop records that came from a DROPOFF/PICKUP order type record. It indicates if other stops can be scheduled between the PICKUP and DROPOFF type stops for that order. It is not applicable to single leg order types (PICKUP or DROPOFF).
OnLoadPosition	tinyint	1	Use to explicitly specify first or last position on a route. Valid values: 0 = ignored 1 = must be first on load 2 = must be last on load
PreferredResourceInd	bit	1	This is a Boolean attribute that determines if the preferred route is restricted to the preferred route only. This attribute is dependent on the PerferredResourceKey on the stop table and is ignored when the PreferredResourceKey is empty. Note― The PreferredResourceKey is not defined at the FWStopTemplate level because it is almost always an Activity type attribute and a default setting would never be used.
Profit	float	8	This is a numeric attribute used to add additional profit to the already supplied profit at the order and location levels. Please note that it is cumulative and not an override value.
Requirements	nvarchar	255	This value can be used to set a universal requirement that will apply to all orders. Please note that this value is cumulative where it is linked to the order and location requirements. More then one value can be specified and needs to be delimited by a space. Each specific value must be validated against the FWCode table for type Requirements.
RoutePositionInd	bit	1	This value sets the priority of certain stops positioned before other stops. For example: Stops with RoutePosition set to 1 are sequenced before activities with RoutePosition set higher than 1. A value of zero can be sequenced in any order.
Type	varchar	50	This field is used to identify different stop template types that may require different processes.	Required
Territory	varchar	50	When entered, it must exist on the FWCode Table Type Territory. It is used as a default value for all stops.
AllowConsolidationInd	bit	1	This is a Boolean value used to override the AllowConsolidationInd on the Schedule optimization setting for a specific stop. If specified as default, and not overwritten by the order, all orders will have this setting.
PreServiceDuration	int	4	This integer value (in seconds) is added to the pre-service duration of the order, order lines, and location pre-service duration when the activity is created. See the service duration attribute for more details.
Status	varchar	50	This field is used to identify a different status of a given stop template over time. The current implementation is configured to support one status value ”r;DEFAULT.” As the application develops over time, additional statuses will follow.	Required
Commodities	varchar	255	This attribute is linked with the commodities from the Order, Order Lines, and Location tables. See requirements for details. Each specific value must be validated against the FWCode table for type Commodities.
ServiceDuration	int	4	This integer value (in seconds) is added to the service duration of the order, order lines, and location values service duration when the activity is created. Note― The ServiceDuration comes with two other attributes—pre-service and post-service duration—providing the ability to specify additional time before and after any service time. These attributes can be used for any wait, setup, or cleanup time needed for a given service. All three settings are independent of each other.
ProfitDepreciationPerHour	float	8	It is a percentage value that will depreciate the profit by the percentage value for every hour from the start of the route. It makes orders less profitable later in the route. Negative values are allowed and when specified will provide the opposite effect of making later stops more profitable.
SpecialHandling	tinyint	1	If you specify a value of 1, stops are ignored for Dynamic Zoning calculations; therefore an activity that is more than the DynamicZoningDistance from a special stop can still be inserted on the route. Routes that only contain special stops are considered empty and can be seeded.