Batch Framework Initialization (Managed Package)

For the managed package runtime, the Vlocity batch framework launches the jobs that are defined in the Vlocity Scheduled Job custom object. To start the Vlocity batch framework, you must execute Apex code, which creates an instance of the framework and invokes its start method.

Managed Package app icon This information is for Omnistudio for Managed Packages. For Omnistudio on standard runtime, see Omnistudio Help.

VlocityBatchFramework batchFramework = new VlocityBatchFramework();
batchFramework.startBatchScheduler('<frequency>');

These commands create a CronTrigger (scheduled job) with the name VlocityScheduledJob.

The Frequency parameter specifies how often the batch framework checks for jobs to launch. To ensure that jobs are executed on the desired schedule, specify a frequency greater than or equal to that of the highest-frequency job. For example, if you have a job that is scheduled to run hourly, specify Hourly or 15 Minutes for the batch framework frequency. Note that the timing of job execution is controlled entirely by the batch framework, and jobs might not be executed at precise intervals.

VlocityBatchFramework batchFramework = new VlocityBatchFramework();
batchFramework.startBatchScheduler('15 Minutes');