Use the ColdFusion administrator

ColdFusion System Probes HAS BEEN DEPRECATED

For a full list of deprecated features, refer to Deprecated features.

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.

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

Access online help

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:

New in ColdFusion (2018 release)

Executor Pool Configuration  for Asynchronous Programming framework

These settings enable you to finetune your async executor according to your requirements. Also, these property changes take effect without any server restart.

We have also added the following Admin APIs to support the properties mentioned above. These APIs are a part of runtime.cfc.

In this release, to support the pool configuration settings, we have also added three new properties to the API, getRuntimeProperty(required propertyName). They are:

• corePoolSize
• maxPoolSize
• keepAliveTime

New in ColdFusion (2018 release) Update 2

Settings for mobile.

Request Tuning

Simultaneous request tuning overview

You can specify the number of simultaneous requests that can be processed for each of the following types of requests:

• CFM page requests
• CFC method invocations (via an HTTP GET)
• Flash Remoting requests

• Web Service requests
  The settings are contained completely within ColdFusion code and work across all J2EE application servers. You do not have to restart the ColdFusion server for changes to the configuration to take effect. JSP processing is not affected by these changes.

  Note: The Flash Remoting request control setting applies to remoting that uses ActionScript 2.0 and ActionScript 3.0, with each type treated independently. For example, a setting of 5 means that up to 5 ActionScript 2.0 Flash Remoting and 5 ActionScript 3.0. Flash Remoting requests are allowed simultaneously.

Capabilities by edition

• Standard Edition: Only the Async CFML, DirectoryWatcher, Socket, and user written event gateways are enabled. The maximum number of threads in the pool for the cfthread tag is limited to 10. Only the CFM page request limit is adjustable.
• Enterprise Edition: All event gateways are supported. The number of threads in the pool for the cfthread tag is unlimited. You can adjust the limits for each request type (CFM page, CFC, Flash Remoting, and Web Service) independently.

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	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.
Maximum Number Of Simultaneous Flash Remoting Requests	The number of Adobe Flash Remoting requests that can be processed concurrently.
Maximum Number Of Simultaneous Web Service Requests	The number of Web Service requests that can be processed concurrently.
Maximum Number Of Simultaneous CFC Function Requests	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.
Maximum Number Of Simultaneous Report Threads	The maximum number of ColdFusion reports that can be processed concurrently.
Maximum Number Of Threads Available For CFTHREAD	CFTHREAD that runs concurrently. Threads that CFTHREAD creates in excess of the specified limit are queued.
Timeout Requests Waiting In Queue After n Seconds	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).
Request Queue Timeout Page	Specify a relative path to an HTML page to send to clients when a template requests time out before 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.

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:

Client Variables page

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 10, 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

  Note: 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.

Store client variables in a data source

1. On the Client Variables page, in the Select Data Source to Add as Client Store table, select a data source from the drop-down.
2. Click Add. The Add/Edit Client Store page for the data source appears.
3. Select options for the data source, as described in the following table. (To exit from the page without saving changes, click the left-arrow icon.)

1. Click Submit Changes. The Client Variables page appears, with your data source in the list.
2. In the Select Default Storage Mechanism for Client Sessions table, select the data source.
3. Click Apply.

Store client variables in a cookie or in the system registry

1. In the Client Variables page, select Cookie or Registry.
2. Click Apply.

Client variable storage options

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:

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.

Sample table creation page

Memory Variables page

You can specify maximum and default time-out values for session and application variables. Unless you define a time-out 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.

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.You can also determine how ColdFusion stores the session variables - in memory or Redis. Select an option from the Session Storage drop-down list. For more information, see External session storage.

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  cfinclude  and  cfmodule  tags. If you save CFML pages outside the web_root directory (or whatever directory is mapped to "/"), you add a mapping to the location of those files on your server. 
Assume that the "/" mapping on your server points to C:\coldfusion2018\wwwroot, but that all of your ColdFusion header pages reside in C:\foo\newpages\headers. Add a mapping in the ColdFusion Administrator that points to C:\foo\newpages\headers, for ColdFusion to find the header pages. For example, add a mapping for /headers that points to C:\foo\newpages\headers. In the ColdFusion pages located in C:\coldfusion2018\wwwroot, you reference these header pages using /headers in your  cfinclude  and  cfmodule  tags.

Mail page

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.

Mail Server Settings area

The following table describes basic mail server settings:

Mail Spool Settings area

The following table describes mail server spool settings:

Mail Logging Settings area

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

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

• \coldfusion10\logs (Windows server configuration)
• /opt/coldfusion10/log (Solaris and Linux server configuration)
• cf_webapp_root/WEB-INF/cfusion/logs ( J2EE configurations, all platforms)
  The following table describes the e-mail log files:

Mail Character Set Settings area

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

Scheduled Tasks page

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. 

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. 
When a scheduled page executes, ColdFusion writes a message to a log file called schedule.log automatically. This file identifies the name of the scheduled action, the page to be executed, and whether the task scheduled executed successfully .You can pause and resume scheduled tasks.

For more information, see cfschedule .

