ドキュメントAEM as a Cloud Serviceユーザーガイド

AEM Forms as a Cloud Service 通信の概要 frequently-asked-questions

Last update: Fri Apr 12 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

作成対象：

  • Admin
  • Developer
  • User
バージョン
記事リンク
AEM 6.5
ここをクリックしてください
AEM as a Cloud Service
この記事

通信機能は、ビジネス文書、ステートメント、請求処理レター、特典通知、毎月の請求書、ウェルカムキットなど、ブランド承認済みのパーソナライズされた標準的なドキュメントを作成するのに役立ちます。

この機能には、ドキュメントを生成および操作するための API が用意されています。オンデマンドでドキュメントを生成または操作することも、バッチジョブを作成して、定義された間隔で複数のドキュメントを生成することもできます。通信 API は以下を提供します。

  • 効率化されたオンデマンドおよびバッチドキュメント生成機能。

  • PDF ドキュメントをオンデマンドで結合、並べ替えおよび検証する機能。

  • 外部システムとの統合を容易にする HTTP API。オンデマンド操作（低遅延）用とバッチ操作（高スループット操作）用に別々の API が含まれています。

  • データへのセキュリティで保護されたアクセス。通信 API は、顧客が指定したデータリポジトリにのみ接続してデータにアクセスするので、通信の安全性が高くなります。

クレジットカード明細書のサンプル
クレジットカード明細書は、通信 API を使用して作成できます。このサンプル文は同じテンプレートですが、クレジットカードの使用状況に応じて、顧客ごとに別々のデータを使用しています。

ドキュメントの生成

コミュニケーションドキュメント生成 API は、テンプレート（XFA または PDF）と顧客データ（XML）を組み合わせて、PDF 形式や PS、PCL、DPL、IPL、ZPL 形式などの印刷形式でドキュメントを生成するのに役立ちます。これらの API は、XML データを含んだ PDF および XFA テンプレートを利用して、単一のドキュメントをオンデマンドで生成したり、複数のドキュメントをバッチジョブで生成したりすることができます。

通常、Designer を使用してテンプレートを作成し、通信 API を使用してテンプレートにデータを結合します。アプリケーションは、出力ドキュメントをネットワークプリンター、ローカルプリンター、またはアーカイブ用のストレージシステムに送信できます。標準ワークフローとカスタムワークフローの例を次に示します。

通信機能のドキュメント生成ワークフロー

ユースケースによっては、これらのドキュメントを Web サイトまたはストレージサーバーからダウンロードできるようにすることもできます。

ドキュメント生成 API の例を以下に示します。

PDF ドキュメントの作成 create-pdf-documents

ドキュメント生成 API を使用すると、フォームデザインと XML フォームデータに基づく PDF ドキュメントを作成できます。結果として出力されるのは非インタラクティブ PDF ドキュメントです。つまり、ユーザーはフォームデータの入力や変更はできません。基本ワークフローは、XML フォームデータをフォームデザインと結合して PDF ドキュメントを作成することです。次の図は、フォームデザインと XML フォームデータを結合して PDF ドキュメントを生成するところを示しています。

PDF ドキュメントの作成
図：PDF ドキュメントを作成するための一般的なワークフロー

PostScript（PS）、Printer Command Language（PCL）、Zebra Printing Language（ZPL）ドキュメントの作成 create-PS-PCL-ZPL-documents

ドキュメント生成 API を使用して、XDP フォームデザインまたは PDF ドキュメントに基づく PS、PCL および ZPL ドキュメントを作成できます。これらの API は、フォームデザインとフォームデータを結合してドキュメントを生成します。ドキュメントをファイルに保存し、カスタムプロセスを開発してファイルをプリンターに送信することができます。

バッチデータの処理による複数のドキュメントの作成 processing-batch-data-to-create-multiple-documents

ドキュメント生成 API を使用して、XML バッチデータソース内のレコードごとに別個のドキュメントを作成できます。ドキュメントは一括モードと非同期モードで生成できます。コンバージョンの様々なパラメーターを設定し、バッチ処理を開始できます。

PDF ドキュメントの作成

ドキュメントの操作

通信機能のドキュメント操作 API は、PDF ドキュメントの結合、並べ替えおよび検証に役立ちます。通常は、DDX を作成し、それをドキュメント操作 API に送信して、ドキュメントをアセンブリしたり、並べ替えたりします。DDX ドキュメントには、ソースドキュメントを使用して 1 組の必要なドキュメントを生成する方法についての指示が記述されています。DDX リファレンスドキュメントは、サポートされているすべての操作に関する詳細な情報を提供します。ドキュメント操作の例を以下に示します。

PDF ドキュメントのアセンブリ

ドキュメント操作 API を使用すると、複数の PDF または XDP ドキュメントを 1 つの PDF ドキュメントまたは PDF ポートフォリオに組み合わせることができます。次に、PDF ドキュメントのアセンブリ方法を示します。

  • 単純な PDF ドキュメントのアセンブリ
  • PDF ポートフォリオの作成
  • 暗号化ドキュメントのアセンブリ
  • ベイツナンバリングを使用したドキュメントのアセンブリ
  • ドキュメントの統合およびアセンブリ

複数の PDF ドキュメントからの単一 PDF ドキュメントのアセンブリ
図：複数の PDF ドキュメントからの単一 PDF ドキュメントのアセンブリ

PDF ドキュメントのディスアセンブリ

ドキュメント操作 API を使用して PDF ドキュメントを分割できます。また、ソースドキュメントからページを抽出したり、しおりの位置を境にソースドキュメントを分割することもできます。通常、このタスクは PDF ドキュメントが最初に多数の個別ドキュメント（明細書など）から作成された場合に役立ちます。

  • ソースドキュメントからのページの抽出
  • しおりに基づいたソースドキュメントの分割

しおりに基づいたソースドキュメントの複数のドキュメントへの分割
図：しおりに基づいたソースドキュメントの複数のドキュメントへの分割

PDF/A 準拠ドキュメントへの変換と PDF/A 準拠ドキュメントの検証

ドキュメント操作 API を使用して、PDF ドキュメントを PDF/A 準拠のドキュメントに変換したり、PDF ドキュメントが PDF/A に準拠しているかどうかを判断したりできます。PDF/A は、ドキュメントのコンテンツを長期保存するためのアーカイブ形式です。フォントはドキュメントに埋め込まれ、ファイルは非圧縮になります。その結果、通常、PDF/A ドキュメントは標準の PDF ドキュメントよりも大きくなります。なお、PDF/A ドキュメントには、オーディオおよびビデオのコンテンツは含まれません。

NOTE
AEM Forms には、PDF ファイルとシームレスに統合できる様々な組み込みフォントが用意されています。サポートされているフォントのリストを表示するには、ここをクリックしてください。

ドキュメント保証 doc-assurance

DocAssurance サービスには、以下の Signature API と Encyption API が含まれています。

Signature API

Signature API を使用すると、組織は配布および受信する Adobe PDF ドキュメントのセキュリティとプライバシーを保護できます。 セキュリティ機能はドキュメント自体に適用され、ドキュメントは安全で、ライフサイクル全体にわたって制御されます。 ドキュメントは、ファイアウォール外でも、オフラインでダウンロードされた場合でも、組織に送り返される場合でも、安全なままです。 Signature API を使用して、次のタスクを実行できます。

  • PDFドキュメントに表示可能な署名フィールドを追加します。
  • PDFドキュメントに非表示の署名フィールドを追加します。
  • PDF ドキュメント内の指定した署名フィールドに署名します。
  • PDF ドキュメントの証明

暗号化 API

暗号化 API を使用すると、ドキュメントの暗号化および復号が可能になります。ドキュメントが暗号化されると、その内容が読み取れなくなります。許可されたユーザーは、ドキュメントを復号化して、コンテンツにアクセスできます。PDFドキュメントをパスワードで暗号化する場合、ドキュメントをAdobe ReaderまたはAdobe Acrobatで表示するには、開いているパスワードを指定する必要があります。

暗号化 API を使用して、次のタスクを実行できます。

  • パスワードで PDF ドキュメントを暗号化します。
  • PDF ドキュメントからパスワードベースの暗号化を削除します。
  • PDF ドキュメントに適用されるセキュリティのタイプを取得します。
  • PDFドキュメントに適用されるセキュリティタイプを返します。

Signature API と Encryption API は両方とも 同期 API です。

Reader Extension サービス

Reader拡張サービスは、早期導入プログラムの対象です。 次に書き込むことができます。aem-forms-ea@adobe.com公式メール id から早期導入プログラムに参加し、機能へのアクセスをリクエストします。

Reader拡張機能サービスを使用すると、使用権限を追加してAdobe Readerの機能を拡張することで、組織内でインタラクティブなPDFドキュメントを簡単に共有できます。 Reader拡張機能サービスは、Adobe Readerで動作します。 このサービスは、使用権限を PDF ドキュメントに追加します。このアクションにより、ドキュメントへのコメントの追加、フォームへの入力、ドキュメントの保存など、Adobe Readerを使用してPDFドキュメントを開いた場合には通常使用できない機能が有効になります。

PDF ドキュメントに適切な使用権限が追加されている場合、受信者は Adobe Reader 内で次の作業を行うことができます。

  • PDFの文書やフォームをオンラインまたはオフラインで記入することで、受信者は自分の記録のコピーをローカルに保存し、追加された情報をそのまま保持できます。
  • PDFドキュメントをローカルハードドライブに保存して、元のドキュメントと追加のコメント、データ、添付ファイルを保持します。
  • PDF文書にファイルとメディア クリップを添付します。
  • 業界標準の公開鍵インフラストラクチャ （PKI） テクノロジを使用してデジタル署名を適用することにより、PDF文書の署名、認証、および認証を行います。
  • 完了または注釈が付いたPDF文書を電子的に送信します。
  • 内部データベースおよび web サービスに対する直感的なPDFフロントエンドとして、開発ドキュメントおよびフォームを使用します。
  • レビュー担当者は直観的なマークアップツールを使用してドキュメントにコメントを追加できるよう、PDF ドキュメントを他のユーザーと共有する。使用できるツールには、電子付箋、スタンプ、ハイライト、および取り消し線が含まれます。これらと同じ機能は Acrobat でも利用できます。
  • バーコードフォームのデコードをサポートする。

