Attribute Name

Type

Field Size

Description

Required

DataSetGroupID

int

4

Unique internal DB Identifier of the DataSetGroup record.

Required

DataSetGroupKey

nvarchar

50

Business key to identify the activity this DataSetGroup refers to.

Required

AreaKey

nvarchar

50

Business key to identify the Area this DataSetGroup refers to. Must exist on the FWArea table.

Required

Type

nvarchar

50

This attribute is assigned a specific string value by the user when created. Valid values must be validated against a predefined list of valid values on the FWCode table. 

Fixed values:

·     BGO = Background Optimizer

·     DEDICATED_BGO = Background optimizer fixed on one group

·     PLANNER = Route Planner

·     DISPATCH = Dispatch

Required

ServiceName

nvarchar

255

The service name is set to ”r;-None-” when the status is set to ”r;Free.” It is system assigned to a service name of the service receiving the dataset for processing. It is typically set to a unique service scheduler machine name and port.

Required

Status

nvarchar

50

This attribute is assigned a specific string value by the system. It is not modifiable by the user. Valid values must be validated against a predefined list of valid values. The predefined list needs to be externalized for possible extension during implementations.

Fixed values: System Assigned

·     Planning

·     Dispatching

·     Frozen

·     Optimizing

·     Free

·     Busy

·     Done

Required

LastEvaluated

datetime

8

When the status is set to ”r;Processing” or ”r;Done.” Should be blank when the status is set to ”r;Free.” 

Comment

nvarchar

500

See Comment.

CreatedBy

int

4

See CreatedBy.

CreatedDate

datetime

8

See CreatedDate.

ModifiedBy

int

4

See ModifiedBy.

ModifyDate

datetime

8

See ModifyDate.

Last Retrieved

datetime

8

Last time the record is retrieved.

UseDipatchBGO

bit

1

Specifies whether or not this data slice selects from a Dispatching schedule

Active

bit

1

When this setting is enabled, the BGO will optimize the data slice. This functionality applies to both types of data slices: dedicated and dynamic.

The Active setting is disabled by default in order to allow users to configure the data slice first and then activate it when configuration is complete. In cases where the data slice is active and being optimized and this setting is turned off, the system will behave as follows:

• The data slice will not be assigned to a BGO instance.

• Or, if a BGO instance is currently optimizing the data slice, the next time that the BGO requests a refresh of the data slice, the data slice will not be returned, causing BGO instance to move on to another data slice. The refresh interval is controlled by the RefreshData optimizer property:

com.descartes.escheduler.optimizer.refresh_lnosfw_data

Company

nvarchar

50

See Company.