Attribute Name

Type

Field Size

Description

Required

BucketID

int

4

Unique Identifier of the Bucket record.

Required

ScheduleID

int

4

Unique Identifier of the Schedule record. Must exist on the FWSchedule table.

Required

ScheduleKey

nvarchar

50

Business key to identify the Schedule this Bucket refers to. Must exist on the FWSchedule table.

Required

TimeZoneKey

nvarchar

50

Business key to identify the Time zone this Bucket refers to. Must exist on the FWSchedule table.

Description

nvarchar

255

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. The predefined list needs to be externalized for possible extension during implementations.

EarliestDate

datetime

8

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. The predefined list needs to be externalized for possible extension during implementations.

Required

LatestDate

datetime

8

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. The predefined list needs to be externalized for possible extension during implementations.

Type

nvarchar

50

Custom-defined type of a bucket.

Territory

nvarchar

300

Territory to which this bucket applies. Only buckets with territory code matching to that of an order are sent to Adapi or Rmpi for advise.

Comment

nvarchar

500

See Comment.

ModifiedBy

int

4

See ModifedBy.

ModifyDate

datetime

8

See ModifyDate.

CreatedBy

int

4

See CreatedBy.

CreatedDate

datetime

8

See CreatedDate.

BucketKey

nvarchar

50

Business key to identify the activity this Bucket refers to.

UseFrequency

bit

1

Flag to indicate if frequency is used. If used, then the Frequency field will be used instead of the date portion of the StartDate and EndDate fields.

Frequency

int

4

Flag to indicate what days of the week in a date range should be used. Buckets will be loaded into the advise engine for each of the frequency days that fall within the input date range of the advise call.

For Example: Suppose there is a daily bucket, only Monday through Friday, to offer between 8:00 am to 10:00 am. Then just creating a Bucket with a Frequency of M/T/W/Th/F on from 8:00 am to 10:00 am will suffice. The date portion of the start/end is ignored. This way there is no need to generate buckets for specific dates.

When an advise call is sent with a date range from say 23-May to 26-May, Route Planner will send the following buckets to adapi:

·        Bucket 1

¡       Start Date/Time: 23-May-2008 08:00 am

¡       End Date/Time: 23-May-2008 10:00 pm

·        Bucket 2

¡       Start Date/Time: 26-May-2008 08:00 am

¡       End Date/Time: 26-May-2008 10:00 pm