Integrating Create Correspondence UI with your custom portal

Last update: May 2, 2024

CREATED FOR:

  • Admin
  • User
  • Developer

Overview

This article details how you can integrate the Create Correspondence Solution with your environment.

URL-based invocation

One way to call the Create Correspondence application from a custom portal is to prepare the URL with the following request parameters:

  • the identifier for the letter template (using the cmLetterId parameter).

  • the URL to the XML data fetched from the desired data source (using the cmDataUrl parameter).

For example, the custom portal would prepare the URL as
https://'[server]:[port]'/[contextPath]/aem/forms/createcorrespondence.html?random=[timestamp]&cmLetterId=[letter identifier]&cmDataUrl=[data URL], which could be the href from a link on the portal.

NOTE
Calling in such a way is not secure since the necessary parameters are passed along as a GET request, by exposing the same (clearly visible) in the URL.
NOTE
Before calling the Create Correspondence application, save and upload the data to call the Create Correspondence UI at the given dataURL. This could either be done from the custom portal itself or through another back end process.