Skip Headers
Oracle® Warehouse Builder OMB*Plus Command Reference
11g Release 2 (11.2)

Part Number E14406-01
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Master Index
Master Index
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
 

OMBCREATE CALENDAR

Purpose

To create a calendar.

Prerequisites

Should be in the context of a Calendar Folder.

Syntax

createCalendarCommand =  ( OMBCREATE CALENDAR "QUOTED_STRING" [ SET ( ( 
          "setPropertiesClause" [ SET "setReferenceIconSetClause" ] ) | 
          "setReferenceIconSetClause" ) ] ( ADD SCHEDULE ) [ SET 
          "setPropertiesClause" ] )
     setPropertiesClause =  PROPERTIES "propertyKeyList" VALUES 
          "propertyValueList"
     setReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
     propertyKeyList =  "(" "propertyKey" { "," "propertyKey" } ")"
     propertyValueList =  "(" "propertyValue" { "," "propertyValue" } ")"
     propertyKey =  "UNQUOTED_STRING"
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" | 
          "FLOATING_POINT_LITERAL" )

Parameters

createCalendarCommand

Create a new calendar.

setPropertiesClause

Describe the keys of properties for the calendar.

setPropertiesClause

Basic properties for CALENDAR:

Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Business name of the Calendar

Name: DESCRIPTION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Description of the Calendar


Each calendar contains a single schedule with the name 'LOCALWINDOW' 
which has the following properties which define the various aspects
of the schedule
Basic properties for SCHEDULE:

Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Business name of the Schedule

Name: DESCRIPTION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Description of the Schedule

setPropertiesClause

Basic properties for the owned SCHEDULE OBJECT :

Name: START_TIME
Type: STRING(4000)
Valid Values: Start time in the format specified by property DATE_FORMAT. The value NULL can also be passed if a schedule that takes on a start time of ASAP ie. upon deployment.
Default: Empty string
Start time for the schedule

Name: END_TIME
Type: STRING(4000)
Valid Values: End time in the format specified by property DATE_FORMAT. The value NULL can also be passed if a schedule that repeats forever is to be created..
Default: Empty string
End time for the schedule

Name: TIMEZONE
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Time zone which times refer to.

Name: REPEAT_EXPRESSION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
iCal format of a repeat expression. If no REPEAT_EXPRESSION is supplied, the scheduled activity is only performed once. The REPEAT_EXPRESSION includes the following:
FREQ
This specifies the type of recurrence. It must be specified. The possible predefined frequency values are YEARLY, MONTHLY, WEEKLY, DAILY, HOURLY, MINUTELY, and SECONDLY. Alternatively, specifies an existing schedule to use as a user-defined frequency. 
INTERVAL
This specifies a positive integer representing how often the recurrence repeats. The default is 1, which means every second for secondly, every day for daily, and so on. The maximum value is 999. 
BYMONTH
This specifies which month or months you want the job to execute in. You can use numbers such as 1 for January and 3 for March, as well as three-letter abbreviations such as FEB for February and JUL for July. 
BYWEEKNO
This specifies the week of the year as a number. byweekno is only valid for YEARLY.
BYYEARDAY
This specifies the day of the year as a number. Valid values are 1 to 366. An example is 69, which is March 10 (31 for January, 28 for February, and 10 for March). 69 evaluates to March 10 for non-leap years and March 9 in leap years. -2 will always evaluate to December 30th independent of whether it is a leap year. 
BYMONTHDAY
This specifies the day of the month as a number. Valid values are 1 to 31. An example is 10, which means the 10th day of the selected month. You can use the minus sign (-) to count backward from the last day, so, for example, BYMONTHDAY=-1 means the last day of the month and BYMONTHDAY=-2 means the next to last day of the month. 
BYDAY
This specifies the day of the week from Monday to Sunday in the form MON, TUE, and so on. Using numbers, you can specify the 26th Friday of the year, if using a YEARLY frequency, or the 4th THU of the month, using a MONTHLY frequency. Using the minus sign, you can say the second to last Friday of the month. For example, -1 FRI is the last Friday of the month. 
BYHOUR
This specifies the hour on which the job is to run. Valid values are 0 to 23. As an example, 10 means 10 a.m. 
BYMINUTE
This specifies the minute on which the job is to run. Valid values are 0 to 59. As an example, 45 means 45 minutes past the chosen hour. 
BYSECOND
This specifies the second on which the job is to run. Valid values are 0 to 59. As an example, 30 means 30 seconds past the chosen minute. 

BYSETPOS (10gR2 only)
This selects one or more items by position in the list of timestamps that result after the whole calendaring expression is evaluated. It is useful for requirements such as running a job on the last workday of the month. Rather than attempting to express this with the other BY clauses, you can code the calendaring expression to evaluate to a list of every workday of the month, and then add the BYSETPOS clause to select only the last item of that list.  

All of the above properties can be used in the SET PROPERTIES clause as well.

setPropertiesClause

The following properties are supported for the GET PROPERTIES clause only
Name: DATE_FORMAT
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: N//A
Region specific time format string, eg MMM/dd/yy:HH:mm:ss.
Name: AVAILABLE_TIMEZONES
Type: STRING ARRAY
Valid Values: Any valid character string in supported character set.
Default: N//A
List of available time zone ids that can be used to set the TIMEZONE property. This property is for information purposes only.
Name: PREVIEW_DATES
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Preview of dates that this schedule includes. This property is only valid for OMBRETRIEVE.

setReferenceIconSetClause

Set specified Icon Set.

propertyKeyList

The list of property keys.

propertyValueList

A list of property values.

propertyKey

A property key for an object.

propertyValue

A single property value. It can be a number, float, boolean or single-quoted string.

CALENDAR Object

Table 6-4 CALENDAR Object

Property Type Choices Min Max Default Description

GENERATION_COMMENTS

STRING

none

none

none

empty string

Enter additional comments for the generated code.