UsageType

This is the primary specifier for the type of content reference. There are a number of different types of content references, but all content references can be categorized into the following major types:

  • Target

  • Template

  • Portal Component

Target

The target is the page referenced by a URL in the user's browser. This is the main transaction or page that the user wants, and the portal may place other content around this target page based on the template. The template describes any other content, and where to place it, on the page. The template is either gotten from the content reference or a set of default templates.

Content reference links can only be created for content references that have a type of target.

Template

A portal template defines how the portal creates a user's page. It's an HTML document that describes the content and where the content is placed. The template specifies one target and zero or more portal components.

The portal template in the following example is comprised of four separate template components: one for the navigation and search header, one for related links, one for the target content region, and one for the overall template which specifies where the other components should be placed. At runtime, the target content region would be filled by the HTML returned by the target page, as would the other template component regions.

A portal template

See Portal Technology: Portal Templates and Template Pagelets.

Portal Component

A portal component is an HTML document, or something that produces an HTML document. The portal component must be defined within a template.

A portal component could be one of a Homepage tab, component reference, or Homepage Pagelet.

UsageType Values

The following table matches the general types of target, template, and portal component to the actual values of the UsageType property.

General Type UsageType Value

Target

Target (TARG)

Template

Frame template (FRMT) or HTML template (HTMT)

Pagelet

Pagelet (HPGC)

Homepage Tab

Homepage Tab (HPGT)

More specifically:

  • A UsageType value of TARG specifies a content reference that is a target.

  • A UsageType value of FRMT specifies a content reference that is an HTML frame template.

  • A UsageType value of HTMP specifies a content reference that is an HTML template.

  • A UsageType value of HPGC specifies a content reference that is a PeopleSoft homepage component (pagelet).

  • A UsageType value of HPGT specifies a Homepage tab.

  • A UsageType value of LINK specifies a content reference link.