TIBCO EMS Transport Channel for WCF Installation. Software Release 1.1 December 2008

Transcription

1 TIBCO EMS Transport Channel for WCF Installation Software Release 1.1 December 2008

2 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 ActiveEnterprise, TIBCO Hawk, TIBCO Rendezvous, TIBCO Enterprise, TIBCO Enterprise Message Service, TIBCO SmartSockets and the TIBCO logo 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. PLEASE 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 NON-INFRINGEMENT. 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. Copyright 2008 TIBCO Software Inc. ALL RIGHTS RESERVED. TIBCO Software Inc. Confidential Information

3 iii Contents Preface v Related Documentation vi TIBCO EMS Transport Channel for WCF Documentation vi Other TIBCO Product Documentation vi How to Contact TIBCO Support vii Chapter 1 Installation Overview Introduction Installation Requirements Supported Platforms TIBCO_HOME Microsoft.NET Framework Internet Information Services 7.0 / WAS Installer Log File Samples Post-Installation Requirements Installation Modes GUI Mode Console Mode Silent Mode Chapter 2 Installation Procedure Installing TIBCO EMS Transport Channel for WCF Install in GUI Mode Install in Console Mode Install in Silent Mode Chapter 3 Uninstalling Uninstalling the Software

4 iv Contents

5 v Preface This document describes how to install the TIBCO EMS Transport Channel for WCF, which allows you to use TIBCO Enterprise Message Service (EMS) as a transport channel for Windows Communication Foundation (WCF) services. Topics Related Documentation, page vi How to Contact TIBCO Support, page vii

6 vi Related Documentation Related Documentation This section lists documentation resources you may find useful. TIBCO EMS Transport Channel for WCF Documentation The following documents form the TIBCO EMS Transport Channel for WCF documentation set: TIBCO EMS Transport Channel for WCF Installation - Read this manual for instructions on site preparation and installation. TIBCO EMS Transport Channel for WCF User s Guide - Read this manual for instructions on using this product. TIBCO EMS Transport Channel for WCF Release Notes - Read the release notes for a list of new and changed features. This document also contains lists of known issues and closed issues for each release. Other TIBCO Product Documentation You may find it useful to read the documentation for the following TIBCO products: TIBCO Enterprise Message Service User s Guide - This guide provides an overall description of the features and configuration of TIBCO Enterprise Message Service. TIBCO Enterprise Message Service.NET Reference - This guide provides reference information about the TIBCO Enterprise Message Service.NET API.

7 Preface vii How to Contact TIBCO Support For comments or problems with this manual or the software it addresses, please contact TIBCO Support as follows. For an overview of TIBCO Support, and information about getting started with TIBCO Support, visit this site: If you already have a valid maintenance or support contract, visit this site: Entry to this site requires a user name and password. If you do not have a user name, you can request one.

8 viii How to Contact TIBCO Support

9 1 Chapter 1 Installation Overview This chapter presents an overview of the installation process. Topics Introduction, page 2 Samples, page 5 Post-Installation Requirements, page 6 Installation Modes, page 7

10 2 Chapter 1 Installation Overview Introduction The TIBCO EMS Transport Channel for WCF installer uses the TIBCO Universal Installer. It allows you to install the following product features: TEMS Transport Channel - This provides the software needed to use TIBCO Enterprise Message Service (EMS) as a transport channel for Windows Communication Foundation (WCF) services. When this feature is installed, the TIBCO.EMS.WCF.dll file is installed in the specified directory. It is also registered in the Global Assembly Cache (GAC) by the installer. TEMS Protocol Activator - This provides the software needed to use Windows Activation Service (WAS) to manage the activation and lifetime of the worker processes that contain applications that host WCF services that use TEMS transport channel. Note that this feature is actually listed as "WAS Activation" on the installation Product Features screen. When this feature is installed, the installer adds a new Windows service named NetTemsActivator.exe. This service contains the components needed to host a WCF service in WAS when using the TemsTransport protocol. After installing the TEMS Protocol Adapter, you can confirm that the service is installed by using the Microsoft Management Console for Services (available through Start > Programs > Administrative Tools > Services). It is listed as: Net.Tems Listener Adapter The installer also updates a number of configuration files to add support for the TemsTransport protocol to WAS. For details about the configuration settings the installer performs, see the TEMS Protocol Activator Configuration During Installation section in the TIBCO EMS Transport Channel for WCF User s Guide. Also, in order to comply with the "Works with Windows 2008" standards from Microsoft, NetTemsActivator.exe is copied to the %SystemRoot% directory (which defaults to \Windows) during the installation. For information about configuring and using each of these features, see the TIBCO EMS Transport Channel for WCF User s Guide.

