De interface Correspondentie maken integreren met uw aangepaste portal

Laatste update: 2023-05-04
  • Gemaakt voor:
  • User
LET OP

AEM 6.4 heeft het einde van de uitgebreide ondersteuning bereikt en deze documentatie wordt niet meer bijgewerkt. Raadpleeg voor meer informatie onze technische ondersteuningsperioden. Ondersteunde versies zoeken hier.

Overzicht

In dit artikel wordt beschreven hoe u de Correspondentieoplossing maken kunt integreren met uw omgeving.

Oproepen op basis van URL

U kunt de toepassing Correspondentie maken aanroepen vanuit een aangepast portaal door de URL voor te bereiden met de volgende aanvraagparameters:

  • de id voor de lettertypesjabloon (met de parameter cmLetterId) of de naam van de lettertypesjabloon (met de parameter cmLetterName)

  • de URL naar de XML-gegevens die van de gewenste gegevensbron worden opgehaald (met de parameter cmDataUrl).

Het aangepaste portaal bereidt bijvoorbeeld de URL voor als
https://[server]:[port]/[contextPath]/aem/forms/createcorrespondence.html?random=[timestamp]&cmLetterId=[letter identifier]&cmDataUrl=[data URL], wat de href zou kunnen zijn van een link op het portaal.
Als het portaal de sjabloonnaam Letter heeft, kan de URL
https://[server]:[port]/content/cm/createcorrespondence.html?cmLetterName=[letter name]&cmDataUrl=[data URL].

OPMERKING

Op deze manier aanroepen is niet veilig omdat de noodzakelijke parameters als een verzoek van de GET worden doorgegeven, door het zelfde (duidelijk zichtbare) in URL toegankelijk te maken.

OPMERKING

Voordat u de toepassing Correspondentie maken aanroept, slaat u de gegevens op en uploadt u deze om de interface Correspondentie maken op de opgegeven dataURL aan te roepen. Dit zou of van het douaneportaal zelf of door een ander achtereindeproces kunnen worden gedaan.

Inline op gegevens gebaseerde aanroeping

Een andere (en veiligere) manier om de toepassing Create Correspondentie aan te roepen zou kunnen zijn door de URL eenvoudig te raken bij https://[server]:[port]/[contextPath]/aem/forms/createcorrespondence.html, terwijl het verzenden van de parameters en de gegevens om de toepassing Create Correspondence als een POST-verzoek aan te roepen (hen voor de eindgebruiker verbergen). Dit betekent ook dat u nu de XML-gegevens voor de toepassing Correspondentie maken inline kunt doorgeven (als onderdeel van hetzelfde verzoek, met de parameter cmData), wat niet mogelijk/ideaal was in de vorige aanpak.

Parameters voor het opgeven van de letter

Naam Type Beschrijving
cmLetterInstanceId String De id voor de letter-instantie.
cmLetterName String

De id voor de lettertypesjabloon.

Als er meerdere CM-letters met dezelfde naam op een server staan, genereert het gebruik van de parameter cmLetterName in de URL een fout "Er bestaan meerdere letters met naam". Gebruik in dat geval de parameter cmLetterId in de URL in plaats van cmLetterName.

cmLetterId String De naam van de Letter-sjabloon.

De volgorde van parameters in de tabel geeft de voorkeur aan parameters die worden gebruikt voor het laden van de letter.

Parameters voor het opgeven van de XML-gegevensbron

Naam Type Beschrijving
cmDataUrl
URL XML-gegevens uit een bronbestand met basisprotocollen zoals cq, ftp, http of file.
cmLetterInstanceId String XML-gegevens gebruiken die beschikbaar zijn in Letter Instance.
cmUseTestData Boolean De testgegevens in het gegevenswoordenboek opnieuw gebruiken.

De volgorde van parameters in de tabel geeft de voorkeur aan parameters die worden gebruikt voor het laden van de XML-gegevens.

Andere parameters

Naam Type Beschrijving
cmPreview
Boolean True to open the letter in preview mode
Willekeurig Tijdstempel Oplossen van cacheproblemen met de browser.

Als u het http- of cq-protocol voor cmDataURL gebruikt, moet de URL van http/cq anoniem toegankelijk zijn.

Op deze pagina