Entering content frame

Component documentation Portal Object Name and Alias Locate the document in its SAP Library structure

Purpose

Each of the portal objects is accessed on different occasions summarized by the following table:

Object

Purpose

Examples

Application

Applications are referenced by other applications to indicate class loader dependencies in the deployment descriptor file (portalapp.xml).

CharingReference = ApplicationName,

PrivateSharingReference = ApplicationName

ServicesReference = ApplicationName

Application

Application are referenced by either components or services to access to a resource packaged in the PAR file of the application by calling one of the different getResource() methods of the API.

getResource(applicationName, ..)

Service

Services are referenced by components or services using the getService() API of the PRT.

getService(ServiceName)

Service

Services are referenced in a URL to access WEB services using the soap connection.

irj/servlet/prt/soap/ServiceName

Component

Components are referenced by other components using the getComponentContext() of the PortalComponentRequest object of the PRT API.

getComponentContext(ComponentName) in the URL.

Component

Components are referenced in the URL to be executed and rendered.

irj/servlet/prt/portal/prtroot/ComponentName

Integration

Name

The following rules apply for naming objects in the portal runtime.

The ApplicationName is defined by the name of the file containing the application.

The ServiceName or the ComponentName is defined by prefixing the name of the component or a service defined in the portal application descriptor with the name of the application

<ApplicationName >.<name>

Alias

The portal runtime also offers a concept of alias that enables an alternative name for portal objects to be defined for reasons of compatibility. The following rule applies to declaring an alias on portal objects.

·        The application can have an alias, then the alias can replace the name of the application without any limitation. For example, <ApplicationName> == <ApplicationAlias>

·        The component can have an alias by using the alias of the application. For example <ApplicationName>.<name> == <ApplicationAlias>.<name>, 

·        The service can have an alias. In this case, the name of the service can be replaced by the service alias. For example, <ApplicationName>.<name> == <ServiceAlias>. In the case of a service, using the alias of the application name is not accepted. For example <ApplicationAlias>.<name> is not a valid service name.

Example

If the myApplication.par defines the following entries:

<application alias="myAlias">

  <services>

    <service name="myService" alias="alias.service" >

    ...

  <components>

    <component name="myComponent" >

The following name will be valid and recognized by the portal:

·        myApplication.myComponent, myAlias.myComponent for the component defined myComponent

·        myApplication.myService, alias.service for the service myService

·        myApplication or myAlias for the application myApplication

 

 

Leaving content frame