1 TIBCO ActiveMatrix BusinessWorks Plug-in for sftp Installation Software Release 1.0 June 2013 Two-Second Advantage
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 FILE) 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. TIBCO, The Power of Now, TIBCO ActiveMatrix BusinessWorks, TIBCO Rendezvous, TIBCO Administrator, TIBCO Enterprise Message Service, TIBCO InConcert, TIBCO Policy Manager, and TIBCO Hawk 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 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 2013 TIBCO Software Inc. ALL RIGHTS RESERVED. TIBCO Software Inc. Confidential Information
3 iii Contents Preface... Changes from the Previous Release of this Guide... vi Related Documentation... vii TIBCO ActiveMatrix BusinessWorks Plug-in for sftp Documentation... vii Other TIBCO Product Documentation... vii Typographical Conventions... ix Connecting with TIBCO Resources... xi How to Join TIBCOmmunity... xi How to Access TIBCO Documentation.... xi How to Contact TIBCO Support... xi Installing TIBCO ActiveMatrix BusinessWorks Plug-in for sftp... 1 Installation Requirements... 2 Installation Account Requirements... 2 Required and Optional TIBCO Products... 3 Installation... 5 Preparing for Installation Installing in GUI Mode... 7 Installing in Console Mode Installing in Silent Mode Post Installation Tasks Troubleshooting Installation Uninstalling TIBCO ActiveMatrix BusinessWorks Plug-in for sftp Index v
4 iv Contents
5 v Preface 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 file for the availability of this software version on a specific operating system platform. This preface gives some information on the TIBCO ActiveMatrix BusinessWorks TM Plug-in for sftp documentation set, related documentation, and on conventions used in TIBCO manuals. Topics Changes from the Previous Release of this Guide, page vi Related Documentation, page vii Typographical Conventions, page ix Connecting with TIBCO Resources, page xi
6 vi Changes from the Previous Release of this Guide Changes from the Previous Release of this Guide This is a new guide.
7 Preface vii Related Documentation This section lists documentation resources you may find useful. TIBCO ActiveMatrix BusinessWorks Plug-in for sftp Documentation The following documents form the TIBCO ActiveMatrix BusinessWorks Plug-in for sftp documentation set: Read this manual for information on installing one or more components of TIBCO ActiveMatrix BusinessWorks and setting up a TIBCO ActiveMatrix BusinessWorks domain. TIBCO ActiveMatrix BusinessWorks Plug-in for sftp User s Guide Read this manual to learn about SFTP Plug-in and SFTP Palette in ActiveMatrix BusinessWorks.. TIBCO ActiveMatrix BusinessWorks Plug-in for sftp Release Notes Read the release notes for the features and known issues. Other TIBCO Product Documentation TIBCO ActiveMatrix BusinessWorks is a pre-requisite for TIBCO ActiveMatrix BusinessWorks Plug-in for sftp and is used with other products. You may find it useful to read the documentation for the following TIBCO products: TIBCO ActiveMatrix BusinessWorks The following documents form the TIBCO ActiveMatrix BusinessWorks documentation set: TIBCO ActiveMatrix BusinessWorks Concepts Read this manual before reading any other manual in the documentation set. This manual describes terminology and concepts of TIBCO ActiveMatrix BusinessWorks, and the other manuals in the documentation set assume you are familiar with the information in this manual. TIBCO ActiveMatrix BusinessWorks Getting Started This manual steps you through a very simple example of designing, deploying, and monitoring a TIBCO ActiveMatrix BusinessWorks process. TIBCO ActiveMatrix BusinessWorks Process Design Guide This manual describes how to create, edit, and test business processes using TIBCO ActiveMatrix BusinessWorks.
8 viii Related Documentation TIBCO ActiveMatrix BusinessWorks Palette Reference This manual describes each of the palettes available in TIBCO ActiveMatrix BusinessWorks. TIBCO ActiveMatrix BusinessWorks Administration This manual describes how to use TIBCO Administrator to deploy, manage, and monitor TIBCO ActiveMatrix BusinessWorks processes. TIBCO ActiveMatrix BusinessWorks Installation Read this manual for information on installing one or more components of TIBCO ActiveMatrix BusinessWorks and setting up a TIBCO ActiveMatrix BusinessWorks domain. TIBCO ActiveMatrix BusinessWorks Error Codes This manual describes errors returned by TIBCO ActiveMatrix BusinessWorks. TIBCO ActiveMatrix BusinessWorks 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 this release. Other TIBCO Products TIBCO ActiveMatrix BusinessWorks is used with other products. You may find it useful to read the documentation for the following TIBCO products: TIBCO Designer software: TIBCO Designer is an easy to use graphical user interface for design-time configuration of TIBCO applications. TIBCO Designer includes online help for each palette. TIBCO Administrator software: TIBCO Administrator is the monitoring and managing interface for new-generation TIBCO products such as TIBCO ActiveMatrix BusinessWorks. TIBCO Adapter software Third-Party Documentation
9 Preface ix Typographical Conventions The following typographical conventions are used in this manual. Table 1 General Typographical Conventions Convention Use TIBCO products are installed into an installation environment. A product installed into an installation environment does not access components in other installation environments. Incompatible products and multiple instances of the same product must be installed into different installation environments. An installation environment consists of the following properties: ENV_NAME TIBCO_HOME code font Name Identifies the installation environment. This name is referenced in documentation as ENV_NAME. On Microsoft Windows, the name is appended to the name of Windows services created by the installer and is a component of the path to the product shortcut in the Windows Start > All Programs menu. Path The folder into which the product is installed. This folder is referenced in documentation as TIBCO_HOME. The value of TIBCO_HOME depends on the operating system. For example, on Windows systems, the default value is C:\tibco. Code font identifies commands, code examples, filenames, pathnames, and output displayed in a command window. For example: Use MyCommand to start the foo process. bold code font Bold code font is used in the following ways: In procedures, to indicate what a user types. For example: Type admin. In large code samples, to indicate the parts of the sample that are of particular interest. In command syntax, to indicate the default parameter for a command. For example, if no parameter is specified, MyCommand is enabled: MyCommand [enable disable]
10 x Typographical Conventions Table 1 General Typographical Conventions (Cont d) Convention italic font Key combinations Use Italic font is used in the following ways: To indicate a document title. For example: See TIBCO ActiveMatrix BusinessWorks Concepts. To introduce new terms For example: A portal page may contain several portlets. Portlets are mini-applications that run in a portal. To indicate a variable in a command or code syntax that you must replace. For example: MyCommand pathname Key name separated by a plus sign indicate keys pressed simultaneously. For example: Ctrl+C. Key names separated by a comma and space indicate keys pressed one after the other. For example: Esc, Ctrl+Q. The note icon indicates information that is of special interest or importance, for example, an additional action required only in certain circumstances. The tip icon indicates an idea that could be useful, for example, a way to apply the information provided in the current section to achieve a specific result. The warning icon indicates the potential for a damaging situation, for example, data loss or corruption if certain steps are taken or not taken.
11 Preface xi Connecting with TIBCO Resources How to Join TIBCOmmunity TIBCOmmunity is an online destination for TIBCO customers, partners, and resident experts. It is a place to share and access the collective experience of the TIBCO community. TIBCOmmunity offers forums, blogs, and access to a variety of resources. To register, go to How to Access TIBCO Documentation You can access TIBCO documentation here: How to Contact TIBCO Support For comments or problems with this manual or the software it addresses, 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.
12 xii Connecting with TIBCO Resources
13 1 Installing TIBCO ActiveMatrix BusinessWorks Plug-in for sftp This document explains how to install TIBCO ActiveMatrix BusinessWorks TM Plug-in for sftp on Microsoft Windows and UNIX systems. Topics Installation Requirements, page 2 Required and Optional TIBCO Products, page 3 Installation, page 5 Installing in GUI Mode, page 7 Installing in Console Mode, page 9 Installing in Silent Mode, page 10 Post Installation Tasks, page 11
14 2 Installing TIBCO ActiveMatrix BusinessWorks Plug-in for sftp Installation Requirements Before you run the installer on your Windows or Linux system, ensure that you log in with the appropriate account, and ensure your system meets the hardware and software requirements. Installation Account Requirements To install on Microsoft Windows or on UNIX, you must have the appropriate privileges. The privileges differ for different platforms. Microsoft Windows Only users with administrator privileges can install the TIBCO BusinessWorks Plug-in for sftp. If you do not have administrator privileges, the installer exits. To install the product on a network drive, ensure that the account used for installation has the permission to access the network drive. UNIX Any type of user regular (non-root) user and super-user (root) can install TIBCO BusinessWorks plug-in for sftp. On UNIX platforms, use the same installer account to install all TIBCO products. A window environment such as CDE (that is, X Windows) is required to run the installer in the GUI mode. It is not required for a console installation.
15 Required and Optional TIBCO Products 3 Required and Optional TIBCO Products Depending on the tasks to perform, you must install one or more other TIBCO products. Table 2 describes the required and optional products and their purpose. Table 2 Required and Optional TIBCO Products Software Description TIBCO Software The following software products are distributed and installed separately. See the readme file for the supported versions. TIBCO Rendezvous TIBCO Runtime Agent TIBCO Designer TIBCO ActiveMatrix BusinessWorks Required. TIBCO Rendezvous must be installed before installing TIBCO Runtime Agent. Required. TIBCO Runtime Agent supplies a number of TIBCO and third-party libraries used by TIBCO ActiveMatrix BusinessWorks and other TIBCO products both at design-time and runtime. This includes, for example, the TIBCO Rendezvous software. You must install TIBCO Runtime Agent on each machine that hosts a TIBCO ActiveMatrix BusinessWorks process engine. Install TIBCO Runtime Agent before you install TIBCO ActiveMatrix BusinessWorks. Required. TIBCO Designer is an easy to use graphical user interface for design-time configuration of TIBCO ActiveMatrix BusinessWorks. TIBCO Designer is installed as a part of the TIBCO Runtime Agent installation. Required. TIBCO ActiveMatrix BusinessWorks supports your integration project throughout the project lifecycle. It includes a common graphical user interface for adapter configuration, process design, and deployment. User administration, component management, and process monitoring are available through a web browser based GUI.
16 4 Installing TIBCO ActiveMatrix BusinessWorks Plug-in for sftp Software TIBCO Administrator Description Required. TIBCO Administrator is available in two editions, Repository Edition and Enterprise Edition. The Enterprise Edition is required for TIBCO ActiveMatrix BusinessWorks. Administrator includes the following modules: User Management: Managing authentication, roles and users, that is, connecting roles (groups) and users to access control lists (ACLs). This includes security for deployed applications at runtime. Resource Management: Monitoring machines and all running applications in a TIBCO administration domain. Alerts can be created, for example, to notify an administrator if the number of processes or disk usage exceeds a certain number. Application Management: Uploading of Enterprise Archive (EAR) files, creation, configuration, deployment, and monitoring of applications. This console is also used to start and stop applications. TIBCO Administrator is available as a separate installation and can be installed after installing TIBCO ActiveMatrix BusinessWorks.
17 Installation 5 Installation Install TIBCO products with TIBCO Universal Installer. The installer runs on multiple platforms. You can run the installer in the: GUI mode Console mode Silent mode Preparing for Installation Before you start with the installation, make sure your system meets all prerequisites, decide on the installation environment name and folder, and download and extract the installation package. Installation environment (TIBCO_HOME) is the top-level installation directory for TIBCO products. Installation environments isolate product installations; a product installed into an installation environment does not access components in other environments. An installation environment consists of a name and a folder. The name identifies the environment, and is appended to the name of the Windows services created by the installer. In the Windows Start > All Programs menu, the name is a component of the path to the product. The folder contains the installed software. When installing, you can choose either a new installation environment to create a new folder or use an existing installation environment. If a previous installation of a TIBCO product did not use the TIBCO Universal Installer, then the TIBCO Universal Installer does not detect the folder those older products used as an installation environment folder. If you want to use the existing location as the installation folder, create a new installation environment and select the folder where the other products exist. Procedure Make sure your environment meets all requirements. See Installation Requirements, page 2 for details. 1. Decide on the installation environment (TIBCO_HOME) you want to use. Select an installation environment on which TIBCO ActiveMatrix BusinessWorks is already installed. During the installation, the installer will prompt you for a name and a folder.
18 6 Installing TIBCO ActiveMatrix BusinessWorks Plug-in for sftp 2. Stop all processes that are using Java from TIBCO_HOME. Processes might include the TIBCO Administrator server, TIBCO Host instances, and nodes, or the TIBCO ActiveMatrix BusinessWorks processes. 3. Open the physical media or download the installer and extract the archive file to a temporary directory. 4. Extract the TIBCO ActiveMatrix BusinessWorks Plug-in for the sftp archive file to a temporary directory. 5. Navigate to the temporary directory. 6. Continue the installation process based on the following modes you selected: Installing in GUI Mode Installing in Console Mode Installing in Silent Mode
19 Installing in GUI Mode 7 Installing in GUI Mode In the GUI mode, the installer prompts you for information about the installation environment, and allows other customizations. When you invoke the installer by double-clicking the icon, the GUI mode is used. Procedure To install TIBCO ActiveMatrix BusinessWorks Plug-in for sftp in the GUI mode: 1. Run TIBCOUniversalInstaller.exe. You can do so in one of the following ways: Double-click the installer icon. On the command prompt, provide the absolute path of the installer file without specifying any options. The installer defaults to the GUI mode. 2. On the Welcome screen, click Next. 3. Read the License Agreement, select the I Accept The Terms of The License Agreement, and click Next. 4. Select a new installation environment (TIBCO_HOME) or an existing installation environment (recommended) and click Next. Option Create a new TIBCO_HOME Use an existing TIBCO_HOME Procedure Specify properties: Directory The directory into which the product is installed. The directory cannot be the same as the directory of an existing installation environment. Note: The directory path cannot contain special characters such as "*", "#", "?",">", "<", "%", "&", "$", "`" or " ". Name Identifies the installation environment. Note: The name cannot contain special characters such as "*", "?", ">", "<", ":", " ", "/", "\", or quotes ("). Select an installation environment from the drop-down list.
20 8 Installing TIBCO ActiveMatrix BusinessWorks Plug-in for sftp 5. Select a typical or custom installation. Typical - Click Next to perform Typical installation, which includes both Runtime and Documentation. Custom - Click Customize Installation to clear one of the components and click Next. If you do not select a component, it is not installed. 6. Verify the list of products selected for installation in the Pre-Install Summary screen and click Install. 7. Review the Post-Install Summary, click Finish to complete the installation process, and close the installer window.
21 Installing in Console Mode 9 Installing in Console Mode The Console mode enables you to run the installer from the command prompt or terminal window. This is useful if your machine does not have a Windows environment. The installer prompts you for values. Type the following at the command prompt: TIBCOUniversalInstaller.exe -console When running in the console mode, you can move through the installation process as described next: Enter Key = Moves forward in the installer 2 = Goes back to previous screen 3 = Cancels the Wizard and exits the installation or uninstallation 4 = Redisplays the current screen
22 10 Installing TIBCO ActiveMatrix BusinessWorks Plug-in for sftp Installing in Silent Mode Run the installer without user input by pointing the installer to a response file. You can also edit the pre-configured response file and specify the TIBCO_HOME location. In the silent mode, the installer does not prompt for input during the installation but reads the inputs from a response file. By default, the installer uses the TIBCOUniversalInstaller.silent file, which is included in the directory that contains the universal installer. You must specify the TIBCO_HOME location in the response file. Procedure 1. Make a copy of the TIBCOUniversalInstaller.silent file. It is recommended to copy the file to a different name and edit that file for the silent install. 2. Using a text editor, open the copied file and update the installation location and features to install. 3. Run the silent installer. Windows TIBCOUniversalInstaller.cmd -silent [-V responsefile="myfilename.silent" ] UNIX TIBCOUniversalInstaller.bin -silent [-V responsefile='myfilename.silent'] If you do not specify a response file, the installer uses the TIBCOUniversalInstaller.silent file you just edited.
23 Post Installation Tasks 11 Post Installation Tasks After completing the installation, if required, view the installer log files. You can also uninstall TIBCO ActiveMatrix BusinessWorks Plug-in for sftp. Troubleshooting Installation If you encounter problems with the installation: Ensure your system meets all prerequisites. Check the installer log file for potential problems. The installer log file, tibco_universal_installer.timestamp.username_install.log is written to the.tibco/install_timestamp folder in the user's home directory. The installer log file captures the following information: Installation home details such as the user that invoked the installer, hostname, Java home in the installation home, operating system details, and so on. List of assemblies installed. Information related to the Ant scripts executed by the installer. To change the location of the installer log file, specify the option -V logfile="mylogfile", when you run the installer.
24 12 Installing TIBCO ActiveMatrix BusinessWorks Plug-in for sftp Uninstalling TIBCO ActiveMatrix BusinessWorks Plug-in for sftp You can uninstall TIBCO ActiveMatrix BusinessWorks Plug-in for sftp by running the Universal Installer. The installation manager enables you to uninstall all products in the TIBCO_HOME folder or select the products to uninstall. Procedure To uninstall: 1. Run the uninstaller. Platform Windows UNIX Procedure Uninstall from the UI or from the directory. Click Start > Program Files > TIBCO_HOME > Uninstall. InTIBCO_HOME /tools/universal_installer/, run TIBCOUniversalInstaller. Navigate to TIBCO_HOME/_uninstall and run universal_uninstall.bin. 2. On TIBCO Installation Manager, select Uninstall Products from a TIBCO Home Location, click Next, and on the Welcome screen click Next. 3. Select Custom Uninstall (select the products to be product) and click Next. 4. Under Products Available for Uninstall, select the product related checkboxes and click Next. 5. Review the products and click Uninstall. 6. When prompted about the clean up of the /tools directory, click Yes, clean it up. 7. Click Finish to exit the uninstall wizard. 8. Optional: In the TIBCO_HOME directory, delete the directories corresponding to the software you uninstalled.
25 13 Index C changes from the previous release vi customer support xi I Installing 7 Versions with Higher Version Numbers 7 Installing in Console Mode 9 Installing in GUI Mode 7 Installing in Silent Mode 10 P Post Installation Tasks 11 S support, contacting xi T technical support xi TIBCO_HOME ix Troubleshooting Installation 11