cqtsadmin-dbset-userdb.xml

cqtsadmin-dbset-userdb.xml é um arquivo de configuração do administrador da procura de texto completa que o script Perl cqtsadmin.pl gera e usa. O arquivo contém dados sobre sua implementação, os quais podem ser mais customizados.

cqtsadmin-dbset-userdb.xml é um dos dois componentes da ferramenta do administrador de procura de texto completa. O outro componente é o script Perl cqtsadmin.pl, que automatiza as etapas para instalar, configurar e administrar a procura de texto completa do IBM Rational ClearQuest.

O arquivo de configuração cqtsadmin-dbset-userdb.xml contém elementos XML que representam configurações de procura de texto completa usados pelo script Perl cqtsadmin.pl. Cada elemento contém essas tags:

Tabela 1. Formato do elemento XML do cqtsadmin-dbset-userdb.xml
Tag Descrição
<description> Explica o propósito do elemento XML
<note> Fornece informações adicionais importantes sobre a tag
<defaultValue> Contém o valor padrão do elemento XML
<newValue required="yes"> Pode conter um novo valor de substituição para o valor padrão na tag <defaultValue>. O valor de <newValue> é definido com base nos parâmetros especificados na opção da linha de comandos ou que são reunidos a partir do banco de dados do ClearQuest ou do sistema operacional. Também é possível alterar esse valor editando diretamente o arquivo.
Nota: Os elementos de configuração necessários possuem o atributo XML <newValue required="yes">
.
No exemplo a seguir, o elemento XML <dbSet> possui uma descrição, uma nota e um valor padrão de TextSearch. A tag <newValue required="yes"> substitui o valor padrão de TextSearch pelo valor 8.0.0, que é baseado no parâmetro da linha de comandos usado para a opção -userdb.
<dbSet>
	<description>O nome do repositório de esquema do CQ (conjunto de bancos de dados) para o qual deseja ativar o FTS.</description> do CQ
	<note>É necessário fornecer estes dados pois o padrão pode não ser adequado (eles são específicos para seu banco de dados do CQ).</note>
	<defaultValue>TextSearch</defaultValue>
			<newValue required="yes">8.0.0</newValue>
</dbSet>

Elementos XML cqtsadmin-dbset-userdb.xml

Tabela 2. Tags do elemento XML cqtsadmin-dbset-userdb.xml
Nome da tag Descrição Notas
<dbSet> O nome do conjunto de bancos de dados do ClearQuest.

O valor padrão dessa tag é automaticamente gerado pela ferramenta cqtsadmin.pl. Você não tem que modificá-lo.

O valor desta tag é baseado no conjunto de bancos de dados do ClearQuest especificado no argumento de linha de comandos para a ferramenta cqtsadmin.pl na configuração inicial.

<userDB> O nome do banco de dados do usuário do ClearQuest.

O valor padrão dessa tag é automaticamente gerado pela ferramenta cqtsadmin.pl. Você não tem que modificá-lo.

O valor para esta tag é baseado no nome do banco de dados do usuário do ClearQuest especificado no argumento de linha de comandos para a ferramenta cqtsadmin.pl na configuração inicial.

<siteName> O nome do site do ClearQuest.

O valor padrão dessa tag é automaticamente gerado pela ferramenta cqtsadmin.pl. Não é necessário modificá-lo.

O valor para esta tag é baseado no seu tipo de banco de dados do ClearQuest. Se o seu banco de dados não estiver replicado, o valor será <local>. Caso contrário, o valor será o nome de sua réplica principal.

<enableAtSites> Lista separada por vírgula de sites nos quais a procura de texto completa do ClearQuest será ativada.

O valor padrão dessa tag é automaticamente gerado pela ferramenta cqtsadmin.pl. Você não tem que modificá-lo.

O valor para esta tag é baseado no seu tipo de banco de dados do ClearQuest. Se o seu banco de dados não estiver replicado, este valor será ignorado. Se o seu banco de dados estiver replicado, o valor padrão será vazio, o que permite que a procura de texto completa do ClearQuest em todos os sites.

Para ativar a procura de texto completa do ClearQuest em sites selecionados, liste os nomes de site nesta tag XML usando uma vírgula como separador.

<entityFile> O arquivo de entidade da procura de texto completa do ClearQuest.

O valor padrão dessa tag é automaticamente gerado pela ferramenta cqtsadmin.pl. Não é necessário modificá-lo.

O valor dessa tag é o caminho para o arquivo de entidade gerado automaticamente para sua implementação de procura de texto completa do ClearQuest. O arquivo padrão é Entity-dbset-userdb.txt, que é um arquivo de texto que lista os tipos de registro e seus campos a serem procurados.

<ftsWASProfileName> O nome do perfil do WebSphere Application Server da procura de texto completa.

O valor padrão dessa tag é automaticamente gerado pela ferramenta cqtsadmin.pl. Você não tem que modificá-lo.

As convenções de nomenclatura do nome do são cqsearchprofile_db-set-name_user-db-name, em que db-set-name e user-db-name são determinados a partir dos parâmetros da linha de comandos que são passados para cqtsadmin.pl.

Se o nome do perfil resultante exceder a 27 caracteres, então o nome do perfil cqsearchprofile_db-set-name_user-db-name será abreviado como cqfts_db-set-name user-db-name.

Se o nome do perfil exceder a 27 caracteres, abrevie db-set-name ou user-db-name. Se isso não for possível, forneça seu próprio nome de perfil substituindo o valor nessa tag XML por um nome de perfil que seja exclusivo no computador no qual você está implementando a procura de texto completa como, por exemplo, MyProfile_1.

<ftsWASProfileHome> O caminho para o diretório inicial do perfil do WebSphere Application Server do ClearQuest.

O valor padrão dessa tag é automaticamente gerado pela ferramenta cqtsadmin.pl. Você não tem que modificá-lo.

O valor deste caminho é automaticamente determinado ao usar a opção da linha de comandos fts_was_profile_home. Caso contrário, o caminho padrão %CLEARQUEST_HOME%/cqweb/ será usado.

Nota: Use a opção da linha de comandos fts_was_profile_home para definir um caminho de diretório inicial de perfil do WebSphere Application Server ao implementar seus perfis de procura de texto completa do WebSphere Application Server
.
<ftsWASProfilePort> O número da porta do perfil do WebSphere Application da procura de texto completa do ClearQuest, para utilização com a implementação da procura de texto completa deste banco de dados do usuário.

O valor padrão dessa tag é automaticamente gerado pela ferramenta cqtsadmin.pl. Você não tem que modificá-lo.

O valor padrão de cqsearchprofile do perfil do da procura de texto completa do ClearQuest inicial é 14080. Quando um novo perfil do WebSphere Application Server é criado para uma nova implementação da procura de texto completa, o valor de porta é automaticamente gerado por meio da utilização da próxima porta disponível em seu servidor, iniciando com 15080 e aumentando em incrementos de 1000 para implementações adicionais da procura de texto completa. Por exemplo, os valores de porta devem ser, por exemplo: 15080, 16080, 17080 e assim por diante.

<ftsWASProfilePortsDefPropFile> O caminho para o arquivo de portas do perfil do WebSphere Application Server da procura de texto completa do ClearQuest. Use esse caminho com a opção da linha de comandos create_fts_was_profile para a implementação da procura de texto completa do banco de dados do usuário. Se tiver que especificar as portas, use a opção da linha de comandos was_profile_ports_file.

O valor padrão dessa tag é automaticamente gerado pela ferramenta cqtsadmin.pl. Você não tem que modificá-lo.

Por padrão, as portas do perfil do WebSphere Application Server são automaticamente determinadas para perfis do WebSphere Application Server da procura de texto completa do ClearQuest que você cria usando a opção da linha de comandos create_fts_was_profile. Todavia, se você tiver que especificar suas próprias portas, use a opção da linha de comandos was_profile_ports_file para fornecer o caminho para um arquivo com informações de porta a ser usado como um modelo.

Quando você especifica uma porta, esse arquivo de portas do perfil do WebSphere Application Server é copiado para seu procura de texto completa de implementação da procura de texto completa atual, e esta tag é automaticamente atualizada para apontar para a instância do diretório inicial da procura de texto completa do arquivo.

Não altere o valor dessa tag a menos que você necessite de um controle mais preciso sobre a configuração ou se estiver tentando resolver um problema.

<ftsWASProfileMaxHeapSize> O tamanho de heap máximo da Java virtual machine (JVM) para o perfil do WebSphere Application Server em megabytes.

O valor padrão dessa tag é 1024, o que significa que o tamanho de heap máximo da JVM pode ser de até 1 MB.

Durante a indexação, particularmente a indexação em lote, se você receber erros de falta de memória em seu perfil do WebSphere Application Server da procura de texto completa (Solr), aumente o tamanho de heap para ajudar a eliminar esse problema. O valor máximo é atualmente de aproximadamente 1792 MB. Se você alterá-lo, lembre-se de reconfigurá-lo para 1024.

<ftsServerName> O nome do host ou do servidor no qual esta implementação de procura de texto completa do ClearQuest está sendo configurada.

O valor padrão dessa tag é automaticamente gerado pela ferramenta cqtsadmin.pl. Você não tem que modificá-lo.

O valor para esta tag é configurado para o nome do servidor no qual você está implementando a procura de texto completa. Altere esse nome apenas se você renomear seu computador ou mover sua implementação para um servidor que possua um nome diferente.

Nota: Se você alterar esse valor, você deverá fornecer um nome de host completo e universalmente acessível. Se estiver usando o balanceamento de carga ou procura de texto completa em uma configuração de banco de dados replicado do ClearQuest MultiSite, o nome do host deve ser acessível a partir de todos os servidores do ClearQuest Web.
<enableCQFTS> Esta tag é configurada como TRUE para ativar o botão de opções Texto Completo no ClearQuest Web.

O valor padrão dessa tag é automaticamente gerado pela ferramenta cqtsadmin.pl. Você não tem que modificá-lo.

Essa tag possui dois valores: TRUE e mais alguma coisa, ou vazio. Quando configurada como TRUE, o botão de opções Texto Completo no ClearQuest Web fica ativado durante a configuração. Caso contrário, essa etapa é ignorada.

Não altere o valor dessa tag a menos que você necessite de um controle mais preciso sobre a configuração ou se estiver tentando resolver um problema.

Atenção: Não configure o valor como FALSE para desativar o botão de opções se o banco de dados do usuário for parcial ou completamente indexado, mas não replicado. A desativação do botão de opções desativa a criação de oplogs para bancos de dados não replicados do ClearQuest. Assim, a procura de texto completa não controla as alterações nos registros do ClearQuest, e os registros alterados nunca são reindexados. Se o valor for configurado como FALSE e os registros forem alterados, você deve reindexar completamente o banco de dados. Se tiver configurar o valor como FALSE, você deve evitar alterações no registro do ClearQuest até que o valor seja reconfigurado como TRUE.
<runBatchIndex> Esta tag é configurada como TRUE para ativar a indexação em lote para iniciar durante a configuração da procura de texto completa do ClearQuest.

O valor padrão dessa tag é automaticamente gerado pela ferramenta cqtsadmin.pl. Você não tem que modificá-lo.

Essa tag possui dois valores: TRUE e mais alguma coisa, ou vazio. Quando esta tag é configurada como TRUE, o indexador de modo em lote é executado durante a configuração. Caso contrário, essa etapa é ignorada.

Ignorar a indexação em lote significa que todos os registros existentes não serão indexados e não poderão ser procurados. Assim os resultados da procura serão incompletos.

<startUpdateIndex> Esta tag é configurada como TRUE para ativar a indexação de atualização para iniciar durante a configuração de procura de texto completa do ClearQuest.

O valor padrão dessa tag é automaticamente gerado pela ferramenta cqtsadmin.pl. Você não tem que modificá-lo.

Essa tag possui dois valores: TRUE e mais alguma coisa, ou vazio. Quando o valor é configurado como TRUE, o indexador de modo de atualização é configurado para carregar quando o perfil do WebSphere Application Server iniciar. Caso contrário, essa etapa é ignorada.

Ignorar a indexação de atualização significa que todos os registros modificados ou recém incluídos não serão indexados após a indexação em lote inicial e não poderão ser procurados. Assim os resultados da procura serão incompletos.

<batchIndexJVMParm> A configuração de parâmetro da JVM que o indexador em modo em lote usa.

O valor padrão desta tag é -Xmx1536m, o que significa que o indexador de modo em lote pode usar até 1,5 GB de RAM.

Se você receber erros de falta de memória durante a indexação em lote, diminua o tamanho do lote ou o número de encadeamentos. Aumentar o valor da JVM para -Xmx1792m pode ajudar, mas não muito porque o valor máximo em um sistema operacional de 32 bits é de 2048 MB.

Como esse valor de parâmetro da JVM é passado no estado em que se encontra ao indexador de modo em lote, use valores corretos como especificado na especificação da JVM. Por exemplo, para aumentar o tamanho de heap da JVM para 1,7 GB, use -Xmx1792m, não 1792. Para aumentar a memória e ativar a depuração da JVM, use o valor -Xmx1536m -XX:-PrintGCDetails.

<batchIndexBatchSize> O número de registros a serem indexados por encadeamento durante a indexação em lote. O valor é um número inteiro entre 1 e 1000. O valor padrão é 50.

O valor padrão dessa tag é automaticamente gerado pela ferramenta cqtsadmin.pl. É possível alterar o valor dessa tag para aumentar a velocidade de indexação em lote, aumentando o número de registros para leitura por encadeamento. Ou, é possível alterar o valor para superar os erros de falta de memória diminuindo o número de registros para leitura por encadeamento.

O valor padrão é 50. Se o seu ambiente tiver ciclos de CPU e recursos de RAM suficientes, e você desejar aumentar a velocidade de indexação em lote, considere o aumento do valor para 200. Isso reduzirá o tempo necessário para os indexação em lote dos registros do ClearQuest. Entretanto, você corre o risco de recebimento de erros de falta de memória. Para corrigir esses erros, aumente a memória da JVM para o indexador em lote, o perfil do WebSphere Application Server ou ambos.

<batchIndexDelay> O valor do atraso em segundos para o indexador em lote. O valor é um número inteiro entre 0 e 86400 (1 dia). O valor padrão é 0.

O valor padrão dessa tag é automaticamente gerado pela ferramenta cqtsadmin.pl. É possível alterar o valor para ajustar o tempo da indexação em lote com base na carga e no desempenho do processador, mantendo recursos para outros aplicativos no servidor.

Cada vez que o indexador em lote processa a quantidade de registros que a tag <batchIndexBatchSize> especifica, ele pausa pelo período configurado na tag <batchIndexDelay>. Esse atraso permite a outros processos usarem o processador. O valor padrão é de 0 segundo.

Use esse valor para ajustar quanta carga você deseja colocar em seu servidor, principalmente no servidor de banco de dados do ClearQuest e no servidor de procura de texto completa do ClearQuest. Pelo design, um valor 0 possui uma pausa integrada que ambos os servidores não usaram ao mesmo tempo. Durante a indexação de modo em lote, quando os dados são lidos do banco de dados, o servidor de procura de texto completa fica principalmente inativo. Quando o servidor de procura de texto completa estiver indexando dados, o servidor de banco de dados fica inativo. Se não deseja pausa entre esse ciclo, aumente o valor para 30. Em seguida, o indexador não faz nada por 30 segundos, permitindo que outros processos em ambos os servidores usem recursos do processador.

<batchIndexThreads> O número de encadeamentos a serem criados para a indexação em lote. O valor é um número inteiro entre 1 e 10. O valor padrão é 5.

O valor padrão dessa tag é automaticamente gerado pela ferramenta cqtsadmin.pl. É possível alterar o valor desta tag para reduzir tempo de indexação em lote aumentando o valor, ou aumentar o tempo de indexação em lote reduzindo o valor para que a CPU seja liberada para outros aplicativos ou para aliviar a demanda no servidor de banco de dados.

Na indexação em lote, é possível especificar quantos encadeamentos são criados, onde cada encadeamento processa sua própria quantidade de registros <batchIndexBatchSize>.

Se tiver recursos de processador e RAM suficientes, é possível acelerar o indexador em lote aumentando o número de encadeamentos. Todavia, você corre o risco de receber erros de falta de memória. Se acontecer isso, aumente a memória da JVM para o indexador em lote, o perfil do WebSphere Application Server ou ambos. Ou, configure um menor número de registros <batchIndexBatchSize> para serem lidos por encadeamento.

<updateIndexBatchSize> O número de registros a serem indexados durante uma única passagem do indexador de atualização. O valor é um número inteiro entre 1 e 1000. O valor padrão é 250.

O valor padrão dessa tag é automaticamente gerado pela ferramenta cqtsadmin.pl. Você não tem que modificá-lo.

O valor padrão é 250. Pode ser necessário aumentar o valor se o indexador de modo de atualização não puder manter a quantia de alterações feitas no banco de dados do ClearQuest.
Nota: Diferentemente do indexador de modo em lote, o indexador de modo de atualização é de um único encadeamento. Você pode ter que configurar valores de tamanho superiores por passagem, ou configurações de <updateIndexDelay> mais curtas, para atingir o rendimento de indexação de modo de atualização necessário. Essa taxa de rendimento depende da média de envios e atualizações e exclusões de registros por minuto por banco de dados do usuário do ClearQuest.
<updateIndexDelay> O valor do atraso em segundos para o indexador de atualização. O valor é um número inteiro entre 1 e 86400 (1 dia). O valor padrão é 60.

O valor padrão dessa tag é automaticamente gerado pela ferramenta cqtsadmin.pl. Você não tem que modificá-lo.

O valor padrão é 60 segundos (1 minuto). Se você aumentar esse valor para 600 (10 minutos), então seu índice de procura é sincronizado com suas modificações de banco de dados do ClearQuest a cada 10 minutos pelo custo de poucos logins (e um consumo de licença adicional temporária) e menos ciclos de processador.

<updateIndexLoginInterval> Esta tag especifica a ocorrência de n números de ciclos de extração de registro de modo de atualização antes de uma conta do ClearQuest poder efetuar login novamente. O valor padrão é 10.

O valor padrão dessa tag é automaticamente gerado pela ferramenta cqtsadmin.pl e é configurado como 10.

O valor desta tag é usado em conjunto com o valor da tag <updateIndexDelay>. Com esses valores, é possível ajustar a frequência com a qual o indexador de modo de atualização sincroniza o índice com o banco de dados do ClearQuest. Por exemplo, para configurar o índice de procura de texto completa para sincronizar com o banco de dados do ClearQuest a cada minuto, configure o valor de <updateIndexDelay> como 60 e o valor de <updateIndexLoginInterval> como 1. A cada minuto o indexador de modo de atualização efetua logon no banco de dados do ClearQuest para verificar as alterações feitas desde a última verificação. Se forem detectadas alterações, os dados serão lidos e enviados ao indexador. Em seguida, o indexador de modo de atualização efetua logoff. Como uma operação de logon exigem muitos recursos, é possível atingir a mesma frequência de sincronização configurando o valor <updateIndexLoginInterval> como 10. Isso informa ao indexador de modo de atualização para sincronizar o índice uma vez por minuto, mas permanecer com logon efetuado por 10 minutos. Após a décima sincronização, o indexador efetua logoff por um minuto. Usando esse método, você não consome recursos de logon a cada minuto para sincronizar o índice, mas mantém a licença retirada por um período maior.

Nota: Não especifique uma combinação de segundos calculada pelos valores de <updateIndexLoginInterval> e <updateIndexDelay>, o que representa uma configuração de duração de login mais longa que sua configuração de tempo limite de banco de dados do ClearQuest. Fazer isso pode levar a vários problemas como a falta de recursos.
<addRecordType> Uma lista de tipos de registro e campos a serem incluídos em uma implementação existente de procura de texto completa.

O valor padrão desta tag é vazio. Use esta tag ao incluir novos tipos de registro ou campos em seu índice de procura se seu esquema do ClearQuest mudar após a configuração inicial.

