在 IBM Lotus Connections 2.5 中定製電子郵件通知

3.2 Channel Con fig – Email Channel con fig

我們在這個部分指定如何定義 SMTP 伺服器以及如何引用它。此外，我們還可以在此處新增一些 Java(TM)Mail 在郵件傳送期間使用的屬性。NF 通過兩種方式來引用 SMTP 伺服器：

• 使用 DNS MX 伺服器解決方案
• 使用在 IBM WebSphere(R) Application Server 中設定的對 JNDI 郵件會話的引用

如果您想使用 DNS MX 解決方案，您必須將 useJavaMailProvider設定為 false，並建立您希望用來查詢 MX 記錄的 DNS。您還可以配置一些可以直接從 Java Mail 使用的特殊屬性，比如 Debug 模式和超時（見清單 1）：

				

  
  false
  
    dns: mycompny.com
    smtpAdmin
    
      false
       120000
      1 20000
      465
      465
      
	  javax.net.ssl .SSLSocketFactory
      false
    
  
  50

如果您喜歡將 NF 配置為使用在 WebSphere Application Server 中定義的 Mail Session，那麼必須將 useJavaMailProvider設定為 true（見清單 2）：

				

  
    true
    50
  

			

使用這種方式時，NF 將查詢 WebS phere Application Server 以獲取需要使用的 SMTP 伺服器。

在兩種配置中管理員都能夠配置 maxRecipients，這是每封電子郵件的收件人的最大數量。例如，如果 NF 需要向 100 位使用者傳送訊息，並且 maxRecipients被設定為 50，那麼將建立兩個電子郵件，它們的 TO 欄位分別有 50 個收件人。

該設定對效能非常重要，並且必須與 SMTP 伺服器的吞吐量保持一致，從而保持合適的負載。預設值設定為 50；不過，如果管理員知道 SMTP 伺服器具有更大的處理能力，那麼可以增加收件人的數量。

要了解如何配置這個部分和後臺基礎設施的更多資訊，請參考 wiki 文章“Configuring notifications in IBM Lotus Connections 2.0”。

3.3 模板部分

當將 NF 使用的郵件模板配置為編寫電子郵件時，這部分是最重要的。該部分位於檔案的底端。注意，這裡有一個摘要；我們將在後文仔細檢視這個部分。

清單 3 顯示了模板的標準配置。

				

  [...omissis. . .]
  
    
      
        
		dogear-admin@your-emai l-domain.com
        
        
        {notification.source.url}/templates/ notifytemplate.jsp
        
      
      
        dogear.notification.notify
        com. ibm. 
          lotus.connections.core.notify.channels.event.DogearNotificati 
          onEventTransformer	
      
    
  <source>

  [...omissis. . .]
  

模板 是在 templates 標記之間定義的。模板部分通常為每個元件包含多個模板，其中元件由 source name定義。因此，每個元件都被作為一個通知源引用，並且可以使用 enabled屬性啟用或禁用源的通知。

以上例子中的源稱為 Dogear（在 Lotus Connections 2.5 中稱為“Bookmarks”），它可以傳送不同型別的通知，並且每個通知型別都基於不同的模板（這些模板的內容和佈局可以定製）。通知甚至還可以包含影像，使用 imageURL屬性指定影像的資料夾位置。

另外還要注意，源可以通過兩種通訊渠道（電子郵件和事件）傳送通知。通過渠道名指定渠道。在這裡，我們主要關注通過電子郵件渠道傳送的通知，以及如何配置它們。

清單 4 列出了電子郵件渠道使用的選項。

				

  
    dogear-admin@your-emai l-domain.com
  
  
      {notification.source.url}/templates/ notifytemplate.jsp
  

當 Lotus Connections 被配置為不顯示電子郵件地址時，將使用 sender屬性。如果沒有指定，將使用 globalSenderEmailAddress屬性；否則，將重寫全域性設定。

url 屬性指定用於建立通知的模板位置。模板可以是 JSP 或 XML 檔案。

