1 Step RoboPDF, ActiveEdit, ActiveTest, Authorware, Blue Sky Software, Blue Sky, Breeze, Breezo, Captivate, Central,
ColdFusion, Contribute, Database Explorer, Director, Dreamweaver, Fireworks, Flash, FlashCast, FlashHelp, Flash Lite,
FlashPaper, Flex, Flex Builder, Fontographer, FreeHand, Generator, HomeSite, JRun, MacRecorder, Macromedia, MXML,
RoboEngine, RoboHelp, RoboInfo, RoboPDF, Roundtrip, Roundtrip HTML, Shockwave, SoundEdit, Studio MX, UltraDev,
and WebHelp are either registered trademarks or trademarks of Macromedia, Inc. and may be registered in the United States or
in other jurisdictions including internationally. Other product names, logos, designs, titles, words, or phrases mentioned within
this publication may be trademarks, service marks, or trade names of Macromedia, Inc. or other entities and may be registered in
certain jurisdictions including internationally.
This product includes code licensed from RSA Data Security.
Third-Party Information
This guide contains links to third-party websites that are not under the control of Macromedia, and Macromedia is not
responsible for the content on any linked site. If you access a third-party website mentioned in this guide, then you do so at your
own risk. Macromedia provides these links only as a convenience, and the inclusion of the link does not imply that Macromedia
endorses or accepts any responsibility for the content on those third-party sites.
Configuring and Administering ColdFusion MX is intended for anyone who needs to configure and
manage their ColdFusion development environment.
About Macromedia ColdFusion MX 7 documentation
The ColdFusion MX 7 documentation is designed to provide support for the complete spectrum of
participants.
Documentation set
The ColdFusion MX 7 documentation set includes the following titles:
BookDescription
Installing and Using
ColdFusion MX
Configuring and
Administering
ColdFusion MX
ColdFusion MX
Developer’s Guide
Getting Started
Building
ColdFusion MX
Applications
CFML ReferenceProvides descriptions, syntax, usage, and code examples for all ColdFusion
CFML Quick Reference Shows the syntax of ColdFusion tags, functions, and variables in a brief guide.
Describes system installation and basic configuration for Microsoft Windows,
Solaris, and Linux. www.macromedia.com/go/livedocs_cfmx7docs_installing
Part I describes how to manage the ColdFusion environment, including
connecting to your data sources and configuring security for your applications.
Part II describes Verity search tools and utilities that you can use for configuring
the Verity Search Server, as well as creating, managing, and troubleshooting
Verity collections. To see this manual, go to www.macromedia.com/go/
livedocs_cfmx7docs_configadmin.
Describes how to develop your dynamic web applications, including retrieving
and updating your data, and using structures and forms. This manual includes
two volumes. To see this manual, go to www.macromedia.com/go/
livedocs_cfmx7docs_dev.
Contains an overview of ColdFusion features and application development
procedures. This manual includes a tutorial that guides you through the process
of developing a sample ColdFusion application. To see this manual online, go to
www.macromedia.com/go/livedocs_cfmx7docs_gs.
tags, functions, and variables. This manual includes two volumes. To see this
manual, go to www.macromedia.com/go/livedocs_cfmx7docs_cfml_reference.
Viewing online documentation
All ColdFusion MX documentation is available online in HTML and Adobe Acrobat Portable
Document Format (PDF) files. Go to the documentation home page for ColdFusion MX on the
Macromedia website: www.macromedia.com. In addition, you can view the documentation in
LiveDocs, which lets you add comments to pages and view the latest comments added by
Macromedia, by going to www.macromedia.com/go/livedocs_cfmx7docs.
8Introduction:
PART I
Administering ColdFusion MX 7
This part describes how to manage the ColdFusion environment, including using the
ColdFusion MX Administrator, connecting to your data sources, managing your web server,
deploying your applications, and configuring security for your applications.
This chapter presents an overview of Macromedia ColdFusion MX 7 configuration and
administration tasks. Although you perform most ColdFusion MX administration tasks using the
ColdFusion MX Administrator, you also manage databases, web server configurations, and the
Verity Search Server.
The ColdFusion MX Administrator provides a browser-based interface for managing your
ColdFusion environment. You can configure many settings to provide optimal levels of security
and functionality. The available options are based on your edition of ColdFusion MX 7—
Standard or Enterprise—as well as your configuration: server, multiserver, or J2EE. For more
information on ColdFusion MX configurations, see “About the ColdFusion MX 7 installation” in
Chapter 1, “Preparing to Install ColdFusion MX 7,” in Installing and Using ColdFusion MX.
The default location for the ColdFusion MX Administrator login page is:
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 used by the J2EE application server’s web server.
Tip: If you were using the built-in web server in a previous version and upgraded to ColdFusion MX 7,
the installer automatically finds an unused port for the built-in web server (typically 8501).
11
If your ColdFusion MX 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 MX Administrator, enter the password specified when you installed
ColdFusion MX.
Tip: If you are running in a multihomed environment and have problems displaying the
ColdFusion MX Administrator, see Chapter 4, “Web Server Management,” on page 65 for
configuration information.
For more information, see Chapter 2, “Using the ColdFusion MX Administrator,” on page 13.
About web server administration
ColdFusion MX 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 Chapter 4, “Web Server Management,” on page 65.
About Verity administration
ColdFusion MX includes Verity K2 Server search technology. Verity K2 Server is a highperformance search engine designed to process searches quickly in a high-performance,
distributed system.
For more information, see Chapter 8, “Introducing Verity and Verity Tools,” on page 105.
12Chapter 1: Administering ColdFusion MX
CHAPTER 2
Using the ColdFusion MX Administrator
This chapter explains the basic administration tasks, following the structure of the Macromedia
ColdFusion MX Administrator sections. It also includes a brief description of each Administrator
screen and a discussion of performing Administrator functionality programmatically through the
Administrator application programming interface (API).
Immediately after you install ColdFusion MX, you might have to perform some or all of the
administrative tasks described in the following table:
TaskDescription
Establish database
connections
Specify directory
mappings
Configure debugging
settings
Set up e-mailE-mail lets ColdFusion applications send automated e-mail messages. To
Change passwordsYou might have to change the passwords that you set for the
Configure Java settings (Server configuration only) You might have to customize Java settings,
Restrict tag accessSome CFML tags might present a potential security risk for your server. To
ColdFusion applications require data source connections to query and
write to databases. To create, verify, edit, and delete database
connections, use the Data Sources page.
For more information, see Chapter 3, “Data Source Management,” on
page 43.
Directory mappings redirect relative file paths to physical directories on
your server. To specify server-wide directory aliases, use the Mappings
page.
For more information, see “Mappings page” on page 20.
Debugging information provides important data about CFML page
processing. To choose the debugging information to display, and to
designate an IP address to receive debugging information, use the
Debugging & Logging section.
For more information, see “Debugging Settings and Debugging IPs
pages” on page 26.
configure an e-mail server and mail options, use the Mail Server page.
For more information, see “Mail Server page” on page 20.
ColdFusion MX Administrator and RDS during ColdFusion MX
installation. To change passwords, use the Security section.
For more information, see “CF Admin Password page” on page 35 and
“RDS Password page” on page 36.
such as classpath information, to meet the needs of your applications. To
change Java settings, use the Java and JVM page.
For more information, see “Extensions section” on page 32.
disable certain tags, use the Sandbox Security page.
For more information, see Chapter 6, “Administering Security,” on
page 85.
Accessing user assistance
You can obtain assistance from the ColdFusion MX Administrator in the following ways:
Online Help You access the context-sensitive online Help by clicking the question-mark icon on
any ColdFusion MX Administrator page. The online Help has procedural and brief overview
content for the ColdFusion MX Administrator page that you are viewing. This information
appears in a new browser window and contains standard Contents, Index, and Search tabs.
14Chapter 2: Using the ColdFusion MX Administrator
Getting Started Experience Click the Getting Started link to open the Getting Started
Experience, which provides descriptions of new features, code examples, and sample applications
to help you learn about ColdFusion MX.
Documentation Click the Documentation link to access the entire ColdFusion MX
documentation set online.
Tech notes Click the Tech Notes link to access the collection of articles about ColdFusion MX
from the Macromedia website (www.macromedia.com).
Server Settings section
The Server Settings section lets you manage client and memory variables, mappings, charting,
and archiving. You also configure e-mail and Java settings in this section.
The Server Settings section contains the following pages:
• Settings page
• Caching page
• Client Variables page
• Memory Variables page
• Mappings page
• Mail Server page
• Charting Settings page
• Java and JVM Settings page
• ColdFusion Archives page
• Settings Summary page
Settings page
The Settings page of the ColdFusion MX Administrator contains configuration options that you
can set or enable to manage ColdFusion MX. These options can significantly affect server
performance. The following table describes the options:
OptionDescription
Maximum number of
simultaneous requests
(not available in J2EE
configuration)
Timeout requests after n
seconds
Use UUID for cftokenSpecify whether to use a universally unique identifier (UUID), rather
Enter a number to limit simultaneous requests to ColdFusion MX.
When the server reaches the limit, requests are queued and handled in
the order received. Limiting the number of simultaneous requests can
improve performance.
Select this option to prevent unusually lengthy requests from using up
server resources. Enter a limit to the time that ColdFusion MX waits
before terminating a request. Requests that take longer than the
timeout period are terminated.
than a random number, for a cftoken.
Server Settings section15
OptionDescription
Enable HTTP status codes Select this option to configure ColdFusion MX to set a status code of
Enable Whitespace
Management (not available
in J2EE configuration)
Enable Global Script
Protection
Default CFFORM
ScriptSrc Directory
Missing Template Handler Specify a page to execute when ColdFusion MX cannot find a
Site-wide Error HandlerSpecify a page to execute when ColdFusion MX encounters an error
500 Internal Server Error for an unhandled error. Disable this option to
configure ColdFusion MX to set a status code of 200 OK for
everything, including unhandled errors.
Select this option to compress repeating sequences of spaces, tabs,
and carriage return/linefeeds. Compressing whitespace can
significantly compact the output of a ColdFusion page.
Select this option to protect Form, URL, CGI, and Cookie scope
variables from cross-site scripting attacks. Select this option if your
application does not contain this type of protection logic.
Specify the default path (relative to the web root) to the directory that
contains the cfform.js file. 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.
requested page. This specification is relative to the web root.
Note: If the user is running Microsoft Internet Explorer with "Show
Friendly HTTP error messages" enabled in advanced settings (the
default), Internet Explorer will only display this page if it contains more
than 512 bytes.
while processing a request. This specification is relative to the web
root. When you define a site-wide error handler or missing template
handler, ColdFusion MX does not log page not found errors and
exceptions.
Note: If the user is running Internet Explorer with "Show Friendly HTTP
error messages" enabled in advanced settings (the default), Internet
Explorer will only display this page if it contains more than 512 bytes.
cfform tag.
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:
OptionDescription
Maximum number of
cached templates
Trusted cacheSelect this option if you want ColdFusion MX to use cached templates
16Chapter 2: Using the ColdFusion MX Administrator
Select this option by entering a value that specifies the number of
templates that ColdFusion MX caches. For best performance, set this
to a value that is large enough to contain your application’s commonly
accessed ColdFusion pages, yet small enough to avoid excessive
reloading. You can experiment with a range of values on your
development server; a suitable starting point is one page per MB of
Java Virtual Machine (JVM) size.
without checking whether they changed. For sites that are not updated
frequently, using this option minimizes file system overhead.
OptionDescription
Save Class FilesSelect this option to save to disk the class files generated by the
Cache web server paths
(not available in J2EE
configuration)
Limit the maximum number
of cached queries on the
server to [n] queries
Clear Template Cache Now Empties the template cache. ColdFusion reloads templates into
ColdFusion bytecode compiler. During the development phase, it is
typically faster if you disable this option.
Select this option to cache ColdFusion page paths for a single server.
Clear this option if ColdFusion MX connects to a web server with
multiple websites or multiple virtual websites.
Select this option by entering a value to limit the maximum number of
cached queries that the server maintains. Cached queries allow
retrieval of result sets from memory rather than through a database
transaction. Because queries reside in memory, and query result set
sizes differ, you must provide a limit for the number of cached queries.
You enable cached queries with the
attributes of the
memory the next time they are requested and recompiles them if they
have been modified.
cfquery tag.
cachedwithin or cachedafter
Client Variables page
Client variables let you store user information and preferences between sessions. Using
information from client variables, you can customize page content for individual users.
You enable client variable default settings in ColdFusion MX on the Client Variables page of the
Administrator. ColdFusion MX lets you store client variables in the following ways:
• In database tables
Note: If your data source uses one of the JDBC drivers bundled with ColdFusion MX 7,
ColdFusion MX can automatically create the necessary tables. If your data source uses the ODBC
Socket or a third-party JDBC driver, you must manually create the necessary CDATA and
CGLOBAL database tables.
• As cookies in users’ web browsers
• In the operating system registry
Caution: Macromedia recommends that you do not store client variables in the registry because it
can critically degrade performance of the server. If you do use the registry to store client variables,
you must allocate sufficient memory and disk space.
You can override settings specified in the Client Variables page using the Application.cfc file or
the
cfapplication tag. For more information, see ColdFusion MX Developer’s Guide.
Server Settings section17
The following table compares the client variable storage options:
Storage typeAdvantagesDisadvantages
Data source• Can use existing data source
• Portable: not tied to the host
system or operating system
Browser cookies • Simple implementation
• Good performance
• Can be set to expire automatically
• Client-side control
System registry• Simple implementation
• Good performance
• Registry can be exported easily to
other systems
• Server-side control
• Requires database transaction to
read/write variables
• More complex to implement
• Users can configure browsers to
disallow cookies
• Cookie data is limited to 4 KB
• Netscape Navigator allows only 20
cookies from one host; ColdFusion MX
uses three cookies to store read-only
data, leaving only 17 cookies available
• Possible restriction of the registry’s
maximum size limit in Windows in the
Control Panel
• Integrated with the host system: not
practical for clustered servers
• Not available for UNIX
Migrating client variable data
To migrate your client variable data to another data source, you should know the structure of the
database tables that store this information. Client variables stored externally use two simple
database tables, like those shown in the following tables:
CDATA Table
ColumnData type
cfidCHAR(64), TEXT, VARCHAR, or equivalent
appCHAR(64), TEXT, VARCHAR, or equivalent
dataMEMO, LONGTEXT, LONG VARCHAR, or equivalent
CGLOBAL Table
ColumnData type
cfidCHAR(64), TEXT, VARCHAR, or equivalent
dataMEMO, LONGTEXT, LONG VARCHAR, or equivalent
lvisitTIMESTAMP, DATETIME, DATE, or equivalent
Creating client variable tables
Use the following sample ColdFusion page as a model for creating client variable database tables
in your own database. However, keep in mind that not all databases support the same column
data type names. For the proper data type, see your database documentation.
Tip: The ColdFusion MX Administrator can create client variable tables for data sources that use one
of the bundled JDBC drivers. For more information, see the online help.
18Chapter 2: Using the ColdFusion MX Administrator
Sample table creation page
<!---- Create the Client variable storage tables in a datasource.
This example applies to Microsoft Access databases. --->
You use the Memory Variables page of the ColdFusion MX Administrator to enable application
and session variables server-wide. By default, application and session variables are enabled when
you install ColdFusion MX. If you disable either type of variable in the Memory Variables page,
you cannot use them in a ColdFusion application.
You can specify maximum and default timeout values for session and application variables. Unless
you define a timeout value in 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 timeout values on the Memory Variables page of the
Administrator.
Note: Timeout values that you specify for application variables override the timeout values set in the
Application.cfc or Application.cfm file.
Server Settings section19
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 ColdFusion MX Developer’s Guide.
Note: When using J2EE sessions, ensure that the session timeout, specified in the
WEB-INF/web.xml
the ColdFusion MX Administrator and longer than any
cfapplication tag.
session-timeout element is longer than the session timeout that you specify in
sessiontimeout attribute specified in a
Mappings page
You use the Mappings page of the ColdFusion MX Administrator to add, update, and delete
logical aliases for paths to directories on your server. ColdFusion mappings apply only to pages
processed by ColdFusion MX with the
cfinclude and cfmodule tags. If you save CFML pages
outside of the web_root directory (or whatever directory is mapped to "/"), you must add a
mapping to the location of those files on your server.
Assume that the "/" mapping on your server points to C:\CFusionMX7\wwwroot, but all your
ColdFusion header pages reside in C:\2002\newpages\headers. In order for ColdFusion MX to
find your header pages, you must add a mapping in the ColdFusion MX Administrator that
points to C:\2002\newpages\headers (for example, add a mapping for /headers that points to
C:\2002\newpages\headers). In the ColdFusion pages located in C:\CFusionMX7\wwwroot, you
reference these header pages using /headers in your
Note: ColdFusion mappings are different from web server virtual directories. For information on
creating a virtual directory to access a given directory using a URL in your web browser, consult your
web server’s documentation.
cfinclude and cfmodule tags.
Mail Server page
You use the Mail Server page of the ColdFusion MX Administrator to specify a mail server to
send automated e-mail messages. ColdFusion MX supports the Simple Mail Transfer Protocol
(SMTP) for sending e-mail messages and the Post Office Protocol (POP) for retrieving e-mail
messages from your mail server. To use e-mail messaging in your ColdFusion applications, you
must have access to an SMTP server and a POP account.
The ColdFusion MX Enterprise Edition supports mail server failover as well as additional mail
delivery options.
The ColdFusion implementation of SMTP mail uses a spooled architecture. This means that
when a
cfmail tag is processed in an application page, the messages generated might not be sent
immediately. If ColdFusion is extremely busy or has a large queue, delivery could occur after some
delay.
Note: For more information about the cfmail tag, see “Sending SMTP e-mail with the cfmail tag” in
Chapter 39, “Sending and Receiving E-Mail,” in ColdFusion MX Developer’s Guide.
20Chapter 2: Using the ColdFusion MX Administrator
Mail Server Settings area
The following table describes basic mail server settings:
OptionDescription
Mail ServerEnter a valid mail server for sending dynamic SMTP mail messages in the
Verify Mail Server
Connection
Server PortEnter the number of the port on which the mail server is running. Contact
Backup Mail Servers
(Enterprise Edition only)
Maintain Connection to
Mail Server
(Enterprise Edition only)
Connection Timeout
(seconds)
text box. You can enter an Internet address, such as mail.company.com,
or the IP address of the mail server, such as 127.0.0.1.
Select this option to verify that ColdFusion MX can connect to your
specified mail server after you submit this form.
Whether or not you use this option, you should verify that your mail server
connection works by sending a test message.
your server administrator if 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
username and password, as follows:
username:password@mailserveraddress
To use a port number other than the default (25), specify
mailserveraddress:portnumber
Select this option to keep mail server connections open after sending a
mail message. Enabling this option can enhance performance when
delivering multiple messages.
Enter the number of seconds that ColdFusion MX should wait for a
response from the mail server before timing out.
Mail Spool Settings area
The following table describes mail server spool settings:
OptionDescription
Spool Interval (seconds) Enter the interval, in seconds, at which you want the mail server to
Mail Delivery Threads
(Enterprise Edition only)
process spooled mail.
Enter the maximum number of simultaneous threads used to deliver
spooled mail.
Server Settings section21
OptionDescription
Spool mail messages for
delivery
(Memory spooling
available for Enterprise
Edition only)
Maximum number of
messages spooled to
memory
(Enterprise Edition only)
Select this option to route outgoing mail messages to the mail spooler. If
you disable this option, ColdFusion MX delivers outgoing mail messages
immediately. In ColdFusion MX Enterprise Edition, you can spool
messages to disk (slower, but messages persist across shutdowns) or to
memory (faster, but messages do not persist).
You can override this setting in the
Enter the maximum number of messages ColdFusion MX will spool to
memory before switching to disk spooling.
cfmail tag.
Mail Logging Settings area
Select preferences for handling mail logs, as described in the following table:
OptionDescription
Error Log SeverityFrom the drop-down list box, 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 e-mail messages
sent by ColdFusion MX
Select this option to save to a log file the To, From, and Subject fields of
all e-mail messages.
ColdFusion MX writes sent mail and mail error logs to the following directories:
• \CFusionMX7\logs (Windows server configuration)
• /opt/coldfusionmx7/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:
LogDescription
mailsent.logRecords sent e-mail messages.
mail.logRecords general e-mail errors.
Mail Character Set Settings area
Select preferences for the default mail character set, as described in the following table:
OptionDescription
Default CFMAIL
CharSet
22Chapter 2: Using the ColdFusion MX Administrator
From the drop-down list box, select the default character set used by the
cfmail tag. The default value is UTF-8. If the majority 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 Settings page
The ColdFusion charting and graphing engine lets you produce highly customizable business
graphics, in a variety of formats, using the
cfquery tag. You use the Charting page in the
Administrator to control characteristics of the engine.
The following table describes the caching and thread settings for the ColdFusion charting and
graphing engine:
OptionDescription
Cache TypeSet the cache type. Charts can be cached either in memory or to disk.
Memory caching is faster, but more memory intensive.
Maximum number of
images in cache
Max number of charting
threads
Disk cache locationWhen caching to disk, specify the directory in which to store the
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.
Specify the maximum number of chart requests that can be processed
concurrently. The minimum number is 1 and the maximum is 5. (Higher
numbers are more memory-intensive.)
generated charts.
Font Management page
The Font Management page lets you review and define fonts for use with Macromedia FlashPaper
and Acrobat PDF output formats. ColdFusion generates FlashPaper and PDF output through the
cfdocument tag and through the cfreport tag, when used to call a report created with the
ColdFusion Report Builder.
ColdFusion MX 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 must register them with the ColdFusion MX
Administrator so that the
cfdocument and cfreport tags can locate and render PDF and
FlashPaper reports.
This page contains the following sections:
Register New Font with ColdFusion Lets you browse to a directory that contains fonts, or
select a specific font.
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 MX Administrator online Help.
For more information on reporting in ColdFusion MX, see Chapter 32, “Creating Reports for
Printing,” in ColdFusion MX Developer’s Guide.
Server Settings section23
Java and JVM Settings page
The Java and JVM Settings page lets you specify the following settings, which enable
ColdFusion MX to work with Java:
OptionDescription
Java Virtual Machine
Path
Minimum JVM Heap
Size
Maximum Memory Size The JVM maximum heap size. The default value is 512 MB.
Class PathThe file paths to the directories that contain the JAR files used by
JVM ArgumentsThe arguments to the JVM. Use a space to separate multiple entries (for
Note: This page is available in the server configuration only.
The absolute file path to the location of the Java virtual machine (JVM)
root directory. The default is cf_root/runtime/jre.
The JVM initial heap size.
ColdFusion MX. Specify either the fully qualified name of a directory that
contains your JAR files or a fully qualified JAR filename. Use a comma to
separate multiple entries.
example, -Xint -Xincgc).
Before ColdFusion saves your changes, it saves a copy of the current
cf_root/runtime/bin/jvm.config file as jvm.bak. If your changes prevent ColdFusion from
restarting, use the jvm.bak file to restore your system. For more information, see the online help.
Settings Summary page
The Settings Summary page shows all ColdFusion configuration settings. Click a group name to
open that group’s Administrator section, where you can edit settings. This page is not enabled in
the Standard Edition.
Data & Services section
The Data & Services section of the Administrator is the interface for ColdFusion MX, data
sources, and Verity search and indexing features. The following table describes some common
tasks that you can perform in the Data & Services section of the Administrator:
TaskDescription
Create and manage
JDBC data sources
Create and maintain
Verity collections
Define mappings for web
services
24Chapter 2: Using the ColdFusion MX Administrator
The Data Sources page lets you establish, edit, and delete JDBC data
source connections for ColdFusion MX. For more information, see
Chapter 3, “Data Source Management,” on page 43.
The Verity Collections page lets you create and delete Verity collections
and perform maintenance operations on collections that you create. For
more information, see “Verity Collections page” on page 25.
The Web Services page lets you produce and consume remote
application functionality over the Internet. For more information, see
“Web Services page” on page 26.
The Data & Services section contains the following pages:
• Data Sources page
• Ver i ty C o lle ct io ns pa ge
• Verity K2 Server page
• Web Servi c es page
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 must register the data source in the ColdFusion MX
Administrator. For more information, see Chapter 3, “Data Source Management,” on page 43.
Verity Collections page
ColdFusion MX includes Verity, which provides indexing and searching technology to create,
populate, and manage collections of indexed data that are optimized for fast and efficient site
searches.
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 Chapter 24, “Building a Search
Interface,” in ColdFusion MX Developer’s Guide.
ColdFusion lets you manage your collections from the Administrator. You can index, optimize,
purge, or delete Verity collections that are connected to ColdFusion. You use the icons in the
Actions column to perform the following actions:
ActionDescription
IndexAnalyzes the files in a collection and assembles metadata and pointers to
OptimizeReclaims space left by deleted and changed files by consolidating
PurgeDeletes all documents in a collection, but not the collection itself. Leaves
DeleteDeletes a collection.
the files.
collection indexes for faster searching. You should optimize collections
regularly.
the collection directory structure intact.
The Verity Search Server must be running. If this page is unable to retrieve collections, ensure
that the Verity Search Server is running. For more information, see “Collections and the
ColdFusion MX Verity architecture” on page 105.
Data & Services section25
Verity K2 Server page
You can install Verity on a different host computer from the one ColdFusion MX is running on.
If this is the case, you can configure the host that ColdFusion will use when it performs search
operations. If you have purchased the Verity product, you may need to use advanced settings to
configure the aliases and ports of the services that ColdFusion uses. You should not need to
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 MX Administrator lets you register web services so that you do not
have to specify the entire Web Services Description Language (WSDL) URL when you reference
the web service. The first time you reference a web service, ColdFusion MX automatically
registers it in the Administrator.
When you register a web service, you can shorten your code and change a web service’s URL
without editing your code. For more information, see Chapter 36, “Using Web Services,” in
ColdFusion MX Developer’s Guide.
Debugging & Logging section
The Debugging & Logging section contains the following pages:
• Debugging Settings and Debugging IPs pages
• Debugging IP Addresses page
• Logging Settings page
• Log Files page
• Scheduled Tasks page
• System Probes page
• Code Compatibility Analyzer page
• License Scanner page
Debugging Settings and Debugging IPs pages
You use the Debugging Settings and Debugging IPs pages to configure ColdFusion MX to
provide debugging information for every application page requested by a browser. You specify
debugging preferences using the pages as follows:
• On the Debugging Settings page, select debugging output options. If debugging is enabled, the
output appears in block format after normal page output.
• On the Debugging IPs page, restrict access to debugging output. If a debugging option is
enabled, debugging output is visible to all users by default.
Note: Enabling debugging affects performance. You should not enable debugging on a production
server.
26Chapter 2: Using the ColdFusion MX Administrator
The Debugging Settings page provides the following debugging options:
OptionDescription
Enable Robust Exception
Information
Enable DebuggingEnables the ColdFusion debugging service.
Select Debugging Output
Format
Report Execution TimesReports execution times that exceed a specified time limit.
General Debug InformationShow general information about the ColdFusion MX version,
Database Activity Shows the database activity for the SQL Query events and
Exception InformationShows all ColdFusion exceptions raised for the request in the
Tracing InformationShows trace event information in the debugging output. Tracing
Timer InformationShows output from the
VariablesDisplays information about parameters, URL parameters,
Displays detailed information in the exceptions page, including
the template’s physical path and URI, the line number and
snippet, the SQL statement used (if any), the data source name
(if any), and the Java stack trace.
Controls debugging format. Select either of the following
formats:
• 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.
template, time stamp, user locale, user agent, user IP, and host
name.
Stored Procedure events in the debugging output.
debugging output.
lets you track program flow and efficiency using the
cftimer tag.
cftrace tag.
cookies, sessions, and CGI variables in the debugging output.
Enables the standard NT Performance Monitor application to
display information about a running server.
Shows performance information on platforms that do not support
the NT Performance Monitor. For more information, see “Using
the cfstat utility” on page 28.
* Restart ColdFusion MX after changing this setting.
Debugging & Logging section27
Using the cfstat utility
The
cfstat command-line utility provides real-time performance metrics for ColdFusion MX.
Using a socket connection to obtain metric data, the
cfstat utility displays the information that
ColdFusion MX writes to the System Monitor without actually using the System Monitor
application. The following table lists the metrics that the
cfstat utility returns:
Metric
abbreviation
Pg/SecPage hits per secondThe number of ColdFusion pages processed per
DB/SecDatabase accesses per
CP/SecCache pops per secondThe number of ColdFusion template cache pops per
Req Q'edNumber of queued requests The number of requests that are currently waiting for
Req Run'gNumber of running requests The number of requests that ColdFusion MX is
Req TO'edNumber of timed out
AvgQ TimeAverage queue timeA running average of the time, in milliseconds, that
AvgReq Time Average request timeA running average of the time, in milliseconds, that
AvgDB TimeAverage database
Bytes In/SecBytes incoming per second The number of bytes that ColdFusion MX read in the
Bytes
Out/Sec
Metric nameDescription
second. You can reduce this by moving static content
to HTML pages.
The number of database accesses per second made
second
requests
transaction time
Bytes outgoing per second The number of bytes that ColdFusion MX wrote in the
by ColdFusion MX. Any difference in complexity and
resource load between calls is ignored.
second. A cache pop occurs when ColdFusion MX
ejects a cached template from the template cache to
make room for a new template.
ColdFusion MX to process them. Lower values,
which you can achieve with efficient CFML, are
better.
currently actively processing.
The total number of ColdFusion requests that have
timed out. Lower values, which you can achieve by
aggressive caching, removing unnecessary dynamic
operations and third-party events, are better.
requests spend waiting for ColdFusion MX to
process them. Lower values, which you can achieve
with efficient CFML and enhanced caching, are
better.
ColdFusion MX spends to process a request
(including queued time). Lower values, which you can
achieve with efficient CFML, are better.
A running average of the time that ColdFusion MX
spends on database-related processing of
ColdFusion requests.
last second (not an average).
last second (not an average).
28Chapter 2: Using the ColdFusion MX Administrator
Before you use the cfstat utility, ensure that you selected the Enable Performance Monitoring
check box in the ColdFusion MX Administrator (on the Debugging & Logging > Debugging
Settings page). If you select this check box, you must restart ColdFusion MX for this change to
take effect.
cfstat options
The cf_root/bin directory contains the cfstat utility. From that directory, type cfstat and use the
following switches:
SwitchDescriptionComment
-nSuppress column headers.Useful for saving output to a file.
-sDisplay output in a single line.Display a single line and delay display of the first
#Where # is an integer, display
output every # seconds.
line so the
values in the per-second counters.
If you do not specify an integer, the
returns one line. Specify this switch with or without
the -s switch.
cfstat utility can display meaningful
cfstat utility
This example runs the
cfstat 20
cfstat utility and displays a new line every 20 seconds:
Debugging IP Addresses page
You use the Debugging IP Addresses page to restrict debugging output to one or more IP
addresses. You can add and remove IP addresses.
Note: If you do not specify IP addresses, and debugging options are active, ColdFusion MX displays
debugging output for all users.
Debugging & Logging section29
Logging Settings page
You use the Logging Settings page of the Administrator to change ColdFusion MX logging
options. The following table describes the settings:
OptionDescription
Log directory*Specifies the directory to which error log files are written.
Maximum file size
(kb)
Maximum number of
archives
Log slow pages
taking longer than [n]
seconds
Log all CORBA calls Logs all CORBA calls.
Enable logging for
scheduled tasks
* Restart ColdFusion MX after changing this setting.
Sets the maximum file size for log files. When a file hits this size, it
automatically is archived.
Sets the maximum number of log archives to create. When they reach this
limit, files are deleted in the order of oldest to newest.
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.
Logs ColdFusion Executive task scheduling.
Log Files page
The Log Files page lets you perform operations on log files, such as searching, viewing,
downloading, archiving, and deleting.
Click on a Log File icon, located in the Actions column of the Available Log Files table, to search,
view, download, archive, or delete a log file.
For more information, see the ColdFusion MX Administrator online Help.
The following table describes the ColdFusion MX log files:
Log fileDescription
rdservice.logRecords errors that occur in the ColdFusion Remote Development Service
(RDS). RDS provides remote HTTP-based access to files and databases.
application.logRecords every ColdFusion MX error reported to a user. Application page
exception.log Records stack traces for exceptions that occur in ColdFusion.
scheduler.logRecords scheduled events that have been submitted for execution. Indicates
server.logRecords errors for ColdFusion MX.
customtag.logRecords errors generated in custom tag processing.
car.logRecords errors associated with site archive and restore operations.
30Chapter 2: Using the ColdFusion MX Administrator
errors, including ColdFusion MX syntax, ODBC, and SQL errors, are written
to this log file.
whether task submission was initiated and whether it succeeded. Provides
the scheduled page URL, the date and time executed, and a task ID.
Loading...
+ 140 hidden pages
You need points to download manuals.
1 point = 1 manual.
You can buy points or you can get point for every manual you upload.