You are here:
Batch Jobs for Integration Procedures and Vlocity Open Interfaces
The Vlocity batch framework lets you run an Integration Procedure or VlocityOpenInterface on a schedule. Typical use cases are a recurrent billing cycle or a scan for insurance policies that come up for renewal in the next 60 days. When a job is run, it sends its input to an Integration Procedure or Apex method that processes the records.
Batch Actions and Scheduled Jobs are available in Omnistudio if the Omnistudio package was installed before the Salesforce Industries package was installed. See OmniStudio-First Side-by-Side Package Installation Results.
The input can be one of the following:
-
Null: The Integration Procedure or VlocityOpenInterface finds data using its Actions or methods.
-
SOQL query: The result of a static query is the input.
-
JSON data with merge fields: The Integration Procedure is called by a business process that has contextual data, such as an Omniscript, and is queued immediately rather being scheduled.
To define the jobs to be run, you add records to the Vlocity Scheduled Job custom object. To launch scheduled jobs, you can:
-
Run the Vlocity batch framework
-
Launch jobs programmatically
The following sections describe these tasks in detail.
- Batch Framework Initialization
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. - Programmatic Job Invocation
Use VlocityBatchFramework methods to start scheduled jobs with a Data Source Type of Query. You can start all jobs, multiple jobs, or a single job. You can also invoke an Integration Procedure or VlocityOpenInterface as a job.
