cqtsadmin.pl

cqtsadmin.pl automatiza los pasos para configurar y administrar la búsqueda de texto completo de IBM® Rational ClearQuest.

Sinopsis

cqperl cqtsadmin.pl --username nombresuperusuario --password contraseña --dbset conjunto_db --userdb nombreconexión --ftshome cqftshome [options]

Descripción

cqtsadmin.pl es uno de los dos componentes de la herramienta de administrador de búsqueda de texto completo. El otro componente es cqtsadmin-dbset-userdb.xml, generado por el script cqtsadmin.pl. El archivo cqtsadmin-dbset-userdb.xml proporciona y contiene datos sobre el despliegue de la búsqueda de texto completo. Edite cqtsadmin-dbset-userdb.xml para completar el despliegue. Todas las opciones de línea de mandatos funcionan del mismo mod en Windows, UNIX o Linux con la excepción de scrub_oplog que no está disponible en UNIX o Linux.

Importante: Para ejecutar el mandato cqtsadmin.pl, la variable de entorno CQFTS_AppServer_HOME se debe establecer en el directorio en el que WebSphere Application Server está instalado. En determinadas circunstancias, como cuando instala ClearQuest en un perfil de WebSphere Application existente, o cuando instala la característica de búsqueda de texto completo en un sistema diferente que accede de forma remota a los servidores de ClearQuest Web, la variable de entorno CQFTS_AppServer_HOME no está establecida y se muestra un error similar al siguiente:

Cannot determine WebSphere’s AppServer home. See the ClearQuest Full-Text Search Administrator Guide on how to set it via the CQFTS_AppServer_HOME environment variable.

Para solucionar el problema, defina la varible CQFTS_AppServer_HOME en el directorio en el que haya instalado WebSphere Application Server. Por ejemplo, defina la variable de la siguiente manera:

En sistemas operativos Windows:
set CQFTS_AppServer_HOME=C:\Program Files\IBM\WebSphere\AppServer
En los sistema operativos UNIX y Linux:
setenv CQFTS_AppServer_HOME /opt/IBM/WebSphere/AppServer
Importante: Los argumentos arguments para dbset, userdb y ftshome son sensibles a las mayúsculas y minúsculas. Debe mantener las mayúsculas y minúsculas al utilizar el script cqtsadmin.pl. De lo contrario, es posible que se vuelva a configurar el despliegue de búsqueda de texto completo.

La opción ftshome

Al desplegar una búsqueda de texto completo o referirse a un despliegue, las los argumentos de opciones de línea de mandatos necesarias ftshome, dbset y userdb definen donde se ubican los datos de despliegue. El siguiente ejemplo muestra cómo crear un nuevo despliegue de búsqueda de texto completo de ClearQuest en la unidad D del directorio CQ.Search. El directorio se crea si no existe. El subdirectorio TextSearch_SAMPL se crea en el directorio anterior. El nombre del subdirectorio se genera en base al nombre del conjunto de bases de datos ClearQuest y al nombre de base de datos de usuario lógica ClearQuest. El subdirectorio contiene datos de búsqueda de texto completo para este despliegue.

cqperl cqtsadmin.pl --username admin --password “” --dbset TextSearch --userdb SAMPL --ftshome D:\CQ.Search --init_cq_fts --create_fts_was_profile manual --fts_was_profile_home D:\FTS.WASprofiles

Después de crear el directorio D:\CQ.Search\TextSearch_SAMPL, es la ubicación del despliegue de búsqueda de texto completo para el conjunto de bases de datos TextSearch y la base de datos de usuario SAMPL. Todos los datos y valores relacionados con este despliegue se realizan en este directorio. El resto de mandatos que emita que utilicen el mismo valor para los argumentos ftshome, dbset y userdb se aplican a este directorio.

Para desplegar una búsqueda de texto completo para una segunda base de datos de usuario de ClearQuest, especifique las opciones de línea de mandatos necesarias que pertenezcan a la segunda base de datos del usuario de ClearQuest. Bases de datos del usuario de ClearQuest adicionales desplegarán configuraciones de búsqueda de texto completo basadas en los argumentos ftshome específicos y la estructura de subdirectorios generada.

cqperl cqtsadmin.pl --username admin --password “” --dbset TextSearch --userdb PROD --ftshome D:\CQ.Search --init_cq_fts --create_fts_was_profile manual --fts_was_profile_home D:\FTS.WASprofiles
Tabla 1. Estructura de directorios del despliegue de la búsqueda de texto completo
Directorio o archivo Descripción
ftshome\dbset_userdb\logs\ Este directorio contiene registros de cada mandato que emita en este despliegue. Haga referencia a este directorio para obtener un historial de los mandatos que ha utilizado, cuándo los ha utilizado y su estado. IBM Software Support puede examinar estos registros cuando trabaje con usted en un problema. Las contraseñas se muestran como asteriscos (*) en los registros y salida de pantalla y no en texto sin formato.
ftshome\dbset_userdb\Solr\solr\conf\schema.xml Este archivo es uno de los archivos de configuración que el motor de búsqueda utiliza para determinar qué campos indexar y buscar. Al emitir el mandato cust_solr_files, los campos de este archivo se personalizan para coincidir con los campos de los tipos de registro como se especifica en el archivo de entidades.

Es posible que deba editar este archivo para personalizarlo más si su base de datos de ClearQuest no está en inglés. Consulte el apartado Habilitación de la búsqueda de texto completo en una base de datos en un idioma distinto del inglés para obtener más información.

ftshome\dbset_userdb\Solr\solr\data\index\ Este directorio contiene el índice real del despliegue.
Atención: No modifique el contenido de este directorio. La modificación del directorio puede poner en peligro la integridad del despliegue y puede requerir que se vuelva a indexar o a realizar el despliegue.
ftshome\dbset_userdb\AboutThisFTS.txt Este archivo se genera durante el despliegue inicial de la búsqueda de texto completo. Contiene información acerca del despliegue al que puede que deba hacer referencia. IBM Software Support puede examinar este archivo cuando trabaje con usted en un problema.
ftshome\dbset_userdb\CQ-dbset-userdb.xml Este archivo es el archivo XML de propiedades de búsqueda de texto completo de ClearQuest. El archivo contiene datos sobre la indexación por lotes y de actualización, el servidor de búsqueda, el perfil de conexión, los tipos de registro y los campos para indexar y buscar. IBM Software Support examina este archivo cuando trabaja con usted en un problema.
ftshome\dbset_userdb\cqtsadmin-dbset-userdb.xml Este archivo contiene la configuración del administrador de búsqueda de texto completo. Contiene datos sobre su despliegue. La mayoría de los datos se establece durante el despliegue, pero es posible que deba editar este archivo para personalizar algunos valores. IBM Software Support examina este archivo cuando trabaja con usted en un problema.
ftshome\dbset_userdb\Entity-dbset-userdb.txt El archivo de entidad contiene una lista de tipos de entidad y sus campos, para los que está habilitada la búsqueda. Durante el despliegue, es posible que deba editar este archivo para eliminar los campos o tipos de registro que no desee buscar. Después de completar el despliegue, no modifique este archivo. IBM Software Support examina este archivo cuando trabaja con usted en un problema.

Soporte de idioma nacional

Para utilizar cqtsadmin.pl en un sistema operativo no inglés, establezca la variable de entorno del sistema LANGUAGE en uno de los siguientes valores soportados:

Si LANGUAGE especifica un valor no soportado, cqtsadmin.pl falla con un mensaje de error.

Opciones y argumentos

El script cqtsadmin.pl tiene opciones de línea de mandatos necesarias y opcionales. Debe proporcionar las opciones de línea de mandatos necesarias cada vez que ejecute el script cqtsadmin.pl. Si alguno de los parámetros para las opciones necesarias es incorrecto, la herramienta falla con un mensaje de error. La herramienta autentica el usuario con la base de datos de ClearQuest antes de realizar una acción. Debe proporcionar como mínimo una opción de línea de mandatos opcional al ejecutar el script cqtsadmin.pl.

Opciones de línea de mandatos necesarias
username nombresuperusuario
Nombre de usuario ClearQuest con privilegios de superusuario
password contraseña
Contraseña del usuario de ClearQuest
dbset conjunto_db
Nombre del conjunto de bases de datos de ClearQuest. El valor distingue entre mayúsculas y minúsculas.
userdb nombreconexión
Nombre de la base de datos de usuario de ClearQuest. El valor distingue entre mayúsculas y minúsculas.
ftshome cqftshome
Directorio de inicio de búsqueda de texto completo de ClearQuest. Esta opción contiene todos los archivos de configuración relacionados con este despliegue y archivos de Solr, valores y el índice Lucene. El valor distingue entre mayúsculas y minúsculas.

Opciones de línea de mandatos opcionales

Las opciones de línea de mandatos opcionales llevan a cabo acciones específicas en el despliegue de búsqueda de texto completo de ClearQuest. Todos los mandatos generan salidas informativas, de progreso, aviso, error e instrucción. La salida de instrucción le ayuda a recuperarse de un error. La salida mostrada también se registra en el directorio de registros. Estos datos de registro son útiles al intentar depurar o rastrear la acción en un despliegue, porque no tiene que redirigir la salida de pantalla a un archivo. Normalmente, los mandatos no fallan. Si se produce un fallo, la mayoría de mandatos revierten todos los cambios. Cuando no se pueda revertir un cambio, se muestra un mensaje de error con instrucciones sobre lo que se debe hacer. Puede emitir una opción de línea de mandatos varias veces. Cuando se dan varias opciones de línea de mandatos opcionales, se ejecutan en el orden que aparecen en la línea de mandatos. Si una opción falla, la siguiente evaluación y ejecución de mandatos se detiene y la herramienta se cierra con un mensaje de error. Las opciones de línea de mandatos opcionales se pueden agrpar en dos categorías: opciones que más se utiliza y que casi nunca se utilizan.

add_record_type
Resumen
Añade uno o varios tipos de registro al índice. Esta opción inhabilita temporalmente la característica de búsqueda de texto completo para usuarios web de ClearQuest mientras el mandato se ejecuta. La lista de nuevos tipos de registro y los campos asociados se proporciona en el código <addRecordType> del archivo de configuración de administrador de búsqueda de texto completo.
Utilización
Utilice esta opción de línea de mandatos para añadir un tipo de registro si ha omitido un tipo de registro durante el despliegue de búsqueda de texto completo inicial o si ha añadido un nuevo tipo de registro al esquema de ClearQuest después del despliegue inicial y desea buscar en un nuevo tipo de registro. Utilice este mandato si ha renombrado, añadido o eliminado un campo en un tipo de registro que ya está indexado. Para reflejar el cambio en el índice, emita el mandato remove_record_type para eliminar el tipo de registro y, a continuación, emita este mandato para añadirlo de nuevo. Para añadir dos o más tipos de registro, utilice el punto y coma como separador. Por ejemplo, el siguiente código añade los tipos de registro Customer and Product.

<newValue required="no">Customer=CustomerNum,address,phone,product;Product=name,version</newValue>

Si lista un tipo de registro sin una lista de campos, todos los campos de ese tipo de registro se añadirán. En el siguiente ejemplo, se añaden todos los campos de los tipos de registro Customer y Product.

