Managing background jobs


About background jobs

Displaying the Filter Background Jobs page

Filtering the list of background jobs

Information included in the list

Refreshing the results

Executing a background job

Stopping a background job

Restarting an app server instance

Viewing the most recent transactions for a job

Configuring a background job


About background jobs

Background jobs are used to perform regular tasks in the system. Background jobs are usually scheduled to run on a regular basis. Examples of background jobs include:

Poetic provides tools for managing background jobs, including:

Displaying the Filter Background Jobs page

You manage background jobs from the Filter Background Jobs page. To display the page:

  1. On the Administration menu, click Site maintenance.
  2. On the Site Maintenance menu, click the System Monitoring tab.
  3. On the System Monitoring tab, click Background jobs.

The Background jobs option also is available from the Tools menu.

Filtering the list of background jobs

By default, the list only includes jobs that are Active.

To change the list that displays:

  1. In the Name/Description field, type the name or description of the background job. Use the wildcard character to specify partial criteria. For example, to find jobs with the word 'entitlement' somewhere in the name or description, type %entitlement%.
  2. From the Status dropdown, select the status for which to include jobs. For example, to only show jobs that are currently running, select Running from the dropdown.
  3. From the Show jobs that are dropdown:
    • To only include jobs that are active, select Active
    • To only include jobs that are inactive, select Inactive
    • To include both active and inactive jobs, select the blank option

Information included in the list

The background job list can include the following information for each job:

Options Click the Options link to display a list of actions you can perform on the job.
Job Name The database name for the job. This name cannot be edited.
Description A brief text description of the job.
Instance The instance on which the job runs.
Active Whether the job is currently active.
Status The current status of the job. For active jobs, indicates whether the job is running, finished successfully, or failed.
Running since For jobs that are currently running, the date and time at which the run started.
Last run The last date and time at which the job ran.
Next run The next date and time the job is scheduled to run.

Refreshing the results

To refresh the list of results, for example to check whether the status of a job has changed since the last search, click Refresh list in the toolbar.

Executing a background job

To run a job that is not currently running:

  1. Click the Options link for the job.
  2. For active jobs, in the options list, click Execute. For inactive jobs, the option is Run once.

If the job is active, it is executed immediately and then continues running on its current schedule.

If the job was inactive, it is executed once. It remains inactive.

Stopping a background job

To stop a job that is currently running:

  1. Click the Options link for the job.
  2. In the Options list, click Stop.

Restarting an instance

To restart an instance:

  1. Click the Restart job scheduler instance link in the toolbar.

    A dropdown listing the available instances displays.

  2. In the dropdown, select the instance to restart.
  3. Click Restart.

Viewing the most recent transactions for a job

To view the last 50 transactions for a job:

  1. Click the Options link for the job.
  2. In the options list, click View transactions.

    The View Job Transactions page displays.

The page includes basic information about the job as well as the list of transactions. For each transaction, the list includes a brief description, the instance used, and the date and time.

Configuring a background job

To change the description or schedule for a background job:

  1. Click the Options link for the job.
  2. In the options list, click Edit.

    The Background Job Maintenance page displays.

For details on editing and scheduling background jobs, see Editing and scheduling a background job.