uCosminexus DocumentBroker Version 3 オブジェクト操作ツール
![[目次]](figure/content.gif)
![[用語]](figure/gloss.gif)
![[索引]](figure/index.gif)
![[前へ]](figure/front.gif)
![[次へ]](figure/after.gif)
dbrrndrdoc（文書のレンディション操作）
機能
文書のレンディションを操作します。次の操作ができます。
- レンディションの追加
- マスタレンディションの変更
- レンディションの削除
- レンディション一覧の取得
なお，レンディション一覧の取得で出力される情報は，レンディションタイプです。
操作クラス
- CdbrDocumentクラス
- CdbrVersionableDocumentクラス
形式
レンディションを追加する場合
dbrrndrdoc -x ADD -M レンディションタイプ
〔 -v { バージョン識別子 | バージョン識別子ファイル } 〕
〔 -t { USER | BATCH } 〕
〔 -k { Content | FileLink
〔 -j コンテント登録先FAM名 〕
〔 -g コンテント登録先パス 〕 } 〕
{ OIID | OIIDファイル } 〔 登録ファイルURL 〕
マスタレンディションを変更する場合
dbrrndrdoc -x CHANGE -M レンディションタイプ
〔 -v { バージョン識別子 | バージョン識別子ファイル } 〕
{ OIID | OIIDファイル }
レンディションを削除する場合
dbrrndrdoc -x DELETE -M レンディションタイプ
〔 -v { バージョン識別子 | バージョン識別子ファイル } 〕
{ OIID | OIIDファイル }
レンディション一覧を取得する場合
dbrrndrdoc -x LIST
〔 -v { バージョン識別子 | バージョン識別子ファイル } 〕
〔 -p プロパティ情報ファイル 〕
{ OIID | OIIDファイル }
オプション
- -x { ADD | CHANGE | DELETE | LIST }
- 操作の種類を指定します。このオプションを省略した場合は，LISTが仮定されます。
- ADD
- レンディションを追加します。
- CHANGE
- マスタレンディションを変更します。
- DELETE
- レンディションを削除します。
- LIST
- レンディション一覧を取得します。
- -M レンディションタイプ
- 操作するレンディションのレンディションタイプを指定します。
- -xオプションのオプションの引数にLIST以外を指定した場合，このオプションは省略できません。
- -xオプションのオプションの引数にLISTを指定した場合，このオプションを指定するとエラーになります。
- -v { バージョン識別子 | バージョン識別子ファイル }
- バージョン付き文書の場合，操作するバージョンのバージョン識別子を指定します。このオプションを省略した場合は，最新バージョンが仮定されます。
- バージョンなし文書の場合にこのオプションを指定するとエラーになります。
- バージョン識別子
- 操作するバージョンのバージョン識別子を指定します。
- バージョン識別子ファイル
- 操作するバージョンのバージョン識別子を記述したファイルのファイルパスを指定します。ファイルパスは，絶対パスまたは相対パスのどちらでも指定できます。ただし，「DBRVTVERSION」という文字列および「acl://」で始まるパスは指定できません。なお，バージョン識別子ファイルに記述できるバージョン識別子の数は一つだけです。
- -t { USER | BATCH }
- ファイル指定の種類を指定します。
- -xオプションのオプションの引数にADD以外を指定した場合，このオプションを指定するとエラーになります。また，-kオプションにFileLinkを指定した場合，このオプションにUSER以外を指定するとエラーになります。
- -xオプションのオプションの引数にADDを指定した場合，このオプションを省略するとUSERが仮定されます。
- USER
- コマンド引数の登録ファイルURLに指定したファイルを，追加したレンディションに登録します。
- BATCH
- ファイルが未登録のレンディションを追加します。
- 追加したレンディションは，DocumentBroker Rendering Optionによってマスタレンディションに登録されたファイルを変換する場合に，変換後のファイルを登録するために使用します。
- -k { Content | FileLink 〔 -j コンテント登録先FAM名 〕〔 -g コンテント登録先パス 〕 }
- レンディションを追加して登録する文書のコンテント種別を指定します。
- -x ADDオプション以外を指定した場合，このオプションを指定するとエラーになります。また，このオプションにFileLinkを指定した場合に，-tオプションにUSER以外を指定するとエラーになります。
- なお，このオプションを省略した場合，Contentが仮定されます。
- Content
- シングルファイル文書のレンディションを追加します。コンテントは，データベースに登録します。
- FileLink
- File Link文書のレンディションを追加します。コンテントは，ファイルサーバに登録します。
- -j コンテント登録先FAM名
- File Link文書のレンディションを追加する場合に，コンテントの登録先となるファイルサーバのFAM名を指定します。-kオプションにFileLinkを指定していない場合に，このオプションを指定するとエラーになります。このオプションを省略した場合，実行環境制御ファイルのFileLinkセクションの，DefaultFAMNameエントリに指定されたFAM名のファイルサーバを使用します。
- -g コンテント登録先パス
- File Link文書としてレンディションを追加する場合に，ファイルサーバ上の登録先パスを指定します。
- クライアントのコンテントを指定してレンディションを追加するとき，およびファイルサーバ上に登録されているコンテントを指定してレンディションを追加するときの，オプションの引数の指定方法を次に示します。
- クライアントのコンテントを指定してレンディションを追加するとき
ファイルサーバ上の登録先ディレクトリのパスを指定します。ディレクトリのパスの末尾にはデリミタ「/」（UNIXの場合）または「\」（Windowsの場合）を記述します。ファイルサーバに登録するコンテントは，登録ファイルURLで指定します。
このオプションに指定した登録先ディレクトリが存在しない場合，ディレクトリが作成され，コンテントが登録されます。ただし，ディレクトリの末尾にデリミタ「/」（UNIXの場合）または「\」（Windowsの場合）を記述しない場合，コンテント名称の自動生成を行わない（実行環境制御ファイルで，FileLinkセクションの FileNamingModeエントリにSpecifyを指定している）環境で，このオプションに指定したディレクトリがファイルサーバ上に存在するとエラーになり，存在しないとこのオプションで指定した名称でコンテントが登録されます。
UNIXの場合に，コンテントの登録先ディレクトリが，「/dir01/data」の下位にある「area1」ディレクトリのとき，次のように指定します。
| 指定形式の種別 |
指定例 |
| フルパス指定 |
/dir01/data/area1/ |
| エイリアス指定 |
DATA/area1/
（「/dir01/data」のエイリアス名が「DATA」のとき） |
また，Windowsの場合に，コンテントの登録先ディレクトリが，「c:\dir01\data」の下位にある「area1」ディレクトリのとき，次のように指定します。
| 指定形式の種別 |
指定例 |
| フルパス指定 |
c:\dir01\data\area1\ |
| エイリアス指定 |
DATA\area1\
（「c:\dir01\data」のエイリアス名が「DATA」のとき） |
- ファイルサーバ上に登録されているコンテントを指定してレンディションを追加するとき
ファイルサーバ上のコンテントのパスを指定します。登録ファイルURLには，DBRSVCONTENTを指定します。
-
- なお，-kオプションにFileLinkを指定していない場合に，このオプションを指定するとエラーになります。このオプションを省略した場合，実行環境制御ファイルのFileLinkセクションの，DefaultContentPathエントリの指定を使用します。ファイルサーバ上に登録されているコンテントを指定してレンディションを追加する場合には，このオプションは省略できません。
- UNIXの場合に，レンディションの追加に使用するコンテントが，「/dir01/data/area1」の下位にある「file.jpg」のとき，次のように指定します。
| 指定形式の種別 |
指定例 |
| フルパス指定 |
/dir01/data/area1/file.jpg |
| エイリアス指定 |
DATA/area1/file.jpg
（「/dir01/data」のエイリアス名が「DATA」のとき） |
-
- Windowsの場合に，レンディションの追加に使用するコンテントが，「c:\dir01\data\area1」の下位にある「file.jpg」のとき，次のように指定します。
| 指定形式の種別 |
指定例 |
| フルパス指定 |
c:\dir01\data\area1\file.jpg |
| エイリアス指定 |
DATA\area1\file.jpg
（「/dir01/data」のエイリアス名が「DATA」のとき） |
- -p プロパティ情報ファイル
- -xオプションにLISTを指定してレンディションの一覧を取得するときに，同時にプロパティ値を取得する場合，レンディションの一覧を取得するオブジェクトのクラス名，およびプロパティ値を取得するプロパティの名称を記述したプロパティ情報ファイルのファイルパスを指定します。ファイルパスの指定は，絶対パスまたは相対パスのどちらでも指定できます。
- 取得したプロパティ値は，レンディションタイプに続いてコンマ（,）で区切って出力されます。
- 指定できるプロパティを次に示します。次のプロパティ以外を指定した場合は，エラーとなります。
- dbrProp_RetrievalName
レンディションのdbrProp_RetrievalNameプロパティの値を取得する場合に指定します。
- dbrProp_RenditionStatus
レンディションのdbrProp_RenditionStatusプロパティの値を取得する場合に指定します。
dbrProp_RenditionStatusプロパティの値は，マスタレンディションとサブレンディションの状態を表します。10進数で表示されます。
dbrProp_RenditionStatusプロパティに設定される値とレンディションの状態の関係を次の表に示します。なお，dbrProp_RenditionStatusプロパティには，16進数の値が設定されます。また，指定したレンディションがマスタレンディションの場合は，DBR_RENDSTATUS_MASTERD（00000000：4バイトの16進数）が設定されます。
表5-4 dbrProp_RenditionStatusプロパティの値とレンディションの状態の関係（状態フラグ：下位2バイト）
| dbrProp_RenditionStatusプロパティの値 |
対応する値（16進数） |
レンディションの状態 |
| DBR_RENDSTATUS_NO_SUBREND |
0001 |
指定したサブレンディションに対応するマスタレンディションのコンテントは登録済みですが，サブレンディションのコンテントが未登録です。 |
| DBR_RENDSTATUS_SUBREND_EXIST |
0002 |
指定したサブレンディションに対応するマスタレンディションおよびサブレンディションのコンテントが登録されています。 |
| DBR_RENDSTATUS_MASTERREND_UPDATE |
0004 |
指定したサブレンディションに対応するマスタレンディションが更新されていますが，サブレンディションが更新されていないため，マスタレンディションとサブレンディションの内容が不一致です。 |
表5-5 dbrProp_RenditionStatusプロパティの値とレンディションの状態の関係（変換フラグ：上位2バイト）
| dbrProp_RenditionStatusプロパティの値 |
対応する値（16進数） |
レンディションの状態 |
| DBR_RENDSTATUS_CONVERT_NOTREQUIRED |
0000 |
レンディション変換が不要な状態です。この状態の場合，DocumentBroker Rendering Optionによるレンディション変換の対象になりません。 |
| DBR_RENDSTATUS_CONVERT_REQUIRED |
0001 |
レンディション変換が必要な状態です。この状態の場合，DocumentBroker Rendering Optionによるレンディション変換の対象になります。 |
| DBR_RENDSTATUS_CONVERT_ERROR |
0002 |
DocumentBroker Rendering Optionによるレンディション変換時にエラーが発生した状態です。この状態になると，DocumentBroker Rendering Optionによるレンディション変換はできなくなります。 |
- dbrProp_ContentType
レンディションのdbrProp_ContentTypeプロパティの値（コンテントの登録先）を取得する場合に指定します。
dbrProp_ContentTypeプロパティは，各レンディションに対応したコンテント種別を示します。コンテント種別から，レンディションのコンテントがマルチファイル文書か，シングルファイル文書か，File Link文書か，またはリファレンスファイル文書かどうか知ることができます。このプロパティは，Integer32型の4バイトの値として表示されます。
dbrProp_ContentTypeプロパティの値とコンテント種別の関係を次の表に示します。
表5-6 dbrProp_ContentTypeプロパティの値とコンテント種別の関係
| dbrProp_ContentTypeプロパティの値 |
対応する値 |
コンテント種別 |
| DBR_CONTENTTYPE_CONTENT |
0 |
ContentTransferオブジェクト（シングルファイル文書であるコンテント）です。 |
| DBR_CONTENTTYPE_FILELINK |
1 |
ContentFileLinkオブジェクト（File Link文書であるコンテント）です。 |
| DBR_CONTENTTYPE_MULTIFILE |
2 |
ContentTransfersオブジェクト（マルチファイル文書であるコンテント）です。 |
| DBR_CONTENTTYPE_REFERENCE |
3 |
ContentReferenceオブジェクト（リファレンスファイル文書であるコンテント）です。 |
| DBR_CONTENTTYPE_OTHER |
-1 |
上記以外のコンテントを持つオブジェクトです。 |
- dbrProp_ReferenceType
リファレンスファイル文書のレンディションのReferenceTypeプロパティの値を取得する場合に指定します。
ReferenceTypeプロパティの値は，コンテントのリファレンス種別を表します。ReferenceTypeプロパティの値とリファレンス種別の関係を次の表に示します。
表5-7 dbrProp_ReferenceTypeプロパティの値とリファレンス種別の関係
| dbrProp_ReferenceTypeプロパティの値 |
対応する値 |
リファレンス種別 |
| DBR_REFERENCETYPE_NONE |
0 |
コンテントはありません。 |
| DBR_REFERENCETYPE_USER_RELATIVE_CONTENT |
1001 |
ユーザ管理領域に格納したコンテント（相対パス）です。 |
- dbrProp_ContentLocation
リファレンスファイル文書のレンディションのContentLocation（コンテントロケーション）を取得する場合に指定します。
コマンド引数
- OIID
- 操作する文書のOIIDを指定します。
- OIIDファイル
- 操作する文書のOIIDを記述したOIIDファイルのファイルパスを指定します。ファイルパスは，絶対パスまたは相対パスのどちらでも指定できます。ただし，「dma://」で始まるパスは指定できません。なお，OIIDファイルに記述できるOIIDの数は一つだけです。
- 登録ファイルURL
- シングルファイル文書の場合，追加するレンディションに登録するファイルのファイルパスをURL形式で指定します。
- File Link文書の場合，クライアントのコンテントを指定してレンディションを追加するときは，ファイルサーバに登録するコンテントのパスをURL形式で指定します。また，ファイルサーバ上に登録されているコンテントを指定してレンディションを追加するときは，DBRSVCONTENTを指定して，-gオプションに利用するファイルサーバ上のコンテントのパスを指定します。なお，ファイルサーバ上に登録されているコンテントを使用するとき，-gオプションを省略するとエラーになります。
- 例えば，UNIXの場合，「/tmp/add.doc」を登録するときには，「file:///tmp/add.doc」と指定します。Windowsの場合，「c:\temp\add.doc」を登録するときには，「file:///c:\temp\add.doc」と指定します。
- なお，-x ADDオプション以外を指定した場合，このコマンド引数を指定するとエラーになります。
実行例
実行例を次に示します。なお，この例はWindowsの場合です。UNIXの場合は，「file:///c:\temp\add.txt」を「file:///tmp/add.txt」に，「type PropFile」を「cat PropFile」に読み替えてください。
$ dbrrndrdoc -x LIST dma:///07a17522…00000051
# dma:///07a17522…00000051
MIME::application/ms-word
KMBR32002-I 1件のオブジェクトに対する操作を行いました。
$ dbrrndrdoc -x ADD -M MIME::text/plain dma:///07a17522…00000051 file:///c:\temp\add.txt
KMBR32002-I 1件のオブジェクトに対する操作を行いました。
$ dbrrndrdoc -x LIST dma:///07a17522…00000051
# dma:///07a17522…00000051
MIME::application/ms-word
MIME::text/plain
KMBR32002-I 1件のオブジェクトに対する操作を行いました。
$ dbrrndrdoc -x CHANGE -M MIME::text/plain dma:///07a17522…00000051
KMBR32002-I 1件のオブジェクトに対する操作を行いました。
$ dbrrndrdoc -x DELETE -M MIME::application/ms-word dma:///07a17522…00000051
KMBR32002-I 1件のオブジェクトに対する操作を行いました。
$ dbrrndrdoc -x LIST dma:///07a17522…00000051
# dma:///07a17522…00000051
MIME::text/plain
KMBR32002-I 1件のオブジェクトに対する操作を行いました。
$ type PropFile
[usrClass_Document]
dbrProp_ContentType
dbrProp_RetrievalName
dbrProp_RenditionStatus
$ dbrrndrdoc -x LIST -p PropFile dma:///07a17522…00000051
# dma:///07a17522…00000051
MIME::application/ms-word,0,資料1.doc,0
MIME::text/plain,0,資料1.txt,2
KMBR32002-I 1件のオブジェクトに対する操作を行いました。
注意事項
- -vオプションのオプションの引数に「DBRVTVERSION」を指定するとエラーになります。
- -xオプションのオプションの引数にADDを指定した場合，すでに存在するレンディションタイプを-Mオプションで指定すると，実行メソッドでエラーになります。
- -xオプションのオプションの引数にADDを指定して，-tオプションを省略または-tオプションのオプションの引数にUSERを指定する場合は，必ず登録ファイルURLを指定してください。登録ファイルURLを省略すると，実行メソッドでエラーになります。
- -xオプションのオプションの引数にADDを指定して，-tオプションのオプションの引数にBATCHを指定する場合は，登録ファイルURLを指定しないでください。登録ファイルURLを指定すると，実行メソッドでエラーになります。
- -xオプションのオプションの引数にCHANGEを指定した場合，マスタレンディションのレンディションタイプまたは存在しないレンディションタイプを-Mオプションで指定すると，実行メソッドでエラーになります。
- -xオプションのオプションの引数にDELETEを指定した場合，マスタレンディションのレンディションタイプまたは存在しないレンディションタイプを-Mオプションで指定すると，実行メソッドでエラーになります。
- File Link文書で，コンテントの登録先を，ファイルサーバとする場合，-kオプションでFile Linkを指定します。この場合，-kオプションは省略できません。
- File Link文書の，ファイルサーバ上のコンテントの削除モードは，クライアントのコンテントを指定してレンディションを追加した場合と，ファイルサーバ上に登録されているコンテントを指定してレンディションを追加した場合で異なります。それぞれの場合のコンテントの削除モードを次に示します。
- クライアントのコンテントを指定してレンディションを追加した場合
クライアントのコンテントを指定して追加したレンディションを削除すると，ファイルサーバ上のコンテントも同期して削除されます。なお，コンテントとしてディレクトリを登録したときは，ディレクトリごと削除されます。
- ファイルサーバ上に登録されているコンテントを指定してレンディションを追加した場合
ファイルサーバ上に登録されているコンテントを指定して追加したレンディションを削除しても，ファイルサーバ上のコンテントは削除されません。なお，コンテントにディレクトリを使用しているときでも，ディレクトリは削除されません。
コンテントの削除モードを変更する場合は，実行環境制御ファイルのFileLinkセクションの，ClientContentDeleteModeエントリ，またはServerContentDeleteModeエントリの設定を変更してください。
- リファレンスファイル文書の場合，レンディションは追加できません。
All Rights Reserved. Copyright (C) 2006, Hitachi, Ltd.
All Rights Reserved. Copyright (C) 2006, 2013, Hitachi Solutions, Ltd.