iCP Deployment Guide - staff.ebaotech.com 5_Deployment Guide_04.pdf · Section 2 provides...

iCP Deployment GuideiCP V3.5

July, 2010

iCP Deployment Guide

Part No. G00-0-350-04 Copyright © eBaoTech 2010. All Rights Reserved. Disclaimer No part of this document may be reproduced in any form without the written permission of the copyright owner. The contents of this document are subject to revision without notice due to continued progress in methodology, design and manufacturing. eBaoTech shall have no liability for any error or damage of any kind resulting from the use of this document.


Contents

1 Introduction............................................................................................ 1 1.1 Purpose and Scope ................................................................................. 1 1.2 Intended Audiences................................................................................. 1 1.3 Document Structure................................................................................. 1 1.4 Typographical Conventions ..................................................................... 1

2 Hardware and Software Requirement.................................................. 3

3 Package Structure ................................................................................. 4

4 Deploying DB/PLSQL Scripts ............................................................... 6 4.1 Deploying DB Scripts............................................................................... 6 4.2 Deploying PLSQL Scripts ........................................................................ 6

5 Deploying iCP to WebSphere ............................................................... 7 5.1 Creating an EAR Release Package ........................................................ 7 5.2 Deploying EAR ........................................................................................ 7 5.3 Configuring External Extension Directory .............................................. 11 5.4 Creating Customized Configuration Layer............................................. 14 5.5 Configuring Database Connection......................................................... 15 5.6 Other Optional Configurations ............................................................... 15 5.6.1 Configuring Super Administrator ........................................................... 15 5.6.2 Configuring SSO.................................................................................... 16

6 Deploying iCP to Tomcat (in Windows)............................................. 18 6.1 Preparing Tomcat Environment ............................................................. 18 6.2 Deploying Application ............................................................................ 20 6.2.1 Link Deployment.................................................................................... 20 6.2.2 Direct Deployment ................................................................................. 20 6.3 Editing Startup Parameter ..................................................................... 21 6.4 Creating Customized Configuration Layer............................................. 21 6.5 Configuring Database Connection......................................................... 22 6.6 Other Optional Configurations ............................................................... 22

7 Deploying J2SE Applications............................................................. 23 7.1 Deploying Batch .................................................................................... 23 7.1.1 Installing JRE......................................................................................... 23 7.1.2 Installing Batch Resources .................................................................... 23 7.1.3 Deploying Jars....................................................................................... 23 7.1.4 Editing Startup Script ............................................................................. 23 7.1.5 Creating Customized Configuration Layer............................................. 23 7.1.6 Configuring Database Connection......................................................... 24 7.1.7 Running Batch ....................................................................................... 24 7.2 Deploying Windward.............................................................................. 25 7.2.1 Installing JRE......................................................................................... 25 7.2.2 Deploying Windward Resources............................................................ 25

7.2.3 Deploying Jars....................................................................................... 25 7.2.4 Editing Startup Scripts ........................................................................... 25 7.2.5 Creating Customized Configuration Layer............................................. 25 7.2.6 Configuring Database Connection......................................................... 26 7.2.7 Running Windward ................................................................................ 26

8 Glossary ............................................................................................... 27

Introduction

1 Introduction

1.1 Purpose and Scope

This document is intended to provide practical guidance on deploying iCP to Websphere, and Tomcat.

iCP is served as a fundamental role in the whole system. It provides a uniform enterprise-level application development framework, a uniform flexible business process engine and a uniform business logic management system. Due to the high level of unification, iCP enables integration with legacy system and batch execution.

1.2 Intended Audiences

The intended audiences are of this documents include iCP developers, testers, baseline developers who are involved in deploying iCP.

1.3 Document Structure

The organization of this document is as follows:

Section 2 provides information about requirement for iCP deployment, including hardware and software requirement.

Section 3 illustrates the package structure of iCP, presenting the content each directory contains.

Section 4 tells the procedure of deploying DB/PLSQL scripts.

Section 5 offers detailed procedures about the deployment process of iCP to Web Sphere and Tomcat.

Section 6 gives detailed procedures about the deployment process of J2SE applications.

The document also contains a glossary that explains the important terms in this document.

