tibco datasynapse federator™ · repackaged jboss enterprise middleware open source software....

TIBCO DataSynapse Federator™

Installation GuideSoftware Release 3.0 SP1February 2015

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, The Power of Now, DataSynapse Federator, GridServer, FabricServer, GridClient, GridBroker, FabricBroker, LiveCluster, VersaUtility, VersaVision, SpeedLink, Federator, and RTI Design 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.

TIBCO products may include some or all of the following:

Software developed by the Apache Software Foundation.

Software developed by the OpenSSL Project for use in the OpenSSL Toolkit.

Software developed by Sam Stephenson.

Software developed by Yahoo! Inc.

Code licensed from RSA Data Security.

Spring Framework software.

Code licensed under the Lesser Gnu Public License (LGPL)

Repackaged JBoss Enterprise Middleware open source software.

Product integration with the BEA WebLogic® Server software developed and copyrighted by BEA Systems, Inc. Certain third party software is distributed by the BEA WebLogic Server.

WebLogic® is a registered trademark of BEA Systems, Inc.

WebSphere® is a registered trademark and CloudScape™ is a trademark of International Business Machines Corporation in the United States, other countries, or both.

Software developed using the Eclipse open source development platform.

Software developed by the Massachusetts Institute of Technology.

VMware, the VMware “boxes” logo and design, Virtual SMP and VMotion are registered trademarks or trademarks of VMware, Inc. in the United States and/or other jurisdictions.

Portions copyright 2009 John Resig.

PuTTY, copyright 1997-2009 Simon Tatham.

ANTLR 1989-2004 Developed by Terence Parr.

Copyright 2001-2005 (C) MetaStuff, Ltd. All Rights Reserved.

This product includes software licensed under the Eclipse Public License. The source code for such software licensed under the Eclipse Public License is available upon request to TIBCO and additionally may be obtained from http://eclipse.org/.

This product includes HTML Parser software which is licensed under the Common Public License, v1.0. For a period of time not to exceed three years from the Purchase Date, TIBCO also offers to provide Customer, upon written request of Customer, a copy of the source code for this software.

This product includes Javassist licensed under the Mozilla Public License, v1.1. You may obtain a copy of the source code from http://www.jboss.org/javassist/

This product uses Open Thundergraph. Open Thundergraph is distributed pursuant to the terms of the Lesser General Public License. The source code for Open Thundergraph may be obtained from http://sourceforge.net/projects/thundergraph/. For a period of time not to exceed three years from the Purchase Date, TIBCO also offers to provide Customer, upon written request of Customer, a copy of the source code for Open Thundergraph.

