[gatein-commits] gatein SVN: r5259 - in epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US: modules and 1 other directory.

Author: smumford Date: 2010-11-25 01:16:06 -0500 (Thu, 25 Nov 2010) New Revision: 5259 Added: epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/images/WSRP/export_done.png epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/images/WSRP/export_list.png epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/images/WSRP/export_portlet_list.png epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/images/WSRP/import_modified_page.png epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/images/WSRP/import_original_page.png epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/images/WSRP/import_selected_page.png epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/images/WSRP/import_start.png epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/images/WSRP/import_success.png Modified: epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/WSRP.xml Log: JBEPP-580: WSRP2 content imported from GateIn Reference Guide Added: epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/images/WSRP/export_done.png =================================================================== (Binary files differ) Property changes on: epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/images/WSRP/export_done.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/images/WSRP/export_list.png =================================================================== (Binary files differ) Property changes on: epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/images/WSRP/export_list.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/images/WSRP/export_portlet_list.png =================================================================== (Binary files differ) Property changes on: epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/images/WSRP/export_portlet_list.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/images/WSRP/import_modified_page.png =================================================================== (Binary files differ) Property changes on: epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/images/WSRP/import_modified_page.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/images/WSRP/import_original_page.png =================================================================== (Binary files differ) Property changes on: epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/images/WSRP/import_original_page.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/images/WSRP/import_selected_page.png =================================================================== (Binary files differ) Property changes on: epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/images/WSRP/import_selected_page.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/images/WSRP/import_start.png =================================================================== (Binary files differ) Property changes on: epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/images/WSRP/import_start.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/images/WSRP/import_success.png =================================================================== (Binary files differ) Property changes on: epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/images/WSRP/import_success.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Modified: epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/WSRP.xml =================================================================== --- epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/WSRP.xml 2010-11-25 03:33:55 UTC (rev 5258) +++ epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/WSRP.xml 2010-11-25 06:16:06 UTC (rev 5259) @@ -218,7 +218,7 @@ </para> </note> <para> - &PRODUCT; does <emphasis role="bold">NOT</emphasis>, by default, expose local portlets for consumption by remote WSRP consumers. + &PRODUCT; does <emphasis role="bold">not</emphasis>, by default, expose local portlets for consumption by remote WSRP consumers. </para> <para> In order to make a portlet remotely available, it must be made "remotable" by marking it as such in the associated <filename>portlet.xml</filename>. @@ -277,8 +277,11 @@ &PRODUCT;'s Producer is automatically set up when a portal instance is deployed with the WSRP service. </para> <para> - The WSDL file can be accessed at <filename>http://<replaceable>{hostname}</replaceable>:<replaceable>{port}</replaceable>/wsrp-producer/MarkupService?wsdl</filename>. The default hostname is <literal>localhost</literal> and the default port is <literal>8080</literal>. + The WSDL file can be accessed at <filename>http://<replaceable>{hostname}</replaceable>:<replaceable>{port}</replaceable>/wsrp-producer/<replaceable>&lt;VERSION&gt;</replaceable>/MarkupService?wsdl</filename> (replace &lt;VERSION&gt; with either <emphasis>v1</emphasis> or <emphasis>v2</emphasis>, depending on which version of WSRP you are using). </para> + <para> + The default hostname is <literal>localhost</literal> and the default port is <literal>8080</literal>. + </para> </section> @@ -323,15 +326,11 @@ <para> &PRODUCT; provides a graphical portlet to assist with configuring access to, and other facets of, remote WSRP Producers. </para> - <para> - The Configuration Portlet is available at: <ulink type="http" url="http://localhost:8080/portal/login?initialURI=%2Fportal%2Fprivate%2Fclassic%2FwsrpConfiguration&amp;username=root&amp;password=gtn"></ulink> - </para> <!--DOC NOTE: Branching issue --> -<!--Removed for 5.1 Allianz Beta Release (not required and still formalising branching concerns) - <important> + <important> <title>Important: Version-specific Information</title> <para> - <emphasis role="bold">The implementation of this portlet has changed between the &PRODUCT; 5.0 and &PRODUCT; 5.1 releases:</emphasis> + <emphasis role="bold">The implementation of this portlet has changed between the &PRODUCT; 5.0 (WSRP 1.0) and &PRODUCT; 5.1 (WSRP 2.0) releases:</emphasis> </para> <formalpara id="form-Reference_Guide-Configuring_a_Remote_Producer-The_Configuration_Portlet-5.1_Accessing"> <title><emphasis role="bold">EPP 5.1: Accessing the Configuration Portlet</emphasis></title> @@ -363,7 +362,7 @@ </para> </step> </procedure> - </important>--> + </important> @@ -511,7 +510,6 @@ </note> </section> - <section id="sect-Reference_Guide-Configuring_a_Remote_Producer-Configuring_Access_to_a_Remote_Portlet"> <title>Configuring Access to a Remote Portlet</title> <para> @@ -609,7 +607,7 @@ The rate at which the information is refreshed is defined by the <literal>expiration-cache</literal> attribute of the <literal>&#60;wsrp-producer&#62;</literal> element (in seconds). </para> <para> - For example; providing a value of 120 for expiration-cache means that the producer information will not be refreshed for 2 minutes after it has been accessed. If no value is provided, &PRODUCT; will always access the remote producer regardless of whether the remote information has changed or not. + For example; providing a value of <literal>120</literal> for expiration-cache means that the producer information will not be refreshed for 2 minutes after it has been accessed. If no value is provided, &PRODUCT; will always access the remote producer regardless of whether the remote information has changed or not. </para> <para> Since, in most instances, the information provided by the producer does not change often, use of this caching facility to minimize bandwidth usage is recommended. @@ -864,7 +862,7 @@ </varlistentry> </variablelist> <formalpara> - <title><emphasis role="bold">&PRODUCT; 5.1: Additional Functionalities in WSRP 2.0</emphasis></title> + <title><emphasis role="bold">EPP 5.1: Additional Functionalities in WSRP 2.0</emphasis></title> <para> In addition to those listed above, the WSRP 2.0 implementation in &PRODUCT; 5.1 also includes the following functions: </para> @@ -902,15 +900,188 @@ <para> The import/export implementation in &PRODUCT; allows users to export portlets from a given consumer and then import them back to replace existing portlets assigned to windows on pages by the previously exported portlets. </para> - <!--<note> - <title><emphasis role="bold">DOC TODO</emphasis></title> - <para> - Walk-through exporting portlets and then importing them. - </para> - </note>--> + <procedure> + <title></title> + <step> + <para> + Click on the "<guilabel>Export</guilabel>" action for a given consumer to display the list of portlets currently made available by this specific consumer. An example list is shown below: + </para> + <mediaobject> + <imageobject role="html"> + <imagedata fileref="images/WSRP/export_portlet_list.png" format="PNG" align="center" scale="95" /> + </imageobject> + <imageobject role="fo"> + <imagedata fileref="images/WSRP/export_portlet_list.png" format="PNG" align="center" contentwidth="150mm" /> + </imageobject> + </mediaobject> + </step> + <step> + <para> + Once portlets have been selected, they can be exported by clicking on the "<guilabel>Export</guilabel>" button. This makes them available for later import: + </para> + <mediaobject> + <imageobject role="html"> + <imagedata fileref="images/WSRP/export_done.png" format="PNG" align="center" scale="95" /> + </imageobject> + <imageobject role="fo"> + <imagedata fileref="images/WSRP/export_done.png" format="PNG" align="center" contentwidth="150mm" /> + </imageobject> + </mediaobject> + </step> + <step> + <para> + The portlets can be re-imported directly by pressing the "<guilabel>Use for import</guilabel>" button or, on the Consumers list page, using the "<guilabel>Import</guilabel>" action for a given consumer. + </para> + <para> + The example below assumes that the second option has been used and that several sets of previously exported portlets are available to import from. After clicking the action link, a screen similar to the one below shoould appear: + </para> + <mediaobject> + <imageobject role="html"> + <imagedata fileref="images/WSRP/export_list.png" format="PNG" align="center" scale="95" /> + </imageobject> + <imageobject role="fo"> + <imagedata fileref="images/WSRP/export_list.png" format="PNG" align="center" contentwidth="150mm" /> + </imageobject> + </mediaobject> + <para> + This screen presents the list of available exports with available operations for each. + </para> + <variablelist> + <title>View</title> + <varlistentry> + <term></term> + <listitem> + <para> + Displays the export details as previously seen when the export was first performed. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Delete</term> + <listitem> + <para> + Deletes the selected export, asking you for confirmation first. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Use for import</term> + <listitem> + <para> + Selects the export to import portlets from. + </para> + </listitem> + </varlistentry> + </variablelist> + </step> + <step> + <para> + Once you have selected an export to import from, you will see a screen similar to the one below: + </para> + <mediaobject> + <imageobject role="html"> + <imagedata fileref="images/WSRP/import_start.png" format="PNG" align="center" scale="95" /> + </imageobject> + <imageobject role="fo"> + <imagedata fileref="images/WSRP/import_start.png" format="PNG" align="center" contentwidth="150mm" /> + </imageobject> + </mediaobject> + <para> + The screen displays the list of available exported portlets for the previously selected export. You can select which portlet you want to import by checking the checkbox next to its name. + </para> + </step> + <step> + <para> + Select the content of which window the imported portlet will replace. This process is done in three steps: + </para> + <para> + This example assumes that you have the following page called <literal>page1</literal> which contains two windows called <literal>NetUnity WSRP 2 Interop - Cache Markup (remote)</literal> and <literal>/samples-remotecontroller-portlet.RemoteControl (remote)</literal>, as shown below: + </para> + <mediaobject> + <imageobject role="html"> + <imagedata fileref="images/WSRP/import_original_page.png" format="PNG" align="center" scale="95" /> + </imageobject> + <imageobject role="fo"> + <imagedata fileref="images/WSRP/import_original_page.png" format="PNG" align="center" contentwidth="150mm" /> + </imageobject> + </mediaobject> + <para> + In this example, we want to replace the content of the <literal>/samples-remotecontroller-portlet.RemoteControl (remote)</literal> with the content of the <literal>/ajaxPortlet.JSFAJAXPortlet</literal> portlet that we previously exported. + </para> + <procedure> + <title></title> + <step> + <para> + Check the box next to the <literal>/ajaxPortlet.JSFAJAXPortlet</literal> portlet name to indicate that you want to import its data. + </para> + </step> + <step> + <para> + Select <literal>page1</literal> in the list of available pages. The screen will then refresh to display the list of available windows on that page, similar to the one seen below: + </para> + <mediaobject> + <imageobject role="html"> + <imagedata fileref="images/WSRP/import_selected_page.png" format="PNG" align="center" scale="95" /> + </imageobject> + <imageobject role="fo"> + <imagedata fileref="images/WSRP/import_selected_page.png" format="PNG" align="center" contentwidth="150mm" /> + </imageobject> + </mediaobject> + <note> + <title></title> + <para> + At this point, you still need to select the window which content we want to replace before being able to complete the import operation + </para> + </note> + </step> + <step> + <para> + Select the <literal>/samples-remotecontroller-portlet.RemoteControl (remote)</literal> window, which enables the "<guilabel>Import</guilabel>" button. This indicates that all the necessary data to perform the import is available. + </para> + </step> + <step> + <para> + Click the "<guilabel>Import</guilabel>" button. A screen similar to the one below will appear: + </para> + <mediaobject> + <imageobject role="html"> + <imagedata fileref="images/WSRP/import_success.png" format="PNG" align="center" scale="95" /> + </imageobject> + <imageobject role="fo"> + <imagedata fileref="images/WSRP/import_success.png" format="PNG" align="center" contentwidth="150mm" /> + </imageobject> + </mediaobject> + </step> + </procedure> + </step> + <step> + <para> + The <literal>page1</literal> page should now show: + </para> + <itemizedlist> + <listitem> + <para> + That the content of <literal>/samples-remotecontroller-portlet.RemoteControl (remote)</literal> window has been replaced by the content of the <literal>/ajaxPortlet.JSFAJAXPortlet</literal> imported portlet. + </para> + </listitem> + <listitem> + <para> + The window has been renamed appropriately: + </para> + </listitem> + </itemizedlist> + <mediaobject> + <imageobject role="html"> + <imagedata fileref="images/WSRP/import_modified_page.png" format="PNG" align="center" scale="95" /> + </imageobject> + <imageobject role="fo"> + <imagedata fileref="images/WSRP/import_modified_page.png" format="PNG" align="center" contentwidth="150mm" /> + </imageobject> + </mediaobject> + </step> + </procedure> </section> </section> - <section id="sect-Reference_Guide-Consumers_Maintenance-Erasing_Local_Registration_Data"> <title>Erasing Local Registration Data</title> @@ -999,6 +1170,8 @@ <para> The full service description includes which <classname>RegistrationPolicy</classname> (and <classname>RegistrationPropertyValidator</classname> if needed) to use, as well as required registration property descriptions for which consumers must provide acceptable values to successfully register. </para> + <para> + WSDL URLs to access &PRODUCT_NAME;'s WSRP producer are now displayed in either in WSRP 1 or WSRP 2 mode.</para> </section>