Describing the Portlet Entity Registry

The portlet entity registry is the source for both the PeopleSoft portlet content references and the portlets produced through WSRP.

You can choose which portlets to produce for WSRP by including them as <portlet> elements in portletentityregistry.xml.

To produce portlets for WSRP:

  1. Edit portletcontainer/WEB-INF/data/portletentityregistry.xml to add an <application> element for your new portlet application.

    The following code is the portletentityregistry.xml file as delivered, showing the production of four portlets for WSRP consumption, WSRPTestPortlet of the wsrptest portlet application, TestPortlet1 and TestPortlet2 of the testsuite portlet application, and the HelloPortlet of the helloportletapp portlet application.

    <?xml version="1.0" encoding="UTF-8"?>
    <portlet-entity-registry>
        <application id="">
            <definition-id>helloportletapp</definition-id>
            <portlet id="">
                <definition-id>helloportletapp.HelloPortlet</definition-id>
            </portlet>
        </application>
        <application id="">
            <definition-id>wsrptest</definition-id>
            <portlet id="">
                <definition-id>wsrptest.WSRPTestPortlet</definition-id>
            </portlet>
            <portlet id="">
                <definition-id>wsrptest.WSRPTestPortlet</definition-id>
            </portlet>
        </application>
        <application id="">
            <definition-id>testsuite</definition-id>
            <portlet id="">
                <definition-id>testsuite.TestPortlet2</definition-id>
            </portlet>
            <portlet id="">
                <definition-id>testsuite.TestPortlet1</definition-id>
            </portlet>
        </application>
    </portlet-entity-registry>
    

    The portletentityregistry.xml requires that:

    • Your portlet application must have a new <application> element in which the <definition-id> is the name of your portlet application directory and the ID is unique within the file.

    • Any portlets that you want to produce from your portlet application must have their own <portlet> elements within your new <application> element. Use the delivered portletentityregistry.xml as a guide.

      Note: Each portlet must have a unique ID within the <application>. For example, refer to the same definition multiple times—each having different preferences and its own unique entity ID.

    • The <definition-id> of each portlet is a period-separated, fully qualified name for the portlet of the form: “<porletApplicationName>.<portletName>” as shown. The portletApplicationName portion must match the <definition-id> of the <application>. The portletName portion must match the <portlet-name> element for the <portlet> definition in your portlet.xml file.

  2. Restart your web server. Your Java portlets are now produced via WSRP technology. All WSRP consumers that you may use will need to retrieve the new service description, which will include the new Java portlets.