Other product names, logos, designs, titles, words, or phrases mentioned within this publication may be trademarks, service marks, or trade names of Macromedia, Inc. or other entities and may be registered in certain jurisdictions including internationally.
Configuring and Administering ColdFusion MX is intended for anyone who needs to configure and manage their ColdFusion development environment. About Macromedia ColdFusion MX 7 documentation The ColdFusion MX 7 documentation is designed to provide support for the complete spectrum of participants.
Document Format (PDF) files. Go to the documentation home page for ColdFusion MX on the Macromedia website: www.macromedia.com. In addition, you can view the documentation in LiveDocs, which lets you add comments to pages and view the latest comments added by Macromedia, by going to www.macromedia.com/go/livedocs_cfmx7docs.
PART I Administering ColdFusion MX 7 This part describes how to manage the ColdFusion environment, including using the ColdFusion MX Administrator, connecting to your data sources, managing your web server, deploying your applications, and configuring security for your applications. The following chapters are included: Chapter 1: Administering ColdFusion MX .
CHAPTER 1 Administering ColdFusion MX This chapter presents an overview of Macromedia ColdFusion MX 7 configuration and administration tasks. Although you perform most ColdFusion MX administration tasks using the ColdFusion MX Administrator, you also manage databases, web server configurations, and the Verity Search Server.
If your ColdFusion MX Administrator is on a remote computer, use the Domain Name Services (DNS) name or Internet Protocol (IP) address of the remote host. To access the ColdFusion MX Administrator, enter the password specified when you installed ColdFusion MX. Tip: If you are running in a multihomed environment and have problems displaying the ColdFusion MX Administrator, see Chapter 4, “Web Server Management,”...
CHAPTER 2 Using the ColdFusion MX Administrator This chapter explains the basic administration tasks, following the structure of the Macromedia ColdFusion MX Administrator sections. It also includes a brief description of each Administrator screen and a discussion of performing Administrator functionality programmatically through the Administrator application programming interface (API).
Initial administration tasks Immediately after you install ColdFusion MX, you might have to perform some or all of the administrative tasks described in the following table: Task Description Establish database ColdFusion applications require data source connections to query and connections write to databases.
Tech notes Click the Tech Notes link to access the collection of articles about ColdFusion MX from the Macromedia website (www.macromedia.com). Server Settings section The Server Settings section lets you manage client and memory variables, mappings, charting, and archiving.
Option Description Enable HTTP status codes Select this option to configure ColdFusion MX to set a status code of 500 Internal Server Error for an unhandled error. Disable this option to configure ColdFusion MX to set a status code of 200 OK for everything, including unhandled errors.
• In the operating system registry Caution: Macromedia recommends that you do not store client variables in the registry because it can critically degrade performance of the server. If you do use the registry to store client variables, you must allocate sufficient memory and disk space.
The following table compares the client variable storage options: Storage type Advantages Disadvantages Data source • Can use existing data source • Requires database transaction to read/write variables • Portable: not tied to the host system or operating system • More complex to implement Browser cookies •...
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> <cfquery name="data2" datasource="#DSN#"> CREATE UNIQUE INDEX id1 ON CDATA (cfid,app) </cfquery>...
You can also specify whether to use J2EE session variables. When you enable the J2EE session variables, ColdFusion creates an identifier for each session and does not use the CFToken or CFID cookie value. For more information, see ColdFusion MX Developer’s Guide. Note: When using J2EE sessions, ensure that the session timeout, specified in the WEB-INF/web.xml element is longer than the session timeout that you specify in...
Mail Server Settings area The following table describes basic mail server settings: Option Description Mail Server Enter a valid mail server for sending dynamic SMTP mail messages in the text box. You can enter an Internet address, such as mail.company.com, or the IP address of the mail server, such as 127.0.0.1.
Option Description Spool mail messages for Select this option to route outgoing mail messages to the mail spooler. If delivery you disable this option, ColdFusion MX delivers outgoing mail messages immediately. In ColdFusion MX Enterprise Edition, you can spool (Memory spooling messages to disk (slower, but messages persist across shutdowns) or to available for Enterprise memory (faster, but messages do not persist).
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 Macromedia FlashPaper and Acrobat PDF output formats. ColdFusion generates FlashPaper and PDF output through the tag and through the...
Java and JVM Settings page The Java and JVM Settings page lets you specify the following settings, which enable ColdFusion MX to work with Java: Option Description Java Virtual Machine The absolute file path to the location of the Java virtual machine (JVM) Path root directory.
The Data & Services section contains the following pages: • Data Sources page • Verity Collections page • Verity K2 Server page • Web Services page Data Sources page The Data Sources page lets you create, edit, and delete JDBC data sources. Before you can use a database in a ColdFusion application, you must register the data source in the ColdFusion MX Administrator.
Verity K2 Server page You can install Verity on a different host computer from the one ColdFusion MX is running on. If this is the case, you can configure the host that ColdFusion will use when it performs search operations. If you have purchased the Verity product, you may need to use advanced settings to configure the aliases and ports of the services that ColdFusion uses.
The Debugging Settings page provides the following debugging options: Option Description Enable Robust Exception Displays detailed information in the exceptions page, including Information the template’s physical path and URI, the line number and snippet, the SQL statement used (if any), the data source name (if any), and the Java stack trace.
Using the cfstat utility command-line utility provides real-time performance metrics for ColdFusion MX. cfstat Using a socket connection to obtain metric data, the utility displays the information that cfstat ColdFusion MX writes to the System Monitor without actually using the System Monitor application.
Before you use the utility, ensure that you selected the Enable Performance Monitoring cfstat check box in the ColdFusion MX Administrator (on the Debugging & Logging > Debugging Settings page). If you select this check box, you must restart ColdFusion MX for this change to take effect.
Logging Settings page You use the Logging Settings page of the Administrator to change ColdFusion MX logging options. The following table describes the settings: Option Description Log directory* Specifies the directory to which error log files are written. Maximum file size Sets the maximum file size for log files.
Records messages sent by ColdFusion MX. flash.log Records entries for Macromedia Flash Remoting. Scheduled Tasks page You use the Scheduled Tasks page to schedule the execution of local and remote web pages, to generate static HTML pages, send mail with the...
System probes are available in ColdFusion MX Enterprise Edition only. Code Compatibility Analyzer page The Code Compatibility Analyzer page evaluates your ColdFusion pages for potential incompatibilities between ColdFusion MX 7 and ColdFusion Server 5. It reviews the CFML pages that you specify and informs you of any potential compatibility issues. Additionally, the Code Compatibility Analyzer detects unsupported and deprecated CFML features, and outlines the required implementation changes that ensure a smooth migration License Scanner page...
CFX Tags page Before you can use a CFX tag in ColdFusion applications, you must register it. You use the CFX Tags page to register and manage ColdFusion custom tags built with C++ and Java. You can build CFX tags in the following two ways: •...
ColdFusion includes the vbjorb.properties file, which contains the following properties that configure the ORB: org.omg.CORBA.ORBClass=com.inprise.vbroker.orb.ORB org.omg.CORBA.ORBSingletonClass=com.inprise.vbroker.orb.ORB SVCnameroot=namingroot Event Gateways section The Event Gateways section of the Administrator lets you configure event gateway settings, gateway types, and gateway instances. This Event Gateways section contains the following pages: •...
Gateway type Description XMPP Used to send and receive instant messages through the Extensible Messaging and Presence Protocol (XMPP). Samples Sample gateway types, including the following: • DirectoryWatcher Watches a directory for file changes. • JMS Acts as a Java Messaging Service consumer or producer. •...
RDS Password page You use the RDS Password page to enable and disable password-restricted RDS access to server resources from Macromedia Dreamweaver MX, Macromedia HomeSite+, or the ColdFusion Report Builder, and to change the RDS password. Sandbox Security page You use the Sandbox Security page (called Resource Security in the Standard Edition) to specify security permissions for data sources, tags, functions, files, and directories.
EAR or WAR file. Enterprise Manager section The Enterprise Manager section of the Administrator lets you create Macromedia JRun server instances with ColdFusion already deployed, register remote JRun server instances, and create clusters of JRun server instances.
Instance Manager page The Instance Manager page lets you view the local and remote JRun servers that can be accessed by a cfusion server running in the multiserver configuration. From this page you can access pages that define new, local, JRun servers and register existing JRun servers running on remote computers, as follows: Add New Instance Create a new JRun server and automatically deploy a copy of the current...
Administrator API You can perform most ColdFusion MX Administrator tasks programmatically using the Administrator API. 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.
To use the Administrator API: Instantiate administrator.cfc: <cfscript> // Login is always required. adminObj = createObject("component","cfide.adminapi.administrator"); Tip: You can instantiate administrator.cfc and call the method in a single line of code, as the login following example shows: createObject("component","cfide.adminapi.administrator").login("admin"); Call the administrator.cfc method, passing the ColdFusion MX Administrator password login or the RDS password:...
storedProc = true, alter = false, grant = true, select = true, update = true, create = true, delete = true, drop = false, revoke = false ); </cfscript> The following example adds the same SQL Server data source, but uses the argumentCollection attribute to pass all method arguments in a structure: <cfscript>...
//Create a DSN. myObj.setMSSQL(argumentCollection=stDSN); </cfscript> <!--- Optionally dump the stDSN structure. ---> <!--- <cfoutput> <cfdump var="#stDSN#"> </cfoutput> ---> Chapter 2: Using the ColdFusion MX Administrator...
A data source is a complete database configuration that uses a JDBC driver to communicate with a specific database. In Macromedia ColdFusion MX 7, you must 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.
Disadvantages The ODBC driver, and possibly the client database libraries, must reside on the ColdFusion server computer. Performance is slower than other JDBC driver types. Macromedia does not recommend this driver type unless your application requires DBMS-specific features. Native-API/partly Converts JDBC calls to database-specific calls.
“Connecting to Sybase” on page 62 To see a list of database versions that ColdFusion MX supports, go to www.macromedia.com/go/sysreqscf. When running in the J2EE configuration, the ColdFusion MX 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 using your J2EE application server.
Adding data sources in the Administrator You use the ColdFusion MX Administrator to quickly add a data source for use in your ColdFusion applications. When you add a data source, you assign it a data source name (DSN) and set all information required to establish a connection. Note: ColdFusion MX includes data sources that are configured by default.
OS/390 or iSeries, see “Connecting to other data sources” on page 60. To see a list of DB2 versions that ColdFusion MX supports, go to www.macromedia.com/go/sysreqscf. Note: DB2 UDB refers to all versions of DB2 running on Windows, UNIX, and Linux/s390 platforms.
Setting Description Connection A field that passes database-specific parameters, such as login credentials, to String the data source. For UDB on the initial connection, specify DatabaseName, CreateDefaultPackage, ReplacePackage, and sendStringParametersAsUnicode (with no spaces), as the following example shows: DatabaseName=SAMPLE;CreateDefaultPackage=TRUE;ReplacePackage=TRUE; sendStringParametersAsUnicode=false If the database uses Unicode, specify true for the sendStringParametersAsUnicode parameter.
The SQL operations that can interact with the current data source. Connecting to Informix To see a list of Informix versions that ColdFusion MX supports, go to www.macromedia.com/go/sysreqscf. Use the settings in the following table to connect ColdFusion MX to Informix data sources: Setting...
Setting Description Timeout (min) The number of minutes that ColdFusion MX maintains an unused connection before destroying it. Interval (min) The time (in minutes) that the server waits between cycles to check for expired data source connections to close. Disable If selected, suspends all client connections.
Setting Description Description (Optional) A description for this connection. Page Timeout The number of milliseconds before a request for a ColdFusion page times out. The default is 600. If you observe excessive network activity when using this driver, increase the page timeout value. Max Buffer Size The size of the internal buffer, in kilobytes, that Access uses to transfer data to and from the disk.
Setting Description BLOB Buffer The default buffer size, used if the BLOB option is not selected. The default value is bytes. 64000 Allowed SQL The SQL operations that can interact with the current data source. Connecting to Microsoft Access with Unicode Use the settings in the following table to connect ColdFusion MX to Microsoft Access with Unicode data sources (this is a Type 2 driver): Setting...
Connecting to Microsoft SQL Server To see a list of SQL Server versions that ColdFusion MX supports, go to www.macromedia.com/go/sysreqscf. Use the settings in the following table to connect ColdFusion MX to Microsoft SQL Server: Setting...
Setting Description Select Method Determines whether server cursors are used for SQL queries. • The Direct method provides more efficient retrieval of data when you retrieve record sets in a forward-only direction and you limit your SQL Server connection to a single open SQL statement at a time. This is typical for ColdFusion applications.
Settings for the Northwind sample database SQL Server ships with a sample database named Northwind. Establishing a connection to the Northwind database can help you learn ColdFusion MX while using a familiar database. To establish a connection to the SQL Server Northwind database, you must set up the database int he SQL Server Enterprise manager and in the ColdFusion MX Administrator.
Server (Windows and SQL) and removing the user name and password from the ColdFusion data source. Connecting to MySQL To see a list of MySQL versions that ColdFusion MX supports, go to www.macromedia.com/go/sysreqscf. Use the settings in the following table to connect ColdFusion MX to MySQL data sources: Setting Description...
Setting Description Limit Connections Specifies whether ColdFusion MX limits the number of database connections for the data source. If you enable this option, use the Restrict Connections To field to specify the maximum. Restrict Connections To Specifies the maximum number of database connections for the data source.
Setting Description Password The password that ColdFusion MX passes to the JDBC driver to connect to the data source if a ColdFusion application does not supply a password (for example, in a tag). cfquery Description (Optional) A description for this connection. Connection String A field that passes database-specific parameters, such as login credentials, to the data source.
Connecting to Oracle To see a list of Oracle versions that ColdFusion MX supports, go to www.macromedia.com/go/sysreqscf. Use the settings in the following table to connect ColdFusion MX to Oracle data sources: Setting Description CF Data Source Name The data source name (DSN) used by ColdFusion MX to connect to the data source.
Setting Description Login Timeout (sec) The number of seconds before ColdFusion MX times out the data source connection login attempt. CLOB Select to return the entire contents of any CLOB/Text columns in the database for this data source. If not selected, ColdFusion MX retrieves the number of characters specified in the Long Text Buffer setting.
For example, you can use the Other Data Sources option to define a data source for DB2 OS/390 or iSeries, using the following settings: JDBC URL jdbc:datadirect:db2://dbserver:portnumber Driver class macromedia.jdbc.MacromediaDriver Driver name Username A user defined to the database Password...
“Connecting to DB2 Universal Database” on page Connecting to Sybase To see a list of Sybase versions that ColdFusion MX supports, go to www.macromedia.com/go/sysreqscf. Use the settings in the following table to connect ColdFusion MX to Sybase data sources: Setting...
Setting Description Restrict Connections To Specifies the maximum number of database connections for the data source. To use this restriction, you must enable the Limit Connections option. Maintain Connections ColdFusion MX establishes a connection to a data source for every operation that requires one.
Setting Description Password The password that ColdFusion MX passes to JNDI to connect to the data source if a ColdFusion application does not supply a password (for example, in a tag). cfquery Description (Optional) A description for this connection. JNDI Environment Specifies additional JNDI environment settings, if required by the JNDI Settings data source.
CHAPTER 4 Web Server Management You can connect Macromedia ColdFusion MX to the built-in web server and to external web servers, such as Apache, IIS, and Sun ONE Web Server (formerly known as iPlanet). This chapter explores common scenarios, security, and multihosting.
All web servers listen on a TCP/IP port, which you can specify in the URL. By default, web servers listen for HTTP requests on port 80 (for example, http://www.macromedia.com and http://www.macromedia.com:80 are the same). Similarly, port 443 is the default port for HTTPS requests.
• If you want the built-in web server to serve pages from a different web root directory, define a virtual mapping in the cf_root/wwwroot/WEB-INF/jrun-web.xml file (jrun_root/servers/cfusion/cfusion-ear/cfusion-war/WEB-INF/jrun-web.xml in the multiserver configuration), as the following example shows: <virtual-mapping> <resource-path>/*</resource-path> <system-path>C:/myApps/wwwroot</system-path> </virtual-mapping> Warning: If you have CFML pages under your external web server’s root, ensure that ColdFusion MX has been configured to serve these pages through the external web server.
Open a console window. Tip: In Windows, you can start the Web Server Configuration Tool by selecting Start > Programs > Macromedia > ColdFusion MX 7 > Web Server Configuration Tool. Change to the cf_root/runtime/bin (server configuration) or jrun_root/bin (multiserver configuration) directory.
(Optional) The web server connector does not serve static content (such as HTML files and images) from the built-in web server’s root directory. If your ColdFusion web application has an empty context root (/) and you want to serve pages from the built-in web server’s root directory, you can create a web server mapping to the corresponding directory under the built- in web server.
Option Description Enables native OS memory allocation. Specifies the extension mappings list. (To use the web server -map .cfm,.cfc,.cfml,.cfr, connector with ColdFusion MX, you should specify .cfswf,.jsp,.jws .cfm,.cfc,.cfml,.cfr,.cfswf,.jsp,.jws.) (IIS 5 only) Sets in the jrun.ini file. This means -filter-prefix-only ignoresuffixmap=true that the connector module runs as an IIS extension.
Command-line interface examples This section provides examples of multiple use-cases for different web servers: • Configure a specific IIS site: cf_root/runtime/bin/wsconfig.exe -server coldfusion -ws iis -site "web31" -coldfusion -v On systems where all sites run ColdFusion, there is generally no need to configure an individual site.
JRun server. You must set this setting to false apialloc Enables native OS memory allocation rather than the web server’s allocator (for use on Solaris with Sun ONE, at the direction of Macromedia Support staff). ignoresuffixmap (IIS only) Forces the connector to use application mappings.
Apache configuration file The following is a typical httpd.conf file for an installation of ColdFusion MX on the same computer as an Apache 2.0 web server: # JRun Settings LoadModule jrun_module "C:/CFusionMX7/runtime/lib/wsconfig/1/mod_jrun20.so" <IfModule mod_jrun20.c> JRunConfig Verbose false JRunConfig Apialloc false JRunConfig Ssl false JRunConfig Ignoresuffixmap false JRunConfig Serverstore...
Multihoming configuration tasks include the following: Enabling access to the Administrator ColdFusion MX If any of the applications under a virtual host need to access the ColdFusion MX Administrator, you must create a web server mapping (Alias directive in Apache) for /CFIDE that points to the original CFIDE directory. Alternatively, you can copy the entire CFIDE directory to the virtual website.
Apache When you use Apache, you modify the apache_root/conf/httpd.conf file to create virtual hosts and run the Web Server Configuration Tool. You store ColdFusion pages under the web root of each virtual website. To connect multiple Apache virtual hosts on a web server to a single ColdFusion server: Configure DNS for each virtual website, as described in your web server documentation.
Sun ONE Web Server, iPlanet, and Netscape When you use Sun ONE Web Server version 6, you use the Server Administrator to create virtual servers and run the Web Server Configuration Tool. You store ColdFusion pages under the web root of each virtual server. Note: For earlier versions of Sun ONE/iPlanet and Netscape Enterprise Server (NES), you must create separate server instances for each site and run the Web Server Configuration Tool once for each site.
CHAPTER 5 Deploying ColdFusion Applications This chapter describes the archive and deployment options available in Macromedia ColdFusion MX 7. Contents Archive and deployment options ..........79 Packaging applications in CAR files .
Perform the following steps when you archive and deploy site information: Create the archive definition. Identify the type of information to archive about a site. You can archive almost anything about the site, including directories, files, CFX tags, ColdFusion MX mappings, Verity collections, automated tasks, and server settings.
Application packaging The J2EE Archive feature lets you quickly create an archive file that a J2EE administrator can use to deploy your ColdFusion MX application. To add a new archive definition and create an archive file: Open the ColdFusion MX Administrator. Specify a unique name for the archive file (no extension) in the Archive Name field.
Deployment considerations Once the archive file is created, you deploy using standard ColdFusion MX J2EE configuration deployment techniques. For more information, see “Installing an EAR file or WAR files” in Chapter 4, “Installing the J2EE Configuration” of Installing and Using ColdFusion MX. Post-deployment considerations Depending on your application, the resources that it uses, and the environment in which it is deployed, you may need to perform post-deployment configuration, as follows:...
The following table describes these parameters: Parameter Description webroot Fully qualified path to the web server root; for example, C:\Inetpub\wwwroot or C:\CFusionMX7\wwwroot. directory-to-compile Fully qualified path to the directory where the files to be compiled are located. This directory must be under the webroot directory. If not specified, all ColdFusion templates in the webroot directory are compiled.
CHAPTER 6 Administering Security This chapter describes configuration options for Macromedia ColdFusion MX security. You can secure a number of Macromedia ColdFusion MX 7 resources with password access and you can configure sandbox security. Contents About ColdFusion MX security ..........85 Using password protection .
RDS password protection If you configured password protection for RDS access when you installed ColdFusion, you are prompted for the password when you attempt to access ColdFusion MX from Macromedia Dreamweaver MX 2004, Macromedia HomeSite+, or the ColdFusion Report Builder.
To use sandbox security in the multiserver and J2EE editions, the application server must be running a security manager ( ) and you must define the following java.lang.SecurityManager JVM arguments (for Macromedia JRun, this is the java.args line in the jrun_root/jvm.config file): -Djava.security.manager -Djava.security.policy="cf_root/WEB-INF/cfusion/lib/coldfusion.policy" -Djava.security.auth.policy="cf_root/WEB-INF/cfusion/lib/neo_jaas.policy"...
For more information, see the Administrator online Help. Note: When you run ColdFusion MX in the J2EE configuration on IBM WebSphere, the Files/Dirs and Server/Ports tabs are not enabled. About directories and permissions When you enable access to files outside of the sandbox, you specify the filename. When you enable access to directories outside of the sandbox, you specify directoryname\indicator, where indicator is a dash or asterisk, as follows: •...
Configuring a sandbox Before you begin security sandbox configuration, analyze your application and its usage to determine the tags, functions, and resources that it requires. You can then configure the sandbox to enable access to the required resources and disable use of the appropriate tags and functions. For example, if the applications in the sandbox do not use the tag, you can safely cfregistry...
In the Secured Files and Directories list, verify that the file path is correct. The character after the backslash is important. For information, see “About directories and permissions” on page Note: The Files/Dirs tab works together with the file-based permissions of the operating system. To restrict a user from browsing another user’s directory, you must use file-based permissions.
CHAPTER 7 Using Multiple Server Instances When you install Macromedia ColdFusion MX 7 Enterprise Edition using the multiserver configuration, you can use the ColdFusion MX Administrator to create multiple server instances. Deploying ColdFusion MX on multiple server instances lets you isolate individual applications and leverage clustering functionality.
About multiple server instances The ColdFusion MX Administrator lets you create server instances and clusters. Additionally, you can connect to remote JRun servers and add them to clusters. Running multiple instances of ColdFusion MX has the following advantages: Application isolation You deploy an independent application to each server instance.
Defining additional server instances The multiserver configuration is a customized installation of JRun. JRun supports multiple server instances (also called JRun servers) running on the same computer. Each server instance runs in a separate JVM, which executes all ColdFusion pages for that instance. You use the Instance Manager area of the ColdFusion MX Administrator to define and manage server instances.
Enabling application isolation You can create separate server instances, each with its own ColdFusion applications; each application then has its own ColdFusion and J2EE server resources. In this configuration, you typically have a single external web server with multiple server instances on one computer, and separate virtual hosts (or sites) for each server instance.
To use multiple server instances for application isolation: Create a separate server instance using the instructions in “Defining additional server instances” on page 93. 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 application isolation in Apache When you use multiple virtual hosts with multiple server instances under Apache, you edit the httpd.conf file manually. This section assumes that you already created server instances and virtual websites, as described in “Enabling application isolation” on page To configure multiple server instances for application isolation when using Apache: Run the Web Server Configuration Tool once, specifying the location of the Apache httpd.conf file and any other required information.
#JRunConfig ProxyRetryInterval <number of seconds to wait before trying to reconnect to unreachable clustered server> #JRunConfig ConnectTimeout 15 #JRunConfig RecvTimeout 300 #JRunConfig SendTimeout 15 AddHandler jrun-handler .jsp .jws .cfm .cfml .cfc .cfr .cfswf </IfModule> NameVirtualHost 127.0.0.1 <VirtualHost 127.0.0.1> ServerAdmin firstname.lastname@example.org DocumentRoot "C:/Program Files/Apache Group/Apache2/htdocs"...
Enabling clustering for load balancing and failover Load balancing is an enterprise-level feature in which the application server automatically alternates requests among the server instances in a cluster. Clustering also enables application servers to route requests to a running server instance when the original server instance goes down. Note: These instructions apply only when you are running ColdFusion MX in the multiserver configuration.
(Optional) Click the Register Remote Instance button to define existing remote server instances so that you can include them in the cluster. If you use a remote server, ensure that it contains the same application and settings as the local server instances. Note: A server can participate in only one cluster.
(Optional) Store the application’s ColdFusion files in your external web server root directory. Test the application to ensure that load balancing and failover work as expected. Defining remote server instances to the ColdFusion MX Administrator You can use the Cluster Manager to add ColdFusion MX server instances running on other computers;...
Chapter 7: Using Multiple Server Instances...
PART II Administering Verity This part describes the Verity search tools and utilities that you can use for configuring the Verity K2 Server search engine, as well as creating, managing, and troubleshooting Verity collection. The following chapters are included: Chapter 8: Introducing Verity and Verity Tools ........105 Chapter 9: Indexing Collections with Verity Spider .
CHAPTER 8 Introducing Verity and Verity Tools This chapter provides an overview of the advanced Verity features included in Macromedia ColdFusion MX 7. Contents Collections and the ColdFusion MX Verity architecture ......105 About Verity Spider (vspider) .
Server configuration Through the -Xmx argument to the java.args parameter in the cf_root/runtime/bin/jvm.config file (for example, [-Xmx512m]). Multiserver configuration Through the jrun_root/bin/jvm.config file. J2EE configuration Through application server-specific methods. Verity information storage The Verity Search Server runs as a separate process from ColdFusion MX. This server controls all access to Verity collections, as the following figure shows: In the multiserver and J2EE configurations, multiple ColdFusion server instances all use the same Verity Search Server to access the same set of Collections.
About Verity Spider (vspider) Verity Spider (vspider) lets you index web-based and file system documents throughout your enterprise, including dynamic content, and many application document formats, including Microsoft Office, WordPerfect, ASCII text, HTML, and PDF (Adobe Acrobat) documents. For more information, see Chapter 9, “Indexing Collections with Verity Spider,”...
Chapter 8: Introducing Verity and Verity Tools...
Microsoft Office, WordPerfect, ASCII text, HTML, SGML, XML and PDF (Adobe Acrobat) documents. Another advantage of this method, is that the index created by vspider includes dynamic content. tag and indexing a collection through the Macromedia ColdFusion MX cfindex Administrator do not include dynamic content.
Web standard support Verity Spider supports key web standards used by Internet and intranet sites. Standard HREF links and frames pointers are recognized, so that navigation through them is supported. Redirected pages are followed so that the real underlying document is indexed. Verity Spider adheres to the robots exclusion standard specified in robots.txt files, so that administrators can maintain friendly visits to remote websites.
Efficient DNS lookups Verity Spider minimizes DNS lookups, which means great improvements to spidering throughput. If spidering is limited by domain or host, then no DNS lookups are made on hosts that fall outside of that range. In earlier versions, DNS lookups were made on all candidate URLs. Proxy handling efficiency To allow for greater flexibility when dealing with indexing jobs that involve proxy servers and firewalls, use the following options:...
There are dependencies for other options, depending on the nature of the indexing task. The following are some examples: • To build a new collection, you must use -style • To control how Verity Spider operates, including which documents it indexes, use some Verity Spider options.
If an indexing task halts, you can rerun the task as-is. The persistent store for the specified collection is read, and only those candidate URLs that are in the queue but not yet processed are parsed. Candidate URLs correspond to URLs of the following status, as reported by vsdb: cand, used, inse, upda, dele, fail Repository type Starting point...
For better readability, put each option and any parameters on a single line. Verity Spider can properly parse the lines. Note: Macromedia strongly recommends that you take advantage of the abstraction offered by this option. This can greatly reduce user error in erroneously including or omitting options in subsequent indexing jobs.
-style Syntax: -style path Specifies the path to the style files to use when creating a new collection. If the option is not specified, Verity Spider uses the default style files in -style cf_root/lib/common/style. Note: You can safely omit the option when resubmitting an indexing job, as the style -style information will already be part of the collection.
-maxindmem Syntax: -maxindmem kilobytes Specifies the maximum amount of memory, in kilobytes, used by each indexing thread. Specify the number of threads with the option. -indexers By default, each indexing thread uses as much memory as is available from the system. -maxnumdoc Syntax: -maxnumdoc num_docs...
-nodupdetect Type: Web crawling only Disables checksum-based detection of duplicates when indexing websites. URL-based duplicate detection is still performed. By default, a document checksum is computed based on the CRC-32 algorithm. The checksum combined with the document size is used to determine if the document is a duplicate. See also -followdup -noindex...
-preferred Type: Web crawling only Syntax: -preferred exp_1 [exp_n] ... Specifies a list of hosts or domains that are preferred when retrieving documents for viewing. You can use wildcard expressions, where the asterisk (*) is for text strings and the question mark (?) is for single characters.
Due to the use of special characters, which represent the bulk insert file (BIF), you must run Verity Spider with a command file using the option. -cmdfile For example, if you want to use a script called fix_bif to add customized information to BIF files, use the following command: vspider -cmdfile filename Where...
If a halt occurs during indexing, the chunk of documents specified by the option is -submitsize lost because there is no transactional rollback for indexing and the documents are no longer in the queue for indexing. When you rerun the indexing task, Verity Spider can only continue with URLs and documents that are enqueued.
-delay Type: Web crawling only Syntax: -delay num_milliseconds Specifies the minimum time between HTTP requests, in milliseconds. The default value is 0 milliseconds for no delay. -header Type: Web crawling only Syntax: -header string Specifies an HTTP header to add to the spidering request; for example: -header "Referer: http://www.verity.com/"...
-noproxy Type: Web crawling only Syntax: -noproxy name_1 [name_n] ... Used in conjunction with the option, the option specifies that Verity Spider -proxy -noproxy directly access the hosts whose names match those specified. By default, when you specify the option, Verity Spider first tries to access every host with the proxy information. To -proxy improve performance, use the option for the hosts you know can be accessed without a...
-retry Type: Web crawling only Syntax: -retry num_retries Specifies the number of times that Verity Spider should attempt to access a URL. Use the -retry option when it is likely that an unstable network connection will give false rejections. The default value is 4. -timeout Type: Web crawling only Syntax:...
Example The following is a URL without parameters: http://server.com/cgi-bin/program? If you include parameters in the URL to be indexed, as specified with the option, those -start parameters are processed and any resulting pages are indexed and parsed. By default, a URL with a question mark (?) is skipped. -domain Type: Web crawling only Syntax:...
-https Type: Web crawling only Lets you index SSL-enabled websites. Note: You must have the Verity SSL Option Pack installed to use the option. The Verity SSL -https Option Pack is a Verity Spider add-on available separately from a Verity salesperson. -jumps Type: Web crawling only Syntax:...
-norobo Type: Web crawling only Specifies to ignore any robots.txt files encountered. The robots.txt file is used on many websites to specify what parts of the site indexers should avoid. The default is to honor any robots.txt files. If you are re-indexing a site and the robots.txt file has changed, Verity Spider deletes documents that have been newly disallowed by the robots.txt file.
If you specify the following: -refreshtime 1 day 6 hours Only those documents that were last indexed at least 30 hours and 1 second ago, are refreshed. Note: This option is valid only with the option. When you use , the last -refresh vsdb -recreate indexed date is cleared.
Content options The following sections describe the Verity Spider content options. -casesen Makes processing case-sensitive by specifying that the spider separately process keys that differ only in case. Use only for indexing UNIX servers. -exclude Syntax: -exclude exp_1 [exp_n] ... Specifies that files, paths, and URLs matching the specified expression(s) will not be followed.
In Windows, include double-quotation marks around the argument to protect the special characters, such as the asterisk (*). On UNIX, use single-quotation marks. This is only required when you run the indexing job from a command line. Quotation marks are not necessary within a command file (the option).
See also -regexp -indinclude Syntax: -indinclude exp_1 [exp_n] ... Specifies that only those files and paths in URLs that match the expressions be followed and indexed. If you use backslashes, you must double them so that they are properly escaped; for example: C:\\test\\docs\\path You can use wildcard expressions, where the asterisk (*) is for text strings and the question mark...
In Windows, include double-quotation marks around the argument to protect the special characters, such as the asterisk (*). On UNIX, use single-quotation marks. This is only required when you run the indexing job from a command line. Quotation marks are not necessary within a command file (the option).
Specifies that Verity Spider follow and parse links, but not index, any HTML document that contains the text of exp within the given HTML_tag. For multiple HTML_tag and exp combinations, use multiple instances of the option. -skip You can use wildcard expressions, where the asterisk (*) is for text strings and the question mark (?) is for single characters;...
Lets you use a text file to map custom meta tags to valid HTTP header fields. If you use backslashes, you must double them so that they are properly escaped; for example: C:\\test\\docs\\path This means that you can use your own meta tag, in the document, to replace what is returned by the web server, or to insert it if nothing is returned.
-mimeinclude Syntax: -mimeinclude mime_1 [mime_n] ... Specifies MIME types to be included. In Windows, include double-quotation marks around the argument to protect the special characters, such as the asterisk (*). On UNIX, use single-quotation marks. This is only required when you run the indexing job from a command line. Quotation marks are not necessary within a command file (the option).
Example 1 To skip all HTML documents that contain the word "personnel" in the Title element, use the following: -skip title "personnel" Example 2 To skip all HTML documents that contain both the word "private" and the phrase "internal user" in any paragraph element, use the following: -skip title "personnel"...
-msgdb Syntax: -msgdb path Specifies the path to the ind.msg message database file. If Verity Spider was installed properly, this option should be unnecessary. By default, the ind.msg message database file is read from the following directory: cf_root/lib/platform/bin Where platform represents the platform directory. Logging options The following sections describe the Verity Spider logging options.
Choose one of the following arguments to determine which message types are logged: Loglevel Description arguments summary Includes the following message types: information, warning, error, badkey, progress, summary Use this option only if you do not want skip type messages. skip Includes the following message types: information, warning, error, badkey, progress, skip...
-purge Deletes document tables and index files in the collection, and cleans up the collection's persistent store. The collection is then fresh with its original style files, and is not deleted from the file system. -repair Specifies a failure-recovery mode for the collection, where the goal is to determine the causes of any errors, repair the errors (if possible), and restart a collection.
You can also use multiple instances of the MIME type criteria, each with a single parameter value, where quotation marks are necessary only if you use the wildcard character (*). For example: -mimeinclude text/plain -mimeinclude ’application/*’.Setting MIME Types MIME types and web crawling When you index a website, Verity Spider evaluates your MIME type criteria against the "Content- Type"...
On either platform, you must include single-quotation marks for values that include wildcard characters. Also use inclusion and exclusion criteria to finely control what is indexed, as follows: • If your list of file types to index is rather long, use exclusion criteria ( -exclude -indexclude , or...
Using the merge utility............162 Overview of Verity utilities The following command-line utilities are included with Macromedia ColdFusion MX for performing a variety of operations on Verity collections:...
Location of Verity utilities The Verity command-line utilities are located in the following directories: Server and multiserver configuration The utility files are located in cf_root/verity/k2/ platform/bin (server configuration) or jrun_root/verity/k2/platform/bin (multiserver configuration), where platform is _nti40 for Windows, _solaris for Solaris, or _ilnx21 for Linux. J2EE configuration The utility files are located in verity_root/k2/platform/bin, where platform is _nti40 for Windows, _solaris for Solaris, or _ilnx21 for Linux.
The log file contains the following fields: • Date • Time • Level • Code • Component • Description You can use the log file to view details about what happens during the collection creation process. Use the mkvdk command and specify the numeric identifier for the message level you -loglevel want, as summarized in the following table: Type...
Creating a collection Creating a collection with the mkvdk utility involves setting up a collection directory structure and inserting documents into this structure. You can create a collection using the following steps. To create a collection: Set up a collection using the following syntax: mkvdk -create -collection collectionname Where is the path to the collection directory.
General processing options The mkvdk utility provides a variety of general processing options, which the following table describes: Option Description -collection path Specifies the path of the collection to create or open. This option is required to execute the mkvdk utility. Turns off file locking.
Option Description -noindex Prevents indexing by this instance of mkvdk. Documents are not inserted or deleted. Using this option turns off the service-level VdkServiceType_Index. (Service types are described under -nooptimize Specifies the name of the character set to which to map all strings for your -charmap name application.
Bulk inserting or deleting The following command specifies bulk insertion of a list of documents: mkvdk -collection coll -bulk -insert filespec Where filespec is the list of files to insert. Since insert is the default, the following command is equivalent to the preceding command: mkvdk -collection coll -bulk filespec The following command specifies bulk deletion of a list of documents: mkvdk -collection coll -bulk -delete filespec...
Keyword Description dataprep Same as search-index-optimize-assist-housekeep index Same as insert-delete Message options The mkvdk utility provides a variety of messaging options, as described in the following table: Option Description Displays only fatal and error messages to the console. It overrides the -quiet setting.
Option Description -nosave Specifies that a work list, which is generated by the mkvdk utility automatically when you use the option, will not be saved in the collection directory in -extract a file called worklist (in the Verity bulk submit file format). By default, the mkvdk utility saves the worklist in the worklist file.
Collection maintenance options The mkvdk utility provides a variety of collection maintenance options, as described in the following table: Option Description -backup dir Backs up the collection into the specified directory. The backup does not include the tde subdirectory. The tde subdirectory is created by and for Topic Document Entry if Topic Document Entry is used to create or maintain the collection.
Performs the most comprehensive housekeeping possible, and removes out-of-date collection files. Macromedia recommends this optimization only when you are preparing an isolated collection for publication. When using this type, if the collection is being searched, files sometimes get deleted too early, which can affect search results.
Keyword Description ngramindex Builds an ngram index for the collection. An ngram index is designed to improve the search performance for queries with the <TYPO> and <WILDCARD> operators. An ngram index cannot be built without a spanning word list. You can build a spanning word list and ngram index in the same command, for example: mkvdk -collection collname -optimize spanword -ngramindex squeeze...
The VDB optimization option optimizes the packing of a collection’s VDBs. When VDBs are built during normal indexing operations, the segments are not stored sequentially in the one-file VDB file system. As a result of VDB optimization, performance can be improved by reserializing the packed segments in the VDBs so that all segments are contiguous, and VDBs can grow in size.
The rck2 command options The following table describes rck2 command options: rck2 command Description The sort specification for the search results. By default, results are sorted by p <sortspec> Score. Multiple fields must be specified in a space-separated list using asc or desc to indicate ascending or descending order.
When you start the rcvdk utility with no arguments, you get the following message, followed by the rcvdk prompt: Type 'help' for a list of commands. RC> command produces the following list of available commands: help RC> help Available commands: search s Search documents.
In the message returned for the preceding search, the rcvdk utility indicates that 18 documents matched the query. You can perform more elaborate queries using the Verity query language, as shown in the following example: RC>s universal filter <OR> filter.Troubleshooting and Maintenance Tools Viewing results of the rcvdk utility After you have attached to a collection and issued a search command successfully, you can view the results list and look at the retrieved documents.
The following table describes each of the default fields: Field name Description Number The rank of the document in the results list. The document with the highest score is ranked number 1. Score The score assigned to each retrieved document, based on its relevance to the query. For a NULL query, no scores are assigned, so the Score column in the results list is blank.
14: Supported Field Types 16: Recognized Document Types 17: Custom Zone Definitions 18: The KeyView Filter Kit RC> Displaying multiple fields You can specify multiple fields with the command, as shown in the following example. fields The field order corresponds to the order of the columns, with the first field specified appearing in the second column.
acronym acronyms actual administrator advance also Always always ampersand The columns in the display indicate the following: Size The number of bytes used by the Verity engine to store information about the word The number of unique documents in which the word appears Word The total number of occurrences of a word for the partition To view the occurrences of a specific word or pattern, enter a command using the...
Size The number of bytes used by the Verity engine to store information about the zone. The number of unique documents in which the zone appears Region The total number of instances of a zone for the partition Viewing the zone attribute list with the didump utility The zone attribute list contains a list of the HTML attributes for the zones identified by the HTML zone filter.
The browse utility executable, which starts the browse utility application, is located in the platform/bin directory. For more information on the specific location of this directory, see “Location of Verity utilities” on page 142. For example: c:\cfusionmx7\verity\k2\_nti40\bin\browse /common = c:\cfusionmx7\verity\k2\common c:\my_collection\parts\0000001.ddd Using menu options with the browse utility Use the following browse command to start the utility and display a set of menu options:...
61 Title_OF FIX-unsg ( 4) = 2481 62 Title_SZ FIX-unsg ( 2) = 15 You can eliminate the internal fields. To do this, type the underscore character, then press Return. If you enter an underscore character again, then press return, the internal fields are displayed. Using the merge utility The merge utility lets you combine multiple collections with identical schemas.
The merge utility reads srcCollection and splits it into roughly equal pieces, using the filenames given for newCollection1 and so on. If you want to split a very large collection into a large number of new collections, you can use the following command, instead of explicitly naming each new collection: merge -split -number newCollection srcCollection The merge utility reads the collection identified by srcCollection and splits it into the number of...
INDEX CAR files creating and deploying 80 AddHandler directive 67 overview 79 administration, initial tasks 14 CF Admin Password page, ColdFusion MX Administrator API Administrator 35 about 39 cfcompile utility enabling access through sandbox security 36 overview 82 Apache sourceless distribution 83 application isolation configuration 96 cfform tag configuration overview 67...
ColdFusion mappings maintaining with the mkvdk utility 150 J2EE archive 82 merging with the merge utility 162 ColdFusion MX Administrator repairing with the mkvdk utility 150 about 11 searching with the rcvdk utility 155 Caching Settings page 16 setup options for the mkvdk utility 144 CF Admin Password page 35 splitting with the merge utility 162 CFX Tags page 33...
Debugging IP Addresses page, ColdFusion MX Administrator 29 ignoresuffixmap property 72 Debugging Settings page, ColdFusion MX Administrator 26 about configuration 67 didump utility application isolation configuration 95 executable 158 multihoming 75 using 158 sample configuration file 73 word list, viewing 158 Informix, connecting to 49 zone attribute list, viewing 160 Instance Manager page, ColdFusion MX Administrator...
multiserver configuration recvtimeout property 72 application isolation 94 replication, session 100 clustering 99 root security context 89 defining server instances 93 multiple server instances 91 MySQL, connecting to 56 sandbox adding 88 configuring 89 Netscape Enterprise Server (NES) security, Administrator API access 36 about configuration 67 security, using 86 See also Sun ONE Web Server...
Simple Mail Transfer Protocol (SMTP) mail server 20 logging 136 sourceless distribution 82, 83 maintenance 137 ssl property 72 networking 120 sticky sessions 100 path and URL 123 Sun ONE Web Server processing 115 about configuration 67 Verity utilities application isolation configuration 98 about 107 multihoming 77 relationships with CFML 107...