TIBCO Foresight™ Transaction Insight® How to Install an External Note Web Service Software Release 4.2.0 July 2012 two-second advantage™ Important Information SOME TIBCO SOFTWARE EMBEDS OR BUNDLES OTHER TIBCO SOFTWARE. USE OF SUCH EMBEDDED OR BUNDLED TIBCO SOFTWARE IS SOLELY TO ENABLE THE FUNCTIONALITY (OR PROVIDE LIMITED ADD-ON FUNCTIONALITY) OF THE LICENSED TIBCO SOFTWARE. THE EMBEDDED OR BUNDLED SOFTWARE IS NOT LICENSED TO BE USED OR ACCESSED BY ANY OTHER TIBCO SOFTWARE OR FOR ANY OTHER PURPOSE. USE OF TIBCO SOFTWARE AND THIS DOCUMENT IS SUBJECT TO THE TERMS AND CONDITIONS OF A LICENSE AGREEMENT FOUND IN EITHER A SEPARATELY EXECUTED SOFTWARE LICENSE AGREEMENT, OR, IF THERE IS NO SUCH SEPARATE AGREEMENT, THE CLICKWRAP END USER LICENSE AGREEMENT WHICH IS DISPLAYED DURING DOWNLOAD OR INSTALLATION OF THE SOFTWARE (AND WHICH IS DUPLICATED IN LICENSE.PDF) OR IF THERE IS NO SUCH SOFTWARE LICENSE AGREEMENT OR CLICKWRAP END USER LICENSE AGREEMENT, THE LICENSE(S) LOCATED IN THE “LICENSE” FILE(S) OF THE SOFTWARE. USE OF THIS DOCUMENT IS SUBJECT TO THOSE TERMS AND CONDITIONS, AND YOUR USE HEREOF SHALL CONSTITUTE ACCEPTANCE OF AND AN AGREEMENT TO BE BOUND BY THE SAME. This document contains confidential information that is subject to U.S. and international copyright laws and treaties. No part of this document may be reproduced in any form without the written authorization of TIBCO Software Inc. TIB, TIBCO, TIBCO Adapter, Predictive Business, Information Bus, The Power of Now, TIBCO ActiveMatrix BusinessWorks, TIBCO Foresight™ Instream®, TIBCO Foresight™ Studio, and TIBCO Foresight™ Transaction Insight® are either registered trademarks or trademarks of TIBCO Software Inc. in the United States and/or other countries. EJB, Java EE, J2EE, and all Java-based trademarks and logos are trademarks or registered trademarks of Sun Microsystems, Inc. in the U.S. and other countries. All other product and company names and marks mentioned in this document are the property of their respective owners and are mentioned for identification purposes only. THIS SOFTWARE MAY BE AVAILABLE ON MULTIPLE OPERATING SYSTEMS. HOWEVER, NOT ALL OPERATING SYSTEM PLATFORMS FOR A SPECIFIC SOFTWARE VERSION ARE RELEASED AT THE SAME TIME. SEE THE README.TXT FILE FOR THE AVAILABILITY OF THIS SOFTWARE VERSION ON A SPECIFIC OPERATING SYSTEM PLATFORM. THIS DOCUMENT IS PROVIDED “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NONINFRINGEMENT. THIS DOCUMENT COULD INCLUDE TECHNICAL INACCURACIES OR TYPOGRAPHICAL ERRORS. CHANGES ARE PERIODICALLY ADDED TO THE INFORMATION HEREIN; THESE CHANGES WILL BE INCORPORATED IN NEW EDITIONS OF THIS DOCUMENT. TIBCO SOFTWARE INC. MAY MAKE IMPROVEMENTS AND/OR CHANGES IN THE PRODUCT(S) AND/OR THE PROGRAM(S) DESCRIBED IN THIS DOCUMENT AT ANY TIME. THE CONTENTS OF THIS DOCUMENT MAY BE MODIFIED AND/OR QUALIFIED, DIRECTLY OR INDIRECTLY, BY OTHER DOCUMENTATION WHICH ACCOMPANIES THIS SOFTWARE, INCLUDING BUT NOT LIMITED TO ANY RELEASE NOTES AND "READ ME" FILES. Please see Licensing_Foresight_Products.pdf for licensing details. Copyright © 1999-2012 TIBCO Software Inc. ALL RIGHTS RESERVED. TIBCO Software Inc. Confidential Information Contents Preconditions ............................................................................................................................................. 5 Steps.......................................................................................................................................................... 5 Contact Information ................................................................................................................................... 8 Document External Note Web Service Deployment Follow these steps if you plan to add your own external identifiers to your TI documents. Please see External_Identifiers.pdf for more information. Preconditions TI Database Glassfish installed Foresight Service installed and running GlassFish Steps <GLASSFISH_ROOT> refers to the root folder where Glassfish is installed. Example: C:\glassfishv3 1. Go to a command window. 2. Extract the contents of DocumentExternalNoteWS<version>.zip to Transaction Insight's <version>\WebServices directory. If this folder does not exist, create it. Example: > cd C:\Foresight\TransactionInsight\4.2.0 > mkdir WebServices > cd WebServices > mkdir logs > "<GLASSFISH_ROOT>\bin\asadmin.bat" --user "admin" --passwordfile "C:\Foresight\TransactionInsight\4.2.0\WebServices\doc\pwd.txt" -I false deploy --force=true "C:\Foresight\TransactionInsight\4.2.0\WebServices \DocumentExternalNote.war" 3. Copy the jar file as follows:  If doing an Oracle installation: (If you have not installed Oracle yet, please refer Appendix F in System_requirements.pdf) > copy "<path to Oracle Install>\ojdbc6.jar" "<GLASSFISH_ROOT>\glassfish\domains\domain1\lib"  If doing a SQL SERVER Installation: > copy "C:\Foresight\TransactionInsight\4.2.0\ WebServices\lib\ sqljdbc4.jar" "<GLASSFISH_ROOT>\ glassfish\domains\ domain1\lib" Archive and Retrieval System 5 8/1/2012 Set up DocumentExternalNote Web Service Connection Pool 1. Restarting Glassfish: a. Stop Foresight Service from Services MMC. b. Stop Glassfish Java process c. Start Foresight Service from Services MMC. d. Start the Glassfish console in browser (http://localhost:4848) and login as admin. 2. Using the Glassfish admin console: a. click Enterprise Server | System Properties b. define the system property com.tibco.foresight.DocumentExternalNote.logfile as TI's <version>\WebServices\logs\DocumentExternalNote.txt. Example: C:\Foresight\TransactionInsight\4.2.0\WebServices\logs\DocumentExternalNote.txt 3. Using the Glassfish admin console, create a connection pool. You will need to know the name of the DB server, the database name, the port, the user name, and the password. You can find this information in TI's Web.config file, which is in the TI environment's \TIWeb directory. Example: C:\TIBCO64\TransactionInsight\4.2.0\Environments\TIDemo\TIWeb\Web.config Look at the property DB:TransactionInsight for this information. a. From the Glassfish console, click JDBC | Connection Pools | New b. Under General Settings, set these parameters: Name: TransactionInsight_<dbType> Resource Type: javax.sql.DataSource Database Vendor: <dbType> Example: Name: TIdemoDB Resource Type: javax.sql.DataSource Database Vendor: MicrosoftSqlServer c. Click Next and scroll down to Additional Properties and set these properties. DatabaseName: <your TransactionInsight database name> Description: TI Database Password: <password> ServerName: <serverName> User: <username> Archive and Retrieval System 6 8/1/2012 Example: DatabaseName: TIDemoDB Description: TI Database Password: tidemopwd ServerName: BIGHP User: tidemouser d. Click Add Property. Name: URL FOR SQLSERVER Value: jdbc:sqlserver://<serverName>:<port>;databaseName= <dbName>;user=<user>;password=<pass>; FOR ORACLE: Value: jdbc:oracle:thin:<user>/<pass>@//<serverName>:<port>/<sid> e. Click Finish. f. From the list of connection pools that is displayed, select TransactionInsight_<dbType>. g. Click the PING button to verify the connection. You should see "Ping Succeeded." 4. Using the Glassfish admin console, create a JDBC Resource named jdbc/TransactionInsightDB and point it at the newly created connection pool: a. Click JDBC --> JDBC Resources --> New b. Set these parameters: JNDI Name: jdbc/TransactionInsightDB Pool Name: select TransactionInsight_<dbType> from the list. Description: JDBC Resource for TI Database. Click OK. Archive and Retrieval System 7 8/1/2012 Contact Information TIBCO Software Inc., Foresight Group 655 Metro Place South Suite 900 Dublin OH 43017 Phone: (614) 791-1600 Fax: (614) 791-1609 Web: http://foresight.TIBCO.com Support E-mail: [email protected] Archive and Retrieval System 8 8/1/2012