1.4 Typographical Conventions

This section describes the typographical conventions used in this document.

1


Table 1 Typographical Conventions

Convention Description Example

GUI Objects Menus, fields, buttons, and so on.

Choose Exit in the File menu.

System Elements Command and parameter names, program names, path names, Uniform Resource Locators (URLs), and directory names.

The files are located in c:/HOME/bin.

Code Examples Code examples. grep ’:title. ’ $i | \awk -f.’

2

Hardware and Software Requirement

2 Hardware and Software Requirement In order to deploy iCP components on the server successfully, it is recommended to follow the hardware and software specifications as stated below:

Table 2 Hardware and Software Requirement for ICP Deployment

Component Hardware Operating System

Application Software

Web & J2EE Application Server

HP DL360G5

1 way Intel Xeon 2.8Ghz Quad-core CPU

8GB RAM

4 x 146GB Disk

Redhat Linux AS 5.0

IBM WebSpere Application Server 6.1 (280 PVU)

Database Server HP DL360G5

1 way Intel Xeon 2.8Ghz Quad-core CPU

8GB RAM

4 x 146GB Disk

Redhat Linux AS 5.0

Oracle Database 10g Standard Edition (2 CPU license)

Print Server

HP DL360G5

1 way Intel Xeon 2.5Ghz Quad-Core CPU

4GB RAM

2 x 146GB SCSI DISK

Windows 2003

Windows 2003 Server

Windward Report Standard Engine with Auto Tag (4 core license)

Client RAM: 256MB

CPU: 1GHz

Hard Disk: 20GB

Network Interface Card: 100BaseT

Window 2000 English Professional (SP4) or Window XP

Internet Explorer 6.0 (SP1) and above

Other 3rd Party Software e.g. Acrobat Reader etc

Bandwidth(Client to App Server)

100Mbps(Intranet)

Bandwidth(App Server to DB)

100Mbps(Intranet)

3


3 Package Structure This chapter describes the structure of the release package. In iCP 3.5, the package structure is uniform to both GeneralSystem and LifeSystem, shown as follows:

4

Package Structure

Figure 1 Release Package Structure of iCP 3.5

Table 3 Directory Description of Release Package

Directory Content

Customization_data

It contains some default customization implementations, which are put in a dependent jar of a specific project. For example, field_ip.tld, developed independently for Japan project, its subdirectory name is the full name of the jar, e.g., iCP_iFoundation.jar.

Db

Db contains all database scripts of each bundle.

Db_script contains standard database scripts.

Plsql contains Oracle-used database scripts.

Doc All relevant documents to iCP3.5

EAR_FILE eBaoTech software, containing relevant programs for enterprise application

EBAO_HOME -

App_config Extension and configuration directory for enterprise application

applications Local where batch and windward files will be put

data Locale for some specific data

The release package structure of the third party jars is as follows:

Figure 2 Release Package Structure of Third Party Jars

Table 4 Directory Description of Third Party Release Package

Directory Content

batch Third party jars used by batch only

windward Third party jars used by windward only

lib Public jars

5


4 Deploying DB/PLSQL Scripts To deploy DB/PLSQL scripts, you must have installed Oracle on your machine.

4.1 Deploying DB Scripts

To deploy the DB scripts, do as follows:

1. Unpack the release package.

2. Enter the db/db_script directory.

[1] Click Start and then select Run.

[2] Input cmd and click OK.

[3] In the command window, input cd xxx\db_script and press Enter, where xxx is the absolute path of the db_script directory.

3. Connect to sqlplus.

Input sqlplus and press Enter and then input the user name and password.

4. Input @@upgrade_script.sql and then press Enter.

4.2 Deploying PLSQL Scripts

The procedure of deploying PLSQL script is the same with that of deploying DB script.

To deploy the PLSQL scripts, do as follows:

1. Unpack the release package.

2. Enter the db/plsql directory.

[1] Click Start and then select Run.

[2] Input cmd and click OK.

[3] In the command window, input cd xxx\plsql and press Enter, where xxx is the absolute path of the plsql directory.

3. Connect to sqlplus.

Input sqlplus and press Enter and then input the user name and password.

