Readme for IBM OpenAdmin Tool (OAT) for Informix, 3.15.1

IBM OpenAdmin Tool (OAT) for Informix

The IBM® OpenAdmin Tool (OAT) for Informix® is a web application for administering and analyzing the performance of IBM Informix database servers. You can administer multiple database server instances from a single OAT installation on a web server. You can access the web server through any browser to administer all your database servers.

OAT includes these optional plug-ins: the IBM Informix Health Advisor Plug-in for OpenAdmin Tool (OAT), the IBM Informix Replication Plug-in for OpenAdmin Tool (OAT), the IBM Informix Schema Manager Plug-in for OpenAdmin Tool (OAT), the IBM Informix TimeSeries Plug-in for OpenAdmin Tool (OAT), and the IBM Informix JSON Plug-in for OpenAdmin Tool (OAT). You can create more plug-ins for OAT to add the functions that you need.

Prerequisites:
OAT, the Schema Manager plug-in and the TimeSeries plug-in require Informix 11.10 or later. The Health Advisor plug-in requires Informix 11.50.xC7 or later. The Replication plug-in requires Informix 11.50.xC4 or later. The JSON plug-in requires Informix 12.10.xC2 or later.

Minimum version requirements

The minimum version requirements for products that OAT uses are listed in the following table.

Table 1. Minimum version requirements
Product Version
Mozilla Firefox web browser (Recommended) 10
Microsoft Internet Explorer web browser 8
Apple Safari web browser 6
Google Chrome web browser 32
IBM Informix database server 11.10
PHP 5.2.4
Adobe Flash Player 11

Installing OAT

The IBM OpenAdmin Tool (OAT) for Informix is installed by default on the supported platforms during a typical installation of the IBM Informix Client Software Development Kit (Client SDK) or when you install the IBM Informix software bundle and select Client SDK. This installation program includes OAT, the Health Advisor plug-in, the Replication plug-in, the Schema Manager plug-in, the TimeSeries plug-in, the JSON plug-in, and all necessary software to run OAT, including pre-configured Apache, PHP, and PDO_informix. For more information, see the topics in the Informix information center on Installing IBM OpenAdmin Tool (OAT) for Informix with the Client SDK: http://www.ibm.com/support/knowledgecenter/SSGU8G_12.1.0/com.ibm.cpi.doc/ids_cpi_027.htm.

Alternatively, you can download the OpenAdmin Tool Community Edition, which requires manual installation and does not include Apache, PHP, or PDO_informix. This readme file provides information for downloading and installing the OpenAdmin Tool Community Edition.

OpenAdmin Tool Community Edition

The community edition of the IBM OpenAdmin Tool (OAT) for Informix includes all the features and functionality of the IBM OpenAdmin Tool (OAT) for Informix that you install with the IBM Informix Client Software Development Kit (Client SDK) or with the IBM Informix software bundle when you select Client SDK.

Support for the community edition of OAT is available through discussion forums hosted by the International Informix User Group (IIUG) and the IBM developerWorks®Informix technical forums. For more information, see OpenAdmin Tool support forums.

Installing the OpenAdmin Tool Community Edition

The OpenAdmin Tool Community Edition is installed manually. The Health Advisor plug-in, the Replication plug-in, the Schema Manager plug-in, the TimeSeries plug-in, the JSON plug-in can be installed with the OAT Community Edition.

Prerequisites

To install OAT manually, you must have working knowledge of web servers and PHP. If you do not have this knowledge, you might need assistance from a web server administrator in your organization.

OAT is platform independent. You can manually install and run OAT on any operating system for which you can set up and run the prerequisites listed in this section.

OAT requires that the following products be installed. The versions in parentheses indicate the versions with which OAT has been tested.

  • A web server (Apache 2.2.22, 2.4.2)
  • IBM Informix Connect or IBM Informix Client Software Development Kit (Client SDK) (4.10.xC2)
  • PHP 5.2.4 (minimum) compiled with PDO, PDO_SQLITE, GD, and SOAP-enabled (5.2.4, 5.4.4)
  • Informix PDO Module
  • Adobe Flash Player (11)
Important: The PHP and the PDO must come from the same PHP version.
Download packages

