IBM Business Process Manager Telecom Pack version 7.5. Order Handling How To Guide

Transcription

1 IBM Business Process Manager Telecom Pack version 7.5 Order Handling How To Guide

2 Note Before using this information and the product it supports, read the information in Notices at the end of this book. Permissions for the use of these publications are granted subject to the following terms and conditions. Personal Use: You may reproduce these publications for your personal, non-commercial use provided that all proprietary notices are preserved. You may not distribute, display or make derivative work of these publications, or any portion thereof, without the express consent of IBM. Commercial Use: You may reproduce, distribute, and display these publications solely within your enterprise provided that all proprietary notices are preserved. You may not make derivative works of these publications, or reproduce, distribute or display these publications or any portion thereof outside your enterprise, without the express consent of IBM. Except as expressly granted in this permission, no other permissions, licenses, or rights are granted, either express or implied, to the publications or any information, data, software or other intellectual property contained therein. IBM reserves the right to withdraw the permissions granted herein whenever, in its discretion, the use of the publications is detrimental to its interest or, as determined by IBM, the above instructions are not being properly followed. You may not download, export, or re-export this information except in full compliance with all applicable laws and regulations, including all United States export laws and regulations. IBM MAKES NO GUARANTEE ABOUT THE CONTENT OF THESE PUBLICATIONS. THE PUBLICATIONS ARE PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.

3 Contents Preface v Chapter 1. Understanding the scenario 1 Description Business process Key Pain Points Key Performance Indicators and Business Measures. 2 Roles for the BPM solution Chapter 2. End-to-end process for implementing the BPM solution Chapter 3. Prerequisite Steps Performing gap analysis for identifying assets... 7 Identifying assets using the Asset Navigator Chapter 4. Step 1 : Model the Order Handling Business Process Creating a new business process Modifying the Business Process Definition Adding service tasks to the business process Creating Business Objects in IBM Process Designer 16 Adding human services to the business process.. 17 Using participant groups Defining rule services for a business process Simulating process using playback server Summary Chapter 5. Step 2 : Integrating services 25 Implementing web services Creating the implementation logic Creating a mediation module for the simple web service Deploying the web service Unit testing web services using IBM Integration Designer Implementing Advanced Integration Services Creating the Advanced Integration Service Creating a mediation module for the Advanced Integration Service Creating the implementation logic for the Advanced Integration Service Unit testing Advanced Integration Services using IBM Integration Designer Summary Chapter 6. Step 3 : Creating reports and custom dashboards Creating tracking groups Creating simple reports Exporting tracking definitions to Monitor Creating advanced reports and dashboards using Monitor toolkit Defining Metrics Defining Key Performance Indicators Defining the visual model Testing the monitor model Project Interchange file 58 Summary Chapter 7. Step 4 : Implementing data persistence Working with the physical data model Setting up a physical database Implementing a data access layer Integrating the data access layer with the services layer Summary Chapter 8. Step 5 : Deploying the process application Configuring the BPM solution manually Installing the Order Handling Solution Scenario artifacts Configuring the user registry in IBM Process Server Configuring user access for Business Space Configuring Business Space Adding the report to Business Space Testing and executing the BPM solution Testing the process executions and viewing instances Verifying dashboards for KPI and metrics updates Executing the BPM solution Summary Index Notices and Trademarks Copyright IBM Corp. 2006, 2011 iii

4 iv IBM Business Process Manager Telecom Pack version 7.5 : Order Handling How To Guide

5 Preface About this guide By using a real business scenario, this guide describes how to use and extend the IBM Business Process Manager Telecom Pack assets. Audience The document is intended for developers and architects that use the Business Process Manager Telecom Pack to develop service-oriented business solutions. It is assumed the reader is acquainted with the following: v Familiarity with development of Java 2 Platform Enterprise Edition (J2EE) and SOA-based applications using the IBM Integration Designer 7.5 and the Rational Software Architect or later. Organization This document is organized as follows: v Chapter 1: Understanding the Order Handling problem scenario This provides an overview and problems for the Order Handling BPM Solution. v Chapter 2: End-to-end process for implementing the BPM solution This provides the flow diagram for with the steps for developing the Order Handling BPM Solution. v Chapter 3: Prerequisite Steps This provides the steps for identifying the assets for developing the Order Handling BPM Solution. v Chapter 4: Step 1 : Model the Order Handling Business Process This provides the steps for customizing the business process for developing the Order Handling BPM Solution. v Chapter 5: Step 2 : Integrating services This provides the steps for implementing web services and advanced integration services for the Order Handling BPM Solution. v Chapter 6: Step 3 : Creating reports and custom dashboards This provides the steps for monitoring the Order Handling business activities using tracking groups and reports. v Chapter 7: Step 4 : Implementing data persistence This provides the steps for configuring a database for the Order Handling BPM Solution. v Chapter 8: Step 5 : Deploying the process application This provides the steps for configuring and testing the Order Handling BPM Solution. Related documents In addition to this document, see the following documentation to install and work with the Business Process Manager Telecom Pack: Copyright IBM Corp. 2006, 2011 v

6 v Business Process Manager Telecom Pack version Installation Guide The following documentation can be used to comprehend the Business Process Manager Telecom Pack version 7.5: v Business Process Manager Telecom Pack Developer's Guide v IBM Integration Designer version 7.5 documentation v IBM Process Server version 7.5 documentation v IBM Business Monitor version 7.5 documentation v Business Space version 7.5 documentation vi IBM Business Process Manager Telecom Pack version 7.5 : Order Handling How To Guide

7 Chapter 1. Understanding the scenario This section addresses the key customer problems for the Order Handling scenario including the as-is process flow, Key Performance Indicators (KPI), and business measures. Description The Order Handling scenario covers the end-to-end order fulfillment process for the following processes: v Product Order feasibility v Service and resource provisioning v Partner or supplier requisition v Order issuance & tracking v Customer billing Business process The business process flow represented in this section shows the different activities involved in fulfilling a customer order such as collecting order details, performing various feasibility checks, provisioning of resources and services, issuing the order, and setting up billing accounts. Initiate Commercial Feasibility Customer Product Order Request Finalize Customer Negotiation Reservation before Submission Issue Customer Order Initiate Technical Feasibility Adjust Product Selection Track & Manage Customer Order Handling Decompose Service Orders Track & Manage Service Provisioning Decompose Resource Orders Track & Manage Resource Provisioning Close Resource Orders All Resources Completed Decompose Supplier/Partner Orders Track & Manage Supplier/ Partner Requisition Close Supplier/ Partner Orders Close Service Orders Issue Completed Customer Order Close Customer Order Update Customer Billing You may need to zoom in for reading contents Figure 1. Telecom work flow diagram The high-level tasks for the Order Handling process are: IBM 2009 IBM 2006,

8 Key Pain Points 1. Retrieving details: The Customer Service Representative uses the customer name or additional details such as mobile phone number or order ID, to retrieve details of an existing customer. If the customer details are not available, the Customer Service Representative accepts details for the new customer. 2. Verifying customer details The Customer Service Representative verifies the details of the customer and updates the details if required. 3. Selecting an order: The Customer Service Representative selects the available product that a customer requires. 4. Viewing the order summary: The Order Fulfillment Summary displays information to the customer about the provisioned services and unavailable services, if any. The summary is also displayed when there is an order provisioning failure. 5. Notifying the customer: The Customer Service Representative notifies the customer about the order being provisioned and confirms the service provisioning date with the customer. While handling customer orders telecommunication service providers face the challenges listed in this section: v Complexity and dynamic nature of product and catalog hierarchy affects processing of new orders. v Product information catalogued across various Customer, Fulfillment, and Billing systems. v Poor interoperability with resource systems. Using the BPM Solution development approach provided with the Business Process Manager Telecom Pack and using the BPM best practices, the following sections aims to achieve the following tasks: v Ensures seamless processing of customer orders for new and existing customers. v Gains complete insight into the order handling process from start to finish. v Provides strong collaboration capabilities across multiple actors in the Order Management area. Key Performance Indicators and Business Measures The Key Performance Indicators and Business Measures provide Better Telecom the ability to track the track the customer order progress and monitor the received orders. Based on the scenario provided, Better Telecom needs to monitor the Key Performance Indicators (KPIs) and Business Measures provided in this section. v Volume of orders processed per month. v Order distribution by state for the current month. v Average duration for order handling for the day. v Order distribution by state for the current month. (For Business Space) 2 IBM Business Process Manager Telecom Pack version 7.5 : Order Handling How To Guide

9 Roles for the BPM solution The table in this section lists the key stakeholders that will be involved in implementing the solution from a business and IT perspective: Table 1. Roles for the BPM solution Roles Names Functions Business roles Process Owner Lee Larson The Process Owner defines the high-level process flows using business services. Business Analyst Bart Brecken The Business Analyst creates the Process Flows, KPIs, and Business Measures required for the BPM solution. Process Architect Perry Purdue The Process Architect works with the Process Owner and Business Analyst to assemble the BPM solution using Business Services. IT-related roles IT Administrator Adam Anderson The IT Administrator identifies, configures, and tests the hardware and software that is required for the BPM solution. Integration Developer Igor Iron The Integration Developer assembles the different BPM components to build the BPM solution. Business Programmer Bob Bailey The Business Programmer performs coding and migration of assets between environments for building the BPM solution. Data Architect Chuck Goldman The Data Architect creates a logical data model based on the data requirements and implements a corresponding physical data model. User roles Business Manager Martha Green The Business Manager monitors the Order handling process and ensures that the required tasks are complete. Customer Service Representative (CSR) Jay Walk The CSR processes the customer order on behalf of the customer. Chapter 1. Understanding the scenario 3

10 4 IBM Business Process Manager Telecom Pack version 7.5 : Order Handling How To Guide

11 Chapter 2. End-to-end process for implementing the BPM solution The diagram in this section provides the various steps necessary to search and customize assets provided as part of the Business Process Manager Telecom Pack to implement the solution. Figure 2. Building the BPM solution Note: The tasks displayed in purple color are optional steps or additional steps that might be required after the service implementation. Copyright IBM Corp. 2006,

12 6 IBM Business Process Manager Telecom Pack version 7.5 : Order Handling How To Guide

13 Chapter 3. Prerequisite Steps Adam Anderson, the IT Administrator, installs the Business Process Manager Telecom Pack to build the BPM solution. However, before the technical team builds the BPM solution, the Process Owner identifies and maps the business requirements with the artifacts for completing the solution. Performing gap analysis for identifying assets Perry Purdue, the Process Architect, performs a gap analysis for the assets and then provides it to Bob Bailey, the Business Programmer who then identifies the assets required using the Asset Navigator. The resultant gap analysis is then used for locating and identifying the actual assets that have to be created or extended. To develop the as-is process flow, identify whether the required assets are available in the Business Process Manager Telecom Pack. Using the Asset Navigator provided with the BPM Telecom Pack search for the assets present within the Business Process Manager Industry Packs. After you have identified the assets, ensure that you load the asset in its corresponding tool. You can use the following assets as-is, extend, or customize them to meet your specific requirement. For more information about how to use, extend, or customize the specific asset type, see the Business Process Manager Telecom Pack developer guide. v Process Models: Configure KPIs based on business measures Customizing the Business Process Definition Identifying assets using the Asset Navigator Lee Larson, the Process Owner, searches for the assets that he requires using the Asset Navigator. The Asset Navigator provides an easy to use navigation to search for the required assets quickly. Procedure 1. Open the Asset Navigator. Copyright IBM Corp. 2006,

14 Figure 3. Asset navigator 2. Click Search Assets, and then on the Search Assets page click Advanced Search to switch to the advanced search mode. 3. Select Solution Scenario from the Asset Type list. 4. Enter Order Handling for the name of the asset and click. Note: For more information about using the Asset Navigator to identify the assets you require, see Using the Asset Navigator topic in the documentation. Figure 4. Asset navigator 8 IBM Business Process Manager Telecom Pack version 7.5 : Order Handling How To Guide

15 Chapter 4. Step 1 : Model the Order Handling Business Process In this step, Bob Bailey, the Business Programmer, selects the Order Handling process based on the assets he identified using the Asset navigator, during the prerequisite step, and customizes the business process definition (BPD) provided as part of Business Process Manager Telecom Pack. The following assets are used to complete this step: v Fulfillment Toolkit v Telecom Common Toolkit The following table lists the roles, names, and tasks for the step. Table 2. Roles used in the BPM solution Roles Names Functions Integration Developer Igor Iron The Integration Developer assembles the different BPM components to build the BPM solution. Business Programmer Bob Bailey The Business Programmer performs coding and migration of assets between environments for building the BPM solution. The tasks for this step are highlighted in the following flow: Figure 5. Building the BPM solution Note: The tasks displayed in purple color are optional steps or additional steps that might be required after the service implementation. Creating a new business process As a starting point for customizing the Business Process Definition (BPD), Bob Bailey, the Business Programmer, creates a process application using the toolkits provided as part of the Business Process Manager Telecom Pack. Copyright IBM Corp. 2006,

16 About this task You must import the Telecom Toolkits before you customize it by completing the following steps: Procedure 1. Start the IBM Process Designer. 2. In the Process Apps tab, click Create new Process App, and create the required Process Application named Order Handling. 3. In the Process Apps tab, click Open in Designer next to the Order Handling Process Application created in the previous step. 4. Add the Telecom Common toolkit as a dependency to this new Process Application. a. Click Add a dependency icon next to Toolkits. b. Search and select the Telecom Common Toolkit. 5. Copy the Order Handling related BPDs from the Fulfillment toolkit to the Order Handling Process Application, by performing the following steps. Note: For this procedure, it is assumed that you have imported the IBM Business Process Manager Telecom Pack related toolkits into the IBM Process Designer. You can select the required BPDs based on your requirement when creating a new Process Application a. Click Process Center and click the Toolkits tab. b. Click Open in Designer next to the Fulfillment toolkit. Note: For more information about the Toolkits to BPD mapping, see the listing in the Developer's Guide. c. Expand the Fulfillment toolkit and click Processes. d. Search and select all the Order Handling-related Processes, and then right-click to select Copy items to > Other Process App > Order Handling Process App as shown in the following figure. 10 IBM Business Process Manager Telecom Pack version 7.5 : Order Handling How To Guide

17 Figure 6. Order Handling-related processes e. Click Process Center and click the Process Apps tab. f. Click Open in Designer next to the Order Handling Process Application. Modifying the Business Process Definition Bob Bailey, the Business Programmer, uses the Business Process Definition (BPD) and defines the process flow for the user. He creates the logic inside a process, and integrates it with other applications and data sources. Next, he customizes the BPD by adding swim lanes, participant groups, activities, gateways, and so on, to the process using the IBM Process Designer. In this scenario, pattern 3 is used to build the BPM solution. In this pattern, the Telecom-specific Toolkit is cloned and used as a dependency to the Process Application. For more information about the different patterns, see the Development best practices documentation. About this task To customize the BPD, perform the following steps: Chapter 4. Step 1 : Model the Order Handling Business Process 11

18 Procedure 1. In the IBM Process Designer, expand ORDER HANDLING > Processes and double-click Order Handling. The original and customized versions of the Order Handling BPD are displayed in the following figures. The following figure shows the existing Order Handling BPD. In the existing BPD, for the highlighted part of the process, the process begins with searching the records based on the customer's order number. If the order number is not found, the process goes back and searches for another parameter such as customer name or customer ID. Figure 7. Order Handling BPD 2. You now modify the process to build your BPM solution. The following figure is an updated Order Handling BPD where the process searches based on the customer's order number. If the order number is not found, the process moves to the next process in the BPD and does not go back to search for other parameters. Moreover, this enables you to obtain the customer and product order details using the same process. 12 IBM Business Process Manager Telecom Pack version 7.5 : Order Handling How To Guide

19 Figure 8. Updated Order Handling BPD Adding service tasks to the business process Next, Bob Bailey, the Business Programmer, creates an integration service to create a new customer record. Before you begin You must import the Telecom Toolkits before you customize it. About this task To customize the Integration Service, perform the following steps: Procedure 1. Expand Toolkits > Telecom Common > Implementation. 2. Right-click the Create Customer Integration Service, and then click Copy item to > Other Process App > Order Handling Process App as shown in the following figure. Chapter 4. Step 1 : Model the Order Handling Business Process 13

20 Figure 9. Copying Integration Service to Process Application 3. In the IBM Process Designer, expand Order Handling Process App and click Implementation. 4. Double-click Create Customer from the displayed list. 5. Wire the implementation to the actual Web Service Integration Component, as shown in the following figure. 14 IBM Business Process Manager Telecom Pack version 7.5 : Order Handling How To Guide