在執行時從使用 NF 的元件指定 place holder url，以確保完整的 Ulrich (http://.. ../template.jsp, 或者 file://. ../template.xml) 與部署保持一致。

4 什麼是電子郵件模板？

模板是元件用於定製通過 NF 傳送的電子郵件的方式。您可以為源元件支援的各種通知型別提供模板。

建立模板的惟一需求是：

1. 可以通過 HTTP(S) 或直接從檔案系統載入模板：
   • 使用 url 值通過 HTTP(S) 載入模板。
   • 從部署 Lotus Connections 的檔案系統載入模板時，將使用 file 值。
2. 當框架載入頁面時，它可以通過模板 url 或通知物件傳送引數。
3. 在載入之後，模板將返回文字內容。注意，返回的內容可能是純文字或 HTML。

4.1 替換內容

在大部分情況下，模板必須將來自源通知的內容替換成模板文字。可以使用在 {...}（花括號）中定義的替換引數完成該操作。

注意：

• 有兩種型別的替換引數（變數）：由 NF 定義的引數或由源元件定義的引數。
• 您不能定製釋出到模板的引數，因為它們是固定的；不過，您可以通過顯示或隱藏它們改善郵件佈局。

4.1.1 由 NF 定義的變數

有一部分引數可用於任意模板，如表 8 所示。

4.1.2 由源元件定義的變數

Lotus Connections 中的每個元件都可以向模板傳送一組定製變數。

要定製模板，瞭解模板能夠使用的變數比了解變數的傳遞方式更重要。

變數在花括號 { }中定義，例如 ，{myvariable}。模板中的變數通常以這種方式出現，您也可以通過這種方式搜尋它們。

警告：在定製現有的模板時，一定要保留 NF 定義的所有變數（如以上的表 8 所示）；否則，收件人將不能收到所有資訊。

4.2 郵件模板的本地化

我們已經討論過，郵件模板可以基於 JSP 檔案或 XML 檔案。Activities、Bookmarks、 Communities 和 Profiles 基於 JSP，而 Files 和 Wikis 基於 XML。

郵件模板支援本地化訊息，實現方式取決於模板是基於 JSP 還是基於 XML。下面列出了 Lotus Connections 2.5 中支援的 24 種語言模板：

阿拉伯語、捷克語、丹麥語、德語、希臘語、英語、西班牙語、芬蘭語、法語、匈牙利語、義大利語、希伯來語、日語、韓語、荷蘭語、挪威語、波蘭語、巴西葡萄牙語、俄語、瑞典語、土耳其語、簡體中文和繁體中文。

4.2.1 基於 JSP 檔案的郵件

我們使用 JSP Standard Tag Library 支援 JSP 模板的本地化，該庫提供的方法能夠輕鬆本地化 JSP 中的內容。

使用該方法的 Activities、Bookmarks、Communities 和 Profiles：

表 9 顯示了我們外部化 JSP 內容時元件使用的資原始檔。

如上所述，每個資原始檔都被翻譯成 24 種語言。資原始檔的資料夾包含表 10 中列出的所有檔案。

在以上檔案中，外部化的資源基於一組屬性值和變數。在某些情況下，鍵的值可能包含或不包含外部化字串。

在下面這個例子中，既有不包含任何變數的外部化文字，也有包含一個或多個變數的文字：

email.open.activity=Open this: activityemail.notify.body.email.empty=
{activity.event.sender.display.name} has notified you about 
 {activity.node.name}

第一行不包含任何外部化字串，而第二行包含兩個外部化字串，它們被包圍在花括號中。

注意，外部化資源可以使用 HTML 程式碼，如以上例子所示。在執行時，FMT 和 JSP 將選擇正確的檔案，並使用檔案中基於 Recipient Locale 的資訊。

下面的樣例程式碼顯示 JSP 如何使用 FMT 框架載入外部化字串：

[....jsp code ...]

[....jsp code ...]

[... jsp code ...]

要修改和定製郵件內容，您必須根據您的部署支援的語言更改這些屬性。作為一項最佳實踐，我們建議您也修改預設資源。

總而言之，處理 JSP 檔案時，我們使用一個 JSP 模板，以及用於儲存本地化內容的一組資源屬性。這不適用於基於 XML 的模板。

基於 XML 檔案的郵件

為了支援基於 XML 的模板的本地化，我們使用已經包含本地化資源的 XML 模板。

Files 和 Wikis 使用這種方法：

出於這個原因，每個模板 XML 文件都必須翻譯為多種受支援的語言。例如， commentAddMail.xml檔案的模板按照表 11 進行翻譯和複製。

				表 11. 已翻譯的 XML 檔案
			

commentAddMail.xml 是一個包含兩個 CDATA 部分的 XML 檔案，我們在其中定義純文字或 HTML 格式的電子郵件。在這兩個部分中，我們甚至可以訪問通知變數，並且仍然是使用花括號 {. .}。

純文字內容：

HTML 內容：

    
    HTML code
]]>

