cqtsadmin.pl は、IBM® Rational® ClearQuest® 全文検索をセットアップ、構成、管理するステップを自動化します。
概要
- cqperl cqtsadmin.pl --username superusername --password password --dbset dbset --userdb connectionname --ftshome cqftshome [options]
説明
cqtsadmin.pl スクリプトは、全文検索管理機能ツールの 2 つのコンポーネントのうちの 1 つです。もう 1 つのコンポーネントは cqtsadmin-dbset-userdb.xml で、これは cqtsadmin.pl スクリプトによって生成されます。cqtsadmin-dbset-userdb.xml ファイルは、全文検索デプロイメントに関するデータを提供して保持します。cqtsadmin-dbset-userdb.xml を編集して、デプロイメントを完了します。すべてのコマンド行オプションは Windows、UNIX、Linux のいずれの環境でも同様に機能します。ただし、UNIX または Linux で使用不可である scrub_oplog を除きます。
重要: cqtsadmin.pl コマンドを実行するには、
CQFTS_AppServer_HOME 環境変数を、WebSphere® Application Server がインストールされているディレクトリに設定する必要があります。
ClearQuest を既存の WebSphere Application プロファイルにインストールしている場合や、全文検索機能を、ClearQuest Web サーバーにリモート アクセスする別のシステムにインストールしている場合などでは、
CQFTS_AppServer_HOME 環境変数が設定されておらず、以下のようなエラーが表示されます。
WebSphere の AppServer ホームを判別できません。CQFTS_AppServer_HOME 環境変数を使用してこれを設定する方法については「ClearQuest Full-Text Search Administrator Guide」を参照してください。
この問題を解決するには、CQFTS_AppServer_HOME 変数を、WebSphere Application Server をインストールしたディレクトリに設定してください。例えば、変数を以下のように設定します。
- Windows オペレーティング システムの場合:
- set CQFTS_AppServer_HOME=C:¥Program Files¥IBM¥WebSphere¥AppServer
- UNIX システムおよび Linux オペレーティング システムの場合:
- setenv CQFTS_AppServer_HOME /opt/IBM/WebSphere/AppServer
重要: dbset、userdb、および ftshome に指定する引数は、大文字と小文字を区別します。
cqtsadmin.pl スクリプトの使用全体において、同じ大/小文字を指定する必要があります。そうしないと、全文検索デプロイメントが再構成されることがあります。
ftshome オプション
全文検索をデプロイしたりデプロイメントを参照したりするときには、必須コマンド行オプション ftshome、dbset、userdb の各引数によって、デプロイメント データがある場所を定義します。以下の例は、CQ.Search ディレクトリの D ドライブに新しい ClearQuest 全文検索デプロイメントを作成する方法を示しています。
このディレクトリは、存在しない場合には作成されます。前述のディレクトリ内に TextSearch_SAMPL サブディレクトリが作成されます。サブディレクトリ名は、ClearQuest データベース セット名および ClearQuest 論理ユーザー データベース名に基づいて生成されます。このサブディレクトリには、このデプロイメント用の全文検索データが入ります。
- 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
D:¥CQ.Search¥TextSearch_SAMPL ディレクトリの作成後、このディレクトリが TextSearch データベース セットおよび SAMPL ユーザー データベースの全文検索デプロイメントのロケーションになります。
このデプロイメントに関連するすべてのデータおよび設定値は、このディレクトリ内に作成されます。
また、それ以降に ftshome、dbset、および userdb 引数に同じ値を使用して実行するコマンドは、このディレクトリに適用されます。
2 番目の ClearQuest ユーザー データベースに全文検索をデプロイするには、その 2 番目の ClearQuest ユーザー データベースに関して必要なコマンド行オプションを指定します。追加の ClearQuest ユーザー データベースは、指定された ftshome 引数および生成されたサブディレクトリ構造に基づいた全文検索構成をデプロイします。
- 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
表 1. 全文検索デプロイメント ディレクトリ構造ディレクトリまたはファイル |
説明 |
ftshome¥dbset_userdb¥logs¥ |
このディレクトリには、このデプロイメントに対して実行した各コマンドのログが保持されます。このディレクトリを参照することにより、使用したコマンド、それらを使用した時期、およびそれらの状況に関する履歴を取得します。IBM ソフトウェア サポートは、問題に対処する際にこれらのログを調べます。
パスワードは、ログおよび画面出力ではアスタリスク (*) で表示され、プレーン テキストでは表示されません。 |
ftshome¥dbset_userdb¥Solr¥solr¥conf¥schema.xml |
このファイルは、インデックス付けおよび検索を行うフィールドを判別するために検索エンジンが使用する構成ファイルの 1 つです。cust_solr_files コマンドが実行されると、このファイル内のフィールドが、ご使用のエンティティ ファイルで指定されたレコード タイプ内のフィールドに一致するようにカスタマイズされます。 ClearQuest データベースが英語でない場合は、さらにカスタマイズするためにこのファイルを編集する必要があることもあります。詳しくは、英語以外のデータベースでの全文検索の有効化を参照してください。
|
ftshome¥dbset_userdb¥Solr¥solr¥data¥index¥ |
このディレクトリには、デプロイメントの実際のインデックスが保持されます。 重要: このディレクトリの内容は修正しないでください。ディレクトリを修正すると、デプロイメントの保全性が損なわれる恐れがあり、再インデックス付けまたは再デプロイメントが必要になることがあります。
|
ftshome¥dbset_userdb¥AboutThisFTS.txt |
このファイルは、全文検索の初期デプロイメントに 1 回生成されます。このファイルには、参照する必要があるかもしれないデプロイメントに関する情報が含まれています。IBM ソフトウェア サポートは、問題に対処する際にこのファイルを調べることがあります。 |
ftshome¥dbset_userdb¥CQ-dbset-userdb.xml |
このファイルは、ClearQuest 全文検索プロパティ XML ファイルです。このファイルには、バッチおよび更新インデックス付け、検索サーバー、接続プロファイル、レコード タイプ、インデックス付けおよび検索の対象フィールドに関するデータが保持されます。IBM ソフトウェア サポートは、問題に対処する際にこのファイルを調べます。 |
ftshome¥dbset_userdb¥cqtsadmin-dbset-userdb.xml |
このファイルには、全文検索管理機能構成が含まれています。このファイルには、ご使用のデプロイメントについてのデータが含まれます。ほとんどのデータはデプロイメント時に設定されますが、いくつかの設定値をカスタマイズするためにこのファイルの編集が必要になることがあります。IBM ソフトウェア サポートは、問題に対処する際にこのファイルを調べます。 |
ftshome¥dbset_userdb¥Entity-dbset-userdb.txt |
このエンティティ ファイルには、検索が有効になっているエンティティ タイプとそれらのフィールドのリストが含まれています。デプロイメント中に、検索の対象としないレコード タイプまたはフィールドを削除するために、このファイルの編集が必要になることがあります。デプロイメントの完了後は、このファイルを変更しないでください。IBM ソフトウェア サポートは、問題に対処する際にこのファイルを調べます。 |
各国語サポート
英語以外のオペレーティング システムで cqtsadmin.pl を使用するには、LANGUAGE システム環境変数を、以下のサポートされている値のいずれかに設定します。
- en 英語 (アメリカ合衆国; デフォルト)
- de ドイツ語 (ドイツ)
- fr フランス語 (フランス)
- it イタリア語 (イタリア)
- br ポルトガル語 (ブラジル)
- es スペイン語 (スペイン)
- cn 中国語 (簡体字) (中華人民共和国)
- hk 中国語 (繁体字) (香港特別行政区)
- tw 中国語 (繁体字) (台湾; 香港と同じ)
- ja 日本語 (日本)
- ko 韓国語 (韓国)
LANGUAGE にサポートされない値が指定されると、cqtsadmin.pl は失敗し、エラー メッセージが表示されます。
オプションと引数
cqtsadmin.pl スクリプトには、必須のコマンド行オプションと、任意指定のコマンド行オプションがあります。必須のコマンド行オプションは、cqtsadmin.pl スクリプトを実行するたびに指定する必要があります。必須選択オプションに指定したパラメータのいずれかが正しくない場合、このツールはエラー メッセージを出して終了します。このツールは、ユーザーが ClearQuest データベースに対して何らかのアクションを行う前に、ユーザー認証を行います。cqtsadmin.pl スクリプトを実行する場合には、少なくとも 1 つの任意指定のコマンド行オプションを指定する必要があります。
- 必須コマンド行オプション
- username superusername
- スーパーユーザー権限を持つ ClearQuest ユーザーの名前
- password password
- ClearQuest ユーザー パスワード
- dbset dbset
- ClearQuest データベース セット名。この値は大文字と小文字を区別します。
- userdb connectionname
- ClearQuest ユーザー データベース名。この値は大文字と小文字を区別します。
- ftshome cqftshome
- ClearQuest 全文検索ホーム ディレクトリ。このオプションは、このデプロイメントに関連するすべての構成ファイル、および Solr ファイル、設定値、Lucene インデックスを含みます。この値は大文字と小文字を区別します。
任意指定コマンド行オプション
任意指定コマンド行オプションは、ClearQuest 全文検索デプロイメントに対して特定のアクションを実行します。すべてのコマンドは、通知出力、進行状況出力、警告出力、エラー出力、および指示出力を生成します。指示出力は、エラー回復に役立ちます。表示される出力は、ログ ディレクトリにも記録されます。このログ データは、デプロイメントに対するアクションをデバッグまたはトレースする際に役立ちます。画面出力をファイルにリダイレクトする必要がないためです。通常、コマンドは失敗しません。失敗した場合、ほとんどのコマンドはすべての変更内容を元に戻します。変更内容を元に戻すことができない場合、エラー メッセージと共に、行うべきことに関する指示が表示されます。任意指定のコマンド行オプションは、複数回指定できます。複数の任意指定コマンド行オプションを指定した場合、それらのオプションはコマンド行に指定された順に実行されます。あるオプションが失敗すると、後続のコマンド評価および実行が停止し、このツールはエラー メッセージを出して終了します。任意指定コマンド行オプションは、通常使用されるオプションとまれにしか使用されないオプションの 2 つのカテゴリにグループ化することができます。
- add_record_type
- 概要
- 1 つ以上の新規レコード タイプをインデックスに追加します。このオプションは、コマンドが実行されている間、ClearQuest Web ユーザーに対して全文検索機能を一時的に使用不可にします。
新規レコード タイプおよびそれらに関連したフィールドのリストが、全文検索管理機能構成ファイル内にある <addRecordType> タグによって提供されます。
- 使用法
- 初期の全文検索デプロイメント時にレコード タイプを指定しなかった場合、または初期デプロイメント後に ClearQuest スキーマに新規レコード タイプを追加し、その新規レコード タイプで検索が行えるようにしたい場合は、このコマンド行オプションを使用してレコード タイプを追加します。既にインデックスが付けられているレコード タイプ内のフィールドを名前変更、追加、または削除する場合には、このコマンドを使用してください。変更をインデックスに反映するには、remove_record_type コマンドを実行してそのレコード タイプを削除してから、このコマンドを実行して再度追加してください。複数のレコード タイプを追加する場合は、分離文字としてセミコロンを使用してください。例えば、以下のコードは、Customer レコード タイプと Product レコード タイプを追加します。
<newValue
required="no">Customer=CustomerNum,address,phone,product;Product=name,version</newValue>
フィールド リストを指定せずにレコード タイプをリストすると、そのレコード タイプのすべてのフィールドが追加されます。
以下の例では、Customer レコード タイプと Product レコード タイプのすべてのフィールドが追加されます。
<newValue required="no">Customer;Product</newValue>
- 結果
- このコマンドは、ClearQuest 全文検索インデックス、ClearQuest 全文検索プロパティ XML ファイル、エンティティ ファイル、および Solr schema.xml ファイルに影響します。このコマンドを実行する前に、デプロイメントをバックアップしてください。このオプションは、オフピーク時に実行してください。
この操作は時間かかり、全文検索が短時間ダウンするためです。
- ステートフル状況
- このコマンドはステートフルです。このコマンドがいずれかの実行ポイントで失敗した場合には、問題を修正して、コマンドを再実行することができます。操作は停止した箇所から続行されます。障害発生時には、実行すべき作業がエラー メッセージによって指示されます。
- 例
- Customer という新規レコード タイプを追加する必要があるとします。
- cqtsadmin-TextSearch-SAMPL.xml ファイルを編集して、<addRecordType> タグを変更します。
<newValue required="no">Customer=CustomerNum,address,phone,product</newValue>
- バックアップを作成します。
cqperl cqtsadmin.pl --username admin
--password "" --dbset TextSearch --userdb SAMPL --ftshome D:¥CQ.Search
--backup_fts E:¥FTSBackup
- 新規レコード タイプを追加します。
cqperl cqtsadmin.pl --username
admin --password "" --dbset TextSearch --userdb SAMPL --ftshome D:¥CQ.Search
--add_record_type
- cqtsadmin-TextSearch-SAMPL.xml ファイルを編集して、<addRecordType> タグに関して追加した内容を削除します。このステップは、基本的にはクリーンアップ タスクです。
- archive_fts
- 概要
- ClearQuest 全文検索デプロイメントを保存します。これを使用すると、アクティブな全文検索デプロイメントは使用不可になり、デプロイされた WebSphere Application Server プロファイルが削除されます。すべての構成データおよびインデックスは保存されます。このオプションを使用して、新しい構成で再始動し、古い構成を参照することができます。
- 使用法
- このコマンド行オプションは、デプロイメントを新規に開始するか、デプロイメントの全文検索機能が不要になった場合に使用します。このコマンド行オプションは、全文検索のサービスを停止して、サービスやファイルなど、関係するすべてのリソースをアーカイブします。アーカイブ後のデプロイメントは参照することができます。
注: 将来復元を計画している場合は、このコマンド行オプションを使用しないでください。代わりに prep_upgd_was_profiles コマンド行オプションを使用してください。
- 結果
- このコマンド行オプションを実行すると、全文検索が無効になります。また、WebSphere Application Server でこのデプロイメントに対して使用および設定していたすべてのファイル、リソース、設定が削除されます。ftshome にあるデプロイメント データは元のまま残されますが、dbset_userdb.Archived-time-stamp へと名前変更されます。
- ステートフル状況
- このオプションはステートフルではありません。このコマンドがいずれかの実行ポイントで失敗した場合には、アーカイブ作業を手動で完了させる必要がある場合があります。エラーからの復旧方法については、進行状況レポートおよびエラー メッセージの指示に従ってください。
- 例
- 以下の例は、デプロイメントを保存する方法を示しています。
cqperl
cqtsadmin.pl --username admin --password "" --dbset TextSearch --userdb
SAMPL --ftshome D:¥CQ.Search --archive_fts
スクリプトの実行後、保存された全文検索デプロイメントは D:¥CQ.Search¥TextSearch_SAMPL.Archived-time-stamp という名前になります。
- backup_fts destination
- 概要
- ClearQuest 全文検索デプロイメントのバックアップ コピーを作成します。バックアップを作成すると、バックアップからデータをリカバリーしたり、デプロイメント全体をリカバリーしたりすることができます。既存のデプロイメントを大幅に変更するコマンドを実行する場合は、事前にバックアップを作成することをお勧めします。デプロイメントをバックアップする前に、ftshome にあるデプロイメントが使用しているディスク スペースと同容量のディスク スペースをバックアップ先に確保してください。
- 使用法
- レコード タイプを追加または更新する場合、または組織の方針により定期的なバックアップを保守する必要がある場合に、このコマンドを使用してバックアップを作成します。
注: このコマンドは、同じく各ユーザー データベースの WebSphere Application Server プロファイルのバックアップを処理する prep_upgd_was_profiles コマンド行オプションの代わりに使用しないでください。
- 結果
- このコマンドは、バックアップの実行中、更新モードのインデクサを一時的に使用不可にします。
そのため、バックアップの実行中は、全文検索が最新の状態でない可能性があります。所要時間は、インデックスのサイズ、ハード ディスクの速度、およびネットワーク (LAN または WAN 上でバックアップを行う場合) によって異なります。
- ステートフル状況
- このオプションはステートフルではありません。このコマンドがいずれかの実行ポイントで失敗した場合には、失敗のタイプおよび受け取ったエラー メッセージに応じて、バックアップを手動で完了させるか、再実行する必要があります。失敗の原因として最も可能性が高いのは、宛先装置のディスク スペース不足です。バックアップ中にデプロイメントのデータが変更されることはありません。
- 例
- 新規のレコード タイプを追加する前に、デプロイメントのバックアップを作成する必要があります。
cqperl cqtsadmin.pl --username admin
--password "" --dbset TextSearch --userdb SAMPL --ftshome D:¥CQ.Search
--backup_fts E:¥FTSBackup
スクリプトの実行後、保存された全文検索デプロイメントは E:¥FTSBackup¥TextSearch_SAMPL.Backup-time-stamp という名前になります。
- clear_state
- 概要
- cqtsadmin.pl ツール プロシージャの状態をリセットし、状態がなくなるようにします。実際に、ツールがどのような状態であっても (不完全な状態であっても)、クリアされます。
- 使用法
- このコマンド行オプションは、ステートフル コマンドの状態をクリアして、他のコマンドを実行したり、そのステートフル コマンドを再実行したりできるようにするために使用します。いつ状態をクリアするかは、クリアするステートフル コマンド、そのステートフル コマンドが最後に置かれていた状態、受け取ったエラー メッセージおよび修正の指示によって異なります。
- 結果
- このコマンド行オプションの実行の影響は、どのステートフル コマンドが停止したのか、および停止する前にそのコマンドがどこまで実行されていたのかによって異なります。ログおよびエラー メッセージに、状態をリセットできるかどうかが示されます。
- ステートフル状況
- このオプションはステートフルではありません。入出力エラーが発生しない限り、このコマンドが失敗することはありません。
- 例
- エラー メッセージの指示に従ってステートフル アクションの状態をクリアし、リカバリー不能エラーから復旧できるようにする必要があります。
cqperl cqtsadmin.pl --username admin --password
"" --dbset TextSearch --userdb SAMPL --ftshome D:¥CQ.Search --clear_state
- copy_fts_template
- 概要
- ClearQuest 全文検索のデフォルト テンプレートをコピーし、設定します。まだ全文検索が有効になっていないデータベースに全文検索をデプロイする際には、新規のデフォルト テンプレートから作業を開始し、これを ftshome ディレクトリにコピーする必要があります。このコマンドを既存のデプロイメントに対して使用しようとすると、失敗してエラーが出されます。
- 使用法
- 通常、このコマンド行オプションは init_cq_fts コマンド行オプションを実行した際に呼び出されるため、直接使用する必要はありません。このコマンド行オプションは、デプロイメントを微調整またはデバッグする必要がある場合に指定します。
- 結果
- このコマンド行オプションは、全文検索機能に必要なデフォルト データを、指定された ftshome ディレクトリにコピーします。
- ステートフル状況
- このオプションはステートフルではありません。入出力エラーが発生しない限り、このコマンドが失敗することはありません。
- 例
- IBM Rational クライアント サポートから、このコマンドを実行して、デプロイメントに関する問題をデバッグするか、デプロイメントをカスタマイズするように指示されました。
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 }
- 概要
- ClearQuest 全文検索 WebSphere Application Server プロファイルを作成します。すべての新規デプロイメントで実行する必要があります。
- 使用法
各 ClearQuest 全文検索デプロイメントには、独自の WebSphere Application Server プロファイルが必要です。つまり、ClearQuest 全文検索が有効なユーザー データベースごとに 1 つの WebSphere Application Server プロファイルが必要です。
このパラメータ値は、Windows オペレーティング システム デプロイメント用の Windows サービス状況を構成するためにのみ使用します。この値は、UNIX および Linux オペレーティング システムでは無視されます。UNIX および Linux では、ブート時にデーモンとして開始する WebSphere Application Server プロファイルを構成する必要があります。
WebSphere Application Server プロファイル名は、データベース セットおよびユーザー データベースの名前から決定されます。ただし、これは <ftsWASProfileName> タグを使用してオーバーライドできます。
fts_was_profile_home コマンド行オプションを使用して、WebSphere Application Server プロファイルを作成するロケーションを指定してください。
ロケーションを指定しない場合は、デフォルトのロケーション %CLEARQUEST_HOME%/cqweb/ が使用されます。
なるべく、独自のロケーションを指定することをお勧めします。
注: このコマンド行オプションは常に init_cq_fts コマンド行オプションとともに使用して、ユーザーの ClearQuest 全文検索デプロイメントに基づいて WebSphere Application Server プロファイルの作成およびカスタマイズが行われるようにする必要があります。そうしないと、以前にこのツールを使用して作成されている WebSphere Application Server プロファイルが再使用される場合を除き、デプロイメントが失敗します。
- 結果
- このコマンド行オプションは、使用可能な次のポートを使用して、WebSphere Application Server の下に新規の WebSphere Application Server プロファイルを作成します。操作完了後のディスク スペース使用量は約 200 MB です。Windows でプロファイルを [自動] に設定すると、Windows のリスタート時にサービスが自動的に開始されます。
- ステートフル状況
- このオプションはステートフルではありません。入出力エラーが発生しない限り、このコマンドが失敗することはありません。
- 例
- 2 番目のユーザー データベースに全文検索をデプロイする予定であるとします。データベース セット名は MASTR、ユーザー データベース名は SAMPL です。
- 以下のコマンドを実行して、初期デプロイメントをセットアップします。
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
- 必要なレコード タイプおよびフィールドのみが含まれるようにエンティティ ファイルを変更します。
- 以下のコマンドを実行して、デプロイメントを完了します。
cqperl
cqtsadmin.pl --username admin --password "" --dbset MASTR --userdb
SAMPL --ftshome D:¥CQ.Search --setup_cq_fts
- cust_fts_files
- 概要
- ユーザー データベース、エンティティ ファイル、および全文検索管理機能構成ファイルに基づいて、ClearQuest 全文検索プロパティ XML ファイルをカスタマイズします。ClearQuest 全文検索を最初にデプロイする際に、全文検索プロパティ ファイル CQ-dbset-userdb.xml をカスタマイズする必要があります。
- 使用法
- 全文検索のデフォルト テンプレートには、ユーザー データベースに基づいてカスタマイズされる汎用設定値が含まれています。カスタマイズする必要がある 1 つのファイルが、全文検索プロパティ XML ファイルです。このファイルには、エンティティ ファイルの指定内容に基づいて、すべてのレコード タイプおよびそれらのフィールドのリストが保持されています。また、このファイルには、表示フィールドとして使用するフィールド、ClearQuest ユーザー データベースに対する変更の検査頻度、ClearQuest のデータベースおよびサーバーとの通信方法などのパラメータが含まれています。通常、このコマンド行オプションは setup_cq_fts コマンド行オプションを実行した際に呼び出されるため、直接使用する必要はありません。このコマンド行オプションは、デプロイメントを微調整またはデバッグする必要がある場合に指定します。
- 結果
- デプロイメントに対してこのコマンド行オプションを使用すると、CQ-dbset-userdb.xml ファイルが上書きされます。手動またはコマンドの実行によりファイルに行われたすべての変更が失われます。
- ステートフル状況
- このオプションはステートフルではありません。入出力エラーが発生しない限り、このコマンドが失敗することはありません。
- 例
- IBM ソフトウェア サポートから、全文検索のデプロイメントに関する問題をデバッグするか、デプロイメントをカスタマイズするように指示されました。
cqperl
cqtsadmin.pl --username admin --password "" --dbset TextSearch --userdb
SAMPL --ftshome D:¥CQ.Search --cust_fts_files
- cust_solr_files
- 概要
- ClearQuest 全文検索を最初にデプロイする際に、現在の ClearQuest エンティティ ファイルに基づいた Solr スキーマ ファイルをカスタマイズする必要があります。
- 使用法
- 全文検索のデフォルト テンプレートは汎用的なもので、デフォルト設定値が含まれており、これらの値をユーザー データベースに基づいてカスタマイズする必要があります。カスタマイズする必要がある 1 つのファイルが、Solr schema.xml ファイルです。このファイルには、エンティティ ファイルを使用して検索対象として設定したすべてのレコード タイプのすべてのフィールドが含まれています。通常、このコマンド行オプションは setup_cq_fts コマンド行オプションを実行した際に呼び出されるため、直接使用する必要はありません。このコマンド行オプションは、デプロイメントを微調整またはデバッグする必要がある場合に指定します。
- 結果
- このコマンド行オプションは、エンティティ ファイルからデータを読み取り、Solr schema.xml ファイルをカスタマイズします。既存のデプロイメントに対してこのオプションを使用すると、schema.xml ファイルがリファクタリングされます。
初期デプロイメント後にエンティティ ファイルを変更した場合、前の値は失われます。
- ステートフル状況
- このオプションはステートフルではありません。入出力エラーが発生しない限り、このコマンドが失敗することはありません。
- 例
- IBM ソフトウェア サポートから、全文検索のデプロイメントに関する問題をデバッグするか、デプロイメントをカスタマイズするように指示されました。
cqperl cqtsadmin.pl --username admin --password
"" --dbset TextSearch --userdb SAMPL --ftshome D:¥CQ.Search --cust_solr_files
- delete_fts_was_profile
- 概要
- WebSphere Application Server プロファイルを削除する場合、または再始動する場合に、このコマンド行オプションを実行します。これは、この ClearQuest 全文検索デプロイメントに関連する ClearQuest 全文検索 WebSphere Application Server プロファイルを削除します。このオプションは、WebSphere Application Server プロファイルのみが削除される archive_fts とは異なります。ただし、全文検索ホーム ディレクトリおよび関連するメタデータは削除されません。
ClearQuest 全文検索デプロイメントを完全に削除する場合は、archive_fts オプションを使用してください。
- 使用法
- 通常、このコマンドは archive_fts コマンド行オプションの実行時に呼び出されるため、直接使用しないでください。このコマンドは、デプロイメントを微調整またはデバッグする必要がある場合に指定します。
- 結果
- この WebSphere Application Server プロファイルに関して WebSphere によって使用されているリソースが解放されます。disable_cqweb_fts コマンド行オプションによって ClearQuest Web 全文検索が無効にされなかった場合、全文検索による検索結果はエラーになります。
- ステートフル状況
- このオプションはステートフルではありません。入出力エラーが発生しない限り、このコマンドが失敗することはありません。
- 例
- WebSphere Application Server プロファイルの名前またはロケーションを変更する必要がありますが、全文検索ソリューションを完全に再デプロイする必要があるわけではありません。
- WebSphere Application Server プロファイルを削除します。
cqperl cqtsadmin.pl --username admin --password
"" --dbset TextSearch --userdb SAMPL --ftshome D:¥CQ.Search --delete_fts_was_profile
- cqtsadmin-dbset-userdb.xml ファイルを編集し、WebSphere Application Server プロファイルの名前を自動的に生成されたデフォルト名から新しい名前に変更するために <ftsWASProfileName> タグを変更します。この名前は固有でなければなりません。そうでないと、コマンドは失敗します。
- 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
- この WebSphere Application Server プロファイルのポート番号も変更する予定である場合は、前述のステップ 3 を行う前に、cqtsadmin-dbset-userdb.xml ファイルを編集して <ftsWASProfilePort> タグ内のポート番号を更新します。あるいは、以下のコマンドを実行して、ポートを再定義します。
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
- 概要
- このコマンド行オプションは、ClearQuest Web の [全文] ラジオ ボタンを無効にし、レプリカが作成されていない ClearQuest ユーザー データベースでの操作ログ (oplog) の記録を停止します。このコマンド行オプションは、レプリカが作成されている環境の oplog 作成には無効です。
重要: このコマンド行オプションは注意して使用してください。このコマンドは、ClearQuest データベースのレプリカが作成されていない場合に oplog の記録を使用不可にします。
oplog が生成されていない場合に ClearQuest レコードが変更されても、変更されたレコードは再インデックス付けされません。ユーザー データベース全体の再インデックス付けを行う必要があります。全文検索機能が再度有効になるまで、ユーザーが ClearQuest にアクセスできないようにするか、または読み取り専用操作のみを許可するようにしてください。
- 使用法
- テスト環境で作業する場合や、IBM ソフトウェア サポートから指示された場合を除いて、このコマンドを使用する必要はありません。
- 結果
- データベースのレプリカが作成されていない場合は、oplog の生成が停止し、[全文] ラジオ ボタンが無効になります。
- ステートフル状況
- このオプションはステートフルではありません。入出力エラーが発生しない限り、このコマンドが失敗することはありません。
- 例
- IBM Rational クライアント サポートから、問題の解決のために全文検索を無効にするように指示されました。
cqperl
cqtsadmin.pl --username admin --password "" --dbset TextSearch --userdb
SAMPL --ftshome D:¥CQ.Search --disable_cqweb_fts
- enable_cqweb_fts
- 概要
- ClearQuest Web で [全文] ラジオ ボタンを使用できるようにします。ClearQuest データベースのレプリカが作成されておらず、そのデータベースが機能レベル 7 である場合は、oplog の生成も有効になります。ClearQuest ユーザー データベースのレプリカが作成されている場合、oplog の生成に変更はありません。デプロイメントが適切に構成されていない場合、全文検索を使用しようとするユーザーはエラー メッセージを受け取ります。
- 使用法
- テスト環境で作業する場合や、IBM ソフトウェア サポートから指示された場合を除いて、このコマンドを使用する必要はありません。
- 結果
- データベースのレプリカが作成されておらず、そのデータベースが機能レベル 7 である場合は、oplog の生成が開始されます。ClearQuest Web の [全文] ラジオ ボタンが有効になります。
- ステートフル状況
- このオプションはステートフルではありません。入出力エラーが発生しない限り、このコマンドが失敗することはありません。
- 例
- IBM ソフトウェア サポートから、問題の解決のために全文検索を有効にするように指示されました。
cqperl
cqtsadmin.pl --username admin --password "" --dbset TextSearch --userdb
SAMPL --ftshome D:¥CQ.Search --enable_cqweb_fts
- fresh_batch_idx
- 概要
- このコマンド行オプションは、初期インデックス付けの後、バッチ モードで完全な再インデックス付けが行えるようにします。
バッチ モードのインデックス付けは、検索用に構成されているすべての ClearQuest レコードを読み取って、それらのレコードのデータをインデックス付けのために検索エンジン (Solr) に送信するプロセスです。バッチ モードのインデックス付けは、setup_cq_fts コマンド行オプションの実行の一環として実行されます。このコマンドを実行する前に、stop_update_idx コマンド行オプションを実行して更新モードのインデクサを停止してください。そうしないと、更新モードのインデクサによってインデックス付けされた、より新しいレコードのデータが、バッチ モードのインデクサによって置き換えられる可能性があります。再インデックス付けが完了した時点では、インデックスがフラグメント化されています。通常、このフラグメント化が検索のパフォーマンスに影響することはありません。しかし、インデックスのサイズは、最大で現行サイズの 2 倍まで大きくなることがあります。インデックスを最適化してそのサイズを縮小するには、optimize_idx コマンド行オプションを実行します。
- 使用法
- テスト環境で作業する場合や、IBM ソフトウェア サポートから指示された場合を除いて、このコマンドを使用する必要はありません。
- 結果
- 検索インデックスが更新されます。そのサイズが、最大で現行サイズの 2 倍まで大きくなります。したがって、このコマンドを使用する際には、事前に十分なディスク スペースがあるか確認してください。再インデックス付け中に、更新モードのインデクサが使用できないために、検索結果が完全でない場合があります。
- ステートフル状況
- このオプションはステートフルではありません。入出力エラーが発生しない限り、このコマンドが失敗することはありません。
- 例
- IBM ソフトウェア サポートから、検索可能なレコードの完全な再インデックス付けを実行するように指示されました。
- 更新モードのインデクサを停止します。
cqperl cqtsadmin.pl --username admin --password "" --dbset TextSearch --userdb SAMPL --ftshome D:¥CQ.Search --stop_update_idx
- バッチ モードの再インデックス付けを行います。
cqperl cqtsadmin.pl --username admin --password "" --dbset TextSearch --userdb SAMPL --ftshome D:¥CQ.Search --fresh_batch_idx
- インデックスの最適化を実行します。
cqperl cqtsadmin.pl --username
admin --password "" --dbset TextSearch --userdb SAMPL --ftshome D:¥CQ.Search
--optimize_idx
- 更新モードのインデクサを有効にします。
cqperl cqtsadmin.pl --username admin --password "" --dbset TextSearch --userdb SAMPL --ftshome D:¥CQ.Search --start_update_idx
注: これらのステップは 1 つのコマンドに結合することができます。再インデックス付けするレコードの数が多い場合、この操作には長い時間がかかるため、次のようにすると便利です。
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
- 概要
- 更新モードのインデクサにより、記録されたすべての oplog レコード変更の完全な再インデックス付けが行われるようにします。このオプションは慎重に使用してください。更新モード インデクサは、単一スレッドで実行されます。この操作は、特に ClearQuest データベースに多数の oplog が含まれている場合には時間がかかります。
更新モードのインデックス付けは、ClearQuest データベースで、検索用に構成されたレコード タイプへの変更をモニターするプロセスです。このモニターは、ClearQuest データベースの oplog を検査することによって実行されます。更新モードのインデックス付けは、setup_cq_fts コマンド行オプションの一環として有効になります。fresh_batch_idx コマンド行オプションと異なり、このコマンドでは更新モードのインデクサを停止する必要はありません。データが追加されたインデックスに対してこのコマンドが実行された場合、インデックスはフラグメント化されます。通常、このフラグメント化が検索のパフォーマンスに影響することはありません。しかし、インデックスのサイズは、最大で現行サイズの 2 倍まで大きくなることがあります。インデックスを最適化してそのサイズを縮小するには、optimize_idx コマンド行オプションを実行します。更新モードのインデクサを最初に記録された oplog から開始するかどうかは慎重に検討してください。特に、一貫して oplog を消去していなかった場合には、時間とともに、ClearQuest レコードで実行されたすべてのアクションに関する oplog を収集することになるため、最初に記録された oplog からのインデックス付けは好ましくない場合があります。このコマンドは、テスト環境で使用することや、IBM Rational クライアント サポートとともに全文検索デプロイメントの問題をデバッグすることを目的にしています。
- 使用法
- テスト環境で作業する場合や、IBM ソフトウェア サポートから指示された場合を除いて、このコマンドを使用する必要はありません。
- 結果
- 検索インデックスが更新されます。そのサイズが、最大で現行サイズの 2 倍まで大きくなることもあります。したがって、このコマンドを使用する前に、十分なディスク スペースを確保する必要があります。
- ステートフル状況
- このオプションはステートフルではありません。入出力エラーが発生しない限り、このコマンドが失敗することはありません。
- 例
- IBM ソフトウェア サポートから、更新モードのインデクサによる再インデックス付けを強制実行するように指示されました。
cqperl
cqtsadmin.pl --username admin --password "" --dbset TextSearch --userdb
SAMPL --ftshome D:¥CQ.Search --fresh_update_idx
- fts_was_profile_home destination
- 概要
- このコマンド行オプションを create_fts_was_profile コマンド行オプションと共に使用することで、この ClearQuest 全文検索デプロイメントの WebSphere Application Server プロファイルが作成される場所を指定します。
このオプションを省略すると、デフォルトのロケーション ${CLEARQUEST_HOME}/cqweb/ が使用されます。
しかし、ClearQuest インストール ディレクトリ内に作成される追加ファイルが ClearQuest インストール済み環境のアンインストールやアップグレードなどの妨げになる可能性があるため、デフォルトのロケーションは、常に適切であるとは限りません。
このコマンド行オプションは、restore_was_profile コマンド行オプションとともに使用することもできます。
全文検索 WebSphere Application Server プロファイルが作成されるオリジナルのロケーションとは異なるロケーションを指定できます。
- 使用法
- ClearQuest データベースの ClearQuest 全文検索をデプロイします。その際に、デプロイメントに関連した WebSphere ファイルの作成および保存にデフォルトのロケーションを使用しないようにします。
このコマンド行オプションを create_fts_was_profile コマンド行オプションとともに使用して、全文検索 WebSphere Application Server プロファイルを作成する場所を指定します。
このマシン上に複数の全文検索デプロイメントがある場合は、すべてに同じロケーションを使用して、WebSphere Application Server プロファイルがすべて同じロケーションにあるようにします。
- 結果
- ディレクトリが存在しない場合は、fts_was_profile_home ロケーションにディレクトリが作成されます。
このディレクトリには、WebSphere Application Server プロファイルに関するデータが含まれます。このディレクトリ内にサブディレクトリが作成されます。これは、WebSphere Application Server プロファイル名を表す、cqsearchprofile_dbset_userdb または cqfts_dbset_userdb という名前です。
- ステートフル状況
- このオプションはステートフルではありません。このコマンドは、入出力エラーがある場合、またはパスが無効である場合 (存在しないドライブ名や存在しない Unix または Linux マウント パスなど) を除き、失敗することはありません。
- 例
- ClearQuest 全文検索をデプロイする必要があります。
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
- 概要
- IBM ソフトウェア サポートによる、潜在的な ClearQuest 全文検索の問題の診断に役立つデータを収集します。サポートが必要な場合は、この診断コマンド行オプションを実行し、このコマンド行オプションで収集したデータを送信して、支援が円滑に行われるようにします。
このコマンド行オプションは、ClearQuest 全文検索デプロイメントに関連するデータを収集します。データはディレクトリ内にコピーされます。このデータは、IBM ソフトウェア サポートに送信するように指示されることがあります。データを送信する前に、そのデータに機密情報が含まれていないことを確認してください。通常、最も機密度の高いデータは、検索を有効にしたレコード タイプ名、および組織で実行された検索用語の履歴です。履歴は、ご使用の WebSphere Application Server プロファイルのために WebSphere が保持するログです。パスワードは、出力が画面またはログ ファイルに送信される際にアスタリスクに変換されます。これらが非暗号化テキストとして保管されることはありません。
- 使用法
- このコマンドは、全文検索に関する問題を診断しやすくするために、診断データを収集して、IBM ソフトウェア サポートに送信する際に使用します。
- 結果
- データまたは構成設定が変更されることはありません。デプロイメントとタイム スタンプからなる名前の新規ディレクトリが作成されます。診断データの累積サイズはデプロイメント内のログの合計サイズによって変わりますが、通常は MB (メガバイト) 単位です。実際のインデックスは診断データに含まれません。
- ステートフル状況
- このオプションはステートフルではありません。入出力エラーが発生しない限り、このコマンドが失敗することはありません。
- 例
- IBM ソフトウェア サポートから、全文検索に関する問題を解決しやすくするために診断データを送信するように指示されました。以下のコマンドにより診断データが作成され、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
- 概要
- このコマンド行オプションは、エンティティ ファイルを生成します。このエンティティ ファイルには、ClearQuest データベースに送信可能なすべてのレコード タイプが含まれます。デフォルトでこのエンティティ ファイルには、ClearQuest スキーマのすべてのレコード タイプおよびそれらのすべてのフィールドが含まれています。これらが、全文検索の対象となります。このファイルをカスタマイズして、インデックスを付けたいレコード タイプおよび関連フィールドのみが選択されるようにすることができます。ClearQuest ユーザー データベースに対して初めて全文検索をデプロイする際には、ClearQuest ユーザー データベースのスキーマが参照するすべてのレコード タイプおよびそれらのフィールドを保持するエンティティ ファイルが必要です。このエンティティ ファイルを入力として使用して、全文検索プロパティ XML ファイル、Solr 中間 XML ファイル、Solr schema.xml ファイルが生成されます。
- 使用法
- 通常、このコマンドを直接使用する必要はありません。これは init_cq_fts コマンド行オプションを実行した際に呼び出されます。このコマンドは、デプロイメントを微調整またはデバッグする必要がある場合に指定します。
- 結果
- 既存のデプロイメントに対してこのコマンドを使用すると、Entity-dbset-userdb.txt ファイルが上書きされ、行った編集内容が失われます。
- ステートフル状況
- このオプションはステートフルではありません。入出力エラーが発生しない限り、このコマンドが失敗することはありません。
- 例
- IBM Rational ソフトウェア サポートから、全文検索のデプロイメントに関する問題をデバッグするか、デプロイメントをカスタマイズするように指示されました。
cqperl cqtsadmin.pl --username admin --password
"" --dbset TextSearch --userdb SAMPL --ftshome D:¥CQ.Search --gen_entity_file
- gen_fts_files
- 概要
- このコマンド行オプションは、ユーザー データベース、エンティティ ファイル、および全文検索管理機能構成ファイルに基づいて、ClearQuest 全文検索セットアップ ファイルを生成します。ユーザー データベースに全文検索を最初にデプロイする際には、全文検索のプロパティ XML ファイルを生成する必要があります。このファイルには、インデックス付けの頻度、インデックス付けのバッチ サイズ、検索サーバー情報など、デプロイメント設定に関する情報が保持されています。
- 使用法
- 通常、このコマンド行オプションを直接使用することはありません。これは setup_cq_fts コマンド行オプションを実行した際に呼び出されます。このコマンド行オプションは、デプロイメントを微調整またはデバッグする必要がある場合に指定します。
- 結果
- 既存のデプロイメントに対してこのコマンドを使用すると、Entity-dbset-userdb.txt、Solr-dbset-userdb.txt、および CQ-dbset-userdb.xml ファイルが上書きされ、それらに対して行った編集内容が失われます。
- ステートフル状況
- このオプションはステートフルではありません。入出力エラーが発生しない限り、このコマンドが失敗することはありません。
- 例
- IBM Rational ソフトウェア サポートから、全文検索のデプロイメントに関する問題をデバッグするか、デプロイメントをカスタマイズするように指示されました。
cqperl cqtsadmin.pl --username admin --password
"" --dbset TextSearch --userdb SAMPL --ftshome D:¥CQ.Search --gen_fts_file
- help
- 概要
- ヘルプ テキストを表示した後、閉じます。
- 使用法
- cqtsadmin.pl スクリプトについての知識はありますが、使用可能なコマンドについて簡単に確認する必要があります。
- 結果
- なし。このコマンドは、どのデータも変更しません。コマンドを実行するための認証も不要です。
- ステートフル状況
- このオプションはステートフルではありません。入出力エラーが発生しない限り、このコマンドが失敗することはありません。
- 例
- 使用可能なコマンドのリストを表示します。
cqperl cqtsadmin.pl --help
- init_cq_fts
- 概要
ClearQuest 全文検索のデフォルト テンプレートをコピーし、デフォルトのエンティティ ファイルを生成します。実際は、
copy_fts_template と
gen_entity_file オプションの両方を実行します。このコマンドは、全文検索をデプロイする際に実行する最初のコマンドの 1 つです。このコマンドは、
ftshome ディレクトリ内に
dbset_userdb ディレクトリを作成します。
このデプロイメントに関連するすべてのデフォルトのデータおよび設定が、このディレクトリに配置されます。このコマンドで作成される重要なファイルの 1 つが、
Entity-dbset-userdb.txt エンティティ ファイルです。このファイルは、
ftshome ディレクトリに配置されます。
デプロイメントをカスタマイズする際には、それをそのまま使用するか、検索対象から外すレコード タイプおよびフィールドを削除するかを判断します。作成されるもう 1 つのファイルが、
cqftsadmin-dbset-userdb.xml 全文検索管理機能構成ファイルです。このファイルには、サーバー名、WebSphere Application Server プロファイル名、インデックス付けのバッチ サイズ、インデックス付けの頻度など、使用しているデプロイメントおよび環境に固有の追加のデフォルト設定が保持されています。
注: このコマンド行オプションは、通常、create_fts_was_profile および fts_was_profile_home コマンド行オプションとともに実行し、このデプロイメントに対して WebSphere Application Server プロファイルが新規作成されるようにします。そうしないと、以前に全文検索用にデプロイされた WebSphere Application Server プロファイルを再使用しない限り、ClearQuest 全文検索デプロイメントは失敗します。
- 使用法
- このコマンドは、全文検索のデプロイメントを事前構成するために使用します。ftshome ディレクトリが作成され、そこにデフォルトのファイルがコピーされて、デフォルト値が設定されます。通常は、デプロイメントを完了する前に、エンティティ ファイルをカスタマイズします。
- 結果
- このコマンドにより新規の ftshome ディレクトリが作成され (存在しない場合)、デプロイメントのデフォルトのデータおよび設定がその中にコピーされます。
- ステートフル状況
- このオプションはステートフルではありません。入出力エラーが発生しない限り、このコマンドが失敗することはありません。
- 例
- ユーザー データベースの 1 つに対して全文検索のデプロイメントを新規に開始する必要があります。
- 次のコマンドを実行して、デプロイメントを事前構成します。
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
- このデプロイメントのエンティティ ファイルを編集して、検索可能にしないレコード タイプまたはフィールドを削除します。さらに、各レコード タイプのフィールドの前にアンパーサンド (&) を追加します。これが、全文検索で一致する結果セットの表示フィールドになります。
D:¥CQ.Search¥TextSerch_SAMPL¥Entity-TextSearch-SAMPL.txt
- 以下のコマンドを実行して、デプロイメントを完了します。
cqperl
cqtsadmin.pl --username admin --password "" --dbset TextSearch --userdb
SAMPL --ftshome D:¥CQ.Search --setup_cq_fts
- lock_cq_fts
- 概要
このコマンド行オプションは、この ClearQuest 全文検索デプロイメントをロックし、破壊的な悪影響を及ぼさない cqtsadmin.pl コマンドのみを実行できるようにします。gather_diagnostic_data と help 以外のすべてのコマンドは使用不能になります。コマンドを再度使用可能にするには、unlock_cq_fts オプションを使用してください。
- 使用法
- 全文検索をデプロイした後に、このコマンドを実行してデプロイメントをロックし、誤って変更されないようにします。このロックの強度は高くありません。適切なファイル システム アクセス権限または ClearQuest 権限を持っていれば、だれでもデプロイメントをアンロックできます。このコマンドの目的は、デプロイメントが完了していることを管理者に示すことです。デプロイメント後に変更する場合は、通知する必要があり、注意して処理する必要があります。
- 結果
- なし。全文検索デプロイメントのデータおよび設定に影響することはありません。
- ステートフル状況
- このオプションはステートフルではありません。入出力エラーが発生しない限り、このコマンドが失敗することはありません。
- 例
- デプロイメントが完了したため、デプロイメントが変更されないようにする必要があります。
cqperl cqtsadmin.pl --username admin --password
"" --dbset TextSearch --userdb SAMPL --ftshome D:¥CQ.Search --lock_cq_fts
- optimize_idx
- 概要
このコマンド行オプションは、インデックスをデフラグします。最適化を成功させるためには、少なくとも現在のインデックス サイズの 1.5 倍の空きディスク スペースが必要です。例えば、インデックスが 2 GB のディスク スペースを使用している場合、このコマンドを実行するためには 3 GB の空きディスク スペースがなければなりません。
- 使用法
検索インデックスにレコードを追加したり変更したりすると、フラグメント化が発生することがあります。フラグメント化されたインデックスは、フラグメント化されていないインデックスよりも大きくなる傾向があります。また、若干パフォーマンスが低下する可能性があります。インデックスのサイズを縮小してパフォーマンスを回復させるには、少なくとも年に 1 回インデックスを最適化してください。ClearQuest データベースでレコードの変更、追加、削除によるアクティビティが大量に発生する場合には、これよりも高い頻度で最適化を行ってください。
このコマンドを実行する場合は、事前に十分な空きディスク スペースを確保してください。そうしないと、最適化が失敗しますが、元のインデックスには影響はありません。空きディスク スペースが必要になるのは、最適化中に元のインデックスが再書き込みされるためです。古いインデックスは、新しいインデックスが再生成されるまで保持されます。
インデックスの最適化に要する時間は、インデックスのサイズと、ハード ディスクおよび入出力の速度によって変わります。2 GB のインデックスを最適化する場合、数時間かかる可能性があります。最適化の実行中、更新モード インデクサを含む、すべての全文検索サービスが使用可能です。ただし、若干パフォーマンスが低下する可能性があります。
したがって、インデックスの最適化はオフピーク時間に行うように計画してください。
- 結果
- 検索インデックスが再書き込みされます。最適化中に入出力エラーが発生した場合、原因として最も可能性が高いのは、ディスク スペース不足です。元のインデックスはそのままの状態です。元のインデックスのサイズが大きくなることがありますが、最適化が完了すると、元のサイズに戻ります。
- ステートフル状況
- このオプションはステートフルではありません。入出力エラーが発生しない限り、このコマンドが失敗することはありません。
- 例
- 検索インデックスを最適化する必要があります。
cqperl cqtsadmin.pl --username
admin --password "" --dbset TextSearch --userdb SAMPL --ftshome D:¥CQ.Search
--optimize_idx
- prep_upgd_was_profiles destination
- 概要
- このコマンド行オプションは、スケジュールされたダウン時間に、ClearQuest の修正または再インストールの準備を行います。このコマンドによって作成されたバックアップを使用して、WebSphere Application Server プロファイルを含む全文検索デプロイメントを元の状態にリストアします。
- 使用法
全文検索でデプロイされたすべてのユーザー データベースには、対応する WebSphere Application Server プロファイルが必要です。これらのプロファイルは、ClearQuest のアップグレード、修正、再インストールを行う際に保存されない場合があります。ClearQuest フィックスパックで使用可能になった更新は、この準備およびリストア手順によってのみ ClearQuest 全文検索デプロイメントに組み込むことができます。このコマンド行オプションを restore_was_profiles とともに使用すると、バックアップ データが作成され、オプションで WebSphere Application Server プロファイルが削除されます。その後、ClearQuest のアップグレードまたは再インストールの完了後にこのオプションが呼び出されたとき、削除された WebSphere Application Server プロファイルが、指定されたバックアップ データ パスからリストアされます。
ClearQuest WebSphere Application Server プロファイルを削除するには、1 つの cqtsadmin-dbset-userdb.xml 全文検索管理機能構成ファイルの <deleteFtsWASProfiles> タグ値を FALSE から TRUE に変更する必要があります。
コマンドを実行する際、必ずこの修正済みデプロイメントを参照するようにしてください。そうしないと、WebSphere Application Server プロファイルが、復元および更新のための準備で、正しく削除されません。
このコマンド行オプションは、任意の dbset、userdb、ftshome に対して実行することができます。このオプションは、特定の全文検索デプロイメントに関連付けられていません。これは、任意の
ftshome ディレクトリ内の、そのホスト上のすべての ClearQuest 全文検索デプロイメントを評価し、影響を与えます。
注: 現在のマシンに複数の全文検索デプロイメントがある場合は、このコマンド行オプションと restore_was_profiles コマンド行オプションを一度だけ実行する必要があります。これらの 2 つのコマンドは、現在のマシン上のすべての全文検索デプロイメントにわたってグローバルに作用します。
重要: ClearQuest をアップグレードする場合は、<deleteFtsWASProfiles> タグを TRUE に設定して、このコマンド行オプションを実行する必要があります。そうしないと、全文検索デプロイメントのアップグレードが不完全なものになる可能性があります。アップグレードが完了し、restore_was_profiles コマンド行オプションを実行した後に、このオプションを FALSE に変更してください。
- 結果
- 1 つの cqtsadmin-dbset-userdb.xml 全文検索管理機能構成ファイルについて <deleteFtsWASProfiles> タグを TRUE に設定すると、ClearQuest 全文検索 WebSphere Application Server プロファイルのバックアップ データが作成され、これらの WebSphere Application Server プロファイルが削除されます。これらのプロファイルがリストアされるまで、すべての全文検索要求は失敗します。ただし、ラジオ ボタンは有効なままで、レプリカが作成されていない機能レベル 7 のユーザー データベースの oplog は引き続き生成されます。このコマンド行オプションを使用するのは ClearQuest のアップグレード、修正、再インストールを行う場合のみであるため、このタイプの失敗は許容できます。
- ステートフル状況
- このオプションはステートフルではありません。入出力エラーが発生しない限り、このコマンドが失敗することはありません。
- 例
- ClearQuest のアップグレード、修正、再インストールのいずれかを実行しようとしています。インストールを開始する前に、このホスト上のすべての WebSphere Application Server プロファイルをバックアップする必要があります。
- 単一の全文検索デプロイメントの cqtsadmin-dbset-userdb.xml ファイルを編集して、<deleteFtsWASProfiles> XML タグを次のように変更し、WebSphere Application Server プロファイルのバックアップおよび削除を許可します。
<newValue
required="no">true</newValue>
変更内容を保存します。この例では、cqtsadmin-TextSearch-SAMPL.xml ファイルを使用しています。
- コマンド行オプションを実行してバックアップ データを作成し、WebSphere Application Server プロファイルを削除します。
cqperl cqtsadmin.pl --username admin --password
"" --dbset TextSearch --userdb SAMPL --ftshome D:¥CQ.Search --prep_upgd_was_profiles
E:¥FTSBackupWASProfiles
- <deleteFtsWASProfiles> XML タグの値を FALSE に変更するか、または TRUE 値を削除します。
- ClearQuest のアップグレード、全文検索の修正または再インストールを実行します。
- コマンド行オプションを実行し、すべての全文検索デプロイメントと削除した WebSphere Application Server プロファイルをバックアップ データからリストアします。以下の 2 つのシナリオが考えられます。
- 問題が発生した場合は、同じ dbset、userdb、ftshome に対して gather_diagnostic_data コマンド行オプションを実行し、IBM Rational サポートに情報を提供できるようにしてください。
重要: 英語以外の言語をサポートするように Solr schema.xml ファイルをカスタマイズしている場合、あるいは Solr アナライザまたはトークナイザを変更している場合、それらの変更は失われます。
これらの変更を保持するには、変更を記録して、アップグレード完了後にそれらを導入します。schema.xml ファイルを変更した後、全文検索 WebSphere Application Server プロファイルを停止してから開始して、変更を有効にしてください。
- remove_lucene_idx_lock
- 概要
- このコマンドは、Lucene の検索インデックスに対するロックを解除するために使用します。Lucene 検索エンジンは、ロックを使用して更新を同期化します。まれに、Lucene またはサーバーでロックの取得時にエラーが発生し、Lucene を復旧できず、ロックがアクティブなままになることがあります。ロックがアクティブな間は検索インデックスを更新できません。そのため、ClearQuest レコードを追加または更新することができません。インデックスの整合性に問題がない限り、インデックスに対する全文検索は引き続き機能します。このタイプのロックを回復するには、stop_fts_was_profile および start_fts_was_profile コマンド行オプションを実行して、WebSphere Application Server プロファイルを再実行します。
サービスの再実行中は、全文検索は中断されます。
- 使用法
- 新規に追加された ClearQuest レコードが検索結果に含まれていないことに気付きます。WebSphere Application Server プロファイルのログを確認し、Lucene が報告しているエラーから、インデックスがロックされていることが分かります。このコマンドを使用してロックを解除します。
- 結果
- なし。全文検索デプロイメントのデータおよび設定に影響することはありません。
- ステートフル状況
- このオプションはステートフルではありません。入出力エラーが発生しない限り、このコマンドが失敗することはありません。
- 例
- Lucene のインデックス ロックを解除する必要があります。次のように、インデックスの停止、開始、アンロックを 1 つのステップで実行します。
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
- 概要
- このコマンドは、検索インデックスから 1 つ以上の ClearQuest レコード タイプを削除します。それ以降の検索では、削除されたレコード タイプとの一致は検出されなくなります。このコマンドは、cqtsadmin-dbset-userdb.xml 全文検索管理機能構成ファイルを使用して指定する必要のあるデータとともに使用します。構成ファイルの <removeRecordType> XML タグ内に、削除するレコード タイプの名前をリストします。複数のレコード タイプを削除する場合は、名前をセミコロンで区切って指定します。
このコマンドは、複数の状態を経て実行されます。いずれかの状態にあるときにエラーが発生した場合は、エラー メッセージによってエラーの修正方法が通知されます。コマンドを再実行すると、エラーが発生した場所から続行されます。
このコマンドを実行する場合は、事前にデプロイメントのバックアップを作成してください。レコード タイプの削除では、そのレコード タイプに関連するデータのみを検索インデックスから削除します。このコマンドが ClearQuest に影響を及ぼすことはありません。
- 使用法
- 全文検索をデプロイした後には、特定のレコード タイプに対する検索を許可しないように要求されます。このコマンドは、それらのレコード タイプをインデックスから削除して、検索できないようにします。このコマンドのもう 1 つの用法として、インデックス付けされたレコード タイプが ClearQuest スキーマ内で変更された場合が挙げられます。新規のフィールドを追加した場合やフィールド名を変更した場合などが考えられます。この変更を検索インデックスに反映するため、remove_record_type および add_record_type コマンド行オプションを使用します。
- 結果
- 検索インデックスが変更され、削除されたレコード タイプへのすべての参照が存在しなくなります。そのため、削除されたレコード タイプは検索できなくなります。これらのレコード タイプへの参照が、全文検索のプロパティ XML ファイルおよびエンティティ ファイルから削除されます。このコマンドの実行中、WebSphere Application Server プロファイルの再始動時には検索サービスが一時的に中断されます。ユーザーが、サーバーがダウンしているというエラーを受け取ることがあります。また、このコマンドの完了後に ClearQuest セッションを開いたユーザーに対して、削除したレコード タイプが ClearQuest Web の [検索範囲] に引き続き表示されます。しかし、これらのレコード タイプの検索を試行しても、一致するものはありません。ユーザーの [検索範囲] に検索インデックスを反映させるには、それらのユーザーがログインし直す必要があります。このコマンドは、インデックスのフラグメント化を引き起こします。このコマンドを実行した後は、インデックスを最適化して、インデックスのサイズおよびパフォーマンスの両方を最適化してください。
- ステートフル状況
- このコマンドはステートフルです。このコマンドがいずれかの実行ポイントで失敗した場合には、通常、問題を修正して、コマンドを再実行することができます。コマンドは、停止した個所から続行されます。障害発生時には、エラー メッセージに対処法が示されています。
- 例
- 検索インデックスから 2 つのレコード タイプを削除する必要があります。
- cqtsadmin-TextSearch-SAMPL.xml ファイルで、<removeRecordType> XML タグ内に、削除するレコード タイプを指定します。各レコード タイプはセミコロンで区切ります。
<newValue
required="no">Email_Rule;Customer</newValue>
- コマンドを実行して、2 つのレコード タイプを削除します。
cqperl
cqtsadmin.pl --username admin --password "" --dbset TextSearch --userdb
SAMPL --ftshome D:¥CQ.Search --remove_record_type
- cqtsadmin-TextSearch-SAMPL.xml ファイルで、<removeRecordType> XML タグに追加した 2 つのレコード タイプを削除します。このハウスキーピング作業によって、これらの削除したレコード タイプを後で再度追加した場合に、誤って削除してしまうことがなくなります。
- repair_records
- 概要
- バッチ モードおよび更新モードのインデックス付け処理で、レコードを読み取ったり、レコードをインデックス付けのためにサーバーに送信したりすることができなくなるような問題が発生した場合には、修復ファイルが作成されます。修復ファイルには、失敗したレコードの ClearQuest レコード ID がリストされています。
このコマンドは、修復ファイルを読み取って、別の障害が発生する可能性を低くするために、一度に 1 レコードずつ再インデックス付けを行います。
- 使用法
- 全文検索のデプロイメントの一環として、バッチ モードのインデックス付けの完了時に、このコマンドを実行して、インデックス付けが行われなかったレコードにインデックス付けを行ってください。また、更新モードのインデックス付け中には、インデックス付けが行われていないレコードがないか、定期的に ftshome ディレクトリを確認してください。レコードにインデックス付けが行われていない場合は、命名規則 record-type-nametime-stamp.xml に従ったファイルがあります。Defect1222923990646.xml は、インデックス付けが行われていないファイルの例です。このようなタイプのファイルがある場合には、このコマンドを実行してレコードにインデックス付けを行ってください。
- 結果
- 新たにインデックス付けされたレコードからのデータが検索インデックスに組み込まれます。
- ステートフル状況
- このオプションはステートフルではありません。入出力エラーが発生しない限り、このコマンドが失敗することはありません。
- 例
- バッチ モードまたは更新モードのインデックス付けでインデックス付けされなかったレコードにインデックス付けを行う必要があります。
cqperl cqtsadmin.pl --username admin
--password "" --dbset TextSearch --userdb SAMPL --ftshome D:¥CQ.Search
--repair_records
- restore_was_profiles path-to-backup
- 概要
- このコマンド行オプションは、prep_upgd_was_profiles コマンド行オプションによって作成したバックアップ データから ClearQuest 全文検索 WebSphere Application Server プロファイルをリストアするために使用します。
- 使用法
- WebSphere Application Server プロファイルは、ClearQuest をアップグレード、修正、またはアンインストールする際に保存されない場合があります。ClearQuest フィックスパックの適用後に、全文検索の修正を現行の WebSphere Application Server プロファイルに組み込む必要があります。これらはすべて、この準備/リストア手順によって処理されます。ClearQuest をアップグレード、修正、または再インストールした後、このコマンド行オプションは、prep_upgd_was_profiles コマンド行オプションによって作成されたすべての ClearQuest 全文検索 WebSphere Application Server プロファイルをリストアします。
既に存在するか、または最初に prep_upgd_was_profiles コマンド行オプションを使用してバックアップおよび削除を行っていない ClearQuest 全文検索 WebSphere Application Server プロファイルのリストアを試行すると、このコマンド行オプションは失敗します。
このコマンド行オプションは、任意の dbset、userdb、ftshome に対して実行できます。このコマンド行オプションは、このホスト上の、すべての全文検索デプロイメントと、WebSphere Application Server プロファイルのホーム内の WebSphere Application Server プロファイルに影響します。
注: このコマンド行オプションを fts_was_profile_home コマンド行オプションと共に使用することで、オリジナルの宛先の場所に対し、WebSphere Application Server プロファイルの統合された新規の宛先を指定することができます。ClearQuest 7.0 (すべてのリリース) からアップグレードする場合はこのスイッチを使用して、新しい WebSphere Application Server プロファイルのホームが使用されるようにしてください。
- 結果
- 全文検索 WebSphere Application Server プロファイルが再作成され、元の設定値とロケーションにリストアされるか、または指定した fts_was_profile_home ディレクトリ パスに統合されます。
- ステートフル状況
- このオプションはステートフルではありません。入出力エラーが発生しない限り、このコマンドが失敗することはありません。
- 例
- ClearQuest のアップグレードの準備で、<deleteFtsWASProfiles> タグを TRUE に設定して、prep_upgd_was_profiles コマンド行オプションを実行しました。ClearQuest をアップグレードした後、すべての ClearQuest 全文検索 WebSphere Application Server プロファイルをバックアップ データからリストアする必要があります。fts_was_profile_home コマンド行オプションを使用して、WebSphere Application Server プロファイルを新しいディレクトリに統合しようと思っています。
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
]
重要: 英語以外の言語をサポートするように Solr schema.xml ファイルをカスタマイズしている場合、あるいは Solr アナライザまたはトークナイザを変更している場合、それらの変更は失われます。
これらの変更を保持するには、変更を記録して、アップグレード完了後にそれらを導入します。schema.xml ファイルを変更した後、全文検索 WebSphere Application Server プロファイルを停止してから開始して、変更を有効にしてください。
- run_batch_idx
- 概要
- このコマンドはバッチ モードのインデクサを開始します。検索用に構成したすべての ClearQuest レコードにインデックス付けを行います。
バッチ サイズまたはスレッド数の設定が高すぎるか、ClearQuest レコードに大量のデータがある場合、このコマンドは失敗する可能性があります。最も一般的な失敗は、メモリ不足エラーです。この場合は、バッチ サイズを小さくするか、使用中のスレッド数を減らしてください。その結果、インデックス付けの時間が長くなります。あるいは、バッチ モードのインデクサと、検索サーバーのメモリの両方について、それぞれ <batchIndexJVMParm> タグと <ftsWASProfileMaxHeapSize> タグを使用して、Java™ 仮想マシン (JVM) メモリを増やすこともできます。メモリを増やす必要がある場合、それはバッチ モードのインデクサが完了するまでの一時所要量です。このような状況に最適のアクションを判別するためには、IBM Rational クライアント サポートまでお問い合わせください。コマンドが完了する前に停止した場合は、再度開始することができます。コマンドは、停止した箇所から再開されます。
- 使用法
- このコマンドを直接使用する必要はありません。これは setup_cq_fts コマンド行オプションを実行した際に呼び出されます。このコマンドは、デプロイメントを微調整またはデバッグする必要がある場合に指定します。
- 結果
- このコマンドにより、ClearQuest データベースに対して ClearQuest SQL クエリーが実行されます。次に、検索されたレコードが、インデックス付けのために Solr 検索サーバーに送信されます。実質的には、このコマンドの実行中、ClearQuest データベース サーバーは ClearQuest 全文検索へのデータ送信のためビジー状態になり、検索インデックスが更新されます。このコマンドを実行する必要がある場合は、データベース サーバーへの負荷または影響を軽減するために、オフピーク時に実行してください。
- ステートフル状況
- このオプションはステートフルではありません。入出力エラー、メモリ不足エラー、予期しない構成エラーが発生しない限り、このコマンドが失敗することはありません。
- 例
- すべての ClearQuest レコードにインデックス付けを行う必要があります。
cqperl
cqtsadmin.pl --username admin --password "" --dbset TextSearch --userdb
SAMPL --ftshome D:¥CQ.Search --run_batch_idx
- scrub_oplog before-date
- 概要
- このコマンドを使用して、レプリカが作成されていない ClearQuest ユーザー データベースから oplog をスクラブします。 ClearQuest により、レコードに行った変更を追跡するための oplog が生成されます。ClearQuest 全文検索により、更新モードのインデックス付け中の oplog がモニターされ、検索インデックスとこれらの変更が同期されます。
Oplog は一時データです。これらをいつまでも保持する必要はありません。レプリカが作成されていないデータベースで oplog が次第に大きくならないようにするために、時々 (頻繁にならない程度に)、古い oplog をスクラブしてください。
スクラブは、oplog が作成される頻度に基づいて行ってください。
ClearQuest ユーザー データベースのレプリカが作成されている場合は、oplog のスクラブにレプリカ作成ツールとポリシーを使用します。このコマンドをレプリカが作成されているデータベースに対して使用しようとすると、失敗して、レプリカ作成ツールの使用を指示するエラー メッセージが出されます。
一部の oplog が更新モードのインデクサでまだ処理されていないような場合には、すべての oplog をスクラブしないでください。そうしないと、検索インデックスが ClearQuest レコードと同期されなくなります。
その場合、検索が不正確で不完全になる可能性があります。このシナリオでは、バッチ モードでの再インデックス付けが必要です。
oplog のスクラブ頻度が激しい (更新モードのインデクサのスループットが不十分である) 場合、インデックスが不正確になったり、ヒットが失われたりすることがあります。必ず更新モードのインデクサを最新のものにして、1 カ月以上経過している oplog のみをスクラブするか、または oplog のスクラブを行わないでください。
- 使用法
- データベースの容量を節約し、未使用のデータをクリーンアップするために、レプリカが作成されていない ClearQuest ユーザー データベース上の oplog を必要に応じてスクラブします。ClearQuest データベースのレプリカが作成されている場合は、このコマンドを使用しないでください。
- 結果
- 指定された日付以前に作成された oplog テーブルにある ClearQuest oplog が削除されます。
- ステートフル状況
- このオプションはステートフルではありません。入出力エラーが発生しない限り、このコマンドが失敗することはありません。
- 例
- ClearQuest 管理者として、古い oplog を定期的にスクラブすることを計画しています。サポートされる日付形式については、scruboplog コマンド リファレンスを参照してください。
cqperl
cqtsadmin.pl --username admin --password "" --dbset TextSearch --userdb
SAMPL --ftshome D:¥CQ.Search --scrub_oplog "31-Oct-2009"
- setup_cq_fts
- 概要
- このコマンドを使用して、全文検索デプロイメントを完了します。このオプションは、最初に、全文検索管理機能構成ファイル、ClearQuest データベース、およびオペレーティング システムに基づいて、以下のファイルをカスタマイズおよび構成します。
- エンティティ ファイル
- 全文検索プロパティ XML ファイル
- Solr schema.xml ファイル
- 2 番目に、全文] ラジオ ボタンを使用可能にし、ClearQuest Web での ClearQuest 全文検索を可能にします。また、ClearQuest データベースが機能レベル 7 であり、レプリカが作成されていない場合には、oplog の生成を開始します。
3 番目に、エンティティ ファイルで検索対象として設定したレコード タイプのすべての ClearQuest レコードのインデックス付けを行うことにより、バッチ モードのインデックス付けを開始します。最後に、更新モードのインデックス付けが使用可能に設定されます。これで、デプロイメントが完了します。
このコマンドは、その状態を維持します。コマンドが完了する前にエラーが発生した場合、その状態が設定され、続行する前にエラーを修正する必要があります。エラー メッセージおよびログには、エラーを修復する方法についての説明が記載されています。修復手順は、エラーの内容、およびエラーが発生した状態により異なります。
- 使用法
- このコマンドを使用して、全文検索のデプロイメントを完了します。通常、このコマンドは、エンティティ ファイルのカスタマイズ後に実行します。このコマンドの実行中、[全文] ラジオ ボタンが ClearQuest Web で使用可能になります。再度ログインしたユーザーは検索を行うことができます。デプロイメントが完了するまで、検索結果は完全なものになりません。バッチ モードのインデックス付け中およびインデックス付け後に発生するすべてのレコード変更を取り込むために、oplog が生成される必要があるため、特に ClearQuest データベースのレプリカが作成されていない場合は、ラジオ ボタンが使用可能になっている必要があります。
デフォルトの JVM メモリ設定を大きくしている場合、バッチ モードのインデックス付けは、プロセッサ、入出力、およびメモリをかなり消費するため、全文検索をデプロイするコンピュータの使用率は高くなります。また、バッチ サイズおよびスレッド数を増やすことによりバッチ モードのインデクサをどの程度アグレッシブに設定するかによって、バッチ モードのインデックス付け中の ClearQuest データベースの使用率が高くなる可能性があります。
- 結果
- 多数のファイルが ftshome ディレクトリに作成されます。インデックスが作成されます。
WebSphere Application Server での検索サービスが使用可能になります。ClearQuest データベースが更新され、全文検索プロパティ XML ファイルが組み込まれます。
ご使用の ClearQuest データベースのレプリカが作成されていない場合は、oplog 作成が使用可能です。 レプリカ作成済みの ClearQuest ユーザー データベースの oplog 作成は続行されます。
- ステートフル状況
- このコマンドはステートフルです。このコマンドがいずれかの実行ポイントで失敗した場合には、問題を修正して、コマンドを再実行することができます。コマンドは、中断した場所から続行されます。障害発生時には、実行すべき作業がエラー メッセージによって指示されます。コマンドが完了する前にエラーが発生した場合、その状態が設定され、続行する前にエラーを修正する必要があります。エラー メッセージおよびログには、エラーを修復する方法についての説明が記載されています。修復手順は、エラーの内容、およびエラーが発生した状態により異なります。
- 例
- init_cq_fts コマンド行オプションを実行し、エンティティ ファイルを編集しました。次に、デプロイメントを完了する必要があります。
cqperl
cqtsadmin.pl --username admin --password "" --dbset TextSearch --userdb
SAMPL --ftshome D:¥CQ.Search --setup_cq_fts
- set_was_max_mem
- 概要
- このコマンドを使用して、WebSphere Application Server プロファイルが使用できる JVM メモリの最大量を設定します。デフォルト値は 300 MB です。これは、以下の状態でバッチ モードのインデックス付けを行う場合には小さすぎるかもしれません。
- バッチ サイズが増加している
- スレッド数が増加している
- ClearQuest レコード タイプが混在している
このコマンドは、構成ファイル内の <ftsWASProfileMaxHeapSize> XML タグからメモリ設定値を読み取ります。その後、JVM メモリをその値に設定します。
- 使用法
- WebSphere Application Server プロファイル サーバーによりメモリ不足エラーが報告されたために、バッチ モードのインデックス付けが失敗した場合は、おそらくメモリ設定値が低すぎます。
以下のいずれかのアクションを実行して、メモリ不足エラーを修復してください。
- バッチ サイズおよびスレッド数を小さくしてください。これにより、インデックス付けの完了に要する時間は長くなります。
- 一時的に JVM メモリを増加させてください。JVM 最大メモリは、バッチ モードのインデックス付けが完了するまで、やや大きいサイズに設定しておくことをお勧めします。
- 結果
- WebSphere Application Server プロファイル用の JVM 最大メモリは、新規の値に変更されます。実際には、さらに大きなシステム メモリが WebSphere Application Server プロファイルに割り当てられます。
- ステートフル状況
- このオプションはステートフルではありません。入出力エラーが発生しない限り、このコマンドが失敗することはありません。
- 例
- インデックス付け中に WebSphere Application Server プロファイルからメモリ不足エラーを受け取ります。続行する前に、この問題に対処する必要があります。
- cqtsadmin-TextSearch-SAMPL.xml ファイルの <ftsWASProfileMaxHeapSize> XML タグで、JVM メモリを 1.5 GB に設定します。
<newValue
required="no">1536</newValue>
- 次のコマンドを実行して、新規の JVM メモリ設定を行います。
cqperl
cqtsadmin.pl --username admin --password "" --dbset TextSearch --userdb
SAMPL --ftshome D:¥CQ.Search --set_was_max_mem
- set_solr_home
- 概要
- このコマンドを使用して、WebSphere Application Server の下で Solr のホーム ディレクトリを設定します。各デプロイメントには固有の schema.xml 構成ファイルおよびインデックスがあります。Solr ホーム ディレクトリが適切に指定されていない場合、または誤ったロケーションが指定されている場合には、WebSphere Application Server 全文検索プロファイルが開始されないことがあります。WebSphere Application Server 全文検索プロファイルが開始されない場合、対応する全文検索 WebSphere Application Server プロファイルの logs ディレクトリ (パスは %your-WAS-profile-home%/<cqfts>_<dbset>_<userdb>/logs/server1/logs/) にエラーが記録されます。
- 使用法
- このコマンドを直接使用する必要はありません。これは setup_cq_fts コマンド行オプションを実行した際に呼び出されます。このコマンドは、デプロイメントを微調整またはデバッグする必要がある場合に指定します。
- 結果
- デプロイされた WebSphere Application Server プロファイルの JVM プロパティが、Solr のホーム環境変数が設定されるように変更されます。
- ステートフル状況
- このオプションはステートフルではありません。入出力エラーが発生しない限り、このコマンドが失敗することはありません。
- 例
- IBM Rational ソフトウェア サポートから、このコマンドを使用して、全文検索デプロイメントの問題点をデバッグしたり、デプロイメントをカスタマイズしたりするように指示されました。
cqperl cqtsadmin.pl --username
admin --password "" --dbset TextSearch --userdb SAMPL --ftshome D:¥CQ.Search
--set_solr_home
- show_scenarios [ID | all]
- 概要
- このコマンドを使用して、cqtsadmin.pl ツールの使用方法についてのシナリオのリストを、例とともに表示します。シナリオは、インフォメーション センターにリストされているシナリオを簡略化した形式のもので、完全なリストではない場合や、1 対 1 で対応していない場合があります。
- 使用法
- このコマンド行オプションを使用して、cqtsadmin.pl ツール用に最もよく使用されるシナリオのリストを表示します。シナリオの ID と見出しを確認するには、パラメータを指定せずにコマンドを実行します。シナリオの全文を確認するには、シナリオ ID パラメータを指定してコマンドを実行します。シナリオの完全なリスト (各シナリオに ID、見出し、および全文の説明が含まれるもの) を表示するには、all パラメータを指定してコマンドを実行します。
- 結果
- 全文検索デプロイメントのデータおよび設定に影響することはありません。
- ステートフル状況
- このオプションはステートフルではありません。入出力エラーが発生しない限り、このコマンドが失敗することはありません。
- 例
- cqtsadmn.pl ツールを使用してタスクを完了させたいのですが、方法を正確に覚えていません。このコマンド行オプションを使用して、シナリオの見出しを ID とともにリストしてください。その後、参照するシナリオの ID を渡してこのコマンドを再実行し、そのシナリオの全文を表示します。
cqperl cqtsadmin.pl --username
admin --password "" --dbset TextSearch --userdb SAMPL --ftshome D:¥CQ.Search
--show_scenarios
- start_fts_was_profile
- 概要
- このコマンドを使用して、全文検索 WebSphere Application Server プロファイル サービスを開始します。検索要求がサービスされるためには、全文検索 WebSphere Application Server プロファイルが開始されている必要があります。また、更新モードのインデクサが新規レコードまたは更新済みのレコードの検査を開始し、これらのレコードをインデックス付けのために検索エンジンに送信するためには、プロファイルが開始されている必要があります。
- 使用法
- このコマンドを直接使用する必要はありません。これは setup_cq_fts コマンド行オプションを実行した際に呼び出されます。このコマンドは、デプロイメントを微調整またはデバッグする必要がある場合に指定します。
- 結果
- 全文検索 WebSphere Application Server プロファイルが停止していた場合は開始され、一時メモリおよびプロセッサ リソースが利用されます。検索サービスおよび更新モードのインデクサが使用可能であれば、それらの実行が開始されます。WebSphere Application Server プロファイルが既に開始されている場合には、何も変更はありません。
- ステートフル状況
- このオプションはステートフルではありません。このコマンドは、入出力エラー、Solr サーバーの障害、WebSphere Application Server プロファイル開始の失敗 (通常はセットアップの問題が原因) などが起こらない限り、失敗しません。
- 例
- IBM ソフトウェア サポートから、検索 WebSphere Application Server プロファイルを開始するよう指示されました。
cqperl cqtsadmin.pl --username admin --password
"" --dbset TextSearch --userdb SAMPL --ftshome D:¥CQ.Search --start_fts_was_profile
- start_update_idx
- 概要
- このコマンドを使用して、WebSphere Application Server プロファイルの下で実行される更新モードのインデクサを使用可能にしてから、開始します。 更新モードのインデクサにより、検索インデックスと、ClearQuest データベースに対して行われた変更が同期されます。インデクサはインデックスを付ける新規の値について oplog をモニターします。全文検索管理機能構成ファイルの <updateIndexDelay> XML タグを使用して、インデックスが同期される頻度を構成します。
- 使用法
- このコマンドを直接使用する必要はありません。これは setup_cq_fts コマンド行オプションを実行した際に呼び出されます。このコマンドは、デプロイメントを微調整またはデバッグする必要がある場合に指定します。
- 結果
- 更新モードのインデクサが使用可能になって開始されます。ClearQuest レコードに対する変更、追加、および削除がインデックス付けされ、検索結果に表示されるようになります。
- ステートフル状況
- このオプションはステートフルではありません。このコマンドは、入出力エラー、Solr サーバーの障害、WebSphere Application Server プロファイル開始の失敗 (通常はセットアップの問題が原因) などが起こらない限り、失敗しません。
- 例
- IBM ソフトウェア サポートから、更新インデクサを使用可能にするよう指示されました。
cqperl cqtsadmin.pl --username admin --password "" --dbset TextSearch --userdb SAMPL --ftshome D:¥CQ.Search --start_update_idx
- stop_fts_was_profile
- 概要
- このコマンドを使用して、全文検索 WebSphere Application Server プロファイル サービスを停止します。WebSphere Application Server プロファイルが停止すると、検索サービスが使用できなくなり、更新モードのインデクサは、検索インデックスと、ClearQuest レコードに対して行われた変更との同期を停止します。
- 使用法
- このコマンドを直接使用する必要はありません。これは setup_cq_fts コマンド行オプションを実行した際に呼び出されます。このコマンドは、デプロイメントを微調整またはデバッグする必要がある場合に指定します。
- 結果
- 全文検索 WebSphere Application Server プロファイルは停止します。これにより、検索サービスおよび更新モードのインデックス付けも停止します。WebSphere Application Server プロファイルが使用するメモリおよびプロセッサ能力は解放されます。検索はエラーになります。
oplog は、ClearQuest Web で [全文検索] ラジオ ボタンが使用可能になっている限り、引き続きメッセージを受信します。これにより、WebSphere Application Server プロファイルが実行を再開したときに、更新モードのインデクサが新しい情報を取得できます。
- ステートフル状況
- このオプションはステートフルではありません。入出力エラーが発生しない限り、このコマンドが失敗することはありません。
- 例
- IBM ソフトウェア サポートから、検索 WebSphere Application Server プロファイルを停止するよう指示されました。
cqperl cqtsadmin.pl --username admin --password
"" --dbset TextSearch --userdb SAMPL --ftshome D:¥CQ.Search --stop_fts_was_profile
- stop_update_idx
- 概要
- このコマンドを使用して、更新モードのインデクサを使用不可にし、停止します。更新モードのインデクサが停止した場合でも、検索サービスは使用できます。ただし、ClearQuest レコードに対して行われた変更は、更新モードのインデックス付けが再度使用可能に設定されるか再開されるまで、インデックスに反映されません。このため、最新でも正確でもない検索結果が生じる可能性があります。
- 使用法
- このコマンドを直接使用する必要はありません。これは setup_cq_fts および backup_fts コマンド行オプションを実行した際に呼び出されます。このコマンドは、デプロイメントを微調整またはデバッグする必要がある場合に指定します。
- 結果
- WebSphere Application Server プロファイルの下で実行される更新モードのインデクサが使用不可になります。新規および変更済みの ClearQuest レコードは、検索結果に反映されません。oplog は、引き続きメッセージを受信します。ClearQuest レコードの変更は、更新モードのレコード インデクサが再度使用可能になって最新の oplog を反映した後、全文検索に反映されます。
- ステートフル状況
- このオプションはステートフルではありません。入出力エラーが発生しない限り、このコマンドが失敗することはありません。
- 例
- IBM ソフトウェア サポートから、更新モードのインデクサを使用不可にするよう指示されました。
cqperl cqtsadmin.pl --username admin --password "" --dbset TextSearch --userdb SAMPL --ftshome D:¥CQ.Search --stop_update_idx
- unlock_cq_fts
- 概要
- このコマンドを使用して、全文検索のロックされたデプロイメントをアンロックします。コマンドの終了後に、使用可能な全文検索管理機能コマンドをすべて実行できるようになります。
- 使用法
- このコマンドを使用して、全文検索のロック済みデプロイメントをアンロックします。これにより、使用可能なコマンドをすべて実行できるようになります。このコマンドは、lock_cq_fts コマンド行オプションが設定したロックを無効にします。
- 結果
- なし。全文検索デプロイメントのデータおよび設定は影響を受けず、すべてのコマンドを実行できます。
- ステートフル状況
- このオプションはステートフルではありません。入出力エラーが発生しない限り、このコマンドが失敗することはありません。
- 例
- インデックスを最適化したいのですが、デプロイメントがロックされています。デプロイメントをアンロックし、インデックスを最適化してから再度ロックする必要があります。
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
- 概要
- cqtsadmin-dbset-userdb.xml 全文検索管理機能構成ファイルに対して行った変更を伝搬します。
構成ファイル内の以下の XML タグのいずれかを変更した後、それらの変更が有効になるように変更を伝搬する必要があります。
- <batchIndexBatchSize>
- <batchIndexDelay>
- <batchIndexThreads>
- <ftsServerName>
- <ftsWASProfileName>
- <ftsWASProfilePort>
- <updateIndexBatchSize>
- <updateIndexDelay>
- <updateIndexLoginInterval>
例えば、バッチ モードのインデクサのバッチ サイズを変更した場合は、新規の値が使用されるように、このコマンドを実行してから run_batch_idx コマンド行オプションを実行する必要があります。
注: 管理者ユーザーのパスワードを変更するときは、必ず
update_fts_prop_files (新規パスワードを指定) を使用して、パスワード ファイル (
pwd.txt) が更新されて、新規レコードのバッチ インデックス付けが再開されるようにします。次に例を示します。
cqperl cqtsadmin.pl --username admin --password new_password --dbset 7.0.0 --userdb SAMPL --ftshome C:\CQ.Search --fresh_batch_idx
- 使用法
- 全文検索をデプロイする際に、デフォルト設定を変更する必要があるかもしれません。構成ファイルに変更を行った場合、該当する全文検索コンポーネントに変更を伝搬する必要があります。
- 結果
- 影響を受けるコンポーネントは、変更する XML タグの値によって異なります。詳しくは、cqtsadmin-dbset-userdb.xmlを参照してください。
- ステートフル状況
- このオプションはステートフルではありません。入出力エラーが発生しない限り、このコマンドが失敗することはありません。
- 例
- バッチ サイズとスレッド数を増やして、バッチ モードのインデックス付けの速度を上げる必要があります。構成ファイルを変更した後、このコマンドを実行します。
cqperl cqtsadmin.pl --username admin
--password "" --dbset TextSearch --userdb SAMPL --ftshome D:¥CQ.Search
--update_fts_prop_files --run_batch_idx
- upgrade_solr_app
- 概要
- このコマンド行オプションは、現行の全文検索デプロイメントの Apache Solr が、ご使用の ClearQuest のバージョンに組み込まれている最新バージョンであるかどうかをチェックします。
最新バージョンでない場合、このオプションは Apache Solr をアップグレードします。
- 使用法
- ClearQuest の新しいバージョンは、現行の全文検索デプロイメントが使用している Apache Solr のバージョンよりも新しいバージョンをサポートする可能性があります。
prep_upgd_was_profiles と restore_was_profiles コマンド行オプションを使用して ClearQuest と全文検索デプロイメントをアップグレードしても、Apache Solr アプリケーションは自動的にアップグレードされません。このアップグレード手法は計画的に行うものです。このアップグレードにより、インデックス形式が変わる可能性があり、それにより全体の再インデックス付けを行う必要があるためです。このコマンドを使用して、Apache Solr をサポートされる最新バージョンにアップグレードします。
このコマンド行オプションを使用する前に、backup_fts コマンド行オプションを使用して全文検索デプロイメントをバックアップしてください。また、Apache Solr のアップグレード後に ClearQuest データベースの再インデックス付けを行う必要があるかどうかについて、IBM Rational ClearQuest リリース ノートで確認してください。Apache Solr のインデックス形式が変更されている場合は、再インデックス付けを行う必要があるかもしれません。
このコマンド行オプションの実行後、
stop_fts_was_profile コマンド行オプションを実行し、その後
start_fts_was_profile コマンド行オプションを実行して、アップグレードを有効にする必要があります。
重要: ClearQuest をアップグレードした後、および prep_upgd_was_profiles コマンド行オプションと restore_was_profiles コマンド行オプションを使用して全文検索デプロイメントをアップグレードした後は、このコマンド行オプションを実行してください。そうしないと、予期しない問題が発生する可能性があります。
- 結果
- 既存の Apache Solr は、サポートされる最新のバージョンにアップグレードされます。
ClearQuest 全文検索は、アップグレードが完了するまで使用できません。
- ステートフル状況
- このオプションはステートフルではありません。このコマンドは、入出力エラーまたは WebSphere Application Server の問題が発生しない限り、失敗することはありません。
- 例
- 1 つの全文検索デプロイメントに関して Apache Solr アプリケーションをアップグレードしようと思っています。
backup_fts オプションを指定して cqtsadmin.pl コマンドを実行することにより、全文検索デプロイメントをバックアップします。
cqperl
cqtsadmin.pl --username admin --password secret --dbset TextSearch
--userdb SAMPL --ftshome D:¥CQ.Search --backup_fts E:¥FTS.Backup
upgrade_solr_app コマンド行オプションを指定して cqtsadmin.pl コマンドを再度実行することにより、Solr アプリケーションをアップグレードします。
cqperl
cqtsadmin.pl --username admin --password secret --dbset TextSearch
--userdb SAMPL --ftshome D:¥CQ.Search --upgrade_solr_app
ユーザー データベースの再インデックス付けを指示するメッセージが表示されたら、cqtsadmin.pl コマンドを 4 回 (それぞれ stop_update_idx、run_batch_idx、optimize_idx、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
さらに他の ClearQuest データベースの全文検索デプロイメントがある場合は、各データベースについて前述のコマンドを実行します。
- was_profile_ports_file
- 概要
- このコマンド行オプションを使用して、任意で、独自の WebSphere Application Server プロファイル ポート ファイルを用意することができます。このファイルは、全文検索プロファイルの作成時に create_fts_was_profile コマンド行オプションで使用されます。
- 使用法
- 全文検索デプロイメントを新しく作成する場合、デフォルトで、新規の WebSphere Application Server プロファイルを作成します。全文検索管理機能ツールによって、システムで次に使用可能なポートが判別されます。
デプロイメントを調整して独自のポートを使用するよう指定する必要がある場合は、独自のポート ファイルを作成する必要があります。
その後、was_profile_ports_file オプションを使用して、全文検索管理機能ツールに、独自のポート ファイルを使用することを通知します。使用可能なテンプレートが、WebSphere インストール済み環境の portdef.props ファイルにあります。portdef.props ファイルは、通常、¥IBM¥WebSphere¥AppServer¥profileTemplates¥default¥actions¥portsUpdate¥ ディレクトリにあります。WebSphere Application Server プロファイルのポート ファイルの詳しい説明は、WebSphere Application Server インフォメーション センターの「manageprofiles コマンド」の「例: 定義済みポート番号の使用」セクションを参照してください。
http://pic.dhe.ibm.com/infocenter/wasinfo/v8r0/index.jsp?topic=%2Fcom.ibm.websphere.base.doc%2Finfo%2Faes%2Fae%2Frxml_manageprofiles.html
このコマンド行オプションは、
create_fts_was_profile オプションとともに使用されます。
注: 独自のポートを使用する場合は、ポートが他のアプリケーションによって使用されないようにしてください。そうしないと、全文検索と他のアプリケーションで問題が発生する可能性があります。
- 結果
- 全文検索管理機能ツールによって指定されるポートの代わりに、このコマンドで指定したポートが使用されます。
- ステートフル状況
- このオプションはステートフルではありません。入出力エラーが発生しない限り、このコマンドが失敗することはありません。
- 例
- 使用する独自のポート セットを指定する必要があります。
- portdef.props ファイルのコピーを作成して、独自のポート値を指定します。
- 以下のコマンドを実行して、独自のポートを指定する was_profile_ports_file オプションを使用する新規全文検索デプロイメントを作成します。
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
- 引き続き、全文検索デプロイメントを使用します。