Kewill Customs Installations Guide

coldwaterphewServers

Nov 17, 2013 (3 years and 8 months ago)

144 views

Kewill Customs Installation Guide

KC Install
-

1

C
opyright © 2011 by Kewill Inc.




Kewill Customs
Installations
Guide



For

Release
2
.
1



Alliance R07
Patch
3

Compatible


Original
Publication:
March
, 20
1
1





Kewill Customs Installation Guide

KC Install
-

2

Copyright © 2011 by Kewill Inc.

Table of Contents

Table of Contents

................................
................................
................................
................................
.....

2

Kewill Customs Installation Guide

................................
................................
................................
.........

4

1.

Introduction

................................
................................
................................
................................
....

4

1.1.

Overview of Kewill Customs Installation

................................
................................
..............

4

1.2.

Kewill Customs Components

................................
................................
................................
.

4

1.3.

Third Party Com
ponents

................................
................................
................................
.........

5

1.4.

Kewill Customs Release Number Nomenclature

................................
................................
.

6

2.

Implementation of Kewill Customs

................................
................................
..............................

7

2.1.

Implementation Requirements

................................
................................
...............................

7

2.1.1.

Small to Medium Kewill Customs implementation

................................
..............................

7

2.1.
2.

Medium to Large Kewill Customs implementation

................................
..............................

8

2.1.3.

High Availability Kewill Customs Implementation

................................
...............................

8

2.2.

Hardware and So
ftware Requirements

................................
................................
.................

9

2.2.1.

Hardware Configuration

................................
................................
................................
......

9

2.2.2.

Terminal Server or Citrix Requirements (optional)

................................
...........................

10

Please Note: For Remote Customer Site Implementation

................................
................................

11

3.

Installing Kewill Customs Server

................................
................................
................................
..

11

3.1.

Installing Apache Tomcat on AIX or Linux

................................
................................
.........

11

3.1.1.

Starting Tomcat on AIX or Linux

................................
................................
.......................

12

3.1.2.

Stopping Tomc
at on AIX or Linux

................................
................................
.....................

13

3.2.

Installing Kewill Customs Server on AIX or Linux

................................
.............................

13

3.2.1.

Installing Kewill Customs Server using the

installer on AIX or Linux

................................

13

3.2.2.

Installing Kewill Customs Server manually on AIX or Linux

................................
.............

18

3.2.3.

Installing Database scr
ipt manually

................................
................................
..................

21

3.2.4.

Upgrading the Database manually

................................
................................
....................

24

4.

Installing Kewill Customs Services

................................
................................
............................

26

Kewill Customs Installation Guide

KC Install
-

3

Copyright © 2011 by Kewill Inc.

4.1

Installing Kewill Customs Services on AIX or Linux

................................
.............................

26

5. Troubleshooting of Kewill Customs Installation

................................
................................
............

28

6.

Installation of Kewill Customs Adapter

................................
................................
........................

29

6.1.

Kewill Customs Adapter Prerequisites

................................
................................
...............

29

6.2.

Apache Tomcat C
onfiguration for RMS

................................
................................
..............

29

6.3.

Apache Tomcat Configuration for Oracle

................................
................................
...........

31

6.4.

Installation of Apache Tomcat on Windows

................................
................................
.......

31

6.4.1.

Configuring the Database Connection
-

Oracle:

................................
...............................

31

6.4.2.

Configuring the Database Connection
-

Connx:

................................
...............................

32

Appendix 1
--

Installing Java Notes

................................
................................
................................
.....

34

Appendix 2
--

Installing Tomcat Notes

................................
................................
................................

36


Kewill Customs Installation Guide

KC Install
-

4

Copyright © 2011 by Kewill Inc.

Kewill Customs Installation Guide


1.

Intr
oduction

1.1.

Overview of Kewill Customs Installation

Before installing
Kewill Customs

or upgrading to a later version, Kewill strongly recommends that you

familiarize yourself with the requirements and steps described in this
Installation G
uide. These

r
equirem
ents and steps are covered in the following sections:



Implementation of Kewill Customs



I
nstalling
Kewill Customs
Server



Installing Kewill

Customs Services



Troubles
hooting Kewill Customs Installation



Installing Kewill Customs Adapter


1.2.

Kewill Customs Components


The following sections describe the
Kewi
ll
Customs’

components and third
-
party applications and
programs

that are installed and configured during the installation process.


KC Component

Version

Description

Kewill Customs U
ser
I
nterface

Matches the version on this
document

User interface for Shi
pment
Processing,
maintenance

and
administration of Kewill Customs.
This is the application that will be
downloaded to the client via Java
Webstart.


Kewill Customs Server

Matches the version on this
document

The backend for Shipment
Processing, maintenan
ce and
administration of Kewill Customs.

Connects and maintains Kewill
Customs’

摡瑡t慳eK


Kewill Customs Installation Guide

KC Install
-

5

Copyright © 2011 by Kewill Inc.

KC Component

Version

Description

Kewill Customs Services

Matches the version on this
document

