Übergeben von Dokumenten an den Forms-Service

Letzte Aktualisierung: 15. Juli 2024
  • Gilt für:
  • Experience Manager 6.5
  • Themen:

Erstellt für:

  • Entwickler

Die Beispiele in diesem Dokument gelten nur für eine AEM Forms on JEE-Umgebung.

Der AEM Forms-Service gibt interaktive PDF-Formulare an Client-Geräte aus, in der Regel Webbrowser, um Informationen von Benutzern zu erfassen. Ein interaktives PDF-Formular basiert auf einem Formularentwurf, der normalerweise in Designer erstellt und als XDP-Datei gespeichert wird. Was AEM Forms betrifft, können Sie ein com.adobe.idp.Document-Objekt, das den Formularentwurf enthält, an den Forms-Service übergeben. Der Forms-Dienst rendert dann den Formularentwurf, der sich im com.adobe.idp.Document-Objekt befindet.

Ein Vorteil der Übergabe eines com.adobe.idp.Document-Objekts an den Forms-Service ist, dass andere Service-Vorgänge eine com.adobe.idp.Document-Instanz zurückgeben. Das heißt, Sie können eine com.adobe.idp.Document-Instanz von einem anderen Service-Vorgang erhalten und sie wiedergeben. Nehmen Sie zum Beispiel an, dass eine XDP-Datei in einem Knoten von Content Services (veraltet) mit dem Namen /Company Home/Form Designs gespeichert ist, wie in der folgenden Abbildung gezeigt.

Sie können Loan.xdp programmgesteuert von Content Services (veraltet) abrufen und die XDP-Datei in einem com.adobe.idp.Document-Objekt an den Forms-Service übergeben.

HINWEIS
Weitere Informationen zum Forms-Service finden Sie in der Service-Referenz für AEM Forms.

Zusammenfassung der Schritte

Führen Sie die folgenden Aufgaben aus, um ein Dokument aus Content Services (veraltet) an den Forms-Service zu übergeben:

  1. Schließen Sie Projektdateien ein.
  2. Erstellen Sie ein Forms- und ein Document Management Client-API-Objekt.
  3. Rufen Sie den Formularentwurf aus Content Services ab (veraltet).
  4. Geben Sie das interaktive PDF-Formular wieder.
  5. Führen Sie eine Aktion mit dem Formulardaten-Stream aus.

Einschließen von Projektdateien

Schließen Sie die erforderlichen Dateien in Ihr Entwicklungsprojekt ein. Wenn Sie eine Clientanwendung mit Java erstellen, schließen Sie die erforderlichen JAR-Dateien ein. Wenn Sie Web-Services verwenden, schließen Sie die Proxy-Dateien ein.

Erstellen eines Forms- und eines Document Management Client-API-Objekts

Bevor Sie einen Forms-Service-API-Vorgang programmgesteuert durchführen können, erstellen Sie ein Forms-Client-API-Objekt. Da mit diesem Workflow eine XDP-Datei aus Content Services (veraltet) abgerufen wird, erstellen Sie ein Document Management-API-Objekt.

Abrufen des Formularentwurfs aus Content Services (veraltet)

Rufen Sie die XDP-Datei aus Content Services (veraltet) ab, indem Sie die Java- oder Webservice-API verwenden. Die XDP-Datei wird in einer com.adobe.idp.Document-Instanz zurückgegeben (oder in einer BLOB-Instanz, wenn Sie Web-Services verwenden). Sie können dann die com.adobe.idp.Document-Instanz an den Forms-Service übergeben.

Wiedergeben eines interaktiven PDF-Formulars

Um ein interaktives Formular zu rendern, übergeben Sie die com.adobe.idp.Document-Instanz, die von Content Services (veraltet) an den Forms-Service zurückgegeben wurde.

HINWEIS
Sie können ein com.adobe.idp.Document, das den Formularentwurf enthält, an den Forms-Service übergeben. Zwei neue Methoden namens renderPDFForm2 und renderHTMLForm2 akzeptieren ein com.adobe.idp.Document-Objekt, das einen Formularentwurf enthält.

Ausführen einer Aktion mit dem Formulardaten-Stream

Je nach Art des Client-Programms können Sie das Formular in einen Client-Webbrowser schreiben oder das Formular als PDF-Datei speichern. Bei einem Web-basierten Programm wird das Formular normalerweise in den Webbrowser geschrieben. Ein Desktop-Programm hingegen speichert das Formular in der Regel als PDF-Datei.

Siehe auch

Einbeziehung von AEM Forms Java-Bibliotheksdateien

Verbindungseigenschaften festlegen

Schnellstart mit der Forms Service-API

Übergeben von Dokumenten an den Forms-Service mithilfe der Java-API

Übergeben Sie ein Dokument, das von Content Services (veraltet) mithilfe der Forms-Service- und Content Services-API (veraltet) erhalten wurde:

  1. Projektdateien einschließen

    Fügen Sie Client-JAR-Dateien wie „adobe-forms-client.jar“ oder „adobe-contentservices-client.jar“ in den Klassenpfad Ihres Java-Projekts ein.

  2. Erstellen eines Forms- und eines Document Management Client-API-Objekts

    • Erstellen Sie ein ServiceClientFactory-Objekt, das Verbindungseigenschaften enthält. (Siehe Einstellung von Verbindungseigenschaften.)
    • Erstellen Sie ein FormsServiceClient-Objekt, indem Sie seinen Konstruktor verwenden und das ServiceClientFactory-Objekt übergeben.
    • Erstellen Sie ein DocumentManagementServiceClientImpl-Objekt, indem Sie seinen Konstruktor verwenden und das ServiceClientFactory-Objekt übergeben.

  3. Abrufen des Formularentwurfs aus Content Services (nicht mehr unterstützt)

    Rufen Sie die Methode retrieveContent des DocumentManagementServiceClientImpl-Objekts auf und übergeben Sie die folgenden Werte:

    • Ein Zeichenfolgewert, der den Speicher angibt, dem der Inhalt hinzugefügt wird. Der Standardspeicherort ist SpacesStore. Dieser Wert ist ein obligatorischer Parameter.
    • Ein Zeichenfolgenwert, der den vollständig qualifizierten Pfad des abzurufenden Inhalts angibt (z. B. /Company Home/Form Designs/Loan.xdp). Dieser Wert ist ein obligatorischer Parameter.
    • Ein Zeichenfolgenwert, der die Version angibt. Dieser Wert ist ein optionaler Parameter, und Sie können auch eine leere Zeichenfolge übergeben. In diesem Fall wird die neueste Version abgerufen.

    Die Methode retrieveContent gibt ein CRCResult-Objekt zurück, das die XDP-Datei enthält. Sie können eine com.adobe.idp.Document-Instanz erhalten, indem Sie die Methode getDocument des CRCResult-Objekts aufrufen.

  4. Wiedergeben eines interaktiven PDF-Formulars

    Rufen Sie die Methode renderPDFForm2 des FormsServiceClient-Objekts auf und übergeben Sie die folgenden Werte:

    • Ein com.adobe.idp.Document-Objekt, das den Formularentwurf enthält, der von Content Services (veraltet) abgerufen wurde.
    • Ein com.adobe.idp.Document-Objekt, das Daten enthält, die mit dem Formular zusammengeführt werden sollen. Wenn Sie keine Daten zusammenführen möchten, übergeben Sie ein leeres com.adobe.idp.Document-Objekt.
    • Ein PDFFormRenderSpec-Objekt, das Laufzeitoptionen speichert. Dieser Wert ist ein optionaler Parameter, für den Sie null angeben können, wenn Sie keine Laufzeitoptionen angeben möchten.
    • Ein URLSpec-Objekt, das URI-Werte enthält. Dieser Wert ist ein optionaler Parameter, für den Sie auch null angeben können.
    • Ein java.util.HashMap-Objekt, das Dateianlagen speichert. Dieser Wert ist ein optionaler Parameter, für den Sie null angeben können, wenn Sie keine Dateien an das Formular anhängen möchten.

    Die Methode renderPDFForm gibt ein FormsResult-Objekt zurück, das einen Formulardaten-Stream enthält, der in den Client-Webbrowser geschrieben werden muss.

  5. Ausführen einer Aktion mit dem Formulardaten-Stream

    • Sie können ein com.adobe.idp.Document-Objekt erstellen, indem Sie die Methode getOutputContent des FormsResult-Objekts aufrufen.
    • Ermitteln Sie den Content-Typ des com.adobe.idp.Document-Objekts, indem Sie seine Methode getContentType aufrufen.
    • Legen Sie den Content-Typ des javax.servlet.http.HttpServletResponse-Objekts fest, indem Sie seine Methode setContentType aufrufen und den Content-Typ des com.adobe.idp.Document-Objekts übergeben.
    • Erstellen Sie ein javax.servlet.ServletOutputStream-Objekt, das zum Schreiben des Formulardaten-Streams in den Client-Webbrowser verwendet wird, indem Sie die Methode getOutputStream des javax.servlet.http.HttpServletResponse-Objekts aufrufen.
    • Sie können ein java.io.InputStream-Objekt erstellen, indem Sie die Methode getInputStream des com.adobe.idp.Document-Objekts aufrufen.
    • Sie können ein Byte-Array erstellen und es mit dem Formulardaten-Stream füllen, indem Sie die Methode read des InputStream-Objekts aufrufen. Übergeben Sie das Byte-Array als Argument.
    • Rufen Sie die Methode write des javax.servlet.ServletOutputStream-Objekts auf, um den Formulardaten-Stream an den Client-Webbrowser zu senden. Übergeben Sie das Byte-Array an die Methode write.

Siehe auch

Kurzanleitung (SOAP-Modus): Übergeben von Dokumenten an den Forms-Service mithilfe der Java-API

Einbeziehung von AEM Forms Java-Bibliotheksdateien

Verbindungseigenschaften festlegen