11 Installation Requirements 3 Installation Requirements Before starting the installation procedure, review the topics in this section to determine that your system meets the basic requirements and that you have the prerequisite software installed. Supported Platforms The TIBCO EMS Transport Channel for WCF is supported on the following platforms: Microsoft Windows XP Microsoft Windows Server 2003 Microsoft Windows Server 2008 Microsoft Vista, SP1 Note that if you going to use Windows Activation Service (WAS) to manage your WCF services, you must be using either Microsoft Vista SP1 or Windows Server 2008, as WAS is available only in IIS 7.0, which is available in those operating systems. Also, at this time, TIBCO EMS Transport Channel for WCF must be run in 32-bit mode. (Note that you can run on a 64-bit platform, but it must be run in 32-bit compatibility mode.) TIBCO_HOME The TIBCO Universal Installer installs into a destination directory called TIBCO_HOME, which is defined by previous invocations of the Universal Installer. That is, if you already installed another product using the TIBCO Universal Installer, the destination root directory for that product becomes the destination root for all subsequent products that are installed using the Universal Installer. If you are installing for the first time using the Universal Installer, you can specify TIBCO_HOME. Subsequent product will be installed in the same installation directory. Microsoft.NET Framework The TIBCO EMS Transport Channel for WCF installer will install the Microsoft.NET Framework 3.0 Redistributable Package if it is not already installed on your system.

12 4 Chapter 1 Installation Overview Note, however, if you are going to use Windows Activation Service (WAS) to host your WCF service, and you are going to use multiple site bindings in WAS, you must have Microsoft.NET Framework 3.5 installed. The installer, however, will not install.net Framework 3.5. You must install it manually either before or after you install TIBCO EMS Transport Channel for WCF. (If you have it installed prior to installing TIBCO EMS Transport Channel for WCF, the installer will not install version 3.0 over the top of 3.5.) Microsoft.NET Framework 3.5 can be downloaded from the following web site: e35-b d977d32a6&displaylang=en Internet Information Services 7.0 / WAS If you are going to install the TEMS Protocol Activator feature (i.e., you are going to host your WCF service in WAS), you must install certain features of Microsoft Internet Information Services (IIS) version 7.0 and Windows Activation Service (WAS) before installing the TEMS Protocol Activator. (IIS 7.0 is currently only available on Windows Server 2008 and Microsoft Vista.) After you ve installed the TEMS Protocol Activator, you must perform additional steps to set up WAS before hosting your service. For information about installing the required IIS 7.0 features and WAS, as well as other tasks required to host your service in WAS, see the Setting Up a WAS Hosting Environment section in the TIBCO EMS Transport Channel for WCF User s Guide. Installer Log File The installer writes its log file to the User_Home/.TIBCO directory. For example: C:\Documents and Settings\user-name\.TIBCO

13 Samples 5 Samples During the installation of TIBCO EMS Transport Channel for WCF, a "Samples" solution is automatically installed. The Sample solution is a Microsoft Visual Studio 2008 solution containing sample code. It is installed in the following location: TIBCO_HOME\ems_wcf\n.n\samples\Tems where TIBCO_HOME is the directory in which the TIBCO Universal Installer installs all TIBCO products, and n.n is the version number of TIBCO EMS Transport Channel for WCF. For information about the projects provided in the Sample solution, see the Introduction chapter in the TIBCO EMS Transport Channel for WCF User s Guide.

