Skip to main content

Portal Admin Guide

Portal administration covers page structure, boxes, templates, user visibility, and access control. The goal is to provide a focused frontend without exposing internal WebUI complexity.

Administration Areas

The Portal application provides administration routes for portal pages, users, sessions, and configuration. Depending on the installation, these pages are available through /portal/admin and related routes.

Administrative access is usually limited to admin, role_edit_portal, rolle_Portal_Administrator, or installation-specific administrator roles.

Page Structure

Portal pages are DMS objects, typically based on a portal page mask such as cqp_page. Important page properties include:

Property conceptTypical field
Page titleFIELD_PAGE_NAME
DescriptionFIELD_PAGE_DESCRIPTION
Publication stateFIELD_PAGE_PUBLISH
LayoutFIELD_PAGE_LAYOUT
Navigation behaviorFIELD_PAGE_NEW_NAVIGATION
Metadata titleFIELD_PAGE_META_TITLE
Metadata descriptionFIELD_PAGE_META_DESCRIPTION
Metadata languageFIELD_PAGE_META_LANGUAGE
Icon and colorFIELD_PAGE_ICON, FIELD_PAGE_COLOR

The exact field names are configured per installation. A common configuration maps these concepts to cq_* fields.

Boxes

Boxes are DMS objects, typically based on a portal box mask such as cqp_box. A box is rendered only when it is placed in the current page zone, published, and visible for the current user.

Important box concepts are:

Property conceptTypical field
ZoneFIELD_BOX_POSITION
Publication stateFIELD_BOX_PUBLISH
TemplateFIELD_BOX_TEMPLATE
Layout/styleFIELD_BOX_LAYOUT
Result limitFIELD_BOX_NUM_ITEMS
Result orderingFIELD_BOX_RESULT_ORDER
QueryFIELD_BOX_QUERY
ACLobj_acl or cq_acl

Boxes can be placed in page-specific box folders or configured as required boxes that appear on multiple pages.

Zones

Zones are logical layout areas. The configured pb_zone_mapping maps business names to template zones. For example, a customer configuration can map links, oben, unten, and rechts to internal zone identifiers.

When a page renders, the master template calls the relevant zones. Each zone outputs the matching boxes in that area.

Publication

Pages and boxes usually have a publication field. A page or box is visible when the field matches the configured yes value, such as Ja, Yes, true, or 1.

In edit or configuration mode, unpublished boxes may still be rendered so administrators can configure and test them.

ACL Visibility

Portal ACLs restrict visibility beyond the normal DMS permissions. ACL values are read from obj_acl first and from cq_acl as a legacy fallback.

Empty ACL means visible for everyone who can otherwise access the page or object. If ACL values exist, the current user must have at least one matching role. Portal administrators bypass this portal-level ACL check.

User and Session Administration

Portal administrators can manage users and inspect active sessions if the corresponding admin pages are enabled.

User records are stored as obj_user objects. Important fields include:

  • user ID
  • login name
  • first and last name
  • e-mail address
  • company and department
  • status
  • user type
  • roles

The portal user save endpoint updates obj_user objects with elevated rights after checking that the current session is allowed to administer users.

Configuration Checklist

Before publishing a portal, verify:

  • the portal prefix points to the expected route
  • the entry page exists
  • the anonymous user exists and has only minimal rights
  • login and logout work
  • SSO or OIDC redirects behave as expected
  • required boxes are present
  • page-specific boxes are in the expected box folder
  • pages and boxes are published
  • ACL values match real user roles
  • document links work without exposing unrelated content
  • templates are available in the configured layout paths