Lägga till regler i ett adaptivt formulär adaptive-forms-rule-editor

Adobe rekommenderar att du använder den moderna och utbyggbara datainhämtningen Core Componentsför att skapa nya adaptiva Formseller att lägga till adaptiva Forms på AEM Sites-sidor. De här komponenterna utgör ett betydande framsteg när det gäller att skapa adaptiva Forms-filer, vilket ger imponerande användarupplevelser. I den här artikeln beskrivs det äldre sättet att skapa Adaptiv Forms med baskomponenter.

Ökning overview

Regelredigerarfunktionen ger formuläranvändare och utvecklare möjlighet att skriva regler på adaptiva formulärobjekt. Dessa regler definierar åtgärder som ska utlösas av formulärobjekt baserat på förinställda villkor, användarindata och användaråtgärder i formuläret. Det effektiviserar formulärifyllningen ytterligare och ger större precision och snabbhet.

Regelredigeraren har ett intuitivt och förenklat användargränssnitt för att skriva regler. Regelredigeraren erbjuder en visuell redigerare för alla användare. Några av de viktigaste åtgärderna som du kan utföra på adaptiva formulärobjekt med hjälp av regler är:

Användare som läggs till i användargruppen för formulär kan skapa skript och redigera befintliga. Användare i gruppen forms-users kan använda skript men inte skapa eller redigera skript.

Skillnaden mellan regelredigeraren i kärnkomponenterna och regelredigeraren i grundkomponenterna

I följande tabell visas skillnaden mellan de funktioner som är tillgängliga i regelredigerarens kärnkomponenter och grundkomponenterna i regelredigeraren:

Förstå en regel understanding-a-rule

En regel är en kombination av åtgärder och villkor. I regelredigeraren omfattar åtgärderna aktiviteter som att dölja, visa, aktivera, inaktivera eller beräkna värdet för ett objekt i ett formulär. Villkor är booleska uttryck som utvärderas genom att kontroller och åtgärder utförs på ett formulärobjekts status, värde eller egenskap. Åtgärder utförs baserat på det värde ( True eller False) som returneras när ett villkor utvärderas.

Regelredigeraren innehåller en uppsättning fördefinierade regeltyper, till exempel När, Visa, Dölj, Aktivera, Inaktivera, Ange värde för och Validera, som hjälper dig att skriva regler. Med varje regeltyp kan du definiera villkor och åtgärder i en regel. I dokumentet förklaras dessutom varje regeltyp i detalj.

En regel följer vanligtvis någon av följande konstruktioner:

Condition-Action I den här konstruktionen definierar en regel först ett villkor följt av en åtgärd som ska utlösas. Konstruktionen är jämförbar med if-then-programsatsen i programmeringsspråk.

Regeltypen När används i regelredigeraren för att framtvinga konstruktorn för villkorsåtgärd.

Åtgärdsvillkor I den här konstruktionen definierar en regel först en åtgärd som ska utlösas följt av villkor för utvärdering. En annan variant av den här konstruktionen är action-condition-alternate action, som också definierar en alternativ åtgärd som ska utlösas om villkoret returnerar False.

Regeltyperna Visa, Dölj, Aktivera, Inaktivera, Ange värde för och Validera i regelredigeraren framtvingar regelkonstruktionen för åtgärdsvillkor. Som standard är den alternativa åtgärden för Visa Dölj och Aktivera Inaktivera, och tvärtom. Du kan inte ändra den alternativa standardåtgärden.

Mer information om tillgängliga regeltyper i regelredigeraren finns i Tillgängliga regeltyper i regelredigeraren.

Riktlinjer för val av regelkonstruktion guidelines-for-choosing-a-rule-construct

Även om du kan uppnå de flesta användningsexemplen genom att använda valfri regelkonstruktion finns det några riktlinjer för att välja en konstruktion framför en annan. Mer information om tillgängliga regler i regelredigeraren finns i Tillgängliga regeltyper i regelredigeraren.

Tillgängliga operatortyper och händelser i regelredigeraren available-operator-types-and-events-in-rule-editor

Regelredigeraren innehåller följande logiska operatorer och händelser som du kan använda för att skapa regler.

Tillgängliga regeltyper i regelredigeraren available-rule-types-in-rule-editor