You can download the OpenAdmin Tool Community Edition from the IBM Informix Free Product Download page: https://www14.software.ibm.com/webapp/iwm/web/preLogin.do?lang=en_US&source=swg-informixfpd.

These files are available to download.

Table 2. OAT download packages
Download Description
oatidsV3.15.tar OpenAdmin Tool Community Edition packaged as a tar file. The package includes OAT, the Health Advisor plug-in, the Replication plug-in, the Schema Manager plug-in, the TimeSeries plug-in, and the JSON plug-in. It does not include Apache, PHP, PDO_informix, or IBM Informix Connect.
oatidsV3.15.zip OpenAdmin Tool Community Edition packaged as a compressed file. The package includes OAT, the Health Advisor plug-in, the Replication plug-in, the Schema Manager plug-in, the TimeSeries plug-in, and the JSON plug-in. It does not include Apache, PHP, PDO_informix, or IBM Informix Connect.
README.html Instructions on how to install the OpenAdmin Tool Community Edition. (This document.)
RELEASENOTES.html Fixed defects for the release. Link to new features.
Installation instructions
To install the OpenAdmin Tool Community Edition:
  1. Install and set up a working web server that is configured to serve PHP pages. For more information, see the Installation notes section.

    For further help, consult the web server product documentation for installation instructions, or contact the product customer service representatives for assistance.

  2. Update the PHP configuration file (php.ini):
    1. Open the php.ini file for editing.

      If you are using the XAMPP package:

      • Windows: Edit the php.ini file in the apache/bin folder, not in the php folder.
      • Linux: Edit the php.ini file in the /etc folder.
      • Mac OS X: Edit the php.ini file in the /Applications/xampp/etc folder.

      If you are not sure about the location of the correct php.ini configuration file, run the phpinfo() command within a PHP script on your web server to determine the location of the correct php.ini file.

    2. Add the following two lines after the extension=php_pdo.dll line to the "extension" section of the configuration file:
      extension=php_pdo_informix.dll
      extension=php_pdo_sqlite.dll 
      If these lines are already present, remove any comment indicators from in front of them.
    3. Modify the memory_limit parameter to be at least 256 MB.
  3. Install Informix Connect or Client SDK.
  4. Extract the OAT package into your web server document root directory rootdir/OATINSTALL. For example:
    • Windows: C:\xampp\htdocs\oat
    • UNIX or Linux:/usr/local/apache2/htdocs/oat
    • Mac OS X: /Applications/xampp/htdocs/oat
    Important: For security reasons, set password protection for the OAT administration web pages. For more information and an example, see Providing password protection for the Admin configuration pages: Apache example in the OAT Help or in the Informix information center at http://www.ibm.com/support/knowledgecenter/SSGU8G_12.1.0/com.ibm.oat.doc/ids_oat_071.htm.
  5. UNIX, Linux, or Mac OS X users: Change the user or group ownership and permissions on the OAT directories.
    1. Determine which user and group run the Apache (HTTPd) server from the httpd.conf file.
    2. Change ownership for each OAT subdirectory to the user and group that run the Apache (HTTPd) server.
    3. Grant write permissions to all OAT subdirectories and files.

      Following is the syntax for changing the ownership and permissions:

      chown user:group OATINSTALL; chmod +w OATINSTALL;

      Where OATINSTALL is the root directory for OAT, which is the same directory where you extracted the OAT package.

  6. In the web server environment, set the INFORMIXDIR environment variable to the Informix Connect or the Client SDK installation location.
    • Windows: In the Control Panel, click System. In the System Properties dialog box, click the Advanced tab, and then click Environment Variables. Add or edit the system variable INFORMIXDIR.
    • UNIX, Linux, and Mac OS X: Set the environment variable in the shell.
  7. Start the web server.

    If you started the web server before you modified the php.ini file or before you set the INFORMIXDIR environment variable in the environment, restart the web server for the changes to take effect.

  8. To start the OAT installer, go to http://SERVERNAME/OATINSTALL/install

    Where:

    • SERVERNAME is the name of the server where the web server is running
    • OATINSTALL is the location of OAT within your web server document root directory, where you extracted the OAT package.

    For example: http://localhost/oat/install

  9. Follow the instructions in the OAT installation screens:
    1. Read and accept the license agreement.
    2. Verify that all the required PHP modules are installed. If so, click Next; if not, check your PHP installation.
    3. Modify and verify the following configuration parameters:
      • LANG: Specify the default language for the application screens.
      • CONNDBDIR: Set the directory for the connections database.
        Important: For security purposes, specify a secure directory for the connections.db file. Do not use the web server document root directory. Additionally, ensure that the directory in which the connections.db file is located is accessible by the user who runs Apache.
      • BASEURL: Specify the root URL used to start OAT: http://SERVERNAME/OATINSTALL

        For example: http://localhost:8080/OAT

      • HOMEDIR: Verify the directory into which you extracted the installation package.
      • SECURESQL: Specify whether to prompt for login credentials when you use the SQLToolbox.
      • INFORMIXCONTIME: Specify the number of seconds that OAT waits to connect to the database server before OAT returns an error.
      • INFORMIXCONRETRY: Specify the number of times that OAT attempts to connect to the database server during the connect time that is specified by the INFORMIXCONTIME configuration parameter.
    4. To create the connections database, click Next. The connections database is created. Click Next to continue.
    5. Select the plug-ins to install and accept the plug-in license agreements.
  10. Optional: To access a database with a locale that is not included in Client SDK, install the locale by using the IBM Informix International Language Supplement (ILS). OAT requires the UTF-8 locales for all the databases that you access through OAT. After you install OAT, install ILS on the computer where OAT is installed, in the Informix Connect or Client SDK directory. Use ILS to install the additional locale, including the UTF-8 version, in the Informix Connect or Client SDK directory that OAT is using. The database name must be in English characters.
  11. When the installation is completed, go to the OAT root URL: http://SERVERNAME/OATINSTALL.
  12. On the Login page, select Admin and then expand Manage Connections to add an Informix 11.10 (or later) connection to the default group, or to create a group.

    If you are using an Informix Connect or Client SDK version earlier than V3.0, for each new connection that you add, ensure that there is a corresponding SQLHOSTS entry for that connection on the web server.

    To connect to a server, after a connection is created, click Login. Click Get Servers to retrieve the list of connections that you created, and then select the server.

