When should I use the Object Validation Rule client extension type?

• Validation rules are more complex than the built-in expression language supports. • You need to validate against a live external source (address lookup, uniqueness across systems).

How do I create a Object Validation Rule client extension?

1. Ship a paired `oAuthApplicationUserAgent`. 2. Set `resourcePath:` to your validation handler; return `{valid: bool, errorMessage: string}`.

What fields are required on a Object Validation Rule client extension?

resourcePath (string): Validation handler path. oAuth2ApplicationExternalReferenceCode (string): Ref code of the paired `oAuthApplicationUserAgent`.

Object Validation Rule

Validate a Liferay Object entry via an external service.

type: objectValidationRule·Microservice·Liferay docs →

# description

Registers a webhook that Liferay calls to validate an Object entry. Return `valid: false` and Liferay rejects the write with your error message.

Externalize business logic — actions, validation, workflow, notifications.

# when to use

→Validation rules are more complex than the built-in expression language supports.
→You need to validate against a live external source (address lookup, uniqueness across systems).

# how to use

01Ship a paired oAuthApplicationUserAgent.
02Set resourcePath: to your validation handler; return {valid: bool, errorMessage: string}.

# required fields

field	type	description
`resourcePath`required	`string`	Validation handler path.
`oAuth2ApplicationExternalReferenceCode`required	`string`	Ref code of the paired `oAuthApplicationUserAgent`.

# optional fields

field	type	description
`name`	`string`	Display name.
`allowedObjectDefinitionNames`	`string[]`	Restrict to specific Objects.
`dxp.lxc.liferay.com.virtualInstanceId`	`string`	Scope to a virtual instance.

# example

client-extension.yaml

address-validation:
    type: objectValidationRule
    name: Address Validation
    resourcePath: /validate/address
    oAuth2ApplicationExternalReferenceCode: my-oauth-ua

# related types

Usually shipped alongside Object Validation Rule:

❯OAuth Application (User Agent)— Register a browser / SPA OAuth application.

# more in microservice

cd ..scaffold this type in VS Code →