Author: jaredmorgs Date: 2012-02-29 22:08:43 -0500 (Wed, 29 Feb 2012) New Revision: 8512 Modified: epp/docs/branches/5.2/User_Guide/en-US/Book_Info.xml epp/docs/branches/5.2/User_Guide/en-US/Revision_History.xml epp/docs/branches/5.2/User_Guide/en-US/modules/portal/Manage_Portals.xml epp/docs/branches/5.2/User_Guide/en-US/modules/portal/Toolbar.xml Log: Documented the Services Management interface as part of https://bugzilla.redhat.com/show_bug.cgi?id=794409. Modified: epp/docs/branches/5.2/User_Guide/en-US/Book_Info.xml =================================================================== --- epp/docs/branches/5.2/User_Guide/en-US/Book_Info.xml 2012-03-01 00:15:19 UTC (rev 8511) +++ epp/docs/branches/5.2/User_Guide/en-US/Book_Info.xml 2012-03-01 03:08:43 UTC (rev 8512) @@ -8,7 +8,7 @@ <productname>JBoss Enterprise Portal Platform</productname> <productnumber>5.2</productnumber> <edition>5.2.1</edition> - <pubsnumber>5</pubsnumber> + <pubsnumber>6</pubsnumber> <abstract> <para> This document provides an easy to follow guide to the functions and Modified: epp/docs/branches/5.2/User_Guide/en-US/Revision_History.xml =================================================================== --- epp/docs/branches/5.2/User_Guide/en-US/Revision_History.xml 2012-03-01 00:15:19 UTC (rev 8511) +++ epp/docs/branches/5.2/User_Guide/en-US/Revision_History.xml 2012-03-01 03:08:43 UTC (rev 8512) @@ -8,6 +8,20 @@ <simpara> <revhistory> <revision> + <revnumber>5.2.1-6</revnumber> + <date>Thu Mar 01 2012</date> + <author> + <firstname>Jared</firstname> + <surname>Morgan</surname> + <email/> + </author> + <revdescription> + <simplelist> + <member>Documented the Services Management interface as part of https://bugzilla.redhat.com/show_bug.cgi?id=794409.</member> + </simplelist> + </revdescription> + </revision> + <revision> <revnumber>5.2.1-5</revnumber> <date>Fri Feb 24 2012</date> <author> Modified: epp/docs/branches/5.2/User_Guide/en-US/modules/portal/Manage_Portals.xml =================================================================== --- epp/docs/branches/5.2/User_Guide/en-US/modules/portal/Manage_Portals.xml 2012-03-01 00:15:19 UTC (rev 8511) +++ epp/docs/branches/5.2/User_Guide/en-US/modules/portal/Manage_Portals.xml 2012-03-01 03:08:43 UTC (rev 8512) @@ -247,7 +247,7 @@ </para> </section> <section id="Export_and_Import"> - <title><remark>BZ#794408 NEEDINFO </remark>Export and Import</title> + <title><remark>BZ#794408 </remark>Export and Import</title> <para>You can export and import portals and groups using the controls provided in the <menuchoice> <guimenu>Group</guimenu> <guimenu>Administration</guimenu> @@ -396,6 +396,110 @@ </procedure> </task> </section> + <section id="Services_Management"> + <title><remark>BZ#794409 </remark>Manage Services</title> + <para>Users with administrator privileges can run service methods and properties directly from the portal interface, using the controls provided in the <menuchoice> + <guimenu>Group</guimenu> + <guimenu>Administration</guimenu> + <guimenu>Services Management</guimenu> + </menuchoice> interface. </para> + <para>Services Management presents methods and properties organized by the service class name. Controls in the interface allow users to pass parameters and run commands to call the methods and properties. </para> + <para>Follow <xref linkend="task-Services_Management_Call_Method"/> and <xref linkend="task-Services_Management_Call_Property"/> to learn how to call methods and properties related to the <classname>org.exoplatform.portal.application.PortalStatistic</classname> classname. You can adapt the procedures in these tasks to interact with other methods and properties for other portal classes available in the Services Management interface.</para> + <task id="task-Services_Management_Call_Method"> + <title>Task: Call a Method in the Services Management Interface.</title> + <tasksummary> + <para>Complete this task to call a method using the Services Management interface, which shows the average portal execution time in seconds. </para> + </tasksummary> + <taskprerequisites> + <title>Prerequisites</title> + <itemizedlist> + <listitem> + <para>JBoss Enterprise Portal Platform is running. </para> + </listitem> + <listitem> + <para>You are authenticated with administrator privileges.</para> + </listitem> + </itemizedlist> + </taskprerequisites> + <procedure> + <step> + <para>Click <menuchoice> + <guimenu>Group</guimenu> + <guimenu>Administration</guimenu> + <guimenu>Services Management</guimenu> + </menuchoice></para> + </step> + <step> + <para>In the <guilabel>Services</guilabel> drop-down, select <guimenuitem>portalstatistic</guimenuitem>.</para> + <formalpara> + <title>Result</title> + <para>The available methods are displayed on the Methods tab, including <methodname>getMaxTime</methodname>.</para> + </formalpara> + </step> + <step> + <para>In the <guilabel>Parameters</guilabel> column, type the name of the portal you want to check. For example, if you are running the default portal, type <userinput>classic</userinput>.</para> + </step> + <step> + <para>In the <guilabel>Action</guilabel> column, click <guibutton>Run</guibutton>.</para> + </step> + <step> + <formalpara> + <title>Result</title> + <para>The <methodname>getMaxTime</methodname> method is called, and returns the execution time in the value group, underneath the Method table.</para> + </formalpara> + </step> + </procedure> + </task> + <task id="task-Services_Management_Call_Property"> + <title>Task: Call a Property in the Services Management Interface.</title> + <tasksummary> + <para>Complete this task to call a property using the Services Management interface, which returns the identifiers of all known portals. </para> + </tasksummary> + <taskprerequisites> + <title>Prerequisites</title> + <itemizedlist> + <listitem> + <para>JBoss Enterprise Portal Platform is running. </para> + </listitem> + <listitem> + <para>You are authenticated with administrator privileges.</para> + </listitem> + </itemizedlist> + </taskprerequisites> + <procedure> + <step> + <para>Click <menuchoice> + <guimenu>Group</guimenu> + <guimenu>Administration</guimenu> + <guimenu>Services Management</guimenu> + </menuchoice></para> + </step> + <step> + <para>In the <guilabel>Services</guilabel> drop-down, select <guimenuitem>portalstatistic</guimenuitem>.</para> + <formalpara> + <title>Result</title> + <para>The available methods are displayed on the Methods tab. </para> + </formalpara> + </step> + <step> + <para>Click the Properties tab to display all available properties for the <guimenuitem>portalstatistic</guimenuitem> Service.</para> + <formalpara> + <title>Result</title> + <para>The <property>PortalList</property> property displays. </para> + </formalpara> + </step> + <step> + <para>In the <guilabel>Action</guilabel> column, click <guibutton>Run</guibutton>.</para> + </step> + <step> + <formalpara> + <title>Result</title> + <para>The <methodname>PortalList</methodname> property is called, and returns the name of all known portals, underneath the Properties table.</para> + </formalpara> + </step> + </procedure> + </task> + </section> <section id="proc-User_Guide-Manage_Portals-Edit_Properties"> <title>Edit Properties</title> <para> Modified: epp/docs/branches/5.2/User_Guide/en-US/modules/portal/Toolbar.xml =================================================================== --- epp/docs/branches/5.2/User_Guide/en-US/modules/portal/Toolbar.xml 2012-03-01 00:15:19 UTC (rev 8511) +++ epp/docs/branches/5.2/User_Guide/en-US/modules/portal/Toolbar.xml 2012-03-01 03:08:43 UTC (rev 8512) @@ -1,137 +1,142 @@ -<?xml version='1.0' encoding='utf-8' ?> +<?xml version='1.0' encoding='UTF-8'?> <!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % BOOK_ENTITIES SYSTEM "../../User_Guide.ent"> %BOOK_ENTITIES; ]> <section id="sect-User_Guide-Toolbar"> - <title>Toolbar</title> - <para> - The Toolbar offers a convenient way for users and administrators to execute tasks within the portal quickly and easily. - </para> - <mediaobject> - <imageobject role="html"> - <imagedata fileref="images/Toolbar.png" format="PNG" align="center" scale="100"/> - </imageobject> - <imageobject role="fo"> - <imagedata fileref="images/Toolbar.png" format="PNG" align="center" contentwidth="130mm"/> - </imageobject> - </mediaobject> - <section> - <title>User Actions in the Toolbar</title> - - <variablelist> - <varlistentry> - <term><emphasis role="bold">User Menu</emphasis></term> - <listitem> - <para> - You can use the main menu (located under the product icon) to change the language or skin used in the portal or to sign out. - </para> - <mediaobject> - <imageobject role="html"> - <imagedata fileref="images/StarPortlet.png" format="PNG" align="center" scale="100"/> - </imageobject> - <imageobject role="fo"> - <imagedata fileref="images/StarPortlet.png" format="PNG" align="center" contentwidth="130mm"/> - </imageobject> - </mediaobject> - </listitem> - </varlistentry> - <varlistentry> - <term><emphasis role="bold">Site</emphasis></term> - <listitem> - <para> - The Site navigation function shows the different sites available in this Portal and allows users to directly edit the navigation tree. - </para> - <mediaobject> - <imageobject role="html"> - <imagedata fileref="images/SitePortlet.png" format="PNG" align="center" scale="100"/> - </imageobject> - <imageobject role="fo"> - <imagedata fileref="images/SitePortlet.png" format="PNG" align="center" contentwidth="130mm"/> - </imageobject> - </mediaobject> - </listitem> - </varlistentry> - <varlistentry> - <term><emphasis role="bold">Group</emphasis></term> - <listitem> - <para> - Using the Group navigation function users can easily see and access pages in the Portal. - </para> - <mediaobject> - <imageobject role="html"> - <imagedata fileref="images/GroupPortlet.png" format="PNG" align="center" scale="100"/> - </imageobject> - <imageobject role="fo"> - <imagedata fileref="images/GroupPortlet.png" format="PNG" align="center" contentwidth="130mm" /> - </imageobject> - </mediaobject> - </listitem> - </varlistentry> - <varlistentry> - <term><emphasis role="bold">Dashboard</emphasis></term> - <listitem> - <para> - You can use the Dashboard to create your own pages of gadgets. - </para> - <mediaobject> - <imageobject role="html"> - <imagedata fileref="images/DashboardPortlet.png" format="PNG" align="center" scale="100"/> - </imageobject> - <imageobject role="fo"> - <imagedata fileref="images/DashboardPortlet.png" format="PNG" align="center" contentwidth="130mm"/> - </imageobject> - </mediaobject> - <para> - The name shown in the image above is the default and can easily be over-typed when the Dashboard is open. - </para> - </listitem> - </varlistentry> - </variablelist> - </section> - - <section> - <title>Administration Actions in the Toolbar</title> - <variablelist> - <varlistentry> - <term> <emphasis role="bold">Editor</emphasis></term> - <listitem> - <para> - Portal Administrators have access to another navigation that allows them to; - </para> - <itemizedlist> - <listitem> - <para> + <title>Toolbar</title> + <para> + The Toolbar offers a convenient way for users and administrators to execute tasks within the portal quickly and easily. + </para> + <mediaobject> + <imageobject role="html"> + <imagedata align="center" scale="100" fileref="images/Toolbar.png" format="PNG"/> + </imageobject> + <imageobject role="fo"> + <imagedata contentwidth="130mm" align="center" fileref="images/Toolbar.png" format="PNG"/> + </imageobject> + </mediaobject> + <section> + <title>User Actions in the Toolbar</title> + <variablelist> + <varlistentry> + <term> + <emphasis role="bold">User Menu</emphasis> + </term> + <listitem> + <para> + You can use the main menu (located under the product icon) to change the language or skin used in the portal or to sign out. + </para> + <mediaobject> + <imageobject role="html"> + <imagedata align="center" scale="100" fileref="images/StarPortlet.png" format="PNG"/> + </imageobject> + <imageobject role="fo"> + <imagedata contentwidth="130mm" align="center" fileref="images/StarPortlet.png" format="PNG"/> + </imageobject> + </mediaobject> + </listitem> + </varlistentry> + <varlistentry> + <term> + <emphasis role="bold">Site</emphasis> + </term> + <listitem> + <para> + The Site navigation function shows the different sites available in this Portal and allows users to directly edit the navigation tree. + </para> + <mediaobject> + <imageobject role="html"> + <imagedata align="center" scale="100" fileref="images/SitePortlet.png" format="PNG"/> + </imageobject> + <imageobject role="fo"> + <imagedata contentwidth="130mm" align="center" fileref="images/SitePortlet.png" format="PNG"/> + </imageobject> + </mediaobject> + </listitem> + </varlistentry> + <varlistentry> + <term> + <emphasis role="bold">Group</emphasis> + </term> + <listitem> + <para> + Using the Group navigation function users can easily see and access pages in the Portal. + </para> + <mediaobject> + <imageobject role="html"> + <imagedata align="center" scale="100" fileref="images/GroupPortlet.png" format="PNG"/> + </imageobject> + <imageobject role="fo"> + <imagedata contentwidth="130mm" align="center" fileref="images/GroupPortlet.png" format="PNG"/> + </imageobject> + </mediaobject> + </listitem> + </varlistentry> + <varlistentry> + <term> + <emphasis role="bold">Dashboard</emphasis> + </term> + <listitem> + <para> + You can use the Dashboard to create your own pages of gadgets. + </para> + <mediaobject> + <imageobject role="html"> + <imagedata align="center" scale="100" fileref="images/DashboardPortlet.png" format="PNG"/> + </imageobject> + <imageobject role="fo"> + <imagedata contentwidth="130mm" align="center" fileref="images/DashboardPortlet.png" format="PNG"/> + </imageobject> + </mediaobject> + <para> + The name shown in the image above is the default and can easily be over-typed when the Dashboard is open. + </para> + </listitem> + </varlistentry> + </variablelist> + </section> + <section> + <title>Administration Actions in the Toolbar</title> + <variablelist> + <varlistentry> + <term> + <emphasis role="bold">Editor</emphasis> + </term> + <listitem> + <para> + Portal Administrators have access to another navigation that allows them to: + </para> + <itemizedlist> + <listitem> + <para> Add a new page to the current portal. </para> - </listitem> - <listitem> - <para> - Edit a particular page's properties. + </listitem> + <listitem> + <para> + Edit a particular page&apos;s properties. </para> - </listitem> - <listitem> - <para> - Change a page's layout. + </listitem> + <listitem> + <para> + Change a page&apos;s layout. </para> - </listitem> - </itemizedlist> - <para> - This navigation appears next to the Dashboard navigation in the Toolbar and is contextually-named. It will appear as either <emphasis role="bold">Site Editor</emphasis>, <emphasis role="bold">Dashboard Editor</emphasis> or <emphasis role="bold">Group Editor</emphasis> depending on the user's location within the portal. - </para> - <mediaobject> - <imageobject role="html"> - <imagedata fileref="images/EditorPortlet.png" format="PNG" align="center" scale="90"/> - </imageobject> - <imageobject role="fo"> - <imagedata fileref="images/EditorPortlet.png" format="PNG" align="center" contentwidth="130mm"/> - </imageobject> - </mediaobject> - </listitem> - </varlistentry> - </variablelist> - </section> - + </listitem> + </itemizedlist> + <para> + This navigation appears next to the Dashboard navigation in the Toolbar and is contextually-named. It will appear as either <emphasis role="bold">Site Editor</emphasis>, <emphasis role="bold">Dashboard Editor</emphasis> or <emphasis role="bold">Group Editor</emphasis> depending on the user&apos;s location within the portal. + </para> + <mediaobject> + <imageobject role="html"> + <imagedata align="center" scale="90" fileref="images/EditorPortlet.png" format="PNG"/> + </imageobject> + <imageobject role="fo"> + <imagedata contentwidth="130mm" align="center" fileref="images/EditorPortlet.png" format="PNG"/> + </imageobject> + </mediaobject> + </listitem> + </varlistentry> + </variablelist> + </section> </section> - -