21 Figure 10. Wiring the actual Web Service Integration Component 6. Under the Properties tab, click Implementation, and provide the URI for the Create Customer WSDL in the WSDL URI field. 7. Click Discover next to the WSDL URI field. Note: Ensure that after the URI is retrieved, the Endpoint URL is provided with a valid soap address. 8. Click the Variables tab and fix the data type mapping issue. You must map it to the data type from the Telecom Common Toolkit, as shown in the following figure. Igor Iron, the Integration Developer, requires these mappings for creating an Advanced Integration Service. Chapter 4. Step 1 : Model the Order Handling Business Process 15

22 Figure 11. Mapping the data type 9. Save your changes. Note: Ensure that you remove the mock implementation from the Create Customer Integration service copied from the Telecom Common Toolkit Results At this point, Bob has customized the BPD by adding a new integration service task. If the service is implemented, Igor can proceed to perform simulation using the playback server. Creating Business Objects in IBM Process Designer While customizing the business process, Bob Bailey, the Business Programmer, realizes that the attributes provided for Customer Order within the toolkit are not sufficient to meet his business needs. He creates a business object and adds parameters provided here to the Customer Order business type. About this task To create business objects in IBM Process Designer, perform the following steps in the Designer view: Procedure 1. Click the Add ( ) icon for Data and click Business Object. 2. Specify the name as OrderSummary and click Finish. 3. From Parameters, click Add to add a new parameter. 4. From Parameter Properties, enter Customer for the name. 5. From Parameter Properties, click Select and then select Customer from the list. 6. Similarly, create the other parameters that you require as shown in the following figure. 16 IBM Business Process Manager Telecom Pack version 7.5 : Order Handling How To Guide

23 Figure 12. Adding parameters 7. Save your changes. Results Bob uses the Business Object that he created to capture and transfer data using variables from one object to another. Adding human services to the business process As a step in the Business Process Definition (BPD), Bob Bailey, the Business Programmer, adds Human Services to create an interactive service. The Human Service enable a process participant to enter data or specify options that are required by the process using a web-based user interface. He uses the Order Handling BPD to customize the Display Order Summary Human Service associated with it. About this task To customize the Human Service, perform the following steps: Procedure 1. Click the Add ( ) icon for User Interface and click Human Service. 2. Specify the name as Select Order and click Finish. 3. Click the Variables tab. 4. Click Add Input and add the ProductOrder. 5. Click Add Output and add the OrderSummary. Chapter 4. Step 1 : Model the Order Handling Business Process 17

24 Figure 13. Adding variables 6. Drag and wire a coach to the BPD. 7. Click the Coaches tab to view the form. 8. Expand Variables and add the fields that you want to the form. Figure 14. Updating the form 9. Save your changes. 18 IBM Business Process Manager Telecom Pack version 7.5 : Order Handling How To Guide

25 Results Using participant groups Bob uses this coach that he created in the BPD to accept or update information. The different Human Services that are created for the BPM solution must be accessed by different groups of users. This access can be controlled by creating Participant Groups. Participant Groups represent the groups of users in your organization. Bob Bailey, the Business Programmer, creates the different Participant Groups and associates each group with a lane in the BPD to access activities in a process. In this step, he uses the Order Handling BPD to customize the Customer Service Representative Participant Group associated with it. Before you begin All Participant Groups in the Telecom Common Toolkit are associated to the tw_allusers group as shown in the following figure. Figure 15. User group assignment If you select to assign the above Participant Group from the Toolkit to the lane in your BPD, all the users belonging to the tw_allusers group participate in the activities defined inside the lane. The tw_allusers participant group includes all users that are members of the tw_allusers security group. This is a special security group that automatically includes all users in the system. If you want to ensure that the activities are routed to a specific group or users from your enterprise, you must customize the Participant Groups from Toolkits, as explained in the following procedure. Chapter 4. Step 1 : Model the Order Handling Business Process 19

26 About this task To customize the Participant Group, perform the following steps: Procedure 1. Expand the Telecom Common Toolkit, and then click Processes. 2. Select the required Participant Group (in this case Customer Service Representative), and then right-click and select Copy items to > Other Process App > Order Handling Process App as shown in the following figure. Figure 16. Participant Group creation 3. Expand Order Handling Process App > Processes and double-click the Customer Service Representative that you want to modify. 20 IBM Business Process Manager Telecom Pack version 7.5 : Order Handling How To Guide

27 4. Click Add user and search for the users that you want to add to the Customer Service Representative Participant Group, as shown in the following figure. Figure 17. Participant Group creation Note: For more information about creating users using the IBM Process Server administrative console, see the IBM Process Server documentation. 5. Associate the customized Customer Service Representative Participant Group to the lane in your BPD, as shown in the following figure. Chapter 4. Step 1 : Model the Order Handling Business Process 21

28 Figure 18. Participant Group creation 6. Under the Behavior area, click Select to select an existing Participant Group or click New to create a new Participant Group. Defining rule services for a business process To perform calculation on variables, you need to define simple rules. For Order Handling, a rule service must be created for calculating tax on Order Total based on States. This rule can be called from a Coach or a Process. In Order Handling, a Tax Rate Rule service can be created and called as a nested service from the Display Order Summary Human service such that, for every State an appropriate tax is applied on the Order Total using the Action section. About this task To create a Tax Rate Rule service, perform the following steps: Procedure 1. Define a simple rule by performing the following steps: a. Click the Add ( ) icon for Rules and click Rule Service. b. Enter Tax for State for the name and click Finish. c. Drag and wire the Rule Script ( ) icon to create a rule. d. Specify Tax for State for the name. 22 IBM Business Process Manager Telecom Pack version 7.5 : Order Handling How To Guide

29 e. Enter the following code for the Post-execution Assignments: var grandtotal=math.round((tw.local.ordersummary.ordergrandtotal)*100)/100 tw.local.ordersummary.ordergrandtotal=grandtotal f. Click the Variables tab and add Order Summary for the Input and the Output variable. g. Click the Rules tab, click the Add a variable to the rule ( ) icon, and select Input > OrderSummary(OrderSummary) > state. h. Specify AL for the state, TaxforAL for the Action Requirement, and the following code for the Action: var taxamount=0 var grandtotal=0 var tax=1.25 var ordertotal = tw.local.ordersummary.ordertotal taxamount=(parsefloat(tax)*number(ordertotal))/100 grandtotal=parsefloat(taxamount)+number(ordertotal) tw.local.ordersummary.ordergrandtotal=parsefloat(grandtotal) i. Similarly, add a rule condition for the other states. j. Save the rule created. 2. Open the process and go to Finalize Customer Negotiation > Display Order Summary. 3. Click Rules and drag and wire the Tax for State rule. Figure 19. Adding rule 4. Specify the following information on the Data Mapping tab for the following rule properties. v Input Mapping: tw.local.ordersummary v Output Mapping: tw.local.ordersummary 5. Save the changes. Simulating process using playback server After completing the process modification, Bob Bailey, the Business Programmer, and Igor Iron, the Integration Developer, simulate the process using the playback server. The invoke the process in the playback session and trace the path of execution for that process to debug any errors that occur during invocation. Procedure 1. Start the IBM Process Designer. 2. Click the Process Apps tab and click Open in Designer next to Order Handling. Chapter 4. Step 1 : Model the Order Handling Business Process 23

30 3. Expand Order Handling, click Processes, and then double-click the Order Handling Process App process. 4. Click Run Process. 5. Complete the forms displayed to execute the complete process. Results At this point, Bob has completed his changes for the Business Process Definition. He must now inform his IT staff to implement backend services to integrate with the existing customer catalog or CRM systems. Summary The tasks completed during the step 1 include cloning the Toolkit and modifying it to build the BPM solution. The following are the tasks that were completed during this step: v Creating the process application from the Toolkit v Cloning the Toolkit v Customizing the business process v Customizing business objects v Adding service tasks v Creating human services v Adding participant groups v Defining rule services 24 IBM Business Process Manager Telecom Pack version 7.5 : Order Handling How To Guide

31 Chapter 5. Step 2 : Integrating services After the process has been customized and modified into a process application from a toolkit during the step for process modelling. Igor Iron, the Integration Developer, provides the service implementation logic that connects to the backend services, known as integration services. Igor can implement integration services in two ways. One, is to use a simple web services to implement services and the other using the advanced integration services capability. IBM Integration Designer will be used as the web service development IDE for both the ways. Note: The web services development can be done using other IDEs such as IBM Rational Application Developer, Rational Software Architect, or by using the Eclipse development platform. The steps for implementing services using the other IDEs is beyond the scope of this document. The following assets are used to complete this step: v Telecom Common Toolkit The following table lists the roles, names, and tasks for the step. Table 3. Roles used in the BPM solution Roles Names Functions Integration Developer Igor Iron The Integration Developer assembles the different BPM components to build the BPM solution. The tasks for this step are highlighted in the following flow: Figure 20. Building the BPM solution Note: The tasks displayed in purple color are optional steps or additional steps that might be required after the service implementation. Copyright IBM Corp. 2006,

