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

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

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.

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.

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.

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.

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

<cfquery name="data1" datasource="#DSN#"> CREATE TABLE CDATA ( cfid char(20), app char(64), data memo ) </cfquery>

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>

CREATE INDEX id2 ON CGLOBAL (cfid)

</cfquery>

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

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

Logging Settings page

You use the Logging Settings page of the Administrator to change ColdFusion MX logging options. The following table describes the settings:

Setting Description

Log directory* Directory to which error log files are written.

Maximum file size (kb) Set the maximum file size for log files. Once a file hits this size, it will be

automatically archived.

Maximum number of archives

Log slow pages taking longer than [n] seconds

Log all CORBA calls Log all CORBA calls.

Enable logging for scheduled tasks

* Restart ColdFusion MX after changing this setting.

Set the maximum number of log archives to create. After reaching this limit, files will be deleted in order of oldest to newest.

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.

Log ColdFusion Executive task scheduling.

Log Files page

The Log Files page of the Administrator lets you perform operations on log files, such as searching, viewing, downloading, archiving, and deleting.

Click on a Log File icon, located in the Actions column of the Available Log Files table, to search, view, download, archive, or delete a log file.

For more information, see the online Help.

The following table describes the ColdFusion MX log files:

Log Description

rdservice.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 MX error reported to a user. Application page errors,

including ColdFusion MX syntax, ODBC, and SQL errors are written to the log file.

webserver.log Records errors that occur in the web server and the ColdFusion MX stub.

exceptions.log Records stacktraces for exceptions that occur in the server.

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 Records errors for ColdFusion MX.

customtag.log Records errors generated in custom tag processing.

Debugging & Logging section 31

Log Description

car.log Records errors associated with Site Archive and Restore operations.

mail.log Records errors generated by an SMTP mail server.

mailsent.log Records messages sent by ColdFusion MX.

flash.log Records entries for Flash Remoting.

Scheduled Tasks page

You use the Scheduled Tasks page 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 read more often than written is a good candidate for scheduled tasks. Instead of executing a query to a database every time the page is requested, ColdFusion MX 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.

The Schedule Task page lets you create, edit, and delete scheduled tasks. For more information, see the online Help.

System Probes page

System probes help you evaluate the status of your ColdFusion applications. Like scheduled tasks, they access a URL at a specified interval, but they can also check for the presence or absence of a string in the URL. If the URL contents are unexpected, or if an error occurred while accessing the URL, the probe can send an e-mail alert to the address specified in the System Probes page. The probe can also execute a script to perform a recovery action, such as restarting the server. All probe actions are logged in logs/probes.log. The System Probes page also displays the status of each probe.

You use the buttons in the Actions column in the System Probes table to perform the following actions:

Action Description

Edit Lets you edit the probe.

Run Runs the probe immediately, even if it was previously disabled.

Enable/ Disable

Delete Deletes the probe.

Starts and stops the probe from automatically executing at its specified interval.

Because probes run as scheduled ColdFusion tasks, they will not run if the ColdFusion MX server on which they are hosted crashes, or if the host web server crashes or otherwise does not respond.

32 Chapter 2: Basic ColdFusion MX Administration

Code Compatibility Analyzer page

The Code Compatibility Analyzer evaluates your ColdFusion pages for potential incompatibilities between ColdFusion MX and ColdFusion Server 5.

Extensions section

You use the Extensions section of the Administrator to configure ColdFusion MX to work with other technologies, such as Java and CORBA. This section contains the Java Applets, CFX Tags, Custom Tag Paths, and CORBA Connectors pages.

Java Applets page

The Java Applets page of the Administrator lets you register applets and edit 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 MX, 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.

For more information, see the online Help.

CFX Tags page

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 can build CFX tags in the following two ways:

• 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 the cfx.jar file

For more information, see the online Help.

Custom Tag Paths page

You use the Custom Tag Paths page of the Administrator to add, edit, and delete custom tag directory paths. The default custom tag path is under the installation directory. To use custom tags in another path, register the path on this Administrator page.

For more information, see the online Help.

CORBA Connectors page

