Virtual Portal Configuration Service | HCL Digital Experience

The Virtual Portal configuration service (WP VirtualPortalConfigService) enables you to specify properties for the default virtual portal and for specific virtual portals. Refer to the Property names section for details about the portal settings this configuration supports.

Property syntax

There are several ways in which you can define properties for virtual portals:

URL context for the virtual portal

Property format:

context.virtual_portal_context.property.property_name =
property_value

Example: context.vp1.property.property1 = true

Host name of the virtual portal

Property format:

hostname.virtual_portal_hostname.property.property_name =
property_value

Example: hostname.vp1.example.com.property.property1 = true

The default keyword

The default keyword is used to identify the default virtual portal. The default virtual portal has no dedicated URL context or host name.

Property format: default.property_name = property_value

Example: default.property1 = true

The global keyword

The global keyword is used as a fallback property if there no more specific property that is defined for a virtual portal.

Property format: global.property_name = property_value

Example: global.property1 = true

Replace the following variables when you define specific properties:

property_name: The name of the property that you are defining.
property_value: The value of the property that you are defining.
virtual_portal_context: The URL context of the target virtual portal.
virtual_portal_hostname: The host name of the target virtual portal.

Note: You can determine the URL context and the host name of the target virtual portal with the Manage Virtual Portals administration portlet.

Property names

You can use the following values to replace the property_name variable from Property syntax section of the documentation:

toolbar.enabled = (true): Use this property name to enable or disable the site toolbar for an entire portal or for specific virtual portals. The site toolbar provides access to editing features for managed pages, including adding and editing pages and web content. Although essential for an authoring server, it is recommended that you disable the site toolbar on a delivery server.

Evaluation order

The portal evaluates properties for virtual portals in the following order and returns the appropriate value:

The portal checks for a specific property that is defined for a virtual portal by the context, hostname, or default keyword. The value of the property is returned.
Important: If you define conflicting values for a virtual portal with different properties, the results can be unpredictable. For example, this issue can occur if you define one value with the context keyword and a different value with the hostname keyword. To avoid problems, use only one value.
If no specific property is defined for a virtual portal, the portal checks for a property defined by the global keyword. The value of the property is returned.
If no global property is defined, the value null is returned.