Integrating IBM Business Process Manager with a hybrid MobileFirst application
- 1. © Copyright IBM Corporation 2015 Trademarks Integrating IBM Business Process Manager with a hybrid MobileFirst application Page 1 of 13 Integrating IBM Business Process Manager with a hybrid MobileFirst application Use the IBM MobileFirst Platform Foundation V6.3 through a Secure Sockets Layer with IBM BPM Advanced V8.5.X Ganesh Nagalingam (ganesh.nagalingam@in.ibm.com) Smarter Process Application Architect IBM 24 June 2015 This tutorial shows how to integrate IBM® Business Process Manager (BPM) Advanced V8.5.X with a hybrid MobileFirst application using the IBM MobileFirst Platform Foundation V6.3 through a Secure Sockets Layer (SSL). Introduction If a business process contains activities that communicate from Business Process Modelling Notation (BPMN) to Business Process Execution Language (BPEL), you can integrate IBM BPM Advanced with IBM MobileFirst Platform Foundation. Then process partipants (business users) don't need to be sitting in front of a computer. They can trigger the request from a mobile device and invoke a business process, which is an easy way to arrive at the same result. Try the Workflow service Create long-running, stateful workflows that orchestrate tasks and services with synchronous or asynchronous event-driven interactions with the Workflow service from Bluemix. Try it for free! This tutorial walks through a business use case that defines the interaction between a hybrid MobileFirst application, the user-centric BPMN in IBM Process Designer, and the system-centric BPEL in IBM Integration Designer through Advanced integration services (AIS). The solution used in this tutorial shows how a business user can send a request from a mobile device and create a process instance in IBM Business Process Manager through SSL integration. When the process instance is created successfully, the process instance ID is returned back to the mobile device for reference. Because human activities are involved, the business user claims the process instance using the IBM BPM Process Portal. In cases when only system activities are
- 2. developerWorks® ibm.com/developerWorks/ Integrating IBM Business Process Manager with a hybrid MobileFirst application Page 2 of 13 involved, human intervention is not required, and the business process is automatically completed on request from the mobile device. Scope This tutorial is intended for intermediate readers and above who have exposure to the following products: • • IBM BPM Advanced V8.5.X, including IBM Process Designer and IBM Integration Designer • IBM MobileFirst Platform Foundation V6.3 • Eclipse Juno V4.2.2 • Android SDK 5.0.1 (API 21) Overview of integration steps This tutorial illustrates integration techniques through an example, proof-of-concept solution developed to explore how IBM BPM Advanced V8.5.X can integrate with IBM MobileFirst Platform Foundation. The solution has been tested, and screen captures of results are included in this tutorial. The solution created with IBM BPM Advanced V8.5.5 will work with forward versions of IBM BPM Advanced V8.5.X, and it will work with all IBM BPM V8.5 versions. First, you create a stand-alone Process Center profile to use for the development environment. For test and production environments, create a Process Server and use it for application deployment. Then you secure access to an HTTPS web service that is exposed by a business process definition (BPD) and is controlled by a worklight.properties file that checks for ssl.keystore.path, ssl.keystore.type, ssl.keystore.password. The tutorial provides a diagrammatic explanation of SSL access. The hybrid MobileFirst application communicates with an inbound web service exposed by a BPD in Process Center. The inbound web service exposed by a BPD is always a HTTPS web service, which uses SSL. That's why it requires converting .cer and .crt files to keystores, then importing certificates and adding them to the cacerts truststore. The cacerts file is a truststore. It is used for authenticating the request through public key and private key technique. The term "cacerts," stands for a trustore where Java™ certificate authority (CA) certificates are stored. This tutorial walks through the following steps: • Integrating an HTTP adapter through the SSL between IBM BPM Advanced V8.5.5 and a hybrid MobileFirst application developed using IBM MobileFirst Platform Foundation V6.3. • Generating SSL certificates, creating a keystore, and adding them to the cacerts truststore. • Adding the cacerts truststore to the worklight.properties file to communicate with a web service exposed by a BPD in Process Center. • Orchestrating BPMN and connecting BPEL through Advanced integration services. • Creating a stand-alone Process Center profile in the development environment to publish and deploy business process applications and Service Component Architecture (SCA)
- 3. ibm.com/developerWorks/ developerWorks® Integrating IBM Business Process Manager with a hybrid MobileFirst application Page 3 of 13 applications in IBM BPM Advanced V8.5.5. An advantage is to have one Java virtual machine running, which benefits low-memory systems. • Creating and deploying HTTP SOAP adapters in the IBM MobileFirst Platform Foundation. The sample code, which you can extract from the code_sample.zip file in the Downloads section, contains the following artifacts, tested as a proof-of-concept for this tutorial. • a hybrid MobileFirst application project interchange compressed file • a stand-alone Process Center profile properties file • a process application .twx file Architecuture The high-level integration diagram in Figure 1 shows the communication pattern between the hybrid MobileFirst application, the HTTP adapter that is deployed in IBM MobileFirst Platform Foundation, and the web service exposed by a BPD in Process Center. The BPMN connects BPEL through advanced integration services. IBM BPM Advanced is built on IBM WebSphere Application Server Network Deployment, and this tutorial explains advantages of creating a stand-alone Process Center profile. Figure 1 shows that a hybrid MobileFirst application sends a request to the HTTP SOAP adapter. The HTTP SOAP adapter is deployed in the IBM MobileFirst Platform Foundation (an IBM Liberty single-node template). The HTTP SOAP adapter sends an SSL request to the inbound web service exposed by Process Center. The web service returns a response that is converted into Java Script Object Notation (JSON) in a hybrid MobileFirst application. The diagram shows the local setup of the IBM MobileFirst Platform Foundation and stand-alone Process Center servers up and running. Figure 1. High-level integration diagram IBM BPM Advanced Business process management is the systematic method of examining your organization's existing business processes and implementing improvements to make your workflow more effective and more efficient. Every organization uses business processes to accomplish work. A business process is a set of business activities that represent the required steps to achieve a business objective. Business processes often require a combination of internal activities and activities that must be performed by humans. Therefore, you can look at business process management as the intersection between people, processes, and technology. The business process management
- 4. developerWorks® ibm.com/developerWorks/ Integrating IBM Business Process Manager with a hybrid MobileFirst application Page 4 of 13 approach is iterative as you design, model, create, simulate, monitor, and optimize your processes on a regular basis. The feedback you receive from testing and monitoring your processes drives continuous improvements to your organization's workflows. The Process Center repository contains all IBM BPM assets. The high-level assets are process applications, toolkits, tracks, and snapshots. Both the business analyst and the integration developer contribute to the same process applications and toolkits. Process Designer contributes business processes and data types. Integration Designer contributes modules, libraries, and BPEL business logic. Creating a stand-alone Process Center profile using the BPMConfig tool A stand-alone Process Center profile has the advantage of publishing and deploying process applications and SCA applications respectively using a single profile. A stand-alone Process Center profile can be created using the BPMConfig command-line tool and giving the profile properties file as an argument. The next section in the tutorial gives details on how to create a stand-alone Process Center profile. Screen captures show the key properties to be set and the command to execute to make a successful profile creation. You can take either a top-down approach or a bottom up approach to create, publish and unit test that will have one server profile running (one Java Virtual Machine) on the local machine. If you have low-memory systems, adopt the stand-alone Process Center approach, because it helps to store, test process applications and toolkits that are authored in IBM Process Designer v8.5.5 and IBM Integration Designer v8.5.5. For the top-down approach, create toolkits or process applications in the Process Designer that contain interfaces and business objects that can be imported into IBM Integration Designer where you implement the business logic. This approach is usually followed by stakeholders and business analysts. For the bottom-up approach, normally used by developers and architects, create SCA modules, implement, and test them. Import the toolkit or the process appplication into IBM Integration Designer in the Process Center perspective. Then the SCA module can be associated to a process application or toolkit. One stand-alone Process Center profile has the capability to deploy process applications and SCA applications. Install the IBM BPM Advanced V8.5.5 binary files. The BPMConfig command-line tool takes the profile properties file as an argument to successfully create a stand-alone Process Center. Complete the following steps: 1. Create a stand-alone Process Center profile from the command prompt by running the following command: BPMConfig.bat –create –de standalonePC.properties 2. In the properties file, create set the values for your project. The key values to set for successful profile creation are shown in the following example properties file. Replace appropriate values as needed for your local setup.
- 5. ibm.com/developerWorks/ developerWorks® Integrating IBM Business Process Manager with a hybrid MobileFirst application Page 5 of 13 bpm.de.authenticationAlias.1.name=DeAdminAlias bpm.de.authenticationAlias.1.user=admin bpm.de.authenticationAlias.1.password=admin bpm.de.authenticationAlias.3.name=BPM_DB_ALIAS bpm.de.authenticationAlias.3.user=admin bpm.de.authenticationAlias.3.password=db2admin bpm.de.node.1.hostname=gnagalingam bpm.de.node.1.installPath=C:/BPM/WebSphere/AppServer bpm.de.node.1.profileName=procCtr1 bpm.de.node.1.server.db=ProcessServerDb,SharedDb,PerformanceDb bpm.de.db.2.hostname=gnagalingam bpm.de.db.2.portNumber=50000 bpm.de.db.2.sqlServerWinAuth=false Designing and configuring a hybrid MobileFirst application in the IBM MobileFirst Platform Foundation IBM MobileFirst Platform Foundation, formerly IBM Worklight, helps enterprises deliver on their mobile strategy. It provides an open and comprehensive platform to not only build, but also test, run, and manage your native, hybrid and mobile web applications. IBM MobileFirst Platform Foundation is composed of the following components: • IBM MobileFirst Platform Studio offers leading tools for mobile applications development that help maximize code reuse and accelerate development. • IBM MobileFirst Platform Server is mobile-optimized middleware that serves as a gateway between applications, back-end systems and cloud-based services. Business value proposition Enterprise Application Integration (EAI) provides an open, extensible framework for connecting applications within or between enterprises. EAI solutions ensure compliance and interoperability through open messaging, open queuing, open development tools, adapters (applications, web, e- commerce, communications, legacy, generic), and data standards (XML, EDI, HL7, Swift) across all major platforms. Within an EAI framework, web service integration exists at both the adapter and the business process level. Adapters provide communications and data transformation capabilities to enabling rapid integration into packaged, legacy and custom applications. Any of these applications can in turn access a web service or be called by a web service through a SOAP adapter to web service, which enables these existing applications. The adapter performs the hard work by mapping the existing system into the web service interface. A hybrid MobileFirst application can seamlessly integrate through HTTP adapters deployed in IBM MobileFirst Platform Foundation and invoke a web service exposed by a BPD in Process Center. At the business process level, business process management solutions are used to control the flow of business process activities across the systems and users involved. BPM solutions typically offer process modeling, implementation, monitoring, management, and process optimization
- 6. developerWorks® ibm.com/developerWorks/ Integrating IBM Business Process Manager with a hybrid MobileFirst application Page 6 of 13 services to streamline processes and improve efficiency. A web service can be called as needed from any activity within a business process, and in turn, a larger business process can be exposed as a web service to be called by other systems or partners. A web service is an application that adheres to new connectivity standards (SOAP, WSDL, and UDDI) that are based on more mature Internet standards (HTTP and XML). This standards-based connectivity allows a web service implementation to dynamically discover and interact with other web services automatically. A stand-alone Process Center profile in IBM BPM Advanced V8.5.5, provides the advantage for systems that face low memory of having only one Java virtual machine running in a development environment. The profile helps to store, test and manage process applications and toolkits that are authored using Process Designer and Integration Designer. The following subsections describe key integration features. SSL configuration A web service exposed by a BPD in Process Center is an HTTPS service. In order to access an SSL service from a hybrid MobileFirst application, the certificate from the Process Center server must be imported and added to the keystore in the cacerts file. This certificate enables the mobile application to successfully invoke the web service in Process Center. Figure 2 shows the adapter checks for the SSL certificate in the configuration file before invoking the web service in Process Center. Figure 2. SSL configuration IBM MobileFirst Platform Foundation and adapter configuration A web service can be discovered in a hybrid MobileFirst application by choosing the appropriate adapter. To create a SOAP over an HTTP service, HTTP SOAP adapters are created and deployed in IBM MobileFirst Platform Foundation. Because the web services exposed by Process Center are SSL enabled, certificates should be imported and converted as keystores and added to the cacerts file. The adapters check the worklight.properties file for the certificate path, type, and password before invoking the web service. Figure 3 shows how to create and import certificates into keystore and add them to the cacerts file. This step is only required if the certificate of the back-end web service is not signed by a well-known certificate authority.
- 7. ibm.com/developerWorks/ developerWorks® Integrating IBM Business Process Manager with a hybrid MobileFirst application Page 7 of 13 Figure 3. Create and import keystore to the cacerts truststore using keytool Deploying and running your process application A stand-alone Process Center profile is used to publish and deploy process applications (BPMN) and SCA applications (BPEL/ESB). BPMN in IBM Process Designer The BPMN process connects to BPEL through Advanced integration services. The business process definition in the process application exposes an HTTPS web service that is consumed by a hybrid MobileFirst application. To start the business process, the hybrid MobileFirst application invokes the web service exposed by a BPD, which is executed by integration service encapsulated in a BPD. The integration service executes tw.system.startProcessByName to start the business process specified with input parameters received from the hybrid MobileFirst application, and it returns the processId for reference. After the process payment activity is successful, an email is sent to the customer from the business process to inform the status, as shown in Figure 4.
- 8. developerWorks® ibm.com/developerWorks/ Integrating IBM Business Process Manager with a hybrid MobileFirst application Page 8 of 13 Figure 4. Business process definition Process execution Figure 5 shows the input values given in the Mobile Browser Simulator for Android. A business user runs a call on IBM Business Process Manager to send a request, and a successful response is shown in Figure 5 that has the process ID created in IBM BPM Advanced: pId...258 and "success":"true". As shown in Figure 5, the business user submits the required data using a mobile device, which automatically creates a process instance ID in IBM BPM and returns a response to the mobile device to show the successful creation of the process instance ID with the ID 258.
- 9. ibm.com/developerWorks/ developerWorks® Integrating IBM Business Process Manager with a hybrid MobileFirst application Page 9 of 13 Figure 5. Mobile Browser Simulator The next screen capture shows the Business Process instance created in Process Portal that can be claimed. Because the first activity in the process diagram is a human activity, it has to be claimed and needs human intervention. IBM BPM Process Portal Figure 6 shows the request sent from the hybrid MobileFirst application has successfully created a process instance in Process Portal. You can see that the Process instance (Process ID 258) is created in the IBM BPM Process Portal, which business users view through web browsers on their computers.
- 10. developerWorks® ibm.com/developerWorks/ Integrating IBM Business Process Manager with a hybrid MobileFirst application Page 10 of 13 Figure 6. Process instances in Process Portal Conclusion The tutorial showed how to integrate a hybrid MobileFirst application and IBM BPM Advanced V8.5.5. You saw a diagrammatic explanation on SSL configurations and how adapters from hand- held Android mobile devices can invoke HTTPS web services that are exposed by Process Center. The tutorial showed how to create a stand-alone Process Center profile using the BPMConfig tool and passing the properties file as an argument. An advantage of using a stand-alone Process Center profile in IBM BPM Advanced V8.5.5 is that you can publish and deploy process applications and SCA applications in systems with low memory (for example, laptops) with only one Java virtual machine running. Now you can apply the techniques learned in this tutorial to projects that you are working on, benefiting from integrating IBM MobileFirst Platform Foundation technology with IBM BPM Advanced V8.5.5. Acknowledgements The author would like to thank Praveen John and Bill Dodd for their review and input.
- 11. ibm.com/developerWorks/ developerWorks® Integrating IBM Business Process Manager with a hybrid MobileFirst application Page 11 of 13 Downloads Description Name Size Code sample code_sample.zip 24452KB
- 12. developerWorks® ibm.com/developerWorks/ Integrating IBM Business Process Manager with a hybrid MobileFirst application Page 12 of 13 Resources • Get the Developer Edition: IBM MobileFirst Platform Studio (IBM MobileFirst Platform developer center) • Download instructions for IBM Business Process Manager Advanced Version 8.5.5 (IBM Support website) • developerWorks Business process management zone • Integrating WebSphere Service Registry and Repository V8 with the Process Server in IBM Business Process Manager (developerWorks tutorial) • IBM Business Process Management products • IBM Business Process Manager product page • Product support website for IBM Business Process Manager Advanced • IBM Business Process Manager documentation on IBM Knowledge Center • IBM Redbooks about IBM Business Process Manager • IBM Business Process Manager Developer Center
- 13. ibm.com/developerWorks/ developerWorks® Integrating IBM Business Process Manager with a hybrid MobileFirst application Page 13 of 13 About the author Ganesh Nagalingam Ganesh Nagalingam is an architect, IBM Certified I/T Specialist in IBM Global Business Services, Chennai, India. He specializes in and creates proof-of-concepts and integration solutions for IBM Business Process Manager, IBM Process Designer, and IBM Integration Designer in the Smarter Process technology space and in the integration technology space. He also specializes in IBM MobileFirst Studio V6.3.0, Eclipse Juno V4.2.2, and Android SDK 5.0.1 (API 21). © Copyright IBM Corporation 2015 (www.ibm.com/legal/copytrade.shtml) Trademarks (www.ibm.com/developerworks/ibm/trademarks/)