You use the CORBA Connectors page of the Administrator to register, edit, and delete CORBA connectors. You must register CORBA connectors before using them in your ColdFusion applications. You must also restart the server when you are done with the CORBA Connector configuration.

Extensions section 33

ColdFusion MX loads ORB libraries dynamically using a connector, which does not restrict ColdFusion developers to a specific ORB vendor. The connectors depend on the ORB runtime libraries provided by the vendor. A connector for Borland Visibroker is embedded within ColdFusion MX. Make sure that the ORB runtime libraries are in cf_root/runtime/lib.

The following table contains information about the libraries and connectors:

Operating System Vendor ORB

Windows NT and later

Solaris Borland VisiBroker 4.5 coldfusion.runtime.corba.Visib

HP-UX Borland VisiBroker 4.5 coldfusion.runtime.corba.Visib

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.

Borland VisiBroker 4.5 coldfusion.runtime.corba.Visib

ColdFusion connector ORB library

rokerConnector (embedded)

The following lines are an example of a CORBA connector configuration for VisiBroker:

ORB Name visibroker ORB Class Name coldfusion.runtime.corba.VisibrokerConnector ORB Property Filec:\cfusionmx\runtime\cfusion\lib\vbjorb.properties Classpath [blank]

ColdFusion includes the vbjorb.properties file, which contains the following properties that configure the ORB:

org.omg.CORBA.ORBClass=com.inprise.vbroker.orb.ORB org.omg.CORBA.ORBSingletonClass=com.inprise.vbroker.orb.ORB SVCnameroot=namingroot

Security section

The Security section of the Administrator lets you configure the security frameworks of ColdFusion MX.

For more information on security, see Chapter 5, “Administering Security,” on page 69.

vbjorb.jar

CF Admin Password page

You use the CF Admin Password page of the Administrator to enable and disable passwordrestricted access to the Administrator, and to change the Administrator password.

RDS Password page

You use the RDS Password page to enable and disable password-restricted access to server resources from Macromedia Dreamweaver MX or Macromedia HomeSite+ using Remote Development Services (RDS), and to change the password.

34 Chapter 2: Basic ColdFusion MX Administration

Sandbox Security page

You use the Sandbox Security page (called Resource Security in the Standard Edition) to specify security permissions for data sources, tags, functions, files, and directories.

Sandbox security uses the location of your ColdFusion pages to determine functionality. A sandbox is a designated area (CFM files or directories containing CFM files) of your site to which you apply security restrictions. By default, a subdirectory (or child directory) inherits the sandbox settings of the directory one level above it (the parent directory). If you define sandbox settings for a subdirectory, you override the sandbox settings inherited from the parent directory.

Use sandbox security to control access to:

• Data sources

• Ta g s

• Functions

• Files and directories

• IP addresses and ports

Custom Extensions section

You can extend the functionality of the ColdFusion Administrator by adding links to other web applications and sites. These links appear under the Custom Extensions section in the left navigation pane of the Administrator.

Note: You must create a link for the Custom Extensions section to appear in the Administrator.

To extend the Administrator, create a file that contains the HTML link code, followed by a <BR>, with a separate line for each link. Do not include other HTML code, such as tags. Save this file as extensionscustom.cfm in the Administrator root directory (/CFIDE/ administrator/).

For example, the following file adds to the Administrator links for Bowdoin College, Universidad Complutense de Madrid, and La Sapienza:

<a href="http://www.bowdoin.edu/" target="content">Bowdoin College</a><br> <a href="http://www.http://www.ucm.es/" target="_blank">Universidad

Complutense de Madrid</a><br>

<a href="http://www.uniroma1.it/" target="_blank">La Sapienza</a><br>

When you click a link, the page displays. The target attribute is required; if you specify target="content", the page appears in the main pane of the Administrator. If you specify any other value for the target attribute, the page appears in a new window.

Custom Extensions section 35

36 Chapter 2: Basic ColdFusion MX Administration

CHAPTER 3

Data Source Management

This chapter describes the configuration options for ColdFusion MX data sources. For basic information on data sources and connecting to databases, see Developing ColdFusion MX Applications.

About JDBC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

Adding data sources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 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

About JDBC

