Saturday, March 3, 2012

Loops in BPEL 1.1 and 2.0

Introduction

When programming in BPEL, an often used construction is the following;
- the input of a process contains a collection of elements
- the elements need to be processed one at a time

There are several solutions to implement this. A couple of these solutions will be discussed here.

SOA Suite 10g and SOA Suite 11g have some differences in usage of extension functions such as the one used for transformations. SOA Suite 11g (of course) provides several improvements over 10g. Also BPEL 1.1 and BPEL 2.0 standards provide different activities for handling loops.

An alternative for using loop constructions in BPEL when XML needs to be send to the database is by using XML object types. See http://javaoraclesoa.blogspot.nl/2013/03/using-plsql-object-types-to-get-nested.html for more information.

Example processes

The complete BPEL 1.1 and BPEL 2.0 example (including XSD and XSLT) can be downloaded here; http://dl.dropbox.com/u/6693935/blog/TestXSLT.zip

The example used will use the following input and output schema definitions;


<?xml version="1.0" encoding="UTF-8"?>
<schema attributeFormDefault="unqualified" elementFormDefault="qualified"
        targetNamespace="http://test.ms/itemcollections"
        xmlns="http://www.w3.org/2001/XMLSchema"
        xmlns:me="http://test.ms/itemcollections">

 <element name="item" type="me:itemType"/>
<complexType name="itemType">
  <sequence>
   <element name="name" type="string"/>
   <element name="value" type="string"/>
  </sequence>
 </complexType>

 <element name="itemsCollection" type="me:itemsCollectionType"/>
 <complexType name="itemsCollectionType">
  <sequence>
   <element ref="me:item" minOccurs="0" maxOccurs="unbounded"/>
  </sequence>
 </complexType>

<element name="itemCollectionArray" type="me:itemCollectionArrayType"/>
 <complexType name="itemCollectionArrayType">
  <sequence>
   <element ref="me:itemsCollection" minOccurs="0" maxOccurs="unbounded"/>
  </sequence>
 </complexType>

 <element name="simpleString" type="me:simpleStringType"/>
 <complexType name="simpleStringType">
  <sequence>
   <element name="value" type="string"/>
  </sequence>
 </complexType>

<element name="simpleNumber" type="me:simpleNumberType"/>
 <complexType name="simpleNumberType">
  <sequence>
   <element name="value" type="decimal"/>
  </sequence>
 </complexType>

</schema>

This schema has been created to illustrate how collections can be handled.