The Scheduled Task page lets you create, edit, pause, resume, and delete scheduled tasks. This page has the following areas:

• Application Level Scheduled Tasks:Provides a list of application-specific tasks that you have scheduled, with task details in tabular format. The table provides details such as actions, application name, group, task name, duration, interval, last run, next run, repeat count, and if cluster is enabled.

  Note: Application-specific tasks cannot be created using ColdFusion Administrator. But you can pause, resume, or delete the tasks.

• Server Level Scheduled Tasks: Provides a list of server-specific tasks that you have scheduled, with task details in tabular format. The table provides new details such as group, next run, repeat count, if cluster is enabled, and the remaining task count.
• Enable Cluster Setup:Applies if you have at least one data source configured. Specify the following details:
  • Select Data source: All the data sources you have connected to are listed.

  • Create Tables for Cluster Setup:Check to create scheduler-specific tables for cluster.

    Note: Enable this option only for one node in the cluster. Otherwise, the tables are overridden. If you have created tables from one node, in other nodes you need to only select and choose the data source. All nodes will point to the same data source and therefore will be part of the cluster.

  • After you specify the details, click Submit.
    To disable cluster, select the option Disable Cluster.

Add/Edit Scheduled Task page

Add/Edit Scheduled Task page lets you add or edit task. Click Submit after you specify the following tasks. When the page loads for the first time, you are provided with only minimum options to create the task. Click Show Additional Settings to list all settings.

WebSocket page

Use the ColdFusion Administrator (Server Settings > WebSocket) to specify the following WebSocket-related details:

Charting page

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

Font Management page

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:

• 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. The following table describes the fields on the Font Management page:

The Font Management page also displays the built-in Acrobat fonts, which are available for PDF only.For more information on reporting in ColdFusion, see Creating Reports and Documents for Printing in the Developing ColdFusion Applications.

About Font Management

ColdFusion can create documents and reports in both PDF and FlashPaper format. Both of these formats require that the server computer have access to the fonts used in the HTML styles (cfdocument tag) or the report definition (ColdFusion Report Builder). ColdFusion requires access to these fonts to properly render text in PDF and FlashPaper documents and, when specified, to embed fonts into a PDF file.

Types of fonts and font extensions

The ColdFusion Administrator lets you register the following types of fonts:

The Font Management page also displays the built-in Acrobat fonts, which are available for PDF only. ColdFusion does not use PFM or FFT fonts.

Font locations

The ColdFusion Administrator automatically displays the fonts discovered in platform-specific default locations, as follows:

• Windows - The Windows/Fonts directory (for example, WINDOWS/Fonts or WINNT/Fonts)
• Unix - The following directories:
• /usr/X/lib/X11/fonts/TrueType
• /usr/openwin/lib/X11/fonts/TrueType
• /usr/share/fonts/default/TrueType
• /usr/X11R6/lib/X11/fonts/ttf
• /usr/X11R6/lib/X11/fonts/truetype
• /usr/X11R6/lib/X11/fonts/TTF
  Additionally, you can define fonts stored in other locations on the server. These are called user-defined fonts. For example, you may want to register the Lucida family of TrueType fonts, which the Sun JDK ships in the jdk_root/jre/lib/fonts directory.

Embedding fonts in PDF output

Report developers can optionally specify that ColdFusion embed fonts in the PDF file (FlashPaper always embeds fonts). When using the cfdocument tag, fonts are embedded if fontEmbed is set to yes or selective. When using reports defined in the Report Builder, fonts are embedded if specified in the report definition file.Embedding fonts increases file size, but ensures that reports display appropriately regardless of whether or not client computers have the fonts installed.

Client requirements

If fonts are not embedded in the PDF file, fonts must be installed on the client computer to ensure that reports display appropriately.Most Windows computers ship with Internet Explorer, which includes the Microsoft Core Fonts, a set of TrueType fonts.

UNIX considerations

If you install ColdFusion on a UNIX computer you must ensure that the appropriate fonts are installed, even if the computer provides console access only.For more information on TrueType fonts for UNIX, see http://corefonts.sourceforge.net/.

ColdFusion Report Builder considerations

The ColdFusion Report Builder has no automatic knowledge of fonts available on the server so the developer building the report definition must consult the ColdFusion MX Administrator to determine which fonts are available on the server and, if necessary, register fonts in the Administrator or install fonts on the computer that runs Report Builder.

Central Config Server (CCS) page

Document page

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:

Restart ColdFusion server after making the changes.

When you update the Java and JVM Settings page, ColdFusion writes the changes to jvm.config, which is located in cf_root\runtime\bin. Before ColdFusion saves your changes, it saves a copy of the current jvm.config file as jvm.bak. If your changes prevent ColdFusion from restarting, use jvm.bak to restore your system. For example, rename jvm.config to jvm.config_BAD, and then rename jvm.bak to jvm.config.
ColdFusion filters out default settings for the jvm.args attribute from the jvm.config file, including the following:

To use Server Monitor or Multiserver Monitor on a J2EE deployment of ColdFusion on Oracle 10g, in JVM Arguments set -Doc4j.jmx.security.proxy.off=true

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 and Services section

