A script-enabled browser is required for this page to function properly.
Oracle Help for the WebContentsIndexSearchView Topic


What is an attribute?

Skip Navigation Links| Related Help Topics | Additional Information |

Back to top

An attribute is an element that takes a value and is associated with an object, such as an item, a region, a page. An example of such an element is Author, whose value is typically the name of the object creator. Typically, an attribute value is provided by a user, though there are some attributes that provide their own default values.For example, the Publish Date attribute has a default value of the current date and time. In most cases, users can revise an attribute's default value.

There are two types of attributes, with all attributes falling into either one or both types:

Attributes can be further sub-divided into particular types of use groups. For example:

The following table lists all seeded attributes alphabetically, describes their purpose, and indicates the use groups to which the attributes belong.

Attributes used In Oracle AS Portal:

Attribute
Value EDIT REGION SEARCH RESULTS
<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.

This is a display attribute.

--
REGION:A
--
RESULTS
<Hard Blank Line>

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

This is a display attribute.

--
REGION:A
--
RESULTS
<Hard Space>

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

This is a display attribute.

--
REGION:A
--
RESULTS
<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.

This is a display attribute.

--
REGION:A
--
RESULTS
Associated Functions

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

This is a display attribute.

--
REGION:A
--
RESULTS
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 both a content and display attribute.

EDIT
REGION:A
SEARCH
RESULTS
Base Item Type

The seeded item type on which the current item type is based. Compare with Item Type.

--
--
SEARCH
--
Category

The name of the category to which the item or page belongs.

This is both a content and display attribute.

EDIT
REGION:A
SEARCH
RESULTS
Character Set

The character set used for the item if it is other than that used for the database.

Note: This attribute is available only for file- and URL-type items. It is available for use with Base File- and Base URL-based 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.

This is both a content and display attribute.

EDIT
--
SEARCH
RESULTS

Create Date

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

This is a display attribute.

--
REGION:A
SEARCH
RESULTS
Creator

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

This is a display attribute.

--
REGION:A
SEARCH
RESULTS
Date Updated

The date when the item or portlet was last updated.

This is a display attribute.

--
REGION:A
SEARCH
RESULTS
Description

A short text description of the item or page.

This is both a content and display attribute.

EDIT
REGION:A
SEARCH
RESULTS
Display Name

The display name of the item or page.

See also the entries under Link.

This is both a content and display attribute.

--
REGION:A
SEARCH
RESULTS
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.

This is a content attribute.

EDIT
--
--
--
Display Parameter Form Information determining whether a portlet's parameter form should display.
EDIT
--
--
--
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.

This is a display attribute

--
REGION:I
--
RESULTS
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.

This is a content attribute.

EDIT
--
--
--
Expiration Period

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

This is a content attribute.

EDIT
--
--
--
Expire Date

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

This is a display attribute.

--
REGION:I
SEARCH
RESULTS
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.

This is a display attribute.

--
REGION:I
--
RESULTS
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.

This is a display attribute.

--
REGION:I
--
RESULTS
Image

The image associated with the item or page. If no image is associated, nothing is displayed.

See also the image-related entries under Link.

This is both a content and display attribute.

EDIT
REGION:A
--
RESULTS
Image Alignment

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

See Item image alignment for descriptions and examples of image alignment options.

This is a content attribute

EDIT
--
--
--
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.

This is a display attribute.

--
REGION:I
--
RESULTS
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.

This is a display attribute.

--
REGION:I
--
--
Item Type

An item's type. Compare with Base Item Type, which displays the base item type on which a custom item is based. Item Type may have a user-assigned value; where base item type uses only seeded values.

--
--
SEARCH
--
Item Type Icon

The icon and Alt text that represent the item type.

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.

This is both a content and display attribute.

--
REGION:I
--
RESULTS
Keywords

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

This is both a content and display attribute.

EDIT
REGION:A
SEARCH
RESULTS
Last Updated By

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

This is a display attribute.

--
REGION:A
SEARCH
RESULTS
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.

This is a display attribute.

--
REGION:A
--
RESULTS
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.

This is a display attribute.

--
REGION:I
--
--
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.

This is a display attribute.

