Development and tooling

Using Poshi Resources Once the Poshi resources jar file is loaded onto your Poshi project, you are now able to use Liferay's commonly used functions, paths, and macros. To distinguish between files...

Published Date: May 9, 2024 6:55 PM

Reference

Official Documentation

Reference Node Version Information

Published Date: May 9, 2024 6:55 PM

Node Version Information

Official Documentation

Node Version Information Liferay DXP uses Node (and NPM) for many different frontend components. Specifically, the Liferay Theme Generator and Liferay's JavaScript application tools require the use...

Published Date: May 9, 2024 6:55 PM

Using the Bootstrap 3 Compatibility Layer in Liferay 7.4

Official Documentation

Using the Bootstrap 3 Compatibility Layer in Liferay 7.4 As of Liferay DXP 7.4 GA1, the Bootstrap 3 compatibility layer is removed from the built-in packages in Liferay frontend applications. If...

Published Date: May 9, 2024 6:55 PM

7.2 Breaking Changes

Official Documentation

7.2 Breaking Changes This document presents a chronological list of changes that break existing functionality, APIs, or contracts with third party Liferay developers or users. We try our best to...

Published Date: May 9, 2024 6:55 PM

Using Glowroot with Liferay

Official Documentation

Using Glowroot with Liferay Liferay DXP 2023.Q4+/Portal GA100+ Liferay bundles Glowroot, the open source Java application monitoring tool. The tool displays helpful statistics about your system...

Published Date: May 9, 2024 6:59 PM

Troubleshooting JVM Issues with Glowroot

Official Documentation

Troubleshooting JVM Issues with Glowroot Liferay DXP 2023.Q4+/Portal GA100+ Glowroot displays a dashboard for identifying system issues quickly. Click the Errors tab to see a list of tracked...

Published Date: May 9, 2024 6:59 PM

Troubleshooting Templates with Glowroot Freemarker Plugin

Official Documentation

Troubleshooting Templates with Glowroot Freemarker Plugin Liferay DXP 2023.Q4+/Portal GA100+ Glowroot can troubleshoot FreeMarker templates to pinpoint slow transactions. Configuring the...

Published Date: May 9, 2024 6:59 PM

Invoking Liferay Services From Scripts

Official Documentation

Invoking Liferay Services From Scripts Many scripting scenarios require invoking Liferay services. Liferay *ServiceUtil classes are the fastest and most convenient way to invoke Liferay services in...

Published Date: May 9, 2024 6:59 PM

Developing Glowroot Plugins

Official Documentation

Developing Glowroot Plugins Liferay DXP 2023.Q4+/Portal GA100+ Glowroot provides various out-of-the-box plugins. You can also build your own with the use of their plugin API. Here are some tips...

Published Date: May 9, 2024 6:59 PM

Liferay Performance Use Cases with Glowroot

Official Documentation

Liferay Performance Use Cases with Glowroot Liferay DXP 2023.Q4+/Portal GA100+ Use Glowroot to diagnose and inform you on making performance improvements to your Liferay installation. Here are a...

Published Date: May 9, 2024 6:59 PM

Troubleshooting Liferay Performance Issues with Glowroot

Official Documentation

Troubleshooting Liferay Performance Issues with Glowroot Liferay DXP 2023.Q4+/Portal GA100+ Use Glowroot to identify and diagnose performance issues in your Liferay installation. The following...

Published Date: May 9, 2024 6:59 PM

Using the Script Engine

Official Documentation

Using the Script Engine Liferay provides a robust script engine for executing Groovy scripts. You can execute scripts to perform maintenance tasks involving data cleanup, user maintenance...

Published Date: May 9, 2024 6:59 PM

Running Scripts From the Script Console

Official Documentation

Running Scripts From the Script Console The Script Console provides a single view for executing Groovy scripts and printing their output. It has predefined variables that facilitate working with...

Published Date: May 9, 2024 6:59 PM

Script Examples

Official Documentation

Script Examples Here are some examples to help you use scripts in DXP. Most of the examples originated from the Liferay blog post 5 Tips to Improve Usage of the Liferay Script Console. Example 1:...

Published Date: May 9, 2024 6:59 PM

7.3 Breaking Changes

Official Documentation

7.3 Breaking Changes This document presents a chronological list of changes that break existing functionality, APIs, or contracts with third party Liferay developers or users. We try our best to...

