Development and tooling

Workflow Action YAML Configuration Reference

Workflow Action YAML Configuration Reference You can define a workflow action client extension with a client-extension.yaml file. Usage Details This client-extension.yaml file defines a workflow...

Published Date: May 9, 2024 6:54 PM

Creating and Managing Objects

Creating and Managing Objects Liferay 7.4+ Liferay Objects provides a convenient UI for creating custom applications that meet your business needs without writing code. You can also use Objects to...

Published Date: May 9, 2024 6:54 PM

Actions

Actions Object actions define custom business logic that you can run manually or automatically for object entry events. Examples include delivering entry event data to a webhook URL, sending email...

Published Date: May 9, 2024 6:54 PM

Defining Object Actions

Defining Object Actions Liferay 7.4 U60+/GA60+ Object actions define operations that you can run manually or automatically for object entry events. To add an action, Open the Global Menu (...

Published Date: May 9, 2024 6:54 PM

Using Manual Actions

Using Manual Actions Liferay 7.4 U60+/GA60+ When you use the standalone trigger for object actions, the actions become manual instead of automatic. Trigger these actions using these methods: ...

Published Date: May 9, 2024 6:54 PM

Fields

Fields Liferay 7.4 2023.Q4+/GA102+ Object fields are data definitions that represent database columns and store different types of values. All objects include default system fields, but you can...

Published Date: May 9, 2024 6:54 PM

Aggregation Fields

Aggregation Fields Liferay 7.4 U47+/GA47+ Aggregation fields perform basic calculations on the entries from a relationship table and display the resulting values. Available aggregation functions...

Published Date: May 9, 2024 6:54 PM

Activating and Deactivating Objects

Activating and Deactivating Objects Custom objects are activated when published. While active, you can use the object to create entries via the Liferay UI or dedicated REST APIs. If needed, you can...

Published Date: May 9, 2024 6:54 PM

Auditing Object Events

Auditing Object Events Liferay 7.4 U72+/GA72+ You can use Liferay's audit framework to track events for custom object definitions and their entries. To track entry events, you must enable entry...

Published Date: May 9, 2024 6:54 PM

Creating Objects

Creating Objects Liferay 7.4 2023.Q4+/GA102+ Liferay Objects provides development capabilities in the Liferay UI. Using Objects, you can build fully integrated Liferay applications without writing...

Published Date: May 9, 2024 6:54 PM

Deleting Objects

Deleting Objects Liferay 7.4 U26+/GA26+ You can delete draft and published object definitions. Deleting a definition removes its associated data, including the stored entries for published...

Published Date: May 9, 2024 6:54 PM

Exporting and Importing Object Definitions

Exporting and Importing Object Definitions Liferay 7.4 U68+/GA68+ You can export and import object definitions as .json files. These files include the definition's complete schema (e.g.,...

Published Date: May 9, 2024 6:54 PM

Extending System Objects

Extending System Objects Liferay 7.4 U86+/GA86+ With Liferay Objects, you can extend supported system services. Currently, only these services are integrated with the Objects framework: Account...

Published Date: May 9, 2024 6:54 PM

Adding and Managing Custom States

Adding and Managing Custom States Liferay 7.4+ Some use cases may require assigning multiple states to an object entry at the same time. For example, when building an Order application, you may...

Published Date: May 9, 2024 6:54 PM

Adding Fields to Objects

Adding Fields to Objects Liferay 7.4 2023.Q4+/GA102+ Fields are data definitions that represent database columns and store different types of values. By default, all objects include these system...

Published Date: May 9, 2024 6:54 PM

Encrypted Fields

Encrypted Fields Self-Hosted and Self-Managed Only Liferay 7.4 U72+/GA72+ Liferay provides the encrypted field type for storing sensitive user data. To use encrypted fields, first add an...

Published Date: May 9, 2024 6:54 PM

Formula Fields

Formula Fields Liferay 7.4 2023.Q4+/GA102+ Formula fields store read-only values calculated using numeric fields in the object definition. Example use cases include calculating an employee's...

Published Date: May 9, 2024 6:54 PM

Using Read-Only Fields

Using Read-Only Fields Some use cases may require data fields to be read-only. For example, data integrity may require some field values to remain immutable, or you may need to prevent unauthorized...

Published Date: May 9, 2024 6:54 PM

Designing Object Layouts

Designing Object Layouts Liferay 7.4 U31+/GA31+ Layouts define how fields and relationships appear when creating and editing object entries. Each layout can include multiple tabs containing...

Published Date: May 9, 2024 6:54 PM

Picklist Fields

Picklist Fields Liferay 7.4 U72+/GA72+ Picklists define lists of text values usable as single select or multi-select fields in object definitions. By default, single select fields appear as...

Published Date: May 9, 2024 6:54 PM

Layouts

Layouts Liferay 7.4+ Object layouts define how fields and relationships appear when creating and editing entries. All published objects include an autogenerated layout with a single tab that lists...

Published Date: May 9, 2024 6:54 PM

Adding Categorization to Fields Tabs

Adding Categorization to Fields Tabs Liferay 7.4 U31+/GA31+ You can add categorization blocks to fields tabs so end users can apply tags and categories to object entries. Follow these steps: ...

Published Date: May 9, 2024 6:54 PM

Managing Objects with Headless APIs

Managing Objects with Headless APIs Liferay 7.4+ You can create and manage objects from the Applications menu, but you can also use Liferay's REST APIs. Call these services to create and manage...

Published Date: May 9, 2024 6:54 PM

Localizing Object Definitions and Entries

Localizing Object Definitions and Entries Liferay 7.4 2023.Q3+/GA92+ Liferay objects are integrated with the localization framework, so you can add translations for definition labels, and users...

Published Date: May 9, 2024 6:54 PM

Organizing Objects with Folders

Organizing Objects with Folders By default, object definitions are grouped in the Uncategorized folder, but you can add object folders to organize data models and manage access to definitions. ...

Published Date: May 9, 2024 6:54 PM

Adding Field Validations

Adding Field Validations Liferay 7.4 2023.Q3+/GA92+ Validations set rules for determining valid field entries. Each validation has its own trigger, conditions, and error message, which you can set...

Published Date: May 9, 2024 6:54 PM

Using System Objects with Custom Objects

Published Date: May 9, 2024 6:54 PM

Accessing Accounts Data from Custom Objects

Accessing Accounts Data from Custom Objects Liferay 7.4 U35+/GA35+ In some use cases, you may want to access account data from a custom object. For example, if you're building a custom returns...

Published Date: May 9, 2024 6:54 PM

Using the Objects Model Builder

Using the Objects Model Builder [Liferay 7.4 2023.Q4+/GA102+](#model-builder-availability) For Liferay 7.4 2023.Q4+/GA102+, you must have Object Folder → View permissions to access the Objects...

Published Date: May 9, 2024 6:54 PM

Validations

Validations Liferay 7.4+ Object validations set rules for determining valid field inputs. You can define validations with Groovy scripts, Liferay expressions, or a specified Composite Key...

Published Date: May 9, 2024 6:54 PM

Expression Builder Validations Reference

Expression Builder Validations Reference Liferay 7.4 U67+/GA67+ With custom Objects, you can create field validations using Liferay's Expression Builder. This tool provides an integrated editor...

Published Date: May 9, 2024 6:54 PM

Designing Object Views

Designing Object Views Liferay 7.4+ Views define how entries appear in an object's application page. Though each published object has an autogenerated view, you can create your own. Design custom...

Published Date: May 9, 2024 6:54 PM

Renaming Table Columns

Renaming Table Columns Liferay 7.4 U21+/GA21+ With custom views, you can change and localize the display name for table columns so you can serve your global users and ensure the table's naming...

Published Date: May 9, 2024 6:54 PM

Setting a Default Sorting

Setting a Default Sorting Liferay 7.4 U18+/GA18+ With custom views, you can set a default sorting for tables. Follow these steps: Begin editing the desired view and go to the Default Sort tab. ...

Published Date: May 9, 2024 6:54 PM

Managing Data from External Systems

Managing Data from External Systems [Beta Feature](../../../system-administration/configuring-liferay/feature-flags.md#beta-feature-flags) Liferay Objects provides low-code capabilities for...

Published Date: May 9, 2024 6:54 PM

Views

Views Views define how entries appear in an object's application page. All published objects include an autogenerated table that displays all field columns alphabetically. However, you can design...

Published Date: May 9, 2024 6:54 PM

Adding Filters to Views

Adding Filters to Views Liferay 7.4 U49+/GA49+ When designing a custom view, you can determine which fields appear as filter facets. Also, you can set default filters that apply automatically to...

Published Date: May 9, 2024 6:54 PM

Displaying Object Entries with Collections

Displaying Object Entries with Collections Liferay 7.4 U77+/GA77+ When you publish an object definition, Liferay creates a collection provider for it. For site-scoped objects, you can also create...

Published Date: May 9, 2024 6:54 PM

Integrating Objects with Third Party Services

Integrating Objects with Third Party Services You can use Liferay Objects with popular data integration tools to create automated tasks for syncing Object data with external services. These tasks...

Published Date: May 9, 2024 6:54 PM

Using Objects with Salesforce

Using Objects with Salesforce [Beta Feature](../../../../system-administration/configuring-liferay/feature-flags.md#beta-feature-flags) With Liferay, you can create objects that integrate with...

Published Date: May 9, 2024 6:54 PM

Understanding Object Integrations

Understanding Object Integrations Published custom objects are integrated with Liferay's core frameworks, so you can leverage Liferay's features to build unified experiences across the platform....

Published Date: May 9, 2024 6:54 PM

Reference

Reference App Builder Deploying WARs (WAB Generator) JARS Excluded from WABs

Published Date: May 9, 2024 6:54 PM

Creating the Role Change Request App

Creating the Role Change Request App Subscribers The Role Change Request App starts with the employee submitting a request form. Processing then proceeds to the Current Manager, then to the...

Published Date: May 9, 2024 6:55 PM

Deploying WARs (WAB Generator)

Deploying WARs (WAB Generator) You can create applications as Java EE-style Web Application ARchive (WAR) artifacts or as Java ARchive (JAR) OSGi bundle artifacts. Bean Portlets, PortletMVC4Spring...

Published Date: May 9, 2024 6:55 PM

Tooling

Tooling Liferay provides a variety of developer tools that include standard build scripting, lightweight CLI utilities, and full IDE based on Eclipse. This is to serve all developers, whether...

Published Date: May 9, 2024 6:55 PM

App Builder

App Builder Available: Liferay CE/DXP 7.3 (deprecated and removed in 7.4) App Builder is a low-code application development solution for Liferay DXP. Build a data model, define the application's...

Published Date: May 9, 2024 6:54 PM

Creating a Standard Application

Creating a Standard Application To create applications based on a custom object takes four steps: create the object, create at least one form view, create at least one table view, and deploy the...

Published Date: May 9, 2024 6:55 PM

Creating a Workflow Powered Application

Creating a Workflow Powered Application Subscribers Workflow Powered Applications require data from multiple stakeholders. These process-driven applications can go through multiple stages before...

Published Date: May 9, 2024 6:55 PM

Creating the Role Change Request Object

Creating the Role Change Request Object Subscribers Consider a Human Resources application that collects employee requests to change Roles within the software engineering department: the Role...

Published Date: May 9, 2024 6:55 PM

JARs Excluded from WABs

JARs Excluded from WABs [Liferay-generated web application bundles (WABs) are stripped of third party JARs that contain packages that Liferay exports already. Deploying the same third party...

Published Date: May 9, 2024 6:55 PM

Troubleshooting Blade CLI

Troubleshooting Blade CLI If Blade CLI isn't working as expected, you may find answers here. The blade command is not available in my CLI The Blade CLI installer adds the blade command to your...

Published Date: May 9, 2024 6:55 PM

Generating Projects with Blade CLI

Generating Projects with Blade CLI Blade CLI exists to create, build, and deploy Liferay projects in Liferay Workspaces. Once created, these projects can be imported into an IDE or worked on...

Published Date: May 9, 2024 6:55 PM

Liferay Workspace

Liferay Workspace Liferay Workspace is a set of folders and Gradle scripts that represents the Liferay-opinionated way of handling a full development life cycle: Creating projects Building...

Published Date: May 9, 2024 6:55 PM

Other Tools (Deprecated)

Other Tools (Deprecated) These tools are deprecated as of Liferay 2024.Q4/7.4 GA129, and they are planned for future removal. Modern browsers (and Liferay DXP) all support including JavaScript...

Published Date: May 9, 2024 6:55 PM

Liferay CLI Tool

Liferay CLI Tool The Liferay CLI tool is deprecated as of Liferay 2024.Q4/7.4 GA129, and it's planned for future removal. The Liferay CLI tool makes it easy to create Angular, JavaScript, React,...

Published Date: May 9, 2024 6:55 PM

Bundler Migration Guide

Bundler Migration Guide The Liferay npm bundler is deprecated of Liferay 2024.Q4/7.4 GA129, and it's planned for future removal.

Published Date: May 9, 2024 6:55 PM

Migrating a liferay-npm-bundler Project from 1.x to 2.x

Migrating a liferay-npm-bundler Project from 1.x to 2.x The Liferay npm bundler is deprecated of Liferay 2024.Q4/7.4 GA129, and it's planned for future removal. liferay-npm-bundler 2.x offers...

Published Date: May 9, 2024 6:55 PM

Configuring a Liferay Docker Container

Configuring a Liferay Docker Container Creating and deploying containers is an important part of the modern developer workflow. Liferay Workspace makes it easy to use Docker containers both for...

Published Date: May 9, 2024 6:55 PM

Creating A Liferay Workspace

Creating A Liferay Workspace You can create a Liferay Workspace manually or with Blade CLI. Creating a Liferay Workspace Manually To create a Liferay Workspace manually, you must have Gradle...

Published Date: May 9, 2024 6:55 PM

Creating Code with Liferay Workspace

Creating Code with Liferay Workspace Liferay Workspace is the developer's tool for creating and managing Liferay development projects. Creating Projects Blade CLI makes it easy to create projects...

Published Date: May 9, 2024 6:55 PM