Regelredigeraren innehåller en uppsättning fördefinierade regeltyper som du kan använda för att skriva regler. Vi tittar närmare på varje regeltyp. Mer information om hur du skriver regler i regelredigeraren finns i Skriv regler.

When whenruletype

Regeltypen When följer regelkonstruktionen condition-action-alternate action, eller ibland bara condition-action-konstruktionen ​. I den här regeltypen anger du först ett villkor för utvärdering följt av en åtgärd som ska utlösas om villkoret uppfylls ( True). När du använder regeltypen When kan du använda flera AND- och OR-operatorer för att skapa kapslade uttryck.

Med hjälp av regeltypen När kan du utvärdera ett villkor för ett formulärobjekt och utföra åtgärder på ett eller flera objekt.

I klartext är en typisk When-regel strukturerad på följande sätt:

When on Object A:

(Condition 1 AND Condition 2 OR Condition 3) is TRUE;

Then, do the following:

Åtgärd 2 om objekt B;
OCH
Åtgärd 3 om objekt C;

_

När du har en komponent med flera värden, till exempel alternativknappar eller listor, hämtas alternativen automatiskt och görs tillgängliga för regelskaparen när du skapar en regel för den komponenten. Du behöver inte ange alternativvärdena igen.

En lista har till exempel fyra alternativ: Röd, Blå, Grön och Gul. När du skapar regeln hämtas alternativen (alternativknapparna) automatiskt och görs tillgängliga för regelskaparen enligt följande:

När du skriver en When-regel kan du utlösa åtgärden Rensa värde för. Åtgärden Rensa värde för rensar värdet för det angivna objektet. Med alternativet Radera värde för i programsatsen When kan du skapa komplexa villkor med flera fält.

Hide Döljer det angivna objektet.

Show Visar det angivna objektet.

Enable Aktiverar det angivna objektet.

Disable Inaktiverar det angivna objektet.

Invoke service Anropar en tjänst som konfigurerats i en formulärdatamodell (FDM). När du väljer åtgärden Anropa tjänst visas ett fält. När användaren knackar på fältet visas alla tjänster som konfigurerats i alla formulärdatamodeller (FDM) på Experience Manager-instansen. När du väljer en FDM-tjänst (Form Data Model) visas fler fält där du kan mappa formulärobjekt med in- och utdataparametrar för den angivna tjänsten. Se exempelregel för anrop av Form Data Model-tjänster.

Utöver Form Data Model-tjänsten kan du ange en direkt WSDL-URL för att anropa en webbtjänst. En Form Data Model-tjänst har dock många fördelar och det rekommenderade sättet att anropa en tjänst.

Mer information om hur du konfigurerar tjänster i formulärdatamodellen (FDM) finns i Experience Manager Forms Dataintegrering.

Set value of Beräknar och ställer in värdet för det angivna objektet. Du kan ställa in objektvärdet på en sträng, värdet för ett annat objekt, det beräknade värdet med hjälp av matematiska uttryck eller funktioner, värdet för ett objekts egenskap eller utdatavärdet från en konfigurerad Form Data Model-tjänst. När du väljer webbtjänstalternativet visas alla tjänster som konfigurerats i alla formulärdatamodeller (FDM) på Experience Manager-instansen. När du väljer en tjänst för formulärdatamodell visas fler fält där du kan mappa formulärobjekt med in- och utdataparametrar för den angivna tjänsten.

Mer information om hur du konfigurerar tjänster i formulärdatamodellen (FDM) finns i Experience Manager Forms Dataintegrering.

Regeltypen Set Property gör att du kan ange värdet för en egenskap för det angivna objektet baserat på en villkorsåtgärd. Du kan ställa in egenskapen på något av följande:

Du kan till exempel definiera regler för att lägga till kryssrutor dynamiskt i det adaptiva formuläret. Du kan använda en anpassad funktion, ett formulärobjekt eller en objektegenskap för att definiera en regel.

Om du vill definiera en regel baserat på en anpassad funktion väljer du Function Output i listrutan och drar och släpper en anpassad funktion på fliken Functions. Om villkorsåtgärden uppfylls läggs antalet kryssrutor som definierats i den anpassade funktionen till i det adaptiva formuläret.

