Site Search - Liferay Learn

Using an OSGi Service Liferay APIs are readily available as OSGi services. You can access a service by creating a field of that service type and annotating the field with @Reference, like this: ...

Using the Gogo Shell

Official Documentation

Using the Gogo Shell The Gogo shell provides a way to interact with the module framework. Among other things, you can Dynamically install/uninstall bundles (modules) Examine package...

Command Line Gogo Shell

Official Documentation

Command Line Gogo Shell If you're in a development environment, you can interact with the module framework locally from the command line. Gogo shell should only be run from the command line in...

Gogo Shell Commands

Official Documentation

Gogo Shell Commands The Gogo shell executes Felix Gogo basic commands and Liferay commands. The Gogo shell is accessible in the Control Panel (recommended) and from the command line. Here are some...

Logs

Official Documentation

Logs The OSGi Log Service Extender enables bundles to provide OSGi logging configuration using embedded properties files META-INF/osgi-logging.properties or META-INF/osgi-logging-ext.properties....

Advanced Queries

Official Documentation

Advanced Queries Service Builder doesn't limit you to elements in service.xml. If simple finders aren't sufficient for getting data out of your application, there are three other ways to make the...

React Component Utilities Reference

Official Documentation

React Component Utilities Reference Several useful tools are available to help you build high-performance components and applications in Liferay DXP using React: frontend-js-react-web module ...

Listening for Registration Events

Official Documentation

Listening for Registration Events Liferay DXP 2023.Q3/Portal GA92 and Below The messaging API supports listening for destination and message listener registration events. Here are some reasons to...

Using Asynchronous Messaging

Official Documentation

Using Asynchronous Messaging Message Bus's asynchronous option provides fire and forget behavior; send a message and continue processing without waiting for a response. An asynchronous message is...

Using Default Synchronous Messaging in Previous Versions

Official Documentation

Using Default Synchronous Messaging in Previous Versions Liferay DXP 7.4 U48/Portal GA49 and Below In default synchronous messaging, the sender blocks while a Message Bus thread dispatches the...

Aggregating Resource Bundles

Official Documentation

Aggregating Resource Bundles When working with a module that shares localized messages, the bnd header must specify the resource bundles you want to associate with the module. Liferay provides a...

Working with Client Extensions

Official Documentation

Working with Client Extensions Liferay Self-Hosted Liferay SaaS Liferay PaaS Liferay 7.4 Using client extensions, you can extend Liferay without deploying OSGi modules. Just like traditional...

Using Direct Synchronous Messaging in Previous Versions

Official Documentation

Using Direct Synchronous Messaging in Previous Versions Liferay DXP 7.4 U48/Portal GA49 and Below Direct synchronous messaging is the easiest way to block processing until all listeners receive a...

Fundamentals

Official Documentation

Fundamentals Liferay development projects consist primarily of simple .jar files. These contain a few extra configuration files that make them OSGi modules, but they're easily understandable by...

Customizing Liferay's Look and Feel

Official Documentation

Customizing Liferay's Look and Feel One of the easiest ways to get started developing on Liferay's platform is to modify its look and feel. You can change everything from its favicon to its entire...

Language Client Extensions

Official Documentation

Language Client Extensions Liferay DXP 2025.Q1+/Portal GA132+ A language client extension adds new language keys or overrides existing keys and their translations. For example, you can translate...

Integrating Service Builder Applications with Objects

Official Documentation

Integrating Service Builder Applications with Objects You can integrate existing Service Builder applications with the Objects framework. Once integrated, your custom entities become unmodifiable...

Workflow Definition Link API Basics

Official Documentation

Workflow Definition Link API Basics Liferay DXP 2025.Q1+/Portal GA132+ You can manage workflow definition links from the Liferay UI or using Liferay's REST APIs. In Liferay, the Control Panel →...

Upgrading to Jakarta

Official Documentation

Upgrading to Jakarta Liferay DXP 2025.Q3+ Liferay stepped into the future of enterprise Java when it moved to Jakarta EE starting with the DXP 2025 Q3 and the 2026 Q1 Portal releases. This frees...

Using Object Inheritance

Official Documentation

