CODA V11.3. CODA Installation Guide

Transcription

1 CODA V11.3 CODA Installation Guide

2 Introduction CODA Installation Guide Contents 1 Introduction Prework Required Skills Obtain Licenses Application Server Requirements Web Server Requirements AS/400 Requirements for DBSi Integration Application Server Edit INI file Application Server Set Permissions and Groups on Install Drive Install SQL Server Install Java Create Databases Install CODA Financials Install CODA Framework Install CODA epay and estatements Install estatements Configurator Install Customer Statements Server Install CODA Financials Client Install Conversion Scripts Configure Windows Services Reboot the application server Web Server Edit INI file Web Server Set Permissions and Groups on Install Drive Install Java Install Servlet Exec Install CODA Web Reboot the web server Manual Steps Configure AS/400 with Coda Instance Settings Change service settings on Coda Application Server Obtain SSL Certificate Appendix AutoIt Page 2 of 17

3 Introduction Change History Date Change Modified by: August 2007 Initial release. CODA Development August 2008 New scripts, improved guide CODA Development October 2008 Added Configure Windows Services script to Application Server CODA Development January 2009 Update on IIS install as pre-requisite and XML toolkit version number Nageswar Kapa 1 Introduction This document is a guide to assist in the installation of CODA v11 and its related components. This guide attempts to show all of the necessary steps involved. Coda runs on the Windows 2003 Server operating system. It requires a database server, an application server, and a web server. In this guide and the scripts provided the database server and application server are installed on the same instance of Windows. Coda uses the Microsoft SQL Server 2005 database engine. Most of the installation of Coda has been automated using a tool called AutoIt. More detail about this software is contained in the appendix. Page 3 of 17

4 Prework 2 Prework 2.1 Required Skills Knowledge requirements for installing and administering Coda. 1. A thorough understanding of the Windows server operating environment. 2. A basic understanding of Microsoft SQL Server 2005 administration and simple SQL queries. 2.2 Obtain Licenses Obtain ServletExec License As indicated in the DBSi 5.0 Infrastructure Architecture Blueprint, the New Atlanta ServletExec licenses are required to install and run Coda. The dealer or hosting provider will need to purchase these licenses. Visit the website for more information on this product and how to obtain licenses. As indicated in the Web Server Edit INI file section of this document, the ServletExec License= setting needs to be updated with your specific license keys Obtain Coda License File During a Caterpillar Solution Center Exit, the dealer needs to request this dealer specific Coda License file that is located on the solution center server. For new dealer installs, the dealer needs to request a new Coda License file from the DDS Support Center. As indicated in the Application Server Edit INI file section of this document, this file needs to be placed in the lib folder of the installation source. Then, the Application setup.ini file needs to be updated to reference this file. 2.3 Application Server Requirements Obtain Hardware 1. Determine if the Production and Development instances will be hosted on the same server or on separate servers. 2. Determine if a backup server will be set up. Also if it will be shared with the Development instance. Page 4 of 17

5 Prework Obtain Software 1. Install Windows 2003 Server. 2. Install Microsoft SQL Server Download the CodaAppInstall.zip file and unzip it to a folder on the disk of the application server. 2.4 Web Server Requirements Obtain Hardware 1. Determine if the Production and Development instances will be hosted on the same server or on a separate server. 2. Determine if a backup server will be set up. Also if it will be shared with the Development instance Obtain Software 1. Install Windows 2003 Server along with IIS 2. Download the CodaWebInstall.zip file and unzip it to a folder on the disk of the application server. 2.5 AS/400 Requirements for DBSi Integration IBM XML Toolkit for iseries (5733XT1) Required IBM Product IBM XML Toolkit version 1.1 for iseries (5733XT1) is a required software component on the AS/400. DBSi 5.0 uses this product to enable the DBS to Coda Synchronous Web Service integration. Page 5 of 17

