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

ATTENTION

AEM 6.4 a atteint la fin de la prise en charge étendue et cette documentation n’est plus mise à jour. Pour plus d’informations, voir notre période de support technique. Rechercher les versions prises en charge here.

Présentation

Cet article décrit comment intégrer la solution de création de correspondance à votre environnement.

Appel basé sur une URL

Pour appeler l’application de création de correspondance à partir d’un portail personnalisé, préparez l’URL avec les paramètres de requête suivants :

  • l’identifiant du modèle de lettre (à l’aide du paramètre cmLetterId) ou le nom du modèle de lettre (à l’aide du paramètre cmLetterName) ;

  • 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.
Si le nom du modèle de lettre est à portée de main sur le portail, l’URL peut être
https://[server]:[port]/content/cm/createcorrespondence.html?cmLetterName=[letter name]&cmDataUrl=[data URL].

REMARQUE

L’appel de cette manière n’est pas sécurisé, car les paramètres nécessaires sont transmis en tant que requête de GET, en exposant les mêmes paramètres (clairement visibles) dans l’URL.

REMARQUE

Avant d’appeler l’application de création de correspondance, enregistrez et chargez les données pour appeler l’interface utilisateur de création de correspondance à l’adresse URL de données donnée. Cela peut être effectué à partir du portail personnalisé ou par un autre processus d’arrière-plan.

Appel intégré basé sur les données

Un autre moyen (plus sécurisé) d’appeler l’application de création de correspondance consiste à simplement accéder à l’URL à l’adresse https://[server]:[port]/[contextPath]/aem/forms/createcorrespondence.html, lors de l’envoi des paramètres et des données pour appeler l’application de création de correspondance en tant que demande de POST (en les masquant à l’utilisateur final). Cela signifie également que vous pouvez désormais transmettre les données XML pour l’application de création de correspondance en ligne (dans le cadre de la même requête, à l’aide du paramètre cmData), ce qui n’était pas possible/idéal dans l’approche précédente.

Paramètres de spécification de lettre

Nom Type Description
cmLetterInstanceId Chaîne Identifiant de l’instance de lettre.
cmLetterName Chaîne

Identifiant du modèle de lettre.

Si plusieurs lettres CM portent le même nom sur un serveur, l’utilisation du paramètre cmLetterName dans l’URL renvoie l’erreur "Plusieurs lettres portent le même nom". Dans ce cas, utilisez le paramètre cmLetterId dans l’URL au lieu de cmLetterName.
cmLetterId Chaîne Nom du modèle de lettre.

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

Paramètres de spécification de la source de données XML

Nom Type Description
cmDataUrl
 URL Données XML provenant 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 dans le tableau indique la préférence des paramètres utilisés pour le chargement des données XML.

Autres paramètres

Nom Type Description
cmPreview
 Booléen True pour 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