3.2.2 制御情報ファイルの指定項目と指定方法

制御情報ファイルには,TSPIndexerコマンドの処理内容を定義します。制御情報ファイルはサンプルが提供されていますので,ご使用方法に合わせてカスタマイズしてください。

<この項の構成>
(1) 制御情報ファイルの指定項目
(2) 指定項目の詳細

(1) 制御情報ファイルの指定項目

制御情報ファイルに指定する項目を次の表に示します。

表3-1 制御情報ファイルに指定する項目

項番指定項目指定内容指定種別複数指定指定要否
1TBL_IN入力表名表名不可必須
2TBL_OUT出力表名表名不可必須
3COL_INDOC_UNIQUE入力表ルのユニークキー列名および属性必須
4COL_INDOC_DOC入力ドキュメントの格納列名不可必須
5COL_INDOC_FNAME入力ドキュメントファイル名の格納列名不可必須
6COL_INDOC_CTYPE入力ドキュメントのコンテントタイプ格納列不可必須
7COL_INDOC_MKSEARCHインデクス作成指定情報列名不可必須
8COL_MKSTATインデクス作成状態列名不可必須
9COL_MNTTSPIndexer保守情報列名不可必須
10COL_OUT_UNIQUE出力表のユニークキー列名および属性不可必須
11COL_OUT_TEXT全文検索用列名不可必須
12LEVEL_FORCE登録指定以外の文書,または登録に失敗した文書を登録するときに指定する数値不可必須
13FILE_ERRORエラー情報ファイルファイル名不可必須
14TIME_EXEC実行時間指定数値不可任意
15HIRDB_VERSION使用するHiRDBのバージョン文字列不可必須
16FILE_DOCFILTER_CONFDocument Filter for Text Searchのコンフィグレーションファイル名ファイル名不可任意

制御情報ファイルに指定する項目は,指定値の種別によって指定方法が異なります。次に,指定値の種別ごとに指定方法を説明します。

(a) 表を指定する場合

入力表名を指定します。表名は,「認可識別子.表識別子」の形式で指定します。認可識別子は省略できません。

指定例

TBL_IN=USER01.文書表
TBL_OUT="user02"."SearchTable"

(b) 列を指定する場合

列名,列属性,列長,および非ナル値制約オプションを指定します。指定する列の詳細については,「2.2 入力表および出力表の構成」を参照してください。なお,指定した値と実際の表の形式が不一致の場合はエラーとなります。また,代入,比較などの変換できるデータ型同士の場合でもエラーとなりますのでご注意ください。

指定形式

設定項目=列名,列属性[,[列長][,notnull]]

列を指定する場合の注意事項を次に示します。

(c) ファイル名を指定する場合

ファイル名をドライブ名からの絶対パスで指定します。ファイル名の前後を"(ダブルクォーテーション)で囲んでください。

指定例

FILE_ERROR="D:¥tmp¥error.log"
FILE_TRACE="D:¥trace¥trace.log"

(2) 指定項目の詳細

制御情報ファイルの各設定項目について説明します。

(a)  TBL_IN

入力情報格納列が存在する表名を指定します。指定方法については,「3.2.2(1)(a) 表を指定する場合」を参照してください。

(b)  TBL_OUT

抽出したテキストデータを格納する全文検索用列の存在する表名を指定します。指定方法については,「3.2.2(1)(a) 表を指定する場合」を参照してください。

出力表と入力表が同じ場合は,「TBL_IN」に指定した表名を指定してください。

(c)  COL_INDOC_UNIQUE

入力表のユニークキー列名および属性を指定します。ユニークキー列は三つまで指定できます。三つを超えて指定した場合はエラーとなります。指定方法については,「3.2.2(1)(b) 列を指定する場合」を参照してください。

ユニークキー列を複数指定する場合は,この設定項目を複数行指定してください。複数のユニークキー列を指定した場合,ユニークキーの優先順位は指定順となります。列の詳細については,「2.2 入力表および出力表の構成」を参照してください。

(d)  COL_INDOC_DOC

全文検索用テキストデータを抽出する電子ドキュメントの実体が格納されている列名を指定します。指定方法については,「3.2.2(1)(b) 列を指定する場合」を参照してください。列の詳細については,「2.2 入力表および出力表の構成」を参照してください。

(e)  COL_INDOC_FNAME

全文検索用テキストデータを抽出する電子ドキュメントのファイル名が格納されている列名を指定します。指定方法については,「3.2.2(1)(b) 列を指定する場合」を参照してください。列の詳細については,「2.2 入力表および出力表の構成」を参照してください。

(f)  COL_INDOC_CTYPE

全文検索用テキストデータを抽出する電子ドキュメントのコンテントタイプが格納されている列名を指定します。指定方法については,「3.2.2(1)(b) 列を指定する場合」を参照してください。列の詳細については,「2.2 入力表および出力表の構成」を参照してください。

(g)  COL_INDOC_MKSEARCH

