付録E.3 UOCのインターフェースの詳細

<この項の構成>
(1) 入力情報
(2) 出力情報

(1) 入力情報

レンダリングオプションは,UOCを起動する際に,引数にパラメタファイルのファイルパスをフルパスで設定してUOCに渡します。レンダリングオプションが設定するパラメタファイルの内容は次のとおりです。

[UserParam]
infile=変換元ファイルパス
infile2=PostScript形式の変換元ファイルパス
outfile=変換対象ファイルパス
renditiontype=レンディションタイプ
retrievalname=リトリーバルネーム
[RecordInfo]
classname=変換対象のDMAクラスの文書クラス名(dmaClass_DocVersionまたはそのサブクラスの名称)
recordnum=取得したレコード数
propnum=取得したプロパティ数
[Record<n>]
prop<n>=プロパティ値

UOCのパラメタファイルに設定されるセクションおよびエントリについて,次に示す表で説明します。

表E-1 UOCのパラメタファイルに設定されるセクションおよびエントリ

セクション名エントリ名説明
UserParaminfile変換元ファイルのファイルパスがフルパスで設定されます。
infile2変換元ファイルを印刷処理によって変換したPostScript形式のファイルのファイルパスがフルパスで設定されます。
outfilePDF変換の入力ファイルとなる変換対象ファイルのファイルパスがフルパスで設定されます。
renditiontype変換元ファイルのレンディションタイプが設定されます。
retrievalname変換元ファイルのリトリーバルネームが設定されます。
RecordInfo※1classname変換対象のDMAクラスの文書クラス名(dmaClass_DocVersionまたはそのサブクラスの名称)が設定されます。
recordnumSQL情報ファイルに記述されているSQLを実行して取得した,処理対象のDMAクラスの文書クラス(dmaClass_DocVersionまたはそのサブクラス)のレコード数が設定されます。
設定されるレコード数の上限は32です。33個以上のレコードを取得した場合は,32が設定されます。
propnumSQL情報ファイルに記述されているSQLを実行して取得した,処理対象のDMAクラスの文書クラス(dmaClass_DocVersionまたはそのサブクラス)の各レコードを構成するプロパティの数が設定されます。
設定されるプロパティの数の上限は32です。33個以上のプロパティを取得した場合,32が設定されます。
Record<n>※1※2prop<n>SQL情報ファイルに記述されているSQLを実行して取得した,処理対象のDMAクラスの文書クラス(dmaClass_DocVersionまたはそのサブクラス)のレコードを構成するプロパティの値が設定されます。prop<n>エントリは取得したプロパティの数だけ設定されます(<n>は1からの通番)。
なお,SQL文の実行によって取得できるのは,Integer32型およびString型のプロパティだけです。prop<n>エントリの設定例を次に示します。
Integer32型のプロパティの場合
ダブルクォート(")で囲まれた符号付き整数が設定されます。プロパティの値がNULLの場合,"0"が設定されます。
(例)
 prop1="12345"
 prop2="-12"
 prop3="0"
String型のプロパティの場合
ダブルクォート(")で囲まれた文字列が設定されます。プロパティの値が,0バイトの文字列またはNULLの場合,空文字列("")が設定されます。
(例)
 prop1="manual"
 prop2=""
注※1
レンディション変換プラグイン設定ファイル(EDMRDRPlugins.ini)で指定したSQL情報ファイルに,変換対象クラスが定義されている場合だけ設定されます。
注※2
Record<n>セクションは,SQL情報ファイルに記述されているSQLを実行して取得したレコードの数だけ設定されます(<n>は1からの通番)。

UOCは変換対象ファイルを次の流れで作成する必要があります。

  1. infileエントリに設定された変換元ファイル,infile2エントリに設定されたPostScript形式の変換元ファイル,およびパラメタファイルに設定されている各種情報を取得する
  2. 取得した各種情報を利用して,outfileエントリに設定された変換対象ファイルを作成する

(2) 出力情報

処理を完了したあと,UOCがパラメタファイルに書き込む内容は,次のとおりにしてください。

[UserParam]
outfile=変換対象ファイルパス
errorcode=変換結果コード
errormsg=エラーメッセージ

各エントリに設定する必要のある値は,次のとおりです。