ecmOutputDocuments.bat文書一覧CSV出力

形式

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

機能

指定した検索条件を基に検索を実行し,ヒットした文書の一覧および属性情報をCSV形式で出力します。

コマンド引数

-d 文書空間識別子

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

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

-u ユーザID

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

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

-p パスワード

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

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

-s 検索条件ファイルのフルパス名

検索条件ファイルのフルパス名を指定します。検索条件ファイルには,出力対象となる文書の検索条件を記述します。検索条件ファイルの詳細は,「6.3.5 文書一覧CSV出力コマンドで使用するファイル」を参照してください。

指定を省略した場合は,検索条件を追加しないで検索します。

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

検索対象のフォルダパス名を指定します。

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

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

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

(指定例)
次のように指定すると,検索対象のフォルダは「東京営業部」となります。
-b△部門/営業部/東京営業部

(凡例) △:半角スペース

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

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

-r

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

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

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

-v

文書のすべてのバージョンを出力する場合に指定します。

この引数の指定を省略すると,最新のバージョンの情報だけが出力されます。

-a

CSVファイルの出力結果に,文書のバージョンのOIIDなどを含める場合に指定します。このオプションを指定した場合は,CSVファイルの最後の列に文書のOIIDを出力します。

-utf8

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

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

-?

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

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

戻り値

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

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

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

実行例

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

ecmOutputDocuments.bat△-d△2f44eb5e-e211-44f1-b8c0-b589b6fafa0d△-u△admin△-p△pass△-s△C:¥work¥search.txt△-utf8

(凡例)△:半角スペース


文書一覧CSV出力ファイル

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

文書一覧CSV出力ファイルのフォーマット

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

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

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

表6-13 カラム名およびデータの出力内容とカラム番号の対応(文書一覧CSV出力コマンド)

カラム番号カラム名※1データの出力内容
1登録結果なし
2~11フォルダ名_<n>※21階層目から10階層目までのファイル名が出力されます。
12空文字空文字が出力されます。
13所有者ID文書の所有者のIDが出力されます。
14ユーザの表示名称文書の所有者の名称が出力されます。
15採番結果文書の登録時に文書番号を採番した場合に,採番した文書番号が出力されます。
文書番号を採番しない場合は,何も出力されません。
16ファイル名主ファイルのファイル名が出力されます。
17文書名文書名が出力されます。
18コメント文書のコメントが出力されます。
19文書種別文書種別名が出力されます。
20全てのユーザに対するアクセス権限アクセス権限方式が「個別に設定」の文書フォルダに文書が登録されている場合に,「全てのユーザ」に設定されたアクセス権の値が出力されます。
  • FULL_CONTROL:「全て」
  • READ_WRITE:「更新」
  • LINK:「リンク」
  • READ:「参照」
  • NONE:「なし」
「同じ権限を共有」の場合,および公開フォルダの場合で「公開範囲を限定」のときは,「NONE」が出力されます。
公開フォルダの場合で「全員に公開」のときは,「FULL_CONTROL」が出力されます。
21アクセス権限リストアクセス権限方式が「個別に設定」の文書の場合に,文書に設定されたアクセス権の値が出力されます。
「同じ権限を共有」,または公開フォルダの場合で「公開範囲を限定」のときは,共有元となるフォルダのアクセス権が出力されます。公開フォルダの場合で「全員に公開」のときは,何も出力されません。
<アクセス権指定>/<アクセス権指定>/…
<アクセス権指定>を「/(スラント)」で区切って出力します。<アクセス権指定>の形式を次に示します。
「設定対象ID」,「種別」,「アクセス権」を「:(コロン)」で区切って出力します。
設定対象ID:種別:アクセス権
各項目の内容を次に示します。
  • 「設定対象ID」:アクセス権の設定されているユーザ/組織/グループのIDを出力します。
  • 「種別」:設定対象IDの種別を次に示す値で出力します。
    U:ユーザの場合
    G:組織またはグループの場合
  • 「アクセス権」:設定対象に設定されているアクセス権を次に示す値で出力します。
    「全て」の場合:「FULL_CONTROL」
    「更新」の場合:「READ_WRITE」
    「リンク」の場合:「LINK」
    「参照」の場合:「READ」
    「なし」の場合:「NONE」
出力例
user01:U:READ/grp01:G:READ_WRITE
22更新者ID文書の更新者のIDが出力されます。
23更新者名文書の更新者の名称が出力されます。
24更新日時文書の更新日時がYYYY/MM/DD-hh:mm:ss形式で出力されます。
25空文字空文字が出力されます。
26関連ファイル関連ファイルのファイル名が出力されます。
関連ファイルを複数持つ文書の場合は「|」区切りで,複数の関連ファイルが出力されます。
関連ファイルがない場合は,何も出力されません。
27継続行フラグ-vオプションを指定した場合,文書の履歴情報が出力されます。
  • 1:登録する文書が履歴を持つ場合
  • -1:登録する文書が履歴の最終版(最新版)の場合
  • 空文字:履歴を持たない文書の場合
「継続行フラグ」に1を指定したレコードから-1の値を指定したレコードまでを文書の履歴として,古い文書から順番に出力されます。
-vオプションを指定しない場合は,最新バージョンの1行だけを出力するため,空文字が出力されます。
28作成日時文書の作成日時がYYYY/MM/DD-hh:mm:ss形式で出力されます。
29~30空文字空文字が出力されます。
31~35ecmProp_UserInt1~ecmProp_UserInt5データベースの値がそのまま出力されます。
日付型の場合でも,20140120​のように「/」の区切り文字が無いYYYYMMDD形式で出力されます。
36~40ecmProp_UserStr1~ecmProp_UserStr5データベースの値がそのまま出力されます。
41~50ecmProp_DocTypePropInt1~ecmProp_DocTypePropInt10データベースの値がそのまま出力されます。
日付型の場合でも,20140120​のように「/」の区切り文字が無いYYYYMMDD形式で出力されます。
51~60ecmProp_DocTypePropStr1~ecmProp_DocTypePropStr10データベースの値がそのまま出力されます。
マスタ型の場合,文書種別の属性値マスタに設定されている属性値コードを,階層が上位の属性値コードから順番に半角の「-(ハイフン)」で区切って出力されます。
例:00023-000294-00338
61~65ecmProp_DocTypePropLongStr1~ecmProp_DocTypePropLongStr5データベースの値がそのまま出力されます。
66OIID-aオプションを指定した場合だけ出力されます。
文書のバージョンのOIIDを「dma:///~」から始まる133バイトの文字列の形式で出力します。
67作成者ID-aオプションを指定した場合だけ出力されます。
データベースの値をそのまま出力します。
68ファイルサイズ-aオプションを指定した場合だけ出力されます。データベースの値をそのまま出力します。
69全文検索-aオプションを指定した場合だけ出力されます。
主ファイルの情報を,次に示す値で出力します。
  • 0:文書ファイル未登録
    文書ファイルが未登録の状態です。
  • 1:インデクス未作成
    文書ファイルは登録済みですが,全文検索インデクスは作成されていない状態です。
  • 2:インデクス作成済み
    文書ファイルが登録済みで,全文検索インデクスも作成済みの状態です。
  • 3:インデクス不一致
    文書は更新済みですが,全文検索インデクスは未更新のため,文書と全文検索インデクスが不一致の状態です。
  • 100以上:インデクス作成不可
    全文検索テキストの作成時にエラーが発生し,全文検索インデクスの作成ができていない状態です。
