目錄同步概觀

目錄同步處理可確保 Webex for Cisco BroadWorks 使用者能使用 Webex 目錄從 BroadWorks 伺服器呼叫任何通話實體。 啟用此功能時,來自 BroadWorks 伺服器的完整通話目錄會同步到 Webex 目錄。 使用者可以從 Webex 應用程式存取目錄,並從 BroadWorks 伺服器向任何通話實體撥打電話。

目錄同步包括同步使用者通話資訊與電話清單。 同步的電話清單記錄將寫入 Webex 目錄中的兩種聯絡人類型之一:

  • 組織聯絡人 — 這些聯絡人針對組織進行儲存,可供組織中的每個使用者使用。

  • 使用者聯絡人 — 這些聯絡人針對使用者進行儲存,僅可供擁有該聯絡人的使用者使用。


Webex for Cisco BroadWorks 佈建具有將傳訊功能使用者及其在 BroadWorks 伺服器中的相關通話資訊與 Webex 目錄進行同步處理的預設功能。 但是,預設佈建同步會省略非傳訊使用者和非使用者實體(例如會議室電話、傳真機或群組搜尋號碼)。 開啟目錄同步可確保所有通話實體都加入 Webex 目錄。

目錄同步情況

  • 合作夥伴管理員必須在合作夥伴層級開啟此功能。 合作夥伴管理員可以透過單一作業為多個客戶組織開啟或關閉該功能。

  • 預設情況下,首次同步會在啟用同步後的一週內進行(選擇啟動同步的時間是隨機的)。 但是,客戶組織可以使用立即同步選項來繞過一周的等待時間,並為給定客戶組織完成立即同步。

  • 依預設,每個客戶每週執行目錄同步一次。 每次同步都會在上一次同步後一周內進行,無論同步是使用立即同步排定還是手動觸發。

  • 如果發生同步處理失敗,則每 24 小時會自動重新執行同步處理,直到排定的下一次同步處理時間為止。

  • 同步處理會略過沒有電話號碼的使用者。

  • 在 Partner Hub 中,您可以檢視給定客戶的同步狀態資訊。 此外,您還可以將上次同步的相關詳細資訊匯出到 CSV 記錄。 CSV 記錄比 Control Hub 顯示詳細,可以協助進行疑難排解、分析和稽核。

  • 使用者聯絡人以加密格式儲存,只有擁有聯絡人的使用者才有權存取解密金鑰。

  • 此功能會同步來自 BroadWorks 伺服器的下列電話清單類型:

    • 企業常見電話清單

    • 群組常見電話清單

    • 個人電話清單

目錄同步及聯絡人數上限

以下是目錄同步允許每種 Webex 聯絡人類型擁有的聯絡人數上限:

  • 500 個組織聯絡人

  • 500 個使用者聯絡人 — 對於使用者而言,上限包括同步的使用者聯絡人數與手動聯絡人數(使用者透過 Webex 應用程式手動新增的聯絡人)

下列條件適用:

  • 如果組織的任一類別中具有 500 個以上聯絡人,則同步時會排除超過 500 限制臨界值的項目。 已同步或省略的聯絡人未套用任何特定順序。

  • 如果使用者在 Webex 應用程式上手動新增聯絡人,則使用者聯絡人數上限是已同步的使用者聯絡人數減去手動聯絡人數。 例如,如果使用者在 Webex 應用程式上手動新增 100 個聯絡人,則該使用者的目錄同步最多允許從 BroadWorks 同步 400 個使用者聯絡人。

  • 如果其中一個客戶組織的任一類別中具有 500 個以上聯絡人,我們建議您向 Cisco 呈報問題,以將該組織排除在目錄同步之外。

下表將 Webex 聯絡人類型對應至從中同步記錄的 BroadWorks 電話清單:

表 1. 目錄同步聯絡人類型與同步來源

Webex 聯絡人類型

已從 BroadWorks 同步...