32 Implementing web services To implement the web services, Igor Iron, the Integration Developer, implements simple WS-I compliant web services using IBM Integration Designer.Igor implements integration services for calling technical web services. These technical web services implement the standard-based service interfaces also know as Technical Service Interfaces. The integration services perform a web-service call to a mediation module. The mediation module then transforms the simplified business objects to standard-based business objects, also known as technical business objects. This ensures legacy services in the existing system can be called using the mediation module. Creating the implementation logic To create the simple web service, Igor Iron, the Integration Developer, first creates the implementation logic in IBM Integration Designer. The Check Technical Availability implementation logic validates whether the service is available for the zipcode that is provided. The ServiceProvisioning SCA library is used to create this implementation logic. The ServiceProvisioning SCA library contains the CheckTechnicalAvailability.wsdl for the implementation logic. The light version of this wsdl is available in ServiceProvisioningPSM which is implemented by the mediation module. This pattern is implemented for all the Integration Services. Note: All the implementation logic is created in a single module for the solution scenario. The module name is OrderHandlingMockServicesModule. All the implementation logic created in this module are of the Java implementation type. About this task To create a simple web service, perform the following steps: Procedure 1. Import the following SCA modules in IBM Integration Designer: v ServiceProvisioning.zip v Service Provisioning PSM.zip 2. Create the implementation logic by performing the following steps: a. Open the OrderHandlingMockServicesModule created. b. Open the Assembly diagram of the module. c. Drag a java component to the diagram. d. Specify CheckTechnicalAvailability for the component name. 26 IBM Business Process Manager Telecom Pack version 7.5 : Order Handling How To Guide

33 Figure 21. Creating a java component e. Click the Add Interface ( ) icon and add the service you created as the interface for the component. f. Double-click the component, click Yes in the window that is displayed, and create and a new package. g. Specify code for the component, if required. h. Right-click the component created and select Generate export > SCA Binding. Chapter 5. Step 2 : Integrating services 27

34 Figure 22. Creating an SCA binding 3. Save your changes. Creating a mediation module for the simple web service Igor Iron, the Integration Developer, creates a mediation module for calling services on the existing system. About this task To create a mediation module, perform the following steps: Procedure 1. Create a mediation module by performing the following steps: a. Right-click the project explorer, select New > Project > Mediation Module, and specify the name OrderHandlingMM. Note: Ensure that you clear the Create mediation component check box and select the check box for the SCA module, including the process service model, in the wizard. b. Expand OrderHandlingMM and open the Assembly diagram. c. Drag a Mediation Flow to the diagram, specify the name as CheckTechnicalAvailability. d. Add the CheckTechnicalAvailability interface from the ServiceProvisioningPSM SCA library to the mediation flow. 28 IBM Business Process Manager Telecom Pack version 7.5 : Order Handling How To Guide

35 Figure 23. Creating mediation module e. Save the changes f. Double-click the mediation flow, click Yes, select the OrderHandlingMM folder, and click OK to create the implementation. Figure 24. Creating an implementation g. Click the checktechnicalavailability source link, click Service Integration, and add a reference operation. Chapter 5. Step 2 : Integrating services 29

36 Figure 25. Adding a reference h. Wire the objects and ensure that you click the Transform the message using an XSL Transformation primitive option to create an XSL transformation object. i. Specify TransformCheckTechnicalAvailability_Request as the name for the XSL Transformation object. Figure 26. Adding a reference j. Double-click the TransformCheckTechnicalAvailability, clear the Default check box, specify a namespace for the object using BPM Best Practices, specify the name as TransformCheckTechnicalAvailability_Request, and complete the wizard. For this scenario, you can use xmlns/prod/websphere/icp/2011/04/business/telecom/xslt/ TransformCheckTechnicalAvailablity. 30 IBM Business Process Manager Telecom Pack version 7.5 : Order Handling How To Guide

37 k. Map the variables for your implementation. Figure 27. Mapping variables l. Open TransformCheckTechnicalAvailability and click the Response tab. m. Repeat steps i to l for the response component. 2. Create an Import by performing the following steps: a. Open OrderHandlingMM. b. Expand the implementation logic you created, drag the export to the diagram, select Import with SCA Binding, and wire the components. Figure 28. Adding an Import 3. Save your changes. 4. Update the BPEL flow by performing the following steps: a. Go to OrderHandling > OrderHandling_Implementation > Integration Logic > BPEL Process and open the process flow diagram. b. Drag the Invoke component to the flow, add an interface partner for the component, and provide the SCA port in the implementation tab of the Chapter 5. Step 2 : Integrating services 31

38 Import component. Figure 29. Adding an Invoke component 5. Save your changes. Deploying the web service After creating the required services, Igor Iron, the Integration Developer, generates a service export. About this task To generate a service export, perform the following steps: Procedure 1. Generate a service export by performing the following steps: a. Right-click the mediation flow component and click Generate Export > Web Service Binding. b. Select SOAP 1.1/HTTP using JAX-RPC and click Next. c. Select the option to define a namespace. Note: As a best practice, ensure that the binding namespace is different from the interface namespace. d. Define a unique namespace and click Finish. 2. Deploy the module to the IBM Process Server. 3. Optional: Move the generated export binding wsdl to a separate SCA library as a best practice. 32 IBM Business Process Manager Telecom Pack version 7.5 : Order Handling How To Guide

39 4. In the IBM Process Designer, update the WSDL uri for the integration service so that it refers to the generated binding WSDL location during runtime by performing the following steps: a. Open the Order Handling process application in IBM Process Designer. b. For Implementation, click the Add ( ) icon and click Integration Service. c. Specify the name as CheckTechnicalAvailability and click Finish. d. Drag a Web Service Integration component to the diagram, specify the name as CheckTechnicalAvailability, and wire the component. Figure 30. Adding an Integration Service e. From the Properties tab, click Implementation, specify the binding WSDL URI and click Discover. f. Select the required option from the Operations list and specify the Endpoint Address URL for the component. g. Specify the input and output variables from the Variables tab. Chapter 5. Step 2 : Integrating services 33

40 Figure 31. Adding variables h. Click Data Mapping and provide the required mapping. 5. Update the service endpoint address where the mediation flow will be available. 6. Save your changes. Unit testing web services using IBM Integration Designer After implementing the web services, Igor Iron the Integration Developer tests and verifies the individual services in the IBM Integration Designer. It is a best practice to test the implemented services as java components, BPEL flows, or mediation flows, individually. It is required to verify the implementation logic of the services. Procedure 1. Start IBM Integration Designer and switch to the Business Integration perspective. 2. Define a runtime server, if it not available. 3. Create the integration service implementation. For more information, see the Implementing web services on page 26 section. 4. Open the Assembly diagram for the module. 5. Right-click a component and click Test. 6. Provide the service request. 7. Select Run. 8. Select the runtime server. 9. Provide the user credentials and click Finish. 10. Repeat the steps with different test data to invoke different logical scenarios. 34 IBM Business Process Manager Telecom Pack version 7.5 : Order Handling How To Guide

41 Implementing Advanced Integration Services In this section, Igor Iron, the Integration Developer, creates an advanced integration service. An advanced integration service is one of the types of integration services that are supported. It must be created from scratch, if required. Creating the Advanced Integration Service Igor Iron, the Integration Developer, first creates the Advanced Integration Service (AIS) in IBM Process Designer. About this task To create the Advanced Integration Service, perform the following steps: Procedure 1. Start IBM Process Designer and open your process application. 2. Click the Add icon ( ) for the Implementation menu. 3. Select the Advanced Integration Service option. 4. Specify the name Check Technical Availability for the advanced integration service and click Finish. 5. Click the Variables tab and define the input and output types for the service. 6. Save your changes. 7. Click Add ( ) next to Implementation and click General System Service. Note: Ensure that for every Advanced Integration Service you create, a General System Service is created. 8. Provide a name such as TestGSS and click Finish. 9. Click Implementation and drag the service created in the step 4 to the Diagram area. Chapter 5. Step 2 : Integrating services 35

