Development and tooling

Tuning Messaging Performance

Tuning Messaging Performance Messaging performance is tuned at the destinations. Performance depends on the destination type, the amount of processing the message listeners require, and the thread...

Published Date: May 9, 2024 6:53 PM

Portlet Providers

Published Date: May 9, 2024 6:53 PM

Servlets

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 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

Using a Theme Sprite Map Client Extension

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

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

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

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 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

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 7.4 2023.Q4+/GA102+ Object fields are data definitions that represent database columns and store different types of values. All objects include default system fields, but you can...

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

Activating and Deactivating Objects

Activating and Deactivating Objects Custom objects are activated when published. While active, you can use the object to create entries via the Liferay UI or dedicated REST APIs. If needed, you can...

Published Date: May 9, 2024 6:54 PM

Auditing Object Events

Auditing Object Events Liferay 7.4 U72+/GA72+ You can use Liferay's audit framework to track events for custom object definitions and their entries. To track entry events, you must enable entry...

Published Date: May 9, 2024 6:54 PM

Creating Objects

Creating Objects Liferay 7.4 2023.Q4+/GA102+ Liferay Objects provides development capabilities in the Liferay UI. Using Objects, you can build fully integrated Liferay applications without writing...

Published Date: May 9, 2024 6:54 PM

Deleting Objects

Deleting Objects Liferay 7.4 U26+/GA26+ You can delete draft and published object definitions. Deleting a definition removes its associated data, including the stored entries for published...

Published Date: May 9, 2024 6:54 PM

Exporting and Importing Object Definitions

Exporting and Importing Object Definitions Liferay 7.4 U68+/GA68+ You can export and import object definitions as .json files. These files include the definition's complete schema (e.g.,...

Published Date: May 9, 2024 6:54 PM

Extending System Objects

Extending System Objects Liferay 7.4 U86+/GA86+ With Liferay Objects, you can extend supported system services. Currently, only these services are integrated with the Objects framework: Account...

Published Date: May 9, 2024 6:54 PM

Adding and Managing Custom States

Adding and Managing Custom States Liferay 7.4+ Some use cases may require assigning multiple states to an object entry at the same time. For example, when building an Order application, you may...

Published Date: May 9, 2024 6:54 PM

Adding Fields to Objects

Adding Fields to Objects Liferay 7.4 2023.Q4+/GA102+ Fields are data definitions that represent database columns and store different types of values. By default, all objects include these system...

Published Date: May 9, 2024 6:54 PM

Encrypted Fields

Encrypted Fields Self-Hosted and Self-Managed Only Liferay 7.4 U72+/GA72+ Liferay provides the encrypted field type for storing sensitive user data. To use encrypted fields, first add an...

Published Date: May 9, 2024 6:54 PM

Formula Fields

Formula Fields Liferay 7.4 2023.Q4+/GA102+ Formula fields store read-only values calculated using numeric fields in the object definition. Example use cases include calculating an employee's...

Published Date: May 9, 2024 6:54 PM

Using Read-Only Fields

Using Read-Only Fields Some use cases may require data fields to be read-only. For example, data integrity may require some field values to remain immutable, or you may need to prevent unauthorized...

Published Date: May 9, 2024 6:54 PM

Designing Object Layouts

Designing Object Layouts Liferay 7.4 U31+/GA31+ Layouts define how fields and relationships appear when creating and editing object entries. Each layout can include multiple tabs containing...

Published Date: May 9, 2024 6:54 PM

Picklist Fields

Picklist Fields Liferay 7.4 U72+/GA72+ Picklists define lists of text values usable as single select or multi-select fields in object definitions. By default, single select fields appear as...

Published Date: May 9, 2024 6:54 PM

Layouts

Layouts Liferay 7.4+ Object layouts define how fields and relationships appear when creating and editing entries. All published objects include an autogenerated layout with a single tab that lists...

Published Date: May 9, 2024 6:54 PM