用於同步的 API

組織聯絡人

企業常見電話清單

/directories/enterprisecommon

群組常用電話清單(處於服務提供者模式時)**

/directories/groupcommon

使用者聯絡人

群組常用電話清單(處於企業模式時)**

/directories/groupcommon

個人電話清單

/directories/personal


**群組常用電話清單的同步方式不同,具體取決於 BroadWorks 是處於企業模式還是服務提供者模式。 參數 isBroadWorksEnterprise 的值(true 或 false)決定清單的同步方式:

  • True — 同步為組織聯絡人

  • False — 同步為使用者聯絡人

更新

在 BroadWorks 上更新聯絡人之後,下面介紹更新何時顯示在使用者的 Webex 應用程式中:

  • 在使用者重新啟動 Webex 應用程式或者應用程式的本地 72 小時制快取計時器到期後,組織聯絡人更新便會顯示在該應用程式中。

  • 使用者聯絡人更新會立即顯示在該使用者的 Webex 應用程式中。

下面介紹 Webex 目錄如何處理更新:

  • 如果聯絡人姓名在 BroadWorks 上變更,則系統會將現有聯絡人從 Webex 目錄中刪除,並且會建立一個新的聯絡人。

  • 如果聯絡人號碼在 BroadWorks 上變更,則 Webex 目錄中的現有聯絡人會更新為使用新號碼。

目錄同步先決條件

切換要求

此功能存在下列功能切換。 請務必聯絡您的 Webex for Cisco BroadWorks 代表進行這些設定。

功能切換

適用於...

說明

webex-for-broadworks-phone-list-sync

合作夥伴

必要切換。 針對此合作夥伴下的所有客戶組織啟用電話清單同步。

必須為已啟用

webex-for-broadworks-phone-list-sync-disable

客戶組織

選用切換。 停用給定組織的電話清單同步,即使已在合作夥伴層級及客戶範本中啟用此功能也一樣。

僅當您想要停用特定客戶組織的電話清單同步時,才適用此切換。 否則,您可以停用此功能。


 
例如,您應將此切換套用於需要的聯絡人數超過 500 的任何組織。

hidden-personal-contacts-enabled-ga

使用者

選用切換。 隱藏此使用者完成的目錄搜尋中的個人聯絡人。

hidden-org-contacts-enabled-ga

使用者

選用切換。 隱藏此使用者完成的目錄搜尋中的組織聯絡人。

預先設定要求

我們建議您使用以下設定:


以下範例會假設您使用的是 XSP 伺服器。 若為 ADP 伺服器,請將 (XSP_CLI) 替換為 (ADP_CLI)。
  • 速率限制值 — 設定下列 OverloadControl 系統屬性 (XSP_CLI/Applications/Xsi-Actions/OverloadControl):

    • userDirectoryTransactionLimit — 設為 Null 值。

    • globalDirectoryTransactionLimit — 設為 Null 值。


    建議您將 userDirectoryTransactionLimit 和 globalDirectoryTransactionLimit 設定為 Null 值。 但是,如果您決定要指定值,每個值必須至少設定為 transactionLimitPeriodSeconds 值的五倍(應該為 1)。
  • 交易限制 — 設定下列值 (XSP_CLI/System/CommunicationUtility/DefaultSettings):

    • userTransactionLimit — 至少設為 100。

    • transactionLimitPeriodSecs — 設為 1。

  • 傳呼值 — 設定傳呼系統屬性 (XSP_CLI/Applications/Xsi-Actions/Paging):

    • defaultPageSize — 設為 50

    • availableUserMaxLimit — 設為 100

  • CTI 介面 — 確保將該 Webex CA 憑證上傳至 CTI 介面信任存放區,並啟用 CTI 介面上的用戶端驗證。

此外,根據 BroadWorks 發行版,建議您先將下列系統修補程式套用至 BroadWorks 部署,然後再啟用此功能:


