Integrating Create Correspondence UI with your custom portal integrating-create-correspondence-ui-with-your-custom-portal
Overview overview
This article details how you can integrate the Create Correspondence Solution with your environment.
URL-based invocation 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), or the name of the Letter template (using the cmLetterName 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 ashttps://[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.
If the portal has the Letter template name at hand, then the URL could behttps://[server]:[port]/content/cm/createcorrespondence.html?cmLetterName=[letter name]&cmDataUrl=[data URL]
.
Inline data-based invocation inline-data-based-invocation
Another (and a more secure) way to call the Create Correspondence application could be to simply hit the URL at https://[server]:[port]/[contextPath]/aem/forms/createcorrespondence.html
, while sending the parameters and data to call the Create Correspondence application as a POST request (hiding them from the end user). This also means that you can now pass along the XML data for the Create Correspondence application inline (as part of the same request, using the cmData parameter), which was not possible/ideal in the previous approach.
Parameters for specifying letter parameters-for-specifying-letter
The order of parameters in the table specifies the preference of parameters used for loading the letter.
Parameters for specifying the XML data source parameters-for-specifying-the-xml-data-source
The order of parameters in the table specifies the preference of parameters used for loading the XML data.
Other Parameters other-parameters
If you using http or cq protocol for cmDataURL, URL of http/cq should be accessible anonymously.