Jobs
The Jobs feature allows you to create a multi-step job that can be scheduled. After a new job is created, report or utility Favorites are added to the job. When the job runs, the Favorites are run sequentially.
To access the Jobs screen:
From the Application Bar, select Reports > Reports Admin > Favorites > Jobs.
Creating a Job
On the Jobs screen banner, click the New Job button. The Job screen will display.
In the Job Name field, enter a name for job. This name will display on the Jobs screen which lists all jobs.
The Job Name field cannot contain the following special characters: " % | ' * ; _ ~ \\. (These characters are also known as reserved characters.)In the Description field, enter a description for the job. This is limited to 40 characters. The job description will display on the Jobs screen which lists all jobs.
On the banner, click Add Favorite. The Select favorite to add to job window will display.
Enter the following options:
Field | Description |
|---|---|
Favorite | Enter the name of the favorite you are adding to the job. As you begin to type, a list of matching favorites will display. |
Description | Enter a description for this favorite as it pertains to the job. |
Report Format | Select the output type for the report. For more information, see Report Output Types. |
File Name | Enter the file name for the results. |
Overwrite File | Select this check box to replace a file of the same file name with new results. |
Sheet Name | Enter a name for the Excel sheet that will show the results. This field will only display if an Excel output format is chosen.
|
Overwrite Sheet | Select this check box to replace an Excel sheet of the same name with new results. |
Click the Add Favorite button. The favorite will display on the Favorites to Run section of the screen.
If you want to change the sequence of the favorites, simply re-order them using a drag-and-drop operation with the favorite name.Optionally, if you need to remove a favorite from the list, click the check box on the left of the favorite's row. Then, click Delete Favorite on the banner.
When you are finished, click Save Job on the banner.
Scheduling a Job
On the Jobs screen, locate the job name you want to schedule.
Click the New Schedule button for the job. The Schedule Job window will display.
Enter the following fields:
Field | Description |
|---|---|
Report Queue ID | Select a report queue. This field is required; all background processes (regardless of type) are submitted to a queue, where the background processor accesses them to run at the specified time. |
Run | Select whether you want this job to run One Time or to Repeat on a regular basis. |
Time Frame ID | If you are using a relative date to schedule this job, select a time frame to specify the interval between run times. For more information, see Time Frames and Dates on Reports and Utilities. |
Start Schedule On | Select the first day on which the job is to run. While it is possible to also enter a time value in this field, we recommend that you enter the time in the Start Time field. Otherwise, if the job is using a repeating schedule, the time will be lost after the first run. |
Plus Days | Enter a number of days that you want the utility to run past the start date entered. This field is used with custom time frames to have a report run a certain number of days past the start of a time frame. |
Start Time | Enter the time of day at which the task should begin. Use the following format: h:mmPM or h:mmAM |
Est Run Time (Min) | Displays the estimated time (in minutes) required to run the utility. The purpose of this value is to prevent a task from running when the database is expected to be down for maintenance. (The database maintenance schedule is part of the report queue definition.) If a job is scheduled to start, but PCATS calculates that the database will be down before the job completes, the system delays the start of the job until after the scheduled down time. |
Notify User/Group | Select the name of the user or group of users who are to receive an email notification each time the utility has completed. You can also type a specific email address. This field can hold up to 2000 characters. If you select a message group as a recipient, the group name is stored as the recipient for the message in the database. |
The following fields are for your reference.
Field | Description |
|---|---|
Status Type | Displays the current status of the scheduled job. This value is maintained by the system. Possible values include:
|
Report Processor ID | Displays the Processor ID of the Report Queue for the submitted job. See Report Queue Maintenance for details on setting up Report Queues. |
Started Date | Displays the last date and time the job was run. |
Next End Date | Displays the estimated time when the job will finish. This is based on the Est Run Time field. |
Next Run | Displays the next date and time the job is scheduled to run. |
Planned Run | Displays the date and time the system plans to run the job. This field is calculated after the report queue schedule is considered. |
When you have finished scheduling the job, click Ok.
After you schedule a job, the Scheduled Report Results will list the scheduled job and each favorite within the job on the Report Queue Seq column.
Editing a Job Schedule
On the Jobs screen, locate the job schedule you want to update or delete.
Click the Edit Schedule button for the job. The Schedule Job List window will display.
On the Schedule Details section, you will see the job schedules. You can:
Click Delete to remove this job schedule.
Click the schedule name to edit it. Refer to the Scheduling a Job section of this topic for more information on field settings.
Deleting a Job
On the Jobs screen, locate the job name you want to delete.
Select the check box to the left of the job name.
On the banner, click Delete Job. A confirmation message will display.
Click Delete.