Search Results

All Results 6974
Sort By
Resource Type
Applicable Versions
Deployment Approach
Capability
Feature
Accounts API Basics
Official Documentation
Accounts API Basics Liferay DXP/Portal 7.4+ You can manage accounts from the Applications menu or use Liferay's REST APIs. Call these services to create and manage accounts. Adding an Account ...
Postal Address API Basics
Official Documentation
Postal Address API Basics Liferay DXP/Portal 7.4+ Use Liferay's REST APIs to manage postal addresses. Add Postal Address to Account Then, follow these steps: Download and unzip Postal Address...
Batch Engine API Basics - Importing Data
Official Documentation
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...
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: ...
Making Unauthenticated Requests
Official Documentation
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...
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. Fields Parameter Use this parameter to specify and...
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,...
Using OAuth 2.0
Official Documentation
Using OAuth 2.0 OAuth 2.0 is an industry-standard authorization protocol. Users with accounts on a Liferay-based website can share select credentials with various clients seamlessly. OAuth 2.0...
Using External Reference Codes
Official Documentation
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...
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...
Using OAuth2 to Authorize Users
Official Documentation
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...
JAX-RS
JAX-RS JAX-RS web services work in Liferay modules the same way they work outside of Liferay, though you must register the class in the OSGi framework. To learn how to create these applications,...
Creating an OAuth2 Application
Official Documentation
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. Open the Global Menu...
JSON Web Token Assertions
Official Documentation
JSON Web Token Assertions An assertion helps in sharing identity and security information across different domains. There are two uses for assertions: Authorization grants Client authentication...
Client Secret JWT
Official Documentation
Client Secret JWT Liferay supports client secret JWT as an authentication method for OAuth 2 clients. In this flow, the client itself creates the assertion and signs it using the client secret....
Issuing JWT Access Tokens
Official Documentation
Issuing JWT Access Tokens Liferay DXP 7.4 U45+/GA45+ You can configure Liferay to issue access tokens in the JWT format from System Settings. Enabling JWT Tokens Open the Global Menu...
Authorizing Account Access with OAuth2
Official Documentation
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)....
Using Private Key JWT (JSON Web Token)
Official Documentation
Using Private Key JWT (JSON Web Token) Liferay supports private key JWT as an authentication method for OAuth 2 clients. In this flow, the client itself creates the assertion. Liferay authenticates...
REST Builder
Official Documentation
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 REST and...
Using Integrately to Sync Object Data with Google Sheets
Official Documentation
Using Integrately to Sync Object Data with Google Sheets Liferay 7.4+ Here you'll learn how to use webhooks to trigger sync tasks between Liferay Objects and Google Sheets using Integrately....
Using Workato to Sync Object Data with Google Sheets
Official Documentation
Using Workato to Sync Object Data with Google Sheets Liferay 7.4+ Here you'll learn how to use webhooks to trigger sync tasks between Liferay Objects and Google Sheets using Workato. Syncing your...
Using Elastic.io to Sync Object Data with Google Sheets
Official Documentation
Using Elastic.io to Sync Object Data with Google Sheets Liferay 7.4+ You can use Liferay Objects with data integration tools to create automated tasks for syncing Object data with external...
Using Google Sheets with Objects
Official Documentation
Using Google Sheets with Objects Liferay 7.4+ These articles explain how to use webhooks to trigger sync tasks between Liferay Objects and Google Sheets using a variety of third party tools.
Using Make to Sync Object Data with Google Sheets
Official Documentation
Using Make to Sync Object Data with Google Sheets Liferay 7.4+ Here you'll learn how to use webhooks to trigger sync tasks between Liferay Objects and Google Sheets using Make (formerly...
Objects Application Permissions
Official Documentation
Objects Application Permissions Liferay DXP 2023.Q4+/Portal GA102+ The Objects application is integrated with the permissions framework, so you can assign application and resource permissions to...
Using Zapier to Sync Object Data with Google Sheets
Official Documentation
Using Zapier to Sync Object Data with Google Sheets Liferay 7.4+ Here you'll learn how to use webhooks to trigger sync tasks between Liferay Objects and Google Sheets using Zapier. Syncing your...
Integrating Service Builder Applications with Objects
Official Documentation
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
Official Documentation
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...
Managing Workflows
Official Documentation
Managing Workflows With the workflow framework, Users manage asset publication in custom-built workflow processes. Users with permission to access workflow process definitions in the Control Panel...
Workflow Designer
Official Documentation
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...
Designing and Managing Workflows
Official Documentation
Designing and Managing Workflows Building Workflows Managing Workflows Workflow Designer Workflow Designer Overview Workflow Nodes Creating Workflow Tasks Configuring Workflow Actions and...
Creating Workflow Tasks
Official Documentation
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...
Assigning Task Nodes
Official Documentation
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...
Using Condition Nodes
Official Documentation
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
Official Documentation
Configuring Workflow Actions and Notifications Subscription Using the workflow designer, users can configure workflow actions and notifications for each node. Workflow actions are operations that...
Workflow Transitions
Official Documentation
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: ...
Using Forks and Joins
Official Documentation
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...
Workflow Nodes
Official Documentation
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...
Developer Guide
Official Documentation
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 Definition Node Reference
Official Documentation
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...
Workflow Designer Overview
Official Documentation
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 a Condition Evaluator
Official Documentation
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...
Using the Script Engine in Workflow
Official Documentation
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...
Crafting XML Workflow Definitions
Official Documentation
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...
Using Task Timers
Official Documentation
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 an Action Executor
Official Documentation
Creating an Action Executor Workflow nodes can contain elements that execute custom logic via Groovy scripts. approve
Workflow Notification Template Variables
Official Documentation
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
Official Documentation
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...
Working with Workflow Context
Official Documentation
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...
Workflow Metrics: Reports
Official Documentation
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...
Getting Started
Official Documentation
Getting Started Welcome to Liferay Analytics Cloud! Collecting analytics data is a crucial part of any business. There are many different tools out there but not all provide high value. It's not...
Introduction to Workflow
Official Documentation
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
Official Documentation
Using Workflows Activating Workflow Reviewing Assets Using Workflow Metrics Workflow Metrics Reports
Connecting Liferay DXP to Analytics Cloud
Official Documentation
Connecting Liferay DXP to Analytics Cloud Liferay DXP 2024.Q1+/Portal GA112+ Liferay DXP and Analytics Cloud connect via a secure, encrypted token. This token is generated by Analytics Cloud and...
Activating Workflow
Official Documentation
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...
Reviewing Assets
Official Documentation
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...
Analytics Cloud
Analytics Cloud Collecting analytics data is a crucial part of any business. Liferay offers an analytics tool that's integrated with DXP to provide useful information on who visits your site and...
Connecting Liferay DXP 7.3 to Analytics Cloud
Official Documentation
Connecting Liferay DXP 7.3 to Analytics Cloud Liferay DXP 7.3 U30+ The steps to connect Liferay DXP 7.3 to Analytics Cloud differ slightly from the steps to connect Liferay DXP 7.4. Liferay DXP...
Using Workflow Metrics
Official Documentation
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...