uCosminexus DocumentBroker Version 3 オブジェクト操作ツール
![[目次]](figure/content.gif)
![[用語]](figure/gloss.gif)
![[索引]](figure/index.gif)
![[前へ]](figure/front.gif)
dbrupdoc(文書のアップロード)
機能
操作クラス
- CdbrDocumentクラス
- CdbrVersionableDocumentクラス
形式
dbrupdoc 〔-I〕〔 -v { バージョン識別子 | バージョン識別子ファイル } 〕
〔 -M レンディションタイプ 〕
〔 -N 変更レンディションタイプ 〕
〔 -k { Content | MultiContent | FileLink
〔 -j コンテント登録先FAM名 〕
〔 -g コンテント登録先パス 〕
| Reference〔 -a RELATIVE 〕
〔 -b コンテント格納先ベースパス 〕
〔 -h コンテント格納先パス 〕 } 〕
{ OIID | OIIDファイル }
{ アップロードファイルURL |アップロード情報ファイル}
オプション
- -I
- 全文検索インデクスを作成しない場合に指定します。シングルファイル文書をアップロードする場合,このオプションを省略していて,かつアップロードする文書が次の条件を満たしているとき,アップロードファイルURLに指定したファイルから,全文検索インデクスが作成されます。
- 作成時に指定されたdmaClass_DocVersionクラスまたはそのサブクラスが,全文検索機能付き文書クラスである。
- 設定されているレンディションタイプの先頭が「MIME::text/」である。
- なお,マルチファイル文書またはFile Link文書の場合は,このオプションを省略しても全文検索インデクスは作成されません。
- -v { バージョン識別子 | バージョン識別子ファイル }
- バージョン付き文書の場合,アップロードするバージョンのバージョン識別子を指定します。このオプションを省略した場合は,最新バージョンがチェックアウトされて,ファイルがアップロードされたあと,チェックインされます。
- バージョンなし文書をアップロードするときにこのオプションを指定するとエラーになります。
- バージョン識別子
- アップロードするバージョンのバージョン識別子を指定します。
- バージョン識別子ファイル
- アップロードするバージョンのバージョン識別子を記述したバージョン識別子ファイルのファイルパスを指定します。ファイルパスは,絶対パスまたは相対パスのどちらでも指定できます。ただし,「DBRVTVERSION」という文字列および「acl://」で始まるパスは指定できません。なお,バージョン識別子ファイルに記述できるバージョン識別子の数は一つだけです。
- -M レンディションタイプ
- アップロードするレンディションタイプを指定します。このオプションを省略した場合は,マスタレンディションが仮定されます。
- バージョン付き文書に対してこのオプションを指定する場合は,必ず-vオプションも指定してください。
- -N 変更レンディションタイプ
- アップロード時にレンディションタイプを変更する場合に,変更後のレンディションタイプを指定します。このオプションを省略した場合は,レンディションタイプは変更されません。なお,マルチファイル文書の場合,このオプションは指定できません。
- -k { Content | MultiContent | FileLink 〔 -j コンテント登録先FAM名 〕〔 -g コンテント登録先パス 〕 | Reference 〔 -a RELATIVE〕〔 -b コンテント格納先ベースパス〕〔 -h コンテント格納先パス〕 }
- アップロードする文書のコンテントの種別を指定します。
- このオプションを指定した場合,アップロードファイルURL,またはアップロード情報ファイルに指定されたコンテントの登録先が,このオプションの指定と一致していないとエラーになります。また,アップロードしようとするレンディションのコンテントの登録先と一致しないとエラーになります。コンテントの登録先は,dbrrndrdocコマンドでレンディションの一覧を取得する(-xオプションにLISTを指定する)場合に,dbrProp_ContentTypeプロパティの値を取得する(-pオプションで指定するプロパティ情報ファイルに「dbrProp_ContentType」を指定する)ことで確認できます。なお,このオプションを省略した場合は,アップロードファイルURL,またはアップロード情報ファイルの指定に従って文書をアップロードします。
- Content
- シングルファイル文書のコンテントとして,データベースにアップロードします。アップロードURLに指定されたファイルに,コンテントをアップロードします。
- MultiContent
- マルチファイル文書のコンテントとして,データベースにアップロードします。アップロード情報ファイルの指定に従って,コンテントをアップロードします。
- FileLink
- File Link文書のコンテントとして,ファイルサーバにアップロードします。
- Reference
- リファレンスファイル文書のコンテントとして,ファイルシステム上の領域にアップロードします。
- オプション省略時
- アップロードファイルURL,またはアップロード情報ファイルの指定に従って文書のコンテントをデータベースにアップロードします。
- アップロードファイルURLが指定されている場合
シングルファイル文書のコンテントをデータベースにアップロードします。
- アップロード情報ファイルが指定されている場合
マルチファイル文書のコンテントをデータベースにアップロードします。
- -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」のとき) |
- -a RELATIVE
- アップロードするリファレンスファイル文書のリファレンス種別を指定します。
- -kオプションにReferenceを指定していない場合に,このオプションを指定するとエラーになります。
- このオプションを省略した場合,実行環境制御ファイルの,ReferenceセクションのDefaultReferenceTypeエントリの指定を使用します。
- リファレンス種別がNONEの,コンテントが登録されていないリファレンスファイル文書をアップロードする場合も,このオプションまたは実行環境制御ファイルで,リファレンス種別を指定します。
- RELATIVE
- コンテントの格納先をファイルシステム上の領域とし,コンテントロケーションを相対パスで管理します。
- -b コンテント格納先ベースパス
- リファレンスファイル文書をアップロードする場合に,コンテント格納先ベースパスを指定します。
- アップロードするリファレンスファイル文書の,リファレンス種別がRELATIVEのとき,およびリファレンス種別がNONEのときの,オプション引数の指定内容を次に示します。
- リファレンス種別がRELATIVEのとき
オプション引数には,更新元のリファレンスファイル文書のコンテント格納先ベースパスを指定します。例えば,更新元となるリファレンスファイル文書のコンテント格納先ベースパスが「/drv01/dir01/userdir」の場合,このオプションに同じ値「/drv01/dir01/userdir」を指定します。
- リファレンス種別がNONEのとき
オプション引数には,更新するリファレンスファイル文書のコンテントを格納するディレクトリの基点となるパスを指定します。例えば,アップロードファイルURLで指定したコンテントを,「/drv01/dir01/userdir」ディレクトリの下位にある「user01」ディレクトリに格納する場合,「user01」ディレクトリの基点となるパスとして,このオプションに「/drv01/dir01/userdir」を指定します。また,コンテントを格納するディレクトリとして,-hオプションで「user01」を指定します。このオプションの指定の末尾に,パスのデリミタ「/」(UNIXの場合)または「\」(Windowsの場合)を記述する必要はありません。
このオプションで指定したコンテント格納先ベースパスは,-hオプションで指定したコンテント格納先パスと結合して,絶対パスとして使用されます。ContentLocationプロパティには次に示すパスが格納されます。
aaaa/bbbb/cccc
aaaa:コンテント格納先パス
bbbb:DocumentBrokerがコンテントを管理するためのディレクトリ
cccc:ファイル名※
注※
次に示すどちらかのファイル名が設定されます。
・登録ファイル名(DocumentSpace構成定義ファイルのReferenceStorageModeエントリにOriginを指定した場合)
・DocumentBrokerが指定するファイル名(DocumentSpace構成定義ファイルのReferenceStorageModeエントリにDivideを指定した場合)
- -kオプションにReferenceを指定していない場合に,このオプションを指定するとエラーになります。このオプションを省略した場合,実行環境制御ファイルの,ReferenceセクションのDefaultContentBasePathエントリの指定を使用します。
- Windowsの場合,コンテント格納先ベースパスにUNC形式のパスを使用することもできます。例えば,「server01」というマシンのネットワーク上で共有しているフォルダ「share」をコンテント格納先ベースパスに指定する場合は,このオプションに「\\server01\share」を指定します。
- -h コンテント格納先パス
- リファレンスファイル文書をアップロードする場合に,コンテント格納先パスを指定します。このオプションは,リファレンス種別がNONEの,コンテントが登録されていないリファレンスファイル文書をアップロードする場合だけ有効です。
- -kオプションにReferenceを指定していない場合に,このオプションを指定するとエラーになります。
- オプション引数には,-bオプションで指定したコンテント格納先ベースパスからの相対パスで,コンテントの格納先とするディレクトリを指定します。例えば,アップロードファイルURLで指定したコンテントを,-bオプションで指定した「/drv01/dir01/userdir」ディレクトリの下位にある「user01」ディレクトリに格納する場合,このオプションに「user01」を指定します。このオプションの指定の先頭に,パスのデリミタ「/」(UNIXの場合)または「\」(Windowsの場合)を記述する必要はありません。
- このオプションの指定を省略すると,-bオプションで指定したコンテント格納先ベースパスのディレクトリの下位に,DocumentBrokerがコンテントを管理するためのディレクトリが作成され,その下位にコンテントが格納されます。
- このオプションで指定したコンテント格納先パスは,-bオプションで指定したコンテント格納先ベースパスと結合して,絶対パスとして使用されます。ContentLocationプロパティには次に示すパスが格納されます。
- aaaa/bbbb/cccc
- aaaa:コンテント格納先パス
- bbbb:DocumentBrokerがコンテントを管理するためのディレクトリ
- cccc:ファイル名※
- 注※
- 次に示すどちらかのファイル名が設定されます。
- アップロードファイルURLで指定したコンテントのファイル名(DocumentSpace構成定義ファイルのReferenceStorageModeエントリにOriginを指定した場合)
- DocumentBrokerが指定するファイル名(DocumentSpace構成定義ファイルのReferenceStorageModeエントリにDivideを指定した場合)
コマンド引数
- OIID
- アップロードする文書のOIIDを指定します。
- OIIDファイル
- アップロードする文書のOIIDを記述したOIIDファイルのファイルパスを指定します。
- OIIDファイルのファイル名はオブジェクトのOIID形式以外であれば任意です。ファイルパスは,絶対パスまたは相対パスのどちらでも指定できます。ただし,「dma://」で始まるパスは指定できません。なお,OIIDファイルに記述できるOIIDの数は一つだけです。
- アップロードファイルURL
- シングルファイル文書の場合,アップロードするファイルのパスをURL形式で指定します。
- File Link文書の場合,クライアントのコンテントを指定して文書をアップロードするとき,ファイルサーバに登録するコンテントのパスをURL形式で指定します。また,ファイルサーバ上に登録されているコンテントを指定して文書をアップロードするときは,DBRSVCONTENTを指定して,-gオプションにファイルサーバ上のコンテントのパスを指定します。なお,ファイルサーバ上に登録されているコンテントを使用するとき,-gオプションを省略するとエラーになります。
- 例えば,UNIXの場合,「/tmp/upload.doc」のファイルをアップロードするときは,「file:///tmp/upload.doc」と指定します。Windowsの場合,「c:\temp\upload.doc」のファイルをアップロードするときは,「file:///c:\temp\upload.doc」と指定します。
- アップロード情報ファイル
- マルチファイルを管理する文書の場合,アップロードするマルチファイル文書の情報を記述した,アップロード情報ファイルのファイルパスを指定します。ファイルパスは,絶対パスまたは相対パスのどちらでも指定できます。
- ただし,「DBRSVCONTENT」という文字列のファイル,および「file://」で始まるパスは指定できません。
注意事項
- -vオプションを指定した場合,チェックアウトおよびチェックインは実行されません。指定したバージョンのアップロードだけが実行されます。
- -vオプションのオプションの引数に「DBRVTVERSION」を指定するとエラーになります。
- -Iオプションおよび-vオプションを指定しないでシングルファイル文書であるバージョン付き文書をアップロードした場合,チェックイン後のバージョンに対応する全文検索インデクスが作成されます。なお,マルチファイル文書の場合,File Link文書,またはリファレンスファイル文書のレンディションの場合は,-Iオプションの指定を省略しても全文検索インデクスは作成されません。
- 複数のレンディションを持つ,マルチファイルを管理しないバージョン付き文書に対してチェックアウトおよびチェックインをした場合,最新のバージョンの文書はマスタレンディションだけの文書になります。チェックアウト前の文書のサブレンディションは,最新バージョンには引き継がれません。
- シングルファイル文書であるバージョン付き文書に対して-Mオプションを指定する場合,-vオプションを指定しないとエラーになります。
- アップロードファイルが格納されている場所として,ファイルパス(アップロードファイルURL)を指定した場合,アップロードファイルは,マルチファイルを管理する文書として扱われます。また,アップロードファイルが格納されている場所として,ディレクトリパス(アップロードディレクトリURL)を指定した場合,アップロードファイルは,マルチファイルを管理する文書として扱われます。アップロードファイルが格納されている場所の指定と,アップロードファイルの種類が一致しない場合はエラーとなります。
- マルチファイル文書の場合,dbrProp_RetrievalNameプロパティの値を更新するには,プロパティ情報ファイルのdbrProp_RetrievalNameプロパティの値を更新して,dbrsetpropコマンドを実行します。
- マルチファイル文書の場合,アップロード情報ファイルのdirectoryエントリに指定したディレクトリ下にファイルがないとエラーになります。
- シングルファイル文書のレンディションの場合,-vオプションおよび-Iオプションを指定しないでバージョン付き文書をアップロードすると,チェックイン後のバージョンに対する全文検索インデクスが作成されます。
- -kオプションを省略した場合,アップロードファイルURLを指定すると,シングルファイル文書として扱われ,アップロード情報ファイルを指定すると,マルチファイル文書として扱われます。
- File Link文書で,コンテントの登録先を,ファイルサーバとする場合,-kオプションでFileLinkを指定します。この場合,-kオプションは省略できません。
- File Link文書の,ファイルサーバ上のコンテントの削除モードは,クライアントのコンテントを指定してアップロードした場合と,ファイルサーバ上のコンテントを指定してアップロードした場合で異なります。それぞれの場合のコンテントの削除モードを次に示します。
- クライアントのコンテントを指定してアップロードした場合
クライアントのコンテントを指定してアップロードした文書を削除すると,ファイルサーバ上のコンテントも同期して削除されます。なお,クライアントのコンテントをディレクトリ単位で登録したときは,ディレクトリごと削除されます。
- ファイルサーバ上のコンテントを指定してアップロードした場合
ファイルサーバ上のコンテントを指定してアップロードした文書を削除しても,ファイルサーバ上のコンテントは削除されません。なお,ファイルサーバ上のコンテントをディレクトリ単位で指定したときも,ディレクトリは削除されません。
コンテントの削除モードを変更する場合は,実行環境制御ファイルのFileLinkセクションの,ClientContentDeleteModeエントリ,またはServerContentDeleteModeエントリの設定を変更してください。
- リファレンスファイル文書の場合,コンテントの格納先には,DocumentBrokerサーバから接続可能であり,かつDocumentBrokerサーバから参照可能なディレクトリを設定してください。
- リファレンスファイル文書をアップロードする場合に,誤って異なるリファレンスファイル文書のコンテント格納先ベースパスを指定すると,エラーになります。
- リファレンスファイル文書を扱うコンテントの操作でエラーになると,オブジェクトとコンテントの状態が不整合となり,メッセージKMBR30201-E(要因コード3,86)が出力される場合があります。この場合は,エラーになったオブジェクトを削除したあと,再度,dbrupdocコマンド(文書のアップロード)を実行して,リファレンスファイル文書をアップロードしてください。また,メッセージの詳細については,マニュアル「DocumentBroker Version 3 メッセージ」を参照してください。
- リファレンスファイル文書の場合,コンテント格納先ベースパスのディレクトリおよびコンテント格納先パスのディレクトリの下位に,DocumentBrokerがコンテントを管理するためのディレクトリが作成され,その下位にコンテントが格納されます。なお,リファレンスファイル文書のコンテントと,コンテントが格納されているディレクトリを同時に削除する場合は,dbrdeldocコマンド(文書の削除)で,削除ディレクトリのルートパスを指定してください。削除ディレクトリのルートパスの指定方法については,コマンド「dbrdeldoc(文書の削除)」を参照してください。
All Rights Reserved. Copyright (C) 2006, Hitachi, Ltd.
All Rights Reserved. Copyright (C) 2006, 2013, Hitachi Solutions, Ltd.