Om du vill definiera en regel baserat på ett formulärobjekt väljer du Form Object i listrutan och drar och släpper ett formulärobjekt på fliken Form Objects. Om villkorsåtgärden uppfylls läggs antalet kryssrutor som är definierade i formulärobjektet till i det adaptiva formuläret.

Med en regel för att ange egenskap som baseras på en objektegenskap kan du lägga till antalet kryssrutor i ett adaptivt formulär baserat på en annan objektegenskap som ingår i det adaptiva formuläret.

I följande bild visas ett exempel på hur du dynamiskt lägger till kryssrutor baserat på antalet nedrullningsbara listor i det adaptiva formuläret:

Clear Value Of Tar bort det angivna objektets värde.

Set Focus anger fokus på det angivna objektet.

Save Form Sparar formuläret.

Submit Forms skickar formuläret.

Reset Form Återställer formuläret.

Validate Form Validerar formuläret.

Add Instance lägger till en instans av den angivna repeterbara panelen eller tabellraden.

Remove Instance Tar bort en instans av den angivna repeterbara panelen eller tabellraden.

Navigate to Navigerar till annan Adaptiv Forms, andra resurser som bilder eller dokumentfragment eller en extern URL.

Set Value of set-value-of

Med regeltypen Set Value of kan du ange värdet för ett formulärobjekt beroende på om det angivna villkoret är uppfyllt eller inte. Värdet kan anges till ett värde för ett annat objekt, en stränglitteral, ett värde som härleds från ett matematiskt uttryck eller en funktion, ett värde för en egenskap för ett annat objekt eller utdata från en Form Data Model-tjänst. På samma sätt kan du söka efter ett villkor för en komponent, en sträng, en egenskap eller värden som härletts från en funktion eller ett matematiskt uttryck.

Regeltypen Ange värdet för är inte tillgänglig för alla formulärobjekt, till exempel paneler och knappar i verktygsfält. En standarduppsättningsvärde för regel har följande struktur:

Ange värdet för objekt A till:

(sträng ABC) ELLER
(objektegenskap X för objekt C) ELLER
(värde från en funktion) ELLER
(värde från ett matematiskt uttryck) ELLER
(utdatavärde för en datamodellstjänst eller webbtjänst)

När (valfritt):

(Villkor 1 OCH Villkor 2 OCH Villkor 3) är SANT;

I följande exempel används värdet i fältet som indata och fältets värde Relation anges till utdata från Relation argumentet getDependent i dependentid tjänsten Form Data Model.

Exempel på Ange värderegel med tjänsten Formulärdatamodell

Show show

Med regeltypen Show kan du skriva en regel som visar eller döljer ett formulärobjekt baserat på om ett villkor är uppfyllt eller inte. Regeltypen Visa utlöser även åtgärden Dölj om villkoret inte uppfylls eller returnerar False.

En vanlig Visa-regel är strukturerad på följande sätt:

Show Object A;

When:

(Condition 1 OR Condition 2 OR Condition 3) is TRUE;

Else:

Hide Object A;

Hide hide

På liknande sätt som med regeltypen Visa kan du använda regeltypen Hide för att visa eller dölja ett formulärobjekt baserat på om ett villkor är uppfyllt eller inte. Dölj regeltyp utlöser även åtgärden Visa om villkoret inte uppfylls eller returnerar False.

En vanlig Dölj-regel är strukturerad på följande sätt:

Hide Object A;

When:

(Condition 1 AND Condition 2 AND Condition 3) is TRUE;

Else:

Show Object A;

Enable enable

Regeltypen Enable gör att du kan aktivera eller inaktivera ett formulärobjekt baserat på om ett villkor är uppfyllt eller inte. Regeltypen Aktivera utlöser även åtgärden Inaktivera om villkoret inte uppfylls eller returnerar False.

En vanlig Aktivera-regel är strukturerad på följande sätt:

Enable Object A;

When:

(Condition 1 AND Condition 2 AND Condition 3) is TRUE;

Else:

Disable Object A;

Disable disable

På liknande sätt som för typen Aktivera regel kan du med regeltypen Disable aktivera eller inaktivera ett formulärobjekt baserat på om ett villkor är uppfyllt eller inte. Regeltypen Inaktivera utlöser också åtgärden Aktivera om villkoret inte uppfylls eller returnerar False.

