6.3.1 文書登録コマンドで使用するファイル

<この項の構成>
(1) 登録情報ファイル

(1) 登録情報ファイル

文書登録コマンドを実行して文書を登録する場合に,文書を登録するフォルダの情報や登録する文書の情報を定義します。

(a) ファイルの形式

登録情報ファイルには,ヘッダ行とレコード行を記述します。登録情報ファイルの形式を次の図に示します。

図6-1 登録情報ファイルの形式(文書登録コマンドの場合)

[図データ]

(b) ファイルの記述規則
(c) ヘッダ行の記述規則
(d) ヘッダ行とレコード行の指定形式

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

表6-16 カラム名およびデータの指定内容とカラム番号の対応(文書登録コマンド)

カラム番号カラム名※1の指定内容データの指定内容省略可否省略時仮定値
1登録結果ログファイルの出力に使用するフィールドのため,値は記述しません。空文字を指定します。
引数「-l」を指定して文書登録コマンドを実行した場合,ログファイルのこの位置にコマンドの実行結果を示す値が出力されます。
出力される値を次に示します。
  • 1:文書の登録が成功しました。
  • 2:文書の登録でエラーが発生しました。
  • 空文字:登録処理は実行されませんでした。
2~11フォルダ名_<n>※2※61階層目から文書の登録先フォルダまでのフォルダ名を記述します。フォルダ名は1~255バイト※3で記述してください。
例えば,3階層目のフォルダに文書を登録する場合,2~4カラム目には1~3階層目のそれぞれのフォルダ名を記述します。5~11カラム目には空文字を指定します。
フォルダ名の指定方法の詳細は,「(e) フォルダ名の指定形式1」,「(f) フォルダ名の指定形式2(直前のレコード行と登録先フォルダが同じ場合)」,または「(g) フォルダ名の指定形式3(すべての文書を同じフォルダに登録する場合)」を参照してください。
不可
12空文字空文字を指定します。
カラム名およびデータに空文字以外を指定した場合,文書は登録されません。
なし
13所有者ID※6文書の所有者のIDを記述します。
この所有者IDは,1~255バイト※3でLDAPなどのディレクトリサービスに保持しているIDを記述してください。
ただし,記述したIDが妥当かどうかはチェックされません。
不可
14ユーザの表示名称※6文書の所有者の名称を記述します。
この名称は,1~255バイト※3でLDAPなどのディレクトリサービスに保持している名称を記述してください。
ただし,記述した名称が妥当かどうかはチェックされません。
不可
15採番結果ログファイルの出力に使用するフィールドのため,値は記述しません。空文字を指定します。
文書の登録時に文書番号を採番した場合※4に,採番した文書番号が出力されます。文書番号を採番しない場合は,何も出力されません。
また,バージョン付き文書の場合,最古の版(バージョン)の文書以外では何も出力されません。
16ファイル名文書に登録するファイル名をフルパスで記述します。
指定を省略すると,ファイル実体がない文書が作成されます。
ただし,バージョン付き文書の場合,ファイル実体がない空文書の登録はできません。
なお,登録するファイル名に半角の「;」(セミコロン)が含まれている場合は,「;」が半角の「_」(アンダーバー)に変更されて登録されます。
なし
17文書名文書名を1~255バイト※3で記述します。
バージョン付き文書の場合,最古の版(バージョン)の文書以外では,この指定を省略できます。省略したときは,その版(バージョン)の1つ前の版(バージョン)の文書名が指定されます。
不可
18コメント文書のコメントを0~1,024バイト※3で記述します。改行コードは記述できません。空文字
19文書種別※6文書に設定する文書種別の名称を記述します。
文書種別名は,[文書種別一覧]画面の表示名と一致させてください。
文書種別を設定しない
20全てのユーザに対するアクセス権限※6アクセス権限方式が「個別に設定」の文書フォルダに文書を登録する場合に,「全てのユーザ」に設定するアクセス権を指定します。次に示す値で記述します。
  • FULL_CONTROL:「全て」を設定します。
  • READ_WRITE:「更新」を設定します。
  • LINK:「リンク」を設定します。
  • READ:「参照」を設定します。
  • NONE:「なし」を設定します。
