Site Search - Liferay Learn

Liferay UI Icon Help The icon help tag lets you communicate additional information to your users in an unobtrusive way. It renders as an iconic question mark that provides more information through...

Liferay UI Icon Lists

Official Documentation

Liferay UI Icon Lists An icon list displays icons in a horizontal list, instead of in a pop-up navigation menu like an icon menu. You can see an example of an icon list menu in a message board...

Liferay UI Icon Menus

Official Documentation

Liferay UI Icon Menus You can add a pop-up navigation menu to your app with the liferay-ui:icon-menu tag. Icon menus display menu options when needed, storing them away in a collapsed menu when...

Liferay UI Icons

Official Documentation

Liferay UI Icons The Liferay UI taglibs provide several icons you can include in your apps. To add an icon to your app, use the liferay-ui:icon tag and specify the icon with either the icon,...

Liferay UI Tabs

Official Documentation

Liferay UI Tabs Tabs create dividers that organize content into individual sections. Content can be embedded or included from another JSP. To add tabs to your app, use the tag and specify each...

Using Liferay Util Body Bottom

Official Documentation

Using Liferay Util Body Bottom The body bottom tag is not a self-closing tag. It lets you add additional HTML or scripts to the bottom of the body tag. content placed between the opening and...

Using Liferay Util Get URL

Official Documentation

Using Liferay Util Get URL The get URL tag scrapes the URL provided by the url attribute. If a value is provided for the var attribute, the content from the screen scrape is scoped to that...

Using Liferay Util Include

Official Documentation

Using Liferay Util Include The include tag lets you include other JSP files in your portlet's JSP, theme, or web content. This can increase readability as well as provide separation of concerns for...

Liferay Util Tag Library

Official Documentation

Liferay Util Tag Library The Liferay Util taglib is used to pull other resources into a portlet or theme. You can use it to specify which resources to insert at the bottom or top of the page's...

Using Liferay Util Body Top

Official Documentation

Using Liferay Util Body Top The body top tag is not a self-closing tag. The content placed between the opening and closing of this tag is moved to the top of the body tag. When something is passed...

Using Liferay Util Buffer

Official Documentation

Using Liferay Util Buffer The buffer tag is not a self-closing tag. The content placed between the opening and closing of this tag is saved to a buffer and its output is assigned to the Java...

Using Liferay Util Dynamic Include

Official Documentation

Using Liferay Util Dynamic Include The dynamic include tag lets you specify a point or points in a JSP or theme where a developer can inject additional HTML, resources, or functionality, using the...

Using Liferay Util HTML Bottom

Official Documentation

Using Liferay Util HTML Bottom The HTML bottom tag is not a self-closing tag. Content placed between the opening and closing of this tag is moved to the bottom of the tag. When something is passed...

Using Liferay Util HTML Top

Official Documentation

Using Liferay Util HTML Top The HTML top tag is not a self-closing tag. The content placed between the opening and closing of this tag is moved to the tag. When something is passed using this...

Using Liferay Util Whitespace Remover

Official Documentation

Using Liferay Util Whitespace Remover The whitespace remover tag removes line breaks and tabs from code blocks included between the opening and closing of the tag. Below is an example configuration...

Using a JSP and MVC Portlet

Official Documentation

Using a JSP and MVC Portlet An easy way to start developing a web application is to add markup to a JSP file and render it using a portlet Java class. The W3E7 example application demonstrates...

Scoping Configurations

Official Documentation

Scoping Configurations In Liferay DXP, you can set an application's configuration to different levels of scope: System, Instance, Site, or Portlet. For example, if you create an application to have...

Setting and Accessing Configurations

Official Documentation

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

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

Creating Job Scheduler Templates

Official Documentation

Creating Job Scheduler Templates Liferay Self-Hosted Liferay PaaS Job Scheduler Tasks are created by implementing the DispatchTaskExecutor interface. Liferay DXP provides multiple out-of-the-box...

Manually Programming Scheduled Jobs

Official Documentation

Manually Programming Scheduled Jobs Implementing the SchedulerJobConfiguration interface provides greater flexibility and improved performance as it is closer to the core of the job scheduler...

Listening for Messages

Official Documentation

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

Tuning Messaging Performance

Official Documentation

Tuning Messaging Performance Liferay DXP 2023.Q3/Portal GA92 and Below Messaging performance is tuned at the destinations. Performance depends on the destination type, the amount of processing the...

Servlets

Official Documentation

Servlets

Message Bus

Official Documentation

Message Bus The Message Bus provides a loosely coupled way to exchange messages. A class sending a message invokes the Message Bus to send the message to a destination, while other classes...

Bundling Resources

Official Documentation

Bundling Resources

Bundling and Installing Resources into Your Theme via Themelets

Official Documentation

Bundling and Installing Resources into Your Theme via Themelets Themelets are small, modular pieces of code that you can reuse in multiple themes. Unlike themes themselves, themelets may only...

Bundling Independent UI Resources via Theme Contributors

Official Documentation

Bundling Independent UI Resources via Theme Contributors Theme contributors are modules that contain CSS and JavaScript resources and apply them to every page. They are independent from specific...

Embedding Widgets Using Templates

Official Documentation

Embedding Widgets Using Templates You can embed a widget in your theme to make it available on all pages using the chosen template file. When you are embedding a widget, you will need to reference...

Bundling a Thumbnail Preview into Your Theme

Official Documentation

