Forms renderen op basis van fragmenten

Forms renderen op basis van fragmenten

De Forms-service kan formulieren weergeven die zijn gebaseerd op fragmenten die u met Designer maakt. Een fragment is een herbruikbaar onderdeel van een formulier en wordt opgeslagen als een afzonderlijk XDP-bestand dat in meerdere formulierontwerpen kan worden ingevoegd. Een fragment kan bijvoorbeeld een adresblok of juridische tekst bevatten.

Met fragmenten kunt u het maken en beheren van grote aantallen formulieren vereenvoudigen en versnellen. Wanneer u een nieuw formulier maakt, voegt u een verwijzing in naar het gewenste fragment en het fragment wordt in het formulier weergegeven. De fragmentverwijzing bevat een subformulier dat naar het fysieke XDP-bestand wijst. Zie Forms Designer voor informatie over het maken van formulierontwerpen op basis van fragmenten

Een fragment kan meerdere subformulieren bevatten die zijn ondergebracht in een gekozen subformulierset. De gekozen subformuliersets bepalen de weergave van subformulieren op basis van de gegevensstroom van een gegevensverbinding. U gebruikt voorwaardelijke instructies om te bepalen welk subformulier in de set in het resulterende formulier wordt weergegeven. Elk subformulier in een set kan bijvoorbeeld informatie voor een bepaalde geografische locatie bevatten en het weergegeven subformulier kan worden bepaald op basis van de locatie van de gebruiker.

Een scriptfragment bevat herbruikbare JavaScript-functies of waarden die afzonderlijk van een bepaald object worden opgeslagen, zoals een datumparser of een aanroep van een webservice. Deze fragmenten omvatten een enkel scriptobject dat als onderliggend element van variabelen in het palet Hiërarchie voorkomt. Fragmenten kunnen niet worden gemaakt op basis van scripts die eigenschappen zijn van andere objecten, zoals gebeurtenisscripts als valideren, berekenen of initialiseren.

Hier volgen enkele voordelen van het gebruik van fragmenten:

• Inhoud opnieuw gebruiken: Met fragmenten kunt u inhoud hergebruiken in meerdere formulierontwerpen. Als u bepaalde inhoud van dezelfde inhoud in meerdere formulieren wilt gebruiken, is het sneller en eenvoudiger om een fragment te gebruiken dan om de inhoud te kopiëren of opnieuw te maken. Fragmenten voor onderdelen die vaak voorkomen in een formulierontwerp, zorgen ook voor een consistente inhoud en weergave in alle formulieren die ernaar verwijzen.
• Algemene updates: Met fragmenten kunt u globale wijzigingen in meerdere formulieren slechts eenmaal aanbrengen, in één bestand. U kunt de inhoud, scriptobjecten, gegevensbindingen, lay-out of stijlen in een fragment wijzigen en alle XDP-formulieren die naar het fragment verwijzen, weerspiegelen de wijzigingen.
• Een gemeenschappelijk element in vele formulieren kan bijvoorbeeld een adresblok zijn dat een vervolgkeuzelijstobject voor het land bevat. Als u de waarden voor het vervolgkeuzelijstobject moet bijwerken, moet u vele formulieren openen om de wijzigingen aan te brengen. Als u het adresblok in een fragment opneemt, hoeft u slechts één fragmentbestand te openen om de wijzigingen aan te brengen.
• Als u een fragment in een PDF-formulier wilt bijwerken, moet u het formulier opnieuw opslaan in Designer.
• Gedeeld formulier maken: Met fragmenten kunt u de aanmaak van formulieren delen met verschillende bronnen. Formulierontwikkelaars met ervaring in het schrijven van scripts of andere geavanceerde functies van Designer, kunnen fragmenten maken en delen en zo de voordelen benutten van scripts en dynamische eigenschappen. Formulierontwerpers kunnen die fragmenten gebruiken voor de indeling van formulierontwerpen en ervoor zorgen dat alle onderdelen van een formulier een consistente weergave en functionaliteit hebben in meerdere formulieren die door meerdere mensen zijn ontworpen.

Een formulierontwerp samenstellen dat is samengesteld met fragmenten

U kunt een formulierontwerp samenstellen om aan de Forms-service door te geven op basis van meerdere fragmenten. Als u meerdere fragmenten wilt samenstellen, gebruikt u de Assembler-service. Zie PDF-documenten maken met behulp van fragmenten voor een voorbeeld van het gebruik van de service Samenstellen om een formulierontwerp te maken dat wordt gebruikt door andere Forms-services (de service Uitvoer). In plaats van de service Uitvoer te gebruiken, kunt u dezelfde workflow uitvoeren met de Forms-service.

Wanneer u de Assembler-service gebruikt, geeft u een formulierontwerp door dat is samengesteld met fragmenten. Het formulierontwerp dat is gemaakt, verwijst niet naar andere fragmenten. In dit onderwerp wordt daarentegen het doorgeven van een formulierontwerp besproken dat naar andere fragmenten verwijst naar de Forms-service. Het formulierontwerp is echter niet samengesteld door Assembler. Het is gemaakt in Designer.

Overzicht van stappen

Als u een formulier wilt genereren op basis van fragmenten, voert u de volgende taken uit:

1. Inclusief projectbestanden.
2. Maak een Forms Client API-object.
3. Geef URI-waarden op.
4. Het formulier weergeven.
5. Schrijf de gegevensstroom van het formulier naar de webbrowser van de client.

Projectbestanden opnemen

Neem de benodigde bestanden op in uw ontwikkelingsproject. Als u een clienttoepassing maakt met Java, neemt u de benodigde JAR-bestanden op. Als u webservices gebruikt, dient u de proxybestanden op te nemen.

Een Forms Client API-object maken

Voordat u programmatisch een client-API-bewerking voor Forms-services kunt uitvoeren, moet u een Forms-serviceclient maken.

URI-waarden opgeven

Als u een formulier wilt genereren op basis van fragmenten, moet u ervoor zorgen dat de Forms-service zowel het formulier als de fragmenten (de XDP-bestanden) kan vinden waarnaar het formulierontwerp verwijst. Stel bijvoorbeeld dat het formulier de naam PO.xdp heeft en dat in dit formulier twee fragmenten worden gebruikt: FooterUS.xdp en FooterCanada.xdp. In dit geval moet de Forms-service alle drie XDP-bestanden kunnen vinden.

U kunt een formulier en de bijbehorende fragmenten ordenen door het formulier op één locatie en de fragmenten op een andere locatie te plaatsen, of u kunt alle XDP-bestanden op dezelfde locatie plaatsen. In deze sectie wordt ervan uitgegaan dat alle XDP-bestanden zich in de AEM Forms-opslagplaats bevinden. Zie Bronnen schrijven voor informatie over het plaatsen van XDP-bestanden in de AEM Forms-opslagplaats.

Bij het genereren van een formulier op basis van fragmenten moet u alleen naar het formulier zelf verwijzen en niet naar de fragmenten. U moet bijvoorbeeld naar PO.xdp verwijzen en niet naar FooterUS.xdp of FooterCanada.xdp. Plaats de fragmenten op een locatie waar de Forms-service ze kan vinden.

Het formulier renderen

Een formulier dat is gebaseerd op fragmenten, kan op dezelfde manier worden gegenereerd als niet-gefragmenteerde formulieren. U kunt het formulier dus weergeven als PDF-, HTML- of formulierhulplijnen (afgekeurd). In het voorbeeld in deze sectie wordt een formulier dat is gebaseerd op fragmenten, weergegeven als een interactief PDF-formulier. (Zie Interactieve PDF forms renderen.)

De formuliergegevensstroom naar de webbrowser van de client schrijven

Wanneer de Forms-service een formulier genereert, wordt een formuliergegevensstroom geretourneerd die u naar de webbrowser van de client moet schrijven. Wanneer het formulier naar de webbrowser van de client wordt geschreven, is het zichtbaar voor de gebruiker.

Zie ook

Formulieren weergeven op basis van fragmenten met de Java API

Formulieren weergeven op basis van fragmenten met de webservice-API

Inclusief AEM Forms Java-bibliotheekbestanden

Verbindingseigenschappen instellen

Forms Service API Quick Start

Interactieve PDF forms renderen

Webtoepassingen maken die Forms renderen

Formulieren weergeven op basis van fragmenten met de Java API

Een formulier renderen op basis van fragmenten met de Forms API (Java):

1. Projectbestanden opnemen

   Neem client-JAR-bestanden, zoals adobe-forms-client.jar, op in het klassenpad van uw Java-project.

2. Een Forms Client API-object maken

   • Maak een ServiceClientFactory-object dat verbindingseigenschappen bevat.
   • Maak een FormsServiceClient-object door de constructor ervan te gebruiken en het object ServiceClientFactory door te geven.