42 Figure 32. Linking the Advanced Integration Service to the General service 10. Wire the input and output to this service. 11. Click the Variables tab, click Add Input and provide the parameters as per the Advanced Integration Service input. 12. Under the Properties area, click Data mapping, and then click to provide the input and output mapping similar to the Advanced Integration Service. Figure 33. Providing the data mapping 13. Click the Variables tab, click Add Output and provide the parameters as per the Advanced Integration Service output. 36 IBM Business Process Manager Telecom Pack version 7.5 : Order Handling How To Guide

43 14. Click Processes and open the Collect Customer Order Details process. 15. Navigate to the Find Customer service and under the Properties area, click Implementation. 16. Select the General System Service created in step 8. Figure 34. Providing the implementation in the process 17. Create a snapshot of the process application. 18. Start IBM Integration Designer and import the process application in the workspace. 19. Expand the process application and expand Advanced Integration Services. 20. Right-click Check Technical Availability and click Implement. Chapter 5. Step 2 : Integrating services 37

44 Figure 35. Creating an implementation 21. Select Microflow and click Finish to add an implementation. 38 IBM Business Process Manager Telecom Pack version 7.5 : Order Handling How To Guide

45 Figure 36. Adding an implementation 22. Implement the business logic for the BPEL flow by performing the following steps: a. Drag the Invoke component to the flow and add an interface partner for the component. Figure 37. Implementing the business logic Creating a mediation module for the Advanced Integration Service Igor Iron, the Integration Developer, creates a mediation module for calling services on the existing system. Chapter 5. Step 2 : Integrating services 39

46 About this task To create a mediation module, perform the following steps: Procedure 1. Create a mediation module by performing the following steps: a. Right-click the project explorer, select New > Project > Mediation Module, and specify the name OrderHandlingMM. Note: Ensure that you clear the Create mediation component check box and select the check box for the SCA module, including the process service model, in the wizard. b. Expand OrderHandlingMM and open the Assembly diagram. c. Drag a Mediation Flow to the diagram, specify the name as CheckTechnicalAvailability. d. Add the CheckTechnicalAvailability interface to the mediation flow. Figure 38. Creating mediation module e. Save the changes f. Double-click the mediation flow, click Yes, select the OrderHandlingMM folder, and click OK to create the implementation. 40 IBM Business Process Manager Telecom Pack version 7.5 : Order Handling How To Guide

47 Figure 39. Creating an implementation g. Click the checktechnicalavailability source link, click Service Integration, and add a reference operation. Figure 40. Adding a reference h. Wire the objects and ensure that you click the Transform the message using an XSL Transformation primitive option to create an XSL transformation object. i. Specify TransformCheckTechnicalAvailability_Request as the name for the XSL Transformation object. Chapter 5. Step 2 : Integrating services 41

48 Figure 41. Adding a reference j. Double-click the TransformCheckTechnicalAvailability, clear the Default check box, specify a namespace for the object using BPM Best Practices, specify the name as TransformCheckTechnicalAvailability_Request, and complete the wizard. For this scenario, you can use xmlns/prod/websphere/icp/2011/04/business/telecom/xslt/ TransformAuthorizeCredit. k. Map the variables for your implementation. Figure 42. Mapping variables l. Open TransformCheckTechnicalAvailability and click the Response tab. m. Repeat steps i to l for the response component. 2. Create an Import by performing the following steps: a. Open OrderHandlingMM. 42 IBM Business Process Manager Telecom Pack version 7.5 : Order Handling How To Guide

49 b. Expand the implementation logic you created, drag the export to the diagram, select Import with SCA Binding, and wire the components. Figure 43. Adding an Import 3. Save your changes. 4. Refresh and publish your changes. Creating the implementation logic for the Advanced Integration Service To create the Advanced Integration Service (AIS), Igor Iron, the Integration Developer, creates the implementation logic in IBM Integration Designer. About this task To create the implementation logic, perform the following steps: Procedure 1. Import the following SCA modules in IBM Integration Designer: v ServiceProvisioning.zip 2. Create a mock service for your implementation by performing the following steps: a. Create a module with the name ServiceProvisioningModule. Note: Ensure that you add the SCA libraries you imported as a dependency to the module. b. Open the Assembly diagram for the module. c. Drag a java component to the diagram. d. Specify CheckTechnicalAvailabilityExport for the component name. Chapter 5. Step 2 : Integrating services 43

50 Figure 44. Creating a java component e. Click the Add Interface ( ) icon and add the AIS service you created as the interface for the component. f. Double-click the component, click Yes in the window that is displayed, and create and a new package. g. Specify code for the component, if required. h. Right-click the component created and select Generate export > SCA Binding. 44 IBM Business Process Manager Telecom Pack version 7.5 : Order Handling How To Guide

51 Figure 45. Creating an SCA binding 3. Save your changes. Unit testing Advanced Integration Services using IBM Integration Designer After implementing the Advanced Integration Services, Igor Iron the Integration Developer tests and verifies the individual services in the IBM Integration Designer. It is a best practice to test the implemented services as java components, BPEL flows, or mediation flows, individually. It is required to verify the implementation logic of the services. Procedure 1. Start IBM Integration Designer and switch to the Business Integration perspective. 2. Define a runtime server, if it not available. 3. Create the integration service implementation. For more information, see the Implementing Advanced Integration Services on page 35 section. 4. Open the Assembly diagram for the module. 5. Right-click a component and click Test. 6. Provide the service request. 7. Select Run. 8. Select the runtime server. 9. Provide the user credentials and click Finish. 10. Repeat the steps with different test data to invoke different logical scenarios. Chapter 5. Step 2 : Integrating services 45

52 Summary The tasks completed during the step 2 include integrating the backend services to the service implementations. The following are the tasks that were completed during this step: v Implementing and testing simple web services v Implementing and testing advanced integration services 46 IBM Business Process Manager Telecom Pack version 7.5 : Order Handling How To Guide

53 Chapter 6. Step 3 : Creating reports and custom dashboards This section deals with creating basic reports in IBM Process Designer and leveraging advanced dashboards in IBM Business Monitor. For the Order Handling scenario, Bob Bailey obtains a list of business measures and Key Performance Indicators (KPIs) to be reported from Bart Bracken. He then uses the IBM Process Designer to create simple reports using tracking groups thereby allowing Bart to quickly validate his measurement requirements. Igor uses the simple reports created by Bob and exports the definitions to the IBM Business Monitor Toolkit to create complex dashboards and reports. The following assets are used to complete this step: v Process application The following table lists the roles, names, and tasks for the step. Table 4. Roles used in the BPM solution Roles Names Functions Business Analyst Bart Brecken The Business Analyst creates the Process Flows, KPIs, and Business Measures required for the BPM solution. Business Programmer Bob Bailey The Business Programmer performs coding and migration of assets between environments for building the BPM solution. Integration Developer Igor Iron The Integration Developer assembles the different BPM components to build the BPM solution. The tasks for this step are highlighted in the following flow: Figure 46. Building the BPM solution Note: The tasks displayed in purple color are optional steps or additional steps that might be required after the service implementation. Copyright IBM Corp. 2006,