<newValue required="no">Customer;Product</newValue>
Efecto
Este mandato afecta al índice de búsqueda de texto completo de ClearQuest, al archivo XML de propiedades de búsqueda de texto completo de ClearQuest, al archivo de entidad y al archivo schema.xml de Solr. Antes de emitir este mandato, realice una copia de seguridad del despliegue. Ejecute esta opción en las horas de menor actividad. La operación es un proceso que consume tiempo y produce un breve tiempo de inactividad de la búsqueda de texto completo.
Estado
El mandato tiene estado. Si el mandato falla durante uno de sus puntos de ejecución, deberá poder corregir el problema y, a continuación, ejecutar el mandato de nuevo. La operación continúa desde el punto en que se detuvo. Si se produce un error, un mensaje de error indica qué hacer.
Ejemplo
Debe añadir un nuevo tipo de registro llamado Customer.
  1. Edite el archivo cqtsadmin-TextSearch-SAMPL.xml, y cambie el código <addRecordType>.

    <newValue required="no">Customer=CustomerNum,address,phone,product</newValue>

  2. Cree una copia de seguridad.

    cqperl cqtsadmin.pl --username admin --password "" --dbset TextSearch --userdb SAMPL --ftshome D:\CQ.Search --backup_fts E:\FTSBackup

  3. Añada el nuevo tipo de registro.

    cqperl cqtsadmin.pl --username admin --password "" --dbset TextSearch --userdb SAMPL --ftshome D:\CQ.Search --add_record_type

  4. Edite el archivo cqtsadmin-TextSearch-SAMPL.xml, y elimine lo que ha añadido al código <addRecordType>.Este paso es principalmente una tarea de limpieza.
archive_fts
Resumen
Archiva un despliegue de búsqueda de texto completo de ClearQuest. Inhabilita el despliegue de búsqueda de texto completo activo y, a continuación, elimina un perfil de WebSphere Application Server desplegado. Conserva todos los datos de configuración y el índice. Esta opción se puede utilizar para volver a empezar con una nueva configuración y hacer referencia a su configuración antigua.
Utilización
Utilice esta opción de línea de mandatos para iniciar un despliegue nuevo o utilice esta opción si no necesita la característica de búsqueda de texto completo de un despliegue. Esta opción de línea de mandatos detiene los servicios de búsqueda de texto completo y archiva los recursos relevantes como servicios y archivos. Puede consultar los despliegue después de archivarlo.
Nota: No utilice esta opción de línea de mandatos si desea realizar una en el futuro una restauración. Utilice la opción de línea de mandatos prep_upgd_was_profiles en su lugar.
Efecto
Esta opción de línea de mandatos inhabilita la búsqueda de texto completo. También elimina y suprime todos los archivos, recursos y valores utilizados y establecidos en WebSphere Application Server para este despliegue. Los datos de despliegue de ftshome permanecen intactos, pero se les cambia el nombre a dbset_userdb.Archived-time-stamp.
Estado
Esta opción no tiene estado. Si el mandato falla durante uno de sus puntos de ejecución, es posible que deba archivar manualmente. Un informe de progreso y un mensaje de error le indican cómo recuperarse del error.
Ejemplo
El ejemplo siguiente muestra cómo archivar un despliegue.

cqperl cqtsadmin.pl --username admin --password "" --dbset TextSearch --userdb SAMPL --ftshome D:\CQ.Search --archive_fts

Después de ejecutar el script, el despliegue de búsqueda de texto completo archivado se llama D:\CQ.Search\TextSearch_SAMPL.Archived-time-stamp.

backup_fts destination
Resumen
Crea una copia de seguridad del despliegue de búsqueda de texto completo de ClearQuest. Tras crear una copia de seguridad, puede recuperar datos de la copia de seguridad o de todo el despliegue. Para obtener mejores resultados, cree primero una copia de seguridad antes de ejecutar los mandatos que modifiquen considerablemente el despliegue existente. Antes de hacer copia de seguridad del despliegue, asegúrese de tener la misma cantidad de espacio de disco en la ubicación de copia de seguridad que utiliza su despliegue en ftshome.
Utilización
Utilice este mandato para crear una copia de seguridad al añadir o actualizar un tipo de registro o cuando la política de su organización necesite que realice copias de seguridad periódicas.
Nota: No utilice este mandato en lugar de la opción de línea de mandatos prep_upgd_was_profiles, que también gestiona los perfiles de WebSphere Application Server de copia de seguridad para cada base de datos de usuario.
Efecto
Este mandato inhabilita temporalmente el indexador de la modalidad de actualización mientras se realiza la copia de seguridad. Es posible que las búsquedas de texto completo no estén actualizadas durante la copia de seguridad. La duración depende del tamaño del índice, la velocidad del disco duro y si está realizando la copia de seguridad a través de una LAN o WAN.
Estado
Esta opción no tiene estado. Si el mandato falla durante uno de sus puntos de ejecución, debe completar la copia de seguridad manualmente o empezar de nuevo, en función del tipo de error y del mensaje de error que reciba. El error más probable consiste en no tener suficiente espacio de disco en el dispositivo de destino. Ninguno de los datos de despliegue se cambian durante la copia de seguridad.
Ejemplo
Desea crear una copia de seguridad del despliegue antes de añadir nuevos tipos de registro.

cqperl cqtsadmin.pl --username admin --password "" --dbset TextSearch --userdb SAMPL --ftshome D:\CQ.Search --backup_fts E:\FTSBackup

Después de ejecutar el script, el despliegue de búsqueda de texto completo archivado se llama E:\FTSBackup\TextSearch_SAMPL.Backup-time-stamp.

clear_state
Resumen
Restablece el estado en el procedimiento de herramienta cqtsadmin.pl para que no haya estado. De hecho, se desmarca el estado de la herramienta, independientemente del que fuera, que podría ser un estado incompleto.
Utilización
Utilice esta opción de línea de mandatos para desmarcar el estado de un mandato con estado para que pueda emitir otros mandatos o volver a emitir el mandato con estado. El tiempo para desmarcar el estado depende de qué mandato con estado desee desmarcar, el último estado de dicho mandato y el mensaje de error y las instrucciones correctivas proporcionadas.
Efecto
El efecto que tiene haber ejecutado esta opción de línea de mandatos depende de qué mandato con estado se haya detenido y de qué cantidad de mandato se haya completado antes de detenerlo. El mensaje de error y registro indican si puede restablecer el estado.
Estado
Esta opción no tiene estado. Este mandato no debe fallar nunca a menos que haya un error de E/S.
Ejemplo
Debe desmarcar el estado de una acción con estado para poder recuperarse de un error irrecuperable, de acuerdo con las instrucciones del mensaje de error.

cqperl cqtsadmin.pl --username admin --password "" --dbset TextSearch --userdb SAMPL --ftshome D:\CQ.Search --clear_state

copy_fts_template
Resumen
Copia y configura la plantilla predeterminada de búsqueda de texto completo de ClearQuest. Al desplegar la búsqueda de texto completo en una base de datos que todavía no se ha habilitado para la búsqueda de texto completo, debe empezar por una plantilla predeterminada limpia y copiarla a su directorio ftshome. Si intenta utilizar este mandato en un despliegue existente, falla con un error.
Utilización
En general, no necesita utilizar esta opción de línea de mandatos directamente porque se llama cuando emite la opción de línea de mandatos init_cq_fts. Esta opción de línea de mandatos se proporciona en caso de que necesite ajustar o depurar el despliegue.
Efecto
Esta opción de línea de mandatos copia los datos predeterminados necesarios para la característica de búsqueda de texto completo al directorio ftshome especificado.
Estado
Esta opción no tiene estado. Este mandato no debe fallar nunca a menos que haya un error de E/S.
Ejemplo
IBM Rational Client Support le ha indicado que emita este mandato para depurar un problema de despliegue o para personalizar un despliegue.

cqperl cqtsadmin.pl --username admin --password "" --dbset TextSearch --userdb SAMPL --ftshome D:\CQ.Search --copy_fts_template

create_fts_was_profile startup-type { manual | automatic | disabled }
Resumen
Cree un perfil de WebSphere Application Server de búsqueda de texto completo de ClearQuest. Necesario para todos los despliegues nuevos.
Utilización

Cada despliegue de búsqueda de texto completo de ClearQuest debe tener su propio perfil de WebSphere Application Server, un perfil de WebSphere Application Server para cada base de datos de usuario con búsqueda de texto completo de ClearQuest.

El valor de parámetro configura el estado de servicio de Windows solo para los despliegues del sistema operativo Windows. Este valor se ignora en los sistemas operativos UNIX y Linux para los que debe configurar el perfil de WebSphere Application Server para empezar en el tiempo de arranque como daemon.

El nombre de perfil de WebSphere Application Server está determinado por el conjunto de bases de datos y el nombre de base de datos de usuario. Sin embargo, puede sustituirlo por el código <ftsWASProfileName>.

Especifique la ubicación apra crear el perfil de WebSphere Application Server con la opción de línea de mandatos fts_was_profile_home. Si no especifica la ubicación, se utilizará la ubicación predeterminada %CLEARQUEST_HOME%/cqweb/. Para obtener mejores resultados, especifique su ubicación.

Nota: Utilice siempre esta opción de línea de mandatos con la opción de línea de mandatos init_cq_fts para que se cree un perfil de WebSphere Application Server y se personalice en base a su despliegue de búsqueda de texto completo de ClearQuest. De lo contrario, el despliegue fallará a menos que el perfil de WebSphere Application Server se haya creado previamente con esta herramienta y se reutilice.
Efecto
Esta opción de línea de mandatos crea un nuevo perfil de WebSphere Application Server en WebSphere Application Server utilizando el siguiente puerto disponible. Cuando se complete la operación, la utilización de espacio de disco es aproximadamente de 200 MB. Si el perfil se establece en Automático en Windows, el servicio se inicia automáticamente cuando Windows se reinicia.
Estado
Esta opción no tiene estado. Este mandato no debe fallar nunca a menos que haya un error de E/S.
Ejemplo
Tiene previsto desplegar la búsqueda de texto completo para una segunda base de datos de usuario. El nombre de su base de datos establecida es MASTR, y el nombre de base de datos de usuario es SAMPL.
  1. Emita el siguiente mandato para configurar un despliegue inicial.

    cqperl cqtsadmin.pl --username admin --password "" --dbset MASTR --userdb SAMPL --ftshome D:\CQ.Search --init_cq_fts --create_fts_was_profile automatic --fts_was_profile_home D:\FTS.WASprofiles

  2. Modifique su archivo de entidad para que contenga solo los campos y tipos de registro en los que está registrado.
  3. Emita este mandato para completar su despliegue.

    cqperl cqtsadmin.pl --username admin --password "" --dbset MASTR --userdb SAMPL --ftshome D:\CQ.Search --setup_cq_fts

cust_fts_files
Resumen
Personaliza el archivo XML de propiedades de búsqueda de texto completo de ClearQuest basado en la base de datos de usuario, archivo de entidad y archivo de configuración de administrador de búsqueda de texto completo. Al desplegar la búsqueda de texto completo de ClearQuest por primera vez, debe personalizar el archivo de propiedades de búsqueda de texto completo CQ-dbset-userdb.xml.
Utilización
La plantilla de búsqueda de texto completo predeterminada contiene valores genéricos que puede personalizar en base a la base de datos de usuario. Un archivo que debe personalizar es el archivo XML de propiedades de búsqueda de texto completo. Este archivo contiene una lista de todos los tipos de registros y sus campos basada en lo especificado en el archivo de entidad. Este archivo también contiene parámetros tales como qué campo se debe utilizar como campo de visualización, la frecuencia con la que se deben comprobar los cambios de la base de datos de usuario de ClearQuest, y cómo comunicarse con la base de datos y el servidor de ClearQuest. En general, no necesita utilizar esta opción de línea de mandatos directamente porque se llama cuando emite la opción de línea de mandatos setup_cq_fts. Esta opción de línea de mandatos se proporciona en caso de que necesite ajustar o depurar el despliegue.
Efecto
Si utiliza esta opción de línea de mandatos en un despliegue, se sobrescribe el archivo CQ-dbset-userdb.xml. Todos los cambios realizados en el archivo, ya sea manualmente o emitiendo mandatos, se pierden.
Estado
Esta opción no tiene estado. Este mandato no debe fallar nunca a menos que haya un error de E/S.
Ejemplo
IBM Software Support le pide que depure un problema de despliegue de búsqueda de texto completo o que personalice un despliegue.

cqperl cqtsadmin.pl --username admin --password "" --dbset TextSearch --userdb SAMPL --ftshome D:\CQ.Search --cust_fts_files

cust_solr_files
Resumen
Al desplegar la búsqueda de texto completo de ClearQuest por primera vez, debe personalizar el archivo de esquema Solr que se basa en su archivo de entidad de ClearQuest actual.
Utilización
La plantilla de búsqueda de texto completo predeterminada es genérica y contiene valores predeterminados que debe personalizar en base a la base de datos de usuario. Un archivo que debe personalizar es el archivo Solr schema.xml. Este archivo contiene todos los campos de todos los tipos de registro que ha establecido que se buscarán utilizando el archivo de entidad. En general, no necesita utilizar esta opción de línea de mandatos directamente porque se llama cuando emite la opción de línea de mandatos setup_cq_fts. Esta opción de línea de mandatos se proporciona en caso de que necesite ajustar o depurar el despliegue.
Efecto
Esta opción de línea de mandatos lee los datos del archivo de entidad y personaliza el archivo Solr schema.xml. Si utiliza la opción en un despliegue existente, se refactoriza el archivo schema.xml. Si ha cambiado los archivos de entidad después del despliegue inicial, se pierden los valores anteriores.
Estado
Esta opción no tiene estado. Este mandato no debe fallar nunca a menos que haya un error de E/S.
Ejemplo
IBM Software Support le pide que depure un problema de despliegue de búsqueda de texto completo o que personalice un despliegue.

cqperl cqtsadmin.pl --username admin --password "" --dbset TextSearch --userdb SAMPL --ftshome D:\CQ.Search --cust_solr_files

delete_fts_was_profile
Resumen
Para suprimir un perfil de WebSphere Application Server o si desea volver a empezar de nuevo, ejecute esta opción de línea de mandatos. Suprime el perfil de WebSphere Application Server de búsqueda de texto completo de ClearQuest asociado con este despliegue de búsqueda de texto completo de ClearQuest. Esta opción es diferente de archive_fts, en que solo se suprime el perfil de WebSphere Application Server. Sin embargo, no se eliminan el directorio de inicio de búsqueda de texto completo y los metadatos asociados. Para eliminar completamente un despliegue de búsqueda de texto completo de ClearQuest, utilice la opción archive_fts.
Utilización
En general, no utilice este mandato directamente porque se llama cuando emite la opción de línea de mandatos archive_fts. Este mandato se proporciona en caso de que necesite ajustar o depurar el despliegue.
Efecto
Se liberan los recursos utilizados por WebSphere para este perfil de WebSphere Application Server. Si la búsqueda de texto completo de If ClearQuest Web no se ha inhabilitado con la opción de línea de mandatos disable_cqweb_fts, se producirán errores en las búsquedas de texto completo.
Estado
Esta opción no tiene estado. Este mandato no debe fallar nunca a menos que haya un error de E/S.
Ejemplo
Debe cambiar el nombre o la ubicación de su perfil de WebSphere Application Server, pero no debe volver a desplegar completamente la solución de búsqueda de texto completo.
  1. Suprima el perfil de WebSphere Application Server.

    cqperl cqtsadmin.pl --username admin --password "" --dbset TextSearch --userdb SAMPL --ftshome D:\CQ.Search --delete_fts_was_profile

  2. Edite el archivo cqtsadmin-dbset-userdb.xml y cambie el código <ftsWASProfileName> del nombre predeterminado generado automáticamente al nuevo nombre para el perfil de WebSphere Application Server. El nombre debe ser exclusivo. De lo contrario, el mandato fallará.
  3. Vuelva a crear el perfil de WebSphere Application Server.

    cqperl cqtsadmin.pl --username admin --password "" --dbset TextSearch --userdb SAMPL --ftshome D:\CQ.Search --create_fts_was_profile automatic --fts_was_profile_home D:\FTS.WASprofiles

  4. Si también tenía pensado cambiar el número de puerto de este perfil de WebSphere Application Server, edite el archivo cqtsadmin-dbset-userdb.xml y actualice el número de puerto del código <ftsWASProfilePort> antes de realizar el paso 3. O bien, emita este mandao para redefinir los puertos en lugar de:

    cqperl cqtsadmin.pl --username admin --password "" --dbset TextSearch --userdb SAMPL --ftshome D:\CQ.Search --create_fts_was_profile automatic --fts_was_profile_home D:\FTS.WASprofiles --was_profile_ports_file D:\CQ.Search\TextSearch_SAMPL\cqftsportdef.props

disable_cqweb_fts
Resumen
Esta opción de línea de mandatos inhabilita el botón de selección Texto completo en ClearQuest Web, y detiene el registro de registros de operación (oplogs) en una base de datos de usuario de ClearQuest no replicada. Esta opción de línea de mandatos no afecta a la creación de registros de operación en entornos replicados.
Atención: Utilice esta opción de línea de mandatos con cuidado. Inhabilita el registro de oplog si su base de datos de ClearQuest no se replica. Si se cambian los registros de ClearQuest cuando no se generan oplogs y los registros cambiados no se vuelven a indexar. Tendrá que volver realizar una indexación de toda la base de datos de usuario. Evite que los usuarios accedan a ClearQuest o permita solo operaciones de solo lectura hasta que se vuelva a habilitar la capacidad de búsqueda de texto completo.
Utilización
No tiene que utilizar este mandato a menos que esté en un entorno de prueba o que IBM Software Support se lo indique.
Efecto
La generación de oplogs se detiene, si su base de datos no se replica y el botón de selección de Texto completo se inhabilita.
Estado
Esta opción no tiene estado. Este mandato no debe fallar nunca a menos que haya un error de E/S.
Ejemplo
IBM Rational Client Support le indica que inhabilite la búsqueda de texto completo para ayudarle a resolver problemas.

cqperl cqtsadmin.pl --username admin --password "" --dbset TextSearch --userdb SAMPL --ftshome D:\CQ.Search --disable_cqweb_fts

enable_cqweb_fts
Resumen
Habilite el botón de selección Texto completo en ClearQuest Web. La generación de oplogs también se habilita si su base de datos de ClearQuest no se replica y está en el nivel de característica 7. Si su base de datos de usuario de ClearQuest se replica, no se realizan cambios en la generación de oplogs. Si el despliegue no se ha configurado correctamente, los usuarios que intenten utilizar la búsqueda de texto completo reciben mensajes de error.
Utilización
No tiene que utilizar este mandato a menos que esté en un entorno de prueba o que IBM Software Support se lo indique.
Efecto
La generación de oplogs se inicia, si la base de datos no se replica y está en el nivel de característica 7. El botón de selección Texto completo en ClearQuest Web está habilitado.
Estado
Esta opción no tiene estado. Este mandato no debe fallar nunca a menos que haya un error de E/S.
Ejemplo
IBM Software Support le pide que habilite la búsqueda de texto completo para ayudarle a resolver problemas.

cqperl cqtsadmin.pl --username admin --password "" --dbset TextSearch --userdb SAMPL --ftshome D:\CQ.Search --enable_cqweb_fts

fresh_batch_idx
Resumen
Esta opción de línea de mandatos le permite que fuerce una reindexación completa en la modalidad de proceso por lotes tras la indexación inicial. La indexación en modalidad de proceso por lotes es el proceso de lectura de todos los registros de ClearQuest configurados para buscar y enviar los datos de los registros al motor de búsqueda (Solr) para la indexación. La indexación en modalidad de proceso por lotes se realiza como parte de la ejecución de la opción de línea de mandatos setup_cq_fts. Antes de emitir este mandato, emita la opción de línea de mandatos stop_update_idx para detener el indexador de la modalidad de actualización. Si no lo hace, el indexador de la modalidad de proceso por lotes puede sustituir los datos de un registro más reciente indexados por el indexador de la modalidad de actualización. Cuando se complete la reindexación, se fragmenta el índice. Normalmente, esta fragmentación no afecta al rendimiento de sus búsquedas. Sin embargo, el tamaño del índice puede crecer hasta dos veces el tamaño actual. Para optimizar el índice y reducir su tamaño, ejecute la opción de línea de mandatos optimize_idx.
Utilización
No tiene que utilizar este mandato a menos que esté en un entorno de prueba o que IBM Software Support se lo indique.
Efecto
Se actualiza el índice de búsqueda. Su tamaño aumenta hasta dos veces el tamaño actual. Por lo tanto, confirme que tiene suficiente espacio de disco antes de utilizar este mandato. Mientras se realiza la reindexación, puede que los resultados de la búsqueda no estén completos porque el indexador de la modalidad de actualización está inhabilitado.
Estado
Esta opción no tiene estado. Este mandato no debe fallar nunca a menos que haya un error de E/S.
Ejemplo
IBM Software Support le pide que reindexe completamente los registros de búsqueda.
  1. Detenga el indexador de la modalidad de actualización.

    cqperl cqtsadmin.pl --username admin --password "" --dbset TextSearch --userdb SAMPL --ftshome D:\CQ.Search --stop_update_idx

  2. Fuerce la renindexación en modalidad de proceso por lotes.

    cqperl cqtsadmin.pl --username admin --password "" --dbset TextSearch --userdb SAMPL --ftshome D:\CQ.Search --fresh_batch_idx

  3. Ejecute la optimización del índice.

    cqperl cqtsadmin.pl --username admin --password "" --dbset TextSearch --userdb SAMPL --ftshome D:\CQ.Search --optimize_idx

  4. Habilite el indexador de la modalidad de actualización.

    cqperl cqtsadmin.pl --username admin --password "" --dbset TextSearch --userdb SAMPL --ftshome D:\CQ.Search --start_update_idx

    Nota: Puede combinar estos pasos en un mandato. Es posible que desee hacerlo así porque esta operación tarda mucho tiempo si reindexa muchos registros.

    cqperl cqtsadmin.pl --username admin --password "" --dbset TextSearch --userdb SAMPL --ftshome D:\CQ.Search -- stop_update_idx --fresh_batch_idx --optimize_idx --start_update_id

fresh_update_idx
Resumen
Fuerza una reindexación completa de todos los cambios del registro de oplog registrados por el indexador de la modalidad de actualización. Utilice esta opción con cuidado. El indexador de modalidad de actualización tiene una única hebra. Esta operación tarda mucho tiempo, especialmente si la base de datos de ClearQuest contiene muchos oplogs.

La indexación en modalidad de actualización es el proceso de supervisión de la base de datos de ClearQuest para los cambios en los tipos de registro configurados para la búsqueda. La supervisión se realiza comprobando oplogs en la base de datos de ClearQuest. La indexación en modalidad de actualización está habilitada como parte de la opción de línea de mandatos setup_cq_fts. A diferencia de la opción de línea de mandatos fresh_batch_idx, este mandato no necesita que detenga el indexador de la modalidad de actualización. Cuando se complete este mandato en un índice lleno, el índice se fragmentará. Normalmente, esta fragmentación no afecta al rendimiento de sus búsquedas. Sin embargo, el tamaño del índice puede crecer hasta dos veces el tamaño actual. Para optimizar el índice y reducir su tamaño, ejecute la opción de línea de mandatos optimize_idx.Considere cuidadosamente si iniciar el indexador de la modalidad de actualización desde el primer oplog registrado. Con el tiempo, conseguirá un oplog por cada acción llevada a cabo en un registro de ClearQuest y es posible que no desee indexar desde el primer oplog registrado, especialmente si no ha depurado oplogs constantemente. Este mandato está pensado para utilizarlo con entornos de prueba y para depurar problemas de despliegue de búsqueda de texto completo con IBM Rational Client Support.

Utilización
No tiene que utilizar este mandato a menos que esté en un entorno de prueba o que IBM Software Support se lo indique.
Efecto
Se actualiza el índice de búsqueda. Su tamaño podría aumentar hasta dos veces el tamaño actual. Asegúrese de que tiene suficiente espacio de disco antes de utilizar este mandato.
Estado
Esta opción no tiene estado. Este mandato no debe fallar nunca a menos que haya un error de E/S.
Ejemplo
IBM Software Support le pide que fuerce una reindexación del indexador de la modalidad de actualización.

cqperl cqtsadmin.pl --username admin --password "" --dbset TextSearch --userdb SAMPL --ftshome D:\CQ.Search --fresh_update_idx

