Platform - Liferay Learn

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

Published Date: May 9, 2024 6:51 PM

APIs with REST Builder

APIs with REST Builder REST Builder is a code generation tool that makes it easy for you to take your local APIs and make them available on the web. It uses the OpenAPI Specification to generate...

Published Date: May 9, 2024 6:51 PM

Consuming APIs

Consuming APIs APIs, or Application Programming Interfaces, serve as the bridge between different software applications, allowing them to communicate and exchange data. By consuming external APIs,...

Published Date: May 9, 2024 6:51 PM

Producing and Implementing APIs with REST Builder

Producing and Implementing APIs with REST Builder With REST Builder, you can define the API you want to build, and REST Builder provides the framework and endpoints for you. Deploy an Example REST...

Published Date: May 9, 2024 6:51 PM

Using External Reference Codes

Using External Reference Codes Liferay DXP/Portal 7.4+ Many of Liferay's headless API endpoints support an external reference code (ERC). The ERC field is useful in wide range of scenarios. For...

Published Date: May 9, 2024 6:51 PM

Using OAuth 2.0

Using OAuth 2.0 OAuth 2.0 is an industry-standard authorization protocol. Users can seamlessly share select credentials from your Liferay-based website with various clients. OAuth 2.0 works by...

Published Date: May 9, 2024 6:51 PM

Making Unauthenticated Requests

Making Unauthenticated Requests By default, Liferay DXP restricts API access for the sake of security, requiring authentication to get a valid response. However, in certain cases it may make sense...

Published Date: May 9, 2024 6:51 PM

Authenticating with CAS (Central Authentication Service)

Authenticating with CAS (Central Authentication Service) CAS was deprecated as of Liferay DXP 7.2 and removed as of Liferay DXP 7.4. Please use [SAML](./authenticating-with-saml.md) instead. CAS...

Published Date: May 9, 2024 6:52 PM

Configuring SAML at the System Level

Configuring SAML at the System Level Before allowing any portal instances to enable SAML authentication, you should configure it at the system level so those instances have a foundation from which...

Published Date: May 9, 2024 6:52 PM

Importing User Groups' Memberships from an External IdP through SAML

Importing User Groups' Memberships from an External IdP through SAML This feature was released behind a dev feature flag. It was made Generally Available (GA) in Liferay DXP 2024.Q2/GA120. You...

Published Date: May 9, 2024 6:52 PM

Configuring Single Sign-On

Configuring Single Sign-On Liferay Portal/DXP supports many ways of authenticating, from token-based solutions to standards such as OpenID Connect and SAML. With all the available options, you...

Published Date: May 9, 2024 6:52 PM

Authenticating with Kerberos

Authenticating with Kerberos You can use Kerberos to authenticate Microsoft Windows™ accounts with Liferay DXP. This is done by using a combination of Liferay DXP's LDAP support and a web server...

Published Date: May 9, 2024 6:52 PM

Authenticating with SAML

Authenticating with SAML The SAML (Security Assertion Markup Language) adapter provides Single Sign On (SSO) and Single Log Off (SLO) in your deployment. SAML works by using Identity Providers...

Published Date: May 9, 2024 6:52 PM

Configuring SAML at the Instance Level

Configuring SAML at the Instance Level Each portal instance can be a SAML provider, either an Identity Provider (IdP) or a Service Provider (SP). Whichever role your DXP instance fills, you can...

Published Date: May 9, 2024 6:52 PM

SAML Authentication Process Overview

SAML Authentication Process Overview Both the IdP and the SP can initiate the Single Sign On process, and the SSO flow is different depending on each one. Regardless of how it's initiated, SSO is...

Published Date: May 9, 2024 6:52 PM

SAML Settings

SAML Settings Many of the same fields appear in both the Service Provider and the Identity Provider configurations. Here's a reference. Name: Name the SP or IdP. This is just a descriptive name;...

Published Date: May 9, 2024 6:52 PM

Token-based Single Sign On Authentication

Token-based Single Sign On Authentication Token-based SSO authentication was introduced in Liferay Portal 7.0 to standardize support for Shibboleth, SiteMinder, Oracle OAM, and any SSO product that...

Published Date: May 9, 2024 6:52 PM

SAML Admin

SAML Admin The SAML Admin panel is the best place to configure your SAML instance. Use it instead of Instance Settings to streamline your SAML administration experience. You can configure an...

Published Date: May 9, 2024 6:52 PM

Configuring Liferay Authentication With Auth0 Using OpenId Connect

Configuring Liferay Authentication With Auth0 Using OpenId Connect This tutorial guides you through integrating Auth0, your Identity Provider (IdP), with your Liferay environment using OpenID...

Published Date: May 9, 2024 6:52 PM

Configuring Liferay Authentication With Okta Using OpenId Connect

Configuring Liferay Authentication With Okta Using OpenId Connect This tutorial guides you through the basic steps needed to integrate Okta, your Identity Provider (IdP), with your environment...

Published Date: May 9, 2024 6:52 PM

Configuring Liferay Authentication With PingOne Using SAML

Configuring Liferay Authentication With PingOne Using SAML This tutorial guides you through the basic steps needed to integrate PingOne, your Identity Provider (IdP), with your Liferay environment...

Published Date: May 9, 2024 6:52 PM

Using OpenAM

Using OpenAM Deprecated in Liferay DXP 2024.Q4/GA129 OpenAM 13 is deprecated as of Liferay DXP 2024.Q4/GA129. OpenAM 12 and below were deprecated as of Liferay DXP 7.2. Versions of...

Published Date: May 9, 2024 6:52 PM

Using OpenID Connect

