Benq COLDFUSION 9 CFML User Manual

Conguring and Administering

ADOBE® COLDFUSION

This guide is licensed for use under the terms of the Creative Commons Attribution Non-Commercial 3.0 License. This License allows users to copy, distribute, and transmit the guide for noncommercial purposes only so long as (1) proper attribution to Adobe is given as the owner of the guide; and (2) any reuse or distribution of the guide contains a notice that use of the guide is governed by these terms. The best way to provide notice is to include the following link. To view a copy of this license, visit

http://creativecommons.org/licenses/by-nc-sa/3.0/

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

AIX is a trademark of International Business Machines Corporation in the United States, other countries, or both. Java, Solaris, and Sun are trademarks or registered trademarks of Sun Microsystems, Inc. in the United States and other countries. UNIX is a registered trademark of The Open Group in the US and other countries. Linux is the registered trademark of Linus Torvalds in the U.S. and other countries. Macintosh is a trademark of Apple Inc., registered in the United States and other countries. Microsoft and Windows are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. All other marks are the property of their respective owners.

Adobe Systems Incorporated, 345 Park Avenue, San Jose, California 95110, USA.

Last updated 8/5/2010

Chapter 1: Introduction

About ColdFusion documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

Chapter 2: Administering ColdFusion

About the ColdFusion Administrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

About web server administration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

About Verity administration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

Chapter 3: Using the ColdFusion Administrator

Initial administration tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

Accessing user assistance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Server Settings section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Data & Services section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

Debugging & Logging section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

Server Monitoring section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

Extensions section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

Event Gateways section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

Security section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

Packaging and Deployment section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

Enterprise Manager section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

Custom Extensions section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

Administrator API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

iii

Chapter 4: Data Source Management

About JDBC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

Adding data sources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

Connecting to Apache Derby Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

Connecting to Apache Derby Embedded . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

Connecting to DB2 Universal Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

Connecting to Informix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

Connecting to Microsoft Access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

Connecting to Microsoft Access with Unicode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

Connecting to Microsoft SQL Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

Connecting to MySQL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

DataDirect Connect JDBC Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

Connecting to ODBC Socket . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

Connecting to Oracle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

Connecting to other data sources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

Connecting to PostgreSQL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

Connecting to Sybase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

Connecting to JNDI data sources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

Connecting to an external JDBC Type 4 data source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58

Last updated 8/5/2010

CONFIGURING AND ADMINISTERING COLDFUSION 9

Contents

Chapter 5: Web Server Management

About web servers in ColdFusion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

Using the built-in web server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

Using an external web server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

Web server configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61

Multihoming . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67

Chapter 6: Deploying ColdFusion Applications

Archive and deployment options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71

Packaging applications in CAR files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71

Packaging applications in J2EE archive files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72

Using the cfcompile utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73

Chapter 7: Administering Security

About ColdFusion security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75

Using password protection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75

Exposing services to users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76

Configure IP address to access exposed services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77

Using sandbox security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77

Chapter 8: Using Multiple Server Instances

About multiple server instances . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82

Defining additional server instances . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

Enabling application isolation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84

Enabling clustering for load balancing and failover . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89

Define remote server instances to the ColdFusion Administrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91

Chapter 9: Using the ColdFusion Server Monitor

Gathering information about ColdFusion servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92

Starting the ColdFusion Server Monitor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92

Viewing Server Monitor Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93

Specifying Server Monitor Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99

ColdFusion Server Monitor API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99

Using the Server Monitor to improve server performance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100

Setting up Server Manager client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102

Server monitoring enhancements in ColdFusion 9.0 Update 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103

Chapter 10: Working with Server Manager

Launch Server Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107

Register servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107

Create Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112

Manage multiple servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112

Monitor multiple servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115

Chapter 11: Introducing Verity and Verity Tools

Collections and the ColdFusion Verity architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116

About Verity Spider . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117

About the Verity utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118

Last updated 8/5/2010

CONFIGURING AND ADMINISTERING COLDFUSION 9

Contents

Chapter 12: Indexing Collections with Verity Spider

About Verity Spider . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119

About Verity Spider syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120

Core options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122

Processing options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123

Networking options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129

Path and URL options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132

Content options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137

Locale options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144

Logging options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145

Maintenance options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147

Setting MIME types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147

Chapter 13: Using Verity Utilities

Overview of Verity utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150

Using the mkvdk utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150

Using the rck2 utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159

Using the rcvdk utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160

Using the didump utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164

Using the browse utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166

Using the merge utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167

Chapter 14: Solr Server and Collections

Solr collections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169

Solr server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169

Migrating from Verity to Solr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169

Last updated 8/5/2010

Chapter 1: Introduction

Configuring and Administering ColdFusion is intended for anyone who has to configure and manage their Adobe® ColdFusion® 9 development environment.

About ColdFusion documentation

The ColdFusion 9 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 Adobe® ColdFusion® 9

Configuring and Administering Adobe® ColdFusion® 9

Developing Adobe® ColdFusion® 9 Applications

Adobe® ColdFusion® 9 CFML Reference

Describes system installation and basic configuration for Windows, Macintosh, Solaris, Linux, and AIX.

Describes how to perform ColdFusion administration tasks such as managing server settings, configuring datasources, managing security, deploying ColdFusion applications, caching, setting up CFX tags, monitoring server activity using the ColdFusion Server Monitor, and configuring web servers.

Describes how to develop your dynamic web applications. This book provides detailed information about using the CFML programming language and ColdFusion features, such as ColdFusion Web Services, ColdFusion Portlets, ColdFusion ORM, AJAX support, Flex and AIR integration, and integration with other products and technologies such as Microsoft Office, OpenOffice, and SharePoint.

Provides descriptions, syntax, usage, and code examples for all ColdFusion tags, functions, and variables.

Viewing online documentation

All ColdFusion documentation is available online in HTML and Adobe Acrobat Portable Document Format (PDF) files. Go to the ColdFusion Help and Support page at documentation. In addition to viewing the online documentation, you can also add and view comments to the documentation.

www.adobe.com/go/learn_cfu_support_en to view the online

Last updated 8/5/2010

Chapter 2: Administering ColdFusion

Although you use the ColdFusion Administrator to perform most ColdFusion administration tasks, you can also manage databases, web server configurations, and Verity Search Server.

About the ColdFusion Administrator

The ColdFusion 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 9—Standard or Enterprise—as well as your configuration: server, multiserver, or J2EE. For more information on ColdFusion configurations, see Preparing to Install ColdFusion in Installing ColdFusion.

The default location for the ColdFusion Administrator login page is:

http://servername[:portnumber]/CFIDE/administrator/index.cfm

Where 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 for the server configuration is 8500; for example, http://servername:8500/CFIDE/administrator/index.cfm. The default port number for the multiserver configuration is 8300. If you are using the J2EE configuration, include the port number that the web server of the J2EE application server uses.

If you were using the built-in web server in a version earlier than ColdFusion MX 7 and upgraded to ColdFusion 8, the installer automatically finds an unused port for the built-in web server (typically 8501).

If your ColdFusion Administrator is on a remote computer, use the Domain Name Services (DNS) name or Internet Protocol (IP) address of the remote host.

To access the ColdFusion Administrator, enter the password specified when you installed ColdFusion.

Note: If you are running ColdFusion in a multihomed environment and have problems displaying the ColdFusion Administrator, see

For more information, see “Using the ColdFusion Administrator” on page 4.

“Web Server Management” on page 59 for configuration information.

About web server administration

ColdFusion applications require a web server to process ColdFusion Markup Language (CFML) pages. The server and multiserver configurations provide a built-in web server along with support for external web servers, such as Apache, IIS, and Sun ONE Web Server (formerly known as iPlanet).

For more information, see “Web Server Management” on page 59.

Last updated 8/5/2010

CONFIGURING AND ADMINISTERING COLDFUSION 9

Administering ColdFusion

About Verity administration

ColdFusion includes Verity K2 Server search technology. Verity K2 Server is a high-performance search engine designed to process searches quickly in a high-performance, distributed system.

For more information, see “Introducing Verity and Verity Tools” on page 116.

Last updated 8/5/2010

Chapter 3: Using the ColdFusion Administrator

Use the Adobe ColdFusion Administrator to perform basic administration tasks. You can also use the Administrator application programming interface (API) to perform Administrator functionality programmatically.

Initial administration tasks

Immediately after you install ColdFusion, you might have to perform some or all the administrative tasks described in the following table:

Task Description

Establish database connections ColdFusion applications require data source connections to query and write to databases. To create,

Specify directory mappings Directory mappings redirect relative file paths to physical directories on your server. To specify server-

Configure debugging settings Debugging information provides important data about CFML page processing. To choose the debugging

Set up e-mail E-mail lets ColdFusion applications send automated e-mail messages. To configure an e-mail server and

Change passwords You might have to change the passwords that you set for the ColdFusion Administrator and Remote

Define user-specific access to the ColdFusion Administrator

Configure Java settings (Server configuration only) You might have to customize Java settings, such as classpath information, to

verify, edit, and delete database connections, use the Data Sources page.

For more information, see “Data Source Management” on page 34.

wide directory aliases, use the Mappings page.

For more information, see “Mappings page” on page 12.

information to display, and to designate an IP address to receive debugging information, use the Debugging & Logging section.

For more information, see “Debugging Output Settings page” on page 19.

mail options, use the Mail Server page.

