Development and tooling

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, 24, 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, 24, 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, 24, 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, 24, 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, 24, 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, 24, 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, 24, 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, 24, 6:55 PM

Reference

Reference App Builder Deploying WARs (WAB Generator) JARS Excluded from WABs

Published Date: May 9, 24, 6:54 PM

Creating a Standard Application

Creating a Standard Application To create applications based on a custom object takes four steps: create the object, create at least one form view, create at least one table view, and deploy the...

Published Date: May 9, 24, 6:55 PM

Creating the Role Change Request App

Creating the Role Change Request App Subscribers The Role Change Request App starts with the employee submitting a request form. Processing then proceeds to the Current Manager, then to the...

Published Date: May 9, 24, 6:55 PM

Blade CLI

Blade CLI Blade CLI can be installed through a command line interface or a graphical installer. If you're behind a proxy, once it's installed you can configure it to operate through the proxy....

Published Date: May 9, 24, 6:55 PM

Generating Projects with Blade CLI

Generating Projects with Blade CLI Blade CLI exists to create, build, and deploy Liferay projects in Liferay Workspaces. Once created, these projects can be imported into an IDE or worked on...

Published Date: May 9, 24, 6:55 PM

App Builder

App Builder Available: Liferay CE/DXP 7.3 (deprecated and removed in 7.4) App Builder is a low-code application development solution for Liferay DXP. Build a data model, define the application's...

Published Date: May 9, 24, 6:54 PM

Creating the Role Change Request Object

Creating the Role Change Request Object Subscribers Consider a Human Resources application that collects employee requests to change Roles within the software engineering department: the Role...

Published Date: May 9, 24, 6:55 PM

Tooling

Tooling Liferay provides a variety of developer tools that include standard build scripting, lightweight CLI utilities, and full IDE based on Eclipse. This is to serve all developers, whether...

Published Date: May 9, 24, 6:55 PM

Liferay Workspace

Liferay Workspace Liferay Workspace is a set of folders and Gradle scripts that represents the Liferay-opinionated way of handling a full development life cycle: Creating projects Building...

Published Date: May 9, 24, 6:55 PM

How AMD Loader Configuration is Exported

How AMD Loader Configuration is Exported If you don't understand how Liferay AMD Loader works under the hood, please read [Liferay AMD Module Loader](./understanding-bundler-loaders.md) first. ...

Published Date: May 9, 24, 6:55 PM

Default Bundler Loaders

Default Bundler Loaders Several loaders are available for the liferay-npm-bundler by default: babel-loader: processes source files with Babel. This avoids an extra build step before the bundler....

Published Date: May 9, 24, 6:55 PM

How the Bundler Publishes npm Packages

How the Bundler Publishes npm Packages When you deploy an OSGi bundle with the specified structure, its modules are made available for consumption through canonical URLs. To better illustrate...

Published Date: May 9, 24, 6:55 PM

How JavaScript Modules are Formatted for AMD

How JavaScript Modules are Formatted for AMD Liferay AMD Loader is based on the AMD specification. All modules inside an npm OSGi bundle must be in AMD format. This is done for CommonJS modules by...

Published Date: May 9, 24, 6:55 PM

Understanding Bundler Configuration Presets

Understanding Bundler Configuration Presets The liferay-npm-bundler comes with a default configuration preset: liferay-npm-bundler-preset-standard. You may omit the liferay-npm-bundler prefix from...

Published Date: May 9, 24, 6:55 PM

Liferay npm Bundler

Liferay npm Bundler The liferay-npm-bundler is a bundler (like Webpack or Browserify) that targets Liferay Portal as a platform and assumes you're using your npm packages from widgets (as opposed...

Published Date: May 9, 24, 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, 24, 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, 24, 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, 24, 6:55 PM

Understanding Test Results and Debugging Tests

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

Published Date: May 9, 24, 6:55 PM

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, 24, 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, 24, 6:55 PM

Poshi Layers

Published Date: May 9, 24, 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, 24, 6:55 PM

Reference

Reference Node Version Information

Published Date: May 9, 24, 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, 24, 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, 24, 6:55 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: Oct 18, 24, 4:25 PM

Developer Guide

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

Published Date: May 9, 24, 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, 24, 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, 24, 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, 24, 6:57 PM

Fragments Toolkit Command Reference

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

Published Date: May 9, 24, 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, 24, 6:57 PM

Adding Configuration Options to Fragments

Adding Configuration Options to Fragments Liferay DXP 7.2 SP1 Configurable options make your fragments flexible, reducing the need to maintain many similar fragments. For example, instead of...

Published Date: May 9, 24, 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, 24, 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, 24, 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, 24, 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, 24, 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, 24, 6:57 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, 24, 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, 24, 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, 24, 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, 24, 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, 24, 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, 24, 6:57 PM

Using the Fragments Toolkit

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

Published Date: May 9, 24, 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, 24, 6:57 PM

Site Initializers

Site Initializers Liferay 2023.Q4+/GA100+ Site Initializers package pages, content, and configurations to help you jump-start a new site with much of the site already built. You can reuse them...

Published Date: Oct 16, 24, 4:33 PM

Using Glowroot with Liferay

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

Published Date: May 9, 24, 6:59 PM

Liferay Performance Use Cases with Glowroot

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

Published Date: May 9, 24, 6:59 PM

Troubleshooting JVM Issues with Glowroot

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

Published Date: May 9, 24, 6:59 PM

Troubleshooting Liferay Performance Issues with Glowroot

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

Published Date: May 9, 24, 6:59 PM