Bookshelf v8.0: Page Definition

Configuration Guide for Siebel Offline Client for Life Sciences > Configuration Files, Filter Definitions, and Calculated Expressions > Application, Page, and Applet Definitions >

Page Definition

The following code example describes the general definition of a page schema.

Example Code for Page Schema Definition

The following code example describes the structure of a page schema definition:

aagesdefn.xml: <PAGES>
<PAGE>+
</PAGES>

<TEMPLATE_ITEM>: <TEMPLATE_ITEM>
<USERPROPS>?
<TOGGLEAPPLETS>?
<TOGGLEPARTNERS>?
</TEMPLATE_ITEM>

The following topics describe the attributes for the page schema definition:

<PAGE> Attributes

Table 27 describes the <PAGE> attributes for the page schema definition.

Table 27. <PAGE> Attributes
Attribute Name	Required or Optional	Default Value	Value	Function Description
MODE	Required	None	ModalPopUp	This page is a pop-up window relating to the MODE attribute.
MODE	Required	None	PopUp	This page is a pop-up window, which does not relate to the MODE attribute.
MODE	Required	None	Standard	This is a standard page.
NAME	Required	None	Text	Name of the page.

<TEMPLATE> Attributes

Table 28 describes the <TEMPLATE> attribute for the page schema definition.

Table 28. <TEMPLATE> Attributes
Attribute Name	Required or Optional	Default Value	Value	Function Description
NAME	Required	None	Text	Name of a page template.

<SECTION> Attribute

Table 29 describes the <SECTION> attribute for the PAGE definition.

Table 29. <SECTION> Attribute
Attribute Name	Required or Optional	Default Value	Value	Function Description
NAME	Required	None	Text	Name of the section.

<TEMPLATE_ITEM> Attributes

Table 30 describes the <TEMPLATE_ITEM> attributes for the page schema definition.

Table 30. <TEMPLATE_ITEM> Attribute
Attribute Name	Required or Optional	Default Value	Value	Function Description
APPLET	Required	None	Text	Name of the applet to be included in this page.
CAPTION	Optional	None	Text	String ID of the applet title.
CAPTION_TEXT	Optional	None	Text	Text of the applet title.
DEEPCOPY	Optional	None	N	Cannot use a deep copy. NOTE: Deep copy refers to copying an object including its child objects.
DEEPCOPY	Optional	None	Y	Can use a deep copy.
DISPLAY_COUNT	Optional	None	Number	Cached page size.
EQUIVALENTTO	Optional	None	Text	Name of another applet to which this applet is equivalent.
EQUIVALENT_APPLET_FLD	Optional	None	Text	The field to establish the equivalency. Equivalency is a tightly coupled one-to-one relationship between two applets of the same object type. It is used to simulate several levels in a hierarchy. For example, you have a Contact object with an activity Child Object. You also have an activity Object with a SampleDropped Child object. To simulate the hierarchy Contact - Activity - SampleDropped you can set up equivalency between the activity child object and the activity Top Level object. This links the two Activity objects tightly; that is, modifications made to one will automatically reflect in the other.
GROUP	Optional	None	Text	Identifies which Toggle button group to which this applet belongs.
ICON	Optional	None	Text	Name of the icon to be displayed in the Toggle button for this applet.
NAME	Required	None	Text	Indicates a placeholder in the page template where this applet is displayed.
PARENT_APPLET	Optional	None	Text	Name of the parent applet.
SEQUENCE	Optional	None	Number	Sequence of the applet within its toggle applet group.
THIS_APPLET_FLD	Optional	None	Text	Used for Equivalent Applets to match the parent and child equivalent applets.
TOOLTIP	Optional	None	Text	String Id for the tooltip for the Toggle button.
TOOLTIP_TEXT	Optional	None	Text	Tooltip text for the Toggle button.
VISIBLE	Optional	Y	N	This applet is not visible.
VISIBLE	Optional	Y	Y	This applet is visible.

<USERPROP> Attributes

Table 31 describes the <USERPROP> attributes for the page schema definition.

Table 31. <USERPROP Attributes
Attribute Name	Required or Optional	Default Value	Value	Function Description
NAME	Required	None	ToggleAppletsGroup	Defines a toggle applet group.
VALUE	Required	None	Text	Name of toggle applet group.

<TOGGLEAPPLET> Attributes

Table 32 describes the <TOGGLEAPPLET> attributes for the page schema definition.

Table 32. <TOGGLEAPPLET> Attributes
Attribute Name	Required or Optional	Default Value	Value	Function Description
APPLET	Required	None	Text	Name of the applet to be included in this page.
CAPTION	Optional	None	Text	String ID of the applet title.
CAPTION_TEXT	Optional	None	Text	Text of the applet title.
DISPLAY_COUNT	Optional	None	Number	Cached page size.
EQUIVALENTTO	Optional	None	Text	Name of another applet that this applet is equivalent to.
EQUIVALENT_APPLET_FLD	Optional	None	Text	The field to establish the equivalency. Equivalency is a tightly coupled one-to-one relationship between two applets of the same object type. It is used to simulate n-level hierarchies. For example, you have a Contact object with an activity Child Object. You also have an activity Object with a SampleDropped Child object. To simulate the hierarchy Contact - Activity - SampleDropped you can set up equivalency between the activity child object and the activity Top Level object. This links the two Activity objects very tightly, that is, modifications made to one will automatically reflect also in the other.
GROUP	Optional	None	Text	Identifies which Toggle button group this applet belongs to.
ICON	Optional	None	Text	Name of the icon to be displayed in the Toggle button for this applet.
PARENT_APPLET	Optional	None	Text	Name of the parent applet.
SEQUENCE	Optional	None	Number	Sequence of the applet within its toggle applet group.
THIS_APPLET_FLD	Optional	None	Text	Used for Equivalent Applets to match the parent and child equivalent applets.
TOOLTIP	Optional	None	Text	String Id for the tooltip for the Toggle button.
TOOLTIP_TEXT	Optional	None	Text	Tooltip text for the Toggle button.
VISIBLE	Optional	Y	N	This applet is not visible.
VISIBLE	Optional	Y	Y	This applet is visible.

<TOGGLEPARTNER> Attributes

Table 33 describes the <TOGGLEPARTNER> attributes for the page schema definition.

Table 33. <TOGGLEPARTNER> Attributes
Attribute Name	Required or Optional	Default Value	Value	Function Description
APPLET	Required	None	Text	Name of the applet serving as the toggle partner.
ITEM_IDENTIFIER	Required	None	Text	Placeholder in template where this applet is displayed.
VISIBLE	Optional	Y	N	This applet is not visible.
VISIBLE	Optional	Y	Y	This applet is visible.

Configuration Guide for Siebel Offline Client for Life Sciences		Copyright © 2011, Oracle and/or its affiliates. All rights reserved. Legal Notices.