For more information, see “Mail page” on page 12.

Development Service (RDS) during ColdFusion installation. To change passwords, use the Security section.

For more information, see “Administrator page” on page 27 and “RDS page” on page 27.

To grant user-specific access to the ColdFusion Administrator, you create users and specify a user name, password, applicable sandboxes, and the sections of the ColdFusion Administrator that each user can access. For more information, see

meet the needs of your applications. To change Java settings, use the Java and JVM page.

For more information, see “Extensions section” on page 24.

“Security section” on page 27.

Restrict tag access Some CFML tags might present a potential security risk for your server. To disable certain tags, use the

Sandbox Security page.

For more information, see “Administering Security” on page 75.

Last updated 8/5/2010

CONFIGURING AND ADMINISTERING COLDFUSION 9

Using the ColdFusion Administrator

Accessing user assistance

You can use the buttons on the upper left of the ColdFusion Administrator to access online Help, information about additional resources, and system information.

Online Help Click the question-mark icon on any ColdFusion Administrator page to access the context-sensitive

online Help. The online Help has procedural and brief overview content for the ColdFusion Administrator page that you are viewing. This information appears in a new browser window and contains standard Contents, Index, and Search tabs.

System Information Click System Information to see information about the ColdFusion server, including version

number, serial number, and JVM details.

Resources Click Resources to display the Resources page, which provides links to the following:

• Getting Started experience

• Example applications,

• Product Information

• Technical Support and Training,

• Additional Installers

• Product Updates

• Community Resources

• Security-related Information

Server Settings section

The Server Settings section lets you manage client and memory variables, mappings, charting, and archiving. It also allows you to configure e-mail and Java settings.

Settings page

The Settings page of the ColdFusion Administrator contains configuration options that you can set or enable to manage ColdFusion. These options can significantly affect server performance. The following table describes the options:

Option Description

Timeout Requests After (Seconds) Prevents unusually lengthy requests from using up server resources. Enter a limit to the time that

Enable Per App Settings Lets developers programmatically define ColdFusion settings such as mappings and debugging per

Use UUID For cftoken Specify whether to use a universally unique identifier (UUID), rather than a random number, for a

Enable HTTP Status Codes Configures ColdFusion to set a status code of 500 Internal Server Error for an unhandled error.

ColdFusion waits before terminating a request. Requests that take longer than the time-out period are terminated.

application.

cftoken.

Disable this option to configure ColdFusion to set a status code of 200 OK for everything, including unhandled errors.

Last updated 8/5/2010

CONFIGURING AND ADMINISTERING COLDFUSION 9

Using the ColdFusion Administrator

Option Description

Enable Whitespace Management Compresses repeating sequences of spaces, tabs, and carriage returns and linefeeds. Compressing

Disable CFC Type Check Turns off verifying the CFC type when calling methods with CFCs as arguments. This option also

Disable Implicit UDF Registration When checked, Implicit UDFs (setters/getters) are not added into CFC's 'variable' scope, 'this' scope,

Disable Access To Internal ColdFusion Java Components

Prefix serialized JSON with Protects web services, which return JSON data from cross-site scripting attacks by prefixing serialized

Enable In-Memory File System Enables the in-memory virtual file system support. By default, this is enabled.

Memory Limit for In-Memory Virtual File System

Watch Configuration Files For Changes (Check Every n Seconds)

Enable Global Script Protection Protects Form, URL, CGI, and Cookie scope variables from cross-site scripting attacks. Select this

whitespace can significantly compact the output of a ColdFusion page.

This option is enabled, by default.

disables verifying an object that implements the right interface.

Enabling this option can improve the performance of your application. However enable it only on a production server.

or metadata. Although you can still invoke the implicit UDFs, this improves CFC creation performance.

Prevents CFML code from accessing and creating Java objects that are part of the internal ColdFusion implementation. This prevents a non-authenticated CFML template from reading or modifying administration and configuration information for this server.

JSON strings with a custom prefix.

Lets you specify the memory limit in Megabytes (MB) for in-memory virtual file system.

Sets ColdFusion to monitor its configuration files and automatically reload them if they change. This action is required if you deploy ColdFusion in a Websphere ND vertical cluster, because multiple instances of ColdFusion share the same configuration files. It is recommended that you do not enable this feature for most installations.

option if your application does not contain this type of protection logic.

Allow Extra Attributes in AttributeCollection

Clear temporary files created during CFaaS after

Default ScriptSrc Directory Specify the default path (relative to the web root) to the directory that contains the cfform.js file.

Google Map API Key Specify the Google Map API license key that you require to access Google Maps.

Component with onServerStart() method

Application.cfc/Application.cfm lookup order

Specify whether ColdFusion tags can pass non-standard attributes in the attributecollection structure.

Specify the time in minutes after which the temporary files created during CF as a Service(CFaaS) operation must be deleted. The default value is 30 minutes.

Developers reference this file in the ScriptSrc attribute of the

In a hosted environment, you might need to move the cfform.js file to a directory other than CFIDE.

Specify the absolute path to a CFC having onServerStart() method or specify a dot delimited CFC path under web root, like "a.b.server". By default, ColdFusion looks for server.cfc under web root.

Select the order in which ColdFusion searches for Application.cfm or Application.cfc if it is not found in the current project folder. You can set ColdFusion to search as follows:

cfform tag.

• default search order: ColdFusion looks for an Application.cfc/Application.cfm file from the current

folder until the system root directory. On Windows, this could be C:\ and on UNIX, /opt.

• till web root: ColdFusion looks for an Application.cfc/Application.cfm file from the current folder

till web root.

• in web root: ColdFusion looks for an Application.cfc/Application.cfm file in the current folder or

web root.

Last updated 8/5/2010

CONFIGURING AND ADMINISTERING COLDFUSION 9

Using the ColdFusion Administrator

Option Description

Missing Template Handler Specify a page to execute when ColdFusion cannot find a requested page. This specification is

Site-Wide Error Handler Specify a page to execute when ColdFusion encounters an error while processing a request. This

Maximum Size Of Post Data Limits the amount of data that can be posted to the server in a single request. ColdFusion rejects

RequeSt Throttle Threshold Requests smaller than the specified limit are not queued or counted as part of the total memory.

Request Throttle Memory Limits total memory size for the throttle. If sufficient total memory is not available, ColdFusion

relative to the web root.

Note: If the user is running Microsoft Internet Explorer with "Show Friendly HTTP error messages" enabled, Internet Explorer displays this page only if it contains more than 512 bytes.

specification is relative to the web root. When you define a site-wide error handler or missing template handler, ColdFusion does not log page-not-found errors and exceptions.

Note: If the user is running Internet Explorer with Show Friendly HTTP Error Messages enabled, Internet Explorer only displays this page if it contains more than 512 bytes.

single requests larger than the specified limit.

Requests larger than the specified limit are counted as part of total memory and are queued if the request throttle-memory size is exceeded.

queues requests until enough memory is free.

Request Tuning page

The Request Tuning page of the Administrator contains configuration options that you use to specify the number of different types of requests and threads that ColdFusion can handle simultaneously.

Option Description

Maximum Number Of Simultaneous Template Requests

Maximum Number Of Simultaneous Flash Remoting Requests

Maximum Number Of Simultaneous Web Service Requests

Maximum Number Of Simultaneous CFC Function Requests

Maximum Number Of Simultaneous Report Threads

Maximum Number Of Threads Available For CFTHREAD

Timeout Requests Waiting In Queue After n Seconds

The number of CFML page requests that can be processed concurrently. Use this setting to increase overall system performance for heavy-load applications. Requests beyond the specified limit are queued.

The number of Adobe Flash® Remoting requests that can be processed concurrently.

The number of Web Service requests that can be processed concurrently.

The number of ColdFusion Component methods that can be processed concurrently through HTTP. This does not affect starting CFC methods from CFML, only methods requested through an HTTP request.

The maximum number of ColdFusion reports that can be processed concurrently.

CFTHREAD that runs concurrently. Threads that CFTHREAD creates in excess of the specified limit are queued.

If a request has waited in queue beyond the specified limit, time out the request. This value must be at least as long as the Request Timeout setting (currently 60 seconds).

Last updated 8/5/2010

CONFIGURING AND ADMINISTERING COLDFUSION 9

Using the ColdFusion Administrator

Option Description

Request Queue Timeout Page Specify a relative path to an HTML page to send to clients when a template requests time out before

Maximum Number Of Running JRun Threads

Maximum Number Of Queued JRun Threads

getting a chance to run. For example "/CFIDE/timeout.html.” This page cannot contain CFML. If a page is not specified, clients receive a 500 Request Timeout error when their request does not get a chance to run.

Maximum number of JRun handler threads that run concurrently. This option is used to set the number of request threads that the underlying JRun J2EE application server runs at the same time. This includes any non-ColdFusion requests such as JSP or HTML pages served through JRun.

Maximum number of requests that JRun can accept at any one time. This is the number of requests that the underlying JRun J2EE application server can accept at the same time.

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:

Option Description

Maximum Number Of Cached Templates

Trusted Cache Use cached templates without checking whether they changed. For sites that are not updated

Enter a value that specifies the number of templates that ColdFusion caches. For best application performance, set this option to a value that is large enough to contain the 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 Java Virtual Machine (JVM) size.

frequently, using this option minimizes file system overhead.

Cache Template in Request When checked, any requested files are inspected only once for potential updates within a request. If

Component cache When checked, component path resolution is cached and not resolved again. This setting does not