Bundling a Thumbnail Preview into Your Theme A theme's thumbnail is the visual representation of how the theme looks when it is applied to a Site. The thumbnail is shown in the theme selection menu...

Setting Up an Environment and Creating a Theme

Official Documentation

Setting Up an Environment and Creating a Theme Creating a theme is the first step in theme development. Once you have your own theme, you can deploy it to your Liferay DXP instance, and use it for...

Upgrading a Theme

Official Documentation

Upgrading a Theme Themes developed for previous versions of Liferay DXP must be upgraded in order to be deployed to a new version. The gulp upgrade task updates Liferay version references and theme...

Data Sets

Official Documentation

Data Sets Liferay DXP 2024.Q1+/Portal GA112+ Currently, this feature is behind a release feature flag (LPS-164563). Data sets collect data from Liferay headless APIs for you to manage and...

Importing/Exporting Data

Official Documentation

Importing/Exporting Data Liferay Self-Hosted Liferay SaaS Liferay PaaS Liferay 7.4 If you want to import or export data from Liferay, you use batch client extensions. Use and reuse your data...

Integrating External Applications

Official Documentation

Integrating External Applications Custom Element and IFrame client extensions register applications with Liferay and render them as widgets on site pages. When you create one of these frontend...

Creating and Managing Objects

Official Documentation

Creating and Managing Objects Liferay 7.4+ Liferay Objects provides a convenient UI for creating custom applications that meet your business needs without writing code. You can also use Objects to...

Actions

Official Documentation

Actions Object actions define custom business logic that you can run manually or automatically for object entry events. Examples include delivering entry event data to a webhook URL, sending email...

Understanding Action Types

Official Documentation

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

Objects

Official Documentation

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

Defining Object Actions

Official Documentation

Defining Object Actions Liferay 7.4 U60+/GA60+ Object actions define operations that you can run manually or automatically for object entry events. To add an action, Open the Global Menu (...

Using Manual Actions

Official Documentation

Using Manual Actions Liferay 7.4 U60+/GA60+ When you use the standalone trigger for object actions, the actions become manual instead of automatic. Trigger these actions using these methods: ...

Fields

Official Documentation

Fields Liferay DXP 2023.Q4+/Portal GA102+ Object fields are data definitions that represent database columns and store different types of values. All objects include default system fields, but you...

Aggregation Fields

Official Documentation

Aggregation Fields Liferay 7.4 U47+/GA47+ Aggregation fields perform basic calculations on the entries from a relationship table and display the resulting values. Available aggregation functions...

Activating and Deactivating Objects

Official Documentation

Activating and Deactivating Objects Custom objects are activated when published. While active, you can use the object to create entries via the Liferay UI or dedicated REST APIs. If needed, you can...

Creating Objects

Official Documentation

Creating Objects Liferay DXP 2023.Q4+/Portal GA102+ Liferay Objects provides development capabilities in the Liferay UI. Using Objects, you can build fully integrated Liferay applications without...

Deleting Objects

Official Documentation

Deleting Objects Liferay 7.4 U26+/GA26+ You can delete draft and published object definitions. Deleting a definition removes its associated data, including the stored entries for published...

Exporting and Importing Object Definitions

Official Documentation

Exporting and Importing Object Definitions You can export and import object definitions as .json files. These files include the definition's complete schema (e.g., configurations, fields, actions,...

Extending Unmodifiable System Objects

Official Documentation

Extending Unmodifiable System Objects Liferay 7.4 U86+/GA86+ With Liferay Objects, you can extend supported system services. These services are integrated with the Objects framework as...

Adding and Managing Custom States

Official Documentation

Adding and Managing Custom States Liferay 7.4+ Some use cases may require assigning multiple states to an object entry at the same time. For example, when building an Order application, you may...

Adding Fields to Objects

Official Documentation

Adding Fields to Objects Liferay DXP 2023.Q4+/Portal GA102+ Fields are data definitions that represent database columns and store different types of values. By default, all objects include these...

Encrypted Fields

Official Documentation

Encrypted Fields Self-Hosted and PaaS Only Liferay 7.4 U72+/GA72+ Liferay provides the encrypted field type for storing sensitive user data. To use encrypted fields, first add an encryption...

Formula Fields

Official Documentation

Formula Fields Liferay DXP 2023.Q4+/Portal GA102+ Formula fields provide read-only values calculated using numeric fields in the object definition. Unlike other fields, formula values are...

Using Read-Only Fields

Official Documentation

Using Read-Only Fields Some use cases may require data fields to be read-only. For example, data integrity may require some field values to remain immutable, or you may need to prevent unauthorized...

Designing Object Layouts

Official Documentation

Designing Object Layouts Liferay 7.4 U31+/GA31+ Layouts define how fields and relationships appear when creating and editing object entries. Each layout can include multiple tabs containing...

Attachment Fields

Official Documentation

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. Each field can only be linked to...

Auto-Increment Fields

Official Documentation

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

Picklist Fields

Official Documentation

Picklist Fields Liferay 7.4 U72+/GA72+ Picklists define lists of text values usable as single select or multi-select fields in object definitions. By default, single select fields appear as...

Layouts

Official Documentation

Layouts Liferay 7.4+ Object layouts define how fields and relationships appear when creating and editing entries. All published objects include an autogenerated layout with a single tab that lists...

Adding Categorization to Fields Tabs

Official Documentation

Adding Categorization to Fields Tabs Liferay 7.4 U31+/GA31+ You can add categorization blocks to fields tabs so end users can apply tags and categories to object entries. Follow these steps: ...

Search Results