4.3 文書に対するユーザプロパティの追加

文書ユーザプロパティ定義ファイルをテキストエディターなどで編集して,文書のプロパティにユーザプロパティを追加できます。追加したユーザプロパティには,[文書の作成]画面や[文書のプロパティ]画面で任意の情報が登録できます。

プロパティには,次に示すユーザプロパティが追加できます。

<この節の構成>
(1) 文書ユーザプロパティ定義ファイル
(2) 記述規則
(3) 記述できるキー
(4) 注意事項
(5) 記述例

(1) 文書ユーザプロパティ定義ファイル

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

文書ユーザプロパティ定義ファイルのファイル名は,配置ディスクリプタ(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

(2) 記述規則

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

(3) 記述できるキー

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

表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整数型または日付型の情報登録用のユーザプロパティ1ecmProp_UserInt1
2整数型または日付型の情報登録用のユーザプロパティ2ecmProp_UserInt2
3整数型または日付型の情報登録用のユーザプロパティ3ecmProp_UserInt3
4整数型または日付型の情報登録用のユーザプロパティ4ecmProp_UserInt4
5整数型または日付型の情報登録用のユーザプロパティ5ecmProp_UserInt5
6文字列型の情報登録用のユーザプロパティ1ecmProp_UserStr1
7文字列型の情報登録用のユーザプロパティ2ecmProp_UserStr2
8文字列型の情報登録用のユーザプロパティ3ecmProp_UserStr3
9文字列型の情報登録用のユーザプロパティ4ecmProp_UserStr4
10文字列型の情報登録用のユーザプロパティ5ecmProp_UserStr5

(4) 注意事項

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

(5) 記述例

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

[図データ]

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

[図データ]