Developing a Hello World Composite Application

Download ZIP file for offline reading (includes video demo files, 4.55 MB)

In this tutorial, you create a simple BPEL Module project called SynchronousSample and a Composite Application project called SynchronousSampleApplication. This tutorial illustrates how to design a simple XML schema file, a simple WSDL file, and a BPEL file. You learn how to design a BPEL process and deploy. You also learn how to create and perform a test run of a composite application. The process is a simple BPEL process that echoes back the input message. The BPEL process returns the result to the client synchronously. A client starts the BPEL process by invoking a request-response operation. The client is blocked until the process finishes and returns the result. The project includes WSDL and XML schema files, and input files for testing.

This tutorial is intended to be the first step towards building a more complex composite application.

top

Configuring the Tutorial Environment

Before you can deploy your application, the Sun Java System Application Server and JBI runtime must be configured correctly and running.

To configure the tutorial environment:

1. Click the Runtime tab to open the Runtime window.
2. In the Runtime window, expand the Servers node.
3. If the Servers node already contains a Sun Java System Application Server 9 node, then go to step 5.
4. If the Servers node does not contain a Sun Java System Application Server 9 node, then do the following to add an application server:
   
   1. Right-click the Servers node and choose Add Server from the pop-up menu.
      The Add Server Instance dialog box opens.
   2. In the Choose Server page, from the Server drop-down list, select Sun Java System Application Server.
   3. (Optional) In the Name field, accept the default value or type the name you want to use to identify the server in the IDE.
   4. Click Next.
      The Platform Location Folder page opens.
   5. In the Platform Location field, use the Browse button to navigate to and select the Application Server installation location.
      If you accepted the default values during the installation, the location is C:\Sun\Appserver.
   6. Select the Register Local Default Domain radio button.
   7. Click Next.
   8. Supply the user name and password for the domain's administrator.
      If you accepted the default values during the installation, the user name is admin and the password is adminadmin.
   9. Click Finish.
5. In the Runtime window, right-click the Sun Java System Application Server 9 node and choose Start.
   If the Start option is not available, the server is already running and you can skip the next step.
6. Wait until the following message appears in the Output window:
   Application server startup complete.
   When the server is running, the IDE displays a green arrow badge on the Sun Java System Application Server 9 node.

 View Demo

top

Creating the Project

In this section, you create a BPEL Module project called SynchronousSample.

To create the SynchronousSample project:

1. From the IDE's main menu, choose File > New Project.
   The New Project wizard opens.
2. In the Categories list, select the Service Oriented Architecture node.
3. In the Projects list, select the BPEL Module node.
4. Click Next.
5. In the Project Name field, type SynchronousSample.
6. (Optional) In the Project Location field, use the Browse button to navigate to and select a different folder where the IDE will store the project files.
7. Click Finish.
   The Projects window now contains a project node for a BPEL Module project called SynchronousSample.

 View Demo

top

Creating the XML Schema

In this section, you add a new XML schema file to your BPEL Module project and then add XML schema components to the schema.

To create SynchronousSample.xsd:

1. In the Projects window, expand the SynchronousSample project node, then right-click the Process Files node and choose New > File/Folder.
   The New File wizard opens.
2. In the New File wizard, do the following:
   
   1. In the Choose File Type page, in the Categories list, select the XML node, then in the File Types list, select the XML Schema node and click Next.
   2. In the File Name field, type SynchronousSample.
   3. Click Finish.
   In the Projects window, the Process Files node now contains a subnode labeled SynchronousSample.xsd. The Source Editor contains a tab for the XML schema file, SynchronousSample.xsd, with the Schema view open.
3. In the Schema view, click the Design button to open the Design view of the XML schema editor.

 View Demo

To add a complex type to the XML schema:

1. In the Palette of the Design view, expand the XML Schema Components section and select the Complex Type icon.
   If the Palette window is not visible, choose Window > Palette from the main menu.
2. Drag your selection to the schema design area, immediately below the Complex Types node.
   The IDE adds a complex type node and the name of the complex type (newComplexType) is selected and ready for you to change.
3. Type simpleProcess in the new node and press Enter.
   The design area now shows your new complex type, called simpleProcess.

 View Demo

To add a local element to simpleProcess:

1. In the XML Components section of the Palette, select the Element icon and drag your selection onto the simpleProcess node in the schema design area.
   The IDE adds an element node labeled newElement.
2. If the Properties window is not visible, choose Window > Properties.
3. In the schema design area, select the newElement node.
4. In the Properties window, select the value field of the Name property to make it editable and type paramA.
5. In the Properties window, in the Definition property, click the ellipsis button.
   The Definition dialog box opens.
6. In the list, expand the Built-in Types node and select the string node.
7. Click OK.

 View Demo

To add a global element:

