Asynchronous Bean Saves

Why I needed this

In my SugarCRM installation I have many logic hooks that update values in other modules.  For example, when you save a note it, in the before_save logic hook, it updates a "Last Note Update" field (among others) in the related Case.  So that means that you save the note and it has to run all the logic hooks, workflows, advanced workflows and SugarLogic on that note and then it would have to run all that stuff on the related case as well, all while the user waits for their save to finish.

In the past to avoid the overhead of a bean save I would just update the related bean with a direct SQL call.  But this means you lose out on logic_hooks, workflow and all the rest.  So if you can off-load all that extra bean save overhead to a JobQueue job, it will speed up saves while not impacting workflow or logic hooks the way a direct SQL call would.  The JobQueue is explained in the developer guide here.

So this is an example of the kind of code I am talking about and the new code I use

	<?php
	//OLD WAY
	$opportunityBean = BeanFactory::getBean('Opportunities', $bean->parent_id);
	$opportunityBean->last_note_created_c = $bean->date_entered;
	$opportunityBean->last_note_c = $bean->description;
	$opportunityBean->save();
	//NEW WAY
	$data = array('last_note_created_c' => $bean->date_entered,
	'last_note_c' => $bean->description);
	//I feed it the name of the module and the ID instead of a BEAN because
	// I don't want to waste the time loading the bean here. Let the JobQueue do that
	updateBean('Opportunities', $bean->parent_id, $data);

view raw bs_hook.php hosted with ❤ by GitHub

The 'new' code would call a function I have placed in a file called custom/Extension/application/Ext/Utils/UpdateBean.php.  This makes it available anywhere in the app. Custom utilities are in the developer guide here.  That file looks like this

	<?php
	/**
	* @param string $beanModule
	* @param string $beanID
	* @param array $data
	*/
	function updateBean($beanModule, $beanID, $data = array())
	{
	$job = new SchedulersJob();
	$job->name = "Update trigger_workflow_c - {$beanModule}:{$beanID}";
	$data = array(
	'beanModule' => $beanModule,
	'beanID' => $beanID,
	'updatedFields' => $data);
	$jsonData = json_encode($data);
	$job->data = $jsonData;
	$job->target = 'class::updateBeanJob';
	//user the job runs as admin so we don't have permission issues
	$job->assigned_user_id = '1';
	// Now push into the queue to run
	$jq = new SugarJobQueue();
	$jobid = $jq->submitJob($job);
	}

view raw UpdateBean.php hosted with ❤ by GitHub

That function submits a job to the job queue and it will run the next time cron runs.  So you bean save might be delayed by a minute but your user doesn't have to sit through it.  The final file, the job itself is in a file called custom/Extension/modules/Schedulers/Ext/ScheduledTasks/updateBeanJob.php and looks like this

	<?php
	if (!defined('sugarEntry') || !sugarEntry) {
	die('Not A Valid Entry Point');
	}
	class updateBeanJob implements RunnableSchedulerJob
	{
	public function setJob(SchedulersJob $job)
	{
	$this->job = $job;
	}
	public function run($data)
	{
	$decodedData = json_decode($data);
	//Get needed data
	$beanModule = $decodedData->beanModule;
	$beanID = $decodedData->beanID;
	$updatedFields = $decodedData->updatedFields;
	//Load Bean
	// I disable teams and the cache just in case, the Job Queue usually runs as admin
	// so I am not sure it is really necessary.
	$params = array('use_cache' => false, 'disable_row_level_security' => true);
	$focus = BeanFactory::getBean($beanModule, $beanID, $params);
	//Fill in data
	// I iterate through the array fed to the class and update them in the loaded Bean
	foreach ($updatedFields as $fieldName => $fieldValue) {
	$focus->$fieldName = $fieldValue;
	}
	//Save
	$focus->save();
	//always return TRUE as if you don't the Job will be marked as failing even though it worked.
	return true;
	}
	}

view raw updateBeanJob.php hosted with ❤ by GitHub

So thats it, easy Asynchronous bean saves.