A script-enabled browser is required for this page to function properly.

What is an attribute?

Skip Navigation Links| Related Help Topics | Additional Information |

Back to top

There are two types of attributes:

Some attributes are both Content- and Display-type attributes. These are noted in the following tables.

Built-in content attributes:

Attribute:

This attribute contains:

Author

The name of the author of the item. This is also a display attribute.

Category

The name of the category to which the item or page belongs. This is also a display attribute.

Character Set

The character set used for the item if it is other than that used for the database. This is also a display attribute.

Note: This attribute is available only for file- and URL-type items. It is available for use with Base File and Base URL base item types. It comes with an attached, system list of values (wwv_system.charset_values). It is especially useful for facilitating searches in portals that commonly use multi-byte character sets. This is because, for searches to run correctly, content must be converted into the database character set so that it may be indexed. This conversion can occur only when the content's character set is known.

Description

A short text description of the item or page. This is also a display attribute.

Display Name

The display name of the item or page. This is also a display attribute.

Display Option

Information about how the item or portlet should be displayed:

  • Item Displayed Directly In Page Area
  • Link That Displays Item In Full Browser Window
  • Link That Displays Item In New Browser Window

Note: The option Item Displayed Directly In Page Area applies to file-type items with a MIME type of text/html or text/plain, and PL/SQL, text, and URL item types.

The Display Option attribute can be added to any custom item type except the ones based on Base Item Link, Base Portlet Instance, and Base None.

Enable Item Check-Out

Information about whether or not the item can be checked out and checked in. This provides document control, allowing groups of users to edit items and not overwrite each other's work. Users cannot edit items that are checked out by another user.

Expiration Period

Information about how long an item should be displayed on a page.

Image

The image associated with the item or page. This is also a display attribute.

Image Alignment

Information about where the item image should appear in the page.

See Item image alignment for a description and example of the different image alignment options.

Item Type Icon

The icon and Alt text that represent the item type. This is also a display attribute.

Note: OracleAS Portal provides values for this attribute for the following MIME types: doc, exe, gif, html, htm, jpg, mpeg, pdf, ppt, rtf, txt, wav, xls, zip. For other item types, this attribute renders the values entered for the item types' Image and Display Name attributes. When no image is provided, this attribute renders the built-in basetype icon.

Keywords

Keywords that describe the content or purpose of the item or page. When a user performs a search, the user's search criteria is compared to the keywords to find a match. This is also a display attribute.

Name

The internal name of the item. If a Name is not explicitly set, the internal name is defaulted to the item's File Name (for file-based items, such as files, images, and Zip files), Display Name, or globally unique ID (GUID).

When the Name is explicitly set, it is used (in lieu of the File Name, Display Name, or GUID) in the formation of path-based URLs.

Notes:

  • A default value is not required; however, if you plan to specify a default value for the Name attribute, do not use a constant value, such as Your name here. Two or more items on the same page cannot have a common name; consequently, providing a static default value for the Name field results in an error when at least two users accept the default. Instead, consider creating a function that returns a unique value and supplying that as the default.
  • All files uploaded in support of an item retain the same file name across all versions and translations of that item. When a new document file with a different file name from the other versions is uploaded (for example, for a new version of the item), then all files for all versions and translations of that same attribute (for example, the file name attribute) are renamed to match the new file name. This is not only true for documents, it is also true for images, Zip files, or any other file type that is uploaded in support of an item.

Perspectives

The names of the perspectives associated with the item or page. This is also a display attribute.

PL/SQL Execute Options

The PL/SQL Execute Options secure the PL/SQL code so that it is executed or parsed by a selected database schema. Use this attribute to explicitly select the database schema that executes the PL/SQL item: the Public schema or a specified database schema. The Public schema is the default.

This attribute is for use with item types that are based on the PL/SQL base item type.

Portal Template

The Portal Template for items to be used in lieu of the template that was assigned at the page level. This attribute is available for custom item types that are based on one of the following item types: text items, PL/SQL items, URL items, and all file items of the type text/html or text/plain.

