Entering content frame

Background documentation Component Profile Locate the document in its SAP Library structure

This section contains properties that make up the profile of the Portal component as accessed by the com.sapportals.portal.prt.component.IPortalComponentProfile interface at runtime. The profile is usually abstracted in the iView entity. The values of the properties are the default values:

Name

Possible Values

Description

ConfigRootFolder

/com.sap.myapplication.mycomponent

String representing the path within the overall configuration structure of the component specific configuration.

CachingLevel

Shared: The cache content is shared among all users.

User: The content is private for each user

Session: The content of the component is cached all the time the (Servlet) session is running, whether or not a user is connected. This level is used to cache information related to the browser's sessions

String representing the scope of the cache.

ValidityPeriod

The time period in milliseconds

Defines the time in milliseconds for which the content of the cache is valid.

EPCFLevel

1: This component does not use the EPCF at all. Therefore neither script nor applets will be included

2: This level includes all EPCF features that use pure JavaScript

3: This level includes all features of level 1 and additional features that use applets

 

Defines whether or not the enterprise portal client framework is used.

If two or more embedded iViews with different EPCFLevel values meet on one page (within the same frame), the effective level is computed as the maximum of all EPCFLevel values on this page.

The default value is 2.

Each property may have additional attributes describing how the properties are handled with respect to personalization and meta-data handling. Attributes of profile properties are denoted by sub-properties.

Example 

The property “Color has two sub-properties:

·        personalization – defines the type of personalization allowed by the property editor

·        type – defines the relevant value of this property

The portal runtime does not make any assumptions concerning the semantics of those sub-properties. The property attributes are basically used at design time (by administration tools) or during personalization:

<property name="Color" value="red">

<property name="personalization" value="dialog"/>

<property name="type" value="select[red,green,blue]"/>

</property>

Property Attributes

Name

Default Value

Admissible Value

Description

description

---

---

A text token that can be resolved by accessing the component's resource bundle. It represents a locale-sensitive descriptive text for the property that can be used in user interfaces.

plainDescription

The property name.

---

A plain text that can be used in user interfaces to describe the property. This will be used if no description attribute is specified.

type

<none>

select[<option>(,<option>)*],

boolean,

<none>

The type of the property is used by the visual properties editor to control the user’s input when the properties are modified

Example

select[blue, red, yellow]

personalization

dialog

none: cross-user storage, not shown in personalization

no-dialog: per-user storage, not shown in personalization

dialog: per-user storage and shown in personalization

This attribute specifies how to treat this property with respect to personalization.

inheritance

non-final

final, non-final

Specifies whether the property can be overridden by a template derivation (for example, iView chain).

 

 

Leaving content frame