Site Search - Liferay Learn

Liferay Workspace Configuration Reference

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

Bundler Migration Guide

Official Documentation

Bundler Migration Guide The Liferay npm bundler is deprecated of Liferay 2024.Q4/Portal GA129, and it's planned for future removal.

Migrating a Plain JavaScript, Billboard JS, JQuery, Metal JS, React, or Vue JS Project to Use Liferay npm Bundler 2.x

Official Documentation

Migrating a Plain JavaScript, Billboard JS, JQuery, Metal JS, React, or Vue JS Project to Use Liferay npm Bundler 2.x The Liferay npm bundler is deprecated of Liferay 2024.Q4/Portal GA129, and...

Upgrading to Jakarta

Official Documentation

Upgrading to Jakarta Liferay DXP 2025.Q3+/Portal 2026.Q1+ 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...

Migrating a liferay-npm-bundler Project from 1.x to 2.x

Official Documentation

Migrating a liferay-npm-bundler Project from 1.x to 2.x The Liferay npm bundler is deprecated of Liferay 2024.Q4/Portal GA129, and it's planned for future removal. liferay-npm-bundler 2.x offers...

Creating Deployment Environments

Official Documentation

Creating Deployment Environments There comes a point when your code is ready to share. For that, you must build an environment. In the corporate world, there are usually three environments: ...

Liferay npm Bundler (Deprecated)

Official Documentation

Liferay npm Bundler (Deprecated) The Liferay npm bundler is deprecated of Liferay 2024.Q4/Portal GA129, and it's planned for future removal.

Migrating an Angular Project to Use Liferay npm Bundler 2.x

Official Documentation

Migrating an Angular Project to Use Liferay npm Bundler 2.x The Liferay npm bundler is deprecated of Liferay 2024.Q4/Portal GA129, and it's planned for future removal. Follow these steps to...

Liferay CLI Tool

Official Documentation

Liferay CLI Tool The Liferay CLI tool is deprecated as of Liferay 2024.Q4/Portal GA129, and it's planned for future removal. The Liferay CLI tool makes it easy to create Angular, JavaScript,...

Other Tools (Deprecated)

Official Documentation

Other Tools (Deprecated) These tools are deprecated as of Liferay 2024.Q4/Portal GA129, and they are planned for future removal. Modern browsers (and Liferay DXP) all support including JavaScript...

How the Bundler Publishes npm Packages

Official Documentation

How the Bundler Publishes npm Packages The Liferay npm bundler is deprecated of Liferay 2024.Q4/Portal GA129, and it's planned for future removal. When you deploy an OSGi bundle with the...

Default Bundler Loaders

Official Documentation

Default Bundler Loaders The Liferay npm bundler is deprecated of Liferay 2024.Q4/Portal GA129, and it's planned for future removal. Several loaders are available for the liferay-npm-bundler by...

Changes Between Bundler 1.x and 2.x

Official Documentation

Changes Between Bundler 1.x and 2.x The Liferay npm bundler is deprecated of Liferay 2024.Q4/Portal GA129, and it's planned for future removal. This article outlines the key changes between...

How AMD Loader Configuration is Exported

Official Documentation

How AMD Loader Configuration is Exported The Liferay npm bundler is deprecated of Liferay 2024.Q4/Portal GA129, and it's planned for future removal. If you don't understand how Liferay AMD...

Migrating Your Project to Use liferay-npm-bundler's New Mode

Official Documentation

Migrating Your Project to Use liferay-npm-bundler's New Mode The Liferay npm bundler is deprecated of Liferay 2024.Q4/Portal GA129, and it's planned for future removal. Since issue #303, two...

Understanding Bundler Configuration Presets

Official Documentation

Understanding Bundler Configuration Presets The Liferay npm bundler is deprecated of Liferay 2024.Q4/Portal GA129, and it's planned for future removal. The liferay-npm-bundler comes with a...

Understanding the Liferay npm Bundler Loader

Official Documentation

