4. プログラミング¶
4.1. 動作概念¶
通常の JavaEE開発モデル スクリプト開発モデル プログラムは、ApplicationRuntime で実行されます。
IM-PDFAutoConverter for Accel Platform で提供されるAPI も、そのほとんどはApplicationRuntime で動作しますが、実際にPDFファイルを生成するのは PDF変換サーバ です。
以下の方法でPDF変換を行うことができます。詳しくは、APIリストを参照してください。
No. | メソッド | 説明 |
---|---|---|
1 | String convert ( String inFilePath, String outFilePath ) | 変換対象ファイルのパスと変換後ファイルのパスを渡して、PDF 変換を行います。いずれのパスもApplicationRuntime側のパスを指定してください。 |
コラム
PDF ファイル作成の際にサーバ間でネットワーク通信が発生します。したがって、PDF生成処理のレスポンス時間はネットワーク環境に影響を受けます。
4.2. タイムアウトについて¶
PDF変換サーバ に依頼された変換処理は、順番待ち(キュー)の状態となり、一度に大量のPDF変換を指示しても1件ずつ処理される仕組みとなっています。
そのため、大量のPDF変換を指示すると、順番待ちとなったファイルは指示開始から変換処理までに数分以上掛かることもあり、タイムアウトが発生する可能性があります。
大量のPDF変換を指示する場合は、上位アプリケーション側でタイムアウトまでの時間延長設定、または、タイムアウト時にリトライする仕組みなどの対応を検討してください。
AutoExRemote クラスは、以下3種類のタイムアウトを利用します。
詳しくは、APIリストを参照してください。
3種類のタイムアウト設定
- 一定時間経過してもPDF変換処理がはじまらない場合
- 一定時間経過してもPDF変換処理が終わらない場合
- 一定時間経過してもネットワークが返ってこない場合
No. | メソッド | 説明 |
---|---|---|
1 | setBeforeTimeoutSec ( int timeoutSec ) | 変換前のタイムアウト秒数を設定します。PDF 変換依頼を投げてから、PDF 変換処理を開始するまでのタイムアウト時間を設定します。タイムアウト時間を過ぎると、PDF 変換依頼は削除され次の変換処理に移ります。大量のPDF変換処理をおこなうシステムでは処理のキューが溜まりますので、このタイムアウト値は非常に重要です。通常は、0(タイムアウトしない)を指定してください。 |
2 | setTimeoutSec ( int timeoutSec ) | 変換後のタイムアウト秒数を設定します。PDF 変換処理が開始してからのタイムアウト時間を設定します。タイムアウト時間を過ぎると、変換処理は削除され次の変換処理に移ります。このタイムアウトは、必ず設定してください。 |
3 | setTransTimeoutSec ( int timeoutSec ) | 【必須】 SOAPの接続タイムアウト“ミリ”秒数を設定します。短すぎると結果が受け取れません。 |
コラム
PDF 変換処理のタイムアウトを変更した場合は、intara-mart のセッションタイムアウトについてもご確認ください。PDF 変換処理が完了する前にintra-mart のセッションタイムアウトが発生した場合、変換結果を受け取ることができません。 intra-mart のセッションタイムアウトの設定については、intra-mart のドキュメントをご確認ください。
4.3. APIの種類と性質¶
IM-PDFAutoConverter for Accel Platform は、次のAPIを用意しています。
- JavaEE開発モデル で利用可能なJava-API(クラス)
- スクリプト開発モデル で利用可能なスクリプトAPI(クラス)
4.4. プログラム開発における注意点¶
IM-PDFAutoConverter for Accel Platform が提供するAPIで変換元ファイルのパスを指定する際には、AppRuntimeからアクセス可能なパスを指定してください。
作成するPDFファイルのサイズによっては、ネットワーク、APIのレスポンス、PDFファイルがディスク上に完全に書き出されるタイミングが大きく異なる場合があります。
特にサイズの大きいPDFファイルを作成する場合は、十分な時間が経過した後に作成したPDF ファイルにアクセスするようにして下さい。
4.5. 体験版ライセンスにおける注意点¶
試用版ライセンスでご利用のお客様は、30~60 日間の試用期間が終了するとPDF作成APIが自動的に利用できない状態となります。
この状態でPDF作成APIを利用したプログラムを実行した場合に、実行時エラーとなります。
その場合は、正規の製品ライセンスを購入いただき、アンインストール後に再インストールしてください。
アンインストール・再インストールの方法は、インストールマニュアルをご確認ください。