uCosminexus DocumentBroker Version 5　システム導入・運用ガイド

解説・手引書

3021-3-401-10

目　　次

前書き

変更内容

はじめに

1.　概説

1.1　DocumentBrokerの機能

1.1.1　文書の登録機能とバージョン管理機能

1.1.2　フォルダ管理機能

1.1.3　文書の属性情報の管理機能

1.1.4　マルチレンディション管理機能

1.1.5　文書間リンク機能

1.1.6　リファレンスファイル管理機能

1.1.7　レンディションのコンテンツ種別変換機能

1.1.8　独立データの管理機能

1.1.9　アクセス制御機能

1.1.10　検索機能

1.1.11　全文検索インデクス一括登録機能

1.1.12　レンディション変換機能

1.1.13　複数の実行環境機能

1.2　DocumentBrokerのシステム構成

1.2.1　DocumentBrokerを使用したシステムの概略

2.　システム導入前の検討

2.1　適用業務の検討

2.2　追加するクラスおよびプロパティの検討

2.2.1　クラスおよびプロパティの追加

2.2.2　サブクラスの追加

2.2.3　プロパティの追加

2.2.4　全文検索機能付き文書クラスの追加

2.2.5　クラスおよびプロパティの追加例

2.3　文書空間で使用する文字コード種別の検討

2.4　仮想メモリ所要量の見積もり

2.5　データベース容量の見積もり

2.5.1　データベース容量の見積もり方法

2.5.2　ユーザ用RDエリアの容量の見積もり

2.5.3　ユーザLOB用RDエリアの容量の見積もり

2.5.4　アクセス制御機能に関連するデータベース容量の見積もり

2.6　リファレンスファイル管理機能を使用する場合のファイルシステムのディスク容量の見積もり

3.　環境設定

3.1　環境設定の流れ

3.2　環境設定の準備

3.2.1　システム管理者の決定

3.2.2　利用ユーザおよびグループの決定

3.2.3　DocumentBrokerの実行環境を作成するディレクトリの決定

3.3　インストールとアンインストール（UNIXの場合）

3.3.1　インストール

3.3.2　アンインストール

3.3.3　インストール済みプログラムの一覧表示

3.4　インストールとアンインストール（Windowsの場合）

3.4.1　統合CD-ROMからのインストール

3.4.2　リモートインストール

3.4.3　アンインストール

3.5　データベースシステムでの環境設定

3.5.1　HiRDBの環境設定の準備

3.5.2　HiRDBの環境設定

3.5.3　HiRDBのユーザ権限の設定

3.5.4　HiRDB Text Search Plug-in，HiRDB XML Extensionでの環境設定

3.6　ユーザ管理機能の設定

3.6.1　LDAP対応のディレクトリサービスによるユーザ管理機能を使用する場合の設定

3.6.2　ユーザ作成のアクセスルーチンを使用する場合の設定

3.7　DocumentBrokerの実行環境の作成

3.7.1　DocumentBroker実行環境ディレクトリの作成

3.7.2　DocumentBrokerの環境変数の設定

3.7.3　文書空間の定義

3.8　DocumentBrokerでデータベースシステムを使用するための設定

3.8.1　データベースシステムの設定に必要なファイル

3.8.2　データベースシステムの設定手順

3.8.3　全文検索機能を使用する場合に出力されるデータベース定義文

3.9　アプリケーションサーバの設定

3.9.1　アプリケーションサーバの構築

3.9.2　セキュリティポリシーの設定

3.9.3　保護区リストファイルの設定

3.9.4　コンテナ拡張ライブラリの取り込み

3.9.5　J2EEサーバの起動

3.9.6　リソースアダプタの設定

3.10　Javaアプリケーションの設定

3.10.1　環境変数の設定

3.10.2　JARファイルの追加

3.10.3　データベース情報ファイルの設定

3.11　複数の実行環境を構築する場合の設定

3.11.1　新規に実行環境を構築する場合

3.11.2　実行環境を変更する場合

3.11.3　実行環境を削除する場合

3.12　リファレンスファイル管理機能を使用する場合の設定

3.12.1　コンテンツを管理するための設定

3.12.2　ネットワーク上のマシンの共有ディスクでコンテンツを管理する場合の設定

4.　環境設定で必要なファイル

4.1　ファイルの種類

4.1.1　プロパティファイル

4.1.2　コマンドで使用するファイル

4.2　動作環境定義ファイル（docbconf.properties）

4.2.1　動作環境定義ファイルの概要

4.2.2　動作環境定義ファイルの記述形式

4.3　文書空間構成定義ファイル（docspace.properties）

4.3.1　文書空間構成定義ファイルの概要

4.3.2　文書空間構成定義ファイルの記述形式

4.3.3　文書空間構成定義ファイルの記述例

4.3.4　文書空間構成定義ファイルの注意事項

4.4　ユーザ権限定義ファイル（userperm.properties）

4.4.1　ユーザ権限定義ファイルの概要

4.4.2　ユーザ権限定義ファイルの記述形式

4.4.3　ユーザ権限定義ファイルの記述例

4.5　レンディション定義ファイル（mime.properties）

4.6　メタ情報初期化ファイル（docbmetainit.properties）

4.6.1　メタ情報初期化ファイルの記述形式

4.7　データベース情報ファイル（databaseinfo.properties）

4.7.1　データベース情報ファイルの記述形式

4.8　メタ情報ファイル

4.9　定義情報ファイル

4.9.1　定義情報ファイルの概要

4.9.2　サブクラス名およびプロパティ名をデータベース定義の名称に使用する場合の規則

4.9.3　定義情報ファイルの記述形式

4.9.4　定義情報ファイルの記述例

4.9.5　定義情報ファイルの記述例（VariableArray型のプロパティを追加する場合）

4.9.6　定義情報ファイルの記述例（全文検索機能を使用する文書クラスを追加する場合）

4.9.7　定義情報ファイルの記述例（文字列型プロパティに対する全文検索機能を使用する場合）

4.10　RDエリア定義情報ファイル

4.10.1　RDエリア定義情報ファイルの概要

4.10.2　RDエリア定義情報ファイルの記述形式

4.10.3　RDエリア定義情報ファイルの記述例

4.10.4　RDエリア定義情報ファイルの注意事項

4.11　インデクス情報ファイル

4.11.1　インデクス情報ファイルの概要

4.11.2　インデクス名をデータベース定義の名称に使用する場合の規則

4.11.3　インデクス情報ファイルの記述形式

4.11.4　インデクス情報ファイルの記述例

4.12　変更情報ファイル

4.12.1　変更情報ファイルの概要

4.12.2　変更情報ファイルの記述規則

4.12.3　ユーザ識別子変更情報ファイル

4.12.4　グループ識別子変更情報ファイル

4.12.5　プロパティ変更情報ファイル

5.　DocumentBrokerの起動と終了

5.1　DocumentBrokerの起動方法

5.2　DocumentBrokerの終了方法

6.　運用と障害対策

6.1　データベースの運用

6.1.1　バックアップとリストア

6.1.2　ジャーナルファイルの運用

6.1.3　レプリケーション

6.2　クラス定義の変更

6.2.1　クラスの定義を変更する場合について

6.2.2　クラスの追加

6.2.3　クラスの削除

6.2.4　クラスの定義の変更

6.3　リファレンスファイル管理機能を使用する場合の運用

6.3.1　コンテンツの格納先ディレクトリの運用方法

6.3.2　ファイルシステムのバックアップとリストア

6.4　障害対策

6.4.1　障害が発生した時にDocumentBrokerが出力する情報

6.4.2　障害要因の特定

6.4.3　障害への対処

6.4.4　IT Report Utilityを利用した保守情報の採取

7.　コマンドリファレンス

7.1　コマンドの種類

7.1.1　コマンド一覧

7.2　コマンドの形式

7.3　コマンドの文法

dbjaddmeta（メタ情報の追加）

dbjchgmeta（メタ情報の変更）

dbjcrtsql（DocumentBroker用データベース定義文の作成）

dbjdelmeta（メタ情報の削除）

dbjgenguid（GUIDの生成）

dbjinitmeta（メタ情報の初期設定）

dbjprintmeta（登録済みメタ情報の出力）

dbjregenvid（DocumentBroker実行環境の情報の登録）

dbjchgusrid（ユーザ／グループの一括変更）

dbjlsfldr（フォルダ一覧の出力）

dbjlsdoc（文書一覧の出力）

7.4　コマンドが出力するファイル

7.4.1　dbjlsfldrコマンドが出力するファイル

7.4.2　dbjlsdocコマンドが出力するファイル

付録

付録A　システムクラス，システムプロパティおよびデータベース定義の名称規則

付録A.1　システムクラスの名称定義の規則

付録A.2　システムプロパティの名称の規則

付録A.3　データベース定義の名称定義の規則

付録B　ユーザ作成のアクセスルーチンを使用するためのインターフェースとクラス

付録B.1　jp.co.Hitachi.soft.docbroker.auth.DbjAuthModuleインターフェイス

付録B.2　jp.co.Hitachi.soft.docbroker.auth.DbjAuthUserInfoインターフェイス

付録B.3　jp.co.Hitachi.soft.docbroker.auth.DbjAuthExceptionクラス

付録C　DocumentBroker Version 5へのバージョンアップ手順

付録D　このマニュアルの参考情報

付録D.1　関連マニュアル

付録D.2　このマニュアルでの表記

付録D.3　DocumentBrokerのマニュアルで使用する略語

付録D.4　KB（キロバイト）などの単位表記について

付録E　用語解説

索引

[他社商品名称に関する表示]

All Rights Reserved. Copyright (C) 2012, Hitachi, Ltd.
All Rights Reserved. Copyright (C) 2012, 2013, Hitachi Solutions, Ltd.

前書き

■ 対象製品

R-1595F-13　 uCosminexus DocumentBroker Platform　 05-10（適用OS：Windows Server 2008 R2，Windows Server 2012）
R-1L95F-13　 uCosminexus DocumentBroker Platform　 05-10※（適用OS：Red Hat Enterprise Linux 6 (x86_64)）
R-1595F-43　 uCosminexus DocumentBroker Developer　 05-10（適用OS：Windows Server 2008 R2，Windows Server 2012，Windows 7 (x86)，Windows 7 (x64)，Windows 8 (x86)，Windows 8 (x64)）
R-1595F-53　 uCosminexus DocumentBroker Runtime Library　 05-10（適用OS：Windows Server 2008 R2，Windows Server 2012，Windows 7 (x86)，Windows 7 (x64)，Windows 8 (x86)，Windows 8 (x64)）
R-1L95F-53　 uCosminexus DocumentBroker Runtime Library　 05-10※（適用OS：Red Hat Enterprise Linux 6 (x86_64)）

※印の適用OSについては，サポート時期をご確認ください。

■ 輸出時の注意

本製品を輸出される場合には、外国為替及び外国貿易法の規制並びに米国輸出管理規則など外国の輸出関連法規をご確認の上、必要な手続きをお取りください。
なお、不明な場合は、弊社担当営業にお問い合わせください。

■ 商標類

Active Directoryは，米国Microsoft Corporationの，米国およびその他の国における登録商標または商標です。
GIFは，米国CompuServe Inc.が開発したフォーマットの名称です。
Linuxは，Linus Torvalds氏の日本およびその他の国における登録商標または商標です。
Microsoft Office Wordは，米国 Microsoft Corporation の商品名称です。
Microsoftは，米国Microsoft Corporationの米国およびその他の国における登録商標または商標です。Microsoft Wordは，米国Microsoft Corporationの商品名称です。
MicrosoftおよびWindowsは，米国Microsoft Corporationの米国およびその他の国における登録商標または商標です。
MicrosoftおよびWindows Serverは，米国Microsoft Corporationの米国およびその他の国における登録商標または商標です。
OracleとJavaは，Oracle Corporation及びその子会社，関連会社の米国及びその他の国における登録商標です。
UNIXは，The Open Groupの米国ならびに他の国における登録商標です。
その他記載の会社名，製品名は，それぞれの会社の商標もしくは登録商標です。

■ マイクロソフト製品の表記について

このマニュアルでは，マイクロソフト製品の名称を次のように表記しています。

製品名称 | 略称
Microsoft(R) Office Word | Word
Microsoft(R) Word
Windows(R) 8 Pro (32ビット版) | Windows 8 | Windows
Windows(R) 8 Enterprise (32ビット版)
Windows(R) 8 Pro (64ビット版)
Windows(R) 8 Enterprise (64ビット版)
Microsoft(R) Windows(R) 7 Professional 日本語版(32ビット版) | Windows 7
Microsoft(R) Windows(R) 7 Enterprise 日本語版(32ビット版)
Microsoft(R) Windows(R) 7 Ultimate 日本語版(32ビット版)
Microsoft(R) Windows(R) 7 Professional 日本語版(64ビット版)
Microsoft(R) Windows(R) 7 Enterprise 日本語版(64ビット版)
Microsoft(R) Windows(R) 7 Ultimate 日本語版(64ビット版)
Microsoft(R) Windows Server(R) 2012 Datacenter 日本語版 | Windows Server 2012
Microsoft(R) Windows Server(R) 2012 Standard 日本語版
Microsoft(R) Windows Server(R) 2008 R2 Enterprise 日本語版 | Windows Server 2008 R2
Microsoft(R) Windows Server(R) 2008 R2 Standard 日本語版

■ 発行

2013年4月 3021-3-401-10

■ 著作権

All Rights Reserved. Copyright (C) 2012, Hitachi, Ltd.
All Rights Reserved. Copyright (C) 2012, 2013, Hitachi Solutions, Ltd.

変更内容

変更内容（3021-3-401-10）

追加・変更内容 | 変更個所
入力ストリームを使用した文書操作ができるようになりました。 | 4.3.1，4.3.2
オブジェクトに設定されているユーザ，グループの情報を一括で変更できるようになりました。 | 4.12，7.3 dbjchgusrid
IT Report Utilityを利用した保守情報の採取ができるようになりました。 | 6.4.4
フォルダ一覧を出力できるようになりました。 | 7.3 dbjlsfldr，7.4.1
文書一覧を出力できるようになりました。 | 7.3 dbjlsdoc，7.4.2
前提OSにWindows Server 2012およびWindows 8を追加しました。 | －

単なる誤字・脱字などはお断りなく訂正しました。

はじめに

このマニュアルは，次に示すプログラムプロダクトの環境設定および運用方法について説明したものです。

R-1595F-13　uCosminexus DocumentBroker Platform

R-1L95F-13　uCosminexus DocumentBroker Platform

R-1595F-43　uCosminexus DocumentBroker Developer

R-1595F-53　uCosminexus DocumentBroker Runtime Library

R-1L95F-53　uCosminexus DocumentBroker Runtime Library

＜はじめにの構成＞

対象読者

マニュアルの構成

このマニュアルで使用する記号

このマニュアルで使用する構文要素記号

対象読者

このマニュアルは，uCosminexus DocumentBrokerのシステムの導入・運用について説明したものです。uCosminexus DocumentBrokerの機能を解説した，マニュアル「DocumentBroker Version 5　概説」の内容を踏まえた上でご利用ください。

Windowsに関する知識

HiRDBに関する知識

UNIXに関する知識

マニュアルの構成

このマニュアルは，次に示す章と付録から構成されています。

第1章　概説

uCosminexus DocumentBrokerの概要およびシステム構成について説明しています。

第2章　システム導入前の検討

uCosminexus DocumentBrokerを利用した文書管理システムの導入前に必要な検討項目について説明しています。

第3章　環境設定

uCosminexus DocumentBrokerの環境設定について説明しています。

第4章　環境設定で必要なファイル

uCosminexus DocumentBrokerの環境設定で必要なファイルについて説明しています。

第5章　DocumentBrokerの起動と終了

uCosminexus DocumentBrokerの起動方法および終了方法について説明しています。

第6章　運用と障害対策

運用方法および障害対策について説明しています。

第7章　コマンドリファレンス

コマンドの文法について説明しています。

付録A　システムクラスおよびシステムプロパティの名称の規則

uCosminexus DocumentBrokerのシステムクラスおよびシステムプロパティの名前，表識別子，および列名について説明しています。

付録B　ユーザ作成のアクセスルーチンを使用するためのインターフェースとクラス

ユーザ管理システムのアクセスルーチンとしてDocumentBrokerが提供するインターフェースとクラスについて説明しています。

付録C　DocumentBroker Version 5へのバージョンアップ手順

DocumentBrokerVersion 3以前のバージョンから，DocumentBrokerVersion 5へバージョンアップする手順について説明しています。

付録D　このマニュアルの参考情報

関連マニュアルや表記など，参考情報について説明しています。

付録E　用語解説

uCosminexus DocumentBrokerで使用する用語について説明しています。

このマニュアルで使用する記号

このマニュアルで使用する記号を次に示します。

記号
意味

　｜
横に並べられた複数の項目に対する項目間の区切りを示し，「または」の意味を表します。
（例）　A｜B
　AまたはBを指定することを示します。

　＿
括弧で囲まれた複数項目のうち1項目に対し使用され，括弧内のすべてを省略した場合にシステムが取る標準値を示します。
（例）　〔A｜B〕
　何も指定しない場合はAが仮定されます。

｛　｝
この記号で囲まれている複数の項目のうちから一つを選択することを示します。項目が横に並べられ，記号｜で区切られている場合は，そのうちの一つを選択します。
（例）　｛A｜B｜C｝
　A，BまたはCのどれかを指定することを示します。

〔　〕
この記号で囲まれている項目は省略してもよいことを意味します。複数の項目が横に並べて記述されている場合には，すべてを省略するか，記号｛ ｝と同じくどれか一つを選択します。
（例1）　〔A〕
　「何も指定しない」か「Aを指定する」ことを示します。
（例2）　〔B｜C〕
　「何も指定しない」か「BまたはCを指定する」ことを示します。

<　>
この記号で囲まれている項目は，該当する要素を指定することを示します。
（例）　<プロパティ>
　プロパティを記述します。

：：＝
この記号の左にあるものを右にあるもので定義することを示します。
（例）　A：：＝B
　「AとはBである」と定義することを示します。

　...
この記号の直前の項目を繰り返し，複数個指定できることを示します。
（例）　A...
　Aを複数個指定できることを示します。

このマニュアルで使用する構文要素記号

このマニュアルで使用するユーザ指定値の内容を表す記号です。

構文要素記号 | 意　味
英字 | A～Z　a～z
英小文字 | a～z
英大文字 | A～Z
数字 | 0～9
英数字 | A～Z　a～z　0～9
16進数字 | 0～9　A～F　a～f
記号 | !　"　#　$　%　&　'　(　)　+　,　_　・　.　/　:　;　<　=　>　@　[　]　^　－　｛　｝　￣　空白　¥

注　すべて半角文字を使用してください。

1.　概説

この章では，DocumentBrokerの概要について説明します。

＜この章の構成＞

1.1　DocumentBrokerの機能

1.2　DocumentBrokerのシステム構成

1.1　DocumentBrokerの機能

この節では，DocumentBrokerの機能について説明します。

DocumentBrokerの文書管理システムで提供する機能の一覧を次の表に示します。

表1-1　DocumentBrokerの文書管理システムで提供する機能の一覧

項番
分類
機能
機能の実現に必要な関連製品とユティリティ製品
参照先

1
文書管理
文書の登録機能
－
1.1.1

2
バージョン管理機能
－

3
フォルダ管理機能
－
1.1.2

4
文書の属性情報の管理機能
－
1.1.3

5
マルチレンディション管理機能
－
1.1.4

6
文書間リンク機能
－
1.1.5

7
リファレンスファイル管理機能
－
1.1.6

8
レンディションのコンテンツ種別変換機能
－
1.1.7

9
独立データの管理
独立データの管理機能
－
1.1.8

10
アクセス制御
アクセス制御機能
LDAP対応のディレクトリサービス
1.1.9

11
検索
属性検索
－
1.1.10

12
全文検索

HiRDB Text Search Plug-in，またはHiRDB XML Extension

13
概念検索

HiRDB Text Search Plug-in，またはHiRDB XML Extension

HiRDB Text Search Plug-in Conceptual Extension

14
文字列型プロパティに対する全文検索

HiRDB Text Search Plug-in，またはHiRDB XML Extension

15
変換・登録
全文検索インデクス一括登録機能
DocumentBroker Text Search Index Loader
1.1.11

16
レンディション変換機能
－
1.1.12

17
環境構築
複数の実行環境機能
－
1.1.13

＜この節の構成＞

1.1.1　文書の登録機能とバージョン管理機能

1.1.2　フォルダ管理機能

1.1.3　文書の属性情報の管理機能

1.1.4　マルチレンディション管理機能

1.1.5　文書間リンク機能

1.1.6　リファレンスファイル管理機能

1.1.7　レンディションのコンテンツ種別変換機能

1.1.8　独立データの管理機能

1.1.9　アクセス制御機能

1.1.10　検索機能

1.1.11　全文検索インデクス一括登録機能

1.1.12　レンディション変換機能

1.1.13　複数の実行環境機能

1.1.1　文書の登録機能とバージョン管理機能

文書をデータベースに登録して一元管理できます。また，文書を登録する際には，必要に応じて「Version1」や「Version2」などの版（バージョン）を付けて，文書の履歴を管理できます。文書のバージョンを管理することで，過去のある時点での文書を復元したり，その文書を流用して新たに文書を作成したりできます。一つのバージョンだけを持ち，バージョンを管理しない文書を，バージョンなし文書といいます。複数のバージョンを持ち，バージョンを管理する文書を，バージョン付き文書といいます。

バージョン付き文書の管理例を次の図に示します。

図1-1　バージョン付き文書の管理例

この例では，バージョン付き文書「発表資料」を作成して，社内発表時および社外発表時にバージョンを追加して，管理しています。

文書のバージョンを管理するときには，新しく文書を作成した時点からバージョンを付け始め，更新のたびにバージョンを追加していきます。バージョンを追加する場合は，チェックアウトとチェックインという操作が必要になります。チェックアウトは，新しいバージョンの追加を予約するために，最新バージョンの次に仮のバージョンを追加する操作です。また，チェックインは，チェックアウトで追加した仮のバージョンを最新バージョンとして確定する操作です。チェックアウト中はチェックアウトしたユーザ以外は文書を上書きできないため，ほかのユーザによる文書の二重更新を防止できます。

1.1.2　フォルダ管理機能

文書をまとめて格納するフォルダや，文書を分類するフォルダを利用して文書を管理できます。文書をまとめたり，分類したりするフォルダに相当するオブジェクトを，フォルダといいます。

フォルダには，複数の文書またはフォルダを関連づけられます。フォルダを使用すると，複数の文書を目的に応じて一つにまとめて管理したり，一つの文書を複数の観点から分類して管理したりできます。また，フォルダとフォルダを関連づけることで，フォルダや分類に階層を持たせることもできます。

フォルダによる文書の管理例を次の図に示します。

図1-2　フォルダによる文書の管理例

この図では，プロジェクトAというフォルダで，このプロジェクトに関連する文書をまとめて管理しています。「製品仕様書」は，製品仕様書，設計メモおよび変更歴で構成されます。したがって，「プロジェクトA」フォルダの下位に「製品仕様書」というフォルダを作成して，関連する文書をまとめて格納して管理しています。

また，「作成者X」フォルダ，「作成者Y」フォルダおよび「カタログ」フォルダは，文書を分類するためのフォルダです。「プロジェクトAに関連する文書」，「プロジェクトAの製品仕様書を構成する文書」というまとめ方とは別の視点で，文書をまとめています。したがって，製品Aカタログや製品仕様書がプロジェクトAに関連する文書であることを知らないユーザでも，文書を分類しているフォルダからたどることで，文書を見つけやすくなります。

1.1.3　文書の属性情報の管理機能

文書やフォルダなどのオブジェクトにさまざまな属性を付けて管理できます。この属性をプロパティといいます。プロパティには，DocumentBrokerによってあらかじめ定義されているプロパティ（システムプロパティ）と，ユーザが任意に追加定義するプロパティ（ユーザプロパティ）があります。例えば，文書を管理する場合，ユーザプロパティとして，「文書名」や「作成日時」などの標準的な属性情報だけでなく，「顧客名」や「競合他社名」などの業務に応じた属性情報も一緒に管理できます。

文書やフォルダにプロパティを定義すると，プロパティをキーにしてオブジェクトを検索したり，プロパティの値を参照してオブジェクトの状態を確認したりできます。

1.1.4　マルチレンディション管理機能

文書の実体であるコンテンツ（Wordやテキストエディタなどのアプリケーションプログラムで作成された文書ファイル）と，その形式を表すレンディションタイプ（MIME形式）の情報を合わせて，レンディションといいます。

バージョンなし文書とバージョン付き文書には，1個または複数のレンディションを登録して管理できます。一つの文書に対して同じ内容を表す複数のレンディションを登録して管理する機能のことを，マルチレンディション管理機能といいます。また，複数のレンディションを登録した文書を特に，マルチレンディション文書といいます。マルチレンディション文書は，一つの文書の内容を，対応するアプリケーションごとの複数の形式に変換した場合などに使用できます。

マルチレンディション管理機能では，次の2種類のレンディションを区別して扱います。

マスタレンディション
主要なレンディションです。レンディションを1個だけ登録した場合は，そのレンディションがマスタレンディションになります。

サブレンディション
マスタレンディション以外のレンディションです。

なお，このマニュアルでは，2種類のレンディションを合わせて，レンディションと呼びます。レンディションの種類によって説明が異なる場合は，それぞれ「マスタレンディション」，「サブレンディション」と記述して区別します。

マルチレンディション文書の管理例を次の図に示します。

図1-3　マルチレンディション文書の管理例

この図では，マルチレンディション文書のコンテンツとして，同じ内容を表す複数の形式のファイルを登録しています。文書を編集するユーザはWord形式のファイル，Wordがインストールされていないマシンで文書を参照するユーザはHTML形式のファイル，配布用の文書を取得したいユーザはPDF形式のファイルをそれぞれダウンロードできます。このように，マルチレンディション文書では，ユーザの目的やユーザが使用するマシンの環境などの利用形態に応じて，適切なレンディションを指定して文書を利用できます。

また，マルチレンディション管理機能とアクセス制御機能を組み合わせて，マルチレンディション文書を管理できます。例えば，Word形式のファイルとPDF形式のファイルを登録して，文書を更新できるユーザにはWord形式のファイルを参照させて，文書の参照だけできるユーザにはPDF形式のファイルを参照させるというように，ユーザに設定するアクセス権によって，ユーザが参照できるコンテンツを限定するという運用が考えられます。アクセス制御機能については，「1.1.9　アクセス制御機能」を参照してください。

1.1.5　文書間リンク機能

文書と文書を関連づけて管理する機能を，文書間リンクといいます。

文書間リンクは，次のような場合に使用できます。

参考文献のある論文などの文書を，参考文献とともに管理したい場合

別文書として登録しているテキストと図データを関連がわかるように管理したい場合

DocumentBrokerは，二つの文書を文書間リンクという概念を利用して関連づけます。この場合，文書間リンクを設定した文書をリンク元文書，文書間リンクを設定された文書をリンク先文書といいます。

一つの文書間リンクでは，一つのリンク元文書と一つのリンク先文書を関連づけられます。また，一つの文書に対して，複数の文書間リンクを設定できます。一つの文書に対して複数の文書から文書間リンクを設定することもできます。

1.1.6　リファレンスファイル管理機能

リファレンスファイル管理機能では，文書の実体であるコンテンツをファイルシステムの任意のディレクトリに格納し，文書のプロパティとコンテンツの格納先の情報（コンテンツロケーション）をデータベースに登録して管理します。

ファイルシステムには，次のどれかを使用してください。

DocumentBrokerが存在するマシン上のローカルディスクまたは共有ディスク

UNIXの場合
ネットワークファイルシステム（NFS）を利用してアクセス可能な共有ディスク

Windowsの場合
DocumentBrokerが存在するマシンからUNC形式のパスを使用して接続可能な共有ディスク

コンテンツロケーションには，コンテンツの格納先の基点となるディレクトリパス（コンテンツ格納先ベースパス）からの相対パスが登録されます。このため，コンテンツの格納先を移行する場合などは，データベースに影響を与えることなく，コンテンツ格納先ベースパスを変更するだけで，コンテンツの格納領域を変更できます。また，コンテンツをデータベースに格納しないため，データベースの容量を削減できます。

リファレンスファイル管理機能を使用して管理している文書を，リファレンスファイル文書といいます。バージョンなし文書およびバージョン付き文書は，リファレンスファイル文書として管理できます。

リファレンスファイル文書の管理例を次の図に示します。

図1-4　リファレンスファイル文書の管理例

この図では，ファイルシステムとして，DocumentBrokerが存在するマシンのローカルディスクを利用してリファレンスファイル文書を管理する場合と，ファイルサーバの共有ディスクを利用してリファレンスファイル文書を管理する場合の例を示しています。ファイルシステムにコンテンツを格納し，データベースにプロパティとコンテンツロケーションを登録して管理しています。このように，リファレンスファイル管理機能では，データベースにコンテンツを格納しないので，コンテンツの格納先を選択したり，コンテンツの格納先のディスクを移行したりと，柔軟にコンテンツの格納先を管理できます。

また，ファイルシステムをネットワーク上のマシンの共有ディスクとする場合は，コンテンツ格納先ベースパスを，UNC形式のパスで指定してコンテンツを操作します。

1.1.7　レンディションのコンテンツ種別変換機能

レンディションのコンテンツ種別変換機能は，レンディションのコンテンツの格納先（コンテンツ種別）を変換する機能です。

DocumentBrokerでは，文書の実体であるコンテンツをデータベースやDocumentBrokerが接続可能なファイルシステムの任意のディレクトリなどに格納して管理できます。これらの格納先で管理されるコンテンツを，変化するデータの利用価値に応じて，最適な格納先へ変換できます。

コンテンツ種別を，シングルファイル文書（データベースに登録されている一つのファイルをコンテンツとして持つ文書）から，リファレンスファイル文書（DocumentBrokerから接続可能なファイルシステムの任意のディレクトリに格納されているファイルをコンテンツとして持つ文書）に変換したコンテンツは，磁気テープなどのストレージへのバックアップや移動など，コンテンツ管理の柔軟な運用を行うことができます。

レンディションのコンテンツ種別変換機能を使用して，コンテンツ種別を変換する例を次の図に示します。

図1-5　レンディションのコンテンツ種別変換の例

コンテンツ種別の変換は，文書のマルチレンディション管理機能を使用して，変換後のコンテンツをサブレンディションとして追加します。

例2では，シングルファイル文書のコンテンツを，リファレンスファイル文書のコンテンツに変換し，レンディションを追加します。これをコンテンツの二重化と呼びます。コンテンツを二重化する場合，追加するレンディションのレンディションタイプにコメントを付与して格納先を分類します。なお，コンテンツを二重化したあとにレンディションを操作する場合は，マルチレンディション管理機能を使用します。

＜この項の構成＞

(1)　変換できるコンテンツ種別

(2)　注意事項

(1)　変換できるコンテンツ種別

レンディションのコンテンツ種別変換機能で変換できるコンテンツ種別を次の表に示します。

表1-2　レンディションのコンテンツ種別変換機能で変換できるコンテンツ種別

変換前のコンテンツ種別 | 変換後のコンテンツ種別
シングルファイル文書 | リファレンスファイル文書
リファレンスファイル文書 | シングルファイル文書

レンディションのコンテンツ種別は，レンディションのコンテンツ種別を表すプロパティを参照することで判別できます。プロパティの詳細については，マニュアル「DocumentBroker Version 5　概説」を参照してください。

(2)　注意事項

コンテンツ種別を変換して，サブレンディションとして追加するときには，追加するレンディションに対してレンディションコメントを付与します。コンテンツの変換前，または変換後のどちらかのレンディションに対してコメントを付与できますが，変換したコンテンツであることが明確になるように変換後のコンテンツに対して，コンテンツ種別を表すコメントを付けることをお勧めします。

ただし，DocumentBrokerのユティリティ製品を使用した運用で，変換後のコンテンツをマスタレンディションとする場合などでは，変換前のレンディションに対してコメントを付与できます。

レンディションのコンテンツ種別変換機能を使用する場合に，DocumentBrokerのユティリティ製品を使用するときの注意事項を次に示します。

DocumentBroker Text Search Index Loader
レンディションタイプを前方一致で扱います。レンディションのコンテンツ種別変換機能を使用した運用では，レンディション定義ファイル中で該当するレンディションタイプを前方一致で定義します。ただし，DocumentBroker Text Search Index Loaderでは，リファレンスファイル文書のテキスト抽出はできません。

1.1.8　独立データの管理機能

文書やフォルダなどのほかのオブジェクトの体系に関係しない，独立したデータを管理するオブジェクトのことを独立データといいます。単なる表として扱いたいデータなどは独立データとして管理できます。

独立データは，文書のようにまとめたり，フォルダに関連づけたり，バージョンを管理したり，フォルダのように上位・下位の階層構造で管理したりできません。

1.1.9　アクセス制御機能

DocumentBrokerでは，DocumentBrokerが管理するメモリ空間（文書空間）にユーザがログインするときに生成されるユーザ情報やオブジェクトに設定されたアクセス制御情報などからユーザのアクセス権を判定してアクセスを制御します。文書空間にログインするときのユーザ認証，オブジェクトへのアクセス制御は，ユーザ管理システムとの連携によって実現します。

＜この項の構成＞

(1)　ユーザ認証

(2)　オブジェクトに対するアクセス制御

(1)　ユーザ認証

DocumentBrokerでは，LDAP対応のディレクトリサービスと連携したユーザ認証機能を提供しています。これによって，システムへのユーザの不当なログインを制御できます。

文書空間へのログイン要求があった場合，DocumentBrokerは，ユーザから提示されたユーザIDとパスワードに対して，ユーザ管理システムの機能を利用してユーザを認証します。このとき，ログインしたユーザに関する情報を取得して，ユーザ情報を生成します。

(2)　オブジェクトに対するアクセス制御

DocumentBrokerで管理しているオブジェクトに対して，アクセス権を設定できます。例えば，文書に対してアクセス権を設定すると，アクセスを許可されていないユーザが誤って文書を更新してしまうようなことがありません。また，特定の人やグループだけに文書の参照や編集を許可するような運用もできます。

DocumentBrokerが提供するアクセス制御機能は，ユーザやグループに対してアクセス権を与えたり，アクセス権を変更したりできます。例えば，文書の作成，審査，承認といった作業工程に応じてアクセス権を設定できます。これによって，文書のライフサイクル全体を管理できます。

文書にアクセスする場合の，アクセス制御の概要を次の図に示します。

図1-6　アクセス制御の概要

DocumentBrokerのアクセス制御は，アクセス制御対象オブジェクトへアクセスする場合，次に示す二つの情報をアクセス制御機能によって判定し，アクセス制御を実行します。

ログインしたユーザのユーザ情報

アクセス制御対象オブジェクトのアクセス制御情報

文書の操作を要求した場合，操作要求の内容とユーザ情報を比較してアクセス権を判定します。その結果，アクセス権があるときは，要求された文書の操作を実行します。しかし，アクセス権がないときは，「アクセス権なし」というエラーが返却されます。図1-6では，ユーザAが文書の参照を要求しています。DocumentBrokerは，ユーザAのログインによって作成されたユーザ情報と文書Xに設定されているアクセス制御情報とを比較します。その結果，ユーザAに参照権があると判定されて，ユーザＡは文書Xを参照できます。しかし，ユーザBが文書Xの更新を要求した場合，DocumentBrokerは，アクセス権なしのエラーを返却しています。これは，ユーザBには，文書Xを参照する権利だけが与えられているためです。

なお，LDAP対応のディレクトリサービスと連携してアクセス制御機能を使用する場合，アクセス制御機能で使用するユーザ情報は，LDAP対応のディレクトリサービスに管理されている情報を基に生成されます。ただし，運用中のユーザ管理システムがDocumentBrokerのアクセス制御機能に適応していない場合，ユーザが作成したアクセスルーチンを組み込むことによって，そのユーザ管理システムをDocumentBrokerのアクセス制御機能として使用できます。

1.1.10　検索機能

DocumentBrokerで使用できる検索機能について説明します。

＜この項の構成＞

(1)　属性検索機能

(2)　文書に対する全文検索機能

(3)　文字列型プロパティに対する全文検索機能

(4)　検索条件の論理演算機能

(1)　属性検索機能

オブジェクトに設定されているプロパティの値を条件にした検索を実行できる，属性検索機能を提供します。プロパティの値を基に，文書，フォルダ，インデクスに相当するオブジェクトなどが検索できます。例えば，文書名と著者がプロパティとして設定されている場合に，「文書名が『報告書』であり，著者が『日立太郎』である文書を検索する」というような検索ができます。

(2)　文書に対する全文検索機能

文書の内容に含まれるキーワード（検索ターム）を条件にした検索を実行できる，全文検索機能を提供します。

DocumentBrokerは，次のプログラムを利用して全文検索機能を実現します。

HiRDB Text Search Plug-in，またはHiRDB XML Extension

さらに，次のプログラムを利用することによって，HiRDB Text Search Plug-in，またはHiRDB XML Extensionの機能を拡張した検索機能を実現します。

HiRDB Text Search Plug-in Conceptual Extension（概念検索の場合）

全文検索機能では，文書中の任意の検索タームを条件にできます。例えば，「テキスト内に『Document』と『Text』という単語が含まれる文書を検索する」という場合に使用できます。

次に，全文検索機能の基本機能と拡張機能について説明します。なお，このマニュアルでは，これらの検索機能を総称して，全文検索といいます。それぞれの検索に固有の説明をする場合は，それぞれの機能名で説明します。

基本機能

HiRDB Text Search Plug-in，またはHiRDB XML Extensionの機能を使用した検索機能です。

同義語・異表記展開検索
検索タームとして「コンピュータ」を指定した場合，「PC」や「パソコン」といった検索タームの同義語に相当する単語を含む文書も検索できます（同義語展開検索）。
アルファベットの大文字と小文字，かたかなの異表記および半角と全角の文字列を展開して，検索できます。例えば，「ski」を検索タームに指定する場合，「ski」，「SKI」，「Ski」などで表記されている文書も検索できます（異表記展開検索）。

近傍条件検索
二つの検索タームについて，それらの距離や出現順序関係を指定した検索ができます。例えば，「『最新』と『情報』の間の文字数が20文字ちょうどの文書を検索する。ただし，『最新』と『情報』はどちらが先に出現してもよい」という指定ができます。

拡張機能

ほかのプログラムの機能によってHiRDB Text Search Plug-in，またはHiRDB XML Extensionの機能を拡張した検索機能です。

概念検索
全文検索では，指定する検索タームに適した具体的な単語が思いつかない場合に，検索したい文書に類似した概念を持つ文章（種文章）を検索条件とした検索もできます。これを，概念検索といいます。概念検索では，検索条件として指定した文書からその文書を特徴づける単語（特徴ターム）が抽出され，それを検索タームとした検索が実行されます。例えば，「『…リサイクルは，資源の有効活用に貢献するだけでなく，ゴミの減量化にも役立ちます…』という文章に近い概念の文書を検索する」という場合に使用できます。概念検索機能を使用するためには，HiRDB Text Search Plug-in，またはHiRDB XML Extensionの機能のほかに，HiRDB Text Search Plug-in Conceptual Extensionが必要です。

(3)　文字列型プロパティに対する全文検索機能

オブジェクトに設定されている文字列型プロパティの値に含まれるキーワード（検索ターム）を条件にした検索を実行できる，全文検索機能を提供します。全文検索機能を使用できる文字列型プロパティのことを全文検索機能付き文字列型プロパティといいます。

DocumentBrokerは，次のプログラムを利用して文字列型プロパティに対する全文検索機能を実現します。

HiRDB Text Search Plug-in，またはHiRDB XML Extension

HiRDB Text Search Plug-in，またはHiRDB XML Extensionを利用すると，次に示す機能を使用できます。

同義語・異表記展開検索
検索タームとして「コンピュータ」を指定した場合，「PC」や「パソコン」といった検索タームの同義語に相当する単語をプロパティの値に含む文書も検索できます（同義語展開検索）。
アルファベットの大文字と小文字，かたかなの異表記および半角と全角の文字列を展開して，検索できます。例えば，「ski」を検索タームに指定する場合，「ski」，「SKI」，「Ski」などで表記されている文字列をプロパティの値に含む文書も検索できます（異表記展開検索）。

近傍条件検索
二つの検索タームについて，それらの距離や出現順序関係を指定した検索ができます。例えば，「『最新』と『情報』の間の文字数が20文字ちょうどの値をプロパティに含む文書を検索する。ただし，『最新』と『情報』はどちらが先に出現してもよい」という指定ができます。

文字列型プロパティに対する全文検索機能に対応したDocumentBrokerクラスライブラリのインターフェースおよびメソッドについては，マニュアル「DocumentBroker Version 5　概説」を参照してください。

(4)　検索条件の論理演算機能

検索条件同士の論理積や論理和などを求める機能も提供します。

AND検索

検索条件同士の論理積を求められます。例えば，「著者が『日立太郎』で，文書中に『コンピュータ』という文字列を含む文書を検索する」というような場合に使用できます。

OR検索

検索条件同士の論理和を求めることができます。例えば，「作成者が『日立太郎』である文書，または作成者の所属が『日立製作所』である文書を検索する」というような場合に使用できます。

NOT検索

検索条件との不一致を求めることができます。例えば，「作成者が『日立太郎』ではない文書を検索する」というような場合に使用できます。

1.1.11　全文検索インデクス一括登録機能

DocumentBrokerに登録されている文書からテキスト情報を抽出し，全文検索インデクスとして一括登録する機能です。この機能を利用する場合は，DocumentBroker Text Search Index Loaderを使用します。DocumentBroker Text Search Index Loaderの詳細については，マニュアル「DocumentBroker Text Search Index Loader Version 3」を参照してください。

なお，リファレンスファイル文書の場合，全文検索インデクス一括登録機能は使用できません。

1.1.12　レンディション変換機能

マルチレンディション管理機能を利用して文書を管理する場合に，バッチ処理でレンディション変換を実行する機能です。次のような場合に，登録済みのマスタレンディションのファイルを基に，別のレンディションタイプのファイルを作成して，サブレンディションのコンテンツとして登録すると便利です。

マスタレンディションだけにファイルが登録されている場合

サブレンディションのファイルの登録後にマスタレンディションのファイルが更新された場合

なお，この機能についてはサポート時期をご確認ください。

1.1.13　複数の実行環境機能

使用ユーザ数や単位時間当たりのトランザクション数の増加などによるシステム負荷を軽減するために，一つのデータベースに複数のDocumentBrokerの実行環境を配置したシステム構成を構築できます。これによって，システム負荷が複数のサーバに分散されるため，システム全体の処理能力が向上します。複数のDocumentBrokerの実行環境を配置したシステム構成を次の図に示します。

図1-7　複数のDocumentBrokerの実行環境を配置したシステム構成

実行環境を識別する実行環境識別子を使用して，文書を管理できます。これによって，複数の実行環境から，同じ文書空間にアクセスする運用形態を構築できます。

1.2　DocumentBrokerのシステム構成

この節では，DocumentBrokerのシステム構成について説明します。

＜この節の構成＞

1.2.1　DocumentBrokerを使用したシステムの概略

1.2.1　DocumentBrokerを使用したシステムの概略

ここでは，DocumentBrokerを使用したシステムの概略について説明します。

DocumentBrokerは，分散オブジェクト環境での文書管理基盤フレームワークとして，文書管理に関するさまざまな機能を提供します。これによって，用途に合わせた各種業務システムを構築できます。

＜この項の構成＞

(1)　DocumentBrokerのシステムの構成

(1)　DocumentBrokerのシステムの構成

DocumentBrokerのシステムの構成を次の図に示します。

図1-8　DocumentBrokerのシステムの構成

DocumentBrokerは，業務に対応したクライアントアプリケーションを構築し，それを実行することでDocumentBrokerの機能を利用します。クライアントアプリケーションを実行し，DocumentBroker上でデータベースに格納されているオブジェクトを操作することで，文書の参照や更新などの文書管理が実現します。

2.　システム導入前の検討

この章では，DocumentBrokerを利用した文書管理システムの導入前に必要な検討項目について説明します。

＜この章の構成＞

2.1　適用業務の検討

2.2　追加するクラスおよびプロパティの検討

2.3　文書空間で使用する文字コード種別の検討

2.4　仮想メモリ所要量の見積もり

2.5　データベース容量の見積もり

2.6　リファレンスファイル管理機能を使用する場合のファイルシステムのディスク容量の見積もり

2.1　適用業務の検討

DocumentBrokerは，基幹業務での文書管理システムの構築を支援します。この文書管理システムによって膨大な量の文書として蓄積されているデータを扱うことができるとともに，文書管理を基幹業務プロセスの一環として組み込むことで業務の効率を高めます。この節では，DocumentBrokerを使用した文書管理システムの導入時に検討していただきたいことについて説明します。

適用業務の分析

文書管理システムを適用する基幹業務の性質についての分析が必要です。検索機能を充実させたシステムが必要な業務か，手書きの書類を大量にデータとして登録する業務か，文書のライフサイクル管理が必要な業務か，異なる業務間の連携が必要な業務か，などといった基幹業務の性質について分析してください。

文書に付加する情報の検討

対象の文書の分析結果を基にして，管理する文書に付加する情報を検討します。この作業では，管理する文書を種類ごとに分類して，それぞれに必要な付加情報を検討します。例えば，製品の設計ドキュメントを管理する場合は，「設計者名」，「開発完了予定日」，「特許情報」などの情報をあわせて管理することを検討します。なお，DocumentBrokerでは，「文書」は「クラス」に相当し，「付加情報」は「プロパティ」に相当します。したがって，ここでは，管理する文書の種類ごとにサブクラスを作成するとともに，文書の種類ごとに必要な付加情報については，各サブクラスにプロパティを追加していきます。

文書の管理方法の検討

DocumentBrokerでは，文書の管理方法によって，使用するオブジェクトが異なります。例えば，文書のバージョンを管理する場合はバージョン付き文書を，フォルダ機能を使用して文書をまとめて管理する場合はフォルダを使用して，フォルダに具体的でわかりやすい名称を付けるためのプロパティを追加することが考えられます。関連づけの種類ごとに，サブクラスを追加して，そのサブクラスを基にフォルダを作成していくような運用も考えられます。このように，文書の管理方法に合わせて，作成するオブジェクトについて検討し，管理方法に合わせたクラスおよびプロパティを効果的に定義する必要があります。

文書管理に使用するオブジェクトとオブジェクトの構成については，マニュアル「DocumentBroker Version 5　概説」を参照してください。

また，クラスおよびプロパティの追加については，「2.2　追加するクラスおよびプロパティの検討」を参照してください。

文書空間で使用する文字コード種別の分析

文書管理システムで使用する文字コード種別を分析し，文書空間で使用する文字コード種別を選択します。

文字コード種別は，文書の付加情報やファイル名に使用する文字コード種別に応じて，Shift-JISまたはUTF-8を選択してください。

文書空間で使用する文字コード種別の検討については，「2.3　文書空間で使用する文字コード種別の検討」を参照してください。

2.2　追加するクラスおよびプロパティの検討

この節では，クラスとプロパティの追加の概要，サブクラスとプロパティを追加できるクラス，全文検索機能を使用するために作成する全文検索機能付き文書クラスの追加について説明します。また，具体的な例を示してクラスとプロパティの追加について説明します。

DocumentBrokerでは，文書の管理方法に合わせてサブクラスを作成したり，クラスにプロパティを追加したりできます。この節の内容を参照して，サブクラスの作成とプロパティの追加について検討してください。なお，実際にサブクラスを作成して，クラスにプロパティを追加するためには，定義情報ファイルを作成する必要があります。定義情報ファイルの作成については，「3.8.1　データベースシステムの設定に必要なファイル」，および「4.9　定義情報ファイル」を参照してください。

＜この節の構成＞

2.2.1　クラスおよびプロパティの追加

2.2.2　サブクラスの追加

2.2.3　プロパティの追加

2.2.4　全文検索機能付き文書クラスの追加

2.2.5　クラスおよびプロパティの追加例

2.2.1　クラスおよびプロパティの追加

DocumentBrokerで扱うオブジェクトは，オブジェクト指向に基づいて作成されるため，あるクラスを基に作成されるオブジェクトは，そのクラスのインスタンスとして扱われ，クラスからすべてのプロパティを継承します。すなわち，あるクラスを基に作成したオブジェクトは，同じ種類のオブジェクトであり，同じプロパティが付加されることになります。

幾つかのクラスは，文書の種類や管理方法に合わせてサブクラスを追加できます。DocumentBrokerが提供するクラスやユーザが追加したサブクラスには，必要に応じてプロパティを追加できます。プロパティには，文書に共通的に追加すると便利な情報やその文書に固有の情報など，ユーザがオブジェクトの管理情報として保持したい情報を設定できます。また，追加したプロパティをキーにしてオブジェクトを検索できます。オブジェクトをどのように管理するか，どのように検索するかを考慮して，必要なサブクラスを作成し，管理情報として利用できるプロパティや検索のキーになるようなプロパティを追加して，プロパティの値を設定する必要があります。

DocumentBrokerで管理する文書はその種類ごとに分類できます。例えば，ある製品の購入を勧めるためのプレゼンテーション資料を管理する場合，プレゼンテーション資料作成用のサブクラスを定義して，そのサブクラスに対して，必要なプロパティを追加するような運用が考えられます。プレゼンテーション資料作成用に定義したクラスと文書の作成例を次の図に示します。

図2-1　プレゼンテーション資料作成用に定義したクラスと文書の作成例

この図では，プレゼンテーション資料作成用に追加定義したサブクラスに，次に示すプロパティを追加しています。

文書管理に必要な一般的な管理情報
「文書名」と「作成者名」というString型のプロパティを追加しています。

プレゼンテーション資料としての付加情報
プレゼンテーション先の顧客名を管理する「提案先」というプロパティと競合する会社名を管理する「競合先」というプロパティを追加しています。

このクラスを基に作成した文書（プレゼンテーション資料）は，共通のプロパティを持ちます。プロパティに値を入れることによって，それぞれの文書の内容をプロパティから判別したり，文書の検索性を向上させたりできます。

2.2.2　サブクラスの追加

DocumentBrokerが提供しているクラスに対して，必要に応じてサブクラスを追加できます。ここでは，サブクラスを追加できるクラスとサブクラスを追加する場合の注意事項について説明します。

＜この項の構成＞

(1)　サブクラスを追加できるクラス

(2)　サブクラスを追加する場合の注意事項

(1)　サブクラスを追加できるクラス

サブクラスを追加できるクラスを次の表に示します。

表2-1　サブクラスを追加できるクラス

項番
クラス分類
クラス

1
バージョンなし文書

dmaClass_DocVersionクラス

edmClass_VersionTracedDocVersionクラス

edmClass_VersionTracedComponentDocVersionクラス

2
バージョン付き文書
dmaClass_ConfigurationHistoryクラス

3
バージョンなしフォルダ

dmaClass_Containerクラス

edmClass_ContainerVersionクラス

4
独立データ
edmClass_IndPersistenceクラス

5
可変長配列
edmClass_Structクラス

(2)　サブクラスを追加する場合の注意事項

追加するサブクラスの名称には「dmaClass」および「edmClass」で始まる文字列は使用できません。

サブクラスの名称は重複しないようにしてください。

追加したサブクラスはスーパークラスのすべてのプロパティを継承します。

2.2.3　プロパティの追加

DocumentBrokerが提供するクラスとユーザが定義したクラスに対して，プロパティを追加できます。例えば，dmaClass_DocVersionクラスに「文書名」のプロパティを追加するような場合です。ここでは，プロパティを追加できるクラス，プロパティのデータ型，プロパティの基本単位，およびプロパティを追加する場合の注意事項について説明します。

＜この項の構成＞

(1)　プロパティを追加できるクラス

(2)　データ型の対応

(3)　プロパティを追加する場合の注意事項

(1)　プロパティを追加できるクラス

プロパティを追加できるクラスは次のとおりです。

dmaClass_DirectContainmentRelationshipクラス

dmaClass_ReferentialContainmentRelationshipクラス

edmClass_PublicACLクラス

edmClass_Relationshipクラス

ユーザが追加したサブクラス

(2)　データ型の対応

追加できるプロパティのデータ型とHiRDBで対応するデータ型について次の表に示します。

表2-2　追加できるプロパティのデータ型とHiRDBで対応するデータ型

追加できるプロパティのデータ型 | HiRDBで対応するデータ型
String | MVARCHAR
Integer32 | INTEGER
Boolean
VariableArray | 要素のデータ型に準ずる
FreeWordIndex | FREEWORD

(3)　プロパティを追加する場合の注意事項

追加するプロパティの名称には「dmaProp」，「edmProp」および「dbrprop」で始まる文字列は使用できません。

2.2.4　全文検索機能付き文書クラスの追加

ここでは，全文検索機能を利用するための全文検索機能付き文書クラスの追加について説明します。

構造を持たないテキスト形式の文書（プレーンテキスト）に対して全文検索を実行するためには，全文検索の対象となるサブクラスを追加する必要があります。全文検索の対象となるサブクラスのことを，全文検索機能付き文書クラスといいます。全文検索機能付き文書クラスとは，全文検索に必要な機能を持ったプロパティを追加したdmaClass_DocVersionクラスのサブクラスのことです。

全文検索のうち，概念検索の対象になるクラスについては，全文検索用の機能を持ったプロパティのほかに，概念検索用の機能を持ったプロパティも追加する必要があります。概念検索に必要な機能を持ったプロパティを追加したdmaClass_DocVersionクラスのサブクラスのことを特に，概念検索機能付き文書クラスといいます。

全文検索の対象になるオブジェクトを作成する場合は，全文検索機能付き文書クラスを，次に示すオブジェクトの構成要素として指定します。

バージョンなし文書

バージョン付き文書

全文検索機能付き文書クラスに追加するプロパティは，使用する検索機能によって異なります。ここでは，プレーンテキストの文書を対象として，次に示す文書クラスの定義について説明していきます。

全文検索機能付き文書クラス

概念検索機能付き文書クラス

＜この項の構成＞

(1)　全文検索機能付き文書クラスの定義

(2)　概念検索機能付き文書クラスの定義

(1)　全文検索機能付き文書クラスの定義

ここでは，検索タームを指定する全文検索機能を使用する文書クラスの追加定義に必要なプロパティについて説明します。

(a)　追加するプロパティ

全文検索機能を使用する文書クラスを作成する場合，dmaClass_DocVersionクラスのサブクラスとして，次に示すプロパティを追加した文書クラスを作成する必要があります。

全文検索インデクス用プロパティ

edmProp_DocLengthプロパティ

edmProp_ContentIndexStatusプロパティ

全文検索インデクス用プロパティを次に示します。

edmProp_TextIndex

edmProp_ConceptTextIndex

(b)　必要に応じて追加するプロパティ

全文検索機能を使用する文書クラスの定義には，次に示すプロパティのうち，必要なプロパティを追加してください。

edmProp_TextIndexプロパティ
検索エンジンに対して，全文検索用の登録情報を参照することを示すためのプロパティです。プレーンテキストの登録情報を参照する場合は，このプロパティを追加します。

edmProp_ConceptTextIndexプロパティ
検索エンジンに対して，全文検索用または概念検索用の登録情報を参照することを示すためのプロパティです。プレーンテキストの登録情報を参照する場合は，このプロパティを追加します。

edmProp_DocLengthプロパティ
検索した文書の長さを示すプロパティです。バイト単位で示します。

edmProp_ContentIndexStatusプロパティ
全文検索機能を使用する文書クラスに，全文検索インデクスの登録状態を示します。

文書の管理方法に合わせて，プロパティを追加してください。

全文検索機能を使用する文書クラスを定義する場合

1.，2のプロパティのうち，どちらか一つを必ず追加してください。また，3.および4.のプロパティを必ず追加してください。

(2)　概念検索機能付き文書クラスの定義

ここでは，概念検索機能を使用する文書クラスの追加定義に必要なプロパティについて説明します。

(a)　追加するプロパティ

概念検索機能を使用する文書クラスを作成する場合，dmaClass_DocVersionクラスのサブクラスとして，次に示すプロパティを追加した文書クラスを作成する必要があります。

全文検索インデクス用プロパティ（概念検索機能用）

edmProp_DocLengthプロパティ

edmProp_ContentIndexStatusプロパティ

全文検索インデクス用プロパティ（概念検索機能用）を次に示します。

edmProp_ConceptTextIndex

(b)　必要に応じて追加するプロパティ

概念検索機能を使用する文書クラスの定義には，次に示すプロパティのうち，必要なプロパティを追加してください。

edmProp_ConceptTextIndexプロパティ
検索エンジンに対して，概念検索用の登録情報を参照することを示すためのプロパティです。プレーンテキストの登録情報を参照する場合は，このプロパティを追加します。

edmProp_DocLengthプロパティ
検索した文書の長さを示すプロパティです。バイト単位で示します。

edmProp_ContentIndexStatusプロパティ
概念検索機能を使用する文書クラスに，概念検索インデクスの登録状態を示すプロパティです。

文書の管理方法に合わせて，プロパティを追加してください。

概念検索機能を使用する文書クラスを追加する場合

1.のプロパティを必ず追加してください。また，2.および3.のプロパティを必ず追加してください。

2.2.5　クラスおよびプロパティの追加例

ここでは，具体的な例を示して，クラスとプロパティの追加について説明します。

文書を作成，管理するために追加するクラス（dmaClass_DocVersionクラスのサブクラス）とプロパティについて，例に沿って説明します。

（例）

「問題点管理ドキュメント」を管理するためにクラスを追加します。この例で扱う文書の詳細情報を次の表に示します。

表2-3　文書の詳細情報

文書の種類
概要
付加情報
管理方法

問題点管理ドキュメント
製品の開発時の問題点を管理するための文書

問題点分類

問題点発生日時

検討結果

解決日時

直接型のリンクを使用して管理する。

この文書を管理するためのクラスを次のように設計します。追加するサブクラスとスーパークラスの対応を次の表に示します。

表2-4　追加するサブクラスとスーパークラスの対応

管理する文書 | 追加するサブクラス | スーパークラス
問題点管理ドキュメント | usrClass_ProbInfoDoc | dmaClass_DocVersion

問題点管理ドキュメントは，直接型のリンクを使用して管理します。したがって，dmaClass_DocVersionクラスのサブクラスとしてusrClass_ProbInfoDocクラスを追加して管理します。

次に，文書に対して付加する情報を各クラスのプロパティとして追加します。文書の付加情報とプロパティの対応を次の表に示します。

表2-5　付加情報とプロパティの対応

クラス名 | 付加情報 | プロパティ名 | データ型
usrClass_ProbInfoDoc | 問題点分類 | usrProp_Category | String型
問題点発生日時 | usrProp_DateOfProb | Integer32型
検討結果 | usrProp_Status | Boolean型
解決日時 | usrProp_DateOfResolve | Integer32型

なお，追加するサブクラスは，全文検索機能付き文書クラスとして追加します。したがって，この表に示したプロパティのほかに，全文検索用のプロパティを追加する必要があります。全文検索機能付き文書クラスに追加するプロパティについては，「2.2.4　全文検索機能付き文書クラスの追加」を参照してください。

このように，管理する文書の種類や付加情報などから必要なクラスとプロパティを決定してから，その設計情報を基に必要なクラスおよびプロパティを追加してください。

2.3　文書空間で使用する文字コード種別の検討

この節では，文書空間で使用する文字コード種別について説明します。

DocumentBrokerの文書空間では，次のどちらかの文字コード種別を使用できます。一つの文書空間では複数の文字コード種別を使用できません。

Shift-JIS

UTF-8（使用できる文字コードの範囲はUCS-2またはUCS-4です）

選択した文字コード種別は，DocumentBrokerおよびデータベースで必ず一致させてください。異なる文字コード種別を設定した場合の動作は保証しません。

また，日本語および英語以外の言語も使用する場合はUTF-8を選択してください。なお，JIS X0213:2004の規格にはShift-JISで扱えない文字が含まれています。そのため，日本語だけを使用する場合でも，UTF-8を選択することを推奨します。

＜この節の構成＞

(1)　データベースの文字コード種別の設定

(2)　文書空間の文字コード種別の設定

(1)　データベースの文字コード種別の設定

データベース（HiRDB）の文字コード種別は，データベースの環境構築時にHiRDBで設定します。HiRDBの動作環境の設定コマンドの詳細は，マニュアル「HiRDB　コマンドリファレンス」を参照してください。

また，文字コードにUTF-8を使用する場合，全文検索インデクスにUCS-2を利用するかUCS-4を利用するかを検討してください。UCS-4を使用する場合，インデクス定義文にプラグインオプションを追加する必要があります。詳細は，マニュアル「HiRDB Text Search Plug-in」，またはマニュアル「HiRDB XML Extension」を参照してください。

(2)　文書空間の文字コード種別の設定

文書空間の文字コード種別は，DocumentBrokerの環境構築時に設定します。メタ情報の登録コマンド（dbjinitmeta）実行時に，メタ情報初期化ファイルのDocSpaceCharacterSetエントリに指定します。

メタ情報の登録コマンドについては，「7.3　コマンドの文法」を参照してください。

2.4　仮想メモリ所要量の見積もり

ここでは，DocumentBrokerの仮想メモリ所要量の見積もりについて説明します。

仮想メモリ所要量は，次に示す計算式で算出してください。なお，仮想メモリが不足すると，動作が不安定になり異常終了するおそれがあります。仮想メモリには必要量を確保してください。

計算式（単位：メガバイト）

40 + a + b

a＝4×MIN（c,d）×e

b＝（（500＋f×2）×g×h）÷1,048,576

表2-6　仮想メモリの計算式の変数に設定する値

変数 | 設定する値
c | 文書空間で管理する最大文書サイズ（単位：メガバイト）
d | 文書空間構成定義ファイルのBinaryAccessSizeプロパティの値（単位：メガバイト）
e | 文書空間で管理する同時作業文書数
f | 検索で取得するプロパティ長の合計（単位：バイト）
g | 検索ヒット件数
h | 同時検索実行数

2.5　データベース容量の見積もり

ここでは，DocumentBrokerのデータベース容量の見積もりについて説明します。

＜この節の構成＞

2.5.1　データベース容量の見積もり方法

2.5.2　ユーザ用RDエリアの容量の見積もり

2.5.3　ユーザLOB用RDエリアの容量の見積もり

2.5.4　アクセス制御機能に関連するデータベース容量の見積もり

2.5.1　データベース容量の見積もり方法

HiRDBでデータベースシステムを構築するために必要なデータベース容量として，次の容量を確保してください。

データベース容量 = RDエリアの容量 + システムファイルの容量

RDエリアは，HiRDBが管理する表およびインデクスを格納する論理的なエリアのことです。DocumentBrokerで使用するRDエリアを次の表に示します。

表2-7　DocumentBrokerで使用するRDエリア

分類 | RDエリアの種類 | 説明
システム用RDエリア | マスタディレクトリ用RDエリア | データベースシステムの情報を格納します。
データディレクトリ用RDエリア
データディクショナリ用RDエリア
システムLOB用RDエリア | データディクショナリLOB用RDエリア
レジストリ用RDエリア | レジストリ用RDエリア | HiRDB Text Search Plug-in，またはHiRDB XML Extensionを利用した全文検索機能を使用する場合に，HiRDB Text Search Plug-in，またはHiRDB XML Extensionのレジストリ情報を格納します。
レジストリLOB用RDエリア
ユーザ用RDエリア | ユーザ表用RDエリア | DocumentBrokerで扱う文書やフォルダのデータを格納します。
ユーザインデクス用RDエリア
ユーザLOB用RDエリア | コンテンツ格納用RDエリア | 文書のコンテンツを格納します。
SGMLTEXTデータ格納用RDエリア | HiRDB Text Search Plug-in，またはHiRDB XML Extensionを利用した全文検索機能を使用する場合に，コンテンツのテキストデータ，テキストデータのインデクスを格納します。
n-gramインデクス情報格納用RDエリア
全文検索機能付き文字列型プロパティのインデクス格納用RDエリア | HiRDB Text Search Plug-in，またはHiRDB XML Extensionを利用した文字列型プロパティに対する全文検索機能を使用する場合に，全文検索機能付き文字列型プロパティのデータのインデクスを格納します。

このマニュアルでは，DocumentBrokerで扱う文書やフォルダのデータを格納する，次のRDエリアの容量の算出方法について説明します。

ユーザ用RDエリア

ユーザLOB用RDエリア

ほかのRDエリアの容量およびシステムファイルの容量の算出方法については，マニュアル「HiRDB　システム導入・設計ガイド」を参照してください。なお，レジストリ用RDエリアの容量の算出方法については，マニュアル「HiRDB Text Search Plug-in」，またはマニュアル「HiRDB XML Extension」も参照してください。

2.5.2　ユーザ用RDエリアの容量の見積もり

ここでは，DocumentBrokerで使用するユーザ用RDエリアの容量の見積もりについて説明します。なお，アクセス制御機能で使用する容量も加算して，RDエリアの容量を見積もりする必要があります。アクセス制御機能を使用する場合の容量の算出方法については，「2.5.4　アクセス制御機能に関連するデータベース容量の見積もり」を参照してください。

＜この項の構成＞

(1)　DocumentBrokerで使用するユーザ用RDエリア

(2)　ユーザ用RDエリアが使用するデータベースリソースの所要量

(3)　ユーザ用RDエリアの容量の見積もり方法

(4)　見積もりの例

(1)　DocumentBrokerで使用するユーザ用RDエリア

DocumentBrokerで管理する文書やフォルダは，DocumentBrokerオブジェクトとして，データベースに格納されて管理されます。DocumentBrokerオブジェクトは，複数のオブジェクトを包含した形で表現されています。したがって，ユーザ用RDエリアの容量を見積もりする場合，DocumentBrokerオブジェクトに包含されるオブジェクトの構成を考慮して，容量を算出しておく必要があります。

DocumentBrokerで使用するユーザ用RDエリアを次の表に示します。

表2-8　DocumentBrokerで使用するユーザ用RDエリア

ユーザ用RDエリアの種類
説明

ユーザ表用RDエリア
次の情報を格納します。

システムクラス／ユーザクラスに対応する表

DocumentBrokerのメタ情報

ユーザインデクス用RDエリア
次の情報を格納します。

システムクラス／ユーザクラスに対応する表のインデクス

DocumentBrokerのメタ情報のインデクス

ユーザ用RDエリアには，表とそのインデクス，およびDocumentBrokerのメタ情報とそのインデクスを格納します。これらの容量は，文書やフォルダなどの数，定義されているプロパティなどから算出します。また，バージョン付き文書の場合は管理するバージョンの数，マルチレンディション文書の場合はレンディションの数など，文書の構成を考慮する必要があります。

(2)　ユーザ用RDエリアが使用するデータベースリソースの所要量

ここでは，ユーザ用RDエリアの容量を見積もるための目安として，DocumentBrokerのクラス（表）ごとに，各レコードのデータサイズ，および各表に格納するレコード数の見積もり方法を説明した一覧を示します。この一覧を参照して，どのようにRDエリアの容量を見積もるかについては，「(3)　ユーザ用RDエリアの容量の見積もり方法」で説明します。

ユーザ用RDエリア分のデータベースリソースの所要量を次の表に示します。

表2-9　ユーザ用RDエリア分のデータベースリソースの所要量

種別
表名
列数
データサイズ（バイト）
レコード数見積もり方法
備考

文書
dmaClass_DocVersion※1
11
573
バージョン付き文書ごとの平均バージョン数×バージョン付き文書数＋バージョンなし文書数※2
－

dmaClass_Rendition
6
380
（バージョンごとのRendition数－1）×（バージョン付き文書ごとの平均バージョン数×バージョン付き文書数＋バージョンなし文書数※2）
Renditionが一つの場合は，DocVersionの表に含まれます。

dmaClass_ContentReference
8
4949
バージョンごとのRendition数×（バージョン付き文書ごとの平均バージョン数×バージョン付き文書数＋バージョンなし文書数※2）
リファレンスファイル管理機能を使用する場合にだけ必要なクラス。

dmaClass_ContentTransfer
6
605
バージョンごとのRendition数×（バージョン付き文書ごとの平均バージョン数×バージョン付き文書数＋バージョンなし文書数※2）
－

edmClass_VTDocVersion※1
11
573
バージョン付き文書ごとの平均バージョン数×バージョン付き文書数＋バージョンなし文書数※2
－

フォルダ
dmaClass_Container※1
5
176
バージョンなしフォルダ数
－

edmClass_ContainerVersion※1
6
180
バージョンなしフォルダ数
－

edmClass_VTContainer※1
5
176
0
－

バージョン
dmaClass_ConfigHistory※1
6
228
バージョン付き文書数
－

dmaClass_VersionSeries
11
656
バージョン付き文書数
バージョン付き文書ごとのVersionSeries数は一つです。

dmaClass_VerDescription
6
180
バージョン付き文書ごとの平均バージョン数×バージョン付き文書数
－

リンク
dmaClass_DCRelationship
4
172
DirectContainmentRelationshipオブジェクトを利用した関連するオブジェクトの個数
－

dmaClass_RCRelationship
4
172
ReferentialContainmentRelationshipオブジェクトを利用した関連するオブジェクトの個数
－

edmClass_VTCRelationship
7
280
0
－

edmClass_Relationship
5
176
文書間リンクに使用しているRelationshipオブジェクトの個数
－

edmClass_VTRelationship
13
496
0
－

独立データ
edmClass_IndPersistence※1
3
72
独立データオブジェクト数
－

全文検索
全文検索機能付き文書クラス
14
606
バージョン付き文書ごとの平均バージョン数×バージョン付き文書数＋バージョンなし文書数※2
全文検索用のデータを格納する列を追加した文書クラス。

システム用
edmClass_CompoDocVersion※1
11
573
バージョン付き文書ごとの平均バージョン数×バージョン付き文書数＋バージョンなし文書数※2
－

edmClass_VTCompoDocVersion※1
11
573
バージョン付き文書ごとの平均バージョン数×バージョン付き文書数＋バージョンなし文書数※2
－

OIID
edmClass_OIID
3
20
実行環境の数
－

繰り返し列
edmClass_Struct※1
3
84
VariableArray型プロパティの配列に格納する平均要素数×VariableArray型プロパティを定義するオブジェクト数
基本単位がVariableArray型のプロパティの配列の要素を定義する場合のクラス。

メタ情報
EDMS_META_CLASSDESC
4
－
28＋a
a：定義するユーザクラスの数

EDMS_META_CLASSDESC_PROP
4
－
241＋a×23+b
a：定義するユーザクラスの数
b：各クラスに追加するユーザプロパティの合計数

EDMS_META_PROPDESC
9
－
79＋a
a：定義するユーザプロパティの数

EDMS_META_SYSINFO
2
－
11
－

EDMS_META_ENVID
3
－
実行環境の数
－

注※1

サブクラスごとに算出する必要があります。

注※2

バージョンなし文書は，バージョン付き文書の個々のバージョンに対応しない文書を指します。

クラス名と表名の対応については「付録A.1　システムクラスの名称定義の規則」を参照してください。

(3)　ユーザ用RDエリアの容量の見積もり方法

ここでは，ユーザ用RDエリアの容量を見積もるための方法について説明します。ここで算出した値を基にして，実際に使用するディスク占有量を算出してください。

ディスク占有量の算出方法については，マニュアル「HiRDB　システム導入・設計ガイド」を参照してください。

「(2)　ユーザ用RDエリアが使用するデータベースリソースの所要量」の表2-9の内容を参考にして，次の値を算出してください。

(a)　各表に格納するレコードの総数

表2-9のデータサイズおよびレコード数の見積もり方法を参考にして，文書数やフォルダの数などから，各表に格納するレコードの総数を算出してください。

(b)　各表に定義する列の総数

表2-9には，DocumentBrokerのシステムプロパティが使用する列数が示してあります。サブクラスを定義してユーザプロパティを追加した場合は，この表に示すスーパークラスの列数の値に，ユーザプロパティ数を加算して算出してください。

(c)　各列のデータサイズ

表2-9には，DocumentBrokerのシステムプロパティが使用するデータサイズが示してあります。サブクラスを定義してユーザプロパティを追加した場合は，この表に示すスーパークラスのデータサイズの値に，ユーザプロパティのデータサイズを加算してください。ユーザプロパティのデータサイズについては，マニュアル「HiRDB　システム導入・設計ガイド」を参照してください。対応するHiRDBのデータ型を基に，データサイズを算出してください。

(d)　インデクス

オブジェクトのプロパティに定義されるインデクスの算出については，データベース定義文出力コマンド（dbjcrtsql）によって出力されるデータベース定義文を参考にしてください。

メタ情報の表に定義されるインデクスの算出については，createmetatable_hirdb.sqlのデータベース定義文を参考にしてください。これらの定義文を基に，マニュアル「HiRDB　システム導入・設計ガイド」を参照してインデクスを算出してください。

(4)　見積もりの例

ここでは，文書を管理する表の見積もりの例として，バージョン付き文書を管理する表の見積もりの例を示します。バージョン付き文書を管理する表の見積もりの例を次の図に示します。

図2-2　バージョン付き文書を管理する表の見積もりの例

この例では，バージョン付き文書で，3つのバージョンと2つのレンディションを管理しています。ユーザプロパティの追加はありません。例えば，このバージョン付き文書の文書数が1,000の場合，バージョン付き文書を管理する表の容量は次のように算出できます。

文書数 × （文書情報 ＋ （バージョン数 × （バージョン情報 ＋ （レンディション数 － 1） × Renditionオブジェクト ＋ （レンディション数 × ContentTransferオブジェクト））））
= 1,000 ×（884 +（3 ×（753 +（2 － 1）×380 ＋ （2 × 605））））
= 約8.0メガバイト

文書情報

= ConfigurationHistoryのデータサイズ ＋ VersionSeriesのデータサイズ

= 228バイト ＋ 656バイト

= 884バイト

バージョン情報

= VersionDescriptionのデータサイズ ＋ DocVersionのデータサイズ

= 180バイト ＋ 573バイト

= 753バイト

2.5.3　ユーザLOB用RDエリアの容量の見積もり

ここでは，DocumentBrokerで使用するユーザLOB用RDエリアの容量の見積もりについて説明します。

＜この項の構成＞

(1)　DocumentBrokerで使用するユーザLOB用RDエリア

(2)　ユーザLOB用RDエリアが使用するデータベースリソースの所要量

(3)　ユーザLOB用RDエリアの容量の見積もり方法

(1)　DocumentBrokerで使用するユーザLOB用RDエリア

DocumentBrokerで使用するユーザLOB用RDエリアを次の表に示します。

表2-10　DocumentBrokerで使用するユーザLOB用RDエリア

ユーザLOB用RDエリアの種類
説明

コンテンツ格納用RDエリア
文書の実体であるコンテンツを格納します。
このRDエリアは必ず作成してください。

SGMLTEXTデータ格納用RDエリア
コンテンツのテキストデータ（SGMLTEXT）を格納します。
HiRDB Text Search Plug-in，またはHiRDB XML Extensionを利用した全文検索機能を使用する場合には，このRDエリアを作成してください。

n-gramインデクス情報格納用RDエリア
コンテンツのテキストデータのインデクス（n-gramインデクス）を格納します。
HiRDB Text Search Plug-in，またはHiRDB XML Extensionを利用した全文検索機能を使用する場合には，このRDエリアを作成してください。

全文検索機能付き文字列型プロパティのインデクス格納用RDエリア
全文検索機能付き文字列型プロパティのデータのインデクスを格納します。
HiRDB Text Search Plug-in，またはHiRDB XML Extensionを利用した文字列型プロパティに対する全文検索機能を使用する場合には，このRDエリアを作成してください。

ユーザLOB用RDエリアに格納するデータについて説明します。

コンテンツ

Wordやテキストエディタなどのアプリケーションプログラムで作成されたバイナリ形式のファイルです。コンテンツは，dmaClass_ContentTransferクラスに対応する表に格納されます。

テキストデータ（SGMLTEXT）

コンテンツから抽出されたテキスト形式のデータです。テキストデータ（SGMLTEXT）は，dmaClass_DocVersionクラスに対応する表に格納されます。

なお，SGML TEXTは，HiRDB Text Search Plug-in，またはHiRDB XML Extensionでプレーンテキストを扱う抽象データ型（SGMLTEXT型）のデータのことです。詳細については，マニュアル「HiRDB Text Search Plug-in」，またはマニュアル「HiRDB XML Extension」を参照してください。

n-gramインデクス

テキストデータ（SGMLTEXT）の列に対するインデクスデータです。n-gramインデクスは，dmaClass_DocVersionクラスに対応する表に格納されます。

なお，n-gramインデクスは，文書中のn文字（n-gram）の出現位置を登録するインデクスのことで，HiRDB Text Search Plug-in，またはHiRDB XML Extensionで全文検索を実行するときに使用されます。詳細については，マニュアル「HiRDB Text Search Plug-in」，またはマニュアル「HiRDB XML Extension」を参照してください。

全文検索機能付き文字列型プロパティのデータのインデクス

全文検索機能付き文字列型プロパティのデータの列に対するインデクスデータです。全文検索機能付き文字列型プロパティのインデクスデータは，全文検索機能付き文字列型プロパティを追加するサブクラスに対応する表に格納されます。

(2)　ユーザLOB用RDエリアが使用するデータベースリソースの所要量

ここでは，ユーザLOB用RDエリアの容量を見積もるための目安として，DocumentBrokerのクラス（表）ごとのデータサイズの見積もり方法を説明した一覧を示します。この一覧を参照して，どのようにRDエリアの容量を見積もりするかについては，「(3)　ユーザLOB用RDエリアの容量の見積もり方法」で説明します。

ユーザLOB用RDエリア分のデータベースリソースの所要量を次の表に示します。

表2-11　ユーザLOB用RDエリア分のデータベースリソースの所要量

分類 | クラス | データサイズ（バイト） | 備考
コンテンツ格納用 | ContentTransfer | バージョンごとのRendition数×（バージョン付き文書ごとの平均バージョン数×バージョン付き文書数＋バージョンなし文書数※1）×1文書に格納するファイルのファイルサイズの平均値 | 文書の実体であるコンテンツデータを管理するクラス。
全文検索データ格納用 | 全文検索機能付き文書クラス | 登録する文書のコンテンツのサイズに従って算出※2 | －
全文検索機能付き文字列型プロパティのインデクス格納用 | 全文検索機能付き文字列型プロパティを追加するサブクラス | オブジェクトに設定する全文検索機能付き文字列型プロパティのデータのサイズに従って算出※2 | －

注※1

バージョンなし文書は，バージョン付き文書の個々のバージョンに対応しない文書を指します。

注※2

登録する文書のコンテンツのサイズを求めて，マニュアル「HiRDB Text Search Plug-in」，またはマニュアル「HiRDB XML Extension」に従って算出する必要があります。

(3)　ユーザLOB用RDエリアの容量の見積もり方法

ここでは，ユーザLOB用RDエリアの容量を見積もるための方法について説明します。ここで算出した値を基にして，実際に使用するディスク占有量を算出してください。ディスク占有量の算出方法については，マニュアル「HiRDB　システム導入・設計ガイド」を参照してください。

ユーザLOB用RDエリアに格納するデータの容量は，登録するコンテンツのデータサイズや登録する文書の数などを考慮して，的確に見積もってください。

(a)　コンテンツの容量

「(2)　ユーザLOB用RDエリアが使用するデータベースリソースの所要量」の表2-11の内容を参考にして，コンテンツ格納用RDエリアに格納するコンテンツの容量を算出してください。レンディションの数，ファイルの数，文書の論理構造など，文書の構成を考慮して，登録する文書の総数と文書のコンテンツの平均サイズから容量を算出してください。

(b)　全文検索機能で使用する容量

全文検索機能を使用するためには，全文検索機能付き文書クラスごとに，SGMLTEXTデータ格納用RDエリアとn-gramインデクス情報格納用RDエリアをそれぞれ作成する必要があります。全文検索機能を使用するためのRDエリアの容量の見積もりについては，マニュアル「HiRDB Text Search Plug-in」，またはマニュアル「HiRDB XML Extension」を参照してください。

なお，HiRDB Text Search Plug-in，またはHiRDB XML Extensionに登録する文書サイズは，登録する文書のコンテンツのサイズ（単位：バイト）に従って算出してください。

(c)　文字列型プロパティに対する全文検索機能で使用する容量

文字列型プロパティに対する全文検索機能を使用するためには，オブジェクトに設定する全文検索機能付き文字列型プロパティごとに，プロパティのデータのインデクスを格納するためのRDエリアを作成します。

文字列型プロパティに対する全文検索機能を使用するためのRDエリアの容量の見積もりについては，マニュアル「HiRDB Text Search Plug-in」，またはマニュアル「HiRDB XML Extension」を参照してください。

なお，HiRDB Text Search Plug-in，またはHiRDB XML Extensionに登録するプロパティのデータのサイズは，オブジェクトに設定する全文検索機能付き文字列型プロパティのデータのサイズと同じです。

2.5.4　アクセス制御機能に関連するデータベース容量の見積もり

アクセス制御機能のデータベース容量の見積もり方法を説明します。

ここでは，アクセス制御機能のRDエリアの容量を見積もるための目安として，DocumentBrokerのクラス（表）ごとに，各表に定義する列数，各列のデータサイズ，および各表に格納するレコード数の見積もり方法を説明した一覧を示します。アクセス制御機能を使用する場合は，ここで算出した値を，「2.5.2　ユーザ用RDエリアの容量の見積もり」で算出した値に加算して，データベースの容量を見積もってください。

アクセス制御機能が使用するデータベースリソースの所要量を次の表に示します。

表2-12　アクセス制御機能が使用するデータベースリソースの所要量

分類
クラス（表名）
列数
データサイズ（バイト）
レコード数見積もり方法
備考

アクセス制御対象オブジェクト
DocumentBrokerオブジェクトのトップオブジェクトに該当する表
7
532＋17×n
すべてのDocumentBrokerオブジェクトのトップオブジェクト数
n：DocumentBrokerオブジェクトにバインドしたパブリックACLの平均の個数

ACL
edmClass_ACL
6
84＋263×（m＋n）
すべてのDocumentBrokerオブジェクトのトップオブジェクト数

m：DocumentBrokerオブジェクトのローカルACLに設定したACEの平均の個数

n：DocumentBrokerオブジェクトのセキュリティACLに設定したACEの平均の個数

パブリックACL
edmClass_PublicACL
8※1
343＋263×（m＋n）※2
パブリックACLの個数

m：パブリックACLのローカルACLに設定したACEの平均の個数

n：パブリックACLのセキュリティACLに設定したACEの平均の個数

バインド
edmClass_BindRelationship
2
68
すべてのDocumentBrokerオブジェクトのトップオブジェクト数×DocumentBrokerオブジェクトごとのバインドするパブリックACLの平均の個数
なし

注※1

パブリックACLにユーザプロパティを追加した場合，追加したプロパティ数を加えて算出してください。

注※2

パブリックACLにユーザプロパティを追加した場合，追加したプロパティのデータサイズを加えて算出してください。

なお，表2-12の「レコード数見積もり方法」に記述されている「すべてのDocumentBrokerオブジェクトのトップオブジェクト数」とは，作成した文書やフォルダなどに含まれるオブジェクトの個数を表します。このオブジェクトを次に示します。

ComponentDocVersionオブジェクト

ConfigurationHistoryオブジェクト

Containerオブジェクト

ContainerVersionオブジェクト

DocVersionオブジェクト

IndependentPersistenceオブジェクト

VersionTraceableContainerオブジェクト

VersionTracedComponentDocVersionオブジェクト

VersionTracedDocVersionオブジェクト

2.6　リファレンスファイル管理機能を使用する場合のファイルシステムのディスク容量の見積もり

ここでは，リファレンスファイル管理機能を使用する場合の，ファイルシステムのディスク容量の見積もりについて説明します。なお，リファレンスファイル管理機能を使用しない場合，この見積もりは不要です。

ファイルシステムのディスク容量は，コンテンツ格納先ベースパスごとに見積もってください。コンテンツ格納先ベースパスごとに格納する文書の最大サイズを見積もり，見積もりした値より大きいディスク容量を確保する必要があります。コンテンツ格納先ベースパスに対して格納する文書の最大サイズの見積もり式を次に示します。

バージョンごとのRendition数 × （バージョン付き文書ごとの平均バージョン数 × バージョン付き文書数 + バージョンなし文書数※） × 1文書に格納するファイルのファイルサイズの平均値

注※

バージョンなし文書は，バージョン付き文書の個々のバージョンに対応しない文書を指します。

3.　環境設定

この章では，DocumentBrokerの環境設定について説明します。

＜この章の構成＞

3.1　環境設定の流れ

3.2　環境設定の準備

3.3　インストールとアンインストール（UNIXの場合）

3.4　インストールとアンインストール（Windowsの場合）

3.5　データベースシステムでの環境設定

3.6　ユーザ管理機能の設定

3.7　DocumentBrokerの実行環境の作成

3.8　DocumentBrokerでデータベースシステムを使用するための設定

3.9　アプリケーションサーバの設定

3.10　Javaアプリケーションの設定

3.11　複数の実行環境を構築する場合の設定

3.12　リファレンスファイル管理機能を使用する場合の設定

3.1　環境設定の流れ

この節では，DocumentBrokerの環境設定の流れについて説明します。DocumentBrokerの環境を設定する順序を，次に示します。

各プログラムの環境設定をする前の準備
各プログラムの環境設定をする前の準備として，前提プログラムのインストールやオペレーティングシステムにシステム管理者の登録などをします。
「3.2　環境設定の準備」，「3.3　インストールとアンインストール（UNIXの場合）」または「3.4　インストールとアンインストール（Windowsの場合）」，および「3.5　データベースシステムでの環境設定」を参照してください。

ユーザ管理の設定
DocumentBrokerには，幾つかのユーザ管理方法が用意されています。ここでは，利用環境に合わせたユーザ管理機能を設定します。
「3.6　ユーザ管理機能の設定」を参照してください。

DocumentBrokerの実行環境の作成
DocumentBrokerの実行環境を作成します。
「3.7　DocumentBrokerの実行環境の作成」を参照してください。

データベースシステムでの設定
データベースシステムの環境設定をします。
「3.8　DocumentBrokerでデータベースシステムを使用するための設定」を参照してください。

アプリケーションサーバの設定
アプリケーションサーバ（Cosminexus）上でDocumentBrokerを使用するために必要な設定をします。
「3.9　アプリケーションサーバの設定」を参照してください。

Javaアプリケーションの設定
JavaアプリケーションでDocumentBrokerを使用するために必要な設定をします。
「3.10　Javaアプリケーションの設定」を参照してください。

複数の実行環境を構築する設定
複数の実行環境から，同一の文書空間にアクセスする場合に必要な設定をします。
「3.11　複数の実行環境を構築する場合の設定」を参照してください。

リファレンスファイル管理機能の設定
リファレンスファイル管理機能を使用する場合に必要な設定をします。
「3.12　リファレンスファイル管理機能を使用する場合の設定」を参照してください。

3.2　環境設定の準備

この節では，DocumentBrokerの環境を設定する場合の準備について説明します。

＜この節の構成＞

3.2.1　システム管理者の決定

3.2.2　利用ユーザおよびグループの決定

3.2.3　DocumentBrokerの実行環境を作成するディレクトリの決定

3.2.1　システム管理者の決定

DocumentBrokerを運用および管理するシステム管理者には，WindowsのAdministrator権限を持つユーザを割り当てます。UNIXの場合，システム管理者はスーパーユーザ権限，一般ユーザ権限のどちらでも構いません。運用コマンドは，システム管理者だけが実行できます。

3.2.2　利用ユーザおよびグループの決定

DocumentBrokerを利用するユーザとユーザが所属するグループを決定してください。また，ここで決定した利用ユーザおよびグループは，ユーザ管理システムに登録してください。ユーザ管理システムについては，「3.6　ユーザ管理機能の設定」を参照してください。

DocumentBrokerのアクセス制御機能では，DocumentBrokerに登録されたオブジェクトや，そのアクセス権を保守するために，セキュリティ管理者を必ず指定してください。

セキュリティ管理者は，文書空間のすべてのアクセス制御対象オブジェクトに対してフルコントロールのアクセス権を持ちます。セキュリティ管理者は，連携するユーザ管理システムに登録されているユーザから選択して文書空間構成定義ファイルに定義してください。文書空間構成定義ファイルについては，「4.3　文書空間構成定義ファイル（docspace.properties）」を参照してください。

3.2.3　DocumentBrokerの実行環境を作成するディレクトリの決定

DocumentBrokerの実行環境を作成するディレクトリを決定してください。

3.3　インストールとアンインストール（UNIXの場合）

この節では，ご使用のOSがUNIXの場合の，次に示すプログラムのインストール方法およびアンインストール方法について説明します。

DocBroker PlatformまたはDocumentBroker Runtime Library

また，前提プログラムについてもインストールしてください。インストール方法については，各製品のマニュアルを参照してください。

＜この節の構成＞

3.3.1　インストール

3.3.2　アンインストール

3.3.3　インストール済みプログラムの一覧表示

3.3.1　インストール

DocumentBroker PlatformまたはDocumentBroker Runtime Libraryのインストールディレクトリは次のとおりです。

/opt/DocBroker/Platform

/opt/DocBroker/Library

デバイススペシャルファイル名やCD-ROMのマウントディレクトリは，使用する環境によって異なります。詳細については，オペレーティングシステムのマニュアルを参照してください。また，インストールの手順は，プログラムの提供媒体によって異なります。なお，インストール先のフォルダには，ASCIIコードで表せるパスを指定してください。

DocumentBroker PlatformまたはDocumentBroker Runtime Libraryをインストールする手順を次に示します。

スーパーユーザ（id:root）としてオペレーティングシステムにログインする。

「mkdir mnt/cdrom」を実行してCD-ROMをマウントする「mnt/cdrom」ディレクトリを作成する。
「mnt/cdrom」の部分には，CD-ROMをファイルシステムとしてマウントするディレクトリ名を指定してください。

DocumentBroker PlatformまたはDocumentBroker Runtime LibraryのCD-ROMをCD-ROMドライブにセットする。

「mount -r -o mode=0544 /dev/cdrom /mnt/cdrom」を実行してCD-ROMをマウントする。
「/dev/cdrom」および「/mnt/cdrom」の部分は使用する環境によって異なります。使用するデバイススペシャルファイル名およびCD-ROMファイルシステムを指定してください。

CD-ROMのセットアッププログラム「/mnt/cdrom/linux/setup /mnt/cdrom」を実行して日立PPインストーラを起動する。
初期画面が表示されます。なお，CD-ROMのディレクトリ名や，ファイル名は，lsコマンドで確認して，表示されたファイル名を入力してください。

「i」または「I」を入力して「I）Install Software」を選択する。
インストールできるプログラムの一覧が表示されます。

インストールするプログラムにカーソルを移動させて，スペースキーで選択する。
選択したプログラムの左側に「<@>」が付きます。なお，複数のプログラムを選択できます。

「i」または「I」を入力して「I）Install」を選択する。
プログラムをインストールするかどうかについてのメッセージが最下行に表示されます。

最下行に表示されるメッセージに対して「y」または「Y」を入力する。
インストールが始まります。ただし，「n」または「N」を入力すると，インストールが中止されて，手順7.で表示されたインストールできるプログラムの一覧が表示されます。

プログラムのインストールが終了したら，「q」または「Q」を入力して「Q)Quit」を選択して初期画面に戻る。
インストールを終了する場合，初期画面で「q」または「Q」を入力して「Q)Quit」を選択して終了します。

3.3.2　アンインストール

プログラムを再セットアップする場合，すでにインストールされているプログラムをアンインストールする必要があります。

＜この項の構成＞

(1)　アンインストール

(1)　アンインストール

アンインストールする手順を次に示します。

起動しているプログラムを停止する。
DocumentBroker PlatformまたはDocumentBroker Runtime Libraryのライブラリを使用しているプログラムを停止してください。

スーパーユーザ（id:root）としてオペレーティングシステムにログインする。

「/etc/hitachi_setup」を実行して日立PPインストーラを起動する。

「d」または「D」を入力して「D) Delete Software」を選択する。
アンインストールできるプログラムの一覧が表示されます。

アンインストールするプログラムにカーソルを移動させて，スペースキーで選択する。
選択したプログラムの左側に「<@>」が付きます。なお，複数のプログラムを選択できます。

「d」または「D」を入力して「D）Delete」を選択する。
プログラムをアンインストールするかどうかについてのメッセージが最下行に表示されます。

最下行に表示されるメッセージに対して「y」または「Y」を入力する。
アンインストールが始まります。ただし，「n」または「N」を入力すると，アンインストールが中止されて，手順5.で表示されたアンインストールできるプログラムの一覧が表示されます。

プログラムのアンインストールが終了したら，「q」または「Q」を入力して「Q）Quit」を選択して初期画面に戻る。
アンインストールを終了する場合，初期画面で「q」または「Q」を入力して「Q)Quit」を選択して終了します。

3.3.3　インストール済みプログラムの一覧表示

UNIXの場合，日立PPインストーラで，すでにマシンにインストールされているプログラムの一覧を表示できます。プログラムの一覧を表示する手順を次に示します。

日立PPインストーラを起動する。
初期画面が表示されます。なお，日立PPインストーラの起動については，「3.3.1　インストール」の手順5.，または「3.3.2　アンインストール」の手順3.を参照してください。

「l」または「L」を入力して「L）List Installed Software」を選択する。
PP一覧表示画面が表示されます。この画面には，すでにマシンにインストールされているプログラムの一覧が表示されます。

PP一覧表示画面で「q」または「Q」を入力して「Q)Quit」を選択する。
初期画面に戻ります。なお，PP一覧表示画面で「p」または「P」を入力して「P） Print to」を選択すると，すでにインストールされているプログラムの一覧が「/tmp/hitachi_PPLIST」に出力されます。

3.4　インストールとアンインストール（Windowsの場合）

この節では，ご使用のOSがWindowsの場合の，次に示すプログラムのインストール方法およびアンインストール方法について説明します。

DocumentBroker Platform

DocumentBroker Developer

DocumentBroker Runtime Library

また，前提プログラムについてもインストールしてください。インストール方法については，各製品のマニュアルを参照してください。

上書きインストールを実行する場合，次に示すパスのディレクトリ，およびファイルは上書きされます。必要に応じて退避してください。

DocumentBroker Platformの場合

<インストールディレクトリ>¥DocBroker¥Platform¥conf以下のディレクトリ，およびファイル

<インストールディレクトリ>¥DocBroker¥Platform¥sql以下のディレクトリ，およびファイル

DocumentBroker Developerの場合

<インストールディレクトリ>¥DocBroker¥Developer¥conf以下のディレクトリ，およびファイル

<インストールディレクトリ>¥DocBroker¥Developer¥sql以下のディレクトリ，およびファイル

DocumentBroker Runtime Libraryの場合

<インストールディレクトリ>¥DocBroker¥Library¥conf以下のディレクトリ，およびファイル

＜この節の構成＞

3.4.1　統合CD-ROMからのインストール

3.4.2　リモートインストール

3.4.3　アンインストール

3.4.1　統合CD-ROMからのインストール

ここでは，統合CD-ROMからプログラムをインストールする方法について説明します。インストール実行中にエラーが発生した場合，警告ダイアログまたはエラーダイアログが表示されます。警告ダイアログが表示された場合，メッセージに従って対策してから，インストールを続行してください。エラーダイアログが表示された場合，インストールは中止されます。エラーの要因を取り除いたあと，再度インストールを実行してください。

統合CD-ROMからインストールする手順を次に示します。なお，インストール先のフォルダには，ASCIIコードで表せるパスを指定してください。

システム管理者（Administrator）の権限を持つユーザでログインします。

統合CD-ROMの指示に従いインストールする製品名を選択して，インストールを開始します。
セットアップ開始画面の表示後，［ようこそ］ダイアログが表示されます。

インストールする製品（DocumentBroker Platform，DocumentBroker DeveloperまたはDocumentBroker Runtime Library）を確認して，「次へ」をクリックします。
［ユーザ情報］ダイアログが表示されます。

「ユーザ名」および「所属」を入力します。

「次へ」をクリックします。
［インストール先のフォルダ］ダイアログが表示されます。デフォルトのインストール先フォルダを次に示します。

DocumentBroker Platformの場合

＜インストールディレクトリ＞¥DocBroker¥Platform

DocumentBroker Developerの場合

＜インストールディレクトリ＞¥DocBroker¥Developer

DocumentBroker Runtime Libraryの場合

＜インストールディレクトリ＞¥DocBroker¥Library

インストール先のフォルダを変更する場合は「変更」をクリックし，インストール先を選択します。

「次へ」をクリックします。
［インストール準備］ダイアログが表示されます。

「インストール」をクリックすると，ファイルのコピーが開始されます。ファイルのコピー後，［完了］ダイアログが表示されます。

「完了」をクリックします。
ダイアログ表示が終了して，インストールが完了します。

3.4.2　リモートインストール

DocumentBroker Platform，DocumentBroker DeveloperまたはDocumentBroker Runtime Libraryをリモートインストールする場合，以下にインストールされます。

DocumentBroker Platformの場合

OSがインストールされたドライブ:¥Program Files¥Hitachi¥DocBroker¥Platform

ドライブだけを指定した場合
指定したドライブ:¥Program Files¥Hitachi¥DocBroker¥Platform

パスを指定した場合
指定したパス:¥DocBroker¥Platform

DocumentBroker Developerの場合

OSがインストールされたドライブ:¥Program Files※¥Hitachi¥DocBroker¥Developer

ドライブだけを指定した場合
指定したドライブ:¥Program Files※¥Hitachi¥DocBroker¥Developer

パスを指定した場合
指定したパス:¥DocBroker¥Developer

DocumentBroker Runtime Libraryの場合

OSがインストールされたドライブ:¥Program Files※¥Hitachi¥DocBroker¥Library

ドライブだけを指定した場合
指定したドライブ:¥Program Files※¥Hitachi¥DocBroker¥Library

パスを指定した場合
指定したパス:¥DocBroker¥Library

注※　OSが64bitの場合は，Program Files(x86)と表示されます。

上書きインストールの場合は，インストールされているDocumentBroker Platform，DocumentBroker DeveloperまたはDocumentBroker Runtime Libraryと同じフォルダにインストールされます。

3.4.3　アンインストール

プログラムを再セットアップする場合，すでにインストールされているプログラムをアンインストールする必要があります。アンインストールするときの手順を，次に説明します。

アンインストールを実行すると，インストール時に配置されたファイルがすべて消去されます。必要に応じてバックアップを取得してください。

削除されないディレクトリおよびファイル

次に示す情報は，アンインストール時に削除されません。必要に応じて削除してください。

DocumentBroker Platformの場合

<インストールディレクトリ>¥DocBroker¥Platform¥conf以下のディレクトリ，およびファイル

<インストールディレクトリ>¥DocBroker¥Platform¥sql以下のディレクトリ，およびファイル

DocumentBroker Developerの場合

<インストールディレクトリ>¥DocBroker¥Developer¥conf以下のディレクトリ，およびファイル

<インストールディレクトリ>¥DocBroker¥Developer¥sql以下のディレクトリ，およびファイル

DocumentBroker Runtime Libraryの場合

<インストールディレクトリ>¥DocBroker¥Library¥conf以下のディレクトリ，およびファイル

アンインストールする手順を次に示します。

起動しているプログラムを停止します。

Administratorsグループのユーザでログインします。

［コントロールパネル］－［すべてのコントロールパネル項目］の［プログラムと機能］からアンインストールする製品名を選択してください。

3.5　データベースシステムでの環境設定

この節では，DocumentBrokerの前提プログラムであるデータベースシステムで必要な環境設定について説明します。

＜この節の構成＞

3.5.1　HiRDBの環境設定の準備

3.5.2　HiRDBの環境設定

3.5.3　HiRDBのユーザ権限の設定

3.5.4　HiRDB Text Search Plug-in，HiRDB XML Extensionでの環境設定

3.5.1　HiRDBの環境設定の準備

＜この項の構成＞

(1)　データベース容量の算出

(2)　データベースへの接続情報の決定

(1)　データベース容量の算出

HiRDBの環境設定を始める前に，DocumentBrokerで管理する文書数，クラス数，プロパティ数などを基に，データベースの容量を見積もってください。データベースの容量を決定するための計算式については，「2.5　データベース容量の見積もり」を参照してください。

(2)　データベースへの接続情報の決定

データベースに接続するための情報を決定しておく必要があります。

必要な情報を次に示します。

データベースに接続するためのユーザ名

データベースに接続するためのパスワード

データベースで使用するテーブルを格納するためのRDエリア名

データベースで使用するインデクスを格納するためのRDエリア名

データベースで使用するBLOBデータを格納するためのRDエリア名

データベースのポート番号

データベースのホスト名またはIPアドレス

3.5.2　HiRDBの環境設定

DocumentBrokerを運用するために必要なRDエリアなどを作成します。HiRDBの環境設定については，マニュアル「HiRDB　システム導入・設計ガイド」を参照してください。このとき，DocumentBrokerの文書空間で使用する文字コード種別に合わせて，HiRDBで使用する文字コード種別を設定してください。

3.5.3　HiRDBのユーザ権限の設定

DocumentBrokerで使用するテーブルやインデクスを定義する場合，HiRDBに対して接続する必要があります。このため，データベースを作成するユーザに対して，CONNECT権限を付与してください。また，スキーマを定義する必要もあるので，スキーマ定義権限も付与してください。

HiRDBのユーザ権限は，HiRDBのデータベース定義ユティリティ（pddef）を実行して，定義系SQLのGRANT文を使用して与えます。CONNECT権限およびスキーマ定義権限を与えるGRANT文の例を次に示します。

（例）

ユーザ（ユーザ名：USER01　パスワード：PASS01）にCONNECT権限およびスキーマ定義権限を与え，スキーマを作成します。

＜記述例＞

GRANT CONNECT TO USER01 IDENTIFIED BY PASS01;
GRANT SCHEMA TO USER01;
CREATE SCHEMA AUTHORIZATION USER01;

HiRDBのデータベース定義ユティリティについては，マニュアル「HiRDB　コマンドリファレンス」を参照してください。また，GRANT文の文法および詳細な注意事項などについては，マニュアル「HiRDB　SQLリファレンス」を参照してください。

3.5.4　HiRDB Text Search Plug-in，HiRDB XML Extensionでの環境設定

全文検索および概念検索といった全文検索機能を利用する場合には，HiRDBのプラグインプログラムであるHiRDB Text Search Plug-in，またはHiRDB XML Extensionが必要です。これらを使用する場合，HiRDBへのセットアップやRDエリアの追加などが必要です。HiRDB Text Search Plug-in，およびHiRDB XML Extensionの環境設定については，マニュアル「HiRDB Text Search Plug-in」，またはマニュアル「HiRDB XML Extension」を参照してください。また，プラグインプログラムの環境設定については，マニュアル「HiRDB　システム導入・設計ガイド」を参照してください。

3.6　ユーザ管理機能の設定

この節では，DocumentBrokerのユーザ管理機能について説明します。

DocumentBrokerは，LDAP対応のディレクトリサービス，ユーザが作成したアクセスルーチンと連携したユーザ管理機能を提供します。

＜この節の構成＞

3.6.1　LDAP対応のディレクトリサービスによるユーザ管理機能を使用する場合の設定

3.6.2　ユーザ作成のアクセスルーチンを使用する場合の設定

3.6.1　LDAP対応のディレクトリサービスによるユーザ管理機能を使用する場合の設定

LDAP対応のディレクトリサービスによるユーザ管理機能を使用する場合，文書空間構成定義ファイルでの設定が必要です。文書空間構成定義ファイルについては，「4.3　文書空間構成定義ファイル（docspace.properties）」を参照してください。

＜この項の構成＞

(1)　ディレクトリサーバの設定

(2)　ディレクトリサービスの情報管理の概念

(3)　LDAP対応のディレクトリサービスへのバインド

(4)　LDAP対応のディレクトリサービスのユーザ認証

(5)　LDAP対応のディレクトリサービスでのユーザ情報取得

(6)　LDAP対応のディレクトリサービスとの連携時の注意

(1)　ディレクトリサーバの設定

LDAPディレクトリサーバをインストールして初期設定します。インストールと初期設定については，使用しているLDAPディレクトリサーバのマニュアルを参照してください。すでにLDAPディレクトリサーバを使用している場合には，設置する必要はありません。

(2)　ディレクトリサービスの情報管理の概念

連携するLDAP対応のディレクトリサービスのデータ構造について次に示します。

フラット型

ベースDN直下にすべてのユーザエントリが登録されているデータ構造です。

図3-1　ディレクトリサービスで管理する情報の構造の例

階層型

ベースDN以下が分岐しており，各階層にユーザエントリが登録されているデータ構造です。定義によっては，階層構造の場合に関連付いた情報を上位にあるプロパティから取得したり，再帰的に取得することも可能です。定義例については，「3.7.3(1)　ユーザ情報の取得方法」を参照してください。

図3-2　ディレクトリサービスで管理する情報の構造の例（階層型）

(a)　DIT

ディレクトリサービスが管理する情報は，図3-1および図3-2の形式の構造図によって示されます。この構造をDITと呼びます

(b)　エントリ

エントリまたはディレクトリエントリは，DITを構成する情報で，図3-1および図3-2のDITの各節に該当します（以降，エントリと呼びます）。

図3-1および図3-2の「c=jp」「o=hitachi」，「ou=PEOPLE」，「uid=Tanaka」などがエントリです。エントリは，左辺と右辺を「=」（等号）でつないでいます。左辺は属性で右辺は属性値を表します。また，エントリは一つ以上の属性によって構成されています。ディレクトリサービスでは，データをエントリおよび属性によって管理します。

(c)　DN

DNは，DITの各エントリを一意に識別するための情報名です。ファイルシステム内のファイルパスのように扱われます。DNは，「,」（コンマ）で区切られたエントリの集まりで，各エントリはディレクトリ内の位置を表す相対識別名（RDN）で構成されます。相対識別名は，「属性=属性値」の形式で表現されます。例えば，uid=Tanakaやou=People1などが相対識別名に当たります。DNは，ファイルシステム内のファイルパスのように扱われますが，相対識別名の並びがファイルシステムとは逆の順番になります。つまり，ファイルシステムでは，ファイルの名称をいちばん右に指定して，左から右へパスを指定していきますが，DNでは，いちばん左の位置にDITの最下層のエントリを指定し，いちばん右側の位置にDITの最上位のエントリを指定していきます。DNの記述例を次に示します。

uid=Tanaka,ou=People1,o=hitachi,c=jp

この記述例は，図3-1に示した「jp」というディレクトリ内の，「hitachi」というサブディレクトリ内にある「PEOPLE」というサブディレクトリの「Tanaka」というエントリのDNを示します。

(3)　LDAP対応のディレクトリサービスへのバインド

DocumentBrokerでLDAPディレクトリに接続（バインド）するために，情報検索用のユーザを登録してアクセス権を設定します。情報検索用ユーザのDNのことを情報検索用のバインドDNといいます。情報検索用のバインドDNには，DocumentBrokerで参照するベースDN以下すべてのエントリ，およびエントリに設定されたすべての属性に対して，読み取り権，比較権，検索権を付与してください。情報検索用のバインドDNは，LDAPディレクトリサーバからユーザ情報などを取得するときに使用します。

情報検索用のバインドDNは，文書空間構成定義ファイル（docspace.properties）の次に示すプロパティに設定します。

LdapBindUserDNエントリ

LdapBindPasswordエントリ

文書空間構成定義ファイル（docspace.properties）の設定の詳細は，「4.3　文書空間構成定義ファイル（docspace.properties）」を参照してください。

(4)　LDAP対応のディレクトリサービスのユーザ認証

ユーザ管理システムとしてLDAP対応のディレクトリサービスを使用する場合は，セッションを確立するときにユーザが指定したユーザ名を基に，文書空間構成定義ファイルで指定したDITを検索してユーザエントリを特定し，そのDNによりバインドを試みます。

このため，ディレクトリ構成を意識しないでユーザを特定できます。ただし，ディレクトリ内に存在するユーザが，一意に識別できる必要があります。

(5)　LDAP対応のディレクトリサービスでのユーザ情報取得

DocumentBrokerのアクセス制御機能を使用して，アクセス制御されている文書に接続する場合，DocumentBrokerはLDAP対応のディレクトリサービスに登録されているユーザに関する情報を使用して，目的の文書に対するアクセスが許可されているかどうか判断します。DocumentBrokerがアクセス制御機能で使用するユーザに関する情報は，ユーザ識別子およびグループ識別子です。ユーザ識別子およびグループ識別子について，次に説明します。

(a)　ユーザ識別子

ユーザを一意に識別するための情報です。ユーザ識別子は，1～254バイト（ただし，「¥0」を含まない）のASCII半角英数字，「-」，「.」，「@」，「_」で構成されます。LDAP対応のディレクトリサービスを使用する場合，ユーザ識別子として使用する属性は，文書空間構成定義ファイルに指定する必要があります。文書空間構成定義ファイルについては，「4.3　文書空間構成定義ファイル（docspace.properties）」を参照してください。

(b)　グループ識別子

グループを一意に識別する情報です。ユーザが複数のグループに所属する場合があるため，グループ識別子は，一人のユーザに対して複数存在できます。また，プライマリグループも設定できます。

グループ識別子は，1～254バイト（ただし，「¥0」を含まない）のASCII半角英数字，「-」，「.」，「@」，「_」で構成されます。

LDAP対応のディレクトリサービスでは，「組織」と「グループ」をグループとして扱えます。組織とグループについて次に説明します。

組織

オブジェクトクラス「organizationalUnit」またはそのクラスから派生したクラスのオブジェクトです。DocumentBrokerでは，ユーザの属性として格納される組織情報（例えば，ou属性やdepartmentnumber属性など）およびユーザを識別するDNに記述される組織情報をそれぞれ抽出して利用できます。

グループ

オブジェクトクラス「groupOfUniqueNames」またはそのクラスから派生したクラスのオブジェクトです。

(6)　LDAP対応のディレクトリサービスとの連携時の注意

組織構成の変更などによって，ディレクトリ（LDAP）上のグループ識別子が変更されることがあります。このような場合，オブジェクトに付与しているアクセス制御情報で表されるアクセス権を保持するには，ACLに記載されているグループ識別子を変更する必要があります。グループ識別子の変更に伴うオブジェクトのアクセス権の設定の変更については，マニュアル「DocumentBroker Version 5　概説」を参照してください。

DocumentBrokerで利用するLDAPのユーザ識別子およびグループ識別子は，1～254バイト（ただし，「¥0」を含まない）のASCII半角英数字，「-」，「.」，「@」，「_」で構成される必要があります。

3.6.2　ユーザ作成のアクセスルーチンを使用する場合の設定

DocumentBrokerは，文書空間構成定義ファイルの定義によって，使用するユーザ管理システムのアクセスルーチンに，ユーザが作成したアクセスルーチンを組み込む機能を提供しています。これは，ユーザ管理システムにLDAP対応のディレクトリサービス以外を使用する場合や，すでに使用しているLDAP対応のディレクトリサービスの運用形態がDocumentBrokerのサポートしていない形態である場合に利用する機能です。なお，ユーザが作成したアクセスルーチン（コーディング部分）をUOCと呼びます。

＜この項の構成＞

(1)　アクセスルーチンの作成方法

(2)　ユーザ作成のアクセスルーチンを使用する場合のユーザ情報の取得

(1)　アクセスルーチンの作成方法

DocumentBrokerに組み込むユーザ管理システムのアクセスルーチンは，決められた形式および仕様に基づいて作成する必要があります。DocumentBrokerで提供するインターフェースとクラスを使用して，運用中のユーザ管理システムにアクセスできるように，アクセスルーチンを作成してください。DocumentBrokerで提供するインターフェースについては，「付録B　ユーザ作成のアクセスルーチンを使用するためのインターフェースとクラス」を参照してください。

また，作成したアクセスルーチンを組み込む場合は，文書空間構成定義ファイル（docspace.properties）での設定が必要です。文書空間構成定義ファイルのUserAuthenticationプロパティにUOCを指定し，UOCClassプロパティに必要な値を指定してください。なお，文書空間構成定義ファイルについては，「4.3　文書空間構成定義ファイル（docspace.properties）」を参照してください。

(2)　ユーザ作成のアクセスルーチンを使用する場合のユーザ情報の取得

DocumentBrokerのアクセス制御機能を使用して，アクセス制御されている文書に接続する場合，DocumentBrokerはユーザの属性についてのユーザ情報を取得します。そして，取得したユーザ情報を基に，ユーザの接続したい文書に対してアクセスが許可されているかどうかを判断します。UOCによるユーザ管理機能を使用してユーザ情報を取得する場合に，取得できるユーザ情報を次に示します。

(a)　ユーザ識別子

関数DbjAuthUserInfoインターフェースに格納されたユーザ識別子文字列を使用します。インターフェースの詳細については，「付録B　ユーザ作成のアクセスルーチンを使用するためのインターフェースとクラス」を参照してください。

(b)　グループ識別子

関数DbjAuthUserInfoインターフェースに格納されたプライマリグループ識別子およびグループ識別子文字列を使用します。インターフェースの詳細については，「付録B　ユーザ作成のアクセスルーチンを使用するためのインターフェースとクラス」を参照してください。

3.7　DocumentBrokerの実行環境の作成

この節では，DocumentBrokerの実行環境の作成について説明します。

＜この節の構成＞

3.7.1　DocumentBroker実行環境ディレクトリの作成

3.7.2　DocumentBrokerの環境変数の設定

3.7.3　文書空間の定義

3.7.1　DocumentBroker実行環境ディレクトリの作成

DocumentBrokerの実行環境を格納するためのディレクトリを作成してください。実行環境ディレクトリは，インストールディレクトリとは，別のディレクトリとしてください。ここで作成したディレクトリの下にDocumentBrokerのインストールディレクトリ下のconfディレクトリをコピーします。ディレクトリの名称は任意ですが，UNIXの場合，ディレクトリへのアクセスパーミッションに「0777」を設定する必要があります。また，Windowsの場合は，ディレクトリに読み込み，書き込み権限を設定してください。

3.7.2　DocumentBrokerの環境変数の設定

DocumentBrokerの動作に必要な環境変数の設定について説明します。UNIXの場合，環境変数は各サーバマシンのログインシェル環境に合わせて次のファイルに設定してください。なお，$HOMEは，ログインユーザのホームディレクトリを示します。

Bourneシェル環境の場合

$HOME/.profile

Cシェル環境の場合

$HOME/.cshrcまたは$HOME/.login

＜この項の構成＞

(1)　DOCB_CONF_DIRの設定

(2)　PATHの設定

(1)　DOCB_CONF_DIRの設定

環境変数※「DOCB_CONF_DIR」に「3.7.1　DocumentBroker実行環境ディレクトリの作成」で作成したDocumentBroker実行環境ディレクトリを設定します。

注※　Windowsの場合は，システム環境変数，またはユーザ環境変数となります。

(2)　PATHの設定

データベース運用のコマンドを実行する環境の場合は，環境変数「PATH」に，javaのパスを追加します。

3.7.3　文書空間の定義

この節では，DocumentBrokerの文書空間の構成を定義する文書空間構成定義ファイル（docspace.properties）およびユーザ権限定義ファイル（userperm.properties）について説明します。設定内容については，「4.　環境設定で必要なファイル」を参照してください。

＜この項の構成＞

(1)　ユーザ情報の取得方法

(2)　ユーザ権限定義ファイルの設定

(1)　ユーザ情報の取得方法

ここでは，ログインするときに生成されて値が設定されるユーザ情報の取得方法について説明します。

(a)　ログインするときに生成されるユーザ情報（LDAPディレクトリサーバを使用する場合）

ユーザ情報は，DocumentBrokerオブジェクトに対するアクセス権を判定する場合に使用されます。ユーザ情報には，「ユーザ識別子」および「グループ識別子」があります。これらの情報は，ログインしたときに生成されます。

●ユーザ識別子

ユーザを識別する情報です。ユーザ識別子については，「3.6.1(5)(a)　ユーザ識別子」を参照してください。

ユーザ識別子として取得される情報は，文書空間構成定義ファイルで任意に指定できます。ユーザ識別子を取得する場合に文書空間構成定義ファイルで指定するプロパティを次に示します。

LdapUserIdプロパティ

LdapUserCaseプロパティ

これらのプロパティの値は，ユーザ識別子として取得する情報および取得方法に従って指定してください。各プロパティの指定方法については，「4.3　文書空間構成定義ファイル（docspace.properties）」を参照してください。

●グループ識別子

ユーザが所属するグループを識別する情報です。グループ識別子については，「3.6.1(5)(b)　グループ識別子」を参照してください。

グループ識別子の取得方法は，文書空間構成定義ファイルで定義します。グループ情報の取得方法について，次に説明します。なお，DocumentBrokerにログインする場合のログイン名を，属性として登録してあるユーザエントリのことを，ログインユーザエントリと呼ぶことにします。

グループ識別子を取得する場合に，文書空間構成定義ファイルで指定するプロパティを次の図に示します。

図3-3　LDAPディレクトリサーバのツリー構成例

グループエントリの属性から取得する方法

グループ管理用のエントリの属性に，ユーザが所属するグループ名称が登録されている場合に使用する方法です。定義例を次の図に示します。

図3-4　グループエントリの属性から取得する場合の定義例

表3-1　グループエントリの属性から取得する場合の定義例で指定するプロパティ

指定するプロパティ
指定するユーザ識別子
取得するグループ識別子

LdapGroup=Yes
LdapGroupRoot=ou=Groups,DC=hitachi,DC=jp
LdapGroupClass=groupOfUniqueNames
LdapGroupId=cn
tanaka
Group1

階層グループの場合で，グループの階層がDITのエントリ位置で関連付いているときのプロパティの取得例を次の表に示します。

表3-2　グループの階層がDITのエントリ位置で関連付いている場合

指定するプロパティ
指定するユーザ識別子
取得するグループ識別子

LdapGroup=Yes
LdapGroupRoot=ou=Groups,DC=hitachi,DC=jp
LdapGroupClass=groupOfUniqueNames
LdapGroupId=cn
LdapGroupFromGroupDn=Yes
tanaka
Group1
Sales

階層グループの場合で，グループの階層がグループエントリの属性値で関連付いているときのプロパティの取得例を次の表に示します。

表3-3　グループの階層がグループエントリの属性値で関連付いている場合

指定するプロパティ
指定するユーザ識別子
取得するグループ識別子

LdapGroup=Yes
LdapGroupRoot=ou=Groups,DC=hitachi,DC=jp
LdapGroupClass=groupOfUniqueNames
LdapGroupId=cn
LdapGroupFromGroupMember=Yes
tanaka
Group1
Group2

ログインユーザエントリの属性から取得する方法

ログインユーザエントリの属性に，そのユーザが所属する組織名称が登録されている場合に使用する方法です。定義例を次の図に示します。

図3-5　ログインユーザエントリの属性から取得する場合の定義例

表3-4　ログインユーザエントリの属性から取得する場合の定義例で指定するプロパティ

指定するプロパティ
指定するユーザ識別子
取得するグループ識別子

LdapGroupFromUserAttr=Yes
LdapGroupIdFromUserAttr=ou
tanaka
Sales
Group1

組織エントリの属性から取得する方法

ログインユーザエントリの属性に，そのユーザが所属する組織エントリのDNが登録されている場合に使用する方法です。定義例を次の図に示します。

図3-6　組織エントリの属性から取得する場合の定義例

表3-5　組織エントリの属性から取得する場合の定義例で指定するプロパティ

指定するプロパティ
指定するユーザ識別子
取得するグループ識別子

LdapGroupFromUserAttr=Yes
LdapGroupIsDnFromUserAttr=Yes
LdapGroupIdFromUserAttr=ou
LdapGroupIdAttrFromUserAttr=dn
tanaka
ou=Sales,ou=Unit,DC=hitachi,DC=jp
ou=Group1,ou=Unit,DC=hitachi,DC=jp

ログインユーザエントリのDNから取得する方法

ログインユーザエントリのDNの構成要素（RDN）の属性値を，グループ識別子として使用する方法です。定義例を次の図に示します。

図3-7　ログインユーザエントリのDNから取得する場合の定義例

表3-6　ログインユーザエントリのDNから取得する場合の定義例で指定するプロパティ

指定するプロパティ
指定するユーザ識別子
取得するグループ識別子

LdapGroupFromUserDn=Yes
LdapGroupIdFromUserDn=ou
tanaka
Group1
Sales

これらのグループ識別子を取得する方法は，選択して使用したり，組み合わせて使用したりできます。ただし，「ログインユーザエントリの属性から取得する方法」と「組織エントリの属性から取得する方法」を組み合わせることはできません。また，取得するグループ識別子はLDAPディレクトリサーバ上でユニークとなる値を取得する必要があります。

オブジェクトの識別子名（DN）に次の文字が含まれる場合，グループエントリの属性から取得する方法を使用するとグループ情報が取得できません。

* 0x2a

( 0x28

) 0x29

¥ 0x5c

NUL 0x00

/ 0x2f

ログインユーザエントリの属性から取得する方法，または組織エントリの属性から取得する方法，またはログインユーザエントリのDNから取得する方法を使用して取得してください。

文書空間構成定義ファイルで指定した方法に従って，グループ識別子の取得方法ごとに，指定する必要があるプロパティを次の表に示します。

表3-7　グループ識別子の取得方法ごとに指定する必要があるプロパティの一覧

グループ情報の取得方法
指定するプロパティ

グループエントリの属性から取得する方法

LdapGroup=Yes（必須）

LdapGroupRoot=<DN>（必須）

LdapGroupScopeプロパティ

LdapGroupTimeoutプロパティ

LdapGroupClassプロパティ

LdapGroupIdプロパティ

LdapGroupFilterLeftプロパティ

LdapGroupFilterRightプロパティ

LdapGroupMemberプロパティ

LdapGroupCaseプロパティ

LdapGroupFromGroupDnプロパティ

LdapGroupFromGroupMemberプロパティ

ログインユーザエントリの属性から取得する方法

LdapGroupFromUserAttr=Yes（必須）

LdapGroupIdFromUserAttrプロパティ

LdapGroupCaseプロパティ

組織エントリの属性から取得する方法

LdapGroupFromUserAttr=Yes（必須）

LdapGroupIsDnFromUserAttr=Yes（必須）

LdapGroupIdFromUserAttrプロパティ

LdapGroupIdAttrFromUserAttrプロパティ

LdapGroupCaseプロパティ

ログインユーザエントリのDNから取得する方法

LdapGroupFromUserDn=Yes（必須）

LdapGroupIdFromUserDnプロパティ

LdapGroupCaseプロパティ

各プロパティの指定方法については，「4.3　文書空間構成定義ファイル（docspace.properties）」を参照してください。

(b)　ログインするときに生成されるユーザ情報（ユーザ作成のアクセスルーチンを使用する場合）

ユーザ管理機能としてLDAP対応のディレクトリサービスに連携していない場合や運用中のLDAP対応のディレクトリサービスがDocumentBrokerの運用形態に合わない場合，DocumentBrokerは，ユーザが作成したアクセスルーチンを組み込む機能を提供しています。

ユーザ管理システムへのアクセスルーチンとして，ユーザが作成したアクセスルーチンを使用する場合は，文書空間構成定義ファイルのUserAuthenticationプロパティで「UOC」を指定する必要があります。この場合，UOCClassプロパティの値として，ユーザが作成したアクセスルーチンのクラス名で指定します。UserAuthenticationプロパティで「UOC」を指定した場合に生成されるユーザ情報には，ユーザ識別子とグループ識別子があります。ユーザ識別子については，「3.6.2(2)(a)　ユーザ識別子」をグループ識別子については，「3.6.2(2)(b)　グループ識別子」を参照してください。

(2)　ユーザ権限定義ファイルの設定

文書空間にオブジェクトを作成する権限や文書空間内のオブジェクトに対する操作の範囲を定義するためにユーザ権限定義ファイルを作成します。

セキュリティ管理者は，このユーザ権限定義ファイルを更新することでユーザ権限を変更できます。ユーザ権限定義プロパティファイルの設定内容については，「4.4　ユーザ権限定義ファイル（userperm.properties）」を参照してください。

3.8　DocumentBrokerでデータベースシステムを使用するための設定

この節では，DocumentBrokerでデータベースシステムを使用するために必要な設定について説明します。

＜この節の構成＞

3.8.1　データベースシステムの設定に必要なファイル

3.8.2　データベースシステムの設定手順

3.8.3　全文検索機能を使用する場合に出力されるデータベース定義文

3.8.1　データベースシステムの設定に必要なファイル

この節では，DocumentBrokerでデータベースシステムを使用するための設定に必要なファイルについて説明します。データベースの設定を始める前に，次のファイルを準備，作成してください。なお，各ファイルの詳細は，「4.　環境設定で必要なファイル」を参照してください。

データベース情報ファイル

メタ情報初期化ファイル

定義情報ファイル

RDエリア定義情報ファイル

インデクス情報ファイル

3.8.2　データベースシステムの設定手順

ここでは，DocumentBrokerでデータベースシステムを使用するための設定手順について説明します。なお，データベースシステムの設定は，システム管理者が実行してください。また，データベースを設定するユーザに対しては，あらかじめCONNECT権限およびスキーマ定義権限を付与しておいてください。

DocumentBrokerで使用できるデータベースはHiRDBです。したがって，ここで説明するデータベースシステムの設定手順は，HiRDBを使用する場合の設定手順です。また，データベースシステムを設定する前に，HiRDBの環境設定とデータベースシステムを設定するために必要なファイルを作成しておいてください。HiRDBの環境設定については「3.5.2　HiRDBの環境設定」を，必要なファイルについては「4.　環境設定で必要なファイル」を参照してください。

DocumentBrokerで使用するデータベースシステムの設定手順を次に示します。設定中は，HiRDBを起動させておいてください。HiRDBの起動方法については，マニュアル「HiRDB　システム運用ガイド」を参照してください。

＜この項の構成＞

(1)　コマンド用環境設定ファイルを編集します

(2)　文書空間識別子を生成する

(3)　メタ情報用のテーブルを定義します

(4)　メタ情報の初期設定コマンド（dbjinitmeta）を実行します

(5)　メタ情報の追加コマンド（dbjaddmeta）を実行します

(6)　DocumentBroker用データベース定義文の作成コマンド（dbjcrtsql）を実行します

(7)　データベース定義ユティリティを実行します

(1)　コマンド用環境設定ファイルを編集します

DocumentBrokerのコマンド用環境設定ファイルを環境に合わせて編集します。コマンドはjavaで作成し，javaコマンドから呼び出すバッチファイル形式で提供しています。

次のファイルで各コマンド共通で設定する環境変数を指定できます。

Windowsの場合

dbjcmdconf.bat

UNIXの場合

dbjcmdconf

指定できる環境変数と設定値を次の表に示します。

表3-8　指定できる環境変数と設定値

環境変数
設定値

DOCB_JAVA_CMD
実行するJavaコマンドのパスを指定します。

DOCB_JVM_ARGS
JavaVMの起動オプションを指定します。特に値を指定しない場合は，javaコマンドのデフォルト値となります。

DOCB_CLASSPATH
設定されている値をクラスパスに追加します。
複数の値を指定したい場合は，Windowsの場合「;」（セミコロン）で，UNIXの場合「:」（コロン）で区切りで指定してください。

注意

バッチファイル内でエラーが発生する，または環境変数に不正な値を指定した場合の動作は保証しません。

半角スペースを含むパスなどを指定する場合，"（半角ダブルクォーテーション）で囲まないでください。

Windowsの場合の指定例を次に示します。

set DOCB_JAVA_CMD=c:¥propgram files¥Hitachi¥cosminexus¥jdk¥bin¥java.exe
set DOCB_JVM_ARGS=
set DOCB_CLASSPATH=C:¥win32app¥hitachi¥hirdb_s¥CLIENT¥UTL¥pdjdbc2.jar

UNIXの場合の指定例を次に示します。

export DOCB_JAVA_CMD=/opt/Cosminexus/jdk/bin/java
export DOCB_JVM_ARGS=
export DOCB_CLASSPATH=/opt/HiRDB_S/client/lib/pdjdbc2.jar

(2)　文書空間識別子を生成する

文書空間識別子生成コマンド（dbjgenguid）を実行して，文書空間識別子を生成します。コマンドの詳細については，「dbjgenguid（GUIDの生成）」を参照してください。

生成した文書空間識別子を，文書空間構成定義ファイルのDocSpaceIdプロパティに設定してください。

(3)　メタ情報用のテーブルを定義します

DocumentBrokerのメタ情報用のテーブルやインデクスを作成します。テーブルやインデクスは，テーブル定義用のSQLファイルを使用して作成します。

(a)　SQLファイルの編集

メタ情報用のテーブルやインデクスは，次に示すSQLファイルを編集して作成します。

UNIXの場合

/opt/DocBroker/Platform/sql/createmetatable_hirdb.sql

Windowsの場合

<インストールディレクトリ>¥DocBroker¥Platform¥sql¥createmetatable_hirdb.sql，または<インストールディレクトリ>¥DocBroker¥Developer¥sql¥createmetatable_hirdb.sql

SQLファイル中の文字列を，テキストエディタを使用して書き換えます。

テーブルやインデクスを作成するためにSQLファイルの書き換えが必要な文字列，および書き換える内容を次の表に示します。

表3-9　SQLファイルの書き換えが必要な内容

書き換えが必要な文字列 | 書き換える内容
（META） | メタ情報用のテーブルを格納する「ユーザ表用RDエリア」の名称
（METAINDEX） | メタ情報用のインデクスを格納する「ユーザインデクス用RDエリア」の名称

(b)　SQLファイルの実行

編集したSQLファイルを入力ファイルとして，HiRDBでデータベース定義ユティリティ（pddef）を実行して定義します。HiRDBのデータベース定義ユティリティについては，マニュアル「HiRDB　コマンドリファレンス」を参照してください。

(4)　メタ情報の初期設定コマンド（dbjinitmeta）を実行します

メタ情報をデータベースに登録するために，メタ情報の初期設定コマンド（dbjinitmeta）を実行します。メタ情報の初期設定コマンドの使用方法については，「7.3　コマンドの文法」を参照してください。動作環境メタ情報ファイルは，この時点で作成されます。

(5)　メタ情報の追加コマンド（dbjaddmeta）を実行します

作成した定義情報ファイルを入力ファイルとして，メタ情報の追加コマンド（dbjaddmeta）を実行することで，サブクラスおよびプロパティを追加します。定義情報ファイルについては，「4.9　定義情報ファイル」を参照してください。

メタ情報の追加コマンドの使用方法については，「7.3　コマンドの文法」を参照してください。この時点で，動作環境メタ情報ファイルも更新されます。

(6)　DocumentBroker用データベース定義文の作成コマンド（dbjcrtsql）を実行します

RDエリア定義情報ファイルを入力ファイルとして，DocumentBroker用データベース定義文の作成コマンド（dbjcrtsql）を実行し，データベース定義文を出力します。さらに，ユーザが追加するプロパティにインデクスを定義する場合は，インデクス情報ファイルも入力ファイルとして指定してください。RDエリア定義情報ファイルについては「4.10　RDエリア定義情報ファイル」を，インデクス情報ファイルについては「4.11　インデクス情報ファイル」を参照してください。DocumentBroker用データベース定義文の作成コマンドの使用方法については，「7.3　コマンドの文法」を参照してください。また，全文検索機能を利用する場合のデータベース定義文の内容については，「3.8.3　全文検索機能を使用する場合に出力されるデータベース定義文」を参照してください。

(7)　データベース定義ユティリティを実行します

データベース定義文を入力ファイルとして，HiRDBでデータベース定義ユティリティ（pddef）を実行して定義を追加します。HiRDBのデータベース定義ユティリティについては，マニュアル「HiRDB　コマンドリファレンス」を参照してください。

3.8.3　全文検索機能を使用する場合に出力されるデータベース定義文

ここでは，全文検索機能を使用する場合に出力されるデータベース定義文について説明します。

＜この項の構成＞

(1)　出力されるデータベース定義文

(2)　全文検索機能を使用する文書クラスを定義したデータベース定義文

(3)　概念検索機能を使用する文書クラスを定義したデータベース定義文

(4)　文字列型プロパティに対する全文検索機能を使用するためのプロパティを定義したデータベース定義文

(5)　データベース定義文中のRDエリア名についての注意事項

(1)　出力されるデータベース定義文

全文検索機能を使用する場合，DocumentBroker用データベース定義文の作成コマンド（dbjcrtsql）を実行すると，次に示すデータベース定義文が出力されます。

全文検索機能を使用する文書クラスを定義したデータベース定義文

概念検索機能を使用する文書クラスを定義したデータベース定義文

文字列型プロパティに対する全文検索機能を使用するためのプロパティを定義したデータベース定義文

以降，それぞれのデータベース定義文について説明します。

(2)　全文検索機能を使用する文書クラスを定義したデータベース定義文

全文検索機能を使用する文書クラスに定義される全文検索インデクス用プロパティ（検索タームを指定する全文検索機能用）ごとに出力されるデータベース定義文について説明します。ここでは，edmProp_TextIndexプロパティを定義したクラスのデータベース定義文について説明します。

(a)　edmProp_TextIndexプロパティの定義

プレーンテキストを対象とした全文検索機能を使用する文書クラスに，edmProp_TextIndexプロパティを定義します。これによって，次の図に示すデータベース定義文が出力されます。

図3-8　edmProp_TextIndexプロパティの定義で出力されるデータベース定義文

(b)　データベース定義文の定義内容の解説

図3-8のデータベース定義文中の1.，2.，および3.の意味を次に示します。

全文検索機能付き文書クラスのための列作成定義
全文検索用の文書の内容を格納するためのユーザLOB用RDエリアを使用します。例では，SEARCHDB1というユーザLOB用RDエリアを指定しています。

全文検索機能付きクラスのための列作成定義

全文検索機能付きクラスのためのインデクス作成定義
全文検索用のユーザLOB用RDエリアを使用します。例では，SEARCHINDEX1またはSGMLINDEX1というユーザLOB用RDエリアを指定しています。

(3)　概念検索機能を使用する文書クラスを定義したデータベース定義文

概念検索機能を使用する文書クラスに定義される全文検索インデクス用プロパティ（概念検索機能用）ごとに出力されるデータベース定義文について説明します。ここでは，次に示す全文検索インデクス用プロパティを定義したクラスのデータベース定義文について説明します。

edmProp_ConceptTextIndexプロパティ

(a)　edmProp_ConceptTextIndexプロパティを定義した場合

プレーンテキストを対象とする概念検索機能を使用する文書クラスに，edmProp_ConceptTextIndexプロパティを定義します。これによって，次の図に示すデータベース定義文が出力されます。

図3-9　edmProp_ConceptTextIndexプロパティを定義した場合に出力されるデータベース定義文

(b)　データベース定義文の定義内容の解説

図3-9のデータベース定義文中の1.，2.，および3.の意味を次に示します。

概念検索機能を使用する文書クラスのための列作成定義
概念検索用の文書の内容を格納するためのユーザLOB用RDエリアを使用します。例では，SEARCHDB1というユーザLOB用RDエリアを指定しています。

概念検索機能を使用する文書クラスのための列作成定義

概念検索機能を使用する文書クラスのためのインデクス作成定義
概念検索用のユーザLOB用RDエリアを使用します。例では，SEARCHINDEX1というユーザLOB用RDエリアを指定しています。

(4)　文字列型プロパティに対する全文検索機能を使用するためのプロパティを定義したデータベース定義文

ここでは，文字列型プロパティに対する全文検索機能を使用するためのプロパティを定義した場合に出力されるデータベース定義文について説明します。

usrClass_PropTextSearchクラスに対して，全文検索機能付き文字列型プロパティであるusrProp_DocSummaryプロパティを定義した場合に出力されるデータベース定義文を次の図に示します。

図3-10　全文検索機能付き文字列型プロパティを定義した場合に出力されるデータベース定義文

図3-10のデータベース定義文中の1.および2.の意味を次に示します。

全文検索機能付き文字列型プロパティのための列作成定義

全文検索機能付き文字列型プロパティのためのインデクス作成定義
全文検索機能付き文字列型プロパティ用のユーザLOB用RDエリアを使用します。例では，SEARCHINDEX1というユーザLOB用RDエリアを指定しています。

(5)　データベース定義文中のRDエリア名についての注意事項

全文検索機能を使用する場合に出力されるデータベース定義文に定義されているRDエリア名について説明します。

これらのRDエリア名は，「3.5.2　HiRDBの環境設定」で作成したRDエリア名に変更する必要があります。ただし，DocumentBroker用データベース定義文の作成コマンド（dbjcrtsql）の-rオプションでRDエリア定義情報ファイル名を指定している場合，この作業は不要です。RDエリア定義情報ファイルについては，「4.10　RDエリア定義情報ファイル」を参照してください。

3.9　アプリケーションサーバの設定

この節では，アプリケーションサーバ（Cosminexus）上でDocumentBrokerを使用するための設定方法について説明します。

＜この節の構成＞

3.9.1　アプリケーションサーバの構築

3.9.2　セキュリティポリシーの設定

3.9.3　保護区リストファイルの設定

3.9.4　コンテナ拡張ライブラリの取り込み

3.9.5　J2EEサーバの起動

3.9.6　リソースアダプタの設定

3.9.1　アプリケーションサーバの構築

J2EEアプリケーションを実行するシステムを構築します。構築方法については，マニュアル「Cosminexus V9 アプリケーションサーバ　システム構築・運用ガイド」を参照してください。

3.9.2　セキュリティポリシーの設定

アプリケーションサーバ（Cosminexus）上でDocumentBrokerを使用するために，セキュリティポリシーを設定する必要があります。J2EEサーバのセキュリティポリシーファイル（server.policy）に，以下の内容を追加してください。

//
// Grant permissions to JSP/Servlet
//
grant codeBase "file:${ejbserver.http.root}/web/${ejbserver.serverName}/-" {
　　　permission java.util.PropertyPermission "*", "read, write";
　　　permission java.util.logging.LoggingPermission "control";
　　　permission java.lang.RuntimePermission "getenv.DOCB_CONF_DIR";
};
//
// Grant permissions to uCosminexus DocumentBroker
//
grant codeBase "file:${ejbserver.http.root}/ejb/${ejbserver.serverName}/apps/-" {
　　　permission java.io.FilePermission "<<ALL FILES>>", "read, write, delete";
　　　permission java.util.logging.LoggingPermission "control";
　　　permission java.lang.RuntimePermission "getenv.DOCB_CONF_DIR";
};

セキュリティポリシーファイルについては，マニュアル「Cosminexus V9 アプリケーションサーバ　リファレンス 定義編（サーバ定義）」の「server.policy（J2EEサーバ用セキュリティポリシーファイル）」の説明を参照してください。

3.9.3　保護区リストファイルの設定

保護区リストファイルは製品単位の定義で，Cosminexus上でDocumentBrokerを使用するために必要な設定です。

「保護区リストファイル」の要素として，次に示すプリフィックス名を設定してください。

jp.co.Hitachi.soft.docbroker.*

設定した保護区リストファイルは，J2EEサーバの起動時に読み込まれ，Cosminexusをインストールしたマシン上で動作するすべてのJ2EEサーバで有効となります。

保護区リストファイルについては，マニュアル「Cosminexus V9 アプリケーションサーバ　リファレンス 定義編（サーバ定義）」の「criticalList.cfg（保護区リストファイル）」の説明を参照してください。

3.9.4　コンテナ拡張ライブラリの取り込み

J2EEサーバ用オプション定義ファイルへの設定をします。Cosminexus Component Containerのusrconf.cfgファイルに，次のパスを追加してください。

add.class.path=JDBCドライバのファイルパス

add.class.pathについては，マニュアル「Cosminexus V9 アプリケーションサーバ　リファレンス 定義編（サーバ定義）」の「usrconf.cfg（J2EEサーバ用オプション定義ファイル）」の説明を参照してください。

3.9.5　J2EEサーバの起動

J2EEサーバを起動します。J2EEサーバの起動方法は，マニュアル「Cosminexus V9 アプリケーションサーバ　システム構築・運用ガイド」を参照してください。

3.9.6　リソースアダプタの設定

データベースにアクセスするためのリソースアダプタを設定します。設定方法については，マニュアル「Cosminexus V9 アプリケーションサーバ　アプリケーション設定操作ガイド」，および「Cosminexus V9 アプリケーションサーバ　リファレンス 定義編（アプリケーション／リソース定義）」を参照してください。リソースアダプタはDB Connectorを使用します。

UNIXの場合に，コマンドでリソースアダプタを設定するときの例について説明します。

＜この項の構成＞

(1)　リソースアダプタのインポート

(2)　Connector属性ファイルの取得

(3)　Connector属性ファイルの編集

(4)　Connector属性ファイルの反映

(5)　リソースアダプタのデプロイ

(6)　リソースアダプタの接続テスト

(7)　リソースアダプタの開始

(1)　リソースアダプタのインポート

次のコマンド（cjimportres）を実行して，HiRDB Type4 Driverに対応するリソースアダプタをインポートします。

$COSMINEXUS_HOME/CC/admin/bin/cjimportres J2EEサーバ名 -type rar -f $COSMINEXUS_HOME/CC/DBConnector/DBConnector_HiRDB_Type4_CP.rar

(2)　Connector属性ファイルの取得

次のコマンド（cjgetresprop）を実行して，Connector属性ファイルをカレントディレクトリに取得します。

$COSMINEXUS_HOME/CC/admin/bin/cjgetresprop J2EEサーバ名 -type rar -resname DB_Connector_for_HiRDB_Type4 -c DBConnector_docb.xml

(3)　Connector属性ファイルの編集

取得したConnector属性ファイルを次のとおり編集してください。

表3-10　Connector属性ファイルの設定項目

設定項目 | 設定内容
display-name | リソースアダプタの表示名
description | HiRDBのポート番号
DBHostName | HiRDBのホスト名
LONGVARBINARY_Access | LOCATOR
LONGVARBINARY_AccessSize | 1024※1
User | ユーザ名※2
Password | パスワード※2
MinPoolSize | コネクションプールの最小値※3
MaxPoolSize | コネクションプールの最大値※3

注※1

docspace.propertiesのBinaryAccessSizeと一致させることを推奨します。

注※2

データベースにアクセスするためのDocumentBroker用のユーザ名とパスワードです。

注※3

同時実行数以上の値を設定してください。

なお，コネクション枯渇時の動作は，リソースアダプタのConnector属性ファイルのpropertyタグの設定値に依存します。

コネクション枯渇時のコネクション取得待ち行列を有効にするかどうか

RequestQueueEnable（デフォルト：True）

コネクション枯渇時のコネクション取得待ち行列のとどまることのできる時間の最大値

RequestQueueTimeout（デフォルト：30秒）

デフォルトの設定では，データベースアクセス処理でコネクションが枯渇した場合，コネクションが取得できるまで最大30秒の待ちが発生します。30秒以内にコネクションが取得できない場合はSQLエラーが発生します。

設定値の詳細については，マニュアル「Cosminexus V9 アプリケーションサーバ　リファレンス 定義編（サーバ定義）」の<property>タグに指定できるプロパティについて記載されている個所を参照してください。また，Cosminexusの同時実行スレッド数についても適切に設定してください。同時実行スレッド数の詳細については，マニュアル「Cosminexus V9 アプリケーションサーバ　リファレンス 定義編（サーバ定義）」のusrconf.properties（J2EEサーバ用ユーザプロパティファイル）のwebserver.connector.ajp13.max_threadsについて記載されている個所を参照してください。

(4)　Connector属性ファイルの反映

次のコマンド（cjsetresprop）を実行して，編集したConnector属性ファイルの内容をリソースアダプタに反映します。

$COSMINEXUS_HOME/CC/admin/bin/cjsetresprop J2EEサーバ名 -type rar -resname DB_Connector_for_HiRDB_Type4 -c DBConnector_docb.xml

(5)　リソースアダプタのデプロイ

次のコマンド（cjdeployrar）を実行して，リソースアダプタをデプロイします。

$COSMINEXUS_HOME/CC/admin/bin/cjdeployrar J2EEサーバ名 -resnameリソースアダプタの表示名

(6)　リソースアダプタの接続テスト

次のコマンド（cjtestres）を実行して，リソースアダプタが正常に接続できるかテストします。

$COSMINEXUS_HOME/CC/admin/bin/cjtestres J2EEサーバ名 -type rar -resnameリソースアダプタの表示名

(7)　リソースアダプタの開始

次のコマンド（cjstartrar）を実行して，リソースアダプタを開始します。

$COSMINEXUS_HOME/CC/admin/bin/cjstartrar J2EEサーバ名 -resnameリソースアダプタの表示名

3.10　Javaアプリケーションの設定

JavaアプリケーションでDocumentBrokerを使用できます。この場合，環境変数とJava実行時の-classpathオプション，データベース情報ファイル（databaseinfo.properties）の設定が必要です。

＜この節の構成＞

3.10.1　環境変数の設定

3.10.2　JARファイルの追加

3.10.3　データベース情報ファイルの設定

3.10.1　環境変数の設定

「3.7.2　DocumentBrokerの環境変数の設定」に従いDOCB_CONF_DIR環境変数を設定します。

3.10.2　JARファイルの追加

Javaアプリケーションを実行する際の-classpathオプションに，次に示すファイルを追加します。

UNIXの場合

/opt/DocBroker/Platform/lib/djlib5.jar
または

/opt/DocBroker/Library/lib/djlib5.jar

Windowsの場合

<インストールディレクトリ>¥DocBroker¥Platform¥lib¥djlib5.jar
または

<インストールディレクトリ>¥DocBroker¥Library¥lib¥djlib5.jar
または

<インストールディレクトリ>¥DocBroker¥Developer¥lib¥djlib5.jar

また，使用するJDBCドライバ（HiRDBの場合は「HiRDB Type4 JDBC Driver」）を-classpathオプションに追加してください。

3.10.3　データベース情報ファイルの設定

「4.7　データベース情報ファイル（databaseinfo.properties）」を参照して，データベースに接続するための情報を設定します。

3.11　複数の実行環境を構築する場合の設定

この節では，複数の実行環境から，同一の文書空間にアクセスする場合の実行環境の構築方法について説明します。DocumentBrokerでは，使用ユーザ数や単位時間あたりのトランザクション数の増加などのシステム負荷を軽減するために，一つのデータベースに複数のDocumentBrokerの実行環境を配置したシステム構成を構築できます。これによって，システム全体の負荷分散が実現できます。

＜この節の構成＞

3.11.1　新規に実行環境を構築する場合

3.11.2　実行環境を変更する場合

3.11.3　実行環境を削除する場合

3.11.1　新規に実行環境を構築する場合

複数の実行環境から同一文書空間にアクセスするために，新規に実行環境を構築する手順を次に示します。なお，次の手順では，接続する文書空間にアクセスする実行環境がすでに構築されていることが前提です。

DocumentBrokerの実行環境を作成する。
なお，DocumentBrokerの実行環境の作成については，「3.7　DocumentBrokerの実行環境の作成」を参照してください。

文書空間構成定義ファイルを設定する。
このとき，同一文書空間として使用したい実行環境の文書空間構成定義ファイルのDocSpaceIdと同じ値を指定します。
文書空間構成定義ファイルについては，「4.3　文書空間構成定義ファイル（docspace.properties）」を参照してください。

DocumentBroker実行環境の情報の登録コマンド（dbjregenvid -r）を実行する。

これによって，新規に構築した実行環境から同一文書空間にアクセスできるようになります。

3.11.2　実行環境を変更する場合

別マシンへの実行環境の移動や，実行環境ディレクトリのパスの変更によって実行環境を変更する場合の手順を次に示します。

変更後の実行環境を作成する。
DocumentBrokerの実行環境の作成については，「3.7　DocumentBrokerの実行環境の作成」を参照してください。

変更前の実行環境ディレクトリ/confに格納されているファイルを，変更後の実行環境ディレクトリ/confに移動する。

変更後の実行環境で，DocumentBroker実行環境の情報の登録コマンド（dbjregenvid -u）を実行する。

3.11.3　実行環境を削除する場合

実行環境を削除する手順を次に示します。

DocumentBroker実行環境の情報の登録コマンド（dbjregenvid -d）を実行する。

3.12　リファレンスファイル管理機能を使用する場合の設定

この節では，リファレンスファイル管理機能を使用するための設定について説明します。

＜この節の構成＞

3.12.1　コンテンツを管理するための設定

3.12.2　ネットワーク上のマシンの共有ディスクでコンテンツを管理する場合の設定

3.12.1　コンテンツを管理するための設定

ここでは，リファレンスファイル管理機能を使用して，ファイルシステム上の任意のディレクトリにコンテンツを格納するための設定について説明します。

＜この項の構成＞

(1)　コンテンツを格納する領域の確保

(2)　コンテンツを格納するディレクトリの作成

(3)　コンテンツを格納するディレクトリおよびコンテンツのアクセス権限の設定

(4)　システム構成に応じたコンテンツの格納先の設定

(1)　コンテンツを格納する領域の確保

コンテンツを格納するために，ファイルシステム上に領域を確保する必要があります。確保する領域のディスク容量の見積もり方法については「2.5　リファレンスファイル管理機能を使用する場合のファイルシステムのディスク容量の見積もり」を参照してください。見積もりした値よりも大きいディスク容量を確保してください。

(2)　コンテンツを格納するディレクトリの作成

コンテンツの格納先とするディレクトリを基点としたパスをコンテンツ格納先ベースパスといいます。コンテンツ格納先ベースパスに設定するディレクトリは，あらかじめファイルシステム上の任意の領域に作成しておく必要があります。

作成したディレクトリの下に，DocumentBrokerによってコンテンツが格納されます。なお，リファレンスファイル文書の格納方式は，文書空間構成定義ファイルのReferenceStorageModeプロパティで設定します。ReferenceStorageModeプロパティについては「4.3.2　文書空間構成定義ファイルの記述形式」を参照してください。

コンテンツ格納先ベースパス下のコンテンツ格納先の例を，次の図に示します。なお，ここではWindowsの場合を例としています。

図3-11　文書空間構成定義ファイルのReferenceStorageModeプロパティにOriginを指定した場合

Originを指定した場合の例では，コンテンツ格納先ベースパスにはディレクトリ「¥¥Server1¥ContentArea」を，コンテンツ格納先パスにはディレクトリ「USER01」を設定して，コンテンツ「sample.doc」が格納された場合を示しています。

図3-12　文書空間構成定義ファイルのReferenceStorageModeプロパティにDivideを指定した場合

コンテンツ格納先ベースパス

ファイルシステム上の任意の領域に，コンテンツの格納先としてシステム管理者が作成するディレクトリです。このディレクトリは，あらかじめ作成しておく必要があります。作成したディレクトリをコンテンツ格納先ベースパスとして設定します。

文書空間で使用する文字コード種別がUTF-8の場合，コンテンツ格納先ベースパスには，ASCIIコードで表せるパスを指定してください。なお，コンテンツ格納先ベースパスは，絶対パスで指定してください。相対パスでの指定はできません。

コンテンツ格納先パス

コンテンツ格納先ベースパスからの相対パスで指定するディレクトリです。このディレクトリは，コンテンツ格納時にDocumentBrokerによって作成されます。

文書空間で使用する文字コード種別がUTF-8の場合，コンテンツ格納先パスには，ASCIIコードで表せるパスを指定してください。

DocumentBrokerがコンテンツを管理するためのディレクトリ

DocumentBrokerによって作成される，コンテンツ管理するためのディレクトリです。このディレクトリの下にコンテンツが格納されます。

コンテンツ

DocumentBrokerによってコンテンツが登録，管理されます。

コンテンツ格納先パス，DocumentBrokerがコンテンツを管理するためのディレクトリ，およびコンテンツを合わせて，コンテンツロケーションとしてデータベースで管理されます。

なお，コンテンツ格納先ベースパスの長さ，コンテンツ格納先パスの長さおよびファイル名の長さの合計が，次の値を超えないようにしてください。

文書空間構成定義ファイルのReferenceStorageModeプロパティにOrigin（省略値）を指定した場合
コンテンツ格納先ベースパスの長さ（バイト）＋コンテンツ格納先パスの長さ（バイト）＋ファイル名の長さ（バイト）＜OSの最大ファイルパス長（バイト）－35（バイト）

文書空間構成定義ファイルのReferenceStorageModeプロパティにDivideを指定した場合
コンテンツ格納先ベースパスの長さ（バイト）＋コンテンツ格納先パスの長さ（バイト）＋ファイル名の長さ（59バイト）＜OSの最大ファイルパス長（バイト）－6（バイト）

(3)　コンテンツを格納するディレクトリおよびコンテンツのアクセス権限の設定

UNIXの場合，コンテンツ格納先ベースパスに指定するディレクトリには，システム管理者およびシステム管理者グループに対してだけ読み取り権，書き込み権，実行権（770）のアクセス権限を設定してください。

Windowsの場合，コンテンツ格納先ベースパスに指定するディレクトリには，プロセスを起動するユーザに対してだけフルコントロールのアクセス権限を設定してください。

また，どちらのOSの場合でも，そのほかのグループまたはユーザに対しては，操作可能な権限を設定しないでください。

(4)　システム構成に応じたコンテンツの格納先の設定

次に示すシステム構成の場合，必要に応じてコンテンツの格納先を設定してください。

複数の実行環境を構成する場合
DocumentBrokerの実行環境ごとに，コンテンツの格納先ディレクトリを確保してください。このとき，コンテンツの格納先とするファイルシステムは，DocumentBrokerが存在するマシンから接続可能なネットワーク上のマシンの共有ディスクを使用してください。また，Windowsの場合，コンテンツ格納先ベースパスは，UNC形式のパスで指定してください。
対象のネットワーク上のマシンには，プロセスを起動するユーザのユーザ名とパスワードを使ってログインします。必要なアクセス権限を設定してください。

複数の異なる文書空間で，コンテンツの格納先を同一のファイルシステムとする場合
各文書空間で，コンテンツ格納先ベースパスが重複しないようにしてください。複数の異なる文書空間で同一のコンテンツ格納先ベースパスを使用した場合，ファイル破壊の原因となります。

3.12.2　ネットワーク上のマシンの共有ディスクでコンテンツを管理する場合の設定

ここでは，複数の実行環境を構成するシステムでリファレンスファイル管理機能を使用する場合に，ネットワーク上のマシンの共有ディスクにコンテンツを格納するための設定について説明します。

＜この項の構成＞

(1)　Windowsの場合の設定

(2)　UNIXの場合の設定

(1)　Windowsの場合の設定

ネットワーク上のマシンの共有ディスクを使用する場合は，コンテンツ格納先ベースパスをUNC形式のパスで指定してください。

対象のネットワーク上のマシンには，プロセスを起動するユーザのユーザ名とパスワードを使用してログインします。必要なアクセス権限を設定してください。なお，対象のネット上のマシンへの接続ユーザ数が上限に達した場合は，エラーが発生します。

(2)　UNIXの場合の設定

NFSを使用するためには，DocumentBrokerを起動する前に次の設定を実施してください。

NFSサーバの構成
コンテントの格納先となるサーバマシンで，NFSサーバを構成しておきます。

NFSファイルシステムのエクスポート
コンテントの格納先となるサーバマシンでコンテントの格納先ディレクトリを作成し，NFSファイルシステムのエクスポートを行います。

NFSクライアントの構成
DocumentBrokerが存在するマシンで，NFSクライアントの構成を定義します。

NFSファイルシステムのマウント
DocumentBrokerが存在するマシンで，NFSファイルシステムをマウントします。

NFSの設定の詳細については，オペレーティングシステムのマニュアルを参照してください。

なお，コンテントの格納先となるサーバマシンと，DocumentBrokerが存在するマシンは同一のオペレーティングシステムを使用してください。また，パスワードファイルに設定するシステム管理者ユーザのユーザID，およびシステム管理者ユーザが所属するシステム管理者グループのグループIDは，マシン間で同一の内容にしておく必要があります（同じパスワードファイルを使用することを推奨します）。

システム管理者ユーザのユーザID，およびシステム管理者ユーザが所属するシステム管理者グループのグループIDが異なる場合，ファイルアクセスでのエラーの原因となります。

4.　環境設定で必要なファイル

この章では，DocumentBrokerの環境設定で必要なファイルについて説明します。

＜この章の構成＞

4.1　ファイルの種類

4.2　動作環境定義ファイル（docbconf.properties）

4.3　文書空間構成定義ファイル（docspace.properties）

4.4　ユーザ権限定義ファイル（userperm.properties）

4.5　レンディション定義ファイル（mime.properties）

4.6　メタ情報初期化ファイル（docbmetainit.properties）

4.7　データベース情報ファイル（databaseinfo.properties）

4.8　メタ情報ファイル

4.9　定義情報ファイル

4.10　RDエリア定義情報ファイル

4.11　インデクス情報ファイル

4.12　変更情報ファイル

4.1　ファイルの種類

DocumentBrokerの環境設定で必要なファイルには，プロパティファイルとコマンドで使用するファイルがあります。

＜この節の構成＞

4.1.1　プロパティファイル

4.1.2　コマンドで使用するファイル

4.1.1　プロパティファイル

DocumentBrokerの環境設定で必要なプロパティファイルの一覧を次に示します。これらのファイルは，DocumentBrokerの実行環境を作成するときに作成してください。

表4-1　環境設定で必要なプロパティファイル

名称
内容
参照先

動作環境定義ファイル（docbconf.properties）※
DocumentBrokerの動作環境を定義する。
4.2

文書空間構成定義ファイル（docspace.properties）※
DocumentBrokerの文書空間の構成を定義する。
4.3

ユーザ権限定義ファイル（userperm.properties）※
文書空間のすべてのオブジェクトに対しての権限をユーザ，またはグループ単位で定義する。
4.4

レンディション定義ファイル
（mime.properties）※
登録するファイルの拡張子からレンディションタイプ（MIME形式）を自動的に設定する。
4.5

注※　次の場所に提供されています。コピー先にコピーしてから使用してください。

UNIXの場合

格納先：

/opt/DocBroker/Platform/conf
または

/opt/DocBroker/Library/conf

コピー先：実行環境ディレクトリ/conf　以下

Windowsの場合

格納先：

<インストールディレクトリ>¥DocBroker¥Platform¥conf
または

<インストールディレクトリ>¥DocBroker¥Developer¥conf
または

<インストールディレクトリ>¥DocBroker¥Library¥conf

コピー先：実行環境ディレクトリ¥conf　以下

＜この項の構成＞

(1)　プロパティファイルの記述規則

(1)　プロパティファイルの記述規則

ここでは，プロパティファイルの記述規則について説明します。

プロパティファイルは，Java 2 Platform, Standard Editionのプロパティファイル形式です。

プロパティは，「プロパティ名=値」の形式で指定します。

プロパティ名，「=」，値の間に空白文字を指定すると無視されます。

プロパティ名の次の文字（空白文字を除く）が「=」の場合，その次の文字（空白文字を除く）から行末文字までを値として解釈されます。

値の後ろに空白文字を付加した場合，空白文字は無視されます。

値の中に「=」，「#」，または「!」が使用されている場合，値の一部と解釈されます。

プロパティファイルの文字は，ISO 8859-1（Latin1）でエンコードします。ファイルの中にISO 8859-1以外の文字コードの文字が含まれる場合は，Javaツールのnative2asciiなどを使ってエンコードする必要があります。

行頭文字に「#」を指定した場合，行全体がコメントと見なされます。

行頭に続く空白文字（半角スペース，タブまたは改行）は無視されます。

ディレクトリを指定する場合，区切り文字（記号）には，「¥¥」または「/」を使用してください。

指定した値の大文字と小文字は区別されます。

4.1.2　コマンドで使用するファイル

DocumentBrokerのコマンドで必要なファイルの一覧を次に示します。これらのファイルは，DocumentBrokerでデータベースシステムを使用するための設定を始める前に，作成してください。

表4-2　コマンドで必要なファイル

名称
内容
参照先

メタ情報初期化ファイル（docbmetainit.properties）※¹
DocumentBrokerのシステム設定を記述する。
4.6

データベース情報ファイル（databaseinfo.properties）※¹
コマンドが接続するデータベースの情報を記述する。
4.7

メタ情報ファイル
（edmsys.csv，edmclass.csv，edmclassprop.csv，edmprop.csv）
システムクラスを定義したメタ情報を提供する。
4.8

定義情報ファイル※²
サブクラスおよびプロパティを追加するときに，追加するオブジェクトの定義情報を定義する。
4.9

RDエリア定義情報ファイル
DocumentBrokerが使用するユーザ表およびインデクスを，どのRDエリアに格納するか定義する。
4.10

インデクス情報ファイル
追加するプロパティのインデクス情報を定義する。
4.11

変更情報ファイル
ユーザ識別子，グループ識別子，ユーザプロパティの変更内容を定義します。
変更情報ファイルには，次の3種類があります。

ユーザ識別子変更情報ファイル

グループ識別子変更情報ファイル

プロパティ変更情報ファイル

4.12

注※1

コピー先にコピーしてから使用してください。提供場所については「4.1.1　プロパティファイル」を参照してください。

注※2

次の場所にサンプルファイルが提供されています。

UNIXの場合：/opt/DocBroker/Platform/sample

Windowsの場合：<インストールディレクトリ>¥DocBroker¥Platform¥sample，または<インストールディレクトリ>¥DocBroker¥Developer¥sample

4.2　動作環境定義ファイル（docbconf.properties）

この節では，動作環境定義ファイルについて説明します。

＜この節の構成＞

4.2.1　動作環境定義ファイルの概要

4.2.2　動作環境定義ファイルの記述形式

4.2.1　動作環境定義ファイルの概要

動作環境定義ファイルは，DocumentBrokerの動作環境を定義するファイルです。

システム管理者はコピーした「docbconf.properties」を，テキストエディタなどを使用して編集してください。

動作環境定義ファイルで指定するプロパティを次の表に示します。各プロパティの詳細については，「4.2.2　動作環境定義ファイルの記述形式」を参照してください。

表4-3　動作環境定義ファイルのプロパティ一覧

種類 | 設定項目 | プロパティ名 | 指定内容 | 省略の可否
メッセージログ・トレースファイル | 出力先ディレクトリ | LogPath | メッセージログ・トレースファイルの出力先ディレクトリの絶対パス | ○
メッセージログファイルの設定 | MsgLogSize | メッセージログファイルのファイルサイズの上限値 | ○
MsgLogNumber | メッセージログファイルの最大面数 | ○
トレースファイルの設定 | TraceLevel | トレースファイルのトレースレベル | ○
TraceSize | トレースファイルのファイルサイズの上限値 | ○
TraceNumber | トレースファイルの最大面数 | ○
アプリケーションエラーログ・アプリケーショントレースファイル | 出力先ディレクトリ | APTracePath | アプリケーションエラーログ・アプリケーショントレースファイルの出力先ディレクトリの絶対パス | ○
アプリケーションエラーログファイルの設定 | APErrorLogSize | アプリケーションエラーログファイルのファイルサイズの上限値 | ○
APErrorLogNumber | アプリケーションエラーログファイルの最大面数 | ○
アプリケーショントレースファイルの設定 | APTraceLevel | アプリケーショントレースファイルのトレースレベル | ○
APTraceSize | アプリケーショントレースファイルのファイルサイズの上限値 | ○
APTraceNumber | アプリケーショントレースファイルの最大面数 | ○
PromptOutput | アプリケーショントレース情報を標準出力に出力するか，標準エラー出力に出力するか | ○

（凡例）

○：指定を省略できます。

×：指定を省略できません。

4.2.2　動作環境定義ファイルの記述形式

動作環境定義ファイルの記述形式を次に示します。なお，動作環境定義ファイルの記述規則については，「4.1.1(1)　プロパティファイルの記述規則」を参照してください。

<プロパティ名>=<値>

以降，動作環境定義ファイルに記述するプロパティについて説明します。

LogPathプロパティ

メッセージログ・トレースの出力先ディレクトリを絶対パスで指定します。パスは印刷可能なASCIIコードで指定してください。

指定を省略した場合，または次に示す値を指定した場合，UNIXの場合は「$DOCB_CONF_DIR/log」が，Windowsの場合は「%DOCB_CONF_DIR%¥log」が仮定されます。

存在しないディレクトリ

ディレクトリでない

書き込み権限のないディレクトリ

MsgLogSizeプロパティ

メッセージログファイルの1面当たりの最大サイズを指定します。指定できる値の範囲は，4,096～2,147,483,647（バイト）です。指定を省略した場合，「16,777,216」が仮定されます。

MsgLogNumberプロパティ

ファイルサイズの上限を超えた場合に出力する，メッセージログファイルの最大面数を指定します。最新の情報は，常に最新の面（ファイル名0）に記載されます。

指定できる値の範囲は，1～16の整数です。指定を省略した場合は，「10」が仮定されます。

TraceLevelプロパティ

トレースファイルのトレースレベルを指定します。指定できる値は「-1」「0」「10」「20」「30」です。指定する値ごとのトレースレベルと出力情報を次の表に示します。指定を省略した場合，「0」が仮定されます。

表4-4　トレースレベルと出力情報

トレースレベル
設定基準
出力内容

-1
ログを出力しない。
何も出力されません。

0
通常運用でのトレースレベル。

例外発生

例外発生時のスタックトレース

製品公開メソッドの開始・終了※

SQL実行時のSQL文

10

通常運用よりも詳細な情報を取得するために利用されることを想定したレベル。

発生頻度の低い障害の再発監視や本番前の現地テストへの適用を想定。

トレースレベルが0の場合に出力される情報

他プログラムの呼出/戻り

20

障害の個所を詳細に特定するために使用するログレベル。

プログラムの動作シーケンスを把握できるレベル。

トレースレベルが10の場合に出力される情報

主要メソッドの開始/終了

30
障害の個所を詳細に特定するために使用するログレベル。

トレースレベルが20の場合に出力される情報

すべてのメソッドの開始/終了

注※

パラメタクラスのメソッドを除きます。

TraceSizeプロパティ

トレースファイルの1面当たりの最大サイズを指定します。指定できる値の範囲は，4,096～2,147,483,647（バイト）です。指定を省略した場合，「16,777,216」が仮定されます。

TraceNumberプロパティ

ファイルサイズの上限を超えた場合に出力する，トレースファイルの最大面数を指定します。最新の情報は，常に最新の面（ファイル名0）に記載されます。

指定できる値の範囲は，1～16の整数です。指定を省略した場合，「10」が仮定されます。

APTracePathプロパティ

アプリケーショントレースおよびアプリケーションエラーログの出力先ディレクトリを絶対パスで指定します。パスは印刷可能なASCIIコードで指定してください。

指定を省略した場合，または次に示す値を指定した場合，UNIXの場合は「$DOCB_CONF_DIR/log」が，Windowsの場合は「%DOCB_CONF_DIR%¥log」が仮定されます。

存在しないディレクトリ

ディレクトリでない

書き込み権限のないディレクトリ

APTraceLevelプロパティ

アプリケーショントレースファイルのトレースレベルを指定します。この設定は，次に示す出力先にトレース情報を出力する場合に有効になります。

コマンドプロンプト

アプリケーショントレースファイル

指定できる値は「-1」「0」「10」「20」「30」です。指定する値ごとのトレースレベルと出力情報については，表4-4，およびマニュアル「DocumentBroker Version 5　リファレンスAPI」を参照してください。指定を省略した場合，「0」が仮定されます。

APTraceSizeプロパティ

アプリケーショントレースファイルの1面当たりの最大サイズを指定します。指定できる値の範囲は，4,096～2,147,483,647（バイト）です。指定を省略した場合，「1,048,576」が仮定されます。

APTraceNumberプロパティ

ファイルサイズの上限を超えた場合に出力する，アプリケーショントレースファイルの最大面数を指定します。最新の情報は，常に最新の面（ファイル名0）に記載されます。

指定できる値の範囲は，1～16です。指定を省略した場合，「2」が仮定されます。

APErrorLogSizeプロパティ

アプリケーションエラーログファイルの1面当たりの最大サイズを指定します。指定できる値の範囲は，4,096～2,147,483,647（バイト）です。指定を省略した場合，「1,048,576」が仮定されます。

APErrorLogNumberプロパティ

ファイルサイズの上限を超えた場合に出力する，アプリケーションエラーログファイルの最大面数を指定します。最新の情報は，常に最新の面（ファイル名0）に記載されます。

指定できる値の範囲は，1～16です。指定を省略した場合，「2」が仮定されます。

PromptOutputプロパティ

アプリケーショントレース出力時の出力先にコマンドプロンプトを指定した場合，アプリケーショントレース情報を標準出力に出力するか，標準エラー出力に出力するかを指定します。

STDOUT
アプリケーショントレース情報を標準出力に出力します。

STDERR
アプリケーショントレース情報を標準エラー出力に出力します。
指定を省略した場合，「STDOUT」が仮定されます。

4.3　文書空間構成定義ファイル（docspace.properties）

この節では，文書空間構成定義ファイルについて説明します。

＜この節の構成＞

4.3.1　文書空間構成定義ファイルの概要

4.3.2　文書空間構成定義ファイルの記述形式

4.3.3　文書空間構成定義ファイルの記述例

4.3.4　文書空間構成定義ファイルの注意事項

4.3.1　文書空間構成定義ファイルの概要

文書空間構成定義ファイルは，DocumentBrokerの文書空間の構成を定義するファイルです。システム管理者はコピーした「docspace.properties」を，テキストエディタなどを使用して編集してください。

文書空間構成定義ファイルで指定するプロパティを次の表に示します。各プロパティの詳細については，「4.3.2　文書空間構成定義ファイルの記述形式」を参照してください。

表4-5　文書空間構成定義ファイルのプロパティ一覧

項番 | 種類 | 設定項目 | プロパティ名 | 指定内容 | 省略の可否
1 | サービス | 文書空間 | DocSpaceId | 文書空間の識別子 | ×
2 | ConnectorName | DB Connectorの表示名 | ○※1
3 | データベース | 接続するデータベースの設定 | DBType | データベース種別 | ○
4 | ユーザ認証 | ユーザ認証 | UserAuthentication | ユーザ認証方式 | ○
5 | LDAP設定 | LdapHost | ディレクトリサーバのホスト名またはIPアドレス | ○
6 | LdapPort | ディレクトリサーバのポート番号 | ○
7 | UOCライブラリの設定（UOC指定時） | UOCClass | UOCで使用するクラスのクラス名 | ○
8 | ユーザ情報の検索 | 検索条件 | LdapUserRoot | ユーザ検索対象のベースになるDN | ○
9 | LdapUserScope | ユーザ検索時の検索範囲 | ○
10 | LdapUserClass | ユーザとして定義しているクラスの名称 | ○
11 | LdapUserId | ユーザを検索するときのキーとなる属性 | ○
12 | LdapUserFilterLeft | 検索フィルタの「(」（左括弧）および検索フィルタの内容 | ○
13 | LdapUserFilterRight | 検索フィルタの「)」（右括弧）および検索フィルタの内容 | ○
14 | 検索オプション | LdapUserTimeout | ユーザ検索時の最大待ち時間 | ○
15 | LdapUserCase | ユーザ識別子の文字種の制限 | ○
16 | グループ情報の検索 | ディレクトリエントリからの検索 | LdapGroup | グループ識別子のオブジェクトからの検索方法 | ○
17 | LdapGroupRoot | グループ検索対象のベースになるDN | ○
18 | LdapGroupScope | グループ検索時の検索範囲 | ○
19 | LdapGroupClass | グループ識別子にするオブジェクトのクラス | ○
20 | LdapGroupId | グループを検索するときのキーとなる属性 | ○
21 | LdapGroupFilterLeft | 検索フィルタの「(」（左括弧）および検索フィルタの内容 | ○
22 | LdapGroupFilterRight | 検索フィルタの「)」（右括弧）および検索フィルタの内容 | ○
23 | LdapGroupMember | グループに所属しているユーザを記述する属性 | ○
24 | ユーザの属性値からの検索 | LdapGroupFromUserAttr | ユーザの属性値からのディレクトリのノード情報の検索方法 | ○
25 | LdapGroupIdFromUserAttr | グループ情報が格納されているユーザの属性 | ○
26 | LdapGroupIsDnFromUserAttr | ユーザの属性に格納されているグループ情報 | ○
27 | LdapGroupIdAttrFromUserAttr | グループ識別子として利用する属性 | ○
28 | ユーザのDNからの検索 | LdapGroupFromUserDn | グループ識別子の検索方法 | ○
29 | LdapGroupIdFromUserDn | グループ識別子として使用する属性名 | ○
30 | 検索オプション | LdapGroupTimeout | グループ検索時の最大待ち時間 | ○
31 | LdapGroupCase | グループ識別子の文字種の制限 | ○
32 | グループ識別子の取得 | LdapGroupFromGroupDn | グループ識別子をグループプロパティの上位にあるプロパティから取得 | ○
33 | LdapGroupFromGroupMember | グループ識別子をグループプロパティに関連付いているグループプロパティから取得 | ○
34 | ディレクトリサービスに対するバインド方法 | ディレクトリサービスに対するバインド方法 | LdapBindUserDN | ディレクトリサーバにアクセスする認証者のDN | ○
35 | LdapBindPassword | ディレクトリサーバにアクセスする際の認証者に対応するパスワード | ○
36 | アクセス制御機能 | セキュリティ管理者 | SecurityAdmin | セキュリティ管理者 | ○※2
37 | ユーザ権限の定義 | UserPermDef | ユーザ権限の定義 | ○
38 | パーミッション | DefaultACFlagOwner | オブジェクトの所有者に対するパーミッション | ○
39 | DefaultACFlagGroup | グループに対するパーミッション | ○
40 | DefaultACFlagEveryone | すべてのユーザに対するパーミッション | ○
41 | サイズ設定 | コンテンツサイズの設定 | MaxContentSize | コンテンツサイズの最大バイト数 | ○
42 | 全文検索テキストのサイズ設定 | MaxFullTextSize | 全文検索テキストの最大バイト数 | ○
43 | データサイズ設定 | BinaryAccessSize | バイナリデータのアクセスサイズ | ○
44 | リファレンスファイル文書化 | 格納方式設定 | ReferenceStorageMode | リファレンスファイル文書の格納方式 | ○
45 | ディレクトリ数設定 | ReferenceDirDivideNum | リファレンスファイル文書を格納するディレクトリ数 | ○
46 | ベースパス設定 | ReferenceBasePath | リファレンスファイル文書を格納するベースパス | ○
47 | ストリーム形式での操作 | 出力先ディレクトリの設定 | TempDirectory | 一時ディレクトリ名 | ○

（凡例）

○：指定を省略できます。

×：指定を省略できません。

※注1

DocumentBrokerクラスライブラリを使用したJ2EEアプリケーションを実行する場合，指定は省略できません。

※注2

DocumentBrokerクラスライブラリを使用したアプリケーションを実行する場合，指定は省略できません。

4.3.2　文書空間構成定義ファイルの記述形式

文書空間構成定義ファイルの記述形式を次に示します。なお，文書空間構成定義ファイルの記述規則については，「4.1.1(1)　プロパティファイルの記述規則」を参照してください。

<プロパティ名>=<値>

以降，文書空間構成定義ファイルに記述するプロパティについて説明します。

DocSpaceIdプロパティ

文書空間の識別子として，GUIDを指定します。GUIDはdbjgenguidコマンドで生成できます。GUIDは「X」を0～9，およびa～f（小文字）で表される16進数とした「XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX（8-4-4-4-12）」の形式で表されます。デフォルト値は存在しません。また，このプロパティの指定は省略できません。

ConnectorNameプロパティ

データベースに対応するリソースアダプタの設定で指定するDB Connectorの表示名を指定します。

DBTypeプロパティ

文書空間が接続するデータベース種別指定します。「HiRDB」を指定します。指定を省略した場合は「HiRDB」が仮定されます。

UserAuthenticationプロパティ

文書空間で使用するユーザ認証方式を指定します。

LDAP
LDAP対応のディレクトリサービスと連携してユーザ認証を実行します。
DocumentBrokerでは，LDAP対応のディレクトリサービスとして，次の製品との連携をサポートしています。
・Windows Server 2008 R2およびWindows Server 2012のActive Directory
・Oracle Directory Server Enterprise Edition

UOC
ユーザ管理システムへのアクセスルーチンとして，ユーザが作成したアクセスルーチンを使用する場合に指定します。

指定を省略した場合，「LDAP」が仮定されます。

LdapHostプロパティ

UserAuthenticationプロパティで「LDAP」を指定した場合に有効になります。

LDAP対応のディレクトリサービスのホスト名またはIPアドレスを指定します。指定を省略した場合，何も仮定されません。

UOCClassプロパティ

UserAuthenticationプロパティで「UOC」を指定した場合には，必ずUOCで使用するClassのクラス名を指定します。指定を省略した場合，何も仮定されません。

LdapPortプロパティ

UserAuthenticationプロパティで「LDAP」を指定した場合に有効になります。LDAP対応のディレクトリサービスのポート番号を指定します。指定を省略した場合，標準のポート番号（389）が仮定されます。

LdapUserIdプロパティ

UserAuthenticationプロパティで「LDAP」を指定した場合に有効になります。ユーザ識別子として利用するユーザを検索するときのキーとなる属性を指定します。ただし，指定する属性は，ユーザの一意性を保証している必要があります。指定を省略した場合，「uid」が仮定されます。

LDAP対応のディレクトリサービスとしてActive Directoryを使用する場合，「sAMAccountName」または「userPrincipalName」を指定してください。ただし，「userPrincipalName」を指定した場合，ログイン名として「ユーザ名@ドメイン名」の形式で指定する必要があります。

LdapUserTimeoutプロパティ

UserAuthenticationプロパティで「LDAP」を指定した場合に有効になります。ディレクトリプロパティからユーザを検索するときの最大待ち時間を指定します。0～180（秒）の範囲で指定します。0を指定した場合，待ち時間が無制限になります。指定を省略した場合，「60（秒）」が仮定されます。

LdapUserCaseプロパティ

UserAuthenticationプロパティで「LDAP」を指定した場合に有効になります。DocumentBrokerで扱うユーザ識別子の文字種についての制限を指定します。

Upper
ユーザ識別子の文字列を，すべて大文字に変換する場合に指定します。LDAP対応のディレクトリサービスから取得したユーザ識別子を，DocumentBroker内で大文字に変換します。

Lower
ユーザ識別子の文字列を，すべて小文字に変換する場合に指定します。LDAP対応のディレクトリサービスから取得したユーザ識別子を，DocumentBroker内で小文字に変換します。

Default
ユーザ識別子の文字列を変換しません。

指定を省略した場合，「Default」が仮定されます。

LdapUserRootプロパティ

UserAuthenticationプロパティで「LDAP」を指定した場合に有効になります。DIT上でユーザを検索するベースとなるノードのDNを指定します。指定を省略した場合，何も仮定されません。

LdapUserScopeプロパティ

UserAuthenticationプロパティで「LDAP」を指定した場合に有効になります。ディレクトリプロパティからユーザを検索するときの検索範囲を指定します。

Onelevel
検索開始点の一つ下のレベルにあるすべてのプロパティを検索します。

Subtree
検索開始点と，その下のすべてのレベルにあるすべてのプロパティを検索します。

指定を省略した場合，「Subtree」が仮定されます。

LdapUserClassプロパティ

UserAuthenticationプロパティで「LDAP」を指定した場合に有効になります。ユーザとして定義しているクラスの名称を指定します。

LDAP対応のディレクトリサービスとしてActive Directoryを使用する場合，「user」またはuserのサブクラスを指定してください。指定を省略した場合，「inetOrgPerson」が仮定されます。

LdapUserFilterLeftプロパティ

UserAuthenticationプロパティで「LDAP」を指定した場合に有効になります。ユーザを検索する場合に指定する検索フィルタの「(」（左括弧）および追加指定する検索フィルタの内容を指定します。指定を省略した場合，「(」が仮定されます。

LdapUserFilterRightプロパティ

UserAuthenticationプロパティで「LDAP」を指定した場合に有効になります。ユーザを検索する場合に指定する検索フィルタの「)」（右括弧）および追加指定する検索フィルタの内容を指定します。指定を省略した場合，「)」が仮定されます。

LdapGroupプロパティ

UserAuthenticationプロパティで「LDAP」を指定した場合に有効になります。グループ識別子を，メンバ（ユーザ）をリストとしたオブジェクトから検索することを指定します。

Yes
メンバ（ユーザ）をリストとしたオブジェクトから検索します。

No
メンバ（ユーザ）をリストとしたオブジェクトから検索しません。

指定を省略した場合，「Yes」が仮定されます。

LdapGroupRootプロパティ

UserAuthenticationプロパティで「LDAP」を指定した場合に有効になります。DIT上でグループを検索する基となるノードのDNを指定します。指定を省略した場合，何も仮定されません。

LdapGroupScopeプロパティ

UserAuthenticationプロパティで「LDAP」を指定した場合に有効になります。ディレクトリプロパティでグループを検索する場合の検索範囲を指定します。

Onelevel
検索開始点の一つ下のレベルにあるすべてのプロパティを検索します。

Subtree
検索開始点とその下のすべてのレベルにあるすべてのプロパティを検索します。

指定を省略した場合，「Subtree」が仮定されます。

LdapGroupClassプロパティ

UserAuthenticationプロパティで「LDAP」を指定した場合に有効になります。グループ識別子としてメンバ（ユーザ）をリストとしたオブジェクトのクラスを指定します。指定を省略した場合，「groupOfUniqueNames」が仮定されます。

なお，LDAP対応のディレクトリサービスとしてActive Directoryを使用する場合，「group」またはgroupのサブクラスを指定してください。

LdapGroupIdプロパティ

UserAuthenticationプロパティで「LDAP」を指定した場合に有効になります。グループ識別子として利用する属性を指定します。指定を省略した場合，「cn」が仮定されます。

なお，LDAP対応のディレクトリサービスとしてActive Directoryを使用する場合，「sAMAccountName」を指定してください。

LdapGroupFilterLeftプロパティ

UserAuthenticationプロパティで「LDAP」を指定した場合に有効になります。グループを検索するときに指定する検索フィルタの「(」（左括弧）および追加指定する検索フィルタの内容を指定します。指定を省略した場合，「(」が仮定されます。

LdapGroupFilterRightプロパティ

UserAuthenticationプロパティで「LDAP」を指定した場合に有効になります。グループを検索する場合にLDAPに指定する検索フィルタの「)」（右括弧）および追加指定する検索フィルタの内容を指定します。指定を省略した場合，「)」が仮定されます。

LdapGroupMemberプロパティ

UserAuthenticationプロパティで「LDAP」を指定し，LdapGroupプロパティに「Yes」を指定したときに有効になります。グループに所属しているユーザを記述する属性を指定します。指定を省略した場合，「uniqueMember」が仮定されます。

なお，LDAP対応のディレクトリサービスとしてActive Directoryを使用する場合，「member」を指定してください。

LdapGroupFromUserAttrプロパティ

UserAuthenticationプロパティで「LDAP」を指定した場合に有効になります。ユーザの属性値からのグループ識別子を取得するか，取得しないかを指定します。

Yes
ユーザの属性値からグループ識別子を取得します。

No
ユーザの属性値からグループ識別子を取得しません。

指定を省略した場合，「No」が仮定されます。

LdapGroupIdFromUserAttrプロパティ

UserAuthenticationプロパティで「LDAP」を指定した場合に有効になります。グループ情報が格納されているユーザの属性を指定します。指定を省略した場合，「ou」が仮定されます。

LdapGroupIsDnFromUserAttrプロパティ

UserAuthenticationプロパティで「LDAP」を指定した場合に有効になります。ユーザの属性に格納されているグループの情報がDNかどうかを指定します。

Yes
ユーザの属性に格納されているグループの情報がDNの場合，指定します。この場合，DocumentBrokerは，LdapGroupIdAttrFromUserAttrプロパティで指定されたグループの属性の情報を取得します。

No
ユーザの属性に格納されているグループの情報がDNでない場合，指定します。この場合，格納された情報を，そのままグループ識別子とします。

指定を省略した場合，「No」が仮定されます。

LdapGroupIdAttrFromUserAttrプロパティ

LdapGroupFromUserAttrプロパティおよびLdapGroupIsDnFromUserAttrプロパティに「Yes」を指定した場合に有効になります。

ユーザの属性から取得した情報で，グループのグループ識別子として利用する属性を指定します。指定を省略した場合，「dn」が仮定されます。

LdapGroupFromUserDnプロパティ

UserAuthenticationプロパティで「LDAP」を指定した場合に有効になります。グループ識別子をユーザプロパティのDNの構成要素となる属性値から検索するか，検索しないかを指定します。

Yes
グループ識別子をユーザプロパティのDNの構成要素となる属性から取得します。

No
グループ識別子をユーザプロパティのDNの構成要素となる属性から取得しません。

指定を省略した場合，「No」が仮定されます。

LdapGroupIdFromUserDnプロパティ

UserAuthenticationプロパティで「LDAP」を指定した場合に有効になります。ユーザプロパティのDNの構成要素の中で，グループ識別子として使用する属性名を指定します。指定を省略した場合，「ou」が仮定されます。

LdapGroupTimeoutプロパティ

UserAuthenticationプロパティで「LDAP」を指定した場合に有効になります。ディレクトリプロパティからグループを検索するときの最大待ち時間を指定します。0～180（秒）の範囲で指定します。0を指定した場合，待ち時間が無制限になります。指定を省略した場合，「60（秒）」が仮定されます。

LdapGroupCaseプロパティ

UserAuthenticationプロパティで「LDAP」を指定した場合に有効になります。DocumentBrokerで扱うグループ識別子の文字種についての制限を指定します。

Upper
グループ識別子の文字列を，すべて大文字に変換する場合に指定します。LDAP対応のディレクトリサービスから取得したグループ識別子を，DocumentBroker内で大文字に変換します。

Lower
グループ識別子の文字列を，すべて小文字に変換する場合に指定します。LDAP対応のディレクトリサービスから取得したグループ識別子を，DocumentBroker内で小文字に変換します。

Default
グループ識別子の文字列を変換しません。

指定を省略した場合，「Default」が仮定されます。

LdapGroupFromGroupDnプロパティ

UserAuthenticationプロパティで「LDAP」を指定し，LdapGroupプロパティに「Yes」を指定した場合に有効になります。グループ識別子をグループプロパティの上位にあるプロパティから取得するかどうかを指定します。

なお，最上位プロパティはLdapGroupRootプロパティ，グループを検索するときのキーとなる属性はLdapGroupIdプロパティの指定値となります。

Yes
グループ識別子をグループプロパティの上位にあるプロパティから取得します。

No
グループ識別子をグループプロパティの上位にあるプロパティから取得しません。デフォルトの値です。

指定を省略した場合，「No」が仮定されます。

LdapGroupFromGroupMemberプロパティ

UserAuthenticationプロパティで「LDAP」を指定し，LdapGroupプロパティに「Yes」を指定した場合に有効になります。グループ識別子をグループプロパティに関連付いているグループプロパティから，再帰的に取得する場合に指定します。なお，関連付いているグループを記述する属性はLdapGroupMemberプロパティ，グループを検索するときのキーとなる属性はLdapGroupIdプロパティで指定した値となります。

Yes
グループ識別子をグループプロパティに関連付いているグループプロパティから，再帰的に取得します。

No
グループ識別子をグループプロパティに関連付いているグループプロパティから，再帰的に取得しません。デフォルトの値です。

指定を省略した場合，「No」が仮定されます。

LdapBindUserDNプロパティ

UserAuthenticationプロパティで「LDAP」を指定した場合に有効になります。ディレクトリサービスからのデータ読み込み時に，ディレクトリサービスに対して認証を行ってバインドする場合は，認証に使用するDNを指定します。

指定を省略した場合，ディレクトリサービスからのデータ読み込み時に，ディレクトリサービスに対して匿名バインドが使用されます。

なお，ディレクトリサービスに対して認証を行ってバインドする場合は，必ずLdapBindUserDNプロパティとLdapBindPasswordプロパティの両方を指定してください。どちらか一方でも指定を省略した場合は，ディレクトリサービスに対して匿名バインドが使用されます。

LdapBindPasswordプロパティ

UserAuthenticationプロパティで「LDAP」を指定した場合に有効になります。ディレクトリサービスからのデータ読み込み時に，ディレクトリサービスに対して認証を行ってバインドする場合は，認証に使用するパスワードを指定します。

なお，ディレクトリサービスに対して認証を行ってバインドする場合は，必ずLdapBindUserDNプロパティとLdapBindPasswordプロパティの両方を指定してください。どちらか一方でも指定を省略した場合は，ディレクトリサービスに対して匿名バインドが使用されます。

SecurityAdminプロパティ

DocumentBrokerに登録されたオブジェクトやオブジェクトのアクセス権を保守するユーザ（セキュリティ管理者）を指定します。このプロパティは，アクセス制御機能に対応するデータベーススキーマが構築されている場合，有効になります。セキュリティ管理者名には，ユーザ識別子を指定してください。

セキュリティ管理者を複数指定する場合は，ユーザ識別子を「,」（コンマ）で区切って指定します。セキュリティ管理者の人数に制限はありません。セキュリティ管理者の指定例を次に示します。

セキュリティ管理者の指定例

SecurityAdmin=ユーザ識別子1,ユーザ識別子2

ユーザ識別子については，「3.7.3(1)　ユーザ情報の取得方法」を参照してください。なお，このプロパティの指定は省略できません。

UserPermDefプロパティ

文書空間のすべてのオブジェクトに対しての権限をユーザ，またはグループ単位で定義するか，定義しないかを指定します。定義する場合，ユーザ権限定義ファイルを作成します。ユーザ権限定義ファイルについては，「4.4　ユーザ権限定義ファイル（userperm.properties）」を参照してください。このプロパティは，アクセス制御機能に対応するデータベーススキーマが構築されている場合，有効になります。

Yes
文書空間のすべてのオブジェクトに対しての権限をユーザ，またはグループ単位で定義します。

No
文書空間のすべてのオブジェクトに対しての権限をユーザ，またはグループ単位で定義しません。

指定を省略した場合，「No」が仮定されます。

DefaultACFlagOwnerプロパティ

オブジェクトの作成時にデフォルトで付加されるACFlagを指定します。オブジェクトの所有者に対するパーミッションを指定します。ACFlagは，表4-6および表4-7に示されるパーミッション文字列を「|」（ストローク）で結合して指定します。指定を省略した場合，「FULL_CONTROL」が仮定されます。

DefaultACFlagGroupプロパティ

オブジェクトの作成時にデフォルトで付加されるACFlagを指定します。グループに対するパーミッションを指定します。ACFlagは，表4-6および表4-7に示されるパーミッション文字列を「|」（ストローク）で結合して指定します。指定を省略した場合，「FULL_CONTROL」が仮定されます。

DefaultACFlagEveryoneプロパティ

オブジェクトの作成時にデフォルトで付加されるACFlagを指定します。すべてのユーザに対するパーミッションを指定します。ACFlagは，表4-6および表4-7に示されるパーミッション文字列を「|」（ストローク）で結合して指定します。指定を省略した場合，「FULL_CONTROL」が仮定されます。

DefaultACFlagOwnerプロパティ，DefaultACFlagGroupプロパティ，およびDefaultACFlagEveryoneプロパティに設定できるパーミッションには，基本パーミッションと組み合わせパーミッションがあります。どちらのパーミッションも指定できます。また，この2種類のパーミッションを組み合わせて指定することもできます。したがって，各プロパティの値には，次に示す表のパーミッション文字列を指定します。基本パーミッションと対応する文字列を表4-6に示します。また，組み合わせパーミッションと対応する文字列を表4-7に示します。

表4-6　基本パーミッションと対応する文字列

パーミッション文字列 | パーミッション | 意味
PRIM_READ_PROPS | 基本プロパティ参照権 | プロパティを参照する権限
PRIM_WRITE_PROPS | 基本プロパティ更新権 | プロパティを更新する権限
PRIM_READ_CONTENTS | 基本コンテンツ参照権 | 文書の内容を参照する権限
PRIM_WRITE_CONTENTS | 基本コンテンツ更新権 | 文書の内容を更新する権限
PRIM_LINK | 基本リンク権 | オブジェクト同士を関連づける権限
PRIM_VERSION | 基本バージョン管理権 | オブジェクトのバージョンに対する操作をする権限
PRIM_DELETE | 基本削除権 | オブジェクトを削除する権限

基本プロパティ参照権は，そのほかの基本パーミッションにも含まれます。したがって，基本プロパティ参照権以外の基本パーミッションを指定すると，各基本パーミッションで許可される操作に加えて，オブジェクトのプロパティの参照が許可されます。なお，基本パーミッションは，アクセス制御の対象となるオブジェクトごとに許可される操作の内容が異なります。詳細については，マニュアル「DocumentBroker Version 5　概説」を参照してください。

表4-7　組み合わせパーミッションと対応する文字列

パーミッション文字列
パーミッション
意味

READ_PROPS
プロパティ参照権
基本プロパティ参照権と同じ権限

READ
参照権
次の基本パーミッションを組み合わせた権限

基本プロパティ参照権

基本コンテンツ参照権

WRITE_PROPS
プロパティ更新権
次の基本パーミッションを組み合わせた権限

基本プロパティ参照権

基本プロパティ更新権

READ_WRITE
参照更新権
次の基本パーミッションを組み合わせた権限

基本プロパティ参照権

基本プロパティ更新権

基本コンテンツ参照権

基本コンテンツ更新権

DELETE
削除権
次の基本パーミッションを組み合わせた権限

基本プロパティ参照権

基本削除権

LINK
リンク権
次の基本パーミッションを組み合わせた権限

基本プロパティ参照権

基本リンク権

VERSION
バージョン権
次の基本パーミッションを組み合わせた権限

基本プロパティ参照権

基本プロパティ更新権

基本コンテンツ参照権

基本コンテンツ更新権

基本バージョン管理権

FULL_CONTROL
フルコントロール
すべての基本パーミッションを組み合わせた権限

なお，表4-6および表4-7に示したパーミッションのほかに，「NONE」が指定できます。NONEを指定すると，新規にオブジェクトを作成した場合に権限は設定されません。また「NONE」は，ほかのパーミッション文字列と一緒には指定できません。例えば，「DefaultACFlagEveryone=NONE｜LINK」といった指定はできません。

MaxContentSizeプロパティ

登録する文書のファイルの最大サイズを，0～2147483647の範囲で指定します。単位はバイトです。0を指定した場合，登録する文書のサイズをチェックしません。指定を省略した場合は「0」が仮定されます。

MaxFullTextSizeプロパティ

登録する文書の全文検索インデクスを作成するファイルの最大サイズを，0～2147483647の範囲で指定します。単位はバイトです。0を指定した場合，ファイルのサイズをチェックしません。指定を省略した場合は「0」が仮定されます。

BinaryAccessSizeプロパティ

コンテンツ，および全文検索テキストを操作する場合に一度に要求するバイト数を，1～2097151の範囲で指定します。単位はキロバイトです。実データのサイズが指定したサイズよりも小さい場合，実データのサイズでアクセスします。指定を省略した場合は「1024」が仮定されます。

ReferenceStorageModeプロパティ

リファレンスファイル文書の格納方式を設定します。

「Divide」を指定すると，DocumentBrokerがコンテンツを管理するためのディレクトリ階層が少なくなります。

リファレンスファイル文書のコンテンツ数が，「ノードあたりのディレクトリの最大数/2」を超える可能性がある場合は，「Divide」を指定してください。それ以外の場合は，「Origin」を指定してください。

運用開始後にこのプロパティの指定値を変更してもシステムは問題なく動作しますが，異なる格納形式の文書が混在するようになります。そのため，リファレンスファイル文書のコンテンツ数を見積もり，運用を開始する前に適切な値を設定してください。運用開始後にこのプロパティの指定値を変更しないことをお勧めします。

Origin
リファレンスファイル文書のコンテンツを管理するためのディレクトリが，コンテンツ単位に異なります。デフォルトの値です。

Divide
リファレンスファイル文書のコンテンツを管理するためのディレクトリが，複数のコンテンツで共有されます。

指定を省略した場合，「Origin」が仮定されます。

ReferenceDirDivideNumプロパティ

ReferenceStorageModeプロパティで「Divide」を指定した場合に有効となります。リファレンスファイル文書のコンテンツを格納するための，ディレクトリの数を指定します。1～10,000の範囲で指定してください。デフォルトの値は100です。指定を省略した場合，「100」が仮定されます。

運用開始後にこのプロパティの指定値を変更してもシステムは問題なく動作しますが，DocumentBrokerがコンテンツを管理するためのディレクトリ内のコンテンツ数に偏りが発生するため，運用開始後は指定値を変更しないことを推奨します。

ReferenceBasePathプロパティ

リファレンスファイル管理機能で，コンテンツの格納先となるベースパスのデフォルトを指定します。コンテンツの格納先となるベースパスはDbjSession.setReferencePath()でセッションごとに変更できます。相対パスや存在しないパスを指定した場合，リファレンスファイル文書の操作時に例外が発生します。指定を省略した場合，「null」が仮定されます。

TempDirectoryプロパティ

文書のコンテンツをストリーム形式でダウンロードする時に生成される一時ファイルの出力先ディレクトリを指定します。複数の実行環境を構築する場合，実行環境ごとに異なるディレクトリを指定してください。また，このディレクトリ下にはユーザデータを格納しないでください。

指定するディレクトリ下のディスク容量は，次の計算式で算出して必要量を割り当ててください。

最大文書サイズ×同時ダウンロード実行数

指定を省略した場合，「%DOCB_CONF_DIR%¥tmp（Windowsの場合）」または「$DOCB_CONF_DIR/tmp（UNIXの場合）」が仮定されます。

4.3.3　文書空間構成定義ファイルの記述例

文書空間構成定義ファイルの記述例を，次に示します。

＜この項の構成＞

(1)　前提条件

(2)　定義例

(3)　認証，ユーザ情報の取得例

(1)　前提条件

定義例は次の前提条件に従っていることとします。

LDAP対応のディレクトリサービスを使用してユーザ管理をしている。

LDAP対応のディレクトリサービスで構築されているDITは次の図に示す。

各エントリに対応するディレクトリ情報は次の表に示す。

図4-1　DITの例

表4-8　エントリに対応するディレクトリ情報の例

エントリ
各エントリに対応するディレクトリ情報

o: hitachi,c=jp
dn: o=hitachi,c=jp
objectclass: top
objectclass: organization
o: hitachi,c=jp

ou=people
dn:ou=people,o=hitachi,c=jp
objectclass: top
objectclass: person
objectclass: organizationalperson
objectclass: inetOrgPerson
sn: person
cn: personal

uid: s891711
dn: uid=s891711,ou=people,o=hitachi,c=jp
objectclass: top
objectclass: person
objectclass: organizationalperson
objectclass: inetOrgPerson
cn: Taro Hitachi
cn;lang-ja: 日立太郎
uid: s891711
sn: hitachi
ou: unit1
ou: unit
userpassword: s891711

uid: k972251
dn: uid=k972251,ou=people,o=hitachi,c=jp
objectclass: top
objectclass: person
objectclass: organizationalperson
objectclass: inetOrgPerson
cn: Ichiro Yamada
cn;lang-ja: 山田 一郎
uid: k972251
sn: yamada
ou: unit2
ou: unit
userpassword: k972251

uid:k881891
dn: uid=k881891,ou=people,o=hitachi,c=jp
objectclass: top
objectclass: person
objectclass: organizationalperson
objectclass: inetOrgPerson
cn: Jiro Suzuki
cn;lang-ja: 鈴木 二郎
uid: k881891
sn: suzuki
ou: unit2
ou: unit
userpassword: k881891

ou: unit
dn: ou=unit,o=hitachi,c=jp
objectclass: top
objectclass: organizationalUnit
ou: unit
ou;lang-ja: ユニット

ou: unit1
dn: ou=unit1,ou=unit,o=hitachi,c=jp
objectclass: top
objectclass: organizationalUnit
ou: unit1
ou;lang-ja: ユニット1

ou: unit2
dn: ou=unit2,ou=unit,o=hitachi,c=jp
objectclass: top
objectclass: organizationalUnit
ou: unit2
ou;lang-ja: ユニット2

ou: group
dn: ou=group,o=hitachi,c=jp
objectclass: top
objectclass: groupOfUniqueNames
objectclass: hdsgroupofuniquenames
ou: group
ou;lang-ja: グループ
cn:grp0

ou: group1
dn: ou=group1,ou=group,o=hitachi,c=jp
objectclass: top
objectclass: groupOfUniqueNames
objectclass: hdsgroupofuniquenames
cn: grp1
ou: group1
ou;lang-ja: グループ1
uniqueMember: uid=s891711,ou=people,o=hitachi,c=jp

ou: group2
dn: ou=group2,ou=group,o=hitachi,c=jp
objectclass: top
objectclass: groupOfUniqueNames
objectclass: hdsgroupofuniquenames
cn:grp2
ou: group2
ou;lang-ja: グループ2
uniqueMember:uid=k972251,ou=people,o=hitachi,c=jp
uniqueMember:uid=k881891,ou=people,o=hitachi,c=jp

(2)　定義例

前提条件に基づいた文書空間構成定義ファイルの定義例を次に示します。

DocSpaceId = 673d2be0-d1fd-11d0-ab59-08002be29e1d
SecurityAdmin = admin01
DefaultACFlagOwner = FULL_CONTROL
DefaultACFlagGroup = READ_WRITE|LINK|VERSION
DefaultACFlagEveryone = NONE

UserAuthentication = LDAP
LdapHost = 123.45.67.78
LdapPort = 389
LdapUserRoot = o=hitachi,c=jp
LdapGroup = Yes
LdapGroupFromUserAttr = Yes
LdapUserScope = Subtree
LdapUserTimeout = 60
LdapGroupTimeout = 60
LdapUserClass = inetOrgPerson
LdapUserId = uid
LdapUserFilterLeft = (
LdapUserFilterRight = )
LdapUserCase = Default
LdapGroupFromUserDn = Yes
LdapGroupClass = hdsgroupOfUniqueNames
LdapGroupId = cn
LdapGroupRoot = o=hitachi,c=jp
LdapGroupFilterLeft = (
LdapGroupFilterRight = )
LdapGroupIdFromUserAttr = ou
LdapGroupIsDnFromUserAttr = No
LdapGroupIdAttrFromUserAttr = ou
LdapGroupIdFromUserDn = ou
LdapGroupCase = Default
LdapBindUserDN = uid=Tanaka,ou=People,o=hitachi,c=jp
LdapBindPassword = password

(3)　認証，ユーザ情報の取得例

ここでは，例で示した文書空間構成定義ファイルを使用した場合のユーザ認証とユーザ情報の取得について説明します。なお，説明ではログイン名は「s891711」であると仮定します。

認証

UserAuthenticationプロパティがLDAPであるため，DocumentBrokerは次のような検索条件に適合するユーザのエントリを検索します。

検索基点

LdapUserRootプロパティで指定されている「o=hitachi,c=jp」です。

検索範囲

LdapUserScopeプロパティに「Subtree」が指定されているので検索基点からのすべてのサブツリーが検索範囲となります。

検索フィルタによる検索条件

LdapUserFilterLeftプロパティ，LdapUserClassプロパティ，LdapUserIdプロパティおよびLdapUserFilterRightプロパティの指定によって，「（&（objectclass=inetOrgPerson)(uid=s891711))」となります。

この検索によって見つかったエントリのuserpassword属性の値と入力されたパスワードを比較して，一致すれば認証成功になります。

ユーザ情報取得

LdapGroupプロパティがYesであるため，グループのエントリを検索します。この場合，次のような検索条件を用いて検索します。

検索基点

LdapGroupRootプロパティで指定されている「o=hitachi,c=jp」です。

検索範囲

LdapGroupScopeプロパティに「Subtree」が指定されているので検索基点からのすべてのサブツリーが検索範囲となります。

検索条件

LdapGroupFilterLeftプロパティ，LdapGroupClassプロパティおよびLdapGroupFilterRightプロパティの指定によって，「(&(objectclass=hdsgroupOfUniqueNames)(uniqueMember=uid=s891711,ou=people,o=hitachi,c=jp))」となります。

この検索によって見つかったエントリのcn属性（LdapGroupIdプロパティで指定されている属性）の値「grp1」をグループ識別子として取得します。

LdapGroupFromUserAttrプロパティがYesであるため，ユーザの属性値からグループ情報を取得します。この場合，ユーザのou属性（LdapGroupIdFromUserAttrプロパティで指定されている属性）の値は「unit1」および「unit」ですが，LdapGroupIsDnFromUserAttrプロパティがNoであるため，その値をそのままグループ識別子として取得します。

LdapGroupFromUserDnプロパティがYesであるため，ユーザのdnからグループ情報を取得します。この場合，ユーザのdn:uid=s891711,ou=people,o=hitachi,c=jpのou（LdapGroupIdFromUserDnプロパティで指定したDNのキー）の値「people」をグループ識別子として取得します。

このような検索結果から「grp1」，「unit1」，「unit」および「people」をこのユーザのグループ識別子として取得できます。

4.3.4　文書空間構成定義ファイルの注意事項

文書空間構成定義ファイルで文書空間を定義する場合の注意事項について説明します。

＜この項の構成＞

(1)　検索フィルタへ検索条件を追加する場合の注意事項

(2)　文書空間構成定義ファイルの内容を変更する場合の注意事項

(3)　アクセス制御機能の注意事項

(1)　検索フィルタへ検索条件を追加する場合の注意事項

アクセス制御されている文書に接続する場合，DocumentBrokerは，ユーザの属性からのユーザ情報を取得して，アクセスしたい文書にアクセスできるかどうか判断します。ユーザ情報を取得するとき，検索フィルタに検索条件を指定してユーザを検索します。この検索フィルタには，デフォルトの検索フィルタとデフォルトの検索フィルタに検索条件を追加した検索フィルタがあります。

文書空間構成定義ファイルでデフォルトの検索フィルタに検索条件を追加するためには，LdapUserFilterLeftプロパティおよびLdapUserFilterRightプロパティを指定しておく必要があります。

LdapUserFilterLeftプロパティおよびLdapUserFilterRightプロパティの概要

LdapUserFilterLeftプロパティおよびLdapUserFilterRightプロパティは，ユーザ識別子を検索するときにデフォルトの検索フィルタに対して，検索条件を追加して指定します。したがって，デフォルトフィルタに情報を付与して，特定の情報を参照できるユーザを検索できます。

ユーザ識別子を検索する場合にDocumentBrokerが指定するフィルタ

DocumentBrokerはユーザ識別子を検索する場合，次に示すデフォルトフィルタを指定します。

&(objectclass=$LdapUserClass$)($LdapUserId$=ログインユーザ名)

ただし，$x$は，文書空間構成定義ファイルでプロパティxに指定された値です。

このデフォルトフィルタの意味は，(objectclass=$LdapUserClass$)および($LdapUserId$=ログインユーザ名)が真となるユーザ識別子を検索条件として指定するということです。

このデフォルトフィルタに対してLdapUserFilterLeftプロパティおよびLdapUserFilterRightプロパティにユーザ識別子の検索情報を指定して，検索フィルタを設定します。

デフォルトフィルタへの検索条件の追加例

次の例を基に検索フィルタの設定方法を説明します。

（例）

ユーザが使用するアプリケーションプログラムを示す「ApplicationType=DocumentBroker」という属性および属性値を，デフォルトフィルタに追加する。

「ApplicationTypeという属性の属性値がDocumentBrokerであるユーザ」をデフォルトフィルタに追加条件として付与する場合，LdapUserFilterLeftプロパティおよびLdapUserFilterRightプロパティには次のように指定します。

LdapUserFilterLeft=(

LdapUserFilterRight=(ApplicationType=DocumentBroker))
ただし，指定する際，「(」（左括弧）と「)」（右括弧）の個数をそろえる必要があります。これによって作成される検索フィルタを次に示します。
(&(objectclass=$LdapUserClass$)($LdapUserId$=ログインユーザ名) (ApplicationType=DocumentBroker))

この検索フィルタは，(objectclass=$LdapUserClass$)，($LdapUserId$=ログインユーザ名)，および(ApplicationType=DocumentBroker))が真となるユーザ識別子を検索することを意味します。

なお，グループ識別子の検索フィルタに検索情報を追加指定するためのプロパティとして，LdapGroupFilterLeftプロパティおよびLdapGroupFilterRightプロパティがあります。これらのプロパティの指定方法は，LdapUserFilterLeftプロパティおよびLdapUserFilterRightプロパティの指定方法を参考にしてください。

(2)　文書空間構成定義ファイルの内容を変更する場合の注意事項

業務アプリケーションの運用を開始してから，文書空間の構成を変更するような場合が考えられます。このような場合は，次の手順で文書空間の構成を変更してください。

業務アプリケーションを終了する。

文書空間構成定義ファイルを変更する。

業務アプリケーションを再起動する。

なお，業務アプリケーションの起動と終了については，「5.　DocumentBrokerの起動と終了」を参照してください。

(3)　アクセス制御機能の注意事項

アクセス制御機能を利用する環境では，UserAuthenticationプロパティの値として，LDAP，またはUOCを必ず指定してください。これらの値以外が指定されている場合や指定が省略されている場合は，業務アプリケーションが起動しません。

4.4　ユーザ権限定義ファイル（userperm.properties）

この節では，ユーザ権限定義ファイルについて説明します。

DocumentBrokerの運用形態に合わせて，コピーしたサンプルファイルを編集してください。

＜この節の構成＞

4.4.1　ユーザ権限定義ファイルの概要

4.4.2　ユーザ権限定義ファイルの記述形式

4.4.3　ユーザ権限定義ファイルの記述例

4.4.1　ユーザ権限定義ファイルの概要

ユーザ権限定義ファイルはユーザ権限を定義するためのファイルです。ユーザ権限とは，文書空間にオブジェクトを作成する権利（オブジェクト作成権限）と，文書空間内のすべてのオブジェクトに対する操作の範囲（オブジェクト操作権限）をユーザまたはグループ単位で定めるアクセス制御情報の一つです。

システム管理者は，このユーザ権限定義ファイルを更新することでユーザ権限を変更できます。

4.4.2　ユーザ権限定義ファイルの記述形式

ユーザ権限定義ファイルの記述形式を次に示します。なお，ユーザ権限定義ファイルの記述規則については，「4.1.1(1)　プロパティファイルの記述規則」を参照してください。

Subject=SubjectType:パーミッション文字列

Subject

権限を与える対象となるユーザ，グループ，またはシステムサブジェクトを指定します。

SubjectType

アクセス権を与えるサブジェクトが，ユーザなのかグループなのかまたはシステムサブジェクトなのかを識別するための情報です。次に示す識別子のどれかを指定します。

U
Subjectに指定した権限を与える対象が，ユーザであることを示します。

G
Subjectに指定した権限を与える対象が，グループであることを示します。

S
Subjectに指定した権限を与える対象が，システムサブジェクトであることを示します。なお，この値を指定する場合，Subjectには「everyone」だけ指定できます。

パーミッション文字列

Subjectに設定するパーミッションに対応する文字列を指定します。オブジェクト作成権限を表すパーミッション文字列「CREATE」および基本パーミッションを表すパーミッション文字列を指定します。基本パーミッションを表すパーミッション文字列については，「4.3.2　文書空間構成定義ファイルの記述形式」の表4-6　基本パーミッションと対応する文字列を参照してください。パーミッション文字列は，「|」（ストローク）で結合して複数指定できます。

なお，プロパティの指定で，次に示す場合については，複数のプロパティに指定されたパーミッション文字列の論理和のユーザ権限が与えられます。

同一ユーザや同一グループを複数指定して，それぞれにパーミッション文字列を指定した場合

すべてのユーザ（everyone）と特定のユーザや，特定のユーザとそのユーザが所属するグループなど，同一ユーザが該当するサブジェクトを複数指定して，それぞれにパーミッション文字列を指定した場合

ユーザ権限は，ユーザ権限定義ファイルに，ユーザおよびグループ単位でパーミッションを指定します。なお，ユーザ権限定義ファイルにプロパティが指定されなかった場合，すべてのユーザにユーザ権限が与えられません。

4.4.3　ユーザ権限定義ファイルの記述例

ユーザ権限定義ファイルの記述例を例題に沿って説明します。

＜この項の構成＞

(1)　ユーザ権限定義ファイルで使用する例題

(2)　ユーザ権限定義ファイルの記述例

(1)　ユーザ権限定義ファイルで使用する例題

例題として使用するユーザ権限定義ファイルの定義内容を次の表に示します。

表4-9　ユーザ権限定義ファイルの定義内容

指定項目
指定する値
説明

DocumentBrokerを利用するすべてのユーザ(everyone)の権限
CREATE|PRIM_READ_PROPS
DocumentBrokerを利用するすべてのユーザ(everyone)に対して，次の操作を許可します。
オブジェクトの作成
すべてのオブジェクトのプロパティの参照

ユーザ「User1」の権限
PRIM_READ_CONTENTS
「User1」というユーザに対して，次の操作を許可します。
文書のプロパティの参照
文書の内容の参照

グループ「Group1」の権限
PRIM_DELETE
「Group1」というグループに所属するユーザに対して，すべてのオブジェクトの削除を許可します。

(2)　ユーザ権限定義ファイルの記述例

ユーザ権限定義ファイルの記述例を次に示します。

everyone=S:CREATE|PRIM_READ_PROPS
User1=U:PRIM_READ_CONTENTS
Group1=G:PRIM_DELETE

4.5　レンディション定義ファイル（mime.properties）

この節では，レンディション定義ファイルについて説明します。

レンディション定義ファイルは，文書のコンテンツを登録するときに，登録するファイルの拡張子からレンディションタイプ（MIME形式）を自動的に設定するために使用するファイルです。

＜この節の構成＞

(1)　レンディション定義ファイルの記述形式

(2)　ファイル内容の有効期間

(3)　注意事項

(1)　レンディション定義ファイルの記述形式

プロパティ名には，ファイルの拡張子を指定します。値には，レンディションタイプを指定します。レンディションタイプは，MIME形式で指定します。ただし，先頭の「MIME::」は省略して指定してください。

形式は，次のとおりです。

拡張子 = レンディションタイプ

複数の拡張子に同じレンディションタイプを割り当てる場合も，拡張子ごとに1列ずつ，同じレンディションタイプを指定してください。

記述例を示します。

txt = text/plain
htm = text/html
html = text/html

(2)　ファイル内容の有効期間

レンディション定義プロパティファイルの内容は，DocumentBrokerを初期化するときに読み込まれます。一度読み込まれたあとは，プロセスが終了するまで再読み込みはされません。

(3)　注意事項

複数の実行環境でシステムを構築する場合，すべての実行環境でレンディション定義プロパティファイルの内容を一致させておく必要があります。レンディション定義プロパティファイルの内容が不一致の場合，DocumentBrokerに登録されるファイルの形式に関する情報が，使用する実行環境ごとに異なります。

4.6　メタ情報初期化ファイル（docbmetainit.properties）

この節では，メタ情報初期化ファイルについて説明します。

メタ情報初期化ファイルは，DocumentBrokerのシステム設定を記述するファイルです。メタ情報の登録コマンド（dbjinitmeta）の実行時に入力ファイルとして指定することで，システム情報が登録されます。

＜この節の構成＞

4.6.1　メタ情報初期化ファイルの記述形式

4.6.1　メタ情報初期化ファイルの記述形式

ここでは，メタ情報初期化ファイルの記述形式について説明します。なお，メタ情報初期化の記述規則については，「4.1.1(1)　プロパティファイルの記述規則」を参照してください。

メタ情報初期化ファイルは，Java 2 Platform, Standard Editionのプロパティファイル形式です。

<プロパティ名>=<値>

以降，メタ情報初期化ファイルに記述するプロパティについて説明します。

DocSpaceCharacterSetプロパティ

文書空間で使用する文字コード種別を指定します。

SJIS
文書空間で使用する文字コード種別に「Shift-JIS」を使用します。

UTF-8
文書空間で使用する文字コード種別に「UTF-8」を使用します。

指定を省略した場合，「UTF-8」が仮定されます。なお，不正な値を指定した場合，エラーとなります。

4.7　データベース情報ファイル（databaseinfo.properties）

この節では，データベース情報ファイルについて説明します。

データベース情報ファイルは，コマンドが接続するデータベースの情報を記述するファイルです。次のコマンドの実行時に，データベースへの接続に使用します。

メタ情報の初期設定コマンド（dbjinitmeta）

メタ情報の追加コマンド（dbjaddmeta）

DocumentBroker用データベース定義文の作成コマンド（dbjcrtsql）

メタ情報の削除コマンド（dbjdelmeta）

DocumentBroker実行環境の情報の登録コマンド（dbjregenvid）

メタ情報の内容変更コマンド（dbjchgmeta）

メタ情報のCSV出力コマンド（dbjprintmeta）

＜この節の構成＞

4.7.1　データベース情報ファイルの記述形式

4.7.1　データベース情報ファイルの記述形式

ここでは，データベース情報ファイルの記述形式について説明します。なお，メタ情報初期化の記述規則については，「4.1.1(1)　プロパティファイルの記述規則」を参照してください。

データベース情報ファイルは，Java 2 Platform, Standard Editionのプロパティファイル形式です。

<プロパティ名>=<値>

以降，データベース情報ファイルに記述するプロパティについて説明します。

DBTypeプロパティ

使用するデータベースの種類として，「HiRDB」を指定します。このプロパティの指定は省略できません。

DBHostプロパティ

接続先データベースのホスト名を指定します。

DBPortプロパティ

接続先データベースのポート番号を指定します。

DBUserプロパティ

データベースに接続するユーザ名を指定します。

DBPassプロパティ

データベースに接続するユーザのパスワードを指定します。

4.8　メタ情報ファイル

この節では，メタ情報ファイルについて説明します。

DocumentBrokerで使用するクラスの定義情報をメタ情報といいます。このメタ情報は，メタ情報ファイルという初期設定用のファイルに記述されています。メタ情報ファイルは，DocumentBrokerをインストールしたときに以下に格納されます。

UNIXの場合

/opt/DocBroker/Platform/meta以下

Windowsの場合

<インストールディレクトリ>¥DocBroker¥Platform¥meta以下
または

<インストールディレクトリ>¥DocBroker¥Developer¥meta以下

メタ情報ファイルは，直接編集しないでください。メタ情報を追加する場合は，定義情報ファイルに必要なオブジェクトの定義を追加します。定義情報ファイルについては，「4.9　定義情報ファイル」を参照してください。

メタ情報ファイルの一覧を次の表に示します。

表4-10　メタ情報ファイルの一覧

ファイル名 | 内容
edmclass.csv | DocumentBrokerが提供するシステムクラスを定義したファイル
edmclassprop.csv | DocumentBrokerが提供するシステムクラスが持つプロパティを定義したファイル
edmprop.csv | DocumentBrokerが提供するシステムプロパティを定義したファイル
edmsys.csv | システム情報のデフォルト値を定義したファイル

4.9　定義情報ファイル

この節では，定義情報ファイルについて説明します。

定義情報ファイルは，サンプルファイルが提供されています。任意のディレクトリ下に，すべての定義情報ファイルを格納して使用してください。

＜この節の構成＞

4.9.1　定義情報ファイルの概要

4.9.2　サブクラス名およびプロパティ名をデータベース定義の名称に使用する場合の規則

4.9.3　定義情報ファイルの記述形式

4.9.4　定義情報ファイルの記述例

4.9.5　定義情報ファイルの記述例（VariableArray型のプロパティを追加する場合）

4.9.6　定義情報ファイルの記述例（全文検索機能を使用する文書クラスを追加する場合）

4.9.7　定義情報ファイルの記述例（文字列型プロパティに対する全文検索機能を使用する場合）

4.9.1　定義情報ファイルの概要

定義情報ファイルは，ユーザの環境に合わせてサブクラスやプロパティを追加する場合に作成する，オブジェクトを定義するファイルです。このファイルに定義した情報は，メタ情報として追加されます。

作成する定義情報ファイルを次の表に示します。

表4-11　定義情報ファイルの一覧

ファイル名 | 内容
addclass.csv | ユーザ定義のサブクラスを追加する場合に作成します。
addprop.csv | ユーザ定義のプロパティを追加する場合に作成します。ユーザ定義のプロパティを追加した場合，addclassprop.csvでプロパティをクラスに追加する必要があります。
addclassprop.csv | プロパティをクラスに追加する場合に作成します。

4.9.2　サブクラス名およびプロパティ名をデータベース定義の名称に使用する場合の規則

定義情報ファイルに記述するサブクラス名やプロパティ名の規則を説明します。ここでは，表識別子（表の名称として一意に識別できる値），列名を定義する場合の規則について説明します。

なお，システムクラスおよびシステムプロパティのデータベース定義の名称一覧は，「付録A　システムクラス，システムプロパティおよびデータベース定義の名称規則」を参照してください。

＜この項の構成＞

(1)　サブクラス名の規則

(2)　プロパティ名の規則

(1)　サブクラス名の規則

英小文字，英大文字，数字，空白，「_」（下線文字），および「-」（マイナス記号）で指定します。

サブクラス名には，「dmaClass」および「edmClass」で始まる文字列は使用できません。

サブクラスの名称は重複しないようにしてください。

先頭1バイトは，英小文字，または英大文字を指定します。

末尾に，空白は設定できません。

1～28バイトで指定します。

(2)　プロパティ名の規則

英小文字，英大文字，数字，空白，「_」（下線文字），および「-」（マイナス記号）で指定します。

「dmaProp」，「edmProp」および「dbrProp」で始まる文字列は使用できません。

先頭1バイトは，英小文字か英大文字で指定します。

末尾に，空白は設定できません。

VariableArray型のプロパティ名は，1～14バイトで指定します。
VariableArray型のプロパティは，データ型がVariableArrayであるプロパティである必要があります。

VariableArray型の要素のプロパティ名は，1～15バイトで指定します。
VariableArray型の要素のプロパティとは，edmClass_Structクラスのサブクラスに追加したプロパティです。

重複しないように付ける必要があります。
列名は，プリフィクスが「VariableArray型プロパティの列名+'_'」と重複しないように付ける必要があります。例えば列名「varray_elem」とVariableArray型のプロパティの列名「varray」がある場合，両方ともプリフィクス「varray_」が重複するため，片方に別の名称を付ける必要があります。

VariableArray型のプロパティおよびVariableArray型の要素のプロパティ以外は1～28バイトで指定します。

4.9.3　定義情報ファイルの記述形式

ここでは，定義情報ファイルの記述形式について説明します。

＜この項の構成＞

(1)　記述規則

(2)　記述形式

(1)　記述規則

定義情報ファイルを記述する場合の規則を次に示します。

ファイルの文字コードはUTF-8とします。

コメント以外は，ASCIIの範囲で記述します。

区切り文字は「,」とします。

先頭（1バイト目）が「#」で始まる行はコメント行として扱われます。（空白のトリミングは行われません。）

空白行は無視されます。

(2)　記述形式

定義情報ファイルの記述形式について説明します。

(a)　addclass.csvファイル

addclass.csvファイルは次の形式に従って記述します。

クラスID,クラス名,スーパークラス名

各項目について説明します。

クラスID

追加するクラスIDをGUID形式で指定します。GUIDは，「X」を0～9およびa～f（小文字）で表される16進数とした「XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX（8-4-4-4-12）」の形式で表されます。GUID値はシステム内で重複できません。なお，大文字・小文字は区別されません。指定を省略した場合，システムで自動採番されます。

クラス名

追加するクラス名を指定します。

クラス名の規則は，「4.9.2(1)　サブクラス名の規則」を参照してください。この項目の指定は省略できません。

スーパークラス名

追加するクラスのスーパークラス名を指定します。なお，この項目の指定は省略できません。

サブクラスを生成できるスーパークラスを次に示します。

dmaClass_ConfigurationHistoryクラス

dmaClass_Containerクラス

dmaClass_DocVersionクラス

edmClass_ContainerVersionクラス

edmClass_IndependentPersistenceクラス

edmClass_Structクラス

edmClass_VersionTracedDocVersionクラス

edmClass_VersionTracedComponentDocVersionクラス

(b)　addprop.csvファイル

addprop.csvファイルは次の形式に従って記述します。

プロパティID,プロパティ名,データ型,プロパティのデフォルト値,文字列の最大長,VariableArrayクラス名,繰り返し列の最大要素数

各項目について説明します。

プロパティID

追加するプロパティIDをGUID形式で指定します。GUIDは，「X」を0～9およびa～f（小文字）で表される16進数とした「XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX（8-4-4-4-12）」の形式で表されます。GUID値はシステム内で重複できません。なお，大文字・小文字は区別されません。指定を省略した場合，システムで自動採番されます。

プロパティ名

追加するプロパティ名を指定します。

プロパティ名の規則は，「4.9.2(2)　プロパティ名の規則」を参照してください。この項目の指定は省略できません。

データ型

追加するプロパティのデータ型を指定します。なお，この項目の指定は省略できません。

String

Integer

Boolean

VariableArray

FreeWordIndex

プロパティのデフォルト値

プロパティにデフォルト値として設定する値を指定します。指定するデータ型によって指定できる値が異なります。

データ型が「String」の場合
0～255バイトの文字列を指定します。NULL値を指定したい場合は「NULL」を指定します。「文字列の最大長」に指定する最大長より大きい文字列を指定した場合，エラーとなります。
指定を省略した場合，0バイトの文字列が仮定されます。

データ型が「Integer」の場合
-2147483648～2147483647の範囲で指定します。指定を省略した場合，「0」が仮定されます。

データ型が「Boolean」の場合
「0」または「1」を指定します。指定を省略した場合，「0」が仮定されます。

データ型が「FreeWordIndex」の場合
0～255バイトの文字列を指定します。NULL値を指定したい場合は「NULL」を指定します。
指定を省略した場合，0バイトの文字列が仮定されます。

上記以外のデータ型の指定値は無視されます。

文字列の最大長

文字列の最大長（バイト）を指定します。データ型に「String」，または「FreeWordIndex」を指定した場合に指定が必要です。

指定できる範囲は，データベースのデータ型に依存します。DocumentBrokerでは指定値の妥当性はチェックしません。データ型が「String」の場合はデータベースの「MVARCHAR」に対応します。「FreeWordIndex」の場合は「FREEWORD」に対応します。

VariableArrayクラス名

edmClass_Structクラスのサブクラスの名前を指定します。データ型に「VariableArray」を指定した場合に指定が必要です。

繰り返し列の最大要素数

VariableArray型のプロパティをデータベースの繰り返し列に格納する場合に指定します。データ型に「VariableArray」を指定した場合に指定が必要です。指定できる値の範囲は，2～30000です。別表に格納する場合は「-1」を指定します。

(c)　addclassprop.csvファイル

addclassprop.csvファイルは次の形式に従って記述します。

クラス名,プロパティ名,デフォルト値

各項目について説明します。

クラス名

プロパティを追加するクラス名を指定します。なお，この項目の指定は省略できません。

プロパティを追加できるクラスを次に示します。

dmaClass_DirectContainmentRelationshipクラス

dmaClass_ReferentialContainmentRelationshipクラス

edmClass_PublicACLクラス

edmClass_Relationshipクラス

追加したサブクラス

VariableArray型のプロパティを追加できるクラスを次に示します。

edmClass_IndependentPersistenceクラスのサブクラス

dmaClass_ConfigurationHistoryクラスのサブクラス

dmaClass_Containerクラスのサブクラス

edmClass_ContainerVersionクラスのサブクラス

dmaClass_DocVersionクラスのサブクラス

edmClass_VersionTracedDocVersionクラスのサブクラス

edmClass_VersionTracedComponentDocVersionクラスのサブクラス

FreeWordIndex型のプロパティを追加できるクラスを次に示します。

edmClass_IndependentPersistenceクラスのサブクラス

dmaClass_ConfigurationHistoryクラスのサブクラス

dmaClass_Containerクラスのサブクラス

edmClass_ContainerVersionクラスのサブクラス

dmaClass_DocVersionクラスのサブクラス

edmClass_VersionTracedDocVersionクラスのサブクラス

edmClass_VersionTracedComponentDocVersionクラスのサブクラス

全文検索インデクス用プロパティを追加できるクラスを次に示します。

dmaClass_DocVersionクラスのサブクラス

edmClass_VersionTracedDocVersionクラスのサブクラス

dmaClass_ConfigurationHistoryクラスのサブクラス

なお，クラスに全文検索インデクス用プロパティを追加した場合，次のシステムプロパティもそのクラスに追加する必要があります。追加しない場合は，エラーとなります。

edmProp_DocLengthプロパティ

edmProp_ContentIndexStatusプロパティ

プロパティ名

追加するプロパティ名を指定します。この項目の指定は省略できません。

デフォルト値

クラス固有のプロパティのデフォルト値を指定します。指定を省略した場合，addprop.csvファイルの内容が仮定されます。また，""だけが指定された場合は，addprop.csvの内容を参照しないで，空値が指定されます。

4.9.4　定義情報ファイルの記述例

サブクラスおよびプロパティを追加する場合の定義情報ファイルについて，例題に沿って説明します。

＜この項の構成＞

(1)　使用する例題

(2)　記述例

(1)　使用する例題

サブクラスおよびプロパティを追加する場合の定義情報ファイルを作成するための例題を次に示します。

（例）

「問題点管理ドキュメント」という文書を管理するためにサブクラスを追加します。追加するサブクラスには，それぞれ文書の管理に必要なプロパティを追加します。

管理する文書の詳細情報を次の表に示します。

表4-12　管理する文書の詳細情報

文書の種類
概要
付加情報
管理方法

問題点管理ドキュメント
製品の開発時の問題点を管理するための文書

問題点分類

問題点発生日時

検討結果

解決日時

対策日

直接型のリンクを使用して管理する。

この文書を管理するためのサブクラスを次のように設計します。追加するサブクラスとそのスーパークラスを次の表に示します。

表4-13　追加するサブクラスとそのスーパークラス

管理する文書 | 追加するサブクラス | スーパークラス
問題点管理ドキュメント | usrClass_ProbInfoDoc | dmaClass_DocVersion

問題点管理ドキュメントは，dmaClass_DocVersionクラスのサブクラスとしてusrClass_ProbInfoDocクラスを追加して管理します。

次に，文書に対して付加する情報を各クラスのプロパティとして追加します。文書の付加情報とクラスに追加するプロパティの対応を，次の表に示します。

表4-14　文書の付加情報とサブクラスに追加するプロパティの対応

サブクラス名 | 付加情報 | プロパティ名 | データ型
usrClass_ProbInfoDoc | 問題点分類 | usrProp_Category | String型
問題点発生日時 | usrProp_DateOfProb | Integer32型
検討結果 | usrProp_Status | Boolean型
解決日時 | usrProp_DateOfResolve | Integer32型

なお，追加するサブクラスは，全文検索機能付き文書クラスとして追加するため，表に示したプロパティのほかに，全文検索用のプロパティを追加する必要があります。全文検索機能付き文書クラスに追加するプロパティについては，「4.9.6　定義情報ファイルの記述例（全文検索機能を使用する文書クラスを追加する場合）」を参照してください。

このように，管理する文書の種類や付加情報などから必要なクラスとプロパティを決定して，その設計情報を基に必要なクラスおよびプロパティを追加します。

(2)　記述例

addclass.csv

,usrClass_ProbInfoDoc,dmaClass_DocVersion

addclassprop.csv

usrClass_ProbInfoDoc,usrProp_Category,
usrClass_ProbInfoDoc,usrProp_DateOfProb,
usrClass_ProbInfoDoc,usrProp_Status,
usrClass_ProbInfoDoc,usrProp_DateOfResolve,

addprop.csv

,usrProp_Category,String,,64,,
,usrProp_DateOfProb,Integer,,,,
,usrProp_Status,Boolean,,,,
,usrProp_DateOfResolve,Integer,,,,

4.9.5　定義情報ファイルの記述例（VariableArray型のプロパティを追加する場合）

プロパティの基本単位がVariableArray型であるプロパティを追加する場合の定義情報ファイルについて，例題に沿って説明します。

＜この項の構成＞

(1)　使用する例題

(2)　記述例

(1)　使用する例題

プロパティは，データ型に従った値を1個持つか複数個持つかが決められています。これを基本単位といいます。プロパティの基本単位がVariableArray型のプロパティとは，そのプロパティが配列の要素を保持するプロパティです。

VariableArray型のプロパティとして定義するプロパティは，edmClass_Structクラスのインスタンスをリファレンスとして保持します。VariableArray型のプロパティを定義するための例題を次に示します。

（例）

管理する文書として「文書リスト」を定義します。この文書は，書籍の著者に関する情報を管理します。この「文書リスト」について，サブクラスを追加して必要な付加情報を追加します。追加するサブクラスとそのスーパークラスを次の表に示します。

表4-15　追加するサブクラスとそのスーパークラス

管理する情報 | 追加するサブクラス | スーパークラス
文書リスト | usrClass_DocList | edmClass_IndependentPersistence
著者の情報 | usrClass_WriterInfo | edmClass_Struct

「文書リスト」は，書籍の著者に関する情報を管理する文書で，edmClass_IndependentPersistenceクラスのサブクラスとして，「usrClass_DocListクラス」を定義します。「著者の情報」は，著者の情報を管理する文書であり，edmClass_Structクラスのサブクラスとして「usrClass_WriterInfoクラス」を定義します。

「文書リスト」には付加情報としてプロパティを追加します。付加情報に対応するプロパティを次の表に示します。

表4-16　usrClass_DocListクラスの構造

クラス名
付加情報
プロパティ名
（VariableArray型のプロパティ）
データ型

usrClass_DocList
文書名
uP_DocName
String型

著者の情報
uP_WriterInfo
VariableArray型

「uP_WriterInfoプロパティ」は，VariableArray型のプロパティです。表4-17に，「uP_WriterInfoプロパティ」に定義するプロパティを示します。「uP_WriterInfoプロパティ」は，配列の要素としてプロパティを管理します。VariableArray型の「uP_WriterInfoプロパティ」の要素を管理する「usrClass_WriterInfoクラス」に格納されているプロパティを説明します。

表4-17　VariableArray型の「uP_WriterInfoプロパティ」の要素となるクラスの構造

クラス名
（VariableArray型のプロパティの要素）
付加情報
プロパティ名
（VariableArray型のプロパティ要素の構成）
データ型

usrClass_WriterInfo
著者名
uP_WriterName
String型

著者の紹介
uP_Comment
String型

VariableArray型の「uP_WriterInfoプロパティ」の構造を次の図に示します。

図4-2　VariableArray型の「uP_WriterInfoプロパティ」の構造

配列の要素として管理されるこれらのプロパティは，edmClass_Structクラスのプロパティとして追加します。

(2)　記述例

addclass.csv

,usrClass_DocList,edmClass_IndependentPersistence
,usrClass_WriterInfo,edmClass_Struct

addclassprop.csv

usrClass_DocList,uP_DocName,
usrClass_DocList,uP_WriterInfo,
usrClass_WriterInfo,uP_WriterName,
usrClass_WriterInfo,uP_Comment,

addprop.csv

,uP_DocName,String,,64,,
,uP_WriterInfo,VariableArray,,,usrClass_WriterInfo,100
,uP_WriterName,String,,64,,
,uP_Comment,String,,64,,

4.9.6　定義情報ファイルの記述例（全文検索機能を使用する文書クラスを追加する場合）

ここでは，全文検索機能を使用する文書クラスを追加するための定義情報ファイルの記述例を次に示します。なお，文書に対する全文検索機能を使用する場合は，全文検索用のプロパティを追加したdmaClass_DocVersionクラスのサブクラスを作成するために必要な情報を，定義情報ファイルに記述します。

＜この項の構成＞

(1)　記述例

(1)　記述例

# dmaClass_DocVersionクラスのサブクラスusrClass_DocTextSearchクラスを生成する場合の記述例を次に示します。

addclass.csv

,usrClass_DocTextSearch,dmaClass_DocVersion

addclassprop.csv

usrClass_DocTextSearch,edmProp_TextIndex,
usrClass_DocTextSearch,edmProp_DocLength,
usrClass_DocTextSearch,edmProp_ContentIndexStatus,

4.9.7　定義情報ファイルの記述例（文字列型プロパティに対する全文検索機能を使用する場合）

文字列型プロパティに対する全文検索機能を使用する場合の定義情報ファイルについて，例題に沿って説明します。

全文検索機能を使用できる文字列型プロパティのことを<INDEXWORD PRONOUNCE="せんふんけんさくきのうつきもしれつかたふろはてい" INDEXITEM="全文検索機能付き文字列型プロパティ">全文検索機能付き文字列型プロパティ</INDEXWORD>といいます。文字列型プロパティに対して全文検索機能を使用する場合，全文検索機能付き文字列型プロパティを追加します。

なお，全文検索機能付き文字列型プロパティの追加方法は，基本的にString型のプロパティの追加方法と同じです。そのため，ここではString型のプロパティの追加方法と異なる個所について説明します。String型のプロパティの追加方法については，「4.9.4　定義情報ファイルの記述例」を参照してください。

＜この項の構成＞

(1)　使用する例題

(2)　記述例

(1)　使用する例題

全文検索機能付き文字列型プロパティを文書クラスに定義するための例題を次に示します。

（例）

管理する文書として「設計ドキュメント」を定義します。この文書は，製品の開発に関する情報を管理します。

「設計ドキュメント」を管理するためにサブクラスを追加します。追加するサブクラスには，全文検索機能付き文字列型プロパティを追加します。

追加するサブクラスとそのスーパークラスを次に示します。

表4-18　追加するサブクラスとそのスーパークラス（文字列型プロパティに対する全文検索機能を使用する場合）

管理する文書 | 追加するサブクラス | スーパークラス
設計ドキュメント | usrClass_PropTextSearch | dmaClass_DocVersion

dmaClass_DocVersionクラスのサブクラスとしてusrClass_PropTextSearchクラスを追加して，設計ドキュメントを管理します。

また，文書に付加する情報としてプロパティを追加します。設計ドキュメントの付加情報と，付加情報に対応するプロパティを次の表に示します。

表4-19　usrClass_PropTextSearchクラスの構造

クラス名
付加情報
プロパティ名
データ型

usrClass_PropTextSearch
文書名
usrProp_DocName
String型

執筆者
usrProp_DocWriter
String型

文書の概要
usrProp_DocSummary
（全文検索機能付き文字列型プロパティ）
FreeWordIndex型

usrProp_DocSummaryプロパティは，全文検索機能付き文字列型プロパティです。

(2)　記述例

全文検索機能付き文字列型プロパティを追加するには，プロパティを追加するために必要な情報を定義情報ファイルに記述します。

全文検索機能付き文字列型プロパティを追加する場合の定義情報ファイルの記述方法について，「(1)　使用する例題」で設定した例題に沿って説明します。

addclass.csv

,usrClass_PropTextSearch,dmaClass_DocVersion

addclassprop.csv

usrClass_PropTextSearch,usrProp_DocName,
usrClass_PropTextSearch,usrProp_DocWriter,
usrClass_PropTextSearch,usrProp_DocSummary,

addprop.csv

,usrProp_DocName,String,,64,,
,usrProp_DocWriter,String,,64,,
,usrProp_DocSummary,FreeWordIndex,,255,,

4.10　RDエリア定義情報ファイル

この節では，RDエリア定義情報ファイルについて説明します。

＜この節の構成＞

4.10.1　RDエリア定義情報ファイルの概要

4.10.2　RDエリア定義情報ファイルの記述形式

4.10.3　RDエリア定義情報ファイルの記述例

4.10.4　RDエリア定義情報ファイルの注意事項

4.10.1　RDエリア定義情報ファイルの概要

RDエリア定義情報ファイルは，データベース定義文中のRDエリア名を，ユーザが指定したRDエリア名で出力させるために作成するファイルです。作成したファイルは，DocumentBroker用データベース定義文の作成コマンド（dbjcrtsql），およびメタ情報の追加コマンド（dbjaddmeta）の-rオプションで指定します。指定したファイルの内容が，-oオプションで指定したデータベース定義文格納ファイル中のRDエリア名に反映されます。これによって，DocumentBroker用データベース定義文の作成コマンド（dbjcrtsql），およびメタ情報の追加コマンド（dbjaddmeta）で出力されるデータベース定義文中のRDエリアの手動による変更が不要になります。

4.10.2　RDエリア定義情報ファイルの記述形式

ここでは，RDエリア定義情報ファイルの記述形式について説明します。

＜この項の構成＞

(1)　記述規則

(2)　記述形式

(1)　記述規則

RDエリア定義情報ファイルを記述する場合の規則を次に示します。

ファイルの文字コードはUTF-8とします。

区切り文字は「,」とします。

先頭（1 バイト目）が「#」で始まる行はコメント行として扱われます。（空白のトリミングは行われません。）

空白行は無視されます。

(2)　記述形式

RDエリア定義情報ファイルの記述形式を次に示します。

種別,RD エリア名[,クラス名[,プロパティ名,…]]

各項目について説明します。

種別

RDエリアの種別を指定します。指定できる値を次の表に示します。なお，この項目の指定は省略できません。

表4-20　RDエリアの種別

種別
説明
出力するデータベース定義文に種別に対応する指定がない場合の指定値
クラス名の指定
プロパティ名の指定

TableArea
表として定義されるクラスとRDエリア名を対応付ける。
USERAREA
省略可
指定不要

IndexArea
データベースのインデクスとして定義されるプロパティとRDエリアを対応付ける。
INDEXAREA
省略可
1から最大16個指定

LobArea
文書実体を管理するクラスとLOB列格納用RDエリア名を対応付ける。
BLOBAREA
省略不可
dmaClass_ContentTransferクラスを指定する。
指定不要

SGMLTEXTLobArea
全文機能付き文書クラスと全文検索用の文書内容格納用RDエリア名を対応付ける。
BLOBAREA
省略不可
指定不要

NgramIndexArea
全文検索機能付き文書クラスに定義される全文検索インデクスと全文検索インデクス格納用RDエリア名を対応付ける。
BLOBAREA
省略不可
指定不要

FreeWordIndexArea
全文検索機能付き文字列型プロパティに定義される全文検索インデクスと全文検索インデクス格納用RDエリア名を対応付ける。
BLOBAREA
省略不可
1個指定する

RDエリア名

格納先のRDエリア名を指定します。この項目の指定は省略できません。

なお，種別がLobArea，SGMLTEXTLobArea，NgramIndexArea，およびFreeWordIndexAreaの場合に指定するRDエリア名は，ファイル内で一意になっている必要があります。

クラス名

クラス名（定義情報ファイルに設定した値）を指定します。クラスごとにRDエリアを設定する場合に指定する必要があります。指定を省略すると，種別は1つのRDエリアに対応付けられます。

プロパティ名

インデクスのキーに選択するプロパティ名（定義情報ファイルに設定した値）を指定します。インデクスごとにRDエリアを設定する場合に指定する必要があります。

4.10.3　RDエリア定義情報ファイルの記述例

RDエリア定義情報ファイルの記述例を次に示します。

#下記の場合，ClassAはTBLArea1,ClassBはTBLArea2,それ以外のクラスはTBLArea3に格納される。

TableArea,TBLArea1,ClassA
TableArea,TBLArea2,ClassB
TableArea,TBLArea3

#下記の場合，ClassAのPropAをキーとするインデクスはIDXArea1,ClassAのそれ以外インデクスはIDXArea2,それ以外のクラスのインデクスはIDXArea3に格納される。

IndexArea,IDXArea1,ClassA,PropA
IndexArea,IDXArea2,ClassA
IndexArea,IDXArea3

#以下のLOB格納用RDエリアは格納先RDエリアが重複しないように指定する。

LobArea,LOBArea,dmaClass_ContentTransfer
SGMLTEXTLobArea,SGMLTEXTArea
NgramIndexArea,NGRMArea1,ClassA
NgramIndexArea,NGRMArea2,ClassB
FreeWordIndexArea,FREEArea,ClassC,PropB

4.10.4　RDエリア定義情報ファイルの注意事項

RDエリア定義情報ファイルの注意事項について説明します。

指定されたRDエリア名がデータベースに定義されているかどうかについてはチェックしません。

指定されたクラス名，プロパティ名の妥当性についてはチェックしません。

種別がLobArea，SGMLTEXTLobArea，NgramIndexArea，およびFreeWordIndexAreaの場合に指定するRDエリア名は，ユニークな名称を指定してください。重複している場合，該当するエリア名にはBLOBAREAという文字列を出力します。

ファイルの内容に誤りがあった場合，警告メッセージを表示してその行の解析を中止し，処理を続行します。

RDエリア定義情報ファイルには，空白を含むクラス名，プロパティ名，およびRDエリア名は指定できません。空白を含むクラス名，プロパティ名，およびRDエリア名を指定した場合，データベース定義文出力時に警告メッセージが出力されるか，またはデータベース定義ユティリティ実行時にデータベースのエラーでエラーとなります。

4.11　インデクス情報ファイル

この節では，インデクス情報ファイルについて説明します。

インデクス情報ファイルは，ユーザが追加するプロパティにインデクスを定義し，インデクスの作成をデータベース定義に追加する場合に作成してください。

＜この節の構成＞

4.11.1　インデクス情報ファイルの概要

4.11.2　インデクス名をデータベース定義の名称に使用する場合の規則

4.11.3　インデクス情報ファイルの記述形式

4.11.4　インデクス情報ファイルの記述例

4.11.1　インデクス情報ファイルの概要

サブクラスに追加するプロパティをキーにして検索したい場合，プロパティにインデクスを定義します。インデクス情報ファイルは，ユーザが追加するプロパティにインデクスを定義する場合に，インデクスの情報を記述するファイルです。

作成したインデクス情報ファイルをメタ情報の追加コマンド（dbjaddmeta），およびDocumentBroker用データベース定義文の作成コマンド（dbjcrtsql）実行時に入力ファイルとして指定することで，データベース定義文にインデクスの作成を定義できます。インデクス情報ファイルでは，ユーザが定義するプロパティに対するインデクスの作成を定義できます。

4.11.2　インデクス名をデータベース定義の名称に使用する場合の規則

定義情報ファイルに記述したサブクラス名やプロパティ名を，データベース定義の名称定義として使用する場合の規則を説明します。ここでは，インデクス名（表を検索するためのキーとして列に付けた索引の名称）を定義する場合の規則について説明します。

インデクス名を定義する場合，英小文字，英大文字，数字，空白，「_」（下線文字），および「-」（マイナス記号）で指定します。インデクス名の指定では，DocumentBrokerで付けるインデクス名を含めてデータベースのスキーマで一意に付ける必要があります。また，インデクス名を指定する場合は，次に示す規則およびデータベース定義の制約に従ってください。

ユーザがインデクスを追加する場合，インデクス情報ファイルで指定したインデクス名が，データベース定義文のインデクス名になります。

インデクス名には，「dmaClass」および「edmClass」で始まる名称を指定しないでください。

インデクス名の先頭1バイトは，英小文字または英大文字で指定します。

インデクス名の末尾は，空白にできません。

インデクス名は，1～30バイトで指定します。

4.11.3　インデクス情報ファイルの記述形式

ここでは，インデクス情報ファイルの記述形式について説明します。

＜この項の構成＞

(1)　記述規則

(2)　記述形式

(1)　記述規則

インデクス情報ファイルを記述する場合の規則を次に示します。

ファイルの文字コードはUTF-8とします。

区切り文字は「,」とします。

先頭（1 バイト目）が「#」で始まる行はコメント行として扱われます。（空白のトリミングは行われません。）

空白行は無視されます。

(2)　記述形式

インデクス情報ファイルの記述形式を次に示します。

[インデクス名],クラス名,[UNIQUE],[EXCEPT],プロパティ名,[{ASC | DESC}] [,プロパティ名, [{ASC | DESC}]]…

各項目について説明します。

インデクス名

インデクス名を指定します。インデクス名の規則は，「4.11.2　インデクス名をデータベース定義の名称に使用する場合の規則」を参照してください。

指定が省略された場合，インデクス名はシステムインデクス名に続けて「クラス名 + VV（32進数）」の形で自動採番されます。VVを超える場合はエラーとなります。インデクス名を指定し，クラス名にVariableArrayクラス名を指定した場合，VariableArrayプロパティを複数の箇所で使用すると同名のインデクス名が複数出力されます。

クラス名

インデクスを定義するクラス名を指定します。この項目は省略できません。

UNIQUE

インデクスのキーに選択するプロパティを一意に制約する場合に指定します。指定を省略した場合，インデクスのキーに選択するプロパティを一意に制約しません。

EXCEPT

NULL値だけで構成されるキーを除外してインデクスを定義する場合に指定します。指定を省略した場合，NULL値だけで構成されるキー値を除外しません。

プロパティ名

インデクスのキーに選択するプロパティ名を指定します。最大16個まで指定できます。複数指定すると，マルチカラムインデクス定義となります。システム定義のプロパティ（「dma」および「edm」で始まるプロパティ）は指定できません。なお，この項目は省略できません。

ASC|DESC

インデクスを昇順に定義する場合はASC，降順に定義する場合はDESCを指定します。直前のカラムにはプロパティ名を指定する必要があります。なお，指定を省略した場合，キーに選択したプロパティにORDER BY句が設定されません。

4.11.4　インデクス情報ファイルの記述例

インデクス情報ファイルの記述例を次に示します。

INDEXA,usrClassCH,UNIQUE,EXCEPT,usrProp_Name,ASC
INDEXA,usrClassCH,,,usrProp_Author,,usrProp_Count

4.12　変更情報ファイル

この節では，変更情報ファイルについて説明します。

＜この節の構成＞

4.12.1　変更情報ファイルの概要

4.12.2　変更情報ファイルの記述規則

4.12.3　ユーザ識別子変更情報ファイル

4.12.4　グループ識別子変更情報ファイル

4.12.5　プロパティ変更情報ファイル

4.12.1　変更情報ファイルの概要

変更情報ファイルは，オブジェクトに設定されている，ユーザ識別子，グループ識別子，ユーザプロパティを変更する場合に作成してください。dbjchgusridコマンドの実行時に入力ファイルとして指定することで，オブジェクトに設定されているユーザ識別子，グループ識別子，ユーザプロパティの内容を一括で変更することができます。変更情報ファイルには，次の種類があります。変更内容に合わせて必要なファイルを作成してください。なお，コマンドを実行すると，変更情報ファイルで空文字となっている各行の1フィールド目に実行結果が出力されます。コマンドの実行結果でエラーが発生した場合，出力された変更情報ファイルの内容を修正し再実行すると，エラーになったオブジェクトだけ，処理されます。

ユーザ識別子変更情報ファイル

グループ識別子変更情報ファイル

ユーザプロパティを変更する場合は，変更するユーザプロパティを記述した下記のファイルが追加で必要です。

プロパティ変更情報ファイル

それぞれのファイルの記述形式については，「4.12.3　ユーザ識別子変更情報ファイル」「4.12.4　グループ識別子変更情報ファイル」「4.12.5　プロパティ変更情報ファイル」を参照してください。

4.12.2　変更情報ファイルの記述規則

変更情報ファイルを記述する場合の規則を次に示します。

行の終わりは，<EOF>または行末文字とします。

先頭(1バイト目)が「#」および「；」で始まる行はコメント行として扱われます。（空白のトリミングは行われません。）

値に「,」が含まれている場合，「"」（引用符）で囲んでください。

ファイルの文字コードは，文書空間で使用する文字コード（UTF-8またはShift-JIS），または印刷可能なASCIIコードとします。文書空間で使用する文字コードでファイルの内容を読み込むため，文書空間で使用する文字コード種別に応じた文字コードで記述してください。

次の場合は，エラーとなります。

変更前の識別子と変更後の識別子に同じ値を指定している場合

A,A

変更前の識別子を重複して指定している場合

A,B
A,C

変更後の識別子を以降の行で変更前の識別子に指定している場合

A,B
B,C

4.12.3　ユーザ識別子変更情報ファイル

ユーザ識別子を変更する場合に作成します。

＜この項の構成＞

(1)　形式

(2)　記述例

(1)　形式

ユーザ識別子変更情報ファイルは，次の形式で記述します。

登録結果フラグ,ユーザ識別子変更エントリ[,ユーザプロパティ変更エントリ]

各項目について説明します。

登録結果フラグ

変更処理を実行すると，登録結果フラグに実行結果が出力されます。

＜登録結果フラグ＞：：＝｛－| 1 | 2｝

表4-21　登録結果フラグの意味

登録結果フラグ | 意味 | コマンド実行時に指定した場合の動作
－ | 一括変更処理は未実行です。 | 一括変更処理を実行します。
1 | 一括変更処理が正常終了しました。 | 一括変更処理を実行しません。
2 | 一括変更処理が異常終了しました。 | 一括変更処理を実行します。

凡例

－：値を設定しません。

ユーザ識別子変更エントリ

＜ユーザ識別子変更エントリ＞：：＝＜変更前ユーザ識別子＞,＜変更後ユーザ識別子＞

＜変更前ユーザ識別子＞

変更前のユーザ識別子を1～254バイトの範囲で指定します。

＜変更後ユーザ識別子＞

変更後のユーザ識別子を1～254バイトの範囲で指定します。

ユーザプロパティ変更エントリ

＜ユーザプロパティ変更エントリ＞：：＝＜変更前ユーザプロパティ値＞,＜変更後ユーザプロパティ値＞

＜変更前ユーザプロパティ値＞

変更前のユーザプロパティ値を指定します。

＜変更後ユーザプロパティ値＞

変更後のユーザプロパティ値を指定します。

(2)　記述例

ユーザ識別子変更情報ファイルの記述例を次に示します。

;result,before,after,user prop before,user prop after
,user1,user2,日立　太郎1,日立　太郎2
,user3,user4
,user5,user6,日立　太郎5,日立　太郎6

参考

userAをuserBへ，userBをuserAに変更する場合，コマンドを分割して実行する必要があります。1回のコマンドで実行すると，記述規則に反するためエラーとなります。1回目のコマンド実行で，ユーザAをworkに，ユーザBをユーザAに変更します。2回目のコマンド実行でworkをユーザBに変更します。

1回目

ユーザAをworkに，ユーザBをユーザAに変更します。

;result,before,after,user prop before,user prop after
,userA,work,ユーザA,work
,userB,userA,ユーザB,ユーザA

2回目

workをユーザBに変更します。

;result,before,after,user prop before,user prop after
,work,userB,work,ユーザB

4.12.4　グループ識別子変更情報ファイル

グループ識別子を変更する場合に作成します。

＜この項の構成＞

(1)　形式

(2)　記述例

(1)　形式

グループ識別子変更情報ファイルは，次の形式で記述します。

登録結果フラグ,グループ識別子変更エントリ[,ユーザプロパティ変更エントリ]

各項目について説明します。

グループ識別子変更エントリ

＜グループ識別子変更エントリ＞：：＝＜変更前グループ識別子＞,＜変更後グループ識別子＞

＜変更前グループ識別子＞

変更前のグループ識別子を1～254バイトの範囲で指定します。

＜変更後ブループ識別子＞

変更後のグループ識別子を1～254バイトの範囲で指定します。

登録結果フラグ，ユーザプロパティ変更エントリ

ユーザ識別子変更情報ファイルの場合と同じです。「4.12.3(1) 形式」を参照してください。

(2)　記述例

グループ識別子変更情報ファイルの記述例を次に示します。

;result,before,after,user prop before,user prop after
,group1,group2,グループ1,グループ2
,group3,group4
,group5,group6,グループ5,グループ6

参考

groupAをgroupBへ，groupBをgroupCにシフトする場合は，groupBをgroupCに変更する指定の後で，groupAをgroupBに変更する指定を行います。

;result,before,after,user prop before,user prop after
;groupA,groupBの指定はgroupB,groupCの指定行以降に記述します
,groupB,groupC,グループB,グループC
,groupA,groupB,グループA,グループB

4.12.5　プロパティ変更情報ファイル

ユーザプロパティの変更を行う場合に作成します。

＜この項の構成＞

(1)　形式

(2)　記述例

(3)　注意事項

(1)　形式

プロパティ変更情報ファイルは，次の形式で記述します。

クラス名,プロパティ名,[VariableArray型プロパティの要素となるプロパティ名],[ユーザプロパティ値に対応するプロパティ名],[ユーザプロパティ値に対応するVariableArray型プロパティの要素となるプロパティ名],プロパティ種別

各項目について説明します。

クラス名

変更対象のプロパティを持つクラス名を指定します。

プロパティ名

変更対象のプロパティ名を指定します。

VariableArray型プロパティの要素となるプロパティ名

変更対象のプロパティがVariableArray型の要素のプロパティ名を指定します。変更対象のプロパティがVariableArray型でない場合は，指定は無効となります。

ユーザプロパティ値に対応するプロパティ名

＜プロパティ名＞を一意に識別できるプロパティ名を指定します。

例えば，「ユーザ識別子」（一意な値）と「対応する氏名」（一意でない値）が定義されたクラスで，同姓同名のユーザが存在する場合，＜プロパティ名＞に「氏名を格納するプロパティ名」を指定しただけではユーザ識別子の異なる同姓同名の氏名についても値が一律に変更されてしまいます。このような場合は，＜プロパティ名＞には，「氏名を格納するプロパティ名」を指定し，＜ユーザプロパティ値に対応するプロパティ名＞に一意に識別できる「ユーザ識別子を格納するプロパティ名」を指定することで，ユーザ識別子変更情報ファイルで指定したユーザ識別子を一意に識別して「対応する氏名」を変更できます。

ユーザプロパティ値に対応するVariableArray型プロパティの要素となるプロパティ名

＜VariableArray型プロパティの要素となるプロパティ名＞を一意に識別できる要素となるプロパティ名を指定します。＜ユーザプロパティ値に対応するプロパティ名＞がVariableArray型のプロパティでない場合は，指定は無効となります。

プロパティ種別

変更対象のユーザプロパティがユーザ識別子，グループ識別子，ユーザプロパティ値のどれかを指定します。

＜プロパティ種別＞：：＝｛U | G | UU | UG}

表4-22　指定できるプロパティ種別

プロパティ種別
指定時の動作

＜プロパティ名＞または
＜VariableArray型プロパティの要素となるプロパティ名＞で指定されたプロパティ値
＜ユーザプロパティ値に対応するプロパティ名＞または
＜ユーザプロパティ値に対応するVariableArray型プロパティの要素となるプロパティ名＞で指定されたプロパティ値

U
ユーザ識別子変更情報ファイルの変更前ユーザ識別子から，変更後ユーザ識別子に変更します。
ユーザ識別子変更情報ファイルの変更前ユーザ識別子から，変更後ユーザ識別子に変更します。

G
グループ識別子変更情報ファイルの変更前グループ識別子から，変更後グループ識別子に変更します。
グループ識別子変更情報ファイルの変更前グループ識別子から，変更後グループ識別子に変更します。

UU
ユーザ識別子変更情報ファイルの変更前ユーザプロパティ値から，変更後ユーザプロパティ値に変更します。
ユーザ識別子変更情報ファイルの変更前ユーザ識別子から，変更後ユーザ識別子に変更します。

UG
グループ識別子変更情報ファイルの変更前ユーザプロパティ値から，変更後ユーザプロパティ値に変更します。
グループ識別子変更情報ファイルの変更前グループ識別子から，変更後グループ識別子に変更します。

(2)　記述例

プロパティ変更情報ファイルの記述例を次に示します。

;,class name,property name,VA element property name,ex property name,ex VA element property name,type
,edmClass_PublicACL,esysProp_Owner,,,,U
,edmClass_PublicACL,dbuUserProp_OwnerName,,,,UU
,ecmClass_DocContainer,esysProp_Creator,,,,U
,ecmClass_DocContainer,dbuUserProp_OwnerName,,edmProp_OwnerId,,UU
,ecmClass_DocContainer,dbuUserProp_ModifierName,,esysProp_Modifier,,UU
,ecmClass_DocContainer,dbuUserProp_PrimaryGroupName,,edmProp_PrimaryGroupId,,UG
,ecmClass_Flow,ecmProp_Req,ecmProp_Name,ecmProp_Req,ecmProp_Id,UU

(3)　注意事項

プロパティ変更情報ファイルには，次のような指定はできません。

一括変更の対象でないクラスのクラス名

全文検索機能付き文字列型プロパティのプロパティ名

＜プロパティ名＞および＜VariableArray型プロパティの要素となるプロパティ名＞において，「dmaProp」，「edmProp」で始まるプロパティ名
ただし，次のプロパティ名は除きます。
edmProp_Name，edmProp_Owner，edmProp_CreateTime，edmProp_Creator，edmProp_ModifyTime，edmProp_Modifier，edmProp_Comment

データ型が異なるプロパティの一つのプロパティ変更情報ファイル中への指定

なお，次に示すプロパティ値はデータ型により検索，および登録時に扱われる値が異なります。データ型による扱われるプロパティ値の違いを次の表に示します。

表4-23　データ型による扱われるプロパティ値の違い

プロパティ値（指定例） | String型 | Integer型 | Boolean型
1 | 1 | 1 | 1
0 | 0 | 0 | 0
001 | 001 | 1 | エラー※
10.5 | 10.5 | エラー※ | エラー※
0.5 | 0.5 | エラー※ | エラー※
-1 | -1 | -1 | エラー※
2147483648​ | 2147483648​ | エラー※ | エラー※

注※

メッセージKMBJ20708-Eを出力します。

5.　DocumentBrokerの起動と終了

この章では，DocumentBrokerの起動と終了の方法について説明します。

＜この章の構成＞

5.1　DocumentBrokerの起動方法

5.2　DocumentBrokerの終了方法

5.1　DocumentBrokerの起動方法

この節では，DocumentBrokerの起動方法について説明します。

起動手順

次の手順に従って，DocumentBrokerを起動してください。なお，手順1.，手順2.および手順3.の順序は問いません。

データベースシステムを起動する。

LDAP対応のディレクトリサービスを起動する。
ユーザ管理機能にLDAP対応のディレクトリサービスを使用する場合，実行してください。ユーザ管理機能については，「3.6　ユーザ管理機能の設定」を参照してください。

アプリケーションサーバを起動する。

業務アプリケーションを起動する。
次のどちらかの方法で起動します。
・cjstartappコマンドを使用する
・Cosminexus Server Plug-inのGUIを使用する
開始方法については，マニュアル「Cosminexus V9 アプリケーションサーバ　アプリケーション設定操作ガイド」の「J2EEアプリケーションの開始」を参照してください。

5.2　DocumentBrokerの終了方法

この節では，DocumentBrokerの終了方法について説明します。

終了手順

次の手順に従って，DocumentBrokerを終了してください。なお，手順2.，手順3.および手順4.の順序は問いません。

業務アプリケーションを停止する。
次のどちらかの方法で停止します。
・cjstopappコマンドを使用する
・Cosminexus Server Plug-inのGUIを使用する

停止方法については，マニュアル「Cosminexus V9 アプリケーションサーバ　アプリケーション設定操作ガイド」の「J2EEアプリケーションの停止」を参照してください。

アプリケーションサーバを停止する。

LDAP対応のディレクトリサービスを停止する。
ユーザ管理機能に，LDAP対応のディレクトリサービスを使用する場合，実行してください。ユーザ管理機能については，「3.6　ユーザ管理機能の設定」を参照してください。

データベースシステムを停止する。

6.　運用と障害対策

この章では，DocumentBrokerで使用するデータベースの運用方法，およびリファレンスファイル管理機能を使用する場合の運用方法について説明します。また，障害対策，および障害情報の取得についても説明します。

＜この章の構成＞

6.1　データベースの運用

6.2　クラス定義の変更

6.3　リファレンスファイル管理機能を使用する場合の運用

6.4　障害対策

6.1　データベースの運用

この節では，データベースの運用方法について説明します。

＜この節の構成＞

6.1.1　バックアップとリストア

6.1.2　ジャーナルファイルの運用

6.1.3　レプリケーション

6.1.1　バックアップとリストア

DocumentBrokerで使用する表のバックアップと回復は，データベースシステムの機能を利用してください。なお，使用できるデータベースシステムはHiRDBのため，データのバックアップと回復はHiRDBの機能を利用してください。HiRDBでのバックアップの取得方法と回復方法の詳細については，マニュアル「HiRDB　システム運用ガイド」を参照してください。

また，ハードウェア障害の発生に備えて，DocumentBrokerがインストールされているシステムのレジストリ情報などの環境情報のバックアップも取得するようにしてください。

＜この項の構成＞

(1)　バックアップとリストアについて

(2)　バックアップとリストアの方法

(3)　データベース運用上の注意事項

(4)　バックアップの取得

(5)　リストアの方法

(1)　バックアップとリストアについて

DocumentBrokerは，データベース上のレコードを組み合わせることで，アプリケーションで扱う論理的なオブジェクトや，オブジェクト間の関連を実現しています。したがって，障害時の回復には，これらの関連の整合性を保持するようにバックアップおよびリストアを行う必要があります。

(2)　バックアップとリストアの方法

DocumentBrokerでは，オブジェクト間の関連を，文書空間単位に管理しています。また，文書空間はデータベースのスキーマに対応しており，文書空間単位で運用できます。

DocumentBrokerでは，アプリケーションで扱うすべてのデータをデータベース上に格納しています。格納しているデータの障害回復には，データベースの機能を利用してください。

オブジェクト間の関連の整合性を保持したバックアップと回復の方法としては，文書空間単位でバックアップと回復を行う方法とRDエリア単位のバックアップと回復を行う方法があります。次に，これらの方法を説明します。

(a)　 文書空間単位のバックアップと回復

文書空間単位でのバックアップの取得の概念を次の図に示します。

図6-1　文書空間単位でのバックアップの取得

文書空間（スキーマ）に属する全データのバックアップを，同期を取って取得します。障害が発生した場合は，全データをバックアップしたデータを基に回復します。ただし，同期を取って全データのバックアップを取得する運用では，文書空間に属するデータ量が多い場合，バックアップおよび回復に必要とする時間の増大や，障害回復までに，停止する業務範囲が大きいなどの問題が発生します。

この運用の場合，更新ログの取得方法として次に示す方法のどちらかを選択してください。

ロールバックおよびロールフォワードに必要なログを取得する。
この方法の場合，バックアップから取得したデータに対して，更新ログでの任意の同期点までの論理的な整合性を保って回復します。

ロールバックに必要なログだけを取得する。
この方法の場合，最後に全データのバックアップを取得した時点まで回復します。

(b)　RDエリア単位のバックアップと最新同期点までの回復

RDエリア単位でのバックアップの取得の概念図を次の図に示します。

図6-2　RDエリア単位でのバックアップ取得

文書空間を構成する個々のRDエリア，またはディスクのパーティション単位にバックアップします。障害が発生した場合は，バックアップしたデータを基に，障害の発生したRDエリアのデータを回復します。このとき，ほかのRDエリアのデータとの関連の整合性を保証するため，データベースの更新ログから最新の同期点まで回復します。このため，更新ログの取得方法は，ロールバックおよびロールフォワードに必要なログを取得する設定にしてください。

この方式では，バックアップした時にRDエリア相互の同期を取る必要がないため，対象データが多い場合にも，日々のバックアップ対象を全体の一部ずつとするなど，柔軟なバックアップの運用ができます。

(3)　データベース運用上の注意事項

LOB列格納用RDエリアの更新ログの取得方法は，ログ取得モードとなります。次の注意が必要です。

(a)　ログファイル容量

当該LOB列に対する追加・更新のデータ量の分だけログが増加するため，ログ容量（特にアンロードログファイルのディスク容量）が不足しないようにファイルサイズ（バイト）を見積もってください。1文書当たりの見積もりの概算を次に示します。

（文書ファイル数 ＋ 4） × 平均ファイルサイズ（バイト）

システムファイルの容量見積もりの詳細については，マニュアル「HiRDB　システム導入・設計ガイド」を参照してください。

(b)　ログ取得性能

ログの出力量の増加による性能劣化を抑えるため，次の2点を検討してください。

LOB列格納用RDエリアへのグローバルバッファの割り当て

グローバルバッファが指定されていない場合は，データの追加および更新ごとにログがファイルに出力されるため入出力が増加します。しかし，グローバルバッファが指定されている場合は，コミット時にログのファイルをバッファリングして出力するため，前者と比べて入出力の増加を抑えた運用ができます。グローバルバッファのオペランドの設定の詳細については，マニュアル「HiRDB　システム定義」を参照してください。

HiRDBのログ入出力バッファ長の拡大

ログ量の増加に伴ってログ用バッファの使用量が増え，ログバッファの空き待ちになる場合が想定されます。このため，ログ入出力バッファ長の拡大を検討してください。サーバ共通定義の詳細については，マニュアル「HiRDB　システム定義」を参照してください。

(4)　バックアップの取得

データベースシステムの機能を利用して，同期を取って，DocumentBrokerが使用している表一式のバックアップを取得してください。バックアップ対象になる表やエリアなどの情報は，データベースの初期設定で使用したデータベース定義文を基に事前に用意してください。

また，ハードウェア障害の発生に備えて，DocumentBrokerがインストールされているシステムのレジストリ情報などの環境情報のバックアップも取得するようにしてください。

(5)　リストアの方法

取得したバックアップのリストアは，データベースシステムの機能を利用して実行してください。リストアを実行する前には，必ずDocumentBrokerを停止させてください。

6.1.2　ジャーナルファイルの運用

障害が発生した場合は，データベースシステムが取得するジャーナルファイルを利用してデータを回復してください。

なお，使用できるデータベースシステムはHiRDBです。したがって，HiRDBが取得するジャーナルファイルを利用して，データを回復してください。HiRDBのジャーナルファイルの運用方法については，マニュアル「HiRDB　システム運用ガイド」を参照してください。

6.1.3　レプリケーション

データベースの内容をほかのデータベースに反映する機能のことを，レプリケーション機能といいます。レプリケーション機能を利用することで，DocumentBrokerが使用するデータベースのデータを抽出して，ほかのデータベースへ反映できます。

なお，使用できるデータベースシステムはHiRDBです。したがって，HiRDBのレプリケーション機能を利用します。HiRDBのレプリケーション機能を利用するには，HiRDBにHiRDB Datareplicatorを組み込む必要があります。HiRDBのレプリケーション機能については，マニュアル「HiRDB Datareplicator」を参照してください。

＜この項の構成＞

(1)　レプリケーションの方法

(2)　クラス，プロパティとデータベースの表，列との対応関係

(1)　レプリケーションの方法

データベースシステムのレプリケーション機能を利用して，ほかのデータベースへデータを反映できます。レプリケーションの対象となる表やエリアなどの情報は，データベースの初期設定で使用したデータベース定義文を基に事前に用意してください。

(2)　クラス，プロパティとデータベースの表，列との対応関係

データベースシステムの定義系SQLを利用して，クラス，プロパティとデータベースの表，列との対応が取れます。使用できるデータベースシステムは，HiRDBです。したがって，ここではHiRDBを利用する場合の対応関係について説明します。

DocumentBroker用データベース定義文の作成コマンド（dbjcrtsql）では，メタ情報ファイルに記述されているクラス識別子を，オブジェクトを格納するRDB表名として設定します。また，メタ情報ファイルに記述されているプロパティ識別子を表の各列名として設定します。

6.2　クラス定義の変更

この節では，DocumentBrokerの運用中に，サブクラスやプロパティの追加，削除など，データベースの表を定義・削除する場合の操作手順，および注意事項について説明します。

「クラスの定義」および「プロパティの定義」とは，メタ情報として格納しているDocumentBrokerのクラスおよびプロパティの定義を表します。また，「表」および「列」は，データベースの表および列を表します。

＜この節の構成＞

6.2.1　クラスの定義を変更する場合について

6.2.2　クラスの追加

6.2.3　クラスの削除

6.2.4　クラスの定義の変更

6.2.1　クラスの定義を変更する場合について

DocumentBrokerの運用中にクラスを追加したり，プロパティを追加したりする場合は，クラスの定義を変更する必要があります。DocumentBrokerでは，次のような場合にクラス定義を変更します。

クラスの追加

クラスの削除

クラスの定義の変更（プロパティの追加，プロパティの定義の変更，プロパティの削除）

次に，これらのクラスの定義を変更する手順を説明します。

6.2.2　クラスの追加

クラスを追加する場合，追加するクラスの定義を記述した定義情報ファイルを作成します。そして，作成した定義情報ファイルを指定してメタ情報の追加コマンド（dbjaddmeta）で，メタ情報へのクラスの定義の追加，および追加するクラスに対応する表を作成するデータベース定義文の生成を実行します。

＜この項の構成＞

(1)　クラスの追加手順

(1)　クラスの追加手順

クラスを追加する手順を次に示します。

定義情報ファイルを作成します。
追加するクラスの定義を記述した定義情報ファイルを作成します。作成した定義情報ファイルは，メタ情報の追加コマンド（dbjaddmeta）の-fオプションに指定します。定義情報ファイルの作成については，「4.9　定義情報ファイル」を参照してください。

インデクス情報ファイルを作成します。
追加するクラスのプロパティにインデクスを定義する場合，インデクス情報ファイルを作成します。メタ情報の追加コマンド（dbjaddmeta）の-iオプションに，作成したインデクス情報ファイル名を指定して実行することで，インデクス情報ファイルの内容を基に，データベース定義文に定義系SQL「CREATE INDEX」が出力されます。なお，データベース定義文は，-oオプションで指定するデータベース定義文格納ファイルに出力されます。
インデクス情報ファイルについては「4.11　インデクス情報ファイル」を参照してください。

RDエリア定義情報ファイルを作成します。
データベース定義文中のRDエリア名称を，ユーザが指定したRDエリア名で出力させるためには，RDエリア定義情報ファイルを作成します。
メタ情報の追加コマンド（dbjaddmeta）の-rオプションに，作成したRDエリア定義情報ファイル名を指定することで，RDエリア定義情報ファイルの内容がデータベース定義文のRDエリア名に反映されます。なお，データベース定義文は，-oオプションで指定するデータベース定義文格納ファイルに出力されます。
RDエリア定義情報ファイルの作成については，「4.10　RDエリア定義情報ファイル」を参照してください。

メタ情報のバックアップを取得します。
メタ情報を更新する前に，メタ情報ファイルの出力コマンド（dbjprintmeta）でメタ情報のバックアップを取得します。
メタ情報ファイルの出力コマンド（dbjprintmeta）には，-lオプションを指定します。-lオプションには，メタ情報のバックアップを出力するディレクトリ名を指定して，データベースからメタ情報を出力します。

データベースのバックアップを取得します。
クラスに対応する表を作成するので，「3.8.2(3)　メタ情報用のテーブルを定義します」で定義したメタ情報用の表を作成したRDエリアのバックアップを取得します。バックアップの取得方法については，マニュアル「HiRDB　システム運用ガイド」のバックアップの取得方法に関する説明で，定義系SQL「CREATE TABLE」の記述を参照してください。

メタ情報の追加コマンド（dbjaddmeta）を実行します。
手順1.～手順3.で作成した定義情報ファイル，インデクス情報ファイル，およびRDエリア定義情報ファイルを指定して，メタ情報の追加コマンド（dbjaddmeta）を実行して，クラスの定義をメタ情報へ追加します。メタ情報の追加コマンド（dbjaddmeta）の-oオプションで，追加するクラスに対応する表を作成する定義系SQL「CREATE TABLE」を格納するデータベース定義文格納ファイルを指定します。

データベース定義ユティリティを実行します。
手順6.で作成したデータベース定義文を入力ファイルとして指定し，HiRDBのデータベース定義ユティリティ（pddef）を実行して定義するクラスに対応する表を追加します。データベース定義ユティリティ（pddef）は，文書空間構成定義ファイルのPdUserエントリに指定するユーザが実行してください。
HiRDBのデータベース定義ユティリティ（pddef）については，マニュアル「HiRDB　コマンドリファレンス」を参照してください。

6.2.3　クラスの削除

クラスを削除する場合，メタ情報の削除コマンド（dbjdelmeta）でクラスの定義の削除を実行します。ただし，削除するのはメタ情報の削除コマンド（dbjdelmeta）の-rオプションで指定したサブクラスに対応した表のデータだけです（同じRDエリアに含まれる別の表のデータは削除されません）。RDエリア内のデータを削除する場合，ここでの手順を実行する前にアプリケーションなどで削除対象のクラスのすべてのオブジェクトを削除しておいてください。

また，VariableArray型のプロパティの要素を格納するために定義するedmClass_Structクラスのサブクラスの削除は，次に示す条件を満たしている必要があります。

edmClass_Structクラスのサブクラスの削除の条件

削除するedmClass_Structクラスのサブクラスを要素とする，基本単位がVariableArray型のプロパティを定義しているクラスが存在しない。

クラスを削除する手順を次に示します。

メタ情報のバックアップを取得します。
「6.2.2　クラスの追加」のメタ情報のバックアップの取得に関する記述を参照してください。

データベースのバックアップを取得します。
クラスに対応する表を削除するため，「3.8.2(3)　メタ情報用のテーブルを定義します」で定義したメタ情報用の表を作成したRDエリア，およびdbjdelmeta（メタ情報の削除）コマンドの-rオプションで指定したサブクラス名に対応した表を格納しているRDエリアのバックアップを取得します。バックアップの取得方法については，マニュアル「HiRDB　システム運用ガイド」のバックアップの取得方法に関する説明で，定義系SQL「DROP TABLE」の記述を参照してください。

メタ情報の削除コマンド（dbjdelmeta）を実行します。
メタ情報の削除コマンド（dbjdelmeta）でクラスの定義を削除します。メタ情報の削除コマンド（dbjdelmeta）には，-rオプションを指定します。

データベース定義ユティリティを実行します。
HiRDBのデータベース定義ユティリティ（pddef）を実行して定義するクラスに対応する表を削除します。削除するSQL文は，「DROP TABLE "-rオプションに指定するサブクラス名"」です。データベース定義ユティリティ（pddef）は，文書空間構成定義ファイルのPdUserエントリに指定するユーザが実行します。HiRDBのデータベース定義ユティリティ（pddef）については，マニュアル「HiRDB　コマンドリファレンス」を参照してください。

6.2.4　クラスの定義の変更

クラスの定義の変更では，プロパティの追加，プロパティの定義の変更，またはプロパティの削除のどれかがあります。

＜この項の構成＞

(1)　プロパティの追加

(2)　プロパティ定義の変更

(3)　プロパティの削除

(1)　プロパティの追加

プロパティを追加するには，追加するプロパティの定義を記述した定義情報ファイルを作成します。そして，作成した定義情報ファイルをメタ情報の追加コマンド（dbjaddmeta）で指定して，プロパティの定義の追加，およびプロパティに対応する列を追加するデータベース定義文の生成を実行します。

プロパティを追加する手順を次に示します。

定義情報ファイルを作成します。
追加するプロパティの定義を記述する定義情報ファイルを作成します。定義情報ファイルの作成については，「4.9　定義情報ファイル」を参照してください。

インデクス情報ファイルを作成します。
追加するプロパティに対応する列の値は，手順5.で示すようにNULL値になります。これによって，追加するプロパティにインデクスを定義する定義系SQL「CREATE INDEX」で「除外値指定」はできません。インデクス情報ファイルの作成については，「6.2.2　クラスの追加」のインデクス情報ファイルの作成に関する記述を参照してください。

メタ情報のバックアップを取得します。
「6.2.2　クラスの追加」のメタ情報のバックアップの取得に関する記述を参照してください。

データベースのバックアップを取得します。
表に列を追加するので，「3.8.2(3)　メタ情報用のテーブルを定義します」で定義したメタ情報用の表を作成したRDエリアのバックアップを取得します。バックアップの取得方法については，マニュアル「HiRDB　システム運用ガイド」のバックアップの取得方法に関する説明で，定義系SQL「ALTER TABLE」の記述を参照してください。

メタ情報の追加コマンド（dbjaddmeta）を実行します。
手順1.，および手順2.で作成した定義情報ファイル，およびインデクス情報ファイルを指定して，メタ情報の追加コマンド（dbjaddmeta）を実行して，プロパティを追加します。
メタ情報の追加コマンド（dbjaddmeta）の-oオプションで，列を追加する定義系SQL「ALTER TABLE」を格納するデータベース定義文格納ファイルを指定します。定義系SQL「ALTER TABLE」の「ADD」句で追加する列の値にはNULL値が指定されます。
メタ情報の追加コマンド（dbjaddmeta）で追加するプロパティ定義に指定する初期値は，UAPでオブジェクトを新規に作成する場合の初期値であり，追加するプロパティには値を設定しません。

データベース定義ユティリティを実行します。
手順5.で作成したデータベース定義文を入力ファイルとして指定し，HiRDBのデータベース定義ユティリティ（pddef）を実行して追加するプロパティに対応する列を追加します。詳細については，「6.2.2　クラスの追加」のデータベース定義ユティリティの実行に関する記述を参照してください。

(2)　プロパティ定義の変更

プロパティの定義を変更する場合，メタ情報の変更コマンド（dbjchgmeta）で，プロパティの定義の変更を実行します。

プロパティの定義を変更する手順を次に示します。

メタ情報のバックアップを取得します。
「6.2.2　クラスの追加」のメタ情報のバックアップの取得に関する記述を参照してください。

データベースのバックアップを取得します。
表の定義を変更するので，全RDエリアのバックアップを取得します。バックアップの取得方法については，マニュアル「HiRDB　システム運用ガイド」のバックアップの取得方法に関する説明で，定義系SQL「ALTER TABLE」の記述を参照してください。

メタ情報の変更コマンド（dbjchgmeta）を実行します。
メタ情報の変更コマンド（dbjchgmeta）でプロパティの定義を変更します。メタ情報の変更コマンド（dbjchgmeta）の-oオプションで，変更するプロパティに対応する列を変更する定義系SQL「ALTER TABLE」を格納する，データベース定義文格納ファイルを指定します。

データベース定義ユティリティを実行します。
手順3.で作成したデータベース定義文を入力ファイルとして指定し，HiRDBのデータベース定義ユティリティ（pddef）を実行して変更するプロパティに対応する列を変更します。詳細については，「6.2.2　クラスの追加」のデータベース定義ユティリティの実行に関する記述を参照してください。

(3)　プロパティの削除

プロパティを削除する場合，メタ情報の削除コマンド（dbjdelmeta）で，プロパティの定義の削除を実行します。ただし，メタ情報の削除コマンド（dbjdelmeta）では，データベース定義は変更されないため，登録済みのデータは削除されません。また，該当プロパティを持つクラスにデータを追加した場合は，該当プロパティにはNULL値が設定されます。

プロパティの定義を削除する手順を次に示します。

メタ情報のバックアップを取得します。
「6.2.2　クラスの追加」のメタ情報のバックアップの取得に関する記述を参照してください。

メタ情報の削除コマンド（dbjdelmeta）を実行します。
メタ情報の削除コマンド（dbjdelmeta）でプロパティの定義を削除します。メタ情報の削除コマンド（dbjdelmeta）の-pオプション，および-qオプションを指定して実行します。

6.3　リファレンスファイル管理機能を使用する場合の運用

この節では，リファレンスファイル管理機能を使用する場合の，コンテンツの格納先ディレクトリの運用方法，およびファイルシステムのバックアップとリストアについて説明します。

＜この節の構成＞

6.3.1　コンテンツの格納先ディレクトリの運用方法

6.3.2　ファイルシステムのバックアップとリストア

6.3.1　コンテンツの格納先ディレクトリの運用方法

コンテンツの格納先ディレクトリの運用方法として，コンテンツロケーションとコンテンツ格納先ベースパスの管理について説明します。

コンテンツの格納先ディレクトリは，コンテンツ格納先ベースパスとコンテンツロケーションから構成されます。コンテンツの格納先ディレクトリの例を次の図に示します。なお，ここではWindowsの場合を例としています。

図6-3　コンテンツの格納先ディレクトリの例（文書空間構成定義ファイルのReferenceStorageModeエントリにOriginを指定した場合）

この例は，コンテンツ格納先ベースパスにディレクトリ「¥¥Server1¥ContentArea」を設定し，またコンテンツ格納先パスにディレクトリ「USER01」を設定して，コンテンツ「sample.doc」が格納された場合を示しています。

コンテンツの格納先ディレクトリの例を次の図に示します。

図6-4　コンテンツの格納先ディレクトリの例（文書空間構成定義ファイルのReferenceStorageModeエントリにDivideを指定した場合）

コンテンツロケーションの管理
コンテンツロケーションとして，コンテンツ格納先ベースパスからの相対パスがデータベースに登録されます。コンテンツロケーションはデータベースで管理されるため，コンテンツロケーションのディレクトリ構成を変更しないでください。
なお，DocumentBrokerを運用するマシンの移行などによってコンテンツの格納先を変更するときは，コンテンツロケーションのディレクトリ構成は変更しないでください。コンテンツロケーションのディレクトリ構成を変更すると，ファイルシステム上のコンテンツ格納先とデータベースで管理するコンテンツロケーションが不一致となり，リファレンスファイル文書を操作したときエラーになります。

コンテンツ格納先ベースパスの管理
コンテンツ格納先ベースパスは，ユーザが管理するディレクトリです。そのため，コンテンツ格納先ベースパスを変更しても，データベースで管理されるコンテンツロケーションと不一致にならないので，ユーザがコンテンツ格納先ベースパスを変更できます。ただし，ファイルシステムのディスクの移行などでコンテンツ格納先ベースパスを変更する場合は，移行先のディスクでも，コンテンツロケーションを移行前と同様のディレクトリ構成にする必要があります。このため，移行前のコンテンツロケーションのディレクトリ構成を移行後のコンテンツ格納先にコピーしてください。
なお，ファイルシステムのディスク移行時などに，コンテンツの格納先ベースパスを誤って変更した場合，またはコンテンツ格納先ベースパスを誤って指定した場合，ファイルシステム上のコンテンツ格納先とデータベースで管理するコンテンツロケーションが不一致となり，リファレンスファイル文書を操作したときエラーになります。

6.3.2　ファイルシステムのバックアップとリストア

コンテンツを格納するファイルシステムのバックアップおよびリストアは，OSで提供されるシステムツールなどを利用して実施します。

ファイルシステムのバックアップおよびリストアは，必ずDocumentBrokerの停止中に実施してください。また，必ずデータベースのバックアップおよびリストアと同期して実施する必要があります。データベースのバックアップとリストアについては，「6.1.1　バックアップとリストア」を参照してください。

6.4　障害対策

この節では，障害が発生した時にDocumentBrokerが出力する情報，障害が発生した場合に考えられる要因とその対処方法について説明します。

なお，トランザクションの処理など，データベースシステムの機能に依存している対処方法については，マニュアル「HiRDB　システム運用ガイド」，またはマニュアル「HiRDB　UAP開発ガイド」を参照してください。

＜この節の構成＞

6.4.1　障害が発生した時にDocumentBrokerが出力する情報

6.4.2　障害要因の特定

6.4.3　障害への対処

6.4.4　IT Report Utilityを利用した保守情報の採取

6.4.1　障害が発生した時にDocumentBrokerが出力する情報

ここでは，障害が発生した場合に，DocumentBrokerが出力する情報について説明します。

＜この項の構成＞

(1)　ログの種類

(1)　ログの種類

DocumentBrokerが運用中に出力するログの種類を次の表に示します。

表6-1　ログの種類と用途

ログの種類 | 用途
メッセージログ | 稼働中のインフォメーション情報や障害時のエラー情報を出力します。アプリケーションおよびコマンドの稼働監視の情報として使用します。メッセージの詳細については，マニュアル「DocumentBroker Version 5　メッセージ」を参照してください。
トレース | システムでトラブルが発生した場合の障害保守情報を出力します。保守員が障害解析用に使用します。
アプリケーショントレース | DocumentBrokerクラスライブラリを使用したアプリケーションを開発・運用する上で，必要な情報を出力します。
アプリケーションエラーログ | DocumentBrokerクラスライブラリを使用したアプリケーションで，エラーが発生した場合にエラーの内容を出力します。

トラブルシューティングに必要な資料は，運用を開始する前に資料取得のための設定をしておく必要があります。各ログの出力方法や出力内容については，動作環境定義ファイルで設定できます。動作環境定義ファイルについては，「4.2　動作環境定義ファイル（docbconf.properties）」を参照してください。

(a)　出力先ディレクトリ

ログは，動作環境定義ファイルで指定したディレクトリに出力されます。デフォルトの出力先ディレクトリは，次のとおりです。

実行環境ディレクトリ/log

(b)　出力ファイル名

トレースファイルの出力ファイル名は，環境変数に指定できません。次の表に示すファイル名で出力されます。

表6-2　ログの出力先とファイル名

種別
コンポーネント
ログ出力先およびファイル名

メッセージログ
ライブラリ
UNIXの場合：<LogPath>/dbjmessage_x.log
Windowsの場合：<LogPath>¥dbjmessage_x.log

コマンド
UNIXの場合：<LogPath>/<コマンド名>_message_x.log
Windowsの場合：<LogPath>¥<コマンド名>_message_x.log

トレース
ライブラリ
UNIXの場合：<LogPath>/dbjtrace_x.log
Windowsの場合：<LogPath>¥dbjtrace_x.log

コマンド
UNIXの場合：/<LogPath>/<コマンド名>_trace_x.log
Windowsの場合：<LogPath>¥<コマンド名>_trace_x.log

アプリケーショントレース
ライブラリ
UNIXの場合：次のどちらかとなります。

<APTracePath>/dbjaptrace_x.log

<APTracePath>/<tracePrefix>_x.log

Windowsの場合：次のどちらかとなります。

<APTracePath>¥dbjaptrace_x.log

<APTracePath>¥<tracePrefix>_x.log

アプリケーションエラーログ
ライブラリ
UNIXの場合：次のどちらかとなります。

<APTracePath>/dbjaptraceerr_x.log

<APTracePath>/<tracePrefix>err_x.log

Windowsの場合：次のどちらかとなります。

<APTracePath>¥dbjaptraceerr_x.log

<APTracePath>¥<tracePrefix>err_x.log

注意：「x」は面の番号（0から面数（最大15）まで）です。

6.4.2　障害要因の特定

障害要因の特定方法について説明します。

障害が発生した場合，その対処方法を決めるためには，その障害の要因を特定する必要があります。障害の要因を特定するには，次の項目を確認してください。

＜この項の構成＞

(1)　エラーメッセージの確認

(2)　ユーザの操作内容の確認

(1)　エラーメッセージの確認

障害の要因を特定するために，まず，DocumentBrokerが作成するメッセージログファイルにエラーメッセージが出力されているかどうかを確認します。

メッセージログファイルの出力先については，「6.4.1(1)　ログの種類」を参照してください。

エラーメッセージが出力されている場合，エラーメッセージのメッセージIDからエラーが発生しているプログラム，障害の要因が特定できます。

(2)　ユーザの操作内容の確認

障害が発生したときに実行していた操作の詳細な手順を確認します。正しい操作手順をしていないことが要因で，障害が発生している場合が考えられます。操作手順を確認することで，障害の要因がある程度特定できます。

6.4.3　障害への対処

障害への対処方法について説明します。

障害要因が判明したら，適切な対処方法で障害の要因を取り除きます。エラーメッセージが出力されている場合，メッセージの対処に従って対処してください。サポートサービスへの連絡が必要になる障害の場合，または対処方法が不明の障害の場合，必要な障害情報を取得して，サポートサービスに連絡し，その指示に従って対処してください。

6.4.4　IT Report Utilityを利用した保守情報の採取

IT Report Utilityを利用した保守情報の採取方法について説明します。

＜この項の構成＞

(1)　使用方法

(2)　採取できる資料一覧

(3)　注意事項

(1)　使用方法

IT Report Utilityの次のコマンド(systoru)を使用して保守情報を採取します。

systoru -t failure -g "DocumentBroker" -g "os"

(2)　採取できる資料一覧

IT Report Utilityを利用して採取する保守情報は，次のとおりです。

OS資料（syslogファイル（UNIXの場合）またはイベントログ（Windowsの場合）など）

DocumentBrokerの実行環境ディレクトリ（環境変数「DOCB_CONF_DIR」）の内容

(3)　注意事項

このコマンドを実行する前に，IT Report Utilityをインストールしておいてください。IT Report Utilityのインストール方法，詳細な使用方法については，IT Report Utilityが提供しているドキュメント「IT Report Utility（Windows版）の機能」または「システム情報採取ツール（Linux版）の機能」を参照してください。

このコマンドを実行する前に，DocumentBrokerの実行環境ディレクトリを環境変数「DOCB_CONF_DIR」に指定してください。

このコマンドは，DocumentBrokerのシステム管理者が実行してください。

動作環境定義ファイルで各種ログおよびトレースの出力先ディレクトリに実行環境ディレクトリの配下以外を指定している場合，各種ログおよびトレースの採取はできません。

DocumentBrokerの実行環境ディレクトリは300メガバイトを超える場合があります。このため，IT Report Utilityの資料採取で消費するディスク容量の上限値「SYSTORU_MAX_OUTPUT_DATA_SIZE」には，716800（700メガバイト）以上の指定を推奨します。設定方法の詳細についてはIT Report Utilityの提供するドキュメントを参照してください。

7.　コマンドリファレンス

この章では，DocumentBrokerで使用するコマンドの種類と文法について説明します。

＜この章の構成＞

7.1　コマンドの種類

7.2　コマンドの形式

7.3　コマンドの文法

7.4　コマンドが出力するファイル

7.1　コマンドの種類

この節では，DocumentBrokerで使用するコマンドの種類について説明します。

注意事項

コマンドを実行する場合，次の点に注意してください。

コマンドを実行できるユーザは，システム管理者だけです。

コマンドを実行する前に，データベース情報ファイルおよびコマンド用環境設定ファイルを設定しておいてください。

コマンドを実行する前に，DocumentBrokerの実行環境ディレクトリを環境変数「DOCB_CONF_DIR」に指定してください。

コマンドを実行する前に，データベースを起動しておいてください。

格納先

これらのコマンドを実行する場合，以下に格納されているコマンドを使用してください。

UNIXの場合

/opt/DocBroker/Platform/bin

/opt/DocBroker/Library/bin※

Windowsの場合

<インストールディレクトリ>¥DocBroker¥Platform¥bin

<インストールディレクトリ>¥DocBroker¥Developer¥bin

<インストールディレクトリ>¥DocBroker¥Library¥bin※

注※　DocumentBroker Runtime Libraryの場合に使用できるのは，dbjregenvidコマンドだけです。

＜この節の構成＞

7.1.1　コマンド一覧

7.1.1　コマンド一覧

コマンドの一覧を次の表に示します。

表7-1　コマンド一覧

種別 | コマンド | 機能
データベース運用 | dbjinitmeta | メタ情報の初期設定
dbjaddmeta | メタ情報の追加
dbjcrtsql | DocumentBroker用データベース定義文の作成
dbjdelmeta | メタ情報の削除
dbjregenvid | DocumentBroker実行環境の情報の登録
dbjchgmeta | メタ情報の変更
dbjchgusrid | ユーザ／グループの一括変更
一覧出力 | dbjlsfldr | フォルダ一覧の出力
dbjlsdoc | 文書一覧の出力
その他 | dbjprintmeta | 登録済みメタ情報の出力
dbjgenguid | GUIDの生成

7.2　コマンドの形式

この節では，コマンドの入力形式，使用方法および注意事項について説明します。

＜この節の構成＞

(1)　入力形式

(2)　入出力

(3)　コマンドの実行可能ファイルに対するアクセス権限

(1)　入力形式

コマンドの入力形式を次に示します。

コマンド名称〔オプション…〕

(a)　コマンド名

コマンド名は，実行するコマンドのファイル名です。

(b)　オプション

オプションの入力形式の規則を次に示します。なお，説明文で使用する「$」はコマンドプロンプト，「cmd」はコマンド名を表します。

オプションの形式

オプションはマイナス記号で始まる文字列で，次に示すように，引数を取らないか，または1個の引数を取ります。

形式1：-オプションフラグ

形式2：-オプションフラグ＜空白またはタブ＞フラグ引数

（凡例）

オプションフラグ：1文字の英数字で，英大文字・小文字は区別される

フラグ引数：オプションフラグに対する引数

オプションの指定規則

フラグ引数を取らないオプションフラグは，一つのマイナス記号のあとにまとめて指定できません。
誤った指定例：$ cmd -abc
正しい指定例：$ cmd -a -b -c

フラグ引数を必要とするオプションフラグのフラグ引数は省略できません。
例えば，オプションフラグ-aがフラグ引数を取る場合，次のように入力すると-bはフラグ引数とみなされます。
$ cmd -a -b

オプションフラグとフラグ引数の間には空白またはタブが必要です。
誤った指定例：$ cmd -afile
正しい指定例：$ cmd -a file

同じオプションフラグを2回以上指定できません。例えば，「$ cmd -a 1 -a 2」とは入力できません。

マイナス記号だけのオプションは入力できません。例えば，「$ cmd -」と入力すると「-」はコマンド引数とみなされます。

文書空間で使用する文字コード種別がUTF-8の場合に，オプションのフラグ引数としてファイルのパスを指定するとき，パスは印刷可能なASCIIコードで記述します。

(2)　入出力

(a)　入力

入力は，すべてコマンドのオプション，引数の並びです。

(b)　出力

コマンド処理が正常に終了した場合の出力は，すべて標準出力に対して実行します。また，終了コードの一覧を次の表に示します。

表7-2　終了コード一覧

終了コード | 意味
0 | 正常終了
1 | 警告つき正常終了
2 | 引数エラー
それ以外 | そのほかのエラー

コマンド処理がエラーになった場合（終了コードが「0」以外）は，メッセージをすべて標準エラー出力に出力します。引数エラーになった場合（終了コードが「2」）は，標準エラー出力にコマンドの使用方法（USAGE）を出力します。出力形式は次のとおりです。

出力形式

Usage:xxxx yyyy

xxxx：コマンド名称が出力されます。

yyyy：コマンドの指定形式が表示されます。

出力例

Usage:command -a -b option_arg_1 〔-c〕〔-d option_arg_2〕…

　　　 {-e | -f option_arg_3}

(3)　コマンドの実行可能ファイルに対するアクセス権限

コマンドの実行可能ファイルにアクセスしてコマンドを実行できるユーザはシステム管理者だけです。

7.3　コマンドの文法

この節では，コマンドの文法について説明します。なお，各コマンドは，アルファベット順に説明します。

コマンドは，DocumentBrokerの停止中に実行してください。

使用できるデータベースシステムはHiRDBです。したがって，コマンドの文法はHiRDBを使用する場合の記述形式になっています。

＜この節の構成＞

dbjaddmeta（メタ情報の追加）

dbjchgmeta（メタ情報の変更）

dbjcrtsql（DocumentBroker用データベース定義文の作成）

dbjdelmeta（メタ情報の削除）

dbjgenguid（GUIDの生成）

dbjinitmeta（メタ情報の初期設定）

dbjprintmeta（登録済みメタ情報の出力）

dbjregenvid（DocumentBroker実行環境の情報の登録）

dbjchgusrid（ユーザ／グループの一括変更）

dbjlsfldr（フォルダ一覧の出力）

dbjlsdoc（文書一覧の出力）

dbjaddmeta（メタ情報の追加）

機能

引数に指定した定義情報ファイルの内容を基に，データベース中のメタ情報にユーザが定義したサブクラスとプロパティを追加します。サブクラスまたはプロパティを追加した場合は，自動的に動作環境メタ情報ファイルも更新されます。

データベースに対するデータベース定義後に，このコマンドでサブクラスやプロパティを追加した場合，データベース定義文を出力し，データベース定義をする必要があります。

形式

dbjaddmeta  
             -f 格納先ディレクトリ名
           〔-o データベース定義文格納ファイル
           〔-i インデクス情報ファイル名〕
           〔-r RDエリア定義情報ファイル名〕
            〕

オプション

-f　格納先ディレクトリ名

定義情報ファイルを格納したディレクトリ名を絶対パスで指定します。定義情報ファイルについては，「4.9　定義情報ファイル」を参照してください。

-o　データベース定義文格納ファイル

作成したデータベース定義文を格納するファイルを絶対パスで指定します。このオプションを指定した場合，定義情報ファイルの内容によって，データベース定義文に出力されるSQL文が異なります。なお，出力先にファイルが存在する場合は，上書きされます。

サブクラスを追加する場合
定義系SQL「CREATE TABLE」文がデータベース定義文に出力されます。

追加済みのクラスにプロパティを追加する場合
定義系SQL「ALTER TABLE」文がデータベース定義文に出力されます。

-i　インデクス情報ファイル名

-oオプションを指定した場合だけ指定できるオプションです。

追加するプロパティに対して定義系SQL「CREATE INDEX」文（インデクス定義文）を出力する場合に，インデクス情報ファイル名を絶対パスで指定します。インデクス情報ファイルについては，「4.11　インデクス情報ファイル」を参照してください。

-r　RDエリア定義情報ファイル名

-oオプションを指定した場合だけ指定できるオプションです。

RDエリア定義情報ファイル名を絶対パスで指定します。

-oオプションで指定したデータベース定義文格納ファイル中のRDエリア名を，指定したRDエリア定義情報ファイルの情報に従って出力する場合に指定します。RDエリア定義情報ファイルについては，「4.10　RDエリア定義情報ファイル」を参照してください。

注意事項

このコマンドを実行する前には，dbjinitmetaコマンドでメタ情報をデータベースに登録しておく必要があります。

データベースの初期設定をする場合は，dbjcrtsqlコマンドを実行する前に，このコマンドを実行してください。

このコマンドはデータベース自身の定義であるエリアの定義は実行しません。必要なエリアの定義は，出力されるデータベース定義文に追加してください。

このコマンドで追加した定義を削除するには，コマンド実行前に取得したデータベースのバックアップをリストアするか，メタ情報の削除コマンド（dbjdelmeta）を実行してください。コマンドを実行する前にはデータベースのバックアップを取得してください。

次に示す場合は，インデクス格納RDエリアの名称として「USR_INDEX_AREA」が出力されます。

-iオプションにインデクス情報ファイル名を指定し，-rオプションを省略してこのコマンドを実行した場合

RDエリア定義情報ファイルで種別「IndexArea」に，インデクス情報ファイルに記述した項目に対応するRDエリアの定義を記述していない状態で，-iオプションにインデクス情報ファイル名を指定し，-rオプションにRDエリア定義情報ファイル名を指定してこのコマンドを実行した場合

実行結果であるデータベース定義文に対してエリア定義などの必要な項目を追加，修正してからデータベースを作成してください。ただし，-rオプションを指定した場合は，RDエリア定義情報ファイルの指定に従って，RDエリア名が出力されます。

一度このコマンドを実行した環境で，再度メタ情報の追加を行う場合，新たに追加するメタ情報だけを記述した定義情報ファイルを使用する必要があります。

dbjchgmeta（メタ情報の変更）

機能

メタ情報の内容を変更します。変更できる内容を次に示します。

文字列型プロパティの最大長を大きくする。

繰り返し列の最大要素数を大きくする。

形式

dbjchgmeta  -p プロパティ名
          {-l 最大長 | -e 最大要素数}
           -o データベース定義文格納ファイル名

オプション

-p　プロパティ名

変更するプロパティ名を指定します。

-l　最大長

変更後の文字列の最大長を指定します。指定できる範囲はデータベースに依存します。

-e　最大要素数

変更後の繰り返し列の最大要素数を指定します。2～30,000の範囲の10進数の値で指定してください。

-o　データベース定義文格納ファイル名

データベース定義文を格納するファイルを，絶対パスで指定します。なお，出力先にファイルが存在する場合は，上書きされます。

注意事項

文字列プロパティの最大長を変更できるのは，ユーザプロパティだけです。

このコマンドの実行で変更した値を，このコマンドの再実行により小さい値に変更することはできません。コマンドを実行する前に，データベースのバックアップを取得しておいてください。

dbjcrtsql（DocumentBroker用データベース定義文の作成）

機能

データベースに登録されたメタ情報を基に，DocumentBrokerのデータベースを初期設定するために必要な以下のデータベース定義文を作成します。

システムクラスのテーブル定義文

ユーザクラスのテーブル定義文

システムプロパティに対するインデクス定義文

ユーザプロパティに対するインデクス定義文（-iオプション指定時）

形式

dbjcrtsql  -o データベース定義文格納ファイル名
        〔-i インデクス情報ファイル名〕
        〔-r RDエリア定義情報ファイル名〕

オプション

-o　データベース定義文格納ファイル名

作成したデータベース定義文を格納するファイルを絶対パスで指定します。なお，出力先にファイルが存在する場合は，上書きされます。

-i　インデクス情報ファイル名

インデクス定義をするための情報を記述したファイル名を絶対パスで指定します。ユーザが追加したプロパティに対して定義系SQL「CREATE INDEX」文（インデクス定義文）を出力する場合に指定します。インデクス情報ファイルについては，「4.11　インデクス情報ファイル」を参照してください。

-r　RDエリア定義情報ファイル名

RDエリア定義情報ファイル名を絶対パスで指定します。

-oオプションで指定したデータベース定義文格納ファイル中のRDエリア名を，指定したRDエリア定義情報ファイルの情報に従って出力する場合に指定します。RDエリア定義情報ファイルについては，「4.10　RDエリア定義情報ファイル」を参照してください。

注意事項

このコマンドを実行する前には，dbjinitmetaコマンドでメタ情報をデータベースに登録しておく必要があります。

このコマンドは，データベース自身の定義であるエリア定義は実行しません。必要なエリアの定義は，出力されるデータベース定義文に追加してください。

次に示す場合は，インデクス格納RDエリアの名称として「USR_INDEX_AREA」が出力されます。

-iオプションにインデクス情報ファイル名を指定し，-rオプションを省略してこのコマンドを実行した場合

RDエリア定義情報ファイルで種別「IndexArea」に，インデクス情報ファイルに記述した項目に対応するRDエリアの定義を記述していない状態で，-iオプションにインデクス情報ファイル名を指定し，-rオプションにRDエリア定義情報ファイル名を指定してこのコマンドを実行した場合

実行結果であるデータベース定義文に対してエリア定義などの必要な項目を追加，修正してからデータベースを作成してください。ただし，-rオプションを指定した場合は，RDエリア定義情報ファイルの指定に従って，RDエリア名が出力されます。

dbjdelmeta（メタ情報の削除）

機能

dbjaddmetaコマンドで追加したサブクラスやプロパティを削除します。

ユーザが追加したサブクラスを削除する場合は，-rオプションを指定します。ユーザが追加したプロパティを削除する場合は，-pオプションと-qオプションを指定します。ただし，全文検索用のプロパティは削除できません。

形式

dbjdelmeta  { -r サブクラス名 | -p プロパティ名 -q クラス名 }

オプション

-r　サブクラス名

サブクラスを削除する場合に，サブクラス名を指定します。

-p　プロパティ名

プロパティを削除する場合に，プロパティ名を指定します。

-q　クラス名

-pオプションで指定したプロパティを持つクラスの，クラス名を指定します。

注意事項

指定されたサブクラスがedmClass_Structクラスのサブクラスの場合，VariableArray型プロパティから参照されていないときだけ削除できます。

このコマンドを実行すると，データベースに登録されているメタ情報は更新されますが，データベース定義は変更されません。

dbjgenguid（GUIDの生成）

機能

文書空間識別子，クラスID，プロパティIDに使用するGUIDを生成します。

形式

dbjgenguid 〔-n 生成するGUIDの数〕 〔-o 出力ファイル名〕

オプション

-n　生成するGUIDの数

生成するGUIDの数を指定します。1～256の範囲の10進数の値で指定してください。このオプションの指定を省略した場合，1つのGUIDを生成します。

-o　出力ファイル名

生成したGUIDを格納するファイル名を，絶対パスで指定します。このオプションの指定を省略した場合，標準出力に出力します。なお，出力先にファイルが存在する場合は，上書きされます。

実行例

-nオプションを指定しないで実行した場合の，出力例を次に示します。

KMBJ20001-I dbjgenguid start.
aa2e7f2f-d4e9-4a5a-9c20-1d87a882556c
KMBJ20002-I dbjgenguid ended.

-nオプションに2を指定して実行した場合の，出力例を次に示します。

KMBJ20001-I dbjgenguid start.
f3ba558e-bd73-4e6b-9aad-1da72f833039
7ea15529-899d-4372-88b0-bb49afc47170
KMBJ20002-I dbjgenguid ended.

dbjinitmeta（メタ情報の初期設定）

機能

DocumentBrokerのメタ情報を表にして，文書空間構成定義ファイルで指定されているデータベースに登録します。

形式

dbjinitmeta  〔-d〔-e〕〕 〔-f 格納先ディレクトリ名〕

オプション

-d

メタ情報をデータベースに再登録する場合に指定します。このオプションを指定すると，既存のメタ情報をデータベースから削除して，新規にメタ情報を登録します。

-e

複数の実行環境から同一の文書空間にアクセスしている場合，それらの実行環境の情報をすべて削除するときに指定します。このオプションを指定できるのは，実行環境識別子が0の実行環境だけです。

このオプションを指定すると，登録されている実行環境の情報が削除されるため，複数の実行環境から同一の文書空間にアクセスする実行環境を新規に登録し直す必要があります。

-f　格納先ディレクトリ名

メタ情報ファイルを格納したディレクトリ名を，絶対パスで指定します。

このオプションは，dbjprintmetaコマンドで出力したメタ情報ファイルを登録する場合に使用します。

注意事項

-dオプションを指定してこのコマンドを実行した場合は，必ずdbjcrtsqlコマンドを実行して，出力されたデータベース定義文を基に表を再定義してください。

文字コード種別を変更する場合，事前にデータベースの文字コード種別を変更する必要があります。また，データベースで文字コード種別を変更する場合は，データベースの初期化（RDエリアの再作成）を行う必要があります。

dbjprintmeta（登録済みメタ情報の出力）

機能

データベースに登録されているメタ情報をcsv形式で出力します。出力するファイルを次に示します。

edmsys.csv

edmclass.csv

edmclassprop.csv

edmprop.csv

形式

dbjprintmeta  〔-v〕 〔-l 出力先ディレクトリ名〕

オプション

-v

DocumentBroker Version 3以前のメタ情報を基にメタ情報を出力します。このオプションは，DocumentBroker Version 3からDocumentBroker Version 5に移行する場合に使用します。

-l　出力先ディレクトリ名

メタ情報ファイルの出力先を絶対パスで指定します。このオプションの指定を省略した場合は，実行環境ディレクトリ/env_info下に出力します。なお，出力先に同名のファイルが存在する場合は，上書きされます。

dbjregenvid（DocumentBroker実行環境の情報の登録）

機能

DocumentBrokerの実行環境についての情報（実行環境識別子，環境変数「DOCB_CONF_DIR」に指定している実行環境ディレクトリのパス，およびホスト名）をデータベース中の表に登録します。また，登録した実行環境の更新，削除，および登録されている実行環境のファイル出力をします。

なお，このコマンドで登録した実行環境識別子は，該当する実行環境下で作成されるすべてのオブジェクトのOIIDに付加されます。

形式

dbjregenvid  -r 〔-i 実行環境識別子〕　　　　|
            -u  実行環境識別子　　　　　　　|
            -d　　　　　　　　　　　　　　　|
            -l

オプション

-r

DocumentBrokerの実行環境の情報を登録する場合に指定します。

このオプションを指定すると，データベース中の表に実行環境識別子のレコードが挿入（INSERT）されます。

-i　実行環境識別子

登録する実行環境識別子を指定します。1～254の範囲で，10進数の値で指定してください。

このオプションを省略した場合は，1～254の範囲で未使用の識別子のうち，最小値の識別子が自動的に採番されます。

-u　実行環境識別子

実行環境の情報を更新する場合に指定します。実行環境を別のマシンに移動したり，実行環境ディレクトリのパスを変更したりした場合は，-uオプションを指定してこのコマンドを実行してください。

このオプションを指定すると，引数に指定した実行環境識別子に対応するレコードのカラム（環境変数「DOCB_CONF_DIR」に指定している実行環境ディレクトリのパス，およびホスト名）が更新されます。

-d

実行環境を削除する場合に指定します。ただし，このコマンドを実行した実行環境のOIID通番レコードが0件の場合だけ削除できます。

登録されている実行環境の一覧を標準出力に表示する場合に指定します。

-l

登録されている実行環境の一覧を標準出力（UNIX），またはコマンドプロンプト（Windows）に表示する場合に指定します。

実行例

-lオプションを指定して実行した場合の，出力例を次に示します。

ID=0    HOST-NAME=koyuki    ENVDIR=c:¥program files¥hitachi¥docb¥server1
ID=20   HOST-NAME=koyuki    ENVDIR=c:¥program files¥hitachi¥docb¥server2
ID=100  HOST-NAME=Host1     ENVDIR=c:¥program files¥hitachi¥docb100¥server

注意事項

dbjinitmetaコマンドで初期構築した実行環境（実行環境識別子が0）については，-dオプションで削除できません。

一度登録された実行環境識別子は削除・変更できません。ただし，実行環境識別子が0以外の実行環境については，実行環境でオブジェクトを作成していない場合に（実行環境のOIID通番レコードが0件の場合に），-dオプションを指定してこのコマンドを実行することで，実行環境識別子を削除できます。また，実行環境識別子の削除後，-rオプションを指定してこのコマンドを実行することで，実行環境識別子を変更できます。

dbjchgusrid（ユーザ／グループの一括変更）

機能

オブジェクトに設定されているユーザ識別子，グループ識別子，および関連したユーザプロパティを変更情報ファイルに記述した内容に一括で変更します。

一括変更の対象となるクラスを次に示します。

dmaClass_ConfigurationHistory

dmaClass_Container

dmaClass_DocVersion

edmClass_ContainerVersion

edmClass_IndependentPersistence

edmClass_VersionTracedDocVersion

edmClass_VersionTracedComponentDocVersion

dmaClass_DirectContainmentRelationship※1

dmaClass_ReferentialContainmentRelationship※1

edmClass_Relationship※1

edmClass_PublicACL

edmClass_ACL

ユーザが定義したすべてのサブクラス

一括変更の対象となるプロパティを次に示します。

edmProp_OwnerId

edmProp_PrimaryGroupId

edmProp_ACL※2

edmProp_SACL※2

ユーザプロパティ

注※1

一括変更の対象は，ユーザプロパティだけです。

注※2

ACEに設定したユーザ識別子，またはグループ識別子だけが変更されます。パーミッションは変更されません。

形式

dbjchgusrid  {-u ユーザ識別子変更情報ファイル名   |
             -g グループ識別子変更情報ファイル名 |
             -u ユーザ識別子変更情報ファイル名
             -g グループ識別子変更情報ファイル名}
           〔-p プロパティ変更情報ファイル名〕
           〔-t トランザクション件数〕
           〔-c〕
           〔-v〕
             -o 出力ディレクトリ

オプション

-u　ユーザ識別子変更情報ファイル名

変更するユーザ識別子，および関連したユーザプロパティを記述した変更情報ファイル名を絶対パスで指定します。変更処理後は，実行結果が書き込まれます。

このオプションを省略した場合，ユーザ識別子は変更されません。

-g　グループ識別子変更情報ファイル名

変更するグループ識別子，および関連したユーザプロパティを記述した変更情報ファイル名を絶対パスで指定します。変更処理後は，実行結果が書き込まれます。

このオプションを省略した場合，グループ識別子は変更されません。

-p　プロパティ変更情報ファイル名

変更するユーザプロパティを記述した変更情報ファイル名を，絶対パスで指定します。

このオプションを省略した場合，ユーザプロパティは変更されません。

-t　トランザクション件数

1トランザクションで変更するレコード数を0～4,096の範囲で指定します。

0を指定した場合
変更情報ファイルの行ごとに各クラスのプロパティを順番に，1トランザクションでユーザ，グループ，またはプロパティを対象として変更します。

1以上を指定した場合
変更情報ファイルの行ごとに各クラスのプロパティを順番に，指定された件数ずつユーザ，グループ，またはプロパティを変更します。

指定できる範囲以外の値を指定した場合は，エラーとなります。このオプションを省略した場合は，「200」が仮定されます。

-c

ユーザ識別子変更情報ファイル，グループ識別子変更情報ファイル，およびプロパティ変更情報ファイルが正しく記述されているかをチェックする場合に指定します。次の項目がチェックされます。なお，このオプションを指定した場合，変更処理は実行されません。

ファイルが正しく記述されているか。

クラス，およびプロパティが文書空間に存在しているか。

変更前の識別子，および変更後の識別子が指定できる値か。
次の内容を確認します。
･型が一致しているか。
･最大長を超えていないか。

対象となるクラス，プロパティに対応する表，および列がデータベースに存在するかどうかのチェックは行いません。

-v　

変更情報ファイルに指定されたユーザ識別子，グループ識別子の変更を1行完了するごとに，メッセージを出力する場合に指定します。次のメッセージが出力されます。

KMBJ20701-I（ユーザ変更の完了）

KMBJ20702-I（グループ変更の完了）

このオプションを省略した場合は，すべての処理が完了してからメッセージを出力します。

-o　出力ディレクトリ

指定した変更情報ファイルのバックアップファイルを格納するディレクトリを絶対パスで指定します。次のファイルが格納されます。

ユーザ識別子変更情報バックアップファイル（-uオプションを指定した場合）

グループ識別子変更情報バックアップファイル（-gオプションを指定した場合）

プロパティ変更情報バックアップファイル（-pオプションを指定した場合）

チェックアウト一覧出力ファイル（チェックアウト中のオブジェクトが存在した場合）

各ファイルのファイル名と出力形式を次に示します。

表7-3　バックアップファイルのファイル名と出力形式

バックアップファイル名 | ファイル名 | 出力形式
ユーザ識別子変更情報バックアップファイル | dbjchg_u_<YYYYMMDDhhmmssxxx>.log | ユーザ識別子変更情報バックアップファイルと同じ形式です。
グループ識別子変更情報バックアップファイル | dbjchg_g_<YYYYMMDDhhmmssxxx>.log | グループ識別子変更情報バックアップファイルと同じ形式です。
プロパティ変更情報バックアップファイル | dbjchg_p_<YYYYMMDDhhmmssxxx>.log | プロパティ変更情報バックアップファイルと同じ形式です。
チェックアウト一覧出力ファイル | dbjcolist_<YYYYMMDDhhmmssxxx>.log | 下記の「チェックアウト一覧出力ファイルの出力形式」を参照してください。

（凡例）

＜YYYY＞：西暦年号

＜MM＞：月

＜DD＞：日

＜hh＞：時

＜mm＞：分

＜ss＞：秒

＜xxx＞：ミリ秒

チェックアウト一覧出力ファイルの出力形式

チェックアウト一覧出力ファイルの出力形式を次に示します。バージョン付き文書のOIIDが出力されます。

dma:///<system id>/<docspace id>/<object id>
dma:///<system id>/<docspace id>/<object id>
・
・

注意事項

このコマンドを実行する前に，次の項目を実行しておいてください。

チェックアウト中のオブジェクトが存在しないことを確認する。

データベースのバックアップを取得する。

他のアプリケーションを停止する。

このコマンドの実行中にエラーが発生し処理が終了した場合は，データベースの内容が不整合となります。次の方法で回復してください。

バックアップからデータベースを回復する。

エラーの要因を取り除いてから一括変更完了のメッセージが出力されるまで，同じオプションを指定して，コマンドを再実行する。
この場合，引数で指定した変更情報ファイルは変更しないでください。なお，メッセージ「KMBJ20710-E」が出力された場合は，バックアップからデータを復旧してください。

チェックアウト中のオブジェクトが存在する場合，チェックアウト一覧出力ファイルを出力して，警告つき正常終了します。一括変更処理は実行されません。

変更対象のオブジェクト数が多い場合は，処理に時間がかかることがあります。

このコマンドを実行中にキャンセルした場合は，バックアップからデータベースを回復してください。

変更情報ファイルに有効なデータがない場合，バックアップファイルは作成されません。

dbjlsfldr（フォルダ一覧の出力）

機能

指定されたフォルダのリンク先（直接型リンク）フォルダのパス情報，文書数，プロパティ情報をCSV形式で出力します。出力内容については，「7.4.1　dbjlsfldrコマンドが出力するファイル」を参照してください。

直接型リンクでフォルダに包含されているフォルダの情報を再帰的に出力します。

形式

dbjlsfldr   -f {フォルダのOIID | フォルダのクラス名}
           -p プロパティ名
           -o 結果出力ディレクトリ名

オプション

-f　{フォルダのOIID | フォルダのクラス名}

フォルダのOIIDまたはフォルダのクラス名を指定します。

フォルダのOIIDを指定した場合，指定したフォルダに包含されているフォルダの情報を再帰的に出力します。

フォルダのクラス名を指定した場合，指定したクラスに格納されているトップフォルダを起点に，そのトップフォルダに包含されているフォルダの情報を再帰的に出力します。

-p　プロパティ名

フォルダ名を表すユーザプロパティのプロパティ名を指定します。このオプションに指定できるのは，ユーザプロパティだけです。システムプロパティを指定した場合は，エラーとなります。

指定できるプロパティのデータ型は，String型です。

各フォルダクラスで共通のフォルダ名を表すプロパティを指定してください。クラスに指定されたプロパティが存在しない場合，フォルダ名は”(no-data)”と出力されます。指定されたプロパティの値がNULL値の場合，フォルダ名は”(null)”と出力されます。

-o　結果出力ディレクトリ名

結果リストを出力するディレクトリのパスを，絶対パスで指定します。

注意事項

このコマンドを多重実行しないでください。

1つのフォルダ直下に登録（直接型リンク）されているフォルダおよび文書の合計数が100万件を超えるフォルダが出力対象に含まれる場合は，コマンド実行中にフォルダや文書を削除しないでください。100万件を超えるフォルダ直下のフォルダや文書を削除した場合は，正しく情報が出力されないことがあります。フォルダおよび文書の合計数が100万件を超えるフォルダが出力対象に含まれる場合は，Webサーバを停止するなどして，ユーザがフォルダや文書を削除できない状態で，このコマンドを実行してください。

dbjlsdoc（文書一覧の出力）

機能

指定されたフォルダに登録されている文書の一覧を出力します。バージョン付き文書の場合，最新バージョンの情報を出力します。出力する内容については，「7.4.2　dbjlsdocコマンドが出力するファイル」を参照してください。

形式

dbjlsdoc     -ｆ フォルダのOIID
            -o 結果出力ディレクトリ名
          〔-p プロパティ名〕
          〔-c {CH | DV}〕
          〔-t プロパティ名,{開始日時,終了日時 |
                             開始日時 |
                            ,終了日時}〕
          〔-s〕

オプション

-f　フォルダのOIID

文書一覧を出力する文書が登録されたフォルダのOIIDを指定します。

-o　結果出力ディレクトリ名

文書一覧の結果を出力するディレクトリ名を，絶対パスで指定します。

-p　プロパティ名

フォルダ名を表すユーザプロパティのプロパティ名を指定します。このオプションに指定できるのは，ユーザプロパティだけです。システムプロパティを指定した場合は，エラーとなります。

指定できるプロパティのデータ型は，String型です。

各フォルダクラスで共通のフォルダ名を表すプロパティを指定してください。クラスに指定されたプロパティが存在しない場合，フォルダ名は”(no-data)”で出力されます。

-c　{CH | DV}

バージョン付き文書の場合，バージョニングオブジェクトとバージョンオブジェクトのどちらのプロパティ情報を出力するかを指定します。

CH：バージョニングオブジェクトのプロパティ情報を出力します。

DV：バージョンオブジェクトのプロパティ情報を出力します。

このオプションを省略した場合はCHが仮定されます。

-t　プロパティ名,{開始日時,終了日時 | 開始日時 | ,終了日時}

日時を指定して文書を出力する場合に指定します。

開始日時および終了日時を「YYYYMMDDhhmmss」の形式で指定します。

YYYY：西暦年号（1970～2038の範囲で指定してください。）

MM：月

DD：日

hh：時

mm：分

ss：秒

開始日時と終了日時の間のカンマ（,）の前後に余分なスペースを指定しないでください。

開始日時と終了日時のどちらかを必ず指定してください。開始日時を省略すると，終了日時以前の文書だけ出力し，終了日時を省略すると，開始日時以降の文書だけ出力します。

プロパティ名には，文書クラスに定義されている日時を表すユーザプロパティのプロパティ名を指定します。

ユーザプロパティだけが指定でき，システムプロパティを指定した場合，エラーとなります。

指定できるプロパティのデータ型は，String型，Integer型です。

String型プロパティが指定された場合，指定された日時の文字列をそのまま条件とします。Integer型プロパティが指定された場合，指定された日時を通算秒に変換した値を条件とします。

各文書クラスで共通の日時を表すプロパティを指定してください。該当する文書クラスに指定されたプロパティが存在しない場合，指定した条件は無視されます。

-s

このオプションを指定した場合，直接型リンクされているフォルダに格納されている文書も再帰的に出力します。

このオプションを指定しなかった場合，直接型リンクされているフォルダに格納されている文書は出力しません。

注意事項

このコマンドを多重実行しないでください。

1つのフォルダ直下に登録（直接型リンク）されているフォルダおよび文書の合計数が100万件を超えるフォルダが出力対象に含まれる場合は，コマンド実行中にフォルダや文書を削除しないでください。100万件を超えるフォルダ直下のフォルダや文書を削除した場合は，正しく情報が出力されないことがあります。フォルダおよび文書の合計数が100万件を超えるフォルダが出力対象に含まれる場合は，Webサーバを停止するなどして，ユーザがフォルダや文書を削除できない状態で，このコマンドを実行してください。

7.4　コマンドが出力するファイル

＜この節の構成＞

7.4.1　dbjlsfldrコマンドが出力するファイル

7.4.2　dbjlsdocコマンドが出力するファイル

7.4.1　dbjlsfldrコマンドが出力するファイル

dbjlsfldrコマンドを実行すると，次のファイルが出力されます。

フォルダパス情報ファイル

フォルダプロパティ情報ファイル

出力形式

フォルダパス情報ファイルの出力形式を次に示します。

1フォルダの情報が1行（レコード）で出力されます。CSV形式で出力されます。

各項目は，半角のコンマ「,」で区切って出力されます。

各項目の値は，ダブルクォーテーション（"）で囲んで出力されます。項目内にダブルクォーテーション（"）を含む場合は，ダブルクォーテーションが二つ重ねて出力されます。

文書空間の文字コードで出力されます。

それぞれのファイルの詳細を次に示します。

＜この項の構成＞

(1)　フォルダパス情報ファイル

(2)　フォルダプロパティ情報ファイル

(1)　フォルダパス情報ファイル

(a)　ファイル名

ファイル名は「dbjlsfldr_<YYYYMMDDhhmmssxxx>.csv」の形式で出力されます。

＜YYYY＞：西暦年号

＜MM＞：月

＜DD＞：日

＜hh＞：時

＜mm＞：分

＜ss＞：秒

＜xxx＞：ミリ秒

(b)　出力内容

フォルダパス情報ファイルの出力内容を次に示します。

表7-4　フォルダパス情報ファイルの出力内容

項番 | 出力情報 | 説明
1 | フォルダOIID | フォルダのOIIDが出力されます。
2 | フォルダパス | フォルダの階層がフォルダパスで出力されます。フォルダパスは，フォルダを「/」で区切って出力されます。
3 | 文書数 | フォルダにリンク（直接型リンク）されている文書数が出力されます。

(c)　出力例

フォルダパス情報ファイルの出力例を次に示します。

#OIID,フォルダパス,文書数
"dma:///07a17522-a626-…0000000101​","フォルダ01","0"
"dma:///07a17522-a626-…0000000102​","フォルダ01/フォルダ02","100"
"dma:///07a17522-a626-…0000000105​","フォルダ01/フォルダ02/フォルダ05","5"
"dma:///07a17522-a626-…0000000103​","フォルダ01/フォルダ03","200"
"dma:///07a17522-a626-…0000000104​","フォルダ01/フォルダ04","10"

(2)　フォルダプロパティ情報ファイル

(a)　ファイル名

ファイル名は「dbjlsfldr_<クラス名>_<YYYYMMDDhhmmssxxx>.csv」の形式で出力されます。

＜クラス名＞：フォルダが所属するクラスのクラス名

＜YYYY＞：西暦年号

＜MM＞：月

＜DD＞：日

＜hh＞：時

＜mm＞：分

＜ss＞：秒

＜xxx＞：ミリ秒

(b)　出力内容

フォルダプロパティ情報ファイルの出力内容を次に示します。

表7-5　フォルダプロパティ情報ファイルの出力内容

項番
出力情報
説明

1
フォルダOIID
フォルダのOIIDが出力されます。

2～ｎ
ユーザプロパティの値
フォルダクラスに定義されているユーザプロパティの値が出力されます。ただし，VariableArray型プロパティおよびFreeWordIndex型プロパティは出力されません。
値がNULL値の場合は，「""」の形式で出力されます。

(c)　出力例

フォルダプロパティ情報ファイルの出力例を次に示します。

#OIID,usrProp_Name, usrProp_CreateTime
"dma:///07a17522-a626-…0000000101​","フォルダ01","2012/12/12 08:00:00"
"dma:///07a17522-a626-…0000000102​","フォルダ02","2012/09/12 08:00:00"
"dma:///07a17522-a626-…0000000103​","フォルダ03","2012/01/16 10:00:00"
"dma:///07a17522-a626-…0000000104​","フォルダ04","2012/06/12 08:00:00"

7.4.2　dbjlsdocコマンドが出力するファイル

dbjlsdocコマンドを実行すると，次のファイルが出力されます。

文書一覧ファイル

出力形式

文書一覧ファイルの出力形式を次に示します。

1文書の情報が1行（レコード）で出力されます。CSV形式で出力されます。

各項目は，半角のコンマ「,」で区切って出力されます。

各項目の値は，ダブルクォーテーション（"）で囲んで出力されます。項目内にダブルクォーテーション（"）を含む場合は，ダブルクォーテーションが二つ重ねて出力されます。

文書空間の文字コードで出力されます。

＜この項の構成＞

(1)　文書一覧ファイル

(1)　文書一覧ファイル

ファイル名は「dbjlsdoc_<クラス名>_<YYYYMMDDhhmmssxxx>.csv」の形式で出力されます。

＜クラス名＞：文書が所属するクラスのクラス名

＜YYYY＞：西暦年号

＜MM＞：月

＜DD＞：日

＜hh＞：時

＜mm＞：分

＜ss＞：秒

＜xxx＞：ミリ秒

(a)　出力内容

文書一覧ファイルの出力内容を次に示します。

表7-6　文書一覧ファイルの出力内容

項番
出力情報
説明

1
文書OIID
文書のOIIDが出力されます。

2
フォルダOIID
文書が格納されているフォルダのOIIDが出力されます。

3
フォルダパス
フォルダパスが出力されます。
フォルダパスは，指定されたフォルダのフォルダ名を先頭に「/」で区切って出力されます。
-pオプションを指定した場合だけ出力されます。
-pオプションを指定しない場合は，「""」の形式で出力されます。

4
レンディション数
文書のレンディション数が出力されます。

5
レンディションタイプ
文書のマスタレンディションのレンディションタイプが出力されます。

6
ファイル名
文書のマスタレンディションのファイル名が出力されます。

7
チェックアウトユーザ識別子
文書がチェックアウトされている場合，チェックアウトユーザ識別子が出力されます。
文書がチェックアウトされていない場合は，「""」の形式で出力されます。

8～n
ユーザプロパティの値
文書クラスに定義されているユーザプロパティの値が出力されます。
ただし，VariableArray型プロパティおよびFreeWordIndex型プロパティは出力されません。
値がNULL値の場合は，「""」の形式で出力されます。

(b)　出力例

出力例を次に示します。

#OIID,フォルダOIID,フォルダパス,レンディション数,レンディションタイプ,ファイル名,チェックアウトユーザ識別子,usrProp_Name,usrProp_CreateTime
"dma:///07a17522-a6-…0000000101​","dma:///07a17522-a6-…0000000201​","","1","application/msword","a.doc","","user01","2012/12/12 12:00:00"
"dma:///07a17522-a6-…0000000102​","dma:///07a17522-a6-…0000000201​","","1","text/plain","b.txt","","user02","2012/12/12 12:00:00"
"dma:///07a17522-a6-…0000000103​","dma:///07a17522-a6-…0000000201​","","1","application/msword","c.doc

付録

＜この付録の構成＞

付録A　システムクラス，システムプロパティおよびデータベース定義の名称規則

付録B　ユーザ作成のアクセスルーチンを使用するためのインターフェースとクラス

付録C　DocumentBroker Version 5へのバージョンアップ手順

付録D　このマニュアルの参考情報

付録E　用語解説

付録A　システムクラス，システムプロパティおよびデータベース定義の名称規則

ここでは，システムクラスおよびシステムプロパティの名前，表識別子，列名，およびデータベース定義の名称規則を示します。

＜この節の構成＞

付録A.1　システムクラスの名称定義の規則

付録A.2　システムプロパティの名称の規則

付録A.3　データベース定義の名称定義の規則

付録A.1　システムクラスの名称定義の規則

システムクラスは，データベース定義での名称定義が決まっています。システムクラスに対応する表識別子を次の表に示します。

表A-1　システムクラスの名称定義の規則

クラス名
表識別子

dmaClass_ConfigurationHistory
dmaClass_ConfigHistory

dmaClass_DirectContainmentRelationship
dmaClass_DCRelationship

dmaClass_ReferentialContainmentRelationship
dmaClass_RCRelationship

dmaClass_Rendition

マスタレンディションの場合

dmaClass_DocVersionの表識別子と同じ

サブレンディションの場合

dmaClass_Rendition

dmaClass_Reservation
dmaClass_VersionSeries

dmaClass_VersionDescription
dmaClass_VerDescription

edmClass_ComponentDocVersion
edmClass_CompoDocVersion

edmClass_IndependentPersistence
edmClass_IndPersistence

edmClass_VersionTraceableContainer
edmClass_VTContainer

edmClass_VersionTraceableContainmentRelationship
edmClass_VTCRelationship

edmClass_VersionTracedComponentDocVersion
edmClass_VTCompoDocVersion

edmClass_VersionTracedDocVersion
edmClass_VTDocVersion

dmaClass_Container

dmaClass_ContentTransfer

dmaClass_DocVersion

dmaClass_VersionSeries

edmClass_BindRelationship

edmClass_ContainerVersion

edmClass_ContentReference

edmClass_OIID

edmClass_PublicACL

edmClass_Relationship

edmClass_VTRelationship

クラス名と同じ

付録A.2　システムプロパティの名称の規則

システムプロパティは，データベース定義での名称定義が決まっています。システムプロパティに対応する表識別子を次の表に示します。

表A-2　システムプロパティの名称定義の規則

プロパティ名
列名

dmaProp_ConfigurationHistory
dmaProp_ConfigHistory

dmaProp_CurrentOfSeriesCount
dmaProp_CurrentOfSeriesCnt

dmaProp_CurrentVersionDescription
dmaProp_CurrntVerDesc

edmProp_ACL

edmProp_ACL_edmProp_Subj

edmProp_ACL_edmProp_Permis

edmProp_HeadVersionDescription
edmProp_HeadVerDescription

edmProp_HeadVTConfigurationHistory
edmProp_HeadVTConfigHistory

dmaProp_PrimaryVersionSeries
dmaProp_PrimVerSeries

edmProp_PrimaryGroupPermission
edmProp_PrimGrpPermission

edmProp_PublicACLIds
edmProp_PACLs_edmProp_ACLElm

edmProp_SACL

edmProp_SACL_edmProp_Subj

edmProp_SACL_edmProp_Permis

edmProp_TailVersionDescription
edmProp_TailVerDescription

edmProp_TailVTConfigurationHistory
edmProp_TailVTConfigHistory

edmProp_VTConfigurationHistory
edmProp_VTConfigHistory

dmaProp_ComponentType

dmaProp_Head

dmaProp_IsCurrentVersion

dmaProp_NewVersion

dmaProp_OIID

dmaProp_Parent

dmaProp_ParentContainer

dmaProp_RenditionType

dmaProp_RetrievalName

dmaProp_Reservation

dmaProp_ReservedFor

dmaProp_Tail

dmaProp_This

dmaProp_Version

dmaProp_VersionSeries

edmProp_ConceptTextIndex

edmProp_ConceptStIndex

edmProp_ConfigurationTable

edmProp_Content

edmProp_ContentIndexStatus

edmProp_ContentLocation

edmProp_DocLength

edmProp_EveryonePermission

edmProp_HeadVTVersionSeries

edmProp_HeadVTMode

edmProp_OwnerId

edmProp_OwnerPermission

edmProp_Permission

edmProp_PrimaryGroupId

edmProp_ReferenceType

edmProp_RelationType

edmProp_RenditionsCount

edmProp_RenditionStatus

edmProp_RequiredClassId

edmProp_StIndex

edmProp_Subject

edmProp_TailVTVersionSeries

edmProp_TailVTMode

edmProp_TextIndex

edmProp_VTMode

edmProp_VTVersionSeries

プロパティ名と同じ

また，システムプロパティは，次に示す規則にも従っています。

規則1

HiRDBの繰り返し列を利用したVariableArray型のプロパティの列名は，「4.9.2　サブクラス名およびプロパティ名をデータベース定義の名称に使用する場合の規則」の内容に従って生成します。

規則2

列名には，_1という番号が付く場合があります。この番号の意味は，列名に対応するプロパティが属するクラスが，何番目のクラスとして表に格納されているかを表します。番号が付くプロパティを持つクラスを次に示します。

マスタdmaClass_Renditionクラス
"_1"が列名の最後に付きます。

dmaClass_Reservationクラス
"_1"が列名の最後に付きます。

詳細については，「4.9.2　サブクラス名およびプロパティ名をデータベース定義の名称に使用する場合の規則」を参照してください。

付録A.3　データベース定義の名称定義の規則

ここでは，表識別子（表の名称として一意に識別できる値），列名，インデクス名（表を検索するためのキーとして列に付けた索引の名称），およびエリア名を定義する場合の規則を説明します。

クラス名やプロパティ名をデータベース定義の名称とする場合の名称定義の規則を次の表に示します。

表A-3　データベース定義の名称定義の環境ごとの規則

データベース定義の名称定義の環境
クラス名やプロパティ名をデータベース定義の名称とする環境

表識別子
サブクラス名

列名
プロパティ名

列名（二つのクラスを一つの表に格納する場合）
プロパティ名
プロパティ名+'_1'

VariableArray用のクラス（別表）
VariableArrayプロパティ名

VariableArray型のプロパティ（別表）
要素プロパティ名

VariableArray型のプロパティ（HiRDBの繰り返し列）
VariableArrayプロパティ名+'_'+要素プロパティ名

インデクス名
（キーが一つ，または指定省略時）
サブクラス名

インデクス名
（キーが複数，または指定省略時）
サブクラス名

サブクラス名で表識別子の制約
あり

プロパティ名で列名の制約
あり

サブクラス名に対応する表識別子とプロパティ名に対応する列名の詳細な規則については，「4.9.2　サブクラス名およびプロパティ名をデータベース定義の名称に使用する場合の規則」を参照してください。インデクス名を定義する場合の詳細な規則については，「4.11.2　インデクス名をデータベース定義の名称に使用する場合の規則」を参照してください。エリア名については，データベース定義の制約に従って定義してください。

付録B　ユーザ作成のアクセスルーチンを使用するためのインターフェースとクラス

ここでは，ユーザ管理システムのアクセスルーチンとしてDocumentBrokerが提供するインターフェースとクラスについて説明します。

ユーザ管理システムのアクセスルーチンは，DocumentBrokerが提供するDbjAuthModuleインターフェースを実装したクラスをユーザが作成し，そのクラス名を文書空間構成定義ファイル（docspace.properties）に指定します。

DocumentBrokerがUOCで提供するインターフェースとクラスの一覧を次の表に示します。

表B-1　DocumentBrokerがUOCで提供するインターフェースとクラス

関数
機能

jp.co.Hitachi.soft.docbroker.auth.DbjAuthModule
ユーザ認証のインターフェースです。
DocumentBrokerのユーザ認証処理時に発行されます。

jp.co.Hitachi.soft.docbroker.auth.DbjAuthUserInfo
ユーザ情報の取得インターフェースです。

jp.co.Hitachi.soft.docbroker.auth.DbjAuthException
UOC例外クラスです。
UOCでエラーが発生した場合に詳細メッセージを取得します。

各インターフェース，およびクラスに属するメソッドの詳細では，次に示す項目について説明します。

機能

メソッドの概要を記述しています。

形式

メソッドの概要を記述しています。/* */内にコメントを記述しています。

機能説明

メソッドの機能の詳細を記述しています。

引数

引数について次のように記述しています。

引数（入力）

指定する値についての説明

引数（出力）

指定する領域の説明

指定した領域に設定される値の説明

引数は，「形式」で記述した文字列です。

（入力）は，ユーザが値を指定することを示しています。

（出力）は，ユーザが，DocumentBrokerによって設定される値を格納する領域を指定することを示しています。

戻り値

メソッドを呼び出して，正常な場合に返される値，およびエラーが発生した場合に返される主な値を列挙しています。

注意事項

メソッドを使用する場合の注意事項を記述しています。

＜この節の構成＞

付録B.1　jp.co.Hitachi.soft.docbroker.auth.DbjAuthModuleインターフェイス

付録B.2　jp.co.Hitachi.soft.docbroker.auth.DbjAuthUserInfoインターフェイス

付録B.3　jp.co.Hitachi.soft.docbroker.auth.DbjAuthExceptionクラス

付録B.1　jp.co.Hitachi.soft.docbroker.auth.DbjAuthModuleインターフェイス

＜この項の構成＞

(1)　initialize

(2)　login

(3)　commit

(4)　abort

(5)　logout

(1)　initialize

機能

DbjAuthModuleインターフェイスの初期化

形式

public void initialize() throws DbjAuthException

機能説明

DbjAuthModuleインターフェイスを初期化します。このメソッドは，DbjFactory0200#getFactoryメソッド実行時に発行されます。

引数

なし。

戻り値

なし。

注意事項

なし。

(2)　login

機能

ユーザとパスワードのチェック

形式

public DbjAuthUserInfo login(
    String                        userName,
    String                        passWord,
    ) throws DbjAuthException

機能説明

引数で指定されたログインユーザ名とパスワードが正しいかどうかをチェックします。このメソッドは，DbjSession#loginメソッド実行時に発行されます。

引数

userName（入力）

DbjSession#loginメソッドで指定したユーザ名を指定します。

passWord（入力）

DbjSession#loginメソッドで指定したパスワードを指定します。

戻り値

DbjAuthUserInfoインターフェイス

注意事項

このメソッドは，マルチスレッド環境で発行されます。そのため，スレッドセーフにしておく必要があります。

(3)　commit

機能

ユーザ認証，およびユーザ情報の取得後の後処理

形式

public void commit() throws DbjAuthException

機能説明

ユーザ認証，およびユーザ情報の取得後の後処理をします。このメソッドは，DbjSession#loginメソッド実行時に発行されます。

引数

なし。

戻り値

なし。

注意事項

このメソッドは，マルチスレッド環境で発行されます。そのため，スレッドセーフにしておく必要があります。

(4)　abort

機能

ユーザ認証でエラーが発生した場合の後処理

形式

public void abort()

機能説明

ユーザ認証でエラーが発生した場合の後処理をします。このメソッドは，DbjAuthExceptionがスローされた場合，ユーザ情報が不正な場合に発行されます。

引数

なし。

戻り値

なし。

注意事項

このメソッドは，マルチスレッド環境で発行されます。そのため，スレッドセーフにしておく必要があります。

(5)　logout

機能

UOCセッションハンドルの破棄

形式

public void abort()

機能説明

UOCセッションハンドルを破棄します。このメソッドは，セッション破棄時にセッション内で1回だけ発行されます。このメソッドを発行したあとで，UOCセッションハンドルを使用してメソッドを発行しないでください。

引数

userInfo（入力）

DbjAuthModule#loginメソッドで指定したユーザ名を指定します。

戻り値

なし。

注意事項

このメソッドは，マルチスレッド環境で発行されます。そのため，スレッドセーフにしておく必要があります。

付録B.2　jp.co.Hitachi.soft.docbroker.auth.DbjAuthUserInfoインターフェイス

＜この項の構成＞

(1)　getUserId

(2)　getPrimaryGroupId

(3)　getGroupIds

(1)　getUserId

機能

ユーザ識別子の取得

形式

public String getUserId() throws DbjAuthException

機能説明

ユーザ識別子を取得します。

引数

なし。

戻り値

なし。

注意事項

このメソッドは，マルチスレッド環境で発行されます。そのため，スレッドセーフにしておく必要があります。

(2)　getPrimaryGroupId

機能

プライマリグループ識別子の取得

形式

public String getPrimaryGroupId() throws DbjAuthException

機能説明

プライマリグループ識別子を取得します。

引数

なし。

戻り値

なし。

注意事項

このメソッドは，マルチスレッド環境で発行されます。そのため，スレッドセーフにしておく必要があります。

(3)　getGroupIds

機能

グループ情報の取得

形式

public Collection<String> getGroupIds() throws DbjAuthException

機能説明

グループ情報を取得します。

引数

なし。

戻り値

なし。

注意事項

このメソッドは，マルチスレッド環境で発行されます。そのため，スレッドセーフにしておく必要があります。

付録B.3　jp.co.Hitachi.soft.docbroker.auth.DbjAuthExceptionクラス

＜この項の構成＞

(1)　DbjAuthException

(2)　getMessage

(1)　DbjAuthException

機能

コンストラクタ

形式

public DbjAuthException extends Exception(
    String                        message

引数

message（入力）

詳細メッセージです。

戻り値

なし。

注意事項

このメソッドは，マルチスレッド環境で発行されます。そのため，スレッドセーフにしておく必要があります。

(2)　getMessage

機能

詳細メッセージの取得

形式

public String getMessage()

引数

なし。

戻り値

詳細メッセージ

注意事項

このメソッドは，マルチスレッド環境で発行されます。そのため，スレッドセーフにしておく必要があります。

付録C　DocumentBroker Version 5へのバージョンアップ手順

ここでは，DocumentBrokerVersion 3以前のバージョンから，DocumentBrokerVersion 5へバージョンアップする手順について説明します。バージョンアップ時には，HiRDBを起動させておいてください。HiRDBの起動方法については，マニュアル「HiRDB　システム運用ガイド」を参照してください。

＜この節の構成＞

(1)　手動による定義などの修正

(2)　メタ情報用のテーブルを定義します

(3)　メタ情報の出力コマンド（dbjprintmeta）を実行します

(4)　メタ情報の初期設定コマンド（dbjinitmeta）を実行します

(5)　実行環境の情報の登録コマンド(dbjregenvid)を実行します

(6)　DocumentBroker Version 3のメタ情報を削除します

(1)　手動による定義などの修正

次の表に示す項目について，手動での定義の修正が必要となります。

表C-1　手動で定義の修正が必要な項目

Version3以前の定義ファイル | 種類 | 設定項目 | エントリ | Version 5のプロパティファイル | プロパティ
DocumentSpace構成定義ファイル（docspace.ini） | サービス | 文書空間 | SerialId | 文書空間構成定義プロパティファイル(docspace.properties) | DocSpaceId
ユーザ認証 | ユーザ認証 | UserAuthentication | UserAuthentication
LDAP設定 | LdapHost | LdapHost
LdapPort | LdapPort
UOCライブラリの設定 | UOCLibrary | UOCClass
ユーザ情報の検索 | 検索条件 | LdapPrefixDn | LdapPrefixDn
LdapUserId | LdapUserId
LdapUserRoot | LdapUserRoot
LdapUserScope | LdapUserScope
LdapUserClass | LdapUserClass
LdapUserFilterLeft | LdapUserFilterLeft
LdapUserFilterRight | LdapUserFilterRight
検索オプション | LdapUserTimeout | LdapUserTimeout
LdapUserCase | LdapUserCase
グループ情報の検索 | ディレクトリエントリからの検索 | LdapGroup | LdapGroup
LdapGroupRoot | LdapGroupRoot
LdapGroupScope | LdapGroupScope
LdapGroupClass | LdapGroupClass
LdapGroupId | LdapGroupId
LdapGroupFilterLeft | LdapGroupFilterLeft
LdapGroupFilterRight | LdapGroupFilterRight
LdapGroupMember | LdapGroupMember
ユーザの属性値からの検索 | LdapGroupFromUserAttr | LdapGroupFromUserAttr
LdapGroupIdFromUserAttr | LdapGroupIdFromUserAttr
LdapGroupIsDnFromUserAttr | LdapGroupIsDnFromUserAttr
LdapGroupIdAttrFromUserAttr | LdapGroupIdAttrFromUserAttr
ユーザのDNからの検索 | LdapGroupFromUserDn | LdapGroupFromUserDn
LdapGroupIdFromUserDn | LdapGroupIdFromUserDn
検索オプション | LdapGroupTimeout | LdapGroupTimeout
LdapGroupCase | LdapGroupCase
ディレクトリサービスに対するバインド方法 | ディレクトリサービスに対するバインド方法 | LdapBindUserDN | LdapBindUserDN
LdapBindPassword | LdapBindPassword
データベース | 接続するデータベースの設定 | DbType | DbType
HiRDB | 接続設定 | PdHost | ConnectorName
PdNamePort | リソースアダプタの設定
PdUser | リソースアダプタの設定（User）
コネクションプールの設定 | DBConnectionPoolCount | リソースアダプタの設定（MaxPoolSize）
DBConnectionPoolOver | リソースアダプタの設定（RequestQueueEnable）
DBConnectionPoolWaitTimeOut | リソースアダプタの設定（RequestQueueTimeout）
リファレンスファイル文書の格納 | ReferenceStorageMode | ReferenceStorageMode
ReferenceDirDivideNum | ReferenceDirDivideNum
BLOBデータ | BLOBデータの設定 | BlobSubstrMode | 未サポート
データサイズの設定 | BlobSubstrThreshold | 未サポート
BLOBデータの取得先 | BlobGettingMethod | 未サポート
セキュリティ定義ファイル（docaccess.ini） | － | セキュリティ管理者 | SecurityAdmin | SecurityAdmin
ユーザ権限定義ファイルの名称 | UserPermDefFile | UserPermDef
オブジェクトの所有者に対するパーミッション | DefaultACFlagOwner | DefaultACFlagOwner
グループに対するパーミッション | DefaultACFlagGroup | DefaultACFlagGroup
すべてのユーザに対するパーミッション | DefaultACFlagEveryone | DefaultACFlagEveryone
ユーザ権限定義ファイル | － | － | Subject:SubjectType:パーミッション文字列 | Subject=SubjectType:パーミッション文字列
プロパティマッピング定義ファイル | － | － | － | 未サポート | －
動作環境定義ファイル（conf.properties） | アプリケーショントレース | アプリケーショントレース情報出力先 | APTracePath | 動作環境定義ファイル(docbconf.properties) | APTracePath
トレースレベル | APTraceLevel | APTraceLevel
アプリケーショントレースファイルのファイルサイズの上限 | APTraceSize | APTraceSize
アプリケーショントレースファイルのファイルの数 | APTraceNumber | APTraceNumber
アプリケーションエラーログファイルのファイルサイズの上限 | APErrorLogSize | APErrorLogSize
アプリケーションエラーログファイルのファイルの数 | APErrorLogNumber | APErrorLogNumber
クライアント共用トレース | トレース情報出力先 | PromptOutput | PromptOutput
クライアント共用トレースファイル出力先ディレクトリ | TracePath | LogPath
クライアント共用トレースファイルのファイルサイズの上限 | TraceSize | TraceSize
クライアント共用トレースファイルのファイルサイズの上限 | TraceNumber | TraceNumber
環境変数 | トレース | 出力先ディレクトリ | _HIEDMS_TRACE_DIR | LogPath
切り替えファイル数 | _HIEDMS_TRACE_NUM | TraceNumber
ファイルサイズ | _HIEDMS_TRACE_SIZE | TraceSize
トレースレベル | _HIEDMS_TRACE_LEVEL | TraceLevel

次の定義ファイルは，廃止となりました。

ファイル転送サービス環境定義ファイル（ftpsv.ini）

サービスプロセス定義ファイル

ネットワークリソース情報ファイル（netaccess.ini）

クライアントアプリケーション動作定義ファイル（application.ini）

クラス定義情報ファイル

また，次の表に示すエントリは廃止となりました。

表C-2　廃止となったエントリ

定義ファイル | 種類 | 設定項目 | エントリ
DocumentSpace構成定義ファイル（docspace.ini） | 文書空間の共通定義 | 文書空間の数 | Count
ORBおよびBOAのオプション | DocSpaceOrbBoaOption
VisiBrokerプロパティ | DocSpaceVBProperty
エラーログ | ErrLogFileCount
ErrLogFileSize
サービス | プロセス設定 | Process
SessionMax
SessionTimeOut
ProcessOrbBoaOption
ProcessVBProperty
ユーザ認証 | LDAP設定 | LdapClientLib
HiRDB | コネクションプールの設定 | DBConnectionPoolDynamic
DBConnectionPoolTiming
DBConnectionScope
HiRDB Text Search Plug-inの設定 | PdTSPluginOwner
アクセスログ | アクセスログの設定 | AcLogUse
AcLogLevel
AcLogFileCount
AcLogFileSize
メタ情報 | 共有メモリの設定 | XdkShmemManage
XdkShmemSize
ファイル分割転送機能 | データ転送サイズの設定 | FtpBufferSize
複数の実行環境 | サーバの選択 | SelectServerInMultiServer
オブジェクト操作 | VariableArray型のプロパティでの要素のチェック | VArrayElementCheck
オブジェクト操作時のエラーチェックのフラグ | ErrChkFlagOfObjectOperation
オブジェクト操作時の動作のフラグ | EnbFncFlagOfObjectOperation
DocumentBroker Life Cycle Suite | WorkCoordinator連携の設定 | LifeCycleSuiteConnection
動作環境定義ファイル（conf.properties） | － | デフォルトの文書空間識別子 | DefaultDocSpaceId
オブジェクトを操作したときの動作 | EnableFunctionFlag
文書空間で使用する文字コード種別 | DocSpaceCharacterSet
環境変数 | － | － | DOCBROKERDIR
トレース | 保存日数 | _HIEDMS_TRACE_DAYS
保存日数 | _HIEDMS_TRACE_DAYS_CLT
ファイル転送 | － | _HIEDMS_FTPDIR
_HIEDMS_FTPMODE
_HIEDMS_FTPORBBOA_OPTION
_HIEDMS_FTPVB_PROPERTY
_HIEDMS_CON_TIMEOUT
EDMLckWatcher | － | _HIEDMS_LCKINF_DIR
_HIEDMS_LCKWATCH_TIME
EDMUsrView | － | _HIEDMS_USRVIEW_TIMEOUT
－ | － | _HIEDMS_EXCEPTION_FILTER
－ | － | DBJ_CONF_PATH

(2)　メタ情報用のテーブルを定義します

DocumentBrokerのメタ情報用のテーブルやインデクスを作成します。テーブルやインデクスは，テーブル定義用のSQLファイルを使用して作成します。

(a)　SQLファイルの編集

メタ情報用のテーブルやインデクスは，次に示すSQLファイルを編集して作成します。

UNIXの場合

/opt/DocBroker/Platform/sql/createmetatable_hirdb.sql

Windowsの場合

<インストールディレクトリ>¥DocBroker¥Platform¥sql¥createmetatable_hirdb.sql

SQLファイル中の文字列を，テキストエディタを使用して書き換えます。

テーブルやインデクスを作成するためにSQLファイルの書き換えが必要な文字列，および書き換える内容を次の表に示します。

表C-3　SQLファイルの書き換えが必要な内容

書き換えが必要な文字列 | 書き換える内容
（META） | 「2.5.3　ユーザLOB用RDエリアの容量の見積もり」で見積もりしたDocumentBrokerのメタ情報を格納するユーザ表用RDエリア名に書き換えします。
（METAINDEX） | 「2.5.3　ユーザLOB用RDエリアの容量の見積もり」で見積もりしたDocumentBrokerのメタ情報を格納するユーザインデクス用RDエリア名に書き換えします。

(b)　SQLファイルの実行

編集したSQLファイルを入力ファイルとして，HiRDBでデータベース定義ユティリティ（pddef）を実行して定義します。HiRDBのデータベース定義ユティリティについては，マニュアル「HiRDB　コマンドリファレンス」を参照してください。

(3)　メタ情報の出力コマンド（dbjprintmeta）を実行します

DocumentBroker Version 3のメタ情報を，DocumentBroker Version 5のメタ情報として登録するするために，メタ情報の出力コマンド（dbjprintmeta　-v）を実行します。メタ情報の出力コマンド（dbjprintmeta）の使用方法については，「7.3　コマンドの文法」を参照してください。

(4)　メタ情報の初期設定コマンド（dbjinitmeta）を実行します

メタ情報の出力コマンド（dbjprintmeta）で出力したメタ情報をデータベースに登録するために，メタ情報の初期設定コマンド（dbjinitmeta）を実行します。このとき，-fオプションに「(3)　メタ情報の出力コマンド（dbjprintmeta）を実行します」で出力したディレクトリを指定します。メタ情報の初期設定コマンドの使用方法については，「7.3　コマンドの文法」を参照してください。

(5)　実行環境の情報の登録コマンド(dbjregenvid)を実行します

複数の実行環境を登録していた場合，dbjinitmetaを実行した環境以外で実行環境の登録コマンド（dbjregenvid　-r）を実行します。実行環境の登録コマンド（dbjregenvid）の使用方法については，「7.3　コマンドの文法」を参照してください。

(6)　DocumentBroker Version 3のメタ情報を削除します

DocumentBroker Version 3のメタ情報を削除するために，次に示すSQLファイルを入力ファイルとしたデータベース定義文を入力ファイルとして，HiRDBでデータベース定義ユティリティ（pddef）を実行して定義を追加します。

UNIXの場合

/opt/DocBroker/Platform/sql/dropemetatable_v3_hirdb.sql

Windowsの場合

<インストールディレクトリ>¥sql¥dropemetatable_v3_hirdb.sql

HiRDBのデータベース定義ユティリティについては，マニュアル「HiRDB　コマンドリファレンス」を参照してください。

付録D　このマニュアルの参考情報

このマニュアルを読むに当たっての参考情報を示します。

＜この節の構成＞

付録D.1　関連マニュアル

付録D.2　このマニュアルでの表記

付録D.3　DocumentBrokerのマニュアルで使用する略語

付録D.4　KB（キロバイト）などの単位表記について

付録D.1　関連マニュアル

このマニュアルの関連マニュアルを次に示します。必要に応じてお読みください。

なお，本文に記載のマニュアル名称は，「uCosminexus DocumentBroker」を「DocumentBroker」と表記しています。

DocumentBrokerのマニュアル

uCosminexus DocumentBroker Version 5　概説（3021-3-402）
DocumentBrokerの機能について知りたい場合に参照してください。

uCosminexus DocumentBroker Version 5　メッセージ（3021-3-405）
DocumentBrokerが出力するメッセージについて知りたい場合に参照してください。

uCosminexus DocumentBroker Version 5　リファレンスAPI（3021-3-403）
DocumentBrokerクラスライブラリの詳細，インターフェースの詳細，およびメソッドの文法について知りたい場合に参照してください。

uCosminexus DocumentBroker Version 5　サンプルWebアプリケーション（3021-3-404）
DocumentBroker Developerが提供しているサンプルWebアプリケーションの機能と使用方法，およびサンプルWebアプリケーションを参考にしたWebアプリケーションの開発方法について知りたい場合に参照してください。

uCosminexus DocumentBroker Text Search Index Loader Version 3（3020-3-U72）
DocumentBroker Text Search Index Loaderの機能，環境設定，およびコマンドの文法について知りたい場合に参照してください。

関連製品のマニュアル（HiRDB）

HiRDB データ連動機能　HiRDB Datareplicator Version 8（3020-6-360）

ノンストップデータベース HiRDB Version 9 システム導入・設計ガイド（UNIX(R)用）（3000-6-452）

ノンストップデータベース HiRDB Version 9 システム導入・設計ガイド（Wndows(R)用）（3020-6-452）

ノンストップデータベース HiRDB Version 9 システム定義（UNIX(R)用）（3000-6-453）

ノンストップデータベース HiRDB Version 9 システム定義（Windows(R)用）（3020-6-453）

ノンストップデータベース HiRDB Version 9 システム運用ガイド（UNIX(R)用）（3000-6-454）

ノンストップデータベース HiRDB Version 9 システム運用ガイド（Windows(R)用）（3020-6-454）

ノンストップデータベース HiRDB Version 9 コマンドリファレンス（UNIX(R)用）（3000-6-455）

ノンストップデータベース HiRDB Version 9 コマンドリファレンス（Windows(R)用）（3020-6-455）

ノンストップデータベース HiRDB Version 9 UAP開発ガイド（3020-6-456）

ノンストップデータベース HiRDB Version 9 SQLリファレンス（3020-6-457）

HiRDB XML拡張機能 HiRDB XML Extension Version 9（3020-6-480）

HiRDB 全文検索プラグイン HiRDB Text Search Plug-in Version 9（3020-6-481）

関連製品のマニュアル（その他）

Cosminexus V9 アプリケーションサーバ　システム構築・運用ガイド（3020-3-Y02）

Cosminexus V9 アプリケーションサーバ　アプリケーション設定操作ガイド（3020-3-Y13）

Cosminexus V9 アプリケーションサーバ　リファレンス 定義編（サーバ定義）（3020-3-Y16）

Cosminexus V9 アプリケーションサーバ　リファレンス 定義編（アプリケーション／リソース定義）（3020-3-Y17）

関連マニュアルの略称

このマニュアルで使用する関連マニュアルの略称を次に示します。

マニュアル名 | 略称
HiRDB Datareplicator Version 8 | HiRDB Datareplicator
HiRDB Version 9 システム導入・設計ガイド（UNIX(R)用） | HiRDB　システム導入・設計ガイド
HiRDB Version 9 システム導入・設計ガイド（Windows(R)用）
HiRDB Version 9 システム定義（UNIX(R)用） | HiRDB　システム定義
HiRDB Version 9 システム定義（Windows(R)用）
HiRDB Version 9 システム運用ガイド | HiRDB　システム運用ガイド
HiRDB Version 9 コマンドリファレンス（UNIX(R)用） | HiRDB　コマンドリファレンス
HiRDB Version 9 コマンドリファレンス（Windows(R)用）
HiRDB Version 9 UAP開発ガイド | HiRDB　UAP開発ガイド
HiRDB Version 9 SQLリファレンス | HiRDB　SQLリファレンス
HiRDB XML Extension Version 9 | HiRDB XML Extension
HiRDB 全文検索プラグイン HiRDB Text Search Plug-in Version 9 | HiRDB HiRDB Text Search Plug-in

付録D.2　このマニュアルでの表記

このマニュアルでは，製品名称を次に示す略称で表記しています。

製品名称 | 略称
uCosminexus Application Server Version 9 | Cosminexus
uCosminexus Developer Version 9
uCosminexus DocumentBroker Developer Version 5 | DocumentBroker
uCosminexus DocumentBroker Platform Version 5
uCosminexus DocumentBroker Runtime Library Version 5
uCosminexus DocumentBroker Developer Version 5 | DocumentBroker Developer
uCosminexus DocumentBroker Platform Version 5 | DocumentBroker Platform
uCosminexus DocumentBroker Runtime Library Version 5 | DocumentBroker Runtime Library
uCosminexus DocumentBroker Text Search Index Loader Version 3 | DocumentBroker Text Search Index Loader
HiRDB Server Version 9 | HiRDB
HiRDB Text Search Plug-in Conceptual Extension Version 7 | HiRDB Text Search Plug-in Conceptual Extension
HiRDB Text Search Plug-in Version 9 | HiRDB Text Search Plug-in
HiRDB XML Extension Version 9 | HiRDB XML Extension
HiRDB/Run Time Version 9 | HiRDB/Run Time
Preprocessing Library for Text Search Version 2 | Preprocessing Library for Text Search
Red Hat Enterprise Linux 6 (x86_64) | Linux

このほか，このマニュアルでは，次に示す表記方法を使用しています。

HiRDBの製品群を総称してHiRDBと表記します。

LinuxをUNIXと表記することがあります。

それぞれの製品について個別に説明する場合は，製品名称を使用します。

Oracle Directory Server Enterprise Edition，およびActive Directoryを合わせてLDAP対応のディレクトリサービスと表記することがあります。

リレーショナルデータベース管理システムをデータベースシステムと表記します。

付録D.3　DocumentBrokerのマニュアルで使用する略語

DocumentBrokerのマニュアルで使用する英略語を次に示します。

英略語 | 英字での表記
ACE | Access Control Element
ACFlag | Access Control Flag
ACL | Access Control List
API | Application Programming Interface
ASCII | American Standard Code for Information Interchange
BLOB | Binary Large Object
CD-ROM | Compact Disc Read Only Memory
CIFS | Common Internet File System
CR | Carriage Return
CSV | Comma Separated Value
DAT | Digital Audio Tape
DB | Database
DBMS | Database Management System
DCD | Document Content Description
DIT | Directory Information Tree
DLL | Dynamic Linking Library
DMA | Document Management Alliance
DN | Distinguished Name
GIF | Graphics Interchange Format
GUI | Graphical User Interface
GUID | Globally Unique Identifier
HTML | Hypertext Markup Language
HTTP | Hypertext Transfer Protocol
ID | Identifier
ISO | International Organization for Standardization
JIS | Japanese Industrial Standards
LDAP | Lightweight Directory Access Protocol
LF | Line Feed
MIME | Multipurpose Internet Mail Extensions
OIID | Object Instance Identifier
OS | Operating System
PC | Personal Computer
PDF | Portable Document Format
RDB | Relational Database
RDN | Relative Distinguished Name
SGML | Standard Generalized Markup Language
UOC | User Own Coding
UTF-8 | 8-bit UCS Transformation Format
WWW | World Wide Web
XML | Extensible Markup Language

付録D.4　KB（キロバイト）などの単位表記について

1KB（キロバイト），1MB（メガバイト），1GB（ギガバイト），1TB（テラバイト）はそれぞれ1,024バイト，1,024²バイト，1,024³バイト，1,024⁴バイトです。

付録E　用語解説

英字｜ア行｜カ行｜サ行｜タ行｜ハ行｜マ行｜ヤ行｜ラ行

DocumentBrokerで使用する用語について説明します。

英字

ACE（Access Control Element）

アクセス制御エレメントのことです。

ACFlag（Access Control Flag）

アクセス制御フラグのことです。

ACL（Access Control List）

アクセス制御リストのことです。

AND-NOT検索

検索オペレータに「AND-NOT」を使用する検索方法です。二つの検索条件をAND-NOTでつないで，左側のオペランドに指定した検索条件は成立するが，右側のオペランドに指定した検索条件は成立しない文書を検索します。例えば，「著者が『日立太郎』であるが，所属は『日立製作所』ではない文書を検索する」というような場合に使用できます。

AND検索

検索オペレータに「AND」を使用して，検索条件同士の論理積を求める検索方法です。例えば，「著者が『日立太郎』で，文書中に『コンピュータ』という文字列を含む文書を検索する」というような場合に使用できます。

API（Application Programming Interface）

アプリケーションプログラムとのインターフェースを指します。

Child

直接型のリンク（DirectContainment）の場合，オブジェクト（Parent）に包含されるオブジェクトを指します。

ConfigurationHistoryオブジェクト

バージョン管理に使用する最上位のDocumentBrokerオブジェクトです。文書のバージョンを管理するVersionSeriesオブジェクトを管理します。

Containableオブジェクト

フォルダの包含要素になるオブジェクトです。CdbrContainableクラスのサブクラスを基に作成されたオブジェクトを指します。

Containee

参照型のリンク（ReferentialContainment）の場合，オブジェクト（Container）に包含されるオブジェクトを指します。

Container

参照型のリンクの場合，オブジェクト（Containee）を包含するオブジェクトを指します。

ContainerVersionオブジェクト

包含しているオブジェクト全体を一つの概念的なオブジェクトとして管理するDocumentBrokerオブジェクトです。

Containerオブジェクト

リンクを利用してオブジェクトを管理する場合に，オブジェクトを包含するDocumentBrokerオブジェクトの一つです。dmaClass_Containerクラスおよびユーザが定義したdmaClass_Containerクラスのサブクラスを基に作成します。

ContentElement（dmaClass_ContentElementクラス）

文書のコンテンツにアクセスするために使われるDocumentBrokerオブジェクトの抽象クラスです。ContentElementの二つのサブクラス（dmaClass_ContentTransferクラス，dmaClass_ContentReferenceクラス）は，コンテンツの格納とアクセス機能を提供します。

ContentReferenceオブジェクト

文書のコンテンツを管理するために使用するDocumentBrokerオブジェクトです。コンテンツをデータベースに格納しないで，位置情報を永続化して管理する場合に使用します。dmaClass_ContentElementクラスのサブクラスであるdmaClass_ContentReferenceクラスを基に作成します。

ContentTransferオブジェクト

文書のコンテンツを管理するために使用するDocumentBrokerオブジェクトです。コンテンツをデータベースに格納（永続化）して管理する場合に使用します。dmaClass_ContentElementクラスのサブクラスであるdmaClass_ContentTransferクラスを基に作成します。

DocumentBrokerオブジェクト

DocumentBrokerクラスを基に作成されたオブジェクトです。DMAで規定されたクラス（クラス名がdmaClass_で始まるクラス），DocumentBrokerで拡張したクラス（クラス名がedmClass_で始まるクラス），およびこれらのクラスからユーザが定義したサブクラスを基に作成されます。

DocVersionオブジェクト

DocumentBrokerで扱う文書に相当するDocumentBrokerオブジェクトです。dmaClass_DocVersionクラスおよびユーザが定義したdmaClass_DocVersionクラスのサブクラスを基に作成します。

edmSQL

DocumentBrokerのオブジェクトを検索するための検索条件式を表現するための文法です。SQLの文法に基づいています。

edmSQL検索

検索条件に，SQLライクの文法で記述できるedmSQL文を指定して実行する検索のことです。

GUID（Globally Unique Identifier）

DocumentBrokerのクラス，プロパティ，検索オペレータなどに与えるユニークな識別子です。GUIDは，「X」を0～9およびa～f（小文字）で表される16進数とした「XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX（8-4-4-4-12）」の形式で表されます。

LDAP（Lightweight Directory Access Protocol）

TCP/IP上で動作する解放型DAPを提供し，X.500のデータモデルを保持しています。

NOT条件

指定したキーワードとの不一致を求める検索条件です。例えば，「作成者が『日立』ではない文書を検索する」というような場合に使用できます。

OIID（Object Instance Identifier）

文書空間での永続オブジェクトの存在や格納位置などを明確にするために使用する識別子です。

OR検索

検索オペレータに「OR」を使用して，検索条件同士の論理和を求める検索方法です。例えば，「作成者が『日立太郎』であるオブジェクトか，作成者の所属が『日立製作所』であるオブジェクトを検索する」というような場合に使用できます。

Parent

直接型のリンクの場合，オブジェクト（Child）を包含するオブジェクトを指します。

RDエリア

データベースの表，インデクスおよびデータディクショナリを格納するデータ領域のことです。データの格納単位の一つで，1～16個のHiRDBファイルから構成されます。

Renditionオブジェクト

文書の表現形式（HTML，PDFなど）を管理するDocumentBrokerオブジェクトです。

Reservationオブジェクト

新しいバージョンを作成する権利をVersionSeriesオブジェクトに予約するDocumentBrokerオブジェクトです。新しいバージョンのチェックインが完了すると，このオブジェクトは削除されて，VersionDescriptionオブジェクトに置き換えられます。

UOC（User Own Coding）

ユーザによって作成されたプログラムのことです。DocumentBrokerでは，ユーザ認証や，アクセス制御機能のためのユーザ情報取得にUOCを使用できます。

VariableArray型

プロパティの基本単位の一つです。基本単位がVariableArray型であるプロパティは，データ型に従った複数の値を可変長な一次元配列として持ちます。また配列の要素は，構造体で管理できます。

Versionableオブジェクト

バージョン管理の対象になるオブジェクトです。

VersionDescriptionオブジェクト

文書のバージョン（更新履歴）を管理するために使用するDocumentBrokerオブジェクトです。VersionSeriesオブジェクトとVersionableオブジェクトを接続するために使用します。

VersionSeriesオブジェクト

文書のバージョン（更新履歴）を管理するために使用するDocumentBrokerオブジェクトです。連続的な履歴を持つバージョンの構成を保持するオブジェクトです。

VersionTracedComponentDocVersionオブジェクト

直接型，参照型のリンクでフォルダに包含される対象となるためのプロパティを持つDocumentBrokerオブジェクトです。dmaClass_DocVersionクラスのサブクラスのedmClass_VersionTracedComponentDocVersionクラスを基に作成します。

VersionTracedDocVersionオブジェクト

直接型，参照型のリンクで，フォルダに包含される対象となるためのプロパティを持つDocumentBrokerオブジェクトです。dmaClass_DocVersionクラスのサブクラスのedmClass_VersionTracedDocVersionクラスを基に作成します。

VTContainee

オブジェクト（VTContainer）に包含されるオブジェクトを指します。

VTContainer

オブジェクト（VTContainee）を包含するオブジェクトを指します。

W3C（World Wide Web Consortium）

HTMLなど，WWWに関する技術の標準化を推進する非営利団体です。

ア行

アクセス権

オブジェクトを作成したり，すでに作成されているオブジェクトにアクセスしたりする権利です。

アクセス制御エレメント（ACE：Access Control Element）

アクセス制御リスト（ACL）の要素です。一つのサブジェクトと一つのパーミッションの組で構成され，指定されたサブジェクトに対して指定されたパーミッションの範囲のアクセス権を与えることを示す情報です。

アクセス制御機能

DocumentBrokerの文書空間でのオブジェクトの作成や，管理されている文書やフォルダなどのオブジェクトに対する操作を，ユーザやグループごとに許可または制限する機能です。

アクセス制御機能付き検索

アクセス制御機能を利用した文書空間で検索を実行した場合に，ユーザにアクセス権がないオブジェクトは検索結果として取得しない検索です。

アクセス制御情報

アクセス制御されている文書空間で，ユーザがメソッドを発行する際に，アクセス権の判定に使用される情報です。

アクセス制御情報変更権

オブジェクトに設定されているアクセス制御情報（ACFlagおよびACL）を変更する権利です。また，パブリックACLをアクセス制御対象オブジェクトにバインドすることを許可する権利も含みます。なお，パブリックACLのアクセス情報変更権には，パブリックACLのユーザ定義プロパティを変更する権利を含みます。

アクセス制御フラグ（ACFlag：Access Control Flag）

オブジェクトの所有者，プライマリグループおよび全ユーザという区分でパーミッションを設定できるアクセス制御情報の一つです。

アクセス制御モデル

アクセス制御機能を利用して運用されている文書管理モデルです。

アクセス制御リスト（ACL：Access Control List）

任意のユーザまたはグループにパーミッションを設定できるアクセス制御情報の一つです。アクセス制御エレメント（ACE）のリストで構成されます。

アンバインド

パブリックACLとのバインドを解除することです。

異表記展開検索

全文検索条件として指定する検索タームまたは検索タームの異表記を含む文書を検索する方法です。例えば，検索タームとして「バイオリン」を指定した場合に，「ヴァイオリン」という検索タームの異表記を含む文書も検索できます。

インデクス情報ファイル

ユーザが追加するプロパティにインデクスを定義する場合に，定義するインデクスの情報を記述するファイルです。

永続オブジェクト

データベースに格納されたオブジェクトを指します。

永続プロパティ

データベースに存在するプロパティを指します。

オブジェクト作成権

オブジェクト作成権限で，文書空間にオブジェクトを作成する権利を与えるパーミッションです。ユーザ権限定義ファイルに指定します。

オブジェクト作成権限

文書空間にオブジェクトを作成する権限で，ユーザ権限の一つです。ユーザ権限定義ファイルで定義します。オブジェクト作成権限を与えられたユーザおよびグループに属するユーザは，オブジェクトを作成するメソッドを実行できます。

オブジェクト操作権限

文書空間内のすべてのオブジェクトを，与えられた権限の範囲で操作する権利で，ユーザ権限の一つです。ユーザ権限定義ファイルで定義します。例えば，オブジェクト操作権限としてプロパティ参照権を与えられたユーザおよびグループに属するユーザは，文書空間内のすべてのオブジェクトのプロパティを参照できます。

オブジェクトリファレンス

DocumentBrokerオブジェクトへのリファレンスを示すObject型プロパティの値です。例えば，dmaProp_ParentContainerプロパティの値がこれに当たります。

カ行

概念検索

ユーザが任意に指定した文章や文字列を手がかりにして，その条件と似た概念を持つ文書を検索する方法です。全文検索の一種です。概念検索で指定する条件のことを種文章といいます。

仮のバージョン識別子

チェックアウト中の仮のバージョンを識別するための識別子です。

チェックアウト中のオブジェクトを参照・更新する時に使用します。この識別子はチェックアウト時にDocumentBrokerによって設定される識別子であり，仮のバージョンに該当するオブジェクトのOIIDとは異なります。

関連オブジェクト

リンクの型（直接型，間接型）を定義するためのDocumentBrokerオブジェクトです。

直接型のリンクの場合，オブジェクトを包含するオブジェクト（Parent）とオブジェクトに包含されるオブジェクト（Child）をDirectContainmentRelationshipオブジェクトを使用して関連づけます。参照型のリンクの場合，オブジェクトを包含するオブジェクト（Container）とオブジェクトに包含されるオブジェクト（Containee）をReferentialContainmentRelationshipオブジェクトを使用して関連づけます。

基本コンテンツ更新権

基本パーミッションの一つで，オブジェクトのコンテンツを更新する権利を与えるパーミッションです。基本プロパティ参照権を含みます。文書に対して設定する場合は，全文検索インデクスを作成，削除する権利を含みます。

基本コンテンツ参照権

基本パーミッションの一つで，オブジェクトのコンテンツを参照する権利を与えるパーミッションです。基本プロパティ参照権を含みます。文書に対して設定する場合は，全文検索を実行する権利を含みます。

基本削除権

基本パーミッションの一つで，オブジェクトを削除する権利を与えるパーミッションです。基本プロパティ参照権を含みます。

基本単位

DMAで規定されているプロパティは，データ型に従った値を1個持つか複数個持つかが決められています。これを基本単位といいます。

基本バージョン管理権

基本パーミッションの一つで，バージョン管理されているオブジェクトのバージョンを追加，削除する権利を与えるパーミッションです。基本プロパティ参照権を含みます。

基本パーミッション

ユーザおよびグループがオブジェクトに対して実行できる操作の範囲を定めるパーミッションの基本単位です。オブジェクト操作権限，アクセス制御フラグおよびアクセス制御エレメントで，ユーザおよびグループに許可する操作の範囲を定める場合に使用します。例えば，あるユーザに対して，文書の更新と削除を許可する場合は，更新と削除を許可するために，基本コンテンツ更新権と基本削除権という二つのパーミッションを設定します（一つのパーミッションで一つの権利を与える）。基本パーミッションには，基本プロパティ参照権，基本プロパティ更新権，基本コンテンツ参照権，基本コンテンツ更新権，基本リンク権，基本バージョン管理権および基本削除権があります。

基本プロパティ更新権

基本パーミッションの一つで，オブジェクトのプロパティを更新する権利を与えるパーミッションです。基本プロパティ参照権を含みます。

基本プロパティ参照権

基本パーミッションの一つで，オブジェクトのプロパティを参照する権利を与えるパーミッションです。そのほかのすべての基本パーミッションに含まれます。フォルダに対して設定する場合は，関連オブジェクトのユーザ定義プロパティの参照と管理されている要素を参照する権利を含みます。

基本リンク権

基本パーミッションの一つで，リンクの設定，変更および関連オブジェクトのユーザ定義プロパティを変更する権利を与えるパーミッションです。基本プロパティ参照権を含みます。

近傍条件検索

検索オペレータに「Prox」を使用する拡張検索（全文検索）です。指定する検索タームが同時に存在する場合に，その検索ターム間の距離を条件として検索します。例えば，「『文書管理』という検索タームと『ドキュメント』という検索タームを含み，これらの検索タームがこのとおりの順序で出現し，かつ検索ターム間に入る文字が5文字以内である文書を検索する」というような場合に使用できます。

組み合わせパーミッション

基本パーミッションを複数組み合わせた権利を与えるパーミッションの単位です。アクセス制御フラグおよびアクセス制御エレメントでユーザおよびグループに許可する操作の範囲を定めるときに使用します。組み合わせパーミッションには，プロパティ参照権，参照権，プロパティ更新権，参照更新権，削除権，リンク権，バージョン管理権およびフルコントロールがあります。例えば，あるユーザに対して，ある文書の参照更新権という組み合わせパーミッションを設定すると，そのユーザは基本プロパティ参照権，基本プロパティ更新権，基本コンテンツ参照権および基本コンテンツ更新権が設定されたのと同じ範囲の操作を，その文書に対して実行できます。

継承（Inheritance）

既存のクラスを利用して新しいクラスを定義するオブジェクト指向の技術です。

コンテンツ

一般的には，属性に対する文書のデータ部分を指します。DMAでは，ある文書に関連づけられていて，DMAで規定されているContentモデルに従ってアクセスされるオブジェクトの集合を指します。また，アクセスされるオブジェクトの実体（例えば，report.doc，document.htmなど）をコンテンツデータといいます。

コンテンツ格納先パス

リファレンスファイル管理機能を使用する場合に，コンテンツの格納先として，コンテンツ格納先ベースパスからの相対パスで指定するディレクトリパスです。コンテンツ格納先パスで指定したディレクトリの下に，DocumentBrokerがコンテンツを管理するためのディレクトリが作成され，その下にコンテンツが格納されます。コンテンツ格納先パスに指定するディレクトリは，DocumentBrokerによって作成されます。

コンテンツロケーション

リファレンスファイル管理機能を使用する場合に，データベースで管理される，コンテンツの格納先の情報です。コンテンツ格納先ベースパスからの相対パスがコンテンツロケーションとしてデータベースに登録されます。

サ行

サーババインド

DocumentBrokerからLDAP対応のディレクトリサービスに対して，DNとパスワードを使用して認証を行い，バインドすることです。

削除権

組み合わせパーミッションの一つです。基本削除権と同じ操作を許可するパーミッションです。

サブクラス

あるクラスから派生するクラスのことです。または，それ自身がサブクラスとして参照されているクラスのことです。

サブジェクト（Subject）

アクセス権を与えるユーザまたはグループです。

サブジェクト種別（SubjectType）

アクセス権を与えるサブジェクトが，ユーザなのか，グループなのかまたはシステムなのかを識別するための情報です。

サブレンディション

マルチレンディション文書に，追加登録されたレンディションのことです。マスタレンディション以外のレンディションを指します。なお，サブレンディションは，登録後にマスタレンディションに変更できます。

参照型のリンク（ReferentialContainment）

フォルダを利用した文書管理の方法です。参照型のリンクで使われるフォルダは，文書にはり付けるインデクスの働きをします。

参照権

組み合わせパーミッションの一つです。基本コンテンツ参照権と同じ操作を許可するパーミッションです。

参照更新権

組み合わせパーミッションの一つです。基本プロパティ参照権，基本プロパティ更新権，基本コンテンツ参照権および基本コンテンツ更新権を組み合わせたパーミッションです。すなわち，参照更新権を設定することで，プロパティを参照，更新する権利とコンテンツを参照，更新する権利を設定できます。

状態フラグ

マルチレンディション文書のマスタレンディションに対するサブレンディションのコンテンツの状態を表すフラグです。マスタレンディションとサブレンディションのコンテンツの状態が一致している，マスタレンディションのコンテンツが更新されたのに対してサブレンディションのコンテンツが更新されていない，またはサブレンディションのコンテンツが存在しない，という3種類の状態が表されます。dbrProp_RenditionStatusプロパティの下位2バイトに設定されます。

所有者（Owner）

オブジェクトの所有者として設定されているユーザです。アクセス制御フラグでパーミッションを与えられます。所有者に設定されているユーザは，そのオブジェクトのアクセス制御フラグで所有者に与えられたパーミッションの範囲の操作をそのオブジェクトに対して実行できます。また，そのオブジェクトの所有者およびセキュリティACLの値を変更できます。

スーパークラス

あるクラスのクラス定義に使われたクラスを，派生したクラスのスーパークラスといいます。

セキュリティACL

オブジェクトに設定されたアクセス制御情報へのアクセスを制御するためのアクセス制御リストです。任意のユーザまたはグループにアクセス制御情報変更権を設定できます。

セキュリティ管理者

アクセス制御機能を利用した文書空間で，アクセス判定を受けることなく，すべてのオブジェクトに自由にアクセスする特権を持ち，文書空間のすべてのオブジェクトを保守するユーザです。セキュリティ定義ファイルに定義します。

セッション

文書空間に接続している間のことです。文書空間に接続することを，セッションの確立といいます。文書空間との接続を解除することを，セッションの切断といいます。

全文検索

文書中に含まれるキーワードを条件（全文検索条件）として，キーワードを含む文書を検索する方法です。

全文検索インデクス

全文検索の対象になるテキストデータに対応するプロパティです。edmProp_TextIndexプロパティ，edmProp_StIndexプロパティ，edmProp_ConceptTextIndexプロパティ，edmProp_ConceptStIndexプロパティおよびedmProp_Contentプロパティに相当します。

全文検索機能付き文書クラス

全文検索の対象となる文書を作成するためのクラスです。dmaClass_DocVersionクラスのサブクラスに全文検索に必要なプロパティを追加した，ユーザ定義のクラスです。

タ行

チェックアウト（check-out）

文書またはフォルダにバージョンを追加するために，次バージョンの追加を予約して，最新バージョンのコピーを要求することです。

チェックイン（check-in）

文書またはフォルダのバージョンの追加を確定することです。

直接型のリンク（DirectContainment）

フォルダを利用した文書管理の方法です。直接型のリンクで使われるフォルダは，文書を格納するフォルダの働きをします。

定義情報ファイル

サブクラスおよびプロパティを追加するときに，追加するオブジェクトの定義情報を記述するファイルです。

ディレクトリサービス

ネットワーク上にあるユーザや組織の情報などの資源とその属性を記憶し，検索できるようにしたシステムです。

DocumentBrokerでは，SecureWay DirectoryやOracle Directory Server Enterprise Editionなどの製品を使用したLDAP対応のディレクトリサービスと連携できます。

同義語展開検索

全文検索条件として指定する検索タームまたは検索タームの同義語を含む文書を検索する方法です。例えば，検索タームとして「パソコン」を指定した場合に，「電子計算機」，「パーソナルコンピュータ」，「PC」など，検索タームと同じ意味を持つ単語を含む文書も検索できます。

動作環境メタ情報ファイル

DocumentBrokerを起動するときに参照するメタ情報です。実行環境ディレクトリ/env_info（UNIXの場合），または実行環境ディレクトリ¥env_info（Windowsの場合）に格納されます。

匿名バインド

DocumentBrokerからLDAP対応のディレクトリサービスに対して，匿名ユーザで認証を行い，バインドすることです。

独立データ

ほかのオブジェクトに依存しない，独立したデータを表すオブジェクトです。プロパティだけを持つことができる文書空間オブジェクトです。edmClass_IndependentPersistenceクラスまたはそのサブクラスを基に作成したDocumentBrokerオブジェクトをトップオブジェクトとする文書空間オブジェクトです。

特権

アクセス制御機能を利用した文書空間で，アクセス判定を受けることなく，すべてのオブジェクトに自由にアクセスする権利です。セキュリティ定義ファイルにセキュリティ管理者として定義されたユーザに与えられます。特権の有無は，ログイン時にセキュリティ定義ファイルが参照され，ログインユーザごとに作成されるユーザ情報に保持されます。

トップオブジェクト

DocumentBrokerクラスライブラリのオブジェクトを構成する複数のDocumentBrokerオブジェクトのうち，最上位に位置するオブジェクトです。例えば，バージョンなし文書の場合は，DocumentBrokerオブジェクトのDocVersionオブジェクトがトップオブジェクトです。

ハ行

バージョン管理権

組み合わせパーミッションの一つです。基本プロパティ参照権，基本プロパティ更新権，基本コンテンツ参照権，基本コンテンツ更新権および基本バージョン管理権を組み合わせたパーミッションです。

バージョン付き文書

複数のバージョンを保持できる文書を表すオブジェクトです。DocumentBrokerオブジェクトでは，ConfigurationHistoryオブジェクトに相当します。

バージョンなしフォルダ

バージョンを保持しないフォルダを表すオブジェクトです。DocumentBrokerオブジェクトでは，Containerオブジェクト，およびContainerVersionオブジェクトに相当します。

バージョンなし文書

バージョン管理しない文書を表すオブジェクトです。DocumentBrokerオブジェクトでは，DocVersionオブジェクトに相当します。

パーミッション

オブジェクトの作成，オブジェクトのプロパティ参照，オブジェクトのコンテンツ更新などの実行可能な操作の範囲を表す値です。オブジェクト作成権限を与えるパーミッション，オブジェクトの操作の範囲を定めるパーミッションがあります。オブジェクトの操作の範囲を定めるパーミッションには，基本パーミッションと組み合わせパーミッションがあります。

バインド

文書やフォルダからパブリックACLを参照することです。

また，LDAP対応のディレクトリサービスに対して，DNとパスワードを使用して認証を行うことも，バインドといいます。

パブリックACL

文書空間にオブジェクトとして存在するアクセス制御リスト（ACL）です。複数のオブジェクトが共有できます。

非ナル値制約

非ナル値制約とは，列の値にナル値を許さない制約のことです。

複合データ

複数の異なる型によって表されるデータです。主に，VariableArray型のプロパティとして設定されているObject型の要素の値を参照，設定するときに使用します。

フォルダ

リンクでオブジェクトを包含できるオブジェクトの総称です。また，DocumentBrokerオブジェクトとしては，Containerオブジェクト，VersionTraceableContainerオブジェクトおよびContainerVersionオブジェクトがあります。

プライマリグループ

アクセス制御フラグ（ACFlag）でパーミッションを与えるグループです。

フルコントロール

組み合わせパーミッションの一つです。すべての基本パーミッションを組み合わせたパーミッションです。オブジェクトに対するすべての操作を許可します。

プロパティ更新権

組み合わせパーミッションの一つです。基本プロパティ更新権と同じ操作を許可するパーミッションです。

プロパティ参照権

組み合わせパーミッションの一つです。基本プロパティ参照権と同じ操作を許可するパーミッションです。

文書

DocumentBrokerオブジェクトでは，dmaClass_DocVersionクラスおよびそのサブクラスを基に作成するオブジェクトのことです。コンテンツを保持できます。

文書間リンク（Relationship）

文書と文書の関連づけです。

文書空間

DocumentBrokerオブジェクトモデルを実装するリポジトリです。

文書空間構成定義ファイル（docspace.properties）

文書空間の構成を定義するために使用するファイルです。

変換フラグ

マルチレンディション文書のサブレンディションのフォルダを，レンディション変換の対象にするかどうかを表すフラグです。レンディション変換機能を使用してレンディション変換を実行する場合に使用します。また，レンディション変換機能によるレンディション変換でエラーが発生した場合には，エラーを示すフラグとしても使われます。dbrProp_RenditionStatusプロパティの上位2バイトに設定されます。

マ行

マスタレンディション

マルチレンディション文書に登録されたレンディションのうち，主要なレンディションのことです。マルチレンディション文書を参照・更新する場合には，レンディション形式を指定しますが，レンディション形式を指定しないときは，マスタレンディションが対象になります。なお，マスタレンディションとして扱うレンディションは，登録後に変更できます。

マルチレンディション機能

一つの文書に，同一内容の複数の異なる形式のフォルダを登録する機能です。

マルチレンディション文書

複数のレンディションを登録している文書のことです。一つの同じ内容を表す複数の形式のフォルダを保持する文書です。バージョンなし文書またはバージョン付き文書は，マルチレンディション文書として扱えます。

メタ情報ファイル

DocumentBrokerが利用するDocumentBrokerのクラス，プロパティ，検索オペレータなどの詳細情報を定義したファイルです。クラスおよびプロパティを追加，変更する場合に使用できます。

メタデータ（metadata）

クラス，プロパティおよびオペレータに関する詳細情報を定義するデータです。

ヤ行

ユーザ権限

文書空間にオブジェクトを作成する権利（オブジェクト作成権限）と，文書空間内のすべてのオブジェクトに対する操作の範囲（オブジェクト操作権限）をユーザまたはグループ単位で定めるアクセス制御情報の一つです。ユーザ権限定義ファイルに定義します。ユーザ権限の内容は，ログイン時にユーザ権限定義ファイルが参照され，ログインユーザごとに作成されるユーザ情報に保持されます。

ユーザ権限定義ファイル

ユーザ権限（オブジェクト作成権限およびオブジェクト操作権限）を定義するためのファイルです。

ユーザ情報

ログインユーザのユーザ識別子，所属グループ，特権およびユーザ権限を表す情報です。ログイン時にユーザごとに生成され，アクセス権の判定に使用されます。

ラ行

リファレンスファイル管理機能

DocumentBrokerが存在するマシンから接続可能なファイルシステムの任意のディレクトリで文書のコンテンツを管理し，文書のプロパティおよびコンテンツの格納先の情報をデータベースで管理する機能です。

リファレンスファイル文書

DocumentBrokerが存在するマシンから接続可能なファイルシステムの任意のディレクトリに格納されているファイルをコンテンツとして持つ文書のことです。データベースでは，文書のプロパティとコンテンツの格納先の情報を管理しています。バージョンなし文書またはバージョン付き文書をリファレンスファイル文書として扱えます。

リレーション

DocumentBrokerオブジェクトのRelationshipオブジェクトに相当します。文書と文書の間の参照関係を表すオブジェクトです。

リンク

DocumentBrokerオブジェクトのDirectContainmentRelationshipオブジェクト，ReferentialContainmentRelationshipオブジェクトまたはVersionTraceableContainmentRelationshipオブジェクトによって表される，文書とフォルダの関連づけです。

リンク権

組み合わせパーミッションの一つです。基本リンク権と同じ操作を許可するパーミッションです。

リンク識別子

フォルダオブジェクトへのリンク（関連づけ）を識別するための識別子です。

リンクを解除したり，リンクのプロパティを参照または更新したりする時に使用します。

この識別子は関連づけをした時にDocumentBrokerによって設定される識別子です。同じフォルダオブジェクトに，同じ要素を2度関連づけした場合は，それぞれ異なるリンク識別子が設定されます。

レンディション

文書のコンテンツの形式およびそのコンテンツをあわせてレンディションと呼びます。DocumentBrokerオブジェクトのRenditionオブジェクトおよびContentTransferオブジェクトに相当します。

レンディションタイプ

Wordなどのアプリケーションで編集したファイル，HTML形式のファイル，GIFなどの画像データのファイルのように，登録した文書のコンテンツのファイルの形式を表す文字列です。レンディションごとに設定できます。DocumentBrokerでは，レンディションタイプとして，MIME名を指定することを推奨しています。

レンディション変換機能

マルチレンディション文書の，マスタレンディションのフォルダの文書形式を変換して，サブレンディションのフォルダを作成，登録することです。

ローカルACL

オブジェクトごとに設定できるアクセス制御リスト（ACL）です。VariableArray型のプロパティとして設定されます。

ロケール（Locale）

言語や使用する文字コードの種別，特定の国や地域で特別な意味を持つ属性などの定義のことです。ロケールは地域化した形でアプリケーションの拡張性を提供するために使われます。

索引

[Ａ][Ｂ][Ｃ][Ｄ][Ｅ][Ｇ][Ｈ][Ｉ][Ｌ][Ｍ][Ｎ][Ｏ][Ｐ][Ｒ][Ｓ][Ｔ][Ｕ][Ｖ][Ｗ]
[ア行][カ行][サ行][タ行][ハ行][マ行][ヤ行][ラ行]

(英字)

(Ａ)

ACE

ACFlag

ACL

AND-NOT検索

AND検索 ,[2]

API

(Ｂ)

BinaryAccessSizeプロパティ

(Ｃ)

Child

ConfigurationHistoryオブジェクト

ConnectorNameプロパティ

Containableオブジェクト

Containee

Container

ContainerVersionオブジェクト

Containerオブジェクト

ContentElement

ContentReferenceオブジェクト

ContentTransferオブジェクト

(Ｄ)

databaseinfo.properties

dbjaddmeta

dbjchgmeta

dbjchgusrid

dbjcrtsql

dbjdelmeta

dbjgenguid

dbjinitmeta

dbjlsdoc

dbjlsfldr

dbjprintmeta

dbjregenvid

DBTypeプロパティ

DefaultACFlagEveryoneプロパティ

DefaultACFlagGroupプロパティ

DefaultACFlagOwnerプロパティ

DIT

DN

DOCB_CONF_DIR

docbmetainit.properties

DocSpaceIdプロパティ

DocumentBrokerオブジェクト

DocumentBroker実行環境の情報の登録

DocumentBrokerの環境変数の設定

DocumentBrokerの起動方法

DocumentBrokerの機能

DocumentBrokerのシステム構成

DocumentBrokerの終了方法

DocumentBroker用データベース定義文の作成

DocVersionオブジェクト

(Ｅ)

edmProp_ConceptTextIndexプロパティ ,[2]

edmProp_ContentIndexStatusプロパティ ,[2]

edmProp_DocLengthプロパティ ,[2]

edmProp_TextIndexプロパティ

edmSQL

edmSQL検索

(Ｇ)

GUID

GUIDの生成

(Ｈ)

HiRDB Text Search Plug-in，HiRDB XML Extensionでの環境設定

(Ｉ)

IT Report Utilityを利用した保守情報の採取

(Ｌ)

LDAP

LdapBindPasswordプロパティ

LdapBindUserDNプロパティ

LdapGroupCaseプロパティ

LdapGroupClassプロパティ

LdapGroupFilterLeftプロパティ

LdapGroupFilterRightプロパティ

LdapGroupFromGroupDnプロパティ

LdapGroupFromGroupMemberプロパティ

LdapGroupFromUserAttrプロパティ

LdapGroupFromUserDnプロパティ

LdapGroupIdAttrFromUserAttrプロパティ

LdapGroupIdFromUserAttrプロパティ

LdapGroupIdFromUserDnプロパティ

LdapGroupIdプロパティ

LdapGroupIsDnFromUserAttrプロパティ

LdapGroupMemberプロパティ

LdapGroupRootプロパティ

LdapGroupScopeプロパティ

LdapGroupTimeoutプロパティ

LdapGroupプロパティ

LdapHostプロパティ

LdapPortプロパティ

LdapUserCaseプロパティ

LdapUserClassプロパティ

LdapUserFilterLeftプロパティ

LdapUserFilterRightプロパティ

LdapUserIdプロパティ

LdapUserRootプロパティ

LdapUserScopeプロパティ

LdapUserTimeoutプロパティ

LDAP対応のディレクトリサービスによるユーザ管理機能を使用する場合

LDAP対応のディレクトリサービスのユーザ認証

(Ｍ)

MaxContentSizeプロパティ

MaxFullTextSizeプロパティ

mime.properties

(Ｎ)

NOT検索

NOT条件

(Ｏ)

OIID

OR検索 ,[2]

(Ｐ)

Parent

PATH

(Ｒ)

RDエリア

RDエリア定義情報ファイル

ReferenceBasePathプロパティ

ReferenceDirDivideNumプロパティ

ReferenceStorageModeプロパティ

Renditionオブジェクト

Reservationオブジェクト

(Ｓ)

SecurityAdminプロパティ

(Ｔ)

TempDirectoryプロパティ

(Ｕ)

UOC ,[2]

UOCClassプロパティ

UserAuthenticationプロパティ

userperm.properties

UserPermDefプロパティ

(Ｖ)

VariableArray型

Versionableオブジェクト

VersionDescriptionオブジェクト

VersionSeriesオブジェクト

VersionTracedComponentDocVersionオブジェクト

VersionTracedDocVersionオブジェクト

VTContainee

VTContainer

(Ｗ)

W3C

(ア行)

(あ)

アクセス権

アクセス制御エレメント

アクセス制御機能 ,[2]

アクセス制御機能付き検索

アクセス制御機能に関連するデータベース容量の見積もり

アクセス制御情報

アクセス制御情報変更権

アクセス制御フラグ

アクセス制御モデル

アクセス制御リスト

アンインストール

アンバインド

(い)

異表記展開検索

異表記展開検索〔文書に対する全文検索〕

異表記展開検索〔文字列型プロパティに対する全文検索〕

インスタンス

インストールとアンインストール（UNIXの場合）

インストールとアンインストール（Windowsの場合）

インデクス情報ファイル ,[2]

インデクス情報ファイルの記述例

インデクス名をデータベース定義の名称に使用する場合の規則

(え)

永続オブジェクト

永続プロパティ

エントリ

(お)

オブジェクト作成権

オブジェクト作成権限 ,[2]

オブジェクト操作権限 ,[2]

オブジェクトリファレンス

(カ行)

(か)

概念検索 ,[2] ,[3]

仮想メモリ所要量の見積もり

仮のバージョン識別子

環境設定

環境設定の準備

環境設定の流れ

関連オブジェクト

(き)

基本コンテンツ更新権

基本コンテンツ参照権

基本削除権

基本単位 ,[2]

基本バージョン管理権

基本パーミッション ,[2]

基本プロパティ更新権

基本プロパティ参照権

基本リンク権

近傍条件検索

近傍条件検索〔文書に対する全文検索〕

近傍条件検索〔文字列型プロパティに対する全文検索〕

(く)

組み合わせパーミッション ,[2]

クラスおよびプロパティの追加例

グループ識別子 ,[2] ,[3]

(け)

継承

検索機能

検索ターム〔文書に対する全文検索〕

検索ターム〔文字列型プロパティに対する全文検索〕

(こ)

コマンド一覧

コマンドの形式

コマンドの文法

コンテンツ

コンテンツ格納先パス ,[2]

コンテンツ格納先ベースパス ,[2]

コンテンツロケーション ,[2]

(サ行)

(さ)

サーババインド

削除権

サブクラス ,[2]

サブクラスの追加

サブクラス名およびプロパティ名をデータベース定義の名称に使用する場合の規則

サブクラス名の規則

サブジェクト

サブジェクト種別

サブレンディション ,[2]

参照型のリンク

参照権

参照更新権

(し)

システムクラス，システムプロパティおよびデータベース定義の名称規則

システムクラスの名称定義の規則

システムプロパティの名称の規則

実行環境識別子

ジャーナルファイルの運用

出力されるデータベース定義文

障害対策

状態フラグ

所有者

(す)

スーパークラス

(せ)

セキュリティACL

セキュリティ管理者

セッション

全文検索

全文検索インデクス

全文検索インデクス一括登録機能

全文検索機能

全文検索機能付き文書クラス

全文検索機能付き文書クラスの追加

全文検索機能付き文字列型プロパティ

(そ)

相対識別名

属性検索機能

(タ行)

(た)

種文章

(ち)

チェックアウト ,[2]

チェックイン ,[2]

直接型のリンク

(つ)

追加するクラスおよびプロパティの検討

(て)

定義情報ファイル ,[2]

ディレクトリエントリ

ディレクトリサービス

ディレクトリサービスの情報管理の概念

データ型の対応

データベース運用上の注意事項

データベース情報ファイル

データベース定義の名称定義の規則

データベースの運用

データベースの文字コード種別の設定

データベース容量の見積もり

データベース容量の見積もり方法

適用業務の検討

(と)

同義語展開検索

同義語展開検索〔文書に対する全文検索〕

同義語展開検索〔文字列型プロパティに対する全文検索〕

動作環境メタ情報ファイル

登録済みメタ情報の出力

匿名バインド

独立データ ,[2]

独立データの管理機能

特権

トップオブジェクト

(ハ行)

(は)

バージョン

バージョン管理権

バージョン付き文書 ,[2]

バージョンなしフォルダ

バージョンなし文書 ,[2]

パーミッション

バインド

バックアップとリストア

バックアップとリストアの方法

バックアップの取得

パブリックACL

(ひ)

非ナル値制約

(ふ)

ファイルシステムのバックアップ

ファイルシステムのリストア

フォルダ ,[2]

フォルダ一覧の出力

フォルダ管理機能

複合データ

複数の実行環境機能

プライマリグループ

フルコントロール

プロパティ更新権

プロパティ参照権

プロパティの追加

プロパティ名の規則

プロパティを追加する場合の注意事項

文書

文書一覧の出力

文書間リンク ,[2]

文書間リンク機能

文書空間

文書空間構成定義ファイル ,[2]

文書空間構成定義ファイルの内容を変更する

文書空間で使用する文字コード種別の検討

文書空間の文字コード種別の設定

文書の属性情報の管理機能

文書の登録機能とバージョン管理機能

(へ)

変換フラグ

変更情報ファイル

(マ行)

(ま)

マスタレンディション ,[2]

マルチレンディション管理機能

マルチレンディション機能

マルチレンディション文書

マルチレンディション文書

(め)

メタ情報初期化ファイル

メタ情報の削除

メタ情報の初期設定

メタ情報の追加

メタ情報の変更

メタ情報ファイル ,[2]

メタデータ

(ヤ行)

(ゆ)

ユーザ／グループの一括変更

ユーザLOB用RDエリアの容量の見積もり

ユーザ管理機能の設定

ユーザ権限 ,[2]

ユーザ権限定義ファイル ,[2]

ユーザ権限定義ファイルの設定

ユーザ作成のアクセスルーチンを使用する場合

ユーザ識別子 ,[2] ,[3]

ユーザ情報 ,[2] ,[3]

ユーザ用RDエリアの容量の見積もり

(ラ行)

(り)

リストアの方法

リファイレンスファイル文書

リファレンスファイル管理機能 ,[2]

リファレンスファイル管理機能を使用する場合の運用

リファレンスファイル管理機能を使用する場合の設定

リファレンスファイル管理機能を使用する場合のファイルシステムのディスク容量の見積もり

リファレンスファイル文書

リレーション

リンク先文書

リンク元文書

リンク

リンク権

リンク識別子

(れ)

列名

レプリケーション

レンディション ,[2]

レンディションタイプ

レンディション定義ファイル

レンディションのコンテン種別変換機能

レンディション変換機能

(ろ)

ローカルACL

ロケール

■ 商標類

Active Directoryは，米国Microsoft Corporationの，米国およびその他の国における登録商標または商標です。
GIFは，米国CompuServe Inc.が開発したフォーマットの名称です。
Linuxは，Linus Torvalds氏の日本およびその他の国における登録商標または商標です。
Microsoft Office Wordは，米国 Microsoft Corporation の商品名称です。
Microsoftは，米国Microsoft Corporationの米国およびその他の国における登録商標または商標です。Microsoft Wordは，米国Microsoft Corporationの商品名称です。
MicrosoftおよびWindowsは，米国Microsoft Corporationの米国およびその他の国における登録商標または商標です。
MicrosoftおよびWindows Serverは，米国Microsoft Corporationの米国およびその他の国における登録商標または商標です。
OracleとJavaは，Oracle Corporation及びその子会社，関連会社の米国及びその他の国における登録商標です。
UNIXは，The Open Groupの米国ならびに他の国における登録商標です。
その他記載の会社名，製品名は，それぞれの会社の商標もしくは登録商標です。