FWBucketTemplate

 

Attribute Name

Type

Field Size

Description

Required

BucketTemplateID

int

4

Unique internal DB Identifier of the Bucket Template record.

Required

ScheduleID

int

4

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

Required

ScheduleKey

nvarchar

50

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

 

Description

nvarchar

255

Description of this bucket

 

EndDay

int

4

Used for generation of buckets using this template. A value greater than 0, will indicate that the EndDate for the generated bucket will be the date that falls within the date range and matches its frequency value plus this field value.

For example: if buckets are generated for a week date range and its frequency is Monday, Wednesday and Friday, then the EarliestEndDate will be based on Monday’s date plus this field value, Wednesday’s date plus this field value, etc.

 

StartTime

datetime

8

Start time for this bucket

 

EndTime

datetime

8

End time for this bucket

 

Type

nvarchar

50

Field to designate a type of Bucket.

For example: Platinum, gold and silver. This string will guide the interfaces as to what slots to offer given customer loyalty.

 

Territory

nvarchar

300

Territory to which this bucket applies

 

[Size]

int

4

Size of this bucket. Used when generating buckets based. This size field value will determine the Start and End Time

 

SizeTimeUnits

int

4

Time units of the size (hours or minutes)

 

NoOfBucketsPerDay

int

4

Number of buckets to generate per day.

 

Comment

nvarchar

500

See Comment.

 

Company

nvarchar

50

See Company.

 

CreatedBy

int

4

See CreatedBy.

 

CreatedDate

datetime

8

See CreatedDate.

 

ModifiedBy

int

4

See ModifiedBy.

 

ModfiyDate

datetime

8

See ModifyDate.

 

BucketTemplateKey

nvarchar

50

Business key to identify the activity this Bucket template refers to.

 

Name

nvarchar

50

Bucket Template name

 

MultiDayInd

bit

1

Designates if this bucket template is a multi-day. If it is, then

 

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.

 

TimeZone

nvarchar

100

Time zone

 

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