Contents Chapter 1: Introduction About ColdFusion documentation ..................1 Chapter 2: Administering ColdFusion About the ColdFusion Administrator .
Page 4
CONFIGURING AND ADMINISTERING COLDFUSION 10 Contents Connecting to other data sources ..................89 Connecting to PostgreSQL .
Page 5
CONFIGURING AND ADMINISTERING COLDFUSION 10 Contents Chapter 10: Working with Server Manager Launch Server Manager ................... . . 140 Register servers .
Chapter 1: Introduction Configuring and Administering ColdFusion is intended for anyone who has to configure and manage their Adobe® ColdFusion® development environment. About ColdFusion documentation The ColdFusion documentation is designed to provide support for the complete spectrum of participants. Documentation set...
Chapter 2: Administering ColdFusion Although you use the ColdFusion Administrator to perform most ColdFusion administration tasks, you can also manage databases, web server configurations, and ColdFusion Search Server. About the ColdFusion Administrator The ColdFusion Administrator provides a browser-based interface for managing your ColdFusion environment. You can configure many settings to provide optimal levels of security and functionality.
CONFIGURING AND ADMINISTERING COLDFUSION 10 Administering ColdFusion • Online resources - product registration, developer information, white papers, training, enhancement requests, and security What you can do in ColdFusion Administrator Some of the tasks that you can perform in ColdFusion Administrator: •...
CONFIGURING AND ADMINISTERING COLDFUSION 10 Administering ColdFusion • Register Java applets and CFX tags: You can use Java applets and CFX tags in your ColdFusion applications. Register the applets on the appropriate Extensions pages by selecting Extensions > Java Applets or Extensions > CFX Tags in the ColdFusion Administrator navigation pane.
CONFIGURING AND ADMINISTERING COLDFUSION 10 Administering ColdFusion ps - eaf | grep coldfusion If it is running, your computer returns a line like the following: nobody 4528 1 10 12:44 pts/0 00:00:07 /opt/coldfusion/bin/coldfusion -start Manage the ColdFusion process in UNIX Log in as root.
CONFIGURING AND ADMINISTERING COLDFUSION 10 Administering ColdFusion System information Use the ColdFusion System Information page to do the following: • Update or upgrade a Trial or Developer Edition of ColdFusion as follows: On the System Information page, enter your product serial number in the New License field. Click Submit Changes.
Page 12
CONFIGURING AND ADMINISTERING COLDFUSION 10 Administering ColdFusion Caching Options to use internal cache to store queries, clear query cache, and to clear folder-specific template cache. For details, “Caching page” on page 13. Web services ColdFusion supports Axis 2 web service and an option is provided to specify the Axis version. For details, see “Web Services”...
Page 13
Services Session cookie settings The following settings can be made at the server level using ColdFusion Administrator (Server Settings > Memory Variables > Session Cookie Settings). Adobe recommends that you use the new settings. Setting Default HTTPONLY session cookie Checked...
Chapter 3: Using the ColdFusion Administrator Use the Adobe ColdFusion Administrator to perform basic administration tasks. You can also use the Administrator application programming interface (API) to perform Administrator functionality programmatically. Initial administration tasks Immediately after you install ColdFusion, you might have to perform some or all the administrative tasks described in...
CONFIGURING AND ADMINISTERING COLDFUSION 10 Using the ColdFusion Administrator Accessing user assistance You can use the buttons on the upper left of the ColdFusion Administrator to access online Help, information about additional resources, and system information. Click the question-mark icon on any ColdFusion Administrator page to access the context-sensitive Online Help online Help.
Page 16
CONFIGURING AND ADMINISTERING COLDFUSION 10 Using the ColdFusion Administrator Option Description Enable Whitespace Management Compresses repeating sequences of spaces, tabs, and carriage returns and linefeeds. Compressing whitespace can significantly compact the output of a ColdFusion page. This option is enabled, by default. Disable CFC Type Check Turns off verifying the CFC type when calling methods with CFCs as arguments.
Page 17
CONFIGURING AND ADMINISTERING COLDFUSION 10 Using the ColdFusion Administrator Option Description Site-Wide Error Handler Specify a page to execute when ColdFusion encounters an error 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 does not log page-not-found errors and exceptions.
Page 18
Requests beyond the specified limit are queued. Maximum Number Of Simultaneous ® The number of Adobe Flash Remoting requests that can be processed concurrently. Flash Remoting Requests Maximum Number Of Simultaneous The number of Web Service requests that can be processed concurrently.
Page 19
• In the operating system registry Important: Adobe recommends that you do not store client variables in the registry because it can critically degrade performance of the server. If you use the registry to store client variables, you allocate sufficient memory and disk space.
Page 20
CONFIGURING AND ADMINISTERING COLDFUSION 10 Using the ColdFusion Administrator Option Description Description A description of the client data store and its settings. Not displayed for Registry. Create Client database tables If ColdFusion can determine that the database you use supports SQL creation of database tables, this option appears, and you do not need to create the client variable tables before they are used.
Page 21
CONFIGURING AND ADMINISTERING COLDFUSION 10 Using the ColdFusion Administrator 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: CDATA Table Column Data type...
Page 22
CONFIGURING AND ADMINISTERING COLDFUSION 10 Using the ColdFusion Administrator Sample table creation page <!---- Create the Client variable storage tables in a datasource. This example applies to Microsoft Access databases. ---> <cfquery name="data1" datasource="#DSN#"> CREATE TABLE CDATA cfid char(20), app char(64), data memo </cfquery>...
Page 23
CONFIGURING AND ADMINISTERING COLDFUSION 10 Using the ColdFusion Administrator Note: When using J2EE sessions, ensure that the session time out, specified in the WEB-INF/web.xml session-timeout element, is longer than the session time out specified in the ColdFusion Administrator, and longer than any attribute specified in a tag.
Page 24
CONFIGURING AND ADMINISTERING COLDFUSION 10 Using the ColdFusion Administrator Option Description KeyPassword Password with which the private key is stored. If it is not specified, KeystorePassword is used as KeyPassword. Verify Mail Server Connection Verifies that ColdFusion can connect to your specified mail server after you submit this form. Even if you do not use this option, send a test message to verify that your mail server connection works.
CONFIGURING AND ADMINISTERING COLDFUSION 10 Using the ColdFusion Administrator Option Description Error Log Severity From the drop-down list object, select the type of SMTP-related error message to write to a log file. The options are the following: • Debug (contains Information, Warning, and Error) •...
Page 26
CONFIGURING AND ADMINISTERING COLDFUSION 10 Using the ColdFusion Administrator 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.
Page 27
CONFIGURING AND ADMINISTERING COLDFUSION 10 Using the ColdFusion Administrator Option Description Task Name Enter a name for the task in the Task Name text box. Duration Enter the start and end dates for the task. The end date is optional. If you want this task to execute continuously, leave the End Date text box blank.
Page 28
When caching to disk, specify the directory in which to store the generated charts. Font Management page The Font Management page lets you review and define fonts for use with Adobe® FlashPaper™ and Acrobat® PDF output formats. ColdFusion generates FlashPaper and PDF output through the...
Page 29
Font Type Specifies the font type (for example, TrueType or Adobe Built-In) Usable In Specifies whether the font is usable in PDF, FlashPaper, or both formats. Note that Adobe built-in fonts are not usable in FlashPaper output format. Path Fully qualified path to the font file.
Page 30
File extension Description Usable in Open Type An extension of the TrueType font format. PDF and FlashPaper Adobe printer Adobe printer font PDF only font Adobe Font A font format that contains general font PDF only Metrics information and font metrics information.
Page 31
CONFIGURING AND ADMINISTERING COLDFUSION 10 Using the ColdFusion Administrator 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/.
® ™ addresses can perform data service operations. For more information, see “Flex Integration page” on Adobe Flex applications page 31. Data Sources page ColdFusion lets you quickly deliver dynamic database content to the web. A data source is the entry point for database operations.
Page 33
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. Last updated 7/9/2012...
Page 34
CONFIGURING AND ADMINISTERING COLDFUSION 10 Using the ColdFusion Administrator 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: Action Description...
CONFIGURING AND ADMINISTERING COLDFUSION 10 Using the ColdFusion Administrator Rename or create an alias for a Solr collection Click the ColdFusion collection that you need to rename from the ColdFusion Collections page. The Manage Collection page is displayed. In the Rename Collection section, enter a new name in the New Name for Collection field and click Submit. To specify an alias for the collection, enter the alias in the Collection Alias field and click Submit.
Page 36
Use this page to specify which Flex integration features to enable and which IP addresses can perform data-service operations. If you enable Adobe LiveCycle Data Services ES support, but do not specify any IP addresses, only processes on the local computer can connect to the LiveCycle Data Services ES server in ColdFusion.
Page 37
CONFIGURING AND ADMINISTERING COLDFUSION 10 Using the ColdFusion Administrator Enable SSL Create the keystore. Configure Flex. Enable SSL in the ColdFusion Administrator. Create the keystore ❖ To generate the SSL server (ColdFusion) keystore file, use the keytool utility, with a command similar to the following: keytool -genkey -v -alias FlexAssembler -dname "cn=FlexAssembler"...
CONFIGURING AND ADMINISTERING COLDFUSION 10 Using the ColdFusion Administrator Debugging & Logging section Debugging settings overview 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: •...
Page 39
CONFIGURING AND ADMINISTERING COLDFUSION 10 Using the ColdFusion Administrator Option Description Variables Displays information about parameters, URL parameters, cookies, sessions, and CGI variables in the debugging output. Enable Performance Monitoring Enables the standard NT Performance Monitor application to display information about a running server.
Page 40
CONFIGURING AND ADMINISTERING COLDFUSION 10 Using the ColdFusion Administrator Before you use the utility, ensure that you selected the Enable Performance Monitoring option in the cfstat ColdFusion Administrator (on the Debugging & Logging > Debugging Settings page). If you select this option, restart ColdFusion for this change to take effect.
Page 41
CONFIGURING AND ADMINISTERING COLDFUSION 10 Using the ColdFusion Administrator To stop a currently running debugging session, click Stop Debugging. For the changes that you specify on this page to take effect, restart the ColdFusion server. Logging Settings page Use the Logging Settings page of the Administrator to change ColdFusion logging options. The following table describes the settings: Option Description...
Page 42
(entry) column in the log file. Thread IDs The thread identification numbers are used by Adobe Technical Support personnel to track and troubleshoot problems. The thread identification string appears as the fourth entry (column) in a log file.
CONFIGURING AND ADMINISTERING COLDFUSION 10 Using the ColdFusion Administrator Option Description Most Recent Specifies the relative age of included messages. Date Range To display the log content for a specific date range, enter the start and end dates. Enter the dates in year-month-day format ( YYYY-MM-DD). For example, to specify April 21, 2002, enter: 2002-04-21.
Page 44
CONFIGURING AND ADMINISTERING COLDFUSION 10 Using the ColdFusion Administrator 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. Item Description Define New Click this button to create a probe configuration.
Page 45
CONFIGURING AND ADMINISTERING COLDFUSION 10 Using the ColdFusion Administrator Option Description Probe Name Provide a name for the probe configuration. Frequency Select the schedule for running this probe: • How often (hours, minutes, seconds) the probe verifies the availability of the URL resource. •...
• 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.
Page 47
CONFIGURING AND ADMINISTERING COLDFUSION 10 Using the ColdFusion Administrator • 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. •...
Page 48
CONFIGURING AND ADMINISTERING COLDFUSION 10 Using the ColdFusion Administrator To save and apply the registration information, click Submit. 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.
CONFIGURING AND ADMINISTERING COLDFUSION 10 Using the ColdFusion Administrator 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.
Page 50
CONFIGURING AND ADMINISTERING COLDFUSION 10 Using the ColdFusion Administrator Event gateways overview 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.
CONFIGURING AND ADMINISTERING COLDFUSION 10 Using the ColdFusion Administrator Gateway type Description FMS Gateway Modifies data through the ColdFusion application or the Flash client, and reflects the change in the Flash Media Server shared object. Used to send and receive SMS messages. SAMETIME Used to send and receive instant messages through Lotus SameTime.
Page 52
In the Password Seed section, specify the new seed value between 8-500 characters. Click Submit Changes. Note: When you modify the seed value, all data source connections are reset. Therefore, Adobe recommends that you perform this task when the server is idle or at the initial phase (after installation).
Page 53
CONFIGURING AND ADMINISTERING COLDFUSION 10 Using the ColdFusion Administrator 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.
CONFIGURING AND ADMINISTERING COLDFUSION 10 Using the ColdFusion Administrator 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.
Page 55
CONFIGURING AND ADMINISTERING COLDFUSION 10 Using the ColdFusion Administrator • Data sources • Solr collections • Scheduled tasks • Event gateway instances • Java applets • CFX tags • Archive to do lists After you archive the information, you can use the Administrator to deploy your web applications to the same ColdFusion server or to a ColdFusion server running on a different computer.
Page 56
CONFIGURING AND ADMINISTERING COLDFUSION 10 Using the ColdFusion Administrator J2EE Archives J2EE archives overview 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.
CONFIGURING AND ADMINISTERING COLDFUSION 10 Using the ColdFusion Administrator Option Description Serial Number Specifies a valid serial number for ColdFusion Enterprise Edition. Previous Serial Number (if Specify the serial number of the previous ColdFusion installation. Upgrade) Include COM Support Include COM Support Specifies whether to include the modules that provide COM support. Omitting COM support reduces the size of the archive by about 12 MB.
CONFIGURING AND ADMINISTERING COLDFUSION 10 Using the ColdFusion Administrator Available servers Area Description Actions Lets you start, stop, restart, and delete a Tomcat server. Name Specifies the Tomcat server name. If the server is started, you can click this name to open a browser window to the Tomcat server's web root. Server Directory Specifies the server directory.
Page 59
CONFIGURING AND ADMINISTERING COLDFUSION 10 Using the ColdFusion Administrator 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 file. cf_install_dir\cfusion\config\cluster.xml For more information on multicast port, see http://tomcat.apache.org/tomcat-6.0-doc/config/cluster- membership.html.
Page 61
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: www.adobe.com/go/coldfusion-updates 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.
Page 63
CONFIGURING AND ADMINISTERING COLDFUSION 10 Using the ColdFusion Administrator For standalone installations Platform Description On Windows In GUI mode: (Installation possible • At command prompt, run the following command: java -jar <jar-file-name> . This launches the hot in either GUI or Silent fix installer.
Page 64
CONFIGURING AND ADMINISTERING COLDFUSION 10 Using the ColdFusion Administrator 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 •...
Page 65
CONFIGURING AND ADMINISTERING COLDFUSION 10 Using the ColdFusion Administrator For J2EE installations Last updated 7/9/2012...
Page 66
CONFIGURING AND ADMINISTERING COLDFUSION 10 Using the ColdFusion Administrator Last updated 7/9/2012...
Page 67
CONFIGURING AND ADMINISTERING COLDFUSION 10 Using the ColdFusion Administrator Platform Description On Windows In GUI mode (for exploded EAR/WAR deployment): (Installation possible • At command prompt, run the following command: java -jar <jar-file-name> . This launches the hot in either GUI or Silent fix installer.
Page 68
CONFIGURING AND ADMINISTERING COLDFUSION 10 Using the ColdFusion Administrator Platform Description In Console mode (for exploded EAR/WAR deployment): Linux/Solaris/UNIX • At command prompt, run the following command: java -jar <jar-file-name> . The console appears (Installation possible with instructions. in either console or •...
CONFIGURING AND ADMINISTERING COLDFUSION 10 Using the ColdFusion Administrator Platform Description On Mac OSX In GUI mode (for exploded EAR/WAR deployment): (Installation possible • At command prompt, run the following command: java -jar <jar-file-name> -i GUI This launches in either GUI, Silent, the hot fix installer.
CONFIGURING AND ADMINISTERING COLDFUSION 10 Using the ColdFusion Administrator Extend the Administrator Create a file that contains the HTML link code, followed by a , with a separate line for each link. Do not include <BR> other HTML code, such as tags.
Page 71
CONFIGURING AND ADMINISTERING COLDFUSION 10 Using the ColdFusion Administrator The adminapi directory also contains an Application.cfm file and two subdirectories. Note: If you are using sandbox security, enable access to the cf_web_root/CFIDE/adminapi directory to use the Administrator API. Following are the styles of methods in the Administrator API: When setting complex or varied values, the Administrator API uses method arguments.
Page 72
CONFIGURING AND ADMINISTERING COLDFUSION 10 Using the ColdFusion Administrator <cfscript> // Login is always required. This example uses two lines of code. adminObj = createObject("component","cfide.adminapi.administrator"); adminObj.login("admin"); // Instantiate the data source object. myObj = createObject("component","cfide.adminapi.datasource"); // Create a DSN. myObj.setMSSQL(driver="MSSQLServer", name="northwind_MSSQL", host = "xx.x.xxx.xx", port = "1433",...
Page 73
CONFIGURING AND ADMINISTERING COLDFUSION 10 Using the ColdFusion Administrator <cfscript> // Login is always required. This example uses a single line of code. createObject("component","cfide.adminapi.administrator").login("admin"); // Instantiate the data source object. myObj = createObject("component","cfide.adminapi.datasource"); // Required arguments for a data source. stDSN = structNew();...
A data source is a complete database configuration that uses a JDBC driver to communicate with a specific database. In Adobe ColdFusion, you configure a data source for each database that you want to use. After you configure a data source, ColdFusion can then communicate with that data source through JDBC.
“Connecting to Sybase” on page 91 To see a list of database versions that ColdFusion supports, go to www.adobe.com/go/learn_cfu_cfsysreqs_en. When running in the J2EE configuration, the ColdFusion Administrator also lets you configure a data source that connects to a JNDI data source. A Java Naming and Directory Interface (JNDI) data source is equivalent to a ColdFusion data source, except you define it by using your J2EE application server.
CONFIGURING AND ADMINISTERING COLDFUSION 10 Data Source Management Adding data sources in the Administrator You use the ColdFusion Administrator to quickly add a data source for use in your ColdFusion applications. When you add a data source, you assign it a data source name (DSN) and set all information required to establish a connection.
CONFIGURING AND ADMINISTERING COLDFUSION 10 Data Source Management • Data source names can contain only letters, numbers, hyphens, and the underscore character (_). • Data source names must not contain special characters or spaces. • Although data source names are not case sensitive, use a consistent capitalization scheme. •...
CONFIGURING AND ADMINISTERING COLDFUSION 10 Data Source Management Setting Description CLOB Returns the entire contents of any CLOB/ Text columns in the database for this data source. If deselected, ColdFusion retrieves the number of characters specified in the Long Text Buffer setting. For UDB 7.1 and 7.2, a 32K limit on CLOBs exists.
For information on defining data sources that work with DB2 for OS/390 or iSeries, see “Connecting to other data sources” on page 89. To see a list of DB2 versions that ColdFusion supports, go to www.adobe.com/go/learn_cfu_cfsysreqs_en. Note: DB2 Universal Database (UDB) refers to all versions of DB2 running on Windows, UNIX, and Linux/s390 platforms.
Enable connection Check if to validate the connection. validation Connecting to Informix To see a list of Informix versions that ColdFusion supports, go to www.adobe.com/go/learn_cfu_cfsysreqs_en. Use the settings in the following table to connect ColdFusion to Informix data sources: Setting Description CF Data Source Name The data source name (DSN) that ColdFusion uses to connect to the data source.
Page 81
CONFIGURING AND ADMINISTERING COLDFUSION 10 Data Source Management Setting Description User name The user name that ColdFusion passes to the JDBC driver to connect to the data source if a ColdFusion application does not supply a user name (for example, in a cfquery tag).
CONFIGURING AND ADMINISTERING COLDFUSION 10 Data Source Management Connecting to Microsoft Access Use the settings in the following table to connect ColdFusion to Microsoft Access data sources: Setting Description CF Data Source Name The data source name (DSN) used by ColdFusion to connect to the data source. Database File The file that contains the database.
CONFIGURING AND ADMINISTERING COLDFUSION 10 Data Source Management Setting Description BLOB Buffer The default buffer size, used if the BLOB option is not selected. The default value is 64000 bytes. Allowed SQL The SQL operations that can interact with the current data source. Validation query Called when a connection from the pool is resued.
Note: This driver uses the Microsoft Jet list of reserved words, including the word Last. For a complete list, see http://support.microsoft.com/?kbid=248738. Connecting to Microsoft SQL Server To see a list of SQL Server versions that ColdFusion supports, go to www.adobe.com/go/learn_cfu_cfsysreqs_en. Use the settings in the following table to connect ColdFusion to SQL Server: Setting...
Page 85
CONFIGURING AND ADMINISTERING COLDFUSION 10 Data Source Management Setting Description Max Pooled Statements Enables reuse of prepared statements (that is, stored procedures and queries that use the cfqueryparam tag). Although you tune this setting based on your application, start by setting it to the sum of the following: •...
Page 86
CONFIGURING AND ADMINISTERING COLDFUSION 10 Data Source Management Ensure that the database server is using mixed authentication. While in Enterprise Manager, right-click the server, select Properties > Security and then select the Security tab. Ensure that the SQL Server and Windows options are clicked.
Data Source Management Connecting to MySQL To see a list of MySQL versions that ColdFusion supports, go to www.adobe.com/go/learn_cfu_cfsysreqs_en. Note: By default, queries to MySQL data sources return isCaseSensitive = NO for each column in the return structure from the function.
CONFIGURING AND ADMINISTERING COLDFUSION 10 Data Source Management Setting Description CLOB Select to return the entire contents of any CLOB/ Text columns in the database for this data source. If not selected, ColdFusion retrieves the number of characters specified in the Long Text Buffer setting. BLOB Select to return the entire contents of any BLOB/ Image columns in the database for this data source.
CONFIGURING AND ADMINISTERING COLDFUSION 10 Data Source Management A new admin API method, has been added, which lets you create a MySQL DataDirect data source. setMySQL_DD New querytimeout connection option As part of the DataDirect upgrade, the option has been added in the Advanced Settings panel of the querytimeout Edit DSN page.
Page 90
CONFIGURING AND ADMINISTERING COLDFUSION 10 Data Source Management Property Relevance Description Applies to TrustStore Ignored if The directory of the truststore file DB2, Microsoft SQL ValidateServerCertificate=false Server, Oracle, Sybase TrustStorePassword Ignored if The password to access the truststore file DB2, Microsoft SQL Server, Oracle, Sybase ValidateServerCertificate=false ValidateServerCertifi...
CONFIGURING AND ADMINISTERING COLDFUSION 10 Data Source Management Database Database Driver Connection Property DB2 Universal EncryptionMethod=SSL; KeyStore=path to keystore; KeyStorePassword=keystore Database Password; KeyPassword=key Password; TrustStore=path to keystore; TrustStorePassword=trustStorePassword; ValidateServerCertificate=true|false; HostNameInCertificate=host_name|#SERVERNAME#}; Microsoft SQL Microsoft SQL EncryptionMethod=SSL; TrustStore=path to keystore; Server Server TrustStorePassword=trustStorePassword;...
Connecting to Oracle To see a list of Oracle versions that ColdFusion supports, go to www.adobe.com/go/learn_cfu_cfsysreqs_en. Use the settings in the following table to connect ColdFusion to Oracle data sources: Last updated 7/9/2012...
Page 93
CONFIGURING AND ADMINISTERING COLDFUSION 10 Data Source Management Setting Description CF Data Source Name The data source name (DSN) that ColdFusion uses to connect to the data source. SID Name The Oracle System Identifier (SID) that refers to the instance of the Oracle database software running on the server.
CONFIGURING AND ADMINISTERING COLDFUSION 10 Data Source Management Setting Description Client Hostname The host name from where the query is executed. Client Username The user name if the user is logged in using the <cflogin> tag. Application Name The application name specified in the application.cfc. Prefix If specified, the value is prefixed with the application name specified in application.cfc.
“Connecting to DB2 Universal Database” on page 74. Connecting to PostgreSQL To see a list of PostgreSQL versions that ColdFusion supports, go to www.adobe.com. Use the settings in the following table to connect ColdFusion to PostgreSQL data sources: Setting Description CF Data Source Name The data source name (DSN) that ColdFusion uses to connect to the data source.
Connecting to Sybase To see a list of Sybase versions that ColdFusion supports, go to www.adobe.com/go/learn_cfu_cfsysreqs_en. Use the settings in the following table to connect ColdFusion to Sybase data sources: Last updated 7/9/2012...
Page 97
CONFIGURING AND ADMINISTERING COLDFUSION 10 Data Source Management Setting Description CF Data Source Name The data source name (DSN) that ColdFusion uses to connect to the data source. Database The database to which this data source connects. Server The name of the server that hosts the database that you want to use. If the database is local, enclose the word local in parentheses.
CONFIGURING AND ADMINISTERING COLDFUSION 10 Data Source Management Setting Description BLOB Buffer The default buffer size; used if the BLOB option is not selected. The default value is 64000 bytes. Allowed SQL The SQL operations that can interact with the current data source. Validation query Called when a connection from the pool is resued.
CONFIGURING AND ADMINISTERING COLDFUSION 10 Data Source Management Connecting to an external JDBC Type 4 data source To use a JDBC driver that is not included with ColdFusion (such as SQLAnywhere) configure the JDBC driver and add a data source for it. Connect to an external JDBC data source: Copy the database driver .jar file to one of the following directories: •...
Chapter 5: Web Server Management You can connect Adobe ColdFusion to the built-in web server and to external web servers, such as Apache, IIS, and Sun ONE Web Server (formerly known as iPlanet). About web servers in ColdFusion The web server is a critical component in your ColdFusion environment, and understanding how ColdFusion interacts with web servers can help you administer your site.
CONFIGURING AND ADMINISTERING COLDFUSION 10 Web Server Management Keep in mind the following when using the built-in web server: • Whenever possible, configure your external web server as part of the ColdFusion installation, except for the two cases mentioned previously (coexistence with a previous ColdFusion version, and when the computer has no web server).
Page 102
CONFIGURING AND ADMINISTERING COLDFUSION 10 Web Server Management Web server Connector details Apache The Web Server Configuration Tool adds the following elements to the Apache httpd.conf file: • A LoadModule directive defines the connector. • An AddHandler directive tells Apache to route requests for ColdFusion pages through the connector. For Apache 2.x, the connection module is mod_jk.so.
Run the Web Server Configuration Tool in GUI mode Open a console window. Note: In Windows, to start the Web Server Configuration Tool, select Start > Programs > Adobe > ColdFusion 10 > Web Server Configuration Tool. Change to the cf_root/cfusion/runtime/bin.
Page 104
CONFIGURING AND ADMINISTERING COLDFUSION 10 Web Server Management Option Description Specifies the web server, as follows: • • Apache • SunOne The web server name you supply is not case sensitive. -dir Specifies the path to the configuration directory (SunONE config). Specifies the IIS website name (case-sensitive).
CONFIGURING AND ADMINISTERING COLDFUSION 10 Web Server Management Configure all existing IIS sites (ISPs): cf_root/runtime/bin/wsconfig.exe -ws iis -site 0 -v Configure Apache on UNIX #1: cf_root/runtime/bin/wsconfig -ws Apache -bin /opt/apache2/bin/httpd -script /opt/apache2/bin/apachectl -dir /opt/apache2/conf -v Configure Apache on UNIX #2: cf_root/runtime/bin/wsconfig -ws Apache-bin /usr/bin/httpd -script /usr/bin/httpd -dir /etc/httpd/conf -coldfusion -v Configure Apache in Windows:...
Page 106
CONFIGURING AND ADMINISTERING COLDFUSION 10 Web Server Management # # Load mod_jk module LoadModule jk_module "CF_install\config\wsconfig\1\mod_jk.so" # Where to find workers.properties JkWorkersFile "CF_install\config\wsconfig\1\workers.properties" JkMountFile "CF_install\config\wsconfig\1\uriworkermap.properties" # Where to put jk logs JkLogFile "CF_install\config\wsconfig\1\mod_jk.log" # Where to put jk shared memory JkShmFile "CF_install\config\wsconfig\1\jk_shm"...
Page 108
CONFIGURING AND ADMINISTERING COLDFUSION 10 Web Server Management Note: You use web-server-specific methods to create separate virtual websites for each use. Multihoming configuration tasks include: If any of the applications under a virtual host need to access the Enabling access to the ColdFusion Administrator ColdFusion Administrator, create a web server mapping (Alias directive in Apache) for /CFIDE that points to the original CFIDE directory.
Page 110
CONFIGURING AND ADMINISTERING COLDFUSION 10 Web Server Management Run the Web Server Configuration Tool, as follows: • GUI - Specify Sun ONE for the web server, specify the directory that contains the obj.conf and magnus.conf files, and select the Configure Web Server for ColdFusion Applications check box. •...
Chapter 6: Deploying ColdFusion Applications Adobe ColdFusion includes archive and deployment options that let you package applications and create archive files. Archive and deployment options ColdFusion includes the following archive and deployment options. You can package your ColdFusion application’s pages, data sources, and settings in a ColdFusion archive files ColdFusion Archive (CAR) file.
CONFIGURING AND ADMINISTERING COLDFUSION 10 Deploying ColdFusion Applications Packaging applications in J2EE archive files When running ColdFusion in the J2EE configuration, you deploy the ColdFusion application, in enterprise application archive (EAR) or web application archive (WAR) format, on a J2EE application server. You then create your ColdFusion application, configuring resources (such as data sources), and storing CFM, CFC, and CFR files in the web application root or in the web server root.
CONFIGURING AND ADMINISTERING COLDFUSION 10 Deploying ColdFusion Applications Deployment considerations After the archive file is created, you deploy by using standard ColdFusion J2EE configuration deployment techniques. For more information, see Installing an EAR file or WAR files in Installing the J2EE Configuration of Installing ColdFusion.
Page 114
CONFIGURING AND ADMINISTERING COLDFUSION 10 Deploying ColdFusion Applications Sourceless distribution You can use the utility with the - option to create ColdFusion pages (CFM, CFC, and CFR files) cfcompile deploy that contain Java bytecode. You can then deploy the bytecode versions of the ColdFusion pages instead of the original CFML source code.
Chapter 7: Administering Security You can secure many Adobe ColdFusion resources using password authentication and configure sandbox security. About ColdFusion security Security is especially important in web-based applications, such as those you develop in ColdFusion. ColdFusion developers and administrators must fully understand the security risks that could affect their development and runtime environments so they can enable and restrict access appropriately.
8-500 characters. Click Submit Changes. Note: When you modify the seed value, all data source connections are reset. Therefore, Adobe recommends that you perform this task when the server is idle or at the initial phase (after installation).
CONFIGURING AND ADMINISTERING COLDFUSION 10 Administering Security Enhancing ColdFusion Security on Windows To enhance security for the ColdFusion server on Windows, restrict access to the following files to selected ColdFusion users: • /cfusion/lib/seed.properties • /cfusion/lib/password.properties • /cfusion/lib/license.properties • /cfusion/bin/passwordreset.bat • /cfusion/bin/cf-passwordreset.jar Exposing services to users ColdFusion exposes many existing enterprise services as web services.
CONFIGURING AND ADMINISTERING COLDFUSION 10 Administering Security Restricting access to ColdFusion Administrator You can restrict access to ColdFusion Administrator. Note: By default, localhost and all IP addresses can access ColdFusion server. To add IP addresses that must be allowed access: Go to Security >...
CONFIGURING AND ADMINISTERING COLDFUSION 10 Administering Security Administrator Settings Path Default Admin Secure Profile Changes to the Profile setting post migration to ColdFusion 10 Enable WebSocket Server Server Settings > Enabled Disabled WebSocket Start Flash Policy Server Server Settings > Enabled Disabled WebSocket...
CONFIGURING AND ADMINISTERING COLDFUSION 10 Administering Security Note: Sandbox security is not enabled by default. You enable it on the Security > Sandbox Security page before ColdFusion enforces the settings. Using multiple sandboxes (Enterprise Edition only) By default, a subdirectory of a sandbox inherits the settings of the directory one level above it. However, if you define a sandbox for a subdirectory, the subdirectory no longer inherits settings from the parent, completely overriding the parent directory’s sandbox settings.
Page 121
CONFIGURING AND ADMINISTERING COLDFUSION 10 Administering Security You can also specify the actions that ColdFusion tags and functions can perform on files and directories outside the sandbox. The following table shows the relationship between the permissions of a file and a directory: Permission Effect on files Effect on directories...
Page 122
CONFIGURING AND ADMINISTERING COLDFUSION 10 Administering Security Click the CFFunctions tab. To disable functions, in the left column of the CFFunctions tab, highlight the functions, and click the right arrow. By default, ColdFusion pages in this sandbox can access all listed functions. Click the Files/Dirs tab.
Page 123
Also, read permission must be granted to cf_root\lib\ehcache.xml for certain functions that read from/write to ehCache.xml to work. For example, cacheGetProperties cacheSetProperties Using Service CFCs within Sandbox Grant the following permissions: • execute permission to cf_root\CustomTags\com\adobe\coldfusion • read permission to cf_root\WEB-INF\cftags\META_INF\taglib.tld Last updated 7/9/2012...
Chapter 8: Using Multiple Server Instances Instead of JRun, Tomcat is embedded with a stand-alone ColdFusion 10 installation. Previous versions of ColdFusion installer allow you to create multi-server installations whereas ColdFusion 10 installer lets you only install stand-alone installation. After installing ColdFusion in stand-alone mode, you can create multiple instances and clusters, provided you have an Enterprise or Developer license.
CONFIGURING AND ADMINISTERING COLDFUSION 10 Using Multiple Server Instances (Optional) Check Create Windows Service. Click Submit. In the Instance Manager, start, stop, restart, delete, access website, or access administrator. Click the Edit icon to edit the instance manager. Edit the internal webserver port and load balancing factor. Load balancing factor represents the load the instance takes up.
Page 126
CONFIGURING AND ADMINISTERING COLDFUSION 10 Using Multiple Server Instances Use multiple server instances for application isolation Create a separate server instance by using the instructions in “Defining additional server instances” on page 119. If you are using the built-in web server, proceed to step 6 in this procedure. Using your web-server-specific method, create a virtual website (or separate website) for the application.
CONFIGURING AND ADMINISTERING COLDFUSION 10 Using Multiple Server Instances Configure Apache virtual hosts. , add . For example, workers.properties cf-root\config\wsconfig\1 server1 workers.list worker.list=cfusion,server1 Add the following block: worker.server1.type=ajp13 worker.server1.host=localhost worker.server1.port=8014 Note: The port is the AJP port for server1 and that can be found in server1.server.xml in the cf_root\server1\runtime\conf\server.xml.
Page 128
CONFIGURING AND ADMINISTERING COLDFUSION 10 Using Multiple Server Instances Note: When a cluster uses session replication, session data is copied to other servers in the cluster each time it is modified. This can degrade performance if you store a significant amount of information in session scope. If you plan to store a significant amount of information in session scope, consider storing this information in client variables saved in a database.
Page 130
CONFIGURING AND ADMINISTERING COLDFUSION 10 Using Multiple Server Instances Instance name is a string that is used to identify the instance. Remote port and HTTP port are displayed in the Instance Manager page. These ports are provided in the file available in the folder of server.xml runtime\conf...
Chapter 9: Using the ColdFusion Server Monitor The ColdFusion Server Monitor 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.
Previously, this file was placed under <webroot>/CFIDE/multiservermonitor-access-policy.xml. For more information, see www.adobe.com/devnet/flashplayer/articles/fplayer9_security.html By default, server monitoring is turned off. To start and stop monitoring, profiling, and memory tracking, click the corresponding buttons in the top bar of the Server Monitor. The following table indicates what data the Server Monitor...
Page 133
CONFIGURING AND ADMINISTERING COLDFUSION 10 Using the ColdFusion Server Monitor Turning on or off monitoring, profiling, and memory tracking determines which data the Server Monitor gathers. For example, all the query reports require that you turn on profiling. The performance effect of turning on monitoring and profiling is minimal;...
Page 134
CONFIGURING AND ADMINISTERING COLDFUSION 10 Using the ColdFusion Server Monitor Active Requests The Active Requests report lists all currently active requests that take longer to load than the request interval for reports specified in the Refresh Interval setting. Requests include browser requests, CFC HTTP requests, web services, gateways, and Flash remoting.
CONFIGURING AND ADMINISTERING COLDFUSION 10 Using the ColdFusion Server Monitor be compiled before being placed in the cache. A server that is performing well should have more cache hits than misses, which is a high cache-hit ratio. If the cache-hit ratio is too low, you might want to increase the cache size by selecting Server Settings >...
Page 136
CONFIGURING AND ADMINISTERING COLDFUSION 10 Using the ColdFusion Server Monitor Application Scope Memory Usage The Application Scope Memory Usage report lists the application scopes that use the most memory. The detail lists the application scope variables that use the most memory. Server Scope Memory Usage The Server Scope Memory Usage page lists the server scope variables that use the most memory.
CONFIGURING AND ADMINISTERING COLDFUSION 10 Using the ColdFusion Server Monitor Requests with Errors The Requests with Errors report lists the templates that generate an error. The report includes the path of the template, and the number of times errors occurred in that template. For the most recent error, the report indicates the time of the error, the error message, CFML stack traces, and Java stack traces.
CONFIGURING AND ADMINISTERING COLDFUSION 10 Using the ColdFusion Server Monitor • The threshold for either an unresponsive server or a slow server is exceeded When you click Trigger Snapshot, the Server Monitor collects the information for the snapshot and saves it in a file named snapshot_usrgen_timestamp.txt in the cf_root/logs/snapshots folder.
CONFIGURING AND ADMINISTERING COLDFUSION 10 Using the ColdFusion Server Monitor Call the administrator.cfc method, passing the ColdFusion Administrator password or the RDS password: login adminObj.login("admin"); Instantiate the Server Monitor CFC: myObj = createObject("component","cfide.adminapi.servermonitoring"); Call the CFC method you want (this example uses getAverageResponseTime myObj.getAverageResponseTime();...
Page 140
CONFIGURING AND ADMINISTERING COLDFUSION 10 Using the ColdFusion Server Monitor JVM memory usage Because ColdFusion is an enterprise Java application, the Java Virtual Machine (JVM) is the software component that most influences performance. Different JVMs from different vendors and different versions of the same JVM from the same vendor have different performance characteristics.
Page 141
CONFIGURING AND ADMINISTERING COLDFUSION 10 Using the ColdFusion Server Monitor Variable memory usage Configure client variable storage to use cookies or an RDBMS for best performance when using client variables; you do this on the Client Variables page of the ColdFusion Administrator. Wherever possible, it is best to fully scope your variable names, especially when using the function.
CONFIGURING AND ADMINISTERING COLDFUSION 10 Using the ColdFusion Server Monitor Setting up Server Manager client Server Manager is an AIR-based desktop application that allows you to centrally manage multiple ColdFusion servers from one location. From the Server Monitoring page, you can download and install the Server Manager client AIR application.
Page 143
CONFIGURING AND ADMINISTERING COLDFUSION 10 Using the ColdFusion Server Monitor cf_root/WEB-INF/cfusion/lib (in the J2EE configuration). You can specify the following configurations in the XML file: • Port • MaxThreads • Logging For connections using HTTPS protocol Open jetty.xml. Remove or comment out the Set Connectors section: <Call name="addConnector">...
Page 144
CONFIGURING AND ADMINISTERING COLDFUSION 10 Using the ColdFusion Server Monitor Description setMonitoringServerPort(port); Sets the port information for the monitoring server. getMonitoringServerPort(); Gets details of the port to which the monitoring server listens. getMonitoringServerProtocol(); Gets the protocol details for the monitoring server. enableMonitoringServer();...
Chapter 10: Working with Server Manager Adobe ColdFusion Server Manager is an Adobe AIR application packaged with ColdFusion installation. It enables ColdFusion Server administrators to monitor and manage multiple servers and apply the settings from one ColdFusion server to other ColdFusion servers.
Page 146
CONFIGURING AND ADMINISTERING COLDFUSION 10 Working with Server Manager Note: The Server Manager AIR application supports only ColdFusion instances. To register a ColdFusion server: Click the (+) sign in the right-pane of the Server Manager. Enter the server details including the server name, host name/IP address, port number, context root (for J2EE servers), and its user name and password.
Page 147
CONFIGURING AND ADMINISTERING COLDFUSION 10 Working with Server Manager For details on the WAR files corresponding to each application server and the parameters required to run start/stop operations, see: • Stand-alone server (Tomcat) parameters • WebLogic Server-specific parameters • WebSphere-specific parameters •...
Page 148
CONFIGURING AND ADMINISTERING COLDFUSION 10 Working with Server Manager Do the following in the local host from where you add remote instance: Copy the file created in the remote host to any of the locations. .cer Import the certificate. <CF_installation>\jre\bin\keytool.exe -importcert -keystore "<CF_installation>\jre\lib\security\cacerts"...
Page 149
CONFIGURING AND ADMINISTERING COLDFUSION 10 Working with Server Manager • Server: ColdFusion remote instance name. • ColdFusion Version: For ColdFusion, 10. • Admin Server Port: Default https port is 8985. Port of the Jetty server. • Context Root: Value is AdminServlet Click Apply.
Page 150
CONFIGURING AND ADMINISTERING COLDFUSION 10 Working with Server Manager <application-policy name = "jmx-console"> <authentication> <login-module code="org.jboss.security.auth.spi.UsersRolesLoginModule" flag = "required"> <module-option name="usersProperties">props/jmx-console- users.properties</module-option> <module-option name="rolesProperties">props/jmx-console- roles.properties</module-option> </login-module> </authentication> </application-policy> The files must contain props/jmx-console-users.properties props/jmx-console-roles.properties the entries in the following format: /jmx-console-users.properties: Format: {username}={password} /jmx-console-roles.properties...
CONFIGURING AND ADMINISTERING COLDFUSION 10 Working with Server Manager Create Groups Using the Server Manager, you can create groups and associate a registered or new server to one or more groups. To create groups and associate servers to groups: Click Groups > Add from the Groups menu. In the Add Group dialog box, enter the name of the new group and click Apply.
Page 152
CONFIGURING AND ADMINISTERING COLDFUSION 10 Working with Server Manager Settings Actions Datasources • Add a datasource by right-clicking the Datasources setting in the left pane. • Edit an existing datasource by right-clicking the datasource in the left pane. • Remove an existing datasource by right-clicking the datasource in the left pane. •...
CONFIGURING AND ADMINISTERING COLDFUSION 10 Working with Server Manager After the task is completed, you can save the cache log by clicking the Save Snapshot icon or remove it by clicking Remove. Apply hot fix You can update multiple ColdFusion Server instances, once they are registered with Server Manager. Note: After applying a hotfix, restart the server for the hotfix to take effect.
Page 154
CONFIGURING AND ADMINISTERING COLDFUSION 10 Working with Server Manager Following views are available with Server Manager: • Quick View: Displays a quick snapshot of server online time, alerts, warnings, and log in status. • Detail View: Displays an elaborate server status with details about the type of alerts and the request/response time. To view server details, expand the server row by clicking the green arrow in the right corner of that row.
Chapter 11: Basic Troubleshooting and FAQs Basic troubleshooting overview You can perform some tests to avoid experiencing trouble as you begin your work with ColdFusion. Verify the following: • Web server is running: Before you install ColdFusion, ensure that your web server is installed and running. You can do this by loading a page in your web browser using the HTTP protocol.
CONFIGURING AND ADMINISTERING COLDFUSION 10 Basic Troubleshooting and FAQs http://hostname/CFIDE/Administrator/index.cfm where, hostname is the name of the server on which ColdFusion resides. If you are using the internal web server, specify hostname :8500 Note: On UNIX, the ColdFusion Administrator URL is case-sensitive. Ensure that you enter the address as shown. Press Enter.
Page 157
CONFIGURING AND ADMINISTERING COLDFUSION 10 Basic Troubleshooting and FAQs When the program completes, restart your computer. ColdFusion is removed from your server. Remove ColdFusion patches from ColdFusion Administrator Log in to ColdFusion Administrator. Go to Server Updates > Updates > Installed Updates. To begin uninstalling the latest patch, click the Uninstall button.
Page 158
CONFIGURING AND ADMINISTERING COLDFUSION 10 Basic Troubleshooting and FAQs During installation, you typically start ColdFusion services and processes, and configure them to start and run whenever you start your system. After you perform any of the following actions in the ColdFusion Administrator, stop and restart ColdFusion services: •...
Page 159
CONFIGURING AND ADMINISTERING COLDFUSION 10 Basic Troubleshooting and FAQs • Number of running requests • Number of timed out requests To use performance monitoring, Select the Enable Performance Monitoring option on the Debug Output Settings page. For quick details, see Enable performance monitoring.
Page 160
CONFIGURING AND ADMINISTERING COLDFUSION 10 Basic Troubleshooting and FAQs To see a detailed status of all the servers you are monitoring, click Detailed View. The detailed view lists each server. To see details about a server in the list, highlight it. The details appear at the bottom of the page.To see information about any server errors, click Errors.
Page 161
CONFIGURING AND ADMINISTERING COLDFUSION 10 Basic Troubleshooting and FAQs How will I manage undevlivered mails? You can view a list of undelivered mails in the Server Settings > Mail > Undelivered Mail page. To access this page and manage your undelivered mails: Click the View Undelivered Mail button from the Server Settings >...
Page 162
Basic Troubleshooting and FAQs Area Description ThreadID Identifies the thread identification number for the event. This string is used by Adobe Technical Support personnel to track and troubleshoot problems. Application Name If applicable, shows the name of the application. Log Message Describes the error that occurred.