整合建立對應UI與您的自訂入口網站

概覽

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

以URL為基礎的呼叫

從自訂入口網站呼叫「建立對應」應用程式的一種方式,是使用下列請求參數來準備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]

注意

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

注意

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

內嵌資料式呼叫

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

用於指定字母的參數

名稱 類型 說明
cmLetterInstanceId 字串 字母實例的標識符。
cmLetterName 字串

字母模板的標識符。

如果伺服器上存在多個同名的CM字母,則使用URL中的cmLetterName參數會引發錯誤「Multiple letters exist with name(多個字母與名稱存在)」。 在這種情況下,請在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應匿名存取。

本頁內容