cqtsadmin-dbset-userdb.xml

cqtsadmin-dbset-userdb.xml es un archivo de configuración de administrador de búsqueda de texto completo genera y utiliza el script Perl cqtsadmin.pl. El archivo contiene datos acerca del despliegue, que puede personalizar más.

cqtsadmin-dbset-userdb.xml es uno de los dos componentes de la herramienta de administrador de búsqueda de texto completo. El otro componente es el script Perl cqtsadmin.pl, que automatiza los pasos para configurar y administrar la búsqueda de texto completo de IBM Rational ClearQuest.

El archivo de configuración cqtsadmin-dbset-userdb.xml contiene elementos XML que representan valores de búsqueda de texto completo utilizados por el script Perl cqtsadmin.pl. Cada elemento contiene estos códigos:

Tabla 1. Formato de elemento XML cqtsadmin-dbset-userdb.xml
Etiqueta Descripción
<description> Explica el propósito del elemento XML
<note> Proporciona información adicional importante acerca del código
<defaultValue> Contiene el valor predeterminado del elemento XML
<newValue required="yes"> Puede contener un nuevo valor de sobrescritura para sustituir el valor predeterminado en el código <defaultValue>. El valor de <newValue> se establece en base a parámetros que especifica en la opción de línea de mandatos o que se recopilan del sistema operativo o de la base de datos de ClearQuest. También puede cambiar este valor editando directamente el archivo.
Nota: Los elementos de configuración requeridos tienen el atributo XML <newValue required="yes">
.
En el siguiente ejemplo, el elemento XML <dbSet> tiene una descripción, una nota y un valor predeterminado de TextSearch. El código <newValue required="yes"> sustituye el valor predeterminado de TextSearch por el valor 8.0.0, basado en el parámetro de la línea de mandatos utilizado para la opción -userdb.
<dbSet>
		<description>El nombre del repositorio de esquemas de CQ (conjunto-base de datos) para el que desee habilitar CQ FTS.</description>
		<note>Debe proporcionar estos datos ya que los predeterminados pueden no ser adecuados (es específico de la base de datos de CQ).</note>
		<defaultValue>TextSearch</defaultValue>
						<newValue required="yes">8.0.0</newValue>
</dbSet>

Elementos XML de cqtsadmin-dbset-userdb.xml

Tabla 2. Códigos de elemento XML de cqtsadmin-dbset-userdb.xml
Nombre de código Descripción Notas
<dbSet> Nombre del conjunto de bases de datos de ClearQuest.

El valor predeterminado de este código se genera automáticamente mediante la herramienta cqtsadmin.pl. No es necesario que lo modifique.

El valor de este código se basa en el conjunto de bases de datos ClearQuest especificado en el argumento de la línea de mandatos para la herramienta cqtsadmin.pl en la configuración inicial.

<userDB> Nombre de la base de datos de usuario de ClearQuest.

El valor predeterminado de este código se genera automáticamente mediante la herramienta cqtsadmin.pl. No es necesario que lo modifique.

El valor de este código se basa en el nombre de la base de datos del usuario de ClearQuest especificado en el argumento de la línea de mandatos para la herramienta cqtsadmin.pl en la configuración inicial.

<siteName> Nombre de sitio de ClearQuest.

El valor predeterminado de este código se genera automáticamente mediante la herramienta cqtsadmin.pl. No es necesario que lo modifique.

El valor de este código se basa en el tipo de base de datos de ClearQuest. Si su base de datos no se replica, el valor es <local>. De lo contrario, el valor es el nombre de su réplica maestra.

<enableAtSites> Lista separada por comas de sitios en que se habilitará la búsqueda de texto completo de ClearQuest.

El valor predeterminado de este código se genera automáticamente mediante la herramienta cqtsadmin.pl. No es necesario que lo modifique.

El valor de este código se basa en el tipo de base de datos de ClearQuest. Si su base de datos no se replica, se omite este valor. Si la base de datos se replica, el valor predeterminado está vacío, lo que habilita la búsqueda de texto completo de ClearQuest en todos los sitios.

Para habilitar la búsqueda de texto completo de ClearQuest en los sitios seleccionados, liste los nombres de sitio en este código XML utilizando una coma como separador.

<entityFile> Archivo de entidad de búsqueda de texto completo de ClearQuest.

