Scheduler: Schedule

The Schedule screen displays details of all the stored jobs. Use this screen to review job executions, errors and statuses.


Header Filters

Filter

Type

Description

Job ID

Number

Locate a specific gb_scheduler_jobs entry

Show all Children

Checkbox

Check this to see all the child jobs of the filtered job. Visit the Parent Job ID page for all the details feature details

Module

List box

Module category from gb_scheduler_types

Class

List box

Class category from gb_scheduler_types

Method

List box

Web service to execute

Last Run

Date

Jobs that have executed after the selected date

Last Run Status

List box

Jobs with a specific last_run_status

Next Run

Date

Jobs scheduled to execute after the selected date

Status

List box

'Active' denotes a job that is scheduled to run. 'Inactive' jobs are not scheduled. 'Aborted' indicates a system failure. Contact Catch-e Support to investigate

(Button)

Button

Click to execute your chosen filtering. If the button is disabled, then the current filtering has been executed


Displayed Columns

Column

Type

Description

Job ID

Number

Displays the "Job ID" which also hyperlinks you to the Scheduler / Job tab for the selected job

Parent ID

Text

If the job is a child, its parent id will be displayed here. Visit the Parent Job ID page for all the details feature details

Type

Text

Displays a summary of the Module, Class and Method that apply to this job

Description

Text

The user's stored description of the job


Last Run

Column

Type

Description

Last Run Status

Text

Displays the status of the last run of this job. The status is 'Completed' if the job ran successfully and 'Failed' if it did not complete for some reason

Last Message

Text

Displays the message that was generated when the job was last run. These mostly describe job failures or the reasons why a completed job did not generate a report or update as expected. Go to the Message page for a list of messages and explanatory comments

Next Run

Timestamp

The scheduled start date and time for the next run of this job

Status

Text

Displays the current job status of the job. 'Active' jobs will run when their scheduler run time is reached, 'Inactive' jobs will not run


Troubleshooting

Attachment Formatting

If your scheduler job is using 'Office(xlsx)' as the "Mail Attachment", you cannot use a customised Format. Go to the Scheduler / Job and change the output format to be 'Office(xls)' if you want to create and use a customised Format.

My Job Is Inactive

If a job is inactive, and there is no audit record of this, check to see if the job is attached to a parent job.

If a parent job is made inactive, the child jobs are also made inactive.

Handy Hint: Update a Chain of Jobs to Active

If you need to update a chain of jobs to make them active again, do the following:

  1. Find the Parent Job on the Scheduler / Schedule tab

  2. Check on Show all Children

  3. Job ID: find and hyperlink to the last job in the chain

  4. Edit this job

  5. Parent Job ID: select and hyperlink to the parent

  6. Continue until you are back at the original job

  7. Recheck all jobs in the chain again to confirm

My Job Is Active But Does Not Run

If a job is active, and is not a child job, the Run Times settings may be counteracting each other.

If a Job Should Run on a Certain Day of the Week

For example: every Wednesday

  • Days: should be checked ON

  • Months: should be checked ON

  • Weekdays: should be unchecked and should contain selections (e.g. Wed)

If a Job Should Run on a Certain Date(s) in the Month

For example: 15th of each month

  • Days: should be unchecked and should contain selection (e.g. 15ths)

  • Months: should be checked ON

  • Weekdays: should be checked ON

If a Job Should Run on a Certain Date in a Month or Selected Months

For example: 1st July each year

  • Days: should be unchecked and should contain selections (e.g. 1st)

  • Months: should be unchecked and should contain selections (e.g. July)

  • Weekdays: should be checked ON

My Job Has Failed

Find and review the failed job on the Scheduler / Schedule tab. The "Last Message" often contains a message about the failure.

Visit the Message page for a list of these messages and explanatory comments that may help you diagnose the problem.


Fleet Management Scheduler Jobs

The scheduler jobs below are the recommended base set for Fleet Management clients.

The Job ID and Query ID's shown are for the Demo environment and will be different in your system.

The name of each job will be the same, unless changed.

Maintenance Transaction Upload

The Update Maintenance process enables you to Import Table Data and process the transactions into the table in bulk.

The Scheduler Jobs below run to update the data and send a confirmation.

Job ID

Type

Query ID

Parent

Description

10063

executeScript

Contracts - Maintenance - Post uploaded transactions. Run timing: Daily. 5pm EST. Open Update Maintenance for details of uploading bulk maintenance transactions

10064

executeQuery

100195

10063

Contracts - Maintenance - Post uploaded transactions confirmation. Confirmation of loaded transactions

Car Claims

Use the suite of jobs below to automate the processing of claims submitted by drivers and employees for car reimbursement claims.

(Refer to Car Claims documentation for specific job details)

Insurance Annual

The jobs below are used to update comprehensive insurance pricing each year or when a pricing change occurs.

Visit the Insurance Annual page for more details of these jobs and the process to follow.

Job ID

Query ID

Parent

Type

Description

TBA

TBA

executeQuery

Ins - current qt_insurance_rates data

TBA

TBA

executeQuery

Ins - data for fm_insurance_rates update

TBA

TBA

executeQuery

Ins - data for fm_contracts Market Value update

TBA

TBA

executeQuery

Ins - check contract data quality

