Author: chris.laprun(a)jboss.com Date: 2007-06-14 17:35:25 -0400 (Thu, 14 Jun 2007) New Revision: 7423 Added: docs/trunk/referenceGuide/en/images/wsrp/config_create.png docs/trunk/referenceGuide/en/images/wsrp/config_created.png docs/trunk/referenceGuide/en/images/wsrp/config_end.png docs/trunk/referenceGuide/en/images/wsrp/config_init.png docs/trunk/referenceGuide/en/images/wsrp/config_refresh.png docs/trunk/referenceGuide/en/images/wsrp/config_usewsdl.png Modified: docs/trunk/referenceGuide/en/modules/wsrp.xml Log: - Added documentation on how to use the WSRP configuration portlet to create a Consumer. Added: docs/trunk/referenceGuide/en/images/wsrp/config_create.png =================================================================== (Binary files differ) Property changes on: docs/trunk/referenceGuide/en/images/wsrp/config_create.png ___________________________________________________________________ Name: svn:mime-type + image/png Added: docs/trunk/referenceGuide/en/images/wsrp/config_created.png =================================================================== (Binary files differ) Property changes on: docs/trunk/referenceGuide/en/images/wsrp/config_created.png ___________________________________________________________________ Name: svn:mime-type + image/png Added: docs/trunk/referenceGuide/en/images/wsrp/config_end.png =================================================================== (Binary files differ) Property changes on: docs/trunk/referenceGuide/en/images/wsrp/config_end.png ___________________________________________________________________ Name: svn:mime-type + image/png Added: docs/trunk/referenceGuide/en/images/wsrp/config_init.png =================================================================== (Binary files differ) Property changes on: docs/trunk/referenceGuide/en/images/wsrp/config_init.png ___________________________________________________________________ Name: svn:mime-type + image/png Added: docs/trunk/referenceGuide/en/images/wsrp/config_refresh.png =================================================================== (Binary files differ) Property changes on: docs/trunk/referenceGuide/en/images/wsrp/config_refresh.png ___________________________________________________________________ Name: svn:mime-type + image/png Added: docs/trunk/referenceGuide/en/images/wsrp/config_usewsdl.png =================================================================== (Binary files differ) Property changes on: docs/trunk/referenceGuide/en/images/wsrp/config_usewsdl.png ___________________________________________________________________ Name: svn:mime-type + image/png Modified: docs/trunk/referenceGuide/en/modules/wsrp.xml =================================================================== --- docs/trunk/referenceGuide/en/modules/wsrp.xml 2007-06-14 21:09:08 UTC (rev 7422) +++ docs/trunk/referenceGuide/en/modules/wsrp.xml 2007-06-14 21:35:25 UTC (rev 7423) @@ -264,15 +264,77 @@ <sect3> <title>Using the configuration portlet</title> - <para>TODO</para> + <para> + As of Portal 2.6, a configuration portlet is provided to configure access to remote WSRP Producers + grahically. You can access it at <literal>http://{hostname}:{port}/portal/auth/portal/admin/WSRP</literal> + or by logging in as a Portal administrator and clicking on the WSRP tab in the Admin portal. If all went + well, you should see something similar to this: + <mediaobject> + <imageobject> + <imagedata fileref="images/wsrp/config_init.png" format="png" align="center" valign="middle"/> + </imageobject> + </mediaobject> + This screen presents all the configured producers associated with their status and possible actions on + them. A Consumer can be active or inactive. Activating a Consumer means that it is ready to act as a + portlet provider. Deactivating it will remove it from the list of available portlet providers. Note also + that a Consumer can be marked as requiring refresh meaning that the information held about it might not + be up to date and refreshing it from the remote Producer might be a good idea. This can happen for + several reasons: the service description for that remote Producer has not been fetched yet, the cached + version has expired or modifications have been made to the configuration that could potentially invalidate + it, thus requiring re-validation of the information. + </para> + + <para> + Next, we create a new Consumer which we will call "bea". Type "bea" in the "Create a consumer named:" + field then click on "Create consumer": + <mediaobject> + <imageobject> + <imagedata fileref="images/wsrp/config_create.png" format="png" align="center" valign="middle"/> + </imageobject> + </mediaobject> + You should now see a form allowing you to enter/modify the information about the Consumer: + <mediaobject> + <imageobject> + <imagedata fileref="images/wsrp/config_created.png" format="png" align="center" valign="middle"/> + </imageobject> + </mediaobject> + Set the cache expiration value to 120 seconds and check the "Use WSDL?" checkbox. The form should now + morph to: + <mediaobject> + <imageobject> + <imagedata fileref="images/wsrp/config_usewsdl.png" format="png" align="center" valign="middle"/> + </imageobject> + </mediaobject> + Enter the WSDL URL for the producer in the text field and press the "Refresh" button. This will retrieve + the service description associated with the Producer which WSRP is described by the WSDL file found at + the URL you just entered. In our case, querying the service description will allow us to learn that the + Producer requires registration and that it expects a value for the registration property named + "registration/consumerRole": + <mediaobject> + <imageobject> + <imagedata fileref="images/wsrp/config_refresh.png" format="png" align="center" valign="middle"/> + </imageobject> + </mediaobject> + <note>At this point, there is no automated way to learn about which possible values (if any) are + expected by the remote Producer. Please refer to the specific Producer's documentation.</note> + Enter "public" as the value for the registration property and press "Refresh" once more. You should now + see something similar to: + <mediaobject> + <imageobject> + <imagedata fileref="images/wsrp/config_end.png" format="png" align="center" valign="middle"/> + </imageobject> + </mediaobject> + The Consumer for the "bea" Producer should now be available as a portlet provider and is ready to be used. + </para> + </sect3> <sect3> <title>Configuring access to a remote portlet</title> <para> - Let's now look at the Admin page and the Management portlet. Click on the "Portlets" link at the top to - manage the portlets. Once this is done, look at the list of available portlet providers. If all went well, - you should see something similar to this: + Let's now look at the Admin page and the Management portlet. Click on the "Portlet definitions" tab at the + top. Once this is done, look at the list of available portlet providers. If all went well, + you should see something similar to this: <mediaobject> <imageobject> <imagedata fileref="images/wsrp/portlets.png" format="png" align="center" valign="middle"/> @@ -284,7 +346,7 @@ "local" portlet provider exposes all the portlets deployed in this particular instance of Portal. As explained above, the "self" provider refers to the default WSRP consumer bundled with Portal that consumes the portlets exposed by the default WSRP producer. The "bea" provider corresponds to BEA's public producer - we just configured. Select it and click on "Change portlet provider". You should now see something similar to: + we just configured. Select it and click on "Change". You should now see something similar to: <mediaobject> <imageobject> <imagedata fileref="images/wsrp/bea.png" format="png" align="center" valign="middle"/>