Development and tooling

Importing Packages

Importing Packages You often find yourself in a position of needing functionality provided by another module. To access this functionality, you must import packages from other modules into your...

Published Date: Nov 22, 2024 10:50 PM

Module Projects

Module Projects Liferay applications and customizations are OSGi modules: .jar files containing Java code and some extra configuration for publishing and consuming APIs. A module project comprises...

Published Date: Nov 22, 2024 10:50 PM

Semantic Versioning

Semantic Versioning Semantic Versioning is a three tiered versioning system for incrementing version numbers based on the degree of API change made in a releasable software component. It's a...

Published Date: Nov 22, 2024 10:50 PM

Specifying Dependencies

Specifying Dependencies You must satisfy all dependencies to compile and deploy a module successfully. After you find the dependency artifacts, add them as dependencies in your Gradle build file....

Published Date: Nov 22, 2024 10:50 PM

Portal Developer Properties

Portal Developer Properties There are Portal Properties that facilitate development. Liferay's portal-developer.properties file includes all of them. The portal-developer.properties file is enabled...

Published Date: Nov 22, 2024 10:50 PM

Fragment Specific Tags and Attributes Reference for Liferay 7.3 and Earlier Versions

Fragment Specific Tags and Attributes Reference for Liferay 7.3 and Earlier Versions Along with standard HTML, CSS, and JavaScript, you can use Liferay-specific tags and attributes to define...

Published Date: Nov 22, 2024 10:52 PM

Using an OSGi Service

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

Published Date: Nov 22, 2024 10:50 PM

Using the Gogo Shell

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

Published Date: Nov 22, 2024 10:50 PM

Command Line Gogo Shell

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

Published Date: Nov 22, 2024 10:50 PM

Gogo Shell Commands

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

Published Date: Nov 22, 2024 10:50 PM

Reference

Reference 7.4 Breaking Changes 7.3 Breaking Changes 7.2 Breaking Changes Exported Third-Party Packages Portal Developer Properties

Published Date: Nov 22, 2024 10:50 PM

Using Upgrade Processes in Earlier Versions

Using Upgrade Processes in Earlier Versions Liferay DXP 7.4 U10/Portal 7.4 GA14 and Below Follow these steps to create an upgrade process for your module: Open your module's bnd.bnd file, and...

Published Date: Dec 3, 2024 3:10 PM

Logs

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

Published Date: Dec 3, 2024 3:11 PM

Advanced Queries

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

Published Date: Jan 11, 2025 4:12 PM

React Component Utilities Reference

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

Published Date: Jan 18, 2025 2:48 AM

Listening for Registration Events

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

Published Date: Jan 18, 2025 2:48 AM

Using Asynchronous Messaging

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

Published Date: Jan 18, 2025 2:48 AM

Using Default Synchronous Messaging in Previous Versions

Using Default Synchronous Messaging in Previous Versions Synchronous messaging was removed and is no longer supported for Liferay DXP 7.4 U49/Liferay Portal 7.4 GA49 and above. In default...

Published Date: Jan 18, 2025 2:48 AM

Developing a JavaScript Application

Published Date: Jan 18, 2025 2:48 AM

Using Direct Synchronous Messaging in Previous Versions

Using Direct Synchronous Messaging in Previous Versions Synchronous messaging was removed and is no longer supported for Liferay DXP 7.4 U49/Liferay Portal 7.4 GA49 and above. Direct synchronous...

Published Date: Jan 18, 2025 2:48 AM

Fundamentals

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

Published Date: Jan 18, 2025 2:48 AM

Creating Video Shortcut Providers

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

Published Date: May 9, 2024 6:50 PM

Developer Guide

Published Date: May 9, 2024 6:59 PM

Aggregating Resource Bundles

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

Published Date: Jan 18, 2025 2:48 AM

Sharing Localized Messages

Sharing Localized Messages As you work on an application you might have multiple modules, each of which with its own language keys. Instead of maintaining various language properties files in...

Published Date: May 9, 2024 6:53 PM

Implementing an Item Selector

Implementing an Item Selector Item selectors are pop-up dialogs for selecting assets, such as documents, videos, or users. By configuring the item selector's criteria and defining its usage, you...

Published Date: May 9, 2024 6:52 PM

Business Logic with Service Builder

Business Logic with Service Builder Once you've generated model, persistence, and service code with Service Builder, you can begin adding business logic. Entities generated by Service Builder...

Published Date: May 9, 2024 6:52 PM

Enabling Assets

Enabling Assets Many of Liferay's applications (e.g. Blogs, Documents and Media, Message Boards, etc.) are asset-enabled out of the box. You can publish assets with the Asset Publisher widget or...

