Unit 23: Deployment ActiveBPEL Fundamentals This is Unit #23 of the BPEL Fundamentals course. In past Units we ve looked at ActiveBPEL Designer, Workspaces and Projects, created the Process itself and then declared our Imports, PartnerLinks and Variables and then we created Interaction Activities in various ways. Next, we looked at the Sequence activity, Assignments and Copies and after that we studied Correlation, Scopes and Fault Handling. Then, we examined Compensation, Event Handling, Termination Handlers and the If activity and we also looked at the rest of the BPEL Basic activities. In the next four Units we looked at BPEL's Flow and Pick activities, the various types of Looping activities and at the Extension capabilities that are available in the BPEL v2.0 specification and how Active Endpoints has implemented them. In the next Unit we looked at three Advanced BPEL topics: Isolating Receive- Reply pairs, Additional Message definitions and Re-using BPEL snippets. Finally, in our last Unit, we examined how the Simulation of a BPEL Process works in the Designer. Now that we have a completed process whose correctness has been tested through various simulations, we can turn our attention to the actual deployment of our process onto the server. Endpoints, Inc. All Rights Reserved 1
Unit Objectives At the conclusion of this unit, you will be familiar with: Deployment overview Creating a Process Deployment Descriptor File Creating a Business Process Archive Using a Business Process Archive Description 2 Copyright 2004-2007 Active Endpoints, Inc. Endpoints, Inc. All Rights Reserved 2
Deployment Overview Deployment is the act of publishing your BPEL processes to an ActiveBPEL server Where it can listen for messages to start new process instances Once deployed, the ActiveBPEL server ensures that the correct partner services and messages interact with the process 3 Copyright 2004-2007 Active Endpoints, Inc. Once a BPEL process has been designed, created and tested, the next step is to deploy the process onto a BPEL-compliant server. (Recall also that if any extensions are used by the process the server must understand those extensions in order for them to be executed.) Once the BPEL process has been deployed to the server, it can receive the incoming messages that will instantiate it. It will then execute the process and coordinate the partner-process message traffic, as necessary. Endpoints, Inc. All Rights Reserved 3
Deployment artifacts Process Deployment Descriptor Business Process Archive Business Process Archive Description (Optional) 4 Copyright 2004-2007 Active Endpoints, Inc. A BPEL deployment package includes the BPEL Process file (.bpel), the WSDL and Schema files, an optional Partner Definition File (.pdef) and the Process Deployment Descriptor (.pdd), which are all wrapped inside the Business Process Archive (.bpr) or an optional Business Process Archive Description (.bprd). Endpoints, Inc. All Rights Reserved 4
Process Deployment Steps 1 3 2 5 Copyright 2004-2007 Active Endpoints, Inc. The steps to deploying a BPEL process begin with (1.) the design and construction of the BPEL process itself. Once the process has been completed and tested, you put the necessary files into (2.) a Deployment Package (.bpr). This package is then deployed (3.) to the ActiveBPEL server. Once the process is deployed, the server waits for the incoming message activity that will instantiate our process. Endpoints, Inc. All Rights Reserved 5
Unit Objectives At the conclusion of this unit, you will be familiar with: Deployment overview Creating a Process Deployment Descriptor File Creating a Business Process Archive Using a Business Process Archive Description 6 Copyright 2004-2007 Active Endpoints, Inc. Endpoints, Inc. All Rights Reserved 6
Process Deployment Descriptor (PDD) One-to-one relationship with a BPEL process file Provides: Relationship between abstract WSDL service descriptions and the physical implementations Persistence and versioning information Process directives and indexed properties Locations of WSDL file(s) referenced by the process 7 Copyright 2004-2007 Active Endpoints, Inc. Each BPEL process file has a Process Deployment Descriptor that goes with it. The PDD defines: 1.) the relationship between the services defined in the WSDL files and their physical implementations. This includes the message envelope (e.g., SOAP) and the transport mechanism (e.g., HTTP). 2.) Persistence (the storage of process execution data in the database) and versioning (the activation and sunsetting of different process versions.) 3.) Process directives (configuration settings that handle uncaught faults, data retention days, etc.) and indexed properties (which allow for better and faster searches against the process instance database.) 4.) The locations (URLs) of the WSDL files whose definitions are referenced by the process. Endpoints, Inc. All Rights Reserved 7
Creating a new PDD 1. Select File>New>Deployment Descriptor New Deployment Descriptor Wizard opens 2. Select the appropriate deployment platform Chosen platform will be become the default value for newly created PDDs 3. Select the process to create a PDD for If a process is in focus in the Navigator view, then by default that process will be selected in the wizard 4. Select Next Alternatively either Right click on a process, then New>Deployment Descriptor Select New toolbar dropdown, then Deployment Descriptor 8 Copyright 2004-2007 Active Endpoints, Inc. 1.) Once the process is complete and has been simulated, we are ready to create a Process Deployment Descriptor. Select File->New->Deployment Descriptor or select the.bpel file in the Navigator and use the Right Mouse context menu and select New->Deployment Descriptor. Either choice opens the same dialogs. 2.) Select your deployment platform. This choice will depend on your operating system and the product configuration (i.e., Enterprise, Professional, etc.) you are using. 3.) Select the.bpel file that is going to be deployed. Only one.bpel file can be deployed at a time. 4.) Click Next to advance the dialog. Endpoints, Inc. All Rights Reserved 8
Creating a new PDD Process Persistence Refers to storage of active processes deployed to a server System Default Default engine setting is full persistence Full All state information is persisted for each process instance None No state information is persisted for each process instance 9 Copyright 2004-2007 Active Endpoints, Inc. The next screen asks you to set the options for the persistence for a deployed process instance. This controls how much of an instance's data will be retained in the database for later retreival. The choices are Full (save all data) and None (save no data.) The default setting for this option is Full retention. Endpoints, Inc. All Rights Reserved 9
Creating a new PDD Suspend on Uncaught Fault According to the BPEL4WS 1.1 specification, if a fault occurs in (or is re-thrown) to the global process scope, and there is no matching fault handler for the fault at the global level, the process terminates abnormally ActiveBPEL provides an extension to change this behavior Instead of terminating abnormally, the process suspends Allows for process exception management to be performed Only available in ActiveBPEL Enterprise 10 Copyright 2004-2007 Active Endpoints, Inc. The next option is for the "Suspend on Uncaught Fault" setting. The BPEL v2.0 specification normally requires that if a fault rises to the process level without being handled, then the process will terminate abnormally. ActiveBPEL provides an extension that allows you to override this default behavior. Instead of terminating the process, it is suspended, which allows the user to manage the exception through the Administrative Console (or through other access routes to the functionality.) Note: This extension is currently available with the ActiveBPEL Enterprise and Professional Editions. Check with your Active Endpoints representative for further information. Endpoints, Inc. All Rights Reserved 10
Creating a new PDD Process Instance Retention When a process has completed execution, it is persisted indefinitely ActiveBPEL provides a setting to change this behavior Instead of persisting indefinitely, the process can be retained for a specified number of days Allows for process instance purge to be scheduled Only available in ActiveBPEL Enterprise 11 Copyright 2004-2007 Active Endpoints, Inc. The next Process Descriptor setting is for the retention of process instance data. If data is retained, the next question is how long will it be kept? The "Process Instance Retention Days" setting allows you to decide this. Entering this value results in an automatic purge of the data after the designated interval. Note: This extension is currently available with the ActiveBPEL Enterprise and Professional Editions. Check with your Active Endpoints representative for further information. Endpoints, Inc. All Rights Reserved 11
Creating a new PDD - Process Versioning Versioning allows the same fully qualified process name to be deployed multiple times with different parameters and logic Only available in ActiveBPEL Enterprise Specify effective and expiration dates Specify action for previous version's running processes Each of the version parameters have engine defaults if not selected in the PDD 12 Copyright 2004-2007 Active Endpoints, Inc. The Process Versioning settings allow you to manage mutliple versions of the process, and it has three major features. The first is the Versioning method, where you can define the version (major.minor) yourself or let the system do it automatically. The second set is the Effective date and Expiration (sunset) date, which brackets the lifespan of the process and lets you control when a new version is activated and when an old version is sunsetted. The third setting defines the Disposition of a currently running process instance when the changeover occurs. The choices are: keep the old version (which is the default), migrate the instance to the new version or terminate the instance. Endpoints, Inc. All Rights Reserved 12
Creating a new PDD - Partner Link Endpoints Each partner link role must have a binding specified before deployment Only the roles that are defined in the process for a partner link will be enabled All My Role entries have defaults automatically populated 13 Copyright 2004-2007 Active Endpoints, Inc. After we set the Process Versioning information, we have to set the Partner Link Endpoint information. Each Partner Link Role must have a binding specified before the process is deployed. Note that this only applies to partnerroles, because all MyRole (i.e., process) entries will have their defaults populated automatically. Endpoints, Inc. All Rights Reserved 13
Partner Role Endpoint Types Each Partner Role must be bound to an implementation by one of the following endpoint types Dynamic Set through an endpoint reference copy operation in the process Invoker Uses the Reply To information from a request (My Role) on the same Partner Link Principal Looks up a static endpoint from a previously defined and deployed partner definition file by the credentials passed in on a previous request for the same Partner Link Static Binds to the WSDL Service definition in the referenced WSDL file Uses WS-Addressing as the syntax for describing the Service name 14 Copyright 2004-2007 Active Endpoints, Inc. In addition to the PartnerLink Endpoint information we saw on the last slide, we must bind each Partner Role to an implementation. There are four types of endpoint implementations: 1.) Dynamic: Dynamic endpoint references are set by using the data in a Assign's Copy Operation. This could be used in a situation where a User is offered multiple vendors for a product offered by our service, and the endpoint must be set at runtime, i.e., when the User makes the actual choice. 2.) Invoker: In this situation, the process uses Reply To information that is sent in with the original request. 3.) Principal: In this situation, an inbound message will contain credentials which will be used to go to a Partner Definition File (included in the.bpr file) that defines the Endpoint information. 4.) Static: Binds the WSDL Service to a reference in the WSDL file. In this situation, the system will use WS-Addressing syntax to describe the service name. Endpoints, Inc. All Rights Reserved 14
Creating a new PDD - Indexed Properties Indexed properties allow for fast searching of important data items within process variables at runtime ActiveBPEL Enterprise Administrative Console provides ability to perform full searching e.g., Find all orders received where customerid is 101 and ordertotal > $100,000 15 Copyright 2004-2007 Active Endpoints, Inc. The Indexed Properties of a PDD file allow for faster runtime searching of defined variable property data. Endpoints, Inc. All Rights Reserved 15
Creating a new PDD Deployment Descriptor File Specify the location for the Process Deployment Descriptor and the file name The defaults are the same folder and file name as the process Press Finish to complete the wizard 16 Copyright 2004-2007 Active Endpoints, Inc. Now that all of the contents of the PDD have been determined, you simply name and save the file. Endpoints, Inc. All Rights Reserved 16
PDD Editor The PDD editor provides only schema validation When deploying the contents will be validated 17 Copyright 2004-2007 Active Endpoints, Inc. Once you ve saved the file and clicked Finish to exit the wizard, the system will open the file for you. Note that the Schema elements will be validated. Endpoints, Inc. All Rights Reserved 17
Unit Objectives At the conclusion of this unit, you will be familiar with: Deployment overview Creating a Process Deployment Descriptor Creating a Business Process Archive Using a Business Process Archive Description 18 Copyright 2004-2007 Active Endpoints, Inc. Endpoints, Inc. All Rights Reserved 18
Business Process Archive One-to-many relationship with Processes and Deployment Descriptors Contains BPEL file(s) PDD file(s) Optional Locally defined WSDL and schema files WSDL catalog files Partner Definition files 19 Copyright 2004-2007 Active Endpoints, Inc. Once we have completed and tested our process, and created the Process' Deployment Descriptor File, we have to put it all into a Business Process Archive file. This archive will contain the process file (.bpel), the Process Deployment Descriptor file (.pdd), WSDL or Schema files used by the process. The archive can also contain Partner Definition files. Partner Definition files contain pre-defined endpoint information for a single service, consisting of an endpoint reference for each partnerlink type that the partner implements. Endpoints, Inc. All Rights Reserved 19
Creating a New BPR 1.Select File>Export Export Wizard opens 2.Select Business Process Archive File and then click Next 3.Select PDD(s) for deployment Partner definition files may also be selected 4.Specify a file name and location for the BPR 5.Select the deployment method 6.Optionally create a BPRD file 7.Select Finish 20 Copyright 2004-2007 Active Endpoints, Inc. Once you have a PDD file, you are ready to create a Business Process Archive file. Use File->Export and select Business Process Archive. Then, select the PDD(s) file to be included and set the BPR file name and location. Set the Deployment method (examined in detail in a few minutes) and optionally check the box to create a BPRD file. Click Finish. Endpoints, Inc. All Rights Reserved 20
Deployment Type Options None BPR file will be created in the selected location on the file system To be deployed at a later time File BPR file will be copied to the ActiveBPEL server deployment folder When the ActiveBPEL server is running, it scans this folder for any BPR files to deploy Web Service BPR is automatically deployed to a running ActiveBPEL server instance Deployment status and details are returned 21 Copyright 2004-2007 Active Endpoints, Inc. There are three Deployment Type options available for the new BPR file. First, you can generate the file and save it somewhere for later deployment. This is option #1 and you choose this by selecting "None" in the Deployment Type droplist. The next option is "File" and you pick this by selecting "File" in the Deployment Type droplist. With this option, the new BPR will be copied to the BPR folder for a running ActiveBPEL server. The Server automatically scans its BPR (deployment) folder and will deploy any BPRs found there. Finally, there is the option to deploy the BPR as a web service. In this case the service is automatically deployed to a running server and deployment status and details are returned. Endpoints, Inc. All Rights Reserved 21
Unit Objectives At the conclusion of this unit, you will be familiar with: Deployment overview Creating a Process Deployment Descriptor Creating a Business Process Archive Using a Business Process Archive Description 22 Copyright 2004-2007 Active Endpoints, Inc. Endpoints, Inc. All Rights Reserved 22
Business Process Archive Description Ant script with custom tasks to re-create and optionally deploy a BPR Created and executed even if not saved Can be re-executed via right-click on the.bprd file from the Navigator view Scans PDDs for referenced WSDL files and locates all locally defined WSDL and Schemas File paths are all absolute so these are difficult to share 23 Copyright 2004-2007 Active Endpoints, Inc. When creating a BPR file, you are given the option of creating a.bprd file, which is the BPR file with an Ant script that allows you to update the BPR after modifying the.bpel (process) file or the PDD (Process Deployment Descriptor). This Ant script can be executed by using the Right Mouse context menu on the BPRD file. Note that when you create these, the file paths to all of the resources and files are absolute, so they are not portable. Endpoints, Inc. All Rights Reserved 23
Lab 5 Process Deployment Overview of Lab Exercises Deploy supporting files Create the PDD Create the BPR Deploy the process 24 Copyright 2004-2007 Active Endpoints, Inc. The next Lab in the BPEL Fundamentals class is Lab #19. (Note: This is lab #5 if you are taking the BPEL Intermediate course.) In this lab we'll deploy a preconfigured set of supporting (i.e., partner services) files that will interact with our process. Once the partner services we'll interact with are deployed, then we can deploy our own process. First, we'll create a PDD (Process Deployment Descriptor), next we'll create a BPR (Business Process Archive) and finally we'll deploy the process to the server as a web service. Endpoints, Inc. All Rights Reserved 24
Unit Objectives Now you are familiar with: Deployment overview Creating a Process Deployment Descriptor File Creating a Business Process Archive Using a Business Process Archive Description 25 Copyright 2004-2007 Active Endpoints, Inc. Endpoints, Inc. All Rights Reserved 25