Scheduling of jobs for Forms and
Reports printing, formatting,
sending receiving of ABI
messages from U
S Customs.
And also, for processing of
interfaces to
other systems
, e.g.,

Accounting S
ystems.

Kewill Customs Adapter

Matches the version on this
document

Optional component which
f
acilitates integration
from

other
system

to Kewill Customs via
EDI or XML
.

Kewill Ebiz

9.01 or later

Optional component which
facilitates integration from other
system to Kewill Customs via
EDI or XML. Works with Kewill
Customs Adapter.

Note
:
Installati
on of Ebiz will not
be covered i
n this document.


1.3.

Third Party Components


3
r
d

Party Component

Version

Description

Apache Tomcat

6.0.30 or later version of 6.0 for
AIX, Linux and Windows

5.5.26 or later version of 5.5

for
Open VMS

Required to run Kewill Customs.

The application server where
Kewill Customs components will
be instal
led.

Note
:
Installation of Apache
Tomcat on VMS will not be

covered i
n this document.

Java SDK

1.6_10 or later version of 1.6

Required to run Kewill Customs.

Note
:
Installation o
f Java SDK
will not be covered i
n this
document

for VMS, AIX and
Linux
.

Kewill Customs Installation Guide

KC Install
-

6

Copyright © 2011 by Kewill Inc.

3
r
d

Party Component

Version

Description

Orac
le Database

10g release 2

Required to run Kewill Customs

Note
:
Installation of Oracle
Database will not be
covered

i
n
this document.

MQ Server

7.0 or later

Optional component if immediate
response from US Customs is
not required.

Kewill Customs supports
MQ
Server and Client mode
connection to US Customs.


1.4.


Kewill Customs Release Number Nomenclature


Overview

Kewill Customs releases are named with the following nomenclature:

Example
:
Release 1
.
2
.
3
.
4

where

1

= Major Release version #1

2

= Minor Release ver
sion #2

3

= Patch version #3

4

= Minor Patch version #4


Kewill Customs Installation Guide

KC Install
-

7

C
opyright © 2011 by Kewill Inc.

2.

Implementation of Kewill Customs

2.1.

Implementation Requirements

Kewill Customs is highly scalable system, d
epending on business requirements
Kewill Customs can
be implemented in the following setup
de
scribed in the diagram below:

2.1.1.

Small to Mediu
m Kewill Customs implementation

Internet
Citrix
/
Terminal
Server
Application Server
MQ Client
Database
Server
LAN Users
Network Printer
WAN Users
Router
/
Firewall
US Customs
VPN Tunnel


Kewill Customs Installation Guide

KC Install
-

8

C
opyright © 2011 by Kewill Inc.

2.1.2.

Medium to Large Kewill Customs implementation

Internet
Citrix
/
Terminal
Server
Application Servers
Database
Server
LAN Users
Network Printer
WAN Users
Router
/
Firewall
US Customs
MQ Server
VPN Tunnel


2.1.3.

High Availability Kewill Customs Implementation

Internet
Citrix
/
Terminal
Server
Application Servers
Database
Servers
LAN Users
Network Printer
WAN Users
Router
/
Firewall
US Customs
MQ Server
VPN Tunnel
Load Balancer


Kewill Customs Installation Guide

KC Install
-

9

Copyright © 2011 by Kewill Inc.


2.2.

Hardware and Software
Requirements


2.2.1.

Hardware Configuration

The following table shows the minimum hardware and software requirements that must be in
place

before installing the
Kewill Customs Server and Kewill Customs Services
.

No. of Users

Appli
cation
/Database
Server

CPU

(64 bit)

Application
Server Memory

Database Server
Memory

Application
Server
Disk

S
pace

Up to 25

1 server x
1
Quad
Core

or equivalent

8GB

2GB

50GB

Up to 50

1 server x
1
Quad

Core or equivalent

16GB

2GB

50GB

Up to 100

2
server

x 1
Quad

Core or equivalent

2 server x 16GB

4GB

2 server x 50GB

Up to 100

1 server x
2 Quad

Core or equivalent

32GB

4GB

100GB

Over 100

Custom Configuration

Note
: The
disk space

for the database server is dependent on the number of transactions per year
.


Component

Server

Workstation

Operating System

Ubuntu Linux Server 9 or later
with 2.6 Kernel or equivalent.

or

AIX 5.3 or later

or

Open VMS 8.3 or later

or

Windows 2003 with SP2 or later,
Windows 2008 with SP1 or later

Windows XP Professional with
SP2
or later

or

Windows 7 with SP1 or later

CPU

Intel Xeon Quad Core with 2Ghz
or higher

Intel Dual Core with 1Ghz or
higher

Memory

See Hardware Configuration
chart

1GB minimum, 2G is optimal

Kewill Customs Installation Guide

KC Install
-

10

Copyright © 2011 by Kewill Inc.

Component

Server

Workstation

Ethernet Card

100Mb or better

100Mb or better

Printer

HP Laser J
et or equivalent
connected to server or network