3. URI-waarden opgeven

   • Maak een object URLSpec waarin URI-waarden worden opgeslagen met behulp van de constructor.
   • Roep de methode URLSpec van het object setApplicationWebRoot aan en geef een tekenreekswaarde door die de hoofdmap van de toepassing vertegenwoordigt.
   • Roep de methode setContentRootURI van het object URLSpec aan en geef een tekenreekswaarde door die de URI-waarde van de inhoudsbasis opgeeft. Zorg ervoor dat het formulierontwerp en de fragmenten zich in de URI van de inhoudsbasis bevinden. Als niet, werpt de dienst van Forms een uitzondering. Geef repository:// op om naar de gegevensopslagruimte te verwijzen.
   • Roep de methode setTargetURL van het object URLSpec aan en geef een tekenreekswaarde door die de doel-URL-waarde opgeeft waar de formuliergegevens worden gepost. Als u de doel-URL in het formulierontwerp definieert, kunt u een lege tekenreeks doorgeven. U kunt ook de URL opgeven waarnaar een formulier wordt verzonden om berekeningen uit te voeren.

4. Het formulier renderen

   Roep de methode renderPDFForm van het object FormsServiceClient aan en geef de volgende waarden door:

   • Een tekenreekswaarde die de naam van het formulierontwerp opgeeft, inclusief de bestandsnaamextensie. Als u naar een formulierontwerp verwijst dat deel uitmaakt van een Forms-toepassing, moet u het volledige pad opgeven, bijvoorbeeld Applications/FormsApplication/1.0/FormsFolder/Loan.xdp.
   • Een object com.adobe.idp.Document dat gegevens bevat die met het formulier moeten worden samengevoegd. Als u geen gegevens wilt samenvoegen, geeft u een leeg com.adobe.idp.Document-object door.
   • Een PDFFormRenderSpec-object dat uitvoeringsopties opslaat.
   • Een object URLSpec dat URI-waarden bevat die door de Forms-service worden vereist om een formulier te genereren op basis van fragmenten.
   • Een java.util.HashMap-object dat bestandsbijlagen opslaat. Dit is een optionele parameter en u kunt null opgeven als u geen bestanden aan het formulier wilt koppelen.

   De methode renderPDFForm retourneert een FormsResult-object dat een formuliergegevensstroom bevat die naar de webbrowser van de client moet worden geschreven.

5. De formuliergegevensstroom naar de webbrowser van de client schrijven

   • Maak een com.adobe.idp.Document-object door de methode getOutputContent van het object aan te roepen.FormsResult
   • Hiermee wordt het inhoudstype van het object com.adobe.idp.Document opgehaald door de methode getContentType ervan aan te roepen.
   • Stel het inhoudstype van het object javax.servlet.http.HttpServletResponse in door de methode setContentType ervan aan te roepen en het inhoudstype van het object com.adobe.idp.Document door te geven.
   • Maak een javax.servlet.ServletOutputStream-object dat wordt gebruikt om de formuliergegevensstroom naar de webbrowser van de client te schrijven door de methode javax.servlet.http.HttpServletResponse van het object getOutputStream aan te roepen.
   • Maak een java.io.InputStream-object door de methode getInputStream van het object com.adobe.idp.Document aan te roepen.
   • Maak een bytearray die deze met de formuliergegevensstroom vult door de methode readvan het object InputStream aan te roepen en de bytearray als een argument door te geven.
   • Roep de methode javax.servlet.ServletOutputStream van het object write aan om de gegevensstroom van het formulier naar de webbrowser van de client te verzenden. Geef de bytearray door aan de methode write.

Zie ook

Forms renderen op basis van fragmenten

Snel starten (SOAP-modus): Een formulier weergeven op basis van fragmenten met de Java API

Inclusief AEM Forms Java-bibliotheekbestanden

Verbindingseigenschappen instellen

Formulieren weergeven op basis van fragmenten met de API van de webservice

Een formulier weergeven op basis van fragmenten met de Forms API (webservice):

1. Projectbestanden opnemen

   • Maak Java-proxyklassen die gebruikmaken van de Forms-service WSDL.
   • Neem de Java-proxyklassen op in het klassepad.

2. Een Forms Client API-object maken

   Maak een FormsService-object en stel de verificatiewaarden in.

3. URI-waarden opgeven

   • Maak een object URLSpec waarin URI-waarden worden opgeslagen met behulp van de constructor.
   • Roep de methode URLSpec van het object setApplicationWebRoot aan en geef een tekenreekswaarde door die de hoofdmap van de toepassing vertegenwoordigt.
   • Roep de methode setContentRootURI van het object URLSpec aan en geef een tekenreekswaarde door die de URI-waarde van de inhoudsbasis opgeeft. Zorg ervoor dat het formulierontwerp zich in de URI van de inhoudsbasis bevindt. Als niet, werpt de dienst van Forms een uitzondering. Geef repository:// op om naar de gegevensopslagruimte te verwijzen.
   • Roep de methode setTargetURL van het object URLSpec aan en geef een tekenreekswaarde door die de doel-URL-waarde opgeeft waar de formuliergegevens worden gepost. Als u de doel-URL in het formulierontwerp definieert, kunt u een lege tekenreeks doorgeven. U kunt ook de URL opgeven waarnaar een formulier wordt verzonden om berekeningen uit te voeren.

4. Het formulier renderen

   Roep de methode renderPDFForm van het object FormsService aan en geef de volgende waarden door:

   • Een tekenreekswaarde die de naam van het formulierontwerp opgeeft, inclusief de bestandsnaamextensie. Als u naar een formulierontwerp verwijst dat deel uitmaakt van een Forms-toepassing, moet u het volledige pad opgeven, bijvoorbeeld Applications/FormsApplication/1.0/FormsFolder/Loan.xdp.
   • Een object BLOB dat gegevens bevat die met het formulier moeten worden samengevoegd. Als u geen gegevens wilt samenvoegen, geeft u null door.
   • Een PDFFormRenderSpec-object dat uitvoeringsopties opslaat. De optie Gecodeerde PDF kan niet worden ingesteld als het invoerdocument een PDF-document is. Als het invoerbestand een XDP-bestand is, kunt u de optie Gecodeerde PDF instellen.
   • Een object URLSpec dat URI-waarden bevat die door de Forms-service worden vereist.
   • Een java.util.HashMap-object dat bestandsbijlagen opslaat. Dit is een optionele parameter en u kunt null opgeven als u geen bestanden aan het formulier wilt koppelen.
   • Een leeg object com.adobe.idp.services.holders.BLOBHolder dat door de methode is gevuld. Met deze parameter wordt het gegenereerde formulier opgeslagen.
   • Een leeg object javax.xml.rpc.holders.LongHolder dat door de methode is gevuld. In dit argument wordt het aantal pagina's in het formulier opgeslagen.
   • Een leeg object javax.xml.rpc.holders.StringHolder dat door de methode is gevuld. In dit argument wordt de waarde van de landinstelling opgeslagen.
   • Een leeg com.adobe.idp.services.holders.FormsResultHolder-object dat de resultaten van deze bewerking zal bevatten.

   Met de methode renderPDFForm wordt het object com.adobe.idp.services.holders.FormsResultHolder dat als laatste argumentwaarde is doorgegeven, gevuld met een formuliergegevensstroom die naar de webbrowser van de client moet worden geschreven.

5. De formuliergegevensstroom naar de webbrowser van de client schrijven

   • Maak een FormResult-object door de waarde op te halen van het com.adobe.idp.services.holders.FormsResultHolder-gegevenslid van het object.value
   • Maak een BLOB-object dat formuliergegevens bevat door de methode getOutputContent van het object FormsResult aan te roepen.
   • Hiermee wordt het inhoudstype van het object BLOB opgehaald door de methode getContentType ervan aan te roepen.
   • Stel het inhoudstype van het object javax.servlet.http.HttpServletResponse in door de methode setContentType ervan aan te roepen en het inhoudstype van het object BLOB door te geven.
   • Maak een javax.servlet.ServletOutputStream-object dat wordt gebruikt om de formuliergegevensstroom naar de webbrowser van de client te schrijven door de methode javax.servlet.http.HttpServletResponse van het object getOutputStream aan te roepen.
   • Maak een bytearray en vul deze door de methode getBinaryData van het object BLOB aan te roepen. Deze taak wijst de inhoud van het FormsResult voorwerp aan de byteserie toe.
   • Roep de methode javax.servlet.http.HttpServletResponse van het object write aan om de gegevensstroom van het formulier naar de webbrowser van de client te verzenden. Geef de bytearray door aan de methode write.

Zie ook

Forms renderen op basis van fragmenten

AEM Forms aanroepen met Base64-codering

Business.Adobe.com-bronnen

Personalized Experiences Responsive Forms Document Generation Content Management Headless Cms Digital Signage