Uninstalling OAT after manually installing

Important: If you installed OAT with the Client SDK, see the topic in the Informix information center on Uninstalling the OpenAdmin Tool (OAT) for Informix after installing it with the Client SDK: http://www.ibm.com/support/knowledgecenter/SSGU8G_12.1.0/com.ibm.cpi.doc/ids_cpi_032.htm . Do not remove OAT by manually deleting the files.

To uninstall OpenAdmin Tool Community Edition manually, delete the OATINSTALL directory.

Upgrading from a previous version of OAT

To upgrade to OpenAdmin Tool Community Edition v3.15 from a previous version, uninstall the old version and install the new version in the same directory. OAT v2.20 and later preserves the connection database information.

Installation notes

The following section provides more information about installing and configuring OAT and provides other support resources.
DBSPACETEMP configuration parameter
You must define an appropriate value for the DBSPACETEMP configuration parameter for all the database servers that you want to use for OAT before you use OAT.
Avoiding page timeout errors

Set the Informix Connect or Client SDK variables INFORMIXCONRETRY and INFORMIXCONTIME to avoid page timeout errors for invalid connection information. The recommended settings are:

  • INFORMIXCONRETRY=1
  • INFORMIXCONTIME=3
XAMPP package
For a manual installation, the XAMPP package is an easy-to-install Apache distribution that contains MySQL, PHP, and Perl. You can download the XAMPP package from the following website: http://www.apachefriends.org/en/xampp.html.

For more detailed instructions on how to install OAT by using the XAMPP package, refer to the following articles:

Informix PDO driver
The following IBM developerWorks article contains useful information to assist with building an Informix PDO driver: A step-by-step how-to guide to install, configure, and test a Linux, Apache, Informix, and PHP server: http://www.ibm.com/developerworks/data/library/techarticle/dm-0606bombardier/.

Configuring connectivity for high availability clusters

