Bookshelf: Script-Defined Constants

Siebel Analytics Scheduler Guide > Using Siebel Analytics Scheduler > Working with Scheduler Job Scripts >

Script-Defined Constants

Siebel Analytics Scheduler supports the following script-defined constants. These constants are used by the methods to schedule new jobs.

DayEnum Constants

The DayEnum values are used with the scheduling functions to identify days in a month, from Day 1 to Day 31. Table 16 describes DayEnum values.

Table 16. DayEnum Values
Constant	Description
nqDay1	Day 1
nqDay2	Day 2
nqDay3	Day 3
...	...
nqDay31	Day 31

DayOfWeekEnum Constants

The DayOfWeekEnum values are used with the scheduling functions to identify days in a week. Table 17 describes DayOfWeekEnum values.

Table 17. DayOfWeekEnum Values
Constant	Description
nqSunday	Sunday
nqMonday	Monday
nqTuesday	Tuesday
nqWednesday	Wednesday
nqThursday	Thursday
nqFriday	Friday
nqSaturday	Saturday

JobFlagsEnum Constants

The JobFlagsEnum values are used with the scheduling methods of the Script object to control how a job behaves. Table 18 describes JobFlagsEnum values.

Table 18. JobFlagsEnum Values
Constant	Description
nqJobNoFlags	Job has no special behavior.
nqJobDeleteWhenDone	Job is deleted when there are no more scheduled run times.
nqJobDisabled	Job is disabled. This is useful for preventing a job from running at the scheduled time or times.
nqJobHasEndDate	Job has a valid end date.
nqJobExecuteWhenMissed	If for some reason Siebel Analytics Scheduler is down when the job is supposed to start, this flag indicates that the job should run when the Scheduler starts up again.
nqJobDeleteScriptWhenDone	When a job is removed and this flag is set, the script associated with the job is deleted. This is useful only in conjunction with the nqJobScriptContainsPath flag.
nqJobScriptContainsPath	This flag indicates that the script associated with the job contains a path to a file containing the actual script code.
nqJobStartNow	When this flag is set, the begin date and start time are ignored. Instead, these fields get set to the current time of Siebel Analytics Scheduler.
nqJobIsUserScript	When scheduling another job from within a script, this flag specifies that the NQSConnect() function is disabled (the job is not a trusted job). This action effectively sets the nqJobIsUserScript flag for any job that the newly scheduled job may schedule.

MonthEnum Constants

The MonthEnum values are used with the scheduling functions to identify months. Table 19 describes MonthEnum values.

Table 19. MonthEnum Values
Constant	Description
nqJanuary	January
nqFebruary	February
nqMarch	March
nqApril	April
nqMay	May
nqJune	June
nqJuly	July
nqAugust	August
nqSeptember	September
nqOctober	October
nqNovember	November
nqDecember	December

OccurrenceEnum Constants

The OccurrenceEnum values are used with the scheduling functions to identify the occurrence of a given day. Table 20 describes OccurrenceEnum values.

Table 20. OccurrenceEnum Values
Constant	Description
nqFirst	First occurrence
nqSecond	Second occurrence
nqThird	Third occurrence
nqFourth	Fourth occurrence
nqLast	Last occurrence