HP Laser Jet or equivalent
connected to workstation or
network

Report Viewer

Not Applicable

Adobe Reader 8 or later

Internet Browser

Not Applicable

Internet Explorer 6 or later

or

Mozilla Firefox 3 or later

Remote Access


This is needed
when installing
remotely
, or
if you
don’t have
access to the server console.

Remote Desktop
Server
or VNC
Server
for Windows
Server
platform

XWindows
Server
or VNC
Server
for AIX and Linux

platform

SSH server or Telnet serv
er for
AIX and Linux platform on
manual installation of Kewill
Customs

Remote Desktop Client or VNC
Client for Windows
XP or 7

XWindows Client or VNC Client
for Windows
XP or 7

Putty (SSH Client) or Telnet
Client for Windows XP or 7


2.2.2.

Terminal Server or Ci
trix Requirements (optional)


Minimum
Requirements



㈠䝈z 灲潣敳s潲o⁢ 瑴tr



㈰〠䵂敭潲o/畳敲⸠⁔桩s⁩s⁩n

慤di瑩潮⁴漠体⁲敱uir敭敮瑳⸠
††††††
Note
: 64 bit server
is required

to accommodate more users/server. 32 bit
servers have a memory limitatio
n.



5
-
㄰⁇B ⁦r敥⁤ sk⁳灡c攠e敲⁵e敲




䍵Cr敮琠tSS 潲⁃楴ri⁏S
.



䑩r散琠tetw潲o⁡ c敳s⁴ ⁴ 攠ep灬ic慴i潮⁳敲v敲e
-

灲敦er慢ly⁨i杨⁳灥ed

S畮⁊ava⁒ 湴nm攠e⸵.潲o杲敡瑥r
Avail慢l攠慴aJav愮aom




A摯扥⁒敡d敲‸爠杲敡g敲e



䑩r散琠tr整w潲o⁡ c敳s⁴ ⁰物湴
敲⁦潲潣慬 灲楮瑩n朠gf P䑆.


Kewill Customs Installation Guide

KC Install
-

11

Copyright © 2011 by Kewill Inc.

Please Note: For Remote Customer Site Implementation


Implementation Notes
for Remote Customers



T桥⁩m灬em敮瑡ti潮 ⁋e睩ll⁃畳瑯ts⁡ ⁲敭潴o⁣畳瑯t敲esi瑥t 敲⁡e
WA丠N敱畩r敳
Citrix

or
TSS

to provide the required performa
nce for
remote sites.



T桥⁲em潴o⁣lie湴nsit敳 w潵l搠dcc敳s⁴ e⁡ 灬ic慴a潮⁳erv敲⁴桲o畧栠瑨t
Citrix

or
TSS server
. The
Citrix

or
TSS server

must be local to the
application server as well. If it cannot be local, a high speed connection
between the two i
s required.


3.

Installing Kewill Customs

Server


3.1.

Installing Apache Tomcat on AIX

or Linux


Step

Action


Comment

1


Verify that the following ulimits are set
correctly for Alliance

login OS username:

Command to use
:

ulimits
-
a

time(seconds)


unlimited

data(
kbytes)

unlimited

stack(kbytes)

65526

memory(kbytes)

unlimited

Note
: If not set correctly, root username is
required to edit /etc/security/limits.

2


Get
apache
-
tomcat
-
5.5.26.tar.gz
from
the installation media.


3


FTP

apache
-
tomcat
-
5.5.26.tar.
gz to
home
directory of alliance
,

e.g.
,

/home/alliance
.


4


Copy
apache
-
tomcat
-
5.5.26.tar.gz

to
/kcustoms
.


5


Unzip
apache
-
tomcat
-
5.5.26.tar.gz
,
using unzip or gunzip, e.g.
,

gunzip
apache
-
tomcat
-
5.5.26.tar.gz


6


Extract or untar
apache
-
tomcat
-
5.5.26.tar
, e.g.
,

tar

xv
f apache
-
tomcat
-

Kewill Customs Installation Guide

KC Install
-

12

Copyright © 2011 by Kewill Inc.

Step

Action


Comment

5.5.26.tar

7


Navigate to
/kcustoms/apache
-
tomcat
-
5.5.26/bin
, and edit
catalina.sh
. R
ight
after the commented lines, add the
following 2 lines
:

(
See below for the two lines to be added
.)


Add these 2 lines:

JA
VA_HOME=/usr/java5
_64
; export JAVA_HOME

JAVA_OPTS='
-
Xms1536m
-
Xmx1536m
-
Xmaxe256m
-
Djava.awt.headless=true
-
Dicustoms.abi.root.dir=/alliance/RUNTIME/
;
export JAVA_OPTS


3.1.1.

Starting Tomcat on AIX or Linux


Step

Action


Comment

1


Login as alliance username usi
ng telnet.


2


In
$
or shell prompt, type in “
ps

eaf |
grep java
”.

䥦⁋ewill⁃畳瑯ts⁩s⁲畮湩n本gt
h攠牥e畬t ⁴ 攠
comm慮搠睩ll潯kik攠
below
. If so,
proceed
to
Stopping Tomcat
.

