---------------
SPM2BPEL - Tool
---------------

Content:

---------------------------------
-1- The SPM2BPEL program.

-2- Description of the XML-Schema

-3- Service and Error-Reports

---------------------------------

-1- The SPM2BPEL program
------------------------
This program is a protoype implementation for the translation
of a Standard Process Model into BPEL. The implementation followed the
algorithm as introduced in the paper: "Translating Standard
Process Models to BPEL".

A precondition for the program is that the notation of the
SPM input-file follows the convention as defined in the
[2do] xml-schema.

The call-structure is:

java -jar SPM2BPEL.jar <name_of_SPM_File>

The program produces an output on std-out (usually the shell)
logging all steps of the algorithm and produces a 
file named <name_of_SPM_File>.bpel.



-2- Description of the XML-Schema
---------------------------------
An spm-file specifies the SPM process in XML-format. 
To specify a SPM process node and arc tags are used.
Node and arc elements  have their own unique id. There two types of nodes: 
an activity-node is defined using the name-attribute and a 
connector-node is defined via the type-attribute. 
Arc tags are necessary to specify the connection between
nodes. Arcs can have a guard-Attribute, specifying a boolean
expression. 
The code element is used throughout the spm-file to include valid
BPEL-code. 
A specific tag named processInstantiation is used to define the 
initial activity.
If no code is used comments are generated at the corresponding 
places in the BPEL-file.
In the following the general structure of an spm-file is described.
Optional information is indicated using the square brackets 
"[" and  "]".

General Structure:

<spm>  <!-- the start Tag -->
 <process id="..."> <!-- process declaration -->
  [<code> 
   <!-- BPEL code for copying under the process-decl of BPEL -->
   <!-- contains definitions of parner links and variables -->
   <!-- and process instantiation event --> 
   <processInstantiation> BPEL-CODE </processInstantiation>]
  <nodes> <!-- List of activity or connector-node -->
   <node id="..." name="..."> <!--Activity node-->
    [<code> ... </code>] <!-- optional: BPEL-CODE for the activity-->
   </node>
   <node id="..." type="AND-Join | AND-Split | XOR-Join | XOR-Split"/> <!-- Connector Node -->
   </node>
  </nodes>
  <arcs> <!-- List of Arcs-->
   <arc id="..." source="..." target="..." [guard="..."]>
    [<code> ... </code>] <!-- optional: BPEL-cODE for the guard -->
   </arc> 
  </arcs>
 </process>
</spm>
 


-3- Service & Error-Reports
---------------------------
In case an error occurs please follow these steps:

1. produce a screenshot showing the error and the
   call-structure.

2. send the screenshot together with the input-File
   to the following email-address:

   sw.breutel@qut.edu.au

Usually error get fixed within 1-2 working days.