incubator-hise-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From wi...@apache.org
Subject svn commit: r1150573 - in /incubator/hise/trunk/hise-docs/src/main/resources: developer-guide.xml user-guide.xml
Date Mon, 25 Jul 2011 08:09:11 GMT
Author: witek
Date: Mon Jul 25 08:09:10 2011
New Revision: 1150573

URL: http://svn.apache.org/viewvc?rev=1150573&view=rev
Log:
Updated documentation (thanks to PaweĊ‚ Byszewski)

Modified:
    incubator/hise/trunk/hise-docs/src/main/resources/developer-guide.xml
    incubator/hise/trunk/hise-docs/src/main/resources/user-guide.xml

Modified: incubator/hise/trunk/hise-docs/src/main/resources/developer-guide.xml
URL: http://svn.apache.org/viewvc/incubator/hise/trunk/hise-docs/src/main/resources/developer-guide.xml?rev=1150573&r1=1150572&r2=1150573&view=diff
==============================================================================
--- incubator/hise/trunk/hise-docs/src/main/resources/developer-guide.xml (original)
+++ incubator/hise/trunk/hise-docs/src/main/resources/developer-guide.xml Mon Jul 25 08:09:10
2011
@@ -58,4 +58,77 @@
       </itemizedlist>
    </para>
   </chapter>
+  <chapter>
+    <title>Compiling, Running &amp; Testing under ServiceMix 4</title>
+    <para>
+      A quick introduction to compiling and running HISE under ServiceMix 4. During preparing
this tutorial we use Apache Servicemix 4.2.0-fuse-01-00 and Ubuntu 10.04 LTS.
+      <itemizedlist>
+        <listitem>
+          <para>
+            Execute mvn clean and mvn install in hise directory. If you want to omit unit
tests instead 'mvn install' execute 'mvn install -Dmaven.test.skip'
+          </para>
+        </listitem>
+        <listitem>
+          <para>
+            After that in your local maven repository should be hise dorectory. For example
for latest version :
+            <programlisting>~/.m2/repository/org/apache/hise/hise-karaf/1.0.0-SNAPSHOT/</programlisting>
+
+
+          </para>
+          <para>
+            Run Servicemix and add url to HISE.
+            <programlisting>karaf@root> features:addUrl mvn:org.apache.hise/hise-karaf/1.0.0-SNAPSHOT/xml/features</programlisting>
+            Now check if url wass added properly
+            <programlisting>
+            karaf@root> features:listUrl | grep hise
+            mvn:org.apache.hise/hise-karaf/1.0.0-SNAPSHOT/xml/feature
+            </programlisting>
+            
+          </para>
+        </listitem>
+        <listitem>
+          <para>
+            Check if HISE is available to install
+            <programlisting>
+            karaf@root> features:list | grep hise
+            [uninstalled] [1.0.0-SNAPSHOT      ] hise                                 repo-0
+            [uninstalled] [1.0.0-SNAPSHOT      ] hise-h2                              repo-0
+            [uninstalled] [1.0.0-SNAPSHOT      ] hise-sqlserver                       repo-0
+            [uninstalled] [1.0.0-SNAPSHOT      ] hise-oracle                          repo-0
+            [uninstalled] [1.0.0-SNAPSHOT      ] hise-h2-test-example-osgi            repo-0
+            [uninstalled] [1.0.0-SNAPSHOT      ] hise-sqlserver-test-example-osgi     repo-0
+            </programlisting>
+            
+            Execute <programlisting>karaf@root> features:install hise-h2-test-example-osgi</programlisting>
    
+          </para>
+        
+          <para>
+            After instalation execute again features:list, you should see:
+            <programlisting>
+                karaf@root> features:list | grep hise
+                [installed  ] [1.0.0-SNAPSHOT      ] hise                               
 repo-0
+                [installed  ] [1.0.0-SNAPSHOT      ] hise-h2                            
 repo-0
+                [uninstalled] [1.0.0-SNAPSHOT      ] hise-sqlserver                     
 repo-0
+                [uninstalled] [1.0.0-SNAPSHOT      ] hise-oracle                        
 repo-0
+                [installed  ] [1.0.0-SNAPSHOT      ] hise-h2-test-example-osgi          
 repo-0
+                [uninstalled] [1.0.0-SNAPSHOT      ] hise-sqlserver-test-example-osgi   
 repo-0
+            </programlisting>
+          </para>
+        </listitem>
+        <listitem>
+          <para>
+            Run web browser and open http://localhost:8181/cxf. There are listed services
offered by HISE.
+           </para>
+        </listitem>
+        <listitem>
+            <para>
+                Run soapui 3.5-beta1 and run tests from project hise-web/soapui-tests/hise-soapui-project.xml
+            </para>
+            <para>
+                This will run integration tests for HISE.
+            </para>
+        </listitem>
+      </itemizedlist>
+      </para>
+  </chapter>
 </book>