El valor predeterminado de este código se genera automáticamente mediante la herramienta cqtsadmin.pl. No es necesario que lo modifique.

El valor de este código es la vía de acceso al archivo de entidad generado automáticamente para el despliegue de búsqueda de texto completo de ClearQuest. El archivo predeterminado es Entity-dbset-userdb.txt, que es un archivo de texto que lista los tipos de registro y los campos para la búsqueda.

<ftsWASProfileName> Nombre de perfil de WebSphere Application Server de la búsqueda de texto completo.

El valor predeterminado de este código se genera automáticamente mediante la herramienta cqtsadmin.pl. No es necesario que lo modifique.

Los convenios de denominación de perfil son cqsearchprofile_nombre-conjunto-basededatos_nombre-basededatos-usuario, donde nombre-conjunto-basededatos y nombre-basededatos-usuario están determinados por los parámetros de línea de mandatos pasados a cqtsadmin.pl.

Si el nombre de perfil resultante supera los 27 caracteres, el nombre de perfil cqsearchprofile_nombre-conjunto-basededatos_nombre-basededatos-usuario se abrevia a cqfts_nombre-conjunto-basededatos nombre-basededatos-usuario.

Si el nombre de perfil sigue superando los 27 caracteres, abrévielo por nombre-conjunto-basededatos o nombre-basededatos-usuario. Si esto no es posible, proporcione su propio nombre de perfil sustituyendo el valor de este código XML por un nombre de perfil que sea exclusivo en el sistema en el que está desplegando la búsqueda de texto completo, por ejemplo, MyProfile_1.

<ftsWASProfileHome> Vía de acceso al directorio de inicio del perfil de WebSphere Application Server de búsqueda de texto completo de ClearQuest.

El valor predeterminado de este código se genera automáticamente mediante la herramienta cqtsadmin.pl. No es necesario que lo modifique.

El valor de esta vía de acceso se determina automáticamente al utilizar la opción de línea de mandatos de fts_was_profile_home. De lo contrario, se utiliza la vía de acceso predeterminada %CLEARQUEST_HOME%/cqweb/.

Nota: Utilice la opción de línea de mandatos fts_was_profile_home para definir una vía de acceso al directorio de inicio del perfil de WebSphere Application Server cuando despliegue los perfiles de WebSphere Application Server de búsqueda de texto completo
.
<ftsWASProfilePort> Número de puerto del perfil de WebSphere Application Server de búsqueda de texto completo de ClearQuest que se utiliza con el despliegue de búsqueda de texto completo de esta base de datos de usuario.

El valor predeterminado de este código se genera automáticamente mediante la herramienta cqtsadmin.pl. No es necesario que lo modifique.

El valor predeterminado cqsearchprofile del perfil inicial de WebSphere Application Server de búsqueda de texto completo de ClearQuest es 14080. Cuando se crea un nuevo perfil de WebSphere Application Server para un nuevo despliegue de búsqueda de texto completo, el valor de puerto se genera automáticamente utilizando el siguiente puerto disponible en el servidor, empezando por 15080 y aumentando en incrementos de 1000 para despliegues de búsqueda de texto completo adicionales. Por ejemplo, los valores de puerto serían los siguientes: 15080, 16080, 17080 y así sucesivamente.

<ftsWASProfilePortsDefPropFile> Vía de acceso al archivo de puertos del perfil de WebSphere Application Server de búsqueda de texto completo de ClearQuest. Utilice esta vía de acceso con la opción de línea de mandatos create_fts_was_profile para el despliegue de la búsqueda de texto completo de la base de datos de usuario. Si debe especificar los puertos, utilice la opción de línea de mandatos was_profile_ports_file.

El valor predeterminado de este código se genera automáticamente mediante la herramienta cqtsadmin.pl. No es necesario que lo modifique.

De forma predeterminada, los puertos del perfil de WebSphere Application Server se determinan de forma automática para los perfiles de WebSphere Application Server de búsqueda de texto completo de ClearQuest que cree utilizando la opción de línea de mandatos create_fts_was_profile. Sin embargo, si debe especificar sus propios puertos, utilice la opción de línea de mandatos was_profile_ports_file para proporcionar la vía de acceso a un archivo con la información de puerto que se utilizará como plantilla.

