クライアントツール

FileBlogサーバーに[fileblogclient.exe]というコマンドラインツールが含まれています。

 [インストールフォルダ]\bin\fileblogclient.exe

動作環境

  • FileBlogサーバーを除く任意のWindows PCで動作します。

  • FileBlogに接続できることが必要です。

使用準備

  1. fileblogclient.exeをクライアントPCの任意のフォルダに配置します。

  2. PCのコマンドプロンプトを開いて、fileblogclient.exeを引数なしで実行します。

    • fileblogclient.exeのあるフォルダに、fileblogclient.config.jsonファイルが作成されます。

    • コマンドプロンプト画面に表示されるRequired command was not provided.は無視してください。

  3. fileblogclient.config.jsonファイルをテキストエディターで開いて3つの値を編集します。

    • Address: FileBlogに接続するためのURL

    • UserID: FileBlogのログインに使用するユーザーID

    • Password: FileBlogのログインに使用するパスワード

    {
      "Connection": {
        "Address": "http://127.0.0.1/fileblog/",
        "UserId": "user@contso.com",
        "Password": "password",
        "Proxy": {
          "Address": "",
          "UserId": "",
          "Password": ""
        }
      }
    }
    
  4. ProxyはFileBlogに接続するのにプロキシを介している場合に、そのAddress UserID Passwordを設定します。

  5. 編集が完了したら上書き保存します。

セキュリティ設定

fileblogclient.config.jsonファイルにはWindowsユーザーアカウントのIDとパスワードが平文のまま保存されます。

fileblogclient.exeを実行するユーザー以外にはアクセス権を与えないようにしてください。アクセス権限はWindowsエクスプローラで設定します。

  1. fileblogclient.exeを右クリックしてプロパティを表示します。

  2. [セキュリティ]タブを開いてアクセス権設定をします。

    • 既定で登録されている不要なユーザーやグループを削除します。

    • 実行ユーザーのみに明示的にアクセス権を付与します。

    • 場合にはよっては継承の無効化が必要です。

タグ情報をインポートする

CSVファイルでタグの一括登録ができます。

fileblogclient.exe tag import <CsvPath>
  • <CsvPath>は、D:\output\tagsimport.csvのように実在するCSVファイルのパスを指定します。

  • 指定されたCSVファイル(UTF-8)に記述される複数のファイル/フォルダのタグを登録します。

  • CSVファイルは[ファイル操作 > 一覧出力 > タグエクスポート(CSV形式)]で出力される形式を使用します。

エラーログも出力する

CSVファイルの取り込みに失敗した行を抽出するには次のコマンドを実行します。

  1. コマンドプロンプト画面にエラーを表示させるコマンドです。

    fileblogclient.exe tag import <CsvPath> 2>&1
    
  2. ファイルをエラーを出力させるコマンドです。(コマンドプロンプト画面には表示されません)

    fileblogclient.exe tag import <CsvPath> > <OutPath> 2>&1
    
    • <OutPath>は、c:\work\result.txtのような出力先のパスを指定します。

タグ情報をエクスポートする

CSVファイルにタグ情報を一括出力することができます。

fileblogclient.exe tag export <dir> <CsvPath>
  • <dir>は、対象フォルダを/DocRoot/ShareのようにVFSパスで指定します。

  • <CsvPath>は、D:\work\tag-output.csvのように出力先のファイルパスを指定します。

コマンドにオプションを用意しています。

オプション

説 明

--Keyword <Keyword>

pathに指定したフォルダ以下を対象として検索した結果のファイル/フォルダのタグを出力します。

<Keyword>には検索キーワードを指定します。

--List

pathに指定したフォルダ以下のファイル/フォルダのタグを出力します。

--Recurseの指定によりサブフォルダ以下も対象にします。

--Keywordを併用できません。

--Recurse

pathに指定したフォルダ以下を再帰的に探索するかどうかを指定します。

--List指定において機能します。

--Tags <Tags>

出力するタグ名称(フィールド名)をカンマ区切りで指定します。省略時は全タグを出力します。指定したタグ名称の並び順は出力結果に影響しません。

--Size

ファイルサイズも出力します。

--LastWriteTime

ファイル更新日時も出力します。

--ExcluedHidden

隠し属性ありのファイル/フォルダを出力しません。

指定フォルダのタグ情報を出力する

フォルダを指定してタグ情報を一括出力します。

  1. 指定したフォルダの直下にあるファイル/フォルダのタグ情報を出力します。

    fileblogclient.exe tag export <dir> <CsvPath> --List
    
  2. 指定フォルダの直下とサブフォルダ以降にあるファイル/フォルダのタグ情報を出力します。

    fileblogclient.exe tag export <dir> <CsvPath> --List --Recurse
    
  3. 出力対象にサブフォルダを含めるが、隠し属性ありのファイル/フォルダは含めないで出力します。

    fileblogclient.exe tag export <dir> <CsvPath> --List --Recurse --ExcludeHidden
    
  4. 出力対象にサブフォルダは含めず、サイズ、更新日時を含めて出力します。

    fileblogclient.exe tag export <dir> <CsvPath> --List --Size --LastWriteTime
    

検索結果のタグ情報を出力する

検索結果にあるファイル/フォルダのタグ情報を一括出力します。

fileblogclient.exe tag export <dir> <CsvPath> --Keyword <Keyword>

<Keyword>に検索キーワードを指定します。

  1. 指定フォルダにてキーワード仕様書で全文検索した結果のタグ情報を出力します。

    fileblogclient.exe tag export /DocRoot/share D:\output\tags.csv --Keyword 仕様書
    
  2. 指定フォルダの階層に含まれるフォルダのみのタグ情報を出力します。

    fileblogclient.exe tag export /DocRoot/share D:\output\tags.csv --Keyword "type:folder"
    

タグを指定して出力する

指定したタグ項目のみの情報を一括出力します。

fileblogclient.exe tag export <dir> <CsvPath> --Tags <Tags>

<Tags>にタグ項目のフィールド名を指定します。

  1. 指定フォルダにてタグ項目tfb_descriptionのみのタグ情報を出力します。

    fileblogclient.exe tag export /DocRoot/share D:\output\tags.csv --List --Tags tfb_description,tfb_comment 
    
  2. 全対象にタグ項目tfb_descriptionとtfb_commentのみのタグ情報を出力します。

    fileblogclient.exe tag export / D:\output\tags.csv --List --Recurse --Tags tfb_description,tfb_comment 
    

アーカイブを実行する

CSVファイルでアーカイブの一括実行ができます。

fileblogclient.exe timestamp archive <CsvPath> <ResultCsvPath>
  • <CsvPath>は、D:\output\archive.csvのように実在するCSVファイルのパスを指定します。

  • <ResultCsvPath>は、D:\output\result.csvのように出力するファイルパスを指定します。

  • 指定されたcsvファイル(UTF-8)に記述される複数ファイルを対象にアーカイブ(タイムスタンプ付与)機能を実行します。

  • 各ファイルのアーカイブの成否は<ResultCsvPath>に指定したCSVファイルに出力されます。

    • なお1ファイルでもアーカイブに失敗すると、「Failed to archive some files. (Exception)」のエラーを出力します。