インデクス作成指定情報列名を指定します。指定方法については,「3.2.2(1)(b) 列を指定する場合」を参照してください。列の詳細については,「2.2 入力表および出力表の構成」を参照してください。

(h)  COL_MKSTAT

インデクス作成状態列名を指定します。指定方法については,「3.2.2(1)(b) 列を指定する場合」を参照してください。列の詳細については,「2.2 入力表および出力表の構成」を参照してください。

(i)  COL_MNT

TSPIndexer保守情報列名を指定します。指定方法については,「3.2.2(1)(b) 列を指定する場合」を参照してください。列の詳細については,「2.2 入力表および出力表の構成」を参照してください。

(j)  COL_OUT_UNIQUE

入力表のユニークキー列名および属性を指定します。ユニークキー列は三つまで指定できます。三つを超えて指定した場合はエラーとなります。指定方法については,「3.2.2(1)(b) 列を指定する場合」を参照してください。

ユニークキー列を複数指定する場合は,この設定項目を複数行指定してください。複数のユニークキー列を指定した場合,ユニークキーの優先順位は指定順となります。列の詳細については,「2.2 入力表および出力表の構成」を参照してください。

各列の属性および指定順序は,COL_INDOC_UNIQUEと同じにしてください。

(k)  COL_OUT_TEXT

全文検索列名を指定します。指定方法については,「3.2.2(1)(b) 列を指定する場合」を参照してください。列の詳細については,「2.2 入力表および出力表の構成」を参照してください。

(l)  LEVEL_FORCE

テキスト抽出・全文検索列登録する行の実行レベルを指定します。次のどれかを指定してください。

0
インデクス作成指定情報列で「1(登録を実行する)」が指定され,さらに,インデクス作成状態列が0(未登録)である行を処理対象とします。
1
インデクス作成指定情報列で「1(登録を実行する)」が指定され,さらに,インデクス作成状態列が0(未登録)である行を処理対象とします。また,抽出したテキスト長がプラグインの制限を超える場合,テキストの先頭から格納できる長さだけを格納します。このとき,以前にテキスト長がプラグインの制限を超えてエラーとなった行(インデクス作成状態が100)も登録します。
2
インデクス作成指定情報列で「1(登録を実行する)」が指定され,さらに,インデクス作成状態列が0(未登録)である行を処理対象とします。また,インデクス状態列が102(データ不正以外の要因で登録を失敗した)の行を処理対象とします。データ不正以外の障害が発生した場合の,再実行用として利用します。
3
1および2の機能を含みます。
(m)  FILE_ERROR

障害発生時のエラー情報およびTSPIndexerコマンドの実行開始・実行完了メッセージを出力する,出力先ファイル名を指定します。ファイル名はドライブ名からの絶対パスで指定してください。なお,ファイルの出力先となるディレクトリは事前に作成しておく必要があります。指定方法については,「3.2.2(1)(c) ファイル名を指定する場合」を参照してください。

TSPIndexerコマンドを実行すると,指定されたファイルに情報が追加されます。

(n)  TIME_EXEC

TSPIndexerコマンドの実行時間を,0~14400の分単位で指定します。デフォルトは60です。TSPIndexerコマンドは,ここで指定された時間だけ,登録処理を実行します。0を指定すると無制限と解釈され,すべての登録対象列に対して処理を実行します。

(o)  HIRDB_VERSION

TSPIndexerコマンドで使用する,HiRDBのバージョンを指定します。6文字の半角英数字で指定してください。-(ハイフン)や/(スラッシュ)は指定できません。

また,バージョンアップなどでHiRDBのバージョンが変更になった場合は,この指定値も変更してください。

指定例
06-01の場合:060100
07-00-/Aの場合:07000A
07-00-2Cの場合:07002C
06-01-Aの場合:06010A
(p)  FILE_DOCFILTER_CONF

Document Filter for Text Searchの動作を定義したコンフィグレーションファイル名をドライブ名からの絶対パスで指定します。TSPIndexerコマンドがテキストデータを抽出するときに,Document Filter for Text Searchはここで指定したコンフィグレーションファイルの内容に従って動作します。指定しなかった場合は,Document Filter for Text Searchでの定義内容に従って動作します。また,コンフィグレーションファイルに指定されていない項目も,Document Filter for Text Searchでの定義内容に従います。

なお,指定したコンフィグレーションファイルをREADモードでOPENできなかった場合は,エラーメッセージKFGX2001-Eを出力して処理を中断します。

コンフィグレーションファイル(config.cfg)の設定例を次に示します。

[SYSTEM]
 DOCFTIMEOUT     =600
 
[DOCFLIBRARYMAP]
 csv           =DOCF
 ini           =DOCF
 cfg           =DOCF
 txt           =DOCF
 csv           =DOCF
[DOCFTIPEMAP]
 csv           =csv
 ini           =ini
 cfg           =cfg
 .            =txt