JDBC is a Java Application Programming Interface (API) that you use to execute SQL statements. JDBC enables an application, such as ColdFusion MX, to interact with a variety of relational databases, without using interfaces that are database- and platform-specific.

The following table describes the four types of JDBC drivers:

Type Name Description

1JDBC-ODBC

bridge

2 Native-API/partly

Java driver

3JDBC-Net pure

Java driver

4 Native-protocol/

all-Java driver

Translates JDBC calls into ODBC calls, and sends them to the ODBC driver.

Advantages Allows access to many different databases. Disadvantages The ODBC driver, and possibly the client database

libraries, must reside on the ColdFusion server computer. Performance is also below par.

Macromedia does not recommend this driver type unless your application requires specific features of these drivers.

Converts JDBC calls into database-specific calls.

Advantages Better performance than Type 1 Driver. Disadvantages The vendor’s client database libraries must reside on

the same computer as ColdFusion. Macromedia does not recommend this driver type unless your

application requires specific features of these drivers, such as the Unicode support offered by the ColdFusion MX Microsoft Access with Unicode driver.

Translates JDBC calls to the middle-tier server, which then translates the request to the database-specific native-connectivity interface.

Advantages No need for vendor’s database libraries to be present on client computer. Can be tailored for small size (faster loading).

Disadvantages Database-specific code must be executed in the middle-tier.

ColdFusion MX includes an ODBC socket type 3 driver for use with Microsoft Access databases and ODBC data sources.

Converts JDBC calls into the network protocol used directly by the database. Advantages Fast performance. No special software needed on the computer on which you run ColdFusion MX. Disadvantages Many of these protocols are proprietary, requiring a different driver for each database. ColdFusion MX includes type 4 drivers for many popular DBMSs, however, not all DBMSs are supported in ColdFusion MX Standard Edition.

Supplied drivers

The following table shows the database drivers supplied with ColdFusion MX and where you can find more information:

Driver Type Reference

DB2 Universal Database 6.x, 7.2, and OS/390

Informix 9.x 4 “Connecting to Informix 9.x” on page 43

Microsoft Access 3 “Connecting to Microsoft Access” on page 44

38 Chapter 3: Data Source Management

4 “Connecting to DB2 Universal Database 6.x, 7.2, and

OS/390” on page 41

Driver Type Reference

Microsoft Access with Unicode support

Microsoft SQL Server 7.x, 2000 4 “Connecting to Microsoft SQL Server 7.x, 2000”

MySQL 4 “Connecting to MySQL” on page 48

ODBC Socket 3 “Connecting to ODBC Socket” on page 50

Oracle R3 (8.1.7), Oracle 9i 4 “Connecting to Oracle R3 (8.1.7), Oracle 9i”

Other “Connecting to other data sources” on page 52

Sybase 11.5, 11.9, 12.0, 12.5 4 “Connecting to Sybase 11.5, 11.9, 12.0, and 12.5”

2 “Connecting to Microsoft Access with Unicode”

on page 46

on page 47

on page 51

on page 54

Adding data sources

In the ColdFusion MX Administrator, you configure your data sources to communicate with ColdFusion. Once you add a data source to the Administrator, you access it by name in any CFML tag that establishes database connections; for example, source tells ColdFusion which database to connect to and what parameters to use for the connection.

The ColdFusion MX Administrator organizes all the information about a ColdFusion MX server’s database connections in a single, easy-to-manage location. In addition to adding new data sources, you can use the Administrator to specify changes to your database configuration, such as relocation, renaming, or changes in security permissions.

cfquery. During a query, the data

Adding data sources in the Administrator

You use the ColdFusion MX Administrator to quickly add a data source for use in your ColdFusion applications. When you add a data source, you assign it a data source name (DSN) and set all information required to establish a connection.

Note: ColdFusion MX includes several data sources that are configured by default, including cfsnippets, CompanyInfo, and exampleapps. This procedure should not be necessary to work with these data sources.

To add a data source:

1 In the ColdFusion MX Administrator, select Data & Services > Data Sources. 2 Under Add New Data Source, enter a Data Source Name; for example, MyTestDSN. The