Cuando especifique un puerto, este archivo de puertos del perfil de WebSphere Application Server se copiará al directorio de inicio de despliegue de la búsqueda de texto completo actual y este código se actualizará automáticamente para apuntar a la instancia del directorio de inicio de la búsqueda de texto del archivo.

No cambie el valor de este código a menos que necesite un control más detallado de la configuración o porque está intentando resolver un problema.

<ftsWASProfileMaxHeapSize> Tamaño de almacenamiento dinámico máximo de la máquina virtual Java (JVM) para el perfil de WebSphere Application Server en megabytes.

El valor predeterminado de este código es 1024, lo que significa que el tamaño de almacenamiento dinámico máximo de la JVM puede ser de hasta 1 MB.

Durante la indexación, especialmente en una indexación por lotes, si recibe errores de falta de memoria en el perfil de WebSphere Application Server de búsqueda de texto completo (Solr), aumente el tamaño de almacenamiento dinámico para intentar eliminar este problema. El valor máximo actualmente es aproximadamente 1792 MB. Si lo cambia, recuerde restablecerlo en 1.024.

<ftsServerName> Nombre de servidor o host en el que se establece este despliegue de búsqueda de texto completo de ClearQuest.

El valor predeterminado de este código se genera automáticamente mediante la herramienta cqtsadmin.pl. No es necesario que lo modifique.

El valor para este código se establece en el nombre de servidor en el que despliega la búsqueda de texto completo. Cambie el nombre solo si cambia el nombre del sistema o mueve el despliegue a un servidor que tiene un nombre diferente.

Nota: Si cambia este valor, debe proporcionar un nombre de host completo y accesible. Si está utilizando el equilibrio de carga o la búsqueda de texto completo en una configuración de base de datos replicada de ClearQuest MultiSite, el nombre de host debe ser accesible desde todos los servidores de ClearQuest Web.
<enableCQFTS> Este código se establece en TRUE para habilitar el botón de selección Texto completo en ClearQuest Web.

El valor predeterminado de este código se genera automáticamente mediante la herramienta cqtsadmin.pl. No es necesario que lo modifique.

Este código tiene dos valores: TRUE y cualquier otro o está vacío. Cuando se establece en TRUE, el botón de selección Texto completo en ClearQuest Web está habilitado durante la configuración. De lo contrario, se salta este paso.

No cambie el valor de este código a menos que necesite un control más detallado de la configuración o porque está intentando resolver un problema.

Atención: No establezca el valor en FALSE para inhabilitar el botón de selección si la base de datos de usuario está completamente o parcialmente indexada pero no replicada. Al inhabilitar el botón de selección se inhabilita la creación de registros de operación de las bases de datos de ClearQuest no replicadas. Por tanto, las búsquedas de texto completo no realizan el seguimiento de cambios de registros de ClearQuest y los registros cambiados nunca se vuelven a indexar. Si establece el valor en FALSE y se cambian los registros, debe volver a indexar completamente la base de datos. Si debe establecer el valor en FALSE, debe evitar que se realicen cambios en el registro de ClearQuest hasta que el valor se restablezca en TRUE.
<runBatchIndex> Este código se establece en TRUE para permitir que se inicie la indexación por lotes durante la configuración de la búsqueda de texto completo de ClearQuest.

El valor predeterminado de este código se genera automáticamente mediante la herramienta cqtsadmin.pl. No es necesario que lo modifique.

Este código tiene dos valores: TRUE y cualquier otro o está vacío. Al establecer este código en TRUE, el indexador de modalidad de proceso por lotes se ejecuta durante la configuración. De lo contrario, se salta este paso.

Si se omite la indexación por lotes, todos los registros existentes no se indexan y no se pueden realizar búsquedas en ellos. Por lo tanto, los resultados de la búsqueda estarán incompletos.

<startUpdateIndex> Este código se establece en TRUE para permitir que se inicie la indexación de actualización durante la configuración de la búsqueda de texto completo de ClearQuest.

El valor predeterminado de este código se genera automáticamente mediante la herramienta cqtsadmin.pl. No es necesario que lo modifique.

Este código tiene dos valores: TRUE y cualquier otro o está vacío. Cuando el valor se establece en TRUE, el indexador de la modalidad de actualización se configura para que se cargue cuando se inicia el perfil de WebSphere Application Server. De lo contrario, se salta este paso.