4. Input @@upgrade_script.sql and then press Enter.

Now the full db and plsql scripts are deployed successfully.

6

Deploying iCP to WebSphere

5 Deploying iCP to WebSphere

5.1 Creating an EAR Release Package

On how to create an EAR release package, you can refer to relevant j2EE documents. Please note that in the web.war/WEB-INF directory, a template file web.template.xml is provided. If no special requirement is needed, clone a web.template.xml file and rename it as web.xml.

For advanced users, skip this step and deploy the relevant files directly to WebSphere.

5.2 Deploying EAR

Several approaches are available to deploy the created EAR to WebSphere. This document presents the way to deploy EAR to WebSphere through WebSphere administration console. Note that the WebSphere presented below is version 6.1.

Steps to deploy EAR to WebSphere are as follows:

1. Log in to the WebSphere administration console. Click the icon beside Applications and click Enterprise Applications from the displayed pane. Then click Install on the right page.

Figure 3 WebSphere Administration Console Page

2. Click Browse to select the EAR file or input the path of the EAR file directly in the Full path field. Then click Next.

7

https://172.16.29.197:9043/ibm/console/navigatorCmd.do?forwardName=ApplicationDeployment.content.main


Figure 4 Install EAR File Page

3. The following page is displayed. Click Next.

Note: The installation options are selected by default. You can change the installation options if necessary.

8


Figure 5 Select Installation Options Page


9


Figure 6 Map modules to servers Page


Figure 7 Map virtual hosts for Web modules Page

6. The Summary page is displayed. View the deployment settings and click Finish if no error exists.

Note: If you want to change the deployment settings, click Previous to return to previous steps to redo the settings.

Figure 8 Summary Page

7. The end.

10


5.3 Configuring External Extension Directory

Create parameters for java virtual machine in WebSphere administration console.

To configure external extension directory, do as follows:

1. Log in to WebSphere administration console.

Figure 9 Login Page

2. In the WebSphere administration console, click the icon beside Servers to display the hidden items and then click Application servers.

11


Figure 10 WebSphere Administration Console Page

3. Click the server that installs the EAR, for example, server1, to enter the server1 parameter configuration page.

4. On the Configuration tab page, click the icon beside Java and Process Management and then click Process Definition.

Figure 11 Configuration Tab Page (1)

5. Under Additional Properties, click Java Virtual Machine.

12



6. Under Additional Properties, click Custom Properties to enter the page for specifying startup parameter.


Note: Before click Custom Properties, you should set Initial Heap Size to 512 M and Max Heap Size to 1024 M.

7. As shown in the following picture, create the parameter config.file.path.xxx=… for the current application instance. xxx refers to the context name of the web application after the instance is deployed. The parameter value is the user-specified external extension directory path. Usually, it is the absolute path of EBAO_HOME/app_config.

13


Figure 14 Configuring Parameter Page

8. The end.

5.4 Creating Customized Configuration Layer

iCP 3.5 supports hierarchical customization of multiple configurations. This section focuses on how to create customized configuration layer.

Enter the specified extension directory and create directory structure as follows:

1. Create a directory named META-INF and enter this directory.

2. Create a directory by any name as the configuration layer name, e.g., configuration and then enter this directory.

Note: This layer name cannot be identical to the existed layer name. For example, iCP has set a layer named icp, so this created directory name cannot be icp.

3. Create a xml file with extension name .mcf.xml which has a root element <module>, and set parent=”icp”, shown as follows: <?xml version="1.0" encoding="UTF-8"?> <module parent="icp"> </module>

Note: Now, the configuration of this customized new layer overrides the default configuration of the iCP layer. The directory structure is as follows:

14


4. Copy the following files in sample/quickstart of the release package to the External Extension Directory:

- eBao-plugins-state.properties

- ebaoesb-properties.xml

- juddi.properties

- log4j.properties

You can edit the log4j.properties when necessary. For more information, please refer to log4j documentation.

5.5 Configuring Database Connection

iCP 3.5 supports database connection through JNDI and JDBC. For connection through JNDI, create a JNDI data source on WebSphere, named jndiForDB.