En vanlig inaktiveringsregel är strukturerad på följande sätt:

Disable Object A;

When:

(Condition 1 OR Condition 2 OR Condition 3) is TRUE;

Else:

Enable Object A;

Validate validate

Regeltypen Validate validerar värdet i ett fält med hjälp av ett uttryck. Du kan till exempel skriva ett uttryck för att kontrollera att textrutan för att ange namn inte innehåller specialtecken eller siffror.

En vanlig valideringsregel är strukturerad enligt följande:

Validate Object A;

Using:

(Expression 1 AND Expression 2 AND Expression 3) is TRUE;

Set Options Of setoptionsof

Regeltypen Set Options Of gör att du kan definiera regler för att lägga till kryssrutor dynamiskt i det anpassade formuläret. Du kan använda en formulärdatamodell (FDM) eller en anpassad funktion för att definiera regeln.

Om du vill definiera en regel baserat på en anpassad funktion väljer du Function Output i listrutan och drar och släpper en anpassad funktion på fliken Functions. Antalet kryssrutor som definieras i den anpassade funktionen läggs till i det adaptiva formuläret.

Mer information om hur du skapar en anpassad funktion finns i anpassade funktioner i regelredigeraren.

Så här definierar du en regel baserad på en formulärdatamodell (FDM):

Förstå användargränssnittet för regelredigeraren understanding-the-rule-editor-user-interface

Regelredigeraren har ett omfattande men ändå enkelt användargränssnitt för att skriva och hantera regler. Du kan starta regelredigerarens användargränssnitt i ett adaptivt formulär i redigeringsläge.

Så här startar du användargränssnittet för regelredigeraren:

Vi tittar närmare på varje komponent i regelredigeringsgränssnittet.

A. Visning av komponentregel a-component-rule-display

Visar titeln på det adaptiva formulärobjektet genom vilket du startade regelredigeraren och den regeltyp som är vald. I ovanstående exempel startas regelredigeraren från ett anpassat formulärobjekt med namnet Lön och den valda regeltypen är När.

B. Formulärobjekt och -funktioner b-form-objects-and-functions-br

Panelen till vänster i regelredigerarens användargränssnitt innehåller två flikar - Forms Objects och Functions.

På fliken Formulärobjekt visas en hierarkisk vy över alla objekt som finns i det adaptiva formuläret. Där visas objektens namn och typ. När du skriver en regel kan du dra och släppa formulärobjekt till regelredigeraren. När du skapar eller redigerar en regel när du drar och släpper ett objekt eller en funktion till en platshållare, får platshållaren automatiskt rätt värdetyp.

De formulärobjekt som har en eller flera giltiga regler markerade med en grön punkt. Om någon av reglerna som tillämpas på ett formulärobjekt är ogiltig markeras formulärobjektet med en gul punkt.

Fliken Funktioner innehåller en uppsättning inbyggda funktioner, till exempel summan av, Min av, Max av, Medel av, Antal, och Validera formulär. Du kan använda de här funktionerna för att beräkna värden i repeterbara paneler och tabellrader och använda dem i action- och condition-satser när du skriver regler. Du kan dock även skapa anpassade funktioner.

I det vänstra trädet för formulärobjekten kan du markera de formulärobjekt som ska visa de regler som tillämpas på vart och ett av objekten. Du kan inte bara navigera bland reglerna för de olika formulärobjekten, du kan även kopiera och klistra in regler mellan formulärobjekten. Mer information finns i Kopiera och klistra in regler.

C. Växla mellan formulärobjekt och funktioner c-form-objects-and-functions-toggle-br

När användaren knackar på knappen växlar knappen formulärobjekt och funktionsruta.

D. Visuell regelredigerare visual-rule-editor

Visuell regelredigerare är det område i det visuella redigeringsläget i regelredigerarens användargränssnitt där du skriver regler. Här kan du välja en regeltyp och definiera villkor och åtgärder. När du definierar villkor och åtgärder i en regel kan du dra och släppa formulärobjekt och funktioner från rutan Formulärobjekt och funktioner.

Mer information om hur du använder den visuella regelredigeraren finns i Skriva regler.

E. Knapparna Klar och Avbryt done-and-cancel-buttons

