You are viewing a plain text version of this content. The canonical link for it is here.
Posted to hise-commits@incubator.apache.org by rr...@apache.org on 2010/01/28 15:21:16 UTC
svn commit: r904124 - in /incubator/hise/site:
author/src/documentation/content/xdocs/developer-guide.xhtml
author/src/documentation/content/xdocs/user-guide.xhtml
publish/developer-guide.xhtml publish/user-guide.xhtml
Author: rr
Date: Thu Jan 28 15:21:15 2010
New Revision: 904124
URL: http://svn.apache.org/viewvc?rev=904124&view=rev
Log:
Guides update
Modified:
incubator/hise/site/author/src/documentation/content/xdocs/developer-guide.xhtml
incubator/hise/site/author/src/documentation/content/xdocs/user-guide.xhtml
incubator/hise/site/publish/developer-guide.xhtml
incubator/hise/site/publish/user-guide.xhtml
Modified: incubator/hise/site/author/src/documentation/content/xdocs/developer-guide.xhtml
URL: http://svn.apache.org/viewvc/incubator/hise/site/author/src/documentation/content/xdocs/developer-guide.xhtml?rev=904124&r1=904123&r2=904124&view=diff
==============================================================================
--- incubator/hise/site/author/src/documentation/content/xdocs/developer-guide.xhtml (original)
+++ incubator/hise/site/author/src/documentation/content/xdocs/developer-guide.xhtml Thu Jan 28 15:21:15 2010
@@ -1,24 +1,26 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Apache HISE Developer Guide</title><meta name="generator" content="DocBook XSL Stylesheets V1.75.2" /></head><body><div class="book" title="Apache HISE Developer Guide"><div class="titlepage"><div><div><h1 class="title"><a id="id3682160"></a>Apache HISE Developer Guide</h1></div><div><p class="releaseinfo">0.1.0-SNAPSHOT</p></div></div><hr /></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="index"><a href="#id3682208">Index</a></span></dt><dt><span class="chapter"><a href="#id3682242">1. Compiling, Running & Testing</a></span></dt></dl></div><div class="index" title="Index"><div class="titlepage"><div><div><h2 class="title"><a id="id3682208"></a>Index</h2></div></div></div><div class="index"></div></div><div class="chapter" title="Chapter 1. Compiling, Running & Testing"><div class="titlepage"><div><div><h2 class=
"title"><a id="id3682242"></a>Chapter 1. Compiling, Running & Testing</h2></div></div></div><p>
+<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Apache HISE Developer Guide</title><meta name="generator" content="DocBook XSL Stylesheets V1.75.2" /></head><body><div class="book" title="Apache HISE Developer Guide"><div class="titlepage"><div><div><h1 class="title"><a id="id3790226"></a>Apache HISE Developer Guide</h1></div><div><p class="releaseinfo">0.1.0-SNAPSHOT</p></div></div><hr /></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="index"><a href="#id3790274">Index</a></span></dt><dt><span class="chapter"><a href="#id3790308">1. Compiling, Running & Testing</a></span></dt></dl></div><div class="index" title="Index"><div class="titlepage"><div><div><h2 class="title"><a id="id3790274"></a>Index</h2></div></div></div><div class="index"></div></div><div class="chapter" title="Chapter 1. Compiling, Running & Testing"><div class="titlepage"><div><div><h2 class=
"title"><a id="id3790308"></a>Chapter 1. Compiling, Running & Testing</h2></div></div></div><p>
A quick introduction to compiling and running:
</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>
- install oracle XE and create hise user with hise password (easiest way is via http://localhost:8980/apex/apex)
+ Execute mvn install in hise directory
</p></li><li class="listitem"><p>
- mvn clean install
- </p></li><li class="listitem"><p>
- enter hise-web, run mvn jetty:run, enter http://localhost:8080/ - it will show published WS Services and operations
+ enter hise-web, run mvn jetty:run and enter http://localhost:8080/ - it will show published WS Services and operations.
+ </p><p>
+ This will deploy hise-test-example project and start HISE on Jetty.
</p></li><li class="listitem"><p>
run soapui 3.5-beta1 and run tests from project hise-web/soapui-tests/hise-soapui-project.xml
+ </p><p>
+ This will run integration tests for HISE.
</p></li></ul></div><p>
- Each time you do mvn jetty:run, whole DB is erased.
+ Each time you do mvn jetty:run, a whole DB is erased.
+ Additionally, for tests, there is exposed cleanup POJO Web Service, which cleans up DB Tables.
</p><p>
- I prefer to use default configuration as Oracle instead of in memory
- DB, because it's better for monitoring and shows more errors.
- On Debian like systems, you can easily install oracle-xe package.
- But you can modify data source in /hise-test-example/src/main/resources/hise-ds.xml.
- There exists a configuration for H2 Database, which is commented out.
+ By default, HISE integration tests are run using H2 Database.
+ This can be changed, for example to Oracle, by commenting out
+ ojdbc deps in hise-web/pom.xml and Oracle datasource in
+ hise-web/src/test/resources/hise-ds.xml.
</p><p>
HISE has two types of tests:
</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>
Modified: incubator/hise/site/author/src/documentation/content/xdocs/user-guide.xhtml
URL: http://svn.apache.org/viewvc/incubator/hise/site/author/src/documentation/content/xdocs/user-guide.xhtml?rev=904124&r1=904123&r2=904124&view=diff
==============================================================================
--- incubator/hise/site/author/src/documentation/content/xdocs/user-guide.xhtml (original)
+++ incubator/hise/site/author/src/documentation/content/xdocs/user-guide.xhtml Thu Jan 28 15:21:15 2010
@@ -1,8 +1,41 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Apache HISE User Guide</title><meta name="generator" content="DocBook XSL Stylesheets V1.75.2" /></head><body><div class="book" title="Apache HISE User Guide"><div class="titlepage"><div><div><h1 class="title"><a id="id3721373"></a>Apache HISE User Guide</h1></div><div><p class="releaseinfo">0.1.0-SNAPSHOT</p></div></div><hr /></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="index"><a href="#id3721421">Index</a></span></dt><dt><span class="chapter"><a href="#id3721454">1. Quick Introduction</a></span></dt></dl></div><div class="index" title="Index"><div class="titlepage"><div><div><h2 class="title"><a id="id3721421"></a>Index</h2></div></div></div><div class="index"></div></div><div class="chapter" title="Chapter 1. Quick Introduction"><div class="titlepage"><div><div><h2 class="title"><a id="id3721454"></a>Chapter 1.
 Quick Introduction</h2></div></div></div><p>
- In order to have something running, you need to do following steps:
- </p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>Download HISE distribution</p></li><li class="listitem"><p>Then you need to unzip HISE WAR contents into your application server directory (like Apache Tomcat). Name it hise.</p></li><li class="listitem"><p>Copy example files from examples/claims-approval into WEB-INF directory</p></li><li class="listitem"><p>Start your application server</p></li><li class="listitem"><p>Enter hise URL into your browser. For Tomcat, this will be http://localhost:8080/hise.
- There will be a list of services exposed by HISE. It will contain approve operation from example task.
- </p></li></ul></div><p>
+<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Apache HISE User Guide</title><meta name="generator" content="DocBook XSL Stylesheets V1.75.2" /></head><body><div class="book" title="Apache HISE User Guide"><div class="titlepage"><div><div><h1 class="title"><a id="id3538923"></a>Apache HISE User Guide</h1></div><div><p class="releaseinfo">0.1.0-SNAPSHOT</p></div></div><hr /></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="index"><a href="#id3538971">Index</a></span></dt><dt><span class="chapter"><a href="#id3539004">1. Quick Introduction</a></span></dt></dl></div><div class="index" title="Index"><div class="titlepage"><div><div><h2 class="title"><a id="id3538971"></a>Index</h2></div></div></div><div class="index"></div></div><div class="chapter" title="Chapter 1. Quick Introduction"><div class="titlepage"><div><div><h2 class="title"><a id="id3539004"></a>Chapter 1.
 Quick Introduction</h2></div></div></div><p>
+ In order to have something running, you need to do following steps:
+ </p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>Download HISE distribution</p></li><li class="listitem"><p>Then you need to unzip HISE WAR contents into your application server directory (like Apache Tomcat). Name it hise.</p></li><li class="listitem"><p>
+ Copy example files from examples/claims-approval/* into WEB-INF/classes directory.
+ HISE looks up *-hise-dd.xml files for Human Tasks definitions.
+ </p></li><li class="listitem"><p>Start your application server. This will create H2 database schema in files hise-h2-db.*.db. </p></li><li class="listitem"><p>Enter hise URL into your browser. For Tomcat, this will be http://localhost:8080/hise.
+ There will be a list of services exposed by HISE. It will contain approve operation from example task.
+ </p></li><li class="listitem"><p>
+ 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 examples/claimsHandling/claimsHandling-soapui-project.xml.
+ </p></li><li class="listitem"><p>
+ 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:
+ </p><pre class="programlisting">
+ java -cp webapps/hise/WEB-INF/lib/h2-1.1.108.jar org.h2.tools.RunScript -url 'jdbc:h2:file:hise-h2-db;DB_CLOSE_ON_EXIT=false' -user sa -showResults -script addUsers.sql
+ </pre><p>
+ addUsers.sql looks like this:
+ </p><pre class="programlisting">
+ insert into ORG_ENTITY (name, type, userpassword) values ('user1', 'USER', 'pass1');
+ insert into ORG_ENTITY (name, type, userpassword) values ('group1', 'GROUP', null);
+ insert into USER_GROUPS (USERGROUPS_NAME, ORGENTITY_NAME) values ('user1', 'group1');
+ </pre><p>
+ This defines Organizational Entities and specifies associations between users and groups.
+ </p></li><li class="listitem"><p>
+ Next, you need to enter claimsHandling-soapui-project.xml and start Resolving Mock Service
+ and run ClaimsHandling test suite.
+ This will register a claim by sending approve operation and send back response to Mock Service on complete.
+ </p><p>
+ Note that approve operation is meant to be sent by external system to HISE deployed Human Task.
+ This differs from TaskOperations Web Service, which is meant to be used by Task Operator.
+ TaskOperations operations require operator's authentication via WS Security.
+ So in SoapUI operators need to fill fields like "user", "password", "password type" (digest or plain text).
+ When operator completes or fails a task, HISE sends response to external system.
+ This yields to receiving a request in Resolving MockService in SoapUI.
+ Additionally, when WS Addressing reply-to field is specified in approve request,
+ HISE will send reply on task completion to a specified address.
+ </p></li></ul></div><p>
</p></div></div></body></html>
Modified: incubator/hise/site/publish/developer-guide.xhtml
URL: http://svn.apache.org/viewvc/incubator/hise/site/publish/developer-guide.xhtml?rev=904124&r1=904123&r2=904124&view=diff
==============================================================================
--- incubator/hise/site/publish/developer-guide.xhtml (original)
+++ incubator/hise/site/publish/developer-guide.xhtml Thu Jan 28 15:21:15 2010
@@ -1,24 +1,26 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Apache HISE Developer Guide</title><meta name="generator" content="DocBook XSL Stylesheets V1.75.2" /></head><body><div class="book" title="Apache HISE Developer Guide"><div class="titlepage"><div><div><h1 class="title"><a id="id3682160"></a>Apache HISE Developer Guide</h1></div><div><p class="releaseinfo">0.1.0-SNAPSHOT</p></div></div><hr /></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="index"><a href="#id3682208">Index</a></span></dt><dt><span class="chapter"><a href="#id3682242">1. Compiling, Running & Testing</a></span></dt></dl></div><div class="index" title="Index"><div class="titlepage"><div><div><h2 class="title"><a id="id3682208"></a>Index</h2></div></div></div><div class="index"></div></div><div class="chapter" title="Chapter 1. Compiling, Running & Testing"><div class="titlepage"><div><div><h2 class=
"title"><a id="id3682242"></a>Chapter 1. Compiling, Running & Testing</h2></div></div></div><p>
+<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Apache HISE Developer Guide</title><meta name="generator" content="DocBook XSL Stylesheets V1.75.2" /></head><body><div class="book" title="Apache HISE Developer Guide"><div class="titlepage"><div><div><h1 class="title"><a id="id3790226"></a>Apache HISE Developer Guide</h1></div><div><p class="releaseinfo">0.1.0-SNAPSHOT</p></div></div><hr /></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="index"><a href="#id3790274">Index</a></span></dt><dt><span class="chapter"><a href="#id3790308">1. Compiling, Running & Testing</a></span></dt></dl></div><div class="index" title="Index"><div class="titlepage"><div><div><h2 class="title"><a id="id3790274"></a>Index</h2></div></div></div><div class="index"></div></div><div class="chapter" title="Chapter 1. Compiling, Running & Testing"><div class="titlepage"><div><div><h2 class=
"title"><a id="id3790308"></a>Chapter 1. Compiling, Running & Testing</h2></div></div></div><p>
A quick introduction to compiling and running:
</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>
- install oracle XE and create hise user with hise password (easiest way is via http://localhost:8980/apex/apex)
+ Execute mvn install in hise directory
</p></li><li class="listitem"><p>
- mvn clean install
- </p></li><li class="listitem"><p>
- enter hise-web, run mvn jetty:run, enter http://localhost:8080/ - it will show published WS Services and operations
+ enter hise-web, run mvn jetty:run and enter http://localhost:8080/ - it will show published WS Services and operations.
+ </p><p>
+ This will deploy hise-test-example project and start HISE on Jetty.
</p></li><li class="listitem"><p>
run soapui 3.5-beta1 and run tests from project hise-web/soapui-tests/hise-soapui-project.xml
+ </p><p>
+ This will run integration tests for HISE.
</p></li></ul></div><p>
- Each time you do mvn jetty:run, whole DB is erased.
+ Each time you do mvn jetty:run, a whole DB is erased.
+ Additionally, for tests, there is exposed cleanup POJO Web Service, which cleans up DB Tables.
</p><p>
- I prefer to use default configuration as Oracle instead of in memory
- DB, because it's better for monitoring and shows more errors.
- On Debian like systems, you can easily install oracle-xe package.
- But you can modify data source in /hise-test-example/src/main/resources/hise-ds.xml.
- There exists a configuration for H2 Database, which is commented out.
+ By default, HISE integration tests are run using H2 Database.
+ This can be changed, for example to Oracle, by commenting out
+ ojdbc deps in hise-web/pom.xml and Oracle datasource in
+ hise-web/src/test/resources/hise-ds.xml.
</p><p>
HISE has two types of tests:
</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>
Modified: incubator/hise/site/publish/user-guide.xhtml
URL: http://svn.apache.org/viewvc/incubator/hise/site/publish/user-guide.xhtml?rev=904124&r1=904123&r2=904124&view=diff
==============================================================================
--- incubator/hise/site/publish/user-guide.xhtml (original)
+++ incubator/hise/site/publish/user-guide.xhtml Thu Jan 28 15:21:15 2010
@@ -1,8 +1,41 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Apache HISE User Guide</title><meta name="generator" content="DocBook XSL Stylesheets V1.75.2" /></head><body><div class="book" title="Apache HISE User Guide"><div class="titlepage"><div><div><h1 class="title"><a id="id3721373"></a>Apache HISE User Guide</h1></div><div><p class="releaseinfo">0.1.0-SNAPSHOT</p></div></div><hr /></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="index"><a href="#id3721421">Index</a></span></dt><dt><span class="chapter"><a href="#id3721454">1. Quick Introduction</a></span></dt></dl></div><div class="index" title="Index"><div class="titlepage"><div><div><h2 class="title"><a id="id3721421"></a>Index</h2></div></div></div><div class="index"></div></div><div class="chapter" title="Chapter 1. Quick Introduction"><div class="titlepage"><div><div><h2 class="title"><a id="id3721454"></a>Chapter 1.
 Quick Introduction</h2></div></div></div><p>
- In order to have something running, you need to do following steps:
- </p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>Download HISE distribution</p></li><li class="listitem"><p>Then you need to unzip HISE WAR contents into your application server directory (like Apache Tomcat). Name it hise.</p></li><li class="listitem"><p>Copy example files from examples/claims-approval into WEB-INF directory</p></li><li class="listitem"><p>Start your application server</p></li><li class="listitem"><p>Enter hise URL into your browser. For Tomcat, this will be http://localhost:8080/hise.
- There will be a list of services exposed by HISE. It will contain approve operation from example task.
- </p></li></ul></div><p>
+<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Apache HISE User Guide</title><meta name="generator" content="DocBook XSL Stylesheets V1.75.2" /></head><body><div class="book" title="Apache HISE User Guide"><div class="titlepage"><div><div><h1 class="title"><a id="id3538923"></a>Apache HISE User Guide</h1></div><div><p class="releaseinfo">0.1.0-SNAPSHOT</p></div></div><hr /></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="index"><a href="#id3538971">Index</a></span></dt><dt><span class="chapter"><a href="#id3539004">1. Quick Introduction</a></span></dt></dl></div><div class="index" title="Index"><div class="titlepage"><div><div><h2 class="title"><a id="id3538971"></a>Index</h2></div></div></div><div class="index"></div></div><div class="chapter" title="Chapter 1. Quick Introduction"><div class="titlepage"><div><div><h2 class="title"><a id="id3539004"></a>Chapter 1.
 Quick Introduction</h2></div></div></div><p>
+ In order to have something running, you need to do following steps:
+ </p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>Download HISE distribution</p></li><li class="listitem"><p>Then you need to unzip HISE WAR contents into your application server directory (like Apache Tomcat). Name it hise.</p></li><li class="listitem"><p>
+ Copy example files from examples/claims-approval/* into WEB-INF/classes directory.
+ HISE looks up *-hise-dd.xml files for Human Tasks definitions.
+ </p></li><li class="listitem"><p>Start your application server. This will create H2 database schema in files hise-h2-db.*.db. </p></li><li class="listitem"><p>Enter hise URL into your browser. For Tomcat, this will be http://localhost:8080/hise.
+ There will be a list of services exposed by HISE. It will contain approve operation from example task.
+ </p></li><li class="listitem"><p>
+ 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 examples/claimsHandling/claimsHandling-soapui-project.xml.
+ </p></li><li class="listitem"><p>
+ 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:
+ </p><pre class="programlisting">
+ java -cp webapps/hise/WEB-INF/lib/h2-1.1.108.jar org.h2.tools.RunScript -url 'jdbc:h2:file:hise-h2-db;DB_CLOSE_ON_EXIT=false' -user sa -showResults -script addUsers.sql
+ </pre><p>
+ addUsers.sql looks like this:
+ </p><pre class="programlisting">
+ insert into ORG_ENTITY (name, type, userpassword) values ('user1', 'USER', 'pass1');
+ insert into ORG_ENTITY (name, type, userpassword) values ('group1', 'GROUP', null);
+ insert into USER_GROUPS (USERGROUPS_NAME, ORGENTITY_NAME) values ('user1', 'group1');
+ </pre><p>
+ This defines Organizational Entities and specifies associations between users and groups.
+ </p></li><li class="listitem"><p>
+ Next, you need to enter claimsHandling-soapui-project.xml and start Resolving Mock Service
+ and run ClaimsHandling test suite.
+ This will register a claim by sending approve operation and send back response to Mock Service on complete.
+ </p><p>
+ Note that approve operation is meant to be sent by external system to HISE deployed Human Task.
+ This differs from TaskOperations Web Service, which is meant to be used by Task Operator.
+ TaskOperations operations require operator's authentication via WS Security.
+ So in SoapUI operators need to fill fields like "user", "password", "password type" (digest or plain text).
+ When operator completes or fails a task, HISE sends response to external system.
+ This yields to receiving a request in Resolving MockService in SoapUI.
+ Additionally, when WS Addressing reply-to field is specified in approve request,
+ HISE will send reply on task completion to a specified address.
+ </p></li></ul></div><p>
</p></div></div></body></html>