Administrative-Level Personalizations: Classic User Interface

Attention: You can add a new element to a region using OA Personalization Framework only if:

In Oracle JDeveloper OA Extension, the Add Indexed Children property of the region you are adding the element to has been set to True.
You are personalizing a region at the Site, Function, or Localization level.

Any new element that you create while personalizing a region at the Function or Localization level may only be further personalized at the same Function or Localization level at which it was created. New elements that you create while personalizing a region at the Site level may later be personalized at any level. For example, you may personalize at the Responsibility level, an element that you create at the Site level.

Attention: You may add a new item to a table or HGrid; however, all items in the table or HGrid must be set to the same BC4J view usage name.

Item (or Region) Style	Description	Usage Notes
Advanced Table	As of Release 12.2, you can create an advanced table region where each column can be a simple web bean (such as a text input field, a link, a poplist, and so on), or a composite container that groups these simple beans. A common example of a composite container is a flow layout region that contains a pop-up. Note: You can not add Named Child elements, such as table actions, select column, control bar, and so on, to an advanced table using the OA Personalization Framework.	You must enter a View Instance name for the advanced table. To create the columns for the advanced table: In the HGrid of the Page Hierarchy Personalization page , select the Create Item icon for the advanced table. The only style of item you can create under the advanced table region is a Column. Every new column you create is accompanied by a Create Item icon, as well as a Column Header child item with its own Create Item icon. Select the Create Item icon for the Column Header. The only style of item you can create under the Column Header is a Sortable Header. Enter an ID and a value for the Prompt property of the Sortable Header to provide a heading for the column. Select the Create Item icon for the Column to create a child item or region that constitutes the column's content. If you decide to add a region to a column, you may only select one of two region styles: Flow Layout or Stack Layout. The sole purpose of the Flow Layout region style in an advanced table column is to provide support for adding a pop-up. Note: You may only add items as children of a Flow Layout or Stack Layout region within a column of an advanced table. Although the Item Style poplist in the Create Item page currently does not restrict you from adding other region styles as children, OA Personalization Framework does not expect or support this. Caution: If you do not create another child item/region for the column, in addition to the Column Header's Sortable Header, a runtime exception will occur when you choose Return to Application. Additional Information: For an example of how to create an advanced table using the Create Item page, refer to Example 3: Adding a New Table to a Page.
Attachment Image	An Attachment column in a table region that renders the following icons: Attachment icon - navigates to the Attachment page, where users may view the attachments for a current record. Add icon - navigates to the Add Attachment page, where users can add an attachment to a record Note: This item style is only available for creation under a table or advanced table region.	You must enter the name of the View Instance for the entity you are attachment-enabling. After creating Attachment Table item, select the Create Item icon again for categoryMappings in the Page Hierarchy Personalization page to create a Category Map. Select the Create Item icon for entityMappings under the Attachment Table item in the Page Hierarchy Personalization page to create an Entity Map. Finally, select the Create Item icon for primaryKeys under the Attachment Table item in the Page Hierarchy Personalization page to create a Primary Key if none has yet been defined for the entity map.
Attachment Link	A View link that navigates to the Attachments page where users can view existing attachments for the entity record. This item style also renders an Add button that users can select to add new attachments to the current entity record.	You must enter the name of the View Instance for the entity you are attachment-enabling. After creating Attachment Link item, select the Create Item icon again for categoryMappings in the Page Hierarchy Personalization page to create a Category Map. Select the Create Item icon for entityMappings under the Attachment Link item in the Page Hierarchy Personalization page to create an Entity Map. Finally, select the Create Item icon for primaryKeys under the Attachment Link item in the Page Hierarchy Personalization page to create a Primary Key if none has yet been defined for the entity map.
Attachment Table	An Attachments table that users can use to view existing attachments for the entity record.	You must enter the name of the View Instance for the entity you are attachment-enabling. After creating Attachment Table item, select the Create Item icon again for categoryMappings in the Page Hierarchy Personalization page to create a Category Map. Select the Create Item icon for entityMappings under the Attachment Table item in the Page Hierarchy Personalization page to create an Entity Map. Finally, select the Create Item icon for primaryKeys under the Attachment Table item in the Page Hierarchy Personalization page to create a Primary Key if none has yet been defined for the entity map.
Create Item page Button	A button that represents an action that you can perform on a region. OA Framework generates buttons as images that represent the underlying function.	You must enter a value for Prompt with this item style. If you want your Button to navigate to another page, you can specify a Destination URI value that navigates to that page.
Category Map	A custom category to associate with an Attachment item. Note: This item style appears in the Item Style poplist only when you choose the Create Item icon for categoryMappings under an Attachment entity hierarchy in the Page Hierarchy Personalization page.	You must enter a value for the Category property. This value should be identical to the predefined internal name of the category in the FND_DOCUMENT_CATEGORIES table. You may specify whether to secure the categoryMap with Application Security rules. The default value for the Secure property is False.
Column	A new column in an advanced table or a column group. Note: This item style appears in the Item Style poplist only when you choose the Create Item icon for an advanced table or a column group in the Page Hierarchy Personalization page.	Every new column is accompanied by a Create Item icon, as well as a Column Header child item with its own Create Item icon, on the HGrid of the Page Hierarchy Personalization page. The only style of item you can insert under the Column Header is a Sortable Header. Caution: In addition to the Sortable Header item under the Column Header, you must also create at least one more child item for the column (by selecting the column's Create Item icon), otherwise a runtime exception occurs when you choose Return to Application. The Prompt property of the Sortable Header provides the column's "header," and the immediate children of the column constitute its "body."
Entity Map	An entity to associate with an Attachment item. Note: This item style appears in the Item Style poplist only when you choose the Create Item icon for entityMappings under an Attachment entity hierarchy in the Page Hierarchy Personalization page.	You must enter a value for the Entity property: If you defined an entity in the AK Entity form to share between the Oracle Forms and OA Framework interfaces, specify the Entity ID you defined in the AK Entity form. If you are enabling attachments only to be viewed from the OA Framework interface, enter a unique arbitrary value for Entity and be sure to create a primaryKeyMap for the entity map.
Export Button	An Export button that when selected, exports the data displayed in a region.	Create this item at the desired position within the region whose data you want to export. You must set the View Instance name to the same view object associated with the region for which you want to enable export.
Flex	A key or descriptive flexfield. A key flexfield represents an object defined by the values a user enters in each of its segments. A descriptive flexfield is customizable "expansion space" on a page.	You must specify values for the following properties of this item style: Appl Short Name Name - set to the name of the flexfield as it was registered View Instance Type - key or descriptive If you want only specific segments of the flexfield to render, specify a value for the Segment List property. If this property is left blank, then all segments are rendered. Segments within a certain context are listed, separated by "\|", a single pipe, while data from different context is separated by "\|\|", a double pipe. Additionally you can click on the Create Item icon to create a flexMap under the flex item. When the user clicks on the icon, the Create Item page will be displayed with the Item Style as Flex Map. A user can enter the required parameters for the item and click on Apply. The flex map item created will be added under the flex item .
Flex Map	A mapping of a flexfield reference web bean to a named parameter. A reference web bean participates in evaluating one or more properties of a flexfield, such as a default segment value, a value set or a context reference field for a descriptive flexfield. You map the web bean to a`:$PROFILES$.*<NAME>` reference that is used in a flexfield's property. `<NAME>` may be any alphanumeric value and thus provides a potentially infinite namespace of named parameters that you can pass from the OA Framework UI to the flexfield definition. Whenever the value in the reference web bean changes, the page refreshes with changes to the corresponding flexfield property.	Specify the parameter name in the Name property. For example, if your Flexfield definition uses the named parameter, `$PROFILE$.paramName`, then set the Name property to `paramName`. Specify the value or value binding for the parameter in the Reference Value property. The value can be one of the following: A constant value A view attribute represented by SPEL (Simplest Possible Expression Language) as `${oa.<viewUsage>.<viewAttribute>}` The name of the web bean on the current OA Framework page that acts as the reference field, represented by SPEL as `${oa.page.<referenceID>}` For a descriptive flexfield, set the Refer Context property to true if this flex map acts as a reference field. Example As an example, suppose your descriptive flexfield has the context segment with Reference field set and you change the reference field value to use a dummy profile option such as $PROFILES$.ASSET_CATEGORY. Perform the following steps to create a flex map in the OA Framework page that maps the value of this segment to a web bean whose ID is ReferenceField to drive the context field value: Set Level to Site* and Item Style to Flex Map. Enter a value such as sampleMap for ID. Enter ASSET_CATEGORY for Name. Enter ${oa.page.ReferenceField}* for Reference Value. Set Refer Context to true since this flex map acts as a Reference field for the context of this descriptive flexfield.
Flexible Layout	A flexible layout region. Attention: This item type can only be created at the Site level and is intended to be used for inserting another region into a page by adding one flexible content that extends that region. It does not allow the construction of complex flexible layout regions. To construct a fully configurable page, use OA Extension, as described in the Oracle Application Framework Developer's Guide. Additional Information: If a page contains flexible layout and flexible content created from the personalization Create Item page, you get the Page Hierarchy Personalization page UI when you personalize the page. If a page's base definition contains flexible layouts and flexible contents, you get the Page Layout Personalization page UI.	Specify whether the Rendered property is true or false. Specify an optional Comment. Select the Create Item icon for the newly created flexible layout region in the Page Hierarchy Personalization page to create a flexible content element.
Flexible Content	Flexible content that extends another region and renders within a flexible layout region. Note: This item style appears in the Item Style poplist only when you choose the Create Item icon in the Page Hierarchy Personalization page for a newly created Flexible Layout region defined in the Create Item page.	Specify the full package name of the region that the flexible content extends. Attention: Flexible content can only be inserted into a flexible layout at the site level and the current personalization scope must be a page. Flexible contents can be deleted, but not updated. Suggestion: Creating only one flexible content per flexible layout is recommended. If you create more than one flexible content for a single flexible layout, the flexible contents will be vertically aligned and you will not have the option of changing their order or alignment.
Flow Layout	As of Release 12.2, you can create a flow layout region that displays regions and items that you add, in a horizontal flow. The flow layout does not indent the items and does not add horizontal space between items.	You may add a pop-up region as a child, to a flow layout.
Form Value	A value submitted with a form but that is not displayed on the page.	Specify a View Instance and View Attribute from which this item derives its value.
Formatted Text	Formatted text using generic HTML formatting tags.	You must enter Text for this item style.
Header	As of Release 12.2, you can create a header to display a title and to separate page content.	You may optionally enter a Text value that becomes the title of the header.
Image	An image can be a plain image that simply appears on the page, or can have a URL associated with it so that the user can click on it to navigate elsewhere. Although icon images are generally used as global buttons in the Oracle E-Business Suite, an icon image may also be used next to text to visually quantify its content, as in the case of tips, or in line messages.	You must specify a value for Image URI with this item style. If you want to optionally associate a URL with the image, specify a value for the Destination URI property.
Link	A link represents an action that you can perform on a region. A link can be used to navigate to another page or region.	You must enter a value for Text with this item style. For navigation, the Destination URI value must be a valid destination.
Menu	As of Release 12.2.4, you can enable a menu region on an image, link or button item. This menu component provides a way for you to design an intuitive and space-saving user interface that allows end-users to choose one or more actions to perform on a page. The menu may operate in "Selection Enabled" or "Selection Disabled" mode, to allow a user to select multiple menu items or select only a single menu item, respectively. Each menu item may be associated with a client-side action. Additionally, you can define the items on the menu to be user-reorderable and associate a function to each reorder action.	Specify values for the following properties of this region: ID Enable Selection - set this to True for "Selection Enabled" mode and False for "Selection Disabled" mode. Enable Reorder - set this to True if you want the items in this menu to be reordered by the user.
Menu Item	As of Release 12.2.4, you can define a menu item for your menu region. To create a submenu, you can create another menu region under a menu item.	Specify values for the following properties of this item: ID Text - specify the text label to display for the menu item. If Enable Selection is set to True for the parent menu, you should also set these properties: Selected State - specify enabled or disabled to indicate the selection state of the menu item. Enable Selection - indicate whether to enable or disable selection only on this menu item. OnSelect - specify the function to execute when the user selects this menu item. Icon URI - (optional) specify the image source to display before the menu item text. disabled - specify True to disable the entire menu item. onReorderDown - specify the function to execute when the user selects the Reorder Down icon. onReorderUp - specify the function to execute when the user selects the Reorder Up icon. If Enable Selection is set to False for the parent menu, you should set these properties: Destination URI - specify the target URI for the menu item. Icon URI - (optional) specify the image source to display before the menu item text.
Message Check Box	A checkbox, that when checked, specifies a value.	You must enter a value for Prompt with this item style.
Message Choice	A poplist where users can select any value displayed in the poplist.	You must specify values for the following properties of this item style: Prompt Picklist View Instance Picklist View Definition Picklist Display Attribute Picklist Value Attribute
Message Component Layout	As of Release 12.2, you can create a message component layout to correctly position components into an N-column grid. Both the component spacing and tab sequence (down and then across for multiple columns) fully comply with the BLAF UI guidelines.	To obtain a multi-column layout, you may optionally specify values for the Columns and Rows properties based on these rules: The Columns property controls the maximum number of columns you want to render. The Rows property controls how many items should render in any given column before populating the next column. However, this property is ultimately governed by the Columns property. If, for example, you set the Rows property to 2 and the Columns property to 2, and you add 6 items to the message component layout region, your layout will appear as two columns with the first containing objects 1 - 3 while the second contains objects 4 - 6. Note: To create an item under a message component layout, select the Create Item icon for the message component layout in the HGrid of the Page Hierarchy Personalization page. If the new item you create is a "non-message-type" item style (such as a submit button or a tip), it will automatically be created as a child of a message layout item under the message component layout. All "message-type" item styles (for example, message choice or message check box, etc.) you create are added as direct children of the message component layout.
Message Download	A file download link, which when selected opens a small Browser window that allows the user to either open the file and display its content or save the file to a client machine.	You must specify values for the following properties: View Instance - view object instance of the underlying data source. View Attribute - view attribute that maps to a column in the underlying data source. File View Attribute - view attribute that maps to the column that stores the file content.
Message File Upload	An Upload File prompt, input field and Browse button that allows users to upload a file from a client machine to the middle tier. Note: If this item is associated with a view object instance and view attribute that returns a non-null value, that is, a file is already uploaded, OA Framework renders a Upload File prompt, View link and Clear button, so the user can view the already uploaded file, or clear it to upload another file.	You must specify values for the following properties: View Instance - view object instance of the underlying data source. View Attribute - view attribute in the specified view object instance that maps to the column for storing the file content.
Message Inline Attachment	A list of inline attachment links that users can select to view a specific attachment. Also renders the "More..." link, which allows users to navigate to the Attachments user interface to perform further operations on attachments.	You must enter the name of the View Instance for the entity you are attachment-enabling. After creating Message Inline Attachment item, select the Create Item icon again for categoryMappings in the Page Hierarchy Personalization page to create a Category Map. Select the Create Item icon for entityMappings under the Message Inline Attachment item in the Page Hierarchy Personalization page to create an Entity Map. Finally, select the Create Item icon for primaryKeys under the Message Inline Attachment item in the Page Hierarchy Personalization page to create a Primary Key if none has yet been defined for the entity map.
Message LOV Input	A LOV that allows users to select a value from a Search and Select List of Values window.	Follow the instructions outlined in Creating a Message LOV Input Item.
Message Radio Group	A radio group that allows a user to select one of several distinct values.	You must specify values for the following properties of this item style: Prompt Picklist View Instance Picklist View Definition Picklist Display Attribute Picklist Value Attribute
Message Rating Bar	As of Release 12.2.2, you can create a rating bar component under any region to allow users to rate a product, service or entity in an OA Framework-based page.	Create a Message Rating Bar component under a region by specifying an ID for the component. Then in the Personalize Page, select the Update Item icon for the new Message Rating Bar component and specify the following properties: Attribute Set - specify an attribute set if you want to maintain a standard look and feel for your item. Initial Value - specify a default value if you want the rating bar to render a default selected value. Picklist View Definition - specify the fully-qualified view object name for the picklist. The picklist view object must have two attributes, a display attribute and a value attribute. Picklist View Instance - specify the view instance name for the picklist. Picklist Display Attribute - specify the view attribute that serves as the displayed value of choices. When a user hovers the mouse over a rating image, the value of this view attribute displays. Picklist Value Attribute - specify the view attribute that serves as the internal value of choices. This attribute determines the value of the rendered rating image. Prompt - specify the text label for the rating bar. View Attribute - specify the name of the view attribute. The View Attribute value for this web bean must correspond to the Picklist Value Attribute.
Message Rich Text Editor	As of Release 12.2, you can create a rich text editor to a region. A rich text editor allows users to author, edit and view rich text content in a browser that supports IFRAMEs.	Note: Accessibility of the Rich Text Editor is determined by the value of the profile option ICX_ACCESSIBILITY_FEATURES: When ICX_ACCESSIBILITY_FEATURES is set to Yes, strict accessibility compliance is met and the Rich Text Editor always renders in Text Mode. When ICX_ACCESSIBILITY_FEATURES is set to Screen Reader, content is optimized for screen readers and the Rich Text Editor always renders in Text Mode. When ICX_ACCESSIBILITY_FEATURES is set to No, code is optimized to strip out Accessibility-specific constructs and the Rich Text Editor is rendered in Rich Text Mode, along with a Switch Mode hyperlink.
Message Spin Box	As of Release 12.2.4, you can create a spin box that allows a user to select a numeric value from a predefined range. You can specify a minimum and maximum value to define the numeric range of the spin box and you may specify the step size by which users can increase or decreases its value.	You must specify values for the following properties of this item style: Prompt Rendered - set this to True. Read-only - set this to False. Disabled - set this to False. MinValue MaxValue Stepsize Action Type
Message Styled Text	A text field that can be updated and have a default value.	You can optionally enter a value for the Prompt, or View Instance and View Attribute properties. If you wish to change the style of the text or associate a URL with the text, you can specify values for the CSS Class or Destination URI properties, respectively.
Message Text Input	A text input field.	You must enter a value in the Prompt field for this item style. You may also optionally enter a value for the View Instance and View Attribute properties.
Pop-up	As of Release 12.2, you can create a pop-up for a table, advanced table or HGrid column, by adding the pop-up to a flow layout region.	To create a pop-up: Create a flow layout region under a table, advanced table or HGrid column, then select the Create Item icon for the flow layout. Select the item style, Message Styled Text, Image, Link, or Button, as these are the only types of base items within a table column from which you can enable a pop-up. Specify values for the properties necessary to define the item. You may leave the "Popup"-specific properties blank at this point. Select the Create Item icon for the flow layout region again. Select the item style Pop-Up for this new flow layout child. Specify values for the following properties in the Pop-Up item: Title - the title for the pop-up window. Region - the fully-qualified path of the standalone region to be rendered as a pop-up. Type - either embedded or parameterized. Read Only - whether the pop-up is read only. Parameters - any base page parameters to pass to the pop-up region, if the pop-up type is parameterized. Width - in pixels. Height - in pixels, set to a minimum value of 50 to ensure the pop-up window accommodates its pop-up content. Select the Update Item icon for the message styled text, image, link, or button item you created earlier under the flow layout. In this item, specify values for the following "Popup-specific" properties: Popup Enabled - enable or disable the pop-up. Popup ID - the ID of the pop-up item you created as a child of the flow layout. Popup Render Event - type of event (onClick or onHover) that will launch the pop-up.
Primary Key	A primary key associated with the Entity Map of an attachment entity. Note: This item style appears in the Item Style poplist only when no other primary key has been defined yet for the entity map and you choose the Create Item icon for primaryKeys under an Attachment entity hierarchy in the Page Hierarchy Personalization page.	You must enter a View Attribute name for the primary key.
Raw Text	Any type of text. For example, the raw text style allows you to enter HTML tags to display text in bold.	You can optionally enter a value for the following properties: Additional Text, or View Instance and View Attribute. Caution: In general, you should avoid using custom HTML as it does not meet the NLS, accessibility, security, and Oracle Browser Look-and-Feel (BLAF) UI guidelines and standards.
Reset Button	As of Release 12.2, you can create a reset button that when selected, resets the content of a form.	Refer to the OA Component Reference for information about properties to set.
Separator	A line to separate portions of a region. By default, the separator is rendered as a blue dotted line. Note: The Separator is obsolete as of Release 12.	Refer to the OA Component Reference for information about properties to set.
Servlet Include	Includes HTML content loaded from a local Servlet or JSP under the parent region.	You must enter a value for Source URI to indicate the Servlet or JSP source.
Spacer	A space that you can include in a region to improve the appearance of its layout.	You must specify values for spacer Width and spacer Height with this item style.
Stack Layout	A stack layout region that renders its children regions and items in a vertical stack without any indentation.	Stack layouts may be created in any region, but only at the Site level.
Static Styled Text	Text that is for display only and not for editing purposes. For example, if you wish to create a URL link, you would define its item style as static text.	You must enter a value for Prompt with this item style. If you wish to change the style of the text, you can specify the CSS Class whose style you want the text to inherit. Additional Information: For an example of how to create a URL link using the Create Item page, refer to Example 1: Adding a URL Link to the Advanced Worklist Page.
Submit Button	As of Release 12.2, you can create a submit button that when selected, submits the form.	You can optionally set a value for Prompt (if no attribute set has been specified) to set a label for the button.
Tip	Text that provides a tip about the contents of the region.	You must specify an ID and a Tip Message Name for this item style. Additional Information: For an example of how to create a tip using the Create Item page, refer to Example 2: Adding New Instruction Text to a Page.
Table	As of Release 12.2, you can create a table region where each column can be a simple web bean (such as a text input field, a link, a poplist, and so on), or a composite container. A common example of a composite container is a flow layout region that contains a pop-up. Note: You can not add Named Child elements, such as table actions, select column, control bar, and so on, to a table using the OA Personalization Framework.	To create the columns for a table: Define a region and/or item directly to your table region, as a child of the table. In the HGrid of the Page Hierarchy Personalization page , select the Create Item icon for the table. If you define a region as a child of the table, the only region style you can specify is a Flow Layout. The sole purpose of the Flow Layout region style in a table is to provide support for adding a pop-up to a table column. Note: You may only add items as children of a Flow Layout region within a table. Although the Item Style poplist in the Create Item page currently does not restrict you from adding other region styles as children, OA Personalization Framework does not expect or support this.
URL Include	Includes HTML content loaded from an external source under the parent region.	You must enter a value for Source URI to indicate the source of this HTML content. No post processing on the HTML is performed, so the included HTML should not include HTML tags like <html> or <body>.

Advanced Table

As of Release 12.2, you can create an advanced table region where each column can be a simple web bean (such as a text input field, a link, a poplist, and so on), or a composite container that groups these simple beans. A common example of a composite container is a flow layout region that contains a pop-up.

Note: You can not add Named Child elements, such as table actions, select column, control bar, and so on, to an advanced table using the OA Personalization Framework.

You must enter a View Instance name for the advanced table.
To create the columns for the advanced table:

In the HGrid of the Page Hierarchy Personalization page , select the Create Item icon for the advanced table.
The only style of item you can create under the advanced table region is a Column.
Every new column you create is accompanied by a Create Item icon, as well as a Column Header child item with its own Create Item icon.
Select the Create Item icon for the Column Header. The only style of item you can create under the Column Header is a Sortable Header.
Enter an ID and a value for the Prompt property of the Sortable Header to provide a heading for the column.
Select the Create Item icon for the Column to create a child item or region that constitutes the column's content. If you decide to add a region to a column, you may only select one of two region styles: Flow Layout or Stack Layout. The sole purpose of the Flow Layout region style in an advanced table column is to provide support for adding a pop-up.

Note: You may only add items as children of a Flow Layout or Stack Layout region within a column of an advanced table. Although the Item Style poplist in the Create Item page currently does not restrict you from adding other region styles as children, OA Personalization Framework does not expect or support this.

Caution: If you do not create another child item/region for the column, in addition to the Column Header's Sortable Header, a runtime exception will occur when you choose Return to Application.

Additional Information: For an example of how to create an advanced table using the Create Item page, refer to Example 3: Adding a New Table to a Page.

Attachment Image

An Attachment column in a table region that renders the following icons:

Attachment icon - navigates to the Attachment page, where users may view the attachments for a current record.
Add icon - navigates to the Add Attachment page, where users can add an attachment to a record

Note: This item style is only available for creation under a table or advanced table region.

You must enter the name of the View Instance for the entity you are attachment-enabling.
After creating Attachment Table item, select the Create Item icon again for categoryMappings in the Page Hierarchy Personalization page to create a Category Map.
Select the Create Item icon for entityMappings under the Attachment Table item in the Page Hierarchy Personalization page to create an Entity Map.
Finally, select the Create Item icon for primaryKeys under the Attachment Table item in the Page Hierarchy Personalization page to create a Primary Key if none has yet been defined for the entity map.

Attachment Link

A View link that navigates to the Attachments page where users can view existing attachments for the entity record. This item style also renders an Add button that users can select to add new attachments to the current entity record.

You must enter the name of the View Instance for the entity you are attachment-enabling.
After creating Attachment Link item, select the Create Item icon again for categoryMappings in the Page Hierarchy Personalization page to create a Category Map.
Select the Create Item icon for entityMappings under the Attachment Link item in the Page Hierarchy Personalization page to create an Entity Map.
Finally, select the Create Item icon for primaryKeys under the Attachment Link item in the Page Hierarchy Personalization page to create a Primary Key if none has yet been defined for the entity map.

Attachment Table

An Attachments table that users can use to view existing attachments for the entity record.

You must enter the name of the View Instance for the entity you are attachment-enabling.
After creating Attachment Table item, select the Create Item icon again for categoryMappings in the Page Hierarchy Personalization page to create a Category Map.
Select the Create Item icon for entityMappings under the Attachment Table item in the Page Hierarchy Personalization page to create an Entity Map.
Finally, select the Create Item icon for primaryKeys under the Attachment Table item in the Page Hierarchy Personalization page to create a Primary Key if none has yet been defined for the entity map.

Create Item page
Button

A button that represents an action that you can perform on a region. OA Framework generates buttons as images that represent the underlying function.

You must enter a value for Prompt with this item style.
If you want your Button to navigate to another page, you can specify a Destination URI value that navigates to that page.

Category Map

A custom category to associate with an Attachment item.

Note: This item style appears in the Item Style poplist only when you choose the Create Item icon for categoryMappings under an Attachment entity hierarchy in the Page Hierarchy Personalization page.

You must enter a value for the Category property. This value should be identical to the predefined internal name of the category in the FND_DOCUMENT_CATEGORIES table.
You may specify whether to secure the categoryMap with Application Security rules. The default value for the Secure property is False.

Column

A new column in an advanced table or a column group.

Note: This item style appears in the Item Style poplist only when you choose the Create Item icon for an advanced table or a column group in the Page Hierarchy Personalization page.

Every new column is accompanied by a Create Item icon, as well as a Column Header child item with its own Create Item icon, on the HGrid of the Page Hierarchy Personalization page.
The only style of item you can insert under the Column Header is a Sortable Header.

Caution: In addition to the Sortable Header item under the Column Header, you must also create at least one more child item for the column (by selecting the column's Create Item icon), otherwise a runtime exception occurs when you choose Return to Application. The Prompt property of the Sortable Header provides the column's "header," and the immediate children of the column constitute its "body."

Entity Map

An entity to associate with an Attachment item.

Note: This item style appears in the Item Style poplist only when you choose the Create Item icon for entityMappings under an Attachment entity hierarchy in the Page Hierarchy Personalization page.

You must enter a value for the Entity property:

If you defined an entity in the AK Entity form to share between the Oracle Forms and OA Framework interfaces, specify the Entity ID you defined in the AK Entity form.
If you are enabling attachments only to be viewed from the OA Framework interface, enter a unique arbitrary value for Entity and be sure to create a primaryKeyMap for the entity map.

Export Button

An Export button that when selected, exports the data displayed in a region.

Create this item at the desired position within the region whose data you want to export.
You must set the View Instance name to the same view object associated with the region for which you want to enable export.

Flex

A key or descriptive flexfield. A key flexfield represents an object defined by the values a user enters in each of its segments. A descriptive flexfield is customizable "expansion space" on a page.

You must specify values for the following properties of this item style:

Appl Short Name
Name - set to the name of the flexfield as it was registered
View Instance
Type - key or descriptive

If you want only specific segments of the flexfield to render, specify a value for the Segment List property. If this property is left blank, then all segments are rendered. Segments within a certain context are listed, separated by "|", a single pipe, while data from different context is separated by "||", a double pipe.
Additionally you can click on the Create Item icon to create a flexMap under the flex item. When the user clicks on the icon, the Create Item page will be displayed with the Item Style as Flex Map. A user can enter the required parameters for the item and click on Apply. The flex map item created will be added under the flex item .

Flex Map

A mapping of a flexfield reference web bean to a named parameter. A reference web bean participates in evaluating one or more properties of a flexfield, such as a default segment value, a value set or a context reference field for a descriptive flexfield. You map the web bean to a:$PROFILES$.*<NAME> reference that is used in a flexfield's property. <NAME> may be any alphanumeric value and thus provides a potentially infinite namespace of named parameters that you can pass from the OA Framework UI to the flexfield definition. Whenever the value in the reference web bean changes, the page refreshes with changes to the corresponding flexfield property.

Specify the parameter name in the Name property. For example, if your Flexfield definition uses the named parameter, $PROFILE$.*paramName, then set the Name property to *paramName.
Specify the value or value binding for the parameter in the Reference Value property. The value can be one of the following:
- A constant value
- A view attribute represented by SPEL (Simplest Possible Expression Language) as ${oa.<viewUsage>.<viewAttribute>}
- The name of the web bean on the current OA Framework page that acts as the reference field, represented by SPEL as ${oa.page.<referenceID>}
For a descriptive flexfield, set the Refer Context property to true if this flex map acts as a reference field.

Example

As an example, suppose your descriptive flexfield has the context segment with Reference field set and you change the reference field value to use a dummy profile option such as $PROFILES$.*ASSET_CATEGORY. Perform the following steps to create a flex map in the OA Framework page that maps the value of this segment to a web bean whose ID is ReferenceField to drive the context field value:

Set Level to Site and Item Style to Flex Map.
Enter a value such as sampleMap for ID.
Enter *ASSET_CATEGORY for Name.
Enter ${oa.page.ReferenceField} for Reference Value.
Set Refer Context to true since this flex map acts as a Reference field for the context of this descriptive flexfield.

Flexible Layout

A flexible layout region.

Attention: This item type can only be created at the Site level and is intended to be used for inserting another region into a page by adding one flexible content that extends that region. It does not allow the construction of complex flexible layout regions. To construct a fully configurable page, use OA Extension, as described in the Oracle Application Framework Developer's Guide.

Additional Information: If a page contains flexible layout and flexible content created from the personalization Create Item page, you get the Page Hierarchy Personalization page UI when you personalize the page. If a page's base definition contains flexible layouts and flexible contents, you get the Page Layout Personalization page UI.

Specify whether the Rendered property is true or false.
Specify an optional Comment.
Select the Create Item icon for the newly created flexible layout region in the Page Hierarchy Personalization page to create a flexible content element.

Flexible Content

Flexible content that extends another region and renders within a flexible layout region.

Note: This item style appears in the Item Style poplist only when you choose the Create Item icon in the Page Hierarchy Personalization page for a newly created Flexible Layout region defined in the Create Item page.

Specify the full package name of the region that the flexible content extends.

Attention: Flexible content can only be inserted into a flexible layout at the site level and the current personalization scope must be a page.

Flexible contents can be deleted, but not updated.

Suggestion: Creating only one flexible content per flexible layout is recommended. If you create more than one flexible content for a single flexible layout, the flexible contents will be vertically aligned and you will not have the option of changing their order or alignment.

Flow Layout

As of Release 12.2, you can create a flow layout region that displays regions and items that you add, in a horizontal flow. The flow layout does not indent the items and does not add horizontal space between items.

You may add a pop-up region as a child, to a flow layout.

Form Value

A value submitted with a form but that is not displayed on the page.

Specify a View Instance and View Attribute from which this item derives its value.

Formatted Text

Formatted text using generic HTML formatting tags.

You must enter Text for this item style.

Header

As of Release 12.2, you can create a header to display a title and to separate page content.

You may optionally enter a Text value that becomes the title of the header.

Image

An image can be a plain image that simply appears on the page, or can have a URL associated with it so that the user can click on it to navigate elsewhere. Although icon images are generally used as global buttons in the Oracle E-Business Suite, an icon image may also be used next to text to visually quantify its content, as in the case of tips, or in line messages.

You must specify a value for Image URI with this item style.
If you want to optionally associate a URL with the image, specify a value for the Destination URI property.

Link

A link represents an action that you can perform on a region. A link can be used to navigate to another page or region.

You must enter a value for Text with this item style. For navigation, the Destination URI value must be a valid destination.

Menu

As of Release 12.2.4, you can enable a menu region on an image, link or button item. This menu component provides a way for you to design an intuitive and space-saving user interface that allows end-users to choose one or more actions to perform on a page. The menu may operate in "Selection Enabled" or "Selection Disabled" mode, to allow a user to select multiple menu items or select only a single menu item, respectively. Each menu item may be associated with a client-side action. Additionally, you can define the items on the menu to be user-reorderable and associate a function to each reorder action.

Specify values for the following properties of this region:

ID
Enable Selection - set this to True for "Selection Enabled" mode and False for "Selection Disabled" mode.
Enable Reorder - set this to True if you want the items in this menu to be reordered by the user.

Menu Item

As of Release 12.2.4, you can define a menu item for your menu region. To create a submenu, you can create another menu region under a menu item.

Specify values for the following properties of this item:

ID
Text - specify the text label to display for the menu item.

If Enable Selection is set to True for the parent menu, you should also set these properties:

Selected State - specify enabled or disabled to indicate the selection state of the menu item.
Enable Selection - indicate whether to enable or disable selection only on this menu item.
OnSelect - specify the function to execute when the user selects this menu item.
Icon URI - (optional) specify the image source to display before the menu item text.
disabled - specify True to disable the entire menu item.
onReorderDown - specify the function to execute when the user selects the Reorder Down icon.
onReorderUp - specify the function to execute when the user selects the Reorder Up icon.

If Enable Selection is set to False for the parent menu, you should set these properties:

Destination URI - specify the target URI for the menu item.
Icon URI - (optional) specify the image source to display before the menu item text.

Message Check Box

A checkbox, that when checked, specifies a value.

You must enter a value for Prompt with this item style.

Message Choice

A poplist where users can select any value displayed in the poplist.

You must specify values for the following properties of this item style:

Prompt
Picklist View Instance
Picklist View Definition
Picklist Display Attribute
Picklist Value Attribute

Message Component Layout

As of Release 12.2, you can create a message component layout to correctly position components into an N-column grid. Both the component spacing and tab sequence (down and then across for multiple columns) fully comply with the BLAF UI guidelines.

To obtain a multi-column layout, you may optionally specify values for the Columns and Rows properties based on these rules:

The Columns property controls the maximum number of columns you want to render.
The Rows property controls how many items should render in any given column before populating the next column. However, this property is ultimately governed by the Columns property. If, for example, you set the Rows property to 2 and the Columns property to 2, and you add 6 items to the message component layout region, your layout will appear as two columns with the first containing objects 1 - 3 while the second contains objects 4 - 6.

Note: To create an item under a message component layout, select the Create Item icon for the message component layout in the HGrid of the Page Hierarchy Personalization page. If the new item you create is a "non-message-type" item style (such as a submit button or a tip), it will automatically be created as a child of a message layout item under the message component layout. All "message-type" item styles (for example, message choice or message check box, etc.) you create are added as direct children of the message component layout.

Message Download

A file download link, which when selected opens a small Browser window that allows the user to either open the file and display its content or save the file to a client machine.

You must specify values for the following properties:

View Instance - view object instance of the underlying data source.
View Attribute - view attribute that maps to a column in the underlying data source.
File View Attribute - view attribute that maps to the column that stores the file content.

Message File Upload

An Upload File prompt, input field and Browse button that allows users to upload a file from a client machine to the middle tier.

Note: If this item is associated with a view object instance and view attribute that returns a non-null value, that is, a file is already uploaded, OA Framework renders a Upload File prompt, View link and Clear button, so the user can view the already uploaded file, or clear it to upload another file.

You must specify values for the following properties:

View Instance - view object instance of the underlying data source.
View Attribute - view attribute in the specified view object instance that maps to the column for storing the file content.

Message Inline Attachment

A list of inline attachment links that users can select to view a specific attachment. Also renders the "More..." link, which allows users to navigate to the Attachments user interface to perform further operations on attachments.

You must enter the name of the View Instance for the entity you are attachment-enabling.
After creating Message Inline Attachment item, select the Create Item icon again for categoryMappings in the Page Hierarchy Personalization page to create a Category Map.
Select the Create Item icon for entityMappings under the Message Inline Attachment item in the Page Hierarchy Personalization page to create an Entity Map.
Finally, select the Create Item icon for primaryKeys under the Message Inline Attachment item in the Page Hierarchy Personalization page to create a Primary Key if none has yet been defined for the entity map.

Message LOV Input

A LOV that allows users to select a value from a Search and Select List of Values window.

Follow the instructions outlined in Creating a Message LOV Input Item.

Message Radio Group

A radio group that allows a user to select one of several distinct values.

You must specify values for the following properties of this item style:

Prompt
Picklist View Instance
Picklist View Definition
Picklist Display Attribute
Picklist Value Attribute

Message Rating Bar

As of Release 12.2.2, you can create a rating bar component under any region to allow users to rate a product, service or entity in an OA Framework-based page.

Create a Message Rating Bar component under a region by specifying an ID for the component. Then in the Personalize Page, select the Update Item icon for the new Message Rating Bar component and specify the following properties:

Attribute Set - specify an attribute set if you want to maintain a standard look and feel for your item.
Initial Value - specify a default value if you want the rating bar to render a default selected value.
Picklist View Definition - specify the fully-qualified view object name for the picklist. The picklist view object must have two attributes, a display attribute and a value attribute.
Picklist View Instance - specify the view instance name for the picklist.
Picklist Display Attribute - specify the view attribute that serves as the displayed value of choices. When a user hovers the mouse over a rating image, the value of this view attribute displays.
Picklist Value Attribute - specify the view attribute that serves as the internal value of choices. This attribute determines the value of the rendered rating image.
Prompt - specify the text label for the rating bar.
View Attribute - specify the name of the view attribute. The View Attribute value for this web bean must correspond to the Picklist Value Attribute.

Message Rich Text Editor

As of Release 12.2, you can create a rich text editor to a region. A rich text editor allows users to author, edit and view rich text content in a browser that supports IFRAMEs.

Note: Accessibility of the Rich Text Editor is determined by the value of the profile option ICX_ACCESSIBILITY_FEATURES:

When ICX_ACCESSIBILITY_FEATURES is set to Yes, strict accessibility compliance is met and the Rich Text Editor always renders in Text Mode.
When ICX_ACCESSIBILITY_FEATURES is set to Screen Reader, content is optimized for screen readers and the Rich Text Editor always renders in Text Mode.
When ICX_ACCESSIBILITY_FEATURES is set to No, code is optimized to strip out Accessibility-specific constructs and the Rich Text Editor is rendered in Rich Text Mode, along with a Switch Mode hyperlink.

Message Spin Box

As of Release 12.2.4, you can create a spin box that allows a user to select a numeric value from a predefined range. You can specify a minimum and maximum value to define the numeric range of the spin box and you may specify the step size by which users can increase or decreases its value.

You must specify values for the following properties of this item style:

Prompt
Rendered - set this to True.
Read-only - set this to False.
Disabled - set this to False.
MinValue
MaxValue
Stepsize
Action Type

Message Styled Text

A text field that can be updated and have a default value.

You can optionally enter a value for the Prompt, or View Instance and View Attribute properties.
If you wish to change the style of the text or associate a URL with the text, you can specify values for the CSS Class or Destination URI properties, respectively.

Message Text Input

A text input field.

You must enter a value in the Prompt field for this item style.
You may also optionally enter a value for the View Instance and View Attribute properties.

Pop-up

As of Release 12.2, you can create a pop-up for a table, advanced table or HGrid column, by adding the pop-up to a flow layout region.

To create a pop-up:

Create a flow layout region under a table, advanced table or HGrid column, then select the Create Item icon for the flow layout.
Select the item style, Message Styled Text, Image, Link, or Button, as these are the only types of base items within a table column from which you can enable a pop-up. Specify values for the properties necessary to define the item. You may leave the "Popup"-specific properties blank at this point.
Select the Create Item icon for the flow layout region again.
Select the item style Pop-Up for this new flow layout child.
Specify values for the following properties in the Pop-Up item:
- Title - the title for the pop-up window.
- Region - the fully-qualified path of the standalone region to be rendered as a pop-up.
- Type - either embedded or parameterized.
- Read Only - whether the pop-up is read only.
- Parameters - any base page parameters to pass to the pop-up region, if the pop-up type is parameterized.
- Width - in pixels.
- Height - in pixels, set to a minimum value of 50 to ensure the pop-up window accommodates its pop-up content.
Select the Update Item icon for the message styled text, image, link, or button item you created earlier under the flow layout. In this item, specify values for the following "Popup-specific" properties:
- Popup Enabled - enable or disable the pop-up.
- Popup ID - the ID of the pop-up item you created as a child of the flow layout.
- Popup Render Event - type of event (onClick or onHover) that will launch the pop-up.

Primary Key

A primary key associated with the Entity Map of an attachment entity.

Note: This item style appears in the Item Style poplist only when no other primary key has been defined yet for the entity map and you choose the Create Item icon for primaryKeys under an Attachment entity hierarchy in the Page Hierarchy Personalization page.

You must enter a View Attribute name for the primary key.

Raw Text

Any type of text. For example, the raw text style allows you to enter HTML tags to display text in bold.

You can optionally enter a value for the following properties: Additional Text, or View Instance and View Attribute.

Caution: In general, you should avoid using custom HTML as it does not meet the NLS, accessibility, security, and Oracle Browser Look-and-Feel (BLAF) UI guidelines and standards.

Reset Button

As of Release 12.2, you can create a reset button that when selected, resets the content of a form.

Refer to the OA Component Reference for information about properties to set.

Separator

A line to separate portions of a region. By default, the separator is rendered as a blue dotted line.

Note: The Separator is obsolete as of Release 12.

Refer to the OA Component Reference for information about properties to set.

Servlet Include

Includes HTML content loaded from a local Servlet or JSP under the parent region.

You must enter a value for Source URI to indicate the Servlet or JSP source.

Spacer

A space that you can include in a region to improve the appearance of its layout.

You must specify values for spacer Width and spacer Height with this item style.

Stack Layout

A stack layout region that renders its children regions and items in a vertical stack without any indentation.

Stack layouts may be created in any region, but only at the Site level.

Static Styled Text

Text that is for display only and not for editing purposes. For example, if you wish to create a URL link, you would define its item style as static text.

You must enter a value for Prompt with this item style.
If you wish to change the style of the text, you can specify the CSS Class whose style you want the text to inherit.

Additional Information: For an example of how to create a URL link using the Create Item page, refer to Example 1: Adding a URL Link to the Advanced Worklist Page.

Submit Button

As of Release 12.2, you can create a submit button that when selected, submits the form.

You can optionally set a value for Prompt (if no attribute set has been specified) to set a label for the button.

Tip

Text that provides a tip about the contents of the region.

You must specify an ID and a Tip Message Name for this item style.

Additional Information: For an example of how to create a tip using the Create Item page, refer to Example 2: Adding New Instruction Text to a Page.

Table

As of Release 12.2, you can create a table region where each column can be a simple web bean (such as a text input field, a link, a poplist, and so on), or a composite container. A common example of a composite container is a flow layout region that contains a pop-up.

Note: You can not add Named Child elements, such as table actions, select column, control bar, and so on, to a table using the OA Personalization Framework.

To create the columns for a table:

Define a region and/or item directly to your table region, as a child of the table. In the HGrid of the Page Hierarchy Personalization page , select the Create Item icon for the table.
If you define a region as a child of the table, the only region style you can specify is a Flow Layout. The sole purpose of the Flow Layout region style in a table is to provide support for adding a pop-up to a table column.

Note: You may only add items as children of a Flow Layout region within a table. Although the Item Style poplist in the Create Item page currently does not restrict you from adding other region styles as children, OA Personalization Framework does not expect or support this.

URL Include

Includes HTML content loaded from an external source under the parent region.

You must enter a value for Source URI to indicate the source of this HTML content. No post processing on the HTML is performed, so the included HTML should not include HTML tags like <html> or <body>.

Additional Information: For configurable pages, you can only create a new item in a boxed content region or to the top pageLayout region. You cannot create a new item in a boxed layout region that contains only boxed layout regions as children.

Suggestion: If you make a mistake when you create a new item, such that it causes the base page to display an error, you can sign on to the Oracle E-Business Suite as the Functional Administrator responsibility and remove the personalization using the Manage Personalization Levels page.

Creating a Message LOV Input Item

Follow these steps if you wish to create a Message LOV Input item using the Create Item page:

Create Item Page

Creating a Message LOV Input Item