Knappen Done används för att spara en regel. Du kan spara en ofullständig regel. Ofullständiga är dock ogiltiga och kan inte köras. Sparade regler för ett formulärobjekt visas nästa gång du startar regelredigeraren från samma formulärobjekt. Du kan hantera befintliga regler i den vyn. Mer information finns i Hantera regler.

Knappen Cancel ignorerar alla ändringar du har gjort i en regel och stänger regelredigeraren.

Skriv regler write-rules

Du kan skriva regler med den visuella regelredigeraren <!— eller kodredigeraren>. När du startar regelredigeraren första gången öppnas den i det visuella redigeringsläget. Du kan växla till kodredigeringsläget och skriva regler. Om du däremot skriver eller ändrar en regel i kodredigeraren kan du inte växla till den visuella redigeraren för den regeln om du inte rensar kodredigeraren. När du startar regelredigeraren nästa gång öppnas den i det läge som du använde när du skapade regeln senast.

Låt oss först titta på hur man skriver regler med visuell redigerare.

Använda den visuella redigeraren using-visual-editor

Låt oss förstå hur du skapar en regel i den visuella redigeraren med hjälp av följande exempelformulär.

I avsnittet Krav för lån i exempelformuläret för låneansökan måste de sökande ange sin äktenskapsstatus, lön och, om de är gifta, sin makas lön. Baserat på användarens indata beräknar regeln beloppet för rätt till lån och visas i fältet Låneberättigande. Använd följande regler för att implementera scenariot:

Så här skriver du regler:

Anpassade funktioner i regelredigeraren custom-functions

Förutom användningsklara funktioner som Summan av som listas under Funktioner Output, kan du skriva anpassade funktioner som du ofta behöver. Kontrollera att den funktion du skriver åtföljs av jsdoc ovan.

Ytterligare jsdoc krävs:

Regelredigeraren stöder JavaScript ES5-syntax för skript och anpassade funktioner.
Mer information finns i jsdoc.app.

jsdoc taggar som stöds:

Lägger till en anpassad funktion

Du kan t.ex. lägga till en egen funktion som beräknar en kvadratyta. Sidlängd är användarens indata till den anpassade funktionen, som accepteras med en numerisk ruta i formuläret. Beräknade utdata visas i en annan numerisk ruta i formuläret. Om du vill lägga till en anpassad funktion måste du först skapa ett klientbibliotek och sedan lägga till det i CRX-databasen.

Så här skapar du ett klientbibliotek och lägger till det i CRX-databasen:

När du har lagt till ditt klientbibliotek i CRX-databasen kan du använda det i ditt adaptiva formulär. Du kan använda den anpassade funktionen som en regel i formuläret. Så här lägger du till klientbiblioteket i ditt adaptiva formulär:

Typer som stöds för funktionsdeklaration function-declaration-supported-types

Funktionssats

function area(len) {
    return len*len;
}

Den här funktionen ingår utan jsdoc kommentarer.

Funktionsuttryck

var area;
//Some codes later
/** */
area = function(len) {
    return len*len;
};

Funktionsuttryck och programsats

var b={};
/** */
b.area = function(len) {
    return len*len;
}

Funktionsdeklaration som variabel

/** */
var x1,
    area = function(len) {
        return len*len;
    },
    x2 =5, x3 =true;

Begränsning: den anpassade funktionen väljer bara den första funktionsdeklarationen från variabellistan, om den används tillsammans. Du kan använda funktionsuttryck för varje deklarerad funktion.

Funktionsdeklaration som objekt

var c = {
    b : {
        /** */
        area : function(len) {
            return len*len;
        }
    }
};

Hantera regler manage-rules

Alla befintliga regler för ett formulärobjekt visas när du markerar objektet och väljer . Du kan visa titeln och förhandsgranska regelsammanfattningen. I användargränssnittet kan du dessutom expandera och visa hela regelsammanfattningen, ändra ordningen på regler, redigera regler och ta bort regler.

Du kan utföra följande åtgärder på regler:

Kopiera och klistra in regler copy-paste-rules

Du kan kopiera och klistra in en regel från ett fält till andra liknande fält för att spara tid.

Så här kopierar och klistrar du in regler:

Kapslade uttryck nestedexpressions

