A background job runs a background script without making the user wait for the task to finish. Like it’s name implies, a background job runs as a background process.

The background job can be initiated in 3 ways

1. Via a trigger
2. As a scheduled job
3. Via an API call
4. As part of a workflow

Write A Background Script

To write a background script

1. Go to Setup > Scripts
2. Create a new script by clicking the new button
3. Select Background Script from the popup
4. Start writing your script.

A background script is a class that extended the mdxBackground class and implements the mdxJobInterface.

A bacground script will always implement the following three methods

1. StartJob – Write code here to initialize and variables, records queries etc.
2. RunJob – This is what gets called when the Job Executes
3. EndJob – This is what gets called once RunJob is complete.

A sample script is displayed below

 

class testBackgroundJob extends BackgroundJob implements JobInterface {

public $recordId;
public $recordData;

public function startJob() {
var_dump(“start Job at: “. date(‘Y-m-d H:i:s’));
sleep(60);
}

public function runJob() {
$record = new test_auz_second__mdx;
$record->name__mdx = $this->recordData->name__mdx;
$status = $this->mdxDB->insert($record);
var_dump(“run Job”);

$records = range(1, 200);
foreach($records as $record) {
$secondJob = new secondBackgroundJob;
$secondJob->recordId = $this->recordId;
$secondJob->recordData = $this->recordData;

$status = $this->mdxEngine->runBackgroundJob($secondJob, “BG Job 2: “. $record);
}
}

public function endJob() {
var_dump(“end Job at: “. date(‘Y-m-d H:i:s’));
}

}