Skip to content

Commit

Permalink
CIVICRM-2189 Revisit the default Scheduled Jobs. Adjust the frequency…
Browse files Browse the repository at this point in the history
…. Remove comments from API parameters which cause the Job to not execute. Update description with parameters comments
  • Loading branch information
agileware-justin committed Nov 8, 2023
1 parent f40de18 commit c895c4b
Showing 1 changed file with 35 additions and 23 deletions.
58 changes: 35 additions & 23 deletions sql/civicrm_data/civicrm_job.sqldata.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,7 @@
[
'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 CiviCRM version updates. Important for keeping the database secure. Also sends anonymous usage statistics to civicrm.org to assist in prioritizing ongoing development efforts.',
'api_entity' => 'Job',
'api_action' => 'version_check',
'is_active' => 1,
Expand Down Expand Up @@ -41,42 +40,45 @@
[
'run_frequency' => 'Daily',
'name' => 'Process Pledges',
'description' => 'Updates pledge records and sends out reminders',
'description' => 'Updates pledge records and sends out reminders. Use parameters: send_reminders=[1 or 0], use 1 to send payment reminders',
'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' => 'Retrieves geocodes (lat and long) and / or parses street addresses (populates street number, street name, etc.) Use 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',
'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',
'api_entity' => 'Job',
'api_action' => 'update_greeting',
'parameters' => 'ct=[Individual or Household or Organization] required
'description' => 'Goes through contact records and updates email and postal greetings, or addressee value. Use 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',
'api_entity' => 'Job',
'api_action' => 'update_greeting',
'parameters' => 'ct=Individual
gt=email_greeting',
],
[
'run_frequency' => 'Daily',
'name' => 'Mail Reports',
'description' => 'Generates and sends out reports via email',
'description' => 'Generates and sends out reports via email. Use parameters: instanceId=[ID of report instance] required
format=[pdf,csv,print] optional-output CSV or print-friendly HTML, else PDF',
'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',
Expand Down Expand Up @@ -107,7 +109,7 @@
'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.',
'api_entity' => 'Job',
Expand All @@ -121,12 +123,20 @@
'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. Use parameters: limit=Number optional-Limit the number of smart groups 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' => 'Flushes the Smart Group Cache',
'api_entity' => 'Job',
'api_action' => 'group_cache_flush',
'parameters' => '',
],
[
'run_frequency' => 'Daily',
Expand All @@ -138,9 +148,11 @@
[
'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 to indicate that there was a valid delivery to this email address. Consider mailings that have completed between minDays and maxDays. Use parameters: minDays=[number]
maxDays=[number]',
'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',
],
]);

0 comments on commit c895c4b

Please sign in to comment.