6 Application Server Edit INI file 3 Application Server Edit INI file Before running the CODA Application Install scripts you must first change the values in the setup.ini file to match your environment. In the sample setup.ini file provided there are three environments created, it is possible to install more or less envirenments by changing the LSVs= line. If this line is changed then a corresponding subsection will need to be created/deleted for the scripts to work. The setup.ini file is found in the CodaAppInstall folder that was extracted from the zip file. [Install] Install Drive=E DealerCode=DDD [Instance] LSVs=DDDPRD,DDDFDC,DDDTRN (Change to match the drive where you want Coda installed) (Make this match your 3 digit dealercode) (Replace DDD with the 3 digit dealercode) [DDDPRD] (Replace DDD with the 3 digit dealercode) NameServerPort=10100 (This value must be unique for each instance) FinancialsLicenseFile=MQ1339LIVE10100comp.elf (Set this to license file *see note) DefaultCompany=DELTANACD (Set this to the name of your company in CODA) StartupDatabase=DLR_STARTUP.BAK (The initial db to restore *see note) LPAR name= (Enter the name of your as400) CCSID=37 (The CCSID of your as400 LPAR) Date Format=MM/dd/yyyy (The preferred date format, CASE Sensitive) CustomerStatementsPort=10155 (This value must be unique for each instance) [DDDFDC] (Replace DDD with the 3 digit dealercode) NameServerPort=10101 (This value must be unique for each instance) FinancialsLicenseFile=MQ1339LIVE10100comp.elf (Set this to license file *see note) DefaultCompany=DELTANACD (Set this to the name of your company in CODA) StartupDatabase=DLR_STARTUP.BAK (The initial db to restore *see note) LPAR name= (Enter the name of your as400) CCSID=37 (The CCSID of your as400 LPAR) Date Format=MM/dd/yyyy (The preferred date format, CASE Sensitive) CustomerStatementsPort=10156 (This value must be unique for each instance) [DDDTRN] (Replace DDD with the 3 digit dealercode) NameServerPort=10102 (This value must be unique for each instance) FinancialsLicenseFile=MQ1339LIVE10100comp.elf (Set this to license file *see note) DefaultCompany=DELTANACD (Set this to the name of your company in CODA) StartupDatabase=codatrain_fin_db.bak (The initial db to restore *see note) LPAR name= (Enter the name of your as400) CCSID=37 (The CCSID of your as400 LPAR) Date Format=MM/dd/yyyy (The preferred date format, CASE Sensitive) CustomerStatementsPort=10157 (This value must be unique for each instance) *Note: Place the CODA Financials license file, and the initial database backup in the lib folder of the installation source. Update this parameter to be the name of your file.. Page 6 of 17

7 Application Server 4 Application Server 4.1 Set Permissions and Groups on Install Drive Run 01.0 Set Permissions and Groups.exe from the CODAAppInstall\bin folder. 1. Removes the Users group from the install drive for security 2. Adds the Administrators group to the install drive 3. Creates Windows groups for granting permissions to shares and databases. 4.2 Install SQL Server Run 02.0 Install SQL Server 2005 and SP2.exe from the CODAAppInstall\bin folder. Note: This script is only for the Solution Center. Other s must obtain SQL Server licenses separately and manually install this software. 1. Installs SQL Server Installs SQL Server 2005 SP2 4.3 Install Java Run 03.0 Install Java JRE and JDBC Drivers.exe from the CODAAppInstall\bin folder. 1. Copies Java JDBC drivers to install drive 2. Installs Java v1.4.2_ Create Databases Run 04.0 Create DB instance and Set Users.exe from the CODAAppInstall\bin folder. 1. Creates SQL Server users for use with CODA 2. Creates databases for each instance 3. Creates link-tables_datawriter role in each database 4. Sets SQL and Windows Group user access to each database Page 7 of 17

8 Application Server 4.5 Install CODA Financials Run 05.0 Install CODA Financials on Application Server.exe from the CODAAppInstall\bin folder. 1. Installs the CODA Financials Server 2. Applies License file. 3. Creates the financials LSV for each instance 4. Applies Registry Values for each instance 4.6 Install CODA Framework Run 06.0 Install CODA Framework on Application Server.exe from the CODAAppInstall\bin folder. 1. Installs the CODA Framework Server 2. Copies patch and jar files 3. Creates the framework LSV for each instance 4. Edits the properties file 4.7 Install CODA epay and estatements Run 07.0 Install CODA epay and estatements on Application Server.exe from the CODAAppInstall\bin folder. 1. Installs CODA epay and estatements 2. Copies files to bin folder 3. Creates the addons LSV for each instance 4. Creates folders and copies files 5. Edits properties files 6. Creates share Page 8 of 17

9 Application Server 4.8 Install estatements Configurator Run 08.0 Install CODA estatements Configurator on Application Server.exe from the CODAAppInstall\bin folder. 1. Installs the CODA estatements Configurator on the application server. 2. Copies files to bin directory 3. Install econfigurator LSV for each instance 4. Edit properties file 4.9 Install Customer Statements Server Run 09.0 Customer Statement Instance.exe from the CODAAppInstall\bin folder. 1. Creates an instance of FNJSTATMNT 2. Edits properties files 3. Installs and starts the FNJSTATMNT service associated with the instance. 4. Creates share to output folder 4.10 Install CODA Financials Client Run 10.0 Install CODA Financials Client on Application Server.exe from the CODAAppInstall\bin folder. 1. Installs the CODA Financials Client on the application server. 2. Configures each instance of Financials LSVs Page 9 of 17