なお,「全てのユーザに対するアクセス権限」が指定できない文書に対して指定した場合,この指定を無視して文書が登録され,警告メッセージが出力されます。
NONE
21アクセス権限リスト※6アクセス権限方式が「個別に設定」の文書フォルダに文書を登録する場合に,文書に設定するアクセス権を指定します。次に示す形式で値を記述します。
<アクセス権指定>/<アクセス権指定>/…
<アクセス権指定>※5を「/(スラント)」で区切って記述します。<アクセス権指定>は複数記述できます。ただし,記述できる数は配置ディスクリプタ(web.xml)のapp.ACLObjNumパラメタに設定した値までです。NO_ACLを指定した場合,アクセス権は設定されません。なお,「アクセス権限リスト」が指定できない文書に対して指定した場合,この指定を無視して文書が登録され,警告メッセージが出力されます。
文書を登録するフォルダに設定されているアクセス権を継承
22更新者ID文書の更新者のIDを記述します。この更新者IDは,1~255バイト※3でLDAPなどのディレクトリサービスに保持しているIDを記述してください。ただし,記述したIDが妥当かどうかはチェックされません。指定を省略した場合は,「所有者ID」で指定した値が設定されます。所有者ID
23更新者名文書の更新者の名称を記述します。この更新者名は,1~255バイト※3でLDAPなどのディレクトリサービスに保持している名称を記述してください。ただし,記述した名称が妥当かどうかはチェックされません。
指定を省略した場合は,「ユーザの表示名称」で指定した値が設定されます。
ユーザの表示名称
24更新日時文書の更新日時をYYYY/MM/DD-hh:mm:ss形式で指定します。指定できる範囲は,1970/01/01-09:00:00~2038/01/19-00:00:00(1970年1月1日09時00分00秒~2038年1月19日00時00分00秒)です。指定を省略した場合,または不正な値を指定した場合は,文書の登録日時が仮定されます。
「継続行フラグ」で1を指定している場合,指定している更新日時がバージョン間で妥当かどうかをチェックします。
文書の登録日時
25空文字空文字を指定します。なし
26関連ファイル関連ファイルとして登録するファイルのパスをフルパスで記述します。関連ファイルは「|」で区切って,複数の関連ファイルを指定できます。
指定を省略した場合は,関連ファイルを持たない文書として登録します。「ファイル名」に何も指定していない場合,この指定で先頭に記述したファイルが主ファイルとなります。
関連ファイル名は,1~255バイト※3で記述してください。関連ファイルには同じファイル名を複数指定することはできません。大文字と小文字は区別されませんので,「aaa.doc」と「AAA.doc」は同じファイル名となりエラーになります。ファイル名に「;(セミコロン)」を含む場合は,「_(アンダーバー)」に置き換えて登録します。
なお,指定する関連ファイル数が,システム管理者の設定している登録できる関連ファイル数を超えていないかどうかのチェックはしません。
関連ファイルの指定方法の詳細は,「(h) 関連ファイルと継続行フラグの指定形式」を参照してください。
なし
27継続行フラグ文書の履歴を登録する場合に次の値で指定します。
  • 1:登録する文書が履歴を持つ場合に指定します。
  • -1:登録する文書が履歴の最終版(最新版)の場合に指定します。
  • 上記以外:履歴を持たない文書
「継続行フラグ」に1を指定したレコードから-1または1以外の値を指定したレコードまでが順番に履歴として登録されます。
前のレコードが1以外の場合に,-1または1以外の値を指定したときは,履歴を持たない文書として登録します。
なお,指定する履歴数が,システム管理者の設定している文書の更新履歴数の保存件数を超えていないかどうかのチェックはしません。
継続フラグの指定方法の詳細は,「(h) 関連ファイルと継続行フラグの指定形式」を参照してください。
なし
28作成日時文書の作成日時をYYYY/MM/DD-hh:mm:ss形式で指定します。YYYY/MM/DD hh:mm:ss形式のYYYYには西暦年号(4桁),MMには月(2桁),DDには日(2桁),hhには時(2桁),mmには分(2桁),ssには秒(2桁)が出力されます。
指定できる範囲は,1970/01/01-09:00:00~2038/01/19-00:00:00(1970年1月1日09時00分00秒~2038年1月19日00時00分00秒)です。指定を省略した場合,または不正な値を指定した場合は,文書を登録した日時が仮定されます。
「継続行フラグ」で1を指定している場合,指定している作成日時がバージョン間で妥当かどうかをチェックします。
文書の登録日時
29~30空文字空文字を指定します。なし
31~<プロパティ型>:<プロパティ長>:<プロパティ名>※6カラム名には,プロパティ名を含む文字列を記述します。
データには,ユーザプロパティ,または文書種別用プロパティを記述します。
データに記述する形式は指定するプロパティ型によって異なります。
カラム名およびデータの指定方法の詳細は,「(i) ユーザプロパティおよび文書種別用プロパティの指定形式」を参照してください。
文書に文書種別を設定する場合は,文書種別用プロパティを記述してください。
  • 文書種別を設定しない場合:可
  • 文書種別を設定する場合:不可
なし
(凡例)
-:該当しません。
注※1
登録情報ファイルのカラム名は,次の内容をコピーして使用してください。
登録結果,フォルダ名_1,フォルダ名_2,フォルダ名_3,フォルダ名_4,フォルダ名_5,フォルダ名_6,フォルダ名_7,フォルダ名_8,フォルダ名_9,フォルダ名_10,,所有者ID,ユーザの表示名称,採番結果,ファイル名,文書名,コメント,文書種別,全てのユーザに対するアクセス権限,アクセス権限リスト,更新者ID,更新者名,更新日時,,関連ファイル,継続行フラグ,作成日時,,,<プロパティ型>:<プロパティ長>:<プロパティ名>
注※2
<n>はフォルダの階層を示す1~10の半角の整数値です。
注※3
文字コード種別がUTF-8の場合のバイト数です。
バイト数を確認するときは,UTF-8形式で文字列長を調べてください。
注※4
カラム番号31番以降に,文書種別に対応する,文書番号の採番に使用するプロパティが記述されている場合,文書番号を採番して文書を登録します。
注※5
<アクセス権指定>の記述形式を次に示します。「設定対象ID」,「種別」,「アクセス権」を「:(コロン)」で区切って指定します。
設定対象ID:種別:アクセス権
各項目の記述内容を次に示します。
設定対象ID
アクセス権を設定するユーザ,組織,またはグループのIDを記述します。
ただし,記述したIDが妥当かどうかはチェックされません。なお,不正なIDを記述した場合,不正なIDが文書のアクセス権に設定されたままになります。このときは,システム管理者が[文書のアクセス権]画面からIDを削除してください。
種別
設定対象IDの種別を次に示す値で記述します。
  • U:ユーザの場合
  • G:組織またはグループの場合
アクセス権
設定対象に設定するアクセス権を次に示す値で記述します。
  • FULL_CONTROL:「全て」を設定します。
  • READ_WRITE:「更新」を設定します。
  • LINK:「リンク」を設定します。
  • READ:「参照」を設定します。
  • NONE:「なし」を設定します。
<アクセス権指定>を複数記述した場合の例を次に示します。
user01:U:READ/grp01:G:READ_WRITE
注※6
バージョン付き文書の場合,最古の版(バージョン)の文書に指定した値が有効となります。
(e) フォルダ名の指定形式1

カラム番号2番から11番までのデータには,1階層目から文書の登録先フォルダまでのそれぞれのフォルダ名を記述します。フォルダ名は,フォルダ階層と対応させて記述する必要があります。

登録情報ファイルにフォルダ名を指定する例を次の図に示します。

図6-2 登録情報ファイルの指定例1(文書登録コマンドの場合)

[図データ]

図6-2は,「■フォルダ階層」で示すフォルダに対して,5つの文書を登録するための登録情報ファイルの例です。なお,例では,カラム番号2番,3番,4番,および17番以外は,記述を省略しています。

図6-2に示す登録情報ファイルを引数「-r」に指定して文書登録コマンドを実行すると,次のようになります。

(f) フォルダ名の指定形式2(直前のレコード行と登録先フォルダが同じ場合)

直前のレコード行と登録先フォルダが同じ場合,次のレコード行では登録先フォルダの指定を省略できます。

図6-2の例では,文書「報告書」,文書「議事録」,および文書「製品資料」は登録先フォルダが同じです。そのため,文書「報告書」のレコード行にだけ登録先フォルダを記述すれば,文書「議事録」および文書「製品資料」のレコード行では登録先フォルダの記述が不要になります。

図6-2の例と同様の文書を登録する場合で,登録先フォルダの記述を省略する例を次の図に示します。