Using Object Inheritance [Release Feature (LPD-34594)](../../../../security-and-administration/administration/configuring-liferay/feature-flags.md#release-feature-flags) Liferay DXP...

Using a CAPTCHA Client Extension

Official Documentation

Using a CAPTCHA Client Extension Liferay DXP 2025.Q3+ CAPTCHA challenges are used on websites to verify a human user is accessing it, and not a bot or malicious code attacking the site. Liferay...

CAPTCHA YAML Configuration Reference

Official Documentation

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

Configuring service.properties

Official Documentation

Configuring service.properties Service Builder generates a service.properties file in your *-service module's src/main/resources folder. Liferay uses this file's properties to alter your service's...

Liferay Workspace Configuration Reference

Official Documentation

Liferay Workspace Configuration Reference Liferay Workspace has many options you can set. Here's a handy command and properties reference. Running Liferay DXP locally my-project $ blade gw...

Managing Object Entries with Data Sets

Official Documentation

Managing Object Entries with Data Sets Data sets offer a flexible way to display object entries. When your advanced use case outgrows collections, data sets fill the gap. For example, Collections...

Scheduling and Subscription

Official Documentation

Scheduling and Subscription [Release Feature](../../../security-and-administration/administration/configuring-liferay/feature-flags.md#release-feature-flags) (LPD-17564) Liferay DXP...

Assignee Fields

Official Documentation

Assignee Fields Liferay DXP 2025.Q4+/Portal 2026.Q1+ Assignee fields are for selecting existing users or roles in the object entry. Assigned users can edit the entry with no manual permission...

Migrating to PortletMVC4Spring and Jakarta

Official Documentation

Migrating to PortletMVC4Spring and Jakarta There are two possible migrations: You've already used PortletMVC4Spring, and you want to migrate your application to Jakarta. You want to migrate a...

Using Client Extensions

Official Documentation

Using Client Extensions Liferay DXP 2024.Q1+/Portal GA112+ Using client extensions, you can extend Liferay without using OSGi modules. Deploy them to any Liferay environment, whether you host it...

Shipping Engine Client Extension Reference

Official Documentation

Shipping Engine Client Extension Reference Shipping Engine Client Extension YAML Reference FieldValueDescription keyliferay-sample-commerce-shipping-engineSpecifies the unique key for the shipping...

Using the Checkout Step Client Extension

Official Documentation

Using the Checkout Step Client Extension Liferay DXP 2024.Q1+/Portal GA112+ You can use a client extension to create a new checkout step. This tutorial uses an example client extension from the...

Checkout Step Client Extension Reference

Official Documentation

Checkout Step Client Extension Reference Checkout Step Client Extension YAML Reference FieldValueDescription activetrueSpecifies that the checkout step is active....

Payment Integration Client Extension Reference

Official Documentation

Payment Integration Client Extension Reference Payment Integration Client Extension YAML Reference FieldValueDescription keyliferay-sample-commerce-payment-integrationSpecifies the unique key for...

Creating Video Shortcut Providers

Official Documentation

Creating Video Shortcut Providers Liferay DXP 7.4+ By default, Liferay's external video shortcuts support YouTube, Vimeo, Facebook, and Twitch. However, you can extend this feature to support...

Line Charts

Official Documentation

Line Charts Line charts contain multiple sets of data. A Line chart displays the data linearly. Each data series (created with the addColumns() method) is defined with a new instance of the ...

Combination Charts

Official Documentation

Combination Charts Combination charts have minor differences from other charts. In a combination chart, you must define the representation type of each data set: AREA, AREA_SPLINE, AREA_STEP, BAR,...

Donut Charts

Official Documentation

Donut Charts Donut charts are percentage-based. A donut chart is similar to a pie chart, but it has a hole in the center. Each data set must be defined as a new instance of the SingleValueColumn...

Pie Charts

Official Documentation

Pie Charts Pie charts are percentage-based. A pie chart models percentage-based data as individual slices of pie. Each data set must be defined as a new instance of the SingleValueColumn object....

Predictive Charts

Official Documentation

Predictive Charts Predictive charts let you visualize current data along with predicted/forecasted data within a given value range. Predicted/forecasted data is surrounded by a highlighted area of...

Refreshing Charts to Reflect Real Time Data

Official Documentation

Refreshing Charts to Reflect Real Time Data The polling interval property is an optional property for all charts. It specifies the time in milliseconds for the chart's data to refresh. You can use...

Search Results