Aangepaste verzendhandeling schrijven voor aangepaste formulieren

Voor adaptieve formulieren zijn acties verzenden vereist om door de gebruiker opgegeven gegevens te verwerken. Een handeling Verzenden bepaalt de taak die wordt uitgevoerd voor de gegevens die u verzendt met behulp van een adaptief formulier. Adobe Experience Manager (AEM) bevat OOTB Handelingen verzenden die aangepaste taken demonstreren die u kunt uitvoeren met de door de gebruiker verzonden gegevens. U kunt bijvoorbeeld taken uitvoeren, zoals het verzenden van e-mail of het opslaan van de gegevens.

Workflow voor een verzendactie

Het stroomschema geeft de workflow weer voor een handeling Verzenden die wordt geactiveerd wanneer u op de knop Submit klikt in een adaptief formulier. De bestanden in de component Bestandsbijlage worden geüpload naar de server en de formuliergegevens worden bijgewerkt met de URL's van de geüploade bestanden. Binnen de client worden de gegevens opgeslagen in de JSON-indeling. De client verzendt een Ajax-aanvraag naar een interne servlet die de opgegeven gegevens in massa neemt en deze in XML-indeling retourneert. De client sorteert deze gegevens met actievelden. De gegevens worden via een handeling Formulier verzenden verzonden naar de uiteindelijke servlet (Guide verzendt servlet). Dan, door:sturen servlet de controle aan de Submit actie. De handeling Verzenden kan het verzoek doorsturen naar een andere kiesbron of de browser omleiden naar een andere URL.

Stroomdiagram dat de workflow voor een verzendactie weergeeft

XML-gegevensindeling

De XML-gegevens worden naar de servlet verzonden met de aanvraagparameter jcr:data. Verzendhandelingen hebben toegang tot de parameter om de gegevens te verwerken. In de volgende code wordt de indeling van de XML-gegevens beschreven. De velden die zijn gebonden aan het formuliermodel, worden weergegeven in de sectie afBoundData. Niet-gebonden velden worden weergegeven in de sectie afUnoundData. Zie Inleiding tot het vooraf invullen van aangepaste formuliervelden voor meer informatie over de indeling van het data.xml-bestand.

<?xml ?>
<afData>
<afUnboundData>
<data>
<field1>value</field2>
<repeatablePanel>
    <field2>value</field2>
</repeatablePanel>
<repeatablePanel>
    <field2>value</field2>
</repeatablePanel>
</data>
</afUnboundData>
<afBoundData>
<!-- xml corresponding to the Form Model /XML Schema -->
</afBoundData>
</afData>

Handelingsvelden

Met een handeling Verzenden kunt u verborgen invoervelden (met de HTML-tag input) toevoegen aan het gerenderde formulier HTML. Deze verborgen velden kunnen waarden bevatten die nodig zijn tijdens de verwerking van formulierverzendingen. Bij het verzenden van het formulier worden deze veldwaarden teruggeplaatst als aanvraagparameters die de handeling Verzenden kan gebruiken tijdens het verzenden. De invoervelden worden actievelden genoemd.

Met een handeling Verzenden waarmee bijvoorbeeld ook de tijd wordt vastgelegd die nodig is om een formulier in te vullen, kunt u de verborgen invoervelden startTime en endTime toevoegen.

Een script kan de waarden van de velden startTime en endTime leveren wanneer het formulier wordt gerenderd en vóór het verzenden van het formulier. Met het handelingsscript voor verzenden post.jsp hebt u vervolgens toegang tot deze velden met behulp van aanvraagparameters en kunt u de totale tijd berekenen die nodig is om het formulier in te vullen.

Bestandsbijlagen

Verzendhandelingen kunnen ook de bestandsbijlagen gebruiken die u uploadt met de component Bestandsbijlage. Verzend actiescripts kunnen tot deze dossiers toegang hebben gebruikend de schuine streep RequestParameter API. Met de methode isFormField van de API kunt u bepalen of de aanvraagparameter een bestand of een formulierveld is. U kunt de parameters van het Verzoek in een Submit actie herhalen om de parameters van de Bijlage van het Dossier te identificeren.

De volgende voorbeeldcode identificeert de bestandsbijlagen in de aanvraag. Vervolgens worden de gegevens in het bestand gelezen met de Get API. Ten slotte wordt een object Document gemaakt met behulp van de gegevens en toegevoegd aan een lijst.

RequestParameterMap requestParameterMap = slingRequest.getRequestParameterMap();
for (Map.Entry<String, RequestParameter[]> param : requestParameterMap.entrySet()) {
    RequestParameter rpm = param.getValue()[0];
    if(!rpm.isFormField()) {
        fileAttachments.add(new Document(rpm.get()));
    }
}

Door:sturen weg en Redirect URL

Nadat de vereiste actie is uitgevoerd, stuurt de Submit servlet de aanvraag door naar het voorwaartse pad. Een handeling gebruikt de setForwardPath API om het voorwaartse pad in te stellen in de Guide Submit servlet.

Als de handeling geen voorwaarts pad biedt, leidt de verzendserver de browser om met de Redirect URL. De auteur configureert de omleidings-URL met behulp van de configuratie Bedankt voor de pagina in het dialoogvenster Formulier bewerken. U kunt de Redirect URL ook configureren via de handeling Verzenden of de setRedirectUrl-API in het dialoogvenster Guide Verzenden. U kunt de parameters van het Verzoek die naar Redirect URL worden verzonden ook vormen gebruikend setRedirectParameters API in de Gids Submit servlet.

OPMERKING

Een auteur verstrekt Redirect URL (gebruikend de Dank u Configuratie van de Pagina). OOTB verzendt Acties gebruikt Redirect URL om browser van het middel om te leiden dat de voorwaartse weg verwijzingen.

U kunt een douane schrijven voorlegt actie die een verzoek aan een middel of servlet door:sturen. Adobe adviseert dat het manuscript dat middel behandeling voor de voorwaartse weg uitvoert het verzoek aan Redirect URL opnieuw richt wanneer de verwerking voltooit.

Handeling verzenden

Een handeling Verzenden is een tekenreeks:Map die het volgende bevat:

  • addfields.jsp: Dit script bevat de actievelden die tijdens de uitvoering aan het HTML-bestand worden toegevoegd. Gebruik dit script om verborgen invoerparameters toe te voegen die zijn vereist tijdens verzending in het script post.POST.jsp.

  • dialog.xml: Dit script is vergelijkbaar met het dialoogvenster CQ-component. Het verstrekt configuratieinformatie die de auteur aanpast. De velden worden weergegeven op het tabblad Handelingen verzenden in het dialoogvenster Formulier bewerken Adaptief wanneer u de handeling Verzenden selecteert.

  • post.POST.jsp: Het Submit servlet roept dit manuscript met de gegevens die u en de extra gegevens in de vorige secties indient. Elke vermelding van het uitvoeren van een handeling op deze pagina houdt in dat het script post.POST.jsp wordt uitgevoerd. Als u de handeling Verzenden wilt registreren met de adaptieve formulieren die u wilt weergeven in het dialoogvenster Formulier bewerken, voegt u de volgende eigenschappen toe aan de lijst:Map:

    • ​guideComponentType of type String en value fd/af/components/guidesubmittype
    • ​guideDataModelof type String die het type adaptieve vorm opgeeft waarvoor de handeling Verzenden van toepassing is. XFAIS wordt ondersteund voor op XFA gebaseerde adaptieve formulieren, terwijl ​xsdis wordt ondersteund voor op XSD gebaseerde adaptieve formulieren. De basisbeginselen worden ondersteund voor adaptieve formulieren die geen XDP of XSD gebruiken. Voeg de corresponderende tekenreeksen toe om de handeling weer te geven op meerdere typen adaptieve formulieren. Scheid elke tekenreeks door een komma. Als u bijvoorbeeld een handeling zichtbaar wilt maken op op XFA en XSD gebaseerde adaptieve formulieren, geeft u de waarden xfa en xsd op.
    • jcr: beschrijving van het type String. De waarde van deze eigenschap wordt weergegeven in de actielijst Verzenden op het tabblad Handelingen verzenden van het dialoogvenster Formulier bewerken Adaptief. De OOTB-acties zijn aanwezig in de CRX-opslagruimte op de locatie /libs/fd/af/components/guidesubmittype.

Een aangepaste verzendhandeling maken

Voer de volgende stappen uit om een aangepaste handeling Verzenden te maken die de gegevens opslaat in de CRX-opslagplaats en u vervolgens een e-mail stuurt. Het adaptieve formulier bevat de OOTB-actie Store Content (afgekeurd) waarmee de gegevens worden opgeslagen in de CRX-opslagplaats. Daarnaast biedt CQ een Mail-API die kan worden gebruikt om e-mails te verzenden. Voordat u de e-mail-API gebruikt, [configure] (https://docs.adobe.com/docs/en/cq/current/administering/notification.html?#Configuring de e-mailservice) de Day CQ Mail-service via de systeemconsole. U kunt de actie Store Content (afgekeurd) opnieuw gebruiken om de gegevens in de opslagplaats op te slaan. De actie Store Content (afgekeurd) is beschikbaar op de locatie /libs/fd/af/components/guidesubmittype/store in de CRX-opslagruimte.

  1. Meld u aan bij CRXDE Lite op de URL https://<server>:<port>/crx/de/index.jsp. Maak een knooppunt met de eigenschap sling:Folder en name store_and_mail in de map /apps/custom_submit_action. Maak de map custom_submit_action als deze nog niet bestaat.

    Screenshot die het maken van een knooppunt met de eigenschap sling:Folder weergeeft

  2. Geef de verplichte configuratievelden op.

    Voeg de configuratie toe die de winkelactie vereist. Kopieer het knooppunt cq:dialog van de handeling Store van /libs/fd/af/components/guidesubmittype/store naar de map action op /apps/custom_submit_action/store_and_email.

    Screenshot met het kopiëren van het dialoogvenster naar de map action.

  3. Geef configuratievelden op om de auteur te vragen of er een e-mailconfiguratie nodig is.

    Het adaptieve formulier bevat ook een e-mailactie die e-mailberichten naar gebruikers verzendt. Pas deze actie aan op basis van uw vereisten. Navigeer naar /libs/fd/af/components/guidesubmittype/email/dialog. Kopieer de knooppunten in het cq:dialog-knooppunt naar cq:dialog-knooppunt van de handeling Verzenden (/apps/custom_submit_action/store_and_email/dialog?lang=nl).

    De e-mailactie aanpassen

  4. De handeling beschikbaar stellen in het dialoogvenster Formulier bewerken Adaptief.

    Voeg de volgende eigenschappen in store_and_email knoop toe:

    • ​guideComponentType of type ​String en value fd/af/components/guidesubmittype
    • ​guideDataModelof type ​String and value xfa, xsd, basic
    • jcr: beschrijving van type ​String en waarde Store en Email Action
  5. Open een adaptief formulier. Klik op de knop Bewerken naast Start om het dialoogvenster Bewerken van de adaptieve formuliercontainer te openen. De nieuwe actie wordt getoond in Voorlegt Acties Lusje. Als u Handeling opslaan en e-mailen selecteert, wordt de configuratie weergegeven die is toegevoegd in het dialoogvenster.

    Dialoogvenster Handelingsconfiguratie verzenden

  6. Gebruik de handeling om een taak te voltooien.

    Voeg het script post.POST.jsp toe aan uw handeling. (/apps/custom_submit_action/store_and_mail/?lang=nl).

    Voer de actie OOTB Store uit (script post.POST.jsp). Gebruik de API [FormsHelper.runAction] (https://docs.adobe.com/docs/en/cq/current/javadoc/com/day/cq/wcm/foundation/forms/FormsHelper.html#runAction(java.lang.String,%20java.lang.String,%20org.apache.sling.api.resource.Resource,%20org.apache.sling.api.SlingHttpServletRequest,%20org.apache.sling.api.SlingHttpServletResponse?lang=nl) die CQ in biedt Je code om de actie Winkel uit te voeren. Voeg de volgende code in uw JSP dossier toe:

    FormsHelper.runAction("/libs/fd/af/components/guidesubmittype/store", "post", resource, slingRequest, slingResponse);

    Om e-mail te verzenden, leest de code het e-mailadres van de ontvanger van de configuratie. Om de configuratiewaarde in het manuscript van de actie te halen, lees de eigenschappen van het huidige middel gebruikend de volgende code. Op dezelfde manier kunt u de andere configuratiedossiers lezen.

    ValueMap properties = ResourceUtil.getValueMap(resource);

    String mailTo = properties.get("mailTo");

    Tot slot gebruikt u de CQ Mail-API om de e-mail te verzenden. Gebruik de klasse SimpleEmail om het E-mailobject te maken zoals hieronder wordt weergegeven:

    OPMERKING

    Zorg ervoor dat het JSP-bestand de naam post.POST.jsp heeft.

    <%@include file="/libs/fd/af/components/guidesglobal.jsp" %>
    <%@page import="com.day.cq.wcm.foundation.forms.FormsHelper,
           org.apache.sling.api.resource.ResourceUtil,
           org.apache.sling.api.resource.ValueMap,
                    com.day.cq.mailer.MessageGatewayService,
      com.day.cq.mailer.MessageGateway,
      org.apache.commons.mail.Email,
                    org.apache.commons.mail.SimpleEmail" %>
    <%@taglib prefix="sling"
                    uri="https://sling.apache.org/taglibs/sling/1.0" %>
    <%@taglib prefix="cq"
                    uri="https://www.day.com/taglibs/cq/1.0"
    %>
    <cq:defineObjects/>
    <sling:defineObjects/>
    <%
            String storeContent =
                        "/libs/fd/af/components/guidesubmittype/store";
            FormsHelper.runAction(storeContent, "post", resource,
                                    slingRequest, slingResponse);
     ValueMap props = ResourceUtil.getValueMap(resource);
     Email email = new SimpleEmail();
     String[] mailTo = props.get("mailto", new String[0]);
     email.setFrom((String)props.get("from"));
            for (String toAddr : mailTo) {
                email.addTo(toAddr);
       }
     email.setMsg((String)props.get("template"));
     email.setSubject((String)props.get("subject"));
     MessageGatewayService messageGatewayService =
                        sling.getService(MessageGatewayService.class);
     MessageGateway messageGateway =
                    messageGatewayService.getGateway(SimpleEmail.class);
     messageGateway.send(email);
    %>
    

    Selecteer de handeling in het adaptieve formulier. De actie verzendt een e-mail en slaat de gegevens op.

Op deze pagina