following names are reserved. You cannot use them for data source names:

■ service

■ jms_provider

■ comp

■ jms

3 Select a Driver from the drop-down list box; for example, Microsoft SQL Server.

Adding data sources 39

4 Click Add.

A form for additional DSN information appears. The available fields in this form depend on the Driver that you selected.

5 In the Database field, enter the name of the database; for example, Northwind. 6 In the Server field, enter the network name or IP address of the server that hosts the database,

and enter any required Port value; for example, the bullwinkle server on the default port.

7 If your database requires login information, enter your Username and Password.

Tip: The omission of required username and password information is a common reason why a data source fails to verify.

8 (Optional) Enter a Description. 9 (Optional) Click Show Advanced Settings to specify any ColdFusion-specific settings; for

example, to configure which SQL commands can interact with this data source.

10 Create Submit to create the data source.

ColdFusion MX automatically verifies that it can connect to the data source.

11 (Optional) To verify this data source later, click the verify icon:

Note: To check the status of all data sources available to ColdFusion MX, click Verify All Connections.

Specifying connection string arguments

You can use the ColdFusion MX Administrator to specify connection string arguments for data sources that use the Microsoft Access, ODBC Socket, MYSQL, or DB2 drivers. In the Advanced Settings page for one of these drivers,in the Connection String field, enter name=value pairs separated by a semicolon. The Administrator configures the following ODBC connection string:

DSN=odbcdsnname;APP=RaiseGenerator;WSID=TWriter01

In the preceding string, odbcdsnname is the name of the ODBC DSN. This is the string that the Microsoft Access or ODBC Socket driver uses to connect to the data source at runtime.

Note: The connectstring tag attribute (cfquery tag) is not supported in ColdFusion MX.

Adding data source notes and considerations

When adding data sources to ColdFusion MX, keep these guidelines in mind:

• Data source names should be all one word.

• Data source names can contain only letters, numbers, hyphens, and the underscore.

• Data source names should not contain special characters or spaces.

• Although data source names are not case-sensitive, you should use a consistent capitalization

scheme.

• Depending on the JDBC driver, connection strings and JDBC URLs might be case-sensitive.

• Ensure that you use the Administrator to verify that ColdFusion MX can connect to the data

source.

A data source must exist in the ColdFusion MX Administrator before you use it on an application page to retrieve data.

40 Chapter 3: Data Source Management

Connecting to DB2 Universal Database 6.x, 7.2, and OS/390

Use the settings in the following table to connect ColdFusion to DB2 Universal Database 6.x,

7.2, and OS/390 data sources:

Setting Description

CF Data Source Name The data source name (DSN) used by ColdFusion MX to connect to the

Database The name of the database.

Server The name of the server that hosts the database that you want to use. If the

Port The number of the TCP/IP port that the server monitors for connections.

Username The user name that ColdFusion MX passes to the JDBC driver to connect

Password The password (16-character limit) that ColdFusion MX passes to the JDBC

Description (Optional) A description for this connection.

Connection String A field that passes database-specific parameters, such as login credentials,

data source.

database is local, enclose the word local in parentheses.

to the data source if a ColdFusion application does not supply a user name; for example, in a

cfquery tag.

The username must have CREATE PACKAGE privileges for the database, or the database administrator must create a package. Consult the database administrator when configuring this type of data source.

driver to connect to the data source if a ColdFusion application does not supply a password—for example, in a

cfquery tag.

to the data source. For UDB on the initial connection, specify DatabaseName, PackageName, CreateDefaultPackage, and ReplacePackage, as shown in the following example:

DatabaseName=SAMPLE;PackageName=pkgname;

CreateDefaultPackage=TRUE;ReplacePackage=TRUE

For UDB on subsequent connections, specify DatabaseName and PackageName, as shown in the following example:

DatabaseName=SAMPLE;PackageName=pkgname

For OS/390 on the initial connection, specify LocationName, CollectionId, PackageName, and CreateDefaultPackage, as shown in the following example:

LocationName=SAMPLE;CollectionId=DEFAULT;

PackageName=pkgname;CreateDefaultPackage=TRUE