fts_was_profile_home destination
Resumen
Utilice esta opción de línea de mandatos con la opción de línea de mandatos create_fts_was_profile para especificar dónde se creará el perfil de WebSphere Application Server para este despliegue de búsqueda de texto completo de ClearQuest. Si omite esta opción, se utilizará la ubicación predeterminada ${CLEARQUEST_HOME}/cqweb/. La ubicación predeterminada no siempre es adecuada porque es posible que existan archivos adicionales creados en el directorio de instalación de ClearQuest que interfieren con la instalación de ClearQuest como, por ejemplo, en la desinstalación o actualización. Esta opción de línea de mandatos también se puede utilizar con la opción de línea de mandatos restore_was_profile. Puede especificar una ubicación diferente de la original en la que se crearán los perfiles de WebSphere Application Server de búsqueda de texto completo.
Utilización
Si desea desplegar la búsqueda de texto completo de ClearQuest para una base de datos de ClearQuest, y no desea que se utilice la ubicación predeterminada para crear y almacenar los archivos de WebSphere relacionados con el despliegue: Utilice esta opción de línea de mandatos junto con la opción de línea de mandatos create_fts_was_profile para especificar dónde creará el perfil de WebSphere Application Server de búsqueda de texto completo. Si tiene más de un despliegue de búsqueda de texto completo en esta máquina, utilice la misma ubicación para todos ellos, de forma que todos los perfiles de WebSphere Application Server estén en la misma ubicación.
Efecto
Si no existe, se crea un directorio en la ubicación fts_was_profile_home. Contiene los datos relacionados con el perfil de WebSphere Application Server. Se crea un subdirectorio en este directorio. Representa el nombre de perfil de WebSphere Application Server, que es cqsearchprofile_dbset_userdb o cqfts_dbset_userdb.
Estado
Esta opción no tiene estado. Este mandato no debe fallar nunca a menos que se produzca un error de E/S o que la vía de acceso no sea válida como una letra de unidad que no existe o que una vía de acceso de montaje Unix o Linux no existente.
Ejemplo
Debe desplegar la búsqueda de texto completo de ClearQuest. No debe utilizar la ubicación predeterminada pars los perfiles de WebSphere Application Server.

cqperl cqtsadmin.pl --username admin --password "" --dbset TextSearch --userdb SAMPL --ftshome D:\CQ.Search --init_cq_fts --create_fts_was_profile manual --fts_was_profile_home D:\FTS.WASprofiles

gather_diagnostic_data
Resumen
Recopila datos que ayudan a que IBM Software Support diagnostique posibles problemas de búsqueda de texto completo de ClearQuest. Si necesita soporte, ejecute esta opción de línea de mandatos de diagnóstico y envíe los datos que recopile con esta opción de línea de mandatos para obtener asistencia. Esta opción de línea de mandatos recopila datos relevantes acerca del despliegue de búsqueda de texto completo de ClearQuest. Los datos se copian en un directorio que tal vez deba enviar a IBM Software Support. Antes de enviar los datos, compruebe que no contengan información confidencial. Normalmente, los datos más importantes son los nombres de tipo de registro que ha habilitado para la búsqueda y un historial de los términos de búsqueda que haya enviado su organización. El historial es el registro que WebSphere guarda para su perfil de WebSphere Application Server. Las contraseñas se convierten a asteriscos al enviar la salida a la pantalla o los archivos de registro. Nunca se almacenan como texto sin formato.
Utilización
Utilice este mandato para recopilar y enviar datos de diagnóstico a IBM Software Support para ayudarle a diagnosticar problemas con la búsqueda de texto completo.
Efecto
No cambia ninguno de sus datos o valores de configuración. Se crea un nuevo directorio con el nombre de su despliegue y una indicación de fecha y hora. El tamaño acumulativo de los datos de diagnóstico varía en función del tamaño total de los registros del despliegue, que normalmente está en megabytes. El índice real no forma parte de los datos de diagnóstico.
Estado
Esta opción no tiene estado. Este mandato no debe fallar nunca a menos que haya un error de E/S.
Ejemplo
IBM Software Support le pide que envíe datos de diagnóstico para ayudarle a resolver problemas con la búsqueda de texto completo. El siguiente mandato crea los datos de diagnóstico y los coloca un archivo D:\CQ.Search\TextSearch_SAMPL.Diag-time-stamp.

cqperl cqtsadmin.pl --username admin --password "" --dbset TextSearch --userdb SAMPL --ftshome D:\CQ.Search --gather_diagnostic_data

gen_entity_file
Resumen
Esta opción de línea de mandatos genera el archivo de entidad, que contiene todos los tipos de registroque se pueden enviar a la base de datos de ClearQuest. De forma predeterminada, el archivo de entidad contiene todos los tipos de registro y todos los campos del esquema de ClearQuest. Además, son candidatos para la búsqueda de texto completo. Puede personalizar el archivo para seleccionar solo los tipos de registro y los campos asociados que desee indexar. Al desplegar la búsqueda de texto completo en una base de datos de usuario de ClearQuest por primera vez, debe tener un archivo de entidad que contenga todos los tipos de registro y sus campos a los que hace referencia el esquema de la base de datos de usuario de ClearQuest. Este archivo de entidad se utiliza como entrada para generar el archivo XML de propiedades de búsqueda de texto completo, el archivo XML intermedio de Solr y el archivo Solr schema.xml.
Utilización
En general, no tiene que utilizar este mandato directamente. Se llama cuando emite la opción de línea de mandatos init_cq_fts. Este mandato se proporciona en caso de que necesite ajustar o depurar el despliegue.
Efecto
Si utiliza este mandato en un despliegue existente, sobrescribe el archivo Entity-dbset-userdb.txt y pierde los cambios realizados.
Estado
Esta opción no tiene estado. Este mandato no debe fallar nunca a menos que haya un error de E/S.
Ejemplo
IBM Rational Software Support le ha indicado que depure un problema de despliegue de la búsqueda de texto completo o que personalice un despliegue.

cqperl cqtsadmin.pl --username admin --password "" --dbset TextSearch --userdb SAMPL --ftshome D:\CQ.Search --gen_entity_file

gen_fts_files
Resumen
Esta opción de línea de mandatos genera archivos de configuración de búsqueda de texto completo de ClearQuest basados en la base de datos de usuario, archivo de entidad y archivo de configuración de administrador de búsqueda de texto completo. Al desplegar la búsqueda de texto completo en una base de datos de usuario por primera vez, debe generar el archivo XML de propiedades de búsqueda de texto completo. Este archivo contiene información sobre los valores de despliegue como, por ejemplo, la frecuencia de indexación, el tamaño de lote a indexar e información del servidor de búsqueda.
Utilización
En general, no tiene que utilizar esta opción de línea de mandatos directamente. Se llama cuando emite la opción de línea de mandatos setup_cq_fts. Esta opción de línea de mandatos se proporciona en caso de que necesite ajustar o depurar el despliegue.
Efecto
Si utiliza este mandato en un despliegue existente, sobrescribe los archivos Entity-dbset-userdb.txt, Solr-dbset-userdb.txt y CQ-dbset-userdb.xml y pierde los cambios realizados en ellos.
Estado
Esta opción no tiene estado. Este mandato no debe fallar nunca a menos que haya un error de E/S.
Ejemplo
IBM Rational Software Support le ha indicado que depure un problema de despliegue de la búsqueda de texto completo o que personalice un despliegue.

cqperl cqtsadmin.pl --username admin --password "" --dbset TextSearch --userdb SAMPL --ftshome D:\CQ.Search --gen_fts_file

help
Resumen
Muestra el texto de ayuda y, a continuación, se cierra.
Utilización
Está familiarizado con el script cqtsadmin.pl, pero desea refrescar sus conocimientos sobre los mandatos disponibles.
Efecto
Ninguno. Este mandato no cambia los datos y no requiere autenticación para ejecutarse.
Estado
Esta opción no tiene estado. Este mandato no debe fallar nunca a menos que haya un error de E/S.
Ejemplo
Desea una lista de mandatos disponibles.

cqperl cqtsadmin.pl --help

init_cq_fts
Resumen
Copia la plantilla predeterminada de búsqueda de texto completo de ClearQuest y, a continuación, genera el archivo de entidad predeterminado. En efecto, ejecuta las opciones copy_fts_template y gen_entity_file: Este mandato es uno de los primeros mandatos que ejecuta al desplegar la búsqueda de texto completo. Crea un directorio dbset_userdb en el directorio ftshome. Todos los datos predeterminados y valores relacionados con este despliegue se colocan en este directorio. Uno de los archivos de claves que crea esta opción es el archivo de entidad Entity-dbset-userdb.txt. Se coloca en el directorio ftshome. Al personalizar su despliegue, decide si desea dejarlo tal como está o eliminar los tipos de registro y los campos que no desea que se busquen. Otro archivo creado es el archivo de configuración de administrador de búsqueda de texto completo cqftsadmin-dbset-userdb.xml. Este archivo contiene valores predeterminados adicionales específicos para el despliegue y entorno como, por ejemplo, el nombre del servidor, el nombre de perfil de WebSphere Application Server, el tamaño de lote de la indexación y la frecuencia de indexación.
Nota: Esta opción de línea de mandatos normalmente se ejecuta junto con las opciones de línea de mandatos create_fts_was_profile y fts_was_profile_home para que se cree un nuevo perfil de WebSphere Application Server para este despliegue. De lo contrario, el despliegue de búsqueda de texto completo de ClearQuest falla, a menos que vuelva a utilizar un perfil de WebSphere Application Server que se haya desplegado antes para la búsqueda de texto completo.
Utilización
Utilice este mandato para preconfigurar su despliegue de búsqueda de texto completo. Crea el directorio ftshome, copia los archivos predeterminados a este y establece valores predeterminados. Antes de completar el despliegue, normalmente debe personalizar el archivo de entidad.
Efecto
Este mandato crea un nuevo directorio ftshome, si no existe, y copia los valores y datos predeterminados para el despliegue en éste.
Estado
Esta opción no tiene estado. Este mandato no debe fallar nunca a menos que haya un error de E/S.
Ejemplo
Desea iniciar un nuevo despliegue de búsqueda de texto completo para una de sus bases de datos de usuario.
  1. Ejecute este mandato para preconfigurar su despliegue.

    cqperl cqtsadmin.pl --username admin --password "" --dbset TextSearch --userdb SAMPL --ftshome D:\CQ.Search --init_cq_fts --create_fts_was_profile Automatic --fts_was_profile_home D:\CQFTS.WASprofiles

  2. Edite este archivo de entidad de despliegue para eliminar los tipos de registro o campos que los usuarios no deben poder buscar. Además, añada un ampersand (&) delante de un campo para cada tipo de registro. Este será el campo de visualización en el conjunto de resultados de la búsqueda de texto completo.

    D:\CQ.Search\TextSerch_SAMPL\Entity-TextSearch-SAMPL.txt

  3. Complete su despliegue ejecutando este mandato:

    cqperl cqtsadmin.pl --username admin --password "" --dbset TextSearch --userdb SAMPL --ftshome D:\CQ.Search --setup_cq_fts

lock_cq_fts
Resumen

Esta opción de línea de mandatos bloquea este despliegue de búsqueda de texto completo de ClearQuest para que solo se puedan ejecutar los mandatos no destructivos cqtsadmin.pl. Se inhabilitan todos los mandatos, salvo gather_diagnostic_data y help. Utilice la opción unlock_cq_fts para habilitar de nuevo los mandatos.

Utilización
Después de desplegar la búsqueda de texto completo, emita este mandato para bloquear el despliegue y evitar modificaciones involuntarias. Este bloqueo es débil. Cualquier persona con acceso correcto al sistema de archivos o con privilegios de ClearQuest puede desbloquear un despliegue. El objetivo de este mandato consiste en habilitar los administratores para señalizar que el despliegue se ha completado. El resto de modificaciones se deben comunicar y emitir con cuidado.
Efecto
Ninguno. Sus valores y datos de despliegue de búsqueda de texto completo no se ven afectados.
Estado
Esta opción no tiene estado. Este mandato no debe fallar nunca a menos que haya un error de E/S.
Ejemplo
Ha completado un despliegue y desea asegurarse de que el despliegue no se modifica.

