Site Search - Liferay Learn

Hiding the Configuration UI Liferay generates a configuration UI automatically after a configuration interface deploys. But you may have certain use cases where you want to hide the UI. For...

Dependency Injection

Official Documentation

Dependency Injection

Job Scheduler Framework

Official Documentation

Job Scheduler Framework Liferay Self-Hosted Liferay PaaS Job Scheduler is a flexible framework built on Liferay's scheduler engine for running and scheduling business logic. This framework uses...

Tuning Messaging Performance

Official Documentation

Tuning Messaging Performance Liferay DXP 2023.Q3/Portal GA92 and Below Unsupported The messaging API this tutorial covers is unavailable after Liferay DXP 2023.Q3/Portal GA92. Messaging...

Using Default Synchronous Messaging in Previous Versions

Official Documentation

Using Default Synchronous Messaging in Previous Versions Liferay DXP 7.4 U48/Portal GA49 and Below Unsupported The messaging API this tutorial covers is unavailable after Liferay DXP 7.4...

Using Direct Synchronous Messaging in Previous Versions

Official Documentation

Using Direct Synchronous Messaging in Previous Versions Liferay DXP 7.4 U48/Portal GA49 and Below Unsupported The messaging API this tutorial covers is unavailable after Liferay DXP 7.4...

Portlets

Official Documentation

Portlets Liferay DXP started off as a portal server for Java-based web applications called portlets (see JSR 168, JSR-286, and JSR-362). Portlets process requests and generate responses like any...

Portlet 3.0 API Opt In

Official Documentation

Portlet 3.0 API Opt In A portlet must specify version 3.0 to opt in to the Portlet 3.0 API. The 3.0 Portlet API version can be specified in the following ways. Standard Portlet @PortletApplication...

Portlet Descriptor to OSGi Service Property Map

Official Documentation

Portlet Descriptor to OSGi Service Property Map Here's a map of portlet XML descriptor values to OSGi service properties for publishing OSGi Portlets. The properties centralize and simplify portlet...

Portlet IDs

Official Documentation

Portlet IDs Below is a listing of the portlet IDs for the default portlets in Liferay DXP. You can use these IDs to embed portlets in your theme's sitemap. Collaboration PortletID...

Servlets

Official Documentation

Servlets

Data Frameworks

Official Documentation

Data Frameworks

Asset Framework

Official Documentation

Asset Framework The asset framework is behind many of Liferay's most powerful features. It provides tools for displaying and interacting with any type of content and data. For example, if you build...

Service Builder

Official Documentation

Service Builder An application without reliable business logic or persistence isn't much of an application at all. Unfortunately, writing your own persistence code often takes a great deal of time....

Advanced Queries

Official Documentation

Advanced Queries Service Builder doesn't limit you to elements in service.xml. If simple finders aren't sufficient for getting data out of your application, there are three other ways to make the...

Using Custom SQL Queries

Using Custom SQL Queries Service Builder creates finder methods that retrieve entities by their attributes (their column values). When you add a column as a parameter for the finder in your...

Using Domain-Specific Language Queries

Using Domain-Specific Language Queries Liferay 7.4+ DSL Query is an acronym for Domain-Specific Language Query. The foundation is based upon using a domain-specific language for the...

Using Dynamic Query

Using Dynamic Query Liferay's Dynamic Query API wraps Hibernate's Criteria API. It helps you think in terms of objects and member variables instead of tables and columns. Complex queries can be...

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

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

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

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

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

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

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

Completely Custom Configuration

Official Documentation

Completely Custom Configuration A configuration UI is generated automatically when you create a configuration interface. But in some cases you want a completely custom UI for your configuration....

Categorizing a Configuration

Official Documentation

Categorizing a Configuration When you register a configuration interface, the UI for your application is generated in System Settings → Platform → Third Party. If you prefer a different section and...

Configuration Form Renderer

Official Documentation

Configuration Form Renderer When you create a configuration interface, a configuration UI is automatically generated. But in some cases you want customize the look and feel of the UI. For example,...

Configuration Model Listener Reference

Official Documentation

Configuration Model Listener Reference Use model listeners in your own configurations to listen for events and execute code in response. Creating a model listener requires only three steps: ...

DDM Form Annotations

Official Documentation

DDM Form Annotations The auto-generated configuration interface UI may be too simplistic for some configurations. You can use the Dynamic Data Mapping (DDM) form annotations to customize your...

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

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

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

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

Configuration Framework

Official Documentation

Configuration Framework Setting and Accessing Configurations Categorizing a Configuration Scoping Configurations Portlet Level Configuration Configuration Form Renderer DDM Form Annotations ...

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

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

Reference

Official Documentation

Reference Node Version Information

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

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

Field Options Provider

Official Documentation

Field Options Provider You can populate a drop-down list manually in the @Meta.AD annotation of the configuration interface. But you can also populate the option labels and values automatically...

Enabling Assets

Official Documentation

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

Cache

Official Documentation

Cache

Data Scopes

Official Documentation

Data Scopes

Expando

Official Documentation

Expando Accessing Custom Fields with Expando

Accessing Custom Fields With Expandos

Official Documentation

Accessing Custom Fields With Expandos When you need additional fields in your application, you can always add them in your service model definition and re-run Service Builder. This adds new columns...

Implementing an Item Selector

Official Documentation

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

Business Logic with Service Builder

Official Documentation

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

Configuring service.properties

Official Documentation

Configuring service.properties Service Builder generates a service.properties file in your *-service module's src/main/resources folder. Liferay uses this file's properties to alter your service's...

Connecting Service Builder to an External Database

Official Documentation

Connecting Service Builder to an External Database Service builder creates the necessary tables for the service in the lportal database with all other data used by Liferay. If you want to store the...

Defining Entities

Official Documentation

Defining Entities Entities are the heart and soul of a service. They represent the map between the model objects in Java and your database fields and tables. Service Builder automatically maps your...

Adding Model Hints

Official Documentation

Adding Model Hints Once you've used Service Builder to define model entities, you may want to refine how users enter that data. Model hints specify entity data restrictions and other formatting....

Configuring Global Service Options

Official Documentation

Configuring Global Service Options A service's global options apply to all its entities. Here are the options: Dependency Injector Package path Multiversion concurrency control Namespace...

Defining Entity Columns

Official Documentation

Defining Entity Columns An entity's columns represent its attributes. These attributes map table fields to Java object fields. Here you'll examine the sample project from Understanding and...

Defining Entity Finder Methods

Official Documentation

Defining Entity Finder Methods Finder methods retrieve entity objects from the database based on specified parameters. For each finder defined, Service Builder generates several methods to fetch,...

Search Results