14 6 Chapter 1 Installation Overview Post-Installation Requirements The following describes software that is required to use TIBCO EMS Transport Channel for WCF. This software can be installed either before or after you ve installed TIBCO EMS Transport Channel for WCF. TIBCO Enterprise Message Service version or newer This software must be installed on both production and development machines. Note, however, the only feature of EMS required by TIBCO EMS Transport Channel for WCF is the C# Client. The C# Client must also be installed in the Windows Global Assembly Cache (GAC). The way in which you install the C# Client and install it in the GAC depends on the version of EMS you are using, as follows: EMS version If you are using this version of EMS, you can perform a "Custom" installation of EMS, and select the C# Client from the list of features that can be installed. (Performing a "Typical" installation will also install the C# Client.) After installing the C# Client, you must install the C# Client s DLL (TIBCO.EMS.dll) in the GAC. This can be done either by using the Windows Global Assembly Cache Utility (gacutil) see the link below for more information about the GAC. Or you can drag and drop the TIBCO.EMS.dll file from the EMSInstallDir\clients\cs folder to the C:\WINDOWS\assembly folder. The assembly folder is a special folder where the.net Framework stores assemblies for the GAC. (Note you must drag and drop the file into the assembly folder you cannot copy it.) EMS version 5.x - If you are using this version of EMS, the only requirement is that you install the "runtime" version, which automatically installs the C# Client s DLL (TIBCO.EMS.dll) in the GAC. For additional information about the GAC, see: Microsoft Visual Studio 2008 (Version 9) This software is needed only on machines on which you are performing development functions. Visual Studio is used to set up and configure the TIBCO EMS Transport Channel for WCF product. Note that Microsoft Visual Studio 2005 is not supported at this time.

15 Installation Modes 7 Installation Modes The TIBCO Universal Installer allows you to run in different modes. GUI Mode Console Mode Silent mode GUI Mode In GUI mode, the installer presents dialogs that allow you to make choices about product selection, product location, and so on. GUI mode is the installer's default mode. For more information about installing in this mode, see Install in GUI Mode on page 10. Console Mode Console mode allows you to run the installer from the command line. This is useful if your machine does not have a window environment. For more information about installing in this mode, see Install in Console Mode on page 14. Silent Mode Silent mode either installs using the default settings or uses a response file that contains properties you can set for your installation. Silent mode installs without prompting you for information. The TIBCOUniversalInstaller.silent response file is packaged in the directory that contains the universal installer. You must edit the file with information for your environment before launching the silent installation. The file includes comments that describe the installation properties you can set. For more information about installing in this mode, see Install in Silent Mode on page 14.

16 8 Chapter 1 Installation Overview

17 9 Chapter 2 Installation Procedure This chapter describes installing the TIBCO EMS Transport Channel for WCF product. Topics Installing TIBCO EMS Transport Channel for WCF, page 10

18 10 Chapter 2 Installation Procedure Installing TIBCO EMS Transport Channel for WCF You can install TIBCO EMS Transport Channel for WCF using one of the following modes: Install in GUI Mode on page 10 Install in Console Mode on page 14 Install in Silent Mode on page 14 The TIBCO Universal Installer installs the TIBCO EMS Transport Channel for WCF DLL (TIBCO.EMS.WCF.dll) in the Global Assembly Cache (GAC). An existing DLL from a previous version of TIBCO EMS Transport Channel for WCF will be overwritten. Install in GUI Mode The following procedure explains how to install TIBCO EMS Transport Channel for WCF in GUI mode. 1. Open the physical media or download the TIBCO EMS Transport Channel for WCF product package. 2. Extract the TIBCO EMS Transport Channel for WCF product archive file to a temporary directory. 3. Navigate to the temporary directory that contains the universal installer. 4. Run TIBCOUniversalInstaller.exe. The Welcome screen is displayed. 5. Click Next. The TIBCO Software Inc. End User License Agreement is displayed. 6. Read the license agreement, and respond by clicking in the I accept... radio button to accept the agreement, or in the I do not accept... radio button to cancel the installation, then click Next.

19 Installing TIBCO EMS Transport Channel for WCF 11 The following screen is displayed: Note that if this is the first TIBCO software that has been installed on this system, the fields on this dialog will be blank (except for the Path field, which will contain a default value of "C:\tibco"). The TIBCO Universal Installer allows you to install TIBCO software in multiple environments, which basically establishes multiple base directories under which TIBCO software can be installed. Typically, TIBCO software is installed in the TIBCO_HOME environment, which defaults to C:\tibco. By default, the TIBCO EMS Transport Channel for WCF product is installed in the following subdirectory: EnvironmentDir\ems_wcf\Version where EnvironmentDir is the directory specified in the Path field, and Version is the version number of the software you are installing. 7. Select or specify the desired environment, then click Next.

20 12 Chapter 2 Installation Procedure The Installation Type dialog is displayed. The installation types available are: Typical - This installs all available features in the product set. Custom - This allows you to choose which available features you would like installed. 8. Choose either Typical or Custom, them click Next. If you chose "Typical", proceed to step 11. If you chose "Custom", the following screen is displayed: 9. Select the product features you would like installed, then click Next.

