Previous Topic: Reports OverviewNext Topic: Account Settings


Jobs Overview

Jobs are sets of actions used by CA Clarity PPM to perform automated administrative processes on a regular basis. For example, populating or refreshing database tables and running background processes. A job can be composed of queries, statements, or procedures.

For more information, see the Administration Guide.

More Information:

Run or Schedule a Job to Run

Scheduled Job Runs

Define or Edit Scheduled Job Run Properties

Pause or Resume a Scheduled Job Run

View the Status of a Scheduled Job Run

Cancel a Scheduled Job Run

View the Job Log

Delete a Scheduled Job Run

Run or Schedule a Job to Run

You can view a list of all the jobs that you have access to. You can run a job immediately or schedule it to run later using the available jobs page.

Follow these steps:

  1. Open Home, and from Personal, click Reports and Jobs.

    The list page appears.

  2. Click Jobs.

    The list page appears.

  3. Click the name of the job.

    The properties page appears.

  4. In the When section, complete the following field, and save:
    When

    Defines the interval on which the job runs.

    Values:

    • Immediately. Select to run the job now.
    • Scheduled. Select to schedule the job to run later, and complete the following fields:
    Start Date

    Defines the date for running the job.

    Required: Yes

    Start Time

    Defines the start time in hours and minutes.

    Recurrence

    Defines the recurrent run time. To set a recurrence, such as weekly or monthly, click the Set Recurrence link. To set the recurrence of a scheduled job, use UNIX Crontab Format Entry. To use Crontab to set the recurrence, select Use UNIX Crontab Entry Format and enter the schedule.

    Example: 0 0 1, 15 * * means run the job at midnight on the 1st and 15th of every month.

Scheduled Job Runs

Use the scheduled job page to check the run times of a job and to check the run status. All scheduled runs (except deleted ones) are listed regardless of their status.

Use the scheduled jobs page to view the status of scheduled runs.

A scheduled run can have one of the following statuses:

More information:

Define or Edit Scheduled Job Run Properties

Pause or Resume a Scheduled Job Run

View the Status of a Scheduled Job Run

Cancel a Scheduled Job Run

Define or Edit Scheduled Job Run Properties

Using the job properties page, edit the properties of scheduled job runs that have a "Cancelled" or "Completed" status. Otherwise, you can only view job run properties.

Note: If you schedule a job to run only once, you can edit its properties before the scheduled run time.

Follow these steps:

  1. Open the job.

    The properties page appears.

  2. In the General section, complete the following fields:
    Job Name

    Defines the name of the job. For scheduled runs, you can change the name to distinguish each instance of a run.

    Example: Retailing Banking - Monthly Rate Extraction run

    Job ID

    Displays the unique identifier for a scheduled job.

    Job Status

    Displays the status for a scheduled job.

  3. Complete the fields in the Parameters section.

    Note: The parameters that display vary based on the job. If this section does not display implies your CA Clarity PPM administrator defined no parameters. Save the parameters to reuse the defined set of parameters. Saved parameters appear in the list on the available jobs list page below the job type.

  4. Complete the following fields, and save:
    When

    Defines the interval on which the job runs.

    Values:

    • Immediately. Select to run the job now.
    • Scheduled. Select to schedule the job to run later, and complete the following fields:
    Start Date

    Defines the date for running the job.

    Required: Yes

    Start Time

    Defines the start time in hours and minutes.

    Recurrence

    Defines the recurrent run time. To set a recurrence, such as weekly or monthly, click the Set Recurrence link. To set the recurrence of a scheduled job, use UNIX Crontab Format Entry. To use Crontab to set the recurrence, select Use UNIX Crontab Entry Format and enter the schedule.

    Example: 0 0 1, 15 * * means run the job at midnight on the 1st and 15th of every month.

  5. Complete the following fields in the Notify section:
    Resources to Notify on Failure

    Specifies the resources to notify on failure.

    Groups to Notify on Failure

    Specifies the groups to notify on failure.

    Resources to Notify on Completion

    Enter a resource name in the field or use the search tool to select the name from a resource list.

    Groups to Notify on Completion

    Enter the name of the group to notify in the field or use the search tool to select the group from a list.

  6. Complete the following fields in the Sharing section:
    Resources

    Specifies the users who can view the generated report.

    Groups

    Specifies the groups who can view the generated report.

Pause or Resume a Scheduled Job Run

On the scheduled jobs page, you can pause any job with a "Scheduled" status, and resume any paused job. You can pause a run to stop temporarily a job from running. When in this state, the job cannot run at its scheduled time until you resume the job. When you resume a job, it runs at its next schedule run time.

Follow these steps:

  1. Open Home, and from Personal, click Reports and Jobs.

    The list page appears.

  2. Click Jobs.

    The available jobs list appears.

  3. Open the Jobs menu, and click Scheduled Jobs.

    The scheduled jobs list appears.

  4. Select the check box next to the scheduled run, and do one of the following:
    1. Click Pause.

      The status for the job run changes to "Paused".

    2. Click Resume.

      The status for the job run changes to "Scheduled". The job runs at the next scheduled time.

View the Status of a Scheduled Job Run

Follow these steps:

  1. Open Home, and from Personal, click Reports and Jobs.

    The list page appears.

  2. Click Jobs.

    The available jobs list appears.

  3. Open the Jobs menu, and click Scheduled Jobs.
  4. Browse for or filter the scheduled runs.

    The jobs display in the list.

  5. Check their status.

Cancel a Scheduled Job Run

You can cancel a schedule job run from the scheduled jobs list page. Canceling a scheduled job run stops the job immediately and cancels any future runs. A canceled run remains in the scheduled jobs list with a "Canceled" status. Once you cancel a job run, you cannot change its status, or edit any of its properties.

Follow these steps:

  1. Open Home, and from Personal, click Reports and Jobs.

    The list page appears.

  2. Click Jobs.

    The list of available jobs appears.

  3. Open the Jobs menu, and click Scheduled Jobs.

    The scheduled jobs page appears.

  4. Browse for or filter the scheduled runs.

    The jobs display in the list.

  5. Select the check box next to the scheduled run, and click Cancel Job.

    The status of the scheduled job changes to "Canceled."

View the Job Log

Use the jobs log page to view information about a job run, or delete outdated job logs.

A job log consists of a read-only version of its run properties and lists job entries, times, and any messages. If a job fails, the log indicates the nature of the error.

You can also schedule the Remove Job and Library job to remove job logs and report instances periodically from the Report Library or Job Log.

Follow these steps:

  1. Open Home, and from Personal, click Reports and Jobs.

    The list page appears.

  2. Click Jobs.

    The available jobs list appears.

  3. Open the Jobs menu, and click Log.

    A list of jobs with log entries appears.

  4. Click the name of the job.

    The job log displays.

Delete a Scheduled Job Run

Using the scheduled jobs page, you can remove scheduled job runs with a "Cancelled" or "Completed" status. Removing scheduled runs does not delete the job type, or any of the job logs of the run.

Follow these steps:

  1. Open Home, and from Personal, click Reports and Jobs.

    The list page appears.

  2. Click Jobs.

    The available jobs list appears.

  3. Open the Jobs menu, and click Scheduled Jobs.

    The scheduled jobs page appears.

  4. Select the check box next to the scheduled run, and click Delete Job.