The Data and Services section of the Administrator is the interface for ColdFusion, data sources, and search and indexing features. The following table describes some common tasks that you can perform in the Data & Services section of the Administrator:

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 for ColdFusion. 
Before you can access a database with a ColdFusion application, perform the following:

1. Understand and determine the database driver required to interact with the data source. ColdFusion uses JDBC database drivers to communicate with data sources.
2. Configure the database as a ColdFusion data source by specifying a driver, adding data source information, and connecting to a database.
3. Verify the data source.
   For more information on adding data sources, see Adding data sources.

ColdFusion Collections page

Use this page to create and manage your Solr collections. 

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

ColdFusion includes 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.
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 Solr Search Server is running.

Populate a Solr collection

After you create a collection, use the Solr Collections section to populate (or index) it, with data from text and binary files, in a directory that you specify. A collection comprises metadata that describes indexed documents. Data from a ColdFusion query can be indexed only by using the ColdFusion  cfindex  tag. To populate (index) a collection,

1. In the list of Solr Collections, click the name of the collection or its Index Collection button. The Index Solr Collections page appears.
2. Review the extensions in the File Extensions field. You can add, edit, or remove extensions for files in the collection.
3. In the Directory Path field, enter the path to a directory to index. To locate and enter a path, click Browse Server.
4. To include subdirectories of the specified directory, select the Recursively Index Sub Directories option.
5. (Optional) In the Return URL field, enter the URL prefix used to display documents found in the search in a browser. For example, if you index the ColdFusion documentation directory, the directory you index could be C:\ColdFusion2018\cfusion\wwwroot\cfexample. You would enter the return URL as http://localhost:8500/cfexample/. This assumes that you are using the built-in web server on port 8500.
6. Click Submit. ColdFusion populates the collection with data from the specified directory. Then the ColdFusion Collections page appears.
   To close the page without saving changes, click Cancel.

Rename or create an alias for a Solr collection

1. Click the ColdFusion collection that you need to rename from the ColdFusion Collections page. The Manage Collection page is displayed.
2. In the Rename Collection section, enter a new name in the New Name for Collection field and click Submit.
3. To specify an alias for the collection, enter the alias in the Collection Alias field and click Submit.

Solr Server page

The Solr server instance runs as a separate server, which you can start or stop as a service. You can configure your Solr collection for indexing and search capabilities using ColdFusion Administrator.

Solr collections

The ColdFusion Administrator implements Solr support using the following panels in the Data & Services area:

• ColdFusion Collections Once a Solr collection is created, use the Index, Optimize, Purge, or Delete Actions under the Solr Collection area at the bottom of the panel. You can also rename and alias a Solr collection in ColdFusion Administrator. To do this,

1. Click the ColdFusion collection that you need to rename from the ColdFusion Collections page. The Manage Collection page is displayed.
2. In the Rename Collection section, enter a new name in the New Name for Collection field and click Submit.
3. To specify an alias for the collection, enter the alias in the Collection Alias field and click Submit.

• Solr Server Configure the Solr server host name, home directory, and other advance settings using the Solr Server page.

Solr server

Use the Solr Server page to specify the Solr server host name and home directory. You can also configure advance settings including the admin port, web application name, and buffer limit.

Click Show Advance Settings to add the following details:

• Solr admin port
• Solr WebApp
• Solr Buffer Limit
• Authentication details
• If to use an HTTPS connection, and if so the Solr HTTPS port.
  You can also configure indexing laguages by providing a language name and suffix.

Migrate collections

To migrate the collection, browse and select the old Solr home and then click Migrate Solr Collections.For details, see "Solr enhancements in ColdFusion 10" in Developing Adobe ColdFusion Applications.

Web Services page

Web services let you publish and consume remote application functionality over the Internet. With a web service, you can make a request to the remote application to perform an action. You can use the ColdFusion Administrator to register web services so that clients do not have to specify the entire WSDL URL when they reference the web service. For more information on publishing and consuming web services through ColdFusion, see ColdFusion Developer's Guide.

Add a web service

1. In the Web Service Name box, enter the name of the web service.
2. In the WSDL URL box, enter the URL for the Web Services Description Language (WSDL).
3. Enter a user name and password.
4. (If applicable) Specify the proxy server details and credentials.
5. (Optional) Specify the timeout value for the web-service request in seconds.
6. Click Add Web Service. Your Web Service Name appears in the list of Active ColdFusion Web Services.

Edit a web service

1. In the Active ColdFusion Web Services area, click the web service name. The ColdFusion Administrator displays the web service in the top portion of the window.
2. Modify settings.
3. Click Update Web Service.

View WSDL for a web service

1. In the Active ColdFusion Web Services area, click the WSDL URL. The ColdFusion Administrator opens the WSDL in a new browser window.

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.

REST Services page

After you create the CFC you want to REST-enable, specify the folder for registering as web service in the ColdFusion Administrator.

Browse and select the application path or root folder where ColdFusion would search for CFCs.When you specify a folder, all CFCs in that folder or subfolders for which you have specified rest or restPath are registered.