cqperl cqtsadmin.pl --username admin --password "" --dbset TextSearch --userdb SAMPL --ftshome D:\CQ.Search --lock_cq_fts

optimize_idx
Resumen

Esta opción de línea de mandatos desfragmenta el índice. La optimización necesita un mínimo de 1,5 veces el espacio libre de disco que su tamaño de índice actual o uno satisfactorio. Por ejemplo, si el índice utiliza 2 GB de espacio de disco, debe tener 3 GB de espacio libre de disco para ejecutar el mandato.

Utilización

A medida que añade o modifica registros en el índice de búsqueda, este puede fragmentarse. Los índices fragmentados tienden a crecer a un tamaño superior a los no fragmentados. También puede haber una pequeña degradación de rendimiento. Para reducir el tamaño de índice y restaurar el rendimiento, optimice su índice al menos una vez al año. Optimícelo con más frecuencia si la base de datos de ClearQuest tiene una gran actividad de modificación, adición y superesión de registros.

Antes de emitir este mandato, asegúrese de tener suficiente espacio libre de disco. De lo contrario, la optimización fallará, pero el índice original permanecerá intacto. El espacio libre de disco es necesario porque el índice original se reescribe durante la optimización. El índice anterior se mantiene hasta que se vuelve a generar el nuevo índice.

El tiempo necesario para optimizar un índice depende del tamaño del índice y de la velocidad del disco duro y E/S. La optimización puede tardar unas horas en un índice de 2 GB. Mientras la optimización está en curso, todos los servicios de búsqueda de texto completo están disponibles, incluyendo el indexador de la modalidad de actualización. Sin embargo, puede haber una pequeña degradación de rendimiento. Planifique la optimización del índice para las horas de menor actividad.

Efecto
Su índice de búsqueda se sobrescribe. Si un se produce un error de E/S durante la optimización, es probable que sea porque no hay suficiente espacio de disco. El índice original permanece intacto. El índice de original puede ser más grande, pero volverá a su tamaño original después de que se complete su optimización.
Estado
Esta opción no tiene estado. Este mandato no debe fallar nunca a menos que haya un error de E/S.
Ejemplo
Debe optimizar su índice de búsqueda.

cqperl cqtsadmin.pl --username admin --password "" --dbset TextSearch --userdb SAMPL --ftshome D:\CQ.Search --optimize_idx

prep_upgd_was_profiles destination
Resumen
Durante un tiempo de inactividad planificado, esta opción de línea de mandatos se prepara para una modificación y reinstalación de ClearQuest. Utilice la copia de seguridad que crea este mandato para restaurar los despliegues de búsqueda de texto completo incluyendo su perfil de WebSphere Application Server en el estado original.
Utilización

Todas las bases de datos de usuario desplegadas con la búsqueda de texto completo requieren un perfil correspondiente de WebSphere Application Server. Es posible que estos perfiles no se conserven después de actualizar, modificar o reinstalar ClearQuest. Las actualizaciones que estén disponibles en ClearQuest Fixpacks solo pueden incorporarse a los despliegues de búsqueda de texto completo de ClearQuest a través de este procedimiento de preparación y restauración. Al utilizar esta opción de línea de mandatos con la opción de línea de mandatos restore_was_profiles, se crean datos de seguridad, se suprimen opcionalmente los perfiles de WebSphere Application Server y se restauran los perfiles suprimidos de WebSphere Application Server de la vía de acceso de datos de seguridad especificada al invocalos después de actualizar o reinstalar ClearQuest.

Para suprimir los perfiles de ClearQuest WebSphere Application Server, debe cambiar el valor del código <deleteFtsWASProfiles> de FALSE a TRUE para un archivo de configuración de administrador de búsqueda de texto completo cqtsadmin-dbset-userdb.xml. Asegúrese de consultar este de despliegue modificado al ejecutar el mandato. De lo contrario, los perfiles de WebSphere Application Server no se eliminarán correctamente en la preparación para su restauración y actualización.

Esta opción de línea de mandatos se puede ejecutar en cualquier dbset, userdb o ftshome. La opción no está asociada con un determinado despliegue de búsqueda de texto completo: Evalúa y afecta a todos los despliegues de búsqueda de texto completo de ClearQuest en el host en cualquier directorio ftshome.
Nota: Si tiene más de un despliegue de búsqueda de texto completo en la máquina actual, esta opción de línea de mandatos y la opción de línea de mandatos restore_was_profiles solo se deben ejecutar una vez. Estos dos mandatos actúan de forma global en todo el despliegue de búsqueda de texto completo de la máquina actual.
Atención: Al realizar la actualización de ClearQuest, debe ejecutar esta opción de línea de mandatos con el código <deleteFtsWASProfiles> establecido en TRUE. De lo contrario, el resultado podría ser una actualización incompleta de los despliegues de búsqueda de texto completo. Una vez se haya completado la actualización y haya ejecutado la opción de línea de mandatos restore_was_profiles, cambie esta opción a FALSE
Efecto
Si el código <deleteFtsWASProfiles> está establecido en TRUE para un archivo de configuración de administrador de búsqueda de texto completo cqtsadmin-dbset-userdb.xml, se crean datos seguridad de los perfiles de WebSphere Application Server de búsqueda de texto completo de ClearQuest y se suprimen estos perfiles de WebSphere Application Server. Cualquier solicitud de búsqueda de texto completo fallará hasta que estos perfiles se restauren. Sin embargo, el botón de selección permanece habilitado y continúa la creación de registros de operación para bases de datos de usuario en el nivel de característica 7 no replicadas. Este tipo de error es aceptable porque la única vez que utiliza esta opción de línea de mandatos es cuando actualiza, modifica o vuelve a instalar ClearQuest.
Estado
Esta opción no tiene estado. Este mandato no debe fallar nunca a menos que se produzca un error de E/S.
Ejemplo
Está a punto de actualizar, modificar o volver a instalar ClearQuest. Antes de iniciar la instalación, debe realizar una copia de seguridad de todos los perfiles de WebSphere Application Server en este host.
  1. Edite el archivo cqtsadmin-dbset-userdb.xml de un único despliegue de búsqueda de texto completo y cambie el código XML <deleteFtsWASProfiles> de la siguiente manera para perimitir que se realice una copia de seguridad de los perfiles de WebSphere Application Server y que se surpiman.

    <newValue required="no">true</newValue>

    Guarde el cambio. El archivo cqtsadmin-TextSearch-SAMPL.xml se utiliza en este ejemplo.

  2. Emita la opción de línea de mandatos para crear datos de seguridad y suprimir los perfiles de WebSphere Application Server:

    cqperl cqtsadmin.pl --username admin --password "" --dbset TextSearch --userdb SAMPL --ftshome D:\CQ.Search --prep_upgd_was_profiles E:\FTSBackupWASProfiles

  3. Cambie el valor del código XML <deleteFtsWASProfiles> a FALSE o elimine el valor TRUE.
  4. Complete la actualización ClearQuest, la modificación o reinstalación de la característica de búsqueda de texto completo.
  5. Emita la opción de línea de mandatos para restaurar todos los despliegues de búsqueda de texto completo y los perfiles suprimidos de WebSphere Application Server de los datos de seguridad. Estos son dos casos de ejemplo posibles:
    • Para ClearQuest 8.0 (todos los releases), conserve las ubicaciones de inicio del perfil de WebSphere Application Server originales, restáurelas a las ubicaciones originales exclusivas:

      cqperl cqtsadmin.pl --username admin --password "" --dbset TextSearch --userdb SAMPL --ftshome D:\CQ.Search --restore_was_profiles E:\FTSBackupWASProfiles

    • Para ClearQuest 8.0 (todos los releases) y 7.0 (todos los releases), consolide todos los perfiles de WebSphere Application Server en un directorio de inicio del perfil de WebSphere Application Server al restaurarlos.

      cqperl cqtsadmin.pl --username admin --password "" --dbset TextSearch --userdb SAMPL --ftshome D:\CQ.Search --restore_was_profiles E:\FTSBackupWASProfiles --fts_was_profile_home D:\FTS.WASprofiles

  6. Si encuentra un problema, ejecute la opción de línea de mandatos gather_diagnostic_data en el mismo dbset, userdb, ftshome para proporiconar datos a IBM Rational Support.
Atención: Si ha personalizado el archivo schema.xml de Solr para dar soporte a un idioma que no sea el inglés, o si ha realizado cambios en el analizador o creador de señales de Solr, los cambios se perderán. Para conservar los cambios, registre sus cambios y vuelva a introducirlos después de completar la actualización. Después de realizar los cambios en el archivo schema.xml, detenga e inicie el perfil de WebSphere Application Server de búsqueda de texto completo para que los cambios entren en vigor.
remove_lucene_idx_lock
Resumen
Utilice este mandato para eliminar un bloqueo de Lucene en el índice de búsqueda. El motor de búsqueda de Lucene utiliza bloqueos para sincronizar actualizaciones. En pocos casos, si Lucene o el servidor encuentran un error al obtener un bloqueo y Lucene no se puede recuperar, el bloquear permanece activo. Mientras un bloqueo esté activo, no se podrá actualizar el índice de búsqueda. Por lo tanto, no se podrá añadir o actualizar ningún registro de ClearQuest. Las búsquedas de texto completo del índice continúan funcionando a menos que haya un problema de integridad con el índice. Para recuperarse de este tipo de bloqueo, reinicie el perfil de WebSphere Application Server emitiendo las opciones de línea de mandatos stop_fts_was_profile y start_fts_was_profile. Las búsquedas de texto completo se interrumpen mientras se reinicia el servicio.
Utilización
Verá que los registros de ClearQuest añadidos recientemente no están incluidos en los resultados de búsqueda. Examine los registros del perfil de WebSphere Application Server y descubra que Lucene notifica que el índice está bloqueado. Utilice este mandato para borrar el bloqueo.
Efecto
Ninguno. Los valores y datos de despliegue de búsqueda de texto completo no se ven afectados.
Estado
Esta opción no tiene estado. Este mandato no debe fallar nunca a menos que haya un error de E/S.
Ejemplo
Desea eliminar un bloqueo del índice Lucene. Detenga, inicie y desbloquee el índice en un paso:

cqperl cqtsadmin.pl --username admin --password "" --dbset TextSearch --userdb SAMPL --ftshome D:\CQ.Search --stop_fts_was_profile --remove_lucene_idx_lock --start_fts_was_profile

remove_record_type
Resumen
Este mandato elimina uno o varios tipos de registro de ClearQuest del índice de búsqueda. Las siguientes búsquedas no encontrarán coincidencias con los tipos de registro eliminados. Este mandato se utiliza con datos que debe proporcionar en el archivo de configuración de administrador de búsqueda de texto completo cqtsadmin-dbset-userdb.xml. En el archivo de configuración, liste los nombres de los tipos de registro que desea eliminar en el código XML <removeRecordType>. Para eliminar varios tipos de registro, separe los nombres con un punto y coma.

Este mandato se ejecuta en estados. Si se produce un error durante uno de los estados, un mensaje de error explica cómo corregir el error. Cuando vuelve a iniciarse el mandato, continúa desde el punto en el que se ha producido el error.

Cree una copia de seguridad de su despliegue antes de emitir este mandato. Al eliminar un tipo de registro, solo se eliminan los datos relacionados con ese tipo de registro del índice de búsqueda. ClearQuest no se ve afectado por este mandato.

