cqtsadmin-dbset-userdb.xml

cqtsadmin-dbset-userdb.xml is a full-text search administrator configuration file that the cqtsadmin.pl Perl script generates and uses. The file contains data about your deployment, which you can further customize.

cqtsadmin-dbset-userdb.xml is one of two components of the full-text search administrator tool. The other component is the cqtsadmin.pl Perl script, which automates the steps to set up, configure, and administer HCL Compass full-text search.

The cqtsadmin-dbset-userdb.xml configuration file contains XML elements that represent full-text search settings used by the cqtsadmin.pl Perl script. Each element contains these tags:

Table 1. cqtsadmin`-dbset-userdb`.xml XML element format
Tag	Description
`<description>`	Explains the purpose of the XML element
`<note>`	Provides additional noteworthy information about the tag
`<defaultValue>`	Contains the default value of the XML element
`<newValue required="yes">`	Might contain a new overriding value to replace the default value in the `<defaultValue>` tag. The value of `<newValue>` is set based on parameters that you specify in the command-line option or that are gathered from the HCL Compass database or operating system. You can also change this value by directly editing the file. Note: Required configuration elements have the `<newValue required="yes">` XML attribute .

In the following example, the <dbSet> XML element has a description, a note, and a default value of TextSearch. The <newValue required="yes"> tag overrides the default value of TextSearch with the 8.0.0 value , which is based on the command-line parameter used for the -userdb option.

<dbSet>
	<description>The CQ schema repository (database-set) name for which you want to enable CQ FTS.</description>
	<note>You need to provide this data as the default may not be appropriate (it's specific to your CQ database).</note>
	<defaultValue>TextSearch</defaultValue>
			<newValue required="yes">8.0.0</newValue>
</dbSet>

cqtsadmin-dbset-userdb.xml XML elements

Table 2. cqtsadmin-dbset-userdb.xml XML element tags
Tag name	Description	Notes
<dbSet>	The HCL Compass database set name.	The default value of this tag is automatically generated by the cqtsadmin.pl tool. You do not have to modify it. The value of this tag is based on the HCL Compass database set that is specified in the command-line argument to the cqtsadmin.pl tool at initial setup.
<userDB>	The HCL Compass user database name.	The default value of this tag is automatically generated by the cqtsadmin.pl tool. You do not have to modify it. The value for this tag is based on the HCL Compass user database name that is specified in the command-line argument to the cqtsadmin.pl tool at initial setup.
<siteName>	The HCL Compass site name.	The default value of this tag is automatically generated by the cqtsadmin.pl tool. You do not need to modify it. The value for this tag is based on your HCL Compass database type. If your database is not replicated, the value is `<local>`. Otherwise, the value is the name of your master replica.
<enableAtSites>	Comma-separated list of sites where HCL Compass full-text search will be enabled.	The default value of this tag is automatically generated by the cqtsadmin.pl tool. You do not have to modify it. The value for this tag is based on your HCL Compass database type. If your database is not replicated, this value is ignored. If your database is replicated, the default value is empty, which enables HCL Compass full-text search at all sites. To enable HCL Compass full-text search at selected sites, list the site names in this XML tag using a comma as a separator.
<entityFile>	The HCL Compass full-text search entity file.	The default value of this tag is automatically generated by the cqtsadmin.pl tool. You do not need to modify it. The value of this tag is the path to the automatically generated entity file for your HCL Compass full-text search deployment. The default file is Entity`-dbset-userdb`.txt, which is a text file that lists the record types and their fields to search.
<ftsWASProfileName>	The full-text search WebSphere® Application Server profile name.	The default value of this tag is automatically generated by the cqtsadmin.pl tool. You do not have to modify it. The profile naming conventions are `cqsearchprofile_db-set-name_user-db-name`, where `db-set-name` and `user-db-name` are determined from the command-line parameters that are passed to cqtsadmin.pl. If the resulting profile name exceeds 27 characters, then the`cqsearchprofile_db-set-name_user-db-name` profile name is abbreviated as `cqfts_db-set-name user-db-name`. If the profile name still exceeds 27 characters, shorten `db-set-name` or `user-db-name`. If this is not possible, provide your own profile name by replacing the value in this XML tag with a profile name that is unique on the computer that you are deploying full-text search, for example, `MyProfile_1`.
<ftsWASProfileHome>	The path to the HCL Compass full-text search WebSphere Application Server profile home directory.	The default value of this tag is automatically generated by the cqtsadmin.pl tool. You do not have to modify it. The value of this path is automatically determined when using the fts_was_profile_homecommand-line option. Otherwise, the default %COMPASS_HOME%/cqweb/ path is used. Note: Use the fts_was_profile_home command-line option to define a WebSphere Application Server profile home directory path when you deploy your full-text search WebSphere Application Server profiles .
<ftsWASProfilePort>	The HCL Compass full-text search WebSphere Application Server profile port number, for use with the full-text search deployment of this user database.	The default value of this tag is automatically generated by the cqtsadmin.pl tool. You do not have to modify it. The `cqsearchprofile` default value of the initial HCL Compass full-text search WebSphere Application Server profile is 14080. When you create a new WebSphere Application Server profile for a new full-text search deployment, the port value is automatically generated by using the next available port on your server, starting with 15080 and increasing in increments of 1000 for additional full-text search deployments. For example, the port values would be as follows: 15080, 16080, 17080, and so on.
<ftsWASProfilePortsDefPropFile>	The path to the HCL Compass full-text search WebSphere Application Server profile ports file. Use this path with thecreate_fts_was_profile command-line option for the user database full-text search deployment. If you must specify the ports, use the was_profile_ports_file command-line option.	The default value of this tag is automatically generated by the cqtsadmin.pl tool. You do not have to modify it. By default, WebSphere Application Server profile ports are automatically determined for HCL Compass full-text search WebSphere Application Server profiles that you create using the create_fts_was_profile command-line option. However, if you must specify your own ports, use the command-line option was_profile_ports_file command-line option to provide the path to a file with port information to be used as a template. When you specify a port, this WebSphere Application Server profile ports file is copied to your current full-text search deployment home directory, and this tag is automatically updated to point to the full-text search home directory instance of the file. Do not change the value of this tag unless you require finer control over the setup, or you are trying to resolve an issue.
<ftsWASProfileMaxHeapSize>	The maximum Java virtual machine (JVM) heap size for the WebSphere Application Server profile in megabytes.	The default value of this tag is 4096, which means that the JVM maximum heap size can be up to 4 GB. During indexing, particularly batch indexing, if you receive out-of-memory errors in your full-text search WebSphere Application Server profile (Solr), increase the heap size to help eliminate this issue. Start with an increment of 2 GB."
<ftsServerName>	The host or server name on which this HCL Compass full-text search deployment is being set.	The default value of this tag is automatically generated by the cqtsadmin.pl tool. You do not have to modify it. The value for this tag is set to the server name on which you are deploying full-text search. Change this name only if you rename your computer or move your deployment to a server that has a different name. Note: If you change this value, you must supply a fully qualified and universally accessible host name. If you are using load balancing or full-text search in a HCL Compass MultiSite replicated database configuration, the host name must be accessible from allHCL Compass Web servers.
<enableCQFTS>	This tag is set to `TRUE` to enable the Full Text radio button in HCL Compass Web.	The default value of this tag is automatically generated by the cqtsadmin.pl tool. You do not have to modify it. This tag has two values: `TRUE` and anything else, or empty. When set to `TRUE`, the Full Text radio button in HCL Compass Web is enabled during setup. Otherwise, this step is skipped. Do not change the value of this tag unless you require finer control over the setup, or you are trying to resolve an issue. Attention: Do not set the value to `FALSE` to disable the radio button if the user database is fully or partially indexed but is not replicated. Disabling the radio button disables creating oplogs for non-replicated HCL Compass databases. Therefore, full-text search does not track changes to HCL Compass records, and changed records are never reindexed. If you set the value to `FALSE` and records are changed, you must completely reindex the database. If you must set the value to `FALSE`, you must prevent changes to the HCL Compass record until the value is reset to `TRUE`.
<runBatchIndex>	This tag is set to `TRUE` to enable batch indexing to start during full-text search setup.	The default value of this tag is automatically generated by the cqtsadmin.pl tool. You do not have to modify it. This tag has two values: `TRUE` and anything else, or empty. When this tag is set to `TRUE` ,the batch-mode indexer runs during setup. Otherwise, this step is skipped. Skipping the batch indexing means that all existing records are not indexed and are not searchable. Therefore, search results will be incomplete.
<startUpdateIndex>	This tag is set to`TRUE` to enable update indexing to start during full-text search setup.	The default value of this tag is automatically generated by the cqtsadmin.pl tool. You do not have to modify it. This tag has two values: `TRUE` and anything else, or empty. When the value is set to `TRUE`, the update-mode indexer is configured to load when the WebSphere Application Server profile starts. Otherwise, this step is skipped. Skipping the update indexing means that all modified or newly added records are not indexed after the initial batch indexing and are not searchable. Therefore, search results will be incomplete.
<batchIndexJVMParm>	The JVM parameter setting that the batch-mode indexer uses.	The default value of this tag is `-Xmx4096m`, which means that the batch-mode indexer can use up to 4 GB of RAM. If you receive out -of-memory errors during batch indexing, either decrease the batch size or number of threads or increasing the JVM value to -Xmx8192m. Because this JVM parameter value is passed as-is to the batch-mode indexer, use correct values as specified in the JVM specification. For example, to increase the JVM heap size to 6 GB, use "-Xmx6144m" not "6144". To increase memory and enable JVM debugging, use the "-Xmx6144m -XX:-PrintGCDetails" value."
<batchIndexBatchSize>	The number of records to index per thread during batch indexing. The value is an integer between 1 and 1000. The default value is 50.	The default value of this tag is automatically generated by the cqtsadmin.pl tool. You can change the value of this tag to increase the speed of batch indexing, thereby increasing the number of records to read per thread. Or, you can change the value to overcome out-of-memory errors by decreasing the number of records to read per thread. The default value is 50. If your environment has sufficient CPU cycles and RAM resources, and you want to increase the batch indexing speed, consider increasing the value to 200. This action reduces the time that is required to batch index HCL Compass records. However, you run the risk of receiving out-of- memory errors. To fix these errors, increase the JVM memory for the batch indexer, the WebSphere Application Server profile, or both.
<batchIndexDelay>	The delay value in seconds for the batch indexer. The value is an integer between 0 and 86400 (1 day). The default value is 0.	The default value of this tag is automatically generated by the cqtsadmin.pl tool. You can change the value to adjust batch indexing time based on the processor load and performance, maintaining resources for other applications on the server. Each time the batch indexer processes the quantity of records that the `<batchIndexBatchSize>` tag specifies, it pauses for the duration set in the `<batchIndexDelay>`tag. This delay allows other processes to utilize the processor. The default value is 0 seconds. Use this value to tune how much load you want to put on your server, mainly the HCL Compass database server and the HCL Compass full-text search server. By design, a value of 0 has a built-in pause such that both servers are not utilized at the same time. During batch-mode indexing when data is read from the database, the full-text search server is mainly idle. When the full-text search server is indexing data, the database server is idle. If you want to pause between this cycle, increase the value to 30. Then, the indexer does nothing for 30 seconds, allowing other processes on both servers to use processor resources.
<batchIndexThreads>	The number of threads to create for batch indexing. The value is an integer between 1 and 10. The default value is 5.	The default value of this tag is automatically generated by the cqtsadmin.pl tool. You can change the value of this tag to reduce batch indexing time by increasing the value, or increase batch indexing time by decreasing the value so that the CPU is released for other applications or to relax demand on the database server. When batch indexing, you can specify how many threads are created, where each thread processes its own <batchIndexBatchSize> quantity of records. If you have enough processor and RAM resources, you can speed up the batch-mode indexer by increasing the number of threads. However, you risk of receiving out-of-memory errors. If so, increase the JVM memory for the batch, the WebSphere Application Server profile, or both. Or, configure a smaller number of <batchIndexBatchSize> records to be read per thread.
<updateIndexBatchSize>	The number of records to index during a single pass of the update indexer. The value is an integer between 1 and 1000. The default value is 250.	The default value of this tag is automatically generated by the cqtsadmin.pl tool. You do not have to modify it. The default value is 250. You might need to increase the value if the update-mode indexer cannot keep up with the amount of changes made to the HCL Compass database. Note: Unlike the batch-mode indexer, the update-mode indexer is single threaded. You might have to set higher size values per pass, or shorter `<updateIndexDelay>` settings, to achieve the required update-mode indexing throughput. This throughput rate depends on average record submissions and updates and deletions per minute per HCL Compass user database.
<updateIndexDelay>	The delay value in seconds for the update indexer. The value is an integer between 1 and 86400 (1 day). The default value is 60.	The default value of this tag is automatically generated by the cqtsadmin.pl tool. You do not have to modify it. The default value is 60 seconds (1 minute). If you increase this value to 600 (10 minutes), then your search index synchronizes with your HCL Compass database modifications every 10 minutes at the cost of fewer logins (and a temporary additional license consumption), and fewer processor cycles.
<updateIndexLoginInterval>	This tag specifies `n` number of cycles of update-mode record extraction to occur before a HCL Compass account can login again. The default value is 10.	The default value of this tag is automatically generated by the cqtsadmin.pl tool, and is set to 10. The value of this tag is used in conjunction with the value of the `<updateIndexDelay>` tag. With these values, you can tune the frequency with which the update-mode indexer synchronizes the index with the HCL Compass database. For example, to configure the full-text search index to synchronize with the HCL Compass database every minute, set the `<updateIndexDelay>` value to 60 and the `<updateIndexLoginInterval>` value to 1. Every minute the update-mode indexer logs on to the HCL Compass database to check for changes that were made since the last check. If changes are detected, the data is read and sent to the indexer. Then, the update-mode indexer logs off. Because a logon operation is resource intensive, you can achieve the same synchronization frequency by setting the `<updateIndexLoginInterval>` value to 10. This tells the update-mode indexer to synchronize the index once every minute, but to remain logged on for 10 minutes. After the tenth synchronization, the indexer logs off for one minute. By using this method, you do not consume logon resources every minute to synchronize the index, but you keep a license checked-out for a longer period. Note: Do not specify a combination of seconds calculated by the `<updateIndexLoginInterval>` and `<updateIndexDelay>` values, which represent a longer login duration setting than your HCL Compass database timeout configuration. Doing so might lead to various issues such as resource leaks.
<addRecordType>	A list of record types and fields to be added to an existing full-text search deployment.	The default value of this tag is empty. Use this tag when you add new record types or fields to your search index if your HCL Compass schema changes after initial configuration. If you omit a record type during deployment, or you add a record type and want to search on it, you can do so by providing the full record type and associated fields using this tag. For example, suppose during your initial full-text search deployment you did not index the record type Customer, but now you need to index it. Use the following format to add the record type Customer and its set of fields to this tag: `Customer=field1,field2,fieldN` To add multiple record types, use a semicolon (;) as a separator. For example, you can add two record types: `Customer=field1,field2,fieldN;NewRecord=field1,field2,fieldN` You cannot use this option to add additional fields to an existing indexed record type. To do so, first remove the record type, then add it again with this option. This procedure requires full indexing of this record type after it has been added again.
<removeRecordType>	A list of record types to be removed from the full-text search deployment.	The default value of this tag is empty. Use this tag to remove indexed record types from your deployment. Enter the names of record types for removal in this tag. To remove the Customer record type, enter its name in this tag. To remove multiple record types, use a semicolon (;) as a separator. For example, you can remove two record types: `Customer;NewRecord`.
<deleteFtsWASProfiles>	This tag is set to `TRUE` to have the prep_upgd_was_profiles command-line option back up and delete all the HCL Compass full-text search WebSphere Application Server profiles on this host system. This removal is required for preparing to upgrade, modify, or reinstall HCL Compass with full-text search deployed.	The default value of this tag is automatically generated by the cqtsadmin.pl tool and is set to `FALSE`. When you upgrade, modify, or reinstall HCL Compass, set the value to `TRUE` before you run the prep_upgd_was_profiles command-line option for this one full-text search deployment. Then the command operates globally on all full-text search deployments on this server. The tag has two values: `TRUE` and anything else, or empty. When the value is set to `TRUE` and you specify the prep_upgd_was_profiles command-line option, the command creates backup data of your HCL Compass full-text search WebSphere Application Server profiles. The command also deletes these those profiles in preparation for their restoration in the post-installation restoration task. The command does takes this action for every full-text search WebSphere Application Server profile that is on this server. After you upgrade, modify, or reinstall HCL Compass, use the restore_was_profiles command-line option to recreate all the full-text search WebSphere Application Server profiles that were deleted. After you complete the prep_upgd_was_profiles command-line option, reset the value of this tag to `FALSE` for this one full-text search deployment to prevent accidental deletion. Important: Unlike all other tags and commands, this tag and command is global and affects all full-text search deployments on this server. When you make this change and run the prep_upgd_was_profiles command against any of full-text search deployments on this server, it affects all deployments on this server.
<solrVersion>	This tag contains the Apache Solr version that HCL Compass currently supports.	The HCL Compass full-text search administrator tool uses the value of this tag to determine what the current Apache Solr version is and whether a newer version is available. When you upgrade the Apache Solr application by using the upgrade_solr_app command-line option, the value of this tag is updated to reflect the upgraded version. Important: Do not change the value of the `<solrVersion>` tag unless you are instructed to by support. You cannot modify this tag.