Understanding the Liferay npm Bundler Loader The Liferay npm bundler is deprecated of Liferay 2024.Q4/Portal GA129, and it's planned for future removal. liferay-npm-bundler's mechanism is...

OSGi Bundles and npm Package Structure

Official Documentation

OSGi Bundles and npm Package Structure The Liferay npm bundler is deprecated of Liferay 2024.Q4/Portal GA129, and it's planned for future removal. To deploy JavaScript modules, you must create an...

Poshi Test Automation

Official Documentation

Poshi Test Automation Poshi is a test automation framework that is simple, easy to understand, and does not require prior development experience to get started. Poshi tests can be written to...

Understanding the npmbundlerrc Structure

Official Documentation

Understanding the npmbundlerrc Structure The Liferay npm bundler is deprecated of Liferay 2024.Q4/Portal GA129, and it's planned for future removal. The liferay-npm-bundler is configured via a...

How JavaScript Modules are Formatted for AMD

Official Documentation

How JavaScript Modules are Formatted for AMD The Liferay npm bundler is deprecated of Liferay 2024.Q4/Portal GA129, and it's planned for future removal. Liferay AMD Loader is based on the AMD...

Liferay npm Bundler

Official Documentation

Liferay npm Bundler The Liferay npm bundler is deprecated of Liferay 2024.Q4/Portal GA129, and it's planned for future removal. The liferay-npm-bundler is a bundler (like Webpack or Browserify)...

Getting Started

Official Documentation

Getting Started Previously, Poshi tests could only be executed by downloading and creating the test files within the Liferay source code. The Poshi Standalone gradle project enables you to use...

Creating a Macro File

Official Documentation

Creating a Macro File Test Scenario Write your first macro file using the test scenario below: You would like to test that your name does not appear on any learn.liferay.com article. The steps you...

Running a Test

Official Documentation

Running a Test Open the poshi-ext.properties file on your poshi-standalone directory and add the following line, replacing the TestCaseFileName#TestCaseName with the one you created in Creating A...

Poshi Basics

Official Documentation

Poshi Basics New features, improvements, and system upgrades can sometimes introduce unexpected behaviors and bugs. Running suites of automated tests is an advantageous method of identifying issues...

Functions

Official Documentation

Functions In Poshi, Functions handle extra WebDriver commands that an element might require to interact with a page object or element. Functions combine the basic methods defined in the...

Testcases

Official Documentation

Testcases A testcase file in Poshi is a collection of test scenarios grouped in blocks of code called test blocks. The three main test blocks: setUp, test, and tearDown, are made up of multiple...

Understanding Test Results and Debugging Tests

Official Documentation

Understanding Test Results and Debugging Tests Poshi tests are run on the terminal or command line. When a test run is completed there are multiple ways to view the test results and diagnose test...

Poshi Advantages

Official Documentation

Poshi Advantages Simplified Syntax To make it easier for less technical testers to read and write test automation, Poshi uses a simplified Groovy-like script syntax. It is less wordy than most...

Creating A Path File

Official Documentation

Creating A Path File Test Scenario Write your first path file using the test scenario below: You would like to test that your name does not appear on any learn.liferay.com article. The steps you...

Syntax Validation

Official Documentation

Syntax Validation The Poshi Standalone grade projects includes a validation task that can be used to check your code for syntax errors before running your test. To use this, simply run ./gradlew...

Macros

Official Documentation

Macros A macro is a set of functions that perform a task. Macros are where locators (paths) and functions are brought together to script interactions that a user performs on the system being...

Creating the Testcase File

Official Documentation

Creating the Testcase File Test Scenario Write your first testcase file using the test scenario below: You would like to test that your name does not appear on any learn.liferay.com article. The...

Setup

Official Documentation

Setup Prerequisites A supported version of Java. Google Chrome. Gradle or Gradle Wrapper 6.6.1 or higher. Setting up the Poshi Standalone Gradle Project Create a new directory, example...

Poshi Layers

