ecmOutputFolders.bat  　　　　-d 文書空間識別子
　　　　　　　　　　　　　　　-u ユーザID
　　　　　　　　　　　　　　　-p パスワード
　　　　　　　　　　　　　　〔-b 検索対象のフォルダパス名〕
　　　　　　　　　　　　　　〔-f フォルダパスの区切り文字〕
　　　　　　　　　　　　　　〔-r〕
　　　　　　　　　　　　　　〔-a〕
　　　　　　　　　　　　　　〔-utf8〕
　　　　　　　　　　　　　　〔-?〕

検索対象に指定したフォルダの情報を，CSV形式で出力します。

-d 文書空間識別子

処理対象となる文書空間の文書空間識別子を指定します。

この引数は必ず指定してください。

-u ユーザID

システム管理者のIDを指定します。

この引数は必ず指定してください。

-p パスワード

システム管理者のパスワードを指定します。

この引数は必ず指定してください。

-b 検索対象のフォルダパス名

検索対象のフォルダパス名を指定します。フォルダのパスは「/」で区切って指定します。なお，区切り文字は引数「-f」で指定することもできます。

この引数の指定を省略した場合，最上位の階層の「文書フォルダ」が指定されたと判断されます。

引数「-b」の指定例を次に示します。

（指定例）

次のように指定すると，検索対象のフォルダは「東京営業部」となります。

-b△部門/営業部/東京営業部

（凡例）　△：半角スペース

-f フォルダパスの区切り文字

引数「-b」で指定した検索対象のフォルダパスの区切り文字を1文字で指定します。この引数の指定を省略すると，区切り文字を「/」とします。

-r

引数「-b」で指定したフォルダパス以下の下位フォルダも再帰的に検索して，CSVファイルを出力する場合に指定します。

引数「-r」を指定した場合に，CSVファイルに出力される順序を以下に示します。

1. フォルダ名の昇順で出力します。
2. フォルダの下位フォルダが存在する場合は，当該フォルダを出力したあと，先に下位フォルダを出力し，同一階層の続きのフォルダをフォルダ名の昇順で出力します。

-a

CSVファイルの出力結果に，フォルダのOIIDを含める場合に指定します。このオプションを指定した場合は，CSVファイルの最後の列にフォルダのOIIDを出力します。

-utf8

文書管理サーバの文字コード種別がUTF-8の場合に指定します。この引数の指定を省略した場合は，Shift-JISとして処理されます。文書管理サーバの文字コード種別がUTF-8の場合にこの引数の指定を省略すると，ログファイルの出力内容で文字化けが発生することがあります。

この引数を指定した場合，出力するCSVファイルの文字コード種別はUTF-8となります。CSVファイルにはBOMコードを含みます。

-?

このコマンドの使用方法を出力します。

この引数を指定すると，コマンドの使用方法の出力だけが行われ，フォルダ一覧のCSV出力はされません。

コマンドの戻り値を次の表に示します。

表6-14　文書一覧CSV出力コマンドの戻り値

戻り値	意味
0	検索条件を満たす文書がすべてCSV出力されました。
1	警告が発生しましたが，エラーなく最後までCSV出力されました。
-1	続行不可のエラーが発生しました。

このコマンドの実行例を次に示します。

ecmOutputFolders.bat△-d△2f44eb5e-e211-44f1-b8c0-b589b6fafa0d△-u△admin△-p△pass△-utf8

（凡例）△：半角スペース

フォルダ一覧CSV出力ファイルの格納フォルダとファイル名を次に示します。

• 格納フォルダ：{DocumentBroker Standard GUIのインストールフォルダ}\tools\out
• ファイル名：ecmOutFoldersYYYYMMDDhhmmss.csv
  ファイル名のYYYYMMDDhhmmssは，コマンドを実行した日付を表す文字列です。YYYYは西暦年号（4桁），MMは月（2桁），DDは日（2桁），hhは時（2桁），mmは分（2桁），ssは秒（2桁）になります。
  

フォルダ一覧CSV出力ファイルの出力形式と実行結果の例を次に示します。

ヘッダ行とレコード行の出力形式

カラム名およびデータの出力内容とカラム番号の対応を次の表に示します。

表6-15　カラム名およびデータの出力内容とカラム番号の対応（フォルダ一覧CSV出力コマンド）

カラム番号	カラム名※1	データの出力内容
1	登録結果	なし
2〜11	フォルダ名_<n>※2	1階層目から10階層目までのフォルダ名が出力されます。
12	フォルダ種別	フォルダ種別が，次に示す値で出力されます。 1：ノードフォルダ 2：文書フォルダ 3：公開フォルダ
13	所有者ID	フォルダの所有者のIDが出力されます。
14	ユーザの表示名称	フォルダの所有者の名称が出力されます。
15	コメント	フォルダのコメントが出力されます。
16	文書作成可否	指定したフォルダに文書が作成できるかどうかを，次に示す値で出力します。 0：文書が作成できない 1：文書が作成できる ノードフォルダまたは公開フォルダの場合は，何も出力されません。
17	アクセス権限方式	文書フォルダのアクセス権限方式を，次に示す値で出力します。 1：個別に設定 2：同じ権限を共有 ノードフォルダまたは公開フォルダの場合は，何も出力されません。
18	公開範囲	公開フォルダの公開範囲を，次に示す値で出力します。 1：全員に公開する 2：公開範囲を限定する ノードフォルダまたは文書フォルダの場合は，何も出力されません。
19	文書種別	文書種別の名称を出力します。
20	フォルダ下に登録可能な容量	最上位の階層に文書フォルダまたはノードフォルダが作成されている場合で，そのフォルダに対して容量制限がされているときに出力されます。 容量は，数値と単位を続けて出力します。 数値は1〜9999の範囲で出力します。 単位にはMB（メガバイト），GB（ギガバイト）またはTB（テラバイト）を出力します。 出力例 500MB
21	全てのユーザに対するアクセス権限	アクセス権限方式が「個別に設定」の文書フォルダの場合に，「全てのユーザ」に設定されているアクセス権を，次の値で出力します。 FULL_CONTROL：「全て」 READ_WRITE：「更新」 LINK：「リンク」 READ：「参照」 NONE：「なし」 「同じ権限を共有」の場合，および公開フォルダの場合で「公開範囲を限定」のときは，「NONE」が出力されます。 公開フォルダの場合で「全員に公開」のときは，「FULL_CONTROL」が出力されます。
22	アクセス権限リスト	アクセス権限方式が「個別に設定」のフォルダの場合に，フォルダに設定されたアクセス権の値が出力されます。 「同じ権限を共有」，または公開フォルダの場合で「公開範囲を限定」のときは，共有元となるフォルダのアクセス権が出力されます。公開フォルダの場合で「全員に公開」のときは，何も出力されません。 ＜アクセス権指定＞/＜アクセス権指定＞/… ＜アクセス権指定＞を「/（スラント）」で区切って出力します。 ＜アクセス権指定＞の形式を次に示します。「設定対象ID」，「種別」，「アクセス権」を「:（コロン）」で区切って出力します。 設定対象ID:種別:アクセス権 各項目の内容を次に示します。 「設定対象ID」：アクセス権の設定されているユーザ／組織／グループのIDを出力します。 「種別」：設定対象IDの種別を次に示す値で出力します。 U：ユーザの場合 G：組織またはグループの場合 「アクセス権」：設定対象に設定されているアクセス権を次に示す値で出力します。 「全て」の場合：「FULL_CONTROL」 「更新」の場合：「READ_WRITE」 「リンク」の場合：「LINK」 「参照」の場合：「READ」 「なし」の場合：「NONE」 出力例 user01:U:READ/grp01:G:READ_WRITE
23	OIID	-aオプションを指定した場合だけ出力されます。 フォルダのOIIDを「dma:///〜」から始まる133バイトの文字列の形式で出力します。

注※1

フォルダ一覧CSV出力ファイルのカラム名を次に示します。一行目にはヘッダ行を出力します。また，値の有無に関わらず，すべてのカラムを出力します。

登録結果,フォルダ名_1,フォルダ名_2,フォルダ名_3,フォルダ名_4,フォルダ名_5,フォルダ名_6,フォルダ名_7,フォルダ名_8,フォルダ名_9,フォルダ名_10,フォルダ種別,所有者ID,ユーザの表示名称,コメント,文書作成可否,アクセス権限方式,公開範囲,文書種別,フォルダ下に登録可能な容量,全てのユーザに対するアクセス権限,アクセス権限リスト(,OIID)

