Using WSRP to Consume and Produce Remote Portlets

This chapter discusses how to:

Set up the local gateway URL. (Consumer)
Use the WSRP Consumption Wizard. (Consumer)
Display remote portlets on a homepage. (Consumer)
Produce remote portlets. (Producer)

Note. Use the link to the wsrp-primer for more information about WSRP.

Setting Up the Local Gateway URL (Consumer)

This section discusses how to set up the local gateway URL.

The local gateway is used for administrative tasks , such as registering producers.

Page Used to Set Up the Local Gateway URL

Page Name	Object Name	Navigation	Usage
Gateways	IB_GATEWAY	PeopleTools, Integration Broker, Configuration, Gateways Select Local Gateway.	Set up a web server to use for administration tasks; such as registering producers.

Page Name

Object Name

Navigation

Usage

Gateways

IB_GATEWAY

PeopleTools, Integration Broker, Configuration, Gateways

Select Local Gateway.

Set up a web server to use for administration tasks; such as registering producers.

Setting Up the Local Gateway URL

Access the Gateways page.

To set up a web server for WSRP administration tasks:

Change the URL to: http://<web server name:port>/PSIGW/PeopleSoftListeningConnector

Note. If you omit the port number, the system presumes a value of 9000.
Click Save.
Click Load Gateway Connectors.

The connectors will appear in the Connectors grid.
Click Save.

Using the WSRP Consumption Wizard (Consumer)

This section provides an overview of the WSRP Consumption Wizard and discusses how to:

Import producer information.
Register producers.
Create content references.

Understanding the WSRP Consumption Wizard Data

The Consumption Wizard is a tool used to easily import producer information, register producers, and create content references (CREFs) for the producer offered portlets. Once a producer has been registered, the offered portlets become available for use by any of your portals. Although the automatically created CREFs are only available to users of the current portal, an administrator can log into a different portal and manually create CREFs for any of the producer offered portlets.

Common Elements Used in This Section

Click a number to go to the corresponding page within portal wizard.

1: Import Producer Information.

2: Registration.

3: Producer Offered Portlets.

The different background signifies:

Pale Blue: The page is updated.
Orange: Current page.
Dark Blue: The page has not been updated.

Orange indicates the current page.

Previous and Next

Click to navigate page by page.

Producer Title and Description

Enter meaningful titles and descriptions.

Note. The producer title is also used as the default folder label for the content references created based on this producers offered portlets.

Pages Used to Navigate WSRP Consumption Wizard

Page Name	Object Name	Navigation	Usage
Define Producers	PT_WSRP_PRO_LIST	PeopleTools, Portal, WSRP Consumption, Define Producers	Add a new producer, edit an existing producers information, or delete a producer.
Import Producer Information	PT_WSRP_IMPORT	Click Edit or Add a Import Producer Information	Enter the producers WSDL URL to import required information.
Registration	PT_WSRP_REGISTER	Click Save on the Import Producer Information page.	Input producer registration information.
Producer Offered Portlets	PT_WSRP_PORT_LIST	Click Next on the Registration page.	View and edit portlet information. Create PeopleSoft portlets based on these portlets.
Producer Details	PT_WSRP_PRODETAIL	Click the Producer Details link on the Producer Offered Portlets page.	View the producers actual ServiceDescriptionResponse.
Portlet Content References	PT_WSRP_PORT_CREFS	Click the View button for the desired portlet on the Producer Offered Portlets page.	View the Content Reference of the newly created portlet.
Portlet Details	PT_WSRP_PORTDETAIL	Click the Details button for the desired portlet on the Producer Offered Portlets page.	View the XML that was returned from the producer for this portlet.

Importing Producer Information

Access the Import Producer Information page.

Producer Name

Enter a meaningful name for this producer.

The value entered here is also used as part of the default folder name for content references created based on this producers offered portlets. Using the prior screenshot as an example, the folder name will be WSRP_NET_UNITY

Security Node (Optional)

Select the node definition that was created for WS-Security.

See Configuring WS-Security For WSRP Consumption and Production.

Web Service Endpoint URL

URL

Enter the web service WSDL URL for this producer.

Note. The producer conveys this information to you.

Import

Click to import the required producer information.

Status	If the WSDL URL is correct the status will automatically update from No Data Imported to Import Complete.If the URL is incorrect, or the producer is unavailable, you will receive a warning message with information on how to make corrections.
Save	Click to save the producer information and jump to the Registration page.

Registering Producers

Access the Registration page.

Registration Type

Choose a registration type:

In Band: In this process, the consumer sends a request to register with the producer, along with any properties required by the producer.