10 Application Server 4.11 Install Conversion Scripts Run 11.0 Conversion Backup and Restore Scripts.exe from the CODAAppInstall\bin folder. 1. Intialize CODA conversion backup/restore process 2. Schedules regular cleanup of backups 4.12 Configure Windows Services Run 12.0 Configure Windows Services.exe from the CODAAppInstall\bin folder. 1. Adds dependencies to the Windows Services for Coda Reboot the application server Run 13.0 Reboot.exe from the CODAAppInstall\bin folder. Page 10 of 17

11 Web Server Edit INI file 5 Web Server Edit INI file Before running the CODA Web Install scripts you must first change the values in the setup.ini file to match your environment. In the sample setup.ini file provided there are three environments created, it is possible to install more or less envirenments by changing the LSVs= line. If this line is changed then a corresponding subsection will need to be created/deleted for the scripts to work. The setup.ini file is found in the CodaWebInstall folder that was extracted from the zip file. [Install] Install Drive=E DealerCode=DDD Application Server Name= [Instance] LSVs=DDDPRD,DDDFDC,DDDTRN (Change to match the drive where you want Coda installed) (Make this match your 3 digit dealercode) (The name of the Coda App Server) (Replace DDD with the 3 digit dealercode) [DDDPRD] AS400 System Name= AS400 Library Name=LIBDDD AS400 Database Name=LIBDDD AS400 User Profile=CODASRV AS400 Password=CODACNV50 ServletExec License=xxxxx-xxx-xxxxx ServletExec Memory=768 ServletExec Memory WS=768 NameServerPort=10100 (Replace DDD with the 3 digit dealercode) (Enter the name of your as400) (Enter the as400 library) (Enter the as400 database) (Enter the as400 user for integration) (Enter the password for integration) (Enter the servletexec license key *see note) (Amount of java memory for servletexec) (Amount of java memory for WebServices) (Must match the value entered on the app server) [DDDFDC] (Replace DDD with the 3 digit dealercode) AS400 System Name= (Enter the name of your as400) AS400 Library Name=LIBDDD (Enter the as400 library) AS400 Database Name=LIBDDD (Enter the as400 database) AS400 User Profile=CODASRV (Enter the as400 user for integration) AS400 Password=CODACNV50 (Enter the password for integration) ServletExec License= xxxxx-xxx-xxxxx (Enter the servletexec license key *see note) ServletExec Memory=512 (Amount of java memory for servletexec) ServletExec Memory WS=512 (Amount of java memory for WebServices) NameServerPort=10101 (Must match the value entered on the app server) [DDDTRN] (Replace DDD with the 3 digit dealercode) AS400 System Name= (Enter the name of your as400) AS400 Library Name=LIBDDD (Enter the as400 library) AS400 Database Name=LIBDDD (Enter the as400 database) AS400 User Profile=CODASRV (Enter the as400 user for integration) AS400 Password=CODACNV50 (Enter the password for integration) ServletExec License= xxxxx-xxx-xxxxx (Enter the servletexec license key *see note) ServletExec Memory=128 (Amount of java memory for servletexec) ServletExec Memory WS=64 (Amount of java memory for WebServices) NameServerPort=10102 (Must match the value entered on the app server) *Note: Replace the ServletExec License value with your license key. Page 11 of 17

12 6 Web Server 6.1 Set Permissions and Groups on Install Drive Run 01.0 Set Permissions and Groups.au3 from the CodaWebInstall\bin folder. 1. Removes the Users group from the install drive for security 2. Adds the Administrators group to the install drive 3. Creates Windows groups for granting permissions to shares and databases. 4. Creates scripts directory and adds permissions CODA Installation Guide Web Server 6.2 Install Java Run 02.0 Install Java JRE.au3 from the CodaWebInstall\bin folder. 1. Installs Java v1.4.2_ Install Servlet Exec Run 03.0 Install & Configure ServletExec 4.2.au3 from the CodaWebInstall\bin folder. 1. Installs ServletExec 2. Creates all necessary instances of the ServletExec Runtime Environment. 3. Edits properties file 4. Edits batch start file for java memory settings 5. Set service to start automatically 6. Applies ServletExec hotfixes. 7. Creates the scripts virtual directories in IIS and sets permissions. 8. Check Internet Explorer for enhanced security configuration Page 12 of 17

13 Web Server 6.4 Install CODA Web Run 04.0 Install & Configure CODA Apps.au3 from the CodaWebInstall\bin folder. 1. Installs the Coda software. a. e-framework b. e-finance c. e-pay_e-statements d. e-configurator e. XMLi f. XMLiWebServices 2. Installs all SARs 3. Installs all custom code a. fnjinputxt & customer statements 4. Creates instance folders 5. Edits all configuration files 6. Configures servletexec license 7. Configures servletexec webfolders 8. Creates shared folders 6.5 Reboot the web server Run 05.0 Reboot.exe from the CODAAppInstall\bin folder Page 13 of 17