For OS/390 on subsequent connections, specify LocationName, CollectionId, and PackageName, as shown in the following example:

LocationName=SAMPLE;CollectionId=DEFAULT;

PackageName=pkgname

Where pkgname is the name of the package (maximum of 7 characters) that the driver uses to process SQL statements.

Your user ID must have CREATE PACKAGE privileges on the database, or your database administrator must create a package for you.

Connecting to DB2 Universal Database 6.x, 7.2, and OS/390 41

Setting Description

Limit Connections Specifies whether ColdFusion MX limits the number of database

connections for the data source. If you enable this option, use the Restrict Connections to field to specify the maximum.

Restrict Connections toSpecifies the maximum number of database connections for the data

source. To use this restriction, you must enable Limit Connections.

Maintain Connections ColdFusion establishes a connection to a data source for every operation

that requires one. Enable this option to improve performance by caching the data source connection.

String Format Enable this option if your application uses Unicode data in DBMS-specific

Unicode datatypes such as National Character or nchar.

Max Pooled Statements

Enables reuse of prepared statements (that is, stored procedures and queries that use the

cfqueryparam tag). Although you tune this setting

based on your application, start by setting it to the sum of the following:

• Unique

cfquery tags that use cfqueryparam

• Unique cfstoredproc tags

Timeout (min) The maximum number of minutes after the data source connection is made

that you want ColdFusion to cache a connection after it is used.

Interval (min) The time (in minutes) that the server waits between cycles to check for

expired data source connections to close.

Disable Connections If selected, suspends all client connections.

connection login attempt.

CLOB Select to return the entire contents of any CLOB/Text columns in the

database for this data source. If unchecked, ColdFusion retrieves the amount specified in the Long Text Buffer setting.

BLOB Select to return the entire contents of any BLOB/Image columns in the

database for this data source. If unchecked, ColdFusion retrieves the amount specified in the Blob Buffer setting.

LongText Buffer (chr) The default buffer size, used if Enable Long Text Retrieval (CLOB) is not

selected. Default is 64000 bytes.

BLOB Buffer (bytes) The default buffer size, used if Enable binary large object retrieval (BLOB)

is not selected. Default is 64000 bytes.

Allowed SQL The SQL operations that can interact with the current data source.

42 Chapter 3: Data Source Management

Connecting to Informix 9.x

Use the settings in the following table to connect ColdFusion MX to Informix 9.x data sources:

Setting Description

CF Data Source Name The data source name (DSN) used by ColdFusion MX to connect to the

data source.

Database The database to which this data source connects.

Informix Server The name of the Informix database server to which you want to connect.

Server The name of the server that hosts the database that you want to use. If the

database is local, enclose the word local in parentheses.

Port The number of the TCP/IP port that the server monitors for connections.

Username The user name that ColdFusion MX passes to the JDBC driver to connect

to the data source if a ColdFusion application does not supply a user name; for example, in a

Password The password (16-character limit) that ColdFusion MX passes to the JDBC

driver to connect to the data source if a ColdFusion application does not supply a password; for example, in a

Description (Optional) A description for this connection.

Limit Connections Specifies whether ColdFusion MX limits the number of database

connections for the data source. If you enable this option, use the Restrict Connections to field to specify the maximum.

Restrict Connections toSpecifies the maximum number of database connections for the data

source. To use this restriction, you must enable Limit Connections.

Maintain Connections ColdFusion MX establishes a connection to a data source for every

operation that requires one. Enable this option to improve performance by caching the data source connection.

String Format Enable Unicode for data sources that are configured for non-Latin

characters.

Max Pooled Statements

Timeout (min) The maximum number of minutes after the data source connection is made

Interval (min) The time (in minutes) that the server waits between cycles to check for

Disable Connections If selected, suspends all client connections.

Enables reuse of prepared statements (that is, stored procedures and queries that use the cfqueryparam tag). Although you tune this setting based on your application, start by setting it to the sum of the following:

• Unique

• Unique cfstoredproc tags

that you want ColdFusion MX to cache a connection after it is used.

expired data source connections to close.

connection login attempt.

cfquery tag.

cfquery tags that use cfqueryparam