1. In the XML Components section of the Palette, select the Element icon and drag your selection to the design area, immediately below the Elements node.
   The IDE adds a newElement component below the Elements nodes in the schema design area.
2. In the schema design area of the Design view, select the newElement node.
3. In the Properties window, select the value field of the Name property to make it editable and type typeA.
4. In the Properties window, in the Definition property, click the ellipsis button.
   The Element's definition - Definition dialog box opens.
5. In the list of types, expand the Complex Types node and select the simpleProcess complex type node.
6. Click OK.
   In the Design view, the IDE now shows the selected simpleProcess complex type next to the typeA element node.
7. To save your changes, in the Projects window, select the SynchronousSample project node, and from the IDE's main menu, choose File > Save All.

 View Demo

top

Creating the WSDL Document

In this section, you add a WSDL file to your BPEL Module project and then configure the components of the WSDL Document.

To create SynchronousSample.wsdl:

1. In the Projects window, expand the SynchronousSample project node, then right-click the Process Files node and choose New > WSDL Document.
   The New WSDL Document wizard opens.
2. In the Name and Location page, do the following:
   1. In the File Name field, type SynchronousSample.
   2. Select the Import XML Schema File(s) checkbox.
   3. In the XML Schema(s) field, click the Browse button.
      The Select Schemas dialog box opens. This dialog box shows the XML schemas in your project.
   4. Select src/SynchronousSample.xsd and click OK.
   5. Click Next.
   The Abstract Configuration page opens.
3. In the Input area of the Abstract Configuration page, do the following:
   1. In the Message Part Name column, double-click the default value to make the field editable.
   2. Type inputType and press Enter.
   3. In the Element Or Type column, click the ellipsis button.
      The Select Element Or Type dialog box opens.
   4. Expand the SynchronousSample node, the src/SynchronousSample.xsd node, and the Elements node.
   5. Under the Elements node, select the typeA node and click OK.
4. In the Output area of the Abstract Configuration page, do the following:
   1. In the Message Part Name column, double-click the default value to make the field editable.
   2. Type resultType and press Enter.
   3. In the Element Or Type column, click the ellipsis button.
      The Select Element Or Type dialog box opens.
   4. Expand the SynchronousSample node, the src/SynchronousSample.xsd node, and the Elements node.
   5. Under the Elements node, select typeA and click OK.
5. Click Next.
   The Concrete Configuration page opens.
   Note: When you perform the next step, the error message at the bottom of the page disappears.
6. Under Binding Subtype, select the Document Literal radio button.
7. Click Finish.
   In the Projects window, the Process Files node now contains a subnode labeled SynchronousSample.wsdl.
   The Source Editor contains a tab for the WSDL file, SynchronousSample.wsdl, with the WSDL view open.

 View Demo

top

Creating the BPEL Process

To create SynchronousSample.bpel:

1. In the Projects window, right-click the Process Files node and choose New > BPEL Process.
   The New BPEL Process wizard opens.
2. In the File Name field, type SynchronousSample.
3. Click Finish.
   In the Projects window, the Process Files node now contains a subnode labeled SynchronousSample.bpel.
   The Source Editor contains a tab for the BPEL process, SynchronousSample.bpel, with the Design view of the BPEL Designer open.

 View Demo

To add a partner link:

1. In the Projects window, expand the SynchronousSample project node, then expand the Process Files node and select the SynchronousSample.wsdl node.
2. Drag your selection (SynchronousSample.wsdl) from the Projects window to the Design view.
   The Partnerlink1 [Partner Link] - Property Editor opens.
3. Accept the defaults and click OK.

 View Demo

To add a Receive activity:

1. In the Web Service section of the Palette, select the Receive icon and drag your selection to the design area between the Process Start activity and the Empty activity.
   The IDE provides you with visual clues to show you where you can drop the selection.
   This action places a Receive activity called Receive1 in the Design view.
2. Double-click the Receive1 activity.
   The Receive1 [Receive] - Property Editor opens.
3. Change the value in the Name field to start.
4. From the Partner Link drop-down list, select PartnerLink1.
   The IDE fills in the Operation field.
5. Create a new input variable by doing the following:
   1. Click the Create button next to the Input Variable field.
      The New Input Variable dialog box opens.
   2. Change the value in the Name field to inputVar.
   3. Click OK.
6. Click OK to close the Receive1 [Receive] - Property Editor.
   The Receive activity is now labeled start in the Design view.

 View Demo

To add a Reply activity:

1. In the Web Service section of the Palette, select the Reply icon and drag your selection to the design area between the empty activity and the Process End activity.
   The IDE provides you with visual clues to show you where you can drop the selection.
   This action places a Reply activity called Reply1 in the Design view.
2. Double-click the Reply1 activity.
   The Reply1 [Reply] - Property Editor opens.
