Transcript
Express Returns 2.5 SP 6 Installation Guide
Express Returns 2.5 Service Pack 6 Installation Guide
Express Returns 2.5 Installation Guide
Express Returns 2.5 Installation Guide Copyright © Copyright 2009 SAP AG. All rights reserved. SAP Library document classification: PUBLIC No part of this publication may be reproduced or transmitted in any form or for any purpose without the express permission of SAP AG. The information contained herein may be changed without prior notice. Some software products marketed by SAP AG and its distributors contain proprietary software components of other software vendors. Microsoft, Windows, Outlook, and PowerPoint are registered trademarks of Microsoft Corporation. IBM, DB2, DB2 Universal Database, OS/2, Parallel Sysplex, MVS/ESA, S/390, AS/400, OS/390, OS/400, iSeries, pSeries, xSeries, zSeries, z/OS, AFP, Intelligent Miner, WebSphere, Netfinity, Tivoli, and Informix are trademarks or registered trademarks of IBM Corporation in the United States and/or other countries. UNIX, X/Open, OSF/1, and Motif are registered trademarks of the Open Group. Citrix, ICA, Program Neighborhood, MetaFrame, WinFrame, VideoFrame, and MultiWin are trademarks or registered trademarks of Citrix Systems, Inc. HTML, XML, XHTML, and W3C are trademarks or registered trademarks of W3C®, World Wide Web Consortium, Massachusetts Institute of Technology. Java is a registered trademark of Sun Microsystems, Inc. JavaScript is a registered trademark of Sun Microsystems, Inc., used under license for technology invented and implemented by Netscape. MaxDB is a trademark of MySQL AB, Sweden. SAP, R/3, mySAP, mySAP.com, xApps, xApp, SAP NetWeaver, and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and in several other countries all over the world. Transactionware, POS Xpress, Store Manager, and Configurator are all registered trademarks of SAP. All other product and service names mentioned are the trademarks of their respective companies. Data contained in this document serves information purposes only. National product specifications may vary. These materials are subject to change without notice. These materials are provided by SAP AG and its affiliated companies ("SAP Group") for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.
Express Returns 2.5 Installation Guide
SAP - Important Disclaimers SAP Library document classification: PUBLIC This document is for informational purposes only. Its content is subject to change without notice, and SAP does not warrant that it is error-free. SAP MAKES NO WARRANTIES, EXPRESS OR IMPLIED, OR OF MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
Coding Samples Any software coding and/or code lines / strings ("Code") included in this documentation are only examples and are not intended to be used in a productive system environment. The Code is only intended better explain and visualize the syntax and phrasing rules of certain coding. SAP does not warrant the correctness and completeness of the Code given herein, and SAP shall not be liable for errors or damages caused by the usage of the Code, except if such damages were caused by SAP intentionally or grossly negligent.
Internet Hyperlinks The SAP documentation may contain hyperlinks to the Internet. These hyperlinks are intended to serve as a hint where to find supplementary documentation. SAP does not warrant the availability and correctness of such supplementary documentation or the ability to serve for a particular purpose. SAP shall not be liable for any damages caused by the use of such documentation unless such damages have been caused by SAP's gross negligence or willful misconduct.
Accessibility The information contained in the SAP Library documentation represents SAP's current view of accessibility criteria as of the date of publication; it is in no way intended to be a binding guideline on how to ensure accessibility of software products. SAP specifically disclaims any liability with respect to this document and no contractual obligations or commitments are formed either directly or indirectly by this document. This document is for internal use only and may not be circulated or distributed outside your organization without SAP's prior written authorization.
Page iii
Express Returns 2.5 Installation Guide
Table of Contents Introduction ............................................................................................................................................................................. 2 About this Guide ..................................................................................................................................................................... 2 Related Documents ................................................................................................................................................................. 2 System Requirements.............................................................................................................................................................. 2 Hardware Requirements............................................................................................................................................ 2 Software Requirements ............................................................................................................................................. 2 TCP/IP Network ........................................................................................................................................................ 2 POS/Controller........................................................................................................................................................... 3 User Interface (Browser)........................................................................................................................................... 3 Additional Technical Requirements....................................................................................................................................... 3 File Transfer............................................................................................................................................................... 3 Message Information ................................................................................................................................................. 3 Transaction Audit/Tlog Interface ............................................................................................................................. 3 Authorization Rules................................................................................................................................................... 3 The authorization rules may change per business rules and require some additional development. ................... 3 Operations and Functionality Requirements:........................................................................................................... 3 Third Party Software ................................................................................................................................................. 4 Deploying Express Returns .................................................................................................................................................... 4 Overview........................................................................................................................................................................... 4 Part 1: Setup WebSphere 6.0 .................................................................................................................................... 4 Part 2: Installing MS SQL Server 2000/2005.......................................................................................................... 4 Part 2A: Installing MS SQL Server 2000 ................................................................................................................ 4 Part 2B: Installing MS SQL 2005............................................................................................................................. 4 Part 3: Updating XA datasources ............................................................................................................................. 4 Part 4: Importing data to MS SQL Server 2000 / MS SQL 2005........................................................................... 4 Part 5: Creating the Refund datasource.................................................................................................................... 4 Part 6: Creating and configuring JMS destinations................................................................................................. 4 Part 7: Configuring shared libraries for the application server............................................................................... 4 Part 8: Installing the Express Returns application................................................................................................... 4 Part 9: Change of Express Returns Log System...................................................................................................... 4 Part 10: Important note for Express Returns Log System ...................................................................................... 4 Part 11: Starting the Express Returns application ................................................................................................... 4 Testing the Installation……………………………………...…………………………………………………21 Configuring the Common Data Load (CDL)……………………………………………..………………….22
Revised: May 2009
Page 1
Express Returns 2.5 Installation Guide
Introduction About this Guide This document describes how to install or upgrade to version 2.5 SP 6 of the Express Returns application. Note: Procedures for upgrading existing installations will be included in a subsequent version of this document. The procedures in this guide are written based on the assumption that the application will be running on a system that meets or exceeds the Express Returns minimum system requirements. This document also assumes that Microsoft SQLServer 2000 or Microsoft SQL 2005 and IBM WebSphere 6 have been installed. Your project team can assist you with system’s minimum requirements to support your installation. Note: Version numbers for the jar files and drivers noted in the requirements below have been certified with Express Returns 2.5.
Related Documents For additional information about Express Returns, refer to the following companion documents: Express Returns version 2.5 Administration Guide Express Returns version 2.5 User Guide
System Requirements SAP works closely with its customers to establish their storage and other sizing requirements. The following system elements are required to operate Express Returns:
Hardware Requirements Microsoft NT, Windows2000 Server, Windows2003 Server with minimum of 2Ghz CPU, 2GB RAM, and disk space as required to support estimated client specific data requirements.
Software Requirements IBM WebSphere Application Server V 6.0 RP2 IBM WebSphere Application Server V 6.0 Fix Pack 31 IBM Java SDK 1.4.2 Cumulative Fix Pack Microsoft SQLServer2000 Database with Service Pack 4 or Microsoft SQLServer 2005 Database with Service Pack 2 JavaTM 2 Standard Edition (J2SE) v1.4.2
TCP/IP Network A private TCP/IP network is assumed. Application-to-application messages use the TCP/IP sockets API.
Page 2
Revised: May 29, 2009
Express Returns 2.5 Installation Guide
POS/Controller The POS will be able to send application level messages to an IP host and port using IP sockets programming API. The IP address and port must be configurable.
User Interface (Browser) Internet Explorer Netscape
Additional Technical Requirements The following additional systems-related infrastructure is required to support the Express Returns system.
File Transfer The transaction files used by the batch part of refund authorization must be transferred to the server where the loading programs will run (or an available networked drive). The customer usually builds the file transfer scripts (or command files or JCL) with SAP’s assistance.
Message Information The POS system and refund authorization must mutually agree on the message formats and content. Request message to include receipt barcode read indicator POS to send/receive refund request/response POS to action upon receipt POS message may include line item detail information
Transaction Audit/Tlog Interface The refund authorization system interfaces with the Transaction Audit system as part of its reconciliation processing. The Transaction Audit system and its supporting interfaces, for example the transaction reformatter, may require enhancements in order to support the refund processing. The system will also permit an interface with the POS Tlog files.
Authorization Rules The authorization rules may change per business rules and require some additional development.
Operations and Functionality Requirements: The following functional requirements must be provided to support Express Returns: Original receipt information Store card scanned indicator Original receipt scanned indicator Provide secondary identification field
Revised: May 2009
Page 3
Express Returns 2.5 Installation Guide
The POS will be able to handle network unavailable
The POS must have internal time-out logic to handle no response from host The POS must be able to log request/response messages for problem determination.
Third Party Software To support Express Returns, the following third party software, available from the locations listed below, must be acquired: Bouncy Castle (version 1.3.0) called jce-jdk13-126.jar (Clean room JCE and provider) http://www.bouncycastle.org IBM WebSphere Connect JDBC driver JAR files to version 3.7 ftp://ftp.software.ibm.com/software/websphere/info/tools/DataDirect/datadirect.htm#Connect3.7 SQL Server 2000 Driver for JDBC http://www.microsoft.com/downloads/details.aspx?familyid=86212D54-8488-481D-B46BAF29BB18E1E5&displaylang=en SQL Server 2005 Driver for JDBC (version 1.2)
http://www.microsoft.com/downloads/thankyou.aspx?familyId=c47053eb-3b64-4794-950d81e1ec91c1ba&displayLang=en
Deploying Express Returns Overview This procedure is divided into parts that must be completed in sequence as follows: Part 1: Setup WebSphere 6.0 Part 2: Installing MS SQL Server 2000/2005 Part 2A: Installing MS SQL Server 2000 Part 2B: Installing MS SQL 2005 Part 3: Updating XA datasources Part 4: Importing data to MS SQL Server 2000 / MS SQL 2005 Part 5: Creating the Refund datasource Part 6: Creating and configuring JMS destinations Part 7: Configuring shared libraries for the application server Part 8: Installing the Express Returns application Part 9: Change of Express Returns Log System Part 10: Important note for Express Returns Log System Part 11: Starting the Express Returns application
Page 4
Revised: May 29, 2009
Express Returns 2.5 Installation Guide
Part 1: Setting Up IBM’s WebSphere 6.0 You can install this software using default parameters. After installing the application, please install updateinstaller version 6.0.2.3. Once completed you can copy the .pak files for RP2, Fix Pack 31 and IBM Java SDK 1.4.2 Cumulative Fix Pack in \IBM\WebSphere\Appserver\updateinstaller\maintenance directory and run them individually. Part 2: Setting up the directory structure and copying installation files 1. Create the Express Returns directory, i.e., C:\Triversity\ExpressReturns. 2. In the folder created in step 1, extract the contents of the Express Returns build. You must have the following directory structure: Core Manual 3. Copy the following third party jar to the Core\Lib folder created in step 1: jce-jdk13-126.jar (available at: http://www.bouncycastle.org) 4. To install the SQL Server 2000 Driver for JDBC on your system, execute the setup.exe file (available at http://www.microsoft.com/downloads/details.aspx?familyid=86212D54-8488-481D-B46BAF29BB18E1E5&displaylang=en). 5. Once the installation is complete, copy the following jar files to the Core\Lib folder created in step 1. These files should be located in the lib folder of the root folder where the SQL Server driver has been installed. msbase.jar mssqlserver.jar msutil.jar 6. If installing SQL Server 2005 Driver for JDBC on your system, execute and unzip the setup.exe file available at: http://www.microsoft.com/downloads/thankyou.aspx?familyId=c47053eb-3b64-4794-950d81e1ec91c1ba&displayLang=en 7. Once the unzip is completed, copy sqljdbc. jar file to the Core\Lib folder created in step 1. Note: If you have installed SQL 2005, skip step 4 and 5
Part 2: Installing MS SQL Server 2000/2005 Part 2A: Installing MS SQL Server 2000 Use this part of the procedure to install Microsoft SQL Server 2000 with Service Pack 4. 1. If there is an old version of Microsoft SQL Server 2000 on your computer, remove that version along with the SQL Server folder, typically named C:\Program Files\Microsoft SQL Server, and then restart the computer. 2. Obtain SQL Server 2000 Database with Service Pack 4.
Revised: May 2009
Page 5
Express Returns 2.5 Installation Guide
3. To begin the installation setup process, execute the setup.bat file. 4. Complete the installation screens using the default settings, except as follows: a) On the Setup Type dialog, choose Custom. b) On the Services Accounts dialog, under Service Settings, choose Use the Local System account. c) On the Authentication Mode dialog, choose Mixed Mode, and for the password, use admin. d) On the Collation Settings dialog, choose SQL Collations, and then select Binary order, for use with the 850 (Multilingual) Character Set. 5. To extract the SQL Server Service Pack 4 installation files to a temporary directory, execute the SQL2000KB884525-SP4-x86-enu.exe file. 6. In the temporary directory, to perform the upgrade, execute the setup.bat file. 7. Complete the installation screens using the default settings, except in the Setup dialog, check Upgrade Microsoft Search and apply SQL Server 2000 SP4 (required).
Part2B: Installing MS SQL Server 2005 Use this part of the procedure to install Microsoft SQL Server 2005 with Service Pack 2. 1. If there is an old version of Microsoft SQL Server 2000 on your computer, remove that version along with the SQL Server folder, typically named C:\Program Files\Microsoft SQL Server, and then restart the computer. 2. Obtain SQL Server 2005 Database with Service Pack 2. 3. To begin the installation setup process, execute the setup.bat file. 4. Complete the installation screens using the default settings, except as follows: a) On the Setup Type dialog, choose Custom. b) On the Services Accounts dialog, under Service Settings, choose Use the Local System account. c) On the Authentication Mode dialog, choose Mixed Mode, and for the password, use admin. d) On the Collation Settings dialog, choose SQL Collations, and then select Binary order, for use with the 850 (Multilingual) Character Set. 5. To extract the SQL Server Service Pack 2 installation files to a temporary directory, execute the SQLServer2005SP2-KB921896-x86-ENU.exefile. 6. In the temporary directory, to perform the upgrade, execute the setup.bat file. 7. Complete the installation screens using the default settings, except in the Setup dialog, check Upgrade Microsoft Search and apply SQL Server 2005 SP2 (required).
Part 3: Updating XA datasources Use this procedure to support proper jdbc XA transactions when using WebSphere and the built-in jdbc drivers. 1. In a temporary folder, unzip the contents of the ConnectJDBC37-JTA.zip archive file (available at: ftp://ftp.software.ibm.com/software/websphere/info/tools/DataDirect/datadirect.htm#Connect3.7). 2. From the unzipped SQLServer JTA\32-bit subfolder of the temporary folder, copy the sqljdbc.dll file to the C:\Program Files\Microsoft SQL Server\MSSQL\Binn folder. 3. Open SQL Query Analyser, connect to the masterdb database, and copy the content of the 32-bit instjdbc.sql file located in the SQLServer JTA folder and paste it in SQL Query Analyser. 4. Execute the SQL script.
Part 4: Creating Express Returns database in SQL Server 2000/2005 1. Do one of the following:
Page 6
Revised: May 29, 2009
Express Returns 2.5 Installation Guide
If the path to the folder containing the bcp command is defined in the PATH environment variable, proceed to step 7. If this path is not defined in the PATH environment variable, proceed to step 2. 2. From the Windows Start menu, click Settings, Control Panel, and then double-click System. 3. On the Advanced tab, click Environment Variables. 4. In the System Variables section, select Path from the list, and then click Edit. 5. In the Variable Value field, add the path to the BINN directory of the SQL Server folder, i.e., C:\ Progra~1\Microsoft SQL Server\80\Tools\BINN, and then click OK. 6. Click OK, and then to exit the Systems Properties window, click OK again.
Part 4a: SQL Server Database Install Details 7. The automated scripts for installing the ExpressReturns SQL Server database are written for a single instance implementation. If installing in a clustered environment or to an instance other than the initial default instance on a particular machine, follow the instructions below. Installation Steps: Creating the ExpressReturns SQL Server database consists of 5 basic steps: a.) Create the returns database (manually created) b.) Create the returns user (manually created) c.) Create the returns database tables d.) Create the returns database stored procedures e.) Populate the database with initial default data Command batch files are provided for performing each of the above steps and the CreateAll batch file actually just calls each of the individual command files. Should a problem occur with one or more steps, the command files can be run individually. For clustered or multiple-instance environments, it is the first two steps, creating the database and the user, that typically fail. In this event, it is easiest to manually perform these steps, and then run the command files for the remaining 3 steps to install the SQL Server database. The steps outlined below assume a basic understanding of SQL Server Enterprise Manager. Creating the database: Using SQL Server Enterprise Manager, create a database called returndb in the desired instance (if more than one exists). Creating the returns user: Create a returns user login called sa under Security in the instance where the returndb database was just created. Set Authentication to use SQL Server Authentication and set the password to admin. Assign System Administrator as the Server Role and check the returndb database in the Database Access tab. Now that the database and user have been established, the provided command files can be used for the remaining steps.
Revised: May 2009
Page 7
Express Returns 2.5 Installation Guide
8. To install an empty database, from a DOS command prompt, change to the C:\Triversity\ExpressReturns\Core\Database directory, and then enter the following command: CreateAll sa admin serverX . DefaultData Where:
o o o o Note:
sa is the SQL Server user name. Substitute as appropriate. admin is the password for user sa. Substitute as appropriate. serverX is the name of the SQL instance. Substitute as appropriate. (the period) finds SQL build scripts in the current directory DefaultData is the name of the folder containing the default data. If you want to match the User ID and Password values to those used for the Express Returns database login, you can use other values for these fields.
Part 4a: Best Practices a) All data files should reside on dedicated logical drives. No other files should be allowed on those drives. b) The database shouldn’t automatically allocate the additional space during the operational hours. The auto grow option should be set OFF and the maximum available space should be allocated for database from the very beginning. c) tempDB should reside on the fast, separate drive. No other files are allowed on that drive. d) Transaction log files should reside on the fast drives (separate partition). The preferable RAID configuration is RAID 1 or any other RAID with a good fault tolerance and fast writing. e) Tables that are updated and (or) queried frequently are good candidates for partitioning. For example a. Raw_tlog b. Orignal_Item_Tax c. Orignal_LineItems d. Orignal_Tran e. Lowest_Price f. Orignal_Tender g. Orignal_Item_Discount These should be partitioned on date or transaction type or any other criteria, depending on business logic. That should accelerate the return queries and improve the overall performance.
Part 5: Creating the refund datasources Use this part of the procedure to set up an SQL Server datasource. 1. Start the WebSphere server. 2. To log in to the administration console, in a web browser, open the default WebSphere Administration Console URL: http://localhost:9060/ibm/console. The following dialog box appears:
Page 8
Revised: May 29, 2009
Express Returns 2.5 Installation Guide
3. In the User ID field, type a user ID, e.g., Returns, and then click Log in. Note that you can use any ID as the user ID. It is used to track changes and is not a security feature. The administration console appears. 4. From the Servers menu, click Application Servers 5. Click on Server1 6. Click on the Configuration tab
7. On the right under Server Infrastructure expand Java and Process Management 8. Click on Process Definition
Revised: May 2009
Page 9
Express Returns 2.5 Installation Guide
9. On the right under Additional Properties click on Java Virtual Machine 10. Setup Initial Heap Size and Maximum Heap Size according to the chart below Java Heap size by default is only 256 MB. The formula to calculate the correct heap size for the physical server is: The total value of all server JVM heap sizes within the dynamic cluster for a specific node must be less than half of the total RAM of that computer. To determine the maximum heap size setting for a single server instance, use the following equation: total_RAM / 2 / number_of_servers = maximum_heap_size for example, to support three AppServers (you can have more than 1 AppServer in one WebSphere install running on one physical machine) on a machine with 1.5 GB of RAM: 1.5 GB / 2 = 750 MB 750 / 3 = 250 MB The maximum heap size is 250 MB for each server instance. The following table contains some maximum heap size samples. Maximum heap size samples
Page 10
Revised: May 29, 2009
Express Returns 2.5 Installation Guide
WebSphere(R) Virtual Enterprise server total RAM
Number of supported
in GB 1.5 1.5 1.5 2 2 2
servers 1 2 3 1 2 3
Dynamic cluster size in
Approximate maximum heap size
MB Less than 750 Less than 750 Less than 750 Less than 1000 Less than 1000 Less than 1000
in MB 750 375 250 1000 500 333
Increasing the heap size can improve startup. For WebShpere Application server, by increasing heap size, you can reduce the number of garbage collection occurrences with a 10% gain in performance. 11. From Security menu, Click Global Security. 12. Under the Authentication section at the right, expand the JAAS Configuration topic, and click J2cAthentication data, e.g.,
13. Click New, and then under General Properties, complete the following fields: Alias – type MSSQL User ID – type sa Password – type admin Note: If you want to match the User ID and Password values to those used for the Express Returns database login, you can use other values for these fields. 14. Click OK and then from the Resources menu, click JDBC Providers. 15. If WebSphere embedded ConnectJDBC driver for MS SQL Server (XA) does not appear in the list, click New, create a New JDBC provider using the following values, and then click Next, and OK: Database type – type SQL server
Revised: May 2009
Page 11
Express Returns 2.5 Installation Guide
Provider type – type WebSphere embedded ConnectJDBC driver for MS SQL Server Implementation type – type XA datasource 16. Click Next 17. Click OK 18. From the Resources menu, click JDBC Providers, click the link for WebSphere embedded ConnectJDBC driver for MS SQL Server (XA), and then under Additional Properties at the right, click Datasources. 19. Click New, and then complete the fields as follows: Name – type something like MS SQL Server datasource for ER JNDI Name – type jdbc/refundMSDS Component-managed authentication alias – select the authentication alias created above, i.e., {servername}Node01/MSSQL (where {servername} is the name of the server) At this point, the top portion of the General Properties on the Configuration tab should look something like this: Note: All occurrences of ER25SQL2000 in the example below will be replaced with the name of your server.
Page 12
Revised: May 29, 2009
Express Returns 2.5 Installation Guide
20. Complete the remaining General Properties as follows: Database name – type returndb Server Name – type the host name or IP address of the database server being used Revised: 08/01/2009 3:14:39 PM page 10 Port number – type the port number for the database server being used, typically 1433 At this point, the lower portion of the General Properties on the Configuration tab should look something like this: Note: All occurrences of ER25SQL2000 in the example below will be replaced with the name of your server.
Revised: May 2009
Page 13
Express Returns 2.5 Installation Guide
21. Click OK. 22. Click the Save to master configuration link, and then click Save. 23. From the Resources menu, click on JDBC Providers 24. On the right click on WebSphere embedded ConnectJDBC driver for MS SQL Server (XA) 25. From the Additional Properties on the right click on Datasources 26. Click on MS SQL Server datasource for ER 27. On this page under Additional Properties click on Connection pool properties 28. Set Connection timeout to 30 29. Set the Maximum connections to 50 30. Change the Unused timeout to 360
Page 14
Revised: May 29, 2009
Express Returns 2.5 Installation Guide
31. Click on OK 32. Click on Save and then Save again
Part 6: Creating and configuring JMS destinations Due to the length of this procedure, it is split into two sub-parts. Part 6a: Creating JMS destinations 1. From the Service Integration menu, click Buses, then New, and then in the Name field, type the name of the new Bus member, i.e., ERTrickleLoad. The General Properties on the Configuration tab should look like this:
Revised: May 2009
Page 15
Express Returns 2.5 Installation Guide
2. Click OK, click the Save to master configuration link, and then click Save. 3. Click the link for the new Bus member, i.e., ERTrickleLoad, and then under the Topology menu, click Bus members. 4. Click Add, 5. Make sure that the scope is Server, then click Next, and then Finish. 6. Click the Save to master configuration link, and then click Save. 7. Click the link for the new Bus member, i.e., ERTrickleLoad, and then under the Destinations Resources menu, click Destinations. 8. Click New, make sure that Queue is selected, and then click Next. 9. In the Identifier field, type TrickleLoadDestination, and then click Next. 10. Make sure the Bus member created above, i.e., {servername}Node01:server1, is selected (where {servername} is the name of the server), click Next, then Finish, and then save the changes to the master configuration.
Part 6b: Configuring JMS destinations 1. From the Resources menu, expand the JMS Providers entry, and then click Default messaging.
Page 16
Revised: May 29, 2009
Express Returns 2.5 Installation Guide
2. Under Connection Factories in the menu at the right, click JMS connection factory, and then click New. 3. Complete the Administration section of the General Properties as follows: Name – type TrickleLoadQueueFactory JNDI Name – type jms/ERConnect 4. In the Connection section, under Bus Name, make sure the bus created above, i.e., ERTrickleLoad is selected, click OK, and then save the changes to the master configuration. 5. From the Resources menu, expand the JMS Providers entry, and then click Default messaging. 6. Under Destinations in the menu at the right, click JMS queue, and then click New. 7. Complete the Administration section of the General Properties as follows: Name – type TrickleLoadQueue JNDI name – type jms/ERQueue 8. Complete the Connection section of the General Properties as follows: Bus name – select the bus name created above, i.e., ERTrickleLoad Queue name – select the destination created above, i.e., TrickleLoadDestination Delivery mode – select Persistent 9. Click OK, click the Save to master configuration link, and then click Save. 10. From the Resources menu, expand the JMS Providers entry, and then click Default messaging. 11. Under Activation Specifications in the menu at the right, click JMS activation specification, and then click New. 12. Complete the Administration section of the General Properties as follows: Name – type ERActivation JNDI name – type jms/ERActivation 13. Complete the Destination section of the General Properties as follows: Destination JNDI name – select the bus created above, i.e., jms/ERQueue Bus name – select the bus name created above, i.e., ERTrickleLoad For all other fields – use the values provided by default 14. Click OK, click the Save to master configuration link, and then click Save.
Part 7: Configuring shared libraries for the application server 1. In the Admin console of WebSphere, from the Environment menu, click the link for Shared Libraries, and then click New. 2. Click on New and create an entry called TEFLogging, for classpath, type: C:\Triversity\ExpressReturns\Core\lib\tef_logging.jar, and then click OK.
3. Click on New and create an entry called TW-Security, for classpath, type: C:\Triversity\ExpressReturns\Core\lib\tw-security.jar, and then click OK.
Revised: May 2009
Page 17
Express Returns 2.5 Installation Guide
4. Click on New and create an entry called BouncyCastle, for classpath, type: C:\Triversity\ExpressReturns\Core\lib\jce-jdk13-126.jar, and then click OK. 5. Click on New and create an entry called SecurityKeys, for classpath, type: C:\Triversity\ExpressReturns\Core\lib\crypto.jar, and then click OK 6. Click on New and create an entry called CDL, for classpath, type: C:\Triversity\ExpressReturns\Core\lib\cdl.jar, and then click OK. 7. Click on New and create an entry called TLogParser, for classpath, type: C:\Triversity\ExpressReturns\Core\lib\TLogParser.jar, and then click OK. 8. To save the configuration, click the Save link, and then click Save.
Part 8: Installing the Express Returns application 1. In the menu panel at the left, click the beside the Applications menu, then click Install New Application. The following window appears:
2. On the right side of the screen, ensure Local file system is selected and click browse to open the ExpressReturns.ear file located in the C:\Triversity\ExpressReturns\Core\lib directory. Then Click Next. The following window appears:
Page 18
Revised: May 29, 2009
Express Returns 2.5 Installation Guide
3. Make sure Generate Default Bindings is checked, and then click Next. The following window appears:
Revised: May 2009
Page 19
Express Returns 2.5 Installation Guide
4. Make sure that the checkbox for Pre-compile JSP is checked, the checkbox for Create MBeans for resources is unchecked, and the remaining values are set to their defaults, and then click Next. The following window appears:
Page 20
Revised: May 29, 2009
Express Returns 2.5 Installation Guide
5. Note: All occurrences of ER25SQL2000Node01 in the example below will be replaced with the name of your server. For AuthEngineEJB, ERTrickleLoad and ExpressReturnsWeb modules, check the Select checkboxes, click on Apply and then click Next The following window appears:
Revised: May 2009
Page 21
Express Returns 2.5 Installation Guide
6. Check the Select checkbox for ERTrickleLoad. Scroll over to the right hand side of the screen and select Activation Specification. Default data appears in the field immediately under JNDI name. Erase the data, and type jms/ERActivation. Below Destination JNDI Name type jms/ERQueue, and then click Next. 7. The Provide JNDI Names for Beans window appears. Click Next. The following window appears:
8. Validate the JNDI name is ejb/ERTrickleLoad. Click Next. The following window appears:
Page 22
Revised: May 29, 2009
Express Returns 2.5 Installation Guide
Revised: May 2009
Page 23
Express Returns 2.5 Installation Guide
9. Check all three, AuthEngineEJB, ERTrickleLoad and ExpressReturnsWeb 10. Under javax.sql.DataSource choose jdbc/refundMSDS for javax.sql.DataSource and click Apply 11. Check all three, AuthEngineEJB, ERTrickleLoad and ExpressReturnsWeb 12. Choose servernameNode1/MSSQL for Specify authentication method and click Apply and then Next
Page 24
Revised: May 29, 2009
Express Returns 2.5 Installation Guide
13. Make sure that default_host is selected for ExpressReturnsWeb and the click Next. 14. On the next screen make sure that the Uncheck radio button is selected and then click Next and then click Finish. 15. Click the Save to master configuration link, and then click Save. 16. Under Applications menu, click on Enterprise Applications. 17. On the right side of the screen, click ExpressReturns. 18. Scroll down, and under Additional Properties on the right hand side, click the link for Libraries, and then click Add. The following window appears:
Revised: May 2009
Page 25
Express Returns 2.5 Installation Guide
19. Under Library name, from the drop down list: a) Select Security Keys, and then click Apply. Click Save and then click Save. b) Click Add and then select TEFLogging, and then click Apply. Click Save and then click Save. c) Click Add and then select TW-Security, and then click Apply. Click Save and then click Save. d) Click Add, select BouncyCastle, and then click Apply. Click Save and then click Save. e) Click Add, select CDL, and then click Apply. Click Save and then click Save. f) Click Add, select TLogParser, and then click Apply. Click Save and then click Save.
Part 9: Change of ER Log system ER Log system has been switched to TEF_LOGGING (JDK Logger internally). The following steps need to be done to make the logging system work properly. The following steps must be done after ExpressReturn is installed but before it is started. From the Admin console of Websphere, from the Servers menu, click Application Servers.
Click the link for {servername}. Under the Server Infrastructure menu on the right, expand Java and Process Management and choose Process Definition.
Page 26
Revised: May 29, 2009
Express Returns 2.5 Installation Guide
From the Additional Properties menu on the right, choose Java Virtual Machine.
From the Additional Properties menu on the right, choose Custom Properties.
1. Click New 2. For Name, type logging.configuration 3. For Value, type C:\Triversity\ExpressReturns\Core\lib\authlogging.properties 4. Click OK 5. Click New 6. For Name, type loggingExt.configuration 7. For Value, type C:\Triversity\ExpressReturns\Core\lib\authloggingExt.properties 8. Click OK
Revised: May 2009
Page 27
Express Returns 2.5 Installation Guide
9. Click the Save button and then click Save again.
Part 10: Important note for ER Log system Logging system configurations are now located under File Systems. Logging level could be changed by updating configurations. However, application needs to be restarted to effect log configuration change. The following two configurations are for authEngine and TrickleLoad authLogging.properties authLoggingExt.properties. Both files are under \ExpressReturns\Core\Lib By default, log file is under \ExpressReturns\Core\Logs\engine.log.
Part 11: Starting the Express Returns application 1. From the Applications menu, click Enterprise Applications. The Enterprise Applications window appears, as shown below:
2. If the Status arrow beside ExpressReturns is not green, to start the application, click the Select checkbox, and then click Start.
Testing the Installation Use this procedure to determine whether or not the installation was installed correctly. To log in to the Express Returns web application: 1. Using SQL Server Enterprise Manager connect to returndb. 2. Open USERSECURITY table
Page 28
Revised: May 29, 2009
Express Returns 2.5 Installation Guide
3. Modify the date with today’s date in ADDDATE, CHANGEDATE, PWDCHANGED and ACTIVEDATE columns for admin 4. Change the ENABLED field to Y 5. In the address bar of a web browser, enter: http://localhost:9080/ExpressReturnsWeb/RefundLogin.jsp. The Express Returns Login window will appear.
6. In the User Name field, type admin, in the Password field, type abcdef1, and then click Login. If the Express Returns home page appears, the installation was successful and the application is connecting to the database. If the Express Returns home page does not appear, there may be an issue with the XA datasource configuration. Follow the procedures below, and then try logging in to Express Returns again as described above. To set support for XA transactions: 1. From the Windows Start menu, click Settings, and then Control Panel.
2.
Double-click Administrative Tools, and then Component Services.
3.
To locate the computer, e.g., My Computer, in the Tree panel, expand Console Root, Component Services, and then Computers.
4.
Right-click the computer name, and then click Properties.
5.
Click the MSDTC tab, and then click Security Configuration.
6.
Under Security Settings, check the XA Transactions option.
7.
Click OK, and then click YES.
MS DTC service has been restarted.
To create a registry named-value: 1. Use your registry editor and navigate to registry key named: HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\MSDTC\XADLL 2. Create a new registry named-value using the following information: Name - sqljdbc.dll Type - String (REG_SZ) Value - The full path name, including the file name, of the DLL file Name Type Value sqljdbc.dll String (REG_SZ) SQL 2000 server is installed the path is c:\Program Files\Microsoft SQL Server\MSSQL\Binn\sqljdbc.dll If SQL 2005 server is installed the patch is c:\Program Files\Microsoft SQL Server\MSSQL.1\ MSSQL\Binn\sqljdbc.dll
Revised: May 2009
Page 29
Express Returns 2.5 Installation Guide
3. Click OK.
Configuring the Common Data Load (CDL) The CDL is a single code base that manages the entire data loading process, from receiving raw data in a nonstandard format, to loading into the Express Returns application. In order to run the CDL component, you must first configure the following files to reflect your system’s settings: CDL.properties – defines tasks and specifies how they are executed Core2-5.xml – describes the xml file structure of STIFF files pipeline.bat – launches the CDL process setERprops.cmd – contains information specific to your installation of Express Returns Note:
If you have set up the directory structure according to the installation guide, very few additional changes to the configuration should be required. To configure files for CDL:
1. For the CDL.properties file, verify that: a) The various paths are configured properly, and b) The JDBC connection information is configured properly. The information must match the User ID and Password values used in the Express Returns database. 2. For the Core2-5.xml file, ensure that the output folder is pointing to the default path, i.e., C:\Triversity\ExpressReturns\Core\DataLoad\output. If not, modify the path accordingly. 3. For the pipeline.bat file, verify that the specified paths are correct. 4. For the setERprops.cmd file, ensure the paths and the database information are correct. The information defined here must match the User ID and Password values used in the Express Returns database.
Page 30
Revised: May 29, 2009