If not,
proceed to step 3.

3


N
avigate to
“/kcustoms/apache
-
tomcat
-
5.5.26/bin



4


Then type in
“./catalina.sh start



5


To verify that the application is up and
running, use the
command in step 2
.



Expected Command
Results

alliance 82758
8 1 124 11:13:46 pts/7 69:24
/usr/java
6_64
/bin/java

Xms1536m
-
Xmx1536m
-
Xmax
e256m
-
Djava.awt.headless=true

Djava.util.logging.manager=org.apache.juli.ClassLoaderLogM
anager
-
Djava.util.logging.config.file=/kcustoms/apache
-
tomcat
-
5.5.26/conf/logging.p
roperties
-
Djava.endorsed.dirs=/kcustoms/apache
-
tomcat
-
5.5.26/common/endorsed
-
classpath :/kcustoms/apache
-
tomcat
-
5.5.26/bin/bootstrap.jar:/kcustoms/apache
-
tomcat
-
5.5.26/bin/commons
-
logging
-
api.jar
-
Dcatalina.base=/kcustoms/apache
-
tomcat
-
5.5.26
-
Kewill Customs Installation Guide

KC Install
-

13

Copyright © 2011 by Kewill Inc.

Dcatalina.
home=/kcustoms/apache
-
tomcat
-
5.5.26
-
Djava.io.tmpdir=/kcustoms/apache
-
tomcat
-
5.5.26/temp
org.apache.catalina.startup.Bootstrap start


3.1.2.

Stopping Tomcat

on AIX or Linux


Step

Action


Comment

1


Log

in as A
lliance username using telnet.


2


N
avigate to
“/kcusto
ms/apache
-
tomcat
-
5.5.26/bin



3


T
ype in
“./catalina.sh stop



4


U
se the command in
step 2 of
Starting
Tomcat

to verify that application is really
stopped. If
it is
not
,

proceed to step 5.


5


For some reason
if the process of java is
still hanging around after stopping it. Use

kill
-
9
” to hard stop the process.

q桩s⁣omm慮搠dill⁡ ru灴pyill⁴ e⁰牯 敳s
慮搠d桲hw⁡睡y⁡ny 灥n摩n朠gr慮s慣瑩潮ⰠIo
畳攠ehis⁣潭m慮搠d慲敦畬lyK


Note



A
llia湣攠es敲e慭攠m畳琠t攠e
s敤 i渠牥n瑡牴i湧⁡ 搠d瑯t灩n朠
Kewill
䍵C瑯ts⁢ c慵s攠et
s⁥ vir潮m敮琠ts⁳整e慣c潲摩湧ly.



Ke睩ll⁃畳t潭s⁩s⁡ s瑡t敬ess⁡ 灬ic慴a潮⁳漠o桥
畳敲e⁤
n’t have
瑯t
log

潵琠
潦⁴ 敩r⁳cr敥湳⸠K桥⁡灰lic慴ao渠n桯畬d⁢ 慢l攠e漠牥o潶敲e潮c攠e桥⁳敲v敲e
is⁵ 慮搠牵n
ni湧K


3.2.

Installing Kewill Customs Server on AIX or Linux

Kewill C
ustoms can be installed using its

installer on server console. If for som
e reason the installation
needs

to be perform remotely or the server console can’t be access
ed
, proceed to
section 3.2
.2 for
manual installation
.

3.2.1.

Installing Kewill Customs Server using the installer on AIX or Linux

If Java 1.6 is installed on AIX or Lin
ux Server double
-
clicking on Kewill Customs installer
kc.installer_2.1.0.jar

on

the desktop console of the server
will a
utomatically
launch the
installation wizard.

If the installation doesn’t start, check the execute privilege flag on
kc.installer_2.1.0.jar

and
make that flag is set correctly for the user running the instal
ler.

Kewill Customs Installation Guide

KC Install
-

14

Copyright © 2011 by Kewill Inc.

Once the installer is running,
Setup Wizard
w
ill guide

you through the steps to install
Kewill
Customs’

components. The wizard
will
proceed through a series of
screens:

1.

Welcome screen
. C
lick
Next

button.


2.

Release Notes screen
. T
his is a good time to review the release notes, then click
Next

button.


3.

Kewill End
-
User License Agreement screen
. C
lick
Accept
, then click
Next

button.

4.

Stop Apache Tomcat screen
. Make sure Apache Tomcat is not running, then click
Next

button.

5.

Kewill
Customs Home Directory screen
.
Enter and m
ake sure to point the installer to
a
ppropriate Kewill
Customs’

directory. It is recommended to put it on /kcustoms directory.

Then click
Next

Button.


Kewill Customs Installation Guide

KC Install
-

15

Copyright © 2011 by Kewill Inc.

6.

Apache Tomcat Home Directory screen
.

Make sure to point the installer to the root
directory of Apache Tomcat.


7.

