uCosminexus DocumentBroker Rendering Option Version 3

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

6.1.3 レンディション変換プラグイン設定ファイル(EDMRDRPlugins.ini)

レンディション変換プラグイン設定ファイル(EDMRDRPlugins.ini)は,レンディション変換で使用するレンディション変換プラグインの設定を行うファイルです。

レンディション変換プラグイン設定ファイルの設定例を次に示します。

<PDFstaffを使用する場合>
 
[plugin1]
plugin=<インストールディレクトリ>\bin\EDMRDRPFGPDF.DLL
to=application/pdf
from1=application/msword
from2=application/vnd.ms-excel
from3=application/vnd.ms-powerpoint
from4=application/vnd.visio
from5=application/rtf
from6=application/jxw
from7=text/plain
from8=image/tiff
from9=image/jpeg
from10=image/gif
from11=image/png
from12=application/postscript
from13=message/rfc822
from14=application/vnd.ms-word.document.macroEnabled.12
from15=application/vnd.openxmlformats-officedocument.wordprocessingml.document
from16=application/vnd.ms-excel.sheet.binary.macroEnabled.12
from17=application/vnd.ms-excel.sheet.macroEnabled.12
from18=application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
from19=application/vnd.ms-powerpoint.presentation.macroEnabled.12
from20=application/vnd.openxmlformats-officedocument.presentationml.presentation
opt_endpoint= http://servername:port/pdfg-ws/services/PdfGenInterface
opt_useproxy=false
opt_proxyservername=
opt_proxyserverport=
opt_proxyusrname=
opt_proxyusrpassword=
opt_maxpsfilesizews=
opt_timeout=
opt_converttopstimeout=
opt_pollinginterval=
opt_printer=Acrobat Distiller J
opt_joboptionsettingname=
opt_securitysettingname=
opt_filetypesettingname=
opt_bookmarkautocreate=false
opt_pptfittopage=true
opt_messagelocale=ja_JP
opt_pdfgenerator=7
opt_webserviceuser=
opt_webservicepass=
 

<Microsoft Officeを使用する場合>
 
[plugin1]
plugin=<インストールディレクトリ>\bin\EDMRDRPLWD12.DLL
to=application/pd
from1=application/msword
from2=application/rtf
from3=application/vnd.ms-word.document.macroEnabled.12
from4=application/vnd.openxmlformats-officedocument.wordprocessingml.document
from5=text/plainplugin_timeout=
 
[plugin2]
plugin=<インストールディレクトリ>\bin\EDMRDRPLXL12.DLL
to=application/pdf
from1=application/vnd.ms-excel
from2=application/vnd.ms-excel.sheet.binary.macroEnabled.12
from3=application/vnd.ms-excel.sheet.macroEnabled.12
from4=application/vnd.openxmlformats-officedocument.spreadsheetml.sheetplugin_timeout=
 
[plugin3]
plugin=<インストールディレクトリ>\bin\EDMRDRPLPP12.DLL
to=application/pdf
from1=application/vnd.ms-powerpoint
from2=application/vnd.ms-powerpoint.presentation.macroEnabled.12
from3=application/vnd.openxmlformats-officedocument.presentationml.presentationplugin_timeout=
 

レンディション変換プラグイン設定ファイルに設定できるセクションは,plugin<n>セクションです。<n>は1からの通番で,plugin1からplugin32まで最大32個のセクションを指定できます。1個のセクションが1個のレンディション変換プラグインの定義となります。33個以上のセクションを指定した場合,33個目以降のセクションは無視されます。最低1個のセクションを定義することが必要です。デフォルトでは<PDFstaffを使用する場合>のplugin1セクションが設定されています。

plugin<n>セクションに設定できるエントリについて,基本設定,PDF変換プラグインのオプション設定,およびユーザ定義プラグインの設定に分けて説明します。

<この項の構成>
(1) レンディション変換プラグイン設定ファイルの基本設定
(2) PDFstaffを使用する場合のレンディション変換プラグイン設定ファイルのオプション設定
(3) レンディション変換プラグイン設定ファイルのユーザ定義プラグインの設定
(4) SQL情報ファイル

(1) レンディション変換プラグイン設定ファイルの基本設定

レンディション変換プラグイン設定ファイルの基本設定用エントリを次の表に示します。

表6-3 レンディション変換プラグイン設定ファイルの基本設定用エントリ

エントリ名 説明 省略時の仮定値 インストール時の値
plugin 使用するレンディション変換プラグインのファイルパスをフルパスで指定します。省略はできません。
次に示すプラグインのファイルパスが指定できます。

PDFstaffを使用する場合
<インストールディレクトリ>\bin\EDMRDRPFGPDF.DLL

Microsoft Officeを使用する場合
次のどれかを指定してください。
  • 変換元レンディションタイプがWordのとき
    <インストールディレクトリ>\bin\bin\EDMRDRPLWD12.DLL
  • 変換元レンディションタイプがExcelのとき
    <インストールディレクトリ>\bin\bin\EDMRDRPLXL12.DLL
  • 変換元レンディションタイプがPowerPointのとき
    <インストールディレクトリ>\bin\bin\EDMRDRPLPP12.DLL

ユーザ定義プラグイン
<ユーザ定義プラグインの実行ファイル>
必須 <インストールディレクトリ>\bin\EDMRDRPFGPDF.DLL
plugin_timeout Microsoft Officeを使用する場合,またはユーザ定義プラグインを使用する場合,プラグインの変換処理のタイムアウト値をミリ秒単位で指定します。
指定できる値の範囲は300000〜4294967295です。
0を指定すると,タイムアウト値は無限となります。
PDFstaffを使用する場合,このエントリは指定しないでください。PDFstaffの変換処理のタイムアウト値は,opt_timeoutエントリとopt_converttopstimeoutエントリで指定してください。
1800000 なし
to 変換先レンディションタイプを指定します。省略はできません。
先頭の"MIME::"を取り除いて249バイト以内で指定します。
レンディションタイプの詳細は,「6.5 レンディションタイプの指定方法」を参照してください。
必須 application/pdf
from<n> pluginエントリで指定したレンディション変換プラグインが受け付ける変換元レンディションタイプを指定します。省略はできません。
エントリ名の<n>は,1からの通番です。
from1からfrom100まで最大100個のエントリを指定できます。101個以上のエントリを指定した場合,101個目以降のエントリは無視されます。
各エントリのレンディションタイプは,先頭の"MIME::"を取り除いて249バイト以内で指定します。
レンディションタイプの詳細は,「6.5 レンディションタイプの指定方法」を参照してください。
必須(最低1個)
  • application/msword
  • application/vnd.ms-excel
  • application/vnd.ms-powerpoint
  • application/vnd.visio
  • application/rtf
  • application/jxw
  • text/plain
  • image/tiff
  • image/jpeg
  • image/gif
  • image/png
  • application/postscript
  • message/rfc822
  • application/vnd.ms-word.document.macroEnabled.12
  • application/vnd.openxmlformats-officedocument.wordprocessingml.document
  • application/vnd.ms-excel.sheet.binary.macroEnabled.12
  • application/vnd.ms-excel.sheet.macroEnabled.12
  • application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
  • application/vnd.ms-powerpoint.presentation.macroEnabled.12
  • application/vnd.openxmlformats-officedocument.presentationml.presentation
uoc UOCを実行する場合,UOCを格納したファイルのファイルパスをフルパスで指定します。指定を省略すると,UOCは無効となります。
このエントリは,PDFstaffを使用する場合だけ有効になります。Microsoft Officeを使用する場合,およびユーザ定義プラグインを使用する場合は,このエントリの指定は無視されます。
なし なし
uoc_sql UOCでプロパティ値を利用する場合は,SQL情報ファイルのファイルパスをフルパスで指定します。指定を省略すると,UOCのパラメタファイルにプロパティ値が格納されません。
このエントリは,PDFstaffを使用する場合だけ有効になります。Microsoft Officeを使用する場合,およびユーザ定義プラグインを使用する場合は,このエントリの指定は無視されます。
SQL情報ファイルの詳細は,「(4) SQL情報ファイル」を参照してください。
なし なし

(2) PDFstaffを使用する場合のレンディション変換プラグイン設定ファイルのオプション設定

PDFStaffを使用する場合,PDF変換のオプション設定ができます。レンディション変換プラグイン設定ファイルのPDF変換プラグインのオプション設定用エントリを次の表に示します。

表6-4 レンディション変換プラグイン設定ファイルのPDF変換プラグインのオプション設定用エントリ

エントリ名 説明 省略時の仮定値 インストール時の値
opt_endpoint Adobe LiveCycle PDF Generatorのサービスエンドポイントを指定します。省略はできません。
Adobe LiveCycle PDF Generatorのサービスエンドポイントは,通常の場合はhttp://servername:port/pdfg-ws/services/PdfGenInterfaceの形式になります。
Adobe LiveCycle PDF Generator ES2の場合はhttp://servername:8080/soap/services/?blob=dimeの形式となります。
必須 http://servername:port/pdfg-ws/services/PdfGenInterface
opt_useproxy Adobe LiveCycle PDF Generatorに接続する場合にプロキシを使用するかどうかを指定します。
指定できる値は次のとおりです。
true:プロキシを使用します。
false:プロキシを使用しません。
false false
opt_proxyservername Adobe LiveCycle PDF Generatorに接続する場合に使用するプロキシサーバのサーバ名を指定します。 "" なし
opt_proxyserverport Adobe LiveCycle PDF Generatorに接続する場合に使用するプロキシサーバのポート番号を指定します。 0 なし
opt_proxyusrname Adobe LiveCycle PDF Generatorに接続する場合に使用するプロキシの認証ユーザ名を指定します。プロキシサーバの認証が必要なときだけ指定します。 "" なし
opt_proxyusrpassword Adobe LiveCycle PDF Generatorに接続する場合に使用するプロキシの認証ユーザのパスワードを指定します。プロキシサーバの認証が必要なときだけ指定します。 "" なし
opt_maxpsfilesizews Adobe LiveCycle PDF GeneratorのWebサービスに対して,PostScriptをPDFへ変換処理依頼する際のファイルサイズの上限を指定します。 262,144,000(約250メガバイト) なし
opt_timeout Adobe LiveCycle PDF GeneratorのWebサービスに対して,PostScriptをPDFへ変換処理依頼する際のタイムアウト時間をミリ秒単位で指定します。
指定できる値の範囲は0〜2147483647です。
0を指定すると,タイムアウト値は無限となります。
270,000(270秒) なし
opt_converttopstimeout PDFstaffがファイルをPostScriptへ変換する際のタイムアウト時間をミリ秒単位で指定します。
指定できる値の範囲は0〜2147483647です。
0を指定すると,2147483647を指定したときと同じ動作をします。
なお,実際にタイムアウトする時間は,処理のオーバーヘッドなどによって,指定した値よりも大きくなることがあります。
PDFstaff 仮想フォルダのセッションタイムアウト値 (IISの設定)※1,または1,200,000(20分)※2 なし
opt_pollinginterval PDFstaffがAdobe LiveCycle PDF Generatorの処理状況をポーリングする間隔をミリ秒単位で指定します。指定できる値の範囲は0〜2147483647です。
Adobe LiveCycle PDF Generator ES2の場合,このエントリに値を指定しても無視されます。
5000(5秒) なし
opt_printer PDFstaffがOffice文書,HTMLページ(html),および一太郎文書をPDFに変換する過程で使用するPostScriptプリンタドライバのプリンタ名を指定します。
プリンタ名に指定できる文字は,半角英数字,アンダースコア「_」,ピリオド「.」,およびハイフン「-」です。220バイトまで指定できます。
必須 Acrobat Distiller J
opt_joboptionsettingname Adobe LiveCycle PDF GeneratorがPostScriptをPDFに変換する際に使用するAdobe PDF設定名を指定します。Adobe LiveCycle PDF Generatorに登録されているAdobe PDF設定名を文字列で指定します。""(空文字)を指定すると,Adobe LiveCycle PDF Generatorでデフォルトとして設定されているAdobe PDF設定が使用されます。 "" なし
opt_securitysettingname Adobe LiveCycle PDF GeneratorがPostScriptをPDFに変換する際に使用するセキュリティ設定名を指定します。Adobe LiveCycle PDF Generatorに登録されているセキュリティ設定名を文字列で指定します。""(空文字)を指定すると,Adobe LiveCycle PDF Generatorでデフォルトとして設定されているセキュリティ設定名が使用されます。 "" なし
opt_filetypesettingname Adobe LiveCycle PDF GeneratorがPostScriptをPDFに変換する際に使用するファイルタイプ設定名を指定します。このエントリは,指定を省略するか,または空文字を設定して使用してください。""(空文字)を指定すると,Adobe LiveCycle PDF Generatorでデフォルトとして設定されているファイルタイプ設定が使用されます。 "" なし
opt_bookmarkautocreate Word文書をPDFに変換するときに,Wordの見出しからPDFのしおりを作成するかどうかを指定します。
指定できる値は次のとおりです。
true:PDFのしおりを作成します。
false:PDFのしおりを作成しません。
このエントリでtrueを指定した場合でも,目次のリンク,図表番号への相互参照,URLリンクなど,文書中のリンク情報は作成されません。

注意
しおりを作成すると,レンダリングオプションに非常に大きな負荷が掛かり,PCのCPUを長時間独占します。しおりの作成処理は,同じPC上で並列に動作しているほかの処理の処理性能に大きな影響を与えますので,使用するときは十分注意してください。
しおりの生成は次のように処理されます。
見出しの途中にある制御コード文字はスペースに変換されます。
見出しの前後の空白や制御コード文字は削除されます。見出しの前後の空白や制御コード文字が削除されたことによって文字列の長さが0になったときは,しおりは生成されません。
見出しレベルの低い見出しは,直前のより高いレベルの見出しの子のしおりとして,生成されます。ただし,直前により高いレベルの見出しが存在しない場合,トップレベルのしおりとして生成されます。
false false
opt_pptfittopage PowerPoint文書をPostScriptまたはPDFに変換するときに,ページを用紙サイズに合わせて作成するかどうかを指定します。
指定できる値は次のとおりです。
true:用紙サイズに合わせて作成します。
false:用紙サイズに合わせて作成しません。
このエントリでtrueを指定した場合,PowerPointのページ設定で指定した用紙サイズではなく,PostScriptプリンタドライバのデフォルト用紙設定のサイズに合わせて(内容が拡大または縮小されて)PDFが作成されます。
また,このエントリでfalseを指定した場合,PDF作成時に内容が用紙からはみ出して出力されたり,中央に小さく縮小されて出力されたりすることがあります。
true true
opt_messagelocale Adobe LiveCycle PDF Generatorが返すメッセージのロケールを文字列で指定します。
Adobe LiveCycle PDF Generator ES2の場合,このエントリに値を指定しても無視されます。
ja_JP ja_JP
opt_pdfgenerator 使用するAdobe LiveCycle PDF Generatorを指定します。指定できる値は次のとおりです。
  • 7:Adobe LiveCycle PDF Generator for PostScript 7.0,または7.2を使用します。
  • ES:Adobe LiveCycle PDF Generator ES2を使用します。
7 7
opt_webserviceuser Adobe LiveCycle PDF Generator ES2サーバのWeb サービスを利用する際の認証ユーザ名を指定します。opt_pdfgeneratorにESを指定したときにだけ指定します。 "" なし
opt_webservicepass Adobe LiveCycle PDF Generator ES2サーバのWeb サービスを利用する際の認証パスワードを指定します。opt_pdfgeneratorにESを指定したときにだけ指定します。 "" なし

注※1
PDFstaff WebまたはPDFstaff Serverがインストールされている場合

注※2
次のどちらかの場合,省略時の仮定値となります。
・PDFstaff WebまたはPDFstaff Serverがインストールされていない場合
・PDFstaffがPDFstaff仮想フォルダのセッションタイムアウト値の取得に失敗した場合

(3) レンディション変換プラグイン設定ファイルのユーザ定義プラグインの設定

レンディション変換プラグイン設定ファイルのユーザ定義プラグインの設定用エントリを次の表に示します。

表6-5 レンディション変換プラグイン設定ファイルのユーザ定義プラグインの設定用エントリ

エントリ名 説明 省略時の仮定値 インストール時の値
user_plugin_name ユーザ定義プラグインの名称を63バイト以内で指定します。
このエントリで指定した名称は,エラーログ出力時に使用されます。
pluginエントリにユーザ定義プラグインを指定した場合は,必ず指定してください。
pluginエントリにユーザ定義プラグインを指定していない場合,このエントリを指定しても無視されます。
なし なし
user_subprocess_name ユーザ定義プラグインでの変換タイムアウト発生時に,ユーザ定義プラグインの強制停止と同時に停止するサブプロセスの名称を指定します。
セミコロン(;)で区切って最大8個のサブプロセスが指定できます。
各サブプロセスの名称は,パスを含めないで,31バイト以内で指定します。

(例)
SUB1.EXE;SUB2.EXE
pluginエントリにユーザ定義プラグインを指定していない場合,このエントリを指定しても無視されます。
なし なし
user_stop_waittime ユーザ定義プラグインを中断するときにユーザ定義プラグインの終了を待つ期間をミリ秒単位で指定します。
指定できる値の範囲は10000〜60000です。
0を指定すると,ユーザ定義プラグインの終了を待たずにユーザ定義プラグインのプロセスを強制終了します。
10000〜60000の値を指定した場合,イベント "EDMRDR_UserPlugin_StopEvent"をシグナル状態とした後,指定した期間,ユーザ定義プラグインの終了を待ちます。
pluginエントリにユーザ定義プラグインを指定していない場合,このエントリを指定しても無視されます。
0 なし
user_input_extensions ユーザ定義プラグインが処理できる変換元ファイルの拡張子を指定します。
セミコロン(;)で区切って複数個指定できます。セミコロンを含めて全体で255バイト以内で指定します。大文字・小文字は区別されません。指定を省略すると,どの拡張子のファイルでも処理できると見なされます。

(例)
.CSV;.DAT
pluginエントリにユーザ定義プラグインを指定していない場合,このエントリを指定しても無視されます。
なし なし
user_output_extension ユーザ定義プラグインが作成する変換先ファイルの拡張子を32バイト以内で指定します。大文字・小文字は区別されません。

(例)
.CSV
pluginエントリにユーザ定義プラグインを指定していない場合,このエントリを指定しても無視されます。
必須 なし

(4) SQL情報ファイル

UOCでプロパティ値を利用するときは,プロパティ値を取得するためのSQL文をSQL情報ファイルに設定します。

SQL情報ファイルに設定できるセクションは,<文書クラス名>セクションです。

<文書クラス名>には,DMAクラスdmaClass_DocVersionまたはそのサブクラス名を指定できます。複数のクラスが対象の場合は,複数のセクションを指定できます。最大32個のセクションを指定できます。33個以上のセクションを指定した場合,33個目以降のセクションは無視されます。指定した<文書クラス名>が存在しない場合,または指定した<文書クラス名>がDMAクラスdmaClass_DocVersion またはそのサブクラス名でない場合は,エラーメッセージKMBX11311-Eが出力されます。

SQL情報ファイルに設定できるエントリを次の表に示します。

表6-6 SQL情報ファイルに設定できるエントリ

エントリ名 説明 省略時の仮定値 インストール時の値
sql プロパティ値を取得するためのSQL文を指定します。SQL文の文法は,マニュアル「DocumentBroker Version 3 クラスライブラリ C++ 解説」またはマニュアル「DocumentBroker Version 3 クラスライブラリ Java 解説」を参照してください。
また,SQL文には,?パラメタを利用してDocVerのdmaProp_OIIDと完全一致させる条件を付与する必要があります。
sqlエントリには,8,192バイトまでのSQL文が指定できます。8,192バイトを超えるSQL文を指定した場合,8,193バイト以降が切り捨てられます。
エントリの指定,またはエントリの値の指定がないときは,セクションの指定が無視されます。
なし なし

sqlエントリの記述例を次に示します。なお,sqlエントリは1行で記述します。△は半角の空白です。

(例)
sql=select△dmaProp_OIID,任意のプロパティ,…△from△usrClass_DocVer△where△dmaProp_OIID=?△and△<その他の条件>