The first two lines of the XML request file for this API request contain information that specifies the version of XML, the text encoding format being used, and the location of the .dtd file.

DEFCAL

Indicates to Control-M/EM database that the defcal utility is being initiated. Calendar definitions are placed between the opening and closing DEFCAL tags. One or more calendars can be specified.

CALENDAR

Indicates the opening and closing tags of a single calendar definition. The parameters of the job are listed between the tags.

EXAMPLE: <CALENDAR DATACENTER="EM5A" NAME="AcctJob1" TYPE="Relative"></CALENDAR>

DATACENTER

Name of the Control‑M installation to which the calendar definition belongs. String. Mandatory.

NAME

Name of the calendar. String Mandatory.

TYPE

Calendar type. Mandatory. Valid values:

• Regular
• Periodic
• Relative

YEAR

Year-specific definitions in the calendar. Mandatory.

EXAMPLE: YEAR NAME="2016" DAYS="YYYYYYYYYYYYYYYYYYNYYYYYYYYYYYYYYYYYYYY YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYNNNYYYYYYYYY YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY YYYNNYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY YYYYYYYYYYYYYYYYYYYYYYYYYYYYNYYYYYYYYYYYYYYY YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYNNNYY YYYYYYYYYYYYYYYYYYY"

DESCRIPTION="This is the Accounting Jobs calendar for 2016."

NAME

Year for which the calendar definition applies. String. Mandatory.

The year during which the calendar is active. Only one year can be entered for this attribute, but more than one YEAR parameters can be included in a calendar definition.

The value of this attribute is expressed as YYYY (for example, 2016).

DAYS

Days on which the job is ordered. String. Mandatory.Valid values:

For a Relative calendar:

• Y
• N
• +
• -

For a Regular calendar:

• Y
• N

For a Periodic calendar:

any character other than Y, N, +, or -.

NOTE: Each Y and N represents a single day of the year. The value of the DAYS parameter is 365 characters long (366 for a leap year). The first letter of the DAYS value is January first. The last letter is December 31.

DESCRIPTION

Text description of the calendar. String. Optional. For Regular and periodic calendars, only.

RULE_BASED_CALENDAR

Indicates the opening and closing tags of a single Rule-Based Calendar definition. The parameters of the job are listed between the tags.

EXAMPLE: <RULE_BASED_CALENDAR DATACENTER="EM5A" NAME="AcctJob1"></RULE_BASED_CALENDAR>

DATACENTER

Name of the Control‑M installation to which the calendar definition belongs. String. Mandatory.

NAME

Name of the calendar. String Mandatory.

DAYS

Days of the month on which the job is ordered. String. Mandatory.

DAYS_AND_OR

Indicates the relationship between specified Days values and Weekdays values. Optional. Valid values:

• OR
• AND

Default: OR

WEEKDAYS

Days of the week on which to order the job. String. Optional.

Valid values: Weekdays

• 0 - 6
• ALL

• blank

DATE

Specific dates on which to order the job. String. MMDD format. Optional.

DAYSCAL

Name of a user-defined calendar used to specify a set of days. String. Optional.

WEEKSCAL

Name of a calendar to be used to validate specified weekdays on which to order the job. String. Optional.

CONFCAL

Specifies a calendar that is used to validate all specified days and dates on which to schedule the job. String.

SHIFT

Sub-parameter of CONFCAL. Describes how to shift the scheduling date of the job. Valid values:

• IGNOREJOB
• PREVDAY
• NEXTDAY
• NOCONFCAL

SHIFTNUM

Sub-parameter of CONFCAL. Number of days to shift the scheduling date of the job. Default: +00

MAXWAIT

Number of extra days (beyond the original scheduling date) that the job is allowed to remain in the Active Jobs database awaiting execution. Integer. Default: 00

JAN, FEB, MAR, APR, MAY, JUN, JUL, AUG, SEP, OCT, NOV, DEC

Months when the job can run. Optional. Not including a month is the same as including a month having the value 0. Valid values:

• 0 (Default)
• 1

ACTIVE_FROM

Starting date of the Rule-Based Calendar. Format: YYYYMMDD

ACTIVE_TILL

Ending date of the Rule-Based Calendar. Format: YYYYMMDD