Configuration

To get to the Background Update module navigate to Administration and go down to the Jackal Software add-ons panel and click on the Background Updater link:

Click Create from the List View and configure the settings by: 1. Select Target Module 2. Enter the number of records to update each run (Save to see the number of records not updated in the last 24 hours)

Repeat for each module you want the background process to update. If a module isn't showing that you want to configure navigate to Administration->Dropdown Editor and update the list called 'cf_module_list'. The left field should be the value that shows in the browser address bar when you are in the module minus the #. The right field can be the display value for the module.

Process Order

Set the process order to force Background Updater to run all records in certain modules first. This functionality is important where parent-child relationships exist and some records need to be updated before others for calculations to function properly.

All records in a given process order that have not been updated in the last day will be processed first. If there are records left over after each run lower process order modules are not ran.

Custom Queries

For cases where not all records need to be processed we now allow for custom SQL queries to filter records. This is vital for organizations with a large amount of data and only a subset need calculation updating. To enable custom queries first Check the Developer Override checkbox and then enter your query in the text area. Queries should be tested either in a local environment or by using Advanced Reports for Enterprise and Higher version of Sugar.

• Queries must return 1 and exactly 1 columns with the name 'id'. Be careful if you are joining tables as almost all Sugar tables have an 'id' column
  • Queries must exclude deleted records within the query
  • Queries should filter to exclude records updated in the last day to allow all records to be updated in order. Otherwise the same records will likely get updated continually.

Upon save we analyze queries to test their validity. If found invalid the record is marked Inactive and the contents of the query are commented out using SQL syntax

Modified By Override

Admins can specify given processes to not update the date modified or modified by fields when records are updated. A checkbox on each process called "Do not update modified fields" tells Background Update to use a custom field instead of the standard date_modfied field. This feature prevents conflicts with reporting or workflow needs based on the modified fields.

Clear Logs

Admins can clear logs from a given process in the Action Menu in a process Record View. When confirmed the logs for a given process are deleted from the database.

See this video for a walkthrough of the Modified Override and Delete Logs features: