O cqtsadmin.pl automatiza as etapas para instalar, configurar
e administrar a procura de texto completa do IBM® Rational ClearQuest.
Sinopse
- cqperl cqtsadmin.pl --username superusername --password password --dbset dbset --userdb connectionname --ftshome cqftshome [opções]
Descrição
O script cqtsadmin.pl é um dos componentes da ferramenta do administrador de procura de texto completa. O
outro componente é cqtsadmin-dbset-userdb.xml,
que é gerado pelo script cqtsadmin.pl. O arquivo cqtsadmin-dbset-userdb.xml fornece e mantém dados sobre a implementação da procura de texto completa. Você edita cqtsadmin-dbset-userdb.xml para concluir sua implementação. Todas as opções da linha de comandos funcionam da mesma forma em Windows, UNIX ou Linux com a exceção de scrub_oplog que não está disponível em UNIX ou Linux.
Importante: Para execução o comando
cqtsadmin.pl, a variável de ambiente
CQFTS_AppServer_HOME deve ser configurada para o diretório onde o
WebSphere Application Server está instalado.
Sob determinadas circunstâncias, como quando você instala o ClearQuest em um perfil existente do WebSphere Application ou quando você instalar o recurso de procura de texto completa em um sistema separado que acessa remotamente servidores do ClearQuest Web, a variável de ambiente
CQFTS_AppServer_HOME não é configurada e um erro semelhante a este é exibido:
Não é possível determinar o início do AppServer do WebSphere. Consulte o Guia do Administrador da Procura de Texto Completa do ClearQuest sobre como configurá-la por meio da variável de ambiente CQFTS_AppServer_HOME.
Para resolver o problema, configure a variável CQFTS_AppServer_HOME para o diretório em que você instalou o WebSphere Application Server.
Por exemplo, configure a variável como mostrado a seguir:
- Nos sistemas operacionais Windows:
- set CQFTS_AppServer_HOME=C:\Program Files\IBM\WebSphere\AppServer
- No sistema UNIX e em sistemas operacionais Linux:
- setenv CQFTS_AppServer_HOME /opt/IBM/WebSphere/AppServer
Importante: Os argumentos para os argumentos dbset, userdb e ftshome fazem distinção entre maiúsculas e minúsculas. Você deve manter a mesma combinação de maiúsculas e minúsculas durante a utilização do script cqtsadmin.pl. Caso contrário, a implementação da procura de texto completa poderá ser reconfigurada.
A opção ftshome
Quando você implementa a procura de texto completa ou refere-se a uma implementação, os argumentos necessários das opções da linha de comandos ftshome, dbset e userdb definem onde seus dados de implementação estão localizados. O exemplo a seguir mostra como criar uma nova implementação da procura de texto completa do ClearQuest na unidade D no diretório CQ.Search.
O diretório é criado se ele não existir. O subdiretório TextSearch_SAMPL é criado no diretório precedente. O nome do subdiretório é gerado com base no nome do conjunto de bancos de dados do ClearQuest e seu nome de banco de dados do usuário lógico do ClearQuest. O subdiretório contém dados da procura de texto completa para esta implementação.
- 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
Depois o diretório D:\CQ.Search\TextSearch_SAMPL é criado. Ele é a localização da implementação da procura de texto completa para o conjunto de bancos de dados TextSearch e o banco de dados do usuário SAMPL. Todos os dados e todas as configurações relacionados a essa implementação são feitos nesse diretório. Os comandos subsequentes emitidos que utilizam o mesmo valor para os argumentos ftshome, dbset e userdb são aplicados nesse diretório.
Para implementar a procura de texto completa para um segundo banco de dados do usuário do ClearQuest, especifique as opções da linha de comandos necessárias que pertencem a esse segundo banco de dados do usuário do ClearQuest. Bancos de dados adicionais do usuário do ClearQuest implementarão configurações de procura de texto completa com base nos argumentos ftshome especificados e na estrutura de subdiretórios gerada.
- 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
Tabela 1. Estrutura de diretórios de implementação da procura de texto completaDiretório ou arquivo |
Descrição |
ftshome\dbset_userdb\logs\ |
Este diretório mantém logs de cada comando que você emite contra esta implementação. Referencie este diretório para obter um histórico de quais comandos você utilizou, quando os utilizou e seus status. O Suporte de Software IBM poderá examinar esses logs quando trabalhar em conjunto com você em um problema. As senhas são exibidas como asteriscos (*) nos logs e saídas de tela, não no texto simples. |
ftshome\dbset_userdb\Solr\solr\conf\schema.xml |
Este arquivo é um dos arquivos de configuração que o mecanismo de procura utiliza para determinar quais campos indexar e procurar. Quando o comando cust_solr_files é emitido, os campos neste arquivo são customizados para corresponderem aos campos em seus tipos de registro como especificado por seu arquivo de entidade. É possível editar esse arquivo para customizá-lo mais se o seu banco de dados do ClearQuest não estiver em inglês.
Consulte o Ativando a procura de texto completa em um banco de dados não inglês para obter informações adicionais.
|
ftshome\dbset_userdb\Solr\solr\data\index\ |
Este diretório mantém o índice real de sua implementação. Atenção: Não modifique o conteúdo deste diretório. A modificação do diretório pode comprometer a integridade de sua implementação e pode exigir a reindexação da reimplementação.
|
ftshome\dbset_userdb\AboutThisFTS.txt |
Este arquivo é gerado uma vez durante a implementação
inicial da procura de texto completa. Ele contém informações sobre a implementação à qual você pode
ter que se referir. O Suporte de Software IBM pode examinar esse arquivo quando trabalhar em conjunto com você em um problema. |
ftshome\dbset_userdb\CQ-dbset-userdb.xml |
Este arquivo é o arquivo XML de propriedades da procura de texto completa do ClearQuest. O arquivo contém dados sobre a indexação em lote e de atualização, o servidor de procura, seu perfil de conexão e os tipos de registro e campos a serem indexados e procurados. O Suporte de Software IBM examina esse arquivo quando trabalha em conjunto com você em um problema. |
ftshome\dbset_userdb\cqtsadmin-dbset-userdb.xml |
Este arquivo contém a configuração do administrador da procura de texto completa. Ele contém dados sobre sua implementação. A maioria dos dados
é configurada durante a implementação, mas você pode ter que editar este arquivo
para customizar algumas configurações. O Suporte de Software IBM examina esse arquivo quando trabalha em conjunto com você em um problema. |
ftshome\dbset_userdb\Entity-dbset-userdb.txt |
O arquivo de entidade contém uma lista de tipos de entidades e seus campos, para os quais a procura está ativada. Durante a implementação, você pode ter que editar este arquivo para remover tipos de registro ou campos que não deseja procurar. Após concluir a implementação, não modifique este arquivo. O Suporte de Software IBM examina esse arquivo quando trabalha em conjunto com você em um problema. |
Suporte ao idioma nacional
Para
usar o cqtsadmin.pl em um sistema operacional não em inglês,
configure a variável de ambiente do sistema LANGUAGE para um dos valores suportados
a seguir:
- en inglês (Estados Unidos; padrão)
- de alemão (Alemanha)
- fr francês (França)
- it italiano (Itália)
- br português (Brasil)
- es espanhol (Espanha)
- cn chinês simplificado (China)
- hk chinês tradicional (Hong Kong, Região Administrativa
Especial da China)
- tw chinês tradicional (Taiwan; o mesmo que hk)
- ja japonês (Japão)
- ko coreano (Coreia do Sul)
Se LANGUAGE especificar um valor não suportado, cqtsadmin.pl falhará
com uma mensagem de erro.
Opções e Argumentos
O script cqtsadmin.pl
tem opções da linha de comandos necessárias e opções da linha de comandos opcionais.
Você deve fornecer as opções da linha de comandos necessárias toda vez que executar o script cqtsadmin.pl. Se algum dos parâmetros para as opções necessárias estiver incorreto, a ferramenta falhará com uma mensagem de erro. A ferramenta autentica o usuário contra o banco de dados do ClearQuest antes dela tomar uma ação.
Você deve fornecer no mínimo uma opção da linha de comandos opcional ao executar o script cqtsadmin.pl.
- Opções da linha de comandos necessárias
- username superusername
- Nome do usuário do ClearQuest com privilégios de super usuário
- password password
- Senha de usuário do ClearQuest
- dbset dbset
- Nome do conjunto de bancos de dados do ClearQuest. O valor faz distinção entre maiúsculas e minúsculas.
- userdb connectionname
- Nome do banco de dados do usuário do ClearQuest. O valor faz distinção entre maiúsculas e minúsculas.
- ftshome cqftshome
- Diretório inicial da procura de texto completa do ClearQuest. Estas opções contêm todos os arquivos de configuração relacionados a esta implementação e arquivos Solr, configurações e o índice Lucene. O valor faz distinção entre maiúsculas e minúsculas.
Opções da linha de comandos opcionais
As opções da linha de comandos opcionais tomam ações específicas na implementação da procura de texto completa do ClearQuest.
Todos os comandos geram saída de informações, progresso, aviso, erro e instruções. A saída de instruções o ajuda a se recuperar de um erro. A saída exibida também é registrada no diretório de registro.
Esses dados de log são úteis quando você tenta depurar ou rastrear sua ação em uma implementação porque você não tem que redirecionar a saída de tela para um arquivo. Tipicamente, os comandos não falham. Se ocorrer uma falha, a maioria dos comandos reverte todas as alterações. Quando uma alteração não puder ser revertida, uma mensagem de erro será exibida com instruções sobre o que fazer. É possível emitir uma opção da linha de comandos opcional várias vezes. Quando as opções da linha de comandos opcionais são fornecidas, elas são executadas na ordem em que aparecem na linha de comandos. Se uma opção falhar, a avaliação e execução do comando subsequente é interrompida e a
ferramenta sai com uma mensagem de erro. As opções da linha de comandos opcionais podem ser agrupadas em duas categorias: opções comumente usadas e raramente usadas.
- add_record_type
- Resumo
- Inclui um ou mais novos tipos de registros no índice. Esta opção desativa temporariamente o recurso de procura de texto completa para usuários do ClearQuest Web enquanto o comando estiver em execução. A lista de novos tipos de registro e seus campos associados é fornecida pela tag <addRecordType> que está no arquivo de configuração do administrador de procura de texto completa.
- Uso
- Use esta opção da linha de comandos para incluir um tipo de registro se tiver omitido um tipo de registro durante sua implementação da procura de texto completa inicial ou se tiver incluído um novo tipo de registro em seu esquema do ClearQuest após sua implementação inicial e desejar procurar no novo tipo de registro. Use este comando se tiver renomeado, incluído ou removido um campo em um tipo de registro que já esteja indexado. Para refletir a alteração em seu índice, emita o comando remove_record_type para remover o tipo de registro e, em seguida, emita este comando para incluí-lo novamente.
Para incluir dois ou mais tipos de registro, use ponto e vírgula como um separador. Por exemplo, o código a seguir inclui os tipos de registro Cliente e Produto.
<newValue
required="no">Customer=CustomerNum,address,phone,product;Product=name,version</newValue>
Se você listar um tipo de registro sem uma lista de campo, todos os campos desse tipo de registro serão incluídos. No exemplo a seguir, todos os campos para os tipos de registro Cliente e Produto são incluídos.
<newValue required="no">Customer;Product</newValue>
- Efeito
- Este comando afeta o índice de procura de texto completa do ClearQuest, o arquivo XML de propriedades da procura de texto completa do ClearQuest, o arquivo de entidade e o arquivo schema.xml do Solr.
Antes de emitir este comando, faça o backup de sua implementação. Execute esta opção em horários de pico. A operação é demorada e causa breves tempos de inatividade da procura de texto completa.
- Status Stateful
- O comando é stateful. Se o comando falhar durante um de seus pontos de execução, você deverá poder corrigir o problema e, em seguida, executar o comando novamente. A operação continua a partir de onde foi interrompida.
Se ocorrer uma falha, uma mensagem de erro lhe informará o que fazer.
- Exemplo
- Você incluiu um novo tipo de registro chamado Cliente.
- Edite o arquivo cqtsadmin-TextSearch-SAMPL.xml e altere a tag <addRecordType>.
<newValue required="no">Customer=CustomerNum,address,phone,product</newValue>
- Crie um backup.
cqperl cqtsadmin.pl --username admin
--password "" --dbset TextSearch --userdb SAMPL --ftshome D:\CQ.Search
--backup_fts E:\FTSBackup
- Inclua um novo tipo de registro.
cqperl cqtsadmin.pl --username
admin --password "" --dbset TextSearch --userdb SAMPL --ftshome D:\CQ.Search
--add_record_type
- Edite o arquivo cqtsadmin-TextSearch-SAMPL.xml e remova o que você incluiu na tag <addRecordType>. Essa etapa é principalmente uma tarefa de limpeza.
- archive_fts
- Resumo
- Arquiva uma implementação de procura de texto completa do ClearQuest. Ela desativa
a implementação de procura de texto completa ativa e, em seguida, remove um perfil do WebSphere Application
Server implementado. Ela preserva todos os dados de configuração e o índice.
Esta opção pode ser usada para recomeçar uma nova configuração e se referir à
sua configuração antiga.
- Uso
- Use esta opção da linha de comandos para iniciar uma nova implementação ou use
esta opção se não necessitar mais do recurso de procura de texto completa de uma
implementação. Esta opção da linha de comandos para os serviços de procura de texto completa e arquiva todos os recursos relevantes como serviços e arquivos. É possível se referir à implementação após arquivá-la.
Nota: Não use esta opção da linha de comandos se planejar uma restauração futura. Em vez disso, use a opção da linha de comandos prep_upgd_was_profiles.
- Efeito
- Esta opção da linha de comandos desativa a procura de texto completa. Ela também remove todos os arquivos, recursos e configurações que foram usados e definidos no WebSphere Application Server para esta implementação. Os dados de implementação sob ftshome permanecem intactos, mas são
renomeados para dbset_userdb.Archived-time-stamp.
- Status Stateful
- Esta opção não é stateful. Se o comando falhar durante um de
seus pontos de execução, você poderá ter que concluir o arquivamento manualmente.
Um relatório de progresso e uma mensagem de erro instruem você como recuperar a partir do erro.
- Exemplo
- O exemplo a seguir mostra como arquivar uma implementação.
cqperl
cqtsadmin.pl --username admin --password "" --dbset TextSearch --userdb
SAMPL --ftshome D:\CQ.Search --archive_fts
Após executar o
script, a implementação da procura de texto completa arquivada é chamada de D:\CQ.Search\TextSearch_SAMPL.Archived-time-stamp.
- backup_fts destino
- Resumo
- Cria uma cópia de backup de sua implementação de procura de texto completa do ClearQuest. Após um backup ser criado,
é possível recuperar dados a partir do backup ou da implementação inteira. Para
obter os melhores resultados, primeiro crie um backup antes de executar comandos
que alterem consideravelmente sua implementação existente. Antes de fazer backup
de sua implementação, certifique-se de ter a mesma quantia de espaço em disco em
seu local de backup que em sua implementação em ftshome usa.
- Uso
- Use este comando para criar um backup quando incluir ou atualizar um
tipo de registro ou quando sua política de organização exigir que você
mantenha backups periódicos.
Nota: Não use este comando em vez da opção da linha de comandos prep_upgd_was_profiles, que também manipula os perfis de backup do WebSphere Application Server para cada banco de dados do usuário.
- Efeito
- Este comando desativa temporariamente o indexador de modo de atualização
enquanto o backup acontece. Procuras de texto completas podem não ser atualizadas
durante o backup. A duração depende do tamanho de seu índice, da velocidade de
seu disco rígido e de sua rede, se estiver fazendo backup através de uma LAN ou WAN.
- Status Stateful
- Esta opção não é stateful. Se o comando falhar durante um de
seus pontos de execução, você deverá concluir o backup manualmente ou recomeçar,
dependendo do tipo de falha e da mensagem de erro recebida. A falha mais provável é espaço em disco
insuficiente no dispositivo de destino. Nenhum dado de implementação é alterado durante o backup.
- Exemplo
- Você deseja criar um backup de sua implementação antes de incluir novos
tipos de registro.
cqperl cqtsadmin.pl --username admin --password
"" --dbset TextSearch --userdb SAMPL --ftshome D:\CQ.Search --backup_fts
E:\FTSBackup
Após executar o script, a implementação de procura de texto completa arquivada é denominada E:\FTSBackup\TextSearch_SAMPL.Backup-time-stamp.
- clear_state
- Resumo
- Reconfigura o estado no procedimento da ferramenta cqtsadmin.pl
para que não haja estado. Na verdade, se o estado da ferramenta se encontrava em algo
que poderia ser um estado incompleto, ele é limpo.
- Uso
- Use esta opção da linha de comandos para limpar o estado de um comando stateful
para que você possa emitir outros comandos ou emitir novamente o comando stateful. O tempo para limpar o estado depende de qual comando stateful você planeja limpar, o último estado em que o comando stateful se encontrava e a mensagem de erro e as instruções corretivas fornecidas.
- Efeito
- O efeito de executar esta opção da linha de comandos depende de qual comando
stateful foi interrompido e quanto do comando foi concluído antes da interrupção. O log e a mensagem de erro indicam é possível reconfigurar o estado.
- Status Stateful
- Esta opção não é stateful. Este comando nunca
deve falhar, a menos que haja um erro de E/S.
- Exemplo
- Você tem que limpar o estado de uma ação stateful para que possa
recuperar de um erro irrecuperável, de acordo com as instruções na
mensagem de erro.
cqperl cqtsadmin.pl --username admin --password
"" --dbset TextSearch --userdb SAMPL --ftshome D:\CQ.Search --clear_state
- copy_fts_template
- Resumo
- Copia e configura o modelo padrão da procura de texto completa do ClearQuest. Quando você
implementa a procura de texto completa em um banco de dados que ainda
não está ativado para procura de texto completa, você deve iniciar a
partir de um modelo padrão limpo e copiá-lo em seu diretório ftshome.
Se você tentar usar este comando sobre uma implementação existente,
ele falhará com um erro.
- Uso
- Em geral, você não precisa usar esta opção da linha de comandos diretamente
porque ela é chamada quando a opção da linha de comandos init_cq_fts é emitida. Esta opção da linha de comandos é fornecida no caso de você precisar fazer um ajuste fino ou depurar sua implementação.
- Efeito
- Esta opção da linha de comandos copia os dados padrão para o recurso da procura de texto completa para o diretório ftshome especificado.
- Status Stateful
- Esta opção não é stateful. Este comando nunca
deve falhar, a menos que haja um erro de E/S.
- Exemplo
- O Suporte a Clientes do IBM Rational o instruiu a emitir este comando para depurar um problema de implementação ou customizar uma implementação.
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 }
- Resumo
- Cria um perfil do WebSphere Application
Server da procura de texto completa do ClearQuest. Requerido para todas as novas implementações.
- Uso
Cada implementação de procura de texto completa do ClearQuest deve ter seu próprio perfil do WebSphere Application Server, um perfil do WebSphere Application Server para cada banco de dados do usuário de procura de texto completa do ClearQuest.
O valor de parâmetro configura o status do serviço Windows apenas para implementações do sistema operacional Windows. Esse valor é ignorado em sistemas operacionais UNIX e Linux para os quais você deve configurar o perfil do WebSphere Application
Server para iniciar no momento da inicialização como um daemon.
O nome do perfil do WebSphere Application Server é determinado a partir de seu conjunto de bancos de dados e nome de banco de dados do usuário. Todavia, é possível substituí-lo pela tag <ftsWASProfileName>.
Especifique o local para criação do perfil do WebSphere Application Server com a opção da linha de comandos fts_was_profile_home. Se você não especificar o local, o local padrão %CLEARQUEST_HOME%/cqweb/ é usado. Para obter melhores resultados, especifique seu próprio local.
Nota: Sempre use essa opção da linha de comandos com a opção da linha de comandos init_cq_fts para que um perfil do WebSphere Application Server seja criado e customizado com base em sua implementação de procura de texto completa do ClearQuest.
Caso contrário, a implementação falhará a menos que o perfil do WebSphere Application Server tenha sido previamente criado com essa ferramenta e esteja sendo reutilizado.
- Efeito
- Esta opção da linha de comandos cria um novo perfil do WebSphere Application Server sob o WebSphere Application
utilizando a próxima porta disponível. Quando a operação é concluída, a utilização do espaço em disco é de cerca de 200 MB. Se o perfil for configurado como Automático no Windows, o serviço inicia automaticamente quando o Windows reinicia.
- Status Stateful
- Esta opção não é stateful. Este comando nunca
deve falhar, a menos que haja um erro de E/S.
- Exemplo
- Você planeja implementar uma procura de texto completa para um segundo banco de dados do usuário.
O nome de seu conjunto de bancos de dados é MASTR e o nome do banco de dados do usuário é SAMPL.
- Emita o comando a seguir para configurar uma implementação 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
- Modifique seu arquivo de entidade para conter apenas os tipos de registro e os campos nos quais estiver interessado.
- Emita este comando para concluir sua implementação.
cqperl
cqtsadmin.pl --username admin --password "" --dbset MASTR --userdb
SAMPL --ftshome D:\CQ.Search --setup_cq_fts
- cust_fts_files
- Resumo
- Customiza o arquivo XML de propriedades da procura de texto completa do ClearQuest com base em seu banco
de dados do usuário, arquivo de entidade e arquivo de configuração do
administrador da procura de texto completa. Ao implementar a procura de texto completa do ClearQuest
pela primeira vez, você deve customizar o arquivo de propriedades da procura de texto completa
CQ-dbset-userdb.xml.
- Uso
- O modelo de procura de texto completa padrão contém configurações genéricas
que você customiza com base em seu banco de dados do usuário. Um arquivo que
você deve customizar é o arquivo XML de propriedades da procura de texto completa. Esse
arquivo retém uma lista de todos os tipos de registro e seus campos com base no que é
especificado em seu arquivo de entidade. Esse arquivo também contém parâmetros como
qual campo usar como o campo de exibição, quão frequentemente verificar as alterações
em seu banco de dados do usuário do ClearQuest
e como se comunicar com o seu banco de dados e o servidor do ClearQuest. Em geral,
você não tem que usar essa opção da linha de comandos diretamente porque ela é
chamada quando a opção da linha de comandos setup_cq_fts é emitida. Essa opção da linha de comandos é fornecida no caso de você ter que ajustar ou depurar sua implementação.
- Efeito
- Se você usar esta opção da linha de comandos em uma implementação, ela sobrescreve
o arquivo CQ-dbset-userdb.xml.
Todas as alterações feitas no arquivo, seja manualmente ou pela emissão de comandos, serão perdidas.
- Status Stateful
- Esta opção não é stateful. Este comando nunca
deve falhar, a menos que haja um erro de E/S.
- Exemplo
- O Suporte de Software IBM pede que você
depure um problema de implementação da procura de texto completa ou customize uma implementação.
cqperl
cqtsadmin.pl --username admin --password "" --dbset TextSearch --userdb
SAMPL --ftshome D:\CQ.Search --cust_fts_files
- cust_solr_files
- Resumo
- Ao implementar a procura de texto completa do ClearQuest pela primeira vez, você deve customizar o arquivo de esquema do Solr que é baseado em seu arquivo de
entidade do ClearQuest atual.
- Uso
- A procura de texto completa padrão é genérica e contém configurações padrão que devem ser customizados com base em seu banco de dados do usuário.
Um arquivo que deve ser customizado é o arquivo Solr schema.xml.
Esse arquivo contém todos os campos de todos os tipos de registro que você configurou para serem procurados usando o arquivo de entidade. Em geral,
você não tem que usar essa opção da linha de comandos diretamente porque ela é
chamada quando a opção da linha de comandos setup_cq_fts é emitida. Esta opção da linha de comandos é fornecida no caso de você precisar fazer um ajuste fino ou depurar sua implementação.
- Efeito
- Esta opção da linha de comandos lê dados de seu arquivo de entidade e,
em seguida, customiza o arquivo Solr schema.xml. Se a
opção for usada sobre uma implementação existente, ela refatora o arquivo schema.xml.
Se tiver alterado os arquivos de entidade após sua implementação inicial, os
valores anteriores serão perdidos.
- Status Stateful
- Esta opção não é stateful. Este comando nunca
deve falhar, a menos que haja um erro de E/S.
- Exemplo
- O Suporte de Software IBM pede que você
depure um problema de implementação da procura de texto completa ou customize uma implementação.
cqperl cqtsadmin.pl --username admin --password
"" --dbset TextSearch --userdb SAMPL --ftshome D:\CQ.Search --cust_solr_files
- delete_fts_was_profile
- Resumo
- Para excluir um perfil do WebSphere Application
Server ou se você desejar começar novamente, execute esta opção da linha de comandos. Ela exclui o perfil do WebSphere Application Server da procura de texto completa do ClearQuest associado a esta implementação da procura de texto completa do ClearQuest.
Esta opção é diferente de archive_fts, na qual apenas o perfil do
WebSphere Application Server é excluído. Entretanto, o diretório inicial da procura de texto completa e os metadados associados não são removidos. Para remover completamente uma implementação da procura de texto completa do ClearQuest, use alternativamente a opção archive_fts.
- Uso
- Em geral, não use este comando diretamente porque ele é chamado quando a opção da linha de comandos archive_fts é emitida.
Este comando é fornecido se você tiver que ajustar ou depurar sua implementação.
- Efeito
- Os recursos usados pelo WebSphere para este perfil
do WebSphere Application
Server são liberados. Se a procura de texto completa do ClearQuest Web não tiver sido desativada com a opção da linha de comandos disable_cqweb_fts, então a procura de texto completa procurará
resultados com erros.
- Status Stateful
- Esta opção não é stateful. Este comando nunca
deve falhar, a menos que haja um erro de E/S.
- Exemplo
- Você tem que renomear ou alterar o local de seu perfil do WebSphere Application Server, mas não deseja reimplementar sua solução de procura de texto completa.
- Exclua o perfil do WebSphere Application
Server.
cqperl cqtsadmin.pl --username admin --password
"" --dbset TextSearch --userdb SAMPL --ftshome D:\CQ.Search --delete_fts_was_profile
- Edite o arquivo cqtsadmin-dbset-userdb.xml e altere a tag <ftsWASProfileName> a partir do nome padrão automaticamente gerado para o novo nome do perfil do WebSphere Application Server. O nome deve ser exclusivo. Caso contrário, o comando falhará.
- Recrie o perfil do 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
- Se você também estava planejando alterar o número da porta para este perfil do WebSphere Application Server, edite o arquivo cqtsadmin-dbset-userdb.xml e atualize o número da porta na tag <ftsWASProfilePort> antes da etapa 3 acima. Ou alternativamente, emita este comando para redefinir as portas:
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
- Resumo
- Esta opção da linha de comandos desativa o botão de opções Texto Completo no ClearQuest Web e para a gravação de logs de operações (oplogs) em um banco de dados do usuário do ClearQuest não replicado.
Essa opção da linha de comandos não tem efeito na criação de oplogs em ambientes
replicados.
Atenção: Use esta opção da linha de comandos com cuidado. Ela desativa a gravação de oplog se o seu banco de dados do ClearQuest não estiver replicado.
Se os registros do ClearQuest forem alterados quando os
oplogs não são gerados, os registros alterados não serão reindexados. Você terá que executar a reindexação de todo o banco de dados do usuário. Não permite que os usuários acessem o ClearQuest ou permite apenas operações somente de leitura até que a capacidade de procura de texto completa seja reativada.
- Uso
- Você não tem que usar este comando a menos que esteja em um ambiente de teste ou que o Suporte de Software IBM o instrua a fazê-lo.
- Efeito
- A geração de oplog para se o seu banco de dados não for replicado e o botão de opções Texto Completo
estiver desativado.
- Status Stateful
- Esta opção não é stateful. Este comando nunca
deve falhar, a menos que haja um erro de E/S.
- Exemplo
- O Suporte a Clientes do IBM Rational instrui você a desativar a procura de texto completa para ajudá-lo a resolver os problemas.
cqperl
cqtsadmin.pl --username admin --password "" --dbset TextSearch --userdb
SAMPL --ftshome D:\CQ.Search --disable_cqweb_fts
- enable_cqweb_fts
- Resumo
- Ativa o botão de opções Texto Completo no ClearQuest Web. A geração de oplog também é ativada se o seu
banco de dados do ClearQuest não for replicado e estiver no
nível de recurso 7. Se o seu banco de dados do ClearQuest estiver replicado, nenhuma alteração é feita na geração do oplog. Se a sua implementação não estiver corretamente configurada, os usuários que tentarem usar a procura de texto completa recebem mensagens de erro.
- Uso
- Você não tem que usar este comando a menos que esteja em um ambiente de teste ou o Suporte de Software IBM o instrua a usá-lo.
- Efeito
- A geração de oplog inicia se o seu banco de dados não estiver replicado e estiver no nível de recurso 7. O botão de opções Texto Completo no ClearQuest Web é ativado.
- Status Stateful
- Esta opção não é stateful. Este comando nunca
deve falhar, a menos que haja um erro de E/S.
- Exemplo
- O Suporte de Software IBM o instrui
a ativar a procura de texto completa para ajudá-lo a resolver os problemas existentes.
cqperl
cqtsadmin.pl --username admin --password "" --dbset TextSearch --userdb
SAMPL --ftshome D:\CQ.Search --enable_cqweb_fts
- fresh_batch_idx
- Resumo
- Estas opções da linha de comandos permite que você force uma reindexação integral de modo em lote após a indexação inicial. A indexação de modo em lote é o processo de leitura de todos os registros do
ClearQuest que estão configurados para procura e envio de dados desses registros ao mecanismo de procura (Solr) para indexação. A indexação de modo em lote é executada como parte da execução da opção da linha de comandos setup_cq_fts. Antes de emitir esse comando, emita a opção da linha de comandos stop_update_idx para parar o indexador de modo de atualização. Se não fizer isso, o indexador de modo em lote poderá substituir os dados de um registro indexado mais recente pelo indexador de modo de atualização. Quando a reindexação estiver concluída, seu índice está fragmentado. Tipicamente, essa fragmentação não causa impacto no desempenho de suas procuras. Entretanto, o tamanho do índice pode crescer para até duas vezes o tamanho atual. Para otimizar o índice e reduzir seu tamanho, execute a opção da linha de comandos optimize_idx.
- Uso
- Você não precisa usar este comando, a menos que esteja em um ambiente de teste ou o Suporte de Software IBM o instrua a fazê-lo.
- Efeito
- O índice de procura é atualizado. Seu tamanho cresce para até duas vezes o tamanho atual. Portanto, confirme se você possui espaço em disco suficiente antes de usar este comando. Durante a reindexação, os resultados da procura podem não estar completos porque o indexador de modo de atualização está desativado.
- Status Stateful
- Esta opção não é stateful. Este comando nunca
deve falhar, a menos que haja um erro de E/S.
- Exemplo
- O Suporte de Software IBM o instrui a reindexar completamente seus registros que podem ser procurados.
- Pare o indexador de modo de atualização.
cqperl cqtsadmin.pl --username admin --password "" --dbset TextSearch --userdb SAMPL --ftshome D:\CQ.Search --stop_update_idx
- Force a reindexação de modo em lote.
cqperl cqtsadmin.pl --username admin --password "" --dbset TextSearch --userdb SAMPL --ftshome D:\CQ.Search --fresh_batch_idx
- Execute a otimização de índice.
cqperl cqtsadmin.pl --username
admin --password "" --dbset TextSearch --userdb SAMPL --ftshome D:\CQ.Search
--optimize_idx
- Ative o indexador de modo de atualização.
cqperl cqtsadmin.pl --username admin --password "" --dbset TextSearch --userdb SAMPL --ftshome D:\CQ.Search --start_update_idx
Nota: É possível combinar essas etapas em um comando. Você pode desejar fazer isso porque essa operação leva um longo tempo se você reindexar muitos 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
- Resumo
- Força uma reindexação integral de todas as alterações de registros de oplog registrados pelo indexador de modo de atualização. Use essa opção cautelosamente. O indexador de indexador de atualização é de encadeamento único. Essa operação leva muito tempo, especialmente se o seu banco de dados do ClearQuest contiver muitos oplogs.
A indexação de modo de atualização é o processo de monitoramento de alterações no banco de dados do ClearQuest nos tipos de registro configurados para procura. O monitoramento é feito por meio da verificação de oplogs no banco de dados do ClearQuest. A indexação de modo de atualização está ativada como parte da opção da linha de comandos setup_cq_fts. Diferentemente da opção da linha de comandos fresh_batch_idx, este comando não requer que você pare o indexador de modo de atualização. Quando este comando for concluído contra um índice preenchido, seu índice será fragmentado. Tipicamente, essa fragmentação não causa impacto no desempenho de suas procuras. Entretanto, o tamanho do índice pode crescer até duas vezes o tamanho atual. Para otimizar o índice e reduzir seu tamanho, execute a opção da linha de comandos optimize_idx.
Considere cuidadosamente o início do indexador do modo de atualização a partir do primeiro oplog registrado. Ao longo do tempo, você acumula um oplog para cada ação tomada em um registro do ClearQuest e pode ser que não queira indexar a partir do primeiro oplog registrado, especialmente se não tiver limpado consistentemente os oplogs. Este comando é destinado ao uso em ambientes de teste e para depuração de problemas de implementação da procura de texto completa trabalhando em conjunto com o Suporte a Clientes do IBM Rational.
- Uso
- Você não tem que usar este comando a menos que esteja em um ambiente de teste ou que o Suporte de Software IBM o instrua a fazê-lo.
- Efeito
- O índice de procura é atualizado. Seu tamanho pode cresce até duas vezes o tamanho atual. Assegure-se de ter espaço em disco suficiente antes de utilizar este comando.
- Status Stateful
- Esta opção não é stateful. Este comando nunca
deve falhar, a menos que haja um erro de E/S.
- Exemplo
- O Suporte de Software IBM o instrui a forçar uma reindexação do indexador de modo de atualização.
cqperl
cqtsadmin.pl --username admin --password "" --dbset TextSearch --userdb
SAMPL --ftshome D:\CQ.Search --fresh_update_idx
- fts_was_profile_home destino
- Resumo
- Use esta opção da linha de comandos com a opção da linha de comandos create_fts_was_profile para especificar onde o perfil do WebSphere Application Server para esta procura de texto completa do ClearQuest será criado. Se você omitir esta opção, o local padrão ${CLEARQUEST_HOME}/cqweb/ será usado. O local padrão não é sempre adequado porque arquivos adicionais que são criados no diretório de instalação
do ClearQuest podem interferir na instalação do ClearQuest,
assim como na desinstalação ou atualização. Esta opção da linha de comandos também pode ser usada com a opção da linha de comandos restore_was_profile. É possível especificar um local que seja diferente do original no qual os perfis do WebSphere Application
Server da procura de texto completa serão criados.
- Uso
- Você deseja implementar a procura de texto completa do ClearQuest para um banco de dados do ClearQuest e não deseja que o local padrão seja usado para criar e armazenar arquivos do WebSphere relacionados à sua implementação. Use esta opção da linha de comandos em conjunto com a opção da linha de comandos create_fts_was_profile para especificar onde criar ser perfil do WebSphere Application Server da procura de texto completa. Se tiver mais de uma implementação da procura de texto completa nesta máquina, use o mesmo local para todas elas para que todos os seus perfis do WebSphere Application Server fiquem no mesmo local.
- Efeito
- Um diretório é criado, se não existir, no local fts_was_profile_home.
Ele contém os dados relacionados ao perfil do WebSphere Application Server. Um subdiretório dentro desse diretório é criado. Ele representa o nome do perfil do WebSphere Application Server, que é cqsearchprofile_dbset_userdb ou cqfts_dbset_userdb.
- Status Stateful
- Esta opção não é stateful. Este comando nunca deverá falha, a menos que haja um erro de E/S ou o caminho seja inválido como uma letra de unidade que não exista ou um caminho de montagem Unix ou Linux não existente.
- Exemplo
- Você precisa implementar a procura de texto completa do ClearQuest. Você não deseja usar o local padrão para perfis do 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
- Resumo
- Coleta dados que ajudam o Suporte de Software IBM a diagnosticar problemas em potencial com a procura de texto completa do ClearQuest. Se necessitar de suporte, execute esta opção da linha de comandos de diagnóstico e envie os dados coletados com esta opção da linha de comandos para o suporte expedir a assistência. Essa opção da linha de comandos reúne dados relevantes sobre sua implementação da procura de texto completa do ClearQuest. Os dados são copiados em um diretório que você pode ser instruído a enviar ao Suporte de Software IBM. Antes de enviar os dados, verifique se eles não contêm informação confidencial. Tipicamente, os dados mais sensíveis são os nomes de tipo de registro que você ativou para procura e um histórico de termos de procura que sua organização enviou. O histórico é o log que o WebSphere mantém para seu perfil do WebSphere Application Server. As senhas são convertidas em asteriscos quando a saída é enviada para a tela ou os arquivos de log. Elas nunca são armazenadas em texto simples.
- Uso
- Use este comando para reunir e enviar dados diagnósticos ao Suporte de Software IBM para ajudá-lo a diagnosticar
problemas com a procura de texto completa.
- Efeito
- Nenhum de seus dados ou definições de configuração são alterados. Um novo diretório
é criado com o nome de sua implementação e um registro de data e hora.
O tamanho acumulativo dos dados diagnósticos varia dependendo dos tamanhos totais de logs
em sua implementação, o que é normalmente em megabytes.
O índice real não é parte dos dados diagnósticos.
- Status Stateful
- Esta opção não é stateful. Este comando nunca
deve falhar, a menos que haja um erro de E/S.
- Exemplo
- O Suporte de Software do IBM o instrui a enviar
dados diagnósticos para ajudá-lo a resolver problemas com a procura de texto completa. O comando
a seguir cria os dados diagnósticos e os coloca em um arquivo 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
- Resumo
- Este opção da linha de comandos gera o arquivo de entidade, que contém todos os tipos de registro que podem ser enviados ao banco de dados do ClearQuest. Por padrão, o arquivo de entidade contém todos os tipos de registro e todos os campos do seu esquema do ClearQuest. E, eles são candidatos para a procura de texto completa. É possível customizar o arquivo para selecionar apenas os tipos de registro e os campos associados que planejar indexar. Quando planejar implementar a procura de texto completa contra um banco de dados do usuário do ClearQuest pela primeira vez, você deve ter um arquivo de entidade que mantenha todos os tipos de registro e seus campos aos quais o esquema de banco de dados do usuário do ClearQuest se refira. Esse arquivo de entidade é utilizado como uma entrada para gerar o arquivo XML de propriedades da procura de texto completa, o arquivo XML intermediário do Solr e o arquivo Solr schema.xml.
- Uso
- Em geral, você não tem que usar este comando diretamente. Ele é
chamado quando você emite a opção da linha de comandos init_cq_fts. Este comando é fornecido no caso de você ter que ajustar ou depurar sua implementação.
- Efeito
- Se você usar este comando em uma implementação existente, ela sobrescreve
o arquivo Entity-dbset-userdb.txt e você perde as edições
feitas.
- Status Stateful
- Esta opção não é stateful. Este comando nunca
deve falhar, a menos que haja um erro de E/S.
- Exemplo
- O Suporte de Software do IBM Rational o instruiu a depurar um problema de implementação da procura de texto completa ou customizar uma implementação.
cqperl cqtsadmin.pl --username admin --password
"" --dbset TextSearch --userdb SAMPL --ftshome D:\CQ.Search --gen_entity_file
- gen_fts_files
- Resumo
- Esta opção da linha de comandos gera arquivos de configuração da procura de texto completa do ClearQuest com base em seu banco de dados do usuário,
arquivo de entidade e arquivo de configuração do administrador da procura de texto completa. Ao
implementar a procura de texto completa em um banco de dados do usuário pela primeira vez, você
deverá gerar o arquivo XML de propriedades da procura de texto completa. Esse arquivo contém
informações sobre suas configurações de implementação como quão frequentemente indexar, o tamanho do lote para indexação e informações do servidor de procura.
- Uso
- Em geral, você não usa esta opção da linha de comandos diretamente.
Ela é
chamada quando a opção da linha de comandos setup_cq_fts. Essa opção da linha de comandos é fornecida no caso de você ter que ajustar ou depurar sua implementação.
- Efeito
- Se você usar este comando em uma implementação existente, ele sobrescreve
os arquivos Entity-dbset-userdb.txt, Solr-dbset-userdb.txt
e CQ-dbset-userdb.xml e você perde as edições feitas neles.
- Status Stateful
- Esta opção não é stateful. Este comando nunca
deve falhar, a menos que haja um erro de E/S.
- Exemplo
- O Suporte de Software do IBM Rational o instruiu a depurar um problema de implementação da procura de texto completa ou customizar uma implementação.
cqperl cqtsadmin.pl --username admin --password
"" --dbset TextSearch --userdb SAMPL --ftshome D:\CQ.Search --gen_fts_file
- help
- Resumo
- Exibe o texto da ajuda e então fecha.
- Uso
- Você está familiarizado com o script cqtsadmin.pl,
mas deseja que um rápido lembrete sobre os comandos disponíveis.
- Efeito
- Nenhum. Este comando não altera nenhum dado e não necessita de autenticação para executar.
- Status Stateful
- Esta opção não é stateful. Este comando nunca
deve falhar, a menos que haja um erro de E/S.
- Exemplo
- Você deseja uma lista de comandos disponíveis.
cqperl cqtsadmin.pl
--help
- init_cq_fts
- Resumo
Copia o modelo padrão da procura de texto completa do ClearQuest e, em seguida, gera o arquivo de entidade padrão.
De fato, ele executa tanto a opção
copy_fts_template quanto
gen_entity_file.
Este comando é um dos primeiros comando que você executa ao implementar a procura de texto completa. Ele cria um diretório
dbset_userdb em seu diretório
ftshome. Todos os dados e configurações padrão relacionados a essa implementação são colocados nesse diretório.
Um dos arquivos-chave que esta opção cria é o arquivo de entidade
Entity-dbset-userdb.txt. Ele é colocado em seu diretório
ftshome.
Ao customizar sua implementação, você decide se quer deixá-lo
como está ou remover os tipos de registro e campos que não deseja
que sejam procurados. Outro arquivo criado é o arquivo de configuração do administrador da procura de texto completa
cqftsadmin-dbset-userdb.xml. Este arquivo mantém configurações padrão adicionais que são especificadas para sua implementação e ambiente como o nome do servidor, seu nome de perfil do WebSphere Application Server, o tamanho do lote do índice e a frequência do índice.
Nota: Esta opção da linha de comandos é tipicamente executada em combinação com as opções da linha de comandos create_fts_was_profile e fts_was_profile_home para que um novo perfil do WebSphere Application Server seja criado para esta implementação. Caso contrário, a implementação da procura de texto completa do ClearQuest falhará, a menos que você reutilize um perfil do WebSphere Application Server que tenha sido
previamente implementado para procura de texto completa.
- Uso
- Use este comando para pré-configurar sua implementação da procura de texto completa.
Ele cria seu diretório ftshome, copia os arquivos padrão nele e
configura valores padrão. Antes de concluir sua implementação, você tipicamente
customiza o arquivo de entidade.
- Efeito
- Este comando cria um novo diretório ftshome se ele não
existe e copia os dados e as configurações padrão para sua implementação nele.
- Status Stateful
- Esta opção não é stateful. Este comando nunca
deve falhar, a menos que haja um erro de E/S.
- Exemplo
- Você deseja iniciar uma nova implementação da procura de texto completa para um de seus bancos de dados do usuário.
- Execute este comando para pré-configurar sua implementação.
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
- Edite este arquivo de entidade de implementação para remover os tipos de registro ou
campos que os usuários não podem procurar. Além disso, inclua um e comercial (&)
na frente de um campo para cada tipo de registro. Esse será o campo de exibição
no conjunto de resultados de ocorrências de procura de texto completa.
D:\CQ.Search\TextSerch_SAMPL\Entity-TextSearch-SAMPL.txt
- Conclua sua implementação executando este comando:
cqperl
cqtsadmin.pl --username admin --password "" --dbset TextSearch --userdb
SAMPL --ftshome D:\CQ.Search --setup_cq_fts
- lock_cq_fts
- Resumo
Esta opção da linha de comandos bloqueia esta implementação da procura de texto completa do ClearQuest para que apenas comandos cqtsadmin.pl não destrutivos possam ser executados. Todos os comandos, exceto gather_diagnostic_data e help,
são desativados. Use a opção unlock_cq_fts para ativar os comandos novamente.
- Uso
- Após implementar a procura de texto completa, emita este comando para bloquear a
implementação e evitar modificações inadvertidas. Esse bloqueio é fraco. Qualquer um
como o acesso ao sistema de arquivos correto ou privilégios do ClearQuest pode desbloquear uma implementação.
O objetivo deste comando é permitir aos administradores sinalizarem que a implementação está concluída. Modificações adicionais devem ser comunicadas e emitidas com cuidado.
- Efeito
- Nenhum. Seus dados de implementação e configurações de procura de texto completa não são afetados.
- Status Stateful
- Esta opção não é stateful. Este comando nunca
deve falhar, a menos que haja um erro de E/S.
- Exemplo
- Você concluiu uma implementação e deseja assegurar que a implementação
não foi modificada.
cqperl cqtsadmin.pl --username admin --password
"" --dbset TextSearch --userdb SAMPL --ftshome D:\CQ.Search --lock_cq_fts
- optimize_idx
- Resumo
Esta opção da linha de comandos desfragmenta o índice. A otimização
requer um mínimo de 1,5 vezes o espaço livre em disco como seu
tamanho atual de índice para ser bem-sucedida. Por exemplo, se o seu índice
usar 2 GB de espaço em disco, você deve ter 3 GB de espaço livre em disco para
executar o comando.
- Uso
Conforme você inclui ou modifica registros no índice de procura, é possível que ele
fique fragmentado. Índices fragmentados tende a crescer mais do que os não fragmentados. Também pode ocorrer uma pequena degradação no desempenho. Para reduzir o tamanho do índice e desempenho da restauração, otimize seu índice no mínimo uma vez por ano. Otimize-o mais frequentemente se o seu banco de dados do ClearQuest enfrentar uma atividade muito intensa com modificações, adições ou exclusões de registro.
Antes de emitir
este comando, assegure-se de ter espaço livre em disco suficiente.
Caso contrário, a otimização falhará, mas seu índice original permanecerá intacto. Liberar espaço em disco é necessário porque o índice original é regravado durante a otimização. O índice antigo é mantido até o novo índice ser gerado.
O tempo requerido para otimizar um índice depende do tamanho de seu índice e da velocidade de seu disco rígido e sua E/S. A otimização pode levar algumas horas em um índice de 2 GB.
Enquanto a otimização está em andamento, todos os serviços de procura de texto completa estão disponíveis, incluindo o indexador de modo de atualização. Entretanto, pode ocorrer uma pequena degradação de desempenho. Planeje a otimização de índice para horas fora de pico.
- Efeito
- Seu índice de procura é regravado. Se ocorrer um erro de E/S durante a otimização,
ele deve ser provavelmente por causa de espaço em disco insuficiente.
O índice original permanece intacto. O índice original pode ser maior, mas ele retornará
a esse tamanho original após a conclusão de sua otimização.
- Status Stateful
- Esta opção não é stateful. Este comando nunca
deve falhar, a menos que haja um erro de E/S.
- Exemplo
- Você tem que otimizar seu índice de procura.
cqperl cqtsadmin.pl
--username admin --password "" --dbset TextSearch --userdb SAMPL --ftshome
D:\CQ.Search --optimize_idx
- prep_upgd_was_profiles destination
- Resumo
- Durante um tempo de inatividade planejado, esta opção da linha de comandos prepara para uma modificação ou reinstalação do ClearQuest. Use o backup que este comando cria para restaurar as implementações de procura de texto completa incluindo seu perfil do WebSphere Application Server de volta a seu
estado original.
- Uso
Todos os bancos de dados do usuário que estão implementados com a procura de texto completa
requerem um perfil do WebSphere Application Server correspondente. Esses perfis podem não ser preservados no upgrade, na modificação ou na reinstalação do ClearQuest.
Atualizações que são disponibilizadas em Fix Packs do ClearQuest podem apenas ser incorporadas em implementações de procura de texto completa do ClearQuest através deste procedimento de preparação e restauração. Quando esta opção da linha de comandos
é usada com a opção da linha de comandos restore_was_profiles, ele cria dados de
backup, exclui opcionalmente os perfis do WebSphere Application Server e, em seguida, restaura os perfis excluídos do WebSphere Application
Server do caminho de dados de backup especificado quando chamado após a conclusão de seu upgrade ou sua reinstalação do ClearQuest.
Para excluir os perfis do WebSphere Application Server
do ClearQuest, você deve alterar o valor da tag <deleteFtsWASProfiles> de FALSE para TRUE para um arquivo de configuração do administrador de procura de texto completa cqtsadmin-dbset-userdb.xml. Assegure-se de se referir a essa implementação modificada quando você executa o comando. Caso contrário, os perfis do WebSphere Application Server
não serão corretamente removidos em preparação à sua restauração e ao seu upgrade.
Esta opção da linha de comandos pode ser executada em qualquer dbset, userdb ou ftshome. A opção não está associada com uma implementação de procura de texto completa específica. Ela avalia e afeta todas as implementações de procura de texto completa do ClearQuest no host em qualquer diretório
ftshome.
Nota: Se tiver mais de uma implementação de procura de texto completa na máquina atual, esta opção da linha de comandos e a opção da linha de comandos restore_was_profiles deve ser executada apenas uma vez. Estes dois comandos atuam globalmente entre todas as suas implementações de procura de texto completa em sua máquina atual.
Atenção: Ao atualizar o ClearQuest,
você deve executar esta opção da linha de comandos com a tag <deleteFtsWASProfiles>
configurada como TRUE. Caso contrário, o resulta poderá ser um upgrade
incompleto de suas implementações de procura de texto completa. Após a conclusão do upgrade
e execução da opção da linha de comandos restore_was_profiles, altere
esta opção para FALSE
- Efeito
- Se a tag <deleteFtsWASProfiles> for configurada como TRUE para um arquivo de configuração do administrador de procura de texto completa cqtsadmin-dbset-userdb.xml, faça o backup de dados de seus perfis do WebSphere Application Server de procura de texto completa do ClearQuest criado e esses perfis do
WebSphere Application Server são excluídos. Qualquer solicitação de procura de texto completa falhará até que esses perfis sejam restaurados. Mas o botão de opções permanece ativado
e a criação de oplogs continua para bancos de dados do usuário de
Nível de Recurso 7 não replicado. Esse tipo de falha é aceitável porque a única vez que você usa esta opção da linha de comandos é ao atualizar, modificar ou reinstalar o ClearQuest.
- Status Stateful
- Esta opção não é stateful. Este comando nunca deve falhar, a menos que ocorra um erro de E/S.
- Exemplo
- Você está prestes a atualizar, modificar ou reinstalar o ClearQuest. Antes de iniciar a instalação,
você deve fazer backup de todos os perfis do WebSphere Application
Server neste host.
- Edite o arquivo cqtsadmin-dbset-userdb.xml de uma única implementação
de procura de texto completa e altere a tag XML <deleteFtsWASProfiles>,
como mostrado a seguir, para permitir o backup dos perfis do WebSphere Application Server e a exclusão dos perfis.
<newValue
required="no">true</newValue>
Salve a alteração. O arquivo cqtsadmin-TextSearch-SAMPL.xml é usado neste exemplo.
- Emita a opção da linha de comandos para criar dados de backup e excluir os
perfis do WebSphere Application
Server:
cqperl cqtsadmin.pl --username admin --password
"" --dbset TextSearch --userdb SAMPL --ftshome D:\CQ.Search --prep_upgd_was_profiles
E:\FTSBackupWASProfiles
- Altere o valor da tag <deleteFtsWASProfiles> para FALSE ou remova o valor TRUE.
- Conclua o upgrade do ClearQuest, a modificação do recurso de procura de texto completa ou a reinstalação.
- Emita a opção da linha de comandos para restaurar todas as implementações de procura de texto completa e os perfis excluídos do WebSphere Application
Server dos dados de backup. A seguir há dois cenários possíveis:
- Se encontrar um problema, execute a opção da linha de comandos gather_diagnostic_data no mesmo dbset, userdb, ftshome para fornecer dados ao Suporte do IBM Rational.
Atenção: Se tiver customizado o arquivo Solr schema.xml para suportar um idioma diferente do inglês ou tiver feito alterações no analisador ou tokenizer Solr, as alterações serão perdidas. Para preservar as alterações, registre suas alterações e introduza-as novamente após concluir o upgrade. Após fazer as alterações no arquivo schema.xml, pare e inicie o perfil do WebSphere Application Server da procura de texto completa para que as alterações entrem em vigor.
- remove_lucene_idx_lock
- Resumo
- Use este comando para remover um bloqueio Lucene no índice de procura.
O mecanismo de procura Lucene usa bloqueios para sincronizar atualizações. Em casos raros, se o
Lucene ou o servidor encontrar um erro quando um bloqueio for obtido e o Lucene não puder se recuperar, o bloqueio permanecerá ativo. Enquanto um bloqueio estiver ativo, o índice de procura não pode ser atualizado. Assim, nenhum registro do ClearQuest pode ser adicionado ou atualizado. Procuras de texto completas no índice continuam a funcionar, a menos que haja um problema de integridade com o índice. Para recuperar desse tipo de bloqueio, reinicie o perfil do WebSphere Application
Server emitindo as opções da linha de comandos stop_fts_was_profile e start_fts_was_profile. Procuras de texto completas são interrompidas durante reinicializações de serviços.
- Uso
- Você observa que registros recém-incluídos do ClearQuest não estão incluídos nos resultados da procura. Você examina os logs do perfil do WebSphere Application Server e descobre que o Lucene está relatando erros de que o índice está bloqueado.
Use este comando para limpar o bloqueio.
- Efeito
- Nenhum. A implementação e as configurações da procura de texto completa não são afetadas.
- Status Stateful
- Esta opção não é stateful. Este comando nunca
deve falhar, a menos que haja um erro de E/S.
- Exemplo
- Você deseja remover um bloqueio de índice do Lucene. Pare, inicie e desbloqueie o índice em uma etapa:
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
- Resumo
- Este comando remove um ou mais tipos de registro do ClearQuest do índice de procura. Procuras subsequentes não localizarão correspondências com os tipos de registros removidos. Este comando é usado com dados que você deve fornecer através do arquivo de configuração do administrador da procura de texto completa cqtsadmin-dbset-userdb.xml. No arquivo de configuração, liste os nomes dos tipos de registro a serem removidos na tag XML <removeRecordType>. Para remover vários tipos de registro, separe os nomes com um ponto e vírgula.
Este comando é executado em estados. Se ocorrer um erro durante
um dos estados, uma mensagem de erro explica como corrigir o erro.
Ao reiniciar o comando, ele continua a partir do ponto onde ocorreu o
erro.
Crie um backup de sua implementação antes de emitir este comando. A remoção de um tipo de registro remove apenas os dados relacionados a esse tipo de registro do índice de procura. O próprio ClearQuest não é afetado por este comando.
- Uso
- Após implementar a procura de texto completa, você é solicitado a não permitir mais procuras em determinados tipos de registro. Este comando remove esses tipos de registro do índice, que torna esses tipos de registro não pesquisáveis.
Outro uso deste comando é quando os tipos de registro indexados mudaram em seu esquema do ClearQuest.
Talvez você tenha incluído novos campos ou renomeado campos. Para refletir essa alteração em seu índice de procura, use as opções da linha de comandos remove_record_type e add_record_type.
- Efeito
- Seu índice de procura é alterado para que quaisquer referências aos tipos de registro que foram removidos não existam mais. Portanto, os tipos de registro
removidos não são pesquisáveis. Referências a esses tipos de registro
são removidas do arquivo XML de propriedades da procura de texto completa e
do arquivo de entidade. Enquanto este comando estiver em execução, os serviços de procura são brevemente interrompidos quando o perfil do WebSphere Application
Server é reinicializado. Os usuários podem obter um erro indicando que o servidor está inativo. Além disso, os usuários que possuem uma sessão do ClearQuest aberta após a conclusão do comando continuam vendo os tipos de registro removidos em seu Escopo de Pesquisa no ClearQuest Web.
Se eles tentarem procurar esses tipos de registro, não haverá correspondências.
Para que seus Escopos de Procura reflitam o índice de procura, esses usuários devem efetuar login novamente. Este comando causa a fragmentação de índice.
Otimize o índice após a execução deste comando para que tanto o tamanho do índice quanto o desempenho sejam os melhores.
- Status Stateful
- O comando é stateful. Se o comando falhar durante um de seus pontos de execução,
você pode tipicamente corrigir a emissão e executar novamente o comando. Ele continuará a partir de onde foi interrompido. Se ocorrer uma falha, uma mensagem de erro explicará o que fazer.
- Exemplo
- Você deve remover dois tipos de registro de seu índice de procura.
- No arquivo cqtsadmin-TextSearch-SAMPL.xml,
especifique os tipos de registro a serem removidos na tag XML <removeRecordType>. Separe os tipos de registro com um ponto e vírgula.
<newValue
required="no">Email_Rule;Customer</newValue>
- Execute o comando para remover os dois tipos de registro.
cqperl
cqtsadmin.pl --username admin --password "" --dbset TextSearch --userdb
SAMPL --ftshome D:\CQ.Search --remove_record_type
- No arquivo cqtsadmin-TextSearch-SAMPL.xml,
remova os dois tipos de registro incluídos na tag XML <removeRecordType>. Essa tarefa de manutenção evita a remoção acidental se você incluir subsequentemente esses tipos de registro removidos posteriormente.
- repair_records
- Resumo
- Se um processo de indexação de modo em lote ou em modo de atualização tiver problemas que evite a leitura de registros ou o envio deles ao servidor para indexação, um arquivo de reparo será criado. O arquivo de reparo lista os IDs de registro do ClearQuest dos registros com falha.
Este comando lê o arquivo de reparo e indexa um registro por vez para reduzir as chances de outra falha.
- Uso
- Como parte de sua implementação da procura de texto completa, execute este comando quando a indexação em lote estiver concluída para os registros do índice que não foram indexados. Você periodicamente verifica o diretório ftshome para registros que não foram indexados durante a indexação em modo de atualização. Se os registros não estiverem indexados, você verá arquivos com esta convenção de nomenclatura record-type-nametime-stamp.xml.
O exemplo a seguir mostra um arquivo não indexado:Defect1222923990646.xml.
Se você vir esses tipos de arquivos, execute este comando para indexar os registros.
- Efeito
- Seu índice de procura inclui dados a partir dos registros recém indexados.
- Status Stateful
- Esta opção não é stateful. Este comando nunca
deve falhar, a menos que haja um erro de E/S.
- Exemplo
- Você tem que indexar registros que não foram indexados durante a indexação em lote ou
indexação de atualização.
cqperl cqtsadmin.pl --username admin
--password "" --dbset TextSearch --userdb SAMPL --ftshome D:\CQ.Search
--repair_records
- restore_was_profiles path-to-backup
- Resumo
- Use esta opção da linha de comandos para restaurar os perfis do WebSphere Application Server da procura de texto completa do ClearQuest a partir do backup de dados criado com a opção da linha de comandos prep_upgd_was_profiles.
- Uso
- Os perfis do WebSphere Application
Server podem não ser preservados no upgrade, na modificação ou na desinstalação do
ClearQuest.
As correções da procura de texto completa deve ser incorporada nos perfis atuais do WebSphere Application Server após você
aplicar os Fix Packs do ClearQuest, todos
manipulados pelo procedimento de preparo e restauração.
Após o upgrade, a modificação ou a reinstalação do ClearQuest, esta opção da linha de comandos restaura todos os perfis do WebSphere Application
Server da procura de texto completa do ClearQuest que foram criados com a opção da linha de comandos prep_upgd_was_profiles.
Esta opção da linha de comandos falhará se você tentar restaurar um perfil do WebSphere Application Server da procura de texto completa do ClearQuest cujo backup não tenha sido feito primeiro e excluído usando a opção da linha de comandos prep_upgd_was_profiles.
É possível executar essa opção da linha de comandos em qualquer dbset, userdb ou ftshome. Ela afetará todas as implementações da procura de texto completa e os perfis do WebSphere Application Server
em qualquer perfil inicial do WebSphere Application
Server deste host.
Nota: É possível usar esta opção da linha de comandos com a opção da linha de comandos fts_was_profile_home para especificar um novo destino consolidado para os perfis do WebSphere Application Server versus seu destino original. Use este comutador ao atualizar a partir do ClearQuest 7.0 (todas as liberações)
para assegurar que um novo perfil inicial do WebSphere Application Server seja usado.
- Efeito
- Seus perfis do WebSphere Application
Server da procura de texto completa são recriados e restaurados às suas configurações e locais originais
ou são consolidados no caminho de diretório inicial fts_was_profile_home especificado.
- Status Stateful
- Esta opção não é stateful. Este comando nunca
deve falhar, a menos que haja um erro de E/S.
- Exemplo
- Em preparação para seu upgrade do ClearQuest, você executou a opção da linha de comandos prep_upgd_was_profiles com a tag <deleteFtsWASProfiles> configurada como TRUE.
Após ter atualizado o ClearQuest,
você tem que restaurar todos os perfis do WebSphere Application
Server da procura de texto completa do ClearQuest dos dados de backup. E você deseja consolidar os perfis do WebSphere Application Server
em um novo diretório usando a opção da linha de comandos 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
]
Atenção: Se tiver customizado o arquivo Solr schema.xml para suportar um idioma diferente do inglês ou tiver feito alterações no analisador ou tokenizer Solr, as alterações serão perdidas. Para preservar as alterações, registre suas alterações e introduza-as novamente após concluir o upgrade. Após fazer as alterações no arquivo schema.xml, pare e inicie o perfil do WebSphere Application Server da procura de texto completa para que as alterações entrem em vigor.
- run_batch_idx
- Resumo
- Este comando inicia o indexador de modo em lote. Ele indexa todos os registros ClearQuest que você configurou para procura.
Este comando poderá falhar se o tamanho do lote ou o número de encadeamentos for configurado com um valor muito alto, ou se os seus registros do ClearQuest tiverem uma quantia muito grande de dados. A falha mais comum é um erro de falta de memória. Nesse caso, reduza o tamanho do lote ou o número de encadeamentos em uso.
O resultado é um aumento do tempo de indexação. Alternativamente, é possível aumentar
a memória da Java™ virtual machine
(JVM) tanto para o indexador de modo em lote usando a tag XML <batchIndexJVMParm>
quanto a memória do servidor de procura usando a tag XML <ftsWASProfileMaxHeapSize>. Se tiver que aumentar a memória, este será um requisito temporário até que a conclusão do indexador em lote. O Suporte a Clientes do IBM Rational pode ajudá-lo
a determinar a melhor ação nessas circunstâncias. Se o comando
parar antes de ser concluído, é possível iniciá-lo novamente. Ele continuará
a execução a partir de onde foi interrompido.
- Uso
- Você não tem que usar este comando diretamente. Ele é
chamada quando a opção da linha de comandos setup_cq_fts. Este comando é fornecido no caso de você ter que ajustar ou depurar sua implementação.
- Efeito
- Este comando executa consultas SQL do ClearQuest contra seu banco de dados do ClearQuest.
Em seguida, ele envia os registros que foram localizados no servidor de procura Solr para indexação. Na verdade, durante a execução deste comando, seu servidor de banco de dados do ClearQuest fica ocupado enviando dados à procura de texto completa do ClearQuest e seu índice de procura é atualizado. Se precisar executar este comando, execute-o nas horas de pico para reduzir a carga ou os efeitos do desempenho de seu servidor de banco de dados.
- Status Stateful
- Esta opção não é stateful. Este comando nunca deverá falhar, a menos que ocorra um erro de E/S, um erro de falta de memória ou um erro de configuração inesperado.
- Exemplo
- Você tem que indexar todos os registros do ClearQuest.
cqperl
cqtsadmin.pl --username admin --password "" --dbset TextSearch --userdb
SAMPL --ftshome D:\CQ.Search --run_batch_idx
- scrub_oplog before-date
- Resumo
- Este comando é usado para limpar oplogs de um banco de dados do usuário do ClearQuest não replicado. O ClearQuest gera oplogs
para manter o controle das alterações que você fez nos registros. A procura de texto completa do ClearQuest monitora oplogs durante a indexação em modo de atualização para sincronizar o índice de procura com essas alterações.
Oplogs são dados temporários. Você não tem que mantê-los indefinidamente. Para evitar o crescimento contínuo do oplog em bancos de dados não replicados, ocasionalmente limpe oplogs antigos, mas tão pouco frequentemente quanto possível. Baseie a limpeza na taxa de criação de oplogs.
Se o seu banco de dados do usuário do ClearQuest estiver replicado, use sua ferramenta e a política de replicação para limpeza de oplogs. Se você tentar usar este comando em bancos de dados replicados, ela falhará com uma mensagem de erro que o instrui a usar a ferramenta de replicação.
Nunca limpe todos os oplogs, especialmente se alguns ainda não tiverem sido processados pelo indexador em modo
de atualização. Caso contrário, seu índice de procura não será sincronizado com os registros do
ClearQuest.
Procuras podem não ser precisas ou completas. Esse cenário requer a reindexação de modo em lote.
A limpeza excessiva de oplogs onde o rendimento do indexador em modo de atualização é insuficiente pode resultar em imprecisão do índice e na falta de ocorrências. Assegure-se de que o indexador de modo em lote esteja atualizado, limpe apenas oplogs que tenham mais de um mês ou não limpe oplogs.
- Uso
- Para conservar espaço de banco de dados e limpar dados não usados, você pode ter que limpar
oplogs em um banco de dados do usuário do ClearQuest não replicado. Se o seu banco de dados do ClearQuest estiver replicado, não use este comando.
- Efeito
- Os oplogs do ClearQuest em sua
tabela de oplogs criados antes da data especificada são eliminados.
- Status Stateful
- Esta opção não é stateful. Este comando nunca
deve falhar, a menos que haja um erro de E/S.
- Exemplo
- Como um administrador do ClearQuest,
você planeja a limpeza periódica de oplogs antigos. Para obter informações sobre formatos de data suportados, consulte a referência de comando scruboplog.
cqperl
cqtsadmin.pl --username admin --password "" --dbset TextSearch --userdb
SAMPL --ftshome D:\CQ.Search --scrub_oplog "31-Oct-2009"
- setup_cq_fts
- Resumo
- Este comando é usado para concluir uma implementação da procura de texto completa.
Primeiro, a opção customiza e configura os arquivos a seguir, com base em seu arquivo de configuração do administrador da procura de texto completa, no banco de dados do ClearQuest e no sistema operacional:
- O Arquivo de Entidade
- O arquivo XML de propriedades da procura de texto completa
- O arquivo Solr schema.xml
- Segundo, ele possibilita a procura de texto completa do ClearQuest no ClearQuest Web ativando o botão de opções Texto Completo. A geração de oplog começa se o seu banco de dados do ClearQuest for do Nível de Recurso 7 e se ele não estiver replicado. Terceiro, ele inicia a indexação de modo em lote indexando todos os registros do ClearQuest para os tipos de registro que você configura para procura no arquivo de entidade.
Finalmente, ele permite a indexação em modo de atualização, o que conclui sua implementação.
Este comando mantém seu estado. Se ocorrer um erro antes dele concluir, o estado é configurado e você deve corrigir o erro antes de poder continuar.
A mensagem de erro e os logs contêm instruções sobre como se recuperar do erro. As etapas de recuperação dependem do erro e do estado no qual o erro ocorreu.
- Uso
- Use este comando para concluir sua implementação de procura de texto completa.
Tipicamente, você executa este comando após customizar o arquivo de entidade.
Enquanto este comando é executado, o botão de opções Texto Completo
está ativado no ClearQuest Web.
Os usuários que efetuam login novamente estão aptos a realizar procuras. Os resultados da procura não são concluídos até que a implementação seja concluída. Particularmente quando o banco de dados do ClearQuest não está replicado, o botão de opções deve estar ativado
porque os oplogs devem ser gerados para capturar todas as alterações de registro que ocorrerem durante e após a indexação de modo em lote.
O computador no qual você implementa a procura de texto completa é altamente utilizado porque a indexação de modo em lote depende intensamente do processador, da E/S e da memória, se você aumentar a configuração de memória da JVM padrão. Dependendo de quão agressivamente você configura seu indexador de modo em lote aumentando o tamanho do lote e o aumentar de encadeamentos, poderá ocorrer alta utilização de seu banco de dados do ClearQuest durante a indexação de modo em lote.
- Efeito
- Diversos arquivos são criados em seu diretório ftshome. O índice é criado. Serviços de busca sob o WebSphere Application
Server são ativados. E seu banco de dados do ClearQuest é atualizado para incluir o arquivo XML de propriedade da procura de texto completa. Se
o seu banco de dados do ClearQuest
não estiver replicado, a criação de oplogs estará ativada. O banco de dados do usuário
replicado do ClearQuest continuará a criar oplogs.
- Status Stateful
- O comando é stateful. Se o comando falhar
durante um de seus pontos de execução, você deverá ser capaz de corrigir o problema e executar novamente o comando. O comando continua a partir de onde parou. Se ocorrer uma falha, uma mensagem de erro lhe informará o que fazer. Se ocorrer um erro antes dele concluir, o estado é configurado e você deve corrigir o erro antes de poder continuar. A mensagem de erro e os logs contêm instruções sobre como se recuperar do erro. As etapas de recuperação dependem do erro e do estado no qual o erro ocorreu.
- Exemplo
- Você executou a opção da linha de comandos init_cq_fts e editou seu arquivo de entidade. Você agora concluiu a implementação.
cqperl
cqtsadmin.pl --username admin --password "" --dbset TextSearch --userdb
SAMPL --ftshome D:\CQ.Search --setup_cq_fts
- set_was_max_mem
- Resumo
- Este comando é usado para configurar a memória máxima JVM que o perfil do WebSphere Application Server
pode usar. O valor padrão é 300 MB, que pode ser muito pequeno para a indexação de modo em lote nessas situações:
- O tamanho do lote foi aumentado
- O número de encadeamentos foi aumentado
- Os tipos de registro do ClearQuest são complexos
Esta comando lê a configuração de memória da tag XML <ftsWASProfileMaxHeapSize>
em seu arquivo de configuração. Em seguida, ele configura a memória JVM com esse valor.
- Uso
- Se a indexação de modo em lote falhar por causa do servidor de perfil do WebSphere Application Server relatar erro de falta de memória, a configuração de memória está provavelmente com um valor muito baixo.
Tome umas das ações a seguir para se recuperar de um erro de falta de memória:
- Reduza o tamanho do lote e o número de encadeamentos para aumentar o tempo que leva para concluir a indexação.
- Aumente temporariamente a memória da JVM. A memória máxima da JVM tipicamente deve ser configurada para um valor mais alto até a indexação de modo em lote ser concluída.
- Efeito
- A configuração de memória máxima da JVM para o perfil do WebSphere Application Server muda para o novo valor. De fato, mais memória do sistema é alocada ao perfil do WebSphere Application Server.
- Status Stateful
- Esta opção não é stateful. Este comando nunca
deve falhar, a menos que haja um erro de E/S.
- Exemplo
- Você recebe erros de falta de memória do perfil do WebSphere Application Server durante a indexação. Você deve tratar esse problema antes de poder continuar.
- Configure a memória da JVM para 1,5 GB na tag XML <ftsWASProfileMaxHeapSize>
no arquivo cqtsadmin-TextSearch-SAMPL.xml.
<newValue
required="no">1536</newValue>
- Execute este comando para configurar a nova configuração de memória da JVM:
cqperl
cqtsadmin.pl --username admin --password "" --dbset TextSearch --userdb
SAMPL --ftshome D:\CQ.Search --set_was_max_mem
- set_solr_home
- Resumo
- Este comando é usado para configurar o diretório inicial do Solr no WebSphere Application Server.
Cada implementação possui seu próprio arquivo de configuração schema.xml e índice. Se o diretório inicial do Solr não for especificado corretamente ou se o local errado for especificado, o perfil da procura de texto completa do WebSphere Application Server poderá não iniciar. Se o perfil da procura de texto completa do WebSphere Application Server não iniciar, os erros serão registrados no diretório de logs correspondente do perfil do WebSphere Application Server da procura de texto completa no caminho %your-WAS-profile-home%/<cqfts>_<dbset>_<userdb>/logs/server1/logs/.
- Uso
- Você não tem que usar este comando diretamente. Ele é
chamada quando a opção da linha de comandos setup_cq_fts. Este comando é fornecido no caso de você ter que ajustar ou depurar sua implementação.
- Efeito
- A propriedade JVM do perfil do WebSphere Application Server implementado é alterada para a mesma configurada na variável
de home do Solr.
- Status Stateful
- Esta opção não é stateful. Este comando nunca
deve falhar, a menos que haja um erro de E/S.
- Exemplo
- Você foi instruído pelo Suporte de Software do IBM Rational a usar este comando para depurar um problema com a implementação da procura de texto completa ou customizar uma implementação.
cqperl cqtsadmin.pl --username
admin --password "" --dbset TextSearch --userdb SAMPL --ftshome D:\CQ.Search
--set_solr_home
- show_scenarios [ID | all]
- Resumo
- Este comando é usado para exibir uma lista de cenários com exemplos de como usar a ferramenta cqtsadmin.pl. Os cenários são uma forma resumida dos cenários listados no centro de informações e podem não ser a lista completa ou uma correspondência de uma para um.
- Uso
- Use esta opção da linha de comandos para exibir uma lista dos cenários mais comumente usados para a ferramenta cqtsadmin.pl. Emita o comando sem um parâmetro para ver os IDs de cenário e títulos.
Emita o comando com um parâmetro de ID de cenário para ver o texto completo de um cenário. Emita o comando com os parâmetros all para ver uma lista completa de cenários, cada um com um ID, um título e uma descrição de texto completa.
- Efeito
- A implementação e as configurações da procura de texto completa não são afetadas.
- Status Stateful
- Esta opção não é stateful. Este comando nunca
deve falhar, a menos que haja um erro de E/S.
- Exemplo
- Você está prestes a usar a ferramenta cqtsadmn.pl para concluir uma tarefa, mas não consegue se lembrar como usá-la. Use esta opção da linha de comandos para listas os títulos de cenário com seus IDs. Em seguida, execute este comando novamente e passe o ID do cenário no qual está interessado para ver o seu texto completo.
cqperl cqtsadmin.pl --username
admin --password "" --dbset TextSearch --userdb SAMPL --ftshome D:\CQ.Search
--show_scenarios
- start_fts_was_profile
- Resumo
- Este comando é usado para iniciar o serviço de perfil do WebSphere Application Server da procura de texto completa.
Um perfil do WebSphere Application
Server da procura de texto completa deve ser iniciado para que ocorra a manutenção das solicitações de procura.
Um perfil também deve ser iniciado para o indexador em modo de atualização para iniciar a verificação de registros novos e atualizados e enviá-los ao mecanismo de procura para indexação.
- Uso
- Você não tem que usar este comando diretamente. Ele é
chamada quando a opção da linha de comandos setup_cq_fts. Este comando é fornecido no caso de você ter que ajustar ou depurar sua implementação.
- Efeito
- Se o perfil do WebSphere Application
Server da procura de texto completa estava interrompido, ele iniciará, causando a utilização temporária de recursos de memória e processador. Se os serviços de busca e o indexador em modo de atualização estiverem ativados, eles começam a executar. Se o perfil do WebSphere Application Server já estiver iniciado, nenhuma alteração será feita.
- Status Stateful
- Esta opção não é stateful. Este comando nunca
deverá falhar, a menos que seja um erro de E/S, uma falha do servidor do Solr ou uma falha de inicialização do perfil do WebSphere Application Server, o que ocorre tipicamente por causa de problemas de configuração.
- Exemplo
- O Suporte de Software IBM o instruiu a iniciar a procura do perfil do
WebSphere Application Server.
cqperl cqtsadmin.pl --username admin --password
"" --dbset TextSearch --userdb SAMPL --ftshome D:\CQ.Search --start_fts_was_profile
- start_update_idx
- Resumo
- Este comando é usado para ativar e início o indexador em modo de atualização, que executa sob o perfil do WebSphere Application Server. O indexador em modo de atualização sincroniza o índice de procura com as alterações feitas no banco de dados do ClearQuest.
O indexador monitora oplogs para novos valores a serem indexados. Você configura quão frequentemente o índice é sincronizado usando a tag XML <updateIndexDelay> em seu arquivo de configuração de administrador da Identificação.
- Uso
- Você não tem que usar este comando diretamente. Ele é
chamada quando a opção da linha de comandos setup_cq_fts. Este comando é fornecido no caso de você ter que ajustar ou depurar sua implementação.
- Efeito
- O indexador em modo de atualização é ativado e iniciado. Modificações,
inclusões e remoções de registros ClearQuest agora estão indexadas e aparecem nos resultados da procura.
- Status Stateful
- Esta opção não é stateful. Este comando nunca
deverá falhar, a menos que seja um erro de E/S, uma falha do servidor do Solr ou uma falha de inicialização do perfil do WebSphere Application Server, o que ocorre tipicamente por causa de problemas de configuração.
- Exemplo
- O Suporte de Software IBM o instruiu a ativar o indexador de atualização.
cqperl cqtsadmin.pl --username admin --password "" --dbset TextSearch --userdb SAMPL --ftshome D:\CQ.Search --start_update_idx
- stop_fts_was_profile
- Resumo
- Este comando é usado para parar o perfil do WebSphere Application Server da procura de texto completa.
Quando um perfil do WebSphere Application
Server para, então os serviços de busca estão indisponíveis e o indexador em modo de atualização para de sincronizar o índice de procura com as alterações feitas em seus registros do ClearQuest.
- Uso
- Você não tem que usar este comando diretamente. Ele é
chamada quando a opção da linha de comandos setup_cq_fts. Este comando é fornecido no caso de você ter que ajustar ou depurar sua implementação.
- Efeito
- O perfil do WebSphere Application
Server da procura de texto completa para, o que também para os serviços de busca e a indexação de atualização. Os recursos de memória e processador que o perfil do WebSphere Application Server usa são liberados. Uma procura causa um erro.
O oplog continua a receber mensagens enquanto o botão de opções Texto Completo permanecer ativado no ClearQuest Web.
Isso permite que o indexador em modo de atualização capture após o perfil do WebSphere Application Server estar executando novamente.
- Status Stateful
- Esta opção não é stateful. Este comando nunca
deve falhar, a menos que haja um erro de E/S.
- Exemplo
- O Suporte de Software IBM o instruiu a para a procura do perfil do WebSphere Application Server.
cqperl cqtsadmin.pl --username admin --password
"" --dbset TextSearch --userdb SAMPL --ftshome D:\CQ.Search --stop_fts_was_profile
- stop_update_idx
- Resumo
- Este comando é usado para desativar e parar o indexador em modo de atualização.
Quando o indexador em modo de atualização para, os serviços de busca estão disponíveis, mas as alterações feitas nos registros do ClearQuest não são refletidas no índice até a indexação em modo de atualização ser reativada ou retomada. Portanto, procuras podem produzir resultados que não estão atualizados ou precisos.
- Uso
- Você não tem que usar este comando diretamente. Ele é chamado quando você emite as opções da linha de comandos
setup_cq_fts e backup_fts. Este comando é fornecido no caso de você ter que ajustar ou depurar sua implementação.
- Efeito
- O indexador em modo de atualização, que executa sob o perfil do WebSphere Application Server, é desativado. Os registros novos e modificados do ClearQuest não são refletidos nos resultados da procura. O oplog continua a receber mensagens. As alterações de registro do ClearQuest são refletidas em procuras de texto completas após o indexador de registro em modo de atualização ser reativado e após ele capturar os oplogs atuais.
- Status Stateful
- Esta opção não é stateful. Este comando nunca
deve falhar, a menos que haja um erro de E/S.
- Exemplo
- O Suporte de Software IBM o instruiu a desativar o indexador em modo de atualização.
cqperl cqtsadmin.pl --username admin --password "" --dbset TextSearch --userdb SAMPL --ftshome D:\CQ.Search --stop_update_idx
- unlock_cq_fts
- Resumo
- Este comando é usado para desbloquear uma implementação bloqueada de procura de texto completa. Após a conclusão do comando, é possível executar todos os comandos do Administrador da procura de texto completa.
- Uso
- Use este comando para desbloquear uma implementação bloqueada de procura de texto completa para que seja possível executar todos os comandos disponíveis. Este comando reverte o bloqueio que a opção da linha de comandos lock_cq_fts configurou.
- Efeito
- Nenhum. Seus dados e suas configurações da implementação de procura de texto completa não são afetados, e todos os comandos podem ser executados.
- Status Stateful
- Esta opção não é stateful. Este comando nunca
deve falhar, a menos que haja um erro de E/S.
- Exemplo
- Você tem que otimizar seu índice, mas sua implementação está bloqueada.
Você deve desbloqueá-la, otimizar o índice e bloqueá-la novamente.
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
- Resumo
- Propaga as alterações feitas no arquivo de configuração do administrador da procura de texto completa cqtsadmin-dbset-userdb.xml. Após alterar qualquer uma das tags XML E no arquivo de configuração, você deve propagar as alterações para que entrem em vigor:
- <batchIndexBatchSize>
- <batchIndexDelay>
- <batchIndexThreads>
- <ftsServerName>
- <ftsWASProfileName>
- <ftsWASProfilePort>
- <updateIndexBatchSize>
- <updateIndexDelay>
- <updateIndexLoginInterval>
Por exemplo, se você alterar o tamanho do lote para o indexador de modo em lote, emita este comando antes de executar a opção da linha de comandos run_batch_idx para o novo valor a ser usado.
Nota: Sempre que você alterar
a senha para o usuário administrador, use
update_fts_prop_files (especificando
a nova senha) para assegurar que o arquivo de senha (
pwd.txt)
seja atualizado e a indexação de log de novos registros possa continuar; por exemplo
cqperl cqtsadmin.pl --username admin --password new_password --dbset 7.0.0 --userdb SAMPL --ftshome C:\CQ.Search --fresh_batch_idx
- Uso
- Ao implementar a procura de texto completa, você pode ter que alterar uma configuração padrão. Quando uma alteração é feita no arquivo de configuração, a alteração deve ser propagada para os componentes adequados da procura de texto completa.
- Efeito
- O componente afetado depende do valor de tag XML alterado.
Consulte o cqtsadmin-dbset-userdb.xml para obter informações adicionais.
- Status Stateful
- Esta opção não é stateful. Este comando nunca
deve falhar, a menos que haja um erro de E/S.
- Exemplo
- Você tem que acelerar a indexação de modo em lote aumentando o
tamanho do lote e o número de encadeamentos. Após alterar o arquivo de configuração,
emita este comando.
cqperl cqtsadmin.pl --username admin
--password "" --dbset TextSearch --userdb SAMPL --ftshome D:\CQ.Search
--update_fts_prop_files --run_batch_idx
- upgrade_solr_app
- Resumo
- Esta opção da linha de comandos verifica se o Apache Solr de sua implementação de procura de texto completa atual é da versão mais recente enviada com sua versão de ClearQuest.
Se não for, a opção atualiza o Apache Solr.
- Uso
- Uma versão mais nova de ClearQuest pode suportar versões mais novas de Apache Solr do que a versão que sua implementação de procura de texto completa atual usa. Ao atualizar o ClearQuest e suas implementações de procura de texto completa que usam as opções da linha de comandos prep_upgd_was_profiles e restore_was_profiles, seu aplicativo do Apache Solr não é automaticamente atualizado.
Essa abordagem de upgrade é intencional porque o formato do índice pode ter alterado, o que poderia requerer uma reindexação integral. Use este comando para atualizar o Apache Solr para a versão mais recente suportada.
Antes de usar esta opção da linha de comandos, você deve fazer backup de sua implementação de procura de texto completa usando a opção da linha de comandos backup_fts.
Além disso, consulte as notas sobre a liberação do IBM Rational ClearQuest para descobrir se
você tem que reindexar seu banco de dados do ClearQuest
após o upgrade do Apache Solr. Você pode ter que reindexar se o formato do índice do Apache Solr tiver alterado.
Após executar esta opção da linha de comandos, você deve executar a opção da linha de comandos
stop_fts_was_profile e, em seguida, executar a opção da linha de comandos
start_fts_was_profile para o upgrade entrar em vigor.
Importante: Você deve executar esta opção da linha de comandos após atualizar o ClearQuest e após atualizar suas implementações da procura de texto completa usando as opções da linha de comandos prep_upgd_was_profiles e restore_was_profiles. Caso contrário, problemas desconhecidos podem ocorrer.
- Efeito
- Seu Apache Solr existe é atualizado para a versão mais recente suportada. A procura de texto completa do ClearQuest
fica indisponível até que o upgrade esteja concluído.
- Status Stateful
- Esta opção não é stateful. Este comando nunca
deverá falhar, a menos que haja um erro de E/S ou problemas com o WebSphere Application
Server.
- Exemplo
- Você deseja atualizar o Apache Solr para um de suas implementações de procura de texto completa. Faça backup de sua implementação de procura de texto completa executando o comando
cqtsadmin.pl com a opção backup_fts.
cqperl
cqtsadmin.pl --username admin --password secret --dbset TextSearch
--userdb SAMPL --ftshome D:\CQ.Search --backup_fts E:\FTS.Backup
Atualize o aplicativo do
Solr executando o comando cqtsadmin.pl novamente com a opção da linha de comandos
upgrade_solr_app:
cqperl
cqtsadmin.pl --username admin --password secret --dbset TextSearch
--userdb SAMPL --ftshome D:\CQ.Search --upgrade_solr_app
Se uma mensagem for exibida instruindo-o a reindexar o banco de dados do usuário, então execute o comando cqtsadmin.pl quatro vezes com as opções da linha de comandos stop_update_idx, run_batch_idx, optimize_idx
e 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
Se tiver implementações de procura de texto completa adicionais para outros bancos de dados do ClearQuest, execute os comandos anteriores em cada banco de dados.
- was_profile_ports_file
- Resumo
- Esta opção da linha de comandos permite que você opcionalmente forneça seu próprio arquivo de portas do perfil do WebSphere Application
Server, que é usado com a opção da linha de comandos create_fts_was_profile na criação de um perfil de procura de texto completa.
- Uso
- Ao criar uma nova implementação de procura de texto completa, você cria, por padrão, um novo perfil do WebSphere Application Server. A ferramenta de procura de texto completo do administrador
determina a próxima porta disponível para usar em seu sistema. Se tiver que ajustar sua implementação e especificar suas próprias portas para uso, você deve criar se próprio arquivo de portas. Em seguida, você usa a opção was_profile_ports_file para informar à ferramenta do administrador da procura de texto completa para usar seu arquivo de portas. Há um modelo que pode ser usado no arquivo portdef.props em sua instalação do WebSphere.
O arquivo portdef.props está tipicamente localizado no diretório \IBM\WebSphere\AppServer\profileTemplates\default\actions\portsUpdate\.
Para aprender mais sobre o arquivo de portas do perfil do WebSphere Application Server, consulte o comando manageprofiles.
Exemplo: Usando a seção de números de porta predefinidos no centro de informações do 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 opção da linha de comandos é usada com a opção
create_fts_was_profile.
Nota: Se você usar suas próprias portas, assegure-se de que suas portas não sejam usadas por outros aplicativos. Caso contrário, você poderá encontrar problemas com a procura de texto completa e outros aplicativos.
- Efeito
- As portas especificadas com este comando são usadas em vez das portas especificadas pela ferramenta do administrador da procura de texto completa.
- Status Stateful
- Esta opção não é stateful. Este comando nunca deve falhar, a menos que ocorra um erro de E/S.
- Exemplo
- Você tem que especificar seu próprio conjunto de portas a serem usadas.
- Faça uma cópia do arquivo portdef.props e, em seguida,
especifique seu próprio valor de porta.
- Execute este comando para criar uma nova implementação da procura de texto completa que use a opção was_profile_ports_file para especificar suas próprias portas.
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
- Continue a usar sua implementação da procura de texto completa.