Skip to content

Commit

Permalink
Merge pull request #28052 from agileware/CIVICRM-2189
Browse files Browse the repository at this point in the history 
Revisit the default Scheduled Jobs. Adjust the frequency…
  • Loading branch information
@colemanw
colemanw authored Nov 13, 2023
2 parents a41b262 + 6caa499 commit 2e8aeca
Showing 1 changed file with 65 additions and 35 deletions.
100 changes: 65 additions & 35 deletions sql/civicrm_data/civicrm_job.sqldata.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,136 +11,166 @@
[
'run_frequency' => 'Daily',
'name' => 'CiviCRM Update Check',
'description' => 'Checks for CiviCRM version updates. Important for keeping the database secure. Also sends anonymous usage statistics to civicrm.org to to assist in prioritizing ongoing development efforts.',
// FIXME: "to to"
'description' => 'Checks for version updates. https://docs.civicrm.org/user/en/latest/initial-set-up/scheduled-jobs/#job_version_check',
'api_entity' => 'Job',
'api_action' => 'version_check',
'is_active' => 1,
],
[
'run_frequency' => 'Always',
'name' => 'Send Scheduled Mailings',
'description' => 'Sends out scheduled CiviMail mailings',
'description' => 'Sends out scheduled mailings. https://docs.civicrm.org/user/en/latest/initial-set-up/scheduled-jobs/#job_process_mailing',
'api_entity' => 'Job',
'api_action' => 'process_mailing',
],
[
'run_frequency' => 'Hourly',
'name' => 'Fetch Bounces',
'description' => 'Fetches bounces from mailings and writes them to mailing statistics',
'description' => 'Fetches bounces from mailings. https://docs.civicrm.org/user/en/latest/initial-set-up/scheduled-jobs/#job_fetch_bounces',
'api_entity' => 'Job',
'api_action' => 'fetch_bounces',
'parameters' => 'is_create_activities=0',
],
[
'run_frequency' => 'Hourly',
'name' => 'Process Inbound Emails',
'description' => 'Inserts activity for a contact or a case by retrieving inbound emails from a mail directory',
'description' => 'Inserts activity for a contact or a case by retrieving inbound emails. https://docs.civicrm.org/user/en/latest/initial-set-up/scheduled-jobs/#job_fetch_activities',
'api_entity' => 'Job',
'api_action' => 'fetch_activities',
],
[
'run_frequency' => 'Daily',
'name' => 'Process Pledges',
'description' => 'Updates pledge records and sends out reminders',
'description' => 'Updates pledge records and sends out reminders. https://docs.civicrm.org/user/en/latest/initial-set-up/scheduled-jobs/#job_process_pledge',
'api_entity' => 'Job',
'api_action' => 'process_pledge',
'parameters' => 'send_reminders=[1 or 0] optional- 1 to send payment reminders',
'parameters' => 'send_reminders=0',
],
[
'run_frequency' => 'Daily',
'name' => 'Geocode and Parse Addresses',
'description' => 'Retrieves geocodes (lat and long) and / or parses street addresses (populates street number, street name, etc.)',
'description' => 'Geocodes and/or parses street addresses. https://docs.civicrm.org/user/en/latest/initial-set-up/scheduled-jobs/#job_geocode',
'api_entity' => 'Job',
'api_action' => 'geocode',
'parameters' => 'geocoding=[1 or 0] required
parse=[1 or 0] required
start=[contact ID] optional-begin with this contact ID
end=[contact ID] optional-process contacts with IDs less than this
throttle=[1 or 0] optional-1 adds five second sleep',
'parameters' => 'geocoding=1
parse=0
throttle=0',
],
[
'run_frequency' => 'Daily',
'name' => 'Update Greetings and Addressees',
'description' => 'Goes through contact records and updates email and postal greetings, or addressee value',
'name' => 'Update Individual Email Greeting',
'description' => 'Update Individual Email Greeting. https://docs.civicrm.org/user/en/latest/initial-set-up/scheduled-jobs/#job_update_greeting',
'api_entity' => 'Job',
'api_action' => 'update_greeting',
'parameters' => 'ct=[Individual or Household or Organization] required
gt=[email_greeting or postal_greeting or addressee] required
force=[0 or 1] optional-0 update contacts with null value, 1 update all
limit=Number optional-Limit the number of contacts to update',
'parameters' => 'ct=Individual
gt=email_greeting',
],
[
'run_frequency' => 'Daily',
'name' => 'Update Individual Postal Greeting',
'description' => 'Update Individual Postal Greeting. https://docs.civicrm.org/user/en/latest/initial-set-up/scheduled-jobs/#job_update_greeting',
'api_entity' => 'Job',
'api_action' => 'update_greeting',
'parameters' => 'ct=Individual
gt=postal_greeting',
],
[
'run_frequency' => 'Daily',
'name' => 'Update Individual Addressee',
'description' => 'Update Individual Addressee. https://docs.civicrm.org/user/en/latest/initial-set-up/scheduled-jobs/#job_update_greeting',
'api_entity' => 'Job',
'api_action' => 'update_greeting',
'parameters' => 'ct=Individual
gt=addressee',
],
[
'run_frequency' => 'Daily',
'name' => 'Mail Reports',
'description' => 'Generates and sends out reports via email',
'description' => 'Generates and sends out reports via email. https://docs.civicrm.org/user/en/latest/initial-set-up/scheduled-jobs/#job_mail_report',
'api_entity' => 'Job',
'api_action' => 'mail_report',
'parameters' => 'instanceId=[ID of report instance] required
format=[csv or print] optional-output CSV or print-friendly HTML, else PDF',
'parameters' => '',
],
[
'run_frequency' => 'Hourly',
'name' => 'Send Scheduled Reminders',
'description' => 'Sends out scheduled reminders via email',
'description' => 'Sends out scheduled reminders via email. https://docs.civicrm.org/user/en/latest/initial-set-up/scheduled-jobs/#job_send_reminder',
'api_entity' => 'Job',
'api_action' => 'send_reminder',
],
[
'run_frequency' => 'Always',
'name' => 'Update Participant Statuses',
'description' => 'Updates pending event participant statuses based on time',
'description' => 'Updates pending event participant statuses based on time. https://docs.civicrm.org/user/en/latest/initial-set-up/scheduled-jobs/#job_process_participant',
'api_entity' => 'Job',
'api_action' => 'process_participant',
],
[
'run_frequency' => 'Daily',
'name' => 'Update Membership Statuses',
'description' => 'Updates membership statuses. WARNING: Membership renewal reminders have been migrated to the Schedule Reminders functionality, which supports multiple renewal reminders.',
'description' => 'Updates membership statuses. https://docs.civicrm.org/user/en/latest/initial-set-up/scheduled-jobs/#job_process_membership',
'api_entity' => 'Job',
'api_action' => 'process_membership',
],
[
'run_frequency' => 'Always',
'name' => 'Process Survey Respondents',
'description' => 'Releases reserved survey respondents when they have been reserved for longer than the Release Frequency days specified for that survey.',
'description' => 'Releases reserved survey respondents. https://docs.civicrm.org/user/en/latest/initial-set-up/scheduled-jobs/#job_process_respondent',
'api_entity' => 'Job',
'api_action' => 'process_respondent',
],
[
'run_frequency' => 'Hourly',
'run_frequency' => 'Monthly',
'name' => 'Clean-up Temporary Data and Files',
'description' => 'Removes temporary data and files, and clears old data from cache tables. Recommend running this job every hour to help prevent database and file system bloat.',
'description' => 'Removes temporary data and files. https://docs.civicrm.org/user/en/latest/initial-set-up/scheduled-jobs/#job_cleanup',
'api_entity' => 'Job',
'api_action' => 'cleanup',
'parameters' => 'session=0',
],
[
'run_frequency' => 'Always',
'name' => 'Send Scheduled SMS',
'description' => 'Sends out scheduled SMS',
'description' => 'Sends out scheduled SMS. https://docs.civicrm.org/user/en/latest/initial-set-up/scheduled-jobs/#job_process_sms',
'api_entity' => 'Job',
'api_action' => 'process_sms',
],
[
'run_frequency' => 'Always',
'run_frequency' => 'Hourly',
'name' => 'Rebuild Smart Group Cache',
'description' => 'Rebuilds the smart group cache.',
'description' => 'Rebuilds the smart group cache. https://docs.civicrm.org/user/en/latest/initial-set-up/scheduled-jobs/#job_group_rebuild',
'api_entity' => 'Job',
'api_action' => 'group_rebuild',
'parameters' => 'limit=Number optional-Limit the number of smart groups rebuild',
'parameters' => 'limit=0',
],
[
'run_frequency' => 'Hourly',
'name' => 'Group Cache Flush',
'description' => 'Purges aged smart group cache data. https://docs.civicrm.org/user/en/latest/initial-set-up/scheduled-jobs/#job_group_cache_flush',
'api_entity' => 'Job',
'api_action' => 'group_cache_flush',
'parameters' => '',
],
[
'run_frequency' => 'Daily',
'name' => 'Disable expired relationships',
'description' => 'Disables relationships that have expired (ie. those relationships whose end date is in the past).',
'description' => 'Disables relationships that have expired. https://docs.civicrm.org/user/en/latest/initial-set-up/scheduled-jobs/#job_disable_expired_relationships',
'api_entity' => 'Job',
'api_action' => 'disable_expired_relationships',
],
[
'run_frequency' => 'Daily',
'name' => 'Validate Email Address from Mailings.',
'description' => 'Updates the reset_date on an email address to indicate that there was a valid delivery to this email address.',
'description' => 'Updates the reset_date on an email address. https://docs.civicrm.org/user/en/latest/initial-set-up/scheduled-jobs/#mailing_update_email_resetdate',
'api_entity' => 'Mailing',
'api_action' => 'update_email_resetdate',
'parameters' => 'minDays, maxDays=Consider mailings that have completed between minDays and maxDays',
'parameters' => 'minDays=5
maxDays=60',
],
[
'run_frequency' => 'Daily',
'name' => 'Dedupe Contacts',
'description' => 'Executes the Individual, Unsupervised redupe rule. https://docs.civicrm.org/user/en/latest/initial-set-up/scheduled-jobs/#job_process_batch_merge',
'api_entity' => 'Job',
'api_action' => 'process_batch_merge',
],
]);

0 comments on commit 2e8aeca

Please sign in to comment.