IM-PDFDesigner for Accel Platform プログラミングガイド 第13版 2019-04-01

PDFファイル作成用のプログラムの開発

本製品で提供されているAPIを用いて、PDFファイルを作成するためのプログラムを作成します。
PDFファイルを作成するためのAPIの利用方法については、IM-PDFDesignerをインストールすると intra-martサーバに自動的にプログラムがインストールされ各開発モデル用のAPIをご利用頂けます。 各APIの仕様に関しては、 IM-PDFDesigner for Accel Platform APIドキュメントを参照ください。
また、 サンプルプログラム が用意されていますので、API仕様を学ぶ際に利用ください。

動作概念

IM-PDFDesigner では、PDFファイルの作成に必要な各ファイル (レイアウトなど) は、 %PUBLIC_STORAGE_PATH%/public/storage 以下の任意のフォルダに保存しておく必要があります。
また、作成されるPDFファイルも同じく%PUBLIC_STORAGE_PATH%/public/storage 以下の指定のフォルダに 出力されます。
../../_images/gaiyo1.png

コラム

IM-PDFDesignerの各レイアウト/データファイル及びPDFファイル出力位置は、
%PUBLIC_STORAGE_PATH% を C:/storage とした場合
C:/storage/public/storage/以下の任意のフォルダ
です。
IM-PDFDesignerでは、各ファイルの位置は上記のフォルダからの相対パスで指定します。

開発手法

スクリプト開発モデル

本製品によって iAP に追加されたPDF作成用のAPIは、iAP が標準で提供している他のAPIと同様に利用することができます。

JavaEE開発モデル

プログラムのコンパイル

IM-PDFDesigner の APIを利用したプログラムを、コンパイルする場合は、 IM-PDFDesigner for Accel Platform / セットアップガイドで指定した jarファイル( $RESIN_HOME/lib/iowebdoc.jar ファイル) をクラスパスに設定してください。

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

  • 作成した PDFファイル のファイルサイズが大きい場合、 APIのレスポンスとPDFファイルがディスク上に完全に書き出されるタイミングが大きく異なる場合があります。 サイズの大きいPDFファイルを作成した場合は、 十分な時間が経過した後に作成したPDFファイルにアクセスするようにしてください。
  • CSVファイルに画像のパスを指定する場合は、絶対パス もしくは カレントディレクトリからの相対パス にて指定してください。
  • IM-PDFDesignerが提供するAPIは、 指定されたパスを Public Storage (標準では、%PUBLIC_STORAGE_PATH%/public/storage/) を親ディレクトリとして解決します。
    従って、上記パスからの相対パスを指定してください。
  • IM-PDFDesignerが提供するAPIでは、 Public Storage 以下のすべてのファイルに対してアクセスすることができますので、 PDFファイル作成により不用意にファイルを上書きしてしまわないように注意してください。 (指定されたパスが、すでにファイルとして存在していても、API実行の結果エラーになることはありません)。
  • 例外として、CSVファイルでデータを渡す場合は、記載するファイルのパス(画像ファイル等…)はOSの認識するフルパスにて指定してください。
    %PUBLIC_STORAGE_PATH% からの相対パスでは指定できません。
  • IM-PDFDesignerにおいて、通常のJavaアプリケーション同様にファイル出力が競合しないよう、 上位アプリケーション側でファイルの排他制御が必要です。
    • システムで重複しない出力ファイル名を使用する。
    • ダブルクリックを防止する
    出力ファイル名につきましては、上位アプリケーション側でシステムで重複しない ID 等を生成し、ファイル名に付加してください。
    ダブルクリック防止機能につきましては、スクリプト開発モデルであれば isDoubleClick() を利用ください。
    JavaEE開発モデルであれば、DblClickForbidenタグ を利用ください。
    共に、イントラマートの標準APIとなっており、詳細についてはイントラマートAPIマニュアルを参照してください。
  • IM-PDFDesigner は、PDFファイルに2種類のパスワードを設定することが可能です。
    • オープンパスワード

      PDFファイルの閲覧を制限するためのパスワードです。 AdobeReader等で開く際にパスワードが要求されます。

    • セキュリティパスワード

      PDFファイルに対して、編集・加工等の操作を制限するためのパスワードです。 Adobe Acrobat等で編集する際にパスワードが要求されます。