Out of Band: In this process the producer and consumer specify manual processes such as email or phone conversations to establish registration.

None: Registration is not required. No further information is required. Continue to the next page.

Status

Handle

Out of band: Enter the handle value conveyed to you by the producer.

In Band: Read-only. The value will display automatically when you click Register.

Validate

Click to check the validity of the handle.

Note. This button appears only when the registration type is Out of band.

Handle Status

Indicates the validity of the handle.

Note. This field appears only when the registration type is Out of band.

Note. Messages regarding registration status are also displayed within this group box.

Consumer Properties

Consumer Name and Consumer Agent

Displays the consumer information, (URL and software version), which is required by and sent to the producer.

Registration Properties

This group box appears only when the registration type is In-Band.

Note. The fields contained in this group box may vary according to each producers requirements.

Register

Click to register the producer.

If registration is successful, the registration message in the Status group box is updated and the Deregister button appears.

Important! When you deregister a producer, the handle becomes invalid and all user portlet personalizations are removed. You will need to obtain a new handle before attempting a reregistration.

Creating Content References

Access the Producer Offered Portlets page.

Update Portlet List

Click to refresh the list of offered portlets.

Important! When previously listed portlets are no longer offered by a producer, the Delete button associated with those portlets becomes active.

Producer Details

Click to go to the Producer Details page and view the producers actual ServiceDescriptionResponse.

Create Pagelets for All Selected Portlets

Click to create content references for the selected portlets.

These content references can be located in a folder created automatically using the values entered for this producer name and title for its name.

This will make the portlets available when end users are personalizing their homepages.

Note. You can also create the content references manually in any portal via Structure and Content.

See Administering Content References.

Producer Offered Portlets

Selected	Select the portlets you want to consume, then click the Create Pagelets for All Selected Portlets button to create content references. You can also use the Select All and Deselect All buttons.
View	Click to go to the Portlet Content References page to view the newly created content reference in a new browser window. The page displays the portal where the new portlet resides, the name and label of the portlet, and a link to the content reference. Note. This button is disabled until a content reference is created.
Details	Click to go to the Portlet Details page to view the XML returned from the producer for this portlet.
Delete	Click the Update Portlet List to refresh the list of portlets that are being offered by this producer. The Delete button will become active for portlets that are no longer being offered. Click the Delete button to remove the portlet and associated content reference.

Displaying Remote Portlets on a Homepage (Consumer)

This section discusses how to:

Review content references.
Display remote portlets on a homepage.

Pages Used to Display Remote Portlets

Page Name	Object Name	Navigation	Usage
Content Ref Administration	PORTAL_CREF_ADM	PeopleTools, Portal, Structure and Content, Portal Objects, Pagelets Click the desired folder name, then click Edit for the desired portlet. PeopleTools, Portal, WSRP Consumption, Define Producers Click Edit for the desired producer, then navigate to the Producer Offered Portlets page. Click View on the Producer Offered Portlets page for the desired pagelet, then click the navigation link on the Portal Content References page.	Review content reference data or manually create a content reference for an offered portlet.
Tab Content	PORTAL_TAB_CON_ADM	PeopleTools, Portal, Structure and Content, Portal Objects, Homepage, Tabs Click the Edit button associated with the My Page content reference. Click Tab Content.	Select the portlets that can be used for this homepage tab definition.
Personalize Content	PORTALHPCOMP	Click the Personalize Content link on the Homepage.	Choose the remote portlets that you want to appear on your homepage.

Reviewing Content References

Access the Content Ref Administration page for a remote portlet.

The field values that are automatically entered are based on the values entered for the producer via the portal wizard. These include:

Name	Defaults to WSRP_<portlet handle>. This field is read-only and cannot be changed.
Label	Enter a meaningful label description for this portlet. Defaults to the remote portlets short title.
Parent Folder	Defaults to the producers title. Click the Select New Parent button to move the content reference to a different folder.
Usage Type	Defaults to Pagelet.
Storage Type	Defaults to Remote by URL. This field is read-only and cannot be changed.

URL Information

URL Type	Defaults to Remote Portlet.
Producer	Defaults to the producers name.
Portlet	Defaults to the portlets handle.
Producer Details	Click to go to the consumption wizards' Import Producer Information page for this producer.

Note. When you create content references manually for offered portlets update fields by using the same default values explained in this section.

See Defining Content References.

Displaying Remote Portlets on a Homepage

Access the Tab Content page.

Note. This procedure is performed by the administrator.

To make newly created remote portlets available to end users:

