IM-PDFAutoConverter for Accel Platform プログラミングガイド 第16版 2024-10-01

4. プログラミング

4.1. APIの種類と性質

IM-PDFAutoConverter for Accel Platform は、次のAPIを用意しています。

  • JavaEE開発モデル で利用可能なJava-API(クラス)
  • スクリプト開発モデル で利用可能なスクリプトAPI(クラス)

4.2. プログラム開発における注意点

4.2.1. ファイルパスの指定方法について注意してください

変換対象ファイルや、出力先ファイルのパスを指定する際、 intra-mart Accel Platform からアクセス可能な絶対パスを指定してください。

4.2.2. ファイルサイズの大きいPDFファイルは、出力処理に時間がかかる場合があります

ファイルサイズの大きいPDFファイルを作成する際、出力処理に時間がかかり、APIのレスポンスとPDFファイルがディスク上に完全に書き出されるタイミングが大きく異なる場合があります。

サイズの大きいPDFファイルを作成する場合は、出力処理の時間を考慮し、十分な時間が経過した後に、出力されたPDFファイルにアクセスするようにしてください。

4.2.3. HTML→PDF変換 の実行方法には制限があります

HTML→PDF変換 の実行方法には、次の制限があります。

  • ジョブで実行する場合、PDF変換ができません。

  • IM-Workflow のユーザプログラムで実行する場合、セッション情報、および、案件情報が必要になるため、次の処理以外ではPDF変換ができません。

    • 承認ノード、または、動的承認ノードのアクション処理
    • 分岐終了処理

4.2.4. 大量のPDF変換を指示した場合、タイムアウトが発生する可能性があります

IM-PDFAutoConverter for Accel Platform に依頼された変換処理は、順番待ち(キュー)の状態となり、一度に大量のPDF変換を指示しても、次のように処理される仕組みです。

  • Office系→PDF変換 :1件ずつ処理される
  • HTML→PDF変換 :設定ファイルで設定された起動数ずつ処理される

そのため、大量のPDF変換を指示すると、順番待ちとなったファイルは指示開始から変換処理までに数分以上掛かることもあり、タイムアウトが発生する可能性があります。

大量のPDF変換を指示する場合は、上位アプリケーション側でタイムアウトまでの時間延長設定、または、タイムアウト時にリトライする仕組みなどの対応を検討してください。

IM-PDFAutoConverter for Accel Platform のAPIは、次のタイムアウトを利用します。

  • Office系→PDF変換

    JavaEE開発モデル スクリプト開発モデル 説明
    setBeforeTimeoutSec(int timeoutSec) setBeforeTimeoutSec(Number timeoutSec) 変換前のタイムアウト秒数を設定します。PDF変換依頼を投げてから、PDF変換処理を開始するまでのタイムアウト時間を設定します。タイムアウト時間を過ぎると、PDF変換依頼は削除され次の変換処理に移ります。大量のPDF変換処理をおこなうシステムでは処理のキューが溜まりますので、このタイムアウト値は非常に重要です。通常は、0(タイムアウトしない)を指定してください。
    setTimeoutSec(int timeoutSec) setTimeoutSec(Number timeoutSec) 変換後のタイムアウト秒数を設定します。PDF変換処理が開始してからのタイムアウト時間を設定します。タイムアウト時間を過ぎると、変換処理は削除され次の変換処理に移ります。このタイムアウトは、必ず設定してください。
    setTransTimeoutSec(int timeoutSec) setTransTimeoutMilliSec(Number timeoutMilliSec) 【必須】SOAPの接続タイムアウト“ミリ”秒数を設定します。短すぎると結果が受け取れないため、設定する際は、setTimeoutSec(timeoutSec)の10倍以上など、できるだけ長く設定することを推奨します。通常は、0(タイムアウトしない)を指定してください。
  • HTML→PDF変換

    JavaEE開発モデル スクリプト開発モデル 説明
    setTimeoutSec(int timeoutSec) setTimeoutSec(Number timeoutSec) PDFファイルへの変換時、待機する時間を設定します。未指定の場合は3600秒(1時間)待機します。

コラム

PDF変換処理のタイムアウトを変更した場合は、 intra-mart Accel Platform のセッションタイムアウトについても確認してください。

PDF変換処理が完了する前に intra-mart Accel Platform のセッションタイムアウトが発生した場合、変換結果を受け取ることができません。

intra-mart Accel Platform のセッションタイムアウトの設定については、 intra-mart Accel Platform のドキュメントを参照してください。

コラム

APIの詳細については、「 IM-PDFAutoConverter for Accel Platform API ドキュメント 」を参照してください。

4.2.5. PDF変換を行うまでの待機時間が短い場合、正常に変換されない可能性があります

HTML→PDF変換 において、画面表示後、PDF変換を行うまでの待機時間が短い場合、正常に変換されない可能性があります。

次のAPIや設定ファイルを利用し、適切な待機時間を設定することを推奨します。

JavaEE開発モデル スクリプト開発モデル 説明
setWaitMillisecond(int waitMillisecond) setWaitMillisecond(Number waitMillisecond) 画面表示後、PDF変換を行うまでの待機時間をミリ秒単位で設定します。未設定の場合は設定ファイルから値を取得します。未設定かつ、設定ファイルの値が存在しない場合は1000ミリ秒(1秒)待機します。

4.2.6. IM-Workflow のコンテンツ画面をPDF変換する場合、遷移可能なURLを指定してください

URLを指定して IM-Workflow のコンテンツ画面をPDF変換する場合、遷移可能なURLを指定してください。

IM-Workflow のコンテンツ画面のURLについては、「 IM-Workflowの色々なコンテンツ画面へ遷移するURL 」を参照してください。

4.3. 体験版ライセンスにおける注意点

試用版ライセンスでご利用のお客様は、30~60 日間の試用期間が終了するとPDF作成APIが自動的に利用できない状態となります。

この状態でPDF作成APIを利用したプログラムを実行した場合に、実行時エラーとなります。

その場合は、正規の製品ライセンスを購入いただき、アンインストール後に再インストールしてください。

アンインストール・再インストールの方法は、インストールマニュアルをご確認ください。