PreviewURL

The PreviewURL component encapsulates the URL to a preview application and is created from this class:

atg.service.preview.PreviewURL

This component has the following properties:

Property

Description

name

The user-defined name of this preview URL, used by the Preview dialog if you do not set the properties displayNameResourceBundle and displayNameResourceKey.

resourceBundleName

The resource bundle that contains the preview site’s display name, specified by displayNameResourceKey.

displayNameResourceKey

The key in resourceBundleName that defines the preview site’s display name.

host

The Nucleus path of a PreviewHost component, set only for preview-enabled servers that run on a host other than one where the asset management server runs. A null setting indicates the local (asset management server) host.

path

The Nucleus path of a PreviewPath component. This property must be set.

protocol

The protocol to use for this URL, for example, https. If this property is not set, the default protocol is http.

types

A collection of item descriptor names for repository item types to associate to a preview URL. Setting this property limits the number of Preview URLs that appear in the Preview Landing Page column of the Preview Launcher dialog.

The format of this property is:

types=Repository Name=item type|item type|...|item type,...,Repository Name=item type|item type|...|item type

If item type has subtypes, they are automatically included. However, if item type is a subtype, its supertype is not automatically included and must be specified separately.

If this property is not set, the preview URL is applicable to all item types.

For example:

# /atg/dynamo/service/preview/Sketch.properties
$class=atg.service.preview.PreviewURL
name=Sketch
host=
path=SketchPath
types=ProductCatalog=product|category