MCA Services Build Process Guide

Transcription

1 MCA Services Build Process Guide Version 2005 June 2005

2 Siebel Systems, Inc., 2207 Bridgepointe Parkway, San Mateo, CA Copyright 2005 Siebel Systems, Inc. All rights reserved. Printed in the United States of America No part of this publication may be stored in a retrieval system, transmitted, or reproduced in any way, including but not limited to photocopy, photographic, magnetic, or other record, without the prior agreement and written permission of Siebel Systems, Inc. Siebel, the Siebel logo, UAN, Universal Application Network, Siebel CRM OnDemand, TrickleSync, Universal Agent, and other Siebel names referenced herein are trademarks of Siebel Systems, Inc., and may be registered in certain jurisdictions. Other product names, designations, logos, and symbols may be trademarks or registered trademarks of their respective owners. PRODUCT MODULES AND OPTIONS. This guide contains descriptions of modules that are optional and for which you may not have purchased a license. Siebel s Sample Database also includes data related to these optional modules. As a result, your software implementation may differ from descriptions in this guide. To find out more about the modules your organization has purchased, see your corporate purchasing agent or your Siebel sales representative. U.S. GOVERNMENT RESTRICTED RIGHTS. Programs, Ancillary Programs and Documentation, delivered subject to the Department of Defense Federal Acquisition Regulation Supplement, are commercial computer software as set forth in DFARS , Commercial Computer Software and Commercial Computer Software Documentation, and as such, any use, duplication and disclosure of the Programs, Ancillary Programs and Documentation shall be subject to the restrictions contained in the applicable Siebel license agreement. All other use, duplication and disclosure of the Programs, Ancillary Programs and Documentation by the U.S. Government shall be subject to the applicable Siebel license agreement and the restrictions contained in subsection (c) of FAR , Commercial Computer Software - Restricted Rights (June 1987), or FAR , Rights in Data General, including Alternate III (June 1987), as applicable. Contractor/licensor is Siebel Systems, Inc., 2207 Bridgepointe Parkway, San Mateo, CA Proprietary Information Siebel Systems, Inc. considers information included in this documentation and in Siebel Business Applications Online Help to be Confidential Information. Your access to and use of this Confidential Information are subject to the terms and conditions of: (1) the applicable Siebel Systems software license agreement, which has been executed and with which you agree to comply; and (2) the proprietary and restricted rights notices included in this documentation.

3 Contents 1 What s New in This Release 2 About the Build Process 3 Build Process Prerequisites Build Process Platform 9 Extracting the Build Files 9 MCA Services Directory Structure 9 MCA Services Signed JAR Files 10 4 WebLogic 8.1 Build Process Prerequisites for the WebLogic Build Process 11 Running the Automated WebLogic Build Process 11 Deploying the EAR File on WebLogic 12 5 WebSphere Build Process Prerequisites for the WebSphere Build Process 13 Running the Automated WebSphere Build Process 13 Deploying the EAR File on WebSphere 14 MCA Services Build Process Guide Version

4 What s New in This Release Build Process Platform 4 MCA Services Build Process Guide Version 2005

5 1 What s New in This Release What s New in MCA Services Build Process Guide, Version 2005 Table 1 lists changes in this version of the documentation to support release 2005 of the software. Table 1. What s New in MCA Services Build Process Guide, Version 2005 Table 1. Table Title Here Topic Configuring ANT_HOME Build Process Platform, page 9 MCA Services Directory Structure, page 9 Prerequisites for the WebLogic Build Process, page 11 Description Removed the section on configuring ANT_HOME. This property does not need to be configured by the user because it is auto-configured. Added reference to the Siebel Foundation Services System Requirements and Supported Platforms document. Updated the description of the resource files supplied in the <installation directory>\foundationservices\common directory Added configuration of the JAVA_HOME variable in ant.bat. Added configuration of the weblogic.home variable in ant.bat. Running the Automated WebLogic Build Process, page 11 The build process command ant has been replaced with build weblogic. The build script build.xml has been replaced with build.cmd. Running the Automated WebSphere Build Process, page 13 Updated the build process to support WebSphere The build process command ant has been replaced with build [websphere-db2 websphere-orcl]. The build script build.xml has been replaced with build.cmd. MCA Services Build Process Guide Version