Si se omite la indexación de actualización, todos los registros modificados o añadidos recientemente no se indexan después de la indexación por lotes inicial y no se pueden realizar búsquedas en ellos. Por lo tanto, los resultados de la búsqueda estarán incompletos.

<batchIndexJVMParm> Valor del parámetro JVM que el indexador de la modalidad de proceso por lotes utiliza.

El valor predeterminado de este código es -Xmx1536m, lo que significa que el indexador de la modalidad de proceso por lotes puede utilizar hasta 1,5 GB de RAM.

Si recibe errores de memoria insuficiente durante la indexación por lotes, reduzca el tamaño de lote o el número de hebras. Aumentar el valor JVM a -Xmx1792m puede ayudar, pero no mucho porque el valor máximo en un sistema operativo de 32 bits es de 2048 MB.

Dado que este valor de parámetro JVM se pasa tal cual al indexador de la modalidad de proceso por lotes, utilice valores correctos como se especifica en la especificación JVM. Por ejemplo, para aumentar el tamaño de almacenamiento dinámico de la JVM a 1,7 GB, utilice -Xmx1792m y no 1792. Para aumentar la memoria y habilitar la depuración de la JVM, utilice el valor -Xmx1536m -XX:-PrintGCDetails.

<batchIndexBatchSize> Número de registros a indexar por hebra durante la indexación por lotes. El valor es un entero entre 1 y 1000. El valor predeterminado es 50.

El valor predeterminado de este código se genera automáticamente mediante la herramienta cqtsadmin.pl. Puede cambiar el valor de este código para aumentar la velocidad de la indexación por lotes, lo que aumenta el número de registros a leer por hebra. O bien, puede cambiar el valor para reducir los errores de falta de memoria disminuyendo el número de registros a leer por hebra.

El valor predeterminado es 50.Si el entorno tiene suficientes ciclos de CPU y recursos de RAM y desea aumentar la velocidad de a indexación por lotes, considere la posibilidad de aumentar el valor a 200. Esta acción reduce el tiempo necesario para realizar la indexación por lotes de registros de ClearQuest. Sin embargo, corre el riesgo de recibir errores de memoria insuficiente. Para solucionar estos errores, incremente la memoria JVM para el indexador por lotes, el perfil de WebSphere Application Server, o ambos.

<batchIndexDelay> Valor de retardo en segundos para el indexador por lotes. El valor es un entero entre 0 y 86400 (1 día). El valor predeterminado es 0.

El valor predeterminado de este código se genera automáticamente mediante la herramienta cqtsadmin.pl. Puede cambiar el valor para ajustar el tiempo de la indexación por lotes de acuerdo con la carga y el rendimiento del procesador, manteniendo los recursos para otras aplicaciones del servidor.

Cada vez que el indexador por lotes procesa la cantidad de registros que el código <batchIndexBatchSize> especifica, se detiene el tiempo establecido en el código <batchIndexDelay>. Este retardo permite que otros procesos utilicen el procesador. El valor por omisión es 0 segundos.

Utilice este valor para ajustar la cantidad de carga que desea establecer en el servidor, principalmente en el servidor de base de datos de ClearQuest y en el servidor de búsqueda de texto completo de ClearQuest. Por diseño, un valor de 0 tiene una pausa incorporada de modo que ambos servidores no se utilizan al mismo tiempo. Durante la indexación en modalidad de proceso por lotes cuando los datos se leen de la base de datos, el servidor de búsqueda de texto completo está principalmente desocupado. Cuando el servidor de búsqueda de texto completo está indexando datos, el servidor de bases de datos está desocupado. Si desea detener este ciclo, aumente el valor a 30. A continuación, el indexador no hace nada durante 30 segundos, lo que permite que otros procesos en ambos servidores utilicen recursos de procesador.

<batchIndexThreads> Número de hebras que se deben crear para la indexación por lotes. El valor es un entero entre 1 y 10. El valor predeterminado es 5.

El valor predeterminado de este código se genera automáticamente mediante la herramienta cqtsadmin.pl. Puede cambiar el valor de este código para reducir la indexación por lotes aumentando el valor o aumentar el tiempo de indexación por lotes disminuyendo el valor de modo que la CPU quede liberada para otras aplicaciones o para reducir la demanda en el servidor de bases de datos.

