Deploying Physical Solutions to InfoSphere Master Data Management Server Advanced Edition v11

Transcription

1 Deploying Physical Solutions to InfoSphere Master Data Management Server Advanced Edition v11 How to deploy Composite Business Archives (CBA) to WebSphere John Beaven IBM, Hursley

2 Contents Overview...3 Deployable components in Websphere...3 Deployable components for MDM Operational Server...4 Hot Deploying directly from the workspace...4 Checking the deployment using the WAS Admin Console...15 Un-deploying a hot deployed application from WebSphere...18 Installing a CBA archive using the WAS Admin Console...21 Uninstalling a CBA archive using the WAS Admin Console

3 Overview This document describes the how code developed in the MDM Workbench can be deployed to the MDM Operational Server. It discusses the concepts involved and presents the two different approaches to deployment. It also explains how such deployments can subsequently be removed from the server. Topics: Deployable components in WebSphere Deployable components for MDM Operational Server Hot deploying directly from the workspace Checking the deployment with the WAS Admin Console Un-deploying a hot deployed application from WebSphere Installing a CBA archive using the WAS Admin Console Uninstalling a CBA archive using the WAS Admin Console Tip: If you just want to get going quickly, you should focus on the hot deployment approach Deployable components in WebSphere The diagram below shows the structure of assets deployed to a WebSphere server. Business level applications consist of one or more composition units and these have a series of associated composition unit extensions. Business Level Application * Composition Unit * Composition Unit Extension The code developed in the workbench is packaged into a Composite Bundle Archive (CBA) for deployment to the server. This CBA is essentially a Composition Unit Extension for the purposes of deployment. Deployment now becomes a two step process: 3 Deploy the CBA from the workspace to the WebSphere application server as a Composite Unit Extension Associate the Composite Unit Extension with a Composition Unit.

4 Tip: Sometimes the WAS Admin console refers to these components as assets. Deployable components for MDM Operational Server The following diagram shows Business Level Applications and Composition Units to which MDM Operational Server extensions are deployed: BLA : MDM-operational-server-EBA-E001 CU: com.ibm.mdm.hub.server.app-e001_0001.eba Composite Bundle Archive Composite Bundle Archive CUE: Composite Bundle Archive Tip: MDM Operation Server does contain other Business Level Applications and Composition Units. Hot deploying directly from the workspace You can deploy your code directly from the workspace to a WebSphere server with a connection listed in the Servers view. When you do this, there is no need for the code to be exported to an asset (eg.cba file) and then installed through the WAS Admin Console. As you make changes to the code, these can be automatically or manually reflected (published) on the server, again without the need to involve the WAS Admin console. Tip: Before you do this you should ensure that the server connection is configured so that binary code developed in the workspace is copied to the WAS server rather than being linked to it. The distinction may seem subtle, but the effect is to de-couple code developed in the workspace with the code deployed on the server. The server deployment will remain valid and functional even if the workspace is deleted (if it was linked to a workspace that was deleted, this would cause problems). 1.1 Open the Servers view and locate the target WAS server (eg WebSphere Application Server v8.5 at localhost). Check to see if the server is Started 4

5 1.2 If the server is Stopped, start it by opening the context menu on the server definition and selecting the Start option. Wait for the server start-up to complete. 1.3 Open the context menu for the server definition and select Add and Remove 5

6 1.4 In the Add and Remove dialog select the CBA to be deployed from the Available list and click Add > to move it to the Configured list 1.5 Click the Finish button to publish the CBA to the server. 1.6 Wait for the Server connection to become Synchronized again Tip: The CBA is published to the server but not yet associated with a Business Level Application. Before it can be used, it must be configured as a Composition Unit Extension 6

7 1.7 Expand the server connection to reveal the published CBA. Open the context menu for the CBA and select Manage Extensions. 1.8 In the Manage Extensions dialog, expand the Advanced option. 7

8 1.9 Click the Get information from server button to retrieve information about existing deployed applications When the Business-level application drop down appears, select the target application (in the case of MDM Server this is MDM-operation-server-EBAE001). 8

9 1.11 When the Composition unit drop down appears select the target Composition Unit (in the case of MDM Server this is com.ibm.mdm.hub.server.appe001_0001.eba) Click Finish to apply this configuration

10 1.13 The Manage Extension dialog will appear whilst this configuration is performed Once the process is complete, check the Server connection status again and wait for it to become Synchronized Tip: Although the CBA is now fully deployed, the Database configuration must be applied before it can be invoked. The next step is to set up a connection the MDM database and run an SQL script to apply the necessary configuration Open the context menu on the server connection and select Stop Wait for the Server connection to become Stopped 10

11 1.17 Select the Data Source Explorer view and expand Database Connections 1.18 Open the context menu on the MDM database connection (MDM11DB) and select Properties 1.19 In the Properties for MDM11DB dialog, Select Driver Properties in the left hand panel, open the General properties tab in the right hand panel and update the User name and Password fields if necessary. The default values for the MDM Typical Workbench installation are: DB2 User name : db2admin DB2 Password: db3admin 11

