cqtsadmin-dbset-userdb.xml 是全文搜索管理员工具的两个组件之一。 另一个组件是 cqtsadmin.pl Perl 脚本,用于自动完成设置、配置和管理 IBM Rational ClearQuest 全文搜索的步骤。
cqtsadmin-dbset-userdb.xml 配置文件包含可表示 cqtsadmin.pl Perl 脚本使用的全文搜索设置的 XML 元素。每个元素均包含以下标记:
标记 | 描述 |
---|---|
<description> | 解释 XML 元素的目的 |
<note> | 提供与标记有关的其他值得关注的信息 |
<defaultValue> | 包含 XML 元素的缺省值 |
<newValue required="yes"> | 可能包含新的覆盖值以替换 <defaultValue> 标记中的缺省值。系统根据以下项来设置 <newValue> 的值:在命令行选项中指定的参数,或者从 ClearQuest 数据库或操作系统中收集的参数。您也可以通过直接编辑文件来更改该值。 注: 所需的配置元素具有 <newValue required="yes"> XML 属性
. |
<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>
标记名 | 描述 | 注释 |
---|---|---|
<dbSet> | ClearQuest 数据库集名称。 | 该标记缺省值由 cqtsadmin.pl 工具自动生成。无需对其进行修改。 该标记的值基于初始设置时 cqtsadmin.pl 工具的命令行自变量中指定的 ClearQuest 数据库集。 |
<userDB> | ClearQuest 用户数据库名称。 | 该标记缺省值由 cqtsadmin.pl 工具自动生成。无需对其进行修改。 该标记的值基于初始设置时 cqtsadmin.pl 工具的命令行自变量中指定的 ClearQuest 用户数据库名称。 |
<siteName> | ClearQuest 站点名称。 | 该标记缺省值由 cqtsadmin.pl 工具自动生成。无需对其进行修改。 该标记的值基于您的 ClearQuest 数据库类型。 如果未复制数据库,那么该值为 <local>。 否则,该值为主副本名称。 |
<enableAtSites> | 将启用 ClearQuest 全文搜索的站点的逗号分隔列表。 | 该标记缺省值由 cqtsadmin.pl 工具自动生成。无需对其进行修改。 该标记的值基于您的 ClearQuest 数据库类型。 如果数据库未复制,那么将忽略该值。如果已复制数据库,那么缺省值为空,这将在所有站点启用 ClearQuest 全文搜索。 要在所选站点启用 ClearQuest 全文搜索,请使用逗号作为分隔符,列出此 XML 标记中的站点名称。 |
<entityFile> | ClearQuest 全文搜索实体文件。 | 该标记缺省值由 cqtsadmin.pl 工具自动生成。无需对其进行修改。 该标记的值是针对 ClearQuest 全文搜索部署自动生成的实体文件的路径。 此缺省文件是 Entity-dbset-userdb.txt,它是列出要搜索的记录类型及其字段的文本文件。 |
<ftsWASProfileName> | 全文搜索 WebSphere® Application Server 概要文件名称。 | 该标记缺省值由 cqtsadmin.pl 工具自动生成。无需对其进行修改。 概要文件的命名约定为 cqsearchprofile_db-set-name_user-db-name,其中 db-set-name 和 user-db-name 均通过传递至 cqtsadmin.pl 的命令行参数来确定。 如果生成的概要文件名称超过 27 个字符,那么 cqsearchprofile_db-set-name_user-db-name 概要文件名称缩写为 cqfts_db-set-name user-db-name。 如果概要文件名称仍超过 27 个字符,那么请缩短 db-set-name 或 user-db-name。如不可能,请通过以下方式来提供您自己的概要文件名称:将此 XML 标记中的值替换为部署全文搜索的计算机上唯一的概要文件名称,例如,MyProfile_1。 |
<ftsWASProfileHome> | ClearQuest 全文搜索 WebSphere Application Server 概要文件主目录的路径。 | 该标记缺省值由 cqtsadmin.pl 工具自动生成。无需对其进行修改。 该路径的值在使用 fts_was_profile_home 命令行选项时自动确定。 否则,使用缺省的 %CLEARQUEST_HOME%/cqweb/ 路径。 注: 部署全文搜索 WebSphere Application Server 概要文件时,请使用 fts_was_profile_home 命令行选项定义 WebSphere Application Server 概要文件主目录路径
. |
<ftsWASProfilePort> | ClearQuest 全文搜索 WebSphere Application Server 概要文件端口号,用于与该用户数据库的全文搜索部署相结合使用。 | 该标记缺省值由 cqtsadmin.pl 工具自动生成。无需对其进行修改。 初始 ClearQuest 全文搜索 WebSphere Application Server 概要文件的 cqsearchprofile 缺省值为 14080。当创建新的 WebSphere Application Server 概要文件进行新的全文搜索部署时,将使用服务器上下一可用端口自动生成端口值(可用端口从 15080 开始,并按 1000 递增以用于其他全文搜索部署)。例如,端口值应为以下项:15080、16080、17080 等。 |
<ftsWASProfilePortsDefPropFile> | ClearQuest 全文搜索 WebSphere Application Server 概要文件端口文件的路径。将该路径与 create_fts_was_profile 命令行选项一起使用,以进行用户数据库全文搜索部署。如果必须指定端口,请使用 was_profile_ports_file 命令行选项。 | 该标记缺省值由 cqtsadmin.pl 工具自动生成。无需对其进行修改。 缺省情况下,将针对使用 create_fts_was_profile 命令行选项创建的 ClearQuest 全文搜索 WebSphere Application Server 概要文件自动确定 WebSphere Application Server 概要文件端口。然而,如果必须指定您自己的端口,请使用 was_profile_ports_file 命令行选项提供要将端口信息用作模板的文件的路径。 指定端口时,此 WebSphere Application Server 概要文件端口文件将复制到当前的全文搜索部署主目录中,并且此标记将自动进行更新以指向该文件的全文搜索主目录实例。 请勿更改该标记的值,除非您需要对设置进行更全面的控制或尝试解决问题。 |
<ftsWASProfileMaxHeapSize> | WebSphere Application Server 概要文件的最大 Java 虚拟机 (JVM) 堆大小 (MB)。 | 该标记的缺省值是 1024,这意味着 JVM 最大堆大小可高达 1 MB。 在建立索引(尤其是批量建立索引)期间,如果在全文搜索 WebSphere Application Server 概要文件 (Solr) 中收到内存不足错误,请增加堆大小以帮助消除这一问题。最大值当前约为 1792 MB。如更改,请记住将其重置为 1024。 |
<ftsServerName> | 要在上面设置此 ClearQuest 全文搜索部署的主机或服务器的名称。 | 该标记缺省值由 cqtsadmin.pl 工具自动生成。无需对其进行修改。 该标记的值设置为要在上面部署全文搜索的服务器的名称。仅当重命名计算机或者将部署移至具有不同名称的服务器时才需要更改此名称。 注: 如果更改该值,必须提供标准且普遍可访问的主机名。如果要在 ClearQuest MultiSite 复制数据库配置中使用负载均衡或全文搜索,那么必须可从所有 ClearQuest Web 服务器访问该主机名。
|
<enableCQFTS> | 该标记设置为 TRUE 以启用 ClearQuest Web 中的全文单选按钮。 | 该标记缺省值由 cqtsadmin.pl 工具自动生成。无需对其进行修改。 该标记具有两个值:TRUE 和其他任何项或空。当设置为 TRUE 时,将在设置时启用 ClearQuest Web 中的全文单选按钮。否则,跳过该步骤。 请勿更改该标记的值,除非您需要对设置进行更全面的控制或尝试解决问题。 注意: 如果用户数据库建立了全部或部分索引但未复制,那么不要将该值设置为 FALSE 以禁用此单选按钮。禁用单选按钮将禁用针对 ClearQuest 数据库创建操作日志。这样,全文搜索不会跟踪对 ClearQuest 记录的更改,而且从不会为更改的记录重新建立索引。如果将该值设置为 FALSE 并更改记录,那么必须完整地对数据库重新建立索引。如果必须将该值设置为 FALSE,那么必须防止对 ClearQuest 记录进行更改,直至将该值重置为 TRUE。
|
<runBatchIndex> | 该标记设置为 TRUE,以在 ClearQuest 全文搜索设置期间启用批量索引功能。 | 该标记缺省值由 cqtsadmin.pl 工具自动生成。无需对其进行修改。 该标记具有两个值:TRUE 和其他任何项或空。当该标记设置为 TRUE 时,批处理方式索引器将在设置期间运行。否则,跳过该步骤。 跳过批量索引意味着所有现有记录都不会建立索引且不可搜索。因此,搜索结果将是不完整的。 |
<startUpdateIndex> | 该标记设置为 TRUE,以在 ClearQuest 全文搜索设置期间启用更新索引功能。 | 该标记缺省值由 cqtsadmin.pl 工具自动生成。无需对其进行修改。 该标记具有两个值:TRUE 和其他任何项或空。当该值设置为 TRUE 时,更新方式索引器将配置为在 WebSphere Application Server 概要文件启动时装入。否则,跳过该步骤。 跳过更新索引意味着所有已修改或新添加的记录都不会在初始批量建立索引后建立索引且不可搜索。因此,搜索结果将是不完整的。 |
<batchIndexJVMParm> | 批处理方式索引器使用的 JVM 参数设置。 | 该标记的缺省值是 -Xmx1536m,这意味着批处理方式索引器最多可使用 1.5 GB RAM。 如果在批量建立索引期间收到内存不足错误,请减少批量大小或线程数。将 JVM 值增加为 -Xmx1792m 可能有帮助,但不会产生很大作用,因为 32 位操作系统上的最大值是 2048 MB。 由于此 JVM 参数值原样传递到批处理方式索引器,因此请使用 JVM 规范中指定的正确的值。例如,要将 JVM 堆大小增加到 1.7 GB,请使用 -Xmx1792m,而不是 1792。 要增加内存并启用 JVM 调试,请使用值 -Xmx1536m -XX:-PrintGCDetails。 |
<batchIndexBatchSize> | 在以批处理方式建立索引期间,按照线程建立索引的记录数。该值是 1 到 1000 之间的整数。缺省值为 50。 | 该标记缺省值由 cqtsadmin.pl 工具自动生成。您可以更改该标记的值以提高批量建立索引的速度,从而增加每个线程读取的记录数。或者,您可以更改该值,通过减少每个线程读取的记录数来解决内存不足错误。 缺省值为 50。如果您的环境具有足够的 CPU 周期和 RAM 资源,并且希望提高批量建立索引的速度,请考虑将该值增至 200。该操作将减少对 ClearQuest 记录批量建立索引所需的时间。但是,这样具有收到内存不足错误的风险。要解决这些错误,请增加批量索引器和/或 WebSphere Application Server 概要文件的 JVM 内存。 |
<batchIndexDelay> | 批处理索引器的延迟时间值(秒)。该值是 0 到 86400(1 天)之间的整数。缺省值为 0。 | 该标记缺省值由 cqtsadmin.pl 工具自动生成。您可以更改该值,以根据处理器负载和性能调整批量建立索引的时间,为服务器上的其他应用保留资源。 批量索引器每次处理 <batchIndexBatchSize> 标记指定的记录数量时,都会暂停一段时间,该时间为 <batchIndexDelay> 标记中设定的持续时间。 这一延迟允许其他进程使用该处理器。缺省值为 0 秒。 使用该值来调整您希望服务器(主要是 ClearQuest 数据库服务器和 ClearQuest 全文搜索服务器)承担的负载量。按照设计,0 值具有内置暂停时间,因此无法同时使用两个服务器。在以批处理方式建立索引期间,当从数据库读取数据时,全文搜索服务器主要处于闲置状态。当全文搜索服务器对数据建立索引时,数据库服务器处于闲置状态。如果要在此周期内暂停,请将该值增至 30。然后,索引器会在 30 秒内不执行任何活动,允许两个服务器上的其他进程使用处理器资源。 |
<batchIndexThreads> | 为以批处理方式建立索引的操作创建的线程数。该值是 1 到 10 之间的整数。缺省值为 5。 | 该标记缺省值由 cqtsadmin.pl 工具自动生成。您可以更改该标记的值,以通过增加该值来减少批量建立索引的时间,或通过减小该值来增加批量建立索引的时间,从而针对其他应用程序释放 CPU 或缓解对数据库服务器的需求。 以批处理方式建立索引时,您可以指定创建的线程数,每个线程负责处理其自己的记录数 <batchIndexBatchSize>。 如果您拥有足够的处理器和 RAM 资源,可通过增加线程数来加速批处理方式索引器。但是,这样具有收到内存不足错误的风险。如果是这样,请增加批量索引器和/或 WebSphere Application Server 概要文件的 JVM 内存。或者,针对每个线程配置更少数目的 <batchIndexBatchSize> 记录供读取。 |
<updateIndexBatchSize> | 在更新索引器的一次运行过程中,要建立索引的记录数。该值是 1 到 1000 之间的整数。缺省值为 250。 | 该标记缺省值由 cqtsadmin.pl 工具自动生成。无需对其进行修改。 缺省值为 250。如果更新方式索引器无法与对 ClearQuest 数据库所做更改量保持同步,您可能需要增加该值。
注: 不同于批处理方式索引器,更新方式索引器采用单线程。
您可能必须设置更高大小的值或更简短的 <updateIndexDelay> 设置以实现所需的更新方式索引吞吐量。此吞吐量速度取决于每个 ClearQuest 用户数据库每分钟的平均记录提交、更新及删除次数。
|
<updateIndexDelay> | 更新索引器的延迟时间值(秒)。该值是 1 到 86400(1 天)之间的整数。缺省值是 60。 | 该标记缺省值由 cqtsadmin.pl 工具自动生成。无需对其进行修改。 缺省值为 60 秒(1 分钟)。如果将该值增加到 600(10 分钟),那么搜索索引将每 10 分钟与 ClearQuest 数据库修改同步一次,从而需要更少的登录次数(临时附加许可使用)以及更少的处理器周期。 |
<updateIndexLoginInterval> | 该标记指定在 ClearQuest 帐户可以重新登录前发生的更新方式记录抽取周期数 n。缺省值为 10。 | 该标记的缺省值由 cqtsadmin.pl 工具自动生成并设置为 10。 该标记的值与 <updateIndexDelay> 标记的值结合使用。利用这些值,您可以调整更新方式索引器与 ClearQuest 数据库同步索引的频率。例如,要将全文搜索索引配置为每分钟与 ClearQuest 数据库进行同步,请将 <updateIndexDelay> 值设置为 60,将 <updateIndexLoginInterval> 值设置为 1。更新方式索引器每分钟都会登录到 ClearQuest 数据库,查看自上一次检查以来所做的更改。 如果检测到更改,将读取数据并发送至索引器。 然后,更新方式索引器将登出。由于登录操作耗用大量资源,因此您可以将 <updateIndexLoginInterval> 值设置为 10,以获取相同的同步频率。这会告知更新方式索引器每分钟同步一次索引,但保留登录状态 10 分钟。在第十次同步后,索引器将登出一分钟。通过使用该方法,您不必每分钟使用登录资源来同步索引,但保留了更长时间的许可检出功能。 注: 请勿指定由 <updateIndexLoginInterval> 和 <updateIndexDelay> 值计算的一组秒数,它表示较之 ClearQuest 数据库超时配置,可以具有更长的登录持续时间设置。这样做可能导致发生诸如资源泄露等各种问题。
|
<addRecordType> | 要添加到现有全文搜索部署中的记录类型和字段的列表。 | 该标记的缺省值为空。如果在初始配置后 ClearQuest 模式有所更改,请在将新的记录类型或字段添加到搜索索引中时使用该标记。 如果在部署期间省略记录类型,或添加记录类型并希望按其进行搜索,可通过使用该标记提供完整的记录类型及相关字段来完成该操作。 例如,假定在初始全文搜索部署期间未对记录类型“客户”建立索引,现在将需要为其建立索引。使用以下格式将记录类型“客户”及其字段组添加到该标记中:Customer=field1,field2,fieldN 要添加多个记录类型,请使用分号 (;) 作为分隔符。例如,您可以添加两个记录类型:Customer=field1,field2,fieldN;NewRecord=field1,field2,fieldN 不能使用该选项将其他字段添加到建立索引的现有记录类型。要执行此操作,请首先除去记录类型,然后使用该选项重新添加。此过程需要在重新添加此记录类型后对其建立完整的索引。 |
<removeRecordType> | 要从全文搜索部署中除去的记录类型的列表。 | 该标记的缺省值为空。使用该标记从部署中除去已建立索引的记录类型。 在该标记中输入要除去的记录类型的名称。要除去“客户”记录类型,请在该标记中输入其名称。要除去多个记录类型,请使用分号 (;) 作为分隔符。例如,您可以除去两个记录类型:Customer;NewRecord。 |
<deleteFtsWASProfiles> | 该标记设置为 TRUE,以使 prep_upgd_was_profiles 命令行选项备份和删除该主机系统上的所有 ClearQuest 全文搜索 WebSphere Application Server 概要文件。 对于准备使用所部署的全文搜索来升级、修改或重新安装 ClearQuest,此除去过程是必需的。 | 该标记的缺省值由 cqtsadmin.pl 工具自动生成并设置为 FALSE。 升级、修改或重新安装 ClearQuest 时,请将该值设置为 TRUE,然后为此全文搜索部署运行 prep_upgd_was_profiles 命令行选项。该命令会在该服务器上的所有全文搜索部署上进行全局操作。 该标记具有两个值:TRUE 和其他任何项或空。当该值设置为 TRUE 并指定 prep_upgd_was_profiles 命令行选项时,该命令会创建 ClearQuest 全文搜索 WebSphere Application Server 概要文件的备份数据。该命令也会删除这些概要文件,以备在安装后的恢复任务中进行复原。该命令会为该服务器上的每个全文搜索 WebSphere Application Server 概要文件采取此操作。 升级、修改或重新安装 ClearQuest 后,请使用 restore_was_profiles 命令行选项来重新创建已删除的所有全文搜索 WebSphere Application Server 概要文件。 完成 prep_upgd_was_profiles 命令行选项后,请针对此全文搜索部署将该标记的值设置为 FALSE 以防意外删除。 要点: 不同于所有其他标记和命令,该标记和命令是全局性的,会影响该服务器上的所有全文搜索部署。在做出此更改并针对该服务器上的任何全文搜索部署运行 prep_upgd_was_profiles 命令时,将影响该服务器上的所有部署。
|
<solrVersion> | 该标记包含 ClearQuest 当前支持的 Apache Solr 版本。 | ClearQuest 全文搜索管理员工具使用该标记的值来确定 Apache Solr 的当前版本以及是否有可用的更高版本。在使用 upgrade_solr_app 命令行选项升级 Apache Solr 应用程序时,将更新该标记值以反映升级后的版本。 要点: 请勿更改 <solrVersion> 标记的值,除非 IBM 支持人员指示您进行更改。您无法修改该标记。
|