1. Open the customized .mcf.xml file and create a child element <datasource> under root element, shown as follows: <module parent="icp"> <datasource> <include relative-path="/database.properties" /> </datasource> </module>

2. Create a database.properties file in the directory where this customized .mcf.xml file is put.

If to use JNDI, configure the database.properties file as follows: DATASOURCE_TYPE=jndi JDBC_DATA_SOURCE=jndiForDB

If to use JDBC, configure the database.properties as follows; NON_POOL_DB_URL=XXX NON_POOL_DB_USERNAME=XXX NON_POOL_DB_PASSWORD=XXX

5.6 Other Optional Configurations

5.6.1 Configuring Super Administrator

In web application, a super administrator is essentially an administrator with additional permissions. For example only a super administrator can manage other administrators.

To configure super administrator, do as follows:

15


1. Open the customized .mcf.xml file and add a namespace in it, as shown below: <sysadmin> <include relative-path="/sysadmin/admin.properties" /> </sysadmin>

2. Create a relevant admin.propeties file, add the following statement: SUPER_ADMIN=LIFE,ADMIN

Note:

The value of SUPER_ADMIN must all be uppercases.

If to configure multiple super administrators, separate them by “,”.

On iCP layer, the default value is LIFE and ADMIN. Therefore, configure the super administrator when necessary.

5.6.2 Configuring SSO

If to integrate SSO to application, do as follows:

1. In the configuration file web.xml, delete filter-mapping by name PermissionFilter. <filter-mapping> <filter-name>PermissionFilter</filter-name> <url-pattern>*.do</url-pattern> </filter-mapping>

2. Add the following code segment to the web.xml file. <filter> <filter-name>AcegiFilterChainProxy</filter-name> <filterclass> com.ebao.foundation.module.security.acegi.EBaoFilterToBeanProxy </filter-class> <init-param> <param-name>targetClass</param-name> <param-value>org.acegisecurity.util.FilterChainProxy</param-value> </init-param> </filter> <filter-mapping> <filter-name>AcegiFilterChainProxy</filter-name> <url-pattern>*.do</url-pattern> </filter-mapping>

3. In the customized mcf.xml file, add an env namespace by adding the following configuration: <env> <include relative-path="/cas.properties" /> </env>

4. Create the corresponding cas.propertoes file with configuration parameters shown as below: CAS_SERVER_LOGIN_URL=http://172.16.7.163:8123/cas/login LOGIN_PAGE=http://172.16.7.163:8123/cas/logout

16


CAS_VALIDATE_URL=http://172.16.7.163:8123/cas/proxyValidate SSO_WINAD=true

- CAS_SERVER_LOGIN_URL defines the login URL of the central authentication server.

- LOGIN_PAGE defines the logout URL of the central authentication server.

- CAS_VALIDATE_URL defines the URL for authentication ticket validation.

17


6 Deploying iCP to Tomcat (in Windows)

6.1 Preparing Tomcat Environment

1. Download Tomcat V5.5 or later version from the official website http://tomcat.apache.org/. For installing Tomcat, please read the relevant documentation through http://tomcat.apache.org/tomcat-5.5-doc/index.html.

2. Add TOMCAT_HOME parameter to the system environment variable. To add parameter to the system environment variables in Windows, do as follows:

[1] Right-click the My Computer icon, and then click Properties.

[2] On the System Properties dialog box, click the Advanced tag, and then click Environment Variables.

18

http://tomcat.apache.org/download-55.cgi

http://tomcat.apache.org/tomcat-5.5-doc/index.html

Deploying iCP to Tomcat (in Windows)

Figure 15 System Properties Dialog Box

[3] The System Properties dialog box is displayed. Click New in the System variables area to open the New System Variable dialog box. Input TOMCAT_HOME in the Variable name field and path of tomcat in the Variable value field, e.g., C:\Tomcat 5.5. Then click OK to exit.

Figure 16 System Properties Dialog Box

3. Set the enablePooling parameter to false in the %TOMCAT_HOME%conf/web.xml file. The enablePooling parameter is located in servlet configuration by name JSP, shown as follows:

<servlet> <servlet-name>jsp</servlet-name> <servlet-class>org.apache.jasper.servlet.JspServlet</servlet-class> <init-param> <param-name>fork</param-name> <param-value>false</param-value> </init-param> <init-param> <param-name>xpoweredBy</param-name> <param-value>false</param-value> </init-param> <init-param>

19


<param-name>enablePooling</param-name> <param-value>false</param-value> </init-param> <load-on-startup>3</load-on-startup> </servlet>

6.2 Deploying Application

Two approaches are available to deploy application: link deployment and direct deployment.

6.2.1 Link Deployment

Link deployment means to describe the application deployment information through context segment. To perform link deployment, do as follows:

1. Copy the files in web.war directory of the iCP 3.5 release package to a directory, e.g., D:\icp35\web

2. Create a xml file with any name in the directory %TOMCAT_HOME%/conf/ Catalina/localhost. The content of this file should be as follows:

<Context path="found35" reloadable="true" docBase="D:\icp35\web workDir="D:\icp35\work" />

Table 5 Descriptions of Parameters in XML File

Parameter Name Descriptions

path path attribute indicates the application context name.

reloadable reloadable parameter indicates whether to start up the application automatically. Generally, set it to true

docBase docBase attribute indicates the location information of the application, e.g., D:\icp35

workDir workDir attribute indicates the location of the directory where JSP does temporary compilation. The location, or the workDir attribute can be any directory or left unspecified.

6.2.2 Direct Deployment

Direct deployment means to deploy application to %TOMCAT%/webapps. To perform direct deployment, do as follows:

20

Deploying iCP to Tomcat (in Windows)

1. Create a directory name in the %TOMCAT%/webapps directory, e.g., icp35, and the directory name is the application context name.

2. Copy the files in the web.war directory of iCP3.5 release package to the directory created in step 1.

6.3 Editing Startup Parameter

Enter the %TOMCAT_HOME%/bin directory to edit the startup parameter. (catalina.bat in Windows and catalina.sh in Linux). Search out variable JAVA_OPTS, and append the following parameter to the statement where the variable is set.

-Dconfig.file.path.xxx=…

xxx is the application context name, and the parameter value is the absolute path of the External Extension Directory name.

6.4 Creating Customized Configuration Layer

Enter the specified extension directory and create the directory structure as follows:

1. Create a directory named META-INF and enter this directory.

2. Create a directory by any name as the configuration layer name, e.g., configuration, and then enter this directory.



Note: Now, the configuration of this customized new layer overrides the default configuration of the iCP layer. The directory structure is as follows:

4. Copy the following files in sample/quickstart of the release package to the External Extension Directory:

- eBao-plugins-state.properties

- ebaoesb-properties.xml

- juddi.properties

21


- log4j.properties

You can edit the log4j.properties when necessary. For more information, please refer to log4j documentation.

6.5 Configuring Database Connection

On Tomcat server, iCP3.5 only supports database connection through JDBC. To configure the database connection, do as follows:

1. Open the customized .mcf.xml file and create a child element <datasource> under the root element, shown as follows: <module parent="icp"> <datasource> <include relative-path="/database.properties" /> </datasource> </module>

2. Create a database.properties file in the directory where the .mcf.xml file is put, and configure the database.properties file as follows: NON_POOL_DB_URL=XXX NON_POOL_DB_USERNAME=XXX NON_POOL_DB_PASSWORD=XXX

3. After the proper database connection information is configured, save it. Then you can start up the application.

6.6 Other Optional Configurations

For other optional configurations, please refer to section 5.6 Other Optional Configurations on page 15.

22

Deploying J2SE Applications

7 Deploying J2SE Applications The J2SE applications include batch and windward. This chapter illustrates steps of deploy these J2SE applications to the server.

7.1 Deploying Batch

Batch application is a self-governed J2SE application.

7.1.1 Installing JRE

Please make sure that you have installed JRE in the current machine.

7.1.2 Installing Batch Resources

Copy the bin directory located in EBAO_HOME directory from the iCP3.5 release package to the target directory BATCH_HOME. Generally, if the EBAO_HOME directory in iCP3.5 release package is already copied to the server, skip this step.

7.1.3 Deploying Jars

Deploy all the following jars to the %EBAO_HOME%\application\batch\lib directory:

eBaoTech jars iCP_iFoundation.jar and iCP_iService_Batch.jar in the directory \EAR_FILE\insurance.ear\web.war\WEB-INF\lib.

Third party jars which are in the \lib directory of the third party release package;

Special jars which are from the third party release package in the \batch directory.

Job implementation jars which are from the baseline or project.

7.1.4 Editing Startup Script

Modify the node.bat (in Windows) or node.sh (in Linux) in the %EBAO_HOME%\applications\batch\bin directory. You must assign the java_home parameter.

7.1.5 Creating Customized Configuration Layer


23


1. Create a directory named META-INF in BACTH_HOME and enter this directory.




Now, the configuration of this customized new layer overrides the default configuration of the iCP layer. The directory structure is as follows:

7.1.6 Configuring Database Connection

To configure the database connection through JDBC for batch, do as follows:



7.1.7 Running Batch

Enter the BATCH_HOME/bin directory to start Batch:

start.bat in Windows

start.sh for Linux

24

Deploying J2SE Applications

7.2 Deploying Windward

7.2.1 Installing JRE

Please make sure that you have installed JRE in the current machine.

7.2.2 Deploying Windward Resources

Copy the bin directory located in EBAO_HOME directory from the iCP3.5 release package to the target directory BATCH_HOME. Generally, if the EBAO_HOME directory in iCP3.5 release package is already copied to the server, skip this step.

7.2.3 Deploying Jars

Deploy all the following jars to the %EBAO_HOME%\windward\lib directory:

eBaoTech jars iCP_iFoundation.jar and iCP_iService _WindwardReportPrinting.jar in the \EAR_FILE\insurance.ear\ web.war\WEB-INF\lib directory;

Third party jars which are in the \lib directory of the third party release package;

Windward special jars which are in the \windward directory of the third party release package;

Windward jars which are from the Windward product。

7.2.4 Editing Startup Scripts

Modify node.bat (in Windows) or node.sh (in Linux) in the %EBAO_HOME%\applications\windward\bin directory. You must assign java_home parameter.

7.2.5 Creating Customized Configuration Layer


1. Create a directory named META-INF in BACTH_HOME and enter this directory.



25



Now, the configuration of this customized new layer overrides the default configuration of the iCP layer. The directory structure is as follows:

7.2.6 Configuring Database Connection

To configure the database connection through JDBC for Windward, do as follows:



7.2.7 Running Windward

Enter the WINDWARD_HOME\bin directory to start Windward:

start.bat in Windows

start.sh in Linux

26

Glossary

27

8 Glossary EAR

Enterprise Archive file; A JAR archive that contains a J2EE application

J2EE

The Java 2 Platform Enterprise Edition (J2EE) is a platform-independent, Java-centric environment for developing, building and deploying Web-based enterprise applications online.

J2SE

Java 2 Platform, Standard Edition (Java SE) is for developing and deploying Java applications on desktops and servers, as well as embedded and real-time environments.

JDBC

The Java Database Connectivity (JDBC) API is the industry standard for database-independent connectivity between the Java programming language and a wide range of databases – SQL databases and other tabular data sources, such as spreadsheets or flat files. The JDBC API provides a call-level API for SQL-based database access.

JNDI

The Java Naming and Directory Interface (JNDI) is part of the Java platform, providing applications based on Java technology with a unified interface to multiple naming and directory services.

JSP

Java Server Page (JSP) is a technology for controlling the content or appearance of Web pages through the use of servlets, small programs that are specified in the Web page and run on the Web server to modify the Web page before it is sent to the user who requested it.

JRE

The Java Runtime Environment (JRE) provides the libraries, the Java Virtual Machine, and other components to run applets and applications written in the Java programming language.

SSO

Single Sign-on (SSO) is mechanism whereby a single action of user authentication and authorization can permit a user to access all computers and systems where he has access permission, without the need to enter multiple passwords.

Date post:	16-Mar-2020
Category:	Documents
Upload:	others
View:	2 times
Download:	0 times

iCP Deployment Guide - staff.ebaotech.com 5_Deployment Guide_04.pdf · Section 2 provides...

Documents