Published Date: May 9, 2024 6:55 PM

7.4 Breaking Changes

Official Documentation

7.4 Breaking Changes Breaking changes break or significantly alter existing functionality or code structure. Here are all of the breaking changes for Liferay 7.4, starting with the latest quarterly...

Published Date: May 9, 2024 6:55 PM

Exported Third Party Packages

Official Documentation

Exported Third Party Packages Liferay provides over one-hundred third party Java packages at run time. The com.liferay.portal.bootstrap module exports the packages by specifying individual packages...

Published Date: May 9, 2024 6:55 PM

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

Published Date: Feb 12, 2025 12:57 PM

Migrating Your Database from MySQL to PostgreSQL

This recipe guides the user on how to migrate from MySQL to PostgreSQL database.

Published Date: Feb 27, 2025 7:28 PM

Developing Page Fragments

Official Documentation

Developing Page Fragments Page fragments are the building blocks for content pages. They're made from the three components of web pages: CSS, HTML, and JavaScript. To create a page you combine...

Published Date: May 9, 2024 6:57 PM

Applying Styles to Fragments

Official Documentation

Applying Styles to Fragments When you add a fragment to a page, you can use the sidebar menu to configure the fragment, including the Styles configuration tab. Use the Styles tab in the sidebar...

Published Date: May 9, 2024 6:57 PM

Auto-Deploying Fragments

Official Documentation

Auto-Deploying Fragments Liferay Portal 7.3 GA1+ or Liferay DXP 7.3+ If you're developing page fragments with your own tooling, you can deploy them by packaging them in ZIP files for importing via...

Published Date: May 9, 2024 6:57 PM

Adding Configuration Options to Fragments

Official Documentation

Adding Configuration Options to Fragments Liferay DXP 7.2 SP1 Configurable options make your fragments flexible, minimizing the maintenance of similar fragments. For example, instead of creating...

Published Date: May 9, 2024 6:57 PM

Best Practices for Using Fragment Configurations

Official Documentation

Best Practices for Using Fragment Configurations When you are creating page fragments for your site with your own configurations, it's your responsibility to use them in their HTML presentation...

Published Date: May 9, 2024 6:57 PM

Developing Page Fragments Reference

Official Documentation

Developing Page Fragments Reference The Developing Fragments Reference provides essential information on key aspects of fragment development in Liferay. It covers command references, configuration...

Published Date: May 9, 2024 6:57 PM

Creating a Contributed Fragment Set

Official Documentation

Creating a Contributed Fragment Set Contributed fragment sets are deployable modules containing page fragments. Fragments in a contributed set can be used like regular fragments, but aren't...

Published Date: May 9, 2024 6:57 PM

Defining Fragment Drop Zones

Official Documentation

Defining Fragment Drop Zones Drop zones are integral to building your content pages. With them, you can create unique page layouts and dynamic displays by defining areas within fragments where...

Published Date: May 9, 2024 6:57 PM

Including Default Resources in Fragments

Official Documentation

Including Default Resources in Fragments You can include images files (e.g. .gif, .jpg, .jpeg, or .png) direct in your fragment sets. Keeping images with your fragments, rather than in other...

Published Date: May 9, 2024 6:57 PM

Fragment Specific Tags and Attributes Reference

Official Documentation

Fragment Specific Tags and Attributes Reference Along with standard HTML, CSS, and JavaScript, you can use Liferay-specific tags and attributes to define editable sections, embed widgets, and more....

Published Date: May 9, 2024 6:57 PM

Fragment Configuration Types Reference

Official Documentation

Fragment Configuration Types Reference Below are the available configuration types for fragments. See Adding Configuration Options to Fragments for more on how to make a fragment configurable. ...

Published Date: May 9, 2024 6:57 PM

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

Official Documentation

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 Custom Fields in Page Fragments

Official Documentation

Using Custom Fields in Page Fragments If you've added custom fields to Liferay's users or pages, you can access them in fragments. To get the value of a page custom field, use ...

Published Date: May 9, 2024 6:57 PM

Fragments Toolkit Command Reference

Official Documentation

Fragments Toolkit Command Reference The Fragments Toolkit is deprecated as of Liferay 2024.Q1+/Portal GA112+. See Alternatives for the Fragments Toolkit for more information. The Fragments...

Published Date: May 9, 2024 6:57 PM