當您決定基於 XML 模板定製內容時，必須根據您的配置支援的語言更改 XML。作為最佳實踐，我們建議您也修改預設 XML。

5 定製郵件模板

定製操作包括修改模板 JSP、屬性、資源或 XML 檔案。修改了這些檔案之後，那麼就可以使用新的檔案更新部署，以讓新的修改生效。

修改模板時，瞭解模板中的可用變數非常重要。瞭解模板中可用的變數之後，您就可以輕鬆修改模板的外觀。您還可以修改電子郵件的內容和文字，為此，您必須指定哪些是外部化資源。

總體而言，要為 Activities、Bookmarks、 Communities 或 Profiles修改模板時，就必須修改 JSP 和連結資原始檔；如果您需要為Files 和 Wikis 修改模板，那麼就必須更新 XML 檔案。取決於您選擇的更新，可能需要重啟伺服器。

5.1 可用變數

如前所述，這組變數是已經在每個模板中定義的可用變數：

{notification .sender. name}
{notification .sender.email}
{notification . replyto. name}
{notification . replyto.email}
{notification .source}
{notification .type}
{notification .subject}
{notification .source.url}
{notification .container.u rl}
{notification . item.url}

除了這組變數之外，每個元件還為模板提供其他變數。在下面的表 12-18 中，您可以看到在每個模板元件中使用的所有變數：

5.2 定製操作

管理員可以通過執行以下操作來定製通知電子郵件：

• 改變 UI 的樣式和觀感
• 移動或刪除可用變數
• 對電子郵件更新、刪除或新增個人訊息

JSP 和 XML 模板都支援這組操作，但兩個模板的定製方法略有不同。

改變 UI 的樣式和觀感

為此，管理員可以執行以下步驟：

對於基於 JSP 的模板：

1. 在電子郵件和生成電子郵件的操作之間建立關係。
2. 根據該關係獲取原始 JSP 檔案。
3. 將模板複製到一個資料夾中。
4. 編輯模板，使其具有新的觀感。
5. 停止伺服器。
6. 將模板複製回到原始 JSP 所在的位置，覆蓋舊檔案。
7. 重啟伺服器。

注意：為了確定原始 JSP 檔案的位置，請參考表 1-5 獲取模板位置。

對於基於 XML 的模板：

1. 在電子郵件和生成電子郵件的操作之間建立關係。
2. 根據該關係獲取原始 XML 檔案。
3. 將模板複製到一個資料夾中。
4. 編輯模板，使其具有新的觀感。
5. 對所有支援的語言重複這些更改。
6. 停止伺服器。
7. 將模板複製回到正確的位置，覆蓋舊檔案。
8. 重啟伺服器。

注意：為了確定原始 XML 檔案的位置，請參考表 6-7 獲取模板位置。

讓我們檢視一個例子。在這個例子中，管理員可以更改生成原始訊息的 Activities 通知的各個方面，如圖 27 所示。

