Szenario: Vom System erstellte Briefe erstellen

Der Baustein „Asset Composer“ gibt APIs mit dem Dienst „LetterRenderService“ aus, um einen Brief durch einen automatisierten Prozess oder über eine Anwendung zu erstellen, die eine Korrespondenz ohne Öffnen der Benutzeroberfläche „Korrespondenz erstellen“ muss.
Hinweis: Bei der erstellten Korrespondenz sind nur die vorher ausgewählten und obligatorischen Inhalte in den Zielbereichen enthalten. Felder oder Variablen, die sich auf einen Benutzer beziehen, werden geleert und eine Warnmeldung wird in das Protokoll aufgenommen.

    Briefobjekt verwenden

    Die folgende API rendert einen Brief mit einem Briefobjekt:
    public PDFResponseType renderLetter(Letter letter, String initialDataXML, boolean mergeDataOnServer, boolean useTestData, boolean renderInteractive);
    Parameterdetails:

    • letter: Zu rendernde Briefvorlage. Hierbei muss es sich um das vollständige Buchstabenobjekt handeln, das alle erforderlichen Daten und Aufgaben enthält.

    • initialDataXML: XML-Daten, die zur Initialisierung des im Brief verwendeten Datenwörterbuchs (sofern vorhanden) verwendet und schließlich nach der Erweiterung mit den erforderlichen Steuerdaten für den Inhalt des Briefs mit dem Layout des Briefs zusammengeführt werden.

      Diese XML-Daten können von einer externen Datenquelle abgerufen werden.

    • mergeDataOnServer: Dieser Parameter sollte auf „True“ gesetzt werden, damit die relevanten Daten in dem Brief zusammengeführt werden. Sollte für vom System erstellte Korrespondenz augenscheinlich „True“ sein.

    • useTestData: Legen Sie fest, ob Testdaten für das Rendern verwendet werden. In Produktionssystemen sollte dieser Parameter auf „False“ gesetzt werden. Stattdessen wird initialDataXML verwendet.

    • renderInteractive: Geben Sie an, ob eine interaktive oder nicht interaktive (flache) PDF-Datei gerendert wird.

    Briefbezeichner verwenden

    Die folgende API rendert einen Brief mit einem Briefbezeichner:
    public PDFResponseType renderLetter(String letterId, String initialDataXML, boolean mergeDataOnServer, boolean useTestData, boolean renderInteractive);mergeDataOnServer, boolean useTestData, boolean renderInteractive);
    Parameterdetails:

    • letterId: Bezeichner der zu rendernden Briefvorlage.

    • initialDataXML: XML-Daten, die zur Initialisierung des im Brief verwendeten Datenwörterbuchs (sofern vorhanden) verwendet und schließlich nach der Erweiterung mit den erforderlichen Steuerdaten für den Inhalt des Briefs mit dem Layout des Briefs zusammengeführt werden.

      Diese XML-Daten können von einer externen Datenquelle abgerufen werden.

    • mergeDataOnServer: Dieser Parameter sollte auf „True“ gesetzt werden, damit die relevanten Daten in dem Brief zusammengeführt werden. Sollte für vom System erstellte Korrespondenz augenscheinlich „True“ sein.

    • useTestData: Legen Sie fest, ob Testdaten für das Rendern verwendet werden. In Produktionssystemen sollte dieser Parameter auf „False“ gesetzt werden. Stattdessen wird initialDataXML verwendet.

    • renderInteractive: Geben Sie an, ob eine interaktive oder nicht interaktive (flache) PDF-Datei gerendert wird.

    Rückgabewert

    Die API gibt ein Objekt vom Typ com.adobe.icc.render.obj.PDFResponseType zurück, mit dem Sie die endgültigen PDF-Inhalte mithilfe von PDFResponseType.getFile().getDocument() extrahieren können.