Difference between revisions of "Job Scheduler"
From AgileApps Support Wiki
imported>Aeric |
imported>Aeric |
||
| (14 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
''' | '''[[File:GearIcon.png]] > Administration > Data Management > Job Scheduler''' | ||
Use this page to schedule a job that will carry out operations defined in a Java class. | |||
{{Tip|For greater flexibility, use [[Scheduled Rules]], instead.}} | |||
=== Scheduling a Job === | === Scheduling a Job === | ||
# Visit ''' | # Visit '''[[File:GearIcon.png]] > Administration > Data Management > Job Scheduler''' | ||
# Click '''[New Job]''' | # Click '''[New Job]''' | ||
# Fill in the Job Parameters: | # Fill in the Job Parameters: | ||
#* '''Job Name''' - The name that will appear in the job list | #* '''Job Name''' - The name that will appear in the job list | ||
#* '''Select a Schedulable Class''' - Choose a class from the list. | #* '''Select a Schedulable Class''' - Choose a class from the list. | ||
#*: Only classes that have been designed to be [{{DOCHOST}}/javadocs/com/platform/api/Schedulable.html schedulable] are listed for selection. | |||
#*: ''Learn more:'' [[Java API:Schedule a Job]] | |||
#* '''Repeating Frequency''' - Make a selection here to run the job automatically at specified intervals. | #* '''Repeating Frequency''' - Make a selection here to run the job automatically at specified intervals. | ||
#* '''Activation Date''' - Choose the date for the initial activation. | #* '''Activation Date''' - Choose the date for the initial activation. | ||
| Line 14: | Line 18: | ||
#* '''End Date''' - When a Repeating Frequency is chosen, this section appears. Specify the last date | #* '''End Date''' - When a Repeating Frequency is chosen, this section appears. Specify the last date | ||
#* '''Run As''' - Choose the user to run the job as. (Only users with permissions equal to or less than your own are listed.) | #* '''Run As''' - Choose the user to run the job as. (Only users with permissions equal to or less than your own are listed.) | ||
===Viewing Jobs=== | ===Viewing Jobs=== | ||
To view the list of job records: | To view the list of job records, visit | ||
:'''[[File:GearIcon.png]] > Administration > Data Management > Job Scheduler''' | |||
To see jobs currently in the queue | To see jobs currently in the queue and view their status, visit | ||
:'''[[File:GearIcon.png]] > Administration > Monitor > Scheduled Job Log''' | |||
=== Stopping a Job === | === Stopping a Job === | ||
Once a job has been created, use the options available in the list view to delete it. | Once a job has been created, use the options available in the list view to delete it. | ||
{{Note|Only the entry in the scheduling queue is deleted. If the job is currently running, it runs to completion.}} | {{Note| <br> | ||
:*Only the entry in the scheduling queue is deleted. If the job is currently running, it runs to completion. | |||
:*Delete option is available to you only for custom jobs scheduled using business rules or scheduler report. This option is not available for system jobs.}} | |||
===Job Limits=== | ===Job Limits=== | ||
| Line 37: | Line 37: | ||
<noinclude> | <noinclude> | ||
[[Category: | [[Category:System Administration]] | ||
</noinclude> | </noinclude> | ||
Latest revision as of 07:32, 5 August 2021
> Administration > Data Management > Job Scheduler
Use this page to schedule a job that will carry out operations defined in a Java class.
Tip: For greater flexibility, use Scheduled Rules, instead.
Scheduling a Job
- Visit
> Administration > Data Management > Job Scheduler - Click [New Job]
- Fill in the Job Parameters:
- Job Name - The name that will appear in the job list
- Select a Schedulable Class - Choose a class from the list.
- Only classes that have been designed to be schedulable are listed for selection.
- Learn more: Java API:Schedule a Job
- Repeating Frequency - Make a selection here to run the job automatically at specified intervals.
- Activation Date - Choose the date for the initial activation.
- Activation Time -
- End Date - When a Repeating Frequency is chosen, this section appears. Specify the last date
- Run As - Choose the user to run the job as. (Only users with permissions equal to or less than your own are listed.)
Viewing Jobs
To view the list of job records, visit
- > Administration > Data Management > Job Scheduler
To see jobs currently in the queue and view their status, visit
- > Administration > Monitor > Scheduled Job Log
Stopping a Job
Once a job has been created, use the options available in the list view to delete it.
Note:
- Only the entry in the scheduling queue is deleted. If the job is currently running, it runs to completion.
- Delete option is available to you only for custom jobs scheduled using business rules or scheduler report. This option is not available for system jobs.
Job Limits
The number of jobs that can be run on any given day is determined by your billing plan.