Official Documentation

Poshi Layers

Paths

Official Documentation

Paths A path is an element on a page that a test will interact with. An element can be a button, text field, link, image, paragraph, or just about anything you would need to assert, click, or type...

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

Using Poshi Resources

Official Documentation

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

Poshi Resources

Official Documentation

Poshi Resources To give Poshi test writers easy access to commonly used functions or other files, Poshi resources were created to store existing Poshi files as dependencies that can be loaded apart...

Reference

Official Documentation

Reference Node Version Information

Using Variables

Official Documentation

Using Variables Though not a Poshi layer, variables are a large part of Poshi tests. Variables, like in other programming languages, are used to store data which can be referenced and reused in...

Configuration

Official Documentation

Configuration In order to give test writers easy access to commonly used functions, paths, or macros, Poshi resources were created to store existing Poshi files as dependencies. These resources can...

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

Core Frameworks

Official Documentation

Core Frameworks

Traditional Java-Based Development

Official Documentation

Traditional Java-Based Development Liferay is a complex open-source platform built on several key technologies and architectural principles. Liferay is written mostly in Java and built on the OSGi...

Resource Types and Structure

Official Documentation

Resource Types and Structure Properties activeIndividualsCount (Number): Number of active individuals belonging to the account. dateCreated (Date): Date the account was created in the system. ...

Warehouse API Basics

Official Documentation

Warehouse API Basics You can manage warehouses from the Applications menu or REST APIs. Call the headless-commerce-admin-inventory services to create and manage warehouses. Adding a Warehouse ...

Blog API Basics

Official Documentation

Blog API Basics Liferay's REST APIs provide services for adding, modifying, and deleting blog posts and images. Liferay DXP 2024.Q4+/Portal GA129+ The Blogs API now uses External Reference Codes...

Term API Basics

Official Documentation

Term API Basics You can manage terms and conditions from the Applications menu or with REST APIs. Use the /terms endpoint from headless-admin-commerce-order to create and manage terms and...

Discount API Basics

Official Documentation

Discount API Basics You can manage discounts from the Applications menu or with REST APIs. Call the headless-admin-commerce-pricing services to create and manage discounts. Adding a Discount Once...

Channel API Basics

Official Documentation

Channel API Basics You can manage channels from the Applications menu or with REST APIs. Call the headless-commerce-admin-channel services to create and manage channels. Adding a Channel Once...

Store Management Basics

Official Documentation

Store Management Basics Here is a comprehensive resource for understanding and leveraging Liferay’s Channel API basics.

Catalog API Basics

Official Documentation

Catalog API Basics You can manage catalogs from the Applications menu or REST APIs. Call the headless-commerce-admin-catalog services to create and manage catalogs. Adding a Catalog Once Liferay...

Product Management APIs

Official Documentation

Product Management APIs You can invoke the services under headless-commerce-admin-catalog to perform various admin operations related to products. However, if you have a headless storefront, you...

Specification API Basics

Official Documentation

Specification API Basics You can manage product specifications from the Applications menu or with REST APIs. Call the headless-commerce-admin-catalog services to create and manage specifications. ...

Querying Data

Official Documentation

Querying Data The root endpoint of Liferay Analytics Cloud is . You can get the list of all data types endpoints by requesting a GET to the above URL. Try with curl curl -i -L -H "Authorization:...

Pricing APIs

Official Documentation

Pricing APIs Use the Price List and Discount APIs to manage product pricing and discounts in Liferay Commerce programmatically. Below are basic usage examples, including common endpoints and...

Option Value API Basics

Official Documentation

Option Value API Basics You can manage option values from the Options application or with REST APIs. Call the headless-commerce-admin-catalog services to create and manage option values. Adding an...

Asset Libraries API Basics

Official Documentation

Asset Libraries API Basics Liferay's REST APIs provide endpoints for creating, retrieving, updating, and deleting asset libraries. Starting with Liferay DXP 2025.Q4, these same endpoints also...

Search Results