--
REGION:A
--
--
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.

This is a display attribute.

--
REGION:I
--
--
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.

This is a display attribute.

--
REGION:A
--
RESULTS
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.

This is a display attribute.

--
REGION:I
--
--
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.

This is a display attribute.

--
REGION:A
--
RESULTS
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.

This is a display attribute.

--
REGION:I
--
--
Link That Displays Item In New Browser Window

The link associated with an item that, when clicked, renders the item in a second browser window, leaving the first browser window, from which the link was clicked, open.

This is a content attribute.

EDIT
--
--
--
Mime Type

The Mime type of the item:

The conditions that determine which text is rendered include:

  • For items that have an associated file of a recognized MIME type, this attribute renders the text that identifies the MIME type, for example, Adobe Portable Document Format.

    The recognized MIME types are: doc, exe, gif, html, htm, jpg, peg, pdf, ppt, rtf, txt, wav, xls, zip.

  • For other items, this attribute renders the value entered for the item type's Display Name attribute.

When the page group is rendered in a non-default language, the text is translated automatically when a translation is available in the language. For example:

  • Translations for recognized MIME types and built-in item types are available.
  • Translation for a custom item type is available when a translation is provided for the item type's Display Name attribute.

This is both a content and display attribute.

EDIT
--
SEARCH
RESULTS
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.

This is a content attribute.

EDIT
--
SEARCH
--
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.

This is a display attribute.

--
REGION:A
--
RESULTS
Oracle Reports Components

The Oracle Reports component to associate with the object.

This is a content attribute.

EDIT
--
--
--

Page

The name of the page that contains the object returned in a search.

This is a display attribute.

--
--
--
RESULTS
Page Group

The name of the page group that contains the object returned in a search.

This is a display attribute.

--
--
--
RESULTS
Perspectives

The names of the perspectives associated with the item or page.

This is both a content and display attribute.

EDIT
REGION:A
SEARCH
RESULTS
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.

This is a content attribute.

EDIT
--
--
--
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 containing 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).

Note:

  • When you create custom item types, the Portal Template attribute sometimes appears to allow its placement on the Add Item wizard. In fact, this attribute can be displayed only in the Edit Item wizard, and only for the item types mentioned in the first paragraph of this description.
  • When property inheritance rules (set at the page group level) are set to copy property settings from the page, rather than from the page group, all sub-pages of a page where you apply an item template also inherit the parent page's item template setting. Subsequent changes to the template setting cascade to the sub-pages under the page on which you change the setting. The option Allow items on this page to use a different Portal Template is exempted from this behavior. When changes to item template settings on the parent page cascade to sub-pages, any change to the Allow items on this page to use a different Portal Template setting do not also cascade.

This is a content attribute.

EDIT
--
--
--
Portlet Content

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

This is a display attribute.

--
REGION:P
--
--
Portlet Id

The ID of the portlet.

This is a display attribute.

--
REGION:I
--
--
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.

This is a display attribute.

--
REGION:A
--
RESULTS
Provider Id

The ID of the provider. This attribute is appropriate only for Portlet Repository pages.

This is a display attribute.

--
REGION:I
--
--
Provider Name

The name of the provider. This attribute is appropriate only for Portlet Repository pages.

This is a display attribute.

--
REGION:I
--
--
Publish Date

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

This is both a content and display attribute.

EDIT
REGION:A
SEARCH
RESULTS
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 both a content and display attribute.

EDIT
--
--
--
Score

The Oracle Text relevancy score, rating how each result matches the search words.

This is a display attribute

--
--
--
RESULTS
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 are enabled for the page group.

This is a display attribute.

--
REGION:I
--
RESULTS
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.

This is a display attribute.

--
REGION:I
--
RESULTS
Translations

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

This is a display attribute.

--
REGION:A
--
RESULTS
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.

This is a display attribute.

--
REGION:A
--
RESULTS
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.

This is both a content and display attribute.

EDIT
REGION:I
SEARCH
RESULTS
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 both a content and display attribute.

--
REGION:I
--
RESULTS
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.

This is a display attribute.

--
REGION:I
--
RESULTS
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.

This is a display attribute.

--
--
--
RESULTS

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.