Utilización
Después de desplegar la búsqueda de texto completo, se le solicitará que ya no permita realizar búsquedas en determinados tipos de registro. Este mandato elimina los tipos de registro del índice, lo que hace que no se puedan buscar estos tipos de registro. Otro uso de este mandato es cuando los tipos de registro indexados han cambiado en el esquema de ClearQuest. Quizás ha añadido nuevos campos o campos renombrados: Para reflejar este cambio en el índice de búsqueda, utilice las opciones de línea de mandatos remove_record_type y add_record_type.
Efecto
Se altera el índice de búsqueda, de modo que ya no existen las referencias a los tipos de registro que se han eliminado. Por lo tanto, nos se pueden buscar los tipos de registro que se han eliminado. Las referencias a estos tipos de registro se eliminan del archivo XML de propiedades de la búsqueda de texto completo y del archivo de entidad. Aunque este mandato se está ejecutando, los servicios de búsqueda se interrumpen brevemente al reiniciar el perfil de WebSphere Application Server. Los usuarios pueden obtener un error que indica que el servidor está inactivo. Además, los usuarios que tienen una sesión de ClearQuest abierta después de que se haya completado el mandato todavía ven los tipos de registro eliminados en el Ámbito de la búsqueda de ClearQuest Web. Si tratan de buscar estos tipos de registro, no habrán coincidencias. Para que el Ámbito de la búsqueda refleje el índice de búsqueda, estos usuarios deben iniciar sesión de nuevo. Este mandato provoca la fragmentación del índice. Optimice el índice después de ejecutar este mandato para que el tamaño del índice y el rendimiento sena óptimos.
Estado
El mandato tiene estado. Si el mandato falla durante uno de sus puntos de ejecución, normalmente puede corregir el problema y volver a ejecutar el mandato. Se reanudará desde donde se detuvo. Si se produce un error, un mensaje de error indica qué hacer.
Ejemplo
Debe eliminar dos tipos de registro de su índice de búsqueda.
  1. En el archivo cqtsadmin-TextSearch-SAMPL.xml, especifique los tipos de registro que desea eliminar en el código XML <removeRecordType>. Separe los tipos de registro con un punto y coma.

    <newValue required="no">Email_Rule;Customer</newValue>

  2. Ejecute el mandato para eliminar los dos tipos de registro.

    cqperl cqtsadmin.pl --username admin --password "" --dbset TextSearch --userdb SAMPL --ftshome D:\CQ.Search --remove_record_type

  3. En el archivo cqtsadmin-TextSearch-SAMPL.xml, elimine los dos tipos de registro que ha añadido al código XML <removeRecordType>. Esta tarea de mantenimiento impide la eliminación accidental si a continuación añade estos tipos de registro eliminados.
repair_records
Resumen
Si un proceso de indexación de modalidad de proceso por lotes o de modalidad de actualización tiene problemas que impiden la lectura de registros o el envío de estos al servidor para la indexación, se crea un archivo de reparación. El archivo de reparación lista los ID de registro de ClearQuest de los registros que han fallado. Este mandato lee el archivo de reparación y reindexa un registro a la vez para reducir las posibilidades de que se produzca otro error.
Utilización
Como parte del despliegue de búsqueda de texto completo, ejecute este mandato cuando haya finalizado la indexación por lotes para indexar los registros que todavía no se han indexado. Debe comprobar periódicamente el directorio ftshome para buscar registros que no se hayan indexado durante la indexación de modalidad de actualización. Si los registros no se indexan, verá archivos con este convenio de denominación record-type-nametime-stamp.xml. El ejemplo siguiente muestra un archivo sin indexar:Defect1222923990646.xml. Si ve estos tipos de archivos, ejecute este mandato para indexar los registros.
Efecto
El índice de búsqueda incluye datos de los registros indexados más recientemente.
Estado
Esta opción no tiene estado. Este mandato no debe fallar nunca a menos que haya un error de E/S.
Ejemplo
Debe indexar los registros que no se hayan indexado durante la indexación por lotes o la indexación de actualización.

cqperl cqtsadmin.pl --username admin --password "" --dbset TextSearch --userdb SAMPL --ftshome D:\CQ.Search --repair_records

restore_was_profiles path-to-backup
Resumen
Utilice esta opción de línea de mandatos para restaurar los perfiles de WebSphere Application Server de búsqueda de texto completo de ClearQuest a partir de datos de copia de seguridad creados con la opción de línea de mandatos prep_upgd_was_profiles.
Utilización
Es posible que los perfiles de WebSphere Application Server no se conserven después de actualizar, modificar o reinstalar ClearQuest. Los arreglos de la búsqueda de texto completo se deben incorporar a los perfiles de WebSphere Application Server actuales después de aplicar los fixpacks de ClearQuest. De todo esto se encarga el procedimiento de preparación-restauración. Después de actualizar, modificar o reinstalar ClearQuest, esta opción de línea de mandatos restaura todos los perfiles de WebSphere Application Server de búsqueda de texto completo de ClearQuest creados con la opción de línea de mandatos prep_upgd_was_profiles.

Esta opción de línea de mandatos falla si intenta restaurar un perfil de WebSphere Application Server de búsqueda de texto completo de ClearQuest que ya existe o del que no se ha realizado una copia de seguridad y se ha suprimido primero utilizando la opción de línea de mandatos prep_upgd_was_profiles.

Puede ejecutar esta opción de línea de mandatos en cualquier dbset, userdb o ftshome. Afectará a todos los despliegues de búsqueda de texto completo y a los perfiles de WebSphere Application Server de cualquier inicio de perfil de WebSphere Application Server de este host.
Nota: Puede utilizar esta opción de línea de mandatos con la opción de línea de mandatos fts_was_profile_home para especificar un nuevo destino consolidado para los perfiles de WebSphere Application Server frente a su destino original. Utilice este conmutador al actualizar de ClearQuest 7.0 (todos los releases) para garantizar que se utiliza un nuevo inicio de perfil de WebSphere Application Server.
Efecto
Sus perfiles de WebSphere Application Server de búsqueda de texto completo se vuelven a crear y se restauran a sus valores y ubicaciones originales, o se consolidan en la vía de acceso del directorio fts_was_profile_home especificada.
Estado
Esta opción no tiene estado. Este mandato no debe fallar nunca a menos que haya un error de E/S.
Ejemplo
En preparación para la actualización de ClearQuest, debe ejecutar la opción de línea de mandatos prep_upgd_was_profiles con el código <deleteFtsWASProfiles> establecido en TRUE. Después de actualizar ClearQuest, debe restaurar todos los perfiles de WebSphere Application Server de búsqueda de texto completo de ClearQuest de los datos de seguridad. Y desea consolidar los perfiles de WebSphere Application Server en un nuevo directorio utilizando la opción de línea de mandatos fts_was_profile_home.

cqperl cqtsadmin.pl --username admin --password "" --dbset TextSearch --userdb SAMPL --ftshome D:\CQ.Search --restore_was_profiles E:\FTSBackupWASProfiles [ --fts_was_profile_home D:\FTS.WASprofiles ]

Atención: Si ha personalizado el archivo schema.xml de Solr para dar soporte a un idioma que no sea el inglés, o si ha realizado cambios en el analizador o creador de señales de Solr, los cambios se perderán. Para conservar los cambios, registre sus cambios y vuelva a introducirlos después de completar la actualización. Después de realizar los cambios en el archivo schema.xml, detenga e inicie el perfil de WebSphere Application Server de búsqueda de texto completo para que los cambios entren en vigor.
run_batch_idx
Resumen
Este mandato inicia el indexador de la modalidad de proceso por lotes. Indexa todos los registros de ClearQuest que ha configurado para la búsqueda.

Este mandato puede fallar si el tamaño de lote o el número de hebras se ha establecido demasiado alto, o si los registros de ClearQuest tienen una gran cantidad de datos. El error más común es un error de falta de memoria. En este caso, reduzca el tamaño de lote o el número de hebras en uso. El resultado es un incremento del tiempo de indexación. De lo contrario, puede aumentar la memoria de la máquina virtual Java™ (JVM) para el indexador de la modalidad de proceso por lotes utilizando el código XML <batchIndexJVMParm> y la memoria del servidor de búsqueda utilizando el código XML <ftsWASProfileMaxHeapSize>. Si debe aumentar la memoria, este es un requisito temporal hasta que se complete el indexador por lotes. IBM Rational Client Support le puede ayudar a determinar cuál es la mejor acción en estas circunstancias. Si el mandato se detiene antes de completarse, puede iniciarlo de nuevo. La ejecución se reanudará desde donde se detuvo.

Utilización
No tiene que utilizar este mandato directamente. Se llama cuando emite la opción de línea de mandatos setup_cq_fts. Este mandato se proporciona en caso de que necesite ajustar o depurar el despliegue.
Efecto
Este mandato ejecuta las consultas SQL de ClearQuest en la base de datos de ClearQuest. A continuación, envía los registros que se han encontrado en el servidor de búsqueda de Solr para la indexación. En efecto, mientras se ejecuta este mandato, el servidor de bases de datos de ClearQuest está ocupado enviando datos a la búsqueda de texto completo de ClearQuest y se actualiza el índice de búsqueda. Si tiene que ejecutar este mandato, ejecútelo en horas de poca actividad para reducir la carga o los efectos en el rendimiento del servidor de base de datos.
Estado
Esta opción no tiene estado. Este mandato no debe fallar nunca a menos que se produzca un error de E/S, un error de falta de memoria o un error de configuración inesperado.
Ejemplo
Debe indexar todos los registros de ClearQuest.

cqperl cqtsadmin.pl --username admin --password "" --dbset TextSearch --userdb SAMPL --ftshome D:\CQ.Search --run_batch_idx

scrub_oplog before-date
Resumen
Este mandato se utiliza para descartar los registros de operaciones de una base de datos de usuario de ClearQuest no replicada. ClearQuest genera registros de operaciones para realizar un seguimiento de los cambios que realiza en los registros. La búsqueda de texto completo de ClearQuest supervisa los registros de operaciones durante la indexación de la modalidad de actualización para sincronizar el índice de búsqueda con estos cambios.

Los registros de operaciones son datos temporales. No es necesario que los mantenga indefinidamente. Para evitar el crecimiento continuo de registros de operaciones en bases de datos no replicadas, descarte los registros de operaciones de ocasionalmente, pero con la menor frecuencia posible. Base el descarte en el ritmo de creación de oplog.

Si la base de datos de usuario de ClearQuest está replicada, utilice la herramienta de réplica y la política de descarte de registros de operaciones. Si intenta utilizar este mandato en bases de datos replicadas, falla con un mensaje de error que le pide que utilice herramientas de réplica.

No descarte todos los registros de operaciones, especialmente si algunos no están todavía procesados por el indexador de la modalidad de actualización. De lo contrario, su índice de búsqueda no se sincronizará con los registros de ClearQuest. Es posible que las búsquedas no sean precisas o completas. Este caso de ejemplo necesita una reindexación en modalidad de proceso por lotes.

Si el rendimiento del indexador de la modalidad de actualización es insuficiente, descartar registros de operaciones intensivamente puede hacer que el índice no sea preciso y que falten coincidencias. Asegúrese de que el indexador de la modalidad de actualización esté actualizado, descarte solo de los registros de operaciones que tienen más de un mes de antigüedad, o no descarte ninguno.

Utilización
Para conservar espacio de la base de datos y limpiar datos no utilizados, es posible que deba descartar registros de operaciones en una base de datos de usuario de ClearQuest no replicada. Si su base de datos de ClearQuest está replicada, no utilice este mandato.
Efecto
Se suprimirán los registros de operaciones de ClearQuest de la tabla de oplogs creados antes de la fecha especificada.
Estado
Esta opción no tiene estado. Este mandato no debe fallar nunca a menos que haya un error de E/S.
Ejemplo
Como administrador de ClearQuest, desea descartar periódicamente oplogs antiguos. Para obtener información sobre formatos de fecha compatibles, consulte la referencia de mandato scruboplog.

cqperl cqtsadmin.pl --username admin --password "" --dbset TextSearch --userdb SAMPL --ftshome D:\CQ.Search --scrub_oplog "31-Oct-2009"

setup_cq_fts
Resumen
Este mandato se utiliza para completar un despliegue de búsqueda de texto completo. En primer lugar, la opción personaliza y configura los siguientes archivos, en base a su archivo de configuración de búsqueda de texto completo, la base de datos de ClearQuest y el sistema operativo:
  • El archivo de entidades
  • El archivo XML de propiedades de la búsqueda de texto completo
  • El archivo schema.xml de Solr