Se você omitir um tipo de registro durante a implementação ou incluir um tipo de registro e desejar procurá-lo, é possível fazê-lo fornecendo o tipo de registro integral e os campos associados usando esta tag.

Por exemplo, suponha que durante sua implementação de procura de texto completo inicial você não indexou o tipo de registro Cliente, mas agora precisa indexá-lo. Use o formato a seguir para incluir o tipo de registro Cliente e seu conjunto de campos nesta tag: Customer=field1,field2,fieldN

Para incluir múltiplos tipos de registro, use um ponto e vírgula (;) como um separador. Por exemplo, é possível incluir dois tipos de registro: Customer=field1,field2,fieldN;NewRecord=field1,field2,fieldN

Não é possível usar esta opção para incluir campos adicionais a um tipo de registro indexado existente. Para fazer isso, primeiro remova o tipo de registro e, em seguida, o inclua novamente com esta opção. Esse procedimento requer a indexação complete desse tipo de registro após ele ter sido incluído novamente.

<removeRecordType> Uma lista de tipos de registro a serem removidos da implementação de procura de texto completa.

O valor padrão desta tag é vazio. Use esta tag para remover os tipos de registro indexados de sua implementação.

Insira os nomes de tipos de registro para remoção nesta tag. Para remover o tipo de registro Cliente, insira seu nome nesta tag. Para remover múltiplos tipos de registro, use ponto e vírgula (;) como um separador. Por exemplo, é possível remover dois tipos de registro: Customer;NewRecord.

<deleteFtsWASProfiles> Esta tag é configurada como TRUE para que a opção da linha de comandos prep_upgd_was_profiles faça o backup e exclua todos os perfis do WebSphere Application Server de procura de texto completa do ClearQuest neste sistema host. Essa remoção é necessária para preparação de upgrade, modificação ou reinstalação do ClearQuest com procura de texto completa implementada.

O valor padrão dessa tag é automaticamente gerado pela ferramenta cqtsadmin.pl e é configurado como FALSE. Ao atualizar, modificar ou reinstalar o ClearQuest, configure o valor como TRUE antes de executar a opção da linha de comandos prep_upgd_was_profiles para esta implementação da procura de texto completa. Assim, o comando opera globalmente em todas as implementações de procura de texto completa neste servidor.

A tag possui dois valores: TRUE e mais alguma coisa, ou vazio. Quando o valor estiver configurado como TRUE e você especificar a opção da linha de comandos prep_upgd_was_profiles, o comando criará dados de backup de seus perfis WebSphere Application Server da procura de texto completa do ClearQuest. O comando também exclui esses perfis em preparação para sua restauração na tarefa de restauração pós-instalação. O comando toma essa ação para cada perfil do WebSphere Application Server de procura de texto completa neste servidor.

Após a atualização, modificação ou reinstalação do ClearQuest, use a opção da linha de comandos restore_was_profiles para recriar todos os perfis do WebSphere Application Server de procura de texto completa que foram excluídos.

Após concluir a opção da linha de comandos prep_upgd_was_profiles, configure o valor desta tag como FALSE para esta implementação de procura de texto completa de forma a evitar a exclusão acidental.

Importante: Diferentemente de todos os outros comandos e tags, esta tag e este comando são globais e afetam todas as implementações de procura de texto completa neste servidor. Quando fizer essa mudança e executar o comando prep_upgd_was_profiles contra qualquer das implementações de procura de texto completa neste servidor, ele afetará todas as implementações neste servidor.
<solrVersion> Esta tag contém a versão Apache Solr que o ClearQuest suporte atualmente. A ferramenta do administrador de procura de texto completa do ClearQuest usa o valor dessa tag para determinar qual é a versão atual do Apache Solr e se uma versão mais nova está disponível. Quando você atualiza o aplicativo Apache Solr usando a opção da linha de comandos upgrade_solr_app, o valor dessa tag é atualizado para refletir a versão de upgrade.
Importante: Não altere o valor da tag <solrVersion>, a menos que tenha sido instruído pelo Suporte IBM. Você não pode modificar esta tag.

Feedback