将Create Correspondence UI与自定义门户集成

概述

本文详细介绍了如何将创建通信解决方案与您的环境集成。

基于URL的调用

从自定义门户调用Create Correspondence应用程序的一种方法是使用以下请求参数准备URL:

  • 字母模板的标识符(使用cmLetterId参数)或字母模板的名称(使用cmLetterName参数)

  • 从所需数据源获取的XML数据的URL(使用cmDataUrl参数)。

例如,自定义门户会将URL准备为
https://[server]:[port]/[contextPath]/aem/forms/createcorrespondence.html?random=[timestamp]&cmLetterId=[letter identifier]&cmDataUrl=[data URL],可能是门户上链接的href。
如果门户有Letter模板名称,则URL可能
https://[server]:[port]/content/cm/createcorrespondence.html?cmLetterName=[letter name]&cmDataUrl=[data URL]

注意

以这种方式调用是不安全的,因为通过在URL中显示相同(明显可见)的参数作为GET请求传递。

注意

在调用Create Corresponence应用程序之前,请保存并上传数据,以在给定的dataURL上调用Create Corresponence UI。 这可以从自定义门户本身或通过其他后端进程完成。

基于内联数据的调用

调用“创建通信”应用程序的另一种(也是更安全的)方法是直接点击https://[server]:[port]/[contextPath]/aem/forms/createcorrespondence.html的URL,同时发送参数和数据以作为POST请求调用“创建通信”应用程序(将它们隐藏在最终用户面前)。 这也意味着您现在可以随行传递Create Correndence应用程序的XML数据(作为同一请求的一部分,使用cmData参数),这在以前的方法中是不可能的/理想的。

用于指定字母的参数

名称 类型 描述
cmLetterInstanceId 字符串 字母实例的标识符。
cmLetterName 字符串

字母模板的标识符。

如果服务器上存在多个同名CM字母,则使用URL中的cmLetterName参数会引发错误“存在多个带名称的字母”。 在这种情况下,请在URL中使用cmLetterId参数,而不是cmLetterName。

cmLetterId 字符串 Letter模板的名称。

表中的参数顺序指定用于加载字母的参数的首选项。

用于指定XML数据源的参数

名称 类型 描述
cmDataUrl
URL 使用基本协议(如cq、ftp、http或文件)从源文件获取XML数据。
cmLetterInstanceId 字符串 使用Letter实例中可用的xml数据。
cmUseTestData 布尔型 重用数据字典中附加的测试数据。

表中的参数顺序指定用于加载XML数据的参数的首选项。

其他参数

名称 类型 描述
cmPreview
布尔型 如果在预览模式
中打开字母,则为true
随机 时间戳 解决浏览器缓存问题。

如果您对cmDataURL使用http或cq协议,则http/cq的URL应可匿名访问。

On this page

Adobe Summit Banner

A virtual event April 27-28.

Expand your skills and get inspired.

Register for free
Adobe Summit Banner

A virtual event April 27-28.

Expand your skills and get inspired.

Register for free
Adobe Maker Awards Banner

Time to shine!

Apply now for the 2021 Adobe Experience Maker Awards.

Apply now
Adobe Maker Awards Banner

Time to shine!

Apply now for the 2021 Adobe Experience Maker Awards.

Apply now