Defining Zone Types

A Zone Types represents a particular type of zone with a specific behavior. For example, a data explorer zone type is used to select data using a specific SQL statement and display the data based on parameter configuration. The zone type defines the Java Class that controls the behavior of the zone and defines the parameters that the Java Class supports. The base product supports many zone types used to build the portal / zone user interface. Implementations may introduce their own zone types.

Note: It is not very common for an implementation to introduce their own zone types.

Select Admin > System > Zone Type to maintain zone types.

Description of Page

Specify an easily recognizable Zone Type code and Description. Use the Detailed Description to describe in detail what the zone type does.

CAUTION: When adding new zone types, carefully consider its naming convention. Refer to System Data Naming Convention for more information.

Owner indicates if this zone type is owned by the base product or by your implementation (Customer Modification). The system sets the owner to Customer Modification when you add a zone type. This information is display-only.

Java Class Name is the Java class responsible for building the zone using the parameters defined below.

Two types of parameters are specified when defining a zone type:

  • Parameter values that have a Usage of Zone are defined on the zones and control the functionality of each zone governed by the zone type. A Usage value of Zone - Override Allowed indicates that an implementation may override the parameter value for a base zone.
  • Parameter values that have a Usage of Zone Type are defined directly on the zone type and control how the zone type operates (e.g., the name of the XSL template, the name of the application service). A Usage value of Zone Type - Override Allowed indicates that an implementation may override the parameter value for a base zone type.

The following points describe the fields that are defined for each parameter:

  • Sequence defines the relative position of the parameter.
  • Parameter Name is the name of the parameter.
  • Description is a short description that allows you to easily identify the purpose of the parameter.
  • Comments contain information that you must know about the parameter or its implementation. For parameters with a usage of Zone or Zone - Override Allowed, this information is visible to the user when viewing or defining this parameter for a zone of this type.
  • Usage indicates whether the parameter value is defined in a Zone of this type or in the Zone Type. Zone - Override Allowed and Zone Type - Override Allowed indicate that override values for the parameters defined in a base zone or base zone type can be entered.
  • Required is checked to indicate that a zone must define a value for the parameter. It is not checked if a value for the parameter is optional. This field is protected if the Usage is Zone Type or Zone Type - Override Allowed.
  • Parameter Value is used to define the value of zone type parameters. This field is protected if the Usage is Zone or Zone - Override Allowed.

  • Owner indicates if this parameter is owned by the base product or by your implementation (Customer Modification). The system sets the owner to Customer Modification when you add a parameter. This information is display-only.

Zone Type Parameter Comments

For the product owned zone type parameters, the parameter’s detailed description provides the detail needed for properly configuring the parameter. For the Action parameters (IMPLEMENTOR_​ACTION_​n), the parameter description is abbreviated. Additional detail about configuring this parameter may be found in the Zone Action Parameter detailed information. The same details apply.