Using OpenID Connect OpenID Connect is a lightweight authentication layer that enables users to authenticate using accounts they have on other systems. It's built on top of the OAuth 2.0...

Published Date: May 9, 2024 6:52 PM

Developer Guide

Published Date: May 9, 2024 6:52 PM

Fast IDentity Online 2

Fast IDentity Online 2 Available: Liferay DXP/Portal 7.4+ The Fast IDentity Online 2 or FIDO2 standard allows for the use of biometrics (i.e., fingerprint readers), mobile devices, or other...

Published Date: May 9, 2024 6:52 PM

Multi-Factor Authentication

Multi-Factor Authentication Liferay DXP 7.3+ Multi-Factor Authentication (MFA) provides better security by requiring users to prove their identity in multiple ways, or factors. The basic user...

Published Date: May 9, 2024 6:52 PM

AntiSamy

AntiSamy Liferay DXP includes an AntiSamy module that protects against user-entered malicious code. If your site allows users to post content in message boards, blogs, or other applications, these...

Published Date: May 9, 2024 6:52 PM

Multi-Factor Authentication Checkers

Multi-Factor Authentication Checkers Liferay DXP 7.4 ships with two additional factor checkers for Multi-Factor Authentication. Both of them are disabled by default, because they're only useful in...

Published Date: May 9, 2024 6:52 PM

Using Multi-Factor Authentication

Using Multi-Factor Authentication To enhance your installation's security, you should disable less secure, one-factor forms of authentication, such as Basic Auth, Digest Auth, and WebDAV. You can...

Published Date: May 9, 2024 6:52 PM

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

Published Date: May 9, 2024 6:52 PM

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

Published Date: May 9, 2024 6:52 PM

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

Published Date: May 9, 2024 6:52 PM

Configuring Mail

Configuring Mail Liferay DXP/Portal can be configured to use a mail server to send email notifications for a variety of purposes: User registration and password management, Site membership...

Published Date: May 9, 2024 6:52 PM

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

Published Date: May 9, 2024 6:52 PM

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

Published Date: May 9, 2024 6:52 PM

Alternative Email Configuration Methods

Alternative Email Configuration Methods There are several methods of configuring Liferay DXP to connect to a mail server. The simplest way to get started is to configure mail using through the...

Published Date: May 9, 2024 6:52 PM

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

Published Date: May 9, 2024 6:52 PM

Configuring Default Email Senders

Configuring Default Email Senders By default, emails sent by Liferay DXP use the name and email address as the default admin user. This behavior can be configured for each of the different email...

Published Date: May 9, 2024 6:52 PM

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

Published Date: May 9, 2024 6:52 PM

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

Published Date: May 9, 2024 6:52 PM

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

Published Date: May 9, 2024 6:52 PM

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

Published Date: May 9, 2024 6:52 PM

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

Published Date: May 9, 2024 6:54 PM

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

Published Date: May 9, 2024 6:54 PM

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

Published Date: May 9, 2024 6:54 PM

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

Published Date: May 9, 2024 6:54 PM

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

Published Date: May 9, 2024 6:54 PM

Picklists API Basics

Picklists API Basics Liferay provides the headless-admin-list-types REST APIs for creating and managing picklist definitions (ListTypeDefinition) and their entries (ListTypeEntry). You can view and...

Published Date: May 9, 2024 6:54 PM

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

Published Date: May 9, 2024 6:54 PM

Building Forms with Conditional Fields

Building Forms with Conditional Fields Forms can become dynamic forms where the answer to one question may allow the respondent to skip the next three questions, or require the respondent to answer...

Published Date: May 9, 2024 6:55 PM

Customizing Auto-Save Behavior

Customizing Auto-Save Behavior The Forms application automatically saves the form creation progress as you create a form. By default, a form's draft is auto-saved every minute. To change the...

Published Date: May 9, 2024 6:55 PM

Customizing Form Layouts

Customizing Form Layouts By default, new elements on your form are added to a new row and occupy the entire width of the form. Form with all elements occupying entire width of form. Sometimes it...

Published Date: May 9, 2024 6:55 PM

Process Automation

Published Date: May 9, 2024 6:55 PM

Forms

Published Date: May 9, 2024 6:55 PM

Creating and Managing Forms

Creating and Managing Forms Creating Forms Customizing Form Layouts Reusing Sets of Form Elements Providing Help Text and Predefined Values Building Forms with Conditional Fields Validation...

Published Date: May 9, 2024 6:55 PM

Creating Forms

Creating Forms You can create multi-field forms with the Forms application. Only authenticated users with the requisite Process Automation Permissions can create forms. At minimum, they should have...

Published Date: May 9, 2024 6:55 PM

Exporting and Importing Forms

Exporting and Importing Forms You can export all your forms as a LAR file and then import them into a different Site for reuse. See Exporting/Importing Site Pages and Content to learn about the...

Published Date: May 9, 2024 6:55 PM

Forms Field Types Reference

Forms Field Types Reference The Liferay Forms application contains lots of field types and elements to add to your forms. To discover the available elements, Open the Product Menu (Product Menu)...

Published Date: May 9, 2024 6:55 PM

Reusing Sets of Form Elements

Reusing Sets of Form Elements Forms often request the same sets of information, such as name, birthday, and address. Rather than adding these fields for every new form, you can group elements as a...

Published Date: May 9, 2024 6:56 PM

Validation and Masking

Validation and Masking Certain Forms fields can be validated (Text, Date, and Numeric fields) and masked (Numeric fields) to ensure User input is valid. Date Fields can be validated beginning in...

Published Date: May 9, 2024 6:56 PM