This attribute displays on the Edit Item page under the following circumstances:

  • A Portal Template for items must be defined for the parent page group or the Shared Objects page group.
  • The option Allow items on this page to use a different Portal Template must be selected for the page on which the item is placed (Page Properties/Items tab).

Publish Date

The date (in the format, DD-MON-YYYY HH12:MI PM) when the item should start being displayed to users. This is also a display attribute.

Rollover Image

The second image associated with the item or page. This image is displayed whenever a user moves the mouse cursor over the original image on a navigation bar or tab.

Rollover images work only on item types that are displayed as links. For example, they can be used successfully with URL item types, and file-type items that are displayed as links. Rollover images do not display with items that are not displayed as links, such as images, file- and text-type items displayed in place, and so on. This is also a display attribute.

Version Number

A number indicating the version of the currently displayed item. This is also a display attribute.

Note: If you plan to specify a default value for the Version Number attribute, do not use a constant value, such as 2. Because an item cannot have, for example, two version 2s on the same page, providing a static default value for the Version Number field will result in an error. Instead, consider creating a function that returns a unique value and supplying that as the default.

Versions

The Versions icon (Versions) next to items that have multiple versions. Users can click this icon to view other versions of the item. This is also a display attribute.

Built-in display attributes:

Attribute

Adding this attribute to a region displays:

Associated Functions

Links to functions associated with the item if the item is of a custom item type that includes function calls.

Author

The name of the author of the item. When you add an Author attribute to a custom item type, you can use the tag #USER as the default attribute value. This renders the current user's name. Note that you cannot use the #USER tag with custom page types. This is also a content attribute.

Blank Line Inserts a blank line between attributes as specified, unless the subsequent attribute has no value. In this case, the Blank Line attribute is ignored to avoid unnecessary white space. See also, Hard Blank Line.

Category

The name of the category to which the item or portlet belongs. This is also a content attribute.

Character Set

The character set used for the item if it is other than that used for the database. This is also a content attribute.

Note: This attribute is available only for file- and URL-type items. It is available for use with Base File and Base URL base item types. It comes with an attached, system list of values (wwv_system.charset_values). It is especially useful for facilitating searches in portals that commonly use multi-byte character sets. This is because, for searches to run correctly, content must be converted into the database character set so that it may be indexed. This conversion can occur only when the content's character set is known.

Create Date

The date when the item or portlet was added to the page.

Creator

The user name of the user who added the item or portlet to the page.

Date Updated

The date when the item or portlet was last updated.

Description

The short text description of the item or portlet. This is also a content attribute.

Display Name

The display name of the item or portlet. This is also a content attribute.

See also the entries under Link.

Document Size

The size of the uploaded file.

Note: This attribute applies only to File and Simple File items, or items of a type based on the Simple File item type.

Expire Date

The date (in the format, DD-MON-YYYY HH12:MI PM) when the item is due to expire.

Gist

The Gist icon (Display Gist) next to items. Users can click this icon to display an overview of the item created by Oracle Text.

Note: This attribute displays only if Oracle Text is enabled and only for File and Simple File items, or items of a type based on the Simple File item type.

Hard Blank Line Inserts a blank line between attributes as specified regardless of whether any subsequent attributes have values. See also, Blank Line
Hard Space Inserts a blank space between attributes as specified regardless of whether any subsequent attributes have values. See also, Space.

Help URL

The help icon (Help) next to the portlet item. Users can click this icon to display help for the portlet.

Note: This attribute is appropriate only for Portlet Repository pages, and displays only if the portlet developer specified a help URL for the portlet.

Image

The image associated with the item. If the item does not have an associated image, nothing is displayed. This is also a content attribute.

See also the image-related entries under Link.

Image URL

A linked image icon (Image) that displays next to the portlet item. Users can click this icon to display a preview of the portlet.

Note: This attribute is appropriate only for Portlet Repository pages, and displays only if the portlet developer specified a preview image URL for the portlet.