Access the Tab Content page.
Select the required portlets, or select the Include all? check box to display all portlets from the portal registry for remote content group box.
Click Save.

The selected portlets are now available for end users to display on their homepages.

To display the newly created remote portlets on a homepage:

On the homepage, click Personalize Content.
Choose the remote portlets that you want to appear on your homepage.
Click Personalize Layout to organize your portlets.
Click Save to save your selections and return to your homepage.

Producing Remote Portlets (Producer)

This section discusses how to: produce remote portlets.

Specify pagelets for WSRP production.
Offer WSRP portlets.
View content references for WSRP portlets.

Pages Used to Produce Remote Portlets

Page Name	Object Name	Navigation	Usage
Specify Publishing Options	PTPPB_WIZ_PUBOPT	PeopleTools, Portal, Pagelet Wizard, Pagelet Wizard Click the Next button on the Specify Display Options page, or click the icon for step 6.	Specify the manner in which your portlet is published.
Producer Offered Portlets	PT_WSRP_PRO_PORT	PeopleTools, Portal, WSRP Production	Select the portlets you want to offer to third party consumers.
Producer Details	PT_WSRP_PRODUCEDTL	Click the Producer Details link on the Producer Offered Portlets page.	Displays the service description XML that is sent to the consumer for all portlets in the selected portal.
Portlet Details	PT_WSRP_PROPORTDTL	Click the Details button for the desired portlet on the Producer Offered Portlets page.	Displays the generated XML for this portlet that will be sent to a consumer.
Content Ref Administration	PORTAL_CREF_ADM	Click the Path link for the desired portlet on the Producer Offered Portlets page.	Review the content reference that was created automatically for this portlet.
Content Ref Security	PORTAL_CREF_SEC	Click the Security tab on the Content Ref Administration page.	Review the security information for this portlet.

Specifying Pagelets for WSRP Production

Access the Pagelet Wizard - Specify Publishing Options page.

Use Pagelet Wizard to create the pagelets that you want to publish as WSRP portlets.

See Using Pagelet Wizard.

WSRP Portlet

Select to publish as a WSRP Portlet.

This allows this portlet to be consumed and displayed by another portal that is WSRP compliant.

Enable Caching

Select to enable caching.

If you select to enable caching, choose the Caching Type and the Minutes to Cache.

Offering WSRP Portlets

Access the Producer Offered Portlets page.

Portal Name

Choose the portal where the portlets you want to offer are located.

Web Service Endpoint URL

Displays the URL that the Consumer will require to import the offered portlets.

Portlets

Selected	Select the portlets you want to offer to consumers. Click the Select All button to offer all of the portlets listed. Click the Deselect button to remove all of the selections.
Details	Click to go to the Portlet details page to view this portlet's generated XML that will be sent to a consumer.
Path	Click to go to the Content Ref Administration page to view the CREF information for this portlet.
Producer Details	Click this link to go to the Producer Details page to view the service description XML that is sent to the consumer for all portlets in this portal.

Viewing Content References For WSRP Portlets

Access the Content Ref Administration page.

Important! Pagelets that you want to publish as WSRP portlets must be created using the Pagelet Wizard. Use the Content Ref Administration page to only select a new parent folder or update the security for the pagelet.

Name

Defaults to ADMIN_<Pagelet ID>_WSRP

Parent Folder

Defaults to the WSRP Produced Portlets folder.

Click Select New Parent Folder to change to this porlet's location.

Label

Defaults to the value entered for the pagelet's title.

Long Description

Defaults to the pagelet's description.

Storage Type

Defaults to Remote by URL. This value is read-only and cannot be changed.

URL Information

Node Name	Defaults to LOCAL_NODE.
URL Type	Defaults to PeopleSoft Generic URL.
Portal URL	Defaults to s/WEBLIB_PTPPB.ISCRIPT3.FieldFormula.IScript_WSRPPagletBuilder? PTPPB_PAGELET_ID=<Pagelet ID>

Content Reference Attributes

Name	Defaults to PTPPB_PAGELET_ID.
Attribute value	Defaults to <Pagelet ID>.

Portal Name	Choose the portal where the portlets you want to offer are located.
Web Service Endpoint URL	Displays the URL that the Consumer will require to import the offered portlets.

Name	Defaults to ADMIN_<Pagelet ID>_WSRP
Parent Folder	Defaults to the WSRP Produced Portlets folder. Click Select New Parent Folder to change to this porlet's location.
Label	Defaults to the value entered for the pagelet's title.
Long Description	Defaults to the pagelet's description.
Storage Type	Defaults to Remote by URL. This value is read-only and cannot be changed.