如需查看構成 Webex for Cisco BroadWorks 最低要求的修補程式要求的完整清單,請參閱 BroadWorks 軟體要求(位於《Webex for Cisco BroadWorks 的解決方案指南》)。

啟用目錄同步(新範本)

合作夥伴管理員可以在建立新範本時為客戶範本啟用目錄同步。 指派給該範本的任何新客戶組織都將啟用目錄同步。 如需瞭解詳情,請參閱在 Partner Hub 中設定您的合作夥伴組織(位於《Webex for Cisco BroadWorks 的解決方案指南》)中的「設定客戶範本」。

後續動作

請務必讓使用者知道,必須至少按一次 Webex 應用程式上的聯絡人標籤才能在 Webex 應用程式上開啟該功能。 此動作只需完成一次。

啟用目錄同步(現有範本)

合作夥伴管理員可以完成下列步驟,以在現有客戶範本中開啟目錄同步,從而為使用該範本的客戶組織啟用此功能。

1

登入 Partner Hub 並選擇設定

2

捲動至 BroadWorks Calling,然後按一下檢視範本

3

選取適當的客戶範本,然後捲動至 BroadWorks 目錄同步

4

若要依預設為使用此範本的新客戶組織啟用目錄同步,請執行下列操作:

  1. 為所有新的客戶組織啟用 Broadworks 目錄及電話清單同步開關設為開啟

  2. 按一下儲存

5

若要為使用此範本的現有客戶組織啟用目錄同步,請執行下列操作:

  1. 按一下顯示客戶同步狀態的清單

  2. 勾選您想要開啟該功能的每個組織的相鄰核取方塊。

  3. 按一下啟用同步


 

若要停用目錄同步,請遵循上述程序以及:

  • 在步驟 4a 中,將為所有新的客戶組織啟用電話目錄同步開關切換至關閉,以依預設針對使用此範本的新客戶組織停用目錄同步。

  • 在步驟 5c 中,按一下停用同步以針對現有組織關閉該功能。

後續動作

請務必讓使用者知道,必須至少按一次 Webex 應用程式上的聯絡人標籤才能在 Webex 應用程式上開啟該功能。 此動作只需完成一次。

完成立即同步

立即同步選項可讓合作夥伴管理員為給定的客戶組織完成按需同步。 只能為個別客戶組織選取此選項 —「立即同步」沒有批量選項。

1