図6-3 登録情報ファイルの指定例2(文書登録コマンドの場合)

[図データ]

ただし,途中までの階層が同じでも登録先フォルダが異なる場合は,再度,1階層目のフォルダから登録先フォルダまでを記述する必要があります。

例えば,文書「報告書」の登録先フォルダの1階層目は,文書「提案書」の登録先フォルダの1階層目と同じ,フォルダ「大阪府」です。しかし,文書「報告書」の登録先フォルダは「中央区」,文書「提案書」の登録先フォルダは「大阪府」で,登録先フォルダが異なります。

そのため,文書「報告書」を登録するレコード行には,再度,1階層目のフォルダから登録先フォルダまでを記述する必要があります。

(g) フォルダ名の指定形式3(すべての文書を同じフォルダに登録する場合)

すべての文書を同じフォルダに登録する場合,引数「-b」に登録先フォルダのパスを指定して文書登録コマンドを実行することで,登録情報ファイルでのフォルダ名の記述を省略できます。

すべての文書を同じフォルダに登録する場合の登録情報ファイルの例を次の図に示します。

図6-4 登録情報ファイルの指定例3(文書登録コマンドの場合)

[図データ]

文書を登録するフォルダがすべて同じため,文書登録コマンドの引数「-b」に文書を登録するフォルダのパスとして「大阪府/大阪市/中央区」を指定することで,登録情報ファイルでは文書を登録するフォルダ名の記述を省略できます。

(h) 関連ファイルと継続行フラグの指定形式

関連ファイルと継続行フラグを合わせて指定することで,関連ファイルを持つ文書の履歴を登録できます。

3つのバージョンを持つ文書を登録する例を次の図に示します。

[図データ]

「継続行フラグ」に1を指定したレコードから-1を指定したレコードまでが順番に履歴として登録されます。

(i) ユーザプロパティおよび文書種別用プロパティの指定形式
●カラム名の指定形式

カラム名の指定形式を次に示します。「プロパティ型」,「プロパティ長」,および「プロパティ名」を半角の「:(コロン)」で区切って指定します。

カラム名の指定形式
"<プロパティ型>:<プロパティ長>:<プロパティ名>"
<プロパティ型>
プロパティ型を示す数値を半角で記述します。
記述できる数値を次に示します。
  • 1:文字列型
  • 2:整数型
  • 3:日付型
  • 4:マスタ型
<プロパティ長>
半角の整数値で記述します。単位はバイトです。
プロパティ長は指定を省略できます。省略する場合は,空文字を指定します。
指定を省略すると,プロパティ型に応じて次の値が仮定されます。
  • 文字列型:255(バイト)
  • 整数型:4(バイト)
  • 日付型:4(バイト)
  • マスタ型:255(バイト)
なお,文字列型のバイト数は,文字コード種別がUTF-8の場合です。
<プロパティ名>
プロパティの名称を記述します。記述できるプロパティの詳細は,表6-13を参照してください。

カラム名の記述例を次に示します。

カラム名の記述例(プロパティが文字列型の場合)

"1:255:ecmProp_UserStr1"

カラム名の記述例(プロパティが文字列型で,プロパティ長を省略した場合)

"1::ecmProp_UserStr1"

カラム名の記述例(プロパティが整数型の場合)

"2:4:ecmProp_UserInt1"

カラム名の記述例(プロパティが整数型で,プロパティ値を省略した場合)

"2::ecmProp_UserInt1"

●カラム名に記述できるプロパティ

カラム名に記述できるプロパティとその用途を次の表に示します。なお,表では,DocumentBroker Standard GUIをインストール直後の状態で記述できるプロパティを示しています。

表6-17 カラム名に記述できるプロパティとその用途

