Intégration de l’interface utilisateur de création de correspondance dans votre portail personnalisé

Présentation

Cet article décrit la méthode d’intégration de la solution de création de correspondance dans votre environnement.

Appel basé sur une URL

Il est possible d’appeler l’application de création de correspondance à partir d’un portail personnalisé en préparant une URL selon les paramètres de demande suivants :

  • l’identifiant du modèle de lettre (à l’aide du paramètre cmLetterId).

  • l’URL des données XML extraites à partir de la source de données sélectionnée (à l’aide du paramètre cmDataUrl).

Par exemple, le portail personnalisé prépare l’URL sous la forme
https://'[server]:[port]'/[contextPath]/aem/forms/createcorrespondence.html?random=[timestamp]&cmLetterId=[letter identifier]&cmDataUrl=[data URL], qui pourrait être le href dʼun lien sur le portail.

REMARQUE

Cette manière d’appeler l’application n’est pas sûre, car les paramètres nécessaires sont transmis dans le cadre d’une demande GET et affichés (de façon clairement visible) dans l’URL.

REMARQUE

Avant d’appeler l’application de création de correspondance, enregistrez et chargez les données d’appel de l’interface utilisateur de création de correspondance au niveau de l’URL de données requise. Cette opération peut être réalisée à partir du portail personnalisé ou à l’aide d’un autre processus différent d’arrière-plan.

Appel inséré basé sur les données

Un autre moyen (plus sûr) d’appeler l’application de création de correspondance consiste à accéder à l’URL https://'[serveur]:[port]'/[contextPath]/aem/forms/createcorrespondence.html, en transmettant les paramètres et données permettant d’appeler l’application de création de correspondance dans le cadre d’une requête POST (sans que l’utilisateur final ne les voie). En outre, vous pouvez désormais transmettre les données XML à l’application de création de correspondance en mode POST (dans le cadre de la même demande à l’aide du paramètre cmData), ce qui n’était pas possible (ou idéal) dans l’approche précédente.

Paramètres de définition de lettre

Nom Type Description
cmLetterInstanceId Chaîne Identifiant de l’instance de lettre.
cmLetterId Chaîne Nom du modèle de lettre.

L’ordre des paramètres du tableau indique la préférence de paramètres utilisés pour le chargement de la lettre.

Paramètres de définition de la source de données XML

Nom Type Description
cmDataUrl
 URL Données XML à partir d’un fichier source utilisant des protocoles de base, tels que cq, ftp, http ou file.
cmLetterInstanceId Chaîne Utilisation des données XML disponibles dans l’instance de lettre.
cmUseTestData Booléen Pour réutiliser les données de test associées au dictionnaire de données.

L’ordre des paramètres du tableau indique la préférence de paramètres utilisés pour le chargement des données XML.

Autres paramètres

Nom Type Description
cmPreview
 Booléen Permet d’ouvrir la lettre en mode aperçu
Aléatoire Date et heure Pour résoudre les problèmes de mise en cache du navigateur.

Si vous utilisez le protocole http ou cq pour le paramètre cmDataURL, l’URL correspondante doit pouvoir être accessible de manière anonyme.

Sur cette page