Save Class Files Saves to disk the class files that the ColdFusion bytecode compiler generates. During the

Cache Web Server Paths Caches ColdFusion page paths for a single server. Clear this option if ColdFusion connects to a web

Maximum Number Of Cached Queries Enter a value to limit the maximum number of cached queries that the server maintains. Cached

Clear Template Cache Now Empties the template cache. ColdFusion reloads templates into memory the next time they are

Clear Component Cache Now Empties the component cache. ColdFusion ignores the resolved path for components and try

unchecked, requested file are inspected for changes each and every time when it is accessed within the same request. For application where templates/components are not expected to reflect updates within the same request, this minimizes file system overhead. This setting does not require restarting the server.

require restarting the server.

development phase, it is typically faster if you disable this option.

server with multiple websites or multiple virtual websites.

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, provide a limit for the number of cached queries. You enable cached queries with the

cfquery tag. When the maximum number of cached queries is reached, the oldest query is

the dropped from the cache and replaced with the specified query. If you set the maximum number of cached queries to 0, query caching is unlimited.

requested and recompiles them if they have been modified.

resolution again.

cachedwithin or cachedafter attributes of

Last updated 8/5/2010

CONFIGURING AND ADMINISTERING COLDFUSION 9

Using the ColdFusion Administrator

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 on the Client Variables page of the Administrator. ColdFusion lets you store client variables in the following ways:

• In database tables

Note: If your data source uses one of the JDBC drivers bundled with ColdFusion 9, ColdFusion can automatically create the necessary tables. If your data source uses the ODBC Socket or a third-party JDBC driver, you manually create the necessary CDATA and CGLOBAL database tables.

• As cookies in the web browsers

• In the operating system registry

Important: Adobe recommends that you do not store client variables in the registry because it can critically degrade performance of the server. If you use the registry to store client variables, you allocate sufficient memory and disk space.

To override settings specified in the Client Variables page, use the Application.cfc file or the cfapplication tag. For more information, see the Developing ColdFusion Applications.

The following table compares the client variable storage options:

Storage type Advantages Disadvantages

Data source

Browser cookies

System registry

• Can use existing data source

• Portable: not tied to the host system or

operating system

• Simple implementation

• Good performance

• Can be set to expire automatically

• Client-side control

• Simple implementation

• Good performance

• Requires database transaction to read/write variables

• More complex to implement

• Users can configure browsers to disallow cookies

• Cookie data is limited to 4-KB

• Netscape Navigator allows only 20 cookies from one host;

ColdFusion 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

• Registry can be exported easily to other systems

• Server-side control

clustered servers

• Not available for UNIX

Migrating client variable data

To migrate your client variable data to another data source, determine the structure of the database tables that store this information. Client variables stored externally use two simple database tables, as shown in the following tables:

Last updated 8/5/2010

CONFIGURING AND ADMINISTERING COLDFUSION 9

Using the ColdFusion Administrator

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.

Note: The ColdFusion Administrator can create client variable tables for data sources that use one of the bundled JDBC drivers. For more information, see the Online Help.

Last updated 8/5/2010

CONFIGURING AND ADMINISTERING COLDFUSION 9

Using the ColdFusion Administrator

Sample table creation page

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

<cfquery name="data2" datasource="#DSN#"> CREATE UNIQUE INDEX id1 ON CDATA (cfid,app) </cfquery>

<cfquery name="global1" datasource="#DSN#"> CREATE TABLE CGLOBAL ( cfid char(20), data memo, lvisit date ) </cfquery>

<cfquery name="global2" datasource="#DSN#"> CREATE INDEX id2 ON CGLOBAL (cfid) </cfquery>

<cfquery name="global2" datasource="#DSN#"> CREATE INDEX id3 ON CGLOBAL (lvisit) </cfquery>

Memory Variables page

Use the Memory Variables page of the ColdFusion Administrator to enable application and session variables serverwide. By default, application and session variables are enabled when you install ColdFusion. 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 time-out values for session and application variables. Unless you define a timeout value in an Application.cfc or Application.cfm file, application variables expire in two days. Session variables expire when user sessions end. To change these behaviors, enter new default and maximum time-out values on the Memory Variables page of the Administrator.

Note: Time-out values that you specify for application variables override the time-out values set in the Application.cfc or Application.cfm file.

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 the Developing ColdFusion Applications.

Last updated 8/5/2010

CONFIGURING AND ADMINISTERING COLDFUSION 9

Using the ColdFusion Administrator

Note: When using J2EE sessions, ensure that the session time out, specified in the WEB-INF/web.xml session-timeout element, is longer than the session time out specified in the ColdFusion Administrator, and longer than any

sessiontimeout attribute specified in a cfapplication tag.

Mappings page

Use the Mappings page of the ColdFusion Administrator to add, update, and delete logical aliases for paths to directories on your server. ColdFusion mappings apply only to pages that ColdFusion processes with the

cfmodule tags. If you save CFML pages outside the web_root directory (or whatever directory is mapped to "/"),

and you add a mapping to the location of those files on your server.

Assume that the "/" mapping on your server points to C:\coldfusion9\wwwroot, but that all of your ColdFusion header pages reside in C:\2002\newpages\headers. Add a mapping in the ColdFusion Administrator that points to C:\2002\newpages\headers, for ColdFusion to find the header pages. For example, add a mapping for /headers that points to C:\2002\newpages\headers. In the ColdFusion pages located in C:\coldfusion9\wwwroot, you reference these header pages using /headers in your

cfinclude and cfmodule tags.

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 documentation.

cfinclude

Mail page

Use the Mail page of the ColdFusion Administrator to specify a mail server to send automated e-mail messages. ColdFusion 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 a POP account.

The ColdFusion 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 has a large queue, delivery could occur after some delay.

Note: For more information about the cfmail tag, see Sending SMTP e-mail with the cfmail tag in Sending and Receiving E-Mail in the Developing ColdFusion Applications.

Mail Server Settings area

The following table describes basic mail server settings:

Option Description

Mail Server Enter a valid mail server for sending dynamic SMTP mail messages in the text box. You can enter an

Username Enter the user name for the mail server, if necessary.

Password Enter the password for the mail server, if necessary.

Internet address, such as mail.company.com, or the IP address of the mail server, such as 127.0.0.1.

Sign Select this check box to configure ColdFusion to digitally sign your mails.

Keystore Location of the Keystore containing the private key and certificate. The supported type is JKS (java key

Keystore Password Keystore password.

KeyAlias Alias of the key with which the certificate and private key is stored in Keystore. If it is not specified then

store) and pkcs12.

the first entry in the Keystore is be picked up.

Last updated 8/5/2010

CONFIGURING AND ADMINISTERING COLDFUSION 9

Using the ColdFusion Administrator

Option Description

KeyPassword Password with which the private key is stored. If it is not specified, KeystorePassword is used as

Verify Mail Server Connection Verifies that ColdFusion can connect to your specified mail server after you submit this form.

Server Port Enter the number of the port on which the mail server is running. Contact your server administrator if

Backup Mail Servers (Enterprise Edition only)

Maintain Connection To Mail Server

(Enterprise Edition only)

Connection Timeout (seconds) Enter the number of seconds that ColdFusion should wait for a response from the mail server before

Enable SSL Socket Connections To Mail Server

Enable TLS Connection To Mail Server

KeyPassword.

Even if you do not use this option, send a test message to verify that your mail server connection works.

you are unsure of the appropriate port number.

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, prepend the mail server with the user name and password, as follows: username:password@mailserveraddress

To use a port number other than the default (25), specify mailserveraddress:portnumber

Keeps mail server connections open after sending a mail message. Enabling this option can enhance performance when delivering multiple messages.

timing out.

Enables SSL encryption on the connections to the mail server.

Enables Transport Level Security (TLS) on the connection to the mail server.

Mail Spool Settings area

The following table describes mail server spool settings:

Option Description

Spool Interval (Seconds) Enter the interval, in seconds, at which you want the mail server to process spooled mail.

Mail Delivery Threads

(Enterprise Edition only)

Spool Mail Messages For Delivery To

(Memory spooling available for Enterprise Edition only)

Maximum Number Of Messages Spooled To Memory

(Enterprise Edition only)

View Undelivered Mail Click to view undelivered mails.

Enter the maximum number of simultaneous threads used to deliver spooled mail.

Routes outgoing mail messages to the mail spooler. If you disable this option, ColdFusion delivers outgoing mail messages immediately. In ColdFusion Enterprise Edition, you can spool messages to disk (slower, but messages persist across shutdowns) or to memory (faster, but messages do not persist).

You can override this setting in the cfmail tag.

Enter the maximum number of messages that spool to memory before switching to disk spooling.

Mail Logging Settings area

Select preferences for handling mail logs, as described in the following table:

Last updated 8/5/2010

CONFIGURING AND ADMINISTERING COLDFUSION 9

Using the ColdFusion Administrator

Option Description

Error Log Severity From the drop-down list object, select the type of SMTP-related error message to write to a log file. The

options are the following:

• Debug (contains Information, Warning, and Error)

• Information (contains Warning and Error)

• Warning (contains Error)

• Error

Log All Mail Messages Sent By ColdFusion

Saves to a log file the To, From, and Subject fields of all e-mail messages.

ColdFusion writes sent-mail and mail-error logs to the following directories:

• \coldfusion9\logs (Windows server configuration)

• /opt/coldfusion9/log (Solaris and Linux server configuration)

