Show TOC Start of Content Area

Background documentation portalapp.xml  Locate the document in its SAP Library structure

The following is a sample portalapp.xml for a content provider PAR file:

<?xml version="1.0" encoding="utf-8"?>

<application>

  <registry>

    <entry path="/runtime/transformers" type="subcontext"/>

    <entry path="runtime/transformers/com.sap.portal.contentproviders.myCP"    name="TransformersProvider" type="service"/>

  </registry>

  <application-config>

    <property name="SharingReference" value="com.sap.portal.contentproviders"/>

    <property name="releasable" value="false"/>

    <property name="startup" value="true"/>

    <property name="Vendor" value="sap.com"/>

    <property name="SecurityArea" value="NetWeaver.Portal"/>

  </application-config>

  <components>

    <component name="CP_STORY">

      <component-config>

        <property name="ClassName"
   value="com.sap.portal.contentproviders.runtime.ContentProvidersComponent"/>

        <property name="SafetyLevel" value="low_safety"/>

      </component-config>

      <component-profile>

        <property name="com.sap.portal.cp.CP_SERVICE_KEY"                     value="com.sap.portal.contentproviders.myCP.ContentProvider"/>

        <property name="com.sap.portal.cp.ENTITY_KEY" value="CP_STORY"/>

        <property name="com.sap.portal.cp.TRANSFORMER_NAME" value="STORY_TO_XHTMLB"/>

        <property name="com.sap.portal.cp.PARAMETERS_LIST" value="story_id"/>

        <property name="com.sap.portal.cp.parameter.story_id" value="">

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

          <property name="plainDescription" value="Story ID"/>

        </property>

      </component-profile>

    </component>

  </components>

  <services>

    <service name="ContentProvider">

      <service-config>

        <property name="className"                                  value="com.sap.portal.contentproviders.myCP.myCPService"/>

        <property name="startup" value="false"/>

      </service-config>

      <service-profile>

        <property name="com.sap.portal.cp.PROVIDER_SITE" value="http://www.myCP.com"/>

        <property name="com.sap.portal.cp.PROVIDER_ICON"                      value="http://www.myCP.com/logobar.gif"/>

        <property name="com.sap.portal.cp.PROVIDER_VERSION" value="1.0"/>

        <property name="com.sap.portal.cp.PROVIDER_NAME" value="myCP"/>

        <property name="PROVIDER_USERNAME" value="username"/>

        <property name="PROVIDER_PASSWORD" value="password"/>

        <property name="com.sap.portal.cp.BASE_URL" value="http://api.myCP.com/api/?"/>

      </service-profile>

    </service>

    <service name="TransformersProvider">

      <service-config>

        <property name="className"                                  value="com.sap.portal.contentproviders.myCP.myCPTransformersProviderService"/>

        <property name="SafetyLevel" value="no_safety"/>

        <property name="ResourceBundleName"                             value="myCPTransformersProvider_localization"/>

        <property name="startup" value="false"/>

      </service-config>

    </service>

  </services>

Registry Element

The <registry> element creates an entry in the portal registry for the transformer service that will be used for the transformers defined in the content provider framework.

For more information, see Transformation Service.

<registry>

    <entry path="/runtime/transformers" type="subcontext"/>

    <entry path="runtime/transformers/com.sap.portal.contentproviders.myCP"          name="TransformersProvider" type="service"/>

  </registry>

Application Configuration Element

The <application-config> element is a standard element for all PAR files. In addition to the standard properties for this PAR, add a reference to com.sap.portal.contentproviders in the SharingReference property element.

  <application-config>

    <property name="SharingReference"                       value="com.sap.portal.contentproviders"/>

    <property name="releasable" value="false"/>

    <property name="startup" value="true"/>

    <property name="Vendor" value="sap.com"/>

    <property name="SecurityArea" value="NetWeaver.Portal"/>

  </application-config>

Components Element

You need to create a portal component for each entity (XML source) in your project. For each portal component that you need to create, add a <component> element in the <components> section.

For more information on how to create each <component> section, see Step 3: Creating Entity Portal Components.

<component name="CP_STORY">

  <component-config>

    <property name="ClassName" value="com.sap.portal.contentproviders.
runtime.ContentProvidersComponent"/>

  </component-config>

  <component-profile>

    <property name="com.sap.portal.cp.CP_SERVICE_KEY"                         value="com.sap.portal.myCP.ContentProvider"/>

    <property name="com.sap.portal.cp.ENTITY_KEY" value="CP_STORY"/>

    <property name="com.sap.portal.cp.TRANSFORMER_NAME" value="myTrans"/>

    <property name="com.sap.portal.cp.PARAMETERS_LIST" value="story_id"/>

    <property name="com.sap.portal.cp.parameter.story_id" value="">

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

      <property name="plainDescription" value="Story ID"/>

    </property>

  </component-profile>

</component>

Services Element

The <services> element includes two <service> elements, one for the content provider service and one for the transformation service.

For more information on the element for the content provider service, see Step 1: Creating a Content Provider Service.

For more information on the element for the transformation service, see Transformation Service.

 

 

 

End of Content Area