TBA

TBA

executeQuery

Ins - current and suggested amounts

TBA

TBA

executeQuery

Ins - suggested sch_insurance_import

TBA

TBA

executeScript

Ins - contract and payments update

TBA

TBA

executeQuery

Ins - show payments for two months

Exceptions

Contracts / Billing

Job ID

Query ID

Parent

Type

Description

executeQuery

Contract Billing Date Checks. Run Time: Weekdays 5:05am. Delivery Type: Email. Purpose: List novated contracts where there are pending billing records that are not aligned with the client's stored "Payroll Date". Use this list to update the contract billing dates as required

Ad Hoc

Lease Transfers

Job ID

Query ID

Parent

Type

Description

100233

executeQuery

Lease Transfer Report. Run Time: Ad Hoc. Delivery Type: Report Queue. Purpose: List contracts where leases are being transferred to another lease provider. Basic contract and payment information is shown. Report can be modified to select by client and/or channel. Report is designed to use a last day 'DATE' to select and report on contract billings and payments required to be processed by the new provider


Make a Job Active

Qualifiers

  • You want to make a job active so it will run automatically

Process

  1. Find the job

  2. Navigate to the Scheduler / Job tab

  3. Click on Edit

  4. Status: update to 'active'

  5. Click on Save


Make a Job Inactive

Qualifiers

  • You want to make a job inactive so it will not run automatically

Process

  1. Find the job

  2. Navigate to the Scheduler / Job tab

  3. Click on Edit

  4. Status: update to 'inactive'

  5. Click on Save


Run a Job

Qualifiers

  • You want run a job manually, or

  • You are testing an executeQuery, executeScript or mailQuery job in Staging

Process

  1. Go to the System / Scheduler menu

  2. Navigate to Scheduler / Job

  3. Job ID: enter the ID

  4. Tab out of this field

  5. Click on Run Now


Create an executeQuery Job

Qualifiers

  • You want to create an executeQuery job

  • A suitable query exists or has been created

Process

  1. Navigate to the Scheduler / Job tab

  2. Click on New

Job Type

  • Module: 'gb'

  • Class: 'queries'

  • Method: 'executeQuery'

Parameters

  • Query ID: enter or lookup the query you will use

Run Times

Note: If the fields below are greyed out, this means the job is a child of another job. The parent job controls the run times. The run times must be updated in the parent job.

  • Minutes: click on the minute, minutes or range of minutes you want the job to run on. For example: choosing 0, 15, 30, 45 would run the job every 15 minutes for the selected run hours. 'All' is not a recommended setting

  • Hours: click on the hour, hours or range of hours you want the job to run on. For example: choosing 6am-9pm would run the job every 15 minutes from 6:00am to 9:45pm

  • Days: click on the days you want the job to run on. Choose 'All' to run the job on any day

  • Months: click on the months you want the job to run on. Choose 'All' to run the job in any month

  • Weekdays: click on the specify days you want the job to run on. Monday - Friday is a popular choice for business process jobs and emails

Delivery Method

Choose from either Send Mail or Report Queue. Catch-e recommends using the report queue for regular reports to internal staff for better security.

Send Mail (if checked)

  • Subject: enter the email subject

  • Body: enter the email body

Add Recipients (Send Mail)

  • Recipients: Type: choose from 'to', 'cc' or 'bcc'

  • Recipients: Name: enter the name

  • Recipients: Address: enter the email address

  • Repeat for each recipient you want to add

Report Queue (if checked)

  • Recipients: User: enter or lookup a user record

  • Recipients: Name: will populate from selected user record

  • Recipients: Address: will populate from selected user record

  • Recipients: Notify: uncheck if email advice is not required

  • Repeat for each recipient you want to add

  1. Click on Save


UAT an executeQuery Job

Qualifiers

  • You are testing an executeQuery job in Staging

Go to the Job

  1. Go to System / Scheduler

  2. Navigate to Scheduler / Job

  3. Job ID: enter the ID

  4. Enter or tab out of this field

Use the Report Queue

If the job is set up to email, speed up your testing process by changing the job to use the Report Queue.

Note: Emails will only send from the Live environment and will not send from Staging.

  1. Click on Edit

  2. Report Queue: check

  3. Alert Message: Selecting "Report Queue" will disabled "Send Mail" and remove all linked recipients. Do you want to continue?

  4. Click on OK

  5. Recipients: User: enter or lookup your user record (Name and Address will populate)

  6. Recipients: Notify: uncheck

  7. Click on Save

Run the Job and Get the Report

  1. Click on Run Now

  2. Alert Message: Job completed OK!

  3. Click on OK

  4. Go to System / Report Queue

  5. Download your report


Find a Job

Qualifiers

  • You want to find a job so you can edit it or run it

Method 1: Find the Job Using Filters

  1. Go to System / Scheduler

  2. Limit the records you need to search on by filtering as follows:

    • Module: select

    • Class: select

    • Method: select

    • Status: select 'Active'

  3. Click on Type and Description to dynamically sort data to search for the job

  4. Job ID: click on the hyperlink of the job

Method 2: Go to the Job Directly

  1. Go to System / Scheduler

  2. Navigate to Scheduler / Job

  3. Job ID: enter the ID

  4. Enter or tab out of this field