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

本製品で提供されているAPIを用いて、PDFファイルを作成するためのプログラムを作成します。
PDFファイルを作成するためのAPIの利用方法については、PDFデザイナーをインストールすると intra-martサーバに自動的にプログラムがインストールされ各開発モデル用のAPIをご利用頂けます。 各APIの仕様に関しては、APIリスト が提供されていますので、そちらをご利用ください。
サンプルプログラムが用意されていますので、API仕様を学ぶ場合にご利用ください。

動作概念

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

コラム

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

スクリプト開発モデル

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

JavaEE開発モデル

プログラムのコンパイル

PDFデザイナーのAPIを利用したプログラムをコンパイルする場合、IM-PDFDesigner for Accel Plotform / セットアップガイドで指定した jarファイル をクラスパスに設定して下さい。

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

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

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

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

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