This product includes software developed by the Indiana University Extreme! Lab (http://www.extreme.indiana.edu/).

This product includes WSDL4J software which is licensed under the Common Public License, v1.0. The source code for this software may be obtained from TIBCO's software distribution site.

This product includes software licensed under the Common Development and Distribution License (CDDL) version 1.0. The source code for such software licensed under the Common Development and Distribution License (CDDL) version 1.0 is available upon request to TIBCO.

Copyright (C) 2000-2004 Jason Hunter & Brett McLaughlin. All rights reserved.

Copyright (c) 2004-2008 QOS.ch All rights reserved.

This product includes software developed by the OpenSymphony Group (http://www.opensymphony.com/).

This product includes Junit software which is licensed under the Common Public License, v1.0. For a period of time not to exceed three years from the Purchase Date, TIBCO also offers to provide Customer, upon written request of Customer, a copy of the source code for this software.

Portions copyright Robert de Bath, Joris van Rantwijk, Delian Delchev, Andreas Schultz, Jeroen Massar, Wez Furlong, Nicolas Barry, Justin Bradford, Ben Harris, Malcolm Smith, Ahmad Khalifa, Markus Kuhn, Colin Watson, and CORE SDI S.A.

Portions copyright 2005 Envoi Solutions LLC.

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.

This Product is covered by U.S. Patent No. 6,757,730, 7,093,004, 7,093,004, and patents pending.

Copyright © 1999-2015 TIBCO Software Inc. ALL RIGHTS RESERVED.

TIBCO Software Inc. Confidential Information

TIBCO DataSynapse Federator™ Installation Guide

| vi

Contents

Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .vii

Related Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .viiiTIBCO Federator Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .viii

Typographical Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ix

Connecting with TIBCO Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xiiHow to Join TIBCOmmunity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xiiHow to Access All TIBCO Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xiiHow to Contact TIBCO Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xii

Chapter 1 Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1

Installing Federator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

Setting up the Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5Configuring the Database Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5Configuring Federator Database Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Enabling DataSynapse Resource Managers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Uploading Your License . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Redundancy and Failover . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Upgrading Federator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Appendix A Database Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11

Common Configuration Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12Advanced Connection Pool Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

Microsoft SQL Server 2005 and 2008 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Authentication Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Configuration Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Oracle 10g and 11g . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14Configuration Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Sybase ASE 15 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15JDBC Driver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15Configuration Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

| vii

Preface

TIBCO DataSynapse Federator™ offers the flexibility and scalability of the public cloud with the security and control of your own data center. It brings the elasticity of cloud computing to your organization – supporting existing solutions within your current infrastructure while automatically scaling resources to meet demand.

Topics

• Related Documentation, page viii

• Typographical Conventions, page ix

• Connecting with TIBCO Resources, page xii


viii |

Related Documentation

This section lists documentation resources you may find useful.

TIBCO Federator DocumentationThe following documentation is included with Federator in Adobe Acrobat (PDF) format. To view the guides, click on the book icon at the upper right of the interface. The PDF files are also on the Broker at webapps/federator/doc. The following documents form the Federator documentation set:

• TIBCO DataSynapse Federator™ User Guide Covers general usage and administration of Federator.

• TIBCO DataSynapse Federator™ Installation Guide Covers installation of Federator for Windows and Unix.

• TIBCO DataSynapse Federator™ Release Notes Read the release notes for a list of new and changed features. This manual also contains lists of known issues and closed issues for this release.


| ix

Typographical Conventions

The following typographical conventions are used in this manual.

Table 1 General Typographical Conventions

Convention Use

TIBCO_HOME

DS_HOME

Many TIBCO products must be installed within the same home directory. This directory is referenced in documentation as TIBCO_HOME. The default value of TIBCO_HOME depends on the operating system. For example, on Windows systems, the default value is C:\tibco.

TIBCO DataSynapse Federator™ installs into a directory within TIBCO_HOME. This directory is referenced in documentation as DS_HOME. The default value of DS_HOME depends on the operating system. For example on Windows systems, the default value is C:\tibco\datasynapse.

code font 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]

italic font 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


x |

Key combinations

Key names separated by a plus sign indicates 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.

Table 1 General Typographical Conventions (Continued)

Convention Use

Table 2 Syntax Typographical Conventions

Convention Use

[ ] An optional item in a command or code syntax.

For example:

MyCommand [optional_parameter] required_parameter

| A logical OR that separates multiple items of which only one may be chosen.

For example, you can select only one of the following parameters:

MyCommand para1 | param2 | param3


| xi

{ } A logical group of items in a command. Other syntax notations may appear within each logical group.

For example, the following command requires two parameters, which can be either the pair param1 and param2, or the pair param3 and param4.

MyCommand {param1 param2} | {param3 param4}

In the next example, the command requires two parameters. The first parameter can be either param1 or param2 and the second can be either param3 or param4:

MyCommand {param1 | param2} {param3 | param4}

In the next example, the command can accept either two or three parameters. The first parameter must be param1. You can optionally include param2 as the second parameter. And the last parameter is either param3 or param4.

MyCommand param1 [param2] {param3 | param4}

Table 2 Syntax Typographical Conventions (Continued)

Convention Use


xii |

Connecting with TIBCO Resources

How to Join TIBCOmmunityTIBCOmmunity is an online destination for TIBCO customers, partners, and resident experts, 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.

How to Access All TIBCO DocumentationAfter you join TIBCOmmunity, you can access the documentation for all supported product versions here:

http://docs.tibco.com/TibcoDoc

How to Contact TIBCO SupportFor 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:

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.


http://www.tibco.com/services/support

https://support.tibco.com

http://docs.tibco.com/TibcoDoc

http://www.tibcommunity.com

| 1

Chapter 1 Installation

This guide explains how to install TIBCO DataSynapse Federator™.

Topics

• Installing Federator, page 2

• Setting up the Database, page 5

• Enabling DataSynapse Resource Managers, page 7

• Uploading Your License, page 8

• Redundancy and Failover, page 9

• Upgrading Federator, page 10


2 |

Installing Federator

Federator is a web application that runs on a Tomcat application server. The installation archive includes both the Federator application and a Tomcat application server installation.

To install Federator:

1. Decide where to install the software. The recommended location for Unix machines is /opt/TIBCO/federator; the recommended location for Windows is c:\TIBCO\federator. The installation archive includes the federator directory. This installation procedure refers to this directory (for example, c:\TIBCO\federator as DS_HOME. Note that you should not install in a directory containing a space, such as c:\Program Files, or in a directory that is a symbolic link to another directory.

2. The software is shipped as a gzipped TAR archive and a JAR file of third-party libraries.

To unpack the archive on a Windows system, use WinZip or a similar tool. On a Unix system, use tar and gzip. (Note that with Solaris, you must use GNU tar.) For Unix, use the following command:

gzip -d -c TIB_dsfed_*gz | tar xvf -

3. After unarchiving the installation archive, install the third-party library JAR with the following command, where path is the path to your Federator install:

java -jar TIB_dsfed_version_third_party_libs.jar path

4. Set the JAVA_HOME environment variable to the root directory of your Java installation.

5. Federator uses port 8080 for HTTP communication by default. To change this, edit the DS_HOME/conf/server.xml file and change the connector with port 8080 to a different port value.

6. Configure your database, as described in Setting up the Database on page 5.

7. Configure failover, if required, as described in Redundancy and Failover, page 9.

8. Start Federator as follows:

The TAR file contains the federator directory. If you expand the archive in /opt/TIBCO, then /opt/TIBCO/federator is created.


| 3

Windows

Federator is typically run as a Windows Service in production systems. To do so, open a command window and run service.bat with the following arguments:

In Windows 7, you must run the service.bat command as an administrator.

For initial installation, install Federator as a Windows service, then start the service.

You can also start Federator on Windows by running the server.bat file, located in the root directory of the Federator distribution. To test, open a command window and run server.bat run to launch Federator. The command window will contain log messages from the application server.

The server.bat script takes the following arguments:

Unix

Launch Federator by invoking the server.sh script in the install directory with following arguments:

Argument Description

install Install Federator as a Windows service.

remove Remove Federator’s service.

start Start the installed service.

stop Stop the service.


run Start Federator in the same window.

start Start Federator in a new window.

stop Stop Federator in the same window.


run Start Federator in the foreground.

start Start Federator in the background.


4 |

You can configure Federator to launch automatically at system startup and stop cleanly at shutdown. Since the server.sh script conforms to the standard start/stop argument convention (“rc script”), you can accomplish this simply by linking to the appropriate files in the /etc/rc.d directories. For more information on initialization and termination scripts, refer to the init and init.d man pages on your Unix system.

9. Open the Federator Administration Tool in your browser by going to http://hostname:port/federator. By default, port is 8080.

10. On the initial Federator Administration Tool page, you are prompted to enter a username, password, and password verification for your initial admin account. To create additional accounts for Federator users, see the Federator User Guide.

After creating your account, the home page in the Administration Tool appears.

stop Stop Federator running in the background



| 5

Setting up the Database

Federator requires a relational database to maintain its data. You must provide the database server and set it up with user credentials, permissions, and a database for Federator to use.

Configuring the Database ServerSetting up the database is similar, regardless of the particular database server you are using. Supported databases and information on how to configure them can be found in Appendix A, Database Configuration, on page 11.

To configure the database:

1. Create a database user for Federator to log in as. By default, Federator will use the username “federator” and the password “server” to connect.

2. Create a database for Federator to use. By default, Federator will look for a database named “federator_prod”.

3. Set up access controls so that the machines where Federator will be running will be able to connect to the database and that the Federator account (for example, “federator”) will have full access to the newly created database.

4. Copy the JDBC driver for your particular database to DS_HOME/webapps/federator/WEB-INF/lib.

The first time that Federator starts and connects to the database, it creates all tables and indices it requires; there is no need to run a set-up script to do this.

Configuring Federator Database SettingsFederator uses the properties set in the DS_HOME/conf/federator.properties for its database connection. Change these properties as needed for your database. For typical values for supported databases, see Appendix A, Database Configuration, on page 11.

Table 3 Database Settings

Property Description Default

dataSource.driverClassName The fully-qualified name of the class used for the JDBC driver.

com.mysql.jdbc.Driver


6 |

dataSource.username The username that will access the database used for Federator

federator

dataSource.password The password required for the database username.

server

dataSource.url The URL used to connect to the database through JDBC.

jdbc:mysql://localhost:33

06/federator_prod?autorec

onnect=true

Table 3 Database Settings (Continued)

Property Description Default


| 7

Enabling DataSynapse Resource Managers

To enable DataSynapse Resource Managers, use the EnablementInstaller.jar file included with your copy of Federator.

You must enable all Resource Managers you intend to use, including GridServer Secondary Directors and Silver Fabric Failover Brokers.

To run the enabler:

1. Type the following into the command shell from the directory containing the enablement JAR file:

java -jar EnablementInstaller.jar path

where path is the path to the livecluster directory of your GridServer, FabricServer, or Silver Fabric installation. For example, for GridServer 6.0, your path may be C:\TIBCO\datasynapse\manager\webapps\livecluster.

2. Check the output from the command line for a message indicating a successful installation. When successful, the installer will have added an enablementversion.properties file to the server to record the installation.

The enablement version shown in the message may not match your GridServer or Silver Fabric update version exactly, as some enablement versions support multiple service release levels.

If you update Silver Fabric or GridServer after applying an enablement, updating the Federator enablement may also be required. To determine if an updated enablement is required, re-run the Enablement Installer. Any required updates install automatically; if no update is required, no changes will occur.


8 |

Uploading Your License

In the top banner, Federator will display a flashing “key” icon indicating a problem with the license for the product. You’ll need to install the license file you received with Federator.

To install the license:

1. Click the blinking key icon to go to the License page.

2. Click the Browse… or Choose File button to browse for the license file—it should be called license.ser.

3. Click the Upload… button to install the license. You will see a message that the license was successfully installed and the flashing key icon should now be steady and white.


| 9

Redundancy and Failover

Federator supports failover, which enables you to install a primary and secondary Federator server for redundancy. When the primary Federator server fails, the secondary Federator server will assume the role of the primary. When the primary server returns, Federator service will fail back to it.

Servers use a database table to communicate at regular heartbeat intervals. When a secondary server detects that a primary server has not updated within a specified interval, service will fail over to that server. This interval is 10 seconds by default, but can be configured to a different duration.

When the primary server is active, the secondary server is in standby mode, and you cannot log into it. During failback to the primary server, the primary server will briefly be in standby mode during negotiation with the secondary server. When it has resumed control, any active sessions on the secondary server will be terminated. If the secondary server is offline when the primary server restarts, the primary server will detect this and assume control.

To enable failover:

1. Install a primary Federator server with a typical configuration.

2. On another machine, install a second Federator instance, using the same database configuration.

3. On the secondary server, edit the DS_HOME/conf/federator.properties file, and change the federator_role property from Primary to Secondary.

4. To change the heartbeat interval, change the ack_interval property to the new interval, in seconds. Be sure to make this change in the federator.properties file for both the primary and secondary server.

5. Ensure that the federator_id property is the same for both servers. This property is used to identify virtual instances belonging to a server, so the failover server can identify virtual instances started by the primary server.


10 |

Upgrading Federator

To upgrade Federator to version 3.0 from version 2.x, you must follow the installation procedure described in this chapter and install a new instance of the software. See Installing Federator on page 2 for more details.

Note that you can migrate settings from your previous installation by keeping the same database, instead of installing a new database in Step 6 above.

If you are retaining a database from a previous installation:

• The resource_group_id column of the policy_interval table may have a not null constraint which must be removed for use with Federator 3. A SQL statement such as:

alter table policy_interval modify column resource_group_id

numeric(19,0) null

or

alter table policy_interval alter column resource_group_id

numeric(19,0) null

will remove the not null constraint and allow the resource_group_id column to contain null values. (Note that the above SQL syntax may vary, depending on your database type; see your database vendor’s documentation for details.)

• All tables related to PaaS, which was removed from Federator 3.0, are no longer used and ignored. They can be dropped.


| 11

Appendix A Database Configuration

This appendix is to provide specific details for several popular database servers you are likely to be using with your Federator installation. For information on databases supported in this Federator version, see the included Readme file.

Topics

• Common Configuration Items, page 12

• Microsoft SQL Server 2005 and 2008, page 13

• Oracle 10g and 11g, page 14

• Sybase ASE 15, page 15


12 |

Common Configuration Items

The following configuration items apply to all database types.

Advanced Connection Pool PropertiesFederator uses Apache DBCP for database connection pooling. You may wish to tune connection pool properties, depending on your specific Federator and database configuration. Note that many of these parameters can introduce a connection performance/reliability tradeoff. The following properties can also be added to the federator.properties file:

Explanations of these properties can be found at http://commons.apache.org/dbcp/configuration.html

Table 4 Advanced Connection Pool Properties

Property Default Value

dataSource.properties.minEvictableIdleTimeMillis 1800000

dataSource.properties.timeBetweenEvictionRunsMillis 1800000

dataSource.properties.validationQuery select 1 from dsusers (no quotes are required around the query string)

dataSource.properties.validationQueryTimeout 10

dataSource.properties.numTestsPerEvictionRun 3

dataSource.properties.testOnBorrow true

dataSource.properties.testOnReturn true

dataSource.properties.testWhileIdle true

dataSource.properties.poolPreparedStatements true

dataSource.properties.minIdle 1


| 13

Microsoft SQL Server 2005 and 2008

This section describes configuration of the Microsoft SQL Server 2005 and 2008 database server for use with Federator.

Authentication TypeWhen installing SQL Server, make sure that you choose Mixed rather than Windows authentication—Federator cannot connect to the database using Windows authentication.

Configuration PropertiesWhen editing the federator.properties file as described in Configuring Federator Database Settings on page 5, make the following changes:

Table 5 Microsoft SQL Server 2005 and 2008 Configuration Properties

Property Value for SQL Server 2005 and 2008

DB_DRIVER_CLASS com.microsoft.sqlserver.jdbc.SQLServerDriver

DB_URL jdbc:sqlserver://DB host name:1433;databaseName=federator_prod;applicationName=Federator where DB host name is the DNS name or IP address of the database machine


14 |

Oracle 10g and 11g

This section describes configuration of the Oracle 10g and 11g database server for use with Federator.


ConfigurationWhen using Oracle databases for Federator, you must first run the following command:

create sequence hibernate_sequence minvalue 1 start with 1 increment by 1 cache 20;

Table 6 Oracle 10g and 11g Configuration Properties

Property Value for Oracle 10g and 11g

dataSource.driverClassName oracle.jdbc.OracleDriver

dataSource.url jdbc:oracle:thin:@DB host name:1521:FED where DB host name is the DNS name or IP address of the database machine (if you chose a different SID when setting up the database, replace “FED” here with yours)

dataSource.properties.validationQuery select 1 from dual


| 15

Sybase ASE 15

This section describes configuration of the Sybase ASE database server for use with Federator. Federator has been tested with version 15 of Sybase ASE using version 6 of the JConnect JDBC driver.

JDBC DriverThe JDBC driver for ASE, called JConnect, can be downloaded directly from Sybase at: http://www.sybase.com/products/allproductsa-z/softwaredeveloperkit/jconnect. You must use the JDBC3 driver; the JDBC2 driver is not supported.


Table 7 Sybase ASE 15 Configuration Properties

Property Value for ASE 15

dataSource.driverClassName

com.sybase.jdbc3.jdbc.SybDriver

dataSource.url jdbc:sybase:Tds:DB host name:5000/federator_prod where DB host name is the DNS name or IP address of the database machine


16 |


tibco datasynapse federator™ · repackaged jboss enterprise middleware open source software....

Documents