該電子郵件由操作 1-a 觸發：傳送摘要通知 (notifyMail.jsp)。圖 28 顯示了 notifyMail.jsp 的一部分。

如果管理員希望使用 ______________ 符號而不是 ……………………符號修改電子郵件的觀感，那麼需要根據圖 29 修改 JSP。

修改之後，終端使用者看到的訊息郵件如圖 30 所示。

注意，在這個例子中使用基於 JSP 的模板，因此不用重啟伺服器。

這個簡單的例子展示了更改電子郵件 UI 有多麼簡單；更改基於 XML 的模板的外觀也很簡單；不過，對於基於 XML 的模板，管理員需要重啟伺服器。

在下一個例子中，我們將探索在知道模板中的變數之後，可以執行哪些更加複雜的操作。

移動或刪除可用變數

移動或刪除變數的步驟與前面的“更改 UI 的樣式和觀感”部分一樣。在這個例子中，管理員必須知道可用的變數集。

對於操作 1-a：傳送一個摘要通知，模板 JSP 使用表 19 顯示的變數集。

要通過移動變數改變郵件的行為，管理員必須執行以下步驟：

對於 JSP：

1. 在電子郵件和生成電子郵件的操作之間建立關係。
2. 根據該關係獲取原始 JSP 檔案。
3. 將模板複製到一個資料夾中。
4. 通過移動或刪除變數編輯模板。
5. 停止伺服器。
6. 將模板複製回到正確的位置，覆蓋舊檔案。
7. 重啟伺服器。

對於 XML：

1. 在電子郵件和生成電子郵件的操作之間建立關係。
2. 根據該關係獲取原始 XML 檔案。
3. 將模板複製到一個資料夾中。
4. 通過移動或刪除變數編輯模板。
5. 對所有支援的語言應用這些更改。
6. 停止伺服器。
7. 將模板複製回到正確的位置，覆蓋舊檔案。
8. 重啟伺服器。

例如，如果我們想要更改 Activity Name 的位置並刪除 Creation Date 和 Activity Description，我們將對圖 31 所示的模板進行更改，更改後的模板如圖 32 所示。

將更改儲存到正確位置並重啟伺服器之後，將得到如圖 33 所示的電子郵件。

如您所見，現在已經刪除了 Activities 目標和最後的更新日期。

對電子郵件更新、刪除或新增個人訊息

這是管理員能夠在模板上執行的最後一種更改，同時也是最有趣的更改，因為將可以使用獨特的訊息定製電子郵件的內容。為此，管理員首先必須確定模板是基於 JSP 還是基於 XML。

如果模板基於 JSP，那麼管理員必須標識使用哪個資原始檔外部化電子郵件的內容，然後通過在內部更新適當的訊息來編輯這些檔案。

如果模板基於 XML，那麼就非常簡單，因為可以直接在檔案上執行所有操作。

對於 JSP：

1. 在電子郵件和生成電子郵件的操作之間建立關係。
2. 根據該關係獲取原始 JSP 檔案。
3. 在 JSP 中找到用於引用外部化訊息的鍵。
4. 找到包含外部化文字的資原始檔。
5. 使用新的訊息編輯資原始檔，並對所有支援的語言應用這些更改。
6. 停止伺服器。
7. 將模板複製回到正確的位置，覆蓋舊檔案。
8. 重啟伺服器。

對於 XML：

1. 在電子郵件和生成電子郵件的操作之間建立關係。
2. 根據該關係獲取原始 XML 檔案。
3. 使用新的訊息編輯 XML 檔案，並對所有支援的語言應用這些更改。
4. 停止伺服器。
5. 將模板複製回到正確的位置，覆蓋舊檔案。
6. 重啟伺服器。

對於 1-a：傳送一個摘要通知，模板 notifyMail.jsp使用儲存在以下位置中的檔案：

oawebui. war/WEB-INF/lib/oawebui.jar/com/ibm/openactivities/web/coreui/resources

因此，如果您想要更改訊息，那麼必須編輯位於該資料夾中的預設資原始檔，以及所有其他檔案，它們包含用 Lotus Connections 支援的語言翻譯的內容。

