| Class: com.sybase.djc.scheduler.ScheduledTask (Scheduled Task) | EAServer 6.3 Help |
|---|
| Property: afterFailureRun (After Failure Run) | |
|---|---|
| Description | Specifies the name of another scheduled task that should be run if this scheduled task fails. |
| Property: afterMatchRun (After Match Run) | |
|---|---|
| Description | Specifies the name of another scheduled task that should be run if this scheduled task finds a match. |
| Only Used If | Property taskAction has the value "checkFile". |
| Property: afterSuccessRun (After Success Run) | |
|---|---|
| Description | Specifies the name of another scheduled task that should be run if this scheduled task succeeds. |
| Property: appendOutputFrom (Append Output From) | |
|---|---|
| Description | Appends the output from another task to the e-mail message that will be sent by this task. |
| Only Used If | Property taskAction has the value "sendMailMessage". |
| Property: applicationClient (Application Client) | |
|---|---|
| Description | Not supported in this release. |
| Only Used If | Property taskAction has the value "runApplicationClient". |
| Property: attachOutputFrom (Attach Output From) | |
|---|---|
| Description | Not supported in this release. |
| Only Used If | Property taskAction has the value "sendMailMessage". |
| Property: checkFile (Check File) | |
|---|---|
| Description | Checks whether the lines of a text file match the lineMatch expression. |
| Only Used If | Property taskAction has the value "checkFile". |
| Default Value | ${djc.logFile} |
| Property: componentMethod (Component Method) | |
|---|---|
| Description | Name of a void method from a class implementing an EJB's local or remote interface (e.g. "ejb.components.example.MyTaskLocal.myTaskMethod" or "ejb.components.example.MyTaskRemote.myTaskMethod"), or the name of a void method in a plain Java class (e.g. "com.acme.bank.DailyBackupTask.run"). |
| Only Used If | Property taskAction has the value "runComponentMethod". |
| Property: dataSource (Data Source) | |
|---|---|
| Description | The name of a data source which will be used for execution of the databaseCommand. |
| Only Used If | Property taskAction has the value "runDatabaseCommand". |
| Property: databaseCommand (Database Command) | |
|---|---|
| Description | The SQL statement to be executed. |
| Only Used If | Property taskAction has the value "runDatabaseCommand". |
| Property: endDate (End Date (YYYY-MM-DD)) | |
|---|---|
| Description | The last date on which this task can be executed. |
| Property: endTime (End Time (HH:MM)) | |
|---|---|
| Description |
The latest time in the day that this task can be executed.
If startTime > endTime, the task runs between startTime in the evening to endTime the next morning. |
| Only Used If | Property schedule is not empty. |
| Property: exclude (Exclude (YYYY-MM-DD,...)) | |
|---|---|
| Description | Comma-separated list of dates (in format "YYYY-MM-DD") on which this task must not execute. |
| Property: interval (Specified Interval) | |
|---|---|
| Description | The number of seconds between iterations for this task. |
| Only Used If | Property schedule has the value "interval". |
| Default Value | 1 |
| Minimum Value | 1 |
| Maximum Value | 2147483647 |
| Property: lineMatch (Line Match) | |
|---|---|
| Description | Match condition if the syntax of a SQL where clause or JMS selector expression. The variable line can be referenced in this expression to refer to the current line being tested for a match. |
| Only Used If | Property taskAction has the value "checkFile". |
| Default Value | line like '%SomeText%' |
| Property: logExecution (Log Execution) | |
|---|---|
| Description | Print a message to the server log each time this task is executed. |
| Default Value | false |
| Legal Values | false, true |
| Property: mailCc (Cc) | |
|---|---|
| Description | Comma-separated list of e-mail addresses for "Cc:" mail header. |
| Only Used If | Property taskAction has the value "sendMailMessage". |
| Property: mailFrom (From) | |
|---|---|
| Description | E-mail address for "From:" mail header. |
| Only Used If | Property taskAction has the value "sendMailMessage". |
| Property: mailMessage (Message) | |
|---|---|
| Description | Message to be sent in e-mail. This can reference Java system properties as "${systemPropertyName}". It can also reference the match count (number of line matches) as "${count}", and the match delta (increase in count since last run of this task) as "${delta}". |
| Only Used If | Property taskAction has the value "sendMailMessage". |
| Property: mailSession (Mail Session) | |
|---|---|
| Description | The name of a configured mail session. |
| Only Used If | Property taskAction has the value "sendMailMessage". |
| Default Value | default |
| Property: mailSubject (Subject) | |
|---|---|
| Description | Subject for e-mail. This can reference Java system properties as "${systemPropertyName}". It can also reference the match count (number of line matches) as "${count}", and the match delta (increase in count since last run of this task) as "${delta}". |
| Only Used If | Property taskAction has the value "sendMailMessage". |
| Property: mailTo (To) | |
|---|---|
| Description | Comma-separated list of e-mail addresses for "To:" mail header. |
| Only Used If | Property taskAction has the value "sendMailMessage". |
| Property: matchIfCountExceeds (Match If Count Exceeds) | |
|---|---|
| Description | Minimum number of line matches required before this task will call the afterMatchRun task. |
| Only Used If | Property taskAction has the value "checkFile". |
| Default Value | 2147483647 |
| Minimum Value | 0 |
| Maximum Value | 2147483647 |
| Property: matchIfDeltaExceeds (Match If Delta Exceeds) | |
|---|---|
| Description | Minimum change in the number of line matches (since last call to this task) required before this task will call the afterMatchRun task. |
| Only Used If | Property taskAction has the value "checkFile". |
| Default Value | 2147483647 |
| Minimum Value | 0 |
| Maximum Value | 2147483647 |
| Property: maximumHeadLines (Maximum Head Lines) | |
|---|---|
| Description | Maximum number of lines that will be printed from the beginning of printFileHead. |
| Only Used If | Property taskAction has the value "printFileHead". |
| Default Value | 1000 |
| Minimum Value | 0 |
| Maximum Value | 2147483647 |
| Property: maximumTailLines (Maximum Tail Lines) | |
|---|---|
| Description | Maximum number of lines that will be printed from the end of printFileTail. |
| Only Used If | Property taskAction has the value "printFileTail". |
| Default Value | 1000 |
| Minimum Value | 0 |
| Maximum Value | 2147483647 |
| Property: messageQueue (Message Queue) | |
|---|---|
| Description | Name of JMS message queue to which a message will be sent. |
| Only Used If | Property taskAction has the value "sendTextMessage". |
| Property: messageTopic (Message Topic) | |
|---|---|
| Description | Name of JMS message topic to which a message will be published. |
| Only Used If | Property taskAction has the value "publishTextMessage". |
| Property: printFileHead (Print File Head) | |
|---|---|
| Description | Name of a file whose "head" lines will be printed. This type of task is usually used as the target of appendOutputFrom from an e-mail sending task. |
| Only Used If | Property taskAction has the value "printFileHead". |
| Default Value | ${djc.logFile} |
| Property: printFileTail (Print File Tail) | |
|---|---|
| Description | Name of a file whose "tail" lines will be printed. This type of task is usually used as the target of appendOutputFrom from an e-mail sending task. |
| Only Used If | Property taskAction has the value "printFileTail". |
| Default Value | ${djc.logFile} |
| Property: publishTextMessage (Publish Text Message) | |
|---|---|
| Description | Body for JMS text message which will be published. |
| Only Used If | Property taskAction has the value "publishTextMessage". |
| Property: schedule (Schedule) | |
|---|---|
| Description |
How often should this task run.
See also: interval. |
| Default Value | daily |
| Legal Values | startup, shutdown, interval, second, minute, hourly, daily, weekly, monthly |
| Property: sendTextMessage (Send Text Message) | |
|---|---|
| Description | Body for JMS text message which will be sent. |
| Only Used If | Property taskAction has the value "sendTextMessage". |
| Property: startDate (Start Date (YYYY-MM-DD)) | |
|---|---|
| Description | The first date on which this task can be executed. |
| Property: startTime (Start Time (HH:MM)) | |
|---|---|
| Description |
The earliest time in the day that this task can be executed.
If startTime > endTime, the task runs between startTime in the evening to endTime the next morning. |
| Only Used If | Property schedule is not empty. |
| Property: systemCommand (System Command) | |
|---|---|
| Description | Operating system command to be run. This might be used, for example, to initiate a file system or database backup. |
| Only Used If | Property taskAction has the value "runSystemCommand". |
| Property: threadMonitor (Thread Monitor) | |
|---|---|
| Description | Name of a configured thread monitor to be entered while executing this task (but not while waiting between iterations). |
| Property: waitAfterMatch (Wait After Match) | |
|---|---|
| Description | The minimum number of seconds to wait before another iteration of this task if it matches. |
| Only Used If | Property taskAction has the value "checkFile". |
| Default Value | 0 |
| Minimum Value | 0 |
| Maximum Value | 2147483647 |