これらの特別な使用権限の機能は、権限を付与されたPDFドキュメントをAdobe Reader内で開いたときに自動的にアクティブ化されます。 権限を付与されたドキュメントの操作が完了すると、Adobe Readerでこれらの機能が再び無効になります。 ユーザーが権限を付与された別のドキュメントを受け取るまで、これらの機能は無効のままです。

Reader拡張サービスの様々な使用権限の機能は次のとおりです。

  • バーコードのデコード:PDFドキュメント内のバーコードをデコードします。

  • コメント:PDFドキュメントに対してオフラインでコメントします。

  • コメントオンライン:PDFドキュメントにオンラインでコメントします。

  • デジタル署名:PDFドキュメントにデジタル署名を追加します。

  • 動的フォームフィールド：フォームフィールドをPDFドキュメントに追加します。

  • 動的なフォームページ:PDFドキュメントにフォームページを追加する

  • 埋め込みファイル:PDFのドキュメント内にファイルを埋め込みます。

  • フォームデータのインポート：フォームデータをPDFドキュメントに読み込みます。

  • フォームデータのエクスポート：フォームデータをPDFドキュメントに読み込みます。

  • フォームの入力:PDFドキュメント内のフォームフィールドに入力します。

  • オンラインForms:PDFドキュメントから web サービスまたはデータベースにアクセスするため。

  • スタンドアロンで送信:PDFドキュメントからフォームデータをオフラインで送信します。

Reader拡張サービスのその他の機能

  • メッセージ:1 つ以上の使用権限が適用されたPDFドキュメントを開いたときにAdobe Acrobat Reader内に表示されるメッセージ。
  • パスワードのロック解除：暗号化されたPDFドキュメントを開くために必要なパスワード。 通常、これはドキュメントを開くパスワードですが、PDFドキュメントが権限パスワードでさらに保護されている場合は、いずれかを使用して開くことができます。

API から提供されるすべてのパラメーター、認証方法および各種サービスの詳細については、API リファレンスドキュメントを参照してください。API リファレンスドキュメントは、.yaml 形式でも入手できます。.yaml をダウンロードし、postman にアップロードして API の機能を確認できます。

通信 API のタイプ types

通信は、オンデマンドおよびバッチでのドキュメント生成用に HTTP API を提供します。

  • 同期 API は、オンデマンド、低遅延、単一レコードのドキュメント生成シナリオに適しています。これらの API は、ユーザーアクションに基づいたユースケースにより適しています。例えば、ユーザーがフォームへの入力を完了した後にドキュメントを生成するような場合です。

  • バッチ API（非同期 API） ​は、スケジュール化された、高スループットの、複数のドキュメント生成シナリオに適しています。これらの API は、バッチでドキュメントを生成します。例えば、毎月生成される電話料金、クレジットカード明細、給付計算書などです。

オンボーディング

通信機能は、Forms as a Cloud Service ユーザー向けのスタンドアロンおよびアドオンモジュールとして利用できます。アクセス権限を要求する場合は、アドビのセールスチームまたはアドビ担当者に問い合わせてください。お客様の組織で変換サービスを使用できるように設定し、組織の管理者に対して必要な権限を設定します。管理者は、API を使用するためのアクセス権限を、組織内の Forms as a Cloud Service 開発者（ユーザー）に付与することができます。

オンボーディング後、Forms as a Cloud Service 環境で通信機能を有効にするには：

  1. Cloud Manager にログインし、AEM Forms as a Cloud Service インスタンスを開きます。

  2. 「プログラムを編集」オプションを開き、「ソリューションとアドオン」タブに移動して、「Forms - 通信」オプションを選択します。

    通信

    「Forms - デジタル登録」オプションを既に有効にしてある場合は、「Forms - 通信アドオン」オプションを選択します。

    アドオン

  3. 「更新」をクリックします。

  4. ビルドパイプラインを実行します。ビルドパイプラインが正常に完了すると、お使いの環境で通信 API が有効になります。

NOTE
ドキュメント操作 API を有効にし設定するには、次のルールを Dispatcher 設定に追加します。
# Allow Forms Doc Generation requests
/0062 { /type "allow" /method "POST" /url "/adobe/forms/assembler/*" }

関連トピック see-also

recommendation-more-help
fbcff2a9-b6fe-4574-b04a-21e75df764ab