要查詢您的 JSP 使用的是什麼，必須找到所有這些標記：

然後，從屬性檔案查詢 my.key並將連結值更改為 my.key。例如，讓我們更改本例中使用的 Activity name 的標籤：

{activity. name}

在 resources.properties檔案中直接與前面的 HTML 程式碼對應的條目是：

email.activity.name=Activity name:

我們可以將它更改為：

email.activity. name=Activity:

我們還可以以相同的方式更改 Activity 的主題，例如從：

email. notify.subject=[Activities] {activity. node. name}

更改為：

email. notify.subject=[Custom Activities] Post: {activity. node. name}

最後的通知如圖 34 所示。

您可以看到單詞“name”已被刪除，主題也被更改為以下新樣式：

[Custom Activities] Post: Forum name

5.3 獲取和更新模板的簽入 / 簽出指令碼

為了簡化在電子郵件定製期間獲取正確的修改檔案的流程，以及簡化使用已更新檔案更新元件的 EAR 檔案的過程，我們可以使用兩個指令碼 checkIn.sh和 checkOut.sh。

這些指令碼可以在下載部分的 TemplateCheckInOut.zip 壓縮檔案中找到，您可以在解壓縮之後執行它們。

TemplateCheckInOut.zip 檔案包含以下檔案：

• README.txt（一個簡單的 README 檔案，我們建議您先閱讀它）
• init.sh（您 需要編輯它以設定一些重要變數的初始化檔案指令碼）
• initComponentUpdate.sh （不需要編輯的初始化指令碼）
• checkIn.py （checkIn.sh 通過 WebSphere Application Server Admin 控制檯使用它來更新已部署的 EAR；您不需要執行它）
• checkIn.sh （用於簽入更新模板的指令碼）
• checkOut.py （checkOut.sh 用於從 Lotus Connections 安裝提取元件 EAR 的指令碼；您不需要執行它）
• checkOut.sh （用於簽出模板資源的指令碼；需要編輯）

通過使用 checkIn.sh 和 checkOut.sh 您可以從已部署的 Lotus Connections 發行版提取和更新郵件模板。需要使用 init.sh 設定簽入 / 簽出指令碼所需的環境變數。

表 20 總結了以上檔案以及它們的描述和用途。

在使用 checkIn.sh 和 checkOut.sh 之前，記得給所有解壓檔案授予適當的許可權。您可以在解壓縮檔案之後使用以下命令為它們設定許可權：

chmod 755 *

所有解壓縮的檔案都必須有根特權，您必須是根使用者才能執行 checkIn.sh 和 checkOut.sh。在執行這些檔案之前，必須確保：

• 必須擁有根特權。
• 所有檔案都屬於根使用者和組。
• 所有 7 個檔案（README 和 init.sh 等）都位於相同的目錄下。　
• WebSphere Application Server 處於執行狀態，Lotus Connections 正常工作。　
• 出現故障時，能夠接受 Lotus Connections 的意外停機。　
• 備份了您的部署。　
• 正確編輯了 init.sh 檔案。

此外還有記住，在執行 checkIn.sh 之後，必須重啟 WebSphere Application Server 讓修改生效。

執行 checkOut.sh 時，將在一個資料夾中建立目錄。您可以將該資料夾放到 init.sh 中。如果您在 init.sh 中設定了 work_folder 之後，資料夾的內容將如下所示：

export work_folder=/root/connections/article/ear

在執行 checkOut.sh 之後，work_folder 將包含每個簽出的元件的資料夾。例如，如果我們簽出了所有元件，那麼將得到：

[root@lc4eb2 740377211 ear]#ls

activities blogs communities dogear files profiles wikis

以下是在每個元件中能夠找到的東西：

