Cold Fusion Server Install Documentation
Cold Fusion Server Install Documentation
Installing and
Configuring
ColdFusion Server
ColdFusion Server 5
Macromedia, Inc.
install.book Page ii Thursday, May 10, 2001 12:59 PM
Copyright Notice
Contents
iv
vi
Tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
Logs and Statistics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
Logging Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
Log files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
Server Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
Contents
• Intended Audience................................................................................................... viii
• New Features ............................................................................................................ viii
• Developer Resources................................................................................................... x
• About ColdFusion Documentation .......................................................................... xi
• Getting Answers ........................................................................................................ xii
• Contacting Macromedia.......................................................................................... xiii
install.book Page viii Thursday, May 10, 2001 12:59 PM
Intended Audience
Installing and Configuring ColdFusion Server is intended for anyone who needs to
install, configure, and maintain ColdFusion Server 5. It describes:
• System requirements
• Installation processes for all supported operating systems
• Operating system-specific configuration instructions
• Basic configuration options using the ColdFusion Administrator
New Features
The following table lists the new features in ColdFusion 5:
New Features ix
Developer Resources
Macromedia Corporation is committed to setting the standard for customer support
in developer education, technical support, and professional services. The Web site is
designed to give you quick access to the entire range of online resources, as the
following table describes.
Book Description
Installing and Describes system installation and basic configuration for
Configuring Windows, Solaris, Linux, and HP-UX.
ColdFusion Server
Advanced Describes how to connect your data sources to the ColdFusion
ColdFusion Server, configure security for your applications, and how to use
Administration ClusterCATS to manage scalability, clustering, and
load-balancing for your site.
Developing Describes how to use ColdFusion Server to develop your
ColdFusion dynamic Web applications, including retrieving and updating
Applications your data, using structures, and forms.
Getting Answers
One of the best ways to solve particular programming problems is to tap into the vast
expertise of the ColdFusion developer communities on the ColdFusion Forums at
http://forums.coldfusion.com. Other developers on the forum can help you figure
out how to do just about anything with ColdFusion Server. The search facility can
also help you search messages from the previous 12 months, allowing you to learn
how others have solved a problem that you might be facing. The Forums is a great
resource for learning ColdFusion, but it is also a great place to see the ColdFusion
developer community in action.
install.book Page xiii Thursday, May 10, 2001 12:59 PM
Contacting Macromedia
Chapter 1
This chapter explains how to install and configure ColdFusion Server in Windows.
Contents
• Windows System Requirements................................................................................. 4
• Before You Begin the Installation............................................................................... 5
• Installing ColdFusion Server in Windows ............................................................... 10
• Configuring Your Installation................................................................................... 14
• What to Do Next ........................................................................................................ 21
install.book Page 4 Thursday, May 10, 2001 12:59 PM
ColdFusion ColdFusion
Server Server
Requirement Professional Enterprise
Windows Version
Windows 98 x
Windows NT 4.0 (Workstation and Server) x x
Windows 2000 (Professional*, Server, and x x
Advanced Server)
Hardware
Processor Pentium Pentium
Minimum RAM (MB) 128 256
Recommended RAM (MB) 256 512
Free Hard Disk Space (MB) 200 400
CD-ROM Drive x x
Web Servers
Microsoft Personal Web Server (PWS) x
Microsoft IIS 4.0, 5.0 x x
iPlanet/Netscape Enterprise Server 3.6, 4.1 x x
Apache Server 1.3.x*† x x
O’Reilly WebSite Professional* 2.0, 3.0 x x
WebSite Server API (WSAPI)* x x
* ClusterCATS and Application Management features are not supported on
these platforms.
† ColdFusion Server provides a precompiled module that is binary compat-
ible with versions 1.3.6 through 1.3.19. ColdFusion Server also provides
the files required to build a version of the ColdFusion plug-in module for
a custom version of Apache 1.3.x. For more information, see “Configur-
ing Web servers manually” on page 14.
install.book Page 5 Thursday, May 10, 2001 12:59 PM
Operating
System Update Where to find it
Windows 98 Service Pack 1 http://www.microsoft.com/downloads/
MDAC 2.5 SP1 http://www.microsoft.com/data/downloads/
MFC/MSVC 6.0 localdrive\ColdFusion
Image\Redistrib\MSVCRT\setup.exe
NT Option Pack http://www.microsoft.com/msdownload/
ntoptionpack/askwiz.asp
Window NT 4.0 Service Pack 6a http://www.microsoft.com/downloads/
MDAC 2.5 SP1 http://www.microsoft.com/data/
download.htm
MFC/MSVC 6.0 localdrive\ColdFusion
Image\Redistrib\MSVCRT\setup.exe
Simple Network Required only for MIB functionality. For
Management instructions, see “Installing SNMP in Windows
Protocol NT 4.0 Server and Windows 2000 Server” on
(SNMP)* page 6 and “Configuring SNMP MIB” on page
19.
Windows 2000 Service Pack 1 http://www.microsoft.com/downloads/
MDAC 2.5 SP1 http://www.microsoft.com/data/
download.htm
MFC/MSVC 6.0 localdrive\ColdFusion
Image\Redistrib\MSVCRT\setup.exe
install.book Page 6 Thursday, May 10, 2001 12:59 PM
Operating
System Update Where to find it
SNMP† Required only for MIB functionality. For
instructions, see “Installing SNMP in Windows
NT 4.0 Server and Windows 2000 Server” on
page 6 and “Configuring SNMP MIB” on page
36.
* Windows NT 4.0 Server only
† Windows 2000 Server only
Note
If you chose to overwrite new files during the SNMP installation, you must re-apply
your most recent operating system Service Pack after the SNMP installation because
the SNMP install includes some older files.
After finishing the ColdFusion Server installation, you must configure your system to
use the MIB features. For more information, see “Configuring SNMP MIB” on page
19.
Warning
Before proceeding with the upgrade, backup your ColdFusion Server Web
applications.
The following table lists important installation options and considerations for
ColdFusion Enterprise Edition customers:
Warning
Because of potential security concerns, the ColdFusion Server team recommends
that you not install the example applications in production environments.
7 After the Assign Password and Confirm Selections dialogs, the Install Wizard
begins copying the ColdFusion Server files to your system.
8 Restart your system.
Service Purpose
ColdFusion Application The main ColdFusion Server service. ColdFusion pages
Server cannot be processed if this service is not running.
ColdFusion Executive Polls the ColdFusion Application Server service and, if it is
not running, restarts it.
ColdFusion Remote Provides security, directory and file browsing, and
Development Service debugging services for ColdFusion Studio.
(RDS)
* Available only in ColdFusion Server Enterprise
install.book Page 12 Thursday, May 10, 2001 12:59 PM
Service Purpose
SiteMinder Authentication Available only if you select the Advanced Security option
Service* during ColdFusion Server setup. Provides user
authentication services for advanced security.
SiteMinder Authorization Available only if you select the Advanced Security option
Service* during ColdFusion Server installation. Provides access
authorization services for advanced security.
ColdFusion Management Supports ColdFusion Management features, including
Service* Archive/Restore and Server Reporting.
ColdFusion Monitoring Monitors the performance and availability of the
Service* ColdFusion Server, the HTTP server, and probes that are
created. This service supports ClusterCATS and
Application Monitoring.
ColdFusion Graphing Provides a Java runtime required for Macromedia
Server* Generator (cfgraph) support.
ColdFusion Management Provides Repository Management facilities for the
Repository Server* ColdFusion Management Service.
* Available only in ColdFusion Server Enterprise
Executable Purpose
ColdFusion Application The main ColdFusion Server service. ColdFusion pages
Server cannot be processed if this service is not running.
ColdFusion RDS Provides security, directory and file browsing, and
debugging services for ColdFusion Studio.
When ColdFusion Server is running, two icons appear in the task bar. To stop the
ColdFusion Application Server executable, right-click the IDE service icon. To run
ColdFusion Server at startup, place a shortcut for the ColdFusion Server icon in the
Startup program group.
install.book Page 14 Thursday, May 10, 2001 12:59 PM
Tip
If you run ColdFusion Server on Windows 2000 with IIS5, you can improve
performance as follows: open the Internet Services Manager, right-click Default Web
Site, and select Properties. On the Home Directory tab, select Low (IIS Process) in the
Application Protection drop-down list, and click Apply. Stop IIS Admin and all Web
services from the Windows NT Control Panel, and then restart IIS.
2 In the Tree tab, under the Internet Information Services tree, right-click your
Web site and select Properties.
The Properties dialog box displays:
Note
If the Configuration button is greyed out, click Create, then click Configuration.
install.book Page 16 Thursday, May 10, 2001 12:59 PM
4 In the App Mappings tab, select entries for.cfm and .dbm, and click Remove.
5 Click Add.
The Add/Edit Application Extension Mappings dialog box displays:
Note
In previous versions, ColdFusion Server used the .dbm file extension for
ColdFusion Server files. Macromedia recommends that you rename templates
that have a .dbm extension to .cfm.
Warning
Ensure that you do not alter files in the backup or install directories.
Note
Netscape is case sensitive, so add the lines exactly as they appear here . Enter
each command one line. If you remove ColdFusion Server, you must undo these
changes. Otherwise, the iPlanet/Netscape Web server will not work.
Tip
You can find a copy of the MIB definition in CFusion/cfam/Database/lhmib.mib.
2 Select the Log On tab. Click This account. Enter appropriate account
information.
3 Click OK to apply the changes.
Restart ColdFusion Server services.
Warning
Do not rename your Windows Administrator account. It causes problems with
security policies and profiles.
install.book Page 21 Thursday, May 10, 2001 12:59 PM
What to Do Next 21
What to Do Next
After installing ColdFusion Server and configuring your installation, you must
perform some initial administration tasks using the ColdFusion Administrator,
ColdFusion Server’s Web-based control console. For more information, see “Initial
Administration Tasks” on page 68.
install.book Page 22 Thursday, May 10, 2001 12:59 PM
Chapter 2
This chapter explains how to install and configure ColdFusion Server in Solaris.
Contents
• Solaris System Requirements ................................................................................... 24
• Before You Begin the Installation............................................................................. 25
• Installing ColdFusion Server in Solaris.................................................................... 29
• Configuring Your Installation................................................................................... 33
• What to Do Next ........................................................................................................ 38
install.book Page 24 Thursday, May 10, 2001 12:59 PM
ColdFusion
Requirement Server Enterprise
Solaris Version
Solaris 2.6, 7, 8 x
Hardware
Processor SPARC
Minimum RAM (MB) 256
Recommended RAM (MB) 512
Free Hard Disk Space (MB) 350
CD-ROM Drive x
Web Server
iPlanet/Netscape Enterprise Server 3.6, 4.1 x
Apache Server 1.3.x* x
* ColdFusion Server provides a precompiled module that is binary compat-
ible with versions 1.3.6 through 1.3.19. ColdFusion Server also provides
the files required to build a version of the ColdFusion plug-in module for
a custom version of Apache 1.3.x. For more information, see “Configur-
ing Web servers manually” on page 33.
install.book Page 25 Thursday, May 10, 2001 12:59 PM
Operating
System Patch Description
Solaris 2.6 105181-17 or higher Kernel patch
105591-09 or higher LibC: Shared library patch for C++
105210-25 or higher LibC: Shared library patch for C/C++
105568-14 or higher libthread: Shared library patch
Solstice Enterprise Required only for MIB functionality. For
Agent (SEA) Runtime instructions, see “Installing SNMP in Solaris”
1.0.3 on page 26.
Solaris 7 106541-08 or higher Kernel patch
106327-08 or higher LibC: Shared library patch for C++
106980-07 or higher libthread: Shared library patch
107709-10 or higher Required only for MIB functionality. For
instructions, see “Installing SNMP in Solaris”
on page 26.
Solaris 8 108869-03 or higher Required only for MIB functionality. For
instructions, see “Installing SNMP in Solaris”
on page 26.
en_US locale U.S. English language pack
Note
All versions of Solaris require the SUNWxcu4 -- XCU4 Utilities package. To download
all patches and packages, go to http://sunsolve.sun.com.
install.book Page 26 Thursday, May 10, 2001 12:59 PM
Note
For more information on installing the SEA packages, see Chapter 2, "Installing
Solstice Enterprise Agent" in the SEA User Guide Release 1.0 (docs/UGhtml/
install_solaris.doc.html).
Note
Before proceeding with the upgrade, backup your ColdFusion Server Web
applications.
install.book Page 28 Thursday, May 10, 2001 12:59 PM
Note
The uninstall script removes your odbc.ini file and all Verity collections. To
preserve them, copy them to a new location before uninstalling ColdFusion Server.
Note
You can find your ColdFusion Server license key on the product box and the
CD-ROM packaging.
8 After entering the install directory for ColdFusion Server, the installation process
prompts you to enter the name of your Web server.
Note
If you entered Other or if you have a custom release of Apache, such as usr/local/
apache, see “Configuring Web servers manually” on page 33.
9 You are prompted to enter y to install the ColdFusion Server options. For each
option that you want to install, enter y. The following table describes the options:
Option Description
Reporting and Accessed through the ColdFusion Administrator, this option
Archive/ provides ColdFusion application reporting statistics and the ability
Deploy to archive and deploy ColdFusion applications.
Monitors, Accessed through the ColdFusion Administrator, this option
Alarms, and provides ColdFusion application performance monitoring,
Load-Balancer threshold alarms, and hardware load-balancing integration for
Integration Cisco LocalDirector. If you select ClusterCATS, these features is
provided through the ClusterCATS Web Administrator.
ClusterCATS Provides software-based load-balancing and IP failover support
for ColdFusion Server. If you want the server on which you install
ClusterCATS to be able to assume the IP address and HTTP
traffic of a failed server in the cluster, enter y to configure this
server with failover services. For more information, see
“Preparing Your Server for ClusterCATS” on page 135.
SNMP MIB Provides application information to third-party applications. You
must install SNMP on Solaris before installing ColdFusion Server.
For instructions, see “Installing SNMP in Solaris” on page 26 and
“Configuring SNMP MIB” on page 36.
10 After supplying the directory for your Web server documentation, entering and
confirming passwords for the ColdFusion Administrator and ColdFusion Studio,
your are prompted to install Advanced Security. To do this, you must have a
functioning LDAP server for policy storage.
Solaris customers currently using Advanced Security in ColdFusion Server 4.5
encounter a question during installation as to whether SiteMinder is installed.
This is referring to the full, retail version of Netegrity SiteMinder, and it enables
ColdFusion Single Sign-On support in ColdFusion automatically. For details on
this, see your Netegrity SiteMinder documentation.
You are prompted for a target LDAP server instance to migrate the SiteMinder
policy store. ColdFusion Server 5 requires that you do so. This one-time
procedure requires a second, properly-configured LDAP server instance. At the
end of the migration procedure, the install automatically configures Advanced
Security to use this second LDAP instance as the SiteMinder policy store.
11 Select whether to install ColdFusion Server documentation and examples. The
documentation is installed in the /cfdocs directory, under the Web root
directory.
Warning
Because of potential security concerns, the ColdFusion Server team recommends
that you not install the example applications in production environments.
install.book Page 31 Thursday, May 10, 2001 12:59 PM
12 Enter the user name under which ColdFusion Server runs, or press Enter to run
under the default user name ("nobody").
13 Press Enter to begin the installation.
When the installation is complete, a shell script restarts the Web server and starts
ColdFusion Server services. If the ColdFusion Server services are not started
automatically, you can start them manually using the ColdFusion Server start-up
script, which is located in the coldfusion/bin directory.
Process Purpose
cfexec Starts/stops the other processes and manages page scheduling
cfserver The main ColdFusion Server service. ColdFusion pages cannot
be processed if this service is not running.
cfrdsservice Provides system support for the Administrator as well as
security and debugging services for ColdFusion Studio
cfsecurityproxy Links ColdFusion Server to the SiteMinder system
smservauth Provides SiteMinder authentication service
smservaz Provides SiteMinder authorization service
java Provides a runtime for the ColdFusion Server graphing and
charting features and application management features
ipaliasd Provides IP failover capability for ClusterCATS
reqmgr Processes ClusterCATS operations as root
ccmgr Creates processes to support ClusterCATS
wsprobe Probes the application server for load and restarts
unresponsive Web servers
CANamingAdapter Controls the data store for application management features
dfp Provides load-balancing information to LocalDirector
In addition, ColdFusion Application Manager provides two scripts for starting and
stopping ClusterCATS and the Application Manager:
/opt/coldfusion/bin/cfam-start
/opt/coldfusion/bin/cfam-stop
Note
To run scripts, you must be logged in with root privileges.
ColdFusion Server also provides the following scripts to start and stop ColdFusion
Server during system startup and shutdown:
Script Function
/etc/init.d/coldfusion Starts or stops ColdFusion Server
/etc/rc1.d/K19coldfusion Stops ColdFusion Server during system shutdown
/etc/rc3.d/S25coldfusion Starts ColdFusion Server during system startup
/etc/init.d/btccmgr start Starts ClusterCATS and application management
processes.
/etc/init.d/btccmgr Stops ClusterCATS and application management
restart processes.
install.book Page 33 Thursday, May 10, 2001 12:59 PM
Note
If you run the Netscape/iPlanet Server Manager, the browser-based
administrator, you may get a warning about edits to the Netscape configuration
files. This is normal. To reload the new configuration files, follow the instructions
and click Apply
After you configure mod_so in your Apache binary, the simplest way to configure the
ColdFusion Server module is to use the apxs program that is included in the Apache
distribution. It installs by default in <apachedir>/apache/bin. This is a Perl script, so
you must have Perl installed on your system. Perl is available at http://
www.perl.com.
Note
If you have a ClearModuleList directive in httpd.conf, you must add this directive
to the AddModule list, as stated by the comments in the httpd.conf file:
AddModule mod_coldfusion.c
3 Restart Apache.
install.book Page 36 Thursday, May 10, 2001 12:59 PM
Tip
You can find the MIB definition in /usr/lib/btcats/database/lhmib_UNIX.mib.
install.book Page 37 Thursday, May 10, 2001 12:59 PM
Configuring databases
After the install has completed, but before you can setup data sources in the
ColdFusion Administrator, you must edit the /opt/coldfusion/bin/start script to
include information about your database(s).
Normally this requires two changes per database: setting a database-specific
environment variable, and adding the path to the client-side database libraries to
your LD_LIBRARY_PATH environment variable. Examples are provided in the start
script to help you.
After editing the start script, you must stop and restart ColdFusion Server for the
changes to take effect. Then use ColdFusion Administrator to set up your data
sources.
Note
ColdFusion Server no longer supports OpenIngres database drivers on Solaris.
Note
For more information on configuring data sources for ColdFusion Server, see
“Managing Data Sources” on page 109. Also, see the ODBC 3.7 documentation PDF
file in /opt/coldfusion/odbc/doc/odbcref.pdf.
install.book Page 38 Thursday, May 10, 2001 12:59 PM
What to Do Next
After installing ColdFusion Server and configuring your installation, you must
perform some initial administration tasks using the ColdFusion Administrator,
ColdFusion Server’s Web-based control console. For more information, see “Initial
Administration Tasks” on page 68.
install.book Page 39 Thursday, May 10, 2001 12:59 PM
Chapter 3
This chapter explains how to install and configure ColdFusion Server in Linux.
Contents
• Linux System Requirements..................................................................................... 40
• Before You Begin the Installation............................................................................. 41
• Installing ColdFusion Server in Linux ..................................................................... 44
• Configuring Your Installation................................................................................... 48
• What to Do Next ........................................................................................................ 53
install.book Page 40 Thursday, May 10, 2001 12:59 PM
ColdFusion ColdFusion
Server Server
Requirement Professional Enterprise
Linux Distribution
Red Hat Linux 6.2 and later* x x
SuSE Linux 7.0 and later*† x x
Cobalt RAQ3, RAQ4, XTR*† x x
Hardware
Processor Pentium Pentium
Minimum RAM 128 MB 256 MB
Recommended RAM 256 MB 512 MB
Free Hard Disk Space 200 MB 350 MB
CD-ROM Drive x x
Web Server
iPlanet/Netscape Enterprise Server 4.1† x x
Apache Server 13.6‡ x x
* All Linux distributions must be running glibc-2.1.3-11 or later, gcc/egcs
libstdc++ 2.9, and 2.2 kernel or later. For performance reasons, the Cold-
Fusion team recommends performing a Linux Server or Custom install
of Red Hat 6.x rather than KDE or GNOME installation.
† ClusterCATS and Application Management features are not supported on
this platform.
‡ ColdFusion Server provides a precompiled module that is binary compat-
ible with versions 1.3.6 through 1.3.19. ColdFusion Server also provides
the files required to build a version of the ColdFusion plug-in module for
a custom version of Apache 1.3.x. For more information, see “Configur-
ing Web servers manually” on page 48.
install.book Page 41 Thursday, May 10, 2001 12:59 PM
Linux
Distribution Patch Where to find it
Red Hat 6.2, 7.0 compat-libstdc++ RPM ftp://ftp.redhat.com/pub/redhat/current/
UCD-SNMP 4.2.1 Required only for MIB functionality. For
instructions, see “Installing SNMP in
Red Hat” on page 41.
SuSE 7.0 apache.rpm ftp://ftp.suse.com/pub/suse/i386/
update/
Cobalt RAQ 3, glibc-2.1.3-22 http://www.cobalt.com/support/
RAQ4, XTR download/index.html
glibc-profile-2.1.3-22 http://www.cobalt.com/support/
download/index.html
glibc-devel-2.1.3-22 http://www.cobalt.com/support/
download/index.html
Red Hat 6.0 glibc patch ftp://ftp.redhat.com/pub/redhat/current/
Tip
To find the version of SNMP that you are currently running, enter snmpd -v.
install.book Page 42 Thursday, May 10, 2001 12:59 PM
Note
By default, UCD-SNMP installs into the /usr/sbin directory.
Warning
Before proceeding with the upgrade, backup your ColdFusion Server Web
applications.
Note
You can find your ColdFusion Server license key on the product box and the
CD-ROM packaging.
8 After entering the install directory for ColdFusion Server, the installation process
prompts you to enter the name of your Web server.
Note
If you entered Other or if you have a custom release of Apache, such as usr/local/
apache, see “Configuring Web servers manually” on page 48.
Warning
Because of potential security concerns, the ColdFusion Server team recommends
that you not install the example applications in production environments.
10 After entering and confirming the passwords for the ColdFusion Administrator
and ColdFusion Studio, enter the login name under which ColdFusion Server
runs.
11 For each option that you want to install, you are prompted to enter y to install the
ColdFusion Server options. Enter y for each option to install.
The following table lists important installation option options and
considerations for ColdFusion Enterprise Edition customers:.
Option Description
Reporting and Accessed through the ColdFusion Administrator, this option
Archive/ provides ColdFusion application reporting statistics and the ability
Deploy to archive and deploy ColdFusion applications.
Monitors, Accessed through the ColdFusion Administrator, this option
Alarms, and provides ColdFusion application performance monitoring,
Load-Balancer threshold alarms, and hardware load-balancing integration for
Integration Cisco LocalDirector. If you select ClusterCATS, these features is
provided through the ClusterCATS Web Administrator.
ClusterCATS Provides software-based load-balancing and IP failover support
for ColdFusion Server. If you want the server on which you are
installing ClusterCATS to be able to assume the IP address and
HTTP traffic of a failed server in the cluster, enter y to configure
this server with failover services. For more information, see
“Preparing Your Server for ClusterCATS” on page 135.
SNMP MIB Provides application information to third-party applications. You
must install SNMP on Linux before installing ColdFusion Server.
For instructions, see “Installing SNMP in Red Hat” on page 41
and “Configuring SNMP MIB” on page 51.
Process Purpose
cfexec Starts and stops the other processes and manages page
scheduling.
cfserver The main ColdFusion Server service. ColdFusion pages cannot
be processed if this service is not running.
cfrdsservice Provides system support for the Administrator and security and
debugging services for ColdFusion Studio,
java Provides a runtime for the ColdFusion Server graphing and
charting features and application management features.
ipaliasd Provides IP failover capability for ClusterCATS.*
reqmgr Processes ClusterCATS operations as root.*
ccmgr Creates processes to support ClusterCATS*
wsprobe Probes the application server for load and restarts
unresponsive Web servers*
CANamingAdapter Controls the data store for application management features*
dfp Provides load-balancing information to LocalDirector*
* Available in ColdFusion Server Enterprise only
Note
To run the scripts, you must be logged in with root privileges.
install.book Page 47 Thursday, May 10, 2001 12:59 PM
ColdFusion Server also provides the following scripts to start and stop ColdFusion
Server during system startup and shutdown:
Script Function
/etc/rc.d/init.d/coldfusion Starts and stops ColdFusion Server.
/etc/rc1.d/K19coldfusion Stops ColdFusion Server during system
shutdown.
/etc/rc3.d/S90coldfusion Starts ColdFusion Server during system
/etc/rc4.d/S90coldfusion startup.
/etc/rc5.d/S90coldfusion
/etc/rc.d/init.d/btccmgr start Starts ClusterCATS and application
management processes.
/etc/rc.d/init.d/btccmgr restart Stops ClusterCATS and application
management processes.
install.book Page 48 Thursday, May 10, 2001 12:59 PM
Note
If you run the Netscape/iPlanet Server Manager, the browser-based Web server
administrator, you may receive a warning about edits to Netscape configuration
files. This is normal. To reload the new configuration files, follow the instructions
and click Apply.
If your server does not restart, check that the pathname for the plug-in you
specified in the obj.conf file is correct for your installation and that it is on a
single line.
Warning
Ensure that the following line does not appear in snmpd.conf more than once:
dlmod allaire /usr/lib/btcats/program/allaire_mib.so
Tip
You can find a copy of the MIB definition in /usr/lib/btcats/database/
lhmib_UNIX.mib.
Configuring databases
After the install is complete, but before you can set up data sources in the
ColdFusion Administrator, you must edit the /opt/coldfusion/bin/start script to
include information about whatever database(s) you use.
install.book Page 52 Thursday, May 10, 2001 12:59 PM
Note
For more information, see “Managing Data Sources” on page 109.
In Linux, you must use certain database clients in Linux. The following table lists the
required clients for ColdFusion Server 5 in Linux:
• The Oracle ODBC database driver requires the Oracle Client version 8.1.6.1 or
higher.
• Red Hat requires the following Sybase Open Client 11.9.2-3 components or later
to use the Sybase native database driver:
− sybase-common-11.9.2-3.i386.rpm
− sybase-openclient-11.1.1-3.i386.rpm
install.book Page 53 Thursday, May 10, 2001 12:59 PM
What to Do Next 53
What to Do Next
After installing ColdFusion Server and configuring your installation, you must
perform some initial administration tasks using the ColdFusion Administrator,
ColdFusion Server’s Web-based control console. For more information, see “Initial
Administration Tasks” on page 68.
install.book Page 54 Thursday, May 10, 2001 12:59 PM
Chapter 4
This chapter explains how to install and configure ColdFusion Server in HP-UX.
Contents
• HP-UX System Requirements................................................................................... 56
• Before You Begin the Installation............................................................................. 57
• Installing ColdFusion Server in HP-UX ................................................................... 60
• Configuring Your Installation................................................................................... 62
• What to Do Next ........................................................................................................ 66
install.book Page 56 Thursday, May 10, 2001 12:59 PM
ColdFusion
Requirement Server Enterprise
HP-UX Version
HP-UX 11.0 x
Hardware
Processor PA-RISC 1.1 or 2.0
Minimum RAM 128 MB
Recommended RAM 128 MB
Free Hard Disk Space 120 MB
CD-ROM Drive x
Web Server
iPlanet/Netscape Enterprise Server 3.51, 4.1 x
Apache Server 1.3.x* x
* ColdFusion Server provides a precompiled module that is binary compat-
ible with versions 1.3.6 through 1.3.19. ColdFusion Server also provides
the files required to build a version of the ColdFusion plug-in module for
a custom version of Apache 1.3.x. For more information, see “Configur-
ing Web servers manually” on page 62.
install.book Page 57 Thursday, May 10, 2001 12:59 PM
maxdsize 0x79000000
maxssize 0x8000000
maxtsize 0x8000000
maxfiles 1024
maxusers 64 (to indirectly boost NKTHREAD, used below)
max_thread_proc (NKTHREAD-10)
• Note the Web server, Web root, and configuration file locations. They will be
needed during the installation.
• Note the HP-UX username under which ColdFusion Server will run. It will be
needed during the installation.
• Note where you want to install ColdFusion Server on your system (/opt is the
default directory).
Warning
Before upgrading, backup your ColdFusion Server Web applications.
The CD-ROM should be visible under /SD_CDROM. When you finish using the
CD-ROM, you can unmount it using the following command:
/usr/sbin/pfs_umount /SD_CDROM
Note
You can find your ColdFusion Server license key on the product box and the
CD-ROM packaging.
6 After entering the install directory for ColdFusion Server, the installation process
prompts you to enter the name of your Web server.
At the corresponding prompt, enter y to let the installation script automatically
configure your Web server. If you use Apache, you must configure it manually.
For more information, see “Configuring Web servers manually” on page 62. Enter
the install home directory, the instance root directory, and document root
directory for your Web server at the corresponding prompts.
7 Select whether to install the ColdFusion Server documentation and example
applications.
Warning
Because of potential security concerns, the ColdFusion Server team recommends
that you not install the example applications in production environments.
When the installation is complete, the install program starts the ColdFusion Server
services.
If you are running a version of the Netscape/iPlanet Web server, the install program
also configures the Web server to run ColdFusion Server and restart the Web server
automatically.
If you are running the Apache Web server, you must configure and restart the Web
server manually before it will work with ColdFusion Server. Follow the instructions
displayed by the ColdFusion Server installation script for configuring the Apache
Web server, or see “Configuring Web servers manually” on page 62.
Process Purpose
cfexec Starts/stops the other processes and manages page scheduling
cfserver The main ColdFusion Server service. ColdFusion pages cannot be
processed if this service is not running.
cfrdsservice Provides system support for the Administrator and security and
debugging services for ColdFusion Studio
Note
If you run Netscape/iPlanet Server Manager, the browser-based administrator,
you get a warning about edits to the Netscape configuration files. This is normal.
To reload the new configuration files, follow the instructions and click Apply.
Note
For more information, see the Readme file located in /opt/coldfusion/
webserver/apache.
4 For Apache to use the ColdFusion DSO, you must enable Apache DSO support.
To check whether DSO support is enabled, enter the following command from
within the Apache bin directory:
httpd -l
If the output does not include a line containing something like mod_so.c, you
must enable DSO support by running the configure script with the
enable-module option included; for example:
configure --enable-module=rewrite --enable-shared=rewrite
install.book Page 64 Thursday, May 10, 2001 12:59 PM
Configuring databases
After the install is completed, but before you can set up a data source in the
ColdFusion Administrator, you must edit the /opt/coldfusion/bin/start script to
include information about the database(s) you use.
Normally this requires two changes per database: setting a database-specific
environment variable, and adding the path to the client-side database libraries to
your SHLIB_PATH environment variable. The start script provides examples to help
you.
After editing the start script, you must stop and restart ColdFusion Server for the
changes to take effect. After that finishes, proceed to the ColdFusion Administrator
to set up your data sources.
Note
For more information, see “Managing Data Sources” on page 109.
install.book Page 65 Thursday, May 10, 2001 12:59 PM
What to Do Next
After installing ColdFusion Server and configuring your installation, you must
perform some initial administration tasks using the ColdFusion Administrator,
ColdFusion Server’s Web-based control console. For more information, see “Initial
Administration Tasks” on page 68.
install.book Page 67 Thursday, May 10, 2001 12:59 PM
Chapter 5
Contents
• Initial Administration Tasks ..................................................................................... 68
• The ColdFusion Administrator ................................................................................ 69
• Server Settings ........................................................................................................... 70
• Caching ...................................................................................................................... 71
• Client Variables.......................................................................................................... 72
• Memory Variables ..................................................................................................... 76
• Locking....................................................................................................................... 77
• Mappings ................................................................................................................... 79
• Mail/Mail Logging..................................................................................................... 80
• Data Sources .............................................................................................................. 82
• Verity Collections ...................................................................................................... 83
• Debug Settings........................................................................................................... 88
• Automated Tasks ....................................................................................................... 90
• Extensions.................................................................................................................. 93
• Security ...................................................................................................................... 99
• Basic Security........................................................................................................... 100
• Tools ......................................................................................................................... 102
• Logs and Statistics ................................................................................................... 103
install.book Page 68 Thursday, May 10, 2001 12:59 PM
Task Description
Establish ColdFusion applications require data source connections to query
database and write to databases. To create, verify, modify, and delete
connections database connections, use the Data Sources pages in the
Administrator.
For more information, see “Managing Data Sources” on page 109.
Specify directory Directory mappings redirect relative file paths to physical
mappings directories on your server. To specify server-wide directory aliases,
use the Mappings page in the Administrator.
For more information, see “Mappings” on page 79.
Configure debug Debug information provides important data about CFML page
options processing. To choose what debug information to display and to
designate an IP address(es) to receive debug information, use the
Debug Settings pages of the Administrator.
For more information, see “Debug Settings” on page 88.
Set up e-mail E-mail lets ColdFusion Server and ColdFusion applications send
automated mail messages. To configure an email server and mail
options, use the Mail/Mail Logging page of the Administrator.
For more information, see “Mail/Mail Logging” on page 80.
Change You may have to change the passwords that you set for the
passwords ColdFusion Administrator and ColdFusion Studio during the
ColdFusion Server installation. To change passwords, use the
Basic Security pages of the Administrator.
For more information, see “CF Admin Password” on page 100 and
“CF Studio Password” on page 101.
Configure Java Java and Java applets require configuring Java settings, such as
settings JVM paths. To change Java settings, use the JVM and Java
Settings page of the Administrator.
For more information, see “Extensions” on page 93.
Restrict tag Some CFML tags may present a potential security risk for your
access server. To disable certain tags and tag attributes system-wide, use
the Tag Restrictions page of the Administrator.
For more information, see “Tag Restrictions” on page 100.
install.book Page 69 Thursday, May 10, 2001 12:59 PM
Note
The URL path is case-sensitive on Solaris, Linux, and HP-UX.
Server Settings
The Server Settings page of the Administrator contains configuration options you
can set or enable to manage ColdFusion Server. They can significantly affect server
performance. Use the following table to learn more about the option:
Option Description
Limit simultaneous Enter a number to limit simultaneous requests to the ColdFusion
requests* Server. When the server reaches the limit, requests are queued
and handled in the order received. Limiting the number of
simultaneous requests can improve performance.
Timeout requests Enable this option to prevent unusually lengthy requests from
after [n] seconds using up server resources. Enter a limit to the time that
ColdFusion Server waits before terminating a request. Requests
that take longer than the timeout period are terminated.
Restart at [n] Enable this option if you want the ColdFusion Server to track
unresponsive requests that execute code but fail to return in a timely fashion.
requests Enter the number of unresponsive requests at which the service
is restarted. The service restarts within the time specified in
Timeout Request above.
Restart when Enable this option if you want ColdFusion Server to track
requests terminate requests that incur "unexpected exception" abnormal
abnormally termination conditions. The service restarts if abnormal requests
begin to occur on a regular basis.
Suppress Enable this option to compress runs of spaces, tabs and
whitespace by carriage return/line feeds. Compressing whitespace can
default* significantly compact the output of a CFML template.
Enforce strict Enable this option if you want ColdFusion Server to enforce
attribute validation strict attribute validation rules. Extraneous attributes are not
allowed for CFML tags. If this option is not enabled, irrelevant
attributes may be passed to CFML tags. Strict attribute
validation improves template execution time and prevents many
CFML coding errors.
Missing Template Specify a template to execute when ColdFusion Server cannot
Handler find a requested template.
Site-wide Error Specify a template to execute when ColdFusion Server
Handler encounters an error while processing a request.
* Restart ColdFusion Server after making a change to this option.
install.book Page 71 Thursday, May 10, 2001 12:59 PM
Caching 71
Caching
The Caching Settings page of the Administrator contains configuration options that
you can set or enable to cache templates, queries, and data sources. They can
significantly affect server performance. Use the following table to learn more about
the options:
Option Description
Template cache Enable this option to limit the memory reserved for template
size: [n] kilobytes caching. For best performance, set the value to the total
number of kilobytes of all your active ColdFusion pages.
Trusted cache Enable this option if you want ColdFusion Server to use cached
templates without checking whether they changed. For
templates that are not updated frequently, using this option
minimizes file system overhead.
Limit cached Enable this option by entering a value to limit the time that
database ColdFusion Server allows a cached database connection to
connection inactive remain inactive before disconnecting. Enter 0 if inactive
time to [n] minutes connections should be maintained as long as ColdFusion
Server is executing. If the option to maintain database
connections is not enabled in the Edit Data Source page for an
individual data source, the option is ignored. For more
information, see “Adding Data Sources for ColdFusion” on
page 115.
Limit the maximum Enable this option by entering a value to limit the maximum
number of cached number of cached queries that the server maintains. Cached
queries on the queries allow retrieval of result sets from memory rather than
server to [n] queries through a database transaction. Because queries reside in
memory, and query result set sizes differ, you must provide a
limit for the number of cached queries.
install.book Page 72 Thursday, May 10, 2001 12:59 PM
Client Variables
Client variables let you perform tasks like determining the IP address of a site
visitor’s Web browser. Using information from client variables, you can customize
page content for individual users.
You enable client variable default settings in ColdFusion Server on the Client
Variables page of the Administrator. ColdFusion Server lets you store client variables
in these ways:
• The operating system registry
• As cookies in users’ Web browsers
• In a data source.
Note
You can override settings specified in the Client Variables page using the attributes of
the cfapplication tag. For more information, see the Developing ColdFusion
Applications book.
Client Variables 73
Note
If you use the registry to store client variables, ensure that enough memory is
allocated for it.
Option Description
Purge data for Enable this option to periodically purge client data that has not
clients that been accessed in a specified number of days, and enter a
remain number.
unvisited for
[n] days
Disable global Enable this option to prevent ColdFusion Server from updating
client variable client variables for every page request. When updates are
updates disabled, ColdFusion Server only updates global client variables
when they are created and when they are changed. Disabling
updates helps improve the performance of application pages.
Create Client Enable this option only when you configure a data source for
database client variable storage the first time. ColdFusion Server creates
tables the tables necessary for client variables. If the data source has
already been configured, disable this option. Otherwise,
ColdFusion Server generates an SQL error because it tries to
create tables that already exist.
Note
If a cluster of ColdFusion Servers uses this data source, ensure that only one
server is configured to purge client data.
CGLOBAL Table
Column Data Type
cfid char(64)
data memo
lvisit date
CDATA Table
Column Data Type
cfid char(64)
app char(64)
data memo
Client Variables 75
Memory Variables
You use the Memory Variables page of the ColdFusion Administrator to enable
application and session variables server-wide. By default, application and session
variables are enabled when you install ColdFusion Server. If you disable either type
of variable in the Memory Variables page, you cannot use them in a ColdFusion
application.
You can specify maximum and default timeout values for session and application
variables. Unless you define a timeout value in Application.cfm, application
variables expire when you restart ColdFusion Server. Session variables expire when
user sessions end. To change these behaviors, enter default and maximum timeout
values.
Note
Timeout values that you specify for application variables override the timeout values
set in Application.cfm.
install.book Page 77 Thursday, May 10, 2001 12:59 PM
Locking 77
Locking
You use the Locking page of the ColdFusion Administrator to configure automatic
mechanisms to protect shared data from incorrect access and corruption. In
addition, the cflock tag provides granular control of simultaneous access to shared
data scope variables, including server, application, and session scopes. For more
information on the cflock tag, see Developing ColdFusion Applications
Option Description
No automatic No automatic checking or locking occurs. The developer must
checking or locking protect variables with the cflock tag. If variables are not
locked, data corruption may result, and server instability may
occur.
Full checking ColdFusion Server checks shared variable scope access
automatically to ensure that it is properly locked. If a data read
or write occurs outside the scope of a cflock tag, an error
displays.
Automatic read ColdFusion Server checks whether shared variable scope
locking writes are locked and automatically locks shared variable
scope reads. If ColdFusion Server encounters shared variable
scope writes that are not locked, an error displays.
install.book Page 78 Thursday, May 10, 2001 12:59 PM
Note
Apply full checking and automatic read locking only to applications that use the
scope attribute, not the name attribute, of the cflock tag to specify locks. If you
specify the name attribute with full checking enabled, ColdFusion Server responds
with an error on a variable accessed within the scope of a cflock tag scope. If you
specify the name attribute with automatic read locking enabled, ColdFusion Server
responds with errors for writes, and possibly a deadlock for reads.
install.book Page 79 Thursday, May 10, 2001 12:59 PM
Mappings 79
Mappings
You use the Mappings page of the ColdFusion Administrator to add, update, and
delete logical aliases for paths to directories on your server and to change the root
"/" mapping. This alias usually points to the Web root.
ColdFusion mappings apply only to pages processed by the ColdFusion Server with
the cfinclude and cfmodule tags. If you save CFML pages outside of the Web root
(or whatever directory is mapped to "/"), you must add a mapping to the location of
those files on your server.
For example, let’s assume that the "/" mapping on your server points to c:\wwwroot,
but all CFML pages associated with your online store reside in e:\store. For the CFML
pages that sit in the c:\wwwroot, you want to reference the online store pages using /
store in your cfinclude and cfmodule tags. In order for ColdFusion Server to find
those pages, you must add a mapping for /store that points to e:\store.
To add a mapping:
1 In the Logical Path text box, enter an alias to assign to a directory, such as /store.
2 In the Directory Path text box, enter the directory for which to create an alias,
such as e:\store. To locate the directory name, click Browse Server or enter the
directory name.
3 Click Add Mapping.
The Active ColdFusion Mappings table shows the new mapping.
To update a mapping:
1 In the Active ColdFusion Mappings table, click a logical or directory path.
2 To update a logical or directory path, edit the information in the appropriate
field, then click Update Mapping.
The Active ColdFusion Mappings table shows the updated mapping and the original
mapping.
To delete a mapping:
In the Active ColdFusion Mappings table, select a mapping to delete. Click Delete
Mapping. The mapping disappears immediately.
install.book Page 80 Thursday, May 10, 2001 12:59 PM
Mail/Mail Logging
You use the ColdFusion Administrator Mail page of the ColdFusion Administrator to
specify a mail server to send automated e-mail messages. ColdFusion Server
supports the Simple Mail Transfer Protocol (SMTP) for sending e-mail and the Post
Office Protocol (POP) for retrieving e-mail from your mail server. To use e-mail
messaging in your ColdFusion applications, you must have access to an SMTP server
and/or a POP account.
The ColdFusion implementation of SMTP mail uses a spooled architecture. This
means that when a cfmail tag is processed in an application page, the messages
generated may not be sent immediately. If ColdFusion is extremely busy or has a
large queue, delivery could occur after some delay.
Note
For more information about the cfmail tag, see the Developing ColdFusion
Applications book.
Tip
Send a test e-mail message to verify that the e-mail server is working, regardless
of whether you enable the Verify Mail Server Connection option.
install.book Page 81 Thursday, May 10, 2001 12:59 PM
Mail/Mail Logging 81
Mail Logging
Select preferences for handling mail logs, as described in the following table:
Setting Description
Error Log Severity From the drop-down list box, select the type of SMTP-related
error message to write to a log file. The options are: Warning,
Information, and Error.
Log all e-mail To have the content of all e-mail messages that ColdFusion
messages sent by Server generates written to a log file, enable this option.
ColdFusion
ColdFusion Server writes sent mail and mail error logs to the file:
• \cfusion\Log, in Windows
• \opt\coldfusion\log, in Solaris, Linux, and HP-UX
The following table describes the e-mail log files:
Log Description
mailsent.log Records sent e-mail
mail.log Records general e-mail errors
install.book Page 82 Thursday, May 10, 2001 12:59 PM
Data Sources
The Data Sources section of the Administrator is the interface between you,
ColdFusion Server, databases, and Verity search and indexing features. The
following table describes some common tasks that you can perform in the Data
Sources sectionof the Administrator:
Task Description
Create and manage The ODBC Data Sources page lets you establish, modify, and
ODBC data delete ODBC data source connections for ColdFusion Server.
sources For more information, see “Managing Data Sources” on page
109.
Create and manage The Native Data Sources page lets you establish, modify, and
native data sources delete native data source connections for ColdFusion Server.
For more information, see the Advanced ColdFusion
Administration book.
Create and The Verity Collections page lets you create and delete Verity
maintain Verity collections and perform maintenance operations on collections
collections that you create. For more information, see “Verity Collections”
on page 83.
Register a Verity K2 The Verity K2 Server page lets you register a K2 Server to use
Server with with ColdFusion Server. For more information, see the
ColdFusion Server Advanced ColdFusion Administration book.
install.book Page 83 Thursday, May 10, 2001 12:59 PM
Verity Collections 83
Verity Collections
The Verity Development Kit (VDK) provides indexing and searching technology to
create, populate, and manage collections of indexed data that are optimized for fast
and efficient site searches. It is available on the Verity Collections page.
A collection is a logical group of documents and metadata about the documents. The
metadata includes word indexes, an internal documents table of document field
information, and logical pointers to the document files.
To create a collection:
1 On the Verity Collection page, in the Name Field, enter a name for your
collection. The name can consist of multiple words and spaces.
2 In the Path field, specify a path for the collection files.
3 From the drop-down Language list box, select a language for the collection.
4 Click an option:
Option Description
Create New Generates a new collection
Collection
Map Existing Connects a new mapping to a collection that was created outside
Collection ColdFusion Server or copied from another ColdFusion Server.
After the collection is referenced on this page, ColdFusion
searching and indexing tags can reference it.
Note
Mapped collections are sometimes confused with external collections. An external
collection is created with a tool other than ColdFusion Server, such as the Verity
command line tool mkvdk. External collections are then associated with ColdFusion
Server so that it can identify the collection and its directory structure.
install.book Page 84 Thursday, May 10, 2001 12:59 PM
To populate a collection:
1 On the Verity Collections page, in the Connected Verity Collections table, select a
collection to populate.
2 Click Index. The ColdFusion Administrator page displays with the selected
collection name at the top.
3 Review the extensions in the File Extensions field. If necessary, add, edit, or
remove extensions for files in the collection.
4 In the Directory Path field, enter the path to the directory to index.
5 To include subdirectories of the directory, select Recursively Index Sub
Directories.
6 In the Return URL field, enter a URL to which to return documents found in the
search of this collection, such as http://localhost/cfdocs.
7 From the Language drop-down list, select the language of the documents.
Note
By default, the Verity English Language Pack installs with ColdFusion Server. To
select another language, install the corresponding Verity Language Pack. The
Verity Language Packs are included on the ColdFusion Server CD-ROM.
Managing collections
You can repair, optimize, purge, or delete Verity collections that are connected to the
ColdFusion Server. To manage collections, use the buttons along the bottom of the
Connected Verity Collections table.
install.book Page 85 Thursday, May 10, 2001 12:59 PM
Verity Collections 85
Note
Before performing management operations, ensure that the K2 Server is not using
the collections. For more information, see the K2 Server documentation in Advanced
ColdFusion Administration book.
Option Description
Repair Re-indexes a collection to fix broken links and update indexes
Optimize Reclaims space left by deleted and changed files by consolidating
collection indexes for faster searching. Optimize collections regularly
Purge Deletes all documents in a collection, but not the collection itself. Leaves
the collection directory structure intact
Delete Deletes a collection
To repair a collection:
1 On the Verity Collections page, select a collection from the Connected Verity
Collections table.
2 Click Repair. A message warns you not to work on the collection during the repair
process, which can occur over several minutes.
3 Click OK.
When you repair a collection, a confirmation statement displays above the table.
To optimize a collection:
1 On the Verity Collections page, select a collection from the Connected Verity
Collections table.
2 Click Optimize. A message prompts you to verify the process, which can occur
over several minutes.
3 Click OK.
When the optimization is complete, a confirmation statement displays above the
table.
To purge a collection:
1 On the Verity Collections page, select a collection from the Connected Verity
Collections table.
2 Click Purge. A verification message warns you that purging of data cannot be
undone.
3 Click OK.
When the purge is complete, a confirmation statement displays above the table.
install.book Page 86 Thursday, May 10, 2001 12:59 PM
To delete a collection:
1 On the Verity Collections page, select a collection from the Connected Verity
Collections table.
2 Click Delete. A verification message displays warns you that deleting a collection
cannot be undone.
3 Click OK.
When the delete is complete, a confirmation statement displays above the table.
Verity Collections 87
Debug Settings
You use the Debug Setting and Debugging IPs pages of the Administrator to
configure ColdFusion Server to provide debugging information for every application
page requested by a browser. You specify debugging preferences using these pages:
• On the Debugging Options page, select debugging output options. If debugging
is enabled, the output appears in block format after normal page output.
• On the Debugging IPs page, restrict access to debugging output. If a debugging
option is enabled, debugging output is visible to all users by default.
Debug Options
The Debugging Options page provides these debug options:
Option Description
Enable Performance Monitoring* The standard NT Performance Monitor application
displays information about a running ColdFusion
Server. On platforms that do not support the NT
Performance Monitor, a command line utility,
cfstat, displays the same information.
Enable CFML Stack Trace Displays the CFML tags that were executing at the
time of the exception.
Show Variables Displays the names and values of CGI, URL, form
and cookie variables.
Show Total Processing Time Displays the average time, in milliseconds, that it
takes to process a page request.
Show Detailed Processing Time Displays the time, in milliseconds, that it takes to
Breakdown* process each page.
Show SQL and Data Source Displays the data source name and the SQL
Name statement in database query error messages.
Show Query Information Displays the number of records, processing time,
and SQL statement for each query executed.
Display the Template Path in Displays the file name of a template. The name is
Error Messages useful in debugging. However, use of this option
can pose a security hazard because it displays
information about a server’s file structure.
* Restart ColdFusion Server in Windows after selecting this option.
install.book Page 89 Thursday, May 10, 2001 12:59 PM
Debug Settings 89
Debugging IPs
You use the Debugging IPs page to restrict debugging output to one or more IP
addresses. You can add and remove IP addresses.
Warning
If you do not specify IP addresses and debugging options are active, debug output
displays for all users.
Automated Tasks
You use the Automated Tasks pages of the Administrator to schedule the execution
of local and remote Web pages and to generate static HTML pages. The scheduling
facility is useful for applications that do not require user interactions or customized
output. ColdFusion developers use this facility to schedule daily sales reports,
corporate directories, statistical reports, and so on.
Information that is more often read than written is a good candidate for scheduled
tasks. Instead of executing a query to a database every time the page is requested,
ColdFusion Server renders the static page with information generated by the
scheduled event. Response time is faster because no database transaction takes
place.
You can run scheduled tasks once; on a specified date; or at a specified time, daily,
weekly, or monthly. You can run a scheduled task daily, at a specified interval, or
between specified dates.
You create scheduled tasks and set automation options on these pages:
• On the Automation Settings page, you select debugging options
• On the Schedule Task page, you create, modify, and delete scheduled tasks
Automation Settings
The Automation Settings page of the Administrator provides these options:
Option Description
Scheduler Refresh Interval x The time that ColdFusion Server waits before
Minutes* checking for new or updated scheduled tasks
Enable Logging Logs scheduled task actions to the schedule.log or
file
* This option takes effect after you restart ColdFusion Server.
Schedule Task
The Schedule Task page lets you create, modify, and delete scheduled tasks.
Automated Tasks 91
4 In the Schedule to Run section, select one of the options described in the
following table:
Option Description
One Time Runs the task once, at a time (HH:MM:SS) in 24 hour format
specified in the Start Time text box on the date (MM/DD/YY)
specified in the Start Date text box. For the task to execute
successfully, the date and time must be set at least 15 minutes in
the future.
Recurring Runs the scheduled task according to the frequency specified in
the drop-down list. You can run the task daily, weekly, or monthly.
Specify a time (HH:MM:SS), in 24 hour format, for the scheduled
task.
Daily Runs the scheduled task daily. To run the scheduled task
indefinitely:
• In the Daily Every text box, designate the frequency that the
task runs
• Leave the From and To text boxes empty
To start a scheduled task on a specific date and run it indefinitely:
• In the Daily Every text box, designate the frequency, in
minutes, that the task runs
• In the From text box, enter the start date (MM/DD/YY) and
leave the To text box empty
To run a scheduled task between two dates:
• In the Daily Every text box, designate the frequency, in
minutes, that the task runs
• In the From text box, enter the start date (MM/DD/YY) and the
stop date (MM/DD/YY) in the To text box
5 In the Operation drop-down list, select an operation for the scheduled task to
perform. HTTPRequest is the only option.
6 If your Web server requires a port to connect to the Web, enter it in the Port text
box.
7 In the URL text box, enter a local or remote URL to the file that the scheduled task
executes. For external URLs, end the URL with a backslash.
8 Click Submit Changes.
The scheduled task displays in the Scheduled Task table on the Schedule Task page.
install.book Page 92 Thursday, May 10, 2001 12:59 PM
The following table lists the optional settings in the Schedule Task page:
Setting Description
Username Specifies whether the server to which the URL points requires user
authentication
Password Specifies whether the server to which the URL points requires user
authentication
Request A time, in seconds, to wait for a reply
Timeout
Proxy Server The location of the proxy server
Proxy Port The port of the proxy server
Publish Saves the results of the scheduled task as a static HTML file
Path The file path to the directory in which to save the static HTML file
File The name for the static HTML file
Resolve URL Converts relative URLs in the static HTML file to absolute URLs
Extensions 93
Extensions
You use the Extensions pages of the Administrator to configure ColdFusion Server to
work with other technologies, such as Java and CORBA. These pages make up the
Administrator Extensions section:
• JVM and Java Settings
• Java Applets
• CFX Tags
• Custom Tag Paths
• CORBA Connectors
Setting Description
Java Virtual Machine Path The absolute file path to the location of the Java
virtual machine (JVM): jvm.dll in Windows or jvm.so
in Solaris, Linux, and HP-UX
Initial Heap Size JVM initial heap memory size
Max Heap Size JVM maximum heap memory size
Load JVM When Starting Loads the JVM when ColdFusion Server starts up. If
ColdFusion not selected, the JVM loads on the first client request
that requires Java.
Class Path The file paths to the directories that contain the Java
classes used by ColdFusion Server: separate paths
by semi-colons in Windows, or colons in Solaris,
Linux, and HP-UX
System Options Standard JVM initialization options, as name-value
pairs: separate options by semi-colons in Windows
and colons in Solaris, Linux, and HP-UX
Implementation Options Implementation-specific JVM initialization options, as
name-value pairs separated by spaces
CFX Jar Path File path to the ColdFusion cfx.jar file that contains
interfaces used by Java CFX tags
Java Applets
The Java Applets page of the Administrator lets you register applets and modify and
delete applet registrations. Before you can use Java applets in your ColdFusion
applications, you must register them in the Java Applets page.
When your applet is registered with ColdFusion Server, using the cfapplet tag in
your CFML code is very simple, because all parameters are predefined. Simply enter
the applet source and the form variable name you want to use.
Note
Parameters set in the cfapplet tag override parameters defined in the Java Applets
page.
Setting Description
Applet Name Applet name
Code Name of the file that contains the applet subclass. Must be
relative to the code base URL. The class extension is optional.
Code Base Base URL of the applet: directory that contains the applet
components. The applet class files must be located within the
Web server root directory, such as http://servername/classes
Archive File name for the applet archive
Method Method name in the applet that returns a string value. You use the
name in the NAME attribute of the cfapplet tag to populate a
form variable with the method value. If the applet has no method,
leave this field blank.
Height Applet height, in pixels
Width Applet width, in pixel
VSpace Measurement, in pixels, for the space above and below the applet
HSpace Measurement, in pixels, for the space on each side of the applet
Align Applet alignment
Not Supported Message to display if the user’s Web browser does not support
Message Java applets. To override this message, specify a different one in
the cfapplet tag notsupported attribute.
Parameter Name for a required applet parameter, typically provided by the
Name applet.
Value Default value for parameter
install.book Page 95 Thursday, May 10, 2001 12:59 PM
Extensions 95
The Java applet displays in the Registered Java Applets table on the Java Applets
page.
CFX Tags
Before you can use a CFX tag in ColdFusion applications, you must register it. You
use the CFX Tags page to register and manage ColdFusion custom tags built with
C++ and Java.
You build CFX tags:
• Using C++ as a dynamic link library (DLL) in Windows; as shared objects (so/sl)
on Solaris, Linux, and HP-UX
• Using Java interfaces defined within cfx.jar
Setting Description
Tag Name Tag name, which must be prefixed with CFX_
Server Library File path for the library or shared object
(.DLL/.SO/.SL)
Procedure Procedure name that implements the tag, which must correspond
with the procedure name in the library or shared library
Keep Library Prevents ColdFusion Server from reloading the library into
Loaded memory each time it is accessed
Description Description for the CFX tag
Setting Description
Tag Name Tag name, which must be prefaced with CFX_
Class Name File name for the Java class, with no .class extension
Description Description for the CFX tag
Note
The class file must be accessible from the Class Path set in the JVM and Java
Settings page.
Extensions 97
CORBA Connectors
You use the CORBA Connectors page of the Administrator to register, modify, and
delete CORBA connectors. You must register CORBA connectors before using them
in your ColdFusion applications.
ColdFusion Server loads Orb libraries dynamically using a connector, which does not
tie ColdFusion customers to a specific Orb vendor. The connectors depend on the
Orb runtime libraries provided by the vendor. The connectors are located in the bin
directory in Windows and the lib directory in Solaris and HP-UX. Ensure that the
appropriate libraries reside in the load library search path for the ColdFusion
executable.
The following table contains information about the libraries and connectors:
Note
Macromedia will provide implementations of the connectors for some of the popular
Orbs. For those that are not supported, Macromedia will make the source available
under NDA to a select group of third-party candidates and/or Orb vendors.
Setting Description
ORB Name Orb name (alphanumeric characters only)
DLL Path File path to the DLL that the ORB uses
ORB Initialization Options that are necessary to initialize the ORB, separated by
Options spaces
Note
To instruct ColdFusion Server to load the ORB into memory on startup, select the
Load ORB on Startup check box. Click Submit CORBA Settings.
Note
You must restart ColdFusion Server for the changes to take effect.
Security 99
Security
The Security section of the Administrator, accessed by clicking the Security tab at the
top of the left navigation bar, lets you configure the Basic and Advanced Security
frameworks of ColdFusion Server.
Basic Security
The Basic Security framework activates by default during ColdFusion Server
installation, in the Professional and Enterprise editions. It secures ColdFusion Server
in three ways:
• Administrative access — Protects access to Administrator pages with a password
• Application development — Protects access to data sources and files with
passwords and blocks access to some sensitive ColdFusion tags
• Application deployment — Prevents applications from executing several
ColdFusion tags that could be used to update, delete, or manipulate server files
Basic Security provides an adequate level of protection if you have legacy systems, or
other security measures, already in place. On the other hand, developers must spend
more time writing applications, because, while granular runtime access security is
possible with Basic Security, it requires custom development.
For more information, see “Basic Security” on page 100. For more information about
implementing security measures in your ColdFusion applications, see Developing
ColdFusion Applications.
Advanced Security
In ColdFusion Server Enterprise Edition, the Advanced Security framework provides
scalable, granular security in the following ways:
• Application development — It controls access to files, data sources, and
administration for each developer on your team. You coordinate team
development on shared servers with the assurance that sensitive data and
applications are secure.
• Application deployment — It creates complex rules to programmatically control
access to functionality within applications. You can set up multiple levels of user
access within an application, and confine applications to secure areas that
restrict the access applications have to directories, components, databases, or
other resources on the server.
• Administrative access — It assigns different degrees of administrative access to
specified users.
For more information, see the Advanced ColdFusion Administration book. For more
information about implementing security measures in your ColdFusion
applications, see Developing ColdFusion Applications.
install.book Page 100 Thursday, May 10, 2001 12:59 PM
Basic Security
The Basic Security section of the Administrator provides these pages to configure
ColdFusion Server basic security:
Page Description
CF Admin Password Lets you assign and change passwords for the ColdFusion
Administrator
Tag Restrictions Lets you restrict the use of specific tag and tag attributes
CF Studio Password Lets you assign and change passwords for ColdFusion Studio
CF Admin Password
You use the CF Admin Password of the Administrator page to enable and disable
password-restricted access to the Administrator, and to change the Administrator
password.
Note
Enabling Use ColdFusion Administration Authentication in the Advanced Security
page disables the passwords set in the Basic Security page.
Tag Restrictions
You use the Tag Restrictions page of the Administrator to enable and disable tags and
tag attributes, and to specify a directory where tag restrictions are not enforced. Tag
restrictions can be useful to ColdFusion Server hosting providers by preventing
developers from executing tags that could save, change, or delete files on the server.
By default, all tags are enabled when ColdFusion Server is installed. To disable a tag,
clear its check box.
To specify a directory in which otherwise blocked tags can be executed, enter the file
path in the Unsecured Tags Directory text field. The default directory is the
Administrator.
install.book Page 101 Thursday, May 10, 2001 12:59 PM
Warning
If you change the directory from the default ColdFusion Server directory and you
disable the cfregistry tag, you cannot use the ColdFusion Administrator. To regain
access to the Administrator, modify the registry to return the directory to normal.
CF Studio Password
You use the CF Studio Password page to enable and disable password-restricted
access to server resources within ColdFusion Studio using Remote Development
Services (RDS), and to change the password.
Warning
Enabling Use ColdFusion Studio Authentication in the Advanced Security page
disables the passwords set in the Basic Security page.
Note
If you use ColdFusion RDS, you must stop and restart it after you change passwords.
install.book Page 102 Thursday, May 10, 2001 12:59 PM
Tools
The Tools section of the Administrator, accessed by clicking the Tools tab at the top
of the left navigation bar, provides administrative features in ColdFusion Server
Enterprise Edition, for managing Web site specific files, configurations, and
applications
The following table describes some of the common tasks that you can perform in the
Data Sources section:
Task Description
Analyze and view log file The enhanced log viewer and filter utilities let you to extract
information essential information from one or more log files. For more
information, see “Logs and Statistics” on page 103.
Backup and deploy site The site archiving features let you easily back-up and
information deploy site configuration information, files, and/or
applications. For more information, see the Advanced
ColdFusion Administration book.
Monitor resources, send The monitoring and site management features let you
alarm notifications, and monitor resources in your Web site, be informed when
distribute incoming Web critical events occur, and control the distribution of HTTP
traffic traffic hitting your Web sites. for more information, see the
Advanced ColdFusion Administration book.
Examine site The Server Reports page lets you examine ColdFusion
performance statistics Server performance statistics over a period of time, track
and server configuration ColdFusion Server configuration changes as they occur,
changes and identify all current configuration settings from one view.
For more information, see “Server Reports” on page 107.
install.book Page 103 Thursday, May 10, 2001 12:59 PM
Page Description
Logging Settings Lets you configure administrator e-mail address, change the log
directory, control operating system logging, and enable log file
format
Log files Lets you search, view, download, archive, and delete log files
Server Reports Lets you view and filter dynamically generated reports*
* Available only in ColdFusion Server Enterprise Edition. Not available in
HP-UX.
Logging Settings
You use the Logging Settings page of the Administrator to change ColdFusion Server
logging options. The following table describes the settings:
Setting Description
Administrator E-mail address of the server administrator. The address displays
E-mail under each error message, for reporting purposes, enabling users
to report problems. This setting can be overridden in the
Application.cfm file.
Log Directory* Directory to which error log files are written.
Log Slow Pages Causes ColdFusion Server to log the names of pages that take
longer than the specified interval to process. Logging slow pages
can help you diagnose potential problems or bottlenecks in your
ColdFusion applications. Entries are written to server.log.
Use Operating Causes ColdFusion Server to log messages using your operating
System Logging system logging facility (EventLog in Windows; syslog in Solaris,
Facilities Linux, and HP-UX). ColdFusion Server log messages are also
written to the standard ColdFusion Server log files.
Use Version 5 Causes all ColdFusion Server log messages to be written in a
Logging Format* standard format. The standard format is required to use the
enhanced 5 Log Viewer. If not enabled, ColdFusion Server uses
the version 4.5 format. If you do not use ColdFusion Server 5
format, the Administrator Log Viewer does not work.
* Restart ColdFusion Server after changing this setting.
install.book Page 104 Thursday, May 10, 2001 12:59 PM
Log files
The Log Files page of the Administrator lets you perform operations on log files, such
as viewing, downloading, scheduling, archiving, and deleting.
The Log File page icons, located in the Controls column of the Available Log Files
table, can be used to perform all log file actions. The following diagram describes the
icons:
Note
For more information on filtering log files, see the Administrator Online Help.
Log Description
executive.log Records errors related to the ColdFusion Application Server
service. If the service restarts or is unable to access the
system registry, the information is written to executive.log.
rdseservice.log Records errors occurring in the ColdFusion Remote
Development Services (RDS). This service provides remote
HTTP-based access to files and databases.
application.log Records every ColdFusion Server error reported to a user.
Application page errors, including ColdFusion Server syntax,
ODBC, and SQL errors are written to the log file.
webserver.log Records errors that occur in the Web server and the
ColdFusion Server stub.
scheduler.log Records scheduled events that have been submitted for
execution. Indicates whether task submission was initiated
and whether it succeeded. Provides the scheduled page
URL, the date and time executed, and a task ID.
server.log Server log that records errors for ColdFusion Server.
customtag.log Server log that records errors generated in custom tag
processing.
remote.log Server log that records messages associated with the
Network Listener Module (cfdist).
car.log Records errors associated with Site Archive and Restore
operations.
mail.log Records errors generated by a SMTP mail server.
mailsent.log Records messages sent by ColdFusion Server.
* Solaris, Linux, and HP-UX only.
install.book Page 106 Thursday, May 10, 2001 12:59 PM
Log Description
proxy.log Records messages related to the security server proxy.
cfadmin.log Records Administrator operations.
install.log* Records installation information.
server.stdout* Records the standard output of the cfserver process.
rdsservice.stdout* Records the standard output of the cfrdsservice process.
* Solaris, Linux, and HP-UX only.
Column Field
Order Type Field Description
1 Severity Severity level:
• Error
• Warning
• Informational
2 Thread ID The service thread identification number
3 Date The date the event occurred
4 Time The time the event occurred
5 Details Describes the event that occurred, with error number
Note
If you use ColdFusion Server 4.5 or earlier or earlier, you cannot view log files in the
Log Viewer.
Server Reports
You use the Server Reports page of the Administrator to view dynamically generated
reports about server activity and performance. The following reports are available:
• Statistics Summary
• Requests
• Database Operations
• Cache Pops
• Queued Requests
• Requests in Progress
• Timed Out Requests
• Throughput
• Settings Summary
• Settings Change Log
When you click on a report, the right pane of the Server Reports page displays your
choices. The Settings Summary and Settings Change Log reports contain hyperlinks
to the applicable page in the Administrator.
For example, if you made a change to the log directory on 07/01/2001, the change is
listed in the report as "Logging -> Log Directory". You can click on "Logging -> Log
Directory" to go directly to the Logging Settings page in the Administrator.
install.book Page 108 Thursday, May 10, 2001 12:59 PM
You can filter server reports by time frame, dates, and interval. The following table
lists the options:
Parameter Option
Timeframe • Anytime
• Specified Range (used in conjunction with Dates option)
• Today
• Last Two Days
• Last Three Days
• One Week
• Two Weeks
• One Month
• Three Months
• Six Months
Dates Enter past dates in MM/DD/YYYY format, such as 06/01/2001 to
07/01/2001.
Interval • Hour
• Day
• Week
• Month
Chapter 6
Contents
• About ColdFusion Data Sources ............................................................................ 110
• Supported Database Drivers .................................................................................. 111
• Choosing the Correct Drivers................................................................................. 114
• Adding Data Sources for ColdFusion..................................................................... 115
• Verifying ColdFusion Data Sources ....................................................................... 120
• Connecting to Microsoft SQL Server Databases................................................... 121
• Connecting to Microsoft Access Databases .......................................................... 123
• Connecting to Oracle Databases............................................................................ 127
install.book Page 110 Thursday, May 10, 2001 12:59 PM
Note
On the Win32 platform, you can also configure ODBC data sources with the ODBC
Data Source Administrator.
The specific databases that you can configure for ColdFusion depend on two items:
• The platform on which you install ColdFusion Server
• The edition of ColdFusion that you are running—Professional or Enterprise.
When you first open the ColdFusion Administrator, you see four ODBC data sources
already configured for use by ColdFusion:
• cfsnippets Used by the executable code examples. You access the examples
through pages in the CFML Language Reference and through the Snippets
Launcher, which you access from the ColdFusion welcome page.
• cfx Used by the example applications optionally installed with ColdFusion
Server.
• CompanyInfo Used by the examples in Developing Web Applications with
ColdFusion.
• GlobalCorpDB Used by the example applications optionally installed with
ColdFusion Server.
Windows NT
Windows 98
Solaris
Linuxa
HP-UX
Functionality Library name Vendor Version
ODBC
Btrieve DataDirect MERANT 3.7 Pb P
Connect ODBC
FileMaker FileMaker 5.0 P P
dBASE/FoxPro DataDirect MERANT 3.7 P P P E E
Connect ODBC
IBM DB2 UDBc DataDirect MERANT 3.7 E E E E
Connect ODBC
Informix 7.x/9.xd DataDirect MERANT 3.7 E E E E
Connect ODBC
Informix Dynamic DataDirect MERANT 3.7 E E E E
Server for Informix 9.x Connect ODBC
Microsoft SQL Server DataDirect MERANT 3.7 P E E
Connect ODBC
MySQLe DataDirect MERANT 3.6 P E E
Connect ODBC
Oracle 7.3.4 DataDirect MERANT 3.7 E E E
Connect ODBC
Oracle 8 DataDirect MERANT 3.7 E E E E E
Connect ODBC
Paradox DataDirect MERANT 3.7 P P
Connect ODBC
Progress 7.2 DataDirect MERANT 3.7 E
Connect ODBC
SQLbase 6.x DataDirect MERANT 3.7 E E
Connect ODBC
Sybase 11 - Sybase DataDirect MERANT 3.7 E E E E E
Adaptive Server 12.0 Connect ODBC
Text DataDirect MERANT 3.7 P P P E E
Connect ODBC
dBASE MDAC Microsoft P P
install.book Page 112 Thursday, May 10, 2001 12:59 PM
Windows NT
Windows 98
Solaris
Linuxa
HP-UX
Functionality Library name Vendor Version
Microsoft Access MDAC Microsoft P P
Microsoft Excel MDAC Microsoft P P
Microsoft FoxPro MDAC Microsoft P P
Microsoft SQL Server MDAC Microsoft P P
Microsoft Visual MDAC Microsoft P P
FoxPro
Text MDAC Microsoft P P
Native
IBM DB2 Macromedia 5.2.0 E E E E
IBM DB2 Macromedia 6.1 E E E E E
Informix Macromedia 7.x, 9.x E E E E E
Oracle 7.3.4 Macromedia 7.3.0 E E E
Oracle 8.0 Macromedia 8.0.4.0.0, E E E E E
8i
Sybase Macromedia System E E E E E
11, 12
OLE DB
Microsoft.Jet.ODBC MDAC Microsoft 4.0 P P
(8.0.4.0.0 client
libraries)
SQLOLEDB (7.3.3 Microsoft 7.3.0 P P
client libraries)
a. ColdFusion 5 supports Red Hat Linux 6.2 and 7.0, SuSE Linux 7.0, Cobalt
RAQ3, XTR, and RAQ4 Linux.
b. P= ColdFusion Professional Edition; E= ColdFusion Enterprise Edition.
c. DB2 for Windows NT and DB2 Common Server requires either IBM DB2
Client Application Enabler for Win32 version 2.1 or later, or IBM DB2 Soft-
ware Development Kit for Win32 version 2.1 or later. DB2 for Solaris or
HP-UX requires version 2.12 or later.
d. Informix for Windows requires version 2.5 or later of either the Infor-
mix-Connect for Windows or the Informix Software Developer’s Kit for Win-
dows. Informix for Solaris and HP-UX requires Informix-Client Software
Developer’s Kit version 2.5 or later for UNIX.
e. For UNIX, the MySQL driver provided with MyODBC will work. This driver
displays in the drop-down list if it is located at /opt/coldfusion/lib/libmyo-
dbc.so (.s1 for HP-UX).
What to do next
To use an existing database with your ColdFusion applications, you need to register
or create the data source using the ColdFusion Administrator. If you are using a DB2,
Informix, Oracle, or Sybase database and want to take advantage of the ColdFusion
native drivers, you also need to install and configure database client software.
The remaining sections in this chapter provide details about configuring ColdFusion
data sources for Microsoft SQL Server, Microsoft Access, and Oracle databases. To
learn how to connect to other databases, see Advanced ColdFusion Server
Administration.
3 Enter a name for the new data source and select a driver from the drop-down list.
Note
Do not name a ColdFusion data source Registry or Cookie; these words are
reserved for use by ColdFusion.
4 Click Add.
install.book Page 116 Thursday, May 10, 2001 12:59 PM
Note
For the Server field, if you connect to a local SQL Server database using the
Microsoft SQL Server driver, enclose the word local in parentheses: (local).
If ColdFusion cannot verify the data source, the Status displays Failed. You can
run a cfquery against a failed data source to get more information about the
problem. You also can try embedding a username and password into the cfquery
tag, to see if the query works.
install.book Page 118 Thursday, May 10, 2001 12:59 PM
Note
You may have to supply a username and password for data sources that you want
to verify. To define a username and password for a data source, edit the data
source properties.
If you are creating a UNIX data source, you may have to set environment variables
for your database client library by editing the ColdFusion start script in <installdir>/
coldfusion/bin. For more information on editing the ColdFusion start script for your
particular database, see Advanced ColdFusion Server Administration.
ColdFusion Settings
To define a number of advanced ODBC and ColdFusion settings in the ColdFusion
Administrator, select a data source and click CF Settings . The settings apply to all
platforms. The following table describes the ColdFusion data source settings:
Setting Description
Login Timeout The number of seconds before ColdFusion times out the
database connection login attempt.
Limit Connections Select this check box, then specify the number of
simultaneous connections to allow for the current data source.
Note: If you enable Limit Connections without specifying a
limit for simultaneous connections, ColdFusion defaults to
unlimited connections.
ColdFusion Login Enter a username and password for accessing the ODBC
data source. Any username and password specified in a
cfquery or other data access tag overrides the values
specified in the ColdFusion login.
When you create a data source using a native database
driver, you use the username and password options to pass
login information to the database.
• Disable database connections Disables connections to
the data source. Use this setting to perform administrative
tasks with the database. You cannot establish new
connections to a disabled data source. ColdFusion
automatically disconnects and cleans up idle connections.
ColdFusion notifies any connection currently in use to
clean itself up when the current transaction is complete. To
restore the connection to the data source, clear this check
box.
• Maintain database connections ColdFusion
establishes a connection to a data source for every
operation that requires it. To improve performance by
caching the database connection, select this check box.
Setting Description
Connection Timeout Specify the maximum number of minutes after the database
connection is made that you want ColdFusion to cache a
connection after it is used.
This is different from the server setting to Limit database
connection inactive time, located under Server Settings >
Caching. The latter setting is server wide and only releases
cached connections that have been inactive (not used) for the
specified period of time.
The Connection Timeout setting does not return a connection
to the cache after a specified period of time, regardless of
how infrequently it is used.
The default is "" or 0, which means the connection timeout is
never enforced.
Restrict SQL Select SQL operations to restrict for the current data source.
Operations to To allow all SQL operations, clear all check boxes. To allow
specific SQL operations, select the check boxes.
Long Text Retrieval Retrieves all the data for a long text field. If you use this
Settings setting, order the columns in your select statement with the
long text fields referenced last.
ColdFusion retrieves the column with the long text field, and
subsequent columns in the select statement, as unbound
data. Unbound data take longer to retrieve than bound data;
therefore, this setting can affect performance.
Long Text Buffer Size If you do not select the Enable retrieval of long text option,
specifies the maximum number of characters to retrieve from
a long text field is not set. In this case, ColdFusion binds text
columns to a buffer whose size you specify in this field. If you
specify a size that is not supported by your database, a SQL
execution error occurs when you try to retrieve the data.
If you select the Enable retrieval of long text option, this is the
buffer size ColdFusion uses to retrieve the unbound text
column until all data is returned.
Connection String Use this setting to pass driver-specific connection attributes
for ODBC data sources. You can:
• Specify connection attributes that cannot be defined in the
odbc.ini settings
• Override odbc.ini settings
• Make ODBC connections dynamically when there is no
data source defined in the odbc.ini settings
install.book Page 120 Thursday, May 10, 2001 12:59 PM
Note
You might need to supply a username and password for the data sources that you
want to verify. To define a username and password for a data source, edit the
properties for the data source.
Note
If ColdFusion cannot verify a data source, you can run a cfquery against the failed
data source to get more detailed information about the problem. You can also
embed a username and password into the cfquery tag to test if the query works.
Option Description
Data Source Name A name for your ODBC data source.
Description A short description of the data source.
Server The name of the server hosting the database that you want to
use. If the SQL Server database is local and you are using the
Microsoft SQL Server driver, enclose the word local in
parentheses: (local).
• Use Trusted Connection Allows SQL Server to
authenticate users based on their Windows NT logins. You
can use this option if the SQL Server database uses an
Integrated or Mixed security mode.
Login Info • Database The name of the SQL Server database.
• Language The national language used by SQL Server.
• Generate Stored Procedure for Prepared
Statement Stored procedures are created for prepared
statements when you select this option. The SQL Server
driver prepares a statement by placing it in a procedure and
compiling that procedure.
Translation Convert OEM to ANSI characters Select this option if the
SQL Server client computer and SQL Server are using the
same non-ANSI character set. For example, if SQL Server uses
code page 850 and the client computer uses code page 850 for
the OEM code page, selecting this option ensures that
extended characters stored in the database convert properly to
ANSI for use by Windows-based applications.
install.book Page 122 Thursday, May 10, 2001 12:59 PM
Option Description
Data Source Name A name for your ODBC data source.
Description Descriptive information about the data source.
Database Name The name of the database to which you want to connect.
Server IP Address The IP Address of the server that contains the SQL database
that you want to access.
Server Port The number of the TCP/IP port which the server monitors for
connections.
Create Stored Determines whether stored procedures should be created on
Procedures every call, only if parameters are specified, or never.
Note
OLE DB and ODBC connections to Access function identically at the programmatic
level, but OLE DB connections under load are substantially more robust than ODBC.
Wherever possible, you should use OLE DB instead of ODBC to connect to Access
data sources. For details on how to configure an OLE DB data source, see Advanced
ColdFusion Server Administration.
Option Description
Data Source Name A name for your data source.
Description Descriptive information about the data source.
Database File Click Browse to select a database file for a file-based ODBC
data source.
System Database Click Browse to select a shared database. The default user is
Admin and the default password is an empty string. A system
database can be used to secure Microsoft Access database
files.
install.book Page 124 Thursday, May 10, 2001 12:59 PM
Option Description
Driver Settings • Page Timeout The number of milliseconds before a
request for a ColdFusion page times out.
• Buffer Size The total number of bytes that ColdFusion
uses to cache application pages. Enter a value to optimize
ColdFusion performance.
Default Login A username and password combination that ColdFusion uses
to access the data source. If your ODBC data source requires a
username or password, enter them here.
To verify your data source, you need to enter login information
here.
Note
This discussion also applies to many other file-based databases, such as dBASE,
FoxPro, and Paradox.
Note
For an Access database, point to the mdb file. For other file-based databases,
such as dBASE/FoxPro, point to the directory that contains the database files.
9 Select Control Panel > Services > Cold Fusion Application Server > StartUp >
LogOnAs > This Account and specify username: YourDomainName\cfusion and
password: bob. Click OK.
10 Stop and restart the Cold Fusion service so the changes take effect (the Cold
Fusion service now runs under the cfusion account).
11 Open the ColdFusion Administrator.
12 Set up an ODBC data source pointing to the remote database. In the Database
File field of the Create Data Source page, type—do not browse to—the name of
your database in Universal Naming Convention (UNC) format.
Note
The UNC format is: \\servername\sharename\path\filename, where servername
is the name of the server that you will connect to, sharename is the name of a
volume on that server, path is the name of the directory and subdirectories that
contain the file, and filename is the name of the database file; for example,
\\mstillman\cdrive\cfusion\database\cfexamples.mdb.
13 Check if you can connect to the data source with MSQuery (the Microsoft Query
tool that uses ODBC the same way as does Cold Fusion).
With these settings, you can verify that your permissions are sufficient to access the
remote data source.
Note
ColdFusion supports Oracle 7.3.4 and Oracle 8.0.4 and later.
Option Description
Data Source Name A name for your data source.
Description Descriptive information about the data source.
Host String Enter the database alias that you created using the Oracle
Net8 Easy Config utility. To find the database alias for the
database that you want to connect to, you can use the Oracle
Net8 Easy Config utility.
Option Description
Data Source Name A name for your data source.
Description Descriptive information about the data source.
Host String Enter the database alias that you created using the Oracle
Net8 Easy Config utility. To find the database alias for a
database, you can use the Oracle Net8 Easy Config utility.
install.book Page 128 Thursday, May 10, 2001 12:59 PM
ODBC drivers: MERANT Oracle 7.3.4 and Oracle 8.0.x options (UNIX)
The following table describes ColdFusion ODBC driver options for the MERANT
Oracle 7.3.4 and MERANT Oracle 8.0.x ODBC drivers on UNIX:
Option Description
Data Source Name A name for your data source.
Description Descriptive information about the data source.
Connect String The client connection string designating the server and
database that you want to access.
Note
The readme.ora file in $CFHOME/odbc/src/oracle incorrectly refers to $CFHOME as
$ODBC_HOME.
Code Description
scup= Setting for the connect string name in the ColdFusion Administrator.
HOST=scup The IP address, as in HOST=205.185.22.33.
PORT=1521 Port that the tcp listener is assigned to. To identify it, look at the /etc/
services file of the UNIX computer where the Oracle server resides.
SID=WG73 Database identifier. See your Oracle administrator. These settings
are configured when you install the database.
When you complete all the steps in this section, you must stop and restart
ColdFusion services to reload the odbc.ini file.
Oracle troubleshooting
If ColdFusion cannot establish a connection to the Oracle 7.3.4 driver, try the
following workarounds:
• Move the location of the ORACLE_HOME/lib to the end of the
LD_LIBRARY_PATH in the start script.
• Make sure that the listener port number is the same one that you are pointing to
in the tnsnames.ora file.
• Check in the $ORACLE_HOME/lib directory for the libclntsh.so file. If it does not
exist, you must reinstall the Oracle client software.
If the basic information that you entered in the Oracle Net8 Easy Config is correct,
but the connection test fails, then seek assistance from your Oracle 8 database
administrator (DBA). You should first check the basic connection information:
hostname, SID, username, and password. You can do this using the Net8 Easy Config
utility or by directly inspecting the tnsnames.ora file.
In addition, on UNIX, make sure that you defined the Oracle client library and
ORACLE_HOME in the coldfusion/bin/start script.
LD_LIBRARY_PATH=/lib:/usr/dt/lib:/usr/openwin/lib:$CFHOME/
lib:$ORACLE_HOME/lib;export LD_LIBRARY_PATH
2 From $CFHOME/odbc/src/oracle run the script./genclntsh8.
The script generates a new libclntsh.so in CFHOME; move it to $CFHome/lib.
Note
Oracle 8 users have the original libclntsh.so library in the $ORACLE_HOME/lib
directory. Therefore when creating the LD_LIBRAY_PATH in the $CFHOME/bin/
start script, the $CFHOME/lib directory, containing the correct library, must be
on the LD_LIBRARY_PATH before $ORACLE_HOME/lib. Otherwise, the original
Oracle version loads, resulting in an error.
Before you get started, make sure you have the following information handy:
• The name of the host system where the Oracle database resides
• The System Identifier (SID) for your Oracle 8 database
• A login ID and password for connecting to the Oracle 8 database
3 In the dialog box, select TCP/IP as the networking protocol to connect with.
Select the Oracle 8 database that you want to use in your ColdFusion application.
4 In the dialog box, enter the host name of the server where the Oracle 8 database
resides. The following figure shows the default for the port number:
5 After entering a host name, enter the Database SID, which identifies your specific
Oracle database instance.
The default is ORCL, but your database SID may be different. For this
information, see your DBA.
6 In the next dialog box, test the database service that you created.
To test the connection to the Oracle database, enter a username and password to
access the database. If you do not have this information, see your DBA.
install.book Page 134 Thursday, May 10, 2001 12:59 PM
Appendix
Contents
• Before You Install ColdFusion Server .................................................................... 136
• After You Install ColdFusion Server ....................................................................... 146
install.book Page 136 Thursday, May 10, 2001 12:59 PM
Note
ClusterCATS does not support Dynamic Host Configuration Protocol (DHCP). You
must assign a unique IP address to each Web server.
URL IP Address
www1.company.com 192.168.0.1
www2.company.com 192.168.0.2
install.book Page 137 Thursday, May 10, 2001 12:59 PM
Reverse translation entries (PTR records) are just the opposite and look like this:
IP Address URL
192.168.0.1 www1.company.com
192.168.0.2 www2.company.com
It is important that you configure your Web sites to have forward and reverse DNS
entries on your primary DNS server. If you are not responsible for maintaining your
primary DNS server, tell your DNS administrator to add both forward and reverse
entries for your explicit Web server names (www1.company.com,
www2.company.com, and so on).
Note
If both forward and reverse translations are not configured for each explicit Web
server, ClusterCATS will not operate correctly.
Round-robin DNS distributes the initial domain-level requests across all four
servers. Thereafter, ClusterCATS distributes load to avoid failed or overloaded
servers.
Note
When using round-robin DNS, do not define a reverse mapping (PTR record) for the
site name (www.company.com); the cluster does not operate properly if you do.
Only define forward mappings (A records) for www.company.com. However, define
both A records and PTR records for all of the explicit servers (www1, www2,...) in the
cluster. This configuration ensures that requests cycle through the servers
sequentially in round-robin fashion.
Note
You must add the STREAMS Environment to the network protocols in Windows NT
4.0 systems before installing ClusterCATS for ColdFusion. The ClusterCATS
installation procedure automatically configures STREAMS for Windows 2000
systems.
4 Click Add.
The Select Network Protocol dialog box displays.
5 Select STREAMS Environment from the list of available network protocols and
click OK.
6 Close the Network dialog box. Windows NT prompts you to restart your
computer. Click No. (You restart your system at the end of this procedure.)
7 Open the Devices icon in the Control Panel.
8 Select STREAMS Environment from the list of devices and click Startup. Select
System for the Startup Type and click OK.
9 Restart your system for the changes to take effect.
install.book Page 142 Thursday, May 10, 2001 12:59 PM
Configuring firewalls
Many corporate environments today rely on firewalls to securely control access to
proprietary knowledge that resides on public Internet sites, intranet sites, or private
extranet sites. You can configure ClusterCATS to work across one or more firewalls.
A common technique is to use Network Address Translation (NAT) as a security
precaution on your firewall. This configuration segregates internal and external
resources and facilitates extra control and monitoring of Web traffic.
Note
If no internal DNS server is available, you can use the hosts files as the source of
name resolution.
4 Ensure that internal names match external names. The difference between the
external FQHN and the internal FQHN should be the IP addresses. For example,
examine DNS entries for the following clusters of two servers:
External
Forward Reverse
Server 1 FQHN www1.company.com 205.205.205.10
205.205.205.10 www1.company.com
Server 2 FQHN www2.company.com 205.205.205.20
205.205.205.20 www2.company.com
Server 1 Round-Robin www.company.com
205.205.205.10
Server 2 Round-Robin www.company.com
205.205.205.20
install.book Page 143 Thursday, May 10, 2001 12:59 PM
Internal
Forward Reverse
Server 1 FQHN www1.company.com 192.168.0.10
192.168.0.10 www1.company.com
Server 2 FQHN www2.company.com 192.168.0.20
192.168.0.20 www2.company.com
Note
Do not set up any internal round-robin entries. Also, static IP addresses are
recommended in lieu of dynamic IP address when clustering behind any
load-balancing or translating hardware.
5 You should test name resolution using the following diagnostic tools:
6 Create the cluster using the Cluster Creation Wizard. Enter the FQHN for each
server in the cluster, its maintenance address, and so on.
7 Enter the external round-robin names in the Web site alias field in the
ClusterCATS Explorer. Select Start > Programs > ColdFusion Server 5 >
ClusterCATS Explorer. Right-click on the cluster > Configure > Administration >
Load Balance > Website Alias.
8 Test fail-over by restarting either server and trying to hit either server with a Web
browser. Hit the round-robin name and test its ability to serve.
Note
If you are using static IP addresses with ClusterCATS fail-over, the failing server
encounters an IP conflict upon recovery and restarts to reclaim its IP address.
install.book Page 144 Thursday, May 10, 2001 12:59 PM
If you manage your cluster from behind another firewall, you must open both ports
so that the ClusterCATS Explorer can communicate with the cluster.
The following diagram illustrates this scenario:
As you can see, this scenario involves Company ABC, which has an East Coast and a
West Coast group of servers connected to the Internet and protected by several
firewalls. The ClusterCATS Explorer resides at the corporate headquarters behind a
firewall with a direct connection to the Internet.
You must open and configure the appropriate communication ports on your
firewalls to allow server to server communication in a distributed setting and server
to client communication.
Note
You must open both ports on all affected firewalls.
Option Description
Load thresholds for servers Two response time thresholds configured for each
server. One threshold defines maximum or busy load;
the second activates load management. If the load for
the server exceeds the busy threshold, no new sessions
can start on that server. If another server in the cluster
has the capacity to handle additional users, requests are
redirected to that server. The load-management
activation threshold is referred to as the gradual
redirection threshold and is designed to prevent the
server from ever reaching the peak threshold.
For more information on load thresholds, see Advanced
ColdFusion Administration.
Email addresses for alarm ClusterCATS generates alarm notifications for several
recipients events including HTTP server failures, server busy, and
Web server failover. You provide e-mail addresses of all
administrators you want ClusterCATS to notify for each
generated alarm notification.
For more information on ClusterCATS alarms, see
Advanced ColdFusion Administration.
Session-aware load If your Web applications use session variables that store
balancing information in Web server memory, you should enable
session-aware load-balancing. This feature prevents
users who have established a session from being
redirected to another server as a result of
load-balancing.
For more information on enabling session-aware load
balancing, see Advanced ColdFusion Administration.
install.book Page 147 Thursday, May 10, 2001 12:59 PM
Option Description
Administering with the If you are using a UNIX system to administer your cluster
ClusterCATS Web with the ClusterCATS Web Explorer, you must configure
Explorer your Web server to host the Web Explorer pages.
For more information, see Advanced ColdFusion
Administration.
Administrative Password protect administrative access to your cluster
authentication members using domain accounts (Windows NT only) or
local accounts on each system (UNIX and Windows NT).
Administrative users must also be members of the group
sys, or a special BT_<clustername> group.
For more information, see Advanced ColdFusion
Administration.
install.book Page 148 Thursday, May 10, 2001 12:59 PM