Build it yourself

1.1 Import and deploy the prepared project

1.2 Deploy your project in WID to the integrated test environment

1.3 Familiarize yourself with the process

In this section, we export the Web Services Description Language files (WSDL files) from the WebSpheer Process Server on which we want to call the Web service interface later.

To export the WSDL files for the BFM API, follow theses steps:

1. Make sure your WebSphere Process Server is started.
2. In a browser, open the administrative console.
   The default URL is
3. When prompted enter userid admin and password admin.
   
4. In the navigation pane, select Applications > Application Types > WebSphere enterprise Applications.
5. Locate the application named BPEContainer_{your_nodename}_server1 and click on this application name.
   

   

   Within the Configuration page click Web Service Properties > Publish WSDL files.
   

   

6. The Publish WSDL files page shows up. Double click the BPEContainer_{your_nodename}_server1.

   

7. Press Save to save the BPEContainer_{your_nodename}_server1_WSDLFiles.zip to your temporary directory, for example temp.
8. Extract this *.zip file to this temp directory. Delete the b.jar file that is not needed.
   

   

   
   

In this section, you export the Web Services Description Language files (WSDL files) from the WebSphere Process Server on which you want to call the Web service interface later.

Note:
In this sample, we restrict ourselves to the Business Flow Manager API (BFM API), which can be used to interact with the BPEContainer. If you rather want to use the Human Task Manager API (HTM API), which can be used to interact with the TaskContainer, all steps are similar conceptually, but you will export the WSDL files from the TaskContainer application instead. So you might skip this paragraph.

To export the WSDL files for the HTM API, follow theses steps:

1. Make sure your WebSphere Process Server is started.
2. In a browser, open the administrative console.
   The default URL is
3. When prompted enter userid admin and password admin.
   
4. In the navigation pane, select Applications > Application Types > WebSphere enterprise Applications.
5. Locate the application named TaskContainer_{your_nodename}_server1 and click on this application name.
   Within the Configuration page click Web Service Properties > Publish WSDL files.
   
6. The Publish WSDL files page shows up. Double click the TaskContainer_{your_nodename}_server1.
   

   
   

7. Press Save to save the TaskContainer_{your_nodename}_server1_WSDLFiles.zip to your temporary directory.
8. Extract this *.zip file to this temp directory. Delete the h.jar file that is not needed.
   

   

1. Using the Explorer navigate down to the BFMJAXWSService.wsdl file as shown in the diagram below.
   Open this wsdl file with a text editor.
   

   

   You might want to explore this ear file and browse through the BFMJAXWSService.wsdl file.
   
   
   
   
2. Near to the end of this file locate the soap:address location and copy this url including your server to the clipboard.
   

   

3. Open a browser and paste the content of your clipboard.
   Extend the link by adding ?wsdl. Press Goto ... .
   

   

4. Copy the link which is now shown in the entry field to your clipboard.
   

   
   
   -wsdllocation file:/WEB-INF/wsdl/com/ibm/bpe/api/jaxws/BFMJAXWSService.wsdl
    relative Pfadangabe, ebenso für HTM Servcie. wsdl
   
   copy manual from temp\...\WEB-INF/wsdl to WebServiceClient_WEB\WebContent\WEB-INF\ for BFM and HTM
   

5. Generate the BFM proxy using following command:

   <WPS_INSTALL_ROOT>\bin\wsimport.bat
   BPEContainer_qnode_server1.ear\bfmjaxws.war\WEB-INF\wsdl\com\ibm\bpe\api\jaxws\BFMJAXWSService.wsdl
   custom-wsdls\advertiseProcessInterface.wsdl -d 7000-bfm -s 7000-bfm-src
   -wsdllocation http://fmtc5019.boeblingen.de.ibm.com:9081/BFMJAXWSAPI/BFMJAXWSService/WEB-INF/wsdl/com/ibm/bpe/api/jaxws/BFMJAXWSService.wsdl
   

   where
   • <WPS_INSTALL_ROOT>   might look like  c:\Program Files\IBM\WID7_WTE\runtimes\bi_v7\.
     
   • the location of the BFMJAXWSService.wsdl file can be copied from the exploded folder as shown in step 1.
     
   • the process wsdl of your process(es) is stored in the sub folder custom-wsdls as shown in Provide your process interfaces.
   • the wsdl location is the link you copied from the browser in the step 4.
     
     
6. Open a command prompt and navigate to your temporary directory.
   Enter the command to generate the BFM proxy according to your specifications, for example:

    "c:\Program Files\IBM\WID7_WTE\runtimes\bi_v7\profiles\qwps\bin\wsimport.bat" BPEContainer_qnode_server1.ear\bfmjaxws.war\WEB-INF\wsdl\com\ibm\bpe\api\jaxws\BFMJAXWSService.wsdl custom-wsdls\advertiseProcessInterface.wsdl -d 7000-bfm -s 7000-bfm-src -wsdllocation http://fmtc5019.boeblingen.de.ibm.com:9081/BFMJAXWSAPI/BFMJAXWSService/WEB-INF/wsdl/com/ibm/bpe/api/jaxws/BFMJAXWSService.wsdl

   

7. The following screenshots shows the folders and an extract of the generated BFM proxy.

   

1. Using the Explorer navigate down to the HTMJAXWSService.wsdl file as shown in the diagram below.
   Open this wsdl file with an editor.
   

   

   You might want to explore this ear file and browse through the HTMJAXWSService.wsdl file.
   
   
2. Near to the end of this file locate the soap:address location and copy this url including your server to the clipboard.
   

   

3. Open a browser and paste the content of your clipboard.
   Extend the link by adding ?wsdl. Press Goto ... .

   

4. Copy the link which is now shown in the entry field to your clipboard.
   

   
   
   
   -wsdllocation file:/WEB-INF/wsdl/com/ibm/bpe/api/jaxws/BFMJAXWSService.wsdl
    relative Pfadangabe, ebenso für HTM Servcie. wsdl
   
   copy manual from temp\...\WEB-INF/wsdl to WebServiceClient_WEB\WebContent\WEB-INF\ for BFM and HTM
   

5. Generate the HTM proxy using following command:
   <WPS_INSTALL_ROOT>\bin\wsimport.bat"
   TaskContainer_qnode_server1.ear\htmjaxws.war\WEB-INF\wsdl\com\ibm\task\api\jaxws\HTMJAXWSService.wsdl
   custom-wsdls\advertiseProcessInterface.wsdl -d 7000-htm -s 7000-htm-src
   -wsdllocation http://fmtc5019.boeblingen.de.ibm.com:9080/HTMJAXWSAPI/HTMJAXWSService/WEB-INF/wsdl/com/ibm/task/api/jaxws/HTMJAXWSService.wsdl
   

   where
   • <WPS_INSTALL_ROOT>   might look like  c:\Program Files\IBM\WID7_WTE\runtimes\bi_v7\.
     
   • the location of the HTMJAXWSService.wsdl file can be copied from the exploded folder as shown in step 1.
     
   • the process wsdl of your process(es) is stored in the sub folder custom-wsdls as shown in Provide your process interfaces.
   • the wsdl location is the link you copied from the browser in the step 4.
     
     
6. Open a command prompt and navigate to your temporary directory.
   Enter the command to generate the HTM proxy according to your specifications, for example:

   "C:\Program Files\IBM\WID7_WTE\runtimes\bi_v7\bin\wsimport.bat" TaskContainer_qnode_server1.ear\htmjaxws.war\WEB-INF\wsdl\com\ibm\task\api\jaxws\HTMJAXWSService.wsdl custom-wsdls\advertiseProcessInterface.wsdl -d 7000-htm -s 7000-htm-src
   -wsdllocation http://fmtc5019.boeblingen.de.ibm.com:9080/HTMJAXWSAPI/HTMJAXWSService/WEB-INF/wsdl/com/ibm/task/api/jaxws/HTMJAXWSService.wsdl
   
   

   

7. The following screenshots shows the folders and an extract of the generated HTM proxy.

   

echo merge source files
xcopy /E /Y 7000-bfm-src 7000-all-src
xcopy /E /Y 7000-htm-src 7000-all-src

echo merge class files
xcopy /E /Y 7000-bfm 7000-all
xcopy /E /Y 7000-htm 7000-all

Complete the following steps:

1. In the Java EE perspective select the Project Explorer view.
2. Expand the MyWebServiceClient, right-click in the WebContent folder.
   From the pop up menu select New > HTML.
   

   

   
   The New HTML Page window opens.

3. For the file name enter index.html and click Finish.
   

   

   The Page Designer window opens.

4. Change the <title... to index.html
   
5. Replace the default code by the following code:

    <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
   <html>
   <head>
   <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
   <title>Web service API - Sample</title>
   </head>
   <body>
     <CENTER>
     <H1>Web service API - Sample</H1>
     <HR width="100%">
     <BR><BR><BR>
     <BR>Please press the button to see all process templates installed on the server:
     <FORM action="invoke.jsp" method ="get">
        <INPUT type="text" value="Insert userid" name="username"><br>
        <INPUT type="password" value="Insert password" name="password"><br><br>
     <INPUT type="submit" value="List process templates">
     </FORM>
     </CENTER>
   </body>
   </html>
   

   The important code snippet here is the <FORM> element, which triggers a call to the JSP that we will define in the next section.

   

6. Click Ctrl+S to save the index.html file.

1. In the Java EE perspective select the Project Explorer view.
2. Expand the MyWebServiceClient, right-click in the WebContent folder.
   
3. From the pop up menu select New > JSP.
   The New Java Server Page window opens.

   

4. In the File name field, enter invoke.jsp and click Finish.
   The Page Designer window opens.

   

5. Right after the first line <%@ page language=...> insert the following lines:

   <%@page import="com.ibm.xmlns.prod.websphere.business_process.services._7_0.binding.*"%>
   <%@page import="com.ibm.xmlns.prod.websphere.business_process.types._7.*"%>
   <%@page import="com.ibm.xmlns.prod.websphere.bpc_common.types._7.*"%>
   <%@page import="com.ibm.xmlns.prod.websphere.business_process.services._7.QueryProcessTemplates"%>
   <%@page import="com.ibm.xmlns.prod.websphere.business_process.services._7.QueryProcessTemplatesResponse"%>
   <%@page import="com.ibm.xmlns.prod.websphere.business_process.services._7.GetProcessTemplate"%>
   <%@page import="java.util.List"%>

6. Just before the first <META> element insert the following line:

   <jsp:useBean id="BFMService" class="com.ibm.xmlns.prod.websphere.business_process.services._7_0.binding.BFMJAXWSService" scope="session"></jsp:useBean>
   

   This line allows to use the generated Java proxy during the remainder of the browser session.

7. Specify the  <TITLE> to invoke.jsp.
8. In addition, replace the code within the  <BODY>...</BODY> statements by the following code snippet:

<CENTER>
  <H1>Web service API - Sample</H1>
  <HR width="100%"><BR><BR>
<%
    BFMJAXWSPortType bfm = BFMService.getBFMJAXWSPort();
%>
  <BR><BR><A href="index.html" target="_self">Basic sample - Home</A>
  </CENTER>




9. Click Ctrl+S to save the file.

1. Define new package
   In the Project Tree expand MyWebServiceClient > Java Resources > src.
   Right click src. From the pop up menu select New > Package.
   

   
   
   The New Java Package creation window opens.
   

2. For the package name enter com.ibm.jaxws.sample.security.
   Press Finish.
3. Download security helper class
   Click on the link MySecurityHelper class which displays the code. Press File > Save Page as this a MySecurityHelper.java to a directory of your choice, for example c:\temp\.
4. Import MySecurityHelper file
   In WebSphere Integration Developer, right click on your new package com.ibm.jaxws.sample.security.
   From the pop up menu select Import.
   The Import Select window opens. Select General > File System. Press Next. Within import from directory brows and navigate to your temp directory. Select the MySecurityHelper.java file.
   Press Finish.

   
   
   Note:
   In case you have any errors ensure that the required libraries are available.
   
   
   

5. Update the invoke.jsp file to support authentication.
   Within the Project Explorer navigate to the WebContent folder and open the invoke.jsp file.
   Just before the first <!DOCTYPE html ...> element insert the following line:

   <%@page import="com.ibm.jaxws.sample.security.MySecurityHelper"%>

   Add the security token to the proxy.
   Just after the line BFMJAXWSPortType bfm = .... element insert the following snippet:

   //do security
   String user = request.getParameter("username");
   String password = request.getParameter("password");
   MySecurityHelper.enhanceWithUsernameToken(bfm, user, password);
   

   This results in:

   

6. Update the invoke.jsp to issue the query process template api.
   The following code shows just the usage of one of the Web service operations, namely the queryProcessTemplates() operation. It queries and retrieves the available templates and certain properties the user is authorized to access.
   
   Insert this code snippet immediately following the security snippet you inserted in preceeding step. It will be located between the <%  ... %> which means that Java code will be executed within a jsp.

   try {
      QueryProcessTemplates parameters = new QueryProcessTemplates();
      
      ProcessTemplatesType ptt = bfm.queryProcessTemplates(null,null, null, null);
    
      List listTemplates = ptt.getProcessTemplate();
      ProcessTemplateType processTemplateType;
    
       out.println("hello " + user + " - ");
       out.println(listTemplates.size() +" process template(s) found, details following:<BR><BR>");
       out.println("<TABLE border='2'>");
       out.println("<TR><TD><B>Name</B></TD><TD><B>Process Template ID</B></TD><TD><B>Auto-delete</B></TD><TD><B>Long running</B></TD></TR>");
       for (int i=0; i<listTemplates.size();i++) {
          processTemplateType = (ProcessTemplateType) listTemplates.get(i);
        
         out.println("<TR>");
         out.println("<TD>" + processTemplateType.getName()+ "</TD>");
         out.println("<TD>" + processTemplateType.getPtid() + "</TD>");
         out.println("<TD>" + processTemplateType.getAutoDeletionMode() + "</TD>");
         out.println("<TD>" + processTemplateType.getExecutionMode() + "</TD>");
         out.println("</TR>");
       } // end for
       out.println("</TABLE>");
   
   } catch (Exception e) {
     out.println("Error while doing call: "+e);
   }
   

   The screenshot below shows the inserted code to the invoke.jsp file to query and display the process templates.
7. Press Ctrl+S to save the file.

1. Publish the client application.
   Access the server tab. Press the Publish ccon to re-publish the MyWebServiceClient application with  the modified invoke.jsp file-
   
   
2. In a Web browser, refresh the page with thee URL http://yourhost:yourport/MyWebServiceClient/index.html.
   The index page opens.
   
3. With in the index page you are asked to Insert userid and password. Authenticate to your WebSphere Process Server during your current browser session with your userid and password, e.g. admin / admin.
   
4. Press List process templates.
5. The client application sends the request to the BPE Container (Provider) to retrieve the process template list and to display the items in a table. The atttributes include the Process Template ID (PTID) which subsequently can be used to start process instances.
   
   The result of this query is displayed. You will have different process templates currently deployed.
   
   

   

   
   
6. Click Basic sample - Home.