3. Change the value in the Name field to end.
4. From the Partner Link drop-down list, select PartnerLink1.
   The IDE fills in the Operation field.
5. Create a new output variable by doing the following:
   1. Make sure the Normal Response radio button is selected.
   2. Click the Create button next to the Output Variable field.
      The New Output Variable dialog box opens.
   3. Change the value in the Name field to outputVar.
   4. Click OK.
6. Click OK to close the Reply1 [Reply] - Property Editor.
   The Reply activity is now labeled end in the Design view.

 View Demo

To add an Assign activity:

1. In the design area, select the empty activity, right-click and choose Delete from the pop-up menu.
2. In the Basic Activities section of the Palette, select the Assign icon and drag your selection to the design area between the start activity and the end activity.
   This action places an Assign activity called Assign1 in the Design view.
3. Select the Assign1 activity.
4. If the BPEL Mapper window is not visible, choose Window > BPEL Mapper from the main menu.
5. In the left pane of the BPEL Mapper, under Variables, expand the inputVar and inputType nodes.
   paramA appears under inputType.
6. In the right pane of the BPEL Mapper, under Variables, expand the outputVar and resultType nodes.
   paramA appears under resultType.
7. Drag paramA from the left pane of the BPEL Mapper to the paramA node in the right pane of the BPEL Mapper.
   This assignment copies the input statement into the output.
8. To save your changes, in the Projects window, select the SynchronousSample project node, and from the IDE's main menu, choose File > Save All.

 View Demo

top

Creating and Deploying the Composite Application

Before you deploy the BPEL Module project, you must add the JBI module to the deployment project. Deploying the project makes the service assembly available to the application server, thus allowing its service units to be run.

To create the Composite Application project and add the JBI module:

1. From the IDE's main menu, choose File > New Project.
   The New Project wizard opens.
2. In the Categories list, select the Service Oriented Architecture node.
3. In the Projects list, select the Composite Application node.
4. Click Next.
5. In the Project Name field, type SynchronousSampleApplication.
6. Click Finish.
   The Projects window now contains a project node for a Composite Application project called SynchronousSampleApplication.
7. In the Projects window, right-click the SynchronousSampleApplication project node and choose Add JBI Module from the pop-up menu.
   The Select Project dialog box opens.
8. Select the SynchronousSample project you created earlier in this tutorial and click Add Project JAR Files.
   The Select Project dialog box closes.
9. In the Projects window, expand the SynchronousSampleApplication project node and then expand the JBI Modules node.
   Notice that a SynchronousSample.jar node has been added.

 View Demo

To deploy the Composite Application:

• Right-click the SynchronousSampleApplication project node and choose Deploy Project.
  If a message similar to the following message appears in the Output window, then the deployment has succeeded:
  BUILD SUCCESSFUL (total time: 11 seconds)

 View Demo

top

Testing the SynchronousSampleApplication

You can enhance the Composite Application project by adding test cases, binding to the operation, supplying input, and then using the Tester.

To test the SynchronousSampleApplication:

1. In the Projects window, expand the SynchronousSampleApplication project node, right-click the Test node, and choose New Test Case from the pop-up menu.
   The New Test Case wizard opens.
2. Accept the default test case name, TestCase1, and click Next.
3. In the Select the WSDL Document page, expand the SynchronousSample - Process Files node, select SynchronousSample.wsdl, and click Next.
4. In the Select the Operation to Test page, select the SynchronousSampleOperation and click Finish.
   In the Projects window, under Test, a new TestCase1 node has been added.
   This node contains two subnodes: Input and Output.
   The Source Editor contains a tab for the Input file, Input.xml.
5. If the Source Editor does not contain a tab for Input.xml, double-click the Input node in the Projects window to open the file.
6. In the Source Editor tab for the Input.xml file, do the following:
   
   1. Locate the following line:
      <syn:paramA>?string?<syn:paramA>.
   2. Replace ?string? with Hello World.
      The line should look like this:
      <syn:paramA>Hello World<syn:paramA>.
   3. From the IDE's main menu, choose File > Save All.
7. Double-click Output to examine its contents.
   Initially, output.xml is empty. Therefore the first test run will populate output.xml with the real output. Subsequent test runs will compare the real output against the contents of output.xml.
8. In the Projects window, right-click the TestCase1 node and choose Run from the pop-up menu.
   Note: The first run is a special case because Output.xml is empty and the output is written to Output.
   Notice the failed message in the JUnit Test Results window.
   The Overwrite Empty Output? dialog box opens.
9. Click Yes.
10. In the Projects window, right-click the TestCase1 node and choose Run from the pop-up menu.
    After the first run, Output is no longer empty. The file's contents are preserved and are not overwritten by the new result.

 View Demo

top