Modified: incubator/hise/trunk/hise-docs/src/main/resources/user-guide.xml
URL: http://svn.apache.org/viewvc/incubator/hise/trunk/hise-docs/src/main/resources/user-guide.xml?rev=1150573&r1=1150572&r2=1150573&view=diff
==============================================================================
--- incubator/hise/trunk/hise-docs/src/main/resources/user-guide.xml (original)
+++ incubator/hise/trunk/hise-docs/src/main/resources/user-guide.xml Mon Jul 25 08:09:10 2011
@@ -37,7 +37,8 @@ xsi:schemaLocation="http://docbook.org/n
   <index/>
 
   <chapter>
-    <title>Quick Introduction into WAR distibution</title>
+    
+ <title>Quick Introduction into WAR distibution</title>
     <para>
       In order to have something running, you need to do following steps:
       <itemizedlist>
@@ -49,7 +50,7 @@ xsi:schemaLocation="http://docbook.org/n
         </listitem>
         <listitem>
           <para>
-            Copy example files from examples/war/claimsHandling/* into WEB-INF/classes directory.
+            Copy example files from examples/claims-approval/* into WEB-INF/classes directory.
             HISE looks up *-hise-dd.xml files for Human Tasks definitions.  
           </para>
         </listitem>
@@ -77,11 +78,9 @@ xsi:schemaLocation="http://docbook.org/n
             </programlisting>
             addUsers.sql looks like this:
             <programlisting>
-                insert into HISE_ENTITY (name, type, userpassword) values ('user1', 'USER',
'user1pass');
-		insert into HISE_ENTITY (name, type, userpassword) values ('user2', 'USER', 'user2pass');
-		insert into HISE_ENTITY (name, type, userpassword) values ('user3', 'USER', 'user3pass');
-		insert into HISE_ENTITY (name, type, userpassword) values ('group1', 'GROUP', null);
-		insert into HISE_USER_GROUPS (USERGROUPS_NAME, ORGENTITY_NAME) values ('user1', 'group1');
+                insert into HISE_ENTITY (name, type, userpassword) values ('user1', 'USER',
'pass1');
+                insert into HISE_ENTITY (name, type, userpassword) values ('group1', 'GROUP',
null);
+                insert into HISE_USER_GROUPS (USERGROUPS_NAME, ORGENTITY_NAME) values ('user1',
'group1');
             </programlisting>
             This defines Organizational Entities and specifies associations between users
and groups.
           </para>
@@ -105,6 +104,57 @@ xsi:schemaLocation="http://docbook.org/n
         </listitem>
       </itemizedlist>
     </para>
+    <sect1>
+<title>Detail tutorial for Apache Tomcat</title>
+    <para>
+        <itemizedlist>
+            <listitem>
+              <para>Download HISE distribution and Apache Tomcat. This distribution
was tested under Tomcat 5.5 and 7.0</para>
+            </listitem>
+            <listitem>
+              <para>Extract HISE and install Tomcat.
+              <itemizedlist> 
+                <listitem>
+                    <para>The catalog where HISE was extracted in futher part of the
tutorial will be called HISE_DIR</para>
+                </listitem>
+                <listitem>
+                    <para>The catalog of Tomcat instalation in futher part of the tutorial
will be called TOMCAT_DIR</para>
+                </listitem>
+              </itemizedlist>
+              </para>
+           </listitem>
+           <listitem>
+              <para>Copy war file from HISE_DIR to TOMCAT_DIR/webapps. Change name
of the file to hise.war </para>
+           </listitem>
+           <listitem>
+              <para>Start Tomcat. Then on the basis of hise.war will be created directory
TOMCAT_DIR/webapps/hise, and in TOMCAT_DIR/bin will be created files hise-h2-db.*.db for H2
database. After that shutdown Tomcat</para>
+            </listitem>
+            <listitem>
+              <para>You need to import some user and group definitions.By default,
HISE uses H2 file database named hise-h2-db.So you can run addUsers.sql script from HISE distribution,
by following command:
+              <programlisting>
+              java -cp TOMCAT_DIR/webapps/hise/WEB-INF/lib/h2-1.1.108.jar org.h2.tools.RunScript
-url 'jdbc:h2:file:TOMCAT_DIR/bin/hise-h2-db;DB_CLOSE_ON_EXIT=false' -user sa -showResults
-script HISE_DIR/examples/addUsers.sql
+            </programlisting>
+ </para>
+           </listitem>
+           <listitem>
+              <para>Copy files from HISE_DIR/examples/war/claimsHandling/ to TOMCAT_DIR/webapps/hise/WEB-INF/classes
</para>
+           </listitem>
+           <listitem>
+              <para>Copy files from HISE_DIR/examples/war/claimsHandling/ to TOMCAT_DIR/webapps/hise/WEB-INF/classes.</para>
+           </listitem>
+           <listitem>
+              <para>Now you can start Tomcat. If everything is fine at http://localhost:8080/hise
you will see HISE services.</para>
+           </listitem>
+           <listitem>
+              <para>You can import WSDL http://localhost:8080/hise/ClaimsHandlingService/?wsdl
into SoapUI to start interacting with Human Task. There is also a prepared project in HISE_DIR/examples/war/claimsHandling/claimsHandling-soapui-project.xml.
At the first try run prepared test to make certain HISE is working properly.</para>
+           </listitem>
+
+        </itemizedlist>
+    </para>
+
+
+</sect1>
+
   </chapter>
   <chapter>
     <title>Intoduction into OSGi distribution</title>



Mime
View raw message