Development and tooling

Finding Artifacts

Finding Artifacts To use external artifacts in your project, you must configure their dependencies in your build.gradle Gradle script. Before specifying an artifact as a dependency, you must first...

Published Date: May 9, 24, 6:55 PM

Extending Liferay

Extending Liferay Liferay DXP/Portal is highly customizable. Its modular architecture contains components you can extend and override dynamically using APIs.

Published Date: Jul 18, 24, 8:39 PM

Customizing Localization

Customizing Localization Liferay ships with 55 translations, making it ideal for deployments all over the world. Sometimes, however, you must modify a translation or provide a new one. Here you can...

Published Date: Jul 18, 24, 4:48 PM

Adding a Language

Adding a Language Liferay currently supports about 50 languages out-of-the-box. Translation is complete for many of these languages, and some are still in the translation process. Each language has...

Published Date: Jul 18, 24, 8:39 PM

Generating Translations Automatically

Generating Translations Automatically Liferay DXP supports 50 languages out-of-the-box. Each locale has its own language properties file containing keys for its language. When you create an...

Published Date: Jul 18, 24, 8:39 PM

Fundamentals

Fundamentals Liferay development projects consist primarily of simple .jar files. These contain a few extra configuration files that make them OSGi modules, but they're easily understandable by...

Published Date: May 9, 24, 6:55 PM

Resolving Third Party Library Package Dependencies

Resolving Third Party Library Package Dependencies An application can rely on multiple OSGi modules. Resolving their Java package dependencies can be challenging. In a perfect world, every package...

Published Date: May 9, 24, 6:55 PM

Exporting Packages

Exporting Packages In OSGi, packages are private by default. You must explicitly exporting a package so other modules can import and use them. Here's how to export packages: Open your bnd.bnd...

Published Date: May 9, 24, 6:55 PM

Importing Packages

Importing Packages You often find yourself in a position of needing functionality provided by another module. To access this functionality, you must import packages from other modules into your...

Published Date: May 9, 24, 6:55 PM

Semantic Versioning

Semantic Versioning Semantic Versioning is a three tiered versioning system for incrementing version numbers based on the degree of API change made in a releasable software component. It's a...

Published Date: May 9, 24, 6:55 PM

Specifying Dependencies

Specifying Dependencies You must satisfy all dependencies to compile and deploy a module successfully. After you find the dependency artifacts, add them as dependencies in your Gradle build file....

Published Date: May 9, 24, 6:55 PM

Module Projects

Module Projects Liferay applications and customizations are OSGi modules: .jar files containing Java code and some extra configuration for publishing and consuming APIs. A module project comprises...

Published Date: May 9, 24, 6:55 PM

Using an OSGi Service

Using an OSGi Service Liferay APIs are readily available as OSGi services. You can access a service by creating a field of that service type and annotating the field with @Reference, like this: ...

Published Date: May 9, 24, 6:55 PM

7.4 Breaking Changes

7.4 Breaking Changes Breaking changes break or significantly alter existing functionality or code structure. Here are all of the breaking changes for Liferay 7.4, starting with the latest quarterly...

Published Date: May 9, 24, 6:55 PM

7.2 Breaking Changes

7.2 Breaking Changes This document presents a chronological list of changes that break existing functionality, APIs, or contracts with third party Liferay developers or users. We try our best to...

Published Date: May 9, 24, 6:55 PM

Using the Gogo Shell

Using the Gogo Shell The Gogo shell provides a way to interact with the module framework. Among other things, you can Dynamically install/uninstall bundles (modules) Examine package...

Published Date: May 9, 24, 6:55 PM

Command Line Gogo Shell

Command Line Gogo Shell If you're in a development environment, you can interact with the module framework locally from the command line. Gogo shell should only be run from the command line in...

Published Date: May 9, 24, 6:55 PM

Gogo Shell Commands

Gogo Shell Commands The Gogo shell executes Felix Gogo basic commands and Liferay commands. The Gogo shell is accessible in the Control Panel (recommended) and from the command line. Here are some...

Published Date: May 9, 24, 6:55 PM

Reference

Reference 7.4 Breaking Changes 7.3 Breaking Changes 7.2 Breaking Changes Exported Third-Party Packages Portal Developer Properties

Published Date: May 9, 24, 6:55 PM

7.3 Breaking Changes

7.3 Breaking Changes This document presents a chronological list of changes that break existing functionality, APIs, or contracts with third party Liferay developers or users. We try our best to...

Published Date: May 9, 24, 6:55 PM

Exported Third Party Packages

Exported Third Party Packages Liferay provides over one-hundred third party Java packages at run time. The com.liferay.portal.bootstrap module exports the packages by specifying individual packages...

Published Date: May 9, 24, 6:55 PM

Portal Developer Properties

Portal Developer Properties There are Portal Properties that facilitate development. Liferay's portal-developer.properties file includes all of them. The portal-developer.properties file is enabled...

Published Date: May 9, 24, 6:55 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, 24, 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, 24, 6:54 PM

Objects

Objects Liferay 7.4+ With Liferay Objects, you can build and deliver applications without having to write code or deploy modules. Each application built with Objects is integrated with Liferay's...

Published Date: May 9, 24, 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, 24, 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, 24, 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, 24, 6:54 PM

Understanding Action Types

Understanding Action Types Liferay 7.4 U60+/GA60+ Actions define custom operations triggered by object entry events. Liferay provides these action types: TypeDescription NotificationSend email or...

Published Date: May 9, 24, 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, 24, 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, 24, 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, 24, 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, 24, 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, 24, 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, 24, 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, 24, 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, 24, 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, 24, 6:54 PM

Attachment Fields

Attachment Fields Attachment fields are for uploading files to your instance's Document Library. When uploaded, the file is linked to the entry's attachment field, and each field can only be linked...

Published Date: May 9, 24, 6:54 PM

Auto-Increment Fields

Auto-Increment Fields DXP 2024.Q1+/Portal 7.4 GA112+ Auto-Increment fields are configurable read-only fields for uniquely identifying object entries in a human-readable format. For example, an IT...

Published Date: May 9, 24, 6:54 PM