Development and tooling

Poshi Basics

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

Published Date: May 9, 2024 6:55 PM

Paths

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

Published Date: May 9, 2024 6:55 PM

Creating the Testcase File

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

Published Date: May 9, 2024 6:55 PM

Running a Test

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

Published Date: May 9, 2024 6:55 PM

Setup

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

Published Date: May 9, 2024 6:55 PM

Poshi Advantages

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

Published Date: May 9, 2024 6:55 PM

Poshi Layers

Published Date: May 9, 2024 6:55 PM

Functions

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

Published Date: May 9, 2024 6:55 PM

Macros

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

Published Date: May 9, 2024 6:55 PM

Testcases

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

Published Date: May 9, 2024 6:55 PM

Using Variables

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

Published Date: May 9, 2024 6:55 PM

Poshi Resources

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

Published Date: May 9, 2024 6:55 PM

Configuration

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

Published Date: May 9, 2024 6:55 PM

Using Poshi Resources

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

Reference Node Version Information

Published Date: May 9, 2024 6:55 PM

Node Version Information

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

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

Architecture

Architecture The Liferay DXP/Portal architecture has three parts: Core: Bootstraps DXP and its frameworks. The Core provides a runtime environment for managing services, UI components, and...

Published Date: May 9, 2024 6:55 PM

7.2 Breaking Changes

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

7.3 Breaking Changes

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Objects Liferay 7.4+ With Liferay Objects, you can build and deliver applications without having to write code or deploy modules. Each application built with Objects is integrated with Liferay's...

Published Date: May 9, 2024 6:54 PM

Understanding Action Types

Understanding Action Types Liferay 7.4 U60+/GA60+ Actions define custom operations triggered by object entry events. Liferay provides these action types: TypeDescription NotificationSend email or...

Published Date: May 9, 2024 6:54 PM

Attachment Fields

Attachment Fields Attachment fields are for uploading files to your instance's Document Library. When uploaded, the file is linked to the entry's attachment field, and each field can only be linked...

Published Date: May 9, 2024 6:54 PM

Auto-Increment Fields

Auto-Increment Fields DXP 2024.Q1+/Portal GA112+ Auto-Increment fields are configurable read-only fields for uniquely identifying object entries in a human-readable format. For example, an IT...

Published Date: May 9, 2024 6:54 PM

Restricting Access to Object Data by Account

Restricting Access to Object Data by Account Liferay 7.4 U58+/GA58+ In scenarios with multiple business accounts, you may want to restrict access to object entries by account. For example,...

Published Date: May 9, 2024 6:54 PM

Deploying Object Widgets to Sites

Deploying Object Widgets to Sites Liferay 7.4+ When an Object is published, Liferay automatically generates a dedicated widget you can deploy to site pages. This includes both site-scoped and...

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