• 從 Lotus Connections 提取的 EAR 檔案。
• 在簽出操作期間用於解壓縮 EAR 檔案的 .tmp 資料夾。
• 包含需要編輯的資原始檔的 i18n 資料夾；將使用這些檔案外部化郵件模板。
• 包含需要編輯的 JSP 或 XML 檔案的模板資料夾；使用這些檔案來建立郵件模板。
• 在簽入操作期間用於建立 update.zip的更新資料夾。

注意：當您處理 Activities、Blogs、Communities、Profiles 和 Bookmarks 元件時（在向後相容的指令碼中，我們仍然用以前的名稱 Dogear 稱呼 Bookmarks），通常 同時具有 i18n 資料夾和模板資料夾。

當處理 Wikis 和 Files 時，您 僅具有模板資料夾，因為 Wikis 和 Files 不使用外部資原始檔外部化郵件內容。

在這個例子中，我們展示了活動的資料夾結構，但該結構對所有元件都是一樣的：

[root@lc4eb27403772 11 activities]# ls activities.ear i18n template tmp update

要定製模板，您僅需要編輯 i18n 資料夾和模板資料夾中的檔案。表 21 總結了我們討論的資料夾以及它們的內容和用途。

如何設定 init.sh

在執行 checkIn.sh 或 checkOut.sh 之前，您需要編輯 init.sh 。表 22 列出了需要編輯的變數。

附帶的 init.sh 已經包含一些值，因此要記得更改它們。此外， init.sh 還包含一些沒有列出的變數，這些變數不能更改。

如何執行 checkOut.sh

checkOut.sh 檔案從 Lotus Connections 簽出模板和資原始檔。在執行它之前，一定要確保執行第 38 頁的檢查列表中的前期任務操作。

執行 checkOut.sh 將得到以下結果： [root@lc4eb27403772 11 scripts]#./checkOut.sh

初始變數環境

輸入您需要處理的元件

0 - All the components

1 - Communities

2 - Activities

3 - Blogs

4 - Dogear

5 - Wikis

6 - Files

7 - Profiles

輸入元件序號，然後按 [ENTER]

如果您輸入“0”，那麼將提取所有元件。注意，每次最好僅處理一個元件。

元件被提取出來之後，您就可以在 i18n 資料夾和模板資料夾中編輯檔案。在開始編輯這些檔案之前，我們建議您備份原始檔案。這樣，即使破壞了模板，您還可以使用原始模板。編輯完成之後，您可以使用 checkIn.sh 簽入修改後的檔案。

如何執行 checkIn.sh

checkIn.sh 檔案用於簽入您已經修改的模板和資原始檔。在執行它之前，您一定要執行前面提到的檢查列表中的前期任務操作。

執行 ./checkIn.sh 將得到以下結果：

[root@lc4eb2 740377211 scripts]#./checkIn.sh

初始變數環境

輸入您需要處理的元件

0 - All the components

1 - Communities

2 - Activities

3 - Blogs

4 – Dogear

5 – Wikis

6 - Files

7 - Profiles

輸入元件序號，然後按 [ENTER]

如果您輸入“0”，那麼將更新所有元件。注意，每次最好僅處理一個元件。同時更新所有元件會加大伺服器的壓力，甚至可能導致 OutOfMemory 異常。將檔案簽入之後，需要重啟伺服器以讓更改生效。

警告：在解除安裝、安裝、遷移或更新 Lotus Connections 之後，所有定製配置將被覆蓋。因此，我們強烈建議您儲存並存檔元件的定製配置。

進行任何產品更新 / 更改之後，您的所有定製配置將丟失，這時您將需要重新應用以前儲存的定製配置。

6 結束語

在這份白皮書中，我首先介紹了 Lotus Connections 元件如何建立電子郵件通知，並展示它們在使用者郵箱中的外觀，接著詳細描述瞭如何配置 Notification Framework。

我們還解釋瞭如何定製 NF 用於寫郵件的模板，從而定製電子郵件的觀感。最後，我們討論瞭如何使用指令碼簽入或簽出現有的模板。

原文連結：http://www.ibm.com/developerworks/cn/lotus/documentation/d-ls-lcnotifications/index.html