1. (Optional) In the Service Mapping section, specify virtual mapping in place of application name. If the folder has an Application.cfc and an application name, then the service is identified with the application name. You can override this by specifying the service mapping. In this case, the service is identified with the service mapping that is provided. If there is no Applicaiton.cfc in the folder, then it is mandatory to specify the Service mapping.
2. (Optional) Specify an application as default REST service. Only one application can be set as default for a server instance. You can change the default application at any time. Check Set the default application and then click Add Service. To remove the service as default, uncheck it.

3. After you specify the details, click Add Service to register. The Active ColdFusion REST Services section specifies the details of all registered web services.
   After you register, all CFCs are published as RESTful services. On subsequent startups, the registered services automatically get published.

NoSQL Data Sources section

New in ColdFusion (2021 release)

Specify the name of the data source and then from the Driver drop-down list, choose MongoDB. 

The following table lists all the MongoDB settings and their description.

Cloud credentials section

New in ColdFusion (2021 release)

Cloud configuration section

New in ColdFusion (2021 release)

AWS configuration options - S3, DynamoDB, SQS, and SNS

* The settings marked with an asterisk are specific to S3.

New in ColdFusion (2021 release)

Azure configuration options - Blob

Azure configuration options - Service Bus

GCP configuration- Storage

GCP configuration- Firestore

GCP configuration- PubSub

GraphQL

Debugging and Logging section

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 Output Settings page, select debugging output options. If debugging is enabled, the output appears in block format after normal page output.
• On the Debugging IP Addresses page, restrict access to debugging output. If a debugging option is enabled, debugging output is visible to all users by default.

• On the Logging Settings page, specify a directory for error log files that can contain useful debugging information.

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

Debugging Output Settings page

The Debug Output Settings page provides the following debugging options:

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:

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.

cfstat options

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

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

Developer Profile page

Enable Developer Profile

Enable this option to use REST Playground app. It is recommended to disable developer profile in Production/Lockdown environments to disable REST Playground.

The following settings get changed when you enable the developer profile:

• Trusted Cache is disabled
• Robust Exception is enabled
• REST Discovery is enabled

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. 

To add a debugging IP address,

1. In the Debugging IP Addresses page, enter an IP address that you want to receive debugging output. The default IP address is 127.0.0.1.
2. Click Add.
3. (Optional) To add the IP address of the computer you are using, click Add Current. The list below the IP Address field shows the IP addresses that you added.
   To remove a debugging IP address:
4. Select an IP address from the list.

5. Click Remove Selected. The address no longer appears in the list.

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:

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:

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.
Use the Logging Settings page to enable or disable administrative logging options, as the following table describes:

The following table describes the ColdFusion log files:

Enable/Disable logging

Use the icon for start/stop in the Actions column of the Log Files page to stop/start logging for a particular log type.

Filter log content

1. To open the Log Filter, click Launch Filter on the Log Viewer page.
2. In the Log Filter dialog box, specify one or more of the following options:

1. To begin the filter process, click one of the following options:

• Show Matches Displays results that match the filter criteria specified on the tab.
• Hide Matches Displays results that exclude any information that matches the filter criteria specified on the tab.

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

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:

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 page

Use the System Probes page to manage the ColdFusion system probes that were created to monitor the availability of a resource in your website.

Suspend probe operation

In the System Probes table, select the name of the probe to suspend, and click the Disable Probe icon.

Add/Edit System Probe page

1. In the ColdFusion Administrator navigation pane, click System Probes. The System Probes page appears.
2. In the System Probes page, do one of the following:
   • Define a new probe. Click Define New Probe. The Add/Edit System Probe page appears.
   • Edit an existing probe configuration. Locate and click the probe name. The Add/Edit System Probe page appears.
3. In the Add/Edit System Probe page, specify or edit the following settings:

Code Analyzer page

The Code Analyzer page evaluates your ColdFusion pages for potential incompatibilities between ColdFusion 10 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.
Use the analyzer as follows:

1. In the left navigation pane, select Debugging & Logging > Code Analyzer.
2. Enter or browse to a directory that contains the ColdFusion pages to analyze.
3. (Optional) Click Advanced Options to specify the following items:

• Whether to analyze subdirectories.
• The file types to analyze (separate multiple files with semicolons).
• Whether to filter by severity. All reports error and info data, Error reports code that will not execute properly, and Info reports that you should consider editing, but will execute properly; for example, deprecated tags.
• Whether to validate CFML. Reports invalid syntax in your CFML; for example, a comment that has an opening ColdFusion comment tag, and a closing HTML tag.
• The product features to analyze.

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.

Performance Monitoring Toolset

Monitoring Settings

Performance Monitoring Toolset is an application monitoring suite to enable developers gain insight on how applications perform at run time .

In this section, you can modify the following settings:

ColdFusion Hostname: The IP/address of the instance where ColdFusion is installed.

Connected to datastore: Specifies if the Performance Monitoring Toolset is configured with a datastore. The datastore contains information about the performance of various nodes and clusters. This information is collected and displayed by ColdFusion 2018 Performance Monitoring Toolset.