• cf_webapp_root/WEB-INF/cfusion/logs (multiserver and J2EE configurations, all platforms)

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.

Mail Character Set Settings area

Select preferences for the default mail character set, as described in the following table:

Option Description

Default CFMail CharSet From the drop-down list object, select the default character set that the cfmail tag uses. The default

value is UTF-8. If most of your e-mail clients use a specific character set, you can use this setting to switch to that locale-specific character set. For example, Japanese mail is typically sent using the ISO-2022-JP character set.

Charting page

The ColdFusion charting and graphing server lets you produce highly customizable business graphics, in various formats, using the

The following table describes the caching and thread settings for the ColdFusion charting and graphing server:

Option Description

Cache Type Set the cache type. Charts can be cached either in memory or to disk. Memory caching is faster, but more

Maximum Number Of Cached Images

Max Number Of Charting Threads Specify the maximum number of chart requests that can be processed concurrently. The minimum

Disk Cache Location When caching to disk, specify the directory in which to store the generated charts.

cfquery tag. Use the Charting page in the Administrator to control characteristics of the server.

memory intensive.

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.

number is 1 and the maximum is 5. (Higher numbers are more memory-intensive.)

Last updated 8/5/2010

CONFIGURING AND ADMINISTERING COLDFUSION 9

Using the ColdFusion Administrator

Font Management page

The Font Management page lets you review and define fonts for use with Adobe® FlashPaper™ and Acrobat® PDF output formats. ColdFusion generates FlashPaper and PDF output through the

cfreport tag, when used to call a report created with the ColdFusion Report Builder.

cfdocument tag and through the

ColdFusion automatically registers Acrobat built-in fonts and fonts located in typical font locations (such as the Windows\fonts directory). However, if your server has additional fonts installed in nonstandard locations, you register them with the ColdFusion Administrator so that the

cfdocument and cfreport tags can locate and render PDF and

FlashPaper reports.

This page contains the following topics:

User Defined Fonts Displays the fonts that have been registered explicitly.

Current System Fonts Displays fonts stored in platform-specific system font directories.

For more information on font management, see the ColdFusion Administrator online Help. For more information on reporting in ColdFusion, see Creating Reports and Documents for Printing in the Developing ColdFusion Applications.

Document page

The Document page allows you to configure OpenOffice application. If you did not configure during installation, provide the directory path to configure OpenOffice.

Depending on whether your ColdFusion server is installed on a local or remote server, you can configure OpenOffice with your ColdFusion server instance.

For more information about configuring OpenOffice with ColdFusion, see Configuring OpenOffice in Installing ColdFusion.

Java and JVM page

The Java and JVM page lets you specify the following settings, which enable ColdFusion to work with Java:

Option Description

Java Virtual Machine Path The absolute file path to the location of the Java Virtual Machine (JVM) root directory. The default is

Minimum JVM Heap Size The JVM initial heap size.

Maximum JVM Heap Size The JVM maximum heap size. The default value is 512 MB.

ColdFusion Class Path The file paths to the directories that contain the JAR files that ColdFusion uses. Specify either the fully

JVM Arguments The arguments to the JVM. Use a space to separate multiple entries (for example, -Xint -Xincgc).

Note: This page is available in the server configuration only.

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 the jvm.bak file to restore your system. For more information, see the Online Help.

cf_root/runtime/jre.

qualified name of a directory that contains your JAR files or a fully qualified JAR filename. Use a comma to separate multiple entries.

Last updated 8/5/2010

CONFIGURING AND ADMINISTERING COLDFUSION 9

Using the ColdFusion Administrator

Settings Summary page

The Settings Summary page shows all ColdFusion configuration settings. Click a group name to open the Administrator section of that group, where you can edit settings. This page is not enabled in the Standard Edition.

In ColdFusion, you can export the server settings to PDF by clicking the Save As PDF button on this page.

Data & Services section

The Data & Services section of the Administrator is the interface for ColdFusion, 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 ColdFusion collections

Define mappings for web services The Web Services page lets you produce and consume remote application functionality over the

Specify settings to integrate with Adobe® Flex™ applications

The Data Sources page lets you establish, edit, and delete JDBC data source connections for ColdFusion. For more information, see

The ColdFusion Collections page lets you create and delete Verity/Solr collections and perform maintenance operations on collections that you create. For more information, see

Collections page” on page 16.

Internet. For more information, see

The Flex Integration page lets you specify which Flex integration features to enable and which IP addresses can perform data service operations. For more information, see page 17.

“Data Source Management” on page 34.

“ColdFusion

“Web Services page” on page 17.

“Flex Integration page” on

Data Sources page

The Data Sources page lets you create, edit, and delete JDBC data sources. Before you can use a database in a ColdFusion application, you register the data source in the ColdFusion Administrator. For more information, see “Data Source Management” on page 34.

ColdFusion Collections page

Use this page to create and manage your Verity or Solr collections.

ColdFusion lets you manage your collections from the Administrator. You can index, optimize, purge, or delete Verity/Solr collections that are connected to ColdFusion. You use the icons in the Actions column to perform the following actions:

Action Description

Index Analyzes the files in a collection and assembles metadata and pointers to the files.

Optimize Reclaims space left by deleted and changed files by consolidating collection indexes for faster searching. You

Purge Deletes all documents in a collection, but not the collection itself. Leaves the collection directory structure intact.

Delete Deletes a collection.

should optimize collections regularly.

ColdFusion includes Verity and Solr, which provides indexing and searching technology. This enables creating, populating, and managing collections of indexed data that are optimized for fast and efficient site searches.

Last updated 8/5/2010

CONFIGURING AND ADMINISTERING COLDFUSION 9

Using the ColdFusion Administrator

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.

For more information about building search interfaces, see Building a Search Interface and Solr search support in the Developing ColdFusion Applications.

If the ColdFusion Collections page is unable to retrieve collections, ensure that Verity/Solr Search Server is running.

For more information, see “Collections and the ColdFusion Verity architecture” on page 116 and “Solr Server and

Collections” on page 169.

Verity K2 Server page

You can install Verity on a different host computer from the computer on which ColdFusion is running. If so, configure the host to be used by ColdFusion for performing search operations. In addition, you may need to use advanced settings to configure the aliases and ports of the services that ColdFusion uses. You need not change these values if you are running with the ColdFusion installed version of Verity.

Web Services page

You can use web services to produce and consume remote application functionality over the Internet. The ColdFusion 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 automatically registers it in the Administrator.

When you register a web service, you can shorten your code and change a web service URL without editing your code. For more information, see Using Web Services in the Developing ColdFusion Applications.

Flex Integration page

Use this page to specify which Flex integration features to enable and which IP addresses can perform data-service operations. If you enable Adobe LiveCycle Data Services ES support, but do not specify any IP addresses, only processes on the local computer can connect to the LiveCycle Data Services ES server in ColdFusion.

Option Description

Enable Flash Remoting Support

Enable Remote LiveCycle Data Management Access

Server Identity Specifies the ColdFusion server on which you want to enable Flex Data Management Support.

Enable RMI Over SSL For Data Management

Select IP Addresses Where LiveCycle Data Services Are Running

To use SSL, create a keystore file. The keystore is a self-signed certificate. (You do not need a certificate signed by a Certificate Authority, although if you do use one, you do not need to configure Flex as indicated in the following steps.) The information in the keystore is encrypted and can be accessed only with the password that you specify. To create the keystore, use the Java keytool utility, which is included in the Java Runtime Environment (JRE).

Specifies whether to enable Flash clients to connect to this ColdFusion server and invoke methods in ColdFusion components (CFCs).

Specifies whether to enable a LiveCycle Data Services ES server to connect to this ColdFusion server and invoke methods in CFCs to fill, sync, get, or count records in a result set used in a Flex application. Enable this option only if you are running LiveCycle Data Services ES remotely.

To encrypt communication between ColdFusion and Flex, enable Secure Sockets Layer (SSL).

Specifies which LiveCycle Data Services ES servers can connect to the LiveCycle Data Services ES support in ColdFusion. If you do not specify a list of allowed IP addresses, only processes on the local computer can connect to the LiveCycle Data Services ES support in ColdFusion

Last updated 8/5/2010

CONFIGURING AND ADMINISTERING COLDFUSION 9

Using the ColdFusion Administrator

Enable SSL

1 Create the keystore.

2 Configure Flex.

3 Enable SSL in the ColdFusion Administrator.

Create the keystore

❖ To generate the SSL server (ColdFusion) keystore file, use the keytool utility, with a command similar to the

following:

keytool -genkey -v -alias FlexAssembler -dname "cn=FlexAssembler" -keystore cf.keystore keypass mypassword -storepass mypassword

The following table describes the parameters of the keytool utility:

Parameter Description

-alias The name of the keystore entry. You can use any name for this, as long as you are consistent when referring

-dname The Distinguished Name, which contains the Common Name (cn) of the server.

-keystore The location of the keystore file.

-keypass The password for your private key.

-storepass The password for the keystore. The encrypted storepass is stored in ColdFusion configuration files.

-rfc Generates the certificate in the printable encoding format.

-file The name of the keystore file.

-v Generates detailed certificate information

to it.

Place the certificate you created in the file that the JVM uses to determine what certificates to trust. The file in which you place the certificate (usually named cacerts), is located in the JRE, in the lib/security folder.

Configure Flex

1 To export the keystore to a certificate, use the keytool utility, with a command similar to the following:

keytool -export -v -alias FlexAssembler -keystore cf.keystore -rfc -file cf.cer

2 To import the certificate into the JRE cacerts file for your server, use the keytool utility, with a command similar to

the following:

keytool -import -v -alias FlexAssembler -file cf.cer -keystore C:\fds2\UninstallerData\jre\lib\security\cacerts

The preceding example specifies the location of the keystore for LiveCycle Data Services ES with integrated JRun, installed by using the default settings. If you are using a different server, specify the location of the cacerts file for the JRE that you are using. For example, if you are using JBoss, specify the keystore location as $JAVA_HOME/jre/lib/security/cacerts.

Enable SSL in the ColdFusion Administrator

1 Select Data & Services > Flex Integration, and specify the keystore file in the Full Path To Keystore box.

2 Specify the keystore password in the Keystore Password box.

3 Select Enable RMI Over SSL For Data Management, and then click Submit Changes.

Last updated 8/5/2010

CONFIGURING AND ADMINISTERING COLDFUSION 9

Using the ColdFusion Administrator

If you specify an invalid keystore file or password, ColdFusion does not enable SSL, and disables LiveCycle Data Management Support.

Debugging & Logging section

Debugging Output Settings page

Use the Debugging Settings and Debugging IPs pages to configure ColdFusion to provide debugging information for every application page that a browser request. Specify debugging preferences by 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.

Note: Enabling debugging affects performance. It is advised that you do not enable debugging on a production server.

The Debug Output Settings page provides the following debugging options:

Option Description

Enable Robust Exception Information Displays detailed information in the exceptions page, including the physical path and URI of

Enable Request Debugging Output Enables the ColdFusion debugging service.

Select Debugging Output Format Controls debugging format. Select either of the following formats:

the template, 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.

Report Execution Times Reports execution times that exceed a specified time limit.

General Debug Information Show general information about the ColdFusion MX version, template, timestamp, user

Database Activity Shows the database activity for the SQL Query events and Stored Procedure events in the

Exception Information Shows all ColdFusion exceptions raised for the request in the debugging output.

Tracing Information Shows trace event information in the debugging output. Tracing lets you track program flow

Timer Information Shows output from the cftimer tag.

Flash Form Compile Errors And Messages (Development use only) Displays ActionScript errors in the browser when Flash forms are

locale, user agent, user IP, and host name.

debugging output.

and efficiency using the

compiling, and affects the display time of the page.

cftrace tag.

Last updated 8/5/2010

CONFIGURING AND ADMINISTERING COLDFUSION 9

Using the ColdFusion Administrator

Option Description

Variables Displays information about parameters, URL parameters, cookies, sessions, and CGI variables

Enable Performance Monitoring

(Server configuration only)

Enable CFSTAT

(Server configuration only)

in the debugging output.

Enables the standard NT Performance Monitor application to display information about a running server.

TIP: Restart ColdFusion after you change this setting.

Shows performance information on platforms that do not support the NT Performance Monitor. For more information, see

TIP: Restart ColdFusion after you change this setting.

“Using the cfstat utility” on page 20.

Using the cfstat utility

The cfstat command-line utility provides real-time performance metrics for ColdFusion. The cfstat utility uses a socket connection to obtain metric data. You can use the cfstat utility to display information that ColdFusion writes to the System Monitor without using the System Monitor application. The following table lists the metrics that the

cfstat utility returns:

Metric abbreviation Metric name Description

Pg/Sec Page hits per second The number of ColdFusion pages processed per second. You can

DB/Sec Database accesses per second The number of database accesses per second that ColdFusion makes.

Req Q'ed Number of queued requests The number of requests that are currently waiting for ColdFusion to

reduce this limit by moving static content to HTML pages.

Any difference in complexity and resource load between calls is ignored.

process them. Lower values, which you can achieve with efficient CFML, are better.

Req Run'g Number of running requests The number of requests that ColdFusion is currently actively

Req TO'ed Number of timed out requests The total number of ColdFusion requests that have timed out. Lower

AvgQ Time Average queue time A running average of the time, in milliseconds, that requests wait for

AvgReq Time Average request time A running average of the time, in milliseconds, that it takes ColdFusion

AvgDB Time Average database transaction time A running average of the time that ColdFusion spends on database-

Bytes In/Sec Bytes incoming per second The number of bytes that ColdFusion read in the last second (not an

Bytes Out/Sec Bytes outgoing per second The number of bytes that ColdFusion wrote in the last second (not an

processing.

values, which you can achieve by aggressive caching, removing unnecessary dynamic operations and third-party events, are better.

ColdFusion to process them. Lower values, which you can achieve with efficient CFML and enhanced caching, are better.

to process a request (including queued time). Lower values, which you can achieve with efficient CFML, are better.

related processing of ColdFusion requests.

average).

Before you use the cfstat utility, ensure that you selected the Enable Performance Monitoring option in the ColdFusion Administrator (on the Debugging & Logging > Debugging Settings page). If you select this option, restart ColdFusion for this change to take effect.

Last updated 8/5/2010

CONFIGURING AND ADMINISTERING COLDFUSION 9

Using the ColdFusion Administrator

cfstat options

The cf_root/bin directory contains the cfstat utility. From that directory, type cfstat and use the following switches:

Switch Description Comment

-n Suppress column headers. Useful for saving output to a file.

-s Display output in a single line. Display a single line and delay display of the first line so the cfstat

# Where # is an integer, display output

every # seconds.

utility can display meaningful values in the per-second counters.

If you do not specify an integer, the cfstat utility returns one line. Specify this switch with or without the -s switch.

This example runs the cfstat utility and displays a new line every 20 seconds:

cfstat 20

Debugging IP Addresses page

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, ColdFusion displays debugging output for all users.

Debugger Settings page

To use the ColdFusion Debugger that runs in Eclipse, select the Allow Line Debugging option.

Specify the port and the maximum number of simultaneous debugging sessions. Specify the debugger port in the JVM settings of your application server, for example:

-Xrunjdwp:transport=dt_socket,server=y,suspend=n,address=#portNum#

To stop a currently running debugging session, click Stop Debugging.

For the changes that you specify on this page to take effect, restart the ColdFusion server.

Logging Settings page

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

Option Description

Log Directory Specifies the directory to which error log files are written.

TIP: Restart ColdFusion after you change this setting.

Maximum File Size (kb) Sets the maximum file size for log files. When a file reaches this limit, it automatically is archived.

Maximum Number Of Archives Sets the maximum number of log archives to create. When they reach this limit, files are deleted in

the order of oldest to newest.

Last updated 8/5/2010

CONFIGURING AND ADMINISTERING COLDFUSION 9

Using the ColdFusion Administrator

Option Description

Log Slow Pages Taking Longer Than [n] Seconds

Log All CORBA Calls Logs all CORBA calls.

Enable Logging For Scheduled Tasks Logs ColdFusion Executive task scheduling.

Logs 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 the server.log file.

Log Files page

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

Click 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 ColdFusion Administrator online Help.

The following table describes the ColdFusion log files:

Log file Description

rdservice.log Records errors that occur in the ColdFusion Remote Development Service (RDS). RDS provides

application.log Records every ColdFusion error reported to a user. Application page errors, including ColdFusion

exception.log Records stack traces for exceptions that occur in ColdFusion.

remote HTTP-based access to files and databases.

syntax, ODBC, and SQL errors, are written to this log file.

scheduler.log Records scheduled events that have been submitted for execution. Indicates whether task

eventgateway.log Records events and errors related to event gateways.

migration.log Records errors related to upgrading from a previous version of ColdFusion.

migrationException.log Records errors related to running ColdFusion applications after upgrading from a previous version

server.log Records errors for ColdFusion.

customtag.log Records errors generated in custom tag processing.

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 that ColdFusion sends.

flash.log

submission was initiated and whether it succeeded. Provides the scheduled page URL, the date and time executed, and a task ID.

of ColdFusion.

Records entries for Flash® Remoting.

Enable/Disable logging

In ColdFusion 9.0.1, a new icon has been added in the Actions column of the Log Files page. This icon lets you stop/start logging for a particular log type.

Last updated 8/5/2010

CONFIGURING AND ADMINISTERING COLDFUSION 9

Using the ColdFusion Administrator

Log files introduced in ColdFusion 9.0.1

You can generate log files for the following services in ColdFusion 9.0.1:

• http

• ftp

• web service

• Portlet

• Derby

• Feed

Scheduled Tasks page

Use the Scheduled Tasks page to schedule the execution of local and remote web pages, to generate static HTML pages, send mail with the batch-style processing. 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 renders the static page with information that the scheduled event generates. Response time is faster because no database transaction takes place.

cfmail tag, update database tables, index Verity collections, delete temporary files, and any other

You can run scheduled tasks once; on a specified date; or at a specified time, daily, weekly, or monthly; daily; at a specified interval; or between specified dates.

The Scheduled Task page lets you create, edit, pause, resume, and delete scheduled tasks. For more information, see the Online Help.

Scheduling enhancement in ColdFusion 9.0.1

This release supports automatic logging of scheduled tasks.

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 on 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 the logs/probes.log file. The System Probes page also displays the status of each probe.

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 Starts and stops the probe from automatically executing at its specified interval.

Delete Deletes the probe.

Last updated 8/5/2010

CONFIGURING AND ADMINISTERING COLDFUSION 9

Using the ColdFusion Administrator

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

System probes are available in ColdFusion Enterprise Edition only.

Code Analyzer page

The Code Analyzer page evaluates your ColdFusion pages for potential incompatibilities between ColdFusion 9 and previous versions of ColdFusion. It reviews the CFML pages that you specify and informs you of any potential compatibility issues. Additionally, the Code Compatibility Analyzer detects unsupported and deprecated CFML features, and outlines the required implementation changes that ensure a smooth migration

License Scanner page

The License Scanner page searches the local subnet to find other running instances of ColdFusion. You can use this information to determine whether the ColdFusion instances within the subnet are licensed appropriately.

The ColdFusion Administrator uses universal datagram protocol (UDP) multicast to collect license and version information from all ColdFusion instances running within the subnet.

Server Monitoring section

The Server Monitoring section lets you run the following:

• Server Monitor

• Multiserver Monitor

The Server Monitor is an Adobe SWF application that lets you track activities on a ColdFusion Server. You can identify information about the server, including requests, queries, memory usage, and errors. You can start and stop collecting server information and take snapshots of the server.

The Multiserver Monitor is another SWF application. It lets you track the status of several servers.

Extensions section

Use the Extensions section of the Administrator to configure ColdFusion to work with other technologies, such as Java and CORBA.

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, register them in the Java Applets page.

When your applet is registered with ColdFusion, using the cfapplet tag in your CFML code is simple, because all parameters are predefined: Enter the applet source and the form variable name to use.

Note: Parameters set with the cfapplet tag override parameters defined on the Java Applets page.

For more information, see the Online Help.

Last updated 8/5/2010

CONFIGURING AND ADMINISTERING COLDFUSION 9

Using the ColdFusion Administrator

CFX Tags page

Before you can use a CFX tag in ColdFusion applications, register it. 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) on Windows or as shared objects (.so or .sl extension) on Solaris and Linux

