©2008 The Descartes Systems Group Inc.
Copyright and Trademark Notice
This table is used to represent a specific leg of an order (activity). An activity is a unity of work that can be performed at a specific location. Whenever a new order is created, at least one FWActivity record must be created. More than one activity record can be created and the number created is dependent on the incoming order type.
Create: Must be associated with a location and order records. The order type drives the number of activity records that need to be created. An activity cannot be created without an order being supplied and created.
For example: one activity is created for a pickup or drop-off order type. A pickup/drop-off order type will have two activities associated with it and both need to be created. Separate pickup and drop-off type activities is created.
In addition, at least one stop record will need to be created that links each activity to a specified schedule (PreferredScheduleKey) value. If a schedule is not specified, the stop is created to a DefaultSchedule that should always be available. For more stop creation information please see the FWStop descriptions.
Default: Many of the Activity attributes are derived or defaulted from other table values. There are two types of defaulting types: cumulative and override.
· Cumulative: The cumulative attributes are added or linked from values on other tables.
· For example: the measure amounts are added together and the total is represented on the activity record. The StopTemplate, Location, Order, and OrderLine measure amounts are added together and stored on the Activity record. This allows the user to define appropriate values at the different table levels: product, order, location, and template.
· Override: The override attributes get replaced with the value at a higher level.
· For example: the StopTemplate is the lowest level and its value will only be used if no other table has that specific attribute set. The override priority sequence from lowest to highest is: FWStopTemplate, FWLocation, FWOrderLine, and FWOrder.
The default value for the activity table attributes is referenced with either cumulative or override type functions unless otherwise specified.
|
Attribute Name |
Type |
Field Size |
Description |
Required |
|
|
int |
4 |
Unique internal DB Identifier of the Activity record. |
Required |
||
|
int |
4 |
Unique internal DB Identifier of the Order record. System assigned to the Order ID of the FWOrder OrderKey. |
Required |
||
|
nvarchar |
50 |
Business key to identify the Order this Activity refers to. System assigned to the Order Key of the FWOrder table. Must exist on the FWOrder table. |
Required |
||
|
nvarchar |
50 |
Business key to identify the activity this Activity refers to. Users may choose to identify individually every activity contained in the order by using this field. |
|
||
|
nvarchar |
50 |
Business key to identify the Stop template this Activity 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. |
|
| |
|
int |
4 |
System assigned during creation of an order. |
|
| |
|
nvarchar |
50 |
System assigned during creation of an order, but can be modified by the user. If this value is ever changed, the reset function needs to be performed so that the new location values are reflected on this activity. Note― If changed it will not automatically update the associated stops but the activity status attribute is changed to Modified. |
|
| |
|
nvarchar |
50 |
This field is used to identify different order types that may require different processes. For example: users can have pickup, drop-off, or pickup/drop-off orders, which may require different FWActivity records created. Valid Values: · DROPOFF &endash; (default value) a drop-off type is create when the order type is drop-off or pickup/drop-off · PICKUP - a pickup type is create when the order type is pickup or pickup/drop-off · SERVICE &endash; (currently not supported) a service type is create when the order type is service · RECHARGE &endash; (currently no supported) a recharge type is create when the order type is recharge · BREAK &endash; (currently not supported) a break type is create when the order type is break Note― If changed it will not automatically update the associated stops but the activity status attribute is changed to Modified. |
Required |
| |
|
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. Default is 1.0. |
|
| |
|
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). Default is False. |
|
| |
|
float |
8 |
This numeric value is added to the other Measure1-9 amount values supplied with the activity input function. At least one measure amount must be specified for Activities types: DROPOFF, PICKUP, and RECHARGE. These values are used to manage the resource capacity. Note― The MeasureFactors must be applied before the values are added together. |
|
| |
|
float |
8 |
This numeric value is used to adjust the actual corresponding measure amount. It is applied when the FWActivity Measures are created, but only for the OrderLine Measure portion. |
|
| |
|
int |
4 |
It represents the total service time in seconds. 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. Default is zero (0). When the ServiceRateMx and the ServiceFactorMx fields are used, the final calculated ServiceDuration for all line items will be saved in this field. This field is an internal FW Derived field. |
|
| |
|
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. Default is zero (0). |
|
| |
|
nvarchar |
50 |
If entered, this value must exist on the FWResource table. Default is order creation. Note― If the preferred resource record is not associated with the same schedule as this activity, then the preferred resource value is removed from the associated stop record and is ignored. |
|
| |
|
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 PreferredResourceKey on the FWActivity table and is ignored when if the PreferredResourceKey is empty. Default is False. |
|
| |
|
float |
8 |
This numeric value is added to the other profit values from the FWOrder and FWStopTemplate and FWLocation. |
|
| |
|
nvarchar |
255 |
This is a string value that is linked with the requirements for the FWOrder, FWStopTemplate, and FWLocation. Each value must exist on the FWCode table for type Requirements. A selection list should be provided where one or more requirements can be selected. See the StopTemplate for more details. |
|
| |
|
nvarchar |
255 |
This attribute holds the additional commodities at the order line level that is linked with the commodities from the Order, Stop Template, and Location tables whenever an activity is created. Each value must exist on the FWCode table for type Commodities. A selection list should be provided where one or more commodities can be selected. See the StopTemplate for more details. |
|
| |
|
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 Default is zero (0). |
|
| |
|
int |
4 |
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. Default is zero (0). |
|
| |
|
nvarchar |
50 |
When entered it must exist on the FWCode Table. Default is empty. |
|
| |
|
tinyint |
1 |
Currently 0 and 1 are the only values. 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. Default is zero (0). |
|
| |
|
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. Default is false. |
|
| |
|
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. Default is zero (0). Values from -1 to 1. |
|
| |
|
datetime |
8 |
Earliest date an item (or, resource carrying it) can leave the initial depot. If this is not supplied then the Schedule date is used with AvailableTime. If there are multiple PackageItems for a Job, the latest value for the PackageItems and Job is used for the Job. |
|
| |
|
datetime |
8 |
Earliest time of the day an item (or, resource carrying it) can leave the initial depot. If there are multiple PackageItems for a Job, the latest value for the PackageItems and Job is used for the Job. |
|
| |
|
bit |
1 |
Determines if job is limited to its PreferredRoute setting |
|
| |
|
bit |
1 |
Determines if a job is limited to its RoutePosition value. |
|
| |
|
int |
4 |
Designates whether or not this activity belongs to a master order. |
Required |
| |
|
float |
8 |
The amount of workload an order contributes toward the maximum allowed by a resource's work units |
|
| |
|
int |
4 |
Indicate it is hazardous material |
|
| |
|
bit |
1 |
Stores the original value of RestrictRoutePosition. in an unlocking of a route event, this value will be used to reset RestrictRoutePosition |
|
| |
|
int |
4 |
Stores the original value of RoutePosition. in an unlocking of a route event, this value will be used to reset RoutePosition |
|
| |
|
nvarchar |
255 |
All the productTypeKey from all the orderliness related to this activity |
|
| |
|
int |
4 |
Used to identify if this activity belongs to a Cross Dock Leg. Defaults are: <null> or 0 (zero). |
Required |
| |
|
|
|
Used to sequence pickup jobs for a multi-task order. Rank values must start at 0 and increase sequentially or the setting will be ignored. For example, "0,2,3" and "1,2,3" are not valid but "0,1,2" is valid. This only applies to multi-task orders. If it is not entered, backend will send -1 to rmpi so that rmpi will consider the sequence of the pickup by its engine. If the Rank is specified, then the pickup sequence will be determined by the Rank with lowest Rank value first. |
|
| |
|
nvarchar |
500 |
See Comment. |
|
| |