Development and tooling

Client Extensions UI Reference

Client Extensions UI Reference Liferay's widget client extensions (custom element and iframe) register applications with Liferay, adding them as widgets to site pages. Additionally, you can style...

Published Date: May 9, 2024 6:54 PM

Message Bus

Message Bus The Message Bus provides a loosely coupled way to exchange messages. A class sending a message invokes the Message Bus to send the message to a destination, while other classes...

Published Date: May 9, 2024 6:53 PM

Using a CSS Client Extension

Using a CSS Client Extension Liferay 7.4+ CSS client extensions introduce new CSS styling to pages. A deployed CSS client extension on a page adds to the page's existing styling, including theme...

Published Date: May 9, 2024 6:54 PM

Using a JavaScript Client Extension

Using a JavaScript Client Extension Liferay 7.4+ With a JavaScript (JS) client extension, you can run your own JavaScript on any page in Liferay without worrying about dependencies on Liferay code...

Published Date: May 9, 2024 6:54 PM

CSS YAML Configuration Reference

CSS YAML Configuration Reference You can define a CSS client extension with a client-extension.yaml file. Usage Details This client-extension.yaml file defines a CSS client extension definition: ...

Published Date: May 9, 2024 6:54 PM

Theme CSS YAML Configuration Reference

Theme CSS YAML Configuration Reference You can define a theme CSS client extension with a client-extension.yaml file. Usage Details This client-extension.yaml file defines a theme CSS client...

Published Date: May 9, 2024 6:54 PM

Using a Theme Favicon Client Extension

Using a Theme Favicon Client Extension Liferay 7.4+ With a theme favicon client extension, you can override the theme's favicon on the selected page. Start with the sample workspace to build and...

Published Date: May 9, 2024 6:54 PM

Theme Favicon YAML Configuration Reference

Theme Favicon YAML Configuration Reference You can define a theme favicon client extension with a client-extension.yaml file. Usage Details This client-extension.yaml file defines a theme favicon...

Published Date: May 9, 2024 6:54 PM

Theme Sprite Map YAML Configuration Reference

Theme Sprite Map YAML Configuration Reference You can define a theme sprite map client extension with a client-extension.yaml file. Usage Details This client-extension.yaml defines a theme sprite...

Published Date: May 9, 2024 6:54 PM

JavaScript YAML Configuration Reference

JavaScript YAML Configuration Reference You can define a JavaScript client extension with a client-extension.yaml file. Usage Details This client-extension.yaml file defines a JavaScript client...

Published Date: May 9, 2024 6:54 PM

Using a Theme CSS Client Extension

Using a Theme CSS Client Extension Liferay 7.4+ With a theme CSS client extension, you can override the current theme's CSS files (main.css and clay.css) to change the look and feel of a page....

Published Date: May 9, 2024 6:54 PM

Using a Theme Sprite Map Client Extension

Using a Theme Sprite Map Client Extension Liferay DXP 2023.Q4+/Portal GA100+ With a theme sprite map client extension, you can override the default Clay sprite map used for icons on a page. Start...

Published Date: May 9, 2024 6:54 PM

Editor Config Contributor YAML Configuration Reference

Editor Config Contributor YAML Configuration Reference Liferay DXP 2024.Q1+/Portal GA112+ This feature is currently behind a release feature flag (LPS-186870). Read Release Feature Flags for more...

Published Date: May 9, 2024 6:54 PM

Using an Editor Config Contributor Client Extension

Using an Editor Config Contributor Client Extension Liferay DXP 2024.Q2+/Portal GA120+ Editor Config Contributor client extensions override existing CKEditor configuration in a...

Published Date: May 9, 2024 6:54 PM

Creating Data Sets

Creating Data Sets Liferay DXP 2024.Q1+/Portal GA112+ Currently, this feature is behind a release feature flag (LPS-164563). You can create data sets from different resources available through...

Published Date: May 9, 2024 6:54 PM

Using Data Set Actions

Using Data Set Actions Liferay DXP 2024.Q1/Portal GA112 Currently, this feature is behind a release feature flag (LPS-164563). Here are some examples for how to use data set actions and perform...

Published Date: May 9, 2024 6:54 PM

Batch YAML Configuration Reference

Batch YAML Configuration Reference Use a client-extension.yaml file to define a batch client extension. Usage Details This client-extension.yaml file defines a client extension of type batch: ...

Published Date: May 9, 2024 6:54 PM

Managing Data Sets

Managing Data Sets Liferay DXP 2024.Q1+/Portal GA112+ Currently, this feature is behind a release feature flag (LPS-164563). Once you create a data set, you can customize how users see it....

Published Date: May 9, 2024 6:54 PM

Data Set Visualization Modes

Data Set Visualization Modes Liferay DXP 2024.Q1+/Portal GA112+ Currently, this feature is behind a release feature flag (LPS-164563). To customize the data display in your data set, use the...

Published Date: May 9, 2024 6:54 PM

Importing/Exporting Data

Importing/Exporting Data Liferay Self-Hosted Liferay SaaS Liferay PaaS Liferay 7.4 If you want to import or export data from Liferay, you use batch client extensions. Use and reuse your data...

Published Date: May 9, 2024 6:54 PM

Integrating External Applications

Integrating External Applications Custom Element and IFrame client extensions register applications with Liferay and render them as widgets on site pages. When you create one of these frontend...

Published Date: May 9, 2024 6:54 PM

Integrating Microservices

Integrating Microservices Liferay Self-Hosted Liferay SaaS Liferay PaaS Liferay 7.4 You can define microservice client extensions to run your own code in response to events in your Liferay...

Published Date: May 9, 2024 6:54 PM

Notification Type YAML Configuration Reference

Notification Type YAML Configuration Reference You can define a notification type client extension with a client-extension.yaml file. Usage Details This client-extension.yaml file defines a...

Published Date: May 9, 2024 6:54 PM

Object Action YAML Configuration Reference

Object Action YAML Configuration Reference You can define an object action client extension with a client-extension.yaml file. Usage Details This client-extension.yaml defines an object action and...

Published Date: May 9, 2024 6:54 PM

Creating a Basic Custom Element

Creating a Basic Custom Element Liferay 7.4+ Custom element client extensions use Liferay's frontend infrastructure to register external, remote applications with the Liferay platform and render...

Published Date: May 9, 2024 6:54 PM

Custom Element YAML Configuration Reference

Custom Element YAML Configuration Reference You can define a custom element client extension with a client-extension.yaml file. Usage Details This client-extension.yaml file defines a custom...

Published Date: May 9, 2024 6:54 PM

Using an IFrame Client Extension

Using an IFrame Client Extension Liferay 7.4+ IFrame client extensions use Liferay's frontend infrastructure to register external applications as HTML elements. They're added to Liferay pages as...

Published Date: May 9, 2024 6:54 PM

IFrame YAML Configuration Reference

IFrame YAML Configuration Reference You can define an IFrame client extension with a client-extension.yaml file. Data Usage This client-extension.yaml file defines an IFrame client extension: ...

Published Date: May 9, 2024 6:54 PM

Using Routes with Custom Elements

Using Routes with Custom Elements Liferay 7.4+ Custom element client extensions use Liferay's frontend infrastructure to register external applications with the Liferay platform and render them as...

Published Date: May 9, 2024 6:54 PM

Using a Microservice Client Extension

Using a Microservice Client Extension A microservice client extension is a standalone server process that relies on OAuth 2 for communication with Liferay. The microservice is a resource server and...

Published Date: May 9, 2024 6:54 PM

Object Validation Rule YAML Configuration Reference

Object Validation Rule YAML Configuration Reference To define an Object Validation Rule client extension, add the objectValidationRule type to your client-extension.yaml file. Usage Details This...

Published Date: May 9, 2024 6:54 PM

Workflow Action YAML Configuration Reference

Workflow Action YAML Configuration Reference You can define a workflow action client extension with a client-extension.yaml file. Usage Details This client-extension.yaml file defines a workflow...

Published Date: May 9, 2024 6:54 PM

Creating and Managing Objects

Creating and Managing Objects Liferay 7.4+ Liferay Objects provides a convenient UI for creating custom applications that meet your business needs without writing code. You can also use Objects to...

Published Date: May 9, 2024 6:54 PM

Actions

Actions Object actions define custom business logic that you can run manually or automatically for object entry events. Examples include delivering entry event data to a webhook URL, sending email...

Published Date: May 9, 2024 6:54 PM

Understanding Action Types

Understanding Action Types Liferay 7.4 U60+/GA60+ Actions define custom operations triggered by object entry events. Liferay provides these action types: TypeDescription NotificationSend email or...

Published Date: May 9, 2024 6:54 PM

Objects

Objects Liferay 7.4+ With Liferay Objects, you can build and deliver applications without having to write code or deploy modules. Each application built with Objects is integrated with Liferay's...

Published Date: May 9, 2024 6:54 PM

Defining Object Actions

Defining Object Actions Liferay 7.4 U60+/GA60+ Object actions define operations that you can run manually or automatically for object entry events. To add an action, Open the Global Menu (...

Published Date: May 9, 2024 6:54 PM

Using Manual Actions

Using Manual Actions Liferay 7.4 U60+/GA60+ When you use the standalone trigger for object actions, the actions become manual instead of automatic. Trigger these actions using these methods: ...

Published Date: May 9, 2024 6:54 PM

Fields

Fields Liferay DXP 2023.Q4+/Portal GA102+ Object fields are data definitions that represent database columns and store different types of values. All objects include default system fields, but you...

Published Date: May 9, 2024 6:54 PM

Aggregation Fields

Aggregation Fields Liferay 7.4 U47+/GA47+ Aggregation fields perform basic calculations on the entries from a relationship table and display the resulting values. Available aggregation functions...

Published Date: May 9, 2024 6:54 PM