Output サービス output-service

概要 overview

出力サービスは、AEM ドキュメントサービスの一部を成す OSGi サービスです。出力サービスは、様々な出力形式や、AEM Forms Designer の出力設計機能をサポートしています。出力サービスでは、XFA テンプレートと XML データを変換して、様々な形式の印刷ドキュメントを生成することができます。

Output サービスにより、以下のような機能を備えたアプリケーションを作成することができます。

非インタラクティブ形式のドキュメントを作成する creating-non-interactive-form-documents

通常、テンプレートは AEM Forms Designer を使用して作成します。これらのテンプレートは、出力サービスの generatePDFOutput と generatePrintedOutput の各 API により、PDF、ポストスクリプト、ZPL や PCL などの様々な形式に直接変換することができます。

generatePDFOutput 操作は PDF を生成する一方で、generatePrintedOutput 操作は、PostScript、ZPL、および PCL の形式でドキュメントを生成します。各演算の最初のパラメーターは、テンプレートファイルの名前（例えば、ExpenseClaim.xdp）、またはテンプレートが含まれているドキュメントオブジェクトのいずれかを受け取ります。テンプレートファイルの名前を指定した場合は、テンプレートを含むフォルダへのパスとしてのコンテンツルートも指定します。コンテンツルートの指定には、PDFOutputOptions または PrintedOutputOptions パラメータのいずれかを使用します。これらのパラメーターを使用して指定できる他のオプションについて詳しくは、Javadoc を参照してください。

2 番目のパラメーターは、出力ドキュメントの生成中にテンプレートと結合される XML ドキュメントを受け取ります。

generatePDFOutput 演算では、XFA ベースの PDF フォームを入力として受け取り、出力として非インタラクティブの PDF フォームを返すこともできます。

非インタラクティブ形式のドキュメントを作成する generating-non-interactive-form-documents

例えば、1 つ以上のテンプレートが存在しており、各テンプレートには XML データの複数のレコードがあるシナリオを考えてみましょう。

各レコードの印刷文書を生成するために、出力サービスの generatePDFOutputBatch と generatePrintedOutputBatch の演算を使用します。

また、単一のドキュメントにレコードを組み合わせることもできます。いずれの演算でも、4 つのパラメーターが必要です。

最初のパラメーターはマップであり、この中には、任意の文字列が鍵として、およびテンプレートファイルの名前が値として収められています。

2番目のパラメーターは別のマップです。この値は、XML データを含むドキュメントオブジェクトです。この鍵は、最初のパラメーターに指定したものと同じものです。

generatePDFOutputBatch または generatePrintedOutputBatch の 3 番目のパラメーターは、それぞれ PDFOutputOptions タイプまたは PrintedOutputOptions タイプです。

パラメータータイプは generatePDFOutput と generatePrintedOutput 演算のためのパラメーターのタイプと同じで、効果も同じです。

第 4 のパラメーターはタイプ BatchOptions です。これは、レコードごとに別のファイルを生成するかどうかを指定するために使用します。このパラメータのデフォルト値は false です。

generatePrintedOutputBatch と generatePDFOutputBatch は、共にタイプ BatchResult の値を返します。値には、生成されたドキュメントのリストが含まれています。また、XML 形式のメタデータドキュメントも含まれており、この中には、生成された各ドキュメントに関連する情報が収められています。