Creating and Editing a Framework PageLocate this document in the navigation structure

Use

A framework page is a portal page object that contains user interface units, which together define the layout and structure of a portal desktop. A framework page contains the core iViews and pages that are required by a user to operate and navigate the portal.

You create framework pages with the same tools that you use to create regular portal pages.

Procedure

  1. To create or edit a framework page, use the Page editor in the Portal Content Studio.

    For more information, see Editing Page Content and Layout

    Recommendation

    To create your own framework page, we strongly recommend to use the Ajax Framework Page (see Ajax Framework Page ) shipped with the portal as a delta link template. This ensures that the new framework page contains all necessary properties, and that future enhancements made to the Ajax Framework Page by SAP are subsequently applied to your own framework page after upgrading.

  2. To enable the portal runtime to recognize and fully support framework pages, such as underlying navigation-related mechanisms, eventing, and optimal performance, you need to use the Properties editor to set the Element in Framework Page property in the framework page and in the structural pages that compose it.

    The Element in Framework Page property is described below.

    Note

    This property is necessary for page objects only. You do not need to set the property in iViews that compose the framework page, or iViews that run in the framework page, such as iViews in the navigation panel and header area.

'Element in Framework Page' Property

You define the Element in Framework Page property described below in the Properties Editor. For more information, see Editing Object Properties .

The Element in Framework Page property identifies the function of a particular page in relation to the entire framework page. Depending on the function of the page in the framework page, assign one of the following values:

  • AFP - Ajax Framework Page : Assign this value to the main page designated as the framework page. This is the page that holds the structural components constituting the framework page, which you eventually combine with portal themes to create portal desktops. For more information, see Understanding Portal Desktops .

  • Framework Page : This value is relevant only for framework pages based on the Classic Framework Page object ( com.sap.portal.frameworkpage ). For more information, see Classic Framework Page .

  • Dynamic : Assign this value to pages within the framework page that change with each navigation event at runtime.

    For example, this value is assigned by default to the Desktop Innerpage object ( com.sap.portal.innerpage ), which is part of the Classic Framework Page shipped with the portal.

  • None : Assign this value to regular portal pages that display content in the portal runtime environment.

If instead of creating a framework page or inner page from a delta link template, you create them from scratch based on your own portal components, you must add the following code in the portal component descriptor file of the respective pages to enable the Element in Framework Page property and values:

<property name="com.sap.portal.framework.phase" value="None">
        <property name="plainDescription" value="Element in Framework Page"/>
        <property name="validvalues" value="4/None9/Framework8/Navigate12/Personportal10/Personpage"/>
        <property name="validValueTitle0" value="None"/>
                <property name="validValueTitle1" value="Framework Page"/>
                <property name="validValueTitle2" value="Dynamic"/>
                <property name="validValueTitle3" value="Personalize Portal"/>
                <property name="validValueTitle4" value="Personalize Page"/>
                <property name="category" value="Navigation"/>
        </property>

Configuring Framework Page Properties

To facilitate the configuration of framework pages, the Framework Page Configuration tool provides you with access to a predefined set of properties that you can configure for the framework pages in your portal.

  1. Navigate to Start of the navigation path Content Administration Next navigation step Portal Display Next navigation step Framework Page Configuration End of the navigation path.

  2. From the Framework Page Name (Desktop Name) dropdown list, choose the relevant framework page.

    The dropdown list shows all of the framework pages in your system that have been assigned to a desktop. The name of the desktop is shown in parentheses. For example, Ajax Framework Page (Ajax Portal Desktop) .

  3. A list of properties appears. Hover the cursor over each property to see a description of that property.

  4. Make the necessary changes to the listed properties and save your changes.

  5. To restore the default property values, choose Reset .