Capability

Platform

Liferay DXP is a robust platform with its own navigation menus, configuration methods, and core features. These core features are foundational to effective system administration, maintenance, notifications, and other core platform functions.

Category
Category
Using the Notification Queue
Using the Notification Queue Liferay 7.4 U75+/GA75+ Liferay provides the Notification Queue application for reviewing email notifications triggered by an object action. You can verify the status...
Redirecting Users on Form Submission
Redirecting Users on Form Submission By default, when a user submits a form response, they are directed to a success page. This behavior can be configured to instead redirect a user to a specific...
Creating Notification Templates
Creating Notification Templates Liferay DXP 2023.Q4+/Portal GA102+ With Notification Templates, you can design automated email and user notifications for Liferay services. Each template identifies...
Using Forms to Poll Users
Using Forms to Poll Users The Forms application is in maintenance mode as of Liferay DXP 2024.Q4/Portal GA129. Migrate your forms to objects and form container fragments to future-proof your...
Enabling Workflow for Objects
Enabling Workflow for Objects Liferay 7.4+ Every published object is integrated automatically with the Workflow framework, so you can direct object entry creation through a defined review and...
Integrating Service Builder Applications with Objects
Integrating Service Builder Applications with Objects You can integrate existing Service Builder applications with the Objects framework. Once integrated, your custom entities become unmodifiable...
Picklists
Picklists Liferay 7.4+ Liferay picklists are predefined lists of string values that consist of a name/key pair and can include any number of items. Once a list is created, you can use it to add a...
Exporting and Importing Picklists
Exporting and Importing Picklists You can transfer picklists between environments as JSON files using Liferay's export/import framework. Exporting Picklists Open the Global Menu (Global Menu),...
Using Forms with Objects
Using Forms with Objects Liferay 7.4+ Liferay objects are integrated with the Forms application, so you can design forms for receiving user input and creating object entries. To do this, first add...
Creating Picklists
Creating Picklists Liferay 7.4 U72+/GA72+ Picklists are lists of name/key pairs stored as string values. Once defined, you can use the lists with object definitions to populate single or multiple...
Managing Picklist Permissions
Managing Picklist Permissions Liferay 7.4+ Picklist is integrated with Liferay's permissions framework. This means you can assign application and resource permissions to user roles to determine...
Workflow
Workflow Liferay DXP ships with a workflow engine that allows reviewing and approving content such as Blogs, Web Content, or Wikis before publication. Define any number of business...
Using Condition Nodes
Using Condition Nodes Subscription Condition nodes are useful for acting (transitioning, assigning, etc.) conditionally in the workflow. Perhaps you have multiple reviewers and must determine...
Configuring Workflow Actions and Notifications
Configuring Workflow Actions and Notifications Subscription Using the workflow designer, users can configure Workflow Actions and notifications for each node. Actions are very adaptable and you...
Creating Workflow Tasks
Creating Workflow Tasks Subscription The default Single Approver Definition offers a simple introduction to workflow tasks. It has only two task nodes: Review and Update. The workflow enters the...
Using Forks and Joins
Using Forks and Joins Subscription Here you'll learn how to use the Fork, Join and Join XOR nodes. These nodes are useful for workflow processes that have multiple reviewers like the...
Designing and Managing Workflows
Designing and Managing Workflows Building Workflows Managing Workflows Workflow Designer Workflow Designer Overview Workflow Nodes Creating Workflow Tasks Configuring Workflow Actions and...
Assigning Task Nodes
Assigning Task Nodes Subscription Task nodes require interaction by people. To alert and associate tasks with the right people, use notifications and assignments, respectively. You can assign task...
Workflow Designer
Workflow Designer Subscription The Workflow Designer's user interface was refreshed in Liferay DXP 7.4 Update 20. The look and feel of the new builder is improved and the user experience is more...
Using Task Timers
Using Task Timers Task nodes can include task timers to trigger an action after a specified time period. Timers are useful for ensuring a task does not go unattended for too long. Available timer...
Creating a Condition Evaluator
Creating a Condition Evaluator A Workflow condition node uses a Groovy script to determine the proper transition a workflow item traverses. Instead of writing logic in Groovy directly in a workflow...
Developer Guide
Developer Guide Using The Script Engine in Workflow Crafting XML Workflow Definitions Workflow Definition Node Reference Workflow Notification Template Variables Workflow Task Node Reference ...
Workflow Nodes
Workflow Nodes Subscription A Workflow Node represents a specific point in an approval process, whether it begins the review process, approves or rejects the asset, or reassigns the task. Below...
Workflow Transitions
Workflow Transitions Subscription Transitions represent the paths a workflow can traverse. In the Workflow Designer's palette, transitions are the arrows connecting the workflow nodes: ...
Crafting XML Workflow Definitions
Crafting XML Workflow Definitions As of DXP 2024.Q3, scripting is disabled by default. You can enable it in System Settings → Script Management (under the Security category). All Workflow...
Workflow Designer Overview
Workflow Designer Overview Subscription The Process Builder's workflow designer is a graphical interface for creating workflow process definitions. The convenient drag and drop interface makes...
Creating an Action Executor
Creating an Action Executor Workflow nodes can contain elements that execute custom logic via Groovy scripts. approve
Using the Script Engine in Workflow
Using the Script Engine in Workflow As of DXP 2024.Q3, scripting is disabled by default. You can enable it in System Settings → Script Management (under the Security category). Add Groovy scripts...
Workflow Notification Template Variables
Workflow Notification Template Variables Liferay 7.3+ Some variables are auto-injected into the workflow notification context. These are handy to use in your workflow notification templates. ...
Workflow Task Node Reference
Workflow Task Node Reference As of DXP 2024.Q3, scripting is disabled by default. You can enable it in System Settings → Script Management (under the Security category). Tasks are the part of the...
Introduction to Workflow
Introduction to Workflow Liferay DXP ships with a workflow engine that allows users to review and approve content such as Blogs, Web Content, Wikis before they are published. The Workflow...
Using Workflows
Using Workflows Activating Workflow Reviewing Assets Using Workflow Metrics Workflow Metrics Reports
Working with Workflow Context
Working with Workflow Context Workflows in Liferay are used as approval processes. At each step of the process, the workflow has certain data that's available in a Map object referred to in your...
Activating Workflow
Activating Workflow You can activate a workflow process for an asset type either across the DXP instance or only on a specific site. When a workflow process is activated across the instance for a...
Workflow Definition Node Reference
Workflow Definition Node Reference Node elements and their sub-elements are fundamental building blocks making up workflow definitions. Nodes often reflect the real life stages of the review...
Reviewing Assets
Reviewing Assets When an asset's workflow is activated, one or more users must review it before publication. You can assign workflow review processes to specific users or to a particular Role (for...
Using Workflow Metrics
Using Workflow Metrics Subscription This feature works only with Elasticsearch. Workflow Metrics gives insight into the time spent to complete certain workflow events. To use it, set up...
Workflow Metrics: Reports
Workflow Metrics: Reports Subscription Open the Workflow Metrics from the Applications Menu (Applications Menu) (Control Panel → Workflow → Metrics) and you immediately see metrics on each...
Setting Up Liferay
Setting Up Liferay After installing Liferay, configure it to meet your needs. Here are common setup tasks. Setup Tasks Preconfigure the System Activate Liferay (Subscription Required) ...
Configuring Cluster Link
Configuring Cluster Link Enabling Cluster Link activates distributed caching. The cache is distributed across multiple Liferay DXP nodes running concurrently. Cluster Link uses Ehcache replication....
Database Configuration for Cluster Nodes
Database Configuration for Cluster Nodes At minimum, nodes in a DXP cluster must be configured to share the same database (or database cluster) in order to function. Optimizations discussed here...
Example: Creating a Simple DXP Cluster
Example: Creating a Simple DXP Cluster A fast, easy way to learn DXP clustering is to set up a two node DXP cluster environment on one machine using Docker containers. This example creates two DXP...
Session Replication with Tomcat
Session Replication with Tomcat Liferay DXP 2024.Q3+/Portal GA92+ To ensure user session data is synchronized across all instances in the cluster, Liferay supports session replication. If one...
Clustering for High Availability
Clustering for High Availability Liferay DXP can scale to serve everything from the smallest to the largest web sites. Out-of-the-box, it's configured optimally for a single server environment. If...
Configuring Unicast over TCP
Configuring Unicast over TCP If your network configuration or the geographical distance between cluster nodes prevents you from using UDP Multicast clustering, you can configure TCP Unicast. You...
Initial Instance Localization
Initial Instance Localization Liferay DXP supports localization by language, time zone, and more. The English (US) language translation and GMT time zone are the defaults, but DXP has over 40...
Tuning Your JVM
Tuning Your JVM Java Virtual Machine (JVM) tuning primarily focuses on adjusting Java heap and non-heap settings and configuring garbage collection. Finding settings that perform well for you...
Using a CDN
Using a CDN A Content Delivery Network (CDN) is a distributed infrastructure for caching static, file-based content. When visitors hit your site, your static content is loaded from the server...
Tuning Liferay
Tuning Liferay There are several ways to tune Liferay's performance. This involves configuring the Java Virtual Machine and frameworks that support the Liferay application, monitoring performance...
Configuring Microsoft Office 365 with OAuth
Configuring Microsoft Office 365 with OAuth Liferay DXP 7.4 U79+/Liferay Portal 7.4 GA79+ Connect your Microsoft email service to Liferay with the use of OAuth 2.0 authorization. Note, Microsoft...
Getting Started
Getting Started Liferay DXP is a powerful, open source, enterprise-ready platform for building and deploying web applications. However, all of that power and functionality can make it difficult to...
Introduction to the Admin Account
Introduction to the Admin Account The Admin User account is created by default in any new installation of Liferay DXP and has full permissions to modify every facet of a Liferay DXP instance. The...
Navigating DXP
Navigating DXP Liferay DXP's out-of-the-box navigation is organized into three major areas: Site Menu, Personal Menu, and Global Menu. Site Menu The DXP Site Menu on the left side of the screen...
DXP
DXP Welcome to the official documentation for the latest versions of Liferay DXP and Liferay Portal! Liferay DXP is the commercially supported and enterprise ready platform used around the world,...
Building a Sample API Application
Building a Sample API Application Liferay DXP 2023.Q4+/Portal GA102+ [Beta Feature](../../security-and-administration/administration/configuring-liferay/feature-flags.md#beta-feature-flags) The...
API Builder
API Builder Liferay DXP 2023.Q4+/Portal GA102+ [Beta Feature](../security-and-administration/administration/configuring-liferay/feature-flags.md#beta-feature-flags) This feature is currently...
Captcha API Basics
Captcha API Basics Liferay provides a headless API to retrieve and submit captchas using the SimpleCAPTCHA engine. Using the /captcha endpoint from the API Explorer, you can add captchas in your...
Managing Object Entries Using GraphQL
Managing Object Entries Using GraphQL You can use GraphQL to manage custom object entries in Liferay efficiently. This API framework simplifies data interaction and serves as an alternative to REST...
SCIM User API Basics
SCIM User API Basics Liferay DXP 2024.Q1+/Portal GA112+ Liferay provides a headless API to perform CRUD operations on SCIM users to keep their identity information in sync with your company's...
SCIM Resource Type, Service Provider, and Schema Basics
SCIM Resource Type, Service Provider, and Schema Basics Liferay DXP 2025.Q2+ Liferay provides a headless API to query the SCIM resource types, service providers, and schemas available. Use the...