Kewill Customs Application N
ame screen
. This will be the web application name of
Kewill Customs. It is recommended to call it
kcustoms
.


Kewill Customs Installation Guide

KC Install
-

16

Copyright © 2011 by Kewill Inc.

8.

Database Connection screen
.
Enter and m
ake sure that the database connections are
correct. This information will be use
d

by the installer to run t
he database scripts and
to
set

up

the connection to the database. When you are done,
click
Next

button.


Kewill Customs Installation Guide

KC Install
-

17

Copyright © 2011 by Kewill Inc.

9.

Application Server Info screen
.
Enter the

IP an
d port address of Apache Tomcat, then
click
Next

button.


10.

Application Log Filename screen
. Make sure t
hat the location has enough disk space
to hold the log files of the application. Ideally, it should be able to hold a month
’s

worth of
logs for diagnostics of pote
ntia
l issues in the application. T
hen click
Next

button.


Kewill Customs Installation Guide

KC Install
-

18

Copyright © 2011 by Kewill Inc.


11.

Progress screen
.
At this point t
he installer will back up previous Kewill Customs
installation, if there is any and proceed to install the application.

12.

Script Processors screen
. At this point the installer will run the database scripts when
done, click
Next

button.

13.

Summary of Installatio
n screen
. Review the summary notes and check if there are any
critical error in the installation.



14.

P
roceed to
Post Installation Tasks
.


3.2.2.

Installing Kewill Customs Server

manually
on AIX or Linux


Overview

The table below provides the steps required for th
e
manual
setup process.


Step

Action


Comment

1


Get Kewill Customs web archive file
kcustoms.war
from supplied media.


Kewill Customs Installation Guide

KC Install
-

19

Copyright © 2011 by Kewill Inc.

Step

Action


Comment

2


Transfer
kcustoms.war

to the home
directory of Alliance user.


3


Log in to the application server using
telnet.

Copy
kcustoms.war

to
/kcustoms/apache
-
tomcat
-
5.5.26/webapps
.


4


At this point, the war file should have been
automatically exploded by Tomcat. If not,
try to stop and restart Tomcat.

Refer to section
3.1.1 and 3.1.2
on how to
stop and restart Tomcat.


Step

Action


Comment

5


Once exploded, navigate to
/kcustoms/apache
-
tomcat
-
5.5.26/webapps/
kcustoms

Edit
icustoms.jnlp

to point web start to
the correct URL.

To point web start to the correct URL,
replace and set the following lines:

From:


<property


name="icustoms.primary.url
"


value="http://10.146.1.171:8080/

k
customs/MainController"/>

To:


<property


name="icustoms.primary.url"

value="http://HOST_IP:8080/

kcustoms
/MainController"/>

Where:



HOST_IP

is the IP address of the
application server that is hosti
ng Tomcat
and vis
ible to users.

6


Navigate to
/kcustoms/apache
-
tomcat
-
5.5.26/webapps/
kcustoms
/WEB
-
INF

Edit
web.xml

to point the server
component to correct URL.

To point the server component to the
correct

URL replace and set the following lines:

From:

<init
-
param>


<par
am
-
name>icustoms.primary.url</param
-
name>


<param
-
value>http://10.146.1.171:8080/

k
customs/MainController</param
-
value>

Kewill Customs Installation Guide

KC Install
-

20

Copyright © 2011 by Kewill Inc.

Step

Action


Comment

</init
-
param>

To:

<init
-
param>


<param
-
name>icustoms.primary.url</param
-
name>


<param
-
value>http:
HOST_IP
:8080/

kcustoms
/MainContro
ller</param
-
value>

</init
-
param>

Note
: See definition of
HOST_IP

on Step 5
above.

7


Navigate to
/kcustoms/apache
-
tomcat
-
5.5.26/webapps/
kcustoms
/WEB
-
INF/classes
.

Edit
log4j.xml
, and point the log file to
appropriate location.

Example
:

<param name="File" va
lue="/
kcustoms/logs/customs.log" />


Kewill Customs Installation Guide

KC Install
-

21

Copyright © 2011 by Kewill Inc.

Step

Action


Comment

8


Navigate to
/kcustoms/apache
-
tomcat
-
5.5.26/webapps/
kcustoms
/WEB
-
INF/classes/META
-
INF
.

Edit
persistence.xml

to point to correct
database server and database username.

To point to the correct database server and
databa
se username, replace and set the
following lines:

<property name="toplink.jdbc.url"
value="jdbc:oracle:thin:@DATABASE_IP
:1521:DATABASE_SID" />

<property name="toplink.jdbc.user"
value="DB_SCHEMA" />

<property
name="toplink.jdbc.password"
value="DB_PASSWORD
" />

Where:



DATABASE_IP

is the IP address of the
database server
.



DATABASE_SID

is the name of Oracle
database. Usually, the dba should
provide this info.



DB_SCHEMA

is the database username
that were created to access Alliance
database. The default for Kewi
ll
Customs is “
kcapps
”.



DB_PASSWORD

is the password of
database username. The default for
Kewill Customs is “
kcapps