Med regelredigeraren kan du använda flera AND- och OR-operatorer för att skapa kapslade regler. Du kan blanda flera AND- och OR-operatorer i regler.

Nedan visas ett exempel på en kapslad regel som visar ett meddelande till användaren om rätt att vårdas av ett barn när de obligatoriska villkoren är uppfyllda.

Du kan också redigera genom att dra och släppa villkor i en regel. Markera och hovra över handtaget ( ) före ett villkor. När pekaren ändras till en handsymbol enligt nedan drar och släpper du villkoret någonstans i linjen. Regelstrukturen ändras.

Villkor för datumuttryck dateexpression

Med regelredigeraren kan du använda datumjämförelser för att skapa villkor.

Följande är ett exempelvillkor som visar ett statiskt textobjekt om inteckningen på huset redan har tagits, vilket användaren anger genom att fylla i datumfältet.

När datumet för inteckningen av egendomen som fyllts i av användaren har inträffat visas en anteckning om inkomstberäkningen i det adaptiva formuläret. I följande regel jämförs det datum som användaren fyller i med det aktuella datumet och om det datum som användaren fyller i är tidigare än det aktuella datumet visas textmeddelandet (Inkommande) i formuläret.

När det ifyllda datumet infaller tidigare än det aktuella datumet visas textmeddelandet (intäkt) enligt följande:

Nummerjämförelsevillkor number-comparison-conditions

Med regelredigeraren kan du skapa villkor som jämför två tal.

Följande är ett exempelvillkor som visar ett statiskt textobjekt om antalet månader en sökande stannar på den aktuella adressen är mindre än 36.

När användaren anger att han/hon bor på den aktuella bostadsadressen i mindre än 36 månader visas ett meddelande i formuläret om att det går att begära fler bosättningsbevis.

Exempelregler example

Anropa tjänsten Formulärdatamodell invoke

Överväg en webbtjänst GetInterestRates som tar lånebelopp, löptid och sökandens kreditpoäng som indata och returnerar en låneplan som inkluderar EMI-belopp och ränta. Du skapar en formulärdatamodell (FDM) med webbtjänsten som datakälla. Du lägger till datamodellsobjekt och en get-tjänst i formulärmodellen. Tjänsten visas på fliken Tjänster i formulärdatamodellen (FDM). Skapa sedan ett adaptivt formulär som innehåller fält från datamodellsobjekt för att samla in användarindata för lånebelopp, löptid och kreditpoäng. Lägg till en knapp som utlöser webbtjänsten för att hämta planinformation. Utdata fylls i i lämpliga fält.

Följande regel visar hur du konfigurerar åtgärden Anropa tjänst för att slutföra exempelscenariot.

Utlösa flera åtgärder med hjälp av regeln När triggering-multiple-actions-using-the-when-rule

I en låneansökan vill du ta reda på om lånesökanden är en befintlig kund eller inte. Baserat på den information som användaren anger, bör fältet för kund-ID visas eller döljas. Du vill också fokusera på fältet för kund-ID om användaren är en befintlig kund. Formuläret för låneansökan innehåller följande komponenter:

När du skriver en When-regel på alternativknappen för att implementera det här beteendet, visas regeln på följande sätt i den visuella regelredigeraren.

Regel i den visuella redigeraren

I exempelregeln är programsatsen i avsnittet När villkoret, som när returnerar True, utför de åtgärder som anges i avsnittet Sedan.

Använda ett funktionsutdata i en regel using-a-function-output-in-a-rule

I ett inköpsorderformulär har du följande tabell där användarna fyller i sina order. I denna tabell:

A. Rad1 B. Kvantitet C. Totalt antal

Nu vill du lägga till angivna kvantiteter i kolumnen Produktkvantitet för alla produkter och visa summan i cellen Total kvantitet. Du kan uppnå den här summan genom att skriva en Set Value Of-regel i cellen Total Quantity enligt nedan.

Regel i den visuella redigeraren

Validera ett fältvärde med uttryck validating-a-field-value-using-expression

I inköpsorderformuläret som förklaras i föregående exempel vill du hindra användare från att beställa mer än en kvantitet av en produkt till ett pris som överstiger 10000. Du kan skriva en valideringsregel enligt nedan.

Regel i den visuella redigeraren