• Using Java interfaces defined in the cfx.jar file

For more information, see the Online Help.

Custom Tag Paths page

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

Use the CORBA Connectors page to register, edit, and delete CORBA connectors. Register CORBA connectors before you use them in ColdFusion applications and restart the server when you finish configuring the CORBA connector.

ColdFusion loads object request broker (ORB) libraries dynamically by 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. Make sure that the ORB runtime libraries are in cf_root/runtime/lib (server configuration) or cf_webapp_root/WEB-INF/cfusion/lib (multiserver and J2EE configurations).

The following table contains information about the libraries and connectors:

Operating System Vendor ORB ColdFusion connector ORB library

Windows NT and later

Solaris Borland VisiBroker 4.5 coldfusion.runtime.corba.VisibrokerConnector (embedded) vbjorb.jar

Borland VisiBroker 4.5 coldfusion.runtime.corba.VisibrokerConnector (embedded) vbjorb.jar

Example of a CORBA connector configuration for VisiBroker:

ORB Name visibroker ORB Class Name coldfusion.runtime.corba.VisibrokerConnector ORB Property File c:\ColdFusion9\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

Last updated 8/5/2010

CONFIGURING AND ADMINISTERING COLDFUSION 9

Using the ColdFusion Administrator

Event Gateways section

The Event Gateways section of the Administrator lets you configure event gateway settings, gateway types, and gateway instances.

Event Gateways Settings page

The Event Gateways Settings page lets you configure settings for all event gateways, and start or stop the Short Message Service (SMS) test server. The following table describes the settings:

Option Description

Enable ColdFusion Event Gateway Services

Event Gateway Processing Threads

Maximum Number Of Events To Queue

Start/Stop SMS Test Server Starts and stops the short message service (SMS) test server.

Specifies whether the service is enabled. Changing this setting restarts the service.

Specifies the maximum number of threads used to execute ColdFusion functions when an event arrives. A higher number uses more resources, but increases event throughput.

Specifies the maximum number of events allowed on the event queue. If the queue length exceeds this value, gateway events are not be added to the processing queue.

Gateway Types page

The Gateways Types pages let you configure the types of gateways available on your system. After you configure a type, you can create any number of gateway instances of that type. The following table describes the event gateway types that ColdFusion includes:

Gateway type Description

CFML Triggers asynchronous events from ColdFusion.

DataManagement Lets a ColdFusion application notify a Flex destination about changes in the data that the destination

DataServicesMessaging Sends messages to and receive messages from Flex applications.

FMS Gateway Modifies data through the ColdFusion application or the Flash client, and reflects the change in the

SMS Used to send and receive SMS messages.

manages.

Flash Media Server shared object.

SAMETIME Used to send and receive instant messages through Lotus SameTime.

XMPP Used to send and receive instant messages through the Extensible Messaging and Presence Protocol

Samples Sample gateway types, including the following:

(XMPP).

• DirectoryWatcher Watches a directory for file changes.

• JMS Acts as a Java Messaging Service consumer or producer.

• Socket Listens on a TCP/IP port.

Gateway Instances page

The Gateway Instances page lets you configure ColdFusion event gateway instances to direct events from various sources to ColdFusion components (CFCs) that you have written. The following table describes the settings:

Last updated 8/5/2010

CONFIGURING AND ADMINISTERING COLDFUSION 9

Using the ColdFusion Administrator

Option Description

Gateway ID A name for the event gateway instance. You use this value in the ColdFusion GetGatewayHelper and

Gateway Type The event gateway type.

CFC Path The absolute path to the listener CFC that handles incoming messages.

Configuration File (Optional) Configuration file, if necessary for the event gateway instance.

Startup Mode The event gateway startup status, as follows:

SendGatewayMessage functions.

• Automatic Start the event gateway when ColdFusion starts.

• Manual Do not start the event gateway with ColdFusion, but allow starting it from the Gateway

Instances page.

• Disabled Do not allow the event gateway to start.

Security section

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

For more information on security, see “Administering Security” on page 75.

Administrator page

Use the Administrator page of the Administrator to enable and disable password-restricted access to the Administrator, and to change the Administrator password. Restrict ColdFusion Administrator access to trusted users. You can also configure all users to use a single ColdFusion Administrator password or allow only users defined in the User Manager and the root administrative user to have access to the ColdFusion Administrator.

RDS page

Use the RDS page to enable and disable password-restricted RDS access to server resources from Adobe Macromedia Dreamweaver MX , Adobe Macromedia HomeSite+ , ColdFusion Extensions for Eclipse, or the ColdFusion Report Builder, and to change the RDS password. You can also configure all users to use a single RDS password, or allow only users defined in the User Manager to have access through RDS.

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, directories, IP addresses, ports, and runtime permissions.