Connecting to Informix 9.x 43

Setting Description

CLOB Select to return the entire contents of any CLOB/Text columns in the

BLOB Select to return the entire contents of any BLOB/Image columns in the

LongText Buffer The default buffer size, used if Enable Long Text Retrieval(CLOB) is not

BLOB Buffer The default buffer size; used if Enable binary large object retrieval (BLOB)

Allowed SQL The SQL operations that can interact with the current data source.

database for this data source. If not selected, ColdFusion MX retrieves the amount specified in the Long Text Buffer setting.

database for this data source. If not selected, ColdFusion MX retrieves the amount specified in the Blob Buffer setting.

selected. Default is 64000 bytes.

is not selected. Default is 64000 bytes.

Connecting to Microsoft Access

Use the settings in the following table to connect ColdFusion MX to Microsoft Access data sources:

Setting Description

CF Data Source Name The data source name (DSN) used by ColdFusion MX to connect to the

data source.

Database File The file that contains the database.

System Database File To secure access to the specified database file, click Browse Server to

locate and enter a database that contains database security information. The system database is usually located in winnt\system32\system.mdw.

Use Default Username If selected, ColdFusion MX does not pass a user name or password when

requesting a connection. The Microsoft Access driver uses the default user name and password. (specified in Advanced Settings).

ColdFusion Username The user name that ColdFusion MX passes to the JDBC driver to connect

to the data source if a ColdFusion application does not supply a user name; for example, in a

ColdFusion Password The password (16-character limit) that ColdFusion MX passes to the

JDBC driver to connect to the data source if a ColdFusion application does not supply a password; for example, in a

Description (Optional) A description for this connection.

Page Timeout The time (in tenths of a second) before a request for a ColdFusion page

times out.

Max Buffer Size The total number of bytes that ColdFusion MX uses to cache application

pages. Enter a value to optimize ColdFusion performance.

Connection String A field that passes database-specific parameters, such as login

credentials, to the data source.

Default Username The user name that ColdFusion MX passes to the JDBC driver to connect

to the data source if a ColdFusion application does not supply a user name-for example, in a

cfquery tag.

44 Chapter 3: Data Source Management

Setting Description

Default Password The password (16-character limit) that ColdFusion MX passes to the

JDBC driver to connect to the data source if a ColdFusion application

Return Timestamp as String

does not supply a password-for example, in a

Enable this setting if your application retrieves Date/Time data and then re-uses it in SQL statements without applying formatting (using functions

cfquery tag.

such as DateFormat, TimeFormat, and CreateODBCDateTime).

Limit Connections Specifies whether ColdFusion MX limits the number of database

connections for the data source. If you enable this option, use the Restrict Connections to field to specify the maximum.

Restrict Connections to Specifies the maximum number of database connections for the data

source. To use this restriction, you must enable Limit Connections.

Maintain Connections ColdFusion MX establishes a connection to a data source for every

operation that requires one. Enable this option to improve performance by caching the data source connection.

Timeout (min) The maximum number of minutes after the data source connection is

made that you want ColdFusion MX to cache a connection after it is used. The 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 that the connection timeout is never

enforced.

Interval (min) The time (in minutes) that the server waits between cycles to check for

expired data source connections to close.

Disable Connections If selected, suspends all client connections.

connection login attempt.

CLOB Select to return the entire contents of any CLOB/Text columns in the

database for this data source. If not selected, ColdFusion MX retrieves the amount specified in the Long Text Buffer setting.

BLOB Select to return the entire contents of any BLOB/Image columns in the

database for this data source. If unchecked, ColdFusion retrieves the amount specified in the Blob Buffer setting.

LongText Buffer The default buffer size, used if Enable Long Text Retrieval(CLOB) is not

selected. Default is 64000 bytes.

BLOB Buffer The default buffer size, used if Enable binary large object retrieval (BLOB)

is not selected. Default is 64000 bytes.

Allowed SQL The SQL operations that can interact with the current data source.

Connecting to Microsoft Access 45

Connecting to Microsoft Access with Unicode

Type 2 driver. Use the settings in the following table to connect ColdFusion MX to Microsoft Access with Unicode data sources: