Configuring and Administering ColdFusion MX
Trademarks Afterburner, AppletAce, Attain, Attain Enterprise Learning System, Attain Essentials, Attain Objects for Dreamweaver, Authorware, Authorware Attain, Authorware Interactive Studio, Authorware Star, Authorware Synergy, Backstage, Backstage Designer, Backstage Desktop Studio, Backstage Enterprise Studio, Backstage Internet Studio, ColdFusion, Design in Motion, Director, Director Multimedia Studio, Doc Around the Clock, Dreamweaver, Dreamweaver Attain, Drumbeat, Drumbeat 2000, Extreme 3D, Fireworks,
CONTENTS INTRODUCTION ................................................... 9 About Macromedia ColdFusion MX documentation . . . . . . . . . . . . . . . . . . . . . . . 9 Documentation set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 Viewing online documentation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 PART I: Administering ColdFusion MX CHAPTER 1: Administering ColdFusion MX . . . . . . . . . . . . . . . . . . . . . .
Verity K2 Server page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27 Web Services page. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27 Debugging & Logging section. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27 Debugging Settings page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28 Debugging IP Addresses page . . . . . . . . . . . . . . . . . . .
CHAPTER 5: Administering Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69 About ColdFusion MX security. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69 Security and edition differences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70 Using sandbox security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70 Using multiple sandboxes (Enterprise Edition only) . . . . . . . . . .
About squeezing deleted documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99 About optimized Verity databases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100 Performance tuning options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100 CHAPTER 9: Indexing Collections with Verity Spider . . . . . . . . . . . . . . . . . . . . . 101 About Verity Spider . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CHAPTER 11: Searching Collections with the rcvdk Utility . . . . . . . . . . . . . . . . . . 143 Using the Verity rcvdk utility. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143 Attaching to a collection using the rcvdk utility. . . . . . . . . . . . . . . . . . . . . . . . . . 144 Basic searching . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144 Viewing results of the rcvdk utility . . . . . . . . . . . . . . . . . . . . .
Contents
INTRODUCTION Configuring and Administering ColdFusion MX is intended for anyone who needs to configure and manage their ColdFusion development environment. About Macromedia ColdFusion MX documentation The ColdFusion documentation is designed to provide support for the complete spectrum of participants.
Introduction
This part describes how to use the ColdFusion MX Administrator to manage the ColdFusion environment, including connecting to your data sources and configuring security for your applications Chapter 1: Administering ColdFusion MX. . . . . . . . . . . . . . . . . . . . . . . . . 13 Chapter 2: Basic ColdFusion MX Administration . . . . . . . . . . . . . . . . . . . 17 Chapter 3: Data Source Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37 Chapter 4: Web Server Management . . . . . . . .
CHAPTER 1 Administering ColdFusion MX This chapter presents an overview of the ColdFusion MX Administrator and how you can use it to manage your development environment. For procedures, see the ColdFusion MX Administrator online Help. Contents About the ColdFusion MX Administrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 Accessing user assistance. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Accessing user assistance You can obtain assistance from the ColdFusion MX Administrator in the following ways: • • • • Online Help You access the context-sensitive online Help by clicking the question-mark icon on any ColdFusion MX Administrator page. The online Help has procedural and brief overview content for the ColdFusion MX Administrator page that you are viewing. This information appears in a new browser window and contains standard Contents, Index, and Search tabs.
• • • • • • • • Client Variables Configure an external data source, the operating system registry, or web browser cookies to store client variables. These can use and store information about a client browsing your site to provide customized page content. Memory Variables Specify timeout values for Application and Session variables. These variables are stored in RAM and maintain information throughout a ColdFusion session. Mappings Create logical aliases for physical directories on your server.
• • System Probes Manage probes that monitor your application’s status. If a potential problem is detected, a system probe can send an alert e-mail message and execute a recovery script. Code Analyzer Evaluate application code for potential incompatibilities between ColdFusion MX and ColdFusion Server 5. Extensions section The Extensions section contains the following pages: • • • • Java Applets Register, edit, or delete Java applets.
CHAPTER 2 Basic ColdFusion MX Administration This chapter explains the basic ColdFusion MX administration tasks, following the structure of the ColdFusion MX Administrator sections. Contents Initial administration tasks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 Server Settings section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18 Data & Services section . . . . . . . . . . . .
Task Description Set up e-mail E-mail lets ColdFusion MX and ColdFusion applications send automated mail messages. To configure an e-mail server and mail options, use the Mail Server page of the Administrator. For more information, see “Mail Server page” on page 23. Change passwords You might have to change the passwords that you set for the ColdFusion MX Administrator and RDS during ColdFusion MX installation. To change passwords, use the Security section of the Administrator.
Setting Description Missing Template Handler Specify a page to execute when ColdFusion MX cannot find a requested page. This specification is relative to the web root. If the user is running Internet Explorer with "Show Friendly HTTP error messages" enabled in advanced settings (the default), Internet Explorer will only display this page if it contains more than 512 bytes. Site-wide Error Handler Specify a page to execute when ColdFusion MX encounters an error while processing a request.
Client Variables page Client variables let you store user information and preferences between sessions. Using information from client variables, you can customize page content for individual users. You enable client variable default settings in ColdFusion MX on the Client Variables page of the Administrator.
Migrating client variable data To migrate your client variable data to another data source, you should know the structure of the database tables that store this information.
) CREATE INDEX id2 ON CGLOBAL (cfid) CREATE INDEX id3 ON CGLOBAL (lvisit) Memory Variables page You use the Memory Variables page of the ColdFusion Administrator to enable application and session variables server-wide. By default, application and session variables are enabled when you install ColdFusion MX.
Mail Server page You use the Mail Server page of the ColdFusion MX Administrator to specify a mail server to send automated e-mail messages. ColdFusion MX supports the Simple Mail Transfer Protocol (SMTP) for sending e-mail messages and the Post Office Protocol (POP) for retrieving e-mail messages from your mail server. To use e-mail messaging in your ColdFusion applications, you must have access to an SMTP server and/or a POP account.
Setting Description Spool mail messages for delivery (Memory spooling available for Enterprise Edition only) Select this option to route outgoing mail messages to the mail spooler. If you disable this option, ColdFusion MX delivers outgoing mail messages immediately. In ColdFusion MX Enterprise Edition, you can spool messages either to disk (slower, but messages persist across shutdowns) or to memory (faster, but messages do not persist). You can override this setting in the cfmail tag.
Setting Description Max number of charting threads Specify the maximum number of chart requests that can be processed concurrently. The minimum number is 1 and the maximum is 5. Higher numbers are more memory intensive. Disk cache location When caching to disk, specify the directory in which to store the generated charts.
After you archive the information, you can use the Administrator to deploy your web applications to the same ColdFusion MX server or to a ColdFusion MX server running on a different computer. Additionally, you can use these features to deploy and receive any ColdFusion archive file electronically. The Archive Settings page in the Administrator lets you configure various archive system settings that apply to all archive and deploy operations. For more information, see the online Help.
For more information about building search interfaces, see the chapters about the cfindex, cfsearch, and cfcollection tags in Developing ColdFusion MX Applications. ColdFusion lets you manage your collections from the Administrator. You can index, repair, optimize, purge, or delete Verity collections that are connected to ColdFusion.
This section also includes pages for managing your Log Files, Scheduled Tasks, System Probes, and the Code Compatibility Analyzer. Debugging Settings page The Debugging Settings page provides the following debugging options: Setting Description Enable Robust Exception Information Displays detailed information in the exceptions page, including the template’s physical path and URI, the line number and snippet, the SQL statement used (if any), the data source name (if any), and the Java stack trace.
Using the cfstat utility The cfstat command-line utility provides real-time performance metrics for ColdFusion MX. Using a socket connection to obtain metric data, the cfstat utility displays the information that ColdFusion MX writes to the System Monitor without actually using the System Monitor application. The following table lists the metrics that cfstat returns: Metric abbreviation Metric name Description Pg/Sec Page hits per second The number of ColdFusion pages processed per second.
Metric abbreviation Metric name Description Bytes In/Sec Bytes incoming per second The number of bytes that ColdFusion MX read in the last second (not an average). Bytes Out/Sec Bytes outgoing per second The number of bytes that ColdFusion MX wrote in the last second (not an average). Before you use the cfstat utility, ensure that you selected the Enable Performance Monitoring check box in the ColdFusion MX Administrator (on the Debugging & Logging > Debugging Settings page).
Logging Settings page You use the Logging Settings page of the Administrator to change ColdFusion MX logging options. The following table describes the settings: Setting Description Log directory* Directory to which error log files are written. Maximum file size (kb) Set the maximum file size for log files. Once a file hits this size, it will be automatically archived. Maximum number of archives Set the maximum number of log archives to create.
Log Description car.log Records errors associated with Site Archive and Restore operations. mail.log Records errors generated by an SMTP mail server. mailsent.log Records messages sent by ColdFusion MX. flash.log Records entries for Flash Remoting. Scheduled Tasks page You use the Scheduled Tasks page to schedule the execution of local and remote web pages and to generate static HTML pages.
Code Compatibility Analyzer page The Code Compatibility Analyzer evaluates your ColdFusion pages for potential incompatibilities between ColdFusion MX and ColdFusion Server 5. Extensions section You use the Extensions section of the Administrator to configure ColdFusion MX to work with other technologies, such as Java and CORBA. This section contains the Java Applets, CFX Tags, Custom Tag Paths, and CORBA Connectors pages.
ColdFusion MX loads ORB libraries dynamically using a connector, which does not restrict ColdFusion developers to a specific ORB vendor. The connectors depend on the ORB runtime libraries provided by the vendor. A connector for Borland Visibroker is embedded within ColdFusion MX. Make sure that the ORB runtime libraries are in cf_root/runtime/lib.
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. Sandbox security uses the location of your ColdFusion pages to determine functionality. A sandbox is a designated area (CFM files or directories containing CFM files) of your site to which you apply security restrictions.
Chapter 2: Basic ColdFusion MX Administration
CHAPTER 3 Data Source Management This chapter describes the configuration options for ColdFusion MX data sources. For basic information on data sources and connecting to databases, see Developing ColdFusion MX Applications. Contents About JDBC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37 Adding data sources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
The following table describes the four types of JDBC drivers: Type Name Description 1 JDBC-ODBC bridge Translates JDBC calls into ODBC calls, and sends them to the ODBC driver. Advantages Allows access to many different databases. Disadvantages The ODBC driver, and possibly the client database libraries, must reside on the ColdFusion server computer. Performance is also below par. Macromedia does not recommend this driver type unless your application requires specific features of these drivers.
Driver Type Reference Microsoft Access with Unicode support 2 “Connecting to Microsoft Access with Unicode” on page 46 Microsoft SQL Server 7.x, 2000 4 “Connecting to Microsoft SQL Server 7.x, 2000” on page 47 MySQL 4 “Connecting to MySQL” on page 48 ODBC Socket 3 “Connecting to ODBC Socket” on page 50 Oracle R3 (8.1.7), Oracle 9i 4 “Connecting to Oracle R3 (8.1.7), Oracle 9i” on page 51 Other Sybase 11.5, 11.9, 12.0, 12.
4 Click Add. A form for additional DSN information appears. The available fields in this form depend on the Driver that you selected. 5 In the Database field, enter the name of the database; for example, Northwind. 6 In the Server field, enter the network name or IP address of the server that hosts the database, and enter any required Port value; for example, the bullwinkle server on the default port. 7 If your database requires login information, enter your Username and Password.
Connecting to DB2 Universal Database 6.x, 7.2, and OS/390 Use the settings in the following table to connect ColdFusion to DB2 Universal Database 6.x, 7.2, and OS/390 data sources: Setting Description CF Data Source Name The data source name (DSN) used by ColdFusion MX to connect to the data source. Database The name of the database. Server The name of the server that hosts the database that you want to use. If the database is local, enclose the word local in parentheses.
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. To use this restriction, you must enable Limit Connections. Maintain Connections ColdFusion establishes a connection to a data source for every operation that requires one.
Connecting to Informix 9.x Use the settings in the following table to connect ColdFusion MX to Informix 9.x data sources: Setting Description CF Data Source Name The data source name (DSN) used by ColdFusion MX to connect to the data source. Database The database to which this data source connects. Informix Server The name of the Informix database server to which you want to connect. Server The name of the server that hosts the database that you want to use.
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 MX retrieves the amount 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. If not selected, ColdFusion MX retrieves the amount specified in the Blob Buffer setting.
Setting Description Default Password The password (16-character limit) 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 cfquery tag. Return Timestamp as String Enable this setting if your application retrieves Date/Time data and then re-uses it in SQL statements without applying formatting (using functions such as DateFormat, TimeFormat, and CreateODBCDateTime).
Connecting to Microsoft Access with Unicode Type 2 driver. Use the settings in the following table to connect ColdFusion MX to Microsoft Access with Unicode data sources: 46 Setting Description CF Data Source Name The data source name (DSN) used by ColdFusion MX to connect to the data source. Database File The file that contains the database. Description (Optional) A description for this connection.
Setting Description BLOB Select to return the entire contents of any BLOB/Image columns in the database for this data source. If not selected, ColdFusion MX retrieves the amount specified in the Blob Buffer setting. LongText Buffer The default buffer size, used if Enable Long Text Retrieval(CLOB) is not selected. Default is 64000 bytes. BLOB Buffer The default buffer size, used if Enable binary large object retrieval (BLOB) is not selected. Default is 64000 bytes.
Setting Description Maintain Connections ColdFusion MX establishes a connection to a data source for every operation that requires one. Enable this option to improve performance by caching the data source connection. String Format Enable this option if your application uses Unicode data in DBMSspecific Unicode datatypes such as National Character or nchar. Max Pooled Statements Enables reuse of prepared statements (that is, stored procedures and queries that use the cfqueryparam tag).
Setting Description Username The user name that ColdFusion MX 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. Password The password (16-character limit) 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 cfquery tag. Description (Optional) A description for this connection.
Connecting to ODBC Socket Type 3 driver. Use the settings in the following table to connect ColdFusion MX to ODBC Socket data sources: 50 Setting Description CF Data Source Name The data source name (DSN) used by ColdFusion MX to connect to the data source. ODBC DSN Select the ODBC DSN to which you want ColdFusion MX to connect. Trusted Connection Specifies whether to use domain user account access to the database. Only valid for SQL Server.
Setting Description BLOB Buffer The default buffer size, used if Enable binary large object retrieval (BLOB) is not selected. Default is 64000 bytes. Allowed SQL The SQL operations that can interact with the current data source. Connecting to Oracle R3 (8.1.7), Oracle 9i Use the settings in the following table to connect ColdFusion MX to Oracle R3 (8.1.7), Oracle 9i 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 Interval (min) The time (in minutes) that the server waits between cycles to check for expired data source connections to close. Disable Connections If selected, suspends all client connections. Login Timeout (sec) The number of seconds before ColdFusion 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.
Setting Description Maintain Connections ColdFusion MX establishes a connection to a data source for every operation that requires one. Enable this option to improve performance by caching the data source connection. Timeout (min) The maximum number of minutes after the data source connection is made that you want ColdFusion MX to cache a connection after it is used. Interval (min) The time (in minutes) that the server waits between cycles to check for expired data source connections to close.
Connecting to Sybase 11.5, 11.9, 12.0, and 12.5 Use the settings in the following table to connect ColdFusion MX to Sybase 11.5, 11.9, 12.0, and 12.5 data sources: Setting Description CF Data Source Name The data source name (DSN) used by ColdFusion MX 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.
Setting Description Max Pooled Statements Enables reuse of prepared statements (that is, stored procedures and queries that use the cfqueryparam tag). Although you tune this setting based on your application, start by setting it to the sum of the following: • Unique cfquery tags that use cfqueryparam • Unique cfstoredproc tags Timeout (min) The maximum number of minutes after the data source connection is made that you want ColdFusion MX to cache a connection after it is used.
Chapter 3: Data Source Management
CHAPTER 4 Web Server Management This chapter discusses connecting ColdFusion MX to the built-in web server and to external web servers, such as Apache, IIS, and SunONE Web Server (formerly known as iPlanet). It explores common scenarios, security, multi-hosting, and other issues that you might find helpful. The discussions in this chapter apply when running ColdFusion MX in the server configuration; they do not apply when running ColdFusion MX in the J2EE configuration.
Using the built-in web server The ColdFusion MX server configuration is built on top of JRun, which includes the JRun web server, also called the built-in web server.
Using an external web server ColdFusion MX uses the JRun web server connector to forward requests from an external web server to the ColdFusion MX runtime system. When a request is made for a CFM page, the connector on the web server opens a network connection to the JRun proxy service. The ColdFusion MX runtime system handles the request and sends its reply back through the proxy service and connector.
Using GUI mode The Web Server Configuration Tool includes a GUI mode, which you can use to specify external web server configuration settings through a graphical interface. Note: When using the Web Server Configuration Tool in GUI mode, it is critical that you select the Configure web server for ColdFusion MX applications checkbox. To run the Web Server Configuration Tool in GUI mode: 1 Open a console window.
Option Description -site Specifies the IIS website name. Specify All or 0 to configure the connector at a global level, which applies to all IIS websites. -host Specifies the ColdFusion server address. The default is localhost. -server Specifies the ColdFusion server name. The default is default. -username Specifies a username defined to the JRun server.The default is guest account. -password Specifies a password that corresponds to -username. The default is guest account.
Using the batch files and shell scripts ColdFusion MX ships with batch files and shell scripts that implement typical command-line connector configurations. These files are in cf_root/bin/connectors. For example, IIS_connector.bat configures all sites in IIS to site 0, which establishes a globally defined connector so that all sites inherit the filter and mappings. If you use Apache or iPlanet, use these files as prototypes, editing and saving them, as appropriate for your site.
The following table describes the web server connector properties in the web server configuration files. The web server connector uses these settings to help it find the ColdFusion server and know which servers to connect to. Property Description bootstrap The IP address and port on which the JRun server’s proxy service is listening for connector requests. JRun must also be configured to listen on this port/address combination, the ProxyService must be activated, and the JRun server must be running.
#JRunConfig Errorurl AddHandler jrun-handler .cfm .cfc .cfml .jsp .jws IIS configuration file For IIS, JRun uses the jrun.ini file to initialize jrun.dll (jrun_iis6.dll on IIS 6). A typical jrun.ini file follows: verbose=false scriptpath=/JRunScripts/jrun.dll serverstore=C:/CFusionMX/runtime/lib/wsconfig/1/jrunserver.store bootstrap=127.0.0.
Advanced configurations You typically use the Web Server Configuration Tool to configure a connection between the web server and ColdFusion server running on the same computer. However, you can use the web server connector to route requests to multiple virtual sites to a single ColdFusion server. This section also describes how to configure SSL between the web server and ColdFusion MX.
5 The JavaScript validation used by the cfform tag references the CFIDE/scripts/cfform.js file. However in a multi-homed environment, each virtual website may not contain this directory and file. Either copy this file and store it in your virtual website’s web root in a CFIDE/scripts directory or modify all cfform tags to use the scriptsrc attribute to specify the location of the cfform.js file.
3 Restart Apache to ensure that the virtual hosts are defined correctly. You store CFM files for each virtual host in the directory specified by the DocumentRoot directive. 4 Test each virtual host to ensure that HTML pages are served correctly. 5 Run the Web Server Configuration Tool, as follows: ■ ■ GUI Specify Apache for the Web Server, specify the directory containing the httpd.conf file, and select the Configure web server for ColdFusion MX applications option.
5 The JavaScript validation used by the cfform tag references the CFIDE/scripts/cfform.js file. However in a multi-homed environment, each virtual website may not contain this directory and file. Either copy this file and store it in your virtual website’s web root in a CFIDE/scripts directory or modify all cfform tags to use the scriptsrc attribute to specify the location of the cfform.js file.
CHAPTER 5 Administering Security You can secure a number of ColdFusion MX resources with password access and configure sandbox security. This chapter describes configuration options for ColdFusion security. Contents About ColdFusion MX security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69 Using sandbox security. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Security and edition differences If you have the Enterprise Edition of ColdFusion MX, you can configure multiple security sandboxes. If you have the Standard Edition of ColdFusion MX, you can only configure a single security sandbox. For more on sandbox security, see “Using sandbox security” on page 70. ColdFusion MX Administrator password protection The Administrator installs with secure access enabled. The password that you enter during installation is saved as the default.
This hierarchical arrangement of security permits the configuration of personalized sandboxes for users with different security levels. For example, if you are a web hosting administrator who hosts several clients on a ColdFusion shared server, you can configure a sandbox for each customer. This prevents one customer from accessing the data sources or files of another customer.
Adding a sandbox (Enterprise Edition only) ColdFusion MX Enterprise Edition lets you define multiple security sandboxes. To add a sandbox: 1 Open the Security > Sandbox Security page in the ColdFusion MX Administrator. The Sandbox Security Permissions page appears. 2 In the Add Security Sandbox box, enter the name of the new sandbox. This name must be either a ColdFusion mapping (defined in the Administrator) or an absolute path.
9 To enable files or directories, in the File Path box, enter or browse to the files or directories; for example, C:\pix. A file path consisting of the special token <> matches any file. For information on using the \- and \* wildcard characters, see “About directories and permissions” on page 71. 10 Select the permissions. For example, select the Read check box to let ColdFusion pages in the mytestapps sandbox read files in the C:\pix directory. 11 Click Add Files/Paths.
Chapter 5: Administering Security
CHAPTER 6 Using Multiple Server Instances When you install ColdFusion MX Enterprise using a J2EE deployment, you can use J2EE application-server-specific functionality to create multiple server instances. Deploying ColdFusion MX on multiple server instances lets you isolate individual applications and leverage clustering functionality. Contents Overview of multiple server instances . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
File location considerations In the J2EE configuration, you can store CFM pages either under the external web server root or under the ColdFusion web application root. ColdFusion MX first looks for CFM files in the web application root and then looks in the external web server root. The discussions in this chapter assume that you are using an external web server and that you store your CFM pages under the external web server root.
Enabling application isolation When you install the J2EE version of ColdFusion MX Enterprise on top of JRun, you can use the JMC to create multiple server instances and deploy ColdFusion MX on each instance. This configuration provides multiple ColdFusion MX web applications in fully independent processes, with no shared ColdFusion or J2EE server resources. In this configuration, you typically have a single web server with multiple virtual hosts (or sites) and multiple server instances on one computer.
3 Open the ColdFusion MX Administrator on the server instance using the built-in web server (hostname:portnumber/CFIDE/administrator/index.cfm) and define the resources (such as data sources and Verity collections) required for the application. Performing this step also ensures that ColdFusion MX was deployed successfully. 4 Using your web-server-specific method, create a virtual website (or separate website) for the application.
To configure multiple server instances for application isolation when using Apache: 1 Run the Web Server Configuration Tool once, specifying the location of the Apache httpd.conf file and any other required information. 2 The Web Server Configuration Tool creates a sequentially numbered subdirectory under jrun_root/lib/wsconfig. You can use the subdirectory created by the Web Server Configuration Tool for one of your virtual hosts but you must create additional subdirectories for all other virtual hosts.
ServerName myemployee ErrorLog logs/error-employee.log ... 5 For each VirtualHost directive, copy the IfModule directive from its default location outside the VirtualHost directive to the last element in the VirtualHost directive. 6 Delete the Apialloc, Ssl, and Ignoresuffixmap elements in the IfModule directive for each virtual host. Modify the Serverstore and Bootstrap elements to point to the appropriate proxy port (from the jrun.
Configuring application isolation in SunONE Web Server When using multiple virtual hosts with multiple server instances under SunONE Web Server, you create multiple SunONE Web Server instances, one for each ColdFusion server instance. This discussion assumes that you have already created server instances, as described in “Enabling application isolation” on page 77.
5 Open the jrun_root/lib/security.properties file and add the IP addresses of the other JRun servers in the cluster to jrun.trusted.hosts. 6 Open the JMC and create a cluster that contains your server instances. Note: Do not add the admin JRun server to a cluster. 7 If using failover, perform the following steps in the JMC: a Open the cluster by clicking the cluster name in the left panel. b Open the first server instance by clicking its name in the list. c Open the Macromedia ColdFusion MX application.
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. Chapter 7: Introducing Verity Tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85 Chapter 8: Managing Collections with the mkvdk Utility . . . . . . . . . . . . . 89 Chapter 9: Indexing Collections with Verity Spider . . . . . . . . . . . . . . . . .
CHAPTER 7 Introducing Verity Tools This chapter provides an overview of the advanced Verity features included in ColdFusion MX. These include several utilities that you can use to configure, manage, and troubleshoot search functionality in your ColdFusion applications. This chapter also introduces the Verity K2 Server, which lets you provide high-performance search capabilities for your ColdFusion applications. Contents About the Verity utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ColdFusion MX OEM restrictions ColdFusion MX includes an OEM-restricted version of the Verity Server. The version of Verity Server that is part of ColdFusion MX is restricted in the following areas: • ColdFusion MX can only interact with one Verity Server at a time.
Verity search modes in ColdFusion MX Your ColdFusion MX applications can search Verity collections using two modes: • • VDK mode The default ColdFusion MX search mode. You register a collection with ColdFusion MX by using the cfcollection tag or by using the Verity Collections page in the ColdFusion MX Administrator (which also uses the cfcollection tag). K2 mode The high-performance K2 Server mode.
Verity information storage All Verity configuration data and collection name registration information are stored in an XML file (neo-verity.xml), which is used solely by the ColdFusion server. This XML file, which is located in cf_root/lib, contains two collection lists. One list contains collections that are registered with ColdFusion MX; ColdFusion MX uses the VDK mode to search these collections.
CHAPTER 8 Managing Collections with the mkvdk Utility The mkvdk utility is a command-line utility installed with ColdFusion MX. You can use it to perform maintenance operations on Verity collections. Contents About the Verity mkvdk utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89 Getting started with the Verity mkvdk utility. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
4 A new partition is created, which includes an index and an attribute table. 5 Assist data is generated, which might include a spanning word list. When problems occur during an operation, the mkvdk utility writes error messages to the system log file (sysinfo.log). You can direct error and other messages to the console by using the mkvdk command with the -outlevel option. You can direct messages to a file of your choice by using the -loglevel and -logfile options.
Getting started with the Verity mkvdk utility The following is the basic mkvdk syntax: mkvdk -collection path [option] [...] [filespec] [...] Where: ■ ■ ■ ■ Square brackets ( [ ] ) indicate optional items. An ellipsis (...) indicates repetition of the previous item. Thus, [filespec] [...] indicates an optional series of filespec items. filespec represents a document filename or a list of document filenames.
Collection setup options The mkvdk utility has a variety of collection setup options, which the following table describes: Option Description -create Creates a collection in the specified collection directory. It creates the directory structure, determines the index contents and sets up the document’s table schema according to the style files used. If the specified collection already exists, the mkvdk utility exits rather than overwriting the existing collection.
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. -nolock Turns off file locking. Locking is on by default. -synch Performs work immediately. If this option is not used, indexing work is done in the background, as time permits.
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.) -charmap name Specifies the name of the character set to which to map all strings for your application. Set this to a character set that your system can display properly.
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 Where filespec is the list of files to delete.
Message options The mkvdk utility provides a variety of messaging options, as described in the following table: Option Description -quiet Displays only fatal and error messages to the console. It overrides the -outlevel setting. For a list of message types, see the table in “The mkvdk utility syntax” on page 89. -outlevel (num) Indicates which message types to display to the console. Valid values are determined by adding together the numbers that correspond to the desired message types.
Bulk submit options The mkvdk utility provides a variety of bulk submit options, as described in the following table: Option Description -bulk Interprets filespec as a bulk submit file. You can use this option with the -insert, -update, and -delete options. -offset num Specifies the offset into a bulk submit file or files. If you specify multiple bulk submit files and use the -offset option, the offset is applied to all of the bulk submit files.
Option Description -persist Services the collection repeatedly, at default intervals of 30 seconds. Use the -sleeptime option to set a different interval. -sleeptime sec Specifies the interval between service calls when the mkvdk utility is run with the -persist option. -optimize spec Performs various optimizations on the collection, depending on the value of spec. The specifier, spec, is a string consisting of keywords separated by hyphens, such as maxmerge-squeeze-readonly.
Deleting a collection The -purge option deletes all documents in a collection, but does not delete the collection itself. To delete a collection, use operating system commands, such as the rm command on UNIX, to remove the collection directory structure and control files. Optimization keywords The following table describes the optimization keywords for the -optimize option: Keyword Description maxclean Performs the most comprehensive housekeeping possible, and removes out-of-date collection files.
You can safely squeeze deleted documents for a collection at anytime, because the mkvdk utility ensures that the collection is available for searching and servicing through its self-administration features. The application does not need to temporarily disable a collection to squeeze deleted documents, because when a squeeze request is made, the mkvdk utility assigns a new revision code to the collection.
CHAPTER 9 Indexing Collections with Verity Spider This chapter contains basic Verity Spider information and explains how to index documents on your website. Contents About Verity Spider . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101 About Verity Spider syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103 Core options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
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.
Multithreading Since version 3.1, Verity Spider has separated the gathering and indexing jobs into multiple threads for concurrence. Verity Spider V3.7 can create concurrent connections to web servers for fetching documents, and have concurrent indexing threads for maximum utilization. This translates to an overall improvement in throughput. In previous releases, work was done in a round-robin manner, so that at any given time, only one job was running.
At its most basic level, a Verity Spider command consists of the following: vspider -initialize -collection coll [options] Where -initialize is -start or -refresh (when starting points have changed), and -collection is required to provide a target for the Verity Spider, and [options] can be a nearlimitless combination of the options described later in this chapter.
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 Web The URL or URLs from which Verity Spider is to begin indexing.
Core options The following sections describe the Verity Spider core options. -cmdfile Syntax: -cmdfile path_and_filename Specifies that Verity Spider reads command-line syntax from a file, in addition to the options passed in the command-line. This option includes the pathname to the file that contains the command-line syntax. The -cmdfile option circumvents command-line length limits.
-style Syntax: -style path Specifies the path to the style files to use when creating a new collection. If the -style option is not specified, Verity Spider uses the default style files in cf_root/lib/ common/style. Note: You can safely omit the -style option when resubmitting an indexing job, as the style information will already be part of the collection. If you are using the -cmdfile option, you can leave it there. Processing options The following sections describe the Verity Spider processing options.
-maxindmem Syntax: -maxindmem kilobytes Specifies the maximum amount of memory, in kilobytes, used by each indexing thread. Specify the number of threads with the -indexers option. By default, each indexing thread uses as much memory as is available from the system. -maxnumdoc Syntax: -maxnumdoc num_docs Specifies the maximum number of documents to download or submit for indexing. The value for num_docs does not necessarily correspond to the number of documents indexed.
-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 Specifies that Verity Spider gathers document locations without indexing them.
-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. To use regular expressions, also specify the -regexp option. Use this option when you leave duplicate detection enabled and do not specify the -nodupdetect option.
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 filename is the text-only command file that contains the following (along with any other necessary options): -processbif 'fix_bif !*' Your command file will include other options as well.
-temp Syntax: -temp path Specifies the directory for temporary files (disk cache). By default, the temp directory is under the job directory (optionally specified with the -jobpath option). If you do not specify a value for this option, Verity Spider creates a /spider/temp directory within the collection. For multiple-collection tasks, the first collection specified is used.
-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/" Verity Spider sends some predefined headers, such as Accept and User-Agent, by default. Special headers are sometimes necessary to correctly index a site. For example, earlier versions of Verity Spider did not support the Host header, which is needed for Virtual Host indexing.
You cannot use the question mark (?) wildcard, and the -regexp option does not let you use regular expressions. In Windows, include double-quotation marks around the argument to protect the asterisk special character (*). 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 -cmdfile option). Note: You must have valid Verity Spider licensing capability to use this option.
Path and URL options The following sections describe the Verity Spider path and URL options. -auth Syntax: -auth path_and_filename Specifies an authorization file to support authentication for secure paths. Use the -auth option to specify the authorization file. The file contains one record per line. Each line consists of server, realm, username, and password, separated by whitespace.
-followdup Specifies that Verity Spider follows links within duplicate documents, although only the first instance of any duplicate documents is indexed. You might find this option useful if you use the same home page on multiple sites. By default, only the first instance of the document is indexed, while subsequent instances are skipped.
-nofollow Type: Web crawling only Syntax: -nofollow "exp" Specifies that Verity Spider cannot follow any URLs that match the exp expression. If you do not specify an exp value for the -nofollow option, Verity Spider assumes a value of "*", where no documents are followed. You can use wildcard expressions, where the asterisk (*) is for text strings and the question mark (?) is for single characters. Always encapsulate the exp values in double-quotation marks to ensure that they are properly interpreted.
Example For the following URL, the path length would be four: http://www.spider:80/comics/fun/funny/world.html <-1-> <2> <-3-> <---4---> For the following file system path, the path length would be three: C:\files\docs\datasheets <-1-><-2-><---3---> The default value is 100 path segments. -refreshtime Syntax: -refreshtime timeunits Specifies not to refresh any documents that have been indexed since the timeunits value began.
Normally, when Verity Spider resolves host names, it uses DNS lookups to convert the names to canonical names, of which there can be only one per machine. This allows for the detection of duplicate documents, to prevent results from being diluted. In the case of multiple aliased hosts, however, duplication is not a barrier as documents can be referred to by more than one alias and yet remain distinct because of the different alias names. Example You can have both marketing.verity.com and sales.verity.
-include Specifies that only those files, paths, and URLs that match the specified expression or expressions will be followed.
Where the -exclude option prevents Verity Spider from even following anything that matches the specified expressions, the -indexclude option allows Verity Spider to follow anything while only skipping that which matches the specified expressions. For document types, use the -indmimeexclude option instead. Note: When specifying a URL, you must use full, absolute paths using the same format as appears in the HTML hyperlink. If the link is relative, you must change it to absolute to use it with -indexclude.
-indmimeexclude Syntax: -indmimeexclude mime_1 [mime_n] ... Specifies that only those MIME types that match the expressions be followed but not indexed. 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 -cmdfile option).
-indskip Syntax: -indskip HTML_tag "exp" Type: Web crawling only 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 -skip option.
-metafile Type: Web crawling only Syntax: -metafile path_and_filename Allows you to 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. Currently, the only header fields of real value are "Last-Modified" and "Content-Length.
-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 -cmdfile option). The default is to include all MIME types.
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" -skip p "*internal use*" See also -regexp. Locale options The following sections describe the Verity Spider locale options. -charmap Syntax: -charmap name Specifies the character map to use. Valid values are 8859 or 850. The default value is 8859. -common Specifies the path to the Verity home directory, cf_root/lib/common.
Logging options The following sections describe the Verity Spider logging options. -loglevel Syntax: -loglevel [nostdout] argument Specifies the types of messages to log. By default, messages are written to standard output and to various log files in the subdirectory named /log beneath the Verity Spider job directory. If you add nostdout to the -loglevel option, messages are not written to standard output. Log files, however, are still created.
Loglevel arguments Description debug Includes the following message types: information, warning, error, badkey, progress, summary, skip, debug Note: Only use this argument at the direction of Verity technical support or for troubleshooting indexing problems. trace Includes the following message types: information, warning, error, badkey, progress, summary, skip, debug, trace Note: Only use this argument at the direction of Verity technical support or for troubleshooting indexing problems.
Setting MIME types You can use the MIME type criteria options, -mimeinclude, -indmimeinclude, -mimeexclude, and -indmimeexclude, to include or exclude MIME types. Syntax restrictions When you specify MIME type criteria, keep in mind the restrictions described in the following sections. Using the wildcard character (*) The asterisk (*) wildcard character does not operate as a regular expression for the value of the MIME type criteria.
You can examine the indexing job’s log files for indications that files are being skipped due to MIME types. For example, a typical ASCII file you might want indexed is a log file (filename.log). Unless the web server understands that files with .LOG extensions are ASCII text, of MIME type text/plain, you will see in the indexing job log file that .
Known MIME types for file system indexing The following table lists the MIME types that Verity Spider recognizes when indexing file systems: Format MIME type Extension HTML text/html htm, html ASCII text/plain txt, text ASCII, source files text/plain c, h, cpp, cxx PDF application/pdf pdf MS Word application/msword doc MS Excel application/excel xls MS PowerPoint application/vnd.ms-powerpoint ppt WordPerfect 5.1 application/wordperfect5.
Chapter 9: Indexing Collections with Verity Spider
CHAPTER 10 Searching Collections with K2 Server This chapter provides information about how to configure the Verity K2 Server, which is installed with ColdFusion MX. Contents Using K2 Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133 Stopping K2 Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135 The k2server.ini parameter reference . . . . . . . . . . . . .
To edit the k2server.ini file: 1 Open the k2server.ini file in your text editor. Tip: Use your text editor’s search function to locate the appropriate code. For example, to locate the settings for the port number, as described in the next step of this procedure, search for portNo=. Note: If you did not install ColdFusion MX into the default directory, edit the paths in this procedure to reflect the appropriate directories.
Note: To search multiple collections, use a comma-delimited list. For example, use collection="test_01_file,test_02_file" in your cfsearch tag. Within a single cfsearch tag, the collections must be either all K2 Server-registered or all ColdFusion-registered; you cannot use one cfsearch tag to search a K2 Server-registered collection and a ColdFusion-registered collection.
Stopping K2 Server when run as a service To halt K2 Server when it is running as a Windows service, do either of the following: • Open the Services Control Panel and stop the K2 Server service. • Open a command window and enter the following command: k2server -ntService 0 Stopping K2 Server when run as an application When K2 Server is running as an application in a command window, you stop it by pressing Ctrl+C to kill the process in the window where it is running.
Parameter Description portNo The TCP port number for client connections. The value of portNo is the same value assigned to portNo in the k2broker.ini file that identifies the broker referring to this server. numListeners The maximum number of clients that can connect to the server at one time. The numListeners value must be equal to or greater than the sum of all numThreads values specified by all K2 Brokers in the K2 search system. The numThreads value is set for a K2 Broker in the k2broker.ini file.
Keyword Description locale The name of the locale (combination of language, dialect, and character set) to use for all internal Verity engine operations. This name must correspond to a subdirectory in the common directory where the configuration file for the locale is found and where the message database and other locale-specific files are located. Leaving this parameter null means that the server uses the default internal locale, which is “english” written in the “850” character set.
Increment the block label for each collection that you configure, starting with Coll-0. The following table describes the keywords used to configure each collection and search service: Keyword Description collPath The pathname identifying the collection home directory. collAlias An arbitrary name used to identify the collection. topicSet The pathname to a directory for the default topic set, which is an indexed set of topics.
Keyword Description charMap A string that names the character set to use for strings that are sent into the server and generated by the server. This string must match the name of a .cs file in the root of the common directory that configures a character set and its mappings. If not specified, the value of the charMap parameter from the server section is used.
rck2 command Description c The list of collections to search. Multiple collections must be specified in a space-separated list. For example: c coll1 coll2 coll3 f The list of fields to retrieve. For example: f k2dockey title date s The query (or question) to be used to process the search. The query can be expressed as words and phrases separated by commas. Additionally, the query can include Verity query language, operators and modifiers.
Chapter 10: Searching Collections with K2 Server
CHAPTER 11 Searching Collections with the rcvdk Utility This chapter provides information about using the rcvdk utility to search Verity collections. Contents Using the Verity rcvdk utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143 Attaching to a collection using the rcvdk utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144 Viewing results of the rcvdk utility. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
The help command produces the following list of available commands: RC> help Available commands: search s Search documents. results r Display search results. clusters c Display clustered search results. view v View document. summarize z Summarize documents. attach a Attach to one or more collections. detach d Detach from one or more collections. quit q Leave application. about Display VDK ‘About’ info help ? Display help text; ‘help help’ for details. expert x Toggle expert mode on/off.
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. You can use the options in the following table: Option Description r Displays the results list, starting with the first document. A maximum of 24 documents are displayed. rn Displays the results list, starting with the nth document. A maximum of 24 documents are displayed.
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. VdkVgwKey The document key used by the Verity engine to manage the document.
17: Custom Zone Definitions 18: The KeyView Filter Kit RC> Displaying multiple fields You can specify multiple fields with the fields command, as shown in the following example. The field order corresponds to the order of the columns, with the first field specified appearing in the second column. The first column is reserved for the rank order. Rerun the search before you display the results list with the fields specified.
Chapter 11: Searching Collections with the rcvdk Utility
CHAPTER 12 Troubleshooting Collections with Verity Utilities This chapter provides information about using Verity utilities to configure, maintain, and troubleshoot Verity collections. Contents Overview of Verity utilities. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149 Using the Verity didump utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150 Using the Verity browse utility . . . . . . . . . . .
Using the Verity didump utility Using the didump utility, you can view key components of the word index per partition. The word list is a list of all words indexed by the Verity engine. The zone list is a list of all zones and the zone attribute list is a list of the zone attributes found by the Verity engine. The didump executable, which starts the didump application, is located in the cf_root\lib\_nti40\bin directory in Windows, and the cf_root/lib/platform/bin directory on UNIX.
Viewing the zone list with the didump utility The zone list contains a list of the zones identified by the zone filter. You can search the zones listed using the Verity IN operator in a query. To view the contents of the zone list, use the didump utility with the -zones flag plus the pathname to a partition, like the following: didump -zones /z/collbldg/html/parts/00000003.did This partition is for a collection containing the Verity Collection Building Guide in HTML format.
The columns in the display indicate the following: • • • Size The number of bytes used by the Verity engine to store information about the zone attribute Doc The number of unique documents in which the zone attribute appears Word The total number of occurrences of a zone attribute for the partition Using the Verity browse utility A documents table is built for each partition in a collection. The documents table is used for field searching and for sorting search results.
Displaying fields You can use several options to control the display of field information. To display all the document fields: 1 At the Action prompt, enter ## 2 Press Return twice to display the fields for the first document record. 3 Press Return to view the document fields for the next sequential record. The following partial display of the results of the browse command includes internal fields, used by the Verity search engine. An internal field name starts with an underscore character (_).
Merging collections using the merge utility The following is the syntax for using the merge utility to merge multiple collections into a single collection: merge [srcCollectionN] The utility reads srcCollection1, srcCollection2 and so on and merges them into a single collection with the directory name given for newCollection If the directory name given for newCollection does not exist, it is created.
CHAPTER 13 Verity Error Messages This chapter provides information about error messages that might occur when using Verity in either VDK mode or K2 mode. Contents VDK mode error codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155 K2 mode error codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Error code No. Description VdkError_NestedFree (-18) VdkSessionFree called reentrantly. VdkError_Unsupported (-19) Using an unsupported feature. Error code No. Description VdkError_NoMsgDb (-20) Cannot find the message database. VdkError_FatalError (-21) Fatal error. VdkError_OutOfMemory (-22) Out of memory. VdkError_DiskFull (-23) Out of disk space. VdkError_NoFileHandles (-24) Out of file handles. VdkError_InvalidDoc (-25) Bad document ID or key (internal or external).
Error code No. Description VdkError_V3Legacy (-35) Unsupported legacy collection(s). VdkError_LocaleIncompat (-101) Collection and session locales are incompatible. VdkError_KBNotOpened (-102) Knowledge base is incompatible and cannot be opened. Error code No. Description VdkError_QueryParse (-40) Query has a parsing error. Query error codes Licensing error codes Error code No. Description VdkError_Signature (-50) Invalid/missing signature.
Error code No. Description VdkError_LicenseField (-117) No support for field search. VdkError_LicenseAccrue (-118) No support for the ACCRUE operator. VdkError_LicenseProximity (-119) No support for the proximity operators. VdkError_LicenseStem (-120) No stemming. VdkError_LicenseWildcard (-121) No support for wildcard queries. VdkError_LicenseTypo (-122) No support for typo assist. VdkError_LicenseOperator (-123) Unlicensed operator.
Error code No. Description VdkError_FilterLoadFailed (-144) Error occurred during filter initialization. VdkError_FileOpenFailed (-145) File could not be opened. Error code No. Description VdkError_CouldntLoadDLL (-200) Cannot load DLL. VdkError_NoSuchFunction (-201) Dispatch error codes Function not available. Warning error codes Error code No. Description VdkWarning_CollectionDown (10) The collection was down when it was opened.
Error code No. Description K2Error_BadHandleType (-11) Improper object type. K2Error_HandleNotFound (-12) Object not found. K2Error_MissingArgs (-13) Missing required arguments. K2Error_InvalidArgs (-14) Invalid arguments. K2Error_Unsupported (-19) Using an unsupported feature. Runtime error codes l Error code No. Description K2Error_NoMsgDb (-20) Cannot find the message database. K2Error_FatalError (-21) Fatal error. K2Error_OutOfMemory (-22) Out of memory.
Error code No. Description K2Error_CollPurge (-38) Purge failed due to problems deleting from any of the following directories: pdd, work, trans K2Error_CollPathTooBig (-39) Collection path supplied for the path member in K2CollectionOpenArgRec is too long. K2Error_LocaleIncompat (-101) Collection and session locales are incompatible. K2Error_KBNotOpened (-102) Knowledge base cannot be opened. Error code No. Description K2Error_QueryParse (-40) Query has a parsing error. ErrorCode No.
Warning error codes Error code No. Description K2Warning_CollectionDown (10) The collection was down when it was opened. K2Warning_QueryComplex (11) Too many matching words. K2Warning_LowMemory (12) Memory is low for indexing. K2Warning_CollectionReadOnly (13) The collection is read-only. K2Warning_DriverNotFound (14) Couldn’t locate specified driver. K2Warning_LargeToken (15) Returned a token greater than maxSize. K2Warning_ArgTooLarge (16) Argument too large.
INDEX A AddHandler directive 59 administration, initial tasks 17 Apache application isolation configuration 78 configuration overview 59 multihoming 66, 78 sample configuration files 63 apialloc property 63 application isolation enabling 77 overview 77 web server configuration 78 application variables 22 Archives and Deployment page, ColdFusion MX Administrator 25 B batch files 62 bootstrap property 63 browse utility 152 built-in web server overview 58 web root 58 C Cache Real Paths, disabling for multihom
layout 14 Mail Server page 23 Mappings page 22 Memory Variables page 22 password 70 RDS Password page 34 Sandbox Security page 35 Security section 34, 69 Server Settings section 18 Settings Summary page 26 user assistance, types of 14 Verity Collections page 26 Verity K2 Server page 27 Web Services page 27 ColdFusion MX, deploying 76 ColdFusion security 72 collections attaching to with the rcvdk utility 144 backing up with the mkvdk utility 98 creating with the mkvdk utility 91 deleting with the mkvdk utili
F failover 81 files and directories, security 72 H hosting application isolation 77 multihoming 65 httpd.
Microsoft Access with Unicode, connecting to 46 Microsoft Access, connecting to 44 Microsoft SQL Server, connecting to 47 migrating client variable data 21 mkvdk utility bulk insert and delete, using 97 getting started 91 inserting documents into collections 91 log file 90 mkvdk.
S sandbox adding 72 configuring 72 security, using 70 Sandbox Security page, ColdFusion MX Administrator 35 scriptpath property 63 scriptsrc attribute 65 security about 69 ColdFusion 72 data sources 72 directories and permissions, about 71 files and directories 72 IP/Port 73 RDS password 70 resources, restricting 71 root security context 72 sandbox, adding 72 sandbox, configuring 72 sandbox, using 70 Security section, ColdFusion MX Administrator 34, 69 Server Settings section, ColdFusion MX Administrator 18
W web root, built-in web server 58 Web Server Configuration Tool advanced configurations 65 batch files 62 cluster 82 command-line interface 60 configuration files 62 GUI mode 60 shell scripts 62 SSL 68 using 59 web servers built-in web server 58 configuring 59 configuring for load balancing and failover 81 external 59 overview 57 Web Services page, ColdFusion MX Administrator 27 wildcard, IIS 6 59 168 Index