.

9


Restart Tomcat to put the
new settings

into effect
.

The application s
hould be accessible on this
URL:
http:HOST_IP:8080/
kcustoms
/


Note
: See definition of
HOST_IP

on Step 5
above.


3.2.3.

Installing Database script manually


Database Install

Note that Database
Install

must be done by a DBA or under supervision
of Kewill DBA Services.

The table below describes the steps required for installing t
he database on top
of
Alliance R07 Patch 2 Hotfix 1
.

After running the install scripts, the upgrade scripts has to be perform to bring
the database to the latest patch or hotfix of Kewill Customs.

Kewill Customs Installation Guide

KC Install
-

22

Copyright © 2011 by Kewill Inc.


Create a database user for Kewill Customs
:


Step

Action

1


Run
sqlplus
, and login as
SYSTEM

(dba for Oracle).

2


Using
sqlplus
, run the following:

a.

install
\
db
-
2
.0
\
create_kc_user
.sql


Grant the Alliance table to Kewill Customs:


Step

Action

3


Run
sqlplus
, and login as
TPSDBA

(database username/schema of Alliance).

4


Using
sqlplus
, run the following script from the installation media:

b.

install
\
db
-
2
.0
\
grant_alliance
_table
s
.sql


Kewill Customs Installation Guide

KC Install
-

23

C
opyright © 2011 by Kewill Inc.

Create the synonyms of Alliance table to Kewill Customs:


Step

Action

5


Run
sqlplus
, and login as
KCAPPS

(database username/schema of Kewill
Customs).

6


Using
sqlplus
, run the following script from the installation media:

c.

install
\
db
-
2
.0
\
create_kc_synonyms
.sql


Scripts creating and inserting Kewill Customs required tables and data:


Step

Action

7


Run
sqlplus
, and login as
TPSDBA

(database usern
ame/schema of Alliance).

8


Using
sqlplus
, run the following script from the installation media:

d.

install
\
db
-
2
.0
\
create_kc
_table
s
.sql

e.

install
\
db
-
2
.0
\
populate_kc_tables
.sql


Kewill Customs Installation Guide

KC Install
-

24

C
opyright © 2011 by Kewill Inc.

3.2.4.

Upgrading the Database manually


Database
Upgrade

Note that Database Upgrade must b
e done by a DBA or under
supervision of Kewill DBA Services.

The table below describes the steps required for
upgrading
the database on
top of Alliance R07 Patch
2

with Kewill Customs 2.0

or 2.0
.
1
.


Step

Action

1.


Run
sqlplus
, and login as
TPSDBA

(database

username/schema of Alliance).

2.


Using
sqlplus
, run the following script from the installation media

in the
following order
:

Note
: The 2.0.2.x scripts are not required to run if the system has Kewill
Customs 2.0.2.x

already
.

a.

upgrade
\
db
-
2
.0
.2
\
data
\
VALIDATIO
N_TABLE_X_REF
.sql

b.

upgrade
\
db
-
2
.0
.2
\
data
\
VALIDATION_MESS
.sql

c.

upgrade
\
db
-
2
.0
.2
\
data
\
VALIDATION_CONTROL
.sql

d.

upgrade
\
db
-
2
.0
.2
.2
\
data
\
SYSTEM_PARAMETER
.sql

Note
: The 2.0.3 scripts are required to run if upgrading from Kewill Customs
2.0.2.x to 2.0.3

e.

upgrade
\
db
-
2
.0
.
3
\
schema
\
PREFERENCE_KEYS
.sql

f.

upgrade
\
db
-
2
.0
.
3
\
schema
\
S
ECURITY_PREFERENCES
.sql

g.

upgrade
\
db
-
2
.0
.
3
\
data
\
ID_GEN
.sql

h.

upgrade
\
db
-
2
.0
.
3
\
data
\
VALIDATION_TABLE_X_REF
.sql

i.

upgrade
\
db
-
2
.0
.
3
\
data
\
VALIDATION_MESS
.sql

j.

upgrade
\
db
-
2
.0
.
3
\
data
\
VALIDATION_CONTROL
.sql

k.

upgrad
e
\
db
-
2
.0
.
3
\
data
\
SYSTEM_PARAMETER
.sql

l.

upgrade
\
db
-
2
.0
.
3
\
data
\
SECURITY_PREFERENCES
.sql

Note
: The 2.0.3
.1

scripts are required to run if upgrading from Kewill Customs
2.0.2.x
or

2.0.3

m.

upgrade
\
db
-
2
.0
.
3.1
\
data
\
VALIDATION_CONTROL
.sql

Kewill Customs Installation Guide

KC Install
-

25

Copyright © 2011 by Kewill Inc.

n.

upgrade
\
db
-
2
.0
.
3.1
\
data
\
VALID
ATION_MESS
.sql

o.

upgrade
\
db
-
2.0
.
3.1
\
data
\
VALIDATION_TABLE_X_REF
.sql


Grant the Alliance table to Kewill Customs:


Step

Action

3.