Published Date: May 9, 2024 6:52 PM

MVC Render Command

MVC Render Command MVC Render Commands are classes that handle which page to render. They are invoked by MVCPortlet render URLs and requests. If your render logic is simple you can implement all of...

Published Date: May 9, 2024 6:53 PM

Configuration as Code

Configuration as Code Liferay Self-Hosted Liferay SaaS Liferay PaaS Liferay 7.4 Liferay instance configurations are deployable with client extensions. For example, you can deploy OAuth2...

Published Date: Nov 22, 2024 10:50 PM

Core Frameworks

Published Date: Nov 22, 2024 10:50 PM

Listening for Messages

Listening for Messages You can listen for messages sent to any registered Message Bus destination, whether it's built-in to DXP/Portal, defined by third-parties, or created by you. Messages sent to...

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

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

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

Defining Object Relationships

Defining Object Relationships Liferay 7.4+ Relationships add fields and tables to object definitions for relating their entries to one another. Follow these steps to add relationships to object...

Published Date: May 9, 2024 6:54 PM

Relationships

Relationships Liferay 7.4 U47+/GA47+ Relationships add fields and tables to object definitions for relating their entries with one another. This provides access to entry data in different...

Published Date: May 9, 2024 6:54 PM

Removing Relationships

Removing Relationships Liferay 7.4 U26+/GA26+ You can remove relationships from both draft and published object definitions. Removing a relationship permanently deletes its field from the related...

Published Date: May 9, 2024 6:54 PM

Accounts API Basics

Accounts API Basics Liferay DXP/Portal 7.4+ You can manage accounts from the Applications menu or use Liferay's REST APIs. Call these services to create and manage accounts. Adding an Account ...

Published Date: Feb 12, 2025 1:01 PM

Adding the UAD Framework

Adding the UAD Framework You can manage and delete user data with Liferay's User Associated Data (UAD) management tool. The tool is available out-of-the-box for many of Liferay's applications (e.g....

Published Date: May 9, 2024 6:59 PM

User Groups API Basics

User Groups API Basics You can Create and Manage User Groups from the Application menu, but you can also use Liferay's REST APIs. Call these services to manage user groups. Adding a User Group ...

Published Date: May 9, 2024 6:59 PM

Using the Checkout Step Client Extension

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

Published Date: May 9, 2024 6:45 PM

Using the Payment Integration Client Extension

Using the Payment Integration Client Extension Liferay DXP 2024.Q1+/Portal GA112+ You can use a client extension to integrate with a new payment method in Liferay. This client extension from the...

Published Date: May 9, 2024 6:45 PM

Using the Shipping Engine Client Extension

Using the Shipping Engine Client Extension Liferay DXP 2024.Q1+/Portal GA112+ You can use a client extension to add a new shipping engine to Liferay. This client extension from the sample...

Published Date: May 9, 2024 6:45 PM

Using Client Extensions

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

Published Date: May 9, 2024 6:45 PM

Portlet Preferences

Portlet Preferences You can give administrators and users a way to customize a portlet with portlet preferences. Portlet preferences can be added to any MVC Portlet to give users a UI to access and...

Published Date: May 9, 2024 6:53 PM

Working with Client Extensions

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

Published Date: Jan 18, 2025 2:48 AM

Portlet Level Configuration

Portlet Level Configuration With the configuration framework, you can set your application's configuration for different levels of scope. Where Instance and Site-scoped configurations use...

Published Date: Nov 22, 2024 10:50 PM

Setting and Accessing Configurations

Setting and Accessing Configurations You can use Liferay's configuration framework to add a settings UI for a MVC Portlet. See the Example Portlet Then, follow these steps: Download and unzip...

Published Date: May 9, 2024 6:53 PM

Customizing Liferay's Look and Feel

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

Published Date: Jan 18, 2025 2:48 AM

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

Using a Frontend Data Set Filter Client Extension

Using a Frontend Data Set Filter Client Extension Liferay DXP 2024.Q2+/Portal GA120+ Frontend data set filter client extensions define JavaScript functions for creating customizable filter...

Published Date: Jun 6, 2024 3:55 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

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

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 an Editor Config Contributor Client Extension

Using an Editor Config Contributor Client Extension Liferay DXP 2024.Q1+/Portal GA112+ The translation status feature is currently behind a release feature flag (LPS-186870). Read Release Feature...

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

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

Objects Application Permissions

Objects Application Permissions Liferay 7.4 2023.Q4+/GA102+ The Objects application is integrated with the permissions framework, so you can assign application and resource permissions to user...

Published Date: May 9, 2024 6:54 PM