Al realizar la indexación por lotes, puede especificar cuántas hebras se crean, dónde procesa cada hembra su propia cantidad de registros <batchIndexBatchSize>.

Si tiene suficientes recursos de procesador y RAM, puede acelerar el indexador de la modalidad de proceso por lotes aumentando el número de hebras. Sin embargo, se arriesga a recibir errores de falta de memoria. En ese caso, incremente la memoria JVM para el lote, el perfil de WebSphere Application Server, o ambos. O bien, configure un menor número de registros <batchIndexBatchSize> a leer por hebra.

<updateIndexBatchSize> Número de registros a indexar durante un paso único del indexador de actualización. El valor es un entero entre 1 y 1000. El valor por omisión es 250.

El valor predeterminado de este código se genera automáticamente mediante la herramienta cqtsadmin.pl. No es necesario que lo modifique.

El valor por omisión es 250.Es posible que deba incrementar el valor si el indexador de la modalidad de actualización no puede mantener la cantidad de cambios realizados a la base de datos de ClearQuest.
Nota: A diferencia de indexador en modalidad de proceso por lotes, el indexador de la modalidad de actualización tiene una única hebra. Es posible que deba establecer valores de tamaño superiores por paso, o acortar los valores <updateIndexDelay>, para alcanzar el rendimiento de indexación en modalidad de actualización necesario. Esta tasa de rendimiento depende del promedio de envíos de registros y de las actualizaciones y supresiones por minuto por base de datos de usuario de ClearQuest.
<updateIndexDelay> Valor de retardo en segundos para el indexador de actualización. El valor es un entero entre 1 y 86400 (1 día). El valor predeterminado es 60.

El valor predeterminado de este código se genera automáticamente mediante la herramienta cqtsadmin.pl. No es necesario que lo modifique.

El valor predeterminado es 60 segundos (1 minuto). Si incrementa este valor a 600 (10 minutos), su índice de búsqueda se sincroniza con las modificaciones de la base de datos de ClearQuest cada 10 minutos a costa de menos inicios de sesión (y un consumo de licencia adicional temporal) y menos ciclos del procesador.

<updateIndexLoginInterval> Este código especifica el número n de ciclos de extracción de registros en modalidad de actualización que se producirán antes de una cuenta de ClearQuest pueda iniciar sesión de nuevo. El valor predeterminado es 10.

El valor predeterminado de este código se genera automáticamente mediante la herramienta cqtsadmin.pl y se establece en 10.

El valor de este código se utiliza junto con el valor del código <updateIndexDelay>. Con estos valores, se puede ajustar la frecuencia con la que el indexador de la modalidad de actualización sincroniza el índice con la base de datos de ClearQuest. Por ejemplo, para configurar el índice de búsqueda de texto completo para sincronizarlo con la base de datos de ClearQuest cada minuto, establezca el valor <updateIndexDelay> en 60 y el valor <updateIndexLoginInterval> en 1. Cada minuto, el indexador de la modalidad de actualización inicia sesión en la base de datos de ClearQuest para comprobar los cambios que se han realizado desde la última comprobación. Si se detectan cambios, los datos se leen y se envían al indexador. A continuación, el indexador de la modalidad de actualización se desconecta. Puesto que una operación de inicio de sesión requiere recursos, puede conseguir la misma frecuencia de sincronización estableciendo el valor <updateIndexLoginInterval> en 10. Esto indica al indexador de la modalidad de actualización que sincronice el índice cada minuto, pero que permanezca conectado durante 10 minutos. Tras una décima sincronización, el indexador se desconecta durante un minuto. Al utilizar este método, no consume recursos de inicio de sesión cada minuto para sincronizar el índice, pero mantiene una licencia extraída durante un periodo más largo.

Nota: No especifique una combinación de segundos calculada por los valores <updateIndexLoginInterval> y <updateIndexDelay>, que representan una mayor duración de inicio de sesión que la configuración de tiempo de espera de la base de datos de ClearQuest. Esto puede generar varios problemas como pérdidas de recursos.
<addRecordType> Lista de los campos y tipos de registro que se deben añadir a un despliegue de búsqueda de texto completo existente.

El valor predeterminado de este código está vacío. Utilice este código cuando agregue nuevos campos o tipos de registro al índice de búsqueda si el esquema de ClearQuest cambia después de la configuración inicial.