6 What s New in This Release Build Process Platform 6 MCA Services Build Process Guide Version 2005

7 2 About the Build Process This build guide covers the build process for MCA Services on supported platforms. The terms MCA Services and Foundation Services are interchangeable in this documentation. MCA Services encompasses the Financial Process Integrator engine and the Statemachine. This guide is divided into the following chapters: Build Process Prerequisites WebLogic 8.1 Build Process WebSphere Build Process The build scripts for each environment will create an Enterprise Application and deployment descriptors for that environment. MCA Services Build Process Guide Version

8 About the Build Process Build Process Platform 8 MCA Services Build Process Guide Version 2005

9 3 Build Process Prerequisites Build Process Platform The build scripts are supported on the Windows platform and require a J2SE Development Kit (JDK) version 1.4 or higher. NOTE: For all supported platform version information, including the supported database, application server and third-party software versions, refer to the Siebel Foundation Services System Requirements and Supported Platforms document. The SRSP document is available on Siebel SupportWeb ( or from your Siebel representative. Extracting the Build Files The MCA Services installation pack for the appropriate target application server and database needs to be extracted before running the build process. MCA Services Directory Structure The files contained in the installation packs will be extracted to <installation directory>\foundationservices\ with the following directory structure: Table 2. MCA Services Directory Structure Directory 3rdParty\ Build\ build_tmp\ Description Contains third-party libraries required for supporting MCA Services Contains the command shell, ANT scripts, and other required resources for generating a deployable EAR file. The build.properties file in the <installation directory>\foundationservices\common directory is used to specify the target environment as well as the build folder (<installation directory>\foundationservices\build_tmp by default) location. For each supported target environment, the properties files are preset with the appropriate values. Contains the deployable EAR file built using the provided build scripts. This directory is also used for temporary files produced during execution of the build script. The deployable EAR file is output to: <installation directory>\foundationservices\build_tmp\build_releas MCA Services Build Process Guide Version

10 Build Process Prerequisites Extracting the Build Files Directory Description e\siebel.ear Common\ deploy\ deploy\database\ Contains common MCA Services library JAR files such as bfa-utils, mca.jar, and statemachine-ext. Also contains the property files including BankframeResource.properties and BankframeMessages.properties Contains the pre-built and deployable MCA Services EAR file Contains the SQL scripts for the target database MCA Services Signed JAR Files The MCA Services installation pack contains several important class jar files contained in the <installation directory>\foundation Services\Common\lib folder. The following jar files contain compiled classes only - no source code. These jar files have been signed with a digital certificate using the Jar Signer tool. This is intended to aid the verification of jar versions. Signing a jar file prevents any changes being made to it. This means that Siebel Systems can be sure that the version of a jar file being used on a customer site corresponds exactly to the version originally supplied. Table 3. MCA Services Signed JAR Files Signed JAR File mca.jar bfa-utils.jar statemachine-ext.jar Description This is the jar of MCA Services classes. This jar file contains utility classes. This jar file contains extension classes for the StateSoft Statemachine framework supporting the Siebel Screen Orchestrator tool. 10 MCA Services Build Process Guide Version 2005

11 4 WebLogic 8.1 Build Process Prerequisites for the WebLogic Build Process WebLogic must be installed on the build machine. The JAVA_HOME variable in <installation directory>\foundationservices\build\java\ant\bin\ant.bat must be configured to point to the WebLogic JDK. The JAVA_HOME variable in <installation directory>\foundation Services\Build\java\javaenv.bat must be configured to point to the WebLogic JDK. The weblogic.home variable in <installation directory>\foundation Services\Common\build.properties must be uncommented (remove the # symbol) and set to the appropriate WebLogic root directory, as shown in the example configuration below. weblogic.home=/bea/weblogic81/server The weblogic.home variable in <installation directory>\foundation Services\Build\java\ant\bin\ant.bat must be set to the appropriate WebLogic root directory. Comment out the lines in the build scripts that do not refer to the target application server and database. Running the Automated WebLogic Build Process The <installation directory>\foundation Services\Build folder contains the following build files: Table 4. Build Files Build File JavaPrompt.vbs build.cmd Description A Windows script that sets the classpath and path variables for the build process and opens a command shell. This build script creates the EAR file and outputs it to <installation directory>\foundation Services\build_tmp\build_release. MCA Services Build Process Guide Version

12 WebLogic 8.1 Build Process Deploying the EAR File on WebLogic The build process creates the EAR file including the appropriate Application Server specific deployment descriptors. The pre-built MCA Services EAR file at <installation directory>\foundation Services\deploy\ is not overwritten by the provided build process. To run the automated WebLogic build process 1 Navigate to the <installation directory>\foundation Services\Build\ directory. 2 Double-click on the JavaPrompt.vbs file. This opens a command prompt. 3 Type the following commands at the command prompt: cd Build build weblogic The EAR file is output to <installation directory>\foundation Services\build_tmp\build_release\siebel.ear. Deploying the EAR File on WebLogic After the EAR file has been rebuilt it can be redeployed on the application server. Refer to the Installing MCA Services on WebLogic 8.1 guide for deployment instructions. 12 MCA Services Build Process Guide Version 2005

13 5 WebSphere Build Process This section contains information about how to build the MCA Services Enterprise Application for WebSphere using the automated mechanism provided by WebSphere in {WebSphereHome}\bin\ejbdeploy.bat. There is an installation pack provided each for WebSphere and DB2 and WebSphere and Oracle. Prerequisites for the WebSphere Build Process WebSphere must be installed on the build machine. The JAVA_HOME variable in <installation directory>\foundationservices\build\java\ant\bin\ant.bat must be configured to point to the WebSphere JDK. The JAVA_HOME variable in <installation directory>\foundationservices\build\java\ant\bin\javaenv.bat must be configured to point to the WebSphere JDK. The websphere.home variable in <installation directory>\foundation Services\Common\build.properties must be uncommented (remove the # symbol) and set to the appropriate WebSphere root directory, for example: websphere.home=c:/progra~1/websphere/appserver The websphere.home variable in <installation directory>\foundation Services\Build\java\ant\bin\ant.bat must be set to the appropriate WebSphere root directory. Comment out the lines in the build scripts that do not refer to the target application server and database. Running the Automated WebSphere Build Process The <installation directory>\foundation Services\Build folder contains the following build files: MCA Services Build Process Guide Version

14 WebSphere Build Process Deploying the EAR File on WebSphere Table 5. Build Files Build File JavaPrompt.vbs build.cmd Description A Windows script that sets the classpath and path variables for the build process and opens a command shell. This build script creates the EAR file and outputs it to <installation directory>\foundation Services\build_tmp\build_release. The build process creates the EAR file including the appropriate Application Server specific deployment descriptors. The pre-built MCA Services EAR file at <installation directory>\foundation Services\deploy\ is not overwritten by the provided build process. In the instructions below supply the correct argument for the appropriate target platform, that is, websphere-db2 or websphere-orcl. To run the automated WebSphere build process 1 Navigate to the <installation directory>\foundation Services\Build\ directory. 2 Double-click on the JavaPrompt.vbs file. This opens a command prompt. 3 Type the following commands at the command prompt: cd Build build [websphere-db2 websphere-orcl] The EAR file is output to <installation directory>\foundation Services\build_tmp\build_release\siebel.ear. Deploying the EAR File on WebSphere After the EAR file has been rebuilt it can be redeployed on the application server. Refer to the Installing MCA Services on WebSphere guide for deployment instructions. 14 MCA Services Build Process Guide Version 2005