MACROMEDIA COLFUSION MX 7 - INSTALLING AND USING COLDFUSION MX Manual
Summary of COLFUSION MX 7 - INSTALLING AND USING COLDFUSION MX
Page 1
Coldfusion ® mx 7 configuring and administering coldfusion mx.
Page 2
Trademarks 1 step robopdf, activeedit, activetest, authorware, blue sky software, blue sky, breeze, breezo, captivate, central, coldfusion, contribute, database explorer, director, dreamweaver, fireworks, flash, flashcast, flashhelp, flash lite, flashpaper, flex, flex builder, fontographer, freehand...
Page 3: Contents
3 contents introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 part i: administering coldfusion mx 7 chapter 1: administering coldfusion mx . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 about the coldfusion mx administra...
Page 4
4 contents chapter 4: web server management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65 about web servers in coldfusion mx . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65 using the built-in web server . . . . . . . . . . . . . . . . . . . . . . . . . . ....
Page 5
Contents 5 chapter 10: using verity utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141 overview of verity utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141 using the mkvdk utility. . . . . . . . . . . . . . . . . . . . . ...
Page 6
6 contents.
Page 7: Introduction
Introduction 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 par...
Page 8
8 introduction: viewing online documentation all coldfusion mx documentation is available online in html and adobe acrobat portable document format (pdf) files. Go to the documentation home page for coldfusion mx on the macromedia website: www.Macromedia.Com . In addition, you can view the documenta...
Page 9: Part I
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 ch...
Page 11: Chapter 1
11 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, a...
Page 12
12 chapter 1: administering coldfusion mx 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 m...
Page 13: Chapter 2
13 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 func...
Page 14
14 chapter 2: using the coldfusion mx administrator 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: accessing user assistance you can obtain assistance from the coldfusion mx...
Page 15
Server settings section 15 getting started experience click the getting started link to open the getting started experience, which provides descriptions of new features, code examples, and sample applications to help you learn about coldfusion mx. Documentation click the documentation link to access...
Page 16
16 chapter 2: using the coldfusion mx administrator caching page the caching page of the administrator contains configuration options that you can set or enable to cache templates, queries, and data sources . These options can significantly affect server performance. The following table describes th...
Page 17
Server settings section 17 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 ...
Page 18
18 chapter 2: using the coldfusion mx administrator the following table compares the client variable storage options: migrating client variable data to migrate your client variable data to another data source, you should know the structure of the database tables that store this information. Client v...
Page 19
Server settings section 19 sample table creation page create table cdata ( cfid char(20), app char(64), data memo ) create unique index id1 on cdata (cfid,app) create table cglobal ( cfid char(20), data memo, lvisit date ) create index id2 on cglobal (cfid) create index id3 on cglobal (lvisit) memor...
Page 20
20 chapter 2: using the coldfusion mx administrator you can also specify whether to use j2ee session variables. When you enable the j2ee session variables, coldfusion creates an identifier for each session and does not use the cftoken or cfid cookie value. For more information, see coldfusion mx dev...
Page 21
Server settings section 21 mail server settings area the following table describes basic mail server settings: mail spool settings area the following table describes mail server spool settings: option description mail server enter a valid mail server for sending dynamic smtp mail messages in the tex...
Page 22
22 chapter 2: using the coldfusion mx administrator mail logging settings area select preferences for handling mail logs, as described in the following table: coldfusion mx writes sent mail and mail error logs to the following directories: • \cfusionmx7\logs (windows server configuration) • /opt/col...
Page 23
Server settings section 23 charting settings page the coldfusion charting and graphing engine lets you produce highly customizable business graphics, in a variety of formats, using the cfquery tag. You use the charting page in the administrator to control characteristics of the engine. The following...
Page 24
24 chapter 2: using the coldfusion mx administrator 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: note: this page is available in the server configuration only. Before coldfusion saves your changes, it...
Page 25
Data & services section 25 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...
Page 26
26 chapter 2: using 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 t...
Page 27
Debugging & logging section 27 the debugging settings page provides the following debugging options: * restart coldfusion mx after changing this setting. Option description enable robust exception information displays detailed information in the exceptions page, including the template’s physical pat...
Page 28
28 chapter 2: using the coldfusion mx administrator 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 ...
Page 29
Debugging & logging section 29 before you use the cfstat utility, ensure that you selected the enable performance monitoring check box in the coldfusion mx administrator (on the debugging & logging > debugging settings page). If you select this check box, you must restart coldfusion mx for this chan...
Page 30
30 chapter 2: using the coldfusion mx administrator logging settings page you use the logging settings page of the administrator to change coldfusion mx logging options. The following table describes the settings: * restart coldfusion mx after changing this setting. Log files page the log files page...
Page 31
Debugging & logging section 31 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 cfmail tag, update database tables, index verity collections, delete temporary files, and any other batch-st...
Page 32
32 chapter 2: using the coldfusion mx administrator 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 serve...
Page 33
Extensions section 33 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: • using c++ as a dynamic link library ...
Page 34
34 chapter 2: using the coldfusion mx administrator 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 ev...
Page 35
Security section 35 gateway instances page the gateway instances page lets you configure coldfusion event gateway instances to direct events from various sources to coldfusion components (cfcs) that you have written. The following table describes the settings: security section the security section o...
Page 36
36 chapter 2: using the coldfusion mx administrator 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...
Page 37
Enterprise manager section 37 • verity collections • scheduled tasks • event gateway instances • java applets • cfx tags • archive to do lists after you archive the information, you can use the administrator to deploy your web applications to the same coldfusion mx server or to a coldfusion mx serve...
Page 38
38 chapter 2: using the coldfusion mx administrator 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 serv...
Page 39
Administrator api 39 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 s...
Page 40
40 chapter 2: using the coldfusion mx administrator to use the administrator api: 1. Instantiate administrator.Cfc: // login is always required. Adminobj = createobject("component","cfide.Adminapi.Administrator"); tip: you can instantiate administrator.Cfc and call the login method in a single line ...
Page 41
Administrator api 41 storedproc = true, alter = false, grant = true, select = true, update = true, create = true, delete = true, drop = false, revoke = false ); the following example adds the same sql server data source, but uses the argumentcollection attribute to pass all method arguments in a str...
Page 42
42 chapter 2: using the coldfusion mx administrator //create a dsn. Myobj.Setmssql(argumentcollection=stdsn);.
Page 43: Chapter 3
43 chapter 3 data source management 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, coldfusio...
Page 44
44 chapter 3: data source management about jdbc jdbc is a java application programming interface (api) that you use to execute sql statements. Jdbc enables an application, such as coldfusion mx 7, to interact with a variety of database management systems (dbmss), without using interfaces that are da...
Page 45
Adding data sources 45 supplied drivers the following table lists the database drivers supplied with coldfusion mx and where you can find more information about them: to see a list of database versions that coldfusion mx supports, go to www.Macromedia.Com/go/sysreqscf . When running in the j2ee conf...
Page 46
46 chapter 3: data source management 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...
Page 47
Connecting to db2 universal database 47 guidelines for data sources when you add data sources to coldfusion mx, keep the following guidelines in mind: • data source names should be all one word. • data source names can contain only letters, numbers, hyphens, and the underscore character (_). • data ...
Page 48
48 chapter 3: data source management connection string a field that passes database-specific parameters, such as login credentials, to the data source. For udb on the initial connection, specify databasename, createdefaultpackage, replacepackage, and sendstringparametersasunicode (with no spaces), a...
Page 49
Connecting to informix 49 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: longtext buffer (chr) the default buffer size, used if t...
Page 50
50 chapter 3: data source management connecting to microsoft access use the settings in the following table to connect coldfusion mx to microsoft access data sources: timeout (min) the number of minutes that coldfusion mx maintains an unused connection before destroying it. Interval (min) the time (...
Page 51
Connecting to microsoft access 51 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....
Page 52
52 chapter 3: data source management 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): blob buffer the default buffer size, used if the blob option is not selected. The...
Page 53
Connecting to microsoft sql server 53 note: this driver uses the microsoft jet list of reserved words, including the word last. For a complete list, see http://support.Microsoft.Com/?Kbid=248738 . Connecting to microsoft sql server to see a list of sql server versions that coldfusion mx supports, go...
Page 54
54 chapter 3: data source management 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 stateme...
Page 55
Connecting to microsoft sql server 55 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 ...
Page 56
56 chapter 3: data source management • you are running a connection-limited version of sql server and the request exceeds the limit for tcp/ip connections. You can prevent this exception by setting the limit connections and restrict connections to options in coldfusion mx administrator on the advanc...
Page 57
Connecting to odbc socket 57 connecting to odbc socket use the settings in the following table to connect coldfusion mx to odbc socket data sources (this is a type 3 driver): limit connections specifies whether coldfusion mx limits the number of database connections for the data source. If you enabl...
Page 58
58 chapter 3: data source management 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 cfquery tag). Description (optional) a description for this connection. Connection string a ...
Page 59
Connecting to oracle 59 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 (ds...
Page 60
60 chapter 3: data source management connecting to other data sources use the settings in the following table to connect coldfusion mx to data sources through jdbc drivers that do not appear in the drop-down list of drivers: login timeout (sec) the number of seconds before coldfusion mx times out th...
Page 61
Connecting to other data sources 61 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 db2 username a user...
Page 62
62 chapter 3: data source management • on subsequent connections, specify locationname, collectionid, and sendstringparametersasunicode, as the following example shows: locationname=sample;collectionid=default; sendstringparametersasunicode=false note: db2 os/390 refers to all supported versions of ...
Page 63
Connecting to jndi data sources 63 connecting to jndi data sources use the settings in the following table to connect coldfusion mx to jndi data sources that have been defined for a j2ee application server (multiserver and j2ee configurations only): restrict connections to specifies the maximum numb...
Page 64
64 chapter 3: data source management note: the coldfusion mx administrator does not display the jndi data source option when running in the server configuration. Password the password that coldfusion mx passes to jndi to connect to the data source if a coldfusion application does not supply a passwo...
Page 65: Chapter 4
65 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. The information in this cha...
Page 66
66 chapter 4: web server management using the built-in web server the coldfusion mx server configuration is built on top of jrun, which includes the jrun web server (jws), also called the built-in web server. Although not intended for use in a production environment, the built-in web server is parti...
Page 67
Using an external web server 67 • 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...
Page 68
68 chapter 4: web server management web server configuration coldfusion mx uses the web server configuration tool to configure an external web server with the modules and settings that the connector needs to connect to coldfusion mx. You can run the web server configuration tool through either the c...
Page 69
Web server configuration 69 9. (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 ...
Page 70
70 chapter 4: web server management using the batch files and shell scripts the coldfusion mx server configuration includes batch files and shell scripts that implement typical command-line connector configurations. These files are in the cf_root/bin/connectors directory. For example, the iis_connec...
Page 71
Web server configuration 71 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 coldfus...
Page 72
72 chapter 4: web server management 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. Each time you run the web server confi...
Page 73
Web server configuration 73 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" jrunconfig verbose false...
Page 74
74 chapter 4: web server management nametrans fn="document-root" root="$docroot" pathcheck fn="nt-uri-clean" pathcheck fn="check-acl" acl="default" pathcheck fn="find-pathinfo" pathcheck fn=find-index index-names="index.Jsp,index.Html,home.Html,index.Cfm" pathcheck fn="jrunfilter" objecttype fn=type...
Page 75
Multihoming 75 multihoming configuration tasks include the following: enabling access to the coldfusion mx administrator 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 po...
Page 76
76 chapter 4: web server management 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 ...
Page 77
Multihoming 77 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 o...
Page 78
78 chapter 4: web server management.
Page 79: Chapter 5
79 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 applica...
Page 80
80 chapter 5: deploying coldfusion applications perform the following steps when you archive and deploy site information: 1. 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...
Page 81
Packaging applications in j2ee archive files 81 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: 1. Open the coldfusion mx adm...
Page 82
82 chapter 5: deploying coldfusion applications 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 configurati...
Page 83
Using the cfcompile utility 83 the following table describes these parameters: sourceless distribution you can use the cfcompile utility with the -deploy option to create coldfusion pages (cfm, cfc, and cfr files) that contain java bytecode. You can then deploy the bytecode versions of the coldfusio...
Page 84
84 chapter 5: deploying coldfusion applications.
Page 85: Chapter 6
85 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 . . . . . . . . ....
Page 86
86 chapter 6: administering security the security area in the administrator lets you do the following tasks: • configure password protection for the coldfusion mx administrator. For more information, see “coldfusion mx administrator password protection” on page 86 . • configure password protection f...
Page 87
Using sandbox security 87 to use sandbox security in the multiserver and j2ee editions, the application server must be running a security manager ( java.Lang.Securitymanager ) and you must define the following jvm arguments (for macromedia jrun, this is the java.Args line in the jrun_root/jvm.Config...
Page 88
88 chapter 6: administering security 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 o...
Page 89
Using sandbox security 89 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 t...
Page 90
90 chapter 6: administering security 12. 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 88 . Note: the files/dirs tab works together with the file-based ...
Page 91: Chapter 7
91 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 indi...
Page 92
92 chapter 7: using multiple server instances 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 ad...
Page 93
Defining additional server instances 93 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 execute...
Page 94
94 chapter 7: using multiple 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 se...
Page 95
Enabling application isolation 95 to use multiple server instances for application isolation: 1. 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. 2. Using you...
Page 96
96 chapter 7: using multiple server instances 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 de...
Page 97
Enabling application isolation 97 #jrunconfig proxyretryinterval 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 namevirtualhost 127.0.0.1 serveradmin admi...
Page 98
98 chapter 7: using multiple server instances namevirtualhost 127.0.0.1 serveradmin admin@mysite.Com documentroot "c:/program files/apache group/apache2/htdocs" servername rnielsen02 errorlog logs/error.Log serveradmin admin@mysite.Com documentroot "c:/program files/apache group/apache2/htdocs2" ser...
Page 99
Enabling clustering for load balancing and failover 99 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 serv...
Page 100
100 chapter 7: using multiple server instances 8. (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 ins...
Page 101
Defining remote server instances to the coldfusion mx administrator 101 22. (optional) store the application’s coldfusion files in your external web server root directory. 23. Test the application to ensure that load balancing and failover work as expected. Defining remote server instances to the co...
Page 102
102 chapter 7: using multiple server instances.
Page 103: Part II
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 ver...
Page 105: Chapter 8
105 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 (...
Page 106
106 chapter 8: introducing verity and verity tools 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 applicati...
Page 107
About the verity utilities 107 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 (ad...
Page 108
108 chapter 8: introducing verity and verity tools.
Page 109: Chapter 9
109 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 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ...
Page 110
110 chapter 9: indexing collections with verity spider 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 re...
Page 111
About verity spider syntax 111 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 ma...
Page 112
112 chapter 9: indexing collections with verity spider 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 ind...
Page 113
About verity spider syntax 113 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 repor...
Page 114
114 chapter 9: indexing collections with verity spider 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. T...
Page 115
Processing options 115 -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 ...
Page 116
116 chapter 9: indexing collections with verity spider -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 avail...
Page 117
Processing options 117 -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 siz...
Page 118
118 chapter 9: indexing collections with verity spider -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 a...
Page 119
Processing options 119 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 -cmdfile option. For example, if you want to use a script called fix_bif to add customized information to bif files, use the following com...
Page 120
120 chapter 9: indexing collections with verity spider if a halt occurs during indexing, the chunk of documents specified by the -submitsize option is 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 t...
Page 121
Networking options 121 -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 spi...
Page 122
122 chapter 9: indexing collections with verity spider -noproxy type: web crawling only syntax: -noproxy name_1 [name_n] ... Used in conjunction with the -proxy option, the -noproxy option specifies that verity spider directly access the hosts whose names match those specified. By default, when you ...
Page 123
Path and url options 123 -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...
Page 124
124 chapter 9: indexing collections with verity spider 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 -start option, those parameters are processed and any resulting pages are indexed and...
Page 125
Path and url options 125 -https type: web crawling only lets you index ssl-enabled websites. Note: you must have the verity ssl option pack installed to use the -https option. The verity ssl option pack is a verity spider add-on available separately from a verity salesperson. -jumps type: web crawli...
Page 126
126 chapter 9: indexing collections with verity spider -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 ...
Page 127
Path and url options 127 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 -refresh option. When you use vsdb -recreate , the last indexed date is cleared. -...
Page 128
128 chapter 9: indexing collections with verity spider 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. -excl...
Page 129
Content options 129 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 com...
Page 130
130 chapter 9: indexing collections with verity spider 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 esc...
Page 131
Content options 131 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 com...
Page 132
132 chapter 9: indexing collections with verity spider 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. You can use wi...
Page 133
Content options 133 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 retur...
Page 134
134 chapter 9: indexing collections with verity spider -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 ...
Page 135
Locale options 135 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 follow...
Page 136
136 chapter 9: indexing collections with verity spider -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: c...
Page 137
Maintenance options 137 choose one of the following arguments to determine which message types are logged: maintenance options the following sections describe the verity spider maintenance options. -nooptimize prevents verity spider from optimizing the collection, thus reducing processing overhead d...
Page 138
138 chapter 9: indexing collections with verity spider -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-r...
Page 139
Setting mime types 139 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 an...
Page 140
140 chapter 9: indexing collections with verity spider 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 lon...
Page 141: Chapter 10
141 chapter 10 using verity utilities this chapter provides information about using verity utilities to configure, maintain, and troubleshoot verity collections. Contents overview of verity utilities. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ....
Page 142
142 chapter 10: using verity utilities 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...
Page 143
Using the mkvdk utility 143 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 -loglevel command and specify the numeric identifier for th...
Page 144
144 chapter 10: using verity utilities 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: 1. Set up a colle...
Page 145
Using the mkvdk utility 145 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 uti...
Page 146
146 chapter 10: using verity utilities examples: processing documents the following examples show the commands for processing documents. Using the default options by default, the mkvdk command submits and indexes documents specified in the command, and services the specified collection. The followin...
Page 147
Using the mkvdk utility 147 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...
Page 148
148 chapter 10: using verity utilities message options the mkvdk utility provides a variety of messaging options, as described in the following table: document processing options the mkvdk utility provides a variety of document processing options, as the following table describes: dataprep same as s...
Page 149
Using the mkvdk utility 149 bulk submit options the mkvdk utility provides a variety of bulk submit options, as described in the following table: using bulk insert and delete options the bulk submit feature supports the insertion of documents and related field values into collections. To use the bul...
Page 150
150 chapter 10: using verity utilities collection maintenance options the mkvdk utility provides a variety of collection maintenance options, as described in the following table: examples: maintaining collections the following examples show the commands for maintaining a collection. Repairing a coll...
Page 151
Using the mkvdk utility 151 deleting a collection to delete a collection, use the appropriate command for your operating system. For example, to remove the collection directory structure and control files on a unix system, use the following command: rm -r -collection_path purging a collection the fo...
Page 152
152 chapter 10: using verity utilities about squeezing deleted documents when a document is deleted from a collection, its space is not recovered. It is merely marked as deleted and not available for subsequent searches. Squeezing actually removes deleted documents from the collection’s internal doc...
Page 153
Using the rck2 utility 153 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 reseri...
Page 154
154 chapter 10: using verity utilities the rck2 command options the following table describes rck2 command options: using the rcvdk utility using the verity rcvdk utility, you can check the contents of a collection from the command line. The rcvdk utility lets you write a variety of queries, using w...
Page 155
Using the rcvdk utility 155 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> the help command produces the following list of available commands: rc> help available commands: search s search docume...
Page 156
156 chapter 10: using verity utilities 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 filter.Troublesho...
Page 157
Using the rcvdk utility 157 the following table describes each of the default fields: displaying more fields you can tell the rcvdk utility to display certain fields in the results list using the fields command, which is available in the expert mode. To go to the expert mode, enter x or expert at th...
Page 158
158 chapter 10: using verity utilities 14: supported field types 15: 16: recognized document types 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 corresp...
Page 159
Using the didump utility 159 acronym 5 1 2 acronyms 4 1 1 actual 4 1 1 administrator 3 1 1 advance 3 1 1 all 8 2 3 also 9 2 4 always 4 1 1 always 9 2 3 ampersand 4 1 1 the columns in the display indicate the following: size the number of bytes used by the verity engine to store information about the...
Page 160
160 chapter 10: using verity utilities size the number of bytes used by the verity engine to store information about the zone. Doc 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...
Page 161
Using the browse utility 161 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\_n...
Page 162
162 chapter 10: using verity utilities 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...
Page 163
Using the merge utility 163 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 explic...
Page 164
164 chapter 10: using verity utilities.
Page 165: Index
165 index a addhandler directive 67 administration, initial tasks 14 administrator api about 39 enabling access through sandbox security 36 apache application isolation configuration 96 configuration overview 67 multihoming 76, 96 sample configuration files 73 api, administrator 39 apialloc property...
Page 166
166 index coldfusion mappings j2ee archive 82 coldfusion mx administrator about 11 caching settings page 16 cf admin password page 35 cfx tags page 33 charting page 23 client variables page 17 cluster manager page 38 code compatibility analyzer page 32 coldfusion archives page 36 corba connectors pa...
Page 167
Index 167 debugging ip addresses page, coldfusion mx administrator 29 debugging settings page, coldfusion mx administrator 26 didump utility executable 158 using 158 word list, viewing 158 zone attribute list, viewing 160 zone list, viewing 159 directory structure, expanded 92 distribution, sourcele...
Page 168
168 index jrun management console (jmc) cluster creation 99 creating server instances 93 starting and stopping jrun 93 jrun servers creating 93 custom jvm.Config 94 jrun web server. See built-in web server jrun.Dll 67 jrun.Ini file 71 jrun.Trusted.Hosts 100 jrun_iis6.Dll 67 jrun_iis6_wildcard.Dll 67...
Page 169
Index 169 multiserver configuration application isolation 94 clustering 99 defining server instances 93 multiple server instances 91 mysql, connecting to 56 n netscape enterprise server (nes) about configuration 67 see also sun one web server network connection, required for clustering 99 o obj.Conf...
Page 170
170 index simple mail transfer protocol (smtp) mail server 20 sourceless distribution 82, 83 ssl property 72 sticky sessions 100 sun one web server about configuration 67 application isolation configuration 98 multihoming 77 sample configuration file 73 sybase, connecting to 62 u unicode, microsoft ...