cqtsadmin-dbset-userdb.xml は、全文検索管理機能ツールの 2 つのコンポーネントのうちの 1 つです。 もう 1 つのコンポーネントは cqtsadmin.pl Perl スクリプトです。 これは IBM Rational ClearQuest 全文検索をセットアップ、構成、管理するステップを自動化します。
cqtsadmin-dbset-userdb.xml 構成ファイルには、cqtsadmin.pl Perl スクリプトによって使用される、全文検索の設定を表す XML エレメントが含まれています。 各エレメントには、以下のタグが含まれています。
タグ | 説明 |
---|---|
<description> | XML エレメントの目的を説明します。 |
<note> | タグに関する、注目すべき追加情報を提供します。 |
<defaultValue> | XML エレメントのデフォルト値が含まれています。 |
<newValue required="yes"> | <defaultValue> タグ内のデフォルト値を置き換える新しい上書き値が含まれていることがあります。<newValue> の値は、コマンド行オプションで指定するパラメータ、あるいは ClearQuest データベースまたはオペレーティング システムから収集されたパラメータに基づいて設定されます。
この値は、ファイルを直接編集して変更することもできます。
注: 必須の構成エレメントには <newValue required="yes"> XML 属性があります。
. |
<dbSet>
<description>The CQ schema repository (database-set) name for which you want to enable CQ FTS.</description>
<note>You need to provide this data as the default may not be appropriate (it's specific to your CQ database).</note>
<defaultValue>TextSearch</defaultValue>
<newValue required="yes">8.0.0</newValue>
</dbSet>
タグ名 | 説明 | 注 |
---|---|---|
<dbSet> | ClearQuest データベース セット名。 | このタグのデフォルト値は cqtsadmin.pl ツールによって自動生成されます。この値を修正する必要はありません。 このタグの値は、初期セットアップ時に cqtsadmin.pl ツールに対するコマンド行引数で指定した ClearQuest データベース セットに基づいて決まります。 |
<userDB> | ClearQuest ユーザー データベース名。 | このタグのデフォルト値は cqtsadmin.pl ツールによって自動生成されます。この値を修正する必要はありません。 このタグの値は、初期セットアップ時に cqtsadmin.pl ツールに対するコマンド行引数で指定した ClearQuest ユーザー データベース名に基づいて決まります。 |
<siteName> | ClearQuest サイト名。 | このタグのデフォルト値は cqtsadmin.pl ツールによって自動生成されます。この値を修正する必要はありません。 このタグの値は、ClearQuest データベース タイプに基づいて決まります。データベースのレプリカが作成されない場合、値は <local> になります。それ以外の場合、値はマスタ レプリカの名前です。 |
<enableAtSites> | ClearQuest 全文検索を有効にするサイトのコンマ区切りリスト。 | このタグのデフォルト値は cqtsadmin.pl ツールによって自動生成されます。この値を修正する必要はありません。 このタグの値は、ClearQuest データベース タイプに基づいて決まります。データベースのレプリカが作成されない場合、この値は無視されます。データベースのレプリカが作成される場合には、デフォルト値は空になります。つまり、すべてのサイトで ClearQuest 全文検索が有効になります。 選択したサイトで ClearQuest 全文検索を有効にするには、区切り文字としてコンマを使用してこの XML タグでサイト名をリストしてください。 |
<entityFile> | ClearQuest 全文検索エンティティ ファイル。 | このタグのデフォルト値は cqtsadmin.pl ツールによって自動生成されます。この値を修正する必要はありません。 このタグの値は、ClearQuest 全文検索デプロイメント用に自動生成されたエンティティ ファイルのパスです。デフォルト ファイルは Entity-dbset-userdb.txt です。これは、検索対象のレコード タイプとフィールドをリストするテキスト ファイルです。 |
<ftsWASProfileName> | 全文検索 WebSphere® Application Server プロファイル名。 | このタグのデフォルト値は cqtsadmin.pl ツールによって自動生成されます。この値を修正する必要はありません。 プロファイルの命名規則は cqsearchprofile_db-set-name_user-db-name です (db-set-name と user-db-name は、cqtsadmin.pl に渡されたコマンド行パラメータによって決まります)。 得られたプロファイル名が 27 文字を超える場合、cqsearchprofile_db-set-name_user-db-name プロファイル名は cqfts_db-set-name user-db-name に短縮されます。 それでもプロファイル名が 27 文字を超える場合には、db-set-name または user-db-name を短縮してください。それが不可能な場合には、この XML タグの値を、全文検索をデプロイしているコンピュータで固有のプロファイル名 (例えば、MyProfile_1) に置き換えて、独自のプロファイル名を指定してください。 |
<ftsWASProfileHome> | ClearQuest 全文検索 WebSphere Application Server プロファイル ホーム ディレクトリへのパス。 | このタグのデフォルト値は cqtsadmin.pl ツールによって自動生成されます。この値を修正する必要はありません。 このパスの値は、fts_was_profile_home コマンド行オプションが使用された場合は自動的に決定されます。 そうでない場合は、デフォルト パス %CLEARQUEST_HOME%/cqweb/ が使用されます。 注: 全文検索 WebSphere Application Server プロファイルをデプロイする場合は、fts_was_profile_home コマンド行 オプションを使用して WebSphere Application Server プロファイル ホーム ディレクトリ パスを定義してください。
. |
<ftsWASProfilePort> | このユーザー データベースの全文検索デプロイメントで使用する ClearQuest 全文検索 WebSphere Application Server プロファイル ポート番号。 | このタグのデフォルト値は cqtsadmin.pl ツールによって自動生成されます。この値を修正する必要はありません。 ClearQuest 全文検索 WebSphere Application Server 初期プロファイルの cqsearchprofile デフォルト値は 14080 です。新しい全文検索デプロイメント用の新規 WebSphere Application Server プロファイルを作成すると、サーバーで次に使用可能なポートを用いてポート値が自動的に生成されます。ポート値は 15080 から始まって、全文検索デプロイメントが追加されるごとに 1000 ずつ増分されます。 例えば、ポート値は、15080、16080、17080 のようになります。 |
<ftsWASProfilePortsDefPropFile> | ClearQuest 全文検索 WebSphere Application Server プロファイル ポート ファイルのパス。ユーザー データベース全文検索デプロイメントの create_fts_was_profile コマンド行オプションで、このパスを使用します。ポートを指定する必要がある場合は、was_profile_ports_file コマンド行オプションを使用します。 | このタグのデフォルト値は cqtsadmin.pl ツールによって自動生成されます。この値を修正する必要はありません。 デフォルトで、WebSphere Application Server プロファイル ポートは、create_fts_was_profile コマンド行オプションを使用して作成する ClearQuest 全文検索 WebSphere Application Server プロファイルに対して自動的に決定されます。ただし、独自のポートを指定する必要がある場合は、コマンド行オプション was_profile_ports_file コマンド行オプションを使用して、ファイルへのパスとテンプレートとして使用するポート情報を指定します。 ポートを指定すると、この WebSphere Application Server プロファイル ポート ファイルは現在の全文検索デプロイメント ホーム ディレクトリにコピーされ、このタグはそのファイルの全文検索ホーム ディレクトリ インスタンスを指すように自動的に更新されます。 セットアップをより詳細に制御する必要がある場合、または問題を解決しようとしている場合以外は、このタグの値を変更しないでください。 |
<ftsWASProfileMaxHeapSize> | WebSphere Application Server プロファイルの Java 仮想マシン (JVM) の最大ヒープ サイズ (メガバイト)。 | このタグのデフォルト値は 1024 です。これは、JVM の最大ヒープ サイズが最大 1 MB であることを意味します。 インデックス付け中 (特に、バッチ インデックス付け中) に全文検索 WebSphere Application Server プロファイル (Solr) でメモリ不足エラーを受け取った場合、ヒープ サイズを大きくすると問題の解消に役立ちます。現在の最大値は、約 1792 MB です。この値を変更する場合は、1024 にリセットすることを忘れないでください。 |
<ftsServerName> | この ClearQuest 全文検索デプロイメントが設定されるホストまたはサーバーの名前。 | このタグのデフォルト値は cqtsadmin.pl ツールによって自動生成されます。この値を修正する必要はありません。 このタグの値は、全文検索がデプロイされるサーバー名に設定されます。この名前は、コンピュータを名前変更したり異なる名前のサーバーにデプロイメントを移動したりする場合にのみ変更してください。 注: この値を変更する場合は、汎用的にアクセスできる完全修飾ホスト名を指定する必要があります。レプリカが作成された ClearQuest MultiSite データベース構成でロード バランシングまたは全文検索を使用している場合、ホスト名はすべての ClearQuest Web サーバーからアクセスできるものでなければなりません。
|
<enableCQFTS> | このタグを TRUE に設定すると、ClearQuest Web で [全文] ラジオ ボタンを使用できるようになります。 | このタグのデフォルト値は cqtsadmin.pl ツールによって自動生成されます。この値を修正する必要はありません。 このタグの値は、2 つのいずれかの値 (TRUE かそれ以外の値)、または空白です。TRUE に設定すると、セットアップ中に ClearQuest Web で [全文] ラジオ ボタンを使用できるようになります。それ以外の場合、このステップはスキップされます。 セットアップをより詳細に制御する必要がある場合、または問題を解決しようとしている場合以外は、このタグの値を変更しないでください。 重要: ユーザー データベースが部分的または全体的にインデックス付けされていてもレプリカは作成されていない場合は、この値を FALSE に設定 (つまり、ラジオ ボタンを使用不可に設定) しないでください。ラジオ ボタンを使用不可にすると、レプリカが作成されていない ClearQuest データベースの oplog 作成が無効になります。したがって、ClearQuest レコードに対して行った変更は全文検索で把握されず、変更済みのレコードには再インデックス付けが行われません。この値を FALSE に設定した場合にレコードが変更されたときには、データベース全体を再インデックス付けする必要があります。この値を FALSE に設定する必要がある場合は、この値を TRUE にリセットするまで、ClearQuest レコードが変更されないようにする必要があります。
|
<runBatchIndex> | このタグを TRUE に設定すると、ClearQuest 全文検索のセットアップ中にバッチ インデックス付けを開始できるようになります。 | このタグのデフォルト値は cqtsadmin.pl ツールによって自動生成されます。この値を修正する必要はありません。 このタグの値は、2 つのいずれかの値 (TRUE かそれ以外の値)、または空白です。このタグを TRUE に設定すると、セットアップ中にバッチ モードのインデクサが実行されます。それ以外の場合、このステップはスキップされます。 バッチ インデックス付けをスキップすると、既存のすべてのレコードはインデックス付けされず、検索できなくなります。そのため、検索結果が不完全になります。 |
<startUpdateIndex> | このタグを TRUE に設定すると、ClearQuest 全文検索のセットアップ中に更新インデックス付けを開始できるようになります。 | このタグのデフォルト値は cqtsadmin.pl ツールによって自動生成されます。この値を修正する必要はありません。 このタグの値は、2 つのいずれかの値 (TRUE かそれ以外の値)、または空白です。値を TRUE に設定すると、WebSphere Application Server プロファイルの開始時に更新モードのインデクサをロードするように構成されます。 それ以外の場合、このステップはスキップされます。 更新インデックス付けをスキップすると、修正または新規追加されたすべてのレコードは初期バッチ インデックス付け後にはインデックス付けされず、検索できなくなります。そのため、検索結果が不完全になります。 |
<batchIndexJVMParm> | バッチ モードのインデクサが使用する JVM パラメータ設定。 | このタグのデフォルト値は -Xmx1536m です。これは、バッチ モードのインデクサが最大 1.5 GB の RAM を使用できることを意味します。 バッチ インデックス付け時にメモリ不足エラーを受け取った場合は、バッチ サイズを小さくするか、スレッド数を少なくしてください。JVM 値を -Xmx1792m に増やすと改善する可能性があります。ただし、32 ビット オペレーティング システムでの最大値は 2048MB であるため、あまり大きくし過ぎないようにしてください。 この JVM パラメータ値はそのままバッチ モードのインデクサに渡されるため、JVM 仕様で指定されているとおりの正確な値を使用してください。例えば、JVM ヒープ サイズを 1.7 GB に拡張する場合は、1792 ではなく -Xmx1792m と指定してください。メモリを拡張して JVM デバッグを使用可能にするには、値 -Xmx1536m -XX:-PrintGCDetails を使用してください。 |
<batchIndexBatchSize> | バッチ インデックス付け中にインデックス付けする、スレッド当たりのレコード数。値は、1 から 1000 までの整数です。デフォルト値は 50 です。 | このタグのデフォルト値は cqtsadmin.pl ツールによって自動生成されます。このタグの値を変更して、バッチ インデックス付けの速度を上げることができます。それによって、スレッドあたりの読み取りレコード数が多くなります。 あるいは、値を変更してスレッド当たりの読み取りレコード数を少なくし、メモリ不足エラーを回避することができます。 デフォルト値は 50 です。ご使用の環境の CPU サイクルおよび RAM リソースが十分な場合には、バッチ インデックス付けを高速化する際に、値を 200 に増やすことを検討してください。こうすることにより、ClearQuest レコードをバッチ インデックス付けするための所要時間が短縮されます。ただし、メモリ不足エラーを受け取るリスクは高くなります。これらのエラーを解決するには、バッチ インデクサまたは WebSphere Application Server プロファイル、またはその両方の JVM メモリを増やしてください。 |
<batchIndexDelay> | バッチ インデクサの遅延値 (秒単位)。値は、0 から 86400 (1 日) までの整数です。デフォルト値は 0 です。 | このタグのデフォルト値は cqtsadmin.pl ツールによって自動生成されます。サーバー上の他のアプリケーションに対するリソースを維持しながら、プロセッサの負荷およびパフォーマンスに基づいて値を変更し、バッチ インデックス付けの時間を調整することができます。 バッチ インデクサは、<batchIndexBatchSize> タグで指定された数量のレコードを処理するたびに、<batchIndexDelay> タグで設定された期間停止します。この遅延により、他のプロセスがプロセッサを使用できるようにします。デフォルト値は 0 秒です。 この値を使用して、ご使用のサーバー (主に ClearQuest データベース サーバーおよび ClearQuest 全文検索サーバー) にかかる負荷を調整します。両方のサーバーが同時に使用されないように、値 0 には、停止が意図的に組み込まれています。データベースからデータが読み取られるときのバッチ モードのインデックス付け中は、全文検索サーバーは主にアイドル状態です。 全文検索サーバーがデータのインデックス付けを行っている場合は、データベース サーバーがアイドル状態になります。このサイクル間で一時停止させたい場合は、値を 30 に増やしてください。そうすると、インデクサは 30 秒間何も行わず、両方のサーバー上の他のプロセスがプロセッサのリソースを使用することができます。 |
<batchIndexThreads> | バッチ インデックス付けのために作成するスレッドの数。値は、1 から 10 までの整数です。デフォルト値は 5 です。 | このタグのデフォルト値は cqtsadmin.pl ツールによって自動生成されます。このタグの値を大きくしてバッチ インデックス付け時間を短くしたり、このタグの値を小さくしてバッチ インデックス付け時間を長くしたりすることができます。これにより、他のアプリケーションのために CPU を解放したり、データベース サーバーへの要求を緩和したりすることができます。 バッチ インデックス付け中に、作成するスレッドの数を指定できます (各スレッドは、<batchIndexBatchSize> で指定された固有の数量のレコードを処理します。) 十分なプロセッサ リソースおよび RAM リソースがある場合には、スレッドの数を増やしてバッチ モード インデクサを高速化できます。ただし、メモリ不足エラーになるリスクは高くなります。メモリ不足エラーが発生する場合は、バッチ インデクサまたは WebSphere Application Server プロファイル、またはその両方の JVM メモリを増やしてください。または、スレッド当たりの読み取りレコード数 (<batchIndexBatchSize>) を少なくして構成してください。 |
<updateIndexBatchSize> | 更新インデクサの単一受け渡しでインデックス付けするレコードの数。値は、1 から 1000 までの整数です。デフォルト値は 250 です。 | このタグのデフォルト値は cqtsadmin.pl ツールによって自動生成されます。この値を修正する必要はありません。 デフォルト値は 250 です。更新モードのインデクサが、ClearQuest データベースに対して行われる変更の量に対応できない場合には、この値を大きくする必要があるかもしれません。
注: バッチ モードのインデクサとは異なり、更新モードのインデクサは単一スレッドで実行されます。更新モードのインデックス付けで希望するスループットを得るためには、1 回の受け渡し当たりのサイズ値を増やしたり、<updateIndexDelay> 設定を短くしたりしなければならない場合があります。このスループット率は、ClearQuest ユーザー データベース当たりの 1 分間の平均レコード送信数、更新数、および削除数に依存します。
|
<updateIndexDelay> | 更新インデクサの遅延値 (秒単位)。値は、1 から 86400 (1 日) までの整数です。デフォルト値は 60 です。 | このタグのデフォルト値は cqtsadmin.pl ツールによって自動生成されます。この値を修正する必要はありません。 デフォルト値は、60 秒 (1 分) です。この値を 600 (10 分) に増やすと、検索インデックスが 10 分ごとに ClearQuest データベース変更と同期するようになりますが、その代わりに、ログインの頻度 (および追加ライセンスの一時的な使用) とプロセッサ サイクルが減少します。 |
<updateIndexLoginInterval> | このタグは、更新モードのレコード抽出のサイクル数 (n) を指定します。この回数を超えると、ClearQuest アカウントが再ログインできるようになります。デフォルト値は 10 です。 | このタグのデフォルト値は cqtsadmin.pl ツールによって自動生成され、10 に設定されます。 このタグの値は、<updateIndexDelay> タグの値とあわせて使用されます。 これらの値を使用して、更新モードのインデクサがインデックスを ClearQuest データベースと同期化する頻度を調整することができます。 例えば、全文検索インデックスを 1 分ごとに ClearQuest データベースと同期化するよう構成する場合は、 <updateIndexDelay> 値を 60、<updateIndexLoginInterval> 値を 1 に設定します。 そうすると、1 分ごとに更新モードのインデクサが ClearQuest データベースにログオンして、前回のチェック以降に行われた変更をチェックします。 変更が検出されると、データが読み取られ、インデクサに送信されます。 その後、更新モードのインデクサはログオフします。ログオン操作はリソースを集中的に消費するため、<updateIndexLoginInterval> 値を 10 に設定して、同じ同期頻度を達成することができます。 これは、更新モードのインデクサに、1 分に 1 回インデックスを同期化し、10 分間ログオンしたままにすることを通知します。 10 回目の同期後、インデクサは 1 分間ログオフされます。この方法を使用すると、インデックスを同期化するために毎分ログオン リソースを消費することはありませんが、ライセンス チェックアウトの期間がより長くなります。 注: <updateIndexLoginInterval> 値と <updateIndexDelay> 値の計算による秒数の組み合わせは指定しないでください。これは ClearQuest データベースのタイムアウト構成より長いログイン時間設定値になります。このような設定は、リソース リークなどのさまざまな問題につながる恐れがあります。
|
<addRecordType> | 既存の全文検索デプロイメントに追加するレコード タイプおよびフィールドのリスト。 | このタグのデフォルト値は空になっています。このタグは、初期構成後に ClearQuest スキーマが変更された場合に、新しいレコード タイプまたはフィールドを検索インデックスに追加するときに使用します。 デプロイメント時にレコード タイプを指定しなかった場合、またはレコード タイプを追加して、それを検索したい場合は、このタグを用いて完全なレコード タイプおよび関連フィールドを指定して、検索できるようにすることができます。 例えば、初期の全文検索デプロイメント時にレコード タイプ Customer のインデックス付けを行っておらず、そのインデックス付けが必要になったとします。 この場合は、次の形式を使用して、レコード タイプ Customer とその一連のフィールドをこのタグに追加します: Customer=field1,field2,fieldN 複数のレコード タイプを追加する場合は、区切り文字としてセミコロン (;) を使用します。例えば、2 つのレコード タイプを追加する場合は、次のようにします: Customer=field1,field2,fieldN;NewRecord=field1,field2,fieldN このオプションを使用して、既存のインデックス付きレコード タイプにフィールドを追加することはできません。そのようにするには、まずレコード タイプを削除してから、このオプションを使用してレコード タイプを再度追加してください。このプロシージャでは、レコード タイプを追加した後、そのレコード タイプの完全なインデックス付けを行う必要があります。 |
<removeRecordType> | 全文検索デプロイメントから削除するレコード タイプのリスト。 | このタグのデフォルト値は空になっています。このタグは、デプロイメントからインデックス付きレコード タイプを削除するために使用してください。 削除するレコード タイプの名前をこのタグに入力してください。Customer というレコード タイプを削除するには、その名前をこのタグに入力します。複数のレコード タイプを削除する場合は、区切り文字としてセミコロン (;) を使用します。例えば、2 つのレコード タイプを削除する場合は、Customer;NewRecord のように指定します。 |
<deleteFtsWASProfiles> | このタグを TRUE に設定すると、prep_upgd_was_profiles コマンド行オプションは、このホスト システム上の ClearQuest 全文検索 WebSphere Application Server プロファイルをすべてバックアップした後、削除します。この削除は、全文検索がデプロイされた ClearQuest のアップグレード、修正、再インストールの準備に必要です。 | このタグのデフォルト値は cqtsadmin.pl ツールによって自動生成され、FALSE に設定されます。ClearQuest をアップグレード、修正、または再インストールする場合は、この値を TRUE に設定してから、この 1 つの全文検索デプロイメントに対して、prep_upgd_was_profiles コマンド行オプションを実行してください。そうすると、コマンドは、このサーバー上のすべての全文検索デプロイメントに対してグローバルに作用します。 このタグの値は、2 つのいずれかの値 (TRUE かそれ以外の値)、または空白です。値を TRUE に設定して prep_upgd_was_profiles コマンド行オプションを指定すると、コマンドは、ClearQuest 全文検索 WebSphere Application Server プロファイルのバックアップ データを作成します。また、コマンドは、インストール後の復元タスクの復元の準備で、これらのプロファイルを削除します。 コマンドは、このサーバー上のすべての全文検索 WebSphere Application Server プロファイルに対してこのアクションを実行します。 ClearQuest のアップグレード、修正、再インストールを行った後、restore_was_profiles コマンド行オプションを使用して、削除されたすべての全文検索 WebSphere Application Server プロファイルを再作成します。 prep_upgd_was_profiles コマンド行オプションの実行後に、この 1 つの全文検索デプロイメントについて、このタグの値を FALSE にリセットして、誤って削除されないようにします。 重要: 他のすべてのタグおよびコマンドと異なり、このタグおよびコマンドは、グローバルで、このサーバー上のすべての全文検索デプロイメントに影響を与えます。この変更を行って、このサーバー上の任意の全文検索デプロイメントに対して prep_upgd_was_profiles コマンドを実行すると、このサーバー上のすべてのデプロイメントに影響を及ぼします。
|
<solrVersion> | このタグには、ClearQuest が現在サポートしている Apache Solr バージョンが含まれています。 | ClearQuest 全文検索管理機能ツールは、このタグの値を使用することによって、現在の Apache Solr バージョンと、新しいバージョンが使用できるかどうかを判別します。upgrade_solr_app コマンド行オプションを使用して Apache Solr アプリケーションをアップグレードする場合、このタグの値が更新されて、アップグレード後のバージョンが反映されます。
重要: IBM サポートからの指示がない限り、<solrVersion> タグの値は変更しないでください。このタグを修正することはできません。
|