Batch

# description

Ships a folder of JSON files that Liferay's Headless Batch Engine ingests when the extension is registered. Any Headless-Batch-compatible resource can be provisioned this way — users, roles, organizations, sites, vocabularies, taxonomy, custom Objects, and dozens more. Batch is the standard mechanism for shipping reference data with a Liferay application: seed a fresh install with baseline categories, roles, and users so the app is usable immediately after deploy. The paired `oAuthApplicationHeadlessServer` gives the Batch Engine authenticated access to whatever Liferay Headless APIs your JSON payloads target.

Bulk data import and full site provisioning on deploy.

# when to use

• →You want reference data (categories, vocabularies, org units) provisioned on deploy — not created by hand.
• →You're seeding a new environment (dev, staging) from a known dataset.

# how to use

1. 01Put your JSON files under batch/.
2. 02Ship a sibling oAuthApplicationHeadlessServer and reference it via oAuthApplicationHeadlessServer:.
3. 03The Batch Engine runs on deploy.

# required fields

# optional fields

# example

my-batch:
    type: batch
    name: Seed Categories
    oAuthApplicationHeadlessServer: my-oauth-headless

# related types

Usually shipped alongside Batch:

• ❯OAuth Application (Headless Server)— Register a server-to-server OAuth application.

# more in batch & provisioning

• ❯Site InitializersiteInitializer