Item Content

The content of the item. This attribute is meant for use with items displayed in place, that is, items whose Display Option is set to Item Displayed Directly In Page Area. It enables you to arrange the display order of the item's content in relation to the other attributes selected for display. For example, placing the Item Content attribute after the Description attribute in the region's list of displayed attributes causes the Description to display ahead of the item's content.

In the absence of an Item Content attribute, the item's content displays after all the other specified attributes.

Notes:

  • This attribute displays for Text, Simple Text, and PL/SQL items, or items of a type based on the Simple Text or Simple PL/SQL item type, as well as File-type items of the MIME type text/plain or text/html.
  • The value of the Display Option attribute overrides this attribute setting. Items that display as links (that is, items marked for display in a full browser window or in new browser window) are not affected by the presence or absence of the Item Content attribute in the region.
Item Type Icon

The icon and Alt text that represent the item type. This is also a display attribute.

Note: OracleAS Portal provides values for this attribute for the following MIME types: doc, exe, gif, html, htm, jpg, mpeg, pdf, ppt, rtf, txt, wav, xls, zip. For other item types, this attribute renders the values entered for the item types' Image and Display Name attributes. When no image is provided, this attribute renders the built-in basetype icon.

Keywords

The keywords associated with the item or portlet. This is also a content attribute.

Last Updated By

The user name of the user who last updated the item or portlet.

Link - Display Name

The display name of the item or portlet as a link pointing to the item or portlet content. This attribute uses the object's path-based URL.

Note: The display name does not link when the Displayed Directly In Page Area display option is selected for the item or portlet.

Link - Display Name (durable)

The display name of the item or portlet as a link pointing to the item or portlet content. This attribute uses the object's durable URL.

Note: The display name does not link when the Displayed Directly In Page Area display option is selected for the item or portlet.

Link - Image

The image associated with the item as a link pointing to the item content. If the item does not have an associated image, nothing is displayed. This attribute uses the object's path-based URL.

Note: The image does not link when the Item Displayed Directly In Page Area display option is selected for the item.

Link - Image (durable)

The image associated with the item as a link pointing to the item content. If the item does not have an associated image, nothing is displayed. This attribute uses the object's durable URL.

Note: The image does not link when the Item Displayed Directly In Page Area display option is selected for the item.

Link - Image and Display Name

The image and display name of the item or portlet as links pointing to the item or portlet content. If the item has both an image and a display name, these appear next to each other. If the item does not have an associated image, only the display name appears. This attribute uses the object's path-based URL.

Notes:

  • The image and display name do not link when the Displayed Directly In Page Area display option is selected for the item or portlet.
  • Portlets cannot have associated images, so for portlets, only the display name is displayed.
  • When a page link item is selected to display in a region with this attribute selected, and the user has provided an image but no display name for the item, after an upgrade this attribute is rendered as the title of the target page along with the original uploaded image. If this is not the desired effect, select the attribute Link - Image OR Display Name for the affected region. This results in just the image being displayed.
Link - Image and Display Name (durable)

The image and display name of the item or portlet as links pointing to the item or portlet content. If the item has both an image and a display name, these display next to each other. If the item does not have an associated image, only the display name displays. This attribute uses the object's durable URL.

Notes:

  • The image and display do not link when the Displayed Directly In Page Area display option is selected for the item or portlet.
  • Portlets cannot have associated images, so for portlets, only the display name is displayed.
Link - Image OR Display Name

The image associated with the item as a link pointing to the item content. If the item does not have an associated image, the display name is displayed instead. This attribute uses the object's path-based URL.

Note: The image or display name does not link when the Item Displayed Directly In Page Area display option is selected for the item.

Link - Image OR Display Name (durable)

The image associated with the item as a link pointing to the item content. If the item does not have an associated image, the display name is displayed instead. This attribute uses the object's durable URL.

Note: The image or display name dies not link when the Item Displayed Directly In Page Area display option is selected for the item.

New Item Indicator

