Platform

Forms

Forms Forms are important direct data gathering tools for enterprises. Are your web forms providing you invaluable information or turning users away? Analytics Cloud gives you important insights. ...

Published Date: Apr 26, 2024 8:47 PM

Sending Emails

Sending Emails You can configure Liferay to send email notifications for different events that happen in your store. For example, you may want to send updates to the order manager or another person...

Published Date: Apr 26, 2024 8:49 PM

Using Notification Templates

Using Notification Templates Email notifications are sent automatically to users based on events in the store. To send them, you must first create a Notification Template. Notification templates...

Published Date: Apr 26, 2024 8:49 PM

Notification Template Variables Reference Guide

Notification Template Variables Reference Guide When creating notification templates, you can use variables to populate email fields dynamically with data from the triggering channel event. Select...

Published Date: Apr 26, 2024 8:49 PM

Configuring the Commerce Notification Queue

Configuring the Commerce Notification Queue When channel events trigger notifications, Commerce logs them in the channel's Notification Queue tab with the Unsent status. By default, Liferay checks...

Published Date: Apr 26, 2024 8:49 PM

Configuring Mentions

Configuring Mentions Mentions are enabled by the Mentions app. By default, the Mentions app is enabled globally. However, this can be enabled or disabled either globally or per Site. Configuring...

Published Date: Apr 26, 2024 8:52 PM

Notifications and Requests

Notifications and Requests User Guide Notifications and Requests Mentioning Users Managing Notifications and Requests Configuring Mentions

Published Date: Apr 26, 2024 8:52 PM

Managing Notifications and Requests

Managing Notifications and Requests Users receive notifications and requests if they have subscribed to a blog or message board or are mentioned in a post. They may also be notified if someone sent...

Published Date: Apr 26, 2024 8:52 PM

User Guide

User Guide Mentioning Users Managing Notifications and Requests Configuring Mentions

Published Date: Apr 26, 2024 8:52 PM

Mentioning Users

Mentioning Users Mentioning other users in a DXP asset draws their attention to a particular asset (for example, a message boards thread, blog post, or comment) by sending them a site and email...

Published Date: Apr 26, 2024 8:52 PM

Batch Engine API Basics - Importing Data

Batch Engine API Basics - Importing Data Liferay's Headless Batch Engine provides REST APIs to import and export data. Call these services to import data to Liferay. Importing Data Then follow...

Published Date: Apr 26, 2024 8:53 PM

Authorizing Account Access with OAuth2

Authorizing Account Access with OAuth2 Once you have an application registered, you can start authorizing users. To do that, you must construct the URL to the authorization server (Liferay DXP)....

Published Date: Apr 26, 2024 8:53 PM

Consuming REST Services

Consuming REST Services Liferay DXP contains REST services for most of its applications. These services are fully OpenAPI compliant. Here, you'll learn how to consume them. This takes only three...

Published Date: Apr 26, 2024 8:53 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: Apr 26, 2024 8:53 PM

Making Unauthenticated Requests

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

Published Date: Apr 26, 2024 8:53 PM

Using OAuth2 to Authorize Users

Using OAuth2 to Authorize Users You can create applications that access Liferay's headless REST APIs using the OAuth 2.0 authorization protocol. The provided sample React app demonstrates three...

Published Date: Apr 26, 2024 8:53 PM

OAuth 2 Scopes

OAuth 2 Scopes In OAuth 2.0, applications are granted access to limited subsets of user data. These are called scopes (not to be confused with Liferay scopes). You can create them in two ways: ...

Published Date: Apr 26, 2024 8:53 PM

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

Published Date: Apr 26, 2024 8:54 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: Apr 26, 2024 8:54 PM

SCIM User API Basics