Page Fragment Editor Interface Reference

Official Documentation

Page Fragment Editor Interface Reference The page fragment editor's interface is organized into two tabs: Code Editor Configuration The sections below cover how to use these portions of the...

Published Date: May 9, 2024 6:57 PM

Setting the Order of Elements in a Fragment

Official Documentation

Setting the Order of Elements in a Fragment Liferay 7.4+ The Slider or Tab fragments are typically used to show different areas of information. Sliders present this information in a carousel of...

Published Date: May 9, 2024 6:57 PM

Using the Fragments Editor

Official Documentation

Using the Fragments Editor Liferay DXP includes a built-in editor for developing content page fragments. To access the editor, open the Site Menu ( Site Menu ) and navigate to Design → Fragments....

Published Date: May 9, 2024 6:57 PM

Using the Fragments Toolkit

Official Documentation

Using the Fragments Toolkit The Fragments Toolkit is deprecated as of Liferay 2024.Q1+/Portal GA112+. See Alternatives for the Fragments Toolkit for more information. The Fragments Toolkit helps...

Published Date: May 9, 2024 6:57 PM

Validating Fragment Configurations

Official Documentation

Validating Fragment Configurations When defining fragment configuration options, you can add validation properties to text type fields that determine rules for valid entries. Determine what type of...

Published Date: May 9, 2024 6:57 PM

Using a Site Initializer Client Extension

Official Documentation

Using a Site Initializer Client Extension Liferay DXP 2023.Q4+/Portal GA100+ Site Initializer client extensions can quickly create or update a site, complete with configurations and content. Start...

Published Date: Oct 16, 2024 4:13 PM

Adding a Language

Official Documentation

Adding a Language Liferay ships with over 50 languages out-of-the-box. Translation is complete for many of these languages, and some are still in the translation process. Each language has its own...

Published Date: Jul 18, 2024 8:39 PM

Creating Code with Liferay Workspace

Official Documentation

Creating Code with Liferay Workspace Liferay Workspace is the developer's tool for creating and managing Liferay development projects. Creating Projects Blade CLI makes it easy to create projects...

Published Date: May 9, 2024 6:55 PM

Using Manual Actions

Official Documentation

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

Creating Form Fragments

Official Documentation

Creating Form Fragments Liferay 7.4 U45+/GA45+ The form components fragments are for building your object's forms in a content page. If Liferay's form fragments don't satisfy your use case, create...

Published Date: May 9, 2024 6:57 PM

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

Published Date: May 9, 2024 6:45 PM

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

Published Date: May 9, 2024 6:45 PM

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

Published Date: May 9, 2024 6:45 PM

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

Published Date: May 9, 2024 6:45 PM

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

Published Date: May 9, 2024 6:45 PM

Using the Payment Integration Client Extension

Official Documentation

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

Official Documentation

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

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

Published Date: Feb 19, 2025 12:28 PM

Account Groups API Basics

Official Documentation

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

Published Date: Feb 13, 2025 12:50 PM

User Management APIs

Official Documentation

User Management APIs You can use headless APIs to interface with important Liferay user management features, including user accounts, organizations, and roles. Here are resources to help you...

Published Date: May 9, 2024 6:59 PM

Account Users and Roles APIs

Official Documentation

Account Users and Roles APIs You can manage Account Users and Account Roles from the Applications menu, but you can also use Liferay's REST APIs. Call these services to create and manage account...

Published Date: May 9, 2024 6:59 PM

Accounts API Basics

Official Documentation

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

Official Documentation

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

Organizations API Basics

Official Documentation

Organizations API Basics You can Create and Manage Organizations from the Application menu, but you can also use Liferay's REST APIs. Call these services to manage organizations. Adding an...

Published Date: May 9, 2024 6:59 PM

Countries API Basics

Official Documentation

Countries API Basics Liferay 7.4 U24+ and GA24+ Use Liferay's Rest APIs to create and manage countries. Adding a Country Then, follow these steps: Download and unzip Countries API Basics. ...

Published Date: May 9, 2024 6:59 PM

Postal Address API Basics

Official Documentation

Postal Address API Basics Liferay DXP/Portal 7.4+ Use Liferay's REST APIs to manage postal addresses. Add Postal Address to Account Then, follow these steps: Download and unzip Postal Address...

Published Date: May 9, 2024 6:59 PM