Caché System Administration Guide
Using the Task Manager
|
|
-
-
-
-
-
-
Import Tasks (import tasks previously exported to files, possibly by another Caché instance
Note:
The Task Manager polls every 60 seconds to see if there are any Tasks to be run. When you click
Perform Action Now to schedule a Task, there may be a delay of up to 60 seconds before the newly scheduled Task actually runs.
-
The first page of the wizard asks for the following information:
-
-
-
-
Task type choose from among the listed tasks (the list varies with the namespace you select at the previous prompt)
Note:
Depending on the task type selected, you may be presented with a form in which to specify additional information; for example, if you are scheduling an
IntegrityCheck, the form prompts you for
Directory,
Filename, and
KeepDays (number of days to keep the file).
-
-
-
-
-
-
FullDBList a full backup of databases in the defined list
-
-
IntegrityCheck an integrity check of databases in the namespace. The Integrity Check task only appears when the %SYS namespace is selected.
-
-
PurgeAudit purge the audit database after a specified time following a journal switch
-
PurgeBackupLog purge the backup log after a specified time following a database backup
-
Note:
When
System Monitor is running, it monitors and limits the size of the console log.
-
PurgeJournal purge journal files that meet the purging criteria
-
-
RunLegacyTask run a legacy task, that is, your own programmatic task; the line you enter in the text box, for example
do ^MyCode, must be executable in Terminal
Note:
Do not use the local variable
Status in
RunLegacyTask code. Caché uses this variable, and if it is modified by
RunLegacyTask code, the task is likely to end with an error status.
A legacy task that fails to complete due to an error is marked
Suspended due to error and is not scheduled to run until the error is corrected and you resume the task.
-
SecurityScan disables expired user accounts, and expires user passwords and CSP session tokens
-
-
SuspendOnError determines what happens if the Task returns an error
%Status from the
OnTask() method. Errors encountered by the Task Manager trying to execute the task (login error or no such Task found) do not check this flag.
-
-
-
-
Run task as this user Choose from the list of defined users. To choose a different user than the one you are logged in as, you must have the
%Admin_Secure:Use privilege.
-
-
Suspend task on error? Specify whether the task will be rescheduled and continue to run after an error, or suspended. The default is
No, to reschedule and run the task after an error.
-
-
No specifies that the task should run when the system restarts.
-
Yes specifies that the task should be rescheduled for the next logical time after the system restarts.
-
-
Send error email notification to If you have configured email settings for the Task Manager, enter a comma-separated list of email addresses to which a notification should be sent when the task ends in error.
-
-
run on primary failover member only
-
run on backup failover member and async members only (all except primary)
-
run on all mirror members (primary, backup, and asyncs)
Note:
When the status of a failover member is in transition, for example when the backup is in the process of taking over as primary, the Task Manager does not run any tasks on that member until its status as primary or backup is established.
-
Click
Next to specify when you want the task to run.
-
Click
Finish to schedule the task.
All tasks are configured to expire by default. To change this:
-
-
Enter
zn %SYS to change to the %SYS namespace.
-
-
-
Enter the task number you want to edit.
-
Press Enter to save the defaults of each option until you reach
Task Expires?
-
The selected task will no longer expire.
There are three additional expiration fields that control when a task expires. These are controlled by days, hours, and minutes. To adjust when a specific task expires:
-
-
Enter
zn %SYS to change to the %SYS namespace.
-
-
-
Enter the task number you want to edit.
-
-
To edit the expiration times of this task, enter the days, hour, or minutes you would like to schedule.
The values for this expiration are now saved.
You can sort the information in the task list by clicking any column heading. You can
Suspend or
Resume the scheduling of each task by clicking the appropriate option:
-
-
No to suspend it indefinitely.
-
Yes to suspend it now, and resume it when it is normally scheduled to run.
-
Resume Lets you resume a suspended task.
-
taskname Lets you view
details about the task and perform operations on it.
-
-
Run Lets you run the task. A
Run Task wizard displays the task name and ID, and the date and time the task will run; click
Perform Action Now to confirm the information and schedule the task.
To display detailed information about a scheduled task and perform one of several operations on it, click the task’s name in the
Task Name column. The
Task Details page displays information and execution details about the selected task. You can perform one of the following operations on the task by clicking the appropriate button:
-
-
-
-
Delete Lets you permanently delete the task.
-
Export Lets you export a task to a file that can later be
imported, including by another Caché instance.
-
Run Lets you schedule the task. When you click
Run, the
Run Task Wizard page displays the task name and ID, and the date and time the task will run; click
Perform Action Now to confirm the information and schedule the task.
Note:
Some of the actions options described are unavailable while a task is running.
To display history information about an individual scheduled task, click the
History link in the row of the item. The
Task History page displays detailed history for the selected task. The
Result column indicates the outcome the last time the task was run, showing either
Success or an error message. You can sort the information in the table by clicking any column heading.