Sandbox security uses the location of your ColdFusion pages to determine functionality. A sandbox is a designated area (CFM files or directories that contain 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 the following:

• Data sources

• Tags

Last updated 8/5/2010

CONFIGURING AND ADMINISTERING COLDFUSION 9

Using the ColdFusion Administrator

• Functions

• Files and directories

• IP addresses and ports

You can also edit runtime permissions for ColdFusion pages.

Note: If you have enabled sandbox security and want to use the Administrator API, enable access to the CFIDE/adminapi directory.

User Manager page

Use the User Manager page to specify the user name, password, description, access rights, exposed services, sandboxes, and allowed roles for individual users. This page is especially useful for web hosting when multiple ColdFusion applications are on one server, each maintained by a different user or organization.

You can grant access to the ColdFusion Administrator, which also grants access to the Administrator API.

If the administrator revokes the role of a user while the user is logged in, the revocation takes effect only when the user logs in again.

The default user ID of an administrator is admin. To change the administrator user ID, add the following in the neosecurity.xml file, replacing admin with the user ID to use:

<var name='admin.userid.root'> <string>admin</string> </var>

Allowed IP Addresses

Specify client IP addresses that have the permission to access exposed services.

Packaging and Deployment section

The Packaging and Deployment section of the Administrator lets you create and deploy CAR files. You can also create J2EE EAR or WAR files that include an existing ColdFusion application and the ColdFusion runtime system.

ColdFusion Archives page

The ColdFusion Archives 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 faster. The complete list of archivable information includes the following:

• Name and file location

• Server settings

• ColdFusion mappings

• Data sources

• Verity collections

• Scheduled tasks

• Event gateway instances

Last updated 8/5/2010

CONFIGURING AND ADMINISTERING COLDFUSION 9

Using the ColdFusion Administrator

• Java applets

• CFX tags

• Archive to do lists

After you archive the information, you can use the Administrator to deploy your web applications to the same ColdFusion server or to a ColdFusion 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 lets you configure various archive system settings that apply to all archive and deployment operations. For more information, see the Online Help.

J2EE Archives page

The J2EE Archives page lets you create an enterprise application archive (EAR) file or web application archive (WAR) file that contains the following items:

• The ColdFusion web application.

• Server settings, such as data sources and custom tag paths.

• The CFML pages of your application, stored in the root directory of the ColdFusion web application.

With this EAR or WAR file, a J2EE administrator can deploy your ColdFusion MX application to a J2EE application server.

If you are creating a cluster of server instances when running the multiserver configuration, use this page to create the WAR or EAR files required to create each of the servers in the cluster.

You can create a J2EE archive regardless of whether you are running ColdFusion MX in the server configuration or the J2EE configuration. However, you must be running the J2EE configuration to deploy an EAR or WAR file.

Enterprise Manager section

The Enterprise Manager section of the Administrator lets you create JRun server instances with ColdFusion already deployed, register remote JRun server instances, and create clusters of JRun server instances.

Note: The Enterprise Manager section appears only if you install the multiserver configuration. It does not display in the server configuration. Nor does it display when running in a J2EE configuration (other than that deployed in the cfusion server of the multiserver configuration).

Instance Manager page

The Instance Manager page lets you view the local and remote JRun servers that can be accessed by a cfusion server running in the multiserver configuration.

From this page you can access pages that define new, local, JRun servers and register existing JRun servers running on remote computers, as follows:

Add New Instance Create a JRun server and automatically deploy a copy of the current ColdFusion MX application

into that server. Alternatively, you can deploy ColdFusion MX applications packaged using the J2EE Archives page.

a cluster. It is not mandatory to run the remote JRun server instance when you define it to the Instance Manager. However, it must be running before you can add it to a cluster.

Last updated 8/5/2010

CONFIGURING AND ADMINISTERING COLDFUSION 9

Using the ColdFusion Administrator

Cluster Manager page

The Cluster Manager page in ColdFusion MX Administrator lets you create and manage clusters of JRun servers, each containing the same ColdFusion MX application.

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.

Extend the Administrator

1 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

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

2 Save this file as extensionscustom.cfm in the Administrator root directory (/CFIDE/administrator/).

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

<head> or <body> tags.

target attribute, the page appears in a new window.

<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 appears.

Alternatively, you can extend the ColdFusion Administrator by editing the wwwroot/CFIDE/administrator/custommenu.xml file.

Administrator API

You can use the Administrator API to perform most ColdFusion Administrator tasks programmatically. The Administrator API consists of a set of ColdFusion components (CFCs) that contain methods you call to perform Administrator tasks. For example, you use the

The CFCs for the Administrator API are located in the cf_web_root/CFIDE/adminapi directory. Each CFC corresponds to an area of the ColdFusion Administrator, as the following table shows:

CFC Description

accessmanager.cfc Specify the user name, password, description, access rights, sandboxes, and allowed roles for individual

users.

administrator.cfc Contains basic Administrator functionality, including login, logout, the Migration wizard, and the Setup

wizard. You must call the

setMSQL method of datasource.cfc to add a SQL Server data source.

base.cfc Base object for all other Administrator API CFCs.

datasource.cfc Add, modify, and delete ColdFusion data sources.

debugging.cfc Manage debug settings

Last updated 8/5/2010

CONFIGURING AND ADMINISTERING COLDFUSION 9

Using the ColdFusion Administrator

CFC Description

eventgateway.cfc Manage event gateways

extensions.cfc Manage custom tags, mappings, CFXs, applets, CORBA, and web services.

office.cfc Manage OpenOffice settings.

mail.cfc Manage ColdFusion mail settings.

runtime.cfc Manage runtime settings for fonts, cache, charts, configuration, and other settings.

security.cfc Manage passwords, RDS, and sandbox security.

serverinstance.cfc Start, stop, and restart JRun servers. This CFC only works when running the multiserver configuration.

servermonitoring.cfc Perform many of the Server Monitor tasks programmatically.

The adminapi directory also contains an Application.cfm file and two subdirectories.

Note: If you are using sandbox security, enable access to the cf_web_root/CFIDE/adminapi directory to use the Administrator API.

Following are the styles of methods in the Administrator API:

Method arguments When setting complex or varied values, the Administrator API uses method arguments.

Getting and setting simple values When setting simple values, such as true or false debug settings, the Administrator

API uses get and set property methods.

To view the methods, method arguments, and documentation for the Administrator API CFCs, use the CFC Explorer. For example, to view datasource.cfc when running in the server configuration, open a browser to http://localhost:8500/CFIDE/adminapi/datasource.cfc.

Use the Administrator API

1 Instantiate administrator.cfc:

<cfscript> // Login is always required. adminObj = createObject("component","cfide.adminapi.administrator");

Note: You can instantiate administrator.cfc and call the login method in a single line of code, as the following example shows:

createObject("component","cfide.adminapi.administrator").login("admin");

2 Call the administrator.cfc login method, passing the ColdFusion Administrator password or the RDS password:

adminObj.login("admin");

3 Instantiate the desired CFC:

myObj = createObject("component","cfide.adminapi.debugging");

4 Call the desired CFC method (this example enables debugging):

myObj.setDebugProperty(propertyName="enableDebug", propertyValue="true");

Examples

The following example adds a SQL Server data source:

Last updated 8/5/2010

CONFIGURING AND ADMINISTERING COLDFUSION 9

Using the ColdFusion Administrator

<cfscript> // Login is always required. This example uses two lines of code. adminObj = createObject("component","cfide.adminapi.administrator"); adminObj.login("admin");

// Instantiate the data source object. myObj = createObject("component","cfide.adminapi.datasource");

// Create a DSN. myObj.setMSSQL(driver="MSSQLServer", name="northwind_MSSQL", host = "10.1.147.73", port = "1433", database = "northwind", username = "sa", login_timeout = "29", timeout = "23", interval = 6, buffer = "64000", blob_buffer = "64000", setStringParameterAsUnicode = "false", description = "Northwind SQL Server", pooling = true, maxpooledstatements = 999, enableMaxConnections = "true", maxConnections = "299", enable_clob = true, enable_blob = true, disable = false, storedProc = true, alter = false, grant = true, select = true, update = true, create = true, delete = true, drop = false, revoke = false ); </cfscript>

The following example adds the same SQL Server data source, but uses the argumentCollection attribute to pass all method arguments in a structure:

Last updated 8/5/2010

CONFIGURING AND ADMINISTERING COLDFUSION 9

Using the ColdFusion Administrator

<cfscript> // Login is always required. This example uses a single line of code. createObject("component","cfide.adminapi.administrator").login("admin");

// Instantiate the data source object. myObj = createObject("component","cfide.adminapi.datasource");

// Required arguments for a data source. stDSN = structNew(); stDSN.driver = "MSSQLServer"; stDSN.name="northwind_MSSQL"; stDSN.host = "10.1.147.73"; stDSN.port = "1433"; stDSN.database = "northwind"; stDSN.username = "sa";

// Optional and advanced arguments. stDSN.login_timeout = "29"; stDSN.timeout = "23"; stDSN.interval = 6; stDSN.buffer = "64000"; stDSN.blob_buffer = "64000"; stDSN.setStringParameterAsUnicode = "false"; stDSN.description = "Northwind SQL Server"; stDSN.pooling = true; stDSN.maxpooledstatements = 999; stDSN.enableMaxConnections = "true"; stDSN.maxConnections = "299"; stDSN.enable_clob = true; stDSN.enable_blob = true; stDSN.disable = false; stDSN.storedProc = true; stDSN.alter = false; stDSN.grant = true; stDSN.select = true; stDSN.update = true; stDSN.create = true; stDSN.delete = true; stDSN.drop = false; stDSN.revoke = false;

//Create a DSN. myObj.setMSSQL(argumentCollection=stDSN); </cfscript>  <!--- <cfoutput> <cfdump var="#stDSN#"> </cfoutput>

--->

Last updated 8/5/2010

Chapter 4: Data Source Management

A data source is a complete database configuration that uses a JDBC driver to communicate with a specific database. In Adobe ColdFusion, you configure a data source for each database that you want to use. After you configure a data source, ColdFusion can then communicate with that data source through JDBC.

For basic information on data sources and connecting to databases, click Resources in the ColdFusion Administrator, and then select Getting Started Experience.

About JDBC

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

The following table describes the four types of JDBC drivers:

Type Name Description

1 JDBC-ODBC bridge Translates JDBC calls to 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 slower than other JDBC driver types.

Adobe does not recommend this driver type unless your application requires DBMS-specific features.

2 Native-API/partly Java

driver

3 JDBC-Net pure Java driver Translates JDBC calls to the middle-tier server, which then translates the request to the database-

4 Native-protocol/all-Java

driver

Converts JDBC calls to database-specific calls.

Advantages: Better performance than Type 1 driver.

Disadvantages: The client database libraries of the vendor must reside on the same computer as ColdFusion.

ColdFusion includes a Type 2 driver for use with Microsoft Access Unicode databases.

specific native-connectivity interface.

Advantages: The database libraries of vendors are not required client computer. Can be tailored for small size (faster loading).

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

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

Converts JDBC calls to the network protocol used directly by the database.

Advantages: Fast performance. No special software needed on the computer on which you run ColdFusion.

Disadvantages: Many of these protocols are proprietary, requiring a different driver for each database.

ColdFusion includes Type 4 drivers for many DBMSs; however, not all DBMSs are supported in ColdFusion Standard Edition.

Last updated 8/5/2010

CONFIGURING AND ADMINISTERING COLDFUSION 9

Data Source Management

JDBC drivers are stored in JAR files. For example, the JDBC drivers that are supplied with ColdFusion are in the _drivers.jar file. If you are using another JDBC driver, you must store it in the ColdFusion classpath. For example, cf_root/cfusion/lib (server configuration) or cf_webapp_root/WEB-INF/cfusion/lib (multiserver or J2EE configuration).

Supplied drivers

The following table lists the database drivers supplied with ColdFusion and where you can find more information about them:

Driver Type For more information

Apache Derby Client “Connecting to Apache Derby Client” on page 37

Apache Derby Embedded “Connecting to Apache Derby Embedded” on page 38

DB2 Universal Database 4 “Connecting to DB2 Universal Database” on page 39

DB2 OS/390 4 “Connecting to other data sources” on page 53

Informix 4 “Connecting to Informix” on page 40

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

Microsoft Access with Unicode support 2 “Connecting to Microsoft Access with Unicode” on page 42

Microsoft SQL Server 4 “Connecting to Microsoft SQL Server” on page 43

MySQL 4 “Connecting to MySQL” on page 46

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

Oracle 4 “Connecting to Oracle” on page 52

Other “Connecting to other data sources” on page 53

Sybase 4 “Connecting to Sybase” on page 56

To see a list of database versions that ColdFusion supports, go to www.adobe.com/go/learn_cfu_cfsysreqs_en.

When running in the J2EE configuration, the ColdFusion Administrator also lets you configure a data source that connects to a JNDI data source. A Java Naming and Directory Interface (JNDI) data source is equivalent to a ColdFusion data source, except you define it by using your J2EE application server. After it’s defined, ColdFusion applications use it as they would any data source. For information on defining a JNDI data source, see

“Connecting to

JNDI data sources” on page 57.

Adding data sources

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

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

Last updated 8/5/2010

CONFIGURING AND ADMINISTERING COLDFUSION 9

Data Source Management

Adding data sources in the Administrator

You use the ColdFusion 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 includes data sources that are configured by default. You do not need the following procedure to work with these data sources.

1 In the ColdFusion 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; for example, Microsoft SQL Server.

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 user name and password.

Note: The omission of required user name 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 Click Submit to create the data source.

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

11 (Optional) To verify this data source later, click the verify icon in the Actions column.

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

Specifying connection string arguments

The ColdFusion Administrator lets you specify connection-string arguments for data sources. In the Advanced Settings page, use the Connection String field to enter name-value pairs separated by a semicolon. For more information, see the documentation for your database driver.

Note: The cfqueryconnectstring attribute is no longer supported.

Guidelines for data sources

When you add data sources to ColdFusion, keep in mind the following guidelines:

• Data source names must be all one word.

Last updated 8/5/2010

CONFIGURING AND ADMINISTERING COLDFUSION 9

Data Source Management

• Data source names can contain only letters, numbers, hyphens, and the underscore character (_).

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

• Although data source names are not case sensitive, use a consistent capitalization scheme.

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

• Use the Administrator to verify that ColdFusion can connect to the data source.

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

Connection Issues

Executing a query when you restart a database can result in error during the first request. The error does not occur in subsequent requests or if connection pooling is disabled. This is because, during the first request, the cached connection is used to execute the query, leading to an exception. To overcome this issue, validate the connection before executing the query.

Provide validationQuery (to validate the connection) before executing the query in the Advanced Settings page.

Note: validationQuery has to be used with caution as it can result in performance issues.

Connecting to Apache Derby Client

Use the settings in the following table to connect ColdFusion to Apache Derby Client:

Setting Description

CF Data Source Name The data source name (DSN) that ColdFusion uses to connect to the data source.

Database The name of the database.

Server The name of the server that hosts the database that you want to use. If the database is local, enclose the word local

User name The user name that ColdFusion passes to the JDBC driver to connect to the data source if a ColdFusion application

Password The password that ColdFusion passes to the JDBC driver to connect to the data source if a ColdFusion application

Description (Optional) A description for this connection.

Connection String A field that passes database-specific parameters, such as login credentials, to the data source.

Limit Connections Specifies whether ColdFusion limits the number of database connections for the data source. If you enable this

Restrict Connections To Specifies the maximum number of database connections for the data source. To use this restriction, enable the

in parentheses.

does not supply a user name (for example, in a

The user name 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.

does not supply a password (for example, in a

option, use the Restrict Connections To field to specify the maximum.

Limit Connections option.

cfquery tag).

Maintain Connections ColdFusion establishes a connection to a data source for every operation that requires one. Enable this option to

Timeout (min) The number of minutes that ColdFusion MX maintains an unused connection before destroying it.

Disable Connections If selected, suspends all client connections.

Login Timeout (sec) The number of seconds before ColdFusion times out the attempt to log in to the data source connection.

improve performance by caching the data source connection.

Last updated 8/5/2010

CONFIGURING AND ADMINISTERING COLDFUSION 9

Data Source Management

Setting Description

CLOB Returns the entire contents of any CLOB/ Text columns in the database for this data source. If deselected,

BLOB Returns the entire contents of any BLOB/Image columns in the database for this data source. If deselected,

LongText Buffer (chr) The default buffer size, used if the CLOB option is not selected. The default value is 64000 bytes.

BLOB Buffer (bytes) The default buffer size, used if the BLOB option is not selected. The default value is 64000 bytes.

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

Validation Query Called when a connection from the pool is resued. This can slow query response time because an additional query

ColdFusion retrieves the number of characters specified in the Long Text Buffer setting. For UDB 7.1 and 7.2, a 32K limit on CLOBs exists.

ColdFusion retrieves the number of characters specified in the BLOB Buffer setting. BLOBs are not supported on UDB 7.1 and 7.2.

is generated. Specify the validation query just before restarting the database to verify all connections, but remove the validation query after restarting the database to avoid any performance loss.

Connecting to Apache Derby Embedded

Use the settings in the following table to connect ColdFusion to Apache Derby Embedded:

Setting Description

CF Data Source Name The data source name (DSN) that ColdFusion uses to connect to the data source.

Database folder The folder where the database is located.

Create Database Select this option to create a database. The new database exists in the path specified in the Database Folder. If the

Description (Optional) A description for this connection.

ColdFusion user name The user name you use to log in to the ColdFusion Administrator.

ColdFusion Password The password you use to log in to the ColdFusion Administrator.

Connection String A field that passes database-specific parameters, such as login credentials, to the data source.

Limit Connections Specifies whether ColdFusion limits the number of database connections for the data source. If you enable this

Maintain Connections ColdFusion establishes a connection to a data source for every operation that requires one. Enable this option to

Max Pooled Statements Select this option to reuse prepared statements (that is, stored procedures and queries that use the cfqueryparam

database exists, an SQL warning is generated, and a connection to the existing database is established.

option, use the Restrict Connections To field to specify the maximum.

improve performance by caching the data source connection.

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 the cfqueryparam tag

• Unique cfstoredproc tags

Timeout (min) The number of minutes that ColdFusion MX maintains an unused connection before destroying it.

Disable Connections If selected, suspends all client connections.

Login Timeout (sec) The number of seconds before ColdFusion times out the attempt to log in to the data source connection.

CLOB Returns the entire contents of any CLOB/ Text columns in the database for this data source. If deselected,

ColdFusion retrieves the number of characters specified in the Long Text Buffer setting. For UDB 7.1 and 7.2, a 32K limit on CLOBs exits.

Last updated 8/5/2010

CONFIGURING AND ADMINISTERING COLDFUSION 9

Data Source Management

Setting Description

BLOB Returns the entire contents of any BLOB/Image columns in the database for this data source. If deselected,

LongText Buffer (chr) The default buffer size, used if the CLOB option is not selected. The default value is 64000 bytes.

BLOB Buffer (bytes) The default buffer size, used if the BLOB option is not selected. The default value is 64000 bytes.

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

Validation query Called when a connection from the pool is resued. This can slow query response time because an additional query

ColdFusion retrieves the number of characters specified in the BLOB Buffer setting. BLOBs are not supported on UDB 7.1 and 7.2.

is generated.Specify the validation query just before restarting the database to verify all connections, but remove the validation query after restarting the database to avoid any performance loss.

Note: When you add an Apache Derby Embedded data source, ensure that the specified directory does not exist.

Connecting to DB2 Universal Database

For information on defining data sources that work with DB2 for OS/390 or iSeries, see “Connecting to other data

sources” on page 53. To see a list of DB2 versions that ColdFusion supports, go to www.adobe.com/go/learn_cfu_cfsysreqs_en.

Note: DB2 Universal Database (UDB) refers to all versions of DB2 running on Windows, UNIX, and Linux/s390 platforms.

Use the settings in the following table to connect ColdFusion to DB2:

Setting Description

CF Data Source Name The data source name (DSN) that ColdFusion uses to connect to the data source.

Database The name of the database.

Server The name of the server that hosts the database that you want to use. If the database is local, enclose the word local

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

User name The user name that ColdFusion passes to the JDBC driver to connect to the data source if a ColdFusion application

Password The password that ColdFusion passes to the JDBC driver to connect to the data source if a ColdFusion application

Description (Optional) A description for this connection.

Connection String A field that passes database-specific parameters, such as login credentials, to the data source.

Limit Connections Specifies whether ColdFusion limits the number of database connections for the data source. If you enable this

Restrict Connections To Specifies the maximum number of database connections for the data source. To use this restriction, enable the

Maintain Connections ColdFusion establishes a connection to a data source for every operation that requires one. Enable this option to

in parentheses.

does not supply a user name (for example, in a

The user name 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.

does not supply a password (for example, in a

option, use the Restrict Connections To field to specify the maximum.

Limit Connections option.

improve performance by caching the data source connection.

cfquery tag).

Last updated 8/5/2010

CONFIGURING AND ADMINISTERING COLDFUSION 9

Data Source Management

Setting Description

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 the cfqueryparam tag

• Unique cfstoredproc tags

Timeout (min) The number of minutes that ColdFusion MX maintains an unused connection before destroying it.

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.

Login Timeout (sec) The number of seconds before ColdFusion times out the attempt to log in to the data source connection.

CLOB Returns the entire contents of any CLOB/Text columns in the database for this data source. If deselected,