Author: objectiser
Date: 2011-04-04 10:31:39 -0400 (Mon, 04 Apr 2011)
New Revision: 1350
Modified:
trunk/samples/quickstart/management/readme.txt
Log:
Minor changes to the readme.
Modified: trunk/samples/quickstart/management/readme.txt
===================================================================
--- trunk/samples/quickstart/management/readme.txt 2011-04-04 13:53:06 UTC (rev 1349)
+++ trunk/samples/quickstart/management/readme.txt 2011-04-04 14:31:39 UTC (rev 1350)
@@ -1,37 +1,39 @@
Quickstart Examples - Management
-===================================
+================================
-This is a simple example to demonstrate our management APIs that are exposed as Restful
services.
+This is a simple example to demonstrate the management APIs that are exposed as RESTful
services.
-To run this example with best output is to do as following:
+Before running this example, it is necessary to create some appropriate information upon
which to
+issue the management commands. Therefore go to
$RiftSaw/samples/quickstart/simple_correlation folder,
+and run the following commands:
-Go to $sample/quickstart/simple_correlation, run following commands:
-
1. ant deploy
2. ant sendhello
3. ant sendgoodbye
4. ant sendhello2
-With above commands, you've got one active process instance, one completed process
instance.
+These commands will result in one active process instance, and one completed process
instance.
+To run this management example, use the following command:
-This example shows four restful services:
+ ant runclient
-1). all deployments: This service returns all of deployed artifacts on the server.
-2). all process definitions: This services returns all of process definitions that are
deployed on server.
-3). active process instances for simple_correlation example process definition.
-4). historic process instances for simple_correlation example process definition.
+The result from this command will show the output from four RESTful services:
-By default, all of restful services are secured by form authentication, except the status
service and the deployments
-service.
+1) all deployments: This service returns all of the deployed artifacts on the server.
+2) all process definitions: This services returns all of the process definitions that are
deployed on the server.
+3) active process instances: The list of active process instances, in this case for the
simple_correlation example.
+4) historic process instances: The list of historic (completed) process instances, in
this case for the simple_correlation example.
-In the example, firstly, we've invoked the restful service, and then with the JSON
result, we've used the
-third party library (Gson) to marshall the JSON data into Java Objects, where you can
find it on the gwt-console-rpc.jar.
+By default, all of the RESTful services are secured by form authentication, except the
status and deployment services.
-These all restful services are built from the bpm console project, not on the riftsaw
core itself.
-for details on bpm console, please refer to
https://github.com/bpmc/bpm-console/
+In the example, the RESTful services are initially invoked, and then the JSON result is
marshalled into Java Objects using
+the third party Gson library.
+All of the RESTful services are built within the bpm-console project. For further details
please refer to
+https://github.com/bpmc/bpm-console/.
-some handy URLs:
-http://localhost:8080/gwt-console-server/rs/server/resources/riftsaw RiftSaw Restful
Services document in html format.
\ No newline at end of file
+Some handy URLs:
+
+http://localhost:8080/gwt-console-server/rs/server/resources/riftsaw RiftSaw RESTful
Services document in html format.