uCosminexus DocumentBroker Object Loader Version 3

[目次][索引][前へ][次へ]

5.3.3 制御ファイルの構成

制御ファイルは,三つのセクションとセクションを構成する幾つかのエントリで構成されます。

次に制御ファイルに記述するセクションと機能の概要を示します。

表5-2 制御ファイルのセクションと機能概要

セクション名 機能概要
Control 入力データファイルの記述形式やオブジェクトエクスポートの動作を制御する情報を定義する。
DataMapping ユーザが追加するクラスに対するプロパティの並びやDocumentBroker標準クラスにユーザが追加するプロパティの並びを定義する。
Export 文書の出力先を定義する。
<この項の構成>
(1) Controlセクション
(2) DataMappingセクション
(3) Exportセクション

(1) Controlセクション

DocumentBroker Object Loaderの動作を制御する情報を指定するセクションです。

(a) ErrorLogエントリ

エラーログファイルの出力先をファイルパスで指定します。詳細は「4.3.3(1)(a) ErrorLogエントリ」を参照してください。また,エラーログファイルの機能については,「1.5.2 ファイル環境(オブジェクトエクスポート)」を参照してください。

表5-3に指定値に対するオブジェクトエクスポートの動作を示します。省略時にはエラーログを出力しません。指定時でエラーが発生した場合は,エラーメッセージを出力してプログラムを終了します。

表5-3 ErrorLog指定値に対するオブジェクトエクスポートの動作

ErrorLog 状態 動作
省略時 エラーログファイルは出力しない
指定時 パス不正 エラー(DocumentBroker Object Loader実行不可能)
ファイル権限なし エラー(DocumentBroker Object Loader実行不可能)
ファイルがすでに存在 上書きでエラーログファイルを出力する
(b) ErrorDataFileエントリ

エラーデータファイルの出力先をファイルパスで指定します。詳細は「4.3.3(1)(b) ErrorDataFileエントリ」を参照してください。また,エラーデータファイルの機能については,「1.5.2 ファイル環境(オブジェクトエクスポート)」を参照してください。

表5-4に指定値に対するオブジェクトエクスポートの動作を示します。省略時または指定時でエラーが発生した場合は,エラーメッセージを出力してプログラムを終了します。

表5-4 ErrorDataFile指定値に対するオブジェクトエクスポートの動作

ErrorDataFile 状態 動作
省略時 エラー(オブジェクトエクスポート実行不可能)
指定時 パス不正 エラー(オブジェクトエクスポート実行不可能)
ファイル権限なし エラー(オブジェクトエクスポート実行不可能)
ファイルがすでに存在 上書きでエラーデータファイルを出力する
(c) ColumnSeparatorエントリ

入力データファイル中のカラム間区切り文字(1バイト)を引用符(")で囲んで指定します。詳細は「4.3.3(1)(d) ColumnSeparatorエントリ」を参照してください。

(d) RecordSeparatorエントリ

入力データファイル中の行間区切り文字(1バイト)を引用符(")で囲んで指定します。詳細は「4.3.3(1)(e) RecordSeparatorエントリ」を参照してください。

(e) MsgIntervalエントリ

機能
処理の経過を示すメッセージ(KMBV11014-I)を出力する間隔を指定します。

指定形式
MsgInterval = 行数

指定規則
  • 指定する行数はオブジェクトローダ入力データファイルのコマンド行数に相当します。0〜2147483647の間の10進表記で指定してください。
  • 省略時は,「10000」が仮定されます。
  • 0を指定した場合はメッセージを出力しません。
  • 数値以外や範囲外の数値が指定された場合は,省略時の値を仮定します。
  • 指定値を小さくする程,処理の経過を示すメッセージが頻繁に出力されますので,登録するデータ行に応じて適切な値を設定してください。

(2) DataMappingセクション

機能
定義ファイルのClassNameDefinitionセクションで定義したクラスとプロパティの対応関係を定義するセクションです。オブジェクトエクスポートは,DataMappingセクションのエントリの右辺に記述したプロパティに対して,オブジェクトローダの入力データファイルにプロパティ値を出力します。

指定形式
エントリは定義ファイルのClassNameDefinitionセクションで定義したクラスの最上位クラスごとに次の形式で記述します。
 
クラス名=プロパティ名[,プロパティ名…]
プロパティ名::={プロパティ名 | VariableArray型プロパティ名 | システム定義プロパティ名}
 

指定規則
  • プロパティ名には,定義ファイルのPropNameDefinitionセクションで定義したプロパティ名を指定してください。クラス関連ファイルで関連を定義している場合は,「登録先クラス名@」をプロパティ名に修飾して指定してください。
  • 登録先クラス名は省略可能です。省略した場合に適用するクラスを次に示します。

    表5-5 登録先クラス名を省略した場合に適用するクラス

    プロパティ種別 省略時のクラス
    ユーザ定義 左辺に定義したクラス
    システム定義 DocumentBroker標準のクラス
    登録先クラス名が定義ファイルに定義されていない場合や登録先クラスが存在しない場合は,エラーメッセージ(KMBV11049-E)を出力してプログラムを終了します。
  • 定義ファイルのClassNameDefinitionセクションで一つのConfigurationHistoryクラスに対して複数のクラス名を定義している場合,クラス名の記述順序は,定義ファイルのClassNameDefinitionセクションの記述順序に合わせてください。
  • VariableArray型プロパティ名の場合,edmClass_Structクラスのサブクラスを要素とするプロパティを指定するときは,「edmClass_Structサブクラス名.」をプロパティ名に修飾して指定してください。
  • システム定義プロパティ名は,システム定義のプロパティを「**PROP_xxx**」という形式で指定してください。指定できるシステム定義プロパティについては,「5.6.2(4)(d) プロパティ値カラム」を参照してください。
  • **PROP_CT_PATH**プロパティは指定できません。指定した場合,エラーメッセージ(KMBV11049-E)が出力されます。

指定例
DataMappingセクションの指定例を次に示します。

図5-1 DataMappingセクションの指定例

[図データ]
定義ファイルのClassNameDefinitionセクションで,一つのConfigurationHistoryクラスに対して複数のクラス名を定義しているときのDataMappingセクションの記述順序を図5-2に示します。
定義ファイルのClassNameDefinitionセクションの詳細については,「5.4.3(1) ClassNameDefinitionセクション」を参照してください。

図5-2 ClassNameDefinitionセクションとDataMappingセクションの記述順序

[図データ]

(3) Exportセクション

オブジェクトエクスポートの実行時に必要な制御情報を記述するセクションです。

(a) DocDirエントリ

文書のコンテントを格納するディレクトリパスを指定します。ここで指定したディレクトリパスが**PROP_CT**プロパティのパス名となります。ディレクトリパスは,絶対パス(255バイト以内)で指定します。ディレクトリパスには,文書空間で使用する文字コード種別またはASCIIコードを使用できます。文字コード種別としてUTF-8を使用する場合,ファイルにはBOMを付けないでください。パスの指定方法については「4.2.2(3) パスの指定方法」を参照してください。

表5-6に,指定値に対するオブジェクトエクスポートの動作を示します。省略時または指定時にエラーが発生した場合はエラーメッセージ(KMBV11421-E)を出力してプログラムを終了します。

表5-6 DocDir指定値に対するオブジェクトエクスポートの動作

DocDir 状態 動作
省略時 エラー(オブジェクトエクスポート実行不可能)
指定時 パスがすでに存在する エラー(オブジェクトエクスポート実行不可能)
パスが不正 エラー(オブジェクトエクスポート実行不可能)
パスが存在しない パスを作成する

実際のコンテントのパスの構成は次のとおりです。

DocDirエントリの値+ユニークな名称+**PROP_CT**の値(ファイル名)

(凡例)Windowsの場合
ユニークな名称: "\"+最上位オブジェクトのOIID
**PROP_CT**の値(ファイル名): "\"+dmaProp_RetrievalNameプロパティに設定されている値
 
  • dmaProp_RetrievalNameプロパティが未設定の場合は,「DocDirエントリの値+ユニークな名称」が仮定されます。
  • dmaProp_RetrievalNameプロパティが設定されているが,コンテントが取得できない(コンテント格納先プロパティが未設定)場合,ファイルは作成されないで,「"/"+dmaProp_RetrievalNameプロパティに設定されている値」が仮定されます。
UNIXの場合,ディレクトリの区切り文字が「/」になります。