Batched execution

When an Action is triggered in batches, such as in Workshop inline edits or in Automate, the backing Function is usually called once per request in sequence, and all edits are applied atomically at the end of the Action call.

Alternatively, to improve performance or resolve edit conflicts, you may wish to configure a Function to receive the whole batch of Action calls in a single execution.

To enable batched execution, the Function must receive a single input parameter containing a list of structs (also known as a "map" or "dictionary"). You will then be able to enable batched execution and pass data into the fields of this struct in the same way you would usually pass data to a Function’s top-level inputs.

When using batched execution:

• A single Action call will invoke a single Function execution with a single entry in the list input parameter.
• A batched Action call will invoke a single Function execution with several entries in the list input parameter.

Example

Instead of a Function-backed Action with the following signature:

Copied!
1
2
3
4
@OntologyEditFunction()
  public updateDestination(flight: Flight, destination: Airport): void {
    // update flight object
}

A Function can instead receive a "batch" of requests and process them all in a single execution:

Copied!
1
2
3
4
5
6
@OntologyEditFunction()
public updateDestinationBatch(batch: {flight: Flight, destination: Airport}[]): void {
    batch.forEach(({flight, destination}) => {
      // update flight object
    });
}

You can then enable batched execution for this Function when configuring the Action type: