Site Search - Liferay Learn

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

Forms Analytics

Official Documentation

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

Captcha API Basics

Official Documentation

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

Official Documentation

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

Official Documentation

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 Group API Basics

Official Documentation

SCIM Group API Basics Liferay DXP 2024.Q1+/Portal GA112+ Liferay provides a headless API to perform CRUD operations on SCIM groups to keep their information in sync with your company's...

SCIM Resource Type, Service Provider, and Schema Basics

Official Documentation

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

Notifications API Basics

Official Documentation

Notifications API Basics Liferay's headless delivery application provides REST and GraphQL services for subscribing to or unsubscribing from notifications for platform events across several default...

Workflow Definition Link API Basics

Official Documentation

Workflow Definition Link API Basics Liferay DXP 2025.Q1+/Portal GA132+ You can manage workflow definition links from the Liferay UI or using Liferay's REST APIs. In Liferay, the Control Panel →...

Picklists API Basics

Official Documentation

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

Migrating to Liferay Objects

Official Documentation

Migrating to Liferay Objects Dynamic Data Lists is deprecated and scheduled for removal by the end of 2024. To prevent data loss and achieve the same functionality, please migrate your structures...

Getting Started with Dynamic Data Lists

Official Documentation

Getting Started with Dynamic Data Lists Dynamic Data Lists is deprecated as of Liferay DXP 7.3, and is planned for removal in 2024. It is replaced by Objects. Please migrate your Dynamic Data...

Data Providers

Official Documentation

Data Providers Data providers serve data that can be consumed by the Forms application. The REST Data Provider is included with the Forms application. With it, you can consume data from REST web...

Dynamic Data Lists

Official Documentation

Dynamic Data Lists Dynamic Data Lists is deprecated as of Liferay DXP 7.3, and is planned for removal in 2024. It is replaced by Objects. Please migrate your Dynamic Data Lists to Objects as soon...

Validation Conditions Reference

Official Documentation

Validation Conditions Reference There are several out-of-the-box validation conditions that can be used to validate form responses before they are submitted. Text Field Validation Conditions...

Creating Form Templates

Official Documentation

Creating Form Templates Dynamic Data Lists is deprecated as of Liferay DXP 7.3, and is planned for removal in 2024. It is replaced by Objects. Please migrate your Dynamic Data Lists to Objects as...

Creating Data Lists

Official Documentation

Creating Data Lists Dynamic Data Lists is deprecated as of Liferay DXP 7.3, and is planned for removal in 2024. It is replaced by Objects. Please migrate your Dynamic Data Lists to Objects as soon...

Managing Data Definitions

Official Documentation

Managing Data Definitions Dynamic Data Lists is deprecated as of Liferay DXP 7.3, and is planned for removal in 2024. It is replaced by Objects. Please migrate your Dynamic Data Lists to Objects...

Form Rules

Official Documentation

Form Rules 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 solutions. Forms...

Creating Display Templates

Official Documentation

Creating Display Templates Dynamic Data Lists is deprecated as of Liferay DXP 7.3, and is planned for removal in 2024. It is replaced by Objects. Please migrate your Dynamic Data Lists to Objects...

Using Templates to Display Forms and Lists

Official Documentation

Using Templates to Display Forms and Lists Dynamic Data Lists is deprecated as of Liferay DXP 7.3, and is planned for removal in 2024. It is replaced by Objects. Please migrate your Dynamic Data...

Configuring Form Notifications

Official Documentation

Configuring Form Notifications You can configure the Forms app to send a notification email each time a form entry is submitted. If you have enabled workflow for the form, you may not need to...

Sharing Forms and Managing Submissions

Official Documentation

Sharing Forms and Managing Submissions 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...

Form Reports

Official Documentation

Form Reports 7.3, 7.4 Once users begin submitting form entries, you can access a field-by-field report on the form's records: Navigate to the Forms application. In the Product Menu (Product...

Managing Form Entries

Official Documentation

Managing Form Entries Once users begin submitting form entries, you can access the form entry data through the UI or export the data to a different file format for further analysis and review. ...

Enabling CAPTCHA on Form Submissions

Official Documentation

Enabling CAPTCHA on Form Submissions CAPTCHA can be enabled to deter automated form submissions. To enable CAPTCHA: Click the form's Options (Options) and select Settings. Navigate to the Form...

Redirecting Users on Form Submission

Official Documentation

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

Developer Guide

Official Documentation

Developer Guide 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 solutions. ...

Understanding Form Storage Adapters

Official Documentation

Understanding Form Storage Adapters Liferay DXP 7.3 and Liferay DXP 7.2 versions that include the fix for [LPS-97208](https://issues.liferay.com/browse/LPS-97208) (planned for Liferay DXP 7.2 SP3)....

Creating Data Definitions

Official Documentation

Creating Data Definitions Dynamic Data Lists is deprecated as of Liferay DXP 7.3, and is planned for removal in 2024. It is replaced by Objects. Please migrate your Dynamic Data Lists to Objects...

Using the REST Data Provider to Populate Form Options

Official Documentation

Using the REST Data Provider to Populate Form Options Select from List fields can hold many options. Those options can be supplied automatically by using the JSON web services registered in Liferay...

Writing a Custom Form Field Type

Official Documentation

Writing a Custom Form Field Type The Forms application contains many highly configurable field types out-of-the-box. Most use cases are met with one of the existing field types. If your use case...

Using the Require Rule

Official Documentation

Using the Require Rule Use a Require rule to make a field required based on one or more conditions. Require Rules work in association with other Rules, such as the Show Rule. To demonstrate,...

Kaleo Forms

Official Documentation

Kaleo Forms Subscription Kaleo Forms is deprecated as of Liferay DXP 2023.Q3/Portal GA92. Use business processes for Liferay Objects (i.e., objects, workflow, and form container fragments)...

Using the Jump to Page Rule

Official Documentation

Using the Jump to Page Rule Use a Jump to Page rule to navigate automatically to a specific page in the form based on one or more conditions. This is useful if some pages do not apply to all the...

Using the Enable-Disable Rule

Official Documentation

Using the Enable-Disable Rule An enable/disable Rule makes a field editable based on one or more conditions. This is useful for entering optional information or gathering data from only users who...

Using the Show-Hide Rule

Official Documentation

Using the Show-Hide Rule Users can use a Show action show a field if a condition is met. Otherwise, this field is hidden. This example uses a camp registration form with two text fields: I am...

Using Forms to Poll Users

Official Documentation

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

Configuring Personal Notifications

Official Documentation

Configuring Personal Notifications Liferay provides integrated notification tools, so you can ensure users are alerted to platform events. Users can customize which notifications they receive by...

Using Forms with a Workflow

Official Documentation

Using Forms with a Workflow The Forms application is integrated with the Workflow application and therefore users can activate a workflow process for a form. This means that before a form's entry...

Notifications

Official Documentation

Notifications Liferay provides integrated notification tools to alert users to platform events. For Liferay DXP, this includes email and website notifications for the following default...

Sharing Forms

Official Documentation

Sharing Forms There are two ways to share a form: Placing the Form widget on a site page and configuring the widget to display the particular form. This allows the form to be seen and submitted...

Creating Notification Templates

Official Documentation

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 the Notification Queue

Official Documentation

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

Writing a Custom Data Provider

Official Documentation

Writing a Custom Data Provider Liferay Forms fields can be populated using a Data Provider. Out of the box, there's a REST Data Provider that provides a flexible way to consume data from most REST...

Writing a Form Storage Adapter

Official Documentation

Writing a Form Storage Adapter Liferay DXP 7.3 and Liferay DXP 7.2 versions that include the fix for [LPS-97208](https://issues.liferay.com/browse/LPS-97208) (planned for Liferay DXP 7.2 SP3) By...

Developing a Custom Form Field for Liferay 7.2

Official Documentation

Developing a Custom Form Field for Liferay 7.2 React-based custom form fields can be developed for Liferay 7.3 and Liferay 7.4. See Writing Custom Form Field Types to learn how. Liferay 7.2 used a...

Example: Using Hidden Fields with Form Rules

Official Documentation

Example: Using Hidden Fields with Form Rules Configure Forms fields as hidden in the Advanced configuration tab. Hide fields using the advanced setting. There's a hidden field in this form. It...

Using the Autofill Rule

Official Documentation

Using the Autofill Rule The autofill rule filters a form field's options based on pre-configured conditions. If you already have a data provider enabled, the autofill rule is the next step in...

Using the Calculate Rule

Official Documentation

Using the Calculate Rule Users can create Calculate rules that populate a numeric field by calculating its value based on other fields. For example, a Calculate rule can calculate a camp or...

Consuming GraphQL APIs

Official Documentation

Consuming GraphQL APIs Liferay DXP contains GraphQL APIs for most of its applications. The GraphQL APIs are available at http://[host]:[port]/o/graphql. Here's how to consume them in three steps: ...

API Headers Reference

Official Documentation

API Headers Reference API headers are components of HTTP requests that provide essential information to the server about the client's request and how the server should handle it. You can use API...

Consuming APIs

Official Documentation

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

Batch Engine API Basics - Exporting Data

Official Documentation

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

API Query Parameters

Official Documentation

API Query Parameters Whether you consume REST APIs or GraphQL APIs, different query parameters are available to help you filter the responses. Some endpoints do not make use of the filter, sort,...

Configuring JSON Web Services

Official Documentation

Configuring JSON Web Services Liferay’s services are exposed as JSON web services out-of-the-box. This is enabled by default. You can access these services via the API page at...

Consuming REST Services

Official Documentation

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

Sample API Tutorials

Official Documentation

Sample API Tutorials Follow the links below for sample API tutorials that include example requests and example code. Building Applications (Objects) Custom Objects API Basics Custom Objects...

Data Migration Center

Official Documentation

Data Migration Center Liferay DXP 2023.Q4+/Portal GA102+ [Beta Feature](../../../../security-and-administration/administration/configuring-liferay/feature-flags.md#beta-feature-flags) Currently,...

Search Results