Si omite un tipo de registro durante el despliegue, o si añade un tipo de registro y desea buscar en este, puede hacerlo proporcionando el tipo de registro completo y los campos asociados utilizando este código.

Por ejemplo, imagine que durante el despliegue de búsqueda de texto completo inicial no indexó el tipo de registroCustomer, pero ahora lo debe indexar. Utilice el formato siguiente para añadir el tipo de registro Customer y su conjunto de campos a este código: Customer=field1,field2,fieldN

Para añadir varios tipos de registro, utilice un punto y coma (;) como separador. Por ejemplo, puede añadir dos tipos de registro: Customer=field1,field2,fieldN;NewRecord=field1,field2,fieldN

No puede utilizar esta opción para añadir más campos a un tipo de registro indexado existente. Para ello, elimine primero el tipo de registro y, a continuación, añádalo de nuevo con esta opción. Este procedimiento requiere una indexación completa de este tipo de registro después de que se haya añadido de nuevo.

<removeRecordType> Lista de tipos de registro que se deben eliminar del despliegue de búsqueda de texto completo.

El valor predeterminado de este código está vacío. Utilice este código para eliminar los tipos de registro indexados del despliegue.

Especifique los nombres de los tipos de registro para su eliminación en este código. Para eliminar el tipo de registro Customer, escriba su nombre en este código. Para eliminar varios tipos de registro, utilice un punto y coma (;) como separador. Por ejemplo, puede eliminar dos tipos de registro: Customer;NewRecord.

<deleteFtsWASProfiles> Este código está establecido en TRUE para tener una copia de seguridad de la opción de línea de mandatos prep_upgd_was_profiles y suprimir todos los perfiles de WebSphere Application Server de búsqueda de texto completo de ClearQuest en este sistema host. Esta eliminación es necesaria para prepararse para actualizar, modificar o volver a instalar ClearQuest con la búsqueda de texto completo desplegada.

El valor predeterminado de este código se genera automáticamente mediante la herramienta cqtsadmin.pl y se establece en FALSE. Al actualizar, modificar o volver a instalar ClearQuest, establezca el valor en TRUE antes de ejecutar la opción de línea de mandatos prep_upgd_was_profiles para este despliegue de búsqueda de texto completo. A continuación, el mandato funciona globalmente en todos los despliegues de búsqueda de texto completo de este servidor.

El código tiene dos valores: TRUE y cualquier otro o está vacío. Si el valor está establecido en TRUE y especifica la opción de línea de mandatos prep_upgd_was_profiles, el mandato crea datos de seguridad de los perfiles de WebSphere Application Server de búsqueda de texto completo de ClearQuest. El mandato también suprime estos perfiles para prepararse para la restauración en la tarea de restauración después de la instalación. El mandato lleva a cabo esta acción para cada perfil de WebSphere Application Server de búsqueda de texto completo de este servidor.

Después de actualizar, modificar o volver a instalar ClearQuest, utilice la opción de línea de mandatos restore_was_profiles para volver a crear los perfiles de WebSphere Application Server de búsqueda de texto completo que se han suprimido.

Después de completar la opción de línea de mandatos prep_upgd_was_profiles, restablezca el valor de este código en FALSE para este despliegue de búsqueda de texto completo para evitar la supresión accidental.

Importante: A diferencia de otros códigos y mandatos, este código y mandato es global y afecta a todos los despliegues de búsqueda de texto completo de este servidor. Cuando realice este cambio y ejecute el mandato prep_upgd_was_profiles en alguno de los despliegues de búsqueda de texto completo de este servidor, todos los despliegues de este servidor se verán afectados.
<solrVersion> Este código contiene la versión de Apache Solr a la que ClearQuest da soporte actualmente. La herramienta de administrador de búsqueda de texto completo de ClearQuest utiliza el valor de este código para determinar la versión actual de Apache Solr y si existe una versión más reciente disponible. Cuando actualice la aplicación Apache Solr mediante la opción de línea de mandatos upgrade_solr_app, el valor de este código se actualizará para reflejar la versión actualizada.
Importante: No modifique el valor del código <solrVersion> a menos que se lo solicite el soporte técnico de IBM. No puede modificar este código.

Comentarios