The New icon (New) next to a new item or portlet. Users can click this icon to display a list of all new content in the page group.

Note: An item or portlet is considered new for the number of days specified in the page group Icon Display Period property. See Edit Page Group: Items for information about how to change this value. The display period applies to both the New and Recently Updated icons. You cannot set a different display period for the individual icons. This means that, from time to time, an item or portlet may show a New and a Recently Updated icon simultaneously.

Perspectives

The names of the perspectives associated with the item or portlet. This is also a content attribute.

Portlet Content

The portlet itself if the Item Displayed Directly In Page Area display option is selected.

Portlet Id

The ID of the portlet.

Note: This attribute is applicable only to portlets.

Property Sheet

The Property Sheet icon (Property Sheet) next to items and portlets. Users can click this icon to view the properties of an item or portlet.

Provider Id

The ID of the provider.

Note: This attribute is appropriate only for Portlet Repository pages.

Provider Name

The name of the provider.

Note: This attribute is appropriate only for Portlet Repository pages.

Publish Date The date when the item is published on the page (that is, when the item is visible to users in View mode). This is also a content attribute.

Rollover Image

The second image associated with the item or page. This image is displayed whenever a user moves the mouse cursor over the original image on a navigation bar or tab.

Rollover images work only on item types that are displayed as links. For example, they can be used successfully with URL item types, and file-type items that are displayed as links. Rollover images do not display with items that are not displayed as links, such as images, file- and text-type items displayed in place, and so on. This is also a content attribute.

Score The Oracle Text relevancy score, rating how each result matches the search words.
Space Inserts a blank space between attributes as specified, unless the subsequent attribute has no value. In this case, the Space attribute is ignored to avoid unnecessary white space. See also, Hard Space.

Subscribe

The Subscribe (Subscribe) or Unsubscribe (Unsubscribe) icon next to items. Users can click this icon to subscribe to an item and be notified, via the Notifications portlet, when it is updated.

Note: The Subscribe icon displays only if approvals and notifications have been enabled for the page group.

Themes

The Themes icon (Display Themes) next to items. Users can click this icon to display the nouns and verbs appearing most often within an item.

Note: This attribute displays only if Oracle Text is enabled and only for File and Simple File items, or items of a type based on the Simple File item type.

Translations

A list of the languages in which the item or portlet is available.

Updated Item Indicator

The Recently Updated icon (Recently Updated) next to a recently updated item or portlet. Users can click this icon to display a list of all recently updated content in the page group.

Note: An item or portlet is considered recently updated for the number of days specified in the page group Icon Display Period property. See Edit Page Group: Items for information about how to change this value. The display period applies to both the New and Recently Updated icons. You cannot set a different display period for the individual icons. This means that, from time to time, an item or portlet may show a New and a Recently Updated icon simultaneously.

Version Number

A number indicating the version of the currently displayed item. This is also a content attribute.

Note: If you plan to specify a default value for the Version Number attribute, do not use a constant value, such as 2. Because an item cannot have, for example, two version 2s on the same page, providing a static default value for the Version Number field will result in an error. Instead, consider creating a function that returns a unique value and supplying that as the default.

Versions

The Versions icon (Versions) next to items that have multiple versions. Users can click this icon to view other versions of the item. This is also a content attribute.

View As HTML

The View As HTML icon (Display As HTML) next to items. Users can click this icon to view an HTML version of an item.

Note: This attribute displays only if Oracle Text is enabled and only for File and Simple File items, or items of a type based on the Simple File item type.

View As HTML With Highlight

For Search Results pages only. The View as HTML With Highlight icon. Users can click this icon to view search results content in HTML with the search criteria highlighted.

Note: This attribute displays only if Oracle Text is enabled and only for File and Simple File items, or items of a type based on the Simple File item type. Additionally, this attribute display only on search results pages.

Notes

Back to topRelated Help Topics

Concepts:

Related Page Help:

Back to topAdditional Information

Portal Center:

For more information, go to the Oracle Portal documentation page on the Oracle Technology Network.