検索小町
　　　　詳細設定マニュアル		 2010/12/20 版


このマニュアルは検索小町の詳細設定マニュアルです。
Windows以外のＯＳでご利用の場合や、システム環境を詳細に設定したい場合はこのマニュアルを参照してください。
Windows環境下で面倒な設定をせずに簡単にご利用したい場合は検索小町インストールマニュアルを参照してください。）

※このマニュアルは断りなく最新のものに改定されることがあります。

評価版は製品版と同じ機能を持っていますが、使用可能な期間に以下のような限定があります。
・使用開始から30日間、あるいはログイン回数が100回に達するまでの期間のいずれか短い方。

評価版を用いてユーザ様の環境下における動作確認及びシステム機能確認をしていただき、 ご満足いただけるようでしたら弊社ＨＰ上より製品版のお申し込みをしてください。
製品版設定方法に関しては別途ご連絡させていただきます。
　商標、登録商標について
　本文中の製品名などは、各発売元または開発メーカーの登録商標または商標です。
1. システム構成

検索小町はＷＥＢサーバ(Tomcat)上にインストールするＷＥＢシステムであり、検索対象となる各種ＤＢにはＪＤＢＣを用いて接続しています。
そのため詳細設定を行うシステム管理者の方には前提条件として次のような知識が必要となります。

・Tomcat及びwarファイルに関する基本的知識
・ご使用になるＤＢに関する基本的知識
・ＪＤＢＣ接続方法に関する基本的知識



2. 詳細設定手順
以下の手順で環境設定をして下さい。
①準備
　　Ｗｅｂサーバ（Tomcat）
　　ＤＢサーバ
　　ＪＤＢＣドライバ
②warファイルの配置
③管理用ＤＢの作成
④設定ファイルの変更
　　dbsearch.xml
　　init_dbsearch.xml
　　init_dbsearch_batch.xml
⑤起動確認
⑥管理データ作成

2_1.準備

(A)ＷＥＢサーバ
Tomcat(4.1推奨 4.0、5.0、5.5稼動確認済)を利用したＷＥＢサーバの環境をあらかじめ設定しておいてください。
【参考】
TomcatはWebサーバ上でサーブレット、JSPを実行可能なサーブレットコンテナです。 正式にはApache Tomcatといい、 独自の 委員会を持つ Top Level Project として Apache Tomcat Project 内で開発されているオープンソースのソフトウエアです。 （Tomcatについて）

※ご注意 　TomcatではJAVA J2SDKを使用します。「Java SE Runtime Environment」という物もありますが、こちらでは動作しませんので、必ず「Java SE Development Kit」をインストールしてください。
ＳＵＮのダウンロードサイトはこちら

(B)ＤＢサーバ
ご使用になるＤＢサーバの環境をあらかじめ設定しておいてください。

(C)ＪＤＢＣドライバ
ご使用になるＤＢ用のＪＤＢＣドライバをあらかじめ入手し、Tomcatがインストールされているディレクトリ下のcommon\libディレクトリにおいてください。
【参考】
JDBC(Java DataBase Connectivity)とはJavaがRDBの種類に関係なく同じようにデータ処理を行うためのＡＰＩで、そのために各RDB用のJDBCドライバが必要です。 （JDBCドライバについて）

2_2.warファイルの設定
弊社ＨＰ上から検索小町評価版（通常版）をダウンロードし、ダウンロードしたwarファイルをTomcatがインストールされているディレクトリ下のwebappsの下においてください。
この状態でTomcatを（再）起動するとwarファイルが解凍されてdbsearchというディレクトリがwebappsの下に作成されます。
dbsearchディレクトリができていることが確認できたら、Tomcatをいったん停止します。

【再インストール時の注意】
検索小町の再インストール時など、webappsディレクトリの下にすでにdbsearchディレクトリがある状態では、内容の更新はされません。
バージョンアップ時など、再インストールする必要性が生じた場合は、dbsearchディレクトリを削除するか別のディレクトリに移動してから再起動してください。

2_3.管理用ＤＢの作成
検索小町ではユーザ情報やＤＢ情報などのマスタデータを保存しておくための管理ＤＢを用いています。
管理ＤＢをどのＤＢＭＳ上に作成するかはユーザ様のＤＢ環境にあわせ、ご自由にお決めになることができます。（ＪＤＢＣドライバを持つＤＢＭＳなら基本的に作成可能です）

管理ＤＢは各ＤＢＭＳのＤＢ作成方法に合わせdbsearch_kanriという名前で作成してください。

次にdbsearch\sql_fileというディレクトリの下にあるＳＱＬファイル（テーブル作成のcreate文や初期データ作成のinsert文が含まれています）を使ってdbsearch_kanri中にテーブルを作成してください。
ＳＱＬファイルにはデータ型の違いより次の３種類を用意しています。お使いになるＤＢＭＳにあわせて該当するＳＱＬファイルをお選びください。(ＳＱＬファイルはシフトＪＩＳで書かれていますのでご注意ください)

【ＳＱＬファイル】
ファイル名 使用ＤＢＭＳ
set_db.sql PostgreSQL、MySQL、SQL Server等
set_db_ora.sql Oracle
set_db_db2.sql DB2


