[jboss-cvs] jboss-portal-docs/referenceGuide/en/modules ...

[Roy Russo]

  User: russo   
  Date: 06/07/13 10:10:37

  Modified:    referenceGuide/en/modules  xmldescriptors.xml
  Log:
  JBPORTAL-950
  
  Revision  Changes    Path
  1.26      +79 -0     jboss-portal-docs/referenceGuide/en/modules/xmldescriptors.xml
  
  (In the diff below, changes in quantity of whitespace are not shown.)
  
  Index: xmldescriptors.xml
  ===================================================================
  RCS file: /cvsroot/jboss/jboss-portal-docs/referenceGuide/en/modules/xmldescriptors.xml,v
  retrieving revision 1.25
  retrieving revision 1.26
  diff -u -b -r1.25 -r1.26
  --- xmldescriptors.xml	12 Jul 2006 18:52:46 -0000	1.25
  +++ xmldescriptors.xml	13 Jul 2006 14:10:37 -0000	1.26
  @@ -473,6 +473,85 @@
         <title>JBoss Portal Descriptors</title>
         <sect2 id="descriptor_ds">
            <title>Datasource Descriptor (portal-*-ds.xml)</title>
  +         <para>JBoss Portal requires a Datasource descriptor to be deployed alongside the
  +            <emphasis>jboss-portal.sar</emphasis>
  +            for access to a database. This section does not explain what a Datasource Descriptor is, but does explain
  +            where to obtain some templates that you can configure for your own installation.
  +            <note>
  +               For an in-depth introduction to datasources, you can view the JBoss AS documentation online
  +               <ulink url="http://wiki.jboss.org/wiki/Wiki.jsp?page=ConfigDataSources">here</ulink>
  +               .
  +            </note>
  +         </para>
  +         <sect3>
  +            <title>Obtaining Datasource Descriptors Binary releases</title>
  +            <para>
  +               Several template datasource descriptors can be found in the binary and bundle distributions. They are
  +               commonly located under the
  +               <emphasis>setup</emphasis>
  +               directory:
  +               <mediaobject>
  +                  <imageobject>
  +                     <imagedata align="center" fileref="images/setup/package.gif"
  +                                valign="middle"/>
  +                  </imageobject>
  +               </mediaobject>
  +               The directory
  +               <emphasis>setup</emphasis>
  +               should contain the following files, that you can customize for your own Database/Connector:
  +               <mediaobject>
  +                  <imageobject>
  +                     <imagedata align="center" fileref="images/setup/dsfiles.gif"
  +                                valign="middle"/>
  +                  </imageobject>
  +               </mediaobject>
  +            </para>
  +         </sect3>
  +         <sect3>
  +            <title>Building Datasource Descriptors from Source</title>
  +            <para>
  +               You will need a valid datasource descriptor, for JBoss Portal to communicate with your database. Having
  +               obtained the sources and having set your JBOSS_HOME environment variable (
  +               <xref linkend="install_source_env"/>
  +               ), you can now have the JBoss Portal build system generate preconfigured datasources for you.
  +            </para>
  +            <para>
  +               Navigate to
  +               <emphasis>JBOSS_PORTAL_HOME_DIRECTORY/core</emphasis>
  +               and type:
  +               <programlisting>build datasource</programlisting>
  +               <mediaobject>
  +                  <imageobject>
  +                     <imagedata align="center" valign="middle" fileref="images/setup/build_ds.gif"/>
  +                  </imageobject>
  +               </mediaobject>
  +            </para>
  +            <para>
  +               Once complete, the datasource build should produce the following directory and file structure:
  +               <mediaobject>
  +                  <imageobject>
  +                     <imagedata align="center" valign="middle" fileref="images/setup/build_ds_dir.gif"/>
  +                  </imageobject>
  +               </mediaobject>
  +            </para>
  +            <para>At this point, you should configure the one that suits you best with your Database and JDBC
  +               driver.
  +               <programlisting><![CDATA[
  +<?xml version="1.0" encoding="UTF-8"?>
  +<datasources>
  +  <local-tx-datasource>
  +    <jndi-name>PortalDS</jndi-name>
  +    <connection-url>jdbc:postgresql:jbossportal</connection-url>
  +    <driver-class>org.postgresql.Driver</driver-class>
  +    <user-name>portal</user-name>
  +    <password>portalpassword</password>
  +  </local-tx-datasource>
  +</datasources>
  +                  ]]></programlisting>
  +               Please verify that the username, password, url, and driver-class are correct for
  +               your flavor of DB.
  +            </para>
  +         </sect3>
         </sect2>
         <sect2 id="descriptor_debug">
            <title>Portlet Debugging (jboss-portal.sar/conf/config.xml)</title>