Skip Headers
Oracle® Database Lite Administration and Deployment Guide
10g (10.0.0)
Part No. B12262-01
  Go To Table Of Contents
Contents
Go To Index
Index

Previous
Previous
Next
Next
 

9 Job Scheduler

This document enables the Mobile Server administrator to manage the job engine and job schedules through the web. Topics include:

9.1 Overview

The Oracle 10g Job Scheduler provides an Application Programming Interface (API) and a graphical user interface for scheduling and running jobs using a job engine. It is a generic component which enables apply and compose functions for MGP, device manager jobs, and custom jobs.

The Job Scheduler can be used from two interface layers, also known as the inner and outer layers. The inner layer is the API which enables application developers to define jobs, submit jobs, and manage jobs programmatically. The outer layer is a GUI which enables administrators to manage the job engine, and manage job schedules on the web.

The API comprises some methods of the class oracle.lite.sync.ConsolidatorManager and other supporting classes such as Job, Schedule, ExecutionResult and ExecutionLog in the oracle.lite.sync.job package. Application developers can schedule jobs based on a pre-determined time and interval. For example, jobs can be scheduled to run repeatedly for a specified duration on any specified day or days of the week or month. Administrators can schedule jobs to run repeatedly for a specified number of months, weeks or specified days of the month or week. Using the class ConsolidatorManager,application developers can register or de-register a job class, create, drop, enable or disable a job, search, and delete a job execution log. For more information, refer the Consolidator Admin API Java Doc.

The Job Scheduler home page enables administrators to operate the Job Engine using the following tabs.

Home

The Home tab enables Mobile Server administrators to start up or shut down the job engine, check registered alerts, view active jobs, and access the Job History page. The Home tab displays the status of the job engine. If the job engine encounters any exceptions, the Home tab displays the stack trace of the last exception.

The Alerts table displays severity of an exception as a critical alert under the Severity column. Job Execution Failures are another alert type and are displayed as warning alerts.

The Job History page contains search criteria to search, sort, and manage the job history list. Administrators can search the Job History page based on job properties such as name, class name, result or a specific date and time.

Administration

The Administration tab enables administrators to create a new job and edit existing jobs. It provides administrative functions to enable jobs, disable jobs, and delete jobs. The Scheduled Jobs section displays a list of jobs that are scheduled in the job engine.

9.2 Managing the Job Engine

The Job Scheduler home page enables administrators to start the job scheduler and check for alerts that are registered in the job engine. Using this page, administrators can manage active jobs and the job history list. The sections below enable administrators to accomplish the following tasks. Topics include:

9.2.1 Starting the Job Scheduler

To start the Job Scheduler, navigate to the Job Scheduler home page as follows:

  1. Login to the Mobile Server using the appropriate user name and password.

  2. Locate the Mobile Server components table, and click Job Scheduler. The Job Scheduler home page appears.

    The Job Scheduler's default status is "Up". The following image displays the Job Scheduler's default status.

    Figure 9-1 displays the Job Scheduler's default status on the Job Scheduler home page.

    Figure 9-1 Job Scheduler Home Page

    This image displays the Job Scheduler home page.
  3. To start the Job Scheduler, click Start.

    At this stage, the "Start" button is replaced by the "Stop" button. The following image displays that the Job Scheduler is up and running.

    Figure 9-2 displays the Job Scheduler which is currently running.

    Figure 9-2 Starting the Job Scheduler

    This image displays the Job Scheduler when it is running.

9.2.1.1 Stopping the Job Scheduler

To stop the Job Scheduler, click Stop. The Mobile Server displays a warning message that seeks your confirmation to stop the Job Scheduler. Click Yes. You will be returned to the Job Scheduler home page.

9.2.2 Checking Job Scheduler Alerts

The Job Scheduler home page enables administrators to check alerts that are registered in the job engine. To check alerts, locate the "Alerts" table and select the alert that you need to view under the Select column. Click Check. The Mobile Server displays a list of failed jobs on the Job History page.

Figure 9-3 displays the Job History page.

Figure 9-3 Job History Page

This image displays the Job History page.

To delete an alert, locate the "Alerts" table on the Job Scheduler home page. Select the alert and click Delete.

9.2.3 Managing Active Jobs

The Active Jobs table on the Job Scheduler home page contains information such as job name, class name, parameter value, job start time, and duration. To terminate an active job, click Kill. The Job Scheduler displays a warning message that seeks your confirmation to terminate the active job. Click Yes. You will be returned to the Job Scheduler home page.

9.2.4 Managing the Job History List

The Job Scheduler home page displays the total number of jobs that are registered in the job history list. Using this page, the administrator can search, sort, and manage the job history list, which is based on job properties.

To display the job history list, click the number hyperlink which is displayed against Job History. For example, click the number which is displayed as a hyperlink against Job History. The Job Scheduler displays the Job History page.

To search the job history list, enter your search criteria based on job properties such as job name, class name, date, and time in the corresponding fields. Click Go. Based on your search criteria, the Job History page displays job history details under the Results section.

To sort job history details, click the required Header Title. For example, to sort job history details by name, click Name in the header title region.

To delete a job, select the job and click Delete.

The Job Scheduler enables you to delete all job history entries that match your search criteria. To delete job history entries that match your search criteria, click Delete All.

9.3 Administering Scheduled Jobs

The Administration tab enables administrators to create a new job, edit existing jobs, and enable, disable or delete jobs. The sections below enable administrators to accomplish the following tasks. Topics include:

9.3.1 Creating a New Job

To create a new job, navigate to the Administration tab and click Create A New Job. The Create a New Job page appears. The following images display the Create a New Job page.

Figure 9-4 displays the top section of the Create a New Job page.

Figure 9-4 Create a New Job - Top Section

Create a New Job page.

Figure 9-5 displays the bottom section of the Create a New Job page.

Figure 9-5 Create a New Job - Bottom Section

Create a New Job page.

Enter data in the Create a New Job page as described in the following tables.

Table 9-1 describes data that must be entered in the General section of the Create a New Job page.

Table 9-1 General Details Description - Job Section

Field Description Required
Job Name Unique Job Name Yes
Enabled To enable a job, select this check box. Optional
Save To Job History To save a job's execution information in the Job History, select this check box. Optional

Table 9-2 describes data that must be entered in the Job Class section of the Create a New Job page.

Table 9-2 Job Class Details Description - Job Section

Field Description Required
MGP To specify oracle.lite.sync.MgpJob as the job class, select this option.

Note: If selected, choose the appropriate Apply/Compose Mode from the list displayed.

Optional
Custom To specify a custom class for the job, select this option.

Note: If selected, enter the Custom Class Name and its Parameter Value in the corresponding fields.

Optional

Table 9-3 describes data that must be entered in the Start section of the Create a New Job page.

Table 9-3 Start Details Description - Schedule Section

Field Description Required
Immediately To start the job immediately, select this option. Optional
Later To start the job at a later time, select this option.

Note: If selected, select the appropriate Date and Time from the corresponding fields.

Optional

Table 9-4 describes data that must be entered in the Expiration section of the Create a New Job page.

Table 9-4 Expiration Details Description - Schedule Section

Field Description Required
Never Expire To ensure that the chosen job schedule does not expire, select this option. Optional
Expire To indicate that the chosen job schedule will expire within a specified time limit, select this option.

The Job Scheduler cancels jobs that do not start at the specified time. However, it does not stop jobs that have already started.

Note: If selected, enter the job expiry duration in the Limit (minutes) field.

Optional

Table 9-5 describes data that must be entered in the Repeat section of the Create a New Job page.

Table 9-5 Repeat Details Description - Repeat Section

Field Description Required
One Time Only To indicate a one time repeat schedule, select this option. Optional
Interval To indicate a repeat schedule with an interval, select this option.

Note: If selected, enter the interval duration in seconds, in the corresponding field.

Optional
Weekly To indicate a weekly job repeat schedule, select this option.

Note: If selected, choose a number that specifies the weekly repeat frequency from the Frequency (weeks) list. To indicate the repeat schedule on specific days of the week, select the relevant Days of Week boxes.

Optional
Monthly To indicate a monthly job repeat frequency schedule, select this option.

Note: If selected, choose a number specifying the monthly repeat frequency from the Frequency (months) list. To indicate the repeat schedule on specific days of the month, select the relevant Days of Month boxes.

Optional

Table 9-6 describes data that must be entered in the Repeat Until section of the Create a New Job page.

Table 9-6 Repeat Until Details Description - Repeat Section

Field Description Required
Indefinite To repeat the job schedule indefinitely, select this option. Optional
Custom To specify a custom repeat schedule, select this option.

Note: If selected, select the appropriate Date and Time from the corresponding fields.

Optional

To implement the job schedule after specifying changes to the schedule, click OK.

To retain or restore previous job schedule values, click Cancel.


Note:

The calendar does not display the selected date if the java script feature in your browser, any pop up blocking tools or search tools are installed and enabled.

9.3.2 Editing Existing Jobs

To edit existing jobs, click Edit. The Job Scheduler displays the Edit Job page which contains controls to edit a job schedule.

Figure 9-6 displays the Edit Jobs page.

Figure 9-6 Edit Jobs Page

This image displays the Edit Jobs page.

The controls to edit an existing job schedule are the same as the controls that are provided to create a new job schedule. For more information on how to edit job schedule information, refer the relevant field description table in the previous section.

To implement the job schedule after specifying changes to the schedule, click OK.

To retain or restore previous job schedule values, click Cancel.

9.3.3 Enabling Jobs

To enable a job, select the job that you need to enable, and click Enable. The Status column confirms the changed status.

9.3.4 Disabling Jobs

To disable a job, select the job that you need to disable, and click Disable. The Status column confirms the changed status.

9.3.5 Deleting Jobs

To delete a job, select the job that you need to delete, and click Delete. The Job Scheduler displays a warning message that seeks your confirmation to delete the chosen job. Click Yes. You will be returned to the Administration tab.

9.3.6 Default Jobs

The Oracle Database Lite 10g Edition contains default jobs. As a user, you can enable or disable these default jobs and edit or delete them. This edition contains the following default jobs.

  • MGP_DEFAULT

  • PURGE_HISTORY_DEFAULT

9.3.6.1 MGP_DEFAULT

This section describes the job class and the job parameter value.

job Name

MGP_DEFAULT

Description

This job invokes the MGP process.

Job Class

oracle.lite.sync.MgpJob

Job Parameter Value

APPLY_COMPOSE

The parameter value must be a string of the value APPLY_COMPOSE or APPLY_ONLY. When scheduling or editing this parameter using the Job Scheduler's Edit Jobs page, you can choose the required parameter value from the Apply/Compose Mode list.

9.3.6.2 PURGE_HISTORY_DEFAULT

This section describes the job class, job parameter value and its corresponding description.

Job Name

PUR GE_HISTORY_DEFAULT

Description

This job purges old records in history tables.

Job Class

oracle.lite.sync.PurgeHistoryJob

Job Parameter Value

History=Sync,MGP,Job;Days=7

The parameter value must consist a string of semicolon (";") separated name-value pairs. In this parameter value, there are two names called 'History' and 'Days'. The parameter name and its value are separated by the sign "=". The parameter name 'History' enables users to specify the required history component that needs to be purged. For example, in the above parameter value, Sync History, MGP History and the Job History is specified for purging. The parameter name 'Days' enables users to specify purging history records that are old by a certain number of days. For example, in the above parameter value, the number of days for purging the Sync History, MGPHistory and the Job History is specified as 7.