Defining UI Maps

Use this page to define basic information about a user interface (UI) Map.

You can access the portal from the Admin Menu > System > UI Map. You are brought to a query portal with options for searching for a specific UI Map. Once a UI Map has been selected you are brought to the maintenance portal to view and maintain the selected record.

CAUTION:
Important! If you introduce a new UI Map, carefully consider its naming convention. Refer to System Data Naming Convention for more information.

Refer to Understanding UI Maps for more information.

Use UI Map Type to indicate the map type. The system recommends using a Complete XHTML Document (the default) or XHTML Fragment. The values Complete HTML Document and HTML Fragment remain for backward compatibility but are not recommended.

The following zones may appear as part of the portal's Main tab page.

  • UI Map. This zone provides information about the selected UI Map.
  • HTML Editor. This zone allows you to edit the HTML document of the map.
    Note:
    Refer to UI Map Attributes and Functions and UI Map Standards for more information about HTML definition syntax. These topics describe good ways to produce simple HTML, however, they are not an HTML reference. Note that you can use a variety of HTML editors to compose your HTML, which you can then cut and paste into your UI map.
    Note:
    Providing Help. A tool tip can be used to display additional help information to the user. This applies to section elements as well as individual elements on a map. Refer to UI Map Attributes and Functions for more information on how to enable and provide UI map help.
  • HTML Override Editor. This zone allows you to provide an override HTML document for a base product map.

The following zones may appear as part of the portal's Schema tab page.

  • Schema Editor. This zone allows you to edit the UI Map's schema using the Schema Designer tool. The purpose of the schema is to describe the UI Map's properties.
    Fastpath:
    Refer to Schema Syntax and UI Hint syntax for a complete list of the XML nodes and attributes available to you when you construct a schema.
    Tip:
    Click the View Schema hyperlink to view the UI Map's expanded schema definition. Doing this opens the schema viewer window.

The following zones may appear as part of the portal's References tab page.

  • UI Map References. This zone list various configuration entities referencing the current UI Map, its HTML or its schema.

Actions

The page supports the following special actions:

  • View Schema. Click the hyperlink to view the UI Map's expanded schema definition. Doing this opens the schema viewer window.
  • Test UI Map. Use the hyperlink to render your HTML in a test window. This action also exercises the proprietary functionality that binds an XML element with an HTML element so you can get immediate feedback on your HTML syntax.