Author: mmcallis
Date: 2008-04-01 23:10:57 -0400 (Tue, 01 Apr 2008)
New Revision: 10470
Modified:
docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/installation.xml
docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/xmldescriptors.xml
Log:
6.3.1.1. Datasource Descriptors included in Binary releases
6.3.1.2. Building Datasource Descriptors from Source
- revising and adding orderedlist
Modified:
docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/installation.xml
===================================================================
---
docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/installation.xml 2008-04-02
02:26:36 UTC (rev 10469)
+++
docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/installation.xml 2008-04-02
03:10:57 UTC (rev 10470)
@@ -115,7 +115,7 @@
</para>
</sect3>
<sect3>
- <title>Datasource Configuration</title>
+ <title>Datasource Descriptors</title>
<para>
The JBoss Portal binary download that was extracted in <xref
linkend="install_binarydownload"/>, contains pre-configured Datasource
descriptors for the more popular databases. Datasource descriptors are provided for the
MySQL 4, MySQL 5, PostgreSQL, Microsoft SQL Server, and Oracle databases, and can be found
in the <filename>setup</filename> subdirectory where the JBoss Portal binary
was extracted to:
</para>
Modified:
docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/xmldescriptors.xml
===================================================================
---
docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/xmldescriptors.xml 2008-04-02
02:26:36 UTC (rev 10469)
+++
docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/xmldescriptors.xml 2008-04-02
03:10:57 UTC (rev 10470)
@@ -1536,38 +1536,34 @@
</sect1>
<sect1 id="portaldescriptors">
<title>JBoss Portal Descriptors</title>
+ <para>
+ This section describes Datasource descriptors, which are required for JBoss Portal
to communicate with a database, and briefly covers the
<filename>jboss-portal.sar/conf/config.xml</filename> descriptor, which can be
used for configuring logging, and configuring which page a user goes to when they log in.
+ </para>
<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"...
- .
- </note>
+ <title>Datasource Descriptors
(<filename>portal-*-ds.xml</filename>)</title>
+ <para>
+ JBoss Portal requires a Datasource descriptor to be deployed alongside the
<filename>jboss-portal.sar</filename>, in order to communicate with a
database. This section explains where to obtain template Datasource descriptors, how to
compile them from source, and how to configure them for your installation. For an in-depth
introduction to datasources, view the JBoss AS documentation online on the <ulink
url="http://wiki.jboss.org/wiki/Wiki.jsp?page=ConfigDataSources"...
Datasource wiki page</ulink>.
</para>
<sect3>
- <title>Obtaining Datasource Descriptors Binary releases</title>
+ <title>Datasource Descriptors included in 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:
+ Several template Datasource descriptors are included in the binary and bundled
distributions of JBoss Portal. They are commonly located within the
<filename>jboss-portal-<replaceable>version</replaceable>/setup/</filename>
directory:
+ </para>
+ <para>
<mediaobject>
<imageobject>
<imagedata align="center"
fileref="images/setup/package.png"
valign="middle"/>
</imageobject>
</mediaobject>
- The directory
- <emphasis>setup</emphasis>
- should contain the following files, that you can customize for your own
Database/Connector:
+ </para>
+ <para>
+ The <filename>setup/</filename> directory contains sample Datasource
descriptors for the MySQL, Microsoft SQL Server, PostgreSQL, and Oracale databases. These
can be customised for your own database:
+ </para>
+ <para>
<mediaobject>
<imageobject>
- <imagedata align="center"
fileref="images/setup/dsfiles.png"
- valign="middle"/>
+ <imagedata align="center"
fileref="images/setup/dsfiles.png" valign="middle"/>
</imageobject>
</mediaobject>
</para>
@@ -1575,26 +1571,55 @@
<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>
+ Before proceeding:
+ </para>
+ <para>
+ <orderedlist>
+ <listitem>
+ <para>
+ Obtain the JBoss Portal source code: <xref linkend="install_source"
/>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Configure the <computeroutput>$JBOSS_HOME</computeroutput>
environment variable: <xref linkend="install_source_env"/>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Change into the
<filename>JBOSS_PORTAL_SOURCE_DIRECTORY/build/</filename> directory. To build
the JBoss Portal source code on Linux, run the <command>./build.sh
deploy</command> command, or, if you are running Microsoft Windows, run the
<command>build.bat deploy</command> command. If this is the first build,
third-party libaries are obtained from an online repository, so you must be connected to
the internet. After building the JBoss Portal source, the
<filename>JBOSS_PORTAL_SOURCE_DIRECTORY/thirdparty/</filename> directory
contains the required files. For further details, refer to <xref
linkend="building_deploying_from_source" />.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Change into the
<filename>JBOSS_PORTAL_SOURCE_DIRECTORY/core/</filename> directory, and run
the <command>sh build.sh datasource</command> command:
+ </para>
+ <para>
+ <mediaobject>
+ <imageobject>
+ <imagedata align="center" valign="middle"
fileref="images/setup/build_ds.png"/>
+ </imageobject>
+ </mediaobject>
+ </para>
+ </listitem>
+ </orderedlist>
+ </para>
+ <para>
+ Note: the <command>sh build.sh datasource</command> command will fail
with an error such as the following if the JBoss Portal source was not built prior to
running the command, as detailed in step 3:
+ </para>
+ <para>
+<screen><![CDATA[
+BUILD FAILED
+java.io.FileNotFoundException:
/jboss-portal-2.6.3.GA-src/core/../thirdparty/libraries.ent
+(No such file or directory)]]>
+</screen>
+ </para>
+ <para>
+ Once complete, the datasource build produces the following directory and file
structure:
+ </para>
+ <para>
<mediaobject>
<imageobject>
- <imagedata align="center" valign="middle"
fileref="images/setup/build_ds.png"/>
- </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.png"/>
</imageobject>
</mediaobject>