AEM Forms as a Cloud Service Communicatie Batch-verwerking
Via communicatie kunt u merkgeoriënteerde en gepersonaliseerde communicatie maken, samenstellen en leveren, zoals zakelijke correspondentie, documenten, instructies, claimverwerkingsbrieven, voordeelberichten, maandelijkse facturen en welkomstkits. U kunt Communicatie APIs gebruiken om een malplaatje (XFA of PDF) met klantengegevens te combineren om documenten in PDF, PS, PCL, DPL, IPL, en ZPL formaten te produceren.
De mededelingen verstrekken APIs voor het op bestelling en geplande documentgeneratie. U kunt synchrone API's voor asynchrone API's (Asynchrone API's) voor het genereren van geplande documenten gebruiken:
-
Synchrone API's zijn geschikt voor gebruik op aanvraag, met lage latentie en het genereren van documenten met één record. Deze API's zijn geschikter voor gebruiksgevallen die zijn gebaseerd op handelingen van gebruikers. Het genereren van een document bijvoorbeeld nadat een gebruiker een formulier heeft ingevuld.
-
Batch-API's (Asynchrone API's) zijn geschikt voor geplande toepassingen waarbij meerdere documenten met hoge doorvoer worden gegenereerd. Met deze API's worden documenten batchgewijs gegenereerd. Zo worden telefoonrekeningen, creditcardafschriften en uitkeringsafschriften elke maand gegenereerd.
Batchbewerkingen batch-operations
Een batchbewerking is een proces waarbij meerdere documenten van een vergelijkbaar type voor een set records met geplande intervallen worden gegenereerd. Een batchbewerking bestaat uit twee onderdelen: Configuratie (definitie) en uitvoering.
-
Configuratie (definitie): Een partijconfiguratie slaat informatie over diverse activa en eigenschappen op om voor geproduceerde documenten te plaatsen. Bijvoorbeeld, verstrekt het details over het malplaatje XDP of PDF en de plaats van klantengegevens aan gebruik samen met het specificeren van diverse eigenschappen voor outputdocumenten.
-
Uitvoering: Om een partijverrichting te beginnen, ga de naam van de partijconfiguratie tot batch-uitvoering API over.
Componenten van een batchbewerking components-of-a-batch-operations
de configuratie van de Wolk van de Wolk van de Werking: De configuratiehulp van de Wolk van de Ervaring helpt u een instantie van de Experience Manager aan klant bezeten Microsoft Azure Opslag. Hiermee kunt u de referenties opgeven waarmee Microsoft Azure-account bij een klant verbinding kan maken.
de configuratie van de Opslag van de Gegevens van de Partij (USC): De hulp van de de gegevensconfiguratie van de partij u vormt een specifiek geval van opslag Blob voor Partij APIs. Hiermee kunt u de invoer- en uitvoerlocaties opgeven in de Microsoft Azure Blob-opslag die eigendom is van de klant.
Partij APIs: Laat u een partijconfiguraties creëren en de partijlooppas uitvoeren die op deze configuraties wordt gebaseerd om een PDF of malplaatje XDP met gegevens samen te voegen en output in PDF, PS, PCL, DPL, IPL en formaten te produceren ZPL. De mededelingen verstrekken partij APIs voor configuratiebeheer en partijuitvoering.
Opslag: Communicatie APIs gebruikt klant bezeten Microsoft Azure Cloud opslag om klantenverslagen te halen en geproduceerde documenten op te slaan. U configureert Microsoft Azure Storage in Experience Manager Cloud Service Configuration.
App: Uw douanetoepassing om de Partij APIs te gebruiken om documenten te produceren en te verbruiken.
Meerdere documenten genereren met behulp van batchbewerkingen generate-multiple-documents-using-batch-operations
U kunt batchbewerkingen gebruiken om meerdere documenten met een gepland interval te genereren.
U kunt de video bekijken of de onderstaande instructies uitvoeren om te leren hoe u documenten kunt genereren met behulp van batchbewerkingen. De API verwijzingsdocumentatie die in video wordt gebruikt is beschikbaar in het formaat .yaml. U kunt het Band APIsdossier downloaden en het uploaden aan Postman om functionaliteit van APIs te controleren en langs de video te volgen.
Voorwaarden pre-requisites
Voor het gebruik van de batch-API is het volgende vereist:
- Microsoft Azure-opslagaccount
- PDF- of XDP-sjablonen
- Gegevens die met sjablonen moeten worden samengevoegd
- Gebruikers met beheerdersrechten voor Experience Managers
Uw omgeving instellen setup-your-environment
Voordat u een batchbewerking gebruikt:
- Klantgegevens (XML-bestanden) uploaden naar Microsoft Azure Blob Storage
- Een Cloud-configuratie maken
- Batchgegevensopslagconfiguratie maken
- Sjablonen en andere elementen uploaden naar uw Experience Manager Forms Cloud Service-exemplaar
Klantgegevens (XML-bestanden) uploaden naar Azure Storage upload-customer-data-to-Azure-Storage
Op uw Microsoft Azure Opslag, creeer containersen upload klantengegevens (XML)aan de omslagenbinnen de containers.
Een Cloud-configuratie maken create-a-cloud-configuration
Met de cloudconfiguratie wordt uw Experience Manager-instantie verbonden met Microsoft Azure Storage. Een cloudconfiguratie maken:
- Ga naar Extra > Cloud Servicen > Azure Storage
- Open een map als host voor de configuratie en klik op Maken. U gebruikt de algemene map of maakt een map.
- Geef een naam op voor de configuratie en referenties waarmee u verbinding wilt maken met de service. U kunt deze geloofsbrieven van uw portaal van de Opslag van Microsoft Azureterugwinnen.
- Klik op Maken.
Uw Experience Manager-instantie is nu klaar om verbinding te maken met Microsoft Azure Storage en deze te gebruiken om indien nodig inhoud op te slaan en te lezen.
Batchgegevensopslagconfiguratie maken create-batch-data-store-configuration
Met de configuratie van batchgegevens kunt u containers en mappen configureren voor invoer en uitvoer. U bewaart uw klantenverslagen in de Omslag van Source en de geproduceerde documenten worden geplaatst in de Omslag van de Bestemming.
De configuratie maken:
- Ga naar Extra > Forms > Unified Storage Connector.
- Open een map als host voor de configuratie en klik op Maken. U gebruikt de algemene map of maakt een map.
- Geef de titel en naam van de configuratie op. Selecteer in Opslag Microsoft Azure Storage.
- Blader in Opslagconfiguratiepad naar en selecteer de Cloud Configuration die referenties van de Azure-opslagaccount in eigendom van de klant bevat.
- Geef in de Source-map de naam op van de Azure Storage-container en de map met records.
- Geef in de doelmap het pad op van de Azure Storage-container en -map waarin de gegenereerde documenten worden opgeslagen.
- Klik op Maken.
Uw Experience Manager-instantie is nu verbonden met Microsoft Azure Storage en geconfigureerd voor het ophalen en verzenden van gegevens naar specifieke locaties op Microsoft Azure Storage.
Sjablonen en andere elementen uploaden naar uw Experience Manager-instantie upload-templates-and-other-assets-to-your-AEM-instance
Een organisatie heeft doorgaans meerdere sjablonen. Bijvoorbeeld, één malplaatje elk voor creditcardverklaringen, voordelenverklaringen, en claimtoepassingen. Upload al dergelijke XDP en PDF malplaatjes aan uw instantie van de Experience Manager. Een sjabloon uploaden:
- Open een Experience Manager-instantie.
- Ga naar Forms > Forms en Documenten
- Klik op Maken > Map en maak een map. Open de map.
- Klik op Maken > Bestand uploaden en upload de sjablonen.
batch-API gebruiken om documenten te genereren use-batch-API-to-generate-documents
Als u een batch-API wilt gebruiken, maakt u een batchconfiguratie en voert u op basis van die configuratie een uitvoering uit. De API-documentatie biedt informatie over API's voor het maken en uitvoeren van een batch, overeenkomende parameters en mogelijke fouten. U kunt het API definitiedossierdownloaden en het uploaden aan Postmanof gelijkaardige software om APIs te testen om een partijverrichting tot stand te brengen en in werking te stellen.
Een batch maken create-a-batch
Als u een batch wilt maken, gebruikt u de POST /config API. Neem de volgende verplichte eigenschappen op in de hoofdtekst van de HTTP-aanvraag:
-
configName: Specificeer Unieke naam van de partij. Bijvoorbeeld:
wknd-job -
dataSourceConfigUri: specificeer plaats van de configuratie van de Opslag van de Gegevens van de Partij. Het kan relatieve of absolute weg van de configuratie zijn. Bijvoorbeeld:
/conf/global/settings/forms/usc/batch/wknd-batch -
outputTypes: Specificeer outputformaten: PDF en DRUK. Als u het uitvoertype PRINT gebruikt, geeft u in de eigenschap
printedOutputOptionsListten minste één afdrukoptie op. De afdrukopties worden bepaald door hun rendertype, zodat er momenteel geen meerdere afdrukopties met hetzelfde rendertype zijn toegestaan. De ondersteunde indelingen zijn PS, PCL, DPL, IPL en ZPL. -
malplaatje: Specificeer absolute of relatieve weg van het malplaatje. Bijvoorbeeld:
crx:///content/dam/formsanddocuments/wknd/statements.xdp
Als u een relatief pad opgeeft, moet u ook een basisinhoud opgeven. Zie API-documentatie voor meer informatie over de hoofdmap van de inhoud.
U kunt GET /config /[configName] gebruiken om details van de partijconfiguratie te zien.
Een batch uitvoeren run-a-batch
Als u een batch wilt uitvoeren (uitvoeren), gebruikt u de POST /config /[configName]/execution . Als u bijvoorbeeld een batch met de naam wknd-demo wilt uitvoeren, gebruikt u /config/wknd-demo/executing. De server retourneert HTTP-antwoordcode 202 bij het accepteren van de aanvraag. De API retourneert geen lading behalve een unieke code (uitvoering-herkenningsteken) in kopbal van de reactie van HTTP voor de partijbaan die op de server loopt. U kunt de uitvoering-herkenningsteken gebruiken om de status van de partij terug te winnen.
De status van een partij controleren status-of-a-batch
Gebruik GET /config /[configName]/execution/[execution-identifier] om de status van een batch op te halen. De uitvoering-herkenningsteken is inbegrepen in de kopbal van de reactie van HTTP voor het verzoek van de partijuitvoering.
Het antwoord op het statusverzoek bevat de statussectie. Het verstrekt details over status van de partijbaan, aantal verslagen reeds in pijplijn (reeds gelezen en die worden verwerkt), en status van elk outputType/renderType (aantal lopend, opgevolgd, en ontbroken punten). De status omvat ook de begin- en eindtijd van een batchtaak, samen met informatie over eventuele fouten. De eindtijd is -1 tot de partijlooppas eigenlijk voltooit.
- Wanneer u meerdere PRINT-indelingen aanvraagt, bevat de status meerdere items. Bijvoorbeeld PRINT/ZPL, PRINT/IPL.
- Een batchtaak leest niet alle records tegelijk, maar de taak blijft het aantal records lezen en verhogen. De status retourneert dus -1 totdat alle records zijn gelezen.
Gegenereerde documenten weergeven view-generated-documents
Nadat de taak is voltooid, worden de gegenereerde documenten opgeslagen in de map success op de doellocatie die is opgegeven in de configuratie Batch Data Store. Als er fouten optreden, maakt de service een map failure . Het verstrekt informatie over het type en de reden van fouten.
Laten we het met behulp van een voorbeeld begrijpen: neem aan dat er een invoergegevensbestand record1.xml en twee uitvoertypen zijn: PDF en PCL . Vervolgens bevat de doellocatie twee submappen pdf en pcl , één voor elk uitvoertype. Laat veronderstellen dat het genereren van PDF is gelukt, dan bevat de submap pdf de submap success die op zijn beurt het daadwerkelijk gegenereerde PDF-document record1.pdf bevat. Hiermee wordt aangenomen dat PCL-generatie is mislukt. De submap pcl bevat vervolgens een failure submap die op zijn beurt een foutbestand bevat record1.error.txt dat details van de fout bevat. Bovendien bevat de doellocatie een tijdelijke map met de naam __tmp__ , waarin bepaalde bestanden staan die tijdens de uitvoering van de batch zijn vereist. Deze map kan worden verwijderd als er geen actieve batchbewerkingen zijn die verwijzen naar de doelmap.
API-naslagdocumentatie
De API verwijzingsdocumentatie verstrekt gedetailleerde informatie over alle parameters, authentificatiemethodes, en diverse diensten die door APIs worden verleend. De API-naslagdocumentatie is beschikbaar in de indeling .yaml. U kunt het Band APIsdossier downloaden en het uploaden aan Postman om functionaliteit van APIs te controleren.