サーバーツール
FileBlogサーバーには[FileBlog.exe]というコマンドラインツールが含まれています。
[インストールフォルダ]\bin\fileblog.exe
コマンドラインツールの実行準備
文書数のカウントを実行する
検索対象文書数のカウントのみを対象にインデックス再構築のクロール処理のみを実行することができます。
インデックス初期構築前や検索除外の設定後に検索対象文書数の調査・確認ができます。
fileblog.exe publish crawlonly <dir>
アクセスログをCSV変換する
出力されるアクセスログファイルはLTSV形式です。 Excelなどを使って集計するときはツールを使用してCSV形式に変換してください。
fileblog.exe accesslog converttocsv
このコマンドを実行するとツールがCSV変換を実行します。
アクセスログフォルダにある全アクセスログファイルをCSV形式に変換して保存します。
列順が統一されます。
CSVファイルの出力先フォルダです。
[AppData]\AccessLog\Log\csv
タグ情報をインポートする
CSVファイルをインポートすることでファイル/フォルダにタグ情報を一括登録することができます。
fileblog.exe tag import <CsvPath>
エラーログも出力する
CSVファイルの取り込みに失敗した行を抽出するには次のコマンドを実行します。
コマンドプロンプト画面にエラーを表示させるコマンドです。
fileblog.exe tag import <CsvPath> 2>&1
ファイルにエラーを出力させるコマンドです。(コマンドプロンプト画面には表示されません)
fileblog.exe tag import <CsvPath> > <OutPath> 2>&1
<OutPath>
は、c:\work\result.txt
のような出力先のパスを指定します。
タグ情報をエクスポートする
CSVファイルにタグ情報を一括出力することができます。
fileblog.exe tag export <dir> <CsvPath>
<dir>
は、対象フォルダを/DocRoot/Share
のようにVFSパスで指定します。<CsvPath>
は、D:\work\tag-output.csv
のように出力先のファイルパスを指定します。
コマンドにオプションを用意しています。
オプション |
説 明 |
---|---|
--Keyword <Keyword> |
pathに指定したフォルダ以下を対象として検索した結果のファイル/フォルダのタグを出力します。
|
--List |
pathに指定したフォルダ以下のファイル/フォルダのタグを出力します。
|
--Recurse |
pathに指定したフォルダ以下を再帰的に探索するかどうかを指定します。
|
--Tags <Tags> |
出力するタグ名称(フィールド名)をカンマ区切りで指定します。省略時は全タグを出力します。指定したタグ名称の並び順は出力結果に影響しません。 |
--Size |
ファイルサイズも出力します。 |
--LastWriteTime |
ファイル更新日時も出力します。 |
--ExcluedHidden |
隠し属性ありのファイル/フォルダを出力しません。 |
--FileHash |
ファイルのハッシュ値を出力します。 |
指定フォルダのタグ情報を出力する
フォルダを指定してタグ情報を一括出力します。
指定したフォルダの直下にあるファイル/フォルダのタグ情報を出力します。
fileblog.exe tag export <dir> <CsvPath> --List
指定フォルダの直下とサブフォルダ以降にあるファイル/フォルダのタグ情報を出力します。
fileblog.exe tag export <dir> <CsvPath> --List --Recurse
出力対象にサブフォルダを含めるが、隠し属性ありのファイル/フォルダは含めないで出力します。
fileblog.exe tag export <dir> <CsvPath> --List --Recurse --ExcludeHidden
出力対象にサブフォルダは含めず、サイズ、更新日時、ハッシュ値を含めて出力します。
fileblog.exe tag export <dir> <CsvPath> --List --Size --LastWriteTime --FileHash
検索結果のタグ情報を出力する
検索結果にあるファイル/フォルダのタグ情報を一括出力します。
fileblog.exe tag export <dir> <CsvPath> --Keyword <Keyword>
<Keyword>
に検索キーワードを指定します。
指定フォルダにてキーワード
仕様書
で全文検索した結果のタグ情報を出力します。fileblog.exe tag export /DocRoot/share D:\output\tags.csv --Keyword 仕様書
指定フォルダの階層に含まれるフォルダのみのタグ情報を出力します。
fileblog.exe tag export /DocRoot/share D:\output\tags.csv --Keyword "type:folder"
タグを指定して出力する
指定したタグ項目のみの情報を一括出力します。
fileblog.exe tag export <dir> <CsvPath> --Tags <Tags>
<Tags>
にタグ項目のフィールド名を指定します。
指定フォルダにてタグ項目
tfb_description
のみのタグ情報を出力します。fileblog.exe tag export /DocRoot/share D:\output\tags.csv --List --Tags tfb_description,tfb_comment
全対象にタグ項目
tfb_descriptionとtfb_comment
のみのタグ情報を出力します。fileblog.exe tag export / D:\output\tags.csv --List --Recurse --Tags tfb_description,tfb_comment
アーカイブを一括実行する
CSVファイルの指定で複数ファイルのアーカイブを一括実行することができます。 アーカイブ機能の使用にはオプションライセンスが必要です。
fileblog.exe timestamp archive <CsvPath> <ResultCsvPath>
<CsvPath>
には対象CSVのファイルパスを指定します。例)D:\work\archive.csv
<ResultCsvPath>
には成否結果を出力するファイルパスを指定します。例)D:\work\result.txt
CSVファイルの仕様
エンコーディングはUTF-8です。
1行目はヘッダーで
__PATH__
を記述します。2行目以降に
/
で始まるファイルパス(VFSパス)を記述します。WEBドキュメントルートの指定はできません。
__PATH__
/DocRoot/aaa/bbb.pdf
/DocRoot/aaa/ccc.pdf
結果の見方
実行後に5項目の結果が出力されます。
INPUTPATH,SUCCEEDED,DETAIL,OUTPUTPATH,BACKUPPATH
/Docs/working/invoice.pdf,True,,/Docs/archives/invoice.pdf,/Docs/original/invoice.pdf
列名 |
説明 |
---|---|
INPUTPATH |
アーカイブ対象ファイルパス |
SUCCEEDED |
成否(TRUE/FALSE) |
DETAIL |
失敗時のエラーメッセージ |
OUTPUTPATH |
アーカイブ先のファイルパス |
BACKUPPATH |
原本保存先のファイルパス |
抽出失敗ファイルを探す
検索インデックスに用いる全文テキストの抽出や、プレビュー作成に失敗したファイルを探して、それらを対象にインデックス再構築やプレビュー作成を実行することができます。
全文テキストの抽出に失敗したファイルを探す
fileblog tpi search bodyerrortext <dir> <CsvPath> [options]
プレビュー作成に失敗したファイルを探す
fileblog tpi search errortext <dir> <CsvPath> [options]
<dir>
は、対象フォルダを/DocRoot/Share
のようにVFSパスで指定します。<CsvPath>
は、D:\work\fail-output.csv
のように出力先のファイルパスを指定します。オプション
説 明
--Pattern <Pattern>
正規表現パターンで指定します。bodyerror.txt(失敗原因ファイル)の内容で正規表現パターンに適合するものだけを抽出します。省略時はプレビュー抽出に失敗した全てのファイルパスが出力されます。
オプションを指定したコマンド例です。
fileblog tpi search bodyerrortext /DocRoot/Share D:\work\fail-output.csv --Pattern ".*limit.*"
全文テキストの抽出とプレビュー作成を実行する
取得したCSVファイルにあるパスに対してインデックス再構築やプレビュー作成を実行できます。
全文テキストを抽出してインデックス再構築を実行する
fileblog publish text-batch <CsvPath> [options]
オプション
説 明
--force
オプション指定がないと最新のテキスト抽出情報のないファイルに対して抽出を実行しインデックス登録します。指定があると対象ファイルの全てに対してテキスト抽出とインデックス登録を実行します。
プレビュー作成を実行する
fileblog publish preview-batch <CsvPath> [options]
オプション
説 明
--force
オプション指定がないとプレビュー作成が最新でないファイルに対して作成を実行します。指定があると対象ファイルの全てに対してプレビュー作成を実行します。
--previewconfig <pcDefault | pcFileView>
pcDefault
を指定するとサムネイルのみ作成します。pcFileView
を指定するとサムネイルとプレビューを作成します。オプション指定のない場合はサムネイルとプレビューを作成します。
<CsvPath>
は、CSVファイル(UTF-8形式)のパスを指定します。
CSVは1行目に列名として
__Path__
を指定します。CSVの2行目以降はファイルパスを
/DocRoot/Share/foo.pdf
のようなVFSパスで指定します。
オプションを指定したコマンド例です。
fileblog publish preview-batch D:\work\fail-output.csv --force --previewconfig pcFileView
プレビュー保存フォルダを掃除する
プレビュー保存フォルダには運用中に出力されたファイルが保存されています。 それらファイルを一括削除することができます。
erroru.txt を削除する
プレビュー作成の失敗時に記録されるファイルです。
fileblog.exe tpi purge errortext <dir>
<dir>
では対象フォルダをFileBlogのVFSパスで指定します。例)
/DocRoot/Smaple/Test
bodyerror.txt を削除する
インデックス登録用にファイルからテキスト抽出したときの失敗時に記録されるファイルです。
fileblog tpi purge bodyerrortext <dir>
bodyu.txt・bodyerror.txt の両方を削除する
bodyu.txt
はインデックス登録用にファイルから抽出したテキスト情報です。
fileblog.exe tpi purge bodytext <dir>
プレビューファイルを削除する
サムネイル・プレビュー用のファイルです。
fileblog.exe tpi purge preview <dir>
プレビュー保存フォルダ内のファイルを削除する
errou.txt
bodyerror.txt
bodyu.txt
プレビューファイル
を削除します。
fileblog.exe tpi purge all <dir>
削除するファイル形式を指定する
fileblog.exe tpi purge bodytext <dir> --mask *.pdf;*.tiff
--mask
で拡張子を指定します にて、 *.docx
や*.xlsx;*.pptx
のように単数また複数の拡張子を指定します。
検索インデックスデータを掃除する
指定したパスに対応する検索インデックスデータを削除するコマンドです。
fileblog.exe solr purgeindex --directory <dir>
<dir>
は対象フォルダをFileBlogのVFSパスで指定します。例)/DocRoot
インデックス構築後にドキュメントルート設定を削除すると、登録済みの検索インデックスデータは自動削除されず不要なデータとして残ります。
ごみ箱を掃除する
ごみ箱フォルダ内のファイルを一括削除するコマンドです。
fileblog files purgerecyclebin <DaysToKeep>
<DaysToKeep>
には数値(日数)を指定します。削除日時から指定値の日数が経過しているファイルが削除されます。
コマンド実行例 fileblog file purgerecyclebin 30
インデクサーを停止・開始する
Fb5Indexerサービス(インデクサー)の停止・開始を実行するコマンドです。
停止
fileblog.exe service stop --name indexer
開始
fileblog.exe service start --name indexer