2_4.設定ファイルの変更
dbsearch\set_fileというディレクトリの下に設定ファイル（テンプレート）があります。
これら３つのファイルをコピーし、後述の手順に従って内容をシステム環境にあわせて変更し、所定のディレクトリに保存して下さい。
　　　dbsearch.xml (Tomcat4.1/5.0用コンテキストファイル)
　　　dbsearch55.xml (Tomcat5.5用コンテキストファイル)
　　　init_dbsearch.xml
　　　init_dbsearch_batch.xml

(A)dbsearch.xml
dbsearch.xmlはTomcat用の設定ファイルです。
検索小町で使用する管理ＤＢに関する設定もここで行います。
2_4で作成した管理用ＤＢにあわせて設定内容を修正してください。

下図の赤で囲んだデータは必ず変更する必要がある項目です。
青で囲んだデータはコネクションプーリングに関する設定項目です。
ユーザ様のシステム環境にあわせて必要があれば修正してください。
それ以外の項目は変更する必要はありません。
（各項目に関する詳細内容はTomcatのマニュアル等をご参照ください）

Tomcat4.1の場合、修正したファイルはwebappsディレクトリにおいてください。
注）Tomcat5.0または5.5の場合はdbsearch.xmlをconf\Catalina\localhostディレクトリにおいてください。
　　また5.5の場合、ResourceParamsタグは使用できずResourceタグ中にパラメータを設定します。
　
　　Tomcat4.0の場合は、dbsearch.xmlという検索小町固有のファイルではなく、
　　server.xml（Tomcatのconfディレクトリの下に存在します）中に書き込む必要があります。
　　server.xmlのContext要素の位置（Server-Service-Engine-Host-Contextというツリー構造になっています）に
　　dbsearch.xml（内容は4.1または5.0の場合と同様）の内容を書き込んでください。


Tomcat4.1または5.0の場合【dbsearch.xml】 (サンプルはSET_FILE内dbsearch.xml)


Tomcat5.5の場合【dbsearch.xml】 (サンプルはSET_FILE内dbsearch55.xml)


【項目説明】
① driverClassName 管理ＤＢ用のＪＤＢＣドライバのクラス名を指定します。
② url 管理ＤＢにＪＤＢＣ接続する際のデータベースＵＲＬを指定します。
③ maxActive プール中の最大接続数を指定します(0を指定すると無制限になります)
④ maxIdle プール中の使用されていない接続の最大値を設定します(0を指定すると無制限になります)
⑤ maxWait プール中の接続が全て使用されている場合、接続が使用可能になるまで待つ時間をミリ秒単位で指定します(-1を指定すると無制限になります)
⑥ userName 管理ＤＢに接続する際のＤＢユーザ名を指定します。
⑦ password ⑥で指定したＤＢユーザ名のパスワードを指定します。

Tomcat4.0の場合【server.xml】


(B)init_dbsearch.xml
init_dbsearch.xmlは検索小町用の初期設定ファイルです。

下図の赤で囲んだデータは必ず変更する必要がある項目です。
それ以外の項目は必要に応じて変更してください。

変更したファイルはdbsearchディレクトリにおいてください。

【init_dbsearch.xml】


【項目説明】
7行目 LOG_FILEPATH ログ出力先のディレクトリを設定します。
注）空白を含むディレクトリ名を使用することはできません。
8行目 UPLOAD_DIR 管理機能である一括処理用の作業ディレクトリです。
一時ファイルを置く（処理終了後削除されます）だけなので、特に支障がなければLOG_FILEPATHと同じディレクトリを指定してください。
注）空白を含むディレクトリ名を使用することはできません。
9行目 AUTO_TYPE EXCEL(CSV)出力時に文字列判定(※１参照)するのに用います。
0：文字列判定しません。
1：ＤＢ中に文字列型として登録されている項目を文字列として判定します。
2（またはタグ無し）：ＤＢ中に文字列型または日付型として登録されている項目を文字列として判定します。
OFF：EXCEL用の文字列指定を使用しません。
10行目 QUERY_TIMEOUT SQL実行時の最大時間（単位：分）を指定します。指定時間を越えると検索はキャンセルされます。（キャンセル対応ＤＢのみ）
設定が不要の時はこのタグを消去するか、0を指定してください。
11行目 MAX_OUTPUT 最大検索件数を指定します。指定行数を超える検索はできなくなります。
設定が不要の時はこのタグを消去するか、0を指定してください。
12行目 PASSWORD_CHAR パスワードに使用する文字種を指定します。
0（またはタグ無し）：特に指定しません。
1：アルファベット必須
2：アルファベットと数字必須
3：アルファベットと数字と記号必須
13行目 PASSWORD_LENGTH パスワードの最低文字数を指定します。
設定が不要の時はこのタグを消去するか、0を指定してください。
14行目 TABLE_SORT テーブルの一覧表示で、名前順にソートしたい時は１を指定します。
設定が不要の時はこのタグを消去するか、0を指定してください。
15行目 RETSU_SORT 列の一覧表示で、名前順にソートしたい時は１を指定します。
設定が不要の時はこのタグを消去するか、0を指定してください。
16行目 AUTO_SKIP ユーザ種別が検索１（カタログ検索のみ使用可能）のユーザで利用できるＤＢが１つしかない場合、ログイン時にメニュー画面に遷移せずに直接カタログ検索画面に遷移します。
設定が不要の時はこのタグを消去するか、0を指定してください。
17行目 MEMORY_MODE 検索結果が複数ページにまたがる場合の処理方法を指定します。
0（またはタグ無し）：検索結果をメモリに保存しておくのでページ遷移の際の検索が他の場合より速くなります。
1：検索結果を一時ファイルに保存し利用するので、メモリは少ないけどページ遷移の際の検索速度を速くしたい場合に用います。
2：ページ遷移のたびに検索実行するので他の場合より遅くなります。メモリもディスクも容量が足りない場合に用います。
18行目 LOG_CHECK_MONTH 指定した月数以上にログが残っている場合に管理者がロクインしたときに警告メッセージを出します。
0（またはタグ無し）：警告しません
19行目 EXCEL_KUGIRI_MOJI CSVに出力するときの区切り文字を指定します。
タグ無し：\t(タブ)が指定されたものとします。

