Previous Topic: 2.3.1.10.1 Standard Time Zones

Next Topic: 2.3.1.11 Q&R Parameters (MQRPARMS)

2.3.1.10.2 Holiday Time Zones

Holiday zones allow you to single out specific dates and
times and put them into zones of your choice.  One reason to
do this is to acknowledge that, from a reporting and analysis
point of view, 10 a.m.  to noon on New Years Day is a much
different time period than 10 a.m.  to noon on a normal
weekday when you are looking at something like online system
resource consumption.

"Holiday," as noted earlier, is a misnomer:  CA MICS users
use holiday time zones to single out specific dates and times
that are not holidays, but are interesting from an analytic
viewpoint (usually because they are very busy periods).

The format of a statement that defines a holiday time
zone is:

  HOLIDAY n year month day hour1 hour2 sf 'zone description '

The following describes the parameters on this statement.

ZONE NUMBER (n)

     A number from 1 to 9 identifying the time zone.  This
     specification is numeric, however the data element ZONE
     is a one-byte character field in CA MICS database files.
     This number may be the same as one mentioned on a ZONE
     or another HOLIDAY statement.  A typical reason to do
     this is to lump weekends and holidays together.

     Zone numbers, should be defined with the prime (most
     important) zone as zone 1, the next as zone 2, with the
     holiday zone defined as N (the highest zone number
     used).

     There is no requirement that ZONE NUMBERs be defined
     consecutively (so 1, 2, 5, and 7 would be acceptable)
     nor is there a requirement that they be defined in
     numeric order.

YEAR (year)

     A two-digit value of the year in which the special day,
     being defined by this statement occurs, or a %% to
     bypass year checking (which is useful for holidays that
     occur on the same day regardless of the year).

     For example, the HOLIDAY definition below illustrates
     how the %% definition is used to define New Years Day as
     a holiday.

     HOLIDAY 4 %% 01 01 00 23 'HOLIDAY ZONE' *  NEW YEARS DAY

MONTH (month)

     A number from 1 to 12 that specifies the month of the
     year in which the special day being defined by this
     statement occurs.

DAY (day)

     A number from 1 to 31 that specifies the day of the
     month on which the special day being defined by this
     statement occurs.

BEGINNING HOUR OF THE DAY (hour1)

     The first hour of the special day to be included in the
     zone definition.  Hours are specified as numbers from 00
     to 23, and they are inclusive.

ENDING HOUR OF THE DAY (hour2)

     The last hour of the special day to be included in the
     zone definition.  Hours are specified as numbers from 00
     to 23, and they are inclusive.

     When only one hour is to be included, both beginning and
     ending hours must be specified, and they will be
     identical.

     To define a time zone of 8 a.m.  to 5 p.m., you would
     code '08 16', which tells CA MICS to include all times
     between 8:00 a.m.  (inclusive) up through 4:59:59.99
     p.m.  (16:59:59.99).

SERVICE FACTOR (sf)

     The service factor is specified to allow differential
     accounting by CA MICS Accounting and Chargeback. It
     allows a discount or surcharge factor to be specified
     for particular zones to reflect the time of day that the
     service was provided.  For more information on the
     service factor, see the CA MICS Accounting and
     Chargeback User Guide.

     The allowable range of values for the service factor is
     0.1 through 99.9.  If multiple ZONE statements are
     required for one zone, then a plus sign (+) must be
     specified on all but the first statement for that zone.
     The first statement for each zone must always contain a
     numeric service factor value.  This parameter must be
     specified even if Accounting and Chargeback is not
     installed.

ZONE NAME (zone description)

     A one- to 40-character name that is used on reports when
     this Time Zone is displayed.  The name cannot contain
     percent signs or apostrophes.  This parameter is
     required on the first HOLIDAY (or ZONE) statement for a
     given zone number.  On subsequent statements for the
     same zone number, it is ignored.