21 Installing TIBCO EMS Transport Channel for WCF 13 For information about the available features, see Introduction on page 2. The Pre Install Summary dialog is displayed. 10. Review the information on the Pre Install Summary dialog, then click Install. When the installer is finished, a dialog is displayed that reminds you that the VC8-compiled TIBCO EMS C# Client must be installed on the system, as well as in the GAC, before TIBCO EMS Transport Channel for WCF can be used. For more information about this requirement, see Post-Installation Requirements on page Click Next. The Post Install Summary dialog is displayed. 12. Click Finish to close the installer.

22 14 Chapter 2 Installation Procedure Install in Console Mode The following procedure explains how to install TIBCO EMS Transport Channel for WCF in console mode. 1. Open the physical media or download the TIBCO EMS Transport Channel for WCF product package. 2. Extract the TIBCO EMS Transport Channel for WCF product archive file to a temporary directory. 3. Using a console window, navigate to the temporary directory that contains the universal installer. 4. Run the installer using this command line: TIBCOUniversalInstaller -console 5. Complete the installation by responding to the console window prompts. Install in Silent Mode The following procedure explains how to install TIBCO EMS Transport Channel for WCF in silent mode. The TIBCOUniversalInstaller.silent file is packaged in the directory that contains the universal installer. You must edit the file with information for your environment before launching the silent installation. The file includes comments that describe the installation properties you can set. While you can use the TIBCOUniversalInstaller.silent file, it s good practice to copy the file to a different name and edit that file for the silent mode. If errors occur during installation, they will be listed in the installation log file (see the User_Home/.TIBCO directory). 1. Open the physical media or download the TIBCO EMS Transport Channel for WCF product package. 2. Extract the TIBCO EMS Transport Channel for WCF product archive file to a temporary directory. 3. Navigate to the temporary directory that contains the universal installer and copy the TIBCOUniversalInstaller.silent file and rename the file. 4. Using a text editor, open the copied file and update the installation location. 5. Run the installer using this command line: TIBCOUniversalInstaller -silent -V -responsefile=<responsefilename>

23 Installing TIBCO EMS Transport Channel for WCF 15 where <responsefilename> is the name you have given the response file in step 3. If you are using the TIBCOUniversalInstaller.silent file (rather than a copy), and have not renamed it, you need not supply the file name and can use this command line: TIBCOUniversalInstaller -silent

24 16 Chapter 2 Installation Procedure

25 17 Chapter 3 Uninstalling This chapter describes uninstalling the TIBCO EMS Transport Channel for WCF product. Topics Uninstalling the Software, page 18

26 18 Chapter 3 Uninstalling Uninstalling the Software Use the following procedure to uninstall TIBCO EMS Transport Channel for WCF. 1. Run the uninstaller. This can be done in the following ways: Navigate to TIBCO_HOME\_uninstall and run the universal_uninstall executable, from the Start button, select Programs > TIBCO > TIBCO EMS Transport Channel for WCF > Uninstall, or from the Control Panel, select Add or Remove Programs, then select TIBCO Universal Installer, then click Change/Remove. The Uninstall Welcome screen is displayed. There is also an entry on the Add or Remove Programs dialog entitled "TIBCO EMS Transport Channel for WCF GAC Assembly Registration". This entry is used to remove the TIBCO.EMS.WCF.dll from the Global Assembly Cache (GAC). It does not remove the TIBCO EMS Transport Channel for WCF product from your system. The GAC Assembly Registration uninstaller is automatically run when you uninstall the TIBCO EMS Transport Channel for WCF product you should not run it separately. 2. Click Next. 3. To uninstall only TIBCO EMS Transport Channel for WCF, click Custom Uninstall. To uninstall all TIBCO products (installed using the TIBCO Universal Installer), select Typical Uninstall. After making your choice, click Next. If you select Custom Uninstall, the next dialog will list all TIBCO products installed using the TIBCO Universal Installer. 4. Check the check box for TIBCO EMS Transport Channel for WCF, then click Next. The Pre Uninstall Summary dialog is displayed. 5. Review the summary information, then click Uninstall. The uninstaller will remove the files and directories associated with TIBCO EMS Transport Channel for WCF, with the exception of the log directory and its log files so that you do not lose the log history. These can be deleted manually, if desired.

27 Uninstalling the Software 19 The Post Uninstall Summary dialog is displayed when the uninstall is finished. 6. Click Finish to close the uninstaller window.

28 20 Chapter 3 Uninstalling