Run
sqlplus
, and login as
TPSDBA

(database username/schema of Alliance).

4.


Using
sqlplus
, run the following script from the insta
llation media:

f.

install
\
db
-
2
.0
\
grant_alliance
_table
s
.sql


Create the synonyms of Alliance table to Kewill Customs:


Step

Action

5.


Run
sqlplus
, and login as
KCAPPS

(database username/schema of Kewill
Customs).

6.


Using
sqlplus
, run the following script from
the installation media:

g.

install
\
db
-
2
.0
\
create_kc_synonyms
.sql


Kewill Customs Installation Guide

KC Install
-

26

C
opyright © 2011 by Kewill Inc.

4.

Installing Kewill Customs Services


4.1


Installing Kewill Customs Services on AIX or Linux


Step

Action


Comment

1


Copy the directory
/kcustoms/apache
-
tomcat
-
5.5.26

to
/kcustoms/apache
-
tomcat
-
5.5.26
-
2
.


2


Navigate to
/kcustoms/apache
-
tomcat
-
5.5.26
-
2/conf
.

Edit
serv
er
.xml

to change the default port
number of the second Apache Tomcat.

From:

<Server port="8005"
shutdown="SHUTDOWN">

<Connector port="8080"
maxHttpHeaderSize="8192"…

<Connector port=
"8009"
enableLookups="false"
redirectPort="8443"
protocol="AJP/1.3" />

To:

<
Server port="8006"
shutdown="SHUTDOWN">

<Connector port="8081"
maxHttpHeaderSize="8192"…

<Connector port="8010"
enableLookups="false"
redirectPort="84
43"
protocol="AJP/1.3" />

3


Navigate to
/kcustoms/apache
-
tomcat
-
5.5.26
-
2/webapps/kcustoms/WEB
-
INF/classes
.

Edit
service.xml

to enable the Kewill
Customs Reports background processes.

Enable the following services by removing
XML comment (<!
--

--
>) tag surr
ounding
them:

ReportSchedulerHandler

ReportQueueHandler

EMailQueueHandler

PrintQueueHandler

4


Navigate to
/kcustoms/apache
-
tomcat
-
5.5.26
-
2
/webapps/
kcustoms
/WEB
-
From
:

Kewill Customs Installation Guide

KC Install
-

27

Copyright © 2011 by Kewill Inc.

Step

Action


Comment

INF/classes
.

Edit
log4j.xml
, and point the log file to
appropriate location.

<param name=
"File" value="/
kcustoms/logs/customs.log" />

To
:

<param name="File" value="/
kcustoms/logs/
report_
customs.log" />

5


At this point, the setup is done and starts
Tomcat.

Refer to section 3.1.1 and 3.1.2 on how to
stop and restart Tomcat.


Kewill Customs Installation Guide

KC Install
-

28

C
opyright © 2011 by Kewill Inc.

5.
Troubles
hoo
ting of Kewill Customs Installation


To check if Kewill
Customs is operating
correctly

The URL below can be use
d

to check if Kewill Custo
ms is operating correctly.
Use

a browser
to
pull up:

http://ip_address:8080/
kcustoms
/MainController

Example
:
http://69.48.135.27:8080/kcustoms/MainController

The response should be:
Hello!MainController is alive and well.



To check the memory
usage

The URL below can be use
d

to check the memory usage and m
anage the
instances of Kewill Custom
s web application context. Use

a browser to pull up:
http://ip_address:8080/manager/status

Example
:
http://69
.48.135.29:8080/manager/status

(
See below for sample Status results
).


Sample Status:




Note



The “
cr敥

memory” must not exceed or
be equal to “Max memory”. I
f⁩琠isⰠ
瑨攠
he睩ll⁃畳t潭s

慰灬ic慴i潮

湥e摳⁴ 扥⁲敳瑡牴敤
K


Kewill Customs Installation Guide

KC Install
-

29

Copyright © 2011 by Kewill Inc.



6.

I
nstallation of Kewill Customs Adapter


Overview

The Kewill Customs Adapter is an integration module for Kewill Customs.

The following table describes the installation steps for the Kewill Customs
Adapter. The instructions have been separated into t
hree areas:

1.

Prerequisites

2.

Tomcat Configuration


3.

Installation of Program

4.

Configuri
ng the Database Connection


6.1.

Kewill Customs Adapter Prerequisites


Prerequisites

required
for installation:

1.

Sun JDK version 1.5

2.

Apache Tomcat version 5.5.



A灡ch攠eomc慴ac慮⁢ 摯睮wo慤e搠dt㨠
http:/
/tomcat.apache.org/download
-
55.cgi


6.2.

Apache Tomcat Configuration for RMS


Windows:

1.

Open the Tomcat Configuration tool.

2.

Click on the
Java

tab

3.

Append the following line to the Java Options:


-
Dicustoms.database.type=RMS


[
See screenshot below
]


Kewill Customs Installation Guide

KC Install
-

30

Copyright © 2011 by Kewill Inc.

Sample of change in Apache Tomcat Properties window:



Unix/Linux

Edit
<Tomcat_Install>/bin/catalina.sh

1.

Append the following line to the JAVA_OPTS




-
Dicustoms.database.type=RMS


Note on Memory:

The memory se
tting on Apache Tomcat has to be set accordingly. The size of
the memory is dependent on the capacity, load of the system and size of XML
files.

For initial setting, it is recommended to set the following:

On windows, Apache Tomcat Properties:

Initial memo
ry pool:
1024

Maximum memory pool:
1024

On Unix, append the following line to JAVA_OPTS:

-
Xms1024m

Xmx1024m


Kewill Customs Installation Guide

KC Install
-

31

C
opyright © 2011 by Kewill Inc.

6.3.

Apache Tomcat Configuration for Oracle


Note for Oracle:

No special configuration is required for Oracle.


6.4.

Installation of Apache Tomcat on Win
dows


Note on using a Servlet
Container other than
Tomcat

The
se

installation instructions are for
Tomcat
. Please read the web
archive

deploy instructions of the Servlet Container if using a Servlet Container other
than Tomcat.


Step

Action


Comment

1


Copy

the compressed program file
kca
dapter.war
to the

<Tomcat Install>/webapps

folder.


2


Start
Tomcat

if it is not already started.

Tomcat will create a new folder called
adapter

under webapps. The adapter
folder contains the extracted application
files.


6.4.1.

C
onfiguring the Database Connection
-

Oracle
:


Step

Action


Comment

3


Navigate to the folder:

<Tomcat Install>/webapps/
kc
adapter/

WEB
-
INF/classes/META
-
INF


4


Edit the file
persistence.xml


5


Locate the
<properties>

tag within the
file.

It should be towards

the end of the file.

6


Set the correct values for the following
properties:

a.

toplink.jdbc.url



瑨攠e慴a扡s攠
c潮湥c瑩潮⁳瑲i湧


Kewill Customs Installation Guide

KC Install
-

32

Copyright © 2011 by Kewill Inc.

e.g. for Oracle :

jdbc:oracle:thin:@<database
server>:<port>:<sid>

The correct values should be
substituted for
<
database
server
>
, <
port
>, <
sid
>.

[
Contact the database
administrator to find out these
values.
]

b.

toplink.jdbc.user



the database
username

c.

toplink.jdbc.password



the
password for the above database
user


6.4.2.

Configuring the Database Connection
-

Connx:


Step

Action


Comme
nt

7


Navigate to the folder:

<Tomcat Install>/webapps/adapter/

WEB
-
INF/classes/META
-
INF


8


Edit the file
persistence.xml


9


Locate the
<properties>

tag within the
file.

It should be towards the end of the file.

10


Comment out the Oracle Connection
properti
es and uncomment the Connx
Connection properties.


11


Set the correct values for the following
properties:

a.

toplink.jdbc.url



瑨攠e慴a扡s攠
c潮湥c瑩潮⁳瑲i湧

For Connx :

jdbc:connx:DD=<DSN>;GATEWAY=<
gateway>;PORT=7500

The correct values should be
substitute
d for
<
DSN
>
, <
gateway
>.

[
Contact the database administrator to
find out these values.
]

b.

toplink.jdbc.user



瑨t 摡t慢慳攠

Kewill Customs Installation Guide

KC Install
-

33

Copyright © 2011 by Kewill Inc.

username

c.

toplink.jdbc.password



the
password for the above database
user

12


You are done.



Kewill Customs Installation Guide

KC Install
-

34

Copyright © 2011 by Kewill Inc.

Appendix 1

--

Installing Java Notes


Not
es

Action


Comment

1


When installing java, change the Install
Folder from the default location

For example:
Change from

C:
\
Program
Files
\
Java
\
jdk1.5.0_14

C
hange to


C:
\
Java
\
jdk1.5.0_14

[
See screenshots below
for sample
.]

2


Ensure that none of the folder names
have spaces in them and are not too
long.



Sample of changing Java Install Folder from the default location
:



Kewill Customs Installation Guide

KC Install
-

35

Copyright © 2011 by Kewill Inc.

Sample of modified Java Install Folder destination location
:



Kewill Customs Installation Guide

KC Install
-

36

Copyright © 2011 by Kewill Inc.

Appendix 2

--

Installing

Tomcat Notes


Notes

Action


Comment

1


When installing Tomcat, change the
Install Folder from the default location.

For example:

Change from


C:
\
Program Files
\
Apache
Software Foundation
\
Tomcat
5.5


Change to


C:
\
Java
\
Apache
\
Tomcat5.5

[
See screenshots below for sample
.]

2


Make sure that none of the folder
names have spaces in them and are not
too long.



Sample of changing Tomcat Install Folder from the default location:



Kewill Customs Installation Guide

KC Install
-

37

Copyright © 2011 by Kewill Inc.

Sample of modified Install
Fold
er

destination location:



Copyright © 20
1
1

Kewill
Inc.

[last revision date: 0
1
/
21
/
1
1
]