12 1.20 Click the Test Connection button to determine if these settings are correct. You should see the Success dialog after a few seconds. Click OK to dismiss this window Once you have confirmed the connection to the database is correctly set up, close the Properties for MDM11DB dialog by clicking OK 1.22 Select the Package Explorer view 1.23 Expand the MDMSharedResources -> sql folder 1.24 Open the context menu over the Setup_DB2.sql file and select Open With -> SQL and XQuery Editor 12

13 1.25 Open the context menu anywhere in the SQL file and select Use Database Connection 1.26 In the Select Connection Profile dialog, select the MDM11DB database connection and click Finish Tip: This associates the specific SQL file with the MDM11DB connection. When the script is subsequently executed, this is the database connection that will be used. 13

14 Open the context menu anywhere in the SQL file and select Run SQL 1.29 The statements in the SQL file will be executed to configure the MDM database. Progress is displayed in the SQL Results view that will open in the workbench. Tip: You should check to see if the overall process Succeeded or if individual statements failed. Where failures do occur, it may be that a previous deployment is causing conflicts (e.g. a table already exists). You can either resolve such issues by hand or try to remove a previous configuration using the Rollback scripts created alongside the setup scripts. Tip: Once the database is configured its time to restart the WAS server 14

15 1.30 Open the Servers view and locate the target WAS server (eg WebSphere Application Server v8.5 at localhost) Open the context menu on the server definition and select Start. Wait for the server start-up to complete Checking the deployment using the WAS Admin Console 2.1 Open the context menu on the server definition and select Administration -> Run Administrative Console. 15

16 2.2 When the WebSphere Integrated Solutions Console appears, enter the WAS user id and password and click Login. The default values for the MDM Typical Workbench installation are: WAS User name : mdmadmin WAS Password: mdmadmin 2.3 Once the console has opened, select Applications -> Application Types -> Business level applications in the tree view 2.4 Check the right hand panel under Business-level applications to ensure the MDM-operational-server-EBA-E001 is Started. Tip: The Status should show a filled in green arrow. The hover text over the arrow should be Started. If there is a green arrow but it is partially filled in and the hover text is Partially Started then not all the EBA components have started correctly. If there is no arrow then the EBA is not running at all. 16

17 2.5 Click on the MDM-operational-server-EBA-E001 link to see the list of composition units contain in the application 2.6 Click on com.ibm.mdm.hub.server.app-e001_0001.eba link to open the configuration settings for this composition unit 2.7 In the configuration settings panel, click on the Extensions for this composition unit link. 17

18 2.8 Ensure the CBA you are deploying is shown in the list of Composite Bundle Archive Extensions Un-deploying a hot deployed application from WebSphere Tip: You only need to undeploy the application if you wish to remove it from the server or are going to try deploying the application using the WAS Admin Console 3.1 Open the Servers view and locate the target WAS server (eg WebSphere Application Server v8.5 at localhost). Check to see if the server is Started 3.2 If the server is Stopped, start it by opening the context menu on the server definition and selecting the Start option. Wait for the server start-up to complete 18

19 3.3 Expand the server connection to reveal the published CBA. Open the context menu for the CBA and select Manage Extensions 3.4 In the Manage Extensions dialog de-select the MDM-operational-server-EBAE001 and click Finish Tip: The list shows those business level applications to which the CBA is deployed. By de-selecting the application, you are removing the CBA from it. 3.5 Wait for the Manage Extensions progress dialog to complete (this can several minutes to complete) 19

20 3.6 Select the Server view, open the context menu over the target WebSphere server and select Add and Remove 3.7 In the Add and Remove dialog window, select the target CBA from the Configured panel and click Remove to move it to the Available panel then click Finish to make these changes Note: Whilst the application is now completely removed from the WebSphere server, configuration settings remain in the DB2 database. You can ignore this and continue to use the other services provided by the MDM Server or you can follow the steps 20

21 outlined in section 1.15 to run the rollback SQL script and remove the configuration. If you are not going to re-deploy the application, it s recommended that you run the rollback script to remove the configuration from the database. If you are going to re-deploy the application then you should run the rollback script if you have made or plan to make structural changes to the model. You would then need to re-run the updated set up script when you re-deploy the application. If you are going to re-deploy the application but won t be making such structural changes, you can leave the configuration in place. In this case you don t need to rerun the setup script when you re-deploy the application. Installing a CBA archive using the WAS Admin Console Tip: If you are going to try deploying the CBA archive, you must first ensure the application is not hot deployed to the target server. If necessary follow the steps outlined in section 3 above to remove the existing deployment 4.1 Open the context menu on the target CBA project and select Export 4.2 In the Export dialog, select OSGi -> OSGi Composite Bundle and click Next 21

22 4.3 In the OSGi Composite Bundle Export wizard, click Browse, choose a target location for the exported CBA archive file then click Save 4.4 In the Export dialog, click Finish 22

23 4.5 Open the Servers view, locate the target WAS server (eg WebSphere Application Server v8.5 at localhost) and check to see if the server is Started 4.6 If the server is Stopped, start it by opening the context menu on the server definition and selecting the Start option. Wait for the server start-up to complete 4.7 Open the context menu on the server definition and select Administration -> Run Administrative Console 23

