Import Compliance Installation Guide - BluJay Solutions...
Transcript of Import Compliance Installation Guide - BluJay Solutions...
Last Revision Date: August 28, 2009
Import Compliance
Installation Guide
Publication Date: December, 2007
Import Compliance Installation Guide
Import Compliance Install-2
Copyright © 2007-2008 by Kewill plc
Table of Contents
Table of Contents..................................................................................................................................... 2
Instructions for Installing the Import Compliance Application........................................................... 3
1. Install Java SDK 1.4.2_05................................................................................................................. 4
2. Install Oracle 10g Client................................................................................................................... 7
3. Configure Oracle 10g Client .......................................................................................................... 10
4. Install Versata ................................................................................................................................. 11
5. Configuring Versata for Import Compliance................................................................................ 21
Configure JBoss Startup ................................................................................................................... 21
Configure Logging ............................................................................................................................. 22
Copy Application Files....................................................................................................................... 25
Configure VLS Components.............................................................................................................. 25
Configure the Versata Logic Server using the Versata Logic Console ............................................. 27
Versata Logic Console screen: ......................................................................................................28
6. Configuring Import Compliance for Integration with Dashboard Application. ........................ 35
Addendum to Import Compliance Installation Guide......................................................................... 42
Install Instructions for Import Compliance Windows Service: ...................................................... 42
Import Compliance Properties File Installation:.............................................................................. 44
Installation Instructions:..................................................................................................................... 44
Import Compliance Installation Guide
Import Compliance Install-3
Copyright © 2007-2008 by Kewill plc
Instructions for Installing the Import Compliance Application
Overview This document describes the installation steps for the Import Complianceapplication. The instructions have been separated into the following areas:
1. Install Java SDK 1.4.2_05
2. Install Oracle 10g Client
3. Configure Oracle 10g Client
4. Install Versata
5. Configuring Versata for Import Compliance
6. Configuring Import Compliance for Integration with DashboardApplication
Import Compliance Installation Guide
Import Compliance Install-4
Copyright © 2007-2008 by Kewill plc
1. Install Java SDK 1.4.2_05
Step Action Comment
1 Proceed to the next step (step 2) if JavaSDK 1.4.2 is already installed on thesystem.
2 Double-Click on j2sdk-1_4_2_05-windows-i586-p.exe
3 Accept the License Agreement. The Custom Setup screen will display.
Step Action Comment
4 On the Custom Setup Screen, changethe Installation Directory by clicking theChange… button.
(See screen above.)
The Change Current Destination Folderscreen will display.
Import Compliance Installation Guide
Import Compliance Install-5
Copyright © 2007-2008 by Kewill plc
Step Action Comment
5 On the Change Current DestinationFolder, set the folder name to <InstallDrive>\jdk142 and click OK.
The previous Custom Setup screen willredisplay.
6 Click Next and Install. When it is done, the InstallShield WizardCompleted screen will display.
Import Compliance Installation Guide
Import Compliance Install-6
Copyright © 2007-2008 by Kewill plc
Step Action Comment
7 Click on Finish.
Import Compliance Installation Guide
Import Compliance Install-7
Copyright © 2007-2008 by Kewill plc
2. Install Oracle 10g Client
Special Note: For more comprehensive Installation Instructions, please contact yourDatabase Administrator.
Step Action Comment
1 Proceed to the Configure Instructions ifOracle 10g Client is already installed onthe system.
2 Unzip Oracle10gClient.zip
3 Double-click on setup.exe in theOracle10gClient folder.
4 Select Next on the Welcome Screen.
5 Select Administrator on the SelectInstallation Type screen and click Next.
The Specify Home Details screendisplays.
6 Accept the default name on the SpecifyHome Details screen.
Change the path if required and clickNext.
Import Compliance Installation Guide
Import Compliance Install-8
Copyright © 2007-2008 by Kewill plc
Step Action Comment
7 Accept the default name on the SpecifyHome Details screen.
Change the path if required.
8 Click Next.
9 Click Next on the Product-SpecificPrerequisite Checks screen.
10 Click Install on the Summary screenand wait for installation to complete.
The Oracle Net Configuration AssistantWelcome screen displays.
Step Action Comment
11 Select Perform typical configuration. A checkmark will display in checkbox.
12 Click Next.
13 Click Finish.
14 Click Exit on the End of Installationscreen.
Import Compliance Installation Guide
Import Compliance Install-9
Copyright © 2007-2008 by Kewill plc
Import Compliance Installation Guide
Import Compliance Install-10
Copyright © 2007-2008 by Kewill plc
3. Configure Oracle 10g Client
Step Action Comment
1 Navigate to <oracle installfolder>\product\10.2.0\client_1\NETWORK\ADMIN
2 Edit or create a new file calledTNSNAMES.ORA(if one does notalready exist)
3 Paste the following in the file –
Note: The following steps may requirethe assistance of your DatabaseAdministrator.
IMPCMP= (DESCRIPTION =
(ADDRESS_LIST = (ADDRESS =
(PROTOCOL = TCP)(HOST = <OracleDatabase Server Name or IPAddress>)(PORT = <1521>) ) )
(CONNECT_DATA (SID = <orcl>)
(SERVER = DEDICATED) ) )
4 Replace <Oracle Database ServerName or IP Address> with the actualServer Name or IP Address.
5 Replace <1521> with the actual OraclePort.
6 Replace <orcl> with the SID suppliedby the Database Administrator.
7 Save the file.
Import Compliance Installation Guide
Import Compliance Install-11
Copyright © 2007-2008 by Kewill plc
4. Install Versata
Special Note: The User installing Versata needs to have Administrator rights on thecomputer where Versata is being installed.
Step Action Comment
1 Navigate back to the Install Folder.
2 Unzip VLS-nt-2k.zip
3 Open the folder named VLS-nt-2k.
4 Double-click SETUP.EXE. The Splash screen will display.
Step Action Comment
5 On the Splash Screen select the FirstChoice: Versata Logic Server.
The License Agreement will display.
6 Select NEXT and Accept the LicenseAgreement.
The Versata Registration screen displays.
Import Compliance Installation Guide
Import Compliance Install-12
Copyright © 2007-2008 by Kewill plc
Step Action Comment
7 Complete the Versata Registration asfollows:
User Name: KTAL
Company Name: Kewill Trade &Logistics
Serial Number: VA014DM049Y99791
8 Click Next. The Confirmation screen will display.
Import Compliance Installation Guide
Import Compliance Install-13
Copyright © 2007-2008 by Kewill plc
Step Action Comment
9 Click Yes to the Confirmation Screen. Note: If you get the following warning:
Select the location of your Java SDK.
Import Compliance Installation Guide
Import Compliance Install-14
Copyright © 2007-2008 by Kewill plc
Step Action Comment
10 On the Choose Target Directory screen,click on the Browse button to changethe default Installation Directory.
The Choose Folder screen displays.
Import Compliance Installation Guide
Import Compliance Install-15
Copyright © 2007-2008 by Kewill plc
Step Action Comment
11 On the Choose Folder screen, choosethe correct path and installation folder.
Click OK.
Step Action Comment
12 On the Choose Target Directory screen,click on the Browse button to changethe default Installation Directory.
The Choose Folder screen will display.
Import Compliance Installation Guide
Import Compliance Install-16
Copyright © 2007-2008 by Kewill plc
Step Action Comment
13 On the Choose Folder screen, type<Install Drive>\VATA562 in the Pathbox.
14 Click OK. The Destination on the Choose TargetDirectory screen should show <InstallDrive>\VATA562.
Import Compliance Installation Guide
Import Compliance Install-17
Copyright © 2007-2008 by Kewill plc
Step Action Comment
15 Accept the default on the SelectProgram Folder screen.
16 Click Next.
17 Ensure that the Host Name is correct onthe Enter Host Name or Alias screenand click Next
18 Click Next on the Start Copying Filesscreen.
The Install Complete screen will display.
Import Compliance Installation Guide
Import Compliance Install-18
Copyright © 2007-2008 by Kewill plc
Step Action Comment
19 Click Finish on Install Complete screen.
20 Start Versata Server to ensure that theInstallation was successful.
(See screen below).
Import Compliance Installation Guide
Import Compliance Install-19
Copyright © 2007-2008 by Kewill plc
Step Action Comment
21 Successful Startup. (See screen below).
Import Compliance Installation Guide
Import Compliance Install-20
Copyright © 2007-2008 by Kewill plc
Step Action Comment
22 Stop Versata Server. (See screen above).
Import Compliance Installation Guide
Import Compliance Install-21
Copyright © 2007-2008 by Kewill plc
5. Configuring Versata for Import Compliance
Configure JBoss Startup
Step Action Comment
1 To configure JBoss startup, firstnavigate to
<Versata Install>\Config\bin folder
Step Action Comment
2 Edit file run.bat
3 Find the line:
rem set JAVA_OPTS=%JAVA_OPTS%-Xms128m -Xmx512m
Import Compliance Installation Guide
Import Compliance Install-22
Copyright © 2007-2008 by Kewill plc
Step Action Comment
4 Delete: rem
5 Add the following:
-XX:MaxPermSize=256m
(with a leading space) to the end of theline and save the file.
Configure Logging
Step Action Comment
6 To configure logging, copy the TPSfolder (from the Install folder) to thesame drive as Versata Installation drive.
7 Navigate to:
<VersataInstall>\Config\server\default\conf
[See screen below.]
Import Compliance Installation Guide
Import Compliance Install-23
Copyright © 2007-2008 by Kewill plc
Step Action Comment
8 Rename the file:
log4j.xml to log4j.xml.orig
9 Copy
log4j.xml from Install\Config
to
<VersataInstall>\Config\server\default\conf
10 Edit the file:
log4j.xml
11 Search for
<!-- TPS all Classes appender -->
Import Compliance Installation Guide
Import Compliance Install-24
Copyright © 2007-2008 by Kewill plc
Step Action Comment
12 In the value for
<param name=”File” value=
replace “<versata install drive>” with thevalue.
13 Search for
<!-- TPS TARIFFS Upload appender -->
In the value for
<param name=”File” value=
replace “<versata install drive>” with thevalue.
Import Compliance Installation Guide
Import Compliance Install-25
Copyright © 2007-2008 by Kewill plc
14 Search for
<!-- TPS INVOICE Upload appender -->
In the value for
<param name=”File” value=
replace “<versata install drive>” with thevalue.
15 Save file.
Copy Application Files
Step Action Comment
16 To copy the application files, copy allthe files from Install\lib to
<VersataInstall>\Config\server\default\lib
17 In <VersataInstall>\Config\server\default\lib renamexalan.jar to xalan.jar.orig.
18 Copy jellybean.ear
from Install
to
<Versata Install>\Config\server\default\deploy
Configure VLS Components
Step Action Comment
19 To configure VLS components, firstnavigate to
<Versata Install>\VlsComponents
Import Compliance Installation Guide
Import Compliance Install-26
Copyright © 2007-2008 by Kewill plc
20 Rename the file
AppConfig.properties
to AppConfig.properties.orig
21 Rename the file
EJBAppServerConfig.txt
to EJBAppServerConfig.txt.orig
22 Copy the above two files from
Install\VlsComponents
to
<Versata Install>\VlsComponents
23 Edit EJBAppServerConfig.txt.
24 Search for TPSPropertiesLocationand replace <Versata Install Drive> withthe correct value.
25 Search for TPSListenerConfig andreplace <Versata Install> with thecorrect value
26 Search for
TPSVelocityTemplatesLocation
and replace <Versata Install Drive> withthe correct value.
27 Search for TPS_SMTPServer andreplace <Mail SMTP Server> with thecorrect value.
28 Search for TPS_AdminNotifier andreplace <Administrator email address>with the administrator email address.
29 Save the file.
Import Compliance Installation Guide
Import Compliance Install-27
Copyright © 2007-2008 by Kewill plc
Configure the Versata Logic Server using the Versata Logic Console
Step Action Comment
30 Start the Versata Server.
Step Action Comment
31 Start the Versata Logic Console. [See screen above for example.]
Import Compliance Installation Guide
Import Compliance Install-28
Copyright © 2007-2008 by Kewill plc
Step Action Comment
32 Login to the Versata Console. [See above for login screen.]
33 In the Application Name field, type
jellybean
The Versata Logic Console screen willdisplay. [See below.]
Versata Logic Console screen:
Import Compliance Installation Guide
Import Compliance Install-29
Copyright © 2007-2008 by Kewill plc
Step Action Comment
34 Open the Administration node byclicking on the + and the Data Serversnode under the Administration node.
35 Right Click on DataServer0 When you Right Click on DataServer0, aselection box will display with the choiceof Change Name or Assign Objects. [Seebelow.]
Import Compliance Installation Guide
Import Compliance Install-30
Copyright © 2007-2008 by Kewill plc
Step Action Comment
36 From the selection box, select ChangeName.
When you select Change Name, a pop-upbox will display allowing you to enter thenew name. [See pop-up screen below.]
Step Action Comment
37 Type in ImportCompliance as the newDataServer Name.
38 Click OK. The previous screen will display with thenew name.
Import Compliance Installation Guide
Import Compliance Install-31
Copyright © 2007-2008 by Kewill plc
Step Action Comment
39 Select the renamed ImportComplianceData Server and then select theConnection PropertiesTab.
The Connection Properties data willdisplay. [See screen above.]
40 In the Data Server Type field, select
Oracle-JDBC Thin Client.
41 In the Data Server Login field, type inthe database username.
42 Click on the Password button. When you click on the Password button,the Set Password dialog box will display.[See example below.]
Import Compliance Installation Guide
Import Compliance Install-32
Copyright © 2007-2008 by Kewill plc
Step Action Comment
43 In the Default Password field, type inthe password for the database.
In the Confirm Password field, re-typethe password to confirm it.
44 Click the OK button to close thePassword dialog box.
The Set Password dialog box will close.
Import Compliance Installation Guide
Import Compliance Install-33
Copyright © 2007-2008 by Kewill plc
Step Action Comment
45 In the Property/Value grid below theData Server Login field, set the valuesfor their corresponding properties.
46 Next to the Host property, type the<database server name or IP address>
47 Next to the Port property, type the<database port>
48 Next to the Schema property, type the<Schema Name>
49 Next to the SID property, type the <sid>
50 When you are done entering theproperty values, click the TestConnection button.
The application will test the connection. Ifsuccessful, the Connection Resultsscreen will display. [See below.]
Import Compliance Installation Guide
Import Compliance Install-34
Copyright © 2007-2008 by Kewill plc
Step Action Comment
51 Click the OK button.
52 Save all changes.
Import Compliance Installation Guide
Import Compliance Install-35
Copyright © 2007-2008 by Kewill plc
6. Configuring Import Compliance for Integration with DashboardApplication.
Special Note: This step is only required if the Dashboard Application has been installed.
Step Action Comment
1 Right Click on the Data Servers node A Selection box will display allowing youto choose from New or Search. [Seeexample below.]
Step Action Comment
2 From the selection box, select New tocreate a new Data Server.
The Data Server pop-up will display.
Import Compliance Installation Guide
Import Compliance Install-36
Copyright © 2007-2008 by Kewill plc
Step Action Comment
3 In the Data Server Name field, type
Alliance-Dashboard
This will name the new Data Server“Alliance-Dashboard”.
4 Click the OK button. The application will save the new DataServer name and the pop-up screen willclose.
Import Compliance Installation Guide
Import Compliance Install-37
Copyright © 2007-2008 by Kewill plc
Step Action Comment
5 Reselect the ImportComplianceDatasource and then select the DataObjects Tab.
The Data Objects grid will display. [Seescreen above.]
6 Scroll down to the
DASHBOARD_WORK_MGMT Object.
Import Compliance Installation Guide
Import Compliance Install-38
Copyright © 2007-2008 by Kewill plc
Step Action Comment
7 Under the Data Server column (next tothe Dashboard_Work_MGMT Object)on the grid, click on
ImportCompliance
When you click on ImportCompliance, adrop-down list displays.
8 From the drop-down list, select
Alliance-Dashboard
9 Save all the changes (by clicking on theSave icon in the toolbar at the top of thescreen).
You will see “Alliance-Dashboard” displaynext to the DASHBOARD_WORK_MGMTObject Name. [See screen examplebelow.]
Import Compliance Installation Guide
Import Compliance Install-39
Copyright © 2007-2008 by Kewill plc
Step Action Comment
10 Next select the Alliance-DashboardData Server.
Import Compliance Installation Guide
Import Compliance Install-40
Copyright © 2007-2008 by Kewill plc
Step Action Comment
11 Select the Connection Properties Tab. The Connection Properties Tab screenwill display. [See screen below.]
Step Action Comment
12 In the Data Server Type field, from thedrop-down list, select Oracle-JDBCThin Client.
13 In the Data Server Login field, type inthe username for the AllianceDatabase.
14 Click the Password button. When you click on the Password button,the Password dialog box displays.
15 In the Default Password field, type inthe password for the database.
In the Confirm Password field, re-typethe password to confirm it.
Import Compliance Installation Guide
Import Compliance Install-41
Copyright © 2007-2008 by Kewill plc
16 Click the OK button to close thePassword dialog box.
The Set Password dialog box will close.
17 In the Property/Value grid below theData Server Login field, set the valuesfor their corresponding properties.
18 Next to the Host property, type the<database server name or IP address>
19 Next to the Port property, type the<port>
20 Next to the Schema property, type the<schema>
21 Next to the SID property, type the <sid>
22 When you are done entering theproperty values, click the TestConnection button.
The application will test the connection. Ifsuccessful, the Connection Resultsscreen will display.
23 Save the changes (by clicking on theSave icon in the toolbar at the top of thescreen).
Import Compliance Installation Guide
Import Compliance Install-42
Copyright © 2007-2008 by Kewill plc
Addendum to Import Compliance Installation Guide
Install Instructions for Import Compliance Windows Service:
Step Action Comment
1 Copy the files found underImportCompliance_ServiceWrapper/binto
<VersataInstall>/Config/bin
2 Create a new folder called conf under<VersataInstall>/Config
3 Copy the file found underImportCompliance_ServiceWrapper/confto the newly created
<VersataInstall>/Config/conf
4 Copy the files found underImportCompliance_ServiceWrapper/lib to
<VersataInstall>/Config/lib
5 Navigate to the folder<VersataInstall>/Config/conf
6 Edit the file wrapper.conf
7 Replace all instances of <jdk path>(there should be two) in wrapper.confwith the actual path of java on the server.
For example: If java is installed atC:/jdk142_14 the string would look like
C:/jdk142_14/bin/java
8 Replace <TPS Folder Path> inwrapper.conf with the actual path to theTPS folder on the server.
For example: If the TPS folder is at thelocation C:/TPS the string would looklike
C:/TPS/logs/wrapper.log
9 Save the wrapper.conf file.
10 Navigate to <VersataInstall>/Config/bin
Import Compliance Installation Guide
Import Compliance Install-43
Copyright © 2007-2008 by Kewill plc
11 Double-click on the fileInstallImportComplianceService-NT.bat.
This will create a Windows Service forthe Import Compliance application.
12 Open up the Windows Services console.Select the newly created "ImportCompliance Service" and start it like anyother service.
The Import Compliance Service can bestopped like any other Windows Serviceas well from the Windows ServicesConsole.
13 Upon a server restart, the ImportCompliance Service will also restart withthe server.
Import Compliance Installation Guide
Import Compliance Install-44
Copyright © 2007-2008 by Kewill plc
Import Compliance Properties File Installation:
Overview Import Compliance version 2.0.0 or later is required in order to install this TariffUpdate. This Update contains :
Installation.doc : This file containing Installation Instructions
Properties File
Installation Instructions:
Step Action Comment
8 Place the Properties file in theTPS\lib\ext\props folder
A properties / configuration file is required for each uploadcountry. This is a one time process. The Properties file MUSTbe placed in the correct folder location before continuing withthe appropriate Tariff / ECCN upload instructions below.
>IC_Tariff_Update_Install_Instructions_Export_Classifications.doc
> IC_Tariff_Update_Install_Instructions_NON_US.doc
> IC_Tariff_Update_Install_Instructions_US
Copyright © 2008 by Kewill plc [last revision date: 08/28/09]