70チェックアウト中ユーザID-aオプションを指定した場合だけ出力されます。
チェックアウト中ユーザのユーザIDが出力されます。チェックアウト中のユーザがいない場合,公開文書の場合は,空文字が出力されます。
71チェックアウト中ユーザ名-aオプションを指定した場合だけ出力されます。
チェックアウト中ユーザのユーザ名が出力されます。チェックアウト中のユーザがいない場合,公開文書の場合は,空文字が出力されます。
72案件番号-aオプションを指定した場合だけ出力されます。
公開文書の場合に,案件番号が出力されます。公開文書以外の場合は,空文字が出力されます。
73公開開始日-aオプションを指定した場合だけ出力されます。
公開開始日が出力されます。20140120​のように「/」の区切り文字が無いYYYYMMDD形式で出力されます。
一般文書の場合,最新のバージョンの場合は0が,旧バージョンの場合は99991231​が出力されます。
74公開終了日-aオプションを指定した場合だけ出力されます。
公開終了日が出力されます。20140120​のように「/」の区切り文字が無いYYYYMMDD形式で出力されます。
一般文書の場合,最新のバージョンの場合は99991231​が,旧バージョンの場合は0が出力されます。
注※1
文書一覧CSV出力ファイルのカラム名を次に示します。
一行目にはヘッダ行を出力します。また,値の有無に関わらず,すべてのカラムを出力します。
登録結果,フォルダ名_1,フォルダ名_2,フォルダ名_3,フォルダ名_4,フォルダ名_5,フォルダ名_6,フォルダ名_7,フォルダ名_8,フォルダ名_9,フォルダ名_10,,所有者ID,ユーザの表示名称,採番結果,ファイル名,文書名,コメント,文書種別,全てのユーザに対するアクセス権限,アクセス権限リスト,更新者ID,更新者名,更新日時,,関連ファイル,継続行フラグ,作成日時,,,ecmProp_UserInt1,ecmProp_UserInt2,ecmProp_UserInt3,ecmProp_UserInt4,ecmProp_UserInt5,ecmProp_UserStr1,ecmProp_UserStr2,ecmProp_UserStr3,ecmProp_UserStr4,ecmProp_UserStr5,ecmProp_DocTypePropInt1,ecmProp_DocTypePropInt2,ecmProp_DocTypePropInt3,ecmProp_DocTypePropInt4,ecmProp_DocTypePropInt5,ecmProp_DocTypePropInt6,ecmProp_DocTypePropInt7,ecmProp_DocTypePropInt8,ecmProp_DocTypePropInt9,ecmProp_DocTypePropInt10,ecmProp_DocTypePropStr1,ecmProp_DocTypePropStr2,ecmProp_DocTypePropStr3,ecmProp_DocTypePropStr4,ecmProp_DocTypePropStr5,ecmProp_DocTypePropStr6,ecmProp_DocTypePropStr7,ecmProp_DocTypePropStr8,ecmProp_DocTypePropStr9,ecmProp_DocTypePropStr10,ecmProp_DocTypePropLongStr1,ecmProp_DocTypePropLongStr2,ecmProp_DocTypePropLongStr3,ecmProp_DocTypePropLongStr4,ecmProp_DocTypePropLongStr5(,OIID,作成者ID,ファイルサイズ,全文検索,チェックアウト中ユーザID,チェックアウト中ユーザ名,案件番号,公開開始日,公開終了日)
注※2
<n>はフォルダの階層を示す1~10の半角の整数値です。
実行結果
文書一覧CSV出力ファイルの実行結果の例を次に示します。
登録結果,フォルダ名_1,フォルダ名_2,フォルダ名_3,フォルダ名_4,フォルダ名_5,フォルダ名_6,フォルダ名_7,フォルダ名_8,フォルダ名_9,フォルダ名_10,,所有者ID,ユーザの表示名称,採番結果,ファイル名,文書名,コメント,文書種別,全てのユーザに対するアクセス権限,アクセス権限リスト,更新者ID,更新者名,更新日時,,関連ファイル,継続行フラグ,作成日時,,,ecmProp_UserInt1,ecmProp_UserInt2,ecmProp_UserInt3,ecmProp_UserInt4,ecmProp_UserInt5,ecmProp_UserStr1,ecmProp_UserStr2,ecmProp_UserStr3,ecmProp_UserStr4,ecmProp_UserStr5,ecmProp_DocTypePropInt1,ecmProp_DocTypePropInt2,ecmProp_DocTypePropInt3,ecmProp_DocTypePropInt4,ecmProp_DocTypePropInt5,ecmProp_DocTypePropInt6,ecmProp_DocTypePropInt7,ecmProp_DocTypePropInt8,ecmProp_DocTypePropInt9,ecmProp_DocTypePropInt10,ecmProp_DocTypePropStr1,ecmProp_DocTypePropStr2,ecmProp_DocTypePropStr3,ecmProp_DocTypePropStr4,ecmProp_DocTypePropStr5,ecmProp_DocTypePropStr6,ecmProp_DocTypePropStr7,ecmProp_DocTypePropStr8,ecmProp_DocTypePropStr9,ecmProp_DocTypePropStr10,ecmProp_DocTypePropLongStr1,ecmProp_DocTypePropLongStr2,ecmProp_DocTypePropLongStr3,ecmProp_DocTypePropLongStr4,ecmProp_DocTypePropLongStr5,OIID,作成者ID,ファイルサイズ,全文検索,チェックアウト中ユーザID,チェックアウト中ユーザ名,案件番号,公開開始日,公開終了日
"","1","21","","","","","","","","","","admin","セキュリティ管理者(admin)","","1main改造.txt","1main改造","","","NONE","","admin","セキュリティ管理者(admin)","2014/05/08-20:03:25","","","","2014/05/08-20:03:25","","","0","0","0","0","0","","","","","","0","0","0","0","0","0","0","0","0","0","","","","","","","","","","","","","","","","dma:///07a17522-a626-11d0-b11f-0020af27a837/673d2be0-d1fd-11d0-ab59-08002be29e1d/13f4c4cf-5acd-45cf-acc6-3674c81dce070000000000001​A86","admin","94","1",""
"","1","21","","","","","","","","","","admin","セキュリティ管理者(admin)","","2sub.txt","2sub","","","NONE","","admin","セキュリティ管理者(admin)","2014/05/08-20:03:18","","","","2014/05/08-20:03:18","","","0","0","0","0","0","","","","","","0","0","0","0","0","0","0","0","0","0","","","","","","","","","","","","","","","","dma:///07a17522-a626-11d0-b11f-0020af27a837/673d2be0-d1fd-11d0-ab59-08002be29e1d/13f4c4cf-5acd-45cf-acc6-3674c81dce070000000000001​A7A","admin","106","1",""
"","1","21","","","","","","","","","","admin","セキュリティ管理者(admin)","","3sub.txt","3sub","","","NONE","","admin","セキュリティ管理者(admin)","2014/05/08-20:03:11","","","","2014/05/08-20:03:11","","","0","0","0","0","0","","","","","","0","0","0","0","0","0","0","0","0","0","","","","","","","","","","","","","","","","dma:///07a17522-a626-11d0-b11f-0020af27a837/673d2be0-d1fd-11d0-ab59-08002be29e1d/13f4c4cf-5acd-45cf-acc6-3674c81dce070000000000001​A6E","admin","51","1",""
"","1","21","2131","","","","","","","","","admin","セキュリティ管理者(admin)","","1main改造.txt","1main改造","","","NONE","","admin","セキュリティ管理者(admin)","2014/05/08-20:04:10","","","","2014/05/08-20:04:10","","","0","0","0","0","0","","","","","","0","0","0","0","0","0","0","0","0","0","","","","","","","","","","","","","","","","dma:///07a17522-a626-11d0-b11f-0020af27a837/673d2be0-d1fd-11d0-ab59-08002be29e1d/13f4c4cf-5acd-45cf-acc6-3674c81dce070000000000001​AB6","admin","94","1",""
"","1","21","2131","","","","","","","","","admin","セキュリティ管理者(admin)","","2sub.txt","2sub","","","NONE","","admin","セキュリティ管理者(admin)","2014/05/08-20:04:27","","","","2014/05/08-20:04:27","","","0","0","0","0","0","","","","","","0","0","0","0","0","0","0","0","0","0","","","","","","","","","","","","","","","","dma:///07a17522-a626-11d0-b11f-0020af27a837/673d2be0-d1fd-11d0-ab59-08002be29e1d/13f4c4cf-5acd-45cf-acc6-3674c81dce070000000000001​AD0","admin","106","1",""
   :
   :

ログファイル

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

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

注意事項