DocuSleuthCompanion の
使い方

DocuSleuthCompanion の使い方

DocuSleuthCompanion は DocuSleuth システムの中核、検索を担当するアプリケーションです。サーバーというと通常とても設定等に手間がかかるイメージですが、DocuSleuthCompanion は非常に簡単に設定が完了します。

以下に使い方を示しますので、これを参考に設定してください。

システムの起動方法

基本的には、 DocuSleuthCompanion をスタート画面から選んで起動するだけで良いです。

システムの終了方法

左下にあるサーバー終了ボタンを押して下さい。すると、遅延書き込みバッファの中身を一式出力した上で終了します。

クローリング処理が動いている場合、遅延書き込みバッファに大量にデータが残っているため、終了に時間がかかります。PCのスペックによっては10分以上かかるケースもあります。

逆に、クローリングが終わり、遅延書き込みバッファも空になった状態では数秒程度で終了します。

また、検索処理が流れていると、検索が終わるまで終了出来ません。

システムメンテナンスなどで終了する予定がある場合、あらかじめクローリング設定画面でクローラーの動作を停止しておくことをお薦めします。クローラーが停止していれば、遅延書き込みバッファも少しずつ減っていきますので、終了時に待たされる可能性が減ります。

右上の [×] ボタンでも問題なく終了出来ますが、終了時の動作内容等が確認出来なくなるためお薦めはしません。

極力、サーバー終了ボタンで終了するようにして下さい。

細かい設定について

詳細な設定内容については以下で説明します。

初期画面

起動直後は、何も機能が選ばれていない状態です。

この画面の左側にコマンドが並んでいます。コマンドを選択すると、右側にコマンドに対応するタブが表示されますので、そこで詳細な設定を行います。

なお、基本的な設定は既に終わっています。なので、簡単に使いたい場合は、調査フォルダの追加/削除で文書のある場所を指定するだけで大丈夫です。

辞書の追加/削除（基本的にはデフォルトのままで良い）

ここでは、あいまい検索用の辞書を設定します。デフォルトはあいまい度合いが最小の類義語化レベル10000の辞書が選択されています。

こちらで試したところ、この辞書で十分にあいまい検索が出来ますので、よっぽどのことがない限り変える必要はありません。

類義語化レベルが小さくなるほどあいまい度合いが増えていきますので、今よりもさらにあいまいな検索がしたくなった場合は、類義語化レベルの小さい辞書を選択を検討してください。

また、複数の辞書を検索した場合は、複数の辞書での検索結果を総合した結果が検索結果になります。但し、ここまで来ると非常にコントロールが難しくなるので、推奨はしません。

デフォルト値のままでの利用を強く推奨します。

調査フォルダの追加/削除

ここでは、検索対象の文書がどこにあるかを設定します。

参照ボタンを押すとフォルダの選択ダイアログが表示されますので、そこで検索したいファイルのあるフォルダを指定してください。対象となるフォルダは複数指定可能ですが一度に指示は出来ません。一つづつ追加してください。

フォルダ選択後に追加ボタンを押して下さい。すると、エントリが表示されます。

なお、不要となった場合は、登録済のフォルダの右側にある削除ボタンを押して下さい。すると、エントリからファイルが削除されます。

注意）

フォルダを消した後、実際に全てのファイルが DocuSleuthCompanion の辞書から消されまで時間がかかります。利用する際の影響はほぼありませんが、すぐに消えるわけではない点、ご了承ください。

注意）

他のPCからも同じパス名でアクセス出来る場所を指定してください。例えばローカルのフォルダも指定出来ますが、そうすると他のPC空の検索リクエストが来たときに、他のPCから閲覧出来ないファイルを検索することで、検索結果が少なくなったり何も引っかからなくなったりします。

ですので、Windows のファイル共有(多くの場合は SMB)に対応したネットワーク上の共有フォルダを指定してください。

その場合、パス名は大抵 \\host-name\folder1\folder2 みたいな形になります。もし、D:\sample\data みたいな指定をしていると、例え共有していたとしても、指定したパス名で他のPCからアクセス出来ないため検索結果から除外されてしまいます。同じドライブレターで共有すれば問題はありませんが、素直にサーバーにアクセスする方がシンプルになって良いと思います。

検索結果が出ない場合、まず対象のファイルに DocuSleuth を動かしている PC からアクセスできるかどうかを確認してください。検索結果が表示されない原因の多くはこれになります。

検索用DBのファイル保存場所の変更

検索用DBは、任意の場所に保存出来るようになっています。

デフォルトの保存位置は以下になります。

[ユーザーのドキュメントフォルダ]\FuutaSystemService

このフォルダの直下に "DocuSleuthCompanion" というフォルダを作り、その中にDBを保存するようになっています。

このフォルダ以外に変更したい場合は、この画面で別のフォルダを指示してください。

フォルダ指示後、実行ボタンを押すと一旦システムが終了し、次回起動時より新しいフォルダにデータを保存するようになります。

なお、 DBの移行のところにあるコピーを実行するにチェックを入れておくと、終了時にDBのコピーも実施します。

多くの場合は、ここをチェックしておく方が良いでしょう。但し、ストレージのサイズの問題などでコピーが難し場合は、チェックを外してください。そうすると、フォルダの変更のみの動作となります。

注意事項）

ユーザーのドキュメントフォルダが OneDrive に置き換わっているケースがあります。これは、Microsoft がそのように誘導しているという事情もあり、特に一般のユーザーさんだとそのようなケースも多いかと思います。

OneDrive は DB のような大量のファイルが頻繁に修正されるような利用を想定していない様子です。また、OneDrive の処理が追いつかないと、ファイルの破損等、致命的な問題が起きることも考えられます。

つまりは、OneDrive は DocuSleuthCompanion のデータファイルのような使い方を想定していないようです。なので、OneDrive の管轄外のフォルダに保存するようにして下さい。

なお、試してはいませんが、Google Drive や DropBox といった類似のサービスも OneDrive 同様の設計思想であるように見えます。ですので、OneDrive に限らず、何らかのファイル同期システムが介在するフォルダをDBの保存先として設定しないでください。

注意事項）

DBへのアクセスは頻繁に発生します。ですので、極力ローカルのストレージに保存するようにして下さい。

検索対象ファイルの選択

ここでは、DocuSleuth システムが対象とするファイルが選択出来ます。

現時点では、Word, Excel, PowerPoint, PDF に対応しています。

デフォルトでは全てチェックされていますので、特に変更は不要かと思いますが、一部の種類のドキュメントだけにしたいというニーズがある場合はここで対応してください。チェックを外した時点でその書類は対象外となります。

削除処理自体はゆっくりと進みますので、削除が完了するまではしばらく余裕を見ておいてください。

実行状況

ここは、いわゆる稼働ログが出てきます。システムを管理する人が、システムの状況を確認するためのものです。

画面の上半分は、DB等の状況を表示するものです。詳細は将来加筆する予定ですが、現状、優先度を低くしております。申し訳ありません。

画面の下半分は、稼働ログそのものです。現状、ファイルに出力する機能は持っていません。ニーズがあればファイル出力機能についても検討します。

なお、自動更新をすると GUI が不安定になる現象が確認されています。そのため、現時点では自動更新ではなく手動更新という形にしています。「表示更新」ボタンを押すと最新の状態に更新するようになっています。

サーバーとして振る舞う以上、不安定になることは許容できません。不安定になる原因とその対処法が明らかになるまでは、自動更新処理は無効にする方針です。

実際に表示更新ボタンを押すと、例えばこのような画面になります。

細かい情報については後日追記していきますが、通常はここを参照することはまず無いと思います。稼働状態について気になったら、この画面の表示更新ボタンを押すと言うぐらいのイメージで問題はありません。

メンテナンス

システムに何らかの問題が発生したときに使う画面です。

クリアボタンを押すと、アプリケーションを終了し、同時に辞書も初期化します。

実際にこの画面を使うケースはほぼ無いと思いますが、非常時のため設置してあります。

なお、この機能と同様のことを手動で行いたい場合、データベースの保存パスにある "DocuSleuthCompanion" というフォルダを削除して頂いても同じ結果となります。

起動もしなくなった場合は、こちらをお試し下さい。

クローリング設定

検索対象のファイルを解析し、検索用のインデックスを作成する処理（＝クローリング）に関連する設定です。なお、クローリングという処理を行うモジュールをクローラーとここでは呼んでいます。

ここでは、以下のことが出来ます。

クローラーの動作
一時的にクローラーを止めたい場合、ここを停止として下さい。作動を選ぶまでクローラーは動作しません。
Index作成処理の並列度
ここでは、Index作成時に並列処理をどれだけ流すかを指定出来ます。なお、10まで設定は可能ですが、DBへの出力がどうしても並列では実施出来ないため、並列度を増やしても期待するほど処理時間の短縮は望めません。デフォルトでは、低スペックPCでの動作を考慮して 1 となっていますが、CPUパワーに余裕のあるPCで動作させる場合の推奨値は 4 です。
クローラー動作時刻の設定
ここでは、何時台にクローラーを動かすかを設定出来ます。クローラーの動作中は検索のレスポンスが悪化してしまいます。そのため、業務時間帯以外で動作するような設定を推奨します。
デフォルトでは、23時台～7時台までクローラーを動かすような設定になっています。多くの場合はこの設定で問題はないかと思いますが、業務内容に合わせて修正してください。
なお、画面を小さくするとはみ出てしまいますが、その場合はスクロールバーが表示されるようになります。

ヘルプ情報

この Web ページへのリンクが張ってあります。ブラウザが立ち上がりますので、マニュアルを参照したいときにご利用ください。

サブスクリプション購入について

試行期間中は、同時利用ユーザー数が2に制限されます。これを増やしたい場合、サブスクリプション購入が必要となります。サブスクリプションを購入することで、上限値を10に増やすことが出来ます。

サブスクリプションの購入は Microsoft Store 上からも出来ますが、ここではアプリケーションから購入する方法を紹介します。

画面の下部にあるサブスクリプション購入(1ヶ月分) もしくはサブスクリプション購入(1年分) を押して下さい。購入用のダイアログが表示されます。

価格は、10名・1ヶ月で2,000円、10名・1年で20,000円となっております。

その他注意事項

実際にファイルが削除された場合の動作

実際にファイルが削除された（＝見つからなくなった状態）場合であっても、検索用DB内のデータは10日間保存されます。

これは、ファイルサーバーのダウンなど「見つからなくなったが削除されたわけではない」状態を考慮しての処理となっています。

サーバーがダウンするケースは実際にあり得るものですが、多くの場合、10日もあれば復旧するかと思います。

逆に、10日で復旧しないのであれば、DBのクローリング処理を止めていただき（クローリング設定の項目を参照）、ファイルサーバーの復活までは Index 関連の処理を一時的に停止してください。

もちろん、放置していても復活したタイミングで再度 Index を作りにいきますが、Index 作成処理は時間がかかるためお薦めはしません。

GUI の応答時間について

WinUI 上でメモリを大量に使うプログラムを作成したときの問題として、応答時間が非常に長くなり、フリーズしているように見えるというものがあります。

DocuSleuthCompanion では、この症状はクローリング中に頻繁に発生します。

もし、クローリング中に GUI で操作したくなった場合は次のような操作をして下さい。

画面をマウスでクリックしたり、コマンドを選択をする。

これがトリガーとなり、GUIの応答時間が短くなる様子です。但し、ちょっとでも時間が空くとまた GUI の応答が悪くなりますので、GUI 操作をするときはクローリングを一旦止めていただくことをお薦めします。

Page updated

Report abuse