注※2

<n>はフォルダの階層を示す1〜10の半角の整数値です。

実行結果

フォルダ一覧CSV出力ファイルの実行結果の例を次に示します。

登録結果,フォルダ名_1,フォルダ名_2,フォルダ名_3,フォルダ名_4,フォルダ名_5,フォルダ名_6,フォルダ名_7,フォルダ名_8,フォルダ名_9,フォルダ名_10,フォルダ種別,所有者ID,ユーザの表示名称,コメント,文書作成可否,アクセス権限方式,公開範囲,文書種別,フォルダ下に登録可能な容量,全てのユーザに対するアクセス権限,アクセス権限リスト,OIID "","1","","","","","","","","","","2","admin","セキュリティ管理者(admin)","","1","1","","","","NONE","","dma:///07a17522-a626-11d0-b11f-0020af27a837/673d2be0-d1fd-11d0-ab59-08002be29e1d/86238c66-6b6c-4487-bf34-181e6966af7c0000000000001A50" "","1","21","","","","","","","","","2","admin","セキュリティ管理者(admin)","","1","1","","","","NONE","","dma:///07a17522-a626-11d0-b11f-0020af27a837/673d2be0-d1fd-11d0-ab59-08002be29e1d/86238c66-6b6c-4487-bf34-181e6966af7c0000000000001A52" "","1","21","2131","","","","","","","","2","admin","セキュリティ管理者(admin)","","1","1","","","","NONE","","dma:///07a17522-a626-11d0-b11f-0020af27a837/673d2be0-d1fd-11d0-ab59-08002be29e1d/86238c66-6b6c-4487-bf34-181e6966af7c0000000000001A55" 　　　： 　　　：

コマンドの実行経過はログファイルに出力されます。

• 出力先
  {DocumentBroker Standard GUIのインストールフォルダ}\tools\log\ecmOutputFolders.log
  
• 出力形式
  

  YYYY/MM/DD hh:mm:ss　message

  YYYY/MM/DD hh:mm:ss

  メッセージが出力された日時

  message

  コマンドの経過情報

ログファイルは，コマンドを実行するごとに情報が蓄積され，ファイルサイズが増加します。このため，運用時は，定期的にバックアップを取得したあとにログファイルを削除するなどして，ファイルサイズが大きくなり過ぎないようにしてください。

• このコマンドはシステム管理者が実行してください。システム管理者以外のユーザは実行しないでください。
• コマンドの実行時に引数の指定に誤りがある場合，引数「-?」を指定したときと同様に，コマンドの使用方法が出力されます。
• このコマンドは，Webサーバおよび文書管理サーバは起動したまま（＝DocumentBroker Serverサービスは起動したまま）で実行できます。ただし，このコマンドを実行中に，データベースの内容が変更された場合の出力結果は，変更前，変更後のどちらかの値となります。このため，正確な実行結果が必要な場合は，Internet Information ServicesまたはCosminexus HTTP Serverを停止するなど，データベースの変更が発生しない状態にしてから，コマンドを実行する必要があります。
• コマンドが起動できない場合，環境変数%MLD_HOME%が設定されているかを見直してください。
• このコマンドはCosminexusが提供するJDKを使用します。そのため，{Cosminexusのインストールフォルダ}\jdk\bin下にあるJDKが優先されるように環境変数PATHを設定してください。
• コマンドプロンプトの画面上に出力されるメッセージ中に，Shift-JIS以外の文字コードが使用されたファイル名を含む場合は，該当文字が「？」などの文字に置き換わって出力されます。
• 対象となるフォルダ直下のフォルダ数に応じてメモリが必要となります。コマンドのメモリ所要量の計算式は，「2.2.1(6)　フォルダ一覧CSV出力コマンドのメモリ所要量」を参照してください。
• 対象となるフォルダ数に応じて，処理に時間がかかることがあります。
• 対象となるオブジェクト数の見積もりについては「付録B　オブジェクトカウントサンプルファイル」を参照してください。