TIBCO ActiveMatrix BPM Installation: Developer Server Software Release 3.1 November 2014 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 THE 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, Two-Second Advantage, TIBCO Spotfire, TIBCO Enterprise Runtime for R, TIBCO Spotfire Server, TIBCO Spotfire Web Player, TIBCO Spotfire Statistics Services, S-PLUS, TIBCO Enterprise Message Service, TIBCO Hawk, and TIBCO Spotfire S+ are either registered trademarks or trademarks of TIBCO Software Inc. in the United States and/or 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 2005-2014 TIBCO Software Inc. ALL RIGHTS RESERVED. TIBCO Software Inc. Confidential Information
3 Contents TIBCO Documentation and Support Services...4 Introduction... 5 Installation Environment (TIBCO_HOME)...6 Configuration Directory (CONFIG_HOME)...7 System Requirements...8 Hardware Requirements...8 Platform Requirements... 9 Third-Party Software Requirements...9 User Account Requirements...10 Performing Required Pre-Installation Tasks...11 Setting Maximum Number of Open Files on Linux...11 Checking Port Used by Existing Installations of PostgreSQL...11 Downloading TIBCO Software...11 Downloading Required Third-Party Software Assemblies...12 Installing ActiveMatrix BPM...13 Creating an ActiveMatrix BPM Developer Server...14 Credentials for Developer Server Components...15 Troubleshooting...16 Installer Log File...16 TIBCO Configuration Tool Log File...16 Uninstalling ActiveMatrix BPM...18
4 TIBCO Documentation and Support Services All TIBCO documentation is available on the TIBCO Documentation site, which can be found here: https://docs.tibco.com Product-Specific Documentation Documentation for TIBCO products is not bundled with the software. Instead, it is available on the TIBCO Documentation site. To directly access documentation for this product, double-click the following file: TIBCO_HOME/release_notes/TIB_amx-bpm_version_docinfo.html 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: http://www.tibco.com/services/support If you already have a valid maintenance or support contract, visit this site: https://support.tibco.com Entry to this site requires a user name and password. If you do not have a user name, you can request one. 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: http://www.tibcommunity.com
5 Introduction A Developer Server configuration of ActiveMatrix BPM is intended for use in the situation in which you want to perform rapid development and testing of a BPM application, which has been designed in TIBCO Business Studio. It is a simple configuration in which the following components are all installed on the same computer: ActiveMatrix BPM ActiveMatrix BPM database (using bundled PostgreSQL) ActiveMatrix Administrator TIBCO Enterprise Message Service In addition, to enable you to model processes and deploy them, it is required that TIBCO Business Studio - BPM Edition is installed on the same computer. The Developer Server configuration has been designed to be easy to install on a developer's desktop or laptop computer, with minimal system requirements. All TIBCO software must be installed on the same computer because it cannot be accessed remotely in this configuration. The Developer Server configuration is intended only for rapid development and testing purposes. It is not intended for use in a production environment and TIBCO recommends that you do not use it in a production environment.
6 Installation Environment (TIBCO_HOME) You install ActiveMatrix BPM into a new installation environment. An installation environment isolates product installations so that a product installed into one installation environment does not access components in another installation environment. An installation environment consists of the following properties: Directory - The directory into which the product is installed. This directory is referred to as TIBCO_HOME. Name - The identifier of the installation environment. On Microsoft Windows, the name is appended to the name of the Windows services created by the installer and is a component of the path to the product shortcut in the Windows Start menu. You specify the installation environment when you run TIBCO Universal Installer.
7 Configuration Directory (CONFIG_HOME) The directory that stores the ActiveMatrix BPM configuration information, such as scripts, session data, configured binaries, and property and log files, is referred to as CONFIG_HOME. The value of CONFIG_HOME depends on the operating system. For example, on Windows, the default value is: C:\ProgramData\amx-bpm\tibco\data You specify the configuration directory when you run the installer.
8 System Requirements There are basic system requirements that must be in place before you can install this version of ActiveMatrix BPM. Hardware Requirements TIBCO recommends a minimum specification for the computer on which you want to install ActiveMatrix BPM. System Memory 8 GB of virtual memory available for user applications. Disk Space The installer requires space in the temporary directory before installation, and additional space in the temporary directory for running the installer. You must also make sure sufficient space is in the directory that you want to use as the installation environment directory (TIBCO_HOME). While performing installation, avoid running other processes that consume disk space in TIBCO_HOME. If another process consumes disk space while the installer is copying the files, the installer might fail and display a failure message. Directory Temporary directory used to hold the installer Temporary directory used during installation Disk Space Requirement Before you start the installation process, extract the contents of the installation archive to a temporary directory. The installer files consume up to 900 MB of disk space. The installer requires at least 900 MB of free space in the temporary directory used by the installer. On Microsoft Windows, this directory is typically: %SystemDrive%:\Documents and Settings\user_name\Local Settings\Temp If your system does not have sufficient disk space in the default temporary area, you can run the installer with a different temporary directory by using the following option when starting the installer: -is:tempdir /new_temp where /new_temp has sufficient free disk space. Installation environment directory (TIBCO_HOME) The installer calculates the disk space required in the installation environment directory for the selected components. The calculation is done before the actual installation (copying of files to the system) begins. The installer proceeds only if sufficient free disk space is available in the installation environment directory. ActiveMatrix BPM can consume up to 5 GB of free space under TIBCO_HOME.
9 Platform Requirements The ActiveMatrix BPM Developer Server configuration supports various combinations of operating system and processor architecture. Operating System (64 bit) Windows Versions Microsoft Windows 8 (with any subsequent service packs for this version) Microsoft Windows 7 (with any subsequent service packs for this version) Processor Architecture x86-64 Linux Red Hat Enterprise Linux 6.x x86-64 Third-Party Software Requirements LDAP Server ActiveMatrix BPM uses ApacheDS, with which it is bundled. If you want to use a corporate LDAP server instead, after installing ActiveMatrix BPM, you must add and configure new shared resources for the new LDAP connections, as explained in the TIBCO ActiveMatrix BPM Administration guide. Web Browsers ActiveMatrix BPM requires a web browser to run Openspace, Workspace, and the ActiveMatrix Administrator GUI. The following tables list the web browsers that are supported. Openspace and Workspace Browser Versions Notes Internet Explorer 8 9 Compatibility View is not supported. 10 Compatibility View is not supported. Openspace (Accessible) is not supported. 11 Enterprise Mode and Native Mode are supported. Compatibility View is not supported. Openspace (Accessible) is not supported. Firefox 32 The Openspace Spotfire gadget is not supported. Openspace (Accessible) is not supported. Chrome 37 The Openspace Spotfire gadget is not supported. Openspace (Accessible) is not supported. Safari (on Mac OS X 10.8.x) 6 The Openspace Spotfire, Organization Browser, and Event Views gadgets are not supported. Openspace (Accessible) is not supported.
10 ActiveMatrix Administrator GUI Browser Versions Notes Internet Explorer 8 SP2 is required. 9, 10 Compatibility View is not supported. Firefox 26 The versions specified are the minimum versions of each browser that are supported by ActiveMatrix BPM. You can use a more recent version of a browser as long as the vendor claims the recent version to be compatible with the specified version. In the event of a problem with a more recent browser version, TIBCO will employ reasonable efforts to provide support on that browser version. However, TIBCO may request that you reproduce the problem on a supported version of the browser. This may mean that you change to a different version that does not exhibit the issue, ideally only on a temporary basis. User Account Requirements The operating system user account that is used to install ActiveMatrix BPM must have the appropriate privileges. Windows - You must have Administrator privileges for the computer on which ActiveMatrix BPM is installed. If you do not have Administrator privileges, the installer exits. You must then either log off Windows and log on as a user with the required privileges, or request your system administrator to assign the privileges to your account. To run TIBCO Configuration Tool separately (as opposed to the installer running it), you must right-click tct and select Run as administrator. Linux - Any type of user (regular (non-root) user or super-user (root)) can install ActiveMatrix BPM.
11 Performing Required Pre-Installation Tasks You must perform various tasks before installing ActiveMatrix BPM. Setting Maximum Number of Open Files on Linux The maximum number of open files/file descriptors that a user can open is controlled by the operating system. However, the default threshold on Linux is typically too low and has to be increased. TIBCO recommends that you set the maximum number of open files/file descriptors to a value of at least 10000. Checking Port Used by Existing Installations of PostgreSQL If you are using PostgreSQL, or a product that bundles PostgreSQL, on the computer on which you want to install ActiveMatrix BPM, check that it does not use port 5434. This port is used by the PostgreSQL database that is bundled with ActiveMatrix BPM Developer Server. Downloading TIBCO Software Download ActiveMatrix BPM and, if necessary, TIBCO Enterprise Message Service. Extract the contents of the.zip file(s) to the computer on which you want to install ActiveMatrix BPM. Procedure 1. Check if the computer on which you want to install ActiveMatrix BPM has a supported version of Enterprise Message Service installed. ActiveMatrix BPM uses Enterprise Message Service for notification and messaging. To see which versions of Enterprise Message Service are supported, see the ActiveMatrix BPM Readme. 2. If a non-supported version of Enterprise Message Service is installed, download a supported version from the TIBCO Software Product edelivery Site (http://edelivery.tibco.com/) and upgrade, following the Enterprise Message Service installation guide. 3. If Enterprise Message Service is not installed, download it from the TIBCO Software Product edelivery Site (http://edelivery.tibco.com/). 4. Download the ActiveMatrix BPM package for your platform from the TIBCO Software Product edelivery Site (http://edelivery.tibco.com/). 5. If you have downloaded both Enterprise Message Service and ActiveMatrix BPM, check which package contains the later version of the installer. To do this, in each.zip file, open the product_product-name_version_featureconfig.xml file, and check the values of universalinstallerversion and universalinstallerrelease. For example, universalinstallerversion="v7" universalinstallerrelease="3.2.5" means that the complete release number is 3.2.5.7.
12 6. Extract the contents of the.zip file(s) to a temporary, empty directory on the computer on which you want to install ActiveMatrix BPM. If you have downloaded both products, extract the contents of the.zip file that contains the older installer first, then extract the contents of the other.zip file to the same directory, merging subdirectories that have the same name and overwriting installer files that have the same name. On Linux, open a terminal window and use the unzip command to unzip the package. Do not double-click the package to extract its contents: doing so may cause a problem if you try to start TIBCO Configuration Tool after running the installer. Downloading Required Third-Party Software Assemblies ActiveMatrix requires some third-party LGPL software assemblies to be installed. If they are not already installed on the computer on which you want to install ActiveMatrix BPM, and that computer does not have internet access, you must download the assemblies before you install ActiveMatrix BPM. They can then be installed automatically by the ActiveMatrix BPM installer. The required assemblies are: Hibernate Eclipse SWT GTK module (only required if you are installing on Linux) Oracle Java 7 Elliptic Curve Cryptography (ECC) library Procedure 1. From the TIBCO Software Product edelivery Site (http://edelivery.tibco.com/), download Hibernate. When downloading Hibernate, the number in the package name refers to the assembly number and not the version of Hibernate. This can be misleading as the assembly number is not the same as the Hibernate version number. For example, the package name when downloading Hibernate version 3.2.7 is: assembly_tibco_com_tpcl_ord_hibernate_feature_3.2.400.001.zip 2. If you are installing on Linux, download the Eclipse SWT GTK module for your platform. 3. Download the Oracle ECC library for your platform. 4. Extract the contents of the downloaded.zip files to the assemblies subdirectory of the directory in which you extracted the contents of the ActiveMatrix BPM.zip file.
13 Installing ActiveMatrix BPM To install ActiveMatrix BPM and, if necessary, Enterprise Message Service, run the TIBCO Universal Installer and select the Developer Server installation profile. Procedure 1. Go to the directory in which you extracted the contents of the ActiveMatrix BPM package. 2. Run TIBCOUniversalInstaller.cmd. On Linux, open a terminal window and run TIBCOUniversalInstaller.cmd from the command line. Do not double-click the file to run it: doing so may cause a problem if you try to start TIBCO Configuration Tool after running the installer. 3. Ensure that you complete the following installer pages as shown: Page TIBCO Installation Home Installation Profile Selection Post Install Summary Requirements Ensure that Create a new TIBCO_HOME is selected and that Directory does not specify the directory of an existing installation environment. 1. In the left pane, select Developer Server. 2. If you are installing Enterprise Message Service as well, in the right pane, ensure that this is selected. Ensure that the Launch TIBCO Configuration Tool check box is selected. 4. Click Finish. Although the Developer Server profile is not listed on the Pre-Install Summary and the Post Install Summary pages, it is installed. When ActiveMatrix BPM has been installed, TIBCO Configuration Tool is started and the TIBCO Configuration Folder dialog is displayed. Do not change the folder.
14 Creating an ActiveMatrix BPM Developer Server To create an ActiveMatrix BPM Developer Server, run the Create TIBCO ActiveMatrix BPM Server wizard from TIBCO Configuration Tool. Procedure 1. In the TIBCO Configuration Folder dialog, click OK to accept the default. Do not change the folder. If you need to restart TIBCO Configuration Tool, run this command: TIBCO_HOME\bpm\n.n\bin\tct On Windows, you must right-click tct and select Run as administrator. 2. In the Create new configurations dialog, click Create TIBCO ActiveMatrix BPM Server. The Create TIBCO ActiveMatrix BPM Server wizard is started. 3. Start the Enterprise Message Service server, on port 7222. On the Welcome page, click Next. On Windows, ensure that you use the same configuration files as the Windows service. Use the following command: TIBCO_HOME\ems\version number\bin\tibemsd -config EMS_CONFIG_HOME\tibco \cfgmgmt\ems\data\tibemsd.conf where EMS_CONFIG_HOME is the configuration directory for Enterprise Message Service. 4. If the wizard detects that there is already a Developer Server instance on this computer, the ActiveMatrix BPM: Clean Existing Developer Server page is displayed. If you are happy to delete the instance, select the Remove existing Developer Server check box and click Next. Caution: The entire Developer Server instance, including ActiveMatrix BPM, ActiveMatrix Administrator, their associated databases, and all data, will be deleted. 5. On the ActiveMatrix BPM Configuration: Summary page, click Configure. 6. When TIBCO Configuration Tool has created a Developer Server instance on this computer, click Close to exit TIBCO Configuration Tool. Result You have finished installing ActiveMatrix BPM Developer Server. You can use the software only on this computer because it cannot be accessed remotely in this configuration.
15 Credentials for Developer Server Components The credentials for accessing each ActiveMatrix BPM Developer Server component cannot be specified during installation. They are assigned default values. ActiveMatrix Administrator Username: root Password: t ActiveMatrix BPM Username: tibco-admin Password: secret ActiveMatrix BPM Database Username: bpmuser Password: bpmuser
16 Troubleshooting If you have problems installing ActiveMatrix BPM or creating a Developer Server, there are a few things that you should do to try to resolve them. Make sure that your computer meets all prerequisites. See System Requirements. Check the installer log file for potential problems. See Installer Log File. Check the TIBCO Configuration Tool log file for potential problems. See TIBCO Configuration Tool Log File. Re-create the Developer Server. Repeat the procedure described in Creating an ActiveMatrix BPM Developer Server. If the Create TIBCO ActiveMatrix BPM Server wizard detects that there is already a Developer Server instance on this computer, the ActiveMatrix BPM: Clean Existing Developer Server page is displayed. You can then confirm that you are happy to delete the instance completely, so that a fresh instance can be created. Uninstall then reinstall ActiveMatrix BPM. See Uninstalling ActiveMatrix BPM and Installing ActiveMatrix BPM. Installer Log File On Windows, sometimes the TIBCO ActiveMatrix service is left with a "Disabled" status instead of being removed by the uninstaller. Before reinstalling ActiveMatrix BPM, you must restart the computer to remove the service. If you do not restart, the service cannot be re-created during re-creation of the Developer Server. The installer log file contains information about the installation that was performed. Separate log files contain information about scripts that the installer ran. The installer log file, tibco_universal_installer.username_install.log, is written to the.tibco/ install_timestamp directory of the user s home directory. To change the location of the installer log file, specify the option -V logfile="mylogfile" when you run the installer. The installer log file captures the following information: Installation environment details such as user that invoked the installer, operating system details, installer mode, host name, JAVA_HOME and the Java version available in that environment, and so on. List of assemblies installed. Information related to the Ant scripts that are executed by the installer is logged in separate log files: anttask_log_scriptname_timestamp under the directory: install_timestamp TIBCO Configuration Tool Log File When you run the Create TIBCO ActiveMatrix BPM Server wizard from TIBCO Configuration Tool, a log file is created. Examining this file may help you if you have a problem when running the wizard. The log file is stored under the directory specified in the Session Scripts and Log Folder field of the wizard s Summary page. By default, this directory is:
17 CONFIG_HOME\tct\bpm\timestamp The logs subdirectory contains a separate log file for each configuration action executed by TIBCO Configuration Tool. Log files are created when you click Save or Configure from a wizard.
18 Uninstalling ActiveMatrix BPM To uninstall ActiveMatrix BPM, stop the TIBCO processes, run the TIBCO Universal Uninstaller, and delete ActiveMatrix BPM directories. Procedure 1. Stop the TIBCO processes. On Windows, stop the TIBCO ActiveMatrix and PostgreSQL for AMX-BPM services. On Linux, run this command: TIBCO_HOME/bpm/3.1/bin/dev_ctl stop 2. Ensure that you are logged on to the computer with the correct privileges: On Windows, you must have Administrator privileges. On Linux, you must be logged on as the same user who installed ActiveMatrix BPM. If more than one product installation has been made to the same environment and you want to uninstall them all, you should uninstall as the root user. 3. Run the TIBCO Universal Installer: On Windows, click the following: Start > All Programs > TIBCO > ENV_NAME > Uninstall On Linux, change to: TIBCO_HOME/tools/universal_installer Run./TIBCOUniversalInstaller-platform_id.extension. 4. On the TIBCO Installation Manager page of the installer, click Uninstall Products from a TIBCO Home Location and then select the location of TIBCO Home from the list. Click Next. 5. When the TIBCO Universal Uninstaller is started, complete the uninstaller pages as required. On the Pre-Uninstall Summary page, click Uninstall. The uninstaller removes ActiveMatrix BPM. 6. The Running ANT Tasks page is displayed while the selected components are uninstalled. When you are asked about the cleanup of the /tools directory, click Yes, clean it up. 7. On the Post Uninstall Summary page, click Finish. The uninstaller exits and cleans up any temporary files. On Windows, the TIBCO ActiveMatrix BPM entries in the Start menu may remain after the uninstallation. To correct this, log off, then log on again. On Linux, if an error message similar to the following is displayed after uninstallation, log out and log in again for the uninstaller changes to take effect: The wizard requires that you logout and log back in 8. Manually delete the TIBCO ActiveMatrix BPM directories under TIBCO_HOME. 9. Manually delete the TIBCO ActiveMatrix BPM directories under CONFIG_HOME.