Automation Engine Script Guide > Ordered by Function > Date and Time > VALID_CALE

VALID_CALE

Script Function: Checks whether a date is included in the calendar keyword

Syntax

VALID_CALE(Date, Calendar, Calendar Keyword)

Syntax	Description/Format
Date	Indication of a date in the format "YYMMDD" or "YYYYMMDD". Format: script literal or script variable It is also possible to specify a different date format. Do so by entering the required date format, then enter a separator (: or ;) and afterwards the date. Indicating a date format is optional.
Calendar	Name of the Calendar object Format: AE name, script literal or script variable
Calendar Keyword	Name of the calendar keyword Format: AE name, script literal or script variable

Syntax

Description/Format

Date

Indication of a date in the format "YYMMDD" or "YYYYMMDD".

Format: script literal or script variable

It is also possible to specify a different date format. Do so by entering the required date format, then enter a separator (: or ;) and afterwards the date. Indicating a date format is optional.

Calendar

Name of the Calendar object
Format: AE name, script literal or script variable

Calendar Keyword

Name of the calendar keyword
Format: AE name, script literal or script variable

Return codes
"Y" - The date is included in the calendar keyword "N" - The date is not included in the calendar keyword

Comments

Optionally, you may specify a particular Date Format. The default Date Formats to be used are "YYMMDD" or "YYYYMMDD". A colon or semicolon may be used as a separator between Date Format and Date.

Examples

The example shown below checks if the current date is valid within the work schedule calendar. The return value of the function is stored in a script variable.

:SET &CURDATE# = SYS_DATE()
:SET &OPERATOR#=VALID_CALE(&CURDATE#,"READINESS","WORKDAY")

Script element	Description
VALID_DATE	Checks if the date is valid.
VALID_TIME	Checks if a time is valid.