It is advisable to define your element and type definitions inside a separate XSD. This promotes re-use and maintainability. The XSD can for example be put in the MDS (as described in http://javaoraclesoa.blogspot.com/2012/02/using-mds.html). It is also very useful to define separate types for every element used. This makes defining variables containing only a part of the message easier.

The workspace contains a BPEL 1.1 and a BPEL 2.0 process which are both exposed as webservices. The BPEL 1.1 process uses a While activity together with Assign activities to process a collection. The BPEL 2.0 process uses the For Each activity and a transformation to achieve the same.

BPEL 1.1 (SOA Suite 10g + 11g)

BPEL 1.1 contains the While activity and the FlowN activity which can both be used to process collections. The While activity allows to loop over a set of activities until a certain condition is met. The FlowN activity provides the option for parallel execution and an index variable to indicate the branche which is processed. FlowN has been described in; http://javaoraclesoa.blogspot.com/2012/02/parallel-execution-and-variable-scoping.html. This part will focus on the While activity. The part describing how to get a parameter inside an XSLT transformation or use it inside an assign activity, can of course also be applied for FlowN.

The below picture shows my BPEL 1.1 sample process. It transforms the input collection on a per item basis to a local variable (which would allow processing of the individual item). Then it adds the result to the output variable.


The While condition

You can create a variable inside the scope of the while activity and increase this. The condition can be set to check whether the counter is smaller then or equal to the count of elements in the message that need processing.

Getting to your element; The element is an XSLT element

There are several ways to obtain the element you want to process. Depending on the circumstances, some options might not be available.

The easiest option is creating a variable of the type of one of the items of the collection. Then use the assign activity to assign the element.

The empty activity in the process symbolizes actions on the l_item variable. This can for example be a transformation followed by a call to a DbAdapter. The result can be transformed to a different format which can then be used to generate the output. The example is meant as a bare-bones illustration of the functionality.

Things to mind;
- it is advisable to create a scope inside the While activity and use local variables inside this scope
- in the Assign activity where you assign the item to be processed, cast the local counter variable to a number like in the following example (else the condition which selects which item to be processed, doesn't work correctly);

bpws:getVariableData('inputVariable','payload','/ns1:itemsCollection/ns1:item')[number(bpws:getVariableData('l_counter'))]

- Use the Assign append rule type and append an item to the collection for creating output.

            <assign name="AssignOutputItemProcessToOutputProcess">
              <bpelx:append>
                <bpelx:from expression="bpws:getVariableData('l_item')"/>
                <bpelx:to variable="outputVariable" part="payload"
                          query="/ns1:itemsCollection"/>
              </bpelx:append>
            </assign>

- use >= and not => in the While activity condition!

Getting to your element; The element is not an XSLT element type. BPEL 1.1 SOA Suite 10g.

BPEL 1.1 in 10g uses a different transformation function as BPEL 1.1 in 11g. The transformation activity is an Oracle extension and not part of the BPEL specification (actually it's implemented as an Assign which is part of the specification and made easier to use with a wizard). The below part is for using the BPEL 10g version.

Sometimes the element of the collection is not available as a type. This makes processing less straightforward, since a variable of the item can not readily be created in BPEL. A solution for this is using an XSLT transformation with a parameter. It is important to think about to what type you are going to transform to, since the type of the element is not available. You can create a custom element type for this., for example the name/value pair items (as specified in the introduction), can be used for that.

Using a parameter inside an XSLT transformation can for example be found on;  http://rigterink.blogspot.com/2009/09/passing-xml-as-parameter-to-xslt.html

The parameter can be assigned the counter value of the While loop and be passed to the XSLT transformation. This XSLT parameter can then be used to select the correct element of the source XML to be used.

Selecting the correct element from the source XML inside an XSLT transformation, will be illustrated in the BPEL 2.0 part.

BPEL 2.0

BPEL 2.0 is only available in SOA Suite 11g and not in 10g. It has several new features which make it more easy to deal with loops. Also the bpws:getVariableData does not need to be used anymore; the syntax for accessing variables has been simplified. A dot notation can be used, for example an assign activity;

          <assign name="AssignCounter">
            <copy>
              <from>$ForEach1Counter</from>
              <to>$l_counter/ns1:value</to>
            </copy>
          </assign>

For Each activity

The For Each activity can be compared with the While activity, however it is more specific.
- It provides a scope for a loop (in a While activity you have to create the scope yourself)
- It provides a start and endpoint for the counter variable and the counter variable can be created in the For Each activity wizard.
- It provides an option for an additional completion expression
- It provides the option of parallel execution of the individual branches (similar to the FlowN activity in BPEL 1.1)
- it provides a variable which can be used in Assign activities, however not in XSLT transformations without some additions!


The below picture shows the BPEL 2.0 process using the For Each activity. Noticable is that I have to use less activities to achieve the same as with a While activity in BPEL 1.1.



XSLT transformations allow more input variables

The function which is used in the transformation for SOA Suite 10g BPEL 1.1 is different from the transformation function used in SOA Suite 11g BPEL 1.1 and BPEL 2.0. In SOA Suite 11g it is easier to add multiple input parameters to a single transformation in the wizard and the input parameters do not need to confer to a specific schema.

The source types for the transformation all need to be simple or complex types. it is thus easiest to use a complex type. A complex types can be selected when using the wizard to define the type of BPEL variable and by choosing one from the 'Element' or 'Message type' category. you can see examples in the schema shown at the start of this post; simpleNumberType and simpleStringType. These types are complex type wrappers for the simple types string and decimal. They allow the simple types to be used as complex types inside transformations.

Using the counter variable of a For Each activity inside an XSLT transformation, can be done as followed;
- assign the For Each counter variable to a complextype (for example the simpleNumberType)
- use the variable inside a for-each XSLT construction with a selection on the passed simpleNumberType by using the position() function.

The transformation without namespaces used, is the following (see the example ZIP for the complete XSLT);

  <xsl:param name="l_counter"/>
  <xsl:template match="/">
    <xsl:for-each select="/ns1:itemsCollection/ns1:item[position()=$l_counter/ns1:simpleNumber/ns1:value]">
      <ns1:item>
        <ns1:name>
          <xsl:value-of select="ns1:name"/>
        </ns1:name>
        <ns1:value>
          <xsl:value-of select="ns1:value"/>
        </ns1:value>
      </ns1:item>
    </xsl:for-each>
  </xsl:template>
</xsl:stylesheet>


Note on Assigns

Changing the rule type for the assign is in SOA Suite 11g in BPEL 1.1 different then in BPEL 2.0.

BPEL 1.1
Select the rule type from the drop-down box

BPEL 2.0
Right click the From / To rule, Change rule type

10 comments:

  1. Hi! I am developing a BPEL flow that is "polling" a table and a procedure called a "dbAdapter." The "polling" offers a collection of data but to call the procedure there is no collection. So, even putting "for-each" does not run more than once the procedure. Could you tell me if there is any alternative to this need? Thank you, Adauto

    ReplyDelete
    Replies
    1. Hi,

      You can address the below question as followed;
      - create in BPEL 2.0 a For Each BPEL construct. start value of the counter 1, end value of the counter count(elements in collection result of polling)
      - assign the For Each counter variable to a variable of the complex type simpleNumber as specified in the mentioned post
      - create a transformation with as input the collection (result from polling) and the simpleNumber variable. the output should be the input message for the invoke of the procedure
      - use in xslt the for-each construct on the collection input. in the foreach you can match position() to the value of the simpleNumber variable

      Hope this helps,
      with kind regards,
      Maarten Smeets

      Delete
  2. Hi! I am developing a BPEL flow that is "polling" a table and a procedure called a "dbAdapter." The "polling" offers a collection of data but to call the procedure there is no collection. So, even putting "for-each" does not run more than once the procedure. Could you tell me if there is any alternative to this need? Thank you, Adauto
    P.S.: my e-mail: shomp_br@hotmail.com

    ReplyDelete
    Replies
    1. You might want to look at the following post for that; http://javaoraclesoa.blogspot.nl/2013/03/using-plsql-object-types-to-get-nested.html

      Delete
  3. hello... thanks for the article. i have created my first ForEach structure. i run a database query, which returns a set of network node records. i use an XML node count to determine how many records were returned. then i loop across the count with ForEach, and am attempting to access each record's ID to do additional work. using a concat and trying to the get ID, i get the following instead:

    $networkNodesOutputVariable.ExecutionNetworkNodeCollection/ns6:ExecutionNetworkNode/ns6:executionNetworkNodeUid[1]
    $networkNodesOutputVariable.ExecutionNetworkNodeCollection/ns6:ExecutionNetworkNode/ns6:executionNetworkNodeUid[2]

    that's great... but i need the actual UID *value*, not the XPath. how do i actually evaluate my expression to return the *ID*...? thanks for any help you can provide. here's my expression:

    concat('$networkNodesOutputVariable.ExecutionNetworkNodeCollection/ns6:ExecutionNetworkNode/ns6:executionNetworkNodeUid[',$nodeCounter,']')

    note: i've also tried adding "/text()" at the end, which just gets appended to the XPath i receive back.

    ReplyDelete
    Replies
    1. Hello,

      I usually use an XSLT transformation to get to the value inside a ForEach. The transformation has as input the source and a ComplexType variable wrapping the foreach counter variable (type SimpleNumber in the above post). The output is a temporary variable which has the scope of the foreach loop. An example of such a transformation is supplied (http://dl.dropbox.com/u/6693935/blog/TestXSLT.zip)

      Delete
  4. Hello Maarten,

    I am trying to use forEach and parallel execution='yes' in my BPEL. The Counter Name is set to final loop value by default in this case by the framework. I want to use the counter Name inside my loop to chunk a set of data based on the loop number. Is there any thing that i am missing here. If i do not choose parallel execution then counter Name is coming as proper loop number inside loop. Example: I have 3 loops to be done, in parallel, counter Name is set to 3 even in loop 1. In sequence, counter Name is set to 1 in loop 1, 2 in loop 2 and so on.

    ReplyDelete
    Replies
    1. Hi Raghu,

      When using parallel execution, variables which are not inside the scope of the loop and are altered by activities inside the loop can impact all loops.

      If for example you define a loop variable globally and use that in the ForEach loop, it could give the problems you are having. The first instance of the loop alters it to 1, the second alters it to 2, the third alters it to 3 and the value is 3. Then the second activity of the first loop is executed and the counter value is not as expected. If you define the variable inside a scope in the ForEach, you will not have this problem.

      Also you should consider what you will gain by parallel execution. See http://docs.oracle.com/cd/E23943_01/dev.1111/e10224/bp_parallel.htm paragraph 10.1.1. The parallel foreach branches are still executed in a single thread.

      I hope this information helps you,
      With kind regards,
      Maarten

      Delete
  5. Hello,
    Nice post. Thanks! I am trying to do the opposite. Create a collection from individually processed values. Is this possible to do in SOA? My hacks attempting to do this did not work.

    Thanks,
    Stuart

    ReplyDelete
    Replies
    1. Hello,

      Thank you for appreciating this post. To combine results from individually processed values, you can use the Assign activity with the Append rule. See the last part of the post; 'Note on assigns' for screenshots on how to do this.

      With kind regards,
      Maarten

      Delete