Scheduler
Use this page to view existing jobs such as running reports and sending out campaign emails. The Scheduler integrates with external UNIX systems and Windows systems to run jobs that are scheduled through those systems, using either Cron (UNIX, Linux, BSD) or Schedule tasks (Windows).
You can schedule any of the following job types:
- Process Workflow Tasks. This job processes workflow events. If you set a timed trigger for an event; for example, when a lead is a week old, then it finds the predefined Workflow actions and fires them when appropriate.
- Run Report Generation Scheduled Tasks. This job runs reports and emails them to the user as per the schedule specified for a given report. The reports are sent to the user through an email from a PHP script that runs at regular intervals to send out the emails at the appropriate time. The user can choose which reports to receive and how often to send out reports.
- Check Inbound Mailboxes. This job monitors inbound Emails in active mailboxes that you set up using the Inbound Email option in the Email panel of the Admin page.
- Run Nightly Process Bounced Email Campaigns. This job polls any mailbox in which, the "Possible Actions" parameter is set to "Bounce Handling". This is an essential component of monitoring mass email campaigns.
- Run Nightly Mass Email Campaigns. This job processes the outbound email queue for your organization's mass campaign Emails.
- Prune Database on 1st of Month. This job reads all the tables in your Sugar database, finds records that have been soft-deleted, creates a large SQL file, and physically deletes those records. This job enhances performance but is not essential to the use of Sugar. The backup files are placed in cache/backups with time-stamped filenames.
Click a job to view its details. On the detail page, click the appropriate button to edit, duplicate, or delete a job.
To create a new job, in the Shortcuts section of the Scheduler home page, click Create Scheduler. Specify the job name, job type, job status and job interval. When you select the job status, select Active to run the job at the specified intervals;
select Inactive if you want to save the job schedule information but not run the job.
To specify additonal details, click the Advanced Options link below the Job field to enter the following information:
- Execute If Missed. Select this box to run any jobs that the scheduler missed.
- Date & Time Start. Click the Calendar icon and select the start date for the job; select the time, in hours and minutes, from the adjacent drop-down list.
- Date & Time End. Click the Calendar icon and select the end date for the job. select the time, in hours and minutes, from the adjacent drop-down list.
- Active From. From the drop-down lists, select the time, in hours and minutes, when the job becomes active.
- Active To. From the drop-down lists, select the time, in hours and minutes, when the job becomes inactive.
Click Save to schedule the job; click Cancel to exit the page without scheduling the job.
For UNIX and Linux systems, you will need to add a new Cronjob to your Crontab. For Microsoft Windows, you can use the Task Scheduler.