14 Manual Steps 7 Manual Steps 7.1 Configure AS/400 with Coda Instance Settings After finishing the install of Coda, refer to the DBSi CODA & 3rd Party Software Integrations Operations Guide v1.0.doc document to complete the AS/400 integration configuration. This guide can be accessed from the website. It is located on the Technical / DBSi 5.0 / Release Documentation web page. Use the DAUser account for the data audit configuration screens, and use the dddcoda user for the Coda integration screens. 7.2 Change service settings on Coda Application Server In the services tool on the Application server set all the Framework services other than PRD from automatic to manual. This is so that upon reboot, the Framework service for PRD will automatically start. If all Framework services are set to automatic, they will compete for resources after a restart and will not all start. This may cause PRD to not start and will keep users from using Coda. To start the other Framework services after a reboot, simply enter the services tool and start them one at a time. 7.3 Obtain SSL Certificate An SSL Certificate is required to complete the installation of CODA. CODA uses the SSL certificate to allow secure logons. This certificate typically is purchased from a certificate authority on the Internet. (eg. Verisign, Geotrust, etc.) 1. Generate a Certificate Signing Request (CSR) Select the Internet Information Services Manager within the Administrative Tools menu. Select the computer and web site (host) that you wish to secure. Right mouse-click to select Properties. Select the Directory Security tab. Select Server Certificate under Secure Communications Click Next in the Welcome to the Web Server Certificate Wizard window. Select Create a new certificate, Click Next. Select Prepare the request now, but send it later. At the Name and Security Settings screen, fill in the [friendly] name field for the new certificate. Select bit length. We recommend using 1024-bit length. Do NOT check Select cryptographic services provider (CSP) Click Next. Click Next. When creating a CSR you must follow these conventions. Enter your Distinguished Name Field information. The following characters can not be accepted: < > # $ % ^ * / \ ( )?&. This includes commas. Distinguished Name Explanation Example Field Common Name The fully qualified domain name If you intend to secure the URL Page 14 of 17

15 Organization for your web server. This must be an exact match. The exact legal name of your organization. Do not abbreviate your organization name. Page 15 of 17 then your CSR's common name must be myserver.mydomain.com. Dealer Inc. Organization Unit Section of the organization Sales City or Locality The city where your organization Atlanta is legally located. State or Province The state or province where your Georgia organization is legally located. Can not be abbreviated. Country/Region The two-letter ISO abbreviation for your country. US = United States CODA Installation Guide Manual Steps Enter your Administrator contact information. Enter a path and file name for the CSR. Verify your request and then click Next. At the Completing the Web Server screen, select Finish. DO NOT REMOVE the pending request or the.crt file will not match and your certificate will not install. Select Finish. 2. Submit request for SSL certificate. Some corporations that can create SSL Certificates include, GeoTrust, Verisign, Thawte, Entrust, Baltimore and others. Caterpillar uses GeoTrust. You will have to choose how long to have the SSL certificate valid. Two years is a good starting point. You can renew a certificate before it expires. After you submit the request, and pay for the certificate, you will receive the actual certificate. 3. Install SSL certificate. Select the Internet Information Service Manager within the Administrative Tools menu. Select the web site (host) for which the certificate was made. Right mouse-click and select Properties. Select the Directory Security tab. Select the Server Certificate option. The Welcome to the Web Server Certificate Wizard windows opens. Click OK. Select Process the pending request and install the certificate. Click Next. Browse to the location of the new certificate file at the Process a Pending Request window. The file extension may be.txt or.crt instead of.cer (Hint: search for files of type "all files") After the correct certificate file is selected, click Next. Select Port 443 for SSL. 443 is the default; other ports can be entered. Verify the Certificate Summary to make sure all information is accurate. Click Next. Select Finish. Select Web Site tab at the site s Properties window to edit your SSL Port 443 settings for this web server. Click OK. Test your certificate by connecting to your server. Use the https protocol directive (e.g. server/) to indicate you wish to use secure HTTP. The padlock icon on your Web browser will be displayed in the locked position if you have set up your site properly. 4. Backing up your key pair file Select the Internet Information Service Manager within the Administrative Tools menu. Select the web site (host) for which the certificate was made. Right mouse-click and select Properties. Select the Directory Security tab.

16 Manual Steps Select the Server Certificate option. The Welcome to the Web Server Certificate Wizard windows opens. Click OK. Select Export the current certificate to a.pfx file. Click Next. Select the path and file name. Click Next. Select a password. Click Next. View the certificate contents. Click on Finish. Keep this.pfx file in a safe place (e.g., You will need it if your system crashes!) Page 16 of 17

17 Appendix 8 Appendix 8.1 AutoIt AutoIt is a Windows scripting language that can automate many tasks. The CODA Install scripts are created and compiled with this tool and seek to simplify the install of CODA. For further information check the AutoIt website: Page 17 of 17