登入 Partner Hub (http://admin.webex.com) 並選擇設定

2

捲動至 BroadWorks Calling,然後按一下檢視範本

3

選取適當的客戶範本,然後捲動至 BroadWorks 目錄同步

4

按一下顯示客戶同步狀態的清單

5

對於您想要同步的客戶組織,請按一下最右邊的三個點並選取立即同步

6

按一下重新整理以檢視結果。

將同步記錄匯出至 CSV

合作夥伴管理員可以將上次同步的相關詳細資訊匯出到 CSV 檔案。 CSV 包含比 Control Hub GUI 更詳細的同步記錄檢視,可以協助進行疑難排解和分析。

1

登入 Partner Hub (http://admin.webex.com) 並選擇設定

2

捲動至 BroadWorks Calling,然後按一下檢視範本

3

選取適當的客戶範本,然後捲動至 BroadWorks 目錄同步

4

按一下顯示客戶同步狀態的清單

5

勾選您想要包括到匯出中的每個組織的相鄰勾選方塊。

6

按一下匯出結果

用於目錄同步的公用 API

公用 API 在 developer.webex.com 中有提供,可讓合作夥伴管理員更新其管理的客戶組織的目錄同步設定、觸發立即同步或取得同步狀態資訊。 目錄同步方法已歸類到 BroadWorks 企業 下。 有四個 API:

  • 列出 BroadWorks 企業 — 使用此 API 方法來取得給定服務提供者下的企業清單以及每個企業的 id 。 您必須按佈建指定的那樣輸入 spEnterpriseId

  • 更新用於 BroadWorks 企業的目錄同步 — 輸入企業 id 以更新該企業的目錄系統狀態,啟用或停用目錄同步。

  • 針對企業觸發目錄同步 — 如果您想要針對給定企業 id 。 對於 syncStatus ,請輸入 SYNC_NOW 指令。

  • 取得企業的目錄同步狀態 — 輸入企業 id 並執行以取得最新同步的狀態和 trackingId 。 您可以使用 trackingID 透過諸如 Kibana 和 Ganaana 等工具執行其他分析。

如需獲取詳細的 API 文件,請參閱 https://developer.webex.com/docs/api/guides/webex-for-broadworks-developers-guide

您需要登入才能閱讀 API 規格(載於 https://developer.webex.com/docs/api/v1/broadworks-subscribers)。

將多個企業與 API 同步

完成此過程以使用公用 API 來完成多個企業的目錄同步。

  • 目錄同步可讓您一次只同步一個企業。 如果您嘗試同步多個企業,您將收到 429 錯誤。

  • 完成單一企業同步所花費的時間視企業規模而異。

1

執行列出 BroadWorks 企業 API 以產生您要同步的企業清單。

  1. startWith 設定為企業或服務提供者 ID 的起始字串。

  2. 按一下 執行.

2

針對清單中的第一個企業執行觸發企業目錄同步 API。

  1. 輸入企業 ID

  2. syncStatus 設為 SYNC_NOW

  3. 按一下 執行.

    針對企業觸發即時同步。 此同步將計入「每個實例進行一次同步」限制。
3

等待數秒,然後執行取得目錄同步狀態 API 以取得同步狀態。

  1. 輸入企業 ID

  2. 按一下 執行.

4

同步完成後,針對清單中的下一個企業完成步驟 2 到 4。 重複上述步驟,直到同步整個清單為止。

目錄同步的代碼錯誤

下列錯誤代碼適用於目錄同步。

錯誤代碼

錯誤訊息

600000

「Broadworks 外部目錄使用者同步」發生非預期錯誤。

600001

「BroadWorks 外部目錄使用者同步」失敗。

600002

「BroadWorks 外部目錄使用者同步」在完成之前必須終止。

600003

「Broadworks 外部目錄使用者同步」僅部分成功。 部分客戶組織無法同步。

600004

ConfigSet 未啟用「BroadWorks 外部目錄使用者同步」。

600005

ConfigSet 正在進行「BroadWorks 外部目錄使用者同步」。

600006

「BroadWorks 外部目錄使用者同步」執行緒忙碌或正在關閉,因此將不會接受更多同步請求,請稍後重試。

600007

找不到 CustomerConfig 的身分識別組織。

600008

在合作夥伴組織中找不到 CustomerConfig。

600009

「Broadworks 外部目錄使用者同步」無法執行,因為與 CustomerConfig 相關聯的 Broadworks 叢集忙碌

600010

「BroadWorks 外部目錄使用者同步」無法執行,因為不存在與 CustomerConfig 相關聯的 BroadWorks 叢集。

600011

CustomerConfig 未啟用「BroadWorks 外部目錄使用者同步」。

600012

「Broadworks 外部目錄使用者同步」無法執行,因為 CustomerConfig 已啟用「混合目錄同步」。

600013

「BroadWorks 外部目錄使用者同步」無法將使用者和機器帳戶新增至身分識別存放區。

600014

在嘗試連線至 Broadworks 叢集時,「Broadworks 外部目錄使用者同步」失敗。 來自 Broadworks 的錯誤 - %s。

600015

「Broadworks 外部目錄使用者同步」在身分識別存放區中找不到任何相符的使用者。

600017

BroadWorks 電話清單同步無法同步所有使用者和企業/組織聯絡人。

600018

對於企業/組織中的使用者,BroadWorks 電話清單同步失敗。

600019

BroadWorks 電話清單同步無法同步企業/組織聯絡人。