En segundo lugar, habilita la búsqueda de texto completo de ClearQuest en ClearQuest Web habilitando el botón de opción Texto completo. La generación de oplogs empieza si su base de datos de ClearQuest está en el nivel de característica 7 y si no está replicado. En tercer lugar, inicia la indexación en modalidad de proceso por lotes indexando todos los registros de ClearQuest para los tipos de registro que establezca para la búsqueda en el archivo de entidad. Finalmente, habilita la indexación en modalidad de actualización, con lo que se completa su despliegue.

Este mandato mantiene su estado. Si se produce un error antes de que se complete, se establece el estado y debe corregir el error antes de continuar. El mensaje de error y los registros contienen instrucciones sobre cómo recuperarse del error. Los pasos de recuperación dependen del error y del estado en el que se ha producido el error.

Utilización
Utilice este mandato para completar su despliegue de búsqueda de texto completo. Normalmente, debe ejecutar este mandato después de personalizar el archivo de entidad. Mientras se ejecuta este mandato, el botón de selección Texto completo está habilitado en ClearQuest Web. Los usuarios que inician sesión de nuevo pueden realizar búsquedas. Los resultados de búsqueda no están completos hasta que se completa el despliegue. Normalmente, cuando la base de datos de ClearQuest no está replicada, el botón de selección debe estar habilitado porque se deben generar oplogs para capturar todos los cambios de registros que se producen durante y después de la indexación en modalidad de proceso por lotes.

El sistema en el que despliegue la búsqueda de texto completo experimenta un nivel de utilización alto porque la indexación en modalidad de proceso por lotes se basa sobre todo en el procesador, la memoria de E/S y, si aumenta el valor de memoria JVM predeterminado. En función del nivel de intensidad en que establezca el indexador de modalidad de proceso por lotes aumentando el tamaño de lote o el número de hebras, podría haber una alta utilización de la base de datos de ClearQuest durante la indexación en modalidad de proceso por lotes.

Efecto
Se crean diferentes archivos en el directorio ftshome. Se crea el índice. Se habilitan servicios de búsqueda en WebSphere Application Server. Y se actualiza la base de datos de ClearQuest para incluir el archivo XML de propiedades de búsqueda de texto completo. Se su base de datos de ClearQuest no está replicada, se habilita la creación de registros de operación. Las bases de datos de usuario replicadas de ClearQuest continúan creando registros de operación.
Estado
El mandato tiene estado. Si el mandato falla durante uno de sus puntos de ejecución, deberá poder corregir el problema y, a continuación, ejecutar el mandato de nuevo. El mandato se reanuda desde donde se detuvo. Si se produce un error, un mensaje de error indica qué hacer.Si se produce un error antes de que se complete, se establece el estado y debe corregir el error antes de continuar. El mensaje de error y los registros contienen instrucciones sobre cómo recuperarse del error. Los pasos de recuperación dependen del error y del estado en el que se ha producido el error.
Ejemplo
Ha ejecutado la opción de línea de mandatos init_cq_fts y ha editado el archivo de entidad. Ahora debe completar el despliegue.

cqperl cqtsadmin.pl --username admin --password "" --dbset TextSearch --userdb SAMPL --ftshome D:\CQ.Search --setup_cq_fts

set_was_max_mem
Resumen
Este mandato se utiliza para establecer el máximo de memoria JVM que el perfil de WebSphere Application Server puede utilizar. El valor predeterminado es 300 MB, que puede ser demasiado pequeño para la indexación en modalidad de proceso por lotes en estas situaciones:
  • Se ha incrementado el tamaño de lote
  • Se ha incrementado el número de hebras
  • Los tipos de registro de ClearQuest son complejos

Este mandato lee el valor de memoria del código XML <ftsWASProfileMaxHeapSize> en el archivo de configuración. A continuación, establece la memoria JVM en este valor.

Utilización
Si la indexación en modalidad de proceso por lotes falla porque el servidor del perfil de WebSphere Application Server informa de un error de falta de memoria, probablemente el valor de la memoria sea demasiado bajo. Realice una de las acciones siguientes para recuperarse de un error de falta de memoria:
  • Reduzca el tamaño de lote y el número de hebras para aumentar el tiempo que se tarda en completar la indexación.
  • Incremente temporalmente la memoria JVM. El máximo de memoria JVM normalmente se debe establecer más alto hasta que se complete la indexación en modalidad de proceso por lotes.
Efecto
El valor de máximo de memoria JVM para el perfil de WebSphere Application Server cambia al nuevo valor. En efecto, se asigna más memoria del sistema al perfil de WebSphere Application Server
Estado
Esta opción no tiene estado. Este mandato no debe fallar nunca a menos que haya un error de E/S.
Ejemplo
Recibe errores de falta de memoria del perfil de WebSphere Application Server al indexar. Debe solucionar este problema antes de continuar.
  1. Establezca la memoria JVM en 1,5 GB en el código XML <ftsWASProfileMaxHeapSize> en el archivo cqtsadmin-TextSearch-SAMPL.xml.

    <newValue required="no">1536</newValue>

  2. Ejecute este mandato para establecer el nuevo valor de memoria JVM:

    cqperl cqtsadmin.pl --username admin --password "" --dbset TextSearch --userdb SAMPL --ftshome D:\CQ.Search --set_was_max_mem

set_solr_home
Resumen
Este mandato se utiliza para establecer el directorio de inicio de Solr en WebSphere Application Server. Cada despliegue tiene su propio archivo de configuración schema.xml e índice. Si no se especifica el directorio de inicio de Solr correctamente o si se especifica una ubicación errónea, es posible que no se inicie el perfil de búsqueda de texto completo de WebSphere Application Server. Si no se inicia el perfil de búsqueda de texto completo de WebSphere Application Server, los errores se registran en el directorio de registros del perfil de WebSphere Application Server de búsqueda de texto completo correspondiente en la vía de acceso %your-WAS-profile-home%/<cqfts>_<dbset>_<userdb>/logs/server1/logs/.
Utilización
No tiene que utilizar este mandato directamente. Se llama cuando emite la opción de línea de mandatos setup_cq_fts. Este mandato se proporciona en caso de que necesite ajustar o depurar el despliegue.
Efecto
La propiedad JVM del perfil de WebSphere Application Server desplegado cambia para establecer la variable de entorno de inicio de Solr.
Estado
Esta opción no tiene estado. Este mandato no debe fallar nunca a menos que haya un error de E/S.
Ejemplo
IBM Rational Software Support le ha solicitado que utilice este mandato para depurar un problema de despliegue de búsqueda de texto completo o para personalizar un despliegue.

cqperl cqtsadmin.pl --username admin --password "" --dbset TextSearch --userdb SAMPL --ftshome D:\CQ.Search --set_solr_home

show_scenarios [ID | all]
Resumen
Este mandato se utiliza para visualizar una lista de casos de ejemplo con ejemplos de cómo utilizar la herramienta cqtsadmin.pl. Los casos de ejemplo son una forma abreviada de los casos de ejemplo que se listan en el centro de información y es posible que no se trate de una lista completa o que coincidan exactamente.
Utilización
Utilice esta opción de línea de mandatos para visualizar una lista de los casos de ejemplo más utilizados para la herramienta cqtsadmin.pl. Emita el mandato sin un parámetro para ver los ID y titulares de los casos de ejemplo. Emita el mandato con un parámetro de ID de caso de ejemplo para ver el texto completo de un caso de ejemplo. Emita el mandato con los parámetros all para ver una lista completa de casos de ejemplo, cada uno con un ID, titular y una descripción de texto completo.
Efecto
Los valores y datos de despliegue de búsqueda de texto completo no se ven afectados.
Estado
Esta opción no tiene estado. Este mandato no debe fallar nunca a menos que haya un error de E/S.
Ejemplo
Va a utilizar la herramienta cqtsadmn.pl para completar una tarea, pero no puede recordar cómo utilizarla. Utilice esta opción de línea de mandatos para obtener los titulares de caso de ejemplo con sus ID. A continuación, ejecute este mandato de nuevo y pase el ID del caso de ejemplo en el que esté interesado para ver el texto completo.

cqperl cqtsadmin.pl --username admin --password "" --dbset TextSearch --userdb SAMPL --ftshome D:\CQ.Search --show_scenarios

start_fts_was_profile
Resumen
Este mandato se utiliza para iniciar el servicio del perfil de WebSphere Application Server de búsqueda de texto completo. Se debe iniciar un perfil de WebSphere Application Server de búsqueda de texto completo para llevar a cabo las solicitudes de búsqueda. También se debe iniciar un perfil para que el indexador de la modalidad de actualización empiece a buscar registros nuevos o actualizados y los envíe al motor de búsqueda para la indexación.
Utilización
No tiene que utilizar este mandato directamente. Se llama cuando emite la opción de línea de mandatos setup_cq_fts. Este mandato se proporciona en caso de que necesite ajustar o depurar el despliegue.
Efecto
Si se ha detenido el perfil de WebSphere Application Server de búsqueda de texto completo, se iniciará haciendo que se utilice la memoria temporal y el recurso del procesador. Si los servicios de búsqueda y el indexador de la modalidad de actualización están habilitados, empezarán a ejecutarse. Si el perfil de WebSphere Application Server ya se ha iniciado, no se realizarán cambios.
Estado
Esta opción no tiene estado. Este mandato no debe fallar nunca a menos que haya un error de E/S, un fallo del servidor de Solr o un fallo de inicio del perfil de WebSphere Application Server, que normalmente se produce por problemas de configuración.
Ejemplo
IBM Software Support le ha solicitado que inicie el perfil de WebSphere Application Server.

cqperl cqtsadmin.pl --username admin --password "" --dbset TextSearch --userdb SAMPL --ftshome D:\CQ.Search --start_fts_was_profile

start_update_idx
Resumen
Este mandato se utiliza para habilitar e iniciar el indexador de la modalidad de actualización, que se ejecuta en el perfil de WebSphere Application Server. El indexador de la modalidad de actualización sincroniza el índice de búsqueda con los cambios realizados a la base de datos de ClearQuest. El indexador supervisa oplogs de valores nuevos que se debe indexar. Puede configurar la frecuencia con la que se sincroniza el índice utilizando el código XML <updateIndexDelay> en el archivo de configuración de administrador de búsqueda de texto completo.
Utilización
No tiene que utilizar este mandato directamente. Se llama cuando emite la opción de línea de mandatos setup_cq_fts. Este mandato se proporciona en caso de que necesite ajustar o depurar el despliegue.
Efecto
El indexador de la modalidad de actualización se habilita y se inicia. Las modificaciones, adiciones y la eliminación de los registros de ClearQuest se indexan y aparecen en los resultados de la búsqueda.
Estado
Esta opción no tiene estado. Este mandato no debe fallar nunca a menos que haya un error de E/S, un fallo del servidor de Solr o un fallo de inicio del perfil de WebSphere Application Server, que normalmente se produce por problemas de configuración.
Ejemplo
IBM Software Support le ha indicado que habilite el indexador de actualización.

cqperl cqtsadmin.pl --username admin --password "" --dbset TextSearch --userdb SAMPL --ftshome D:\CQ.Search --start_update_idx

stop_fts_was_profile
Resumen
Este mandato se utiliza para detener el servicio del perfil de WebSphere Application Server de búsqueda de texto completo. Cuando un perfil de WebSphere Application Server se detiene, los servicios de búsqueda no están disponibles y el indexador de la modalidad de actualización deja de sincronizar el índice de búsqueda con los cambios realizados a los registros de ClearQuest.
Utilización
No tiene que utilizar este mandato directamente. Se llama cuando emite la opción de línea de mandatos setup_cq_fts. Este mandato se proporciona en caso de que necesite ajustar o depurar el despliegue.
Efecto
El perfil de WebSphere Application Server de búsqueda de texto completo se detiene, lo que también detiene los servicios de búsqueda y la indexación de actualización. Se libera la capacidad del procesador y la memoria que utiliza el perfil de WebSphere Application Server. Una búsqueda causa un error.