項番プロパティ名プロパティ型プロパティ長
(単位:バイト)
用途
1ecmProp_UserInt1整数型または日付型4ユーザ定義
2ecmProp_UserInt2整数型または日付型4ユーザ定義
3ecmProp_UserInt3整数型または日付型4ユーザ定義
4ecmProp_UserInt4整数型または日付型4ユーザ定義
5ecmProp_UserInt5整数型または日付型4ユーザ定義
6ecmProp_UserStr1文字列型255ユーザ定義
7ecmProp_UserStr2文字列型255ユーザ定義
8ecmProp_UserStr3文字列型255ユーザ定義
9ecmProp_UserStr4文字列型255ユーザ定義
10ecmProp_UserStr5文字列型255ユーザ定義
11ecmProp_DocTypePropInt1整数型または日付型4文書種別用定義
12ecmProp_DocTypePropInt2整数型または日付型4文書種別用定義
13ecmProp_DocTypePropInt3整数型または日付型4文書種別用定義
14ecmProp_DocTypePropInt4整数型または日付型4文書種別用定義
15ecmProp_DocTypePropInt5整数型または日付型4文書種別用定義
16ecmProp_DocTypePropInt6整数型または日付型4文書種別用定義
17ecmProp_DocTypePropInt7整数型または日付型4文書種別用定義
18ecmProp_DocTypePropInt8整数型または日付型4文書種別用定義
19ecmProp_DocTypePropInt9整数型または日付型4文書種別用定義
20ecmProp_DocTypePropInt10整数型または日付型4文書種別用定義
21ecmProp_DocTypePropStr1文字列型255文書種別用定義
22ecmProp_DocTypePropStr2文字列型255文書種別用定義
23ecmProp_DocTypePropStr3文字列型255文書種別用定義
24ecmProp_DocTypePropStr4文字列型255文書種別用定義
25ecmProp_DocTypePropStr5文字列型255文書種別用定義
26ecmProp_DocTypePropStr6文字列型またはマスタ型255文書種別用定義
27ecmProp_DocTypePropStr7文字列型またはマスタ型255文書種別用定義
28ecmProp_DocTypePropStr8文字列型またはマスタ型255文書種別用定義
29ecmProp_DocTypePropStr9文字列型またはマスタ型255文書種別用定義
30ecmProp_DocTypePropStr10文字列型またはマスタ型255文書種別用定義
31ecmProp_DocTypePropLongStr1文字列型4,096文書種別用定義
32ecmProp_DocTypePropLongStr2文字列型4,096文書種別用定義
33ecmProp_DocTypePropLongStr3文字列型4,096文書種別用定義
34ecmProp_DocTypePropLongStr4文字列型4,096文書種別用定義
35ecmProp_DocTypePropLongStr5文字列型4,096文書種別用定義
(凡例)
ユーザ定義:ユーザプロパティの場合に指定できるプロパティです。
文書種別用定義:文書種別用プロパティの場合に指定できるプロパティです。
●データの指定形式

データの指定形式を次の表に示します。

表6-18 データの指定形式

プロパティ型指定形式指定例
文字列型任意の文字列を記述します。
記述できる最大文字列長は,文書ユーザプロパティ定義ファイルのprop.Length.Xキーに指定した値です。
例1:
"報告書"
例2:
"Hitachi, Ltd."
整数型10進数の数値を半角で記述します。
記述できる値の範囲は,-2147483648​~2147483647​です。
負の値を記述する場合は,数値の先頭に「-(マイナスの記号)」を記述します。
記述する値には,「,(コンマ)」を含めることができます。
例1:
"8,092"
例2:
"-167103"
例3:
"0"
日付型西暦の年月日を「/(スラント)」で区切って記述します。
記述できる値の範囲は,1900年1月1日から9999年12月31日までです。
例:
"2007/01/03"
マスタ型文書種別の属性値マスタに設定されている属性値コードを,階層が上位の属性値コードから順番に半角の「-(ハイフン)」で区切って記述します。
なお,最上位の階層の属性値コードだけを記述することはできません。必ず2階層目以降の属性値コードも記述してください。
例:
"00023-000294-00338"
注※
属性値コードとは,文書番号の採番に使用する10バイト以内の文字列です。半角の英数字または2バイトコードを指定できます。また,属性値コード中に,半角の「-(ハイフン)」は含めることができません。
属性値マスタに設定されている属性値コードは,[属性値マスタ更新]画面から確認できます。属性値マスタの参照方法の詳細は,マニュアル「DocumentBroker Version 3 Standard GUI 操作ガイド」を参照してください。
データベースに登録されていない属性値コードをレコードに指定すると,そのレコードはエラーとなり,文書は登録されません。
●コマンド実行時にチェックする項目

コマンド実行時,ユーザプロパティまたは文書種別用プロパティが正しく記述されているかどうかをシステムがチェックします。チェックする項目を次に示します。

なお,次の項目についてはチェックしません。