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

Poshi Test Automation

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

Published Date: May 9, 2024 6:55 PM

Creating A Path File

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

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

Syntax Validation

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

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

Creating A Liferay Workspace

Creating A Liferay Workspace You can create a Liferay Workspace manually or with Blade CLI. Creating a Liferay Workspace Manually To create a Liferay Workspace manually, you must have Gradle...

Published Date: May 9, 2024 6:55 PM

Creating Code with Liferay Workspace

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

Other Tools (Deprecated)

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

Published Date: May 9, 2024 6:55 PM

Creating Deployment Environments

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

Published Date: May 9, 2024 6:55 PM

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

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

Published Date: May 9, 2024 6:55 PM

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

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

Published Date: May 9, 2024 6:55 PM

Liferay CLI Tool

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

Published Date: May 9, 2024 6:55 PM

Liferay npm Bundler (Deprecated)

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

Published Date: May 9, 2024 6:55 PM

Bundler Migration Guide

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

Published Date: May 9, 2024 6:55 PM

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

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

Published Date: May 9, 2024 6:55 PM

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

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

Published Date: May 9, 2024 6:55 PM

Understanding the npmbundlerrc Structure

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

Published Date: May 9, 2024 6:55 PM

Changes Between Bundler 1.x and 2.x

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

Published Date: May 9, 2024 6:55 PM

Default Bundler Loaders

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

Published Date: May 9, 2024 6:55 PM

How AMD Loader Configuration is Exported

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

Published Date: May 9, 2024 6:55 PM

How the Bundler Publishes npm Packages

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

Published Date: May 9, 2024 6:55 PM

How JavaScript Modules are Formatted for AMD

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

Published Date: May 9, 2024 6:55 PM

OSGi Bundles and npm Package Structure

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

Published Date: May 9, 2024 6:55 PM

Understanding Bundler Configuration Presets

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

Published Date: May 9, 2024 6:55 PM

Liferay npm Bundler

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

Published Date: May 9, 2024 6:55 PM

Understanding the Liferay npm Bundler Loader

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

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

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

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

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

Reference

Reference Node Version Information

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

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

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

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

Workflow Definition Link API Basics

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

Creating Form Fragments

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

Developer Guide

Developer Guide Below are developer-related articles for site building.

Published Date: May 9, 2024 6:57 PM

Fragment Configuration Types Reference

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

Developing Page Fragments Reference

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

Fragment Specific Tags and Attributes Reference

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

Fragments Toolkit Command Reference

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

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

Developing Page Fragments

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

Adding Configuration Options to Fragments

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

Applying Styles to Fragments

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

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

Best Practices for Using Fragment Configurations

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

Creating a Contributed Fragment Set

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

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

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

Setting the Order of Elements in a Fragment

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

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

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

Validating Fragment Configurations

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