El oplog sigue recibiendo mensajes mientras el botón de selección Texto completo siga habilitado en ClearQuest Web. Esto permite que el indexador de la modalidad de actualización se actualice después de que vuelva a ejecutarse el perfil de WebSphere Application Server.

Estado
Esta opción no tiene estado. Este mandato no debe fallar nunca a menos que haya un error de E/S.
Ejemplo
IBM Software Support le ha solicitado que detenga el perfil de WebSphere Application Server.

cqperl cqtsadmin.pl --username admin --password "" --dbset TextSearch --userdb SAMPL --ftshome D:\CQ.Search --stop_fts_was_profile

stop_update_idx
Resumen
Este mandato se utiliza para inhabilitar y detener el indexador de la modalidad de actualización. Cuando el indexador de la modalidad de actualización se detiene, los servicios de búsqueda están disponibles, pero los cambios que se realizan a los registros de ClearQuest no se reflejan en el índice hasta que se vuelva a habilitar o se reanude la indexación en modalidad de actualización. Por lo tanto, las búsquedas pueden producir resultados que no estén actualizados o que no sean precisos.
Utilización
No tiene que utilizar este mandato directamente. Se llama cuando emiten las opciones de línea de mandatos setup_cq_fts y backup_fts. Este mandato se proporciona en caso de que necesite ajustar o depurar el despliegue.
Efecto
Se inhabilita el indexador de la modalidad de actualización, que se ejecuta en el perfil de WebSphere Application Server. Los recursos de ClearQuest nuevos y modificados no se reflejan en los resultados de búsqueda. El oplog sigue recibiendo mensajes. Los cambios del registro de ClearQuest se reflejan en búsquedas de texto completo cuando se vuelve a habilitar el indexador de registros de la modalidad de actualización y este se pone al día de los oplogs actuales.
Estado
Esta opción no tiene estado. Este mandato no debe fallar nunca a menos que haya un error de E/S.
Ejemplo
IBM Software Support le ha solicitado que inhabilite el indexador de la modalidad de actualización.

cqperl cqtsadmin.pl --username admin --password "" --dbset TextSearch --userdb SAMPL --ftshome D:\CQ.Search --stop_update_idx

unlock_cq_fts
Resumen
Este mandato se utiliza para desbloquear el despliegue bloqueado de una búsqueda de text o completo. Cuando el mandato finaliza, puede ejecutar todos los mandatos de administrador de búsqueda de texto completo.
Utilización
Utilice este mandato para desbloquear el despliegue bloqueado de una búsqueda de texto completo para poder ejecutar todos los mandatos disponibles. Este mandato invierte el bloqueo que establece la opción de línea de mandatos lock_cq_fts.
Efecto
Ninguno. Los datos y valores del despliegue de la búsqueda de texto completo no se ven afectados, y se pueden ejecutar todos los mandatos.
Estado
Esta opción no tiene estado. Este mandato no debe fallar nunca a menos que haya un error de E/S.
Ejemplo
Debe optimizar su índice, pero su despliegue está bloqueado. Debe desbloquearlo, optimizar el índice y bloquearlo de nuevo.

cqperl cqtsadmin.pl --username admin --password "" --dbset TextSearch --userdb SAMPL --ftshome D:\CQ.Search --unlock_cq_fts --optimize_idx --lock_cq_fts

update_fts_prop_files
Resumen
Propaga los cambios que realiza en el archivo de configuración de administrador de búsqueda de texto completo cqtsadmin-dbset-userdb.xml. Después de cambiar cualquiera de los siguientes códigos XML en el archivo de configuración, debe propagar los cambios para que surtan efecto:
  • <batchIndexBatchSize>
  • <batchIndexDelay>
  • <batchIndexThreads>
  • <ftsServerName>
  • <ftsWASProfileName>
  • <ftsWASProfilePort>
  • <updateIndexBatchSize>
  • <updateIndexDelay>
  • <updateIndexLoginInterval>

Por ejemplo, si cambia el tamaño de lote para el indexador de la modalidad de proceso por lotes, deberá emitir este mandato antes de ejecutar la opción de línea de mandatos run_batch_idx para que se utilice el nuevo valor.

Nota: Siempre que cambie la contraseña del usuario de administración, utilice update_fts_prop_files (especificando la nueva contraseña) para asegurarse de que se actualiza el archivo de contraseñas (pwd.txt) y que se puede reanudar la indexación por lotes de nuevos registros. Ejemplo:
cqperl cqtsadmin.pl --username admin --password new_password --dbset 7.0.0 --userdb SAMPL --ftshome C:\CQ.Search --fresh_batch_idx
Utilización
Al desplegar la búsqueda de texto completo, es posible que deba cambiar un valor predeterminado. Al realizar un cambio en el archivo de configuración, el cambio se debe propagar a los componentes de búsqueda de texto completo adecuados.
Efecto
El componente afectado depende del valor de código XML que cambie. Consulte el apartado cqtsadmin-dbset-userdb.xml para obtener más información.
Estado
Esta opción no tiene estado. Este mandato no debe fallar nunca a menos que haya un error de E/S.
Ejemplo
Debe acelerar la indexación en modalidad de proceso por lotes incrementando el tamaño de lote y el número de hebras. Cuando cambie el archivo de configuración, emita este mandato.

cqperl cqtsadmin.pl --username admin --password "" --dbset TextSearch --userdb SAMPL --ftshome D:\CQ.Search --update_fts_prop_files --run_batch_idx

upgrade_solr_app
Resumen
Esta opción de línea de mandatos comprueba si Apache Solr del despliegue de búsqueda de texto completo actual está en la versión más reciente enviada con la versión de ClearQuest. Si no lo está, la opción actualiza Apache Solr.
Utilización
Una versión más reciente de ClearQuest puede dar soporte a versiones más recientes de Apache Solr que la versión que utiliza el despliegue de búsqueda de texto completo actual. Al actualizar ClearQuest y los despliegues de búsqueda de texto completo que utilizan las opciones de línea de mandatos prep_upgd_was_profiles y restore_was_profiles, la aplicación Apache Solr no se actualiza automáticamente. Este enfoque de actualización no es intencional, porque el formato de índice puede haber cambiado, lo que podría requerir una reindexación completa. Utilice este mandato para actualizar Apache Solr a la versión soportada más reciente.

Antes de utilizar esta opción de línea de mandatos, debe realizar una copia de seguridad del despliegue de búsqueda de texto completo mediante la opción de línea de mandatos backup_fts. Además, consulte las notas de release de IBM Rational ClearQuest para saber si debe reindexar la base de datos de ClearQuest después de actualizar Apache Solr. Es posible que tenga que reindexar si el formato de índice de Apache Solr se ha modificado.

Tras ejecutar esta opción de línea de mandatos, debe ejecutar la opción de línea de mandatos stop_fts_was_profile y, a continuación, ejecutar la opción de línea de mandatos start_fts_was_profile para que se realice la actualización.
Importante: Debe ejecutar esta opción de línea de mandatos después de actualizar ClearQuest y después de actualizar los despliegues de búsqueda de texto completo utilizando las opciones de línea de mandatos prep_upgd_was_profiles y restore_was_profiles. De lo contrario, se pueden generar problemas desconocidos.
Efecto
El Apache Solr existente se actualiza a la versión más reciente soportada. La búsqueda de texto completo de ClearQuest no está disponible hasta que se complete la actualización.
Estado
Esta opción no tiene estado. Este mandato no debe fallar nunca a menos que haya un error de E/S, o problemas de WebSphere Application Server.
Ejemplo
Desea actualizar Apache Solr para uno de sus despliegues de búsqueda de texto completo. Realice una copia de seguridad del despliegue de búsqueda de texto completo ejecutando el mandato cqtsadmin.pl con la opción backup_fts.

cqperl cqtsadmin.pl --username admin --password secret --dbset TextSearch --userdb SAMPL --ftshome D:\CQ.Search --backup_fts E:\FTS.Backup

Actualice la aplicación Solr ejecutando el mandato cqtsadmin.pl de nuevo con la opción de línea de mandatos upgrade_solr_app:

cqperl cqtsadmin.pl --username admin --password secret --dbset TextSearch --userdb SAMPL --ftshome D:\CQ.Search --upgrade_solr_app

Si aparece un mensaje que le solicita que reindexe la base de datos de usuario, ejecute el mandato cqtsadmin.pl cuatro veces con las opciones de línea de mandatos stop_update_idx, run_batch_idx, optimize_idx y start_update_idx:

cqperl cqtsadmin.pl --username admin --password secret --dbset TextSearch --userdb SAMPL --ftshome D:\CQ.Search --stop_update_idx

cqperl cqtsadmin.pl --username admin --password secret --dbset TextSearch --userdb SAMPL --ftshome D:\CQ.Search --run_batch_idx

cqperl cqtsadmin.pl --username admin --password secret --dbset TextSearch --userdb SAMPL --ftshome D:\CQ.Search --optimize_idx

cqperl cqtsadmin.pl --username admin --password secret --dbset TextSearch --userdb SAMPL --ftshome D:\CQ.Search --start_update_idx

Si tiene despliegues de búsqueda de texto completo adicionales para otras bases de datos de ClearQuest, ejecute mandatos anteriores en cada base de datos.

was_profile_ports_file
Resumen
Esta opción de línea de mandatos le permite proporcionar opcionalmente su propio archivo de puertos del perfil de WebSphere Application Server, que se utiliza con la opción de línea de mandatos create_fts_was_profile al crear un perfil de búsqueda de texto completo.
Utilización
Al crear un nuevo despliegue de búsqueda de texto completo, se crea un nuevo perfil de WebSphere Application Server de forma predeterminada. La herramienta de administrador de búsqueda de texto completo determina el siguiente puerto disponible para utilizar en el sistema. Si debe ajustar el despliegue y especificar los puertos que utilizará, deberá crear su propio archivo de puertos. A continuación, utilice la opción was_profile_ports_file para indicar a la herramienta del administrador de búsqueda de texto completo que utilice el archivo de puertos. Existe una plantilla que puede utilizar en el archivo portdef.props en la instalación de WebSphere. El archivo portdef.props se ubica normalmente en el directorio \IBM\WebSphere\AppServer\profileTemplates\default\actions\portsUpdate\. Para conocer más acerca del archivo de puertos del perfil de WebSphere Application Server, consulte el mandato manageprofiles, Ejemplo: uso de la sección predefinida de números de puerto en el centro de información de WebSphere Application Server. http://pic.dhe.ibm.com/infocenter/wasinfo/v8r0/index.jsp?topic=%2Fcom.ibm.websphere.base.doc%2Finfo%2Faes%2Fae%2Frxml_manageprofiles.html
Esta opción de línea de mandatos se utiliza con la opción create_fts_was_profile.
Nota: Si utiliza sus propios puertos, asegúrese de que otras aplicaciones no utilicen los puertos. De lo contrario, es posible que encuentre problemas con la búsqueda de texto completo y otras aplicaciones.
Efecto
Los puertos que especifica con este mandato se utilizan en lugar de los puertos especificados por la herramienta del administrador de búsqueda de texto completo.
Estado
Esta opción no tiene estado. Este mandato no debe fallar nunca a menos que se produzca un error de E/S.
Ejemplo
Debe especificar el conjunto de puertos que utilizará.
  1. Realice una copia del archivo portdef.props y, a continuación, especifique su propio valor de puerto.
  2. Ejecute este mandato para crear un nuevo despliegue de búsqueda de texto completo que utilice la opción was_profile_ports_file para especificar sus propios puertos.

    cqperl cqtsadmin.pl --username admin --password "" --dbset MASTR --userdb SAMPL --ftshome D:\CQ.Search --init_cq_fts --create_fts_was_profile automatic --fts_was_profile_home D:\FTS.WASprofiles --was_profile_ports_file D:\my-portdef.props

  3. A continuación, utilice su despliegue de búsqueda de texto completo.

Comentarios