8.27 文書一覧を表示する

この節では,文書一覧表示ユティリティについて説明します。

<この節の構成>
(1) 機能
(2) 起動方法
(3) 文法
(4) 出力形式
(5) 注意事項

(1) 機能

指定されたフォルダに格納されている文書の属性値の一覧を表示します。また,配布文書については,オリジナル文書の情報も出力します。

(2) 起動方法

文書一覧表示ユティリティを起動する前に,次の準備をしてください。

  1. コマンドプロンプトを起動する
  2. 文法に従ってコマンドを入力する

(3) 文法

(a) 形式

ISlsdoc

 -o 出力ファイル名

 -f フォルダID

 〔-s { SHALLOW | DEEP } 〕

 〔-t { BOTH | LOCAL | REPLICA } 〕

(b) オプション

-o 出力ファイル名
文書一覧を出力するファイル名を指定します。ファイル名は絶対パスで指定します。ファイル名だけを指定した場合は,カレントディレクトリ下に出力します。出力するファイルと同じ名称のファイルがある場合は,上書きをします。
-f フォルダID
文書一覧を出力する文書が格納されたフォルダのフォルダIDを指定します。
-s { SHALLOW | DEEP }
指定されたフォルダとその階層下のフォルダに格納されている文書の文書一覧を表示するかどうかを指定します。このオプションを省略した場合,「SHALLOW」が仮定されます。
SHALLOW
階層下のフォルダに格納されている文書は出力しません。
DEEP
階層下のフォルダに格納されている文書も出力します。
-t { BOTH | LOCAL | REPLICA }
表示する文書の文書種別を指定します。このオプションを省略した場合,「BOTH」が仮定されます。
BOTH  :すべての文書種別の文書を表示する。
LOCAL :ローカル文書を表示する。
REPLICA:配布文書を表示する。

(4) 出力形式

ユティリティの実行結果として,次に示す情報をCSV形式で出力します。

(a) フォルダ情報

文書の一覧を表示する対象となるフォルダに関する情報を出力します。表示項目は次のとおりです。各表示項目は,タブで区切られて出力されます。

フォルダ識別子
「*Folder*」と出力します。
フォルダ名称
指定したフォルダの名称を最大63バイトで出力します。
フォルダID
指定したフォルダのIDを16バイトで出力します。

(b) 文書一覧情報

各フォルダに格納されている文書の一覧を出力します。文書一覧情報の出力形式を表8-13に示します。なお,ヘッダ情報及びヘッダ情報に対応する表示項目は,タブで区切られて出力されます。

表8-13 文書一覧情報

ヘッダ情報ヘッダに対応する表示項目説明
'IS_object_id'文書ID文書IDを16バイトで出力
'IS_object_name'文書名文書名を最大63バイトで出力
'IS_class_id'文書データベースID文書が所属する一般文書データベースのIDを16バイトで出力
'IS_class_name'文書データベース名文書が所属する一般文書データベース名を最大63バイトで出力
'IS_owner_name'所有者名文書の所有者名を最大8バイトで出力
'IS_create_time'作成日時文書の作成日時を「YYYY/MM/DD-HH:MM:SS」の形式で19バイトで出力
'IS_creator_name'作成者名文書の作成者名を最大255バイトで出力
'IS_modify_time'更新日時文書の更新日時を「YYYY/MM/DD-HH:MM:SS」の形式で19バイトで出力
'IS_modifier_name'更新者名文書の更新者名を最大8バイトで出力
'IS_replica_flag'文書配布フラグユティリティを実行したサーバに存在する文書か配布文書かを示すフラグを1バイトで出力。ユティリティを実行したサーバに存在する文書の場合は,0又は1を出力。配布文書の場合は,2を出力
'IS_file_size'文書実体ファイルサイズ文書実体ファイルのサイズを最大10バイトで出力
'IS_file_name'文書実体ファイル名文書実体ファイル名を最大128バイトで出力
'IS_version_no'文書実体ファイルバージョン番号文書実体ファイルのバージョン番号を最大10バイトで出力
'IS_ts_id'TS情報ID文書のTS情報IDを最大10バイトで出力
'IS_ts_document_id'TS文書ID文書のTS文書IDを最大10バイトで出力
'IS_comment'コメント文書に対するコメントを最大7167バイトで出力。改行コードは空白に変換する
'IS_folder_id'所属フォルダID文書が格納されているフォルダのフォルダIDを16バイトで出力
'IS_doc_lock_user'更新中ユーザ名現在,文書を更新中のユーザ名を最大8バイトで出力
'Document Type'文書種別ユティリティを実行したサーバに存在する文書の場合は「LOCAL」,配布文書の場合は「REPLICA」と出力
'Original ID'オリジナル文書の文書IDオリジナル文書の文書IDを16バイトで出力。ユティリティを実行したサーバに存在する文書の場合は出力しない
'Server Name'配布元サーバ名配布文書の配布元サーバ名を最大8バイトで出力。ユティリティを実行したサーバに存在する文書の場合は出力しない
'Distribute Count'配布回数配布文書の配布回数を最大10バイトで出力。ユティリティを実行したサーバに存在する文書の場合は出力しない
'Distribute Time'配布日時配布文書の配布日時を「YYYY/MM/DD-HH:MM:SS」形式で19バイトで出力。ユティリティを実行したサーバに存在する文書の場合は出力しない

(5) 注意事項