24 4.8 When the WebSphere Integrated Solutions Console appears, enter the WAS user id and password and click Login. The default values for the MDM Typical Workbench installation are: WAS User name : mdmadmin WAS Password: mdmadmin 4.9 In the left hand panel select Environment > OSGi bundle repositories > Internal bundle repository and click New 4.10 In the Internal bundle repositories panel, select Local file system and click Browse 24

25 4.11 When the Choose File to Upload dialog appears, select the CBA exported above and click Open Click OK again to import the CBA

26 4.13 When the Messages dialog appears click Save to commit these changes. Tip: You will see a series of warnings stating that The service dependency with attributes. required by bundle.. cannot be resolved. You may ignore these warnings. They are occurring as the CBA has not yet been associated with a Business Level Application (ie MDM) 4.14 Once the save process is complete, you will see a dialog showing the CBA as an available bundle in the Internal bundle repository Tip: The CBA is published to the server but not yet associated with a Business Level Application. Before it can be used, it must be configured as a Composition Unit Extension 26

27 4.15 In the Admin Console left hand panel, open the Applications -> Application Types -> Business-level applications and click on the MDM-operationalserver-EBA-E001 Tip: The list above shows the Business Level Applications that are deployed on the server. These business level applications are made up of a series of composition units In the right hand panel, click on the target Composition Unit link (In the case of MDM Operational Server this is com.ibm.mdm.hub.server.app-e eba) Tip: The list above shows the Composition Units that make up the Business Level Application. Each of these can contain a series of Composition Unit Extensions (The CBA you are deploying is one of these extensions) 27

28 4.17 Next, click on the Extensions for this composition unit under the Additional Properties section 4.18 When the extensions panel appears, click the Add button Tip: This list shows the Composition Unit Extensions that are associated with the selected Composition Unit. When your CBA is fully deployed, it will be listed here Tick the Composition Unit Extension (the CBA bundle) you wish to deploy to the application and Click Add Tip: This list shows the bundles residing in the WAS Internal Bundle Repository 28

29 4.20 When the Messages box appears, click Save to commit these changes 4.21 Next you need to navigate back to the MDM Server Composition Unit settings panel. Click on the com.ibm.mdm.hub.server.app-e eba link in the console as shown below: 4.22 Under the OSGI application deployment status section, click the Update to latest deployment button 4.23 A panel will open showing the changes that will be made to upgrade the Composition Unit. Locate the CBA (The extension to the composition unit) that 29

30 you are deploying. It should be listed as Not deployed in the Deployed Version column and show a version number in the New Version column Scroll to the bottom of the panel and click the OK button 4.25 When the Set options settings panel appears, click Next twice to move to Step 3 in the left hand panel 4.26 Now click Finish to upgrade the Composition Unit 4.27 When the Messages box appears, click Save to commit these changes 30

31 Tip: Although the CBA is now fully deployed, the Database configuration must be applied before it can be invoked. The next step is to set up a connection the MDM database and run an SQL script to apply the necessary configuration. The database configuration is performed in the same way as the hot deployment solution outlined above Follow the database configuration steps from 1.15 onwards to deploy the database configuration Uninstalling a CBA archive using the WAS Admin Console 5.1 Open the Servers view and locate the target WAS server (eg WebSphere Application Server v8.5 at localhost). Check to see if the server is Started 5.2 If the server is Stopped, start it by opening the context menu on the server definition and selecting the Start option. Wait for the server start-up to complete. 5.3 Open the context menu on the server definition and select Administration -> Run Administrative Console. 5.4 When the WebSphere Integrated Solutions Console appears, enter the WAS user id and password and click Login. The default values for the MDM Typical Workbench installation are: WAS User name : mdmadmin WAS Password: mdmadmin 31

32 5.5 In the left hand panel select Applications -> Application Types -> Businesslevel applications and then click the MDM-operational-server-EBA-E001 link in the Business-level applications panel 5.6 Once the application is opened in the right hand panel, click the com.ibm.mdm.hub.server.app-e eba link 5.7 Tick the box next to the target CBA file and click the Remove button 32

33 5.8 Once the Message panel appears, click Save to commit these changes 5.9 In the WAS Admin Console left hand panel select Environment -> OSGi bundle repositories -> Internal bundle repository 5.10 Under the Internal bundle repository selection in the right hand panel, check the bundle you previously deployed and click Delete 33

34 5.11 When the Messages panel appears, click Save to commit these changes Note: Whilst the application is now completely removed from the WebSphere server, configuration settings remain in the DB2 database. You can ignore this and continue to use the other services provided by the MDM Server or you can follow the steps outlined in section 1.15 to run the rollback SQL script and remove the configuration. If you are not going to re-deploy the application, it s recommended that you run the rollback script to remove the configuration from the database. If you are going to re-deploy the application then you should run the rollback script if you have made or plan to make structural changes to the model. You would then need to re-run the updated setup script when you re-deploy the application. If you are going to re-deploy the application but won t be making such structural changes, you can leave the configuration in place. In this case you don t need to rerun the setup script when you re-deploy the application. 34