文書ユーザプロパティ定義ファイルは，文書のプロパティに追加するユーザプロパティを定義するファイルです。

文書ユーザプロパティ定義ファイルのファイル名は，配置ディスクリプタ（web.xml）のdef.DocUserPropFileパラメタで指定します。このパラメタには，初期設定値として，次に示すファイル名が指定されています。

■ファイル名

日本語画面の場合

c:\Program Files\Hitachi System\DocBroker\StdGUI\etc\properties\DocUserProp.properties

英語画面の場合

c:\Program Files\Hitachi System\DocBroker\StdGUI\etc\properties_en\DocUserProp.properties

文書ユーザプロパティ定義ファイルの記述規則を次に示します。

• UTF-8で記述します。
• 「キー=値」の形式で記述します。
• 改行までが値になります。
• 値が存在しない行を定義した場合，その行は無視されます。
• #記号から改行まではコメントとなります。

文書ユーザプロパティ定義ファイルには，次の表に示すキーが記述できます。

表4-5　文書ユーザプロパティ定義ファイルに記述できるキー

キー	説明
prop.Num	追加するユーザプロパティの数を値に記述します。 prop.Numキーを省略すると，0が仮定されます。
prop.Name.X※1	追加するユーザプロパティに対応する列名を値に記述します。 追加するユーザプロパティに対応する列名は，表4-6を参照してください。 prop.Name.Xキーは省略できません。
prop.Alias.X※1	追加するユーザプロパティの表示名称を値に記述します。 prop.Alias.Xキーは省略できません。
prop.Type.X※1	整数型または日付型の情報登録用のユーザプロパティを追加するときは，次に示すデータ型のどちらかを値に記述します。 Integer32：整数型 Date：日付型（YYYYMMDD形式※2） 文字列型の情報登録用のユーザプロパティを追加するときは，次に示すデータ型を値に記述します。 String：文字列型 prop.Type.Xキーは省略できません。
prop.Length.X※1	文字列型の情報登録用のユーザプロパティを追加するときは，ユーザプロパティに登録する文字列データの最大文字列長（バイト）を値に記述します。最大文字列長には，256（バイト）未満の値を記述してください。 整数型または日付型の情報登録用のユーザプロパティを追加するときは，4を値に記述します。このとき，prop.Length.Xキーを省略することもできます。prop.Length.Xキーを省略すると，4が仮定されます。
prop.Sortable.X※1	追加するユーザプロパティが画面の一覧領域に表示されたときに，ソート機能を使用するかどうかを値に記述します。 記述できる値を次に示します。 Y：ソート機能を使用します。 N：ソート機能を使用しません。 prop.Sortable.Xキーを省略すると，Nが仮定されます。
prop.SearchMode.X※1	文字列型の情報登録用のユーザプロパティを追加するときに，前方一致で検索するか，部分一致で検索するかを値に記述します。 記述できる値を次に示します。 PRE：前方一致で文字列を検索します。 IN：部分一致で文字列を検索します。 prop.SearchMode.Xキーを省略すると，PREが仮定されます。

注

省略できないキーが記述されていないプロパティ項目の解析処理はスキップして処理を続行します。

注※1

Xには，1〜Nの数値を記述します。Nは，prop.Numキーに記述した値になります。

注※2

YYYYMMDD形式のYYYYは西暦年号（4桁），MMは月（2桁），DDは日（2桁）になります。

表4-6　追加するユーザプロパティに対応する列名

項番	追加するユーザプロパティ	列名
1	整数型または日付型の情報登録用のユーザプロパティ1	ecmProp_UserInt1
2	整数型または日付型の情報登録用のユーザプロパティ2	ecmProp_UserInt2
3	整数型または日付型の情報登録用のユーザプロパティ3	ecmProp_UserInt3
4	整数型または日付型の情報登録用のユーザプロパティ4	ecmProp_UserInt4
5	整数型または日付型の情報登録用のユーザプロパティ5	ecmProp_UserInt5
6	文字列型の情報登録用のユーザプロパティ1	ecmProp_UserStr1
7	文字列型の情報登録用のユーザプロパティ2	ecmProp_UserStr2
8	文字列型の情報登録用のユーザプロパティ3	ecmProp_UserStr3
9	文字列型の情報登録用のユーザプロパティ4	ecmProp_UserStr4
10	文字列型の情報登録用のユーザプロパティ5	ecmProp_UserStr5

DocumentBroker Standard GUIの運用途中でユーザプロパティを追加した場合，登録済みの文書のユーザプロパティには次に示す値が初期値として表示されます。

• 整数型の情報登録用のユーザプロパティの場合：0
• 日付型の情報登録用のユーザプロパティの場合：空白
• 文字列型の情報登録用のユーザプロパティの場合：空白

文字列型，日付型，および整数型の情報登録用のユーザプロパティを一つずつ追加するときは，次に示すように文書ユーザプロパティ定義ファイルを記述します。

これによって，ユーザプロパティが追加されます。追加されたユーザプロパティは，次に示す［文書の作成］画面などに表示されます。