Documentation

App Builder Overview

Available: Liferay CE/DXP 7.3+

App Builder is a low-code application development solution for Liferay DXP. Build a data model, define the application’s forms (for entering data) and tables (for viewing and managing data records), then deploy your application to a Site or as a completely standalone application. With App Builder, you can create functional business applications with dedicated user interfaces and data separation without a single line of code.

Two separate applications are deployed for this App Builder object.

Why use App Builder when the Liferay Forms application includes similar form-building capabilities? Here’s an overview of the differences:

Capability Liferay Forms App Builder
Create simple or complex forms
Deploy the form in a widget or at a dedicated URL
Keep form data separate from other forms' data
Deploy the form to the product menu
Display collected data in multiple places
Control the presentation of form data
Deploy multiple forms for one data object
Deploy multiple data record views for one data object

App Builder goes beyond forms by providing data display tables, flexible deployment options, form combining, and more, all backed by a single data object.

Creating an App

App Builder comes in two flavors: Standard and Workflow Powered. All apps made with App builder consist of three components defined in the app builder UI: objects, form views, and table views. To skip straight to building an application, see Creating an Application with App Builder.

App Builder Objects

An Object is at the foundation of every App Builder application. It defines the information the application collects and manages. For example, a Guestbook object would at least contain a Name field and a Message field.

When creating an application based on an object, you create at least one form view, at least one table view, and deploy the application.

Native objects contain data fields out of the box. You can define the data fields of a custom object at the same time as creating its form views.

Form Views

A form view defines which of the object’s data fields users should fill out. The Liferay Forms application’s form builder tool is repurposed for this. An App Builder object can have multiple form views.

Adding fields to a form view automatically adds them to the object. You can reuse fields added to the object via a previously created form view by dragging the field from a field listing in the form viewer.

Table Views

Table views show the data records collected for an object. In addition, those with permission can access the Add new entry functionality, see the details of an entry, and manage the application’s entries. Table views can show all or a subset of the object’s fields. Every app has at least one table view, though the object can have as many as needed. A drag-and-drop interface makes it easy to create table views out of existing fields.

Deployment

Once an object is defined and at least one form and table view are created, you can deploy an application. You have several deployment options:

Widget: Deploy the application to the widget menu and add it to a page using the Add Widgets menu (from Add → Widgets, search for your application by name). Deploying as a widget really deploys three variations of the application to the Add Widgets menu, each with a different label. Each option exposes different features:

Widget Menu Label Submit Form Entries View Entries Update and Delete Entries
App Name
App Name [Form View]
App Name [Table View]

App Builder widgets are placed on pages.

Standalone: Deploy the application to a dedicated page that’s not part of a site and not visible to any navigation menu. This limits access to only those with the link.

Standalone App Builder applications are accessible only by direct link

Product Menu: Deploy the application to the Control Panel, the Site Menu, or both. This gives you flexibility in deciding which administrative Users can access the application.

App Builder applications can be added to the Product Menu.

A Standalone or Product Menu application always includes both the form and table view. The table view is the default view, while an add button provides access to the form view.