文書登録コマンドを実行して文書を登録する場合に,文書を登録するフォルダの情報や登録する文書の情報を定義します。
登録情報ファイルには,ヘッダ行とレコード行を記述します。登録情報ファイルの形式を次の図に示します。
図6-1 登録情報ファイルの形式(文書登録コマンドの場合)
カラム名およびデータの指定内容とカラム番号の対応を次の表に示します。
表6-16 カラム名およびデータの指定内容とカラム番号の対応(文書登録コマンド)
カラム番号 | カラム名※1の指定内容 | データの指定内容 | 省略可否 | 省略時仮定値 |
---|---|---|---|---|
1 | 登録結果 | ログファイルの出力に使用するフィールドのため,値は記述しません。空文字を指定します。 引数「-l」を指定して文書登録コマンドを実行した場合,ログファイルのこの位置にコマンドの実行結果を示す値が出力されます。 出力される値を次に示します。
| - | - |
2~11 | フォルダ名_<n>※2※6 | 1階層目から文書の登録先フォルダまでのフォルダ名を記述します。フォルダ名は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 | アクセス権限方式が「個別に設定」の文書フォルダに文書を登録する場合に,「全てのユーザ」に設定するアクセス権を指定します。次に示す値で記述します。
| 可 | NONE |
21 | アクセス権限リスト※6 | アクセス権限方式が「個別に設定」の文書フォルダに文書を登録する場合に,文書に設定するアクセス権を指定します。次に示す形式で値を記述します。
| 可 | 文書を登録するフォルダに設定されているアクセス権を継承 |
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以外の値を指定したときは,履歴を持たない文書として登録します。 なお,指定する履歴数が,システム管理者の設定している文書の更新履歴数の保存件数を超えていないかどうかのチェックはしません。 継続フラグの指定方法の詳細は,「(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,フォルダ名_2,フォルダ名_3,フォルダ名_4,フォルダ名_5,フォルダ名_6,フォルダ名_7,フォルダ名_8,フォルダ名_9,フォルダ名_10,,所有者ID,ユーザの表示名称,採番結果,ファイル名,文書名,コメント,文書種別,全てのユーザに対するアクセス権限,アクセス権限リスト,更新者ID,更新者名,更新日時,,関連ファイル,継続行フラグ,作成日時,,,<プロパティ型>:<プロパティ長>:<プロパティ名> |
設定対象ID:種別:アクセス権 |
user01:U:READ/grp01:G:READ_WRITE |
カラム番号2番から11番までのデータには,1階層目から文書の登録先フォルダまでのそれぞれのフォルダ名を記述します。フォルダ名は,フォルダ階層と対応させて記述する必要があります。
登録情報ファイルにフォルダ名を指定する例を次の図に示します。
図6-2 登録情報ファイルの指定例1(文書登録コマンドの場合)
図6-2は,「■フォルダ階層」で示すフォルダに対して,5つの文書を登録するための登録情報ファイルの例です。なお,例では,カラム番号2番,3番,4番,および17番以外は,記述を省略しています。
図6-2に示す登録情報ファイルを引数「-r」に指定して文書登録コマンドを実行すると,次のようになります。
直前のレコード行と登録先フォルダが同じ場合,次のレコード行では登録先フォルダの指定を省略できます。
図6-2の例では,文書「報告書」,文書「議事録」,および文書「製品資料」は登録先フォルダが同じです。そのため,文書「報告書」のレコード行にだけ登録先フォルダを記述すれば,文書「議事録」および文書「製品資料」のレコード行では登録先フォルダの記述が不要になります。
図6-2の例と同様の文書を登録する場合で,登録先フォルダの記述を省略する例を次の図に示します。
図6-3 登録情報ファイルの指定例2(文書登録コマンドの場合)
ただし,途中までの階層が同じでも登録先フォルダが異なる場合は,再度,1階層目のフォルダから登録先フォルダまでを記述する必要があります。
例えば,文書「報告書」の登録先フォルダの1階層目は,文書「提案書」の登録先フォルダの1階層目と同じ,フォルダ「大阪府」です。しかし,文書「報告書」の登録先フォルダは「中央区」,文書「提案書」の登録先フォルダは「大阪府」で,登録先フォルダが異なります。
そのため,文書「報告書」を登録するレコード行には,再度,1階層目のフォルダから登録先フォルダまでを記述する必要があります。
すべての文書を同じフォルダに登録する場合,引数「-b」に登録先フォルダのパスを指定して文書登録コマンドを実行することで,登録情報ファイルでのフォルダ名の記述を省略できます。
すべての文書を同じフォルダに登録する場合の登録情報ファイルの例を次の図に示します。
図6-4 登録情報ファイルの指定例3(文書登録コマンドの場合)
文書を登録するフォルダがすべて同じため,文書登録コマンドの引数「-b」に文書を登録するフォルダのパスとして「大阪府/大阪市/中央区」を指定することで,登録情報ファイルでは文書を登録するフォルダ名の記述を省略できます。
関連ファイルと継続行フラグを合わせて指定することで,関連ファイルを持つ文書の履歴を登録できます。
3つのバージョンを持つ文書を登録する例を次の図に示します。
「継続行フラグ」に1を指定したレコードから-1を指定したレコードまでが順番に履歴として登録されます。
カラム名の指定形式を次に示します。「プロパティ型」,「プロパティ長」,および「プロパティ名」を半角の「:(コロン)」で区切って指定します。
"<プロパティ型>:<プロパティ長>:<プロパティ名>" |
カラム名の記述例を次に示します。
"1:255:ecmProp_UserStr1" |
"1::ecmProp_UserStr1" |
"2:4:ecmProp_UserInt1" |
"2::ecmProp_UserInt1" |
カラム名に記述できるプロパティとその用途を次の表に示します。なお,表では,DocumentBroker Standard GUIをインストール直後の状態で記述できるプロパティを示しています。
表6-17 カラム名に記述できるプロパティとその用途
項番 | プロパティ名 | プロパティ型 | プロパティ長 (単位:バイト) | 用途 |
---|---|---|---|---|
1 | ecmProp_UserInt1 | 整数型または日付型 | 4 | ユーザ定義 |
2 | ecmProp_UserInt2 | 整数型または日付型 | 4 | ユーザ定義 |
3 | ecmProp_UserInt3 | 整数型または日付型 | 4 | ユーザ定義 |
4 | ecmProp_UserInt4 | 整数型または日付型 | 4 | ユーザ定義 |
5 | ecmProp_UserInt5 | 整数型または日付型 | 4 | ユーザ定義 |
6 | ecmProp_UserStr1 | 文字列型 | 255 | ユーザ定義 |
7 | ecmProp_UserStr2 | 文字列型 | 255 | ユーザ定義 |
8 | ecmProp_UserStr3 | 文字列型 | 255 | ユーザ定義 |
9 | ecmProp_UserStr4 | 文字列型 | 255 | ユーザ定義 |
10 | ecmProp_UserStr5 | 文字列型 | 255 | ユーザ定義 |
11 | ecmProp_DocTypePropInt1 | 整数型または日付型 | 4 | 文書種別用定義 |
12 | ecmProp_DocTypePropInt2 | 整数型または日付型 | 4 | 文書種別用定義 |
13 | ecmProp_DocTypePropInt3 | 整数型または日付型 | 4 | 文書種別用定義 |
14 | ecmProp_DocTypePropInt4 | 整数型または日付型 | 4 | 文書種別用定義 |
15 | ecmProp_DocTypePropInt5 | 整数型または日付型 | 4 | 文書種別用定義 |
16 | ecmProp_DocTypePropInt6 | 整数型または日付型 | 4 | 文書種別用定義 |
17 | ecmProp_DocTypePropInt7 | 整数型または日付型 | 4 | 文書種別用定義 |
18 | ecmProp_DocTypePropInt8 | 整数型または日付型 | 4 | 文書種別用定義 |
19 | ecmProp_DocTypePropInt9 | 整数型または日付型 | 4 | 文書種別用定義 |
20 | ecmProp_DocTypePropInt10 | 整数型または日付型 | 4 | 文書種別用定義 |
21 | ecmProp_DocTypePropStr1 | 文字列型 | 255 | 文書種別用定義 |
22 | ecmProp_DocTypePropStr2 | 文字列型 | 255 | 文書種別用定義 |
23 | ecmProp_DocTypePropStr3 | 文字列型 | 255 | 文書種別用定義 |
24 | ecmProp_DocTypePropStr4 | 文字列型 | 255 | 文書種別用定義 |
25 | ecmProp_DocTypePropStr5 | 文字列型 | 255 | 文書種別用定義 |
26 | ecmProp_DocTypePropStr6 | 文字列型またはマスタ型 | 255 | 文書種別用定義 |
27 | ecmProp_DocTypePropStr7 | 文字列型またはマスタ型 | 255 | 文書種別用定義 |
28 | ecmProp_DocTypePropStr8 | 文字列型またはマスタ型 | 255 | 文書種別用定義 |
29 | ecmProp_DocTypePropStr9 | 文字列型またはマスタ型 | 255 | 文書種別用定義 |
30 | ecmProp_DocTypePropStr10 | 文字列型またはマスタ型 | 255 | 文書種別用定義 |
31 | ecmProp_DocTypePropLongStr1 | 文字列型 | 4,096 | 文書種別用定義 |
32 | ecmProp_DocTypePropLongStr2 | 文字列型 | 4,096 | 文書種別用定義 |
33 | ecmProp_DocTypePropLongStr3 | 文字列型 | 4,096 | 文書種別用定義 |
34 | ecmProp_DocTypePropLongStr4 | 文字列型 | 4,096 | 文書種別用定義 |
35 | ecmProp_DocTypePropLongStr5 | 文字列型 | 4,096 | 文書種別用定義 |
データの指定形式を次の表に示します。
表6-18 データの指定形式
プロパティ型 | 指定形式 | 指定例 |
---|---|---|
文字列型 | 任意の文字列を記述します。 記述できる最大文字列長は,文書ユーザプロパティ定義ファイルのprop.Length.Xキーに指定した値です。 |
|
整数型 | 10進数の数値を半角で記述します。 記述できる値の範囲は,-2147483648~2147483647です。 負の値を記述する場合は,数値の先頭に「-(マイナスの記号)」を記述します。 記述する値には,「,(コンマ)」を含めることができます。 |
|
日付型 | 西暦の年月日を「/(スラント)」で区切って記述します。 記述できる値の範囲は,1900年1月1日から9999年12月31日までです。 |
|
マスタ型 | 文書種別の属性値マスタに設定されている属性値コード※を,階層が上位の属性値コード※から順番に半角の「-(ハイフン)」で区切って記述します。 なお,最上位の階層の属性値コード※だけを記述することはできません。必ず2階層目以降の属性値コードも記述してください。 |
|
コマンド実行時,ユーザプロパティまたは文書種別用プロパティが正しく記述されているかどうかをシステムがチェックします。チェックする項目を次に示します。
なお,次の項目についてはチェックしません。