If you are using the high availability clusters features from OAT to start and stop secondary servers or to add SD secondary servers, you must configure the following daemons on the Informix server:

  • xinetd or inetd:
    • Linux - xinetd daemon.
    • UNIX - inetd daemon: See your operating system information.
  • idsd daemon: Installed with IBM Informix 11.50 and later. This file is in the $INFORMIXDIR/bin directory. For information and examples for configuring the idsd daemon, see Configuring connectivity for high availability clusters in the OAT HELP or in the Informix information center at http://www.ibm.com/support/knowledgecenter/SSGU8G_12.1.0/com.ibm.oat.doc/ids_oat_059.htm.

    The idsd daemon requires Informix 11.50 or later. Also, the idsd daemon is not currently available on Mac OS X or Windows. Without the idsd daemon, the high availability cluster management interface is available in OAT, but the feature set is limited.

Adding a plug-in to OAT

You can add plug-ins that are created by IBM or by other organizations to OAT. Plug-ins that are created by IBM are included in the automated and manual installations for OAT. For instructions on installing a plug-in from another organization, see Installing a plug-in for OAT in the OAT HELP or in the Informix information center at http://www.ibm.com/support/knowledgecenter/SSGU8G_12.1.0/com.ibm.oat.doc/ids_oat_000.htm .

OpenAdmin Tool support forums

To ask questions, exchange ideas, and share solutions with your peers in the Informix community, visit the following forums:

Notices

This information was developed for products and services offered in the U.S.A. This material may be available from IBM in other languages. However, you may be required to own a copy of the product or product version in that language in order to access it.

IBM may not offer the products, services, or features discussed in this document in other countries. Consult your local IBM representative for information on the products and services currently available in your area. Any reference to an IBM product, program, or service is not intended to state or imply that only that IBM product, program, or service may be used. Any functionally equivalent product, program, or service that does not infringe any IBM intellectual property right may be used instead. However, it is the user's responsibility to evaluate and verify the operation of any non-IBM product, program, or service.

IBM may have patents or pending patent applications covering subject matter described in this document. The furnishing of this document does not grant you any license to these patents. You can send license inquiries, in writing, to:

IBM Director of Licensing
IBM Corporation
North Castle Drive
Armonk, NY 10504-1785
U.S.A.

For license inquiries regarding double-byte (DBCS) information, contact the IBM Intellectual Property Department in your country or send inquiries, in writing, to:

Intellectual Property Licensing
Legal and Intellectual Property Law
IBM Japan, Ltd.
19-21, Nihonbashi-Hakozakicho, Chuo-ku
Tokyo 103-8510, Japan

The following paragraph does not apply to the United Kingdom or any other country where such provisions are inconsistent with local law: INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS PUBLICATION "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Some states do not allow disclaimer of express or implied warranties in certain transactions, therefore, this statement may not apply to you.

This information could include technical inaccuracies or typographical errors. Changes are periodically made to the information herein; these changes will be incorporated in new editions of the publication. IBM may make improvements and/or changes in the product(s) and/or the program(s) described in this publication at any time without notice.

Any references in this information to non-IBM websites are provided for convenience only and do not in any manner serve as an endorsement of those websites. The materials at those websites are not part of the materials for this IBM product and use of those websites is at your own risk.

IBM may use or distribute any of the information you supply in any way it believes appropriate without incurring any obligation to you.

Licensees of this program who wish to have information about it for the purpose of enabling: (i) the exchange of information between independently created programs and other programs (including this one) and (ii) the mutual use of the information which has been exchanged, should contact:

IBM Corporation
J46A/G4
555 Bailey Avenue
San Jose, CA 95141-1003
U.S.A.

Such information may be available, subject to appropriate terms and conditions, including in some cases, payment of a fee.

The licensed program described in this document and all licensed material available for it are provided by IBM under terms of the IBM Customer Agreement, IBM International Program License Agreement or any equivalent agreement between us.

Any performance data contained herein was determined in a controlled environment. Therefore, the results obtained in other operating environments may vary significantly. Some measurements may have been made on development-level systems and there is no guarantee that these measurements will be the same on generally available systems. Furthermore, some measurements may have been estimated through extrapolation. Actual results may vary. Users of this document should verify the applicable data for their specific environment.

Information concerning non-IBM products was obtained from the suppliers of those products, their published announcements or other publicly available sources. IBM has not tested those products and cannot confirm the accuracy of performance, compatibility or any other claims related to non-IBM products. Questions on the capabilities of non-IBM products should be addressed to the suppliers of those products.

All statements regarding IBM's future direction or intent are subject to change or withdrawal without notice, and represent goals and objectives only.

All IBM prices shown are IBM's suggested retail prices, are current and are subject to change without notice. Dealer prices may vary.

This information is for planning purposes only. The information herein is subject to change before the products described become available.

This information contains examples of data and reports used in daily business operations. To illustrate them as completely as possible, the examples include the names of individuals, companies, brands, and products. All of these names are fictitious and any similarity to the names and addresses used by an actual business enterprise is entirely coincidental.

COPYRIGHT LICENSE:

This information contains sample application programs in source language, which illustrate programming techniques on various operating platforms. You may copy, modify, and distribute these sample programs in any form without payment to IBM, for the purposes of developing, using, marketing or distributing application programs conforming to the application programming interface for the operating platform for which the sample programs are written. These examples have not been thoroughly tested under all conditions. IBM, therefore, cannot guarantee or imply reliability, serviceability, or function of these programs. The sample programs are provided "AS IS", without warranty of any kind. IBM shall not be liable for any damages arising out of your use of the sample programs.

Each copy or any portion of these sample programs or any derivative work, must include a copyright notice as follows:

© (your company name) (year). Portions of this code are derived from IBM Corp. Sample Programs.

© Copyright IBM Corp. _enter the year or years_. All rights reserved.

If you are viewing this information softcopy, the photographs and color illustrations may not appear.

Privacy policy considerations

IBM Software products, including software as a service solutions, (“Software Offerings”) may use cookies or other technologies to collect product usage information, to help improve the end user experience, to tailor interactions with the end user, or for other purposes. In many cases no personally identifiable information is collected by the Software Offerings. Some of our Software Offerings can help enable you to collect personally identifiable information. If this Software Offering uses cookies to collect personally identifiable information, specific information about this offering’s use of cookies is set forth below.

This Software Offering does not use cookies or other technologies to collect personally identifiable information.

If the configurations deployed for this Software Offering provide you as customer the ability to collect personally identifiable information from end users via cookies and other technologies, you should seek your own legal advice about any laws applicable to such data collection, including any requirements for notice and consent.

For more information about the use of various technologies, including cookies, for these purposes, see IBM’s Privacy Policy at http://www.ibm.com/privacy and IBM’s Online Privacy Statement at http://www.ibm.com/privacy/details in the section entitled “Cookies, Web Beacons and Other Technologies”, and the “IBM Software Products and Software-as-a-Service Privacy Statement” at http://www.ibm.com/software/info/product-privacy.

Trademarks

IBM, the IBM logo, and ibm.com® are trademarks or registered trademarks of International Business Machines Corp., registered in many jurisdictions worldwide. Other product and service names might be trademarks of IBM or other companies. A current list of IBM trademarks is available on the web at "Copyright and trademark information" at http://www.ibm.com/legal/copytrade.shtml.

Adobe, the Adobe logo, and PostScript are either registered trademarks or trademarks of Adobe Systems Incorporated in the United States, and/or other countries.

Four Js is a registered trademark of Four Js Development Tools Ltd.

Genero and its logo are registered trademarks of Four Js Development Tools Europe Ltd.

Intel, Itanium, and Pentium are trademarks or registered trademarks of Intel Corporation or its subsidiaries in the United States and other countries.

Linux is a registered trademark of Linus Torvalds in the United States, other countries, or both.

Microsoft, Windows, and Windows NT are trademarks of Microsoft Corporation in the United States, other countries, or both.

Java™ and all Java-based trademarks and logos are trademarks or registered trademarks of Oracle and/or its affiliates.

UNIX is a registered trademark of The Open Group in the United States and other countries.

Other company, product, or service names may be trademarks or service marks of others.

Contact support: http://www.ibm.com/support/entry/portal/

© Copyright The PHP Group 1997-2012. See the license/notices.txt file for additional information.