SCIM User API Basics Liferay DXP 2024.Q1+ [Beta Feature](../../../system-administration/configuring-liferay/feature-flags.md#beta-feature-flags) Liferay provides a headless API to perform CRUD...

Published Date: Apr 26, 2024 8:54 PM

SCIM Group API Basics

SCIM Group API Basics Liferay DXP 2024.Q1+ [Beta Feature](../../../system-administration/configuring-liferay/feature-flags.md#beta-feature-flags) Liferay provides a headless API to perform CRUD...

Published Date: Apr 26, 2024 8:54 PM

Developer Guide

Developer Guide :::: 2 :gutter: 3 3 3 3 ::: Captcha API Basics :link: ./developer-guide/captcha-api-basics.md ::: ::: SCIM User API Basics :link: ./developer-guide/scim-user-api-basics.md ::: ...

Published Date: Apr 26, 2024 8:54 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: Apr 26, 2024 8:54 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: Apr 26, 2024 8:54 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: Apr 26, 2024 8:54 PM

Setting Up Liferay

Setting Up Liferay After installing Liferay, configure it to meet your needs. Here are common setup tasks. Setup Tasks Activate Liferay (Subscription Required) Configure Your Instance ...

Published Date: Apr 26, 2024 8:54 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: Apr 26, 2024 8:54 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: Apr 26, 2024 8:54 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: Apr 26, 2024 8:54 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: Apr 26, 2024 8:54 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: Apr 26, 2024 8:54 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: Apr 26, 2024 8:54 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: Apr 26, 2024 8:54 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: Apr 26, 2024 8:54 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: Apr 26, 2024 8:54 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: Apr 26, 2024 8:54 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: Apr 26, 2024 8:54 PM

What's New in Liferay DXP 7.3

What's New in Liferay DXP 7.3 The latest release of Liferay DXP includes many significant new features and improvements. These features will enhance how you build your site, analyze your site's...

Published Date: Apr 26, 2024 8:53 PM

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: Apr 26, 2024 8:53 PM

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

Published Date: Apr 26, 2024 8:53 PM

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

Published Date: Apr 26, 2024 8:53 PM

API Query Parameters

API Query Parameters Whether you consume REST APIs or GraphQL APIs, different query parameters are available to help you filter the responses. Fields Parameter Use this parameter to specify and...

Published Date: Apr 26, 2024 8:53 PM

Consuming GraphQL APIs

Consuming GraphQL APIs Liferay DXP contains GraphQL APIs for most of its applications. Here, you'll learn how to consume them. This takes only three steps: Identify the API you wish to consume. ...

Published Date: Apr 26, 2024 8:53 PM

Data Migration Center

Data Migration Center Liferay DXP 2023.Q4+/Portal 7.4 GA102+ [Beta Feature](../../system-administration/configuring-liferay/feature-flags.md#beta-feature-flags) This feature is currently behind a...

Published Date: Apr 26, 2024 8:53 PM

API Headers Reference

API Headers Reference This article documents the available headers you can use when making Headless API requests: Accept Accept-Language Authorization Content-Type Cookie Accept Indicates...

Published Date: Apr 26, 2024 8:53 PM

Using Liferay as a Headless Platform

Using Liferay as a Headless Platform Liferay provides a suite of APIs that perform the same kinds of actions available in the web interface. This is essential when you must get data in a...

Published Date: Apr 26, 2024 8:53 PM

Creating an OAuth2 Application

Creating an OAuth2 Application When you have an application that can use OAuth 2.0 for authorization, you must register that application so Liferay can recognize it. Do this by accessing Control...

Published Date: Apr 26, 2024 8:53 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: Apr 26, 2024 8:53 PM

Sample API Tutorials

Sample API Tutorials Follow the links below for sample API tutorials that include example requests and example code. Site Building Navigation Menu API Basics Content Authoring and Management ...

Published Date: Apr 26, 2024 8:53 PM

Securing Liferay

Securing Liferay Liferay DXP is built with security in mind. This includes mitigation of common security vulnerabilities and exploits like those described by the OWASP Top 10 and the CWE/SANS Top...

Published Date: Apr 26, 2024 8:54 PM

Authentication Basics

Authentication Basics By default, Liferay DXP uses the Sign In widget to authenticate users. The Sign In widget appears on the default home page at `http[s]://[server-name:port]/web/guest/home`....

Published Date: Apr 26, 2024 8:54 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: Apr 26, 2024 8:54 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: Apr 26, 2024 8:54 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: Apr 26, 2024 8:54 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: Apr 26, 2024 8:54 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: Apr 26, 2024 8:54 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: Apr 26, 2024 8:54 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: Apr 26, 2024 8:54 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: Apr 26, 2024 8:54 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: Apr 26, 2024 8:54 PM

Cloud

Commerce

Content Management System

Development and Tooling

Digital Asset Management

DXP Self-Hosted Installation, Maintenance, and Administration

Integration

Personalization

Search

Security

Sites

Analytics Cloud

Commerce

DXP

Liferay Cloud

Reference

Platform