oo

Displaying Object Entries

Liferay 7.4+

With Liferay Objects, you can use existing DXP frameworks to display Object entries dynamically in Sites. This includes collection displays for multiple entries and display pages for individual entries.

When an Object is published, Liferay creates a Collection Provider for use with the Collection Display fragment to display multiple Object entries. You can also configure the fragment to style, filter, and paginate the collection. See Displaying Object Entries with Collection Providers for more information.

And since published Objects are integrated with the Info framework, you can select them as the content type for Display Page Templates. When selected, the Object is set as the template’s mapping source, so you can easily map fragment fields to Object fields to create flexible page displays for individual Object entries.

Additionally, you can use FreeMarker to create Information Templates for Objects. Once created, you can map fragment fields to your template to determine how entries are rendered in Content Pages and Display Pages.

note

Information Templates can be used in Content Display fragments and any other fragment with sub-elements (e.g., text, rich text) that can be mapped to Objects.

Together, these integrations enable users to leverage Liferay’s WYSIWYG page building capabilities while delivering personalized user experiences.

Creating Display Page Templates for Objects

When created, each Object entry is assigned automatically a dedicated friendly URL that uses the following pattern: server-address/l/objectEntryId (e.g., https://mysite.com/l/44337). To view an entry at its URL, you must first create a Display Page Template for the Object.

Follow these steps:

  1. Open the Site Menu (Site Menu), expand Design, and go to Page Templates.

  2. Click the Display Page Templates tab.

  3. Click the Add button (Add Button) and select the Blank template.

    This opens a modal window.

  4. Enter a name and select the desired Object for Content Type.

    Enter a name and select the desired Object for Content Type

  5. Click Save.

    This creates a blank template with the selected Object as its default mapping source and redirects you to the template editing page.

  6. Use page fragments and widgets to create flexible, dynamic displays for Object entries. See Using Display Page Templates for information.

    Map fragment elements to Object fields to dynamically populate Display Pages for individual entries.

  7. Add the Page Comments widget so end users can comment on entry display pages.

    note

    You must enable comments for the object definition. Otherwise, the widget is hidden in the display page.

  8. When finished, click Publish.

  9. Click the Actions button (Actions Button) for your template and select Mark as Default.

    This template is now used to render the Object’s entries whenever users visit their friendly URLs.

    Click the Actions button for the template and select Mark as Default.

Enabling Comments

  1. Open the Global Menu (Global Menu), go to the Control Panel tab, and click Objects.

  2. Edit an object definition.

  3. In the Details tab, enable comments and click Save.

    Enable comments.

Creating Information Templates for Objects

  1. Open the Site Menu (Site Menu) and go to DesignTemplatesInformation Templates.

  2. Click Add (Add Button)

  3. Enter a name and select the desired Object.

    Enter a name and select the desired Object.

  4. Click Save. This redirects you to the template design page.

  5. (Optional) Click Actions (Actions Button) in the Application Bar, select Import Script, and choose an .ftl file to import. This replaces the current template with the file’s FreeMarker script.

    Import script from an .ftl file.

  6. Use FreeMarker to design your template.

    In the Elements side panel (Elements), you can access available fields from the selected Object’s structure.

    Select from available fields in the Object's structure.

  7. (Optional) Add a description or image to the template in the Properties side panel (Properties).

    Add a description or image in the Properties panel.

  8. Click Save when finished.

You can now select from the template when mapping Object entries to fragment fields.

Select the template when mapping fragment elements.

Adding Entries to Navigation Menus

Since Objects are integrated with the info framework, you can add Object entries to navigation menus to provide quick access. All published Objects automatically appear as available sources for menu elements. See Using the Navigation Menus Application for more information.

Capability:
Feature: