[jbpm-commits] JBoss JBPM SVN: r5282 - in jbpm4/branches/jbpm-4.0/modules: userguide/src/main/docbook/en/modules and 1 other directory.
do-not-reply at jboss.org
do-not-reply at jboss.org
Fri Jul 10 05:17:55 EDT 2009
Author: tom.baeyens at jboss.com
Date: 2009-07-10 05:17:55 -0400 (Fri, 10 Jul 2009)
New Revision: 5282
Modified:
jbpm4/branches/jbpm-4.0/modules/devguide/src/main/docbook/en/modules/ch01-Introduction.xml
jbpm4/branches/jbpm-4.0/modules/userguide/src/main/docbook/en/modules/ch02-Installation.xml
Log:
documenting the library dependencies and updated the jbpm-console link in the docs
Modified: jbpm4/branches/jbpm-4.0/modules/devguide/src/main/docbook/en/modules/ch01-Introduction.xml
===================================================================
--- jbpm4/branches/jbpm-4.0/modules/devguide/src/main/docbook/en/modules/ch01-Introduction.xml 2009-07-10 07:51:48 UTC (rev 5281)
+++ jbpm4/branches/jbpm-4.0/modules/devguide/src/main/docbook/en/modules/ch01-Introduction.xml 2009-07-10 09:17:55 UTC (rev 5282)
@@ -45,5 +45,73 @@
<ulink url="http://repository.jboss.com/maven2/org/jbpm/jbpm4/">http://repository.jboss.com/maven2/org/jbpm/jbpm4/</ulink>
</para>
</section>
+
+ <section>
+ <title>Library dependencies</title>
+ <para>If you want to install/deploy jBPM into your own application, this is still as easy
+ as it was before: Just put the right libs in your application classpath. We didn't yet clean
+ up the dependency description in the maven pom files. So we can't yet give the exact
+ minimal set of libraries from the <literal>lib</literal> directory that you need to include
+ in your application. The versions of the libraties that are in the <literal>lib</literal>
+ directory are the ones that we tested with. So we recommend you to use those very versions
+ of the libs. To help you on your way, here's the current maven dependency list for jPDL:
+ </para>
+ <programlisting>[INFO] ------------------------------------------------------------------------
+[INFO] Building jBPM 4 - jPDL
+[INFO] task-segment: [dependency:tree]
+[INFO] ------------------------------------------------------------------------
+[INFO] [dependency:tree]
+[INFO] org.jbpm.jbpm4:jbpm-jpdl:jar:4.0
+[INFO] +- org.jbpm.jbpm4:jbpm-pvm:jar:4.0:compile
+[INFO] | +- org.jbpm.jbpm4:jbpm-api:jar:4.0:compile
+[INFO] | | \- jboss:jboss-j2ee:jar:4.2.2.GA:compile
+[INFO] | +- org.jbpm.jbpm4:jbpm-log:jar:4.0:compile
+[INFO] | +- org.jbpm.jbpm4:jbpm-test-base:jar:4.0:compile
+[INFO] | | \- org.hibernate:hibernate-core:jar:3.3.1.GA:compile
+[INFO] | | +- antlr:antlr:jar:2.7.6:compile
+[INFO] | | \- commons-collections:commons-collections:jar:3.1:compile
+[INFO] | +- org.apache.ant:ant:jar:1.7.0:compile
+[INFO] | | \- org.apache.ant:ant-launcher:jar:1.7.0:compile
+[INFO] | +- log4j:log4j:jar:1.2.14:compile
+[INFO] | +- juel:juel:jar:2.1.0:compile
+[INFO] | +- juel:juel-impl:jar:2.1.0:compile
+[INFO] | +- juel:juel-engine:jar:2.1.0:compile
+[INFO] | +- org.slf4j:slf4j-api:jar:1.5.2:compile
+[INFO] | +- org.slf4j:slf4j-jdk14:jar:1.5.2:compile
+[INFO] | +- org.jboss.identity.idm:idm-core:jar:1.0.0.Beta1:compile
+[INFO] | | +- org.jboss.identity.idm:idm-common:jar:1.0.0.Beta1:compile
+[INFO] | | +- org.jboss.identity.idm:idm-api:jar:1.0.0.Beta1:compile
+[INFO] | | +- org.jboss.identity.idm:idm-spi:jar:1.0.0.Beta1:compile
+[INFO] | | \- com.sun.xml.bind:jaxb-impl:jar:2.1.8:compile
+[INFO] | | \- javax.xml.bind:jaxb-api:jar:2.1:compile
+[INFO] | | \- javax.xml.stream:stax-api:jar:1.0-2:compile
+[INFO] | +- org.jboss.identity.idm:idm-hibernate:jar:1.0.0.Beta1:compile
+[INFO] | | +- javassist:javassist:jar:3.4.GA:compile
+[INFO] | | +- org.hibernate:hibernate-cglib-repack:jar:2.1_3:compile
+[INFO] | | \- org.slf4j:slf4j-log4j12:jar:1.5.2:compile
+[INFO] | +- org.hibernate:hibernate-entitymanager:jar:3.4.0.GA:compile
+[INFO] | | +- org.hibernate:ejb3-persistence:jar:1.0.2.GA:compile
+[INFO] | | +- org.hibernate:hibernate-commons-annotations:jar:3.1.0.GA:compile
+[INFO] | | +- org.hibernate:hibernate-annotations:jar:3.4.0.GA:compile
+[INFO] | | +- dom4j:dom4j:jar:1.6.1:compile
+[INFO] | | | \- xml-apis:xml-apis:jar:1.0.b2:compile
+[INFO] | | \- javax.transaction:jta:jar:1.1:compile
+[INFO] | +- org.livetribe:livetribe-jsr223:jar:2.0.5:compile
+[INFO] | \- javax.mail:mail:jar:1.4.1:compile
+[INFO] | \- javax.activation:activation:jar:1.1:compile
+[INFO] +- junit:junit:jar:3.8.1:compile
+[INFO] \- hsqldb:hsqldb:jar:1.8.0.7:test
+[INFO] ------------------------------------------------------------------------</programlisting>
+ <para>The jboss idm dependencies in sections
+ <literal>org.jboss.identity.idm:*</literal> can be ignored, including the
+ <literal>org.hibernate:hibernate-entitymanager</literal> </para>
+ <para>This list should already get you started to select a small subset of libs instead of
+ including all the libs from the <literal>${jbpm.home}/lib</literal> directory.
+ In one of the next releases, we'll clean up those dependency descriptions in the pom and include
+ a good description of which are the minimal libs to get jBPM up and running inside
+ your own application.
+ </para>
+ </section>
+
</chapter>
Modified: jbpm4/branches/jbpm-4.0/modules/userguide/src/main/docbook/en/modules/ch02-Installation.xml
===================================================================
--- jbpm4/branches/jbpm-4.0/modules/userguide/src/main/docbook/en/modules/ch02-Installation.xml 2009-07-10 07:51:48 UTC (rev 5281)
+++ jbpm4/branches/jbpm-4.0/modules/userguide/src/main/docbook/en/modules/ch02-Installation.xml 2009-07-10 09:17:55 UTC (rev 5282)
@@ -23,7 +23,7 @@
<para>jBPM requires a JDK (standard java) version 5 or higher.
</para>
<ulink url="http://java.sun.com/javase/downloads/index.jsp">http://java.sun.com/javase/downloads/index.jsp</ulink>
- <para>To execute the ant scripts, you'll need apache ant version 1.7.0 or higher:
+ <para>To execute the ant scripts, you'll need apache ant version <emphasis role="bold">1.7.0</emphasis> or higher:
</para>
<ulink url="http://ant.apache.org/bindownload.cgi">http://ant.apache.org/bindownload.cgi</ulink>
</section>
@@ -58,7 +58,7 @@
<para>After this is done JBoss will be running in the background. Once eclipse has started, you can continue
to follow the instructions of <xref linkend="graphicalprocessdesigner" />
</para>
- <para>And you can surf to <ulink url="http://localhost:8080/gwt-console">the jBPM console</ulink>
+ <para>And you can surf to <ulink url="http://localhost:8080/jbpm-console">the jBPM console</ulink>
You can login as one of the following users:
</para>
<table><title>Example console users:</title>
@@ -144,6 +144,15 @@
</para>
</section>
+ <section id="librarydependenciesandconfigurationfiles">
+ <title>Library dependencies and configuration files</title>
+ <para>We provide support for installations of jBPM through our automatic ant
+ scripts. Those scripts will be put the right libs and the right configuration
+ files in the right location for you. If you want to create your own installation of
+ jBPM in your application, see the developers guide for more information.
+ </para>
+ </section>
+
<section id="jboss">
<title>JBoss</title>
<para>The build file <literal>${jbpm.home}/jboss/build.xml</literal> contains scripts for
@@ -155,26 +164,24 @@
</para>
</section>
+ <section id="tomcat">
+ <title>Tomcat</title>
+ <para>ETA for Tomcat is 4.1: <ulink url="https://jira.jboss.org/jira/browse/JBPM-2397">See JBPM-2397</ulink></para>
+ </section>
+
<section id="database">
<title>Database</title>
<para>The build file <literal>${jbpm.home}/db/build.xml</literal> contains scripts for
DB operations like creating and dropping the schema. Navigate to that directory and run <literal>ant -p</literal>
for more details.
</para>
+ <para>To create the schema in your database:</para>
+ <itemizedlist>
+ <listitem>First, update the properties file of your database in <literal>${jbpm.home}/db/jdbc</literal></listitem>
+ <listitem>Then run target <literal>ant create.jbpm.schema</literal> in the db directory</listitem>
+ </itemizedlist>
</section>
- <section id="tomcat">
- <title>Tomcat</title>
- <para>ETA for Tomcat is 4.1: <ulink url="https://jira.jboss.org/jira/browse/JBPM-2397">See JBPM-2397</ulink></para>
- </section>
-
- <section id="configurationfiles">
- <title>Configuration files</title>
- <para>If you're not deploying in JBoss, then the example configuration files
- in the examples <literal>src</literal> are the best starting point.
- </para>
- </section>
-
<section id="graphicalprocessdesigner">
<title>Graphical Process Designer (GPD)</title>
<para>Eclipse is used as the platform to host the jPDL graphical process
More information about the jbpm-commits
mailing list