Jump to: navigation, search

Difference between revisions of "SMILA/Documentation/BPEL Workflow Processor"

Line 1: Line 1:
This page describes how to configure the SMILA BPEL workflow processor and how to call SMILA services and pipelets from BPEL processes. We do not assume any BPEL knowledge for this, this page should contain everything to enable you to create at least simple BPEL processes for use in SMILA.
+
This page describes how to configure the SMILA BPEL workflow processor and how to call SMILA pipelets from BPEL processes. We do not assume any BPEL knowledge here, i.e. this page should contain everything to enable you to create at least simple BPEL processes for being used in SMILA.
  
 
== Basic configuration ==
 
== Basic configuration ==
  
The BPEL WorkflowProcessor expects its configuration in subdirectory <tt>org.eclipse.smila.processing.bpel</tt> of the configuration directory. See the test bundle <tt>org.eclipse.smila.processing.bpel.test</tt> for an example. In this it expects a file named <tt>processor.properties</tt> that describes the main configuration. It can contain the following SMILA specific properties:
+
The BPEL WorkflowProcessor expects its configuration in <tt>configuration/org.eclipse.smila.processing.bpel</tt>. See the test bundle <tt>org.eclipse.smila.processing.bpel.test</tt> for an example. In this directory it expects a file named <tt>processor.properties</tt> that describes the main configuration. This file can contain the following SMILA specific properties:
  
* ''pipeline.dir'' (default="pipelines"): The subdirectory of this directory that contains the BPEL process files (together with all needed XSD and WSDL files) and the ODE specific deploy.xml file. See below for details.
+
* ''pipeline.dir'' (default="pipelines"): The name of a folder below <tt>configuration/org.eclipse.smila.processing.bpel</tt> which contains the BPEL process files (together with all needed XSD and WSDL files) and the ODE specific <tt>deploy.xml</tt> file. See below for details.
* ''pipeline.timeout'' (default="300"): Maximum time in seconds allowed for processing a pipeline. If a pipeline invocation takes longer, it is aborted with an error. If you expect that longer evaluations are possible in your application (e.g. analysing very large documents) you may want to increase this value.
+
* ''pipeline.timeout'' (default="300"): Maximum time in seconds allowed for processing a pipeline. If a pipeline invocation takes longer, it is aborted with an error. You may want to increase this value in case you expect longer processing times in your application (e.g. when analyzing very large documents).
* ''record.filter (default = none)'': A record filter defining the attributes and annotations that should be contained in BPEL workflow objects. Of none is set, the workflow objects will contain only the record IDs to be processed. You should take care to add only those attributes and annotations to the filter that are actually used in any pipeline, for adding too many (and too huge) elements to the workflow object may decrease performance and uses more memory. As the WorkflowProcessor uses the Blackboard to filter objects, you must define the filters in <tt>org.eclipse.smila.blackboard/RecordFilters.xml</tt>.
+
* ''record.filter'' (default = none): A record filter defining the attributes and annotations that should be contained in BPEL workflow objects. If none is set, the workflow objects will contain only the record IDs to be processed. Add only those attributes and annotations to the filter that are actually used in any pipeline, because adding too many (and too huge) elements to the workflow object may decrease performance and use more memory. As the WorkflowProcessor uses the Blackboard to filter objects, you must define the filters in <tt>org.eclipse.smila.blackboard/RecordFilters.xml</tt>.
  
As the BPEL WorkflowProcessor is based on the Apache ODE BPEL engine [http://ode.apache.org], you can also add all ODE specific configuration properties to this file, just use the prefix <tt>ode.</tt> See ODE documentation for details. You have to add at least the configuration for a database connection which ODE needs for internal purposes (e.g. storing process definitions). For SMILA purposes usually a in-memory HSQLDB instance is completely sufficient, the HSQLDB library is incldued in bundle <tt>org.apache.ode</tt>. Define it using the following properties:
+
As the BPEL WorkflowProcessor is based on the Apache ODE BPEL engine [http://ode.apache.org], you can also add all ODE specific configuration properties to this file, just use the prefix <tt>ode.</tt> See ODE documentation for details. You have to add at least the configuration for a database connection which ODE needs for internal purposes (e.g. storing process definitions). For SMILA purposes usually an in-memory HSQLDB instance is completely sufficient, the HSQLDB library is incldued in bundle <tt>org.apache.ode</tt>. To use it, set the following properties:
  
 
<pre>
 
<pre>
Line 19: Line 19:
 
</pre>
 
</pre>
  
If you want to use a "real" database you will have to make the JDBC driver available to bundle "org.apache.ode", and check the ODE documentation for how to prepare the database schema for ODE.
+
If you want to use a "real" database you will have to make the JDBC driver available to bundle "org.apache.ode", and check the ODE documentation on how to prepare the database schema for ODE.
  
 
== Pipeline definition using BPEL ==
 
== Pipeline definition using BPEL ==
Line 58: Line 58:
 
</source>
 
</source>
  
To create a new pipeline copy this to a new file with suffix <tt>.bpel</tt> in the configuration directory <tt>org.eclipse.smila.processing.bpel/pipelines</tt> and replace ''$PIPELINENAME'' with the desired name of your pipeline. Add the files from the <tt>xml</tt> directory in bundle <tt>org.eclipse.smila.processing.bpel</tt> (<tt>id.xsd</tt>, <tt>record.xsd</tt> and <tt>processor.wsdl</tt>). Then create a file "deploy.xml" in the same directory like this and replace ''$PIPELINENAME'' by the name of your pipeline:
+
To create a new pipeline:
 +
# Copy the above snippet to a new file with the suffix <tt>.bpel</tt> and saved it to the folder <tt>configuration/org.eclipse.smila.processing.bpel/''$pipeline.dir''</tt>.
 +
# Then replace ''$PIPELINENAME'' by the desired name of your pipeline.
 +
# Next, copy the files <tt>id.xsd</tt>, <tt>record.xsd</tt>, and <tt>processor.wsdl</tt> from the <tt>xml</tt> directory in bundle <tt>org.eclipse.smila.processing.bpel</tt> to the same folder next to your .bpel file.
 +
# Then, still in the same folder, create a file named <tt>deploy.xml</tt> containing the following content but replace ''$PIPELINENAME'' by the name of the new pipeline:
  
 
<source lang="xml">
 
<source lang="xml">
Line 71: Line 75:
 
</source>
 
</source>
  
You can now add service or pipelet invocations to your pipeline BPEL. To add another pipelet you have to add only another BPEL file and copy the <tt><process></tt> element in <tt>deploy.xml</tt> for the new pipeline.
+
You can now add pipelet invocations to your pipeline BPEL. To add another pipelet you have to add only another BPEL file and copy the <tt><process></tt> element in <tt>deploy.xml</tt> for the new pipeline.
  
 
=== Pipelet invocations ===
 
=== Pipelet invocations ===
Line 88: Line 92:
 
** A collection of pipelets for XML processing (XSLT, XPath selection, ...) of documents.
 
** A collection of pipelets for XML processing (XSLT, XPath selection, ...) of documents.
  
To use such a pipelet in your pipeline use the SMILA specific BPEL extension activity <tt><invokePipelet></tt> somewhere between <tt><receive></tt> and <tt><reply></tt> in your BPEL process:
+
To use such a pipelet in your pipeline, use the SMILA specific BPEL extension activity <tt><invokePipelet></tt> somewhere between <tt><receive></tt> and <tt><reply></tt> in your BPEL process:
  
 
<source lang="xml">
 
<source lang="xml">
Line 95: Line 99:
 
     <proc:pipelet class="org.eclipse.smila.pipelet.SomePipelet" />
 
     <proc:pipelet class="org.eclipse.smila.pipelet.SomePipelet" />
 
     <proc:variables input="request" output="request" />
 
     <proc:variables input="request" output="request" />
     <proc:PipeletConfiguration>
+
     <proc:configuration>
    <proc:Property name="configuration-property-name">
+
      <rec:Val key="single-parameter">value</rec:Val>
       <proc:Value>configuration-property-value"/>
+
      <rec:Seq key="multi-parameter">
    </proc:Property>
+
        <rec:Val>value1</rec:Val>
    <!-- more configuration properties -->
+
        <rec:Val>value2</rec:Val>
     </proc:PipeletConfiguration>
+
       <rec:Seq>
 +
      <rec:Map key="complex-parameter">
 +
        <rec:Val key="sub-parameter1">sub-value1</rec:Val>
 +
        <rec:Val key="sub-parameter2">sub-value2</rec:Val>
 +
      </rec:Map>
 +
      <!-- more configuration parameters -->
 +
     </proc:configuration>
 
   </proc:invokePipelet>
 
   </proc:invokePipelet>
 
</extensionActivity>
 
</extensionActivity>
 
</source>
 
</source>
  
Replace the class name with the class name of the pipelet to use and add configuration properties as needed - this should be documented by the pipelet provider. If the output variable is the same as the input variable (which is usually sufficient), you can omit the ''output'' attribute.
+
Replace the class name with the class name of the pipelet to use and add configuration parameters as needed - this should be documented by the pipelet provider. The configuration is a generic AnyMap object like the one used as record metadata, see [[SMILA/Documentation/2011.Simplification/Data Model and Serialization Formats]] for details. If the output variable is the same as the input variable (which is usually sufficient), you can omit the ''output'' attribute.
 
+
=== Service invocations ===
+
 
+
Services (aka ''Processing Services'') are classes that implement interface <tt>org.eclipse.smila.processing.ProcessingService</tt> (in bundle <tt>org.eclipse.smila.processing</tt>) and registered as OSGi services for this interface with a service property named <tt>smila.processing.service.name</tt> descrining the name of this service. They are initialised and configured independently of the workflow engine and invocations from different pipelines will use the same instance. An example in the base SMILA distribution is the ''LuceneService'' in bundle <tt>org.eclipse.smila.lucene</tt> for adding records to a Lucene index.
+
 
+
To use such a service in your pipeline use the SMILA specific BPEL extension activity <tt><invokeService></tt> somewhere between <tt><receive></tt> and <tt><reply></tt> in your BPEL process:
+
 
+
<source lang="xml">
+
<extensionActivity name="invokeLuceneService">
+
  <proc:invokeService>
+
    <proc:service name="LuceneService" />
+
    <proc:variables input="request" />
+
  </proc:invokeService>
+
</extensionActivity>
+
</source>
+
 
+
The output attributes of <tt><proc:variables></TT> is supported here in the same way as in <tt><invokePipelet></tt> (see above), but is omitted in this example because the result of the service invocation should be written to the input variable again. There is no further configuration content in this service invocation. Consult the service documentation about how to configure it.
+
 
+
=== Setting annotations in service and pipelet invocations ===
+
 
+
Both kinds of invocations support setting annotations on the records to process inline in the extension activity XML. This is more important for invocation of services because the operation of some services is controlled by service-defined root annotations of the processed records, but nevertheless it works for invocation of pipelets in the same way. To use this just add a <tt><proc:setAnnotations></tt> element to <tt><proc:invokeService></tt> or <tt><proc:invokePipelet></tt> that contains the annotations in the standard annotation XML format defined in [Data Model and XML representation]. E.g., the ''LuceneIndexService'' (bundle <tt>org.eclipse.smila.lucene</tt>) uses a annotation to define the index to be changed and the type of change (''ADD'', ''DELETE''). In the example pipeline <tt>addpipeline.bpel</tt> of SMILA.application this looks like this:
+
 
+
<source lang="xml">
+
<extensionActivity name="invokeLuceneService">
+
  <proc:invokeService>
+
    <proc:service name="LuceneIndexService" />
+
    <proc:variables input="request" output="request" />
+
    <proc:setAnnotations>
+
      <rec:An n="org.eclipse.smila.lucene.LuceneIndexService">
+
        <rec:V n="indexName">test_index</rec:V>
+
        <rec:V n="executionMode">ADD</rec:V>
+
      </rec:An>
+
    </proc:setAnnotations>
+
  </proc:invokeService>
+
</extensionActivity>
+
</source>
+
 
+
This sets an annotation named <tt>org.eclipse.smila.lucene.LuceneIndexService</tt> with two named values ''indexName="test_index"'' and ''executionMode="ADD"'' to all records in the ''request'' variable. All existing annotations of the same name are removed before the new annotations are set.
+
 
+
  
 
=== Pipeline invocations ===
 
=== Pipeline invocations ===
  
You can also invoke one pipeline from another to group service or pipelet invocations that belong together. To do this you have to use the standard BPEL invoke activity to invoke a BPEL partner link for the sub pipeline:
+
You can also invoke one pipeline from another to group pipelet invocations that belong together. To do this you have to use the standard BPEL invoke activity to invoke a BPEL partner link for the sub pipeline:
  
 
* define a partner link in the <tt><partnerLinks></tt> section of the BPEL file, replace ''$SUBPIPELINENAME'' with the name of pipeline to invoke as defined in its <tt><process></tt> element:
 
* define a partner link in the <tt><partnerLinks></tt> section of the BPEL file, replace ''$SUBPIPELINENAME'' with the name of pipeline to invoke as defined in its <tt><process></tt> element:

Revision as of 08:42, 20 April 2011

This page describes how to configure the SMILA BPEL workflow processor and how to call SMILA pipelets from BPEL processes. We do not assume any BPEL knowledge here, i.e. this page should contain everything to enable you to create at least simple BPEL processes for being used in SMILA.

Basic configuration

The BPEL WorkflowProcessor expects its configuration in configuration/org.eclipse.smila.processing.bpel. See the test bundle org.eclipse.smila.processing.bpel.test for an example. In this directory it expects a file named processor.properties that describes the main configuration. This file can contain the following SMILA specific properties:

  • pipeline.dir (default="pipelines"): The name of a folder below configuration/org.eclipse.smila.processing.bpel which contains the BPEL process files (together with all needed XSD and WSDL files) and the ODE specific deploy.xml file. See below for details.
  • pipeline.timeout (default="300"): Maximum time in seconds allowed for processing a pipeline. If a pipeline invocation takes longer, it is aborted with an error. You may want to increase this value in case you expect longer processing times in your application (e.g. when analyzing very large documents).
  • record.filter (default = none): A record filter defining the attributes and annotations that should be contained in BPEL workflow objects. If none is set, the workflow objects will contain only the record IDs to be processed. Add only those attributes and annotations to the filter that are actually used in any pipeline, because adding too many (and too huge) elements to the workflow object may decrease performance and use more memory. As the WorkflowProcessor uses the Blackboard to filter objects, you must define the filters in org.eclipse.smila.blackboard/RecordFilters.xml.

As the BPEL WorkflowProcessor is based on the Apache ODE BPEL engine [1], you can also add all ODE specific configuration properties to this file, just use the prefix ode. See ODE documentation for details. You have to add at least the configuration for a database connection which ODE needs for internal purposes (e.g. storing process definitions). For SMILA purposes usually an in-memory HSQLDB instance is completely sufficient, the HSQLDB library is incldued in bundle org.apache.ode. To use it, set the following properties:

ode.db.mode=internal
ode.db.int.driver=org.hsqldb.jdbcDriver
ode.db.int.jdbcurl=jdbc:hsqldb:mem:odedb
ode.db.int.username=sa
ode.db.int.password=

If you want to use a "real" database you will have to make the JDBC driver available to bundle "org.apache.ode", and check the ODE documentation on how to prepare the database schema for ODE.

Pipeline definition using BPEL

The minimal BPEL process for SMILA pipelines looks like this:

<?xml version="1.0" encoding="utf-8" ?>
<process name="$PIPELINENAME" targetNamespace="http://www.eclipse.org/smila/processor"
    xmlns="http://docs.oasis-open.org/wsbpel/2.0/process/executable" xmlns:xsd="http://www.w3.org/2001/XMLSchema"
    xmlns:proc="http://www.eclipse.org/smila/processor" expressionLanguage="urn:oasis:names:tc:wsbpel:2.0:sublang:xpath2.0"
    queryLanguage="urn:oasis:names:tc:wsbpel:2.0:sublang:xpath2.0" xmlns:rec="http://www.eclipse.org/smila/record"
    xmlns:id="http://www.eclipse.org/smila/id">
 
    <import location="processor.wsdl" namespace="http://www.eclipse.org/smila/processor"
        importType="http://schemas.xmlsoap.org/wsdl/" />
 
    <partnerLinks>
        <partnerLink name="Pipeline" partnerLinkType="proc:ProcessorPartnerLinkType" myRole="service" />
    </partnerLinks>
 
    <extensions>
        <extension namespace="http://www.eclipse.org/smila/processor" mustUnderstand="no" />
    </extensions>
 
    <variables>
        <variable name="request" messageType="proc:ProcessorMessage" />
    </variables>
 
    <sequence>
        <receive name="start" partnerLink="Pipeline" portType="proc:ProcessorPortType" operation="process"
            variable="request" createInstance="yes" />
 
        <reply name="end" partnerLink="Pipeline" portType="proc:ProcessorPortType" operation="process" variable="request" />
        <exit />
    </sequence>
</process>

To create a new pipeline:

  1. Copy the above snippet to a new file with the suffix .bpel and saved it to the folder configuration/org.eclipse.smila.processing.bpel/$pipeline.dir.
  2. Then replace $PIPELINENAME by the desired name of your pipeline.
  3. Next, copy the files id.xsd, record.xsd, and processor.wsdl from the xml directory in bundle org.eclipse.smila.processing.bpel to the same folder next to your .bpel file.
  4. Then, still in the same folder, create a file named deploy.xml containing the following content but replace $PIPELINENAME by the name of the new pipeline:
<deploy xmlns="http://www.apache.org/ode/schemas/dd/2007/03" xmlns:proc="http://www.eclipse.org/smila/processor">
    <process name="proc:$PIPELINENAME">
        <in-memory>true</in-memory>
        <provide partnerLink="Pipeline">
            <service name="proc:$PIPELINENAME" port="ProcessorPort" />
        </provide>
    </process>
</deploy>

You can now add pipelet invocations to your pipeline BPEL. To add another pipelet you have to add only another BPEL file and copy the <process> element in deploy.xml for the new pipeline.

Pipelet invocations

Pipelets (aka Simple Pipelets) are classes that implement interface org.eclipse.smila.processing.SimplePipelet (in bundle org.eclipse.smila.processing) and are listed in the SMILA-Pipelets manifest header of the bundles that contain them. They are configured by the WorkflowProcessor on pipeline initialization. One instance is created for each time they occur in any pipeline, instances are not shared between multiple pipelines. Examples that come with the base SMILA distribution are

  • in bundle org.eclipse.smila.processing.pipelets:
    • org.eclipse.smila.processing.pipelets.SetAnnotationPipelet: Sets a configured annotation for each record in the input variable.
    • org.eclipse.smila.processing.pipelets.CommitRecordsPipelet: Commits each record in the input variable on the blackboard to the storages.
    • org.eclipse.smila.processing.pipelets.HtmlToTextPipelet: Extract plain text and metadata from an HTML document in an attribute or attachment of each record and writes it to configurable attributes or attachments.
  • in bundle org.eclipse.smila.processing.pipelets.aperture:
    • org.eclipse.smila.processing.pipelets.aperture.AperturePipelet: Uses Aperture to convert many kinds of documents to plain text.
  • in bundle org.eclipse.smila.processing.pipelets.xmlprocessing:
    • A collection of pipelets for XML processing (XSLT, XPath selection, ...) of documents.

To use such a pipelet in your pipeline, use the SMILA specific BPEL extension activity <invokePipelet> somewhere between <receive> and <reply> in your BPEL process:

<extensionActivity name="invokeSomePipelet">
  <proc:invokePipelet>
    <proc:pipelet class="org.eclipse.smila.pipelet.SomePipelet" />
    <proc:variables input="request" output="request" />
    <proc:configuration>
      <rec:Val key="single-parameter">value</rec:Val>
      <rec:Seq key="multi-parameter">
        <rec:Val>value1</rec:Val>
        <rec:Val>value2</rec:Val>
      <rec:Seq>
      <rec:Map key="complex-parameter">
        <rec:Val key="sub-parameter1">sub-value1</rec:Val>
        <rec:Val key="sub-parameter2">sub-value2</rec:Val>
      </rec:Map>
      <!-- more configuration parameters -->
    </proc:configuration>
  </proc:invokePipelet>
</extensionActivity>

Replace the class name with the class name of the pipelet to use and add configuration parameters as needed - this should be documented by the pipelet provider. The configuration is a generic AnyMap object like the one used as record metadata, see SMILA/Documentation/2011.Simplification/Data Model and Serialization Formats for details. If the output variable is the same as the input variable (which is usually sufficient), you can omit the output attribute.

Pipeline invocations

You can also invoke one pipeline from another to group pipelet invocations that belong together. To do this you have to use the standard BPEL invoke activity to invoke a BPEL partner link for the sub pipeline:

  • define a partner link in the <partnerLinks> section of the BPEL file, replace $SUBPIPELINENAME with the name of pipeline to invoke as defined in its <process> element:
<partnerLinks>
  <partnerLink name="Pipeline" partnerLinkType="proc:ProcessorPartnerLinkType" myRole="service" />
  <partnerLink name="$SUBPIPELINENAME" partnerLinkType="proc:ProcessorPartnerLinkType" partnerRole="service" />
</partnerLinks>
  • add an BPEL <invoke> activity between <receive> and <reply>, replace $SUBPIPELINENAME with the pipeline name and adapt the inputVariable and outputVariable attributes if necessary (omitting outputVariable is not allowed here!):
<invoke name="invokeSubPipeline" operation="process" portType="proc:ProcessorPortType" 
  partnerLink="$SUBPIPELINENAME" inputVariable="request" outputVariable="request"
/>
  • add a declaration for the partner link in the deploy.xml entry of your pipeline:
<deploy xmlns="http://www.apache.org/ode/schemas/dd/2007/03" xmlns:proc="http://www.eclipse.org/smila/processor">
    <process name="proc:$PIPELINENAME">
        <in-memory>true</in-memory>
        <provide partnerLink="Pipeline">
            <service name="proc:$PIPELINENAME" port="ProcessorPort" />
        </provide>
        <invoke partnerLink="$SUBPIPELINENAME">
            <service name="proc:$SUBPIPELINENAME" port="ProcessorPort" />
        </invoke>
    </process>
</deploy>

Advanced process definition

You can of course use all other BPEL elements, too, to create your pipelines like conditions, iterations, parallel flows, invocation of external Web Services, etc. However, to describe them is beyond the scope of this introduction and requires "real" knowledge about BPEL (and WSDL, for invoking Web Services).