Limited supportBMC provides limited support for this version of the product. As a result, BMC no longer accepts comments in this space. If you encounter problems with the product version or the space, contact BMC Support.BMC recommends upgrading to the latest version of the product. To see documentation for that version, see BMC AMI Ops Monitor for CMF 6.3.

CYCLE

The CYCLE control statement assigns a name to a unique date-time range.

CYCLE  
{BIWEEKLY|CYCLEnn|CYCLE99|DAILY|HOLIDAYS|
MONTHLY|WEEKENDS|WEEKLY|WORKWKLY}
[,(sdate[:stime],edate[:etime])1...,(sdate[:stime],edate[:etime])31]

The period of the CYCLE range must be within the range defined by the DATETIME control statement. The CYCLE control statement requires that it be preceded by a DATETIME control statement.

A CYCLE range can be activated as a general default range to all report requests in a job or to individual report requests. Data is included in a report for any time range specified in a CYCLE statement, if the interval time for the data falls within that time range.

The CYCLE control statement only defines a symbolic name of a subset (time slice) of the date-time range of the DATETIME statement. A PERIOD statement is used to activate a CYCLE range. It is the placement of the PERIOD statement that determines whether one or all report requests are affected by a single CYCLE range.

When the CYCLE, DATETIME, and PERIOD control statements are used in the same statement set, they must appear in the following order, or else a command error results:

  • DATETIME
  • CYCLE
  • PERIOD

Parameters

The parameters for the CYCLE control statement are as follows:

cycle name

is the first positional parameter in the CYCLE statement and must be specified

The cycle name can be any of the values specified in the following table.

Permitted values for the cycle name parameter

Cycle name

Default

BIWEEKLY

One report is generated for each two-week period defined within the cycle range.

CYCLEnn

One report is generated for each cycle range specified to the CYCLEnn value, wherenn is a two-digit number between 01 and 98.

CYCLE99

One report is generated for the entire DATETIME period. The cycle range for the CYCLE99 value defaults to the DATETIME period.

DAILY

A separate cycle is generated for each day during the general DATETIME period, up to a maximum of 31 days.

HOLIDAYS

One report is generated for each cycle range specified to the HOLIDAYS value. If this information is desired, cycle ranges must be defined that specify the start and end dates and times covering the duration of any holiday. The value HOLIDAYS is printed on the report.

MONTHLY

A separate cycle is defined for each month during the general DATETIME period.

WEEKENDS

A separate cycle is defined for each weekend (Saturday and Sunday) during the general DATETIME period.

WEEKLY

A separate cycle is defined for each week (Monday through Sunday) during the general DATETIME period.

WORKWKLY

A separate cycle is defined for each work week (Monday through Friday) during the general DATETIME period.

Note

The BIWEEKLY, HOLIDAYS, and CYCLE nn values require that at least one cycle range be specified.

(sdate[:stime],edate[:etime])

Thesdate:stime andedate:etime values define a date-time range to be associated with the CYCLE name. Up to 31 cycle ranges can be defined to one CYCLE statement. The cycle range is defined by using the same format as that used in the DATETIME control statement (see DATETIME).

None of the ranges that are defined in a single CYCLE statement can overlap with one another. All ranges must be a subset of the range specified in the DATETIME control statement.

Some CYCLE name values are self-defining; therefore, specifying a date-time range is optional. These values are CYCLE99, DAILY, MONTHLY, WEEKENDS, WEEKLY, and WORKWKLY.

Other CYCLE names are not self-defining; therefore, they require a date-time range. These values are BIWEEKLY, HOLIDAYS and CYCLE99.

Examples

The following examples illustrate the use of the CYCLE control statement.

DATETIME   (10001:000000,10031:240000)
CYCLE      DAILY
PERIOD     CYCLE=DAILY

The reporting period is daily, within the DATETIME specified. That is, daily reports are generated for the 1st through the 31st days of 2010.

DATETIME    (09363,10028)
CYCLE       WEEKLY,(09364,10006),(10006,10013)
                   (10013,10020),(10020,10027)
PERIOD      CYCLE=WEEKLY

Data is collected weekly from day 364 of 2009 to day 6 of 2010; day 6 to day 13 of 2010; day 13 to day 20; and day 20 to day 27 (time default operates: 000000).

DATETIME   (10001,10080)
CYCLE      MONTHLY,(10001,10032)
PERIOD     CYCLE=MONTHLY

The collection period is the first month of 2010 (that is, the beginning of the 1st to the beginning of the 32nd day of 2010), using the time default of 000000. In this example, the end date-time of 10032:000000 is functionally the same as 10031:240000, as seen in the first example.

Note

Collection Phase Log reports do not require cycle definition, but they do require DATETIME boundaries.

Related topic

General-control-statements


 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*