For the managed package runtime, the Batch Action runs a Vlocity Scheduled Job with a Data Source Type of Data Input, Query, List Input, or No Input. A Vlocity scheduled job calls either another Integration Procedure or a VlocityOpenInterface.
This information is for Omnistudio for Managed Packages. For Omnistudio on standard runtime, see Omnistudio Help.
The format of the input that the Scheduled Job sends to the Integration Procedure or
VlocityOpenInterface it invokes differs based on the Is
Input As List and Batch Size job fields. The original
input to the Batch Action is passed in under a vlcInputMap JSON node.
For example, suppose the job has a Data Source Type of
Query and a query that selects Accounts. And suppose in the Batch
Action's input you specify a Key of CompanyName and a
Value of Acme. If Is Input As
List is not checked in the job configuration, the input that the Scheduled
Job sends looks like this:
{"Id": "00161000015IvYnAAK", "vlcInputMap": {"CompanyName": "Acme"}} If Is Input As List is checked and the Batch
Size is 1 in the job configuration, the input looks like this, with a
records node for the list:
{"records": [{"Id": "00161000015IvYnAAK"}], "vlcInputMap": {"CompanyName": "Acme"}}If Is Input As List is checked and the Batch
Size is 2, the input looks like this, again with a records node for the list:
{"records": [{"Id": "00161000015IvYnAAK"}, {"Id": "001610000050IKQAA2"}], "vlcInputMap": {"CompanyName": "Acme"}}If the Data Source Type is List Input, see the following example for an explanation of the input that the Scheduled Job sends to the Integration Procedure.
If the Data Source Type is set to List Input or if Is Input As List is checked, the input must be in list format even if the list contains only one item. Omnistudio Data Mapper Extracts that return a list with one item often convert it to a single object. To convert a single object back into a list, you can use the first example in Omnistudio Data Mapper Transform Examples (Managed Package).
The Integration Procedure doesn't wait for the job that its Batch Action calls to finish.
However, the Batch Action returns the Id of the Apex batch job in the ApexJobId node of the Integration Procedure's output
JSON.
- Batch Action Properties for Integration Procedures (Managed Package)
For the managed package runtime, these properties are unique to or function in a unique manner in Batch Actions. The Batch Action runs a Vlocity Scheduled Job with a Data Source Type of Data Input, Query, List Input, or No Input. A Vlocity Scheduled Job calls either another Integration Procedure or a VlocityOpenInterface. - Workflow for Batch Action Example (Managed Package)
For the managed package runtime, one Integration Procedure uses a Batch Action to invoke a Vlocity Scheduled Job, which invokes a second Integration Procedure on a schedule.