整合「建立通信UI」與您的自訂入口網站

概覽

本文詳細說明如何將建立通信解決方案與您的環境整合。

基於URL的調用

若要從自訂入口網站呼叫「建立通信」應用程式,一種方式是使用下列要求參數準備URL:

  • 字母模板的標識符(使用cmLetterId參數),或字母模板的名稱(使用cmLetterName參數)

  • 從所需資料源(使用cmDataUrl參數)中提取的XML資料的URL。

例如,自訂入口網站會將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]

注意

以這種方式呼叫不安全,因為必要的參數會以GET要求的形式傳遞,方法是在URL中顯示相同的(清楚顯示)。

注意

呼叫「建立通信」應用程式之前,請儲存並上傳資料,以在指定dataURL呼叫「建立通信」UI。 這可以從自訂入口網站本身,或透過其他後端程式來完成。

內嵌資料型調用

呼叫「建立通信」應用程式的另一種(也是更安全的)方式可能是直接在https://[server]:[port]/[contextPath]/aem/forms/createcorrespondence.html點擊URL,同時傳送參數和資料以呼叫「建立通信」應用程式作為POST請求(隱藏給一般使用者)。 這也表示您現在可以內嵌傳遞建立通信應用程式的XML資料(作為相同請求的一部分,使用cmData參數),這在先前的方法中不可能/不理想。

指定字母的參數

名稱 類型 說明
cmLetterInstanceId 字串 信函例項的識別碼。
cmLetterName 字串

信函範本的識別碼。

如果伺服器上有多個同名的CM字母,則在URL中使用cmLetterName參數會擲回錯誤「有多個字母與名稱存在」。 在這種情況下,請在URL中使用cmLetterId參數,而非cmLetterName。

cmLetterId 字串 字母模板的名稱。

表中的參數順序指定用於載入字母的參數的首選項。

指定XML資料源的參數

名稱 類型 說明
cmDataUrl
URL 使用基本協定(如cq、ftp、http或檔案)從源檔案獲取的XML資料。
cmLetterInstanceId 字串 使用信函例項中可用的xml資料。
cmUseTestData 布林值 (Boolean) 重複使用資料字典中附加的測試資料。

表中的參數順序指定用於載入XML資料的參數的首選項。

其他參數

名稱 類型 說明
cmPreview
布林值 (Boolean) 在預覽模式下開啟字母為True
隨機 時間戳記 解決瀏覽器快取問題。

如果您對cmDataURL使用http或cq通訊協定,http/cq的URL應可匿名存取。

本頁內容