※１
　　CSVファイルを開く際にExcel側で表示形式の自動判定を行うため表示内容が変わってしまう場合があります。

　　 (1)頭に0がつく数字の表示（例えば03が3と表示されます）
　　　　　これは、03が文字列としてではなく数値としてExcelに自動判定されるためです。

　　 (2)日付の表示（例えば09/28が9月28日等と表示されます）
　　　　　これは、09/28が文字列としてではなく日付としてExcelに自動判定されるためです。
　
　　このような場合にAUTO_TYPEを用いると文字列として判定させ表示することができます。
　　AUTO_TYPEを1にすると(1)を文字列として判定、
　　AUTO_TYPEを2にすると(1)(2)の両方を文字列として判定します。

　　CSVファイル出力時にEXCELで表示できるように="aaa"のように加工しています。純粋なCSVファイルを出力したい場合はAUTO_TYPE="OFF"を指定してください。

(C)init_dbsearch_batch.xml
init_dbsearch_batch.xmlはバッチ処理を利用する際に用いる初期設定ファイルです。
バッチ処理を利用しない場合は設定の必要はありません。

下図の赤で囲んだデータは必ず変更する必要がある項目です。
青で囲んだデータはＤＢサーバの負荷軽減のためにＳＱＬ実行のタイムアウトを設定する項目です。
ユーザ様のシステム環境にあわせて必要があれば変更してください。

変更したファイルはdbsearchディレクトリにおいてください。

【init_dbsearch_batch.xml】


【項目説明】
① DRIVER_CLASS_NAME 管理ＤＢ用のＪＤＢＣドライバのクラス名を指定します。
(dbsearch.xmlのdriverClassNameと同じものを設定します)
② DB_URL 管理ＤＢにＪＤＢＣ接続する際のデータベースＵＲＬを指定します。
(dbsearch.xmlのurlと同じものを設定します)
③ DB_USERNAME 管理ＤＢに接続する際のＤＢユーザ名を指定します。 (dbsearch.xmlのuserNameと同じものを設定します)
④ DB_PASSWORD ③で指定したＤＢユーザ名のパスワードを指定します。 (dbsearch.xmlのpasswordと同じものを設定します)
⑤ COM_DIR バッチコマンド用ファイルを保存するディレクトリを指定します。
注）空白を含むディレクトリ名を使用することはできません。
⑥ QUERY_TIMEOUT ＳＱＬ実行タイムアウト時間（単位は秒）を指定します。
タイムアウト時間をすぎると実行中のＳＱＬは自動的にキャンセルされます。
0が指定してある場合、またはこの項目自体がファイル中にない場合はキャンセルしません。
注）ＤＢＭＳ及びＪＤＢＣドライバがキャンセル対応できていないと、設定したタイムアウト時間が無視される場合があります。

2_5.起動確認
Tomcatを起動してブラウザ上から下記のようなＵＲＬ（赤字で囲んだ部分はＷＥＢ環境に合わせて変更してください）を入力し検索小町のログイン画面（評価版）が表示されるかどうか確認してください。
この画面でユーザＩＤにadmin、パスワードにtestを指定してログインを行うと、管理者用のメニュー画面に移動することができます。

【ＵＲＬ】


【ログイン画面（評価版）】


2_7.管理データ作成
ユーザ様の環境に応じ下記のような管理データを検索小町上で作成してください。
作成の仕方は管理機能マニュアルを参照してください。
（ＷＥＢ画面上で設定することもできますし、ＣＳＶファイルを用いて設定することもできます。）

(A)ＤＢ関連の管理データ
検索対象となるＤＢ、及びＤＢ中のテーブル・列情報（ＧＵＩ検索画面中で利用）

(B)ユーザ関連の管理データ
システムをご利用になるエンドユーザの方の情報（接続できるＤＢの情報を含む）
注）評価版ではユーザ情報はあらかじめ登録されている管理者の方を含め５人までしか登録できません