Monitoring Shared Secret: Secret to configure Performance Monitoring Toolset with ColdFusion.

Monitoring Enabled: Specifies if Performance Monitoring Toolset will monitor a ColdFusion instance or server.

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.

This page has the following areas:

• Register New Applet: Registers a Java applet to include in your ColdFusion applications.
• Actions: Click the Edit icon to edit registration fields of a Java applet. Click the Delete icon to remove the registration of a Java applet.
• Applet: Click the name of a Java applet to view or edit the registration fields for that applet.
• *Code:*Identifies the name of the file that contains the applet subclass.
• Method: If applicable, this column identifies the method name used in the name attribute of the cfapplet tag.
• Code Base: This area identifies the directory that contains the applet components.

To register or modify a Java applet in ColdFusion, use the Add/Edit Registered Java Applet page. Registering an applet lets you use the cfapplet tag.

Register a Java applet or modify the registration

1. If you are registering a new Java applet, install the Java class files and any other files required for the class. Make a note of the installation path, because you must specify the code base arguments when you register the applet.
2. To access the Add/Edit Registered Java Applet page:

• For new registration, select Extensions > Java Applets, and click Register New Applet. The Add/Edit Registered Java Appletpage appears.
• For existing registration, in the Registered Java Applets table, click the name of the Java applet registration that you want to view or modify.

1. On the Add/Edit Registered Java Applet page, specify or modify the following information:

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
  The page has the following areas:

Add/Edit CFX Java Tag page

Option	Description
Tag Name	Enter the tag name (after the cfx_prefix). Provide a name for the CFX tag that you are registering.
Class Name	Enter the class name (without the .class extension) that implements the interface. The class file should be accessible from the Class Path setting on the Java and JVM page. You typically package the .class file in a .jar file and save it in the cf_root/lib (server configuration) or cf_webapp_root/WEB-INF/cfusion/lib (J2EE configuration) directory.
Description	Provide a message that identifies the use of this CFX tag.

Add/Edit CFX C++ Tag page

Custom Tag Paths page

Use the Custom Tag Paths page of the Administrator to add, edit, and delete custom tag directory paths.

By default, all custom tags are stored under the cf_root/ CustomTags (server configuration) or cf_webapp_root/WEBINF/cfusion/CustomTags (J2EE configuration) directory. However, you can specify additional paths to your custom tag locations by using this page. The following table describes the areas on the page:

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:

Example of a CORBA connector configuration for VisiBroker:

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

Event Gateways section

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

ColdFusion event gateways are ColdFusion elements that let ColdFusion react to or generate external events or messages in an asynchronous manner. Event gateways let a ColdFusion application handle information that does not come through an HTTP request. For example, you can use event gateways to handle instant messages, short messages from mobile devices, or messages sent to a TCP/IP port. ColdFusion includes several event gateways, including an SMS (Short Message Service) gateway for sending short, often text, messages to and from wireless devices, such as mobile phones or pagers and a gateway for the XMPP (Extensible Messaging and Presence Protocol) instant messaging protocol.

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:

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 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:

Security section

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

For more information on security, see Administering ColdFusion Security.

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. The minimum character limit is 5 and the maximum character limit is 50.
In ColdFusion 10, you can enable/disable RDS using ColdFusion Administrator. That is, you can modify the settings that you made at the time of installation using ColdFusion Administrator.
The RDS page on the ColdFusion Administrator (Security > RDS) lets you enable/disable RDS service.

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

  For details, see Using sandbox security

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 neo-security.xml file, replacing admin with the user ID to use:

Add a user

The User Manager lets you create users that have individually tailored access to portions of the ColdFusion Administrator, the Administrator API, or RDS access.

1. In Security > User Manager, click Add User.
2. For external users, choose SAML or LDAP. Doing so will enable the user to log in to the Administrator using the selected mechanism.
3. Specify the username, password, and then confirm the password.
4. Optionally, enter a description.
5. Select the following options:

• Allow RDS access
• Allow Administrative access: Select one of the following: Administrator Console & API Access and API Access Only.

1. Select the ColdFusion Administrator pages that you want the user to be able to access.
2. Select any sandboxes that you want the user to be able to access.
3. Select the services that you want the user to be able to access.

4. Click Add User.

   Note: To select multiple contiguous sandboxes or roles, press the Shift key while making selections. To select multiple noncontiguous sandboxes or roles, press the Control key while making selections.

   After you create a user, you must log into the ColdFusion Administrator using both a username and password. The default username for the root administrator is admin. To change it, you must edit the neo-security.xml file by changing the string "admin" in admin.userid.root, as follows:

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

   When you grant access to specific Administrator pages, the user sees only those pages after logging in to the Administrator. When you grant Administrator API access and select roles, the user can access the API only for the pages you specified. 
   For information editing existing user configuration, see Edit User Configuration.

User Sandboxes

If you change the pages or sandboxes to which a user is allowed access while that user is logged in to the Administrator, the changes take effect only after the user logs out, and then logs in again. For details about creating sandboxes, see Administering ColdFusion Security.

Exposed Services

ColdFusion exposes existing enterprise services as web services. You can access these services using SOAP and AMF/Flash remoting. You can select the services available to a user from the Exposed Services section. By default, all the services are listed in the Allowed Services list box. Press CTRL and select the services that you do not want the user to avail and click the >> button.Now, click Edit User to implement the changes to the user settings. The following are the exposed services:

• Allowed services: Mail Service, Document Service, PDF Service, Image Service, Chard Service, POP Service,
• Prohibited services: Exchange Service
  You can secure the exposed services to prevent access by unknown applications or users. This can be done by configuring the client IP address range to which services are accessible. Also, you can set up user access control for the services.On the Security > User Manager page, you can select the services available to a user from the Exposed Services section. By default, all the services are listed in the Prohibited Services list box.Press CTRL and select the services that you want the user to avail and click the << button. Now, click Edit User to implement the changes to the user settings.

Edit user configuration

In the User Manager page, click either the user name like in the User column or the Edit icon in the Action column. The User Manager page opens in Edit mode, where you can reconfigure the user account settings such as password, RDS Administrator access, adding sandboxes, and resetting the exposed services for the user.

Allowed IP Addresses

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

Also see IP Restriction for CFIDE URLs.

IDP configuration

SP configuration

External Authentication

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:

• Archive information
• Assoc. Files/Dirs
• Server Settings - The following are migrated as part of the archive file:
  • Settings
  • Caching
  • Basic Security
  • Variables
  • Java and JVM
  • Logging
  • Mail
  • Debugging
  • Charting
  • Custom Tag Paths
  • Watcher Settings
  • Server Monitor Settings
  • System Probes
  • Update Settings
  • Web Sockets
  • Web Service
  • PDF Service
  • Remote Inspection Settings
  • Solr Server Settings
• ColdFusion Mappings
  
• Data Sources
• NoSQL Data Sources
• Java Applets
• CFX Tags
• REST Services
• Cloud Settings
• Archive to do list
  
• Archive Summary

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.

Build an archive

To archive a definition,

1. To access the ColdFusion Archives page, select Packaging and Deployment > ColdFusion Archives in the left navigation pane of the ColdFusion Administrator.
2. On the ColdFusion Archives page, locate the name of the archive definition that you want to archive, and then click the Build Archive icon. The Archive Wizard appears.
3. In the Archive Wizard, review the archive summary information, and then click Next to continue. The Choose Archive File Location page appears.
4. In the Choose Archive File Location page, do the following:

• In the File Name text box, specify the full path where you want to store the archive, followed by the name of the archive. The archive name must have a .car extension.
• For U NIX users only: If you must run this archive as a privileged user, select the Run This Archive As A Specific User option, and then enter any system account name in the User name text box and the corresponding account password in the Password text box. The user name and password must match the existing user name and password for this system; the archive process will run as that user. If the user name and password do not match the existing user name and password for this system account, the build procedure fails.

1. Click Next to create the archive.
   When the archive operation completes, one of the following archive messages appears:

• Build Successful: The archive was successfully created and stored in the location that you specified in step 4. Click OK and then click Close on the wizard page.
• Build Failed: The archive was not created. To determine the cause of the problem, review the information appearing on the page, and click Details to further analyze the cause of the problem.

JEE Archives page

ColdFusion lets you create an EAR or WAR file that contains an entire application. This archive file contains the ColdFusion web application, settings for ColdFusion (such as data source definitions), the CFM pages used by your application (text or compiled Java), and optionally, the ColdFusion Administrator. This feature lets you quickly create an archive file that a J2EE administrator can use to deploy your ColdFusion application. 

J2EE archives are different from ColdFusion archives (CAR) files. For information on CAR files, see ColdFusion Archives page.

Context root Because the J2EE environment supports multiple, isolated web applications running in a server instance, each J2EE web application running in a server is rooted at a unique base URL, called a context root (or context path). The J2EE application server uses the initial portion of the URL (that is, the portion immediately following http://_hostname_) to determine which web application processes an incoming request.For example, if you are running ColdFusion with a context root of cfmx, you display the ColdFusion Administrator using the URL http://_hostname_/_cfmx_/CFIDE/administrator/index.cfm.Most J2EE application servers allow one application in each server instance to use / (forward slash) for the context root. The Remote Development Services (RDS) web application is not required if you use a context root of /.

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.

  Note: 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.

Package Manager

New in ColdFusion (2021 release)

In the ColdFusion Administrator, in the Package Manager page, you can install or uninstall the packages via a User Interface. For more information, see ColdFusion Package Manager.

Click Package Manager ad you can view the installation options.

Packages

Core Server

Check for updates to the core packages. Click the button Check for Updates and see a list of available updates.

Installed Packages

The Installed Packages section lists all packages that are already installed. You can also uninstall all the installed packages.

Available Packages

The Available Packages section lists packages that are not yet installed. Click Install All to install the packages simultaneously..

Settings

This section provides options to specify update preferences such as update notifications or if to automatically check for updates.

If you have set up a local update site, you can also specify URL of that site to get updates.

Auto-Check

Click Auto-Check to see if any package updates are available for installation. You will receive a notification when a new update is available for download.

Notification

Provides options to specify update preferences such as update notifications or if to automatically check for updates.

Update Site

If you have set up a local update site, specify the URL of that site to get updates.

Proxy Settings

If you host the packages on a server that is behind a proxy server, then provide these details:

• Proxy host
• Proxy port
• Proxy username
• Proxy password

Licensing and Activation

New in ColdFusion (2021 release)

For more information, see Licensing and Activation.

Enterprise Manager section

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

Instance Manager page

The Instance Manager page lets you view the local and remote Tomcat servers that can be accessed by a cfusion server running.
From this page you can access pages that define new, local, Tomcat servers and register existing Tomcat servers running on remote computers, as follows:

• Add New InstanceCreate a Tomcat server and automatically deploy a copy of the current ColdFusion MX application into that server.
• Register Remote Instance Define an existing remote Tomcat server to the Instance Manager for adding these servers to a cluster. It is not mandatory to run the remote Tomcat server instance when you define it to the Instance Manager. However, it must be running before you can add it to a cluster.
• Edit ColdFusion Server: Modify built-in web server settings for a server instance.

Available servers

• By default, the Instance Manager deploys a copy of the current cfusion application (data sources, settings, administrator password, and so on).
• You can optionally use the Create from EAR/WAR option to create a server with a previously archived application.

Cluster Manager page

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

1. Add a cluster by typing a name in the Cluster Name box, and clicking Add. This creates a cluster and adds it to the Configured Clusters table.
2. Add servers to the cluster by clicking the Edit icon next to the cluster name in the Configured Clusters table. This displays the Edit Cluster Page.

Edit Cluster Page

The Edit Cluster page in ColdFusion Administrator lets you define the server instances for a cluster and to customize cluster settings.

Managing clusters

Manage clusters using the ColdFusion Administrator. If your ColdFusion application uses session replication, sticky sessions are not typically required.

When session replication is enabled, Tomcat propagates session-variable information to all servers in the cluster every time a session variable changes. Consider whether the application's business requirements require session replication and whether your network incurs the increased traffic before enabling session replication. Consider using client variables instead of session variables.

In the ColdFusion Administrator, click Enterprise Manager > Cluster Manager.The sticky sessions and session replication options require the use of J2EE Sessions by all instances participating in the cluster. To enable J2EE sessions, go to the Memory Variables page and enable the Use J2EE session variables option. Do this for each server in the cluster.

1. Enter a cluster name and then click Add.
2. Click the cluster name and move the servers to the cluster based on the requirement.
3. (If required) Edit the multicast port.Multicast port is used to group the cluster members together. Default value of multicast port is 45564. After you create a cluster, the port is added in the cf_install_dir\cfusion\config\cluster.xml file. For more information on multicast port, see http://tomcat.apache.org/tomcat-6.0-doc/config/cluster-membership.html.
4. Specify if you need sticky session.Sticky session ensures that after a session is established on an instance, all future requests from the client are mapped to that instance.
5. Click Submit.

Adding a remote instance to a cluster

To add a remote instance to a cluster, add the cluster block to the remote instances server.xml. Then, register the remote instance and add the instance to the cluster. For more information on configuring clusters on Tomcat, see http://tomcat.apache.org/tomcat-5.5-doc/cluster-howto.html.

1. Register the remote instance to the local machine.
2. Create a cluster in the local machine.
3. Open the cf_install_dir_instance-name_runtime\conf\server.xml file of the remote instance.

4. Add the following block between the entries </host> }}and {{</engine>:

     5. In the entry, update the membership port with the multicast port of the cluster.

     6. Using the ColdFusion Administrator of the local host, add the local instance and the remote instance to the cluster.

     7. Restart all the instances.

Server Updates

In ColdFusion 10 or higher, the ColdFusion Administrator lets you verify and make product updates from the browser-interface itself.

For more information, see Install Adobe ColdFusion hotfix.

Updates page

Verify if there are any product updates using the ColdFusion Administrator (Server Update > Update). The updates can include hot fixes and security hot fixes for ColdFusion 10.
The Updates page has the following options:

• Available updates: Click Check for Updates to see if any updates are available for installation.With ColdFusion 10, you can receive a notification when a new hot fix is available for download by subscribing to RSS feeds using the following URL:http://www.adobe.com/support/coldfusion/downloads_updates.html. For a multi-server setup, when you apply the updates from the main instance, you have option to select all local instances to which you may opt to apply hot fix . By default, update applies only to the main instance. If you apply the updates from a newly created local instance, the hot fix is applied only to that specific instance. You have to apply the hot fix to other instances from the main instance or individually from each instance. Before the update, the main ColdFusion instance automatically stops. But you have to manually stop all other instances (for which you want to apply the updates).

• Download: Downloads and places the file in <cf_home>/hf-updates/ for later installation.

  Note: If your server is behind a firewall or has no outbound internet access, note that you can download the hotfix file from another machine via this URL: http://download.adobe.com/pub/adobe/coldfusion/xml/updates.xml. You can then place the hotfix file on the ColdFusion server and apply the hotfix either with the Admin interface or via the command-line. If you place it in a locally web-accessible location, you can even configure the updater settings to point to that local URL as the location for ColdFusion to find the updates. See the discussion on the "settings" section, below. Similarly, if you're behind a proxy and would need to specify proxy information for ColdFusion to access the public hotfix URL, you can provide that information (proxy host, port, user, and password) by modifying the jvm.config on the ColdFusion server where the Administrator is being used.

• Download and install: Downloads the hot fix and performs a silent installation.

  Note: This option does not apply to J2EE installations. Also, in the case of multi-server installations, you have to select the server on which you want to install the hot fix .

• Installed updates: Lists all updates to ColdFusion 10 that you have installed. For multi-server setup, it shows the list of updates to the instance to which you have logged in from the ColdFusion Administrator.Use the option Uninstall to remove the installed hot fix (if needed).

• Settings: Provides options to specify update preferences such as update notifications or if to automatically check for updates. 
  
  If you have set up a local update site, you can also specify URL of that site to get updates. To do this, populate the updates. xml (see the following sample) and then update the URL in the Administrator (Server Update > Updates > Settings > Update Site > Site URL). For example, http://IPAddress:Port/updates/updates.xml. The following is a sample updates.xml:

Download hot fix for later installation

1. Ensure that JRE is in your system path, or directly access Java from the installation directory of ColdFusion.
2. Access the downloaded files from the following location:<cf_home>/hf-updates/
3. At command prompt, do the following:

For standalone installations

Platform	Description
On Windows(Installation possible in either GUI or Silent mode)	In GUI mode: At command prompt, run the following command: java -jar<jar-file-name>. This launches the hot fix installer. Follow the on-screen instructions. In Silent mode: At command prompt, run the following command:java -jar<jar-file-name> -i silent -f <install_properties_file_path>. Installation occurs silently. The following is a sample properties file: INSTALLER_UI=SILENT USER_INSTALL_DIR=<ColdFusion_Home> DOC_ROOT=<ColdFusion_Home>/cfusion/wwwroot #The following applies only to multi server scenarios. INSTANCE_LIST=cfusion,cfusion1
On Linux/Solaris/UNIX(Installation possible in either console or silent mode)	In Console mode: At command prompt, run the following command:java -jar<jar-file-name>. The console appears with instructions. Follow the instructions provided in the console. In Silent mode: At command prompt, run the following command:java -jar<jar-file-name> -i silent -f <install_properties_file_path>. Installation occurs silently. The following is a sample properties file: INSTALLER_UI=SILENT USER_INSTALL_DIR=<ColdFusion_Home> DOC_ROOT=<ColdFusion_Home>/cfusion/wwwroot #The following applies only to multi server scenarios. INSTANCE_LIST=cfusion,cfusion1
On Mac OSX(Installation possible in either GUI, Silent, or Console mode)	In GUI mode: At command prompt, run the following command:java -jar<jar-file-name> -i GUI. This launches the hot fix installer. Follow the on-screen instructions. In Console mode: At command prompt, run the following command: java -jar<jar-file-name>. The console appears with instructions. Follow the instructions provided in the console. In Silent mode: At command prompt, run the following command:java -jar<jar-file-name> -i silent -f <install_properties_file_path>. Installation occurs silently. The following is a sample properties file: INSTALLER_UI=SILENT USER_INSTALL_DIR=<ColdFusion_Home> DOC_ROOT=<ColdFusion_Home>/cfusion/wwwroot #The following applies only to multi server scenarios. INSTANCE_LIST=cfusion,cfusion1

By default, after applying the hotfix, servers are restarted. If you do not want the servers to restart, additionally, provide the following command:

• For console and GUI mode: Run the following argument: DDONOT_START_SERVERS_POST_INSTALL=true
• For silent installation: Add the property DONOT_START_SERVERS_POST_INSTALL=true to the properties file.

For J2EE installations

Uninstalling from command prompt

1. If you have installed from command prompt in Console or UI mode, from the ColdFusion root directory, run the following command:

(Modify the command according to your path/OS/Hotfix)

2. If you have installed from the ColdFusion Administrator, from the ColdFusion root directory, run the following command:

3. If you have installed the hotfix using silent installation on your own, uninstallation can also be done silently. Run the following command:

Even though you have installed hotfix to 5 instances using a single script, there is only one hotfix uninstaller for all these 5 instances for a given update (Usually this is under cfusion instance. It can be under other instances if cfusion was not opted for HF). When you invoke the previously mentioned commands, it will uninstall the hotfix from all the 5 instances.

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 <head> or <body> tags. 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 target attribute, the page appears in a new window.

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:

   <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 setMSQL method of datasource.cfc to add a SQL Server data source.
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:

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

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");

   Note: You can log in as a user other than administrator, but with proper permissions, as follows. Provide the user name after the password.

   createObject("component","cfide.adminapi.administrator").login ("#password#","#username#")

    

2. Call the administrator.cfc loginmethod, 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:

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