Macromedia COLDFUSION MX 61 User Manual
Configuring and Administering
ColdFusion MX
Trademarks
Afterburner, AppletAce, Attain, Attain Enterprise Learning System, Attain Essentials, Attain Objects for Dreamweaver,
Authorware, Authorware Attain, Authorware Interactive Studio, Authorware Star, Authorware Synergy, Backstage, Backstage
Designer, Backstage Desktop Studio, Backstage Enterprise Studio, Backstage Internet Studio, ColdFusion, Design in Motion,
Director, Director Multimedia Studio, Doc Around the Clock, Dreamweaver, Dreamweaver Attain, Drumbeat, Drumbeat 2000,
Extreme 3D, Fireworks, Flash, Fontographer, FreeHand, FreeHand Graphics Studio, Generator, Generator Developer's Studio,
Generator Dynamic Graphics Server, JRun, Knowledge Objects, Knowledge Stream, Knowledge Track, Lingo, Live Effects,
Macromedia, Macromedia M Logo & Design, Macromedia Flash, Macromedia Xres, Macromind, Macromind Action, MAGIC,
Mediamaker, Object Authoring, Power Applets, Priority Access, Roundtrip HTML, Scriptlets, SoundEdit, ShockRave,
Shockmachine, Shockwave, Shockwave Remote, Shockwave Internet Studio, Showcase, Tools to Power Your Ideas, Universal
Media, Virtuoso, Web Design 101, Whirlwind and Xtra are trademarks of Macromedia, Inc. and may be registered in the United
States or in other jurisdictions including internationally. Other product names, logos, designs, titles, words or phrases mentioned
within this publication may be trademarks, servicemarks, or tradenames of Macromedia, Inc. or other entities and may be
registered in certain jurisdictions including internationally.
This product includes code licensed from RSA Data Security.
This guide contains links to third-party websites that are not under the control of Macromedia, and Macromedia is not
responsible for the content on any linked site. If you access a third-party website mentioned in this guide, then you do so at your
own risk. Macromedia provides these links only as a convenience, and the inclusion of the link does not imply that Macromedia
endorses or accepts any responsibility for the content on those third-party sites.
Apple Disclaimer
APPLE COMPUTER, INC. MAKES NO WARRANTIES, EITHER EXPRESS OR IMPLIED, REGARDING THE
ENCLOSED COMPUTER SOFTWARE PACKAGE, ITS MERCHANTABILITY OR ITS FITNESS FOR ANY
PARTICULAR PURPOSE. THE EXCLUSION OF IMPLIED WARRANTIES IS NOT PERMITTED BY SOME STATES.
THE ABOVE EXCLUSION MAY NOT APPLY TO YOU. THIS WARRANTY PROVIDES YOU WITH SPECIFIC LEGAL
RIGHTS. THERE MAY BE OTHER RIGHTS THAT YOU MAY HAVE WHICH VARY FROM STATE TO STATE.
Copyright © 1999–2003 Macromedia, Inc. All rights reserved. This manual may not be copied, photocopied, reproduced,
translated, or converted to any electronic or machine-readable form in whole or in part without prior written approval of
Macromedia, Inc.
Part Number ZCF61M200
Acknowledgments
Project Management: Randy Nielsen
Writing: Randy Nielsen
Editing: Linda Adler, Noreen Maher
First Edition: August 2003
Macromedia, Inc.
600 Townsend St.
San Francisco, CA 94103
CONTENTS
INTRODUCTION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
About Macromedia ColdFusion MX documentation . . . . . . . . . . . . . . . . . . . . . . . 9
Documentation set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Viewing online documentation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
PART I: Administering ColdFusion MX
CHAPTER 1: Administering ColdFusion MX. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
About the ColdFusion MX Administrator. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Accessing user assistance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Administrator layout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Server Settings section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Data & Services section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Debugging & Logging section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Extensions section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Security section. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
CHAPTER 2: Basic ColdFusion MX Administration . . . . . . . . . . . . . . . . . . . . . . . 17
Initial administration tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Server Settings section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Settings page. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Caching page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Client Variables page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Memory Variables page. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Mappings page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Mail Server page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Charting Settings page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Java and JVM Settings page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Archives and Deployment page. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Settings Summary page. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Data & Services section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Data Sources page. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Verity Collections page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
3
Verity K2 Server page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Web Services page. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Debugging & Logging section. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Debugging Settings page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Debugging IP Addresses page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Logging Settings page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Log Files page. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Scheduled Tasks page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
System Probes page. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Code Compatibility Analyzer page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Extensions section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Java Applets page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
CFX Tags page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Custom Tag Paths page. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
CORBA Connectors page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Security section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
CF Admin Password page. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
RDS Password page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Sandbox Security page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Custom Extensions section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
CHAPTER 3: Data Source Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
About JDBC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Supplied drivers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Adding data sources. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Adding data sources in the Administrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Connecting to DB2 Universal Database 6.x, 7.2, and OS/390 . . . . . . . . . . . . . . . 41
Connecting to Informix 9.x. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Connecting to Microsoft Access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Connecting to Microsoft Access with Unicode . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Connecting to Microsoft SQL Server 7.x, 2000. . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Connecting to MySQL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Connecting to ODBC Socket . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Connecting to Oracle R3 (8.1.7), Oracle 9i. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Connecting to other data sources. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Connecting to Sybase 11.5, 11.9, 12.0, and 12.5 . . . . . . . . . . . . . . . . . . . . . . . . . 54
CHAPTER 4: Web Server Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
Understanding web servers in ColdFusion MX . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
Using the built-in web server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
Using an external web server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Web server configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Using GUI mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Using the command-line interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Configuration files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Advanced configurations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
Multihoming . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
SSL. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
4 Contents
CHAPTER 5: Administering Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
About ColdFusion MX security. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Security and edition differences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Using sandbox security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Using multiple sandboxes (Enterprise Edition only) . . . . . . . . . . . . . . . . . . . . . 70
Resources that can be restricted . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
About directories and permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
Adding a sandbox (Enterprise Edition only) . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
Configuring a sandbox . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
CHAPTER 6: Using Multiple Server Instances . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
Overview of multiple server instances . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
Defining additional server instances . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Deploying ColdFusion MX. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Enabling application isolation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
Web server configuration for application isolation . . . . . . . . . . . . . . . . . . . . . . 78
Enabling load balancing and failover . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
PART II: Administering Verity
CHAPTER 7: Introducing Verity Tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
About the Verity utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
ColdFusion MX OEM restrictions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
Collection structure and ColdFusion MX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
Verity search modes in ColdFusion MX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
How ColdFusion MX determines which mode to use. . . . . . . . . . . . . . . . . . . . 87
Verity information storage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
About K2 Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
CHAPTER 8: Managing Collections with the mkvdk Utility . . . . . . . . . . . . . . . . . . 89
About the Verity mkvdk utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
The mkvdk utility syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
Getting started with the Verity mkvdk utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
Creating a collection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
Collection setup options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
General processing options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
Date format options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
Service-level keywords . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
Message options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
Document processing options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
Bulk submit options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
Using bulk insert and delete options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
Collection maintenance options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
Examples: maintaining collections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
Deleting a collection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
Optimization keywords . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
Contents 5
About squeezing deleted documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
About optimized Verity databases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
Performance tuning options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
CHAPTER 9: Indexing Collections with Verity Spider . . . . . . . . . . . . . . . . . . . . . 101
About Verity Spider. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
Web standard support. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
Restart capability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
State maintenance through a persistent store. . . . . . . . . . . . . . . . . . . . . . . . . . 102
Performance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
About Verity Spider syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
The Verity Spider command. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
Using a command file. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
Command-line option reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
Core options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
Processing options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
Networking options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
Path and URL options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
Content options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
Locale options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
Logging options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
Maintenance options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
Setting MIME types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
Syntax restrictions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
MIME types and web crawling. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
MIME types and file system indexing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
Indexing unknown MIME types. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
Known MIME types for file system indexing . . . . . . . . . . . . . . . . . . . . . . . . . 131
CHAPTER 10: Searching Collections with K2 Server . . . . . . . . . . . . . . . . . . . . . 133
Using K2 Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
Editing the k2server.ini file. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
Starting K2 Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
Specifying K2 Server parameters in the ColdFusion MX Administrator . . . . . 135
Stopping K2 Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
Stopping K2 Server when run as a service . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
Stopping K2 Server when run as an application . . . . . . . . . . . . . . . . . . . . . . . 136
Stopping K2 Server on UNIX. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
The k2server.ini parameter reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
Server section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
Search thread keywords. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
Collection sections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
Using the rck2 utility to search K2 Server documents . . . . . . . . . . . . . . . . . . . . . 140
rck2 syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
rck2 command options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
6 Contents
CHAPTER 11: Searching Collections with the rcvdk Utility. . . . . . . . . . . . . . . . . . 143
Using the Verity rcvdk utility. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
Attaching to a collection using the rcvdk utility. . . . . . . . . . . . . . . . . . . . . . . . . . 144
Basic searching . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
Viewing results of the rcvdk utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
Displaying more fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
CHAPTER 12: Troubleshooting Collections with Verity Utilities. . . . . . . . . . . . . . 149
Overview of Verity utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
Using the Verity didump utility. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
Viewing the word list with the didump utility . . . . . . . . . . . . . . . . . . . . . . . . 150
Viewing the zone list with the didump utility. . . . . . . . . . . . . . . . . . . . . . . . . 151
Viewing the zone attribute list with the didump utility. . . . . . . . . . . . . . . . . . 151
Using the Verity browse utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
Using menu options with the browse utility . . . . . . . . . . . . . . . . . . . . . . . . . . 152
Displaying fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
Using the Verity merge utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
Merging collections using the merge utility . . . . . . . . . . . . . . . . . . . . . . . . . . 154
Splitting collections using the merge utility . . . . . . . . . . . . . . . . . . . . . . . . . . 154
CHAPTER 13: Verity Error Messages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
VDK mode error codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
Generic error codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
Usage error codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
Runtime error codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
Data error codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
Query error codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
Licensing error codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
Security error codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
Remote connection error codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
Filtering error codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
Dispatch error codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
Warning error codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
K2 mode error codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
Generic error codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
Usage error codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
Runtime error codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
Data error codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
Query error codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
Security error codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
Remote connection error codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
File handling error codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
Dispatch error codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
Warning error codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
TCP/IP error codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
INDEX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
Contents 7
8 Contents
INTRODUCTION
Configuring and Administering ColdFusion MX is intended for anyone who needs to configure and
manage their ColdFusion development environment.
About Macromedia ColdFusion MX documentation
The ColdFusion documentation is designed to provide support for the complete spectrum of
participants.
Documentation set
The ColdFusion documentation set includes the following titles:
Book Description
Installing and Using
ColdFusion MX
Configuring and
Administering
ColdFusion MX
Developing ColdFusion
MX Applications
Getting Started
Building ColdFusion
MX Applications
CFML Reference Provides descriptions, syntax, usage, and code examples for all ColdFusion
CFML Quick Reference A brief guide that shows the syntax of ColdFusion tags, functions, and variables.
Describes system installation and basic configuration for Windows, Solaris,
Linux, and HP-UX.
Part I describes how to manage the ColdFusion environment, including
connecting to your data sources and configuring security for your applications.
Part II describes Verity search tools and utilities that you can use for configuring
the Verity K2 Server search engine, as well as creating, managing, and
troubleshooting Verity collections.
Describes how to develop your dynamic web applications, including retrieving
and updating your data, using structures, and forms.
Contains an overview of ColdFusion features and application development
procedures. Includes a tutorial that guides you through the process of
developing an example ColdFusion application.
tags, functions, and variables.
Viewing online documentation
All ColdFusion MX documentation is available online in HTML and Adobe Acrobat Portable
Document Format (PDF) files. Go to the documentation home page for ColdFusion MX on the
Macromedia website: www.macromedia.com.
10 Introduction
PART I
Administering ColdFusion MX
This part describes how to use the ColdFusion MX Administrator to manage
the ColdFusion environment, including connecting to your data sources and
configuring security for your applications
Chapter 1: Administering ColdFusion MX. . . . . . . . . . . . . . . . . . . . . . . . . 13
Chapter 2: Basic ColdFusion MX Administration . . . . . . . . . . . . . . . . . . . 17
Chapter 3: Data Source Management. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Chapter 4: Web Server Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
Chapter 5: Administering Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Chapter 6: Using Multiple Server Instances . . . . . . . . . . . . . . . . . . . . . . . . 75
PART I
CHAPTER 1
Administering ColdFusion MX
This chapter presents an overview of the ColdFusion MX Administrator and how you can use it
to manage your development environment. For procedures, see the ColdFusion MX
Administrator online Help.
Contents
About the ColdFusion MX Administrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Accessing user assistance. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Administrator layout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
About the ColdFusion MX Administrator
The ColdFusion MX Administrator provides a browser-based interface for managing your
ColdFusion environment. You can configure many settings to provide optimal levels of security
and functionality. The available options are based on your edition of ColdFusion: Standard or
Enterprise, as well as your configuration: server or J2EE.
The default location for the ColdFusion MX Administrator login page is:
http://servername/CFIDE/administrator/index.cfm
In the previous URL, servername is the fully qualified domain name of your web server. Common
values for servername are localhost or 127.0.0.1 (each refers to the web server on the local
computer).
If you are using the ColdFusion built-in web server, include the port number as part of the
servername. The default port number is 8500. For example, http://servername:8500/CFIDE/
administrator/index.cfm.
If you are using the J2EE configuration, include the port number used the J2EE application
server’s web server. For example, http: //servername:8100/CFIDE/administrator/index.cfm.
If your ColdFusion MX Administrator is on a remote computer, use the DNS name or IP address
of the remote host.
To access the ColdFusion MX Administrator, enter the password specified when you installed
ColdFusion MX.
13
Accessing user assistance
You can obtain assistance from the ColdFusion MX Administrator in the following ways:
• Online Help You access the context-sensitive online Help by clicking the question-mark icon
on any ColdFusion MX Administrator page. The online Help has procedural and brief
overview content for the ColdFusion MX Administrator page that you are viewing. This
information appears in a new browser window and contains standard Contents, Index, and
Search tabs.
• Documentation Click the link to access the entire ColdFusion MX documentation set
online.
• Examples The example applications provide samples for you to learn about ColdFusion
MX.
• Tech notes You can access the collection of articles about ColdFusion MX from the
Macromedia website.
Administrator layout
The home page of the ColdFusion MX Administrator includes links to Documentation, the
Macromedia Servers TechNotes Knowledge Base, Release Notes, System Information, online
Help, and Code Examples.
The tasks that you perform in the ColdFusion MX Administrator are grouped into the following
sections. Each section contains links to pages for managing aspects of the system.
• Server Settings Manage whitespace, client and memory variables, locking, and mappings.
Register a mail server and configure mail logging. Configure your JVM, the ColdFusion
charting and graphing engine, and create and manage archives.
• Data & Services Configure data sources, Verity collections, and the Verity K2 Server.
Define mappings to web services.
• Debugging & Logging Manage options that can assist you in troubleshooting your
ColdFusion applications. Manage scheduled tasks, system probes, and a variety of log files and
server statistics. Run the Code Compatibility Analyzer to assist you in migrating older
ColdFusion applications.
• Extensions Configure and register Java Applets, CORBA ORBs, and CFX Tags.
• Security Control passwords for ColdFusion MX Administrator and Remote Development
Services (RDS) access. Restrict the use of resources, such as data sources.
For more information about each section, see Chapter 2, “Basic ColdFusion MX
Administration,” on page 17.
Server Settings section
The Server Settings section contains the following areas:
• Settings Manage the number of simultaneous requests, request timeouts, whitespace, and
handlers.
• Caching Manage caching options for memory, database connection time, the number of
cached queries, and using a trusted template cache.
14 Chapter 1: Administering ColdFusion MX
• Client Variables Configure an external data source, the operating system registry, or web
browser cookies to store client variables. These can use and store information about a client
browsing your site to provide customized page content.
• Memory Variables Specify timeout values for Application and Session variables. These
variables are stored in RAM and maintain information throughout a ColdFusion session.
• Mappings Create logical aliases for physical directories on your server. One of your first tasks
after installing ColdFusion is to configure the mapping for your web server.
• Mail Server Configure the mail server that ColdFusion uses to send dynamic mail messages
using SMTP (Simple Mail Transfer Protocol). Specify backup mail servers for failover and
manage concurrent threads (Enterprise Edition only).
• Charting Specify caching and thread settings for the ColdFusion charting and graphing
engine.
• Java and JVM Settings Manage Java Virtual Machine settings such as paths, heap sizes,
and implementation options. Not available in the J2EE configuration.
• Archives and Deployment Create and deploy application archives.
• Settings Summary View the status of all ColdFusion configuration settings. You can
navigate to a particular area of the ColdFusion MX Administrator by clicking its name.
Data & Services section
The Data & Services section contains the following pages:
• Data Sources Create and manage your data sources. You can specify login parameters,
connection information, and restrict certain SQL operations. For more information, see
Chapter 3, “Data Source Management,” on page 37.
• Verity Collections Create and manage your Verity collections. Search engines for your
ColdFusion applications use these indexes of various files within specified directories.
• Verity K2 Server Configure the Host Name and Port settings for your K2 Server. This
specialized server is optimized for high-performance Verity searches.
• Web Services Define a mapping to the location of a web service.
Debugging & Logging section
The Debugging & Logging section contains the following pages:
• Debugging Settings Enable and configure information to help you diagnose ColdFusion
page failures. You can return information on items such as template stack, database activity,
and variable values.
• Debugging IP Addresses Control which IP addresses receive debug messages.
• Logging Settings Specify the directory for your log files, and whether to write some
ColdFusion log messages to the operating system’s logging facility (such as EventLog for
Windows and syslog for UNIX).
• Log Files Search, view, download, schedule, archive, or delete a file from a list of all available
log files.
• Scheduled Tasks Add, edit, or delete scheduled tasks. These tasks are helpful for such items
as daily reports, inventories, and statistical reports.
Administrator layout 15
• System Probes Manage probes that monitor your application’s status. If a potential
problem is detected, a system probe can send an alert e-mail message and execute a recovery
script.
• Code Analyzer Evaluate application code for potential incompatibilities between
ColdFusion MX and ColdFusion Server 5.
Extensions section
The Extensions section contains the following pages:
• Java Applets Register, edit, or delete Java applets. You must register a Java applet prior to
adding it to your CFFORM forms using the
cfapplet tag.
• CFX Tags Register, edit, or delete C++ and Java custom tags.
• Custom Tag Paths Register the paths that contain your custom tags.
• CORBA Connectors Register, edit, or delete CORBA connectors. You can also specify ORB
initialization options.
Security section
The Security section contains the following pages:
• CF Admin Password Set the password for the administrator.
• RDS Password Set the password for Dreamweaver MX and CF Studio users connecting to
ColdFusion.
• Sandbox Security Restrict access to ColdFusion resources such as data sources, tags,
functions, files and directories, and IP addresses. This is called Resource Security in
ColdFusion MX Standard Edition.
For more information, see Chapter 5, “Administering Security,” on page 69.
16 Chapter 1: Administering ColdFusion MX
CHAPTER 2
Basic ColdFusion MX Administration
This chapter explains the basic ColdFusion MX administration tasks, following the structure of
the ColdFusion MX Administrator sections.
Contents
Initial administration tasks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Server Settings section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Data & Services section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Debugging & Logging section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Extensions section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Security section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Custom Extensions section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Initial administration tasks
Immediately after installing ColdFusion MX, you might have to perform some or all of the
administrative tasks described in the following table:
Task Description
Establish database
connections
Specify directory
mappings
Configure debugging
settings
ColdFusion applications require data source connections to query and
write to databases. To create, verify, edit, and delete database
connections, use the Data Sources pages in the Administrator.
For more information, see Chapter 3, “Data Source Management,”
on page 37.
Directory mappings redirect relative file paths to physical directories on
your server. To specify server-wide directory aliases, use the Mappings
page in the Administrator.
For more information, see “Mappings page” on page 22.
Debugging information provides important data about CFML page
processing. To choose the debugging information to display, and to
designate an IP address to receive debugging information, use the
Debugging & Logging section of the Administrator.
For more information, see “Debugging Settings page” on page 28.
17
Task Description
Set up e-mail E-mail lets ColdFusion MX and ColdFusion applications send automated
Change passwords You might have to change the passwords that you set for the ColdFusion
Configure Java settings Java and Java applets require configuring Java settings, such as JVM
Restrict tag access Some CFML tags might present a potential security risk for your server. To
mail messages. To configure an e-mail server and mail options, use the
Mail Server page of the Administrator.
For more information, see “Mail Server page” on page 23.
MX Administrator and RDS during ColdFusion MX installation. To change
passwords, use the Security section of the Administrator.
For more information, see “CF Admin Password page” on page 34 and
“RDS Password page” on page 34.
paths. To change Java settings, use the Java and JVM page of the
Administrator.
For more information, see “Extensions section” on page 33.
disable certain tags, use the Sandbox Security page of the Administrator.
For more information, see “Administering Security” on page 69.
Server Settings section
The Server Settings section lets you manage client and memory variables, mappings, charting,
and archiving. You also configure mail and Java settings in this section.
Settings page
The Settings page of the ColdFusion MX Administrator contains configuration options that you
can set or enable to manage ColdFusion MX. These options can significantly affect server
performance. The following table describes the settings:
Setting Description
Limit simultaneous
requests
(Server configuration only)
Timeout requests after [n]
seconds
Use UUID for cftoken Specify whether to use a universally unique identifier (UUID), rather
Enable HTTP status codes Select this option to configure ColdFusion MX to set a status code of
Enable Whitespace
Management
(Server configuration only)
18 Chapter 2: Basic ColdFusion MX Administration
Enter a number to limit simultaneous requests to ColdFusion MX.
When the server reaches the limit, requests are queued and handled in
the order received. Limiting the number of simultaneous requests can
improve performance.
Enable this option to prevent unusually lengthy requests from using up
server resources. Enter a limit to the time that ColdFusion MX waits
before terminating a request. Requests that take longer than the
timeout period are terminated.
than a random number, for a cftoken.
500 Internal Server Error for an unhandled error. Disable this option to
configure ColdFusion MX to set a status code of 200 OK for
everything, including unhandled errors.
Enable this option to compress runs of spaces, tabs and carriage
return/line feeds. Compressing whitespace can significantly compact
the output of a ColdFusion page.
Setting Description
Missing Template Handler Specify a page to execute when ColdFusion MX cannot find a
Site-wide Error Handler Specify a page to execute when ColdFusion MX encounters an error
requested page. This specification is relative to the web root.
If the user is running Internet Explorer with "Show Friendly HTTP error
messages" enabled in advanced settings (the default), Internet
Explorer will only display this page if it contains more than 512 bytes.
while processing a request. This specification is relative to the web
root. If the user is running Internet Explorer with "Show Friendly HTTP
error messages" enabled in advanced settings (the default), Internet
Explorer will only display this page if it contains more than 512 bytes.
Caching page
The Caching page of the Administrator contains configuration options that you can set or enable
to cache templates, queries, and data sources
. These options can significantly affect server
performance. The following table describes the settings:
Setting Description
Template cache size
(number of templates)
Trusted cache Enable this option if you want ColdFusion MX to use cached templates
Save Class Files Select this option to save to disk the class files generated by the
Cache web server paths
(Server configuration only)
Limit the maximum number
of cached queries on the
server to [n] queries
Enable this option to limit the memory reserved for template caching.
For best performance, set this to a value that is large enough to contain
your application’s commonly accessed ColdFusion pages, yet small
enough to avoid excessive reloading. You can experiment with a range
of values on your development server; a suitable starting point is one
page per MB of JVM size.
without checking whether they changed. For sites that are not updated
frequently, using this option minimizes file system overhead.
ColdFusion bytecode compiler. During the development phase, it is
typically faster to disable this option.
Select this option to cache ColdFusion page paths for a single server.
Deselect this option if ColdFusion MX connects to a web server with
multiple websites or multiple virtual websites.
Enable this option by entering a value to limit the maximum number of
cached queries that the server maintains. Cached queries allow
retrieval of result sets from memory rather than 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.
You enable cached queries with the
attributes of the
cfquery tag.
cachedwithin or cachedafter
Server Settings section 19
Client Variables page
Client variables let you store user information and preferences between sessions. Using
information from client variables, you can customize page content for individual users.
You enable client variable default settings in ColdFusion MX on the Client Variables page of the
Administrator. ColdFusion MX lets you store client variables in the following ways:
• In database tables
If your data source uses one of the JDBC drivers bundled with ColdFusion, ColdFusion can
automatically create the necessary tables. If your data source uses the ODBC Socket or a thirdparty JDBC driver, you must manually create the necessary CDATA and CGLOBAL database
tables. For more information, see Developing ColdFusion MX Applications.
• As cookies in users’ web browsers
• In the operating system registry
Caution: Macromedia recommends that you do not store client variables in the registry because it
can critically degrade performance of the server. If you do use the registry to store client variables,
you must allocate sufficient memory and disk space.
You can override settings specified in the Client Variables page using the attributes of the
cfapplication tag. For more information, see Developing ColdFusion MX Applications.
The following table compares these storage options:
Storage type Advantages Disadvantages
Data source • Can use existing data source
• Portable: not tied to the host
system or operating system
Browser cookies • Simple implementation
• Good performance
• Can be set to expire automatically
• Client-side control
System registry • Simple implementation
• Good performance
• Registry can be exported easily to
other systems
• Server-side control
• Requires database transaction to read/
write variables
• More complex to implement
• Users can configure browsers to
disallow cookies
• Cookie data to is limited to 4 KB
• Netscape Navigator allows only 20
cookies from one host; ColdFusion MX
uses three cookies to store read-only
data, leaving only 17 cookies available
• Possible restriction of the registry’s
maximum size limit in Windows in the
Control Panel
• Integrated with the host system: not
practical for clustered servers
• Solaris, Linux, and HP-UX registries are
text files. Their registries deliver slow
performance and low scalability.
20 Chapter 2: Basic ColdFusion MX Administration
Migrating client variable data
To migrate your client variable data to another data source, you should know the structure of the
database tables that store this information. Client variables stored externally use two simple
database tables, like those shown in the following tables:
CDATA Table
Column Data type
cfid CHAR(64), TEXT, VARCHAR, or equivalent
app CHAR(64), TEXT, VARCHAR, or equivalent
data MEMO, LONGTEXT, LONG VARCHAR, or equivalent
CGLOBAL Table
Column Data type
cfid CHAR(64), TEXT, VARCHAR, or equivalent
data MEMO, LONGTEXT, LONG VARCHAR, or equivalent
lvisit TIMESTAMP, DATETIME, DATE, or equivalent
Creating client variable tables
Use the following sample ColdFusion page as a model for creating client variable database tables
in your own database. However, keep in mind that not all databases support the same column
data type names. For the proper data type, see your database documentation.
Tip: The ColdFusion MX Administrator can create client variable tables for data sources that use
bundled JDBC drivers. For more information, see the online Help.
Sample table creation page
<!---- Create the Client variable storage tables in a datasource.
This example applies to Microsoft Access databases --->
<cfquery name="data1" datasource="#DSN#">
CREATE TABLE CDATA
(
cfid char(20),
app char(64),
data memo
)
</cfquery>
<cfquery name="data2" datasource="#DSN#">
CREATE UNIQUE INDEX id1
ON CDATA (cfid,app)
</cfquery>
<cfquery name="global1" datasource="#DSN#">
CREATE TABLE CGLOBAL
(
cfid char(20),
data memo,
lvisit date
Server Settings section 21
)
</cfquery>
<cfquery name="global2" datasource="#DSN#">
CREATE INDEX id2
ON CGLOBAL (cfid)
</cfquery>
<cfquery name="global2" datasource="#DSN#">
CREATE INDEX id3
ON CGLOBAL (lvisit)
</cfquery>
Memory Variables page
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 MX. 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 in two days. Session
variables expire when user sessions end. To change these behaviors, enter new default and
maximum timeout values on the Memory Variables page of the Administrator.
Note: Timeout values that you specify for application variables override the timeout values set in
Application.cfm.
You can also specify whether to use J2EE session variables. When you enable the J2EE session
variables, ColdFusion creates an identifier for each session and does not use the CFToken or
CFID cookie value. For more information, see Developing ColdFusion MX Applications.
Mappings page
You use the Mappings page of the ColdFusion MX Administrator to add, update, and delete
logical aliases for paths to directories on your server. ColdFusion mappings apply only to pages
processed by ColdFusion MX 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.
Assume that the "/" mapping on your server points to C:\CFusionMX\wwwroot, but all your
ColdFusion header pages reside in c:\2002\newpages\headers. In order for ColdFusion MX to
find your header pages, you must add a mapping in the ColdFusion Administrator that points to
c:\2002\newpages\headers (for example, add a mapping for /headers that points to
c:\2002\newpages\headers). In the ColdFusion pages located in C:\CFusionMX\wwwroot, you
reference these header pages using /headers in your
Note: ColdFusion mappings are different from web server virtual directories. For information on
creating a virtual directory to access a given directory using a URL in your web browser, consult your
web server’s documentation.
22 Chapter 2: Basic ColdFusion MX Administration
cfinclude and cfmodule tags.
Mail Server page
You use the Mail Server page of the ColdFusion MX Administrator to specify a mail server to
send automated e-mail messages. ColdFusion MX supports the Simple Mail Transfer Protocol
(SMTP) for sending e-mail messages and the Post Office Protocol (POP) for retrieving e-mail
messages 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 MX Enterprise edition supports mail server failover as well as additional mail
delivery options.
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 might 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 Developing ColdFusion MX Applications.
Mail Connection Settings area
Select preferences for handling mail logs, as described in the following table:
Setting Description
Mail Server Lets you enter a valid mail server for sending dynamic SMTP mail
messages in the text box. You can enter an Internet address, such as
mail.company.com or the IP address of the mail server, such as 127.0.0.1.
Server Port Enter the number of the port on which the mail server is running. Contact
your server administrator if you are unsure of the appropriate port number.
Verify Mail Server
Connection
Backup Mail Servers
(Enterprise Edition only)
Maintain Connection to
Mail Server
(Enterprise Edition only)
Connection Timeout
(seconds)
Spool Interval (seconds) Enter the number of seconds at which you want the mail server to process
Mail Delivery Threads
(Enterprise Edition only)
Select this option to verify that ColdFusion MX can connect to your
specified mail server after you submit this form.
Whether or not you use this option, you should verify that your mail server
connection works by sending a test message.
Enter zero or more backup servers for sending SMTP mail messages.
You can enter an Internet address, such as mail.company.com, or the IP
address of the mail server, such as 127.0.0.1. Separate multiple servers
with a comma.
If the mail server requires authentication, prefix the mail server with the
username and password, as follows:
username:password@mailserveraddress.
To use a port number other than the default (25), specify
mailserveraddress:portnumber.
Select this option to keep mail server connections open after sending a
mail message. Enabling this option can enhance performance when
delivering multiple messages.
Enter the number of seconds that ColdFusion MX should wait for a
response from the mail server.
spooled mail.
The maximum number of simultaneous threads used to deliver spooled
mail.
Server Settings section 23
Setting Description
Spool mail messages for
delivery
(Memory spooling
available for Enterprise
Edition only)
Maximum number of
messages spooled to
memory
(Enterprise Edition only)
Select this option to route outgoing mail messages to the mail spooler. If
you disable this option, ColdFusion MX delivers outgoing mail messages
immediately. In ColdFusion MX Enterprise Edition, you can spool
messages either to disk (slower, but messages persist across shutdowns)
or to memory (faster, but messages do not persist).
You can override this setting in the
Enter the maximum number of messages ColdFusion MX will spool to
memory before switching to disk spooling.
cfmail tag.
Mail Logging Settings area
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
Log all e-mail messages
sent by ColdFusion MX
message to write to a log file. The options are: Debug, Warning, Debug,
Information, and Error.
Enable this option to save to a log file the To, From, and Subject fields of
all e-mail messages.
ColdFusion MX writes sent mail and mail error logs to either of the following directories:
• \CFusionMX\logs, in Windows
• /opt/coldfusionmx/log, on Solaris, Linux, and HP-UX
The following table describes the e-mail log files:
Log Description
mailsent.log Records sent e-mail messages
mail.log Records general e-mail errors
Charting Settings page
The ColdFusion charting and graphing engine lets you produce highly customizable business
graphics, in a variety of formats, using the
cfquery tag. You use the Charting page in the
Administrator to control characteristics of the engine.
The following table describes the caching and thread settings for the ColdFusion charting and
graphing engine:
Setting Description
Cache Type Set the cache type. Charts can be cached either in memory or to disk. In
memory caching is faster, but more memory intensive.
Maximum number of
images in cache
24 Chapter 2: Basic ColdFusion MX Administration
Specify the maximum number of charts to store in the cache. After the
cache is full, if you generate a new chart, ColdFusion discards the oldest
chart in the cache.
Setting Description
Max number of charting
threads
Disk cache location When caching to disk, specify the directory in which to store the
Specify the maximum number of chart requests that can be processed
concurrently. The minimum number is 1 and the maximum is 5. Higher
numbers are more memory intensive.
generated charts.
Java and JVM Settings page
The Java and JVM Settings page lets you specify the following settings, which enable ColdFusion
MX to work with Java:
Setting Description
Java Virtual Machine Path The absolute file path to the location of the Java virtual machine
(JVM) root directory. Default is cf_root/runtime/jre.
Initial Memory Size The JVM initial heap size. Default is 8196 MB.
Maximum Memory Size The JVM maximum heap size. Default is 512 MB.
Class Path The file paths to the directories that contain the JAR files used by
ColdFusion MX. Specify either the fully qualified name of a
directory that contains your JAR files or a fully qualified JAR file
name. Use a comma to separate multiple entries.
JVM Arguments The arguments to the JVM. Use a space to separate multiple
entries; for example, -Xint -Xincgc
Before ColdFusion saves your changes, it saves a copy of the current cf_root/runtime/bin/
jvm.config file as jvm.bak. If your changes prevent ColdFusion from restarting, use jvm.bak to
restore your system. For more information, see the online Help.
Note: This page is not enabled in the J2EE configuration.
Archives and Deployment page
The Archives and Deployment page includes tools that let you archive and deploy ColdFusion
applications, configuration settings, data source information, and other types of information to
back up your files quickly and easily. The complete list of archivable information includes the
following:
• Name and file location
• Server settings
• ColdFusion mappings
• Data sources
• Verity collections
• Scheduled tasks
• Java applets
• CFX tags
• Archive to do lists
Server Settings section 25
After you archive the information, you can use the Administrator to deploy your web applications
to the same ColdFusion MX server or to a ColdFusion MX server running on a different
computer. Additionally, you can use these features to deploy and receive any ColdFusion archive
file electronically.
The Archive Settings page in the Administrator lets you configure various archive system settings
that apply to all archive and deploy operations. For more information, see the online Help.
Settings Summary page
The Settings Summary page shows all ColdFusion configuration settings. Click a group name to
open that group’s Administrator section, where you can edit settings. This page is not enabled in
the Standard Edition.
Data & Services section
The Data & Services section of the Administrator is the interface between you, ColdFusion MX,
data sources, and Verity search and indexing features. The following table describes some
common tasks that you can perform in the Data & Services section of the Administrator:
Task Description
Create and manage
JDBC data sources
Create and maintain
Verity collections
Register a Verity K2
Server with ColdFusion
MX
Define mappings for web
services
The Data Sources page lets you establish, edit, and delete JDBC data
source connections for ColdFusion MX. For more information, see
Chapter 3, “Data Source Management,” on page 37.
The Verity Collections page lets you create and delete Verity collections
and perform maintenance operations on collections that you create. For
more information, see “Verity Collections page” on page 26.
The Verity K2 Server page lets you register a K2 Server to use with
ColdFusion MX. For more information, see “Verity K2 Server page”
on page 27.
Web services let you produce and consume remote application
functionality over the internet. For more information, see “Web Services
page” on page 27.
Data Sources page
The Data Sources page lets you create, edit, and delete data sources. Before you can use a database
in a ColdFusion application, you must register the data source in the ColdFusion MX
Administrator. For more information,
see Chapter 3, “Data Source Management,” on page 37.
Verity Collections page
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.
26 Chapter 2: Basic ColdFusion MX Administration
For more information about building search interfaces, see the chapters about the cfindex,
cfsearch, and cfcollection tags in Developing ColdFusion MX Applications.
ColdFusion lets you manage your collections from the Administrator. You can index, repair,
optimize, purge, or delete Verity collections that are connected to ColdFusion. You use the
buttons along the bottom of the Connected Verity Collections table to perform the following
actions:
Action Description
Index Analyzes the files in a collection and assembles metadata and pointers to the files.
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. You should 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.
Note: Before performing management operations, ensure that the K2 Server is not using the
collections. For more information, see “Administering Verity” on page 83.
Verity K2 Server page
For faster searching, configure a K2 Server in the ColdFusion MX Administrator. The highperformance K2 Server caches collection information so that your searches retrieve documents
more quickly. The Verity K2 Server delivers rapid search results in a highly efficient and scalable
architecture.
For more information on configuring and using K2 Server with ColdFusion, see
Verity” on page 83
.
“Administering
Web Services page
You can use web services to produce and consume remote application functionality over the
Internet. The ColdFusion MX Administrator lets you register web services so that you do not
have to specify the entire Web Services Description Language (WSDL) URL when you reference
the web service. The first time you reference a web service, ColdFusion MX automatically
registers it in the Administrator.
When you register a web service, you can shorten your code and change a web service’s URL
without editing your code. For more information, see Developing ColdFusion MX Applications.
Debugging & Logging section
You use the Debugging Settings and Debugging IPs pages of the Administrator to configure
ColdFusion MX to provide debugging information for every application page requested by a
browser. You specify debugging preferences using the pages as follows:
• On the Debugging Settings 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.
Debugging & Logging section 27
This section also includes pages for managing your Log Files, Scheduled Tasks, System Probes,
and the Code Compatibility Analyzer.
Debugging Settings page
The Debugging Settings page provides the following debugging options:
Setting Description
Enable Robust Exception
Information
Enable Debugging Enables the ColdFusion debugging service.
Select Debugging Output Format Select a format of:
Report stack trace to a depth of [n]
rows
Database Activity Shows the database activity for the SQL Query events and
Exception Information Shows all ColdFusion exceptions raised for the request in the
Tracing Information Shows trace event information in the debugging output.
Variables Displays information about parameters, URL parameters,
Enable Robust Exception
Information
Enable Performance Monitoring*
(Server configuration only)
Enable CFSTAT*
(Server configuration only)
Displays detailed information in the exceptions page, including
the template’s physical path and URI, the line number and
snippet, the SQL statement used (if any), the data source
name (if any), and the Java stack trace.
• classic.cfm - The format available in ColdFusion 5 and
earlier. It provides a basic view and few browser restrictions.
• dockable.cfm - A dockable tree-based debugging panel.
For details about the panel and browser restrictions, see the
online Help.
Reports execution times. The stack trace shows a hierarchical
tree of executed templates, includes, modules, and custom
tags that were executing at the time of the exception. The
default is 5. A blank value or 0 implies no limit.
Stored Procedure events in the debugging output.
debugging output.
Tracing lets you track program flow and efficiency through the
use of the
cookies, session, and CGI variables in the debugging output.
Lets visitors view detailed information in the exceptions page,
including: the template’s physical path and URI, the line
number and snippet, the SQL statement used (if any), the
Data Source Name (if any), and the Java stack trace.
Enables the standard NT Performance Monitor application to
display information about a running ColdFusion Application
Server.
Shows performance information on platforms that do not
support the NT Performance Monitor. For more information,
see “Using the cfstat utility” on page 29.
cftrace tag.
* Restart ColdFusion MX after changing this setting.
28 Chapter 2: Basic ColdFusion MX Administration
Using the cfstat utility
The cfstat command-line utility provides real-time performance metrics for ColdFusion MX.
Using a socket connection to obtain metric data, the cfstat utility displays the information that
ColdFusion MX writes to the System Monitor without actually using the System Monitor
application. The following table lists the metrics that cfstat returns:
Metric
abbreviation Metric name Description
Pg/Sec Page hits per second The number of ColdFusion pages processed
DB/Sec Database accesses per
second
CP/Sec Cache pops per second The number of ColdFusion template cache
Req Q'ed Number of queued requests The number of requests that are currently
Req Run'g Number of running requests The number of requests that ColdFusion MX is
Req TO'ed Number of timed out requests The total number of ColdFusion requests that
AvgQ Time Average queue time A running average of the time, in milliseconds,
AvgReq Time Average request time A running average of the time, in milliseconds,
AvgDB Time Average database transaction
time
per second. You can reduce this by moving
static content to HTML pages.
The number of database accesses per second
made by ColdFusion MX. Any difference in
complexity and resource load between calls is
ignored.
pops per second. A cache pop occurs when
ColdFusion MX ejects a cached template from
the template cache to make room for a new
template.
waiting for ColdFusion MX to process them.
Lower values, which you can achieve with
efficient CFML, are better.
currently actively processing.
have timed out. Lower values, which you can
achieve by aggressive caching, removing
unnecessary dynamic operations and thirdparty events, are better.
that requests spend waiting for ColdFusion MX
to process them. Lower values, which you can
achieve with efficient CFML and enhanced
caching, are better.
that ColdFusion MX spends to process a
request (including queued time). Lower values,
which you can achieve with efficient CFML, are
better.
A running average of the time that ColdFusion
MX spends on database-related processing of
ColdFusion requests.
Debugging & Logging section 29
Metric
abbreviation Metric name Description
Bytes In/Sec Bytes incoming per second The number of bytes that ColdFusion MX read
in the last second (not an average).
Bytes Out/Sec Bytes outgoing per second The number of bytes that ColdFusion MX wrote
in the last second (not an average).
Before you use the cfstat utility, ensure that you selected the Enable Performance Monitoring
check box in the ColdFusion MX Administrator (on the Debugging & Logging > Debugging
Settings page). If you select this check box, you must restart ColdFusion MX for this change to
take effect.
Your cfusionmx\bin directory contains the cfstat utility. From that directory, type cfstat and use
the following available switches:
Switch Description/Comment
-n Suppress column headers (useful for saving output to a file).
-s Display output in a single line (delay display of the first line so cfstat can display
# Where # is an integer, delay display output by # seconds. If you do not specify an
-h Web server hostname (localhost is the default).
-p Web server listening port number (80 is the default).
meaningful values in the per-second counters).
integer, cfstat returns one line.
Debugging IP Addresses page
You use the Debugging IP Addresses page to restrict debugging output to one or more IP
addresses. You can add and remove IP addresses.
Note: If you do not specify IP addresses, and debugging options are active, debugging output is
displayed for all users.
30 Chapter 2: Basic ColdFusion MX Administration
Loading...