54 Creating tracking groups Tracking groups help you track the process data to be used in reports. In this scenario, Bob Bailey, the Business Programmer creates a tracking group to monitor order handling data to measure key metrics and performance indicators. Bob needs to track the following business objects from the Order Handling business process: v orderrequesteddate v orderstatus v numberofreceivedorders v productname v statename About this task To add tracking groups for monitoring the process, perform the following steps: Procedure 1. From the Designer view of the process application, click the Create ( icon for Performance and click Tracking Group. 2. Enter OrderHandling for the name and click Finish. 3. Click Add and create the following tracked fields. Table 5. Tracking fields Name orderrequesteddate orderstatus numberofreceivedorders productname statename Type Date/Time String Number String String 4. Open the Order Handling process flow. 5. Select the Intermediate Tracking Event ( ) icon, drag and place in the process, and connect the tracking event to the process flow. 6. From the Properties pane, specify Order Submitted for the tracking event name: 7. Click Implementation, click Select and click OrderHandling for the Tracking Group 8. Select the check box and specify the code for the following values: Table 6. Specifying options for the tracking group Name Type orderrequesteddate(datetime) new tw.object.date() orderstatus(string) tw.local.productorder.status numberofreceivedorders(number) 1 productname(string) tw.local.productorder.name 48 IBM Business Process Manager Telecom Pack version 7.5 : Order Handling How To Guide

55 Table 6. Specifying options for the tracking group (continued) Name statename(string) Type tw.local.productorder. customeraccountorder. customer.state 9. Similarly, create the other events that you want to track and save the changes. Figure 47. Creating a tracking event Creating simple reports Bart Brecken, the Business Analyst wants to know whether Bob Bailey, the Business Programmer, can provide the reports in a specified format. He then informs Bob about his requirement on the reports in terms of layout. To achieve this, Bob customizes the reports provided with the Process Model using the report generation tool included in the IBM Process Designer. He also customizes the scoreboard to include newly created reports and view the updated scoreboard in the IBM Process Portal. About this task To customize the report, perform the following steps: Procedure 1. Open the Order Handling and double-click the process. 2. Click File > Ad-Hoc Report Analysis. 3. Under the X-Axis area, click Select and select the required binding, such as OrderDate. Chapter 6. Step 3 : Creating reports and custom dashboards 49

56 Figure 48. Binding definition for X-Axis 4. Under the Y-Axis area, click Select and select the required binding, such as OrderStatus. 50 IBM Business Process Manager Telecom Pack version 7.5 : Order Handling How To Guide

57 Figure 49. Binding definition for Y-Axis 5. Click Select next to the Chart layout field and select the required layout. 6. Click the Create Report from Chart icon, provide a name for the Report, and click Finish to save the Report. 7. Customize the Scoreboard to include the newly created report. a. Click Process Center and click the Process Apps tab. b. Click Open in Designer next to the Order Handling Process Application. c. Expand Fulfillment and click Performance. d. Select and right-click all the parameters grouped under Order Handling, and click Copy items to > Order Handling Process Application. e. Expand Order Handling and click Performance Process Application. f. Double-click Order Handling Dashboard. g. Under the Reports area, you can add new reports created or remove the existing reports. h. Click Add and add the report that you created. Chapter 6. Step 3 : Creating reports and custom dashboards 51

58 Exporting tracking definitions to Monitor After the report is created, Igor Iron, the Integration Developer needs to update the tracking group in the performance database. This is required so the report is displayed for the business users to track the business performance. To update the tracking definitions: 1. Start IBM Process Designer and open the process application. 2. Click File > Update Tracking Definitions. Creating advanced reports and dashboards using Monitor toolkit Bob Bailey, the Business Programmer identifies that the report events generated using the IBM Process Designer can also be leveraged by the Monitor Model. To create custom reports for the Monitor Model, Igor Iron, the Integration Developer, imports the process application in the IBM Integration Designer workspace. Igor uses the simple reports created by Bob and exports the definitions to the IBM Business Monitor Toolkit to create complex dashboards and reports. The reports created can be viewed in Business Space and provide an overview of the business activities on the US map. Procedure 1. Start IBM Integration Designer. 2. Switch to Process Center perspective. Note: You must specify the information for the Process Center in the dialog box that is displayed. 3. Click Open in workspace to import the process application into IBM Integration Designer. 4. Click Window > Open Perspective > Business Integration. 5. Select the following check box to import the required process applications: v Order Handling v Telecom Common 6. Verify that the following items have been imported: v All the tracked fields are created as metrics in the Monitor Model toolkit. 52 IBM Business Process Manager Telecom Pack version 7.5 : Order Handling How To Guide

59 Figure 50. Tracked field in IBM Process Designer Figure 51. Tracked field in IBM Integration Designer v All the tracking groups are imported as events in the Monitor Model. Chapter 6. Step 3 : Creating reports and custom dashboards 53

60 Figure 52. Tracking group in IBM Process Designer Figure 53. Tracking group in IBM Integration Designer v The sources of metric values are the events which are the tracking group in the IBM Process Designer, for example, Value of state is derived from Order submitted event group. 7. Generate the Monitor Model by performing the following steps: a. Right-click Order Handling Process App and click Generate Monitor Model. b. Specify OrderHandling for the project name. c. Specify OrderHandlingMM for the monitor model name and click Next. d. Select the process application and click Next. 54 IBM Business Process Manager Telecom Pack version 7.5 : Order Handling How To Guide

61 e. Select Order Handling from the Event Source list and select all the check boxes from the Monitoring Template and theemitted Events tabs. f. Select Order Handling Events from the Event Source list, click Monitoring Template and select the Tracked Fields check box. g. Click Next and then click Finish. The monitor model is displayed in the Business Monitoring perspective. Defining Metrics After Igor Iron, the Integration Developer, defines the inbound events, monitoring context and its key, he uses the first entity in monitor model to define the metrics. These metrics are placeholders to store the data that is required from the events payload. Procedure 1. From the Monitor Details Model tab, expand OrderHandlingMM and right-click Order Handling > New > Metric. 2. Enter Mobile TX Orders for the metric name, select the Type as Integer, and click OK. 3. Select the A value is required for this metric check box, and enter 0 in the Default Value text box. 4. Specify the following details for the Metric Value Expression: v Trigger: Order Handling Submitted Trigger v Expression: if (bmon_productname eq Mobile Products and bmon_statename eq TX ) then 1 else 0 5. Similarly create the metrics for the remaining states and items that you want to monitor. Defining Key Performance Indicators Igor Iron, the Integration Developer now defines the Key Performance Indicator (KPI) that are required to monitor the BPM solution. KPI measure the business performance on predefined metrics. These are useful in defining future plan of actions for the business. These are modeled as aggregate functions of metrics or other KPI. The KPI are modeled in KPI model tab of the monitor model. Procedure 1. From the KPI Model tab, expand OrderHandlingMM and right-click Order Handling KPI > New > KPI. 2. Enter Mobile TX Orders for the name and click OK. 3. Select the KPI that you created, select the Base this KPI on a metric and an aggregation function, and specify the following information: v Monitoring context: Order Handling v Metric: Mobile TX Orders v Aggregation function: Sum Note: Ensure that you select Metric in the window that is displayed when you select the metric. 4. From the Time Filter area, click Browse for the Metric, select orderrequesteddate, click OK, and then specify the following information: v Time period: Repeating v Period type: Monthly Chapter 6. Step 3 : Creating reports and custom dashboards 55

62 v Time zone: GMT v Base period on: Period in progress 5. Also create a KPI to calculate the percentage using the following KPI information: v Name: Mobile TX Percentage v Type: Decimal v Ranges: Actual value v KPI Value: Write an expression to calculate this KPI on existing KPIs. v KPI Calculation: if (MOBILE ne 0) then fn:round((mobile_tx_orders div MOBILE) * 100) else 0 Note: You must create the MOBILE KPI to aggregate the sum of all mobile products. 6. Save your changes. 7. Similarly, create the KPI model for the states that you want to monitor. Defining the visual model After creating the monitor model, Igor Iron, the Integration Developer, configures the dashboard to monitor the business. Igor can specify the color, values, and other settings for the dashboard. Procedure 1. Import the SVG diagram in IBM Integration Designer. a. Right-click in the Project Explorer view, and then click Import. b. Click General > File System from the "Import" window and click Next. c. Click Browse to locate the file. (For example, <Location>\VisualModel). d. Select TelecomUSMap.svg. e. Click Browse and select TelecomMMProj from the Import into Folder window. f. Click Finish. g. Expand the project in the "Project Explorer" view, and then expand the SVG files to view the new SVG file listed. Figure 54. View SVG files 2. Configure shapeset attributes in SVG. a. From the Visual Model tab, select Order Handling KPI (KPI) for the Selected Context, click Browse, navigate to 56 IBM Business Process Manager Telecom Pack version 7.5 : Order Handling How To Guide

63 OrderHandlingMonitoringProject, and click OrderHandlingUSMap, and then click OK. When prompted, click Yes to create shapesets. b. The SVG diagram is displayed in the visual editor as shown in the following figure. Figure 55. View SVG diagram c. Select a state from the list and add the following text action to the shapeset: 1) On the "visual editor" view, under the Add and Edit Shape set Actions section, you can see the SVG shapes that are available for use in this file. Find the shapeset action for Texas in this list. Right-click this item, and then click Add Action > Set Color 2) Edit the fill color as : #ccffcc. 3) Save the project. Chapter 6. Step 3 : Creating reports and custom dashboards 57

64 Figure 56. Create the shape-set d. Add an action to the shapeset and provide the following information. v Label_Mobile_TX v Action: Set text v text value: fn:concat(mobile_tx_percentage,'%') Testing the monitor model Project Interchange file Summary Igor Iron, the Integration Developer tests the monitor model Project Interchange file by exporting the Project Interchange file, importing it using IBM Integration Designer, and deploying the file to a unit test environment. Procedure 1. Generate the EAR file. 2. Install the monitor model EAR file on the server using the Add and remove project option. 3. Use the Test Component Project to run process instances and invoke events. 4. Configure and view the dashboard in Business Space to view data. The tasks completed during this step includes creating monitoring data and generating reports to view performance of the business. The following are the tasks that were completed during this step: v Creating tracking groups v Adding tracking events v Creating reports v Creating advanced reports using KPIs and defining a visual model 58 IBM Business Process Manager Telecom Pack version 7.5 : Order Handling How To Guide

65 Chapter 7. Step 4 : Implementing data persistence This step provides the detailed steps to implement a data persistence layer. Typically, a Telecom Service provider would have an existing system that already has a database layer or leverage master data to maintain product and customer related information. The details in this step assume that a customer requires a new database model and an associated persistence layer to store and retrieve customer and product data. The following assets are used to complete this step: v Telecom physical data model The following table lists the roles, names, and tasks for the step. Table 7. Roles used in the BPM solution Roles Names Functions Data Architect Chuck Goldman The Data Architect creates a logical data model based on the data requirements and implements a corresponding physical data model. The tasks for this step are highlighted in the following flow: Figure 57. Building the BPM solution Note: The tasks displayed in purple color are optional steps or additional steps that might be required after the service implementation. Working with the physical data model Business Process Manager Telecom Pack packages the physical data model for DB2 version 9.5 databases. The physical data model is generated using the packaged logical data model and the naming standard glossary model. Chuck Goldman, the Data Architect, uses this physical data model and creates a physical database on DB2. After this, he assembles the database and the services layer with the help of a data access layer, such as an ORM framework like Java Persistence API (JPA). Copyright IBM Corp. 2006,

66 Setting up a physical database A physical database can be setup using the entire physical data model or only those entities that are required by the end solution. Setting up a database Chuck Goldman, the Data Architect, sets up a database using the packaged physical data model. Procedure 1. Start InfoSphere Data Architect. 2. Import the physical data model in the InfoSphere workspace. The file is located in the <Install-folder>/solution-scenarios/order-handling/source folder. 3. Go to order-handling-datamodel > Data Models, and double-click TOCP_OH.dbm to open the physical data model for the target database type. 4. In the Data Project Explorer, right-click the Database node and click Generate DDL. Figure 58. Generating a DDL 5. Ensue that the following check boxes are selected on the Options page. v Fully qualified name v CREATE statements v Comments 6. Click Next, complete the wizard, and then click Finish. What to do next The DDL is generated, you can now run the DDL on a database server using a graphical or command line interface to set up the database. 60 IBM Business Process Manager Telecom Pack version 7.5 : Order Handling How To Guide

67 Implementing a data access layer Chuck Goldman, the Data Architect, sets up the physical database. He then adds and configures a data access layer to communicate with the database for basic CRUD (Create, Read, Update and Delete) operations. This is required for the solution development. He adds this data access layer with the help of ORM technologies/frameworks, such as JPA. Procedure 1. Generate the JPA entities that is required for the database entities. a. Start IBM Integration Designer and open a new workspace. b. Click Window > Open perspective > Other > JPA to switch to the JPA perspective. c. In the Data Source Explorer, configure a Data Source for your physical database. d. Click File > New > JPA Project. e. Specify OrderHandlingDBAccess for the project name. f. Right-click OrderHandlingDBAccess, and the click JPA Tools > Configure JPA Entities. g. Click Create New JPA Entities. Chapter 7. Step 4 : Implementing data persistence 61

68 Figure 59. Configure JPA Entities h. Select the connection to the data source that you configured in previous steps, select the schema on which the database has been created, and click Next. 62 IBM Business Process Manager Telecom Pack version 7.5 : Order Handling How To Guide

69 Figure 60. Database Connection page i. Click Select All, ensure that the Update class list in persistence.xml check box is selected, and then click Finish. j. On the Configure JPA Entities page, click Select All, click Next, and then click Finish. k. Right-click OrderHandlingDBAccess, and the click JPA Tools > Configure Project for JPA Deployment. l. Define the JDBC JNDI name, select the connection and schema for deployment, and then click OK. Chapter 7. Step 4 : Implementing data persistence 63

70 Figure 61. Set up connection for deployment 2. Correct the errors reported by the JPA entities. 3. Add = GenerationType.IDENTITY) code to define the annotations for generating the primary key id. Figure 62. Code for Id generation 4. Add (CascadeType.ALL), fetch = FetchType.EAGER) code to configure annotations on relationships for the Cascade and Fetch types. 64 IBM Business Process Manager Telecom Pack version 7.5 : Order Handling How To Guide

71 Figure 63. Code for relationships for Cascade and Fetch types 5. Define any NamedQueries that are required for running queries on an entity or relations. a. In the Project Explorer, right-click the entity class and then click JPA Tools > Configure JPA Entities. b. On the Configure JPA Entities page, click Next. c. On the Tasks page, select NamedQueries and click Add for adding a new NamedQuery. Chapter 7. Step 4 : Implementing data persistence 65

72 Figure 64. Creating Named Queries d. On the Add Named Query page, define named query for columns to select, filter conditions, and order results, and then click OK. 1) Click the Result Attributes tab. 2) Specify findcustomerbyid in the Named Query Name text box. 66 IBM Business Process Manager Telecom Pack version 7.5 : Order Handling How To Guide

73 Figure 65. Updating the Result Attributes 3) Click the Filter Results tab. 4) Click the Add icon. 5) Specify the following details and click OK. v Select an attribute: Id v Select an operation: = v Variable Name: id Chapter 7. Step 4 : Implementing data persistence 67

74 Figure 66. Adding filter results Integrating the data access layer with the services layer After setting up the data access layer, Chuck Goldman, the Data Architect, integrates the data access layer with the services layer. Procedure 1. Define a façade for accessing the DB Access layer. Note: It is a best practice to define a façade for accessing the DB layer. 2. In the façade, create a connection to the JPA for the persistence unit. 3. Create a transformation layer that transforms XML data objects in the web service to JPA entities. 4. Get the handle of the DB Access Façade in the web service implementation. 68 IBM Business Process Manager Telecom Pack version 7.5 : Order Handling How To Guide

75 5. Run a transformation in the web service for transforming XML data objects to JPA entities with relations. 6. Run a save or update, or run query operations on the JPA entities to create, update, read, or delete the JPA entities. Summary The tasks completed during the step 4 include creating and configuring the database. The following are the tasks that were completed during this step: v Setting up the physical database v Setting up database entities v Implementing the data access layer v Integrating the data access layer with the services layer Chapter 7. Step 4 : Implementing data persistence 69

76 70 IBM Business Process Manager Telecom Pack version 7.5 : Order Handling How To Guide

77 Chapter 8. Step 5 : Deploying the process application After the BPM solution is built, it must be configured using the required tools. Next, it must be tested to verify that it is functioning properly. Finally, it must be deployed so that users can work with the BPM solution. The following assets are used to complete this step: v Process application for the BPM solution v Shared libraries v EAR files for the BPM solution The following table lists the roles, names, and tasks for the step. Table 8. Roles used in the BPM solution Roles Names Functions IT Administrator Adam Anderson The IT Administrator identifies, configures, and tests the hardware and software that is required for the BPM solution. User roles Business Manager Martha Green The Business Manager monitors the Order Handling process and ensures that the required tasks are complete. Customer Service Representative (CSR) Jay Walk The CSR processes the customer order on behalf of the customer. The tasks for this step are highlighted in the following flow: Figure 67. Building the BPM solution Note: The tasks displayed in purple color are optional steps or additional steps that might be required after the service implementation. Copyright IBM Corp. 2006,

78 Configuring the BPM solution manually Adam Anderson, the IT Administrator updates the settings that are provided here using various tools to configure the Order Handling Solution Scenario manually. Installing the Order Handling Solution Scenario artifacts The Order Handling Solution Scenario artifacts can be installed by importing the Process Application in the IBM Process Designer and using the EAR files provided with the Business Process Manager Telecom Pack or by importing the Project Interchange file into IBM Integration Designer to invoke the Solution Scenario. Installing the process application in IBM Process Center The Order Handling Solution Scenario artifacts can be installed in the IBM Process Center by importing the process application in IBM Process Designer. About this task To install the process application, perform the following steps: Procedure 1. Start the IBM Process Designer. 2. Click the Process Apps tab, click Import Process App, and then import the Order Handling process application from <Install-folder>/solutionscenarios/order-handling/source/order-handling-process-app.twx 3. Update the environment variable in IBM Process Designer by performing the following steps: a. Start the IBM Process Designer. b. From the Process Apps tab, click Open in Designer besides the ORDER HANDLING process application. c. Expand ORDER HANDLING > Setup and double-click Environment Variables, as shown in the following figure. Figure 68. Adding environment variables d. Update the EditionType environment variable as Advanced. e. Save your changes. 4. Update the environment variable in IBM Process Admin Console by performing the following steps: a. Log on to the IBM Process Admin Console as an administrator. 72 IBM Business Process Manager Telecom Pack version 7.5 : Order Handling How To Guide

79 b. Click Deployed Apps > Environment Vars > All. c. Click Order Handling. d. Update the EditionType environment variable to Advanced. 5. Update the tracking definition to enable tracking for reports. a. Start the IBM Process Designer and log on as an administrator, such as tw_admin. b. Open the Order Handling process application. c. Click Update Tracking Definitions and click OK. Note: Perform the following steps to work with the process application when you install the Solution Scenario using scripts or when a user who is not a member of the administrator group imports the process application. a. Start IBM Process Designer. b. From the Process Apps tab, click Order Handling. c. Click Manage, click Add Users/Groups, and add the administrator, such as tw_admin. d. Select the check box to grant Write and Admin rights for the group. e. From the Toolkits tab, click Telecom Common. f. Click Manage, click Add Users/Groups, and add the administrator, such as tw_admin. g. Select the check box to grant Write and Admin rights for the group. h. Restart IBM Process Designer. Installing the Order Handling Solution Scenario artifacts in IBM Process Server The Order Handling Solution Scenario artifacts can be installed by using the EAR files provided with the Business Process Manager Telecom Pack. Before you begin You must configure IBM Process Server to use the shared libraries. This action ensures that the same library is not loaded multiple times in the memory and it improves the server load. Perform the following steps: 1. Import the shared library jar files into IBM Process Server: a. Create the telecom-shared-libraries folder in the <IBM_Process_Server_profile> folder. b. Copy the contents from the <Install-folder>/solution-scenarios/orderhandling/runtime/shared-libraries folder to the telecom-sharedlibraries folder and the <IBM_Process_Server_HOME>/lib/ext folder. 2. Configure IBM Process Server to identify the shared libraries path for the BPM Telecom Pack: a. Log on to the IBM Process Server administrative console. b. Go to Environment > WebSphere variables, and from the Scope list, select Node=<Node_Name>, Server=<Server_Name>. c. Click New, specify the Name as TELECOM_SHARED_LIB_PATH, and the Value as ${USER_INSTALL_ROOT}/telecom-shared-libraries, click OK, and then click Save. d. Go to Environment > Shared libraries, and from the Scope list, select Node=<Node_Name>, Server-<Server_Name>. Chapter 8. Step 5 : Deploying the process application 73

80 e. Click New, specify the Name as TelecomSharedLibraries, the Classpath as ${TELECOM_SHARED_LIB_PATH}, ensure that the Use an isolated class loader for this shared library check box is selected, click OK, and then click Save. f. Go to Servers > Server Types > WebSphere application servers > server1 > Java and Process Management > Class loader. g. Click New, select Classes loaded with parent class loader first from the list, click OK, and then click Save. h. Go to Servers > Server Types > WebSphere application servers > server1 > Java and Process Management > Class loader, and click the class loader that you created. i. Click Shared library references, click Add, select TelecomSharedLibraries from the list, click OK, and then click Save. j. Restart the application server so that the classpath changes are registered. 3. Import the process application for the Solution Scenario in IBM Integration Designer. a. Start IBM Integration Designer. b. Switch to the Process Center perspective and specify the user name, password, and the URL. c. Click Open in workspace for the Order Handling process application. 4. Restart the IBM Process Server. About this task To install the Order Handling Solution Scenario artifacts in IBM Process Server, perform the following steps: Procedure 1. Log on to the IBM Process Server administrative console. 2. Click Applications > Application Types > WebSphere enterprise applications > Install. 3. Browse to the <Install-folder>/solution-scenarios/order-handling/runtime folder. 4. Install the EAR files listed in the following table and save your changes. Table 9. EAR file names with display names EAR file names order-handling-mock-app.ear order-handling-monitor-model-app.ear order-handling-mediation-module-app.ear Display name TOCP_Order_Handling_ Mock_Service TOCP_Order_Handling_MM TOCP_Order_Handling_Mediation 5. Update the configuration to use the shared library settings: a. Click Applications > Application Types > WebSphere enterprise applications. b. Click the required file, such as TOCP_Order_Handling_Mediation. c. From References, click Shared library references. d. Select the check box for the file, such as TOCP_Order_Handling_Mediation. e. Click Reference Shared Libraries. f. Move TelecomSharedLibraries to the Selected list. 74 IBM Business Process Manager Telecom Pack version 7.5 : Order Handling How To Guide

81 g. Save your changes. h. Repeat the above steps for TOCP_Order_Handling_Mock_ServiceEAR. 6. Select all the installed artifacts and click Start. 7. Restart the application server. Configuring the user registry in IBM Process Server The users and groups that access the Solution Scenario need to be defined in IBM Process Server. About this task To configure the user registry in IBM Process Server, perform the following steps: Procedure 1. Log on to the IBM Process Server administrative console. 2. Go to Users and Groups > Manage Groups > Create. 3. Create the groups Customer Service Representative and Business Manager.. 4. Go to Manage Users > Create and enter the user ID as tc_jay. 5. Click Group Membership > Search > Customer Service Representative > Add > Close. 6. Enter the First name, Last name, Password, Confirm password, and then click Create. 7. Create the following groups and users. Table 10. Mapping users to groups Group User ID First name Last name Password Customer Service Representative Business Manager tc_jay Jay Walk password tc_martha Martha Green password Configuring user access for Business Space The Solution Scenario provided with the Business Process Manager Telecom Pack includes pre-configured pages and widgets that can be imported into the Business Space. After importing these pre-configured pages, the Business Space displays the customized pages relevant to the Solution Scenario. About this task To configure user access for Business Space, perform the following steps: Procedure 1. Log on to Business Space as an administrator. 2. Import the Order Handling business space by performing the following steps: a. Click Manage Spaces > Import Space. b. Click Browse, go to the <Install-folder>/solution-scenarios/orderhandling/runtime/bspace/spacedata folder, select the order-handlingspace.zip file, click OK, and then click Done. Chapter 8. Step 5 : Deploying the process application 75

82 3. Add sharing rights for the Business Space pages by performing the following steps: a. Click Manage Spaces. b. For the Order Handling space, click Actions > Share. c. Expand the Search for Group list and click Group Search, enter *, and press the Enter key. The page for assigning rights is displayed, as shown in the following figure. Figure 69. Search a group d. Add the All Authenticated Users group to the Add to View list and click Save. e. Expand Order Handling Space. f. For the Getting Started page, click Actions > Share. g. Expand the Search for Group list and click Group Search, enter *, and press the Enter key. h. Add the All Authenticated Users group to the Add to View list and click Save. i. For the My Tasks page, click Actions > Share. j. Expand the Search for Group list and click Group Search, enter *, and press the Enter key. k. Add the groups that must view the page to the Add to Edit list and click Save. l. Similarly, add the sharing rights for the other pages using the information shown in Table 1. Note: In the previous step, you must add users to the Add to edit list if you want to give rights to a user to edit the page. For example, add Martha, the Business Manager, to the Add to Edit list for the Order Handling Process page. Ensure that you clear the Include viewers from parent check box and the Include editors from parent check box. Table 11. Updating the page sharing rights Order Handling Roles/Pages Getting Started My Tasks Dashboard Customer Service Representative Yes Yes N/A 76 IBM Business Process Manager Telecom Pack version 7.5 : Order Handling How To Guide

83 Table 11. Updating the page sharing rights (continued) Roles/Pages Getting Started My Tasks Order Handling Dashboard Business Manager Yes N/A Yes Table 12. Create groups and users Group User User ID Password Customer Service Representative Jay Walk tc_jay password Business Manager Martha Green tc_martha password m. Click Done. You can now view the Solution Scenario in Business Space. To view the Solution Scenario, click Go to Spaces > Order Handling. Configuring Business Space You need to create and configure a space and page in Business Space to execute the BPM solutions using Business Space. Procedure 1. Start Business Space. 2. Log on as an administrator, such as tw_admin. 3. Click Manage Spaces > Create Space. 4. Enter Order Handling and click Save. 5. Specify My Task for the Page name in the Create Page window and click OK. 6. Open the My Task page and click Edit Page. 7. Drag the following widgets to the space, click Save, and then click Finish Editing. v Task Definitions List v Tasks List v Task Information Figure 70. My Task page Chapter 8. Step 5 : Deploying the process application 77