目錄同步概觀

目錄同步可確保Cisco BroadWorksWebex使用者可以使用Webex應用程式中的Webex目錄從 BroadWorks 伺服器上呼叫任何呼叫實體。 此功能將不屬於使用者佈建一部分的 BroadWorks 通話資訊同步到Webex目錄。

適用於Cisco BroadWorks 的Webex使用者佈建使用Cisco BroadWorks 使用者的Webex的通話詳細資料(主要電話號碼、行動電話號碼、分機號)來更新Webex目錄,但會忽略外部通話記錄。 但是,當開啟目錄同步時,該功能還將以下通話記錄同步到Webex目錄。

  • 純 BroadWorks 通話使用者(未加入Webex的使用者)

  • 非使用者呼叫實體(例如會議室電話、傳真機、搜尋群組號碼)

  • BroadWorks 電話清單項目

下表總結了 BroadWorks 通話記錄,並顯示瞭如何將其新增至Webex目錄。

表 1. Webex目錄的目錄同步更新

BroadWorks 通話記錄

說明

已透過以下方式新增至Webex目錄...

適用於Cisco BroadWorks 使用者的Webex

已為Cisco BroadWorks 啟用Webex的使用者

使用者佈建(例如佈建流程)

純 BroadWorks 通話使用者

執行下列作業的通話使用者:已加入Webex

目錄同步

非使用者通話實體

例如,會議室電話、傳真機、群組搜尋號碼

目錄同步

BroadWorks 電話清單

BroadWorks 電話清單項目:

  • 企業常見電話清單

  • 群組常用電話清單(服務提供者群組或企業群組)

  • 個人電話清單

目錄同步(電話清單同步)


如需有關使用者佈建的更多詳細資訊,請參閱適用於Cisco BroadWorks 解決方案指南的Webex

目錄同步情況

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

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

  • 依預設,每個客戶每週執行目錄同步一次。 每次同步都會在最後一次同步之後的一個星期發生,而不必考慮最後一次同步是排定還是手動觸發立即同步

  • 每個 BroadWorks 叢集的數目上限同步同步數為兩個: 一個排定的同步和一個隨選同步(透過API或 Partner Hub GUI)。 但是,管理員無法從同一個 BroadWorks 同時執行兩個隨選同步。 無論同步是透過API還是透過立即同步Partner Hub 中的選項。 此外, Webex不會排定兩個已排定的同步同時從同一個 BroadWorks 執行。

  • 如果發生同步失敗, Webex會每隔 24 小時自動重新嘗試同步,直到下一次排定的同步為止。

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

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

  • Webex以加密的格式儲存使用者聯絡人。 僅擁有該聯絡人的使用者有權存取解密金鑰。

  • 對於純 BroadWorks 通話使用者和非使用者通話實體,此功能從 BroadWorks 同步以下電話號碼類型:

    • 主要電話號碼

    • 行動電話號碼

    • 擴充功能

    但是,如果主要電話號碼或分機號都不存在,則同步會將純 BroadWorks 通話使用者和非使用者通話實體排除在同步之外。


    不支援將 BroadWorks 使用者層級隱私服務設定作為目錄同步的一部分。

BroadWorks 電話清單和聯絡人上限

目錄同步還將 BroadWorks 電話清單項目同步到Webex Contacts。 同步的項目會新增至以下其中一個聯絡人類型:

  • 組織聯絡人— Webex針對組織儲存這些聯絡人。 每個使用者都可以存取其組織的組織聯絡人。 最多可以有 30000 個聯絡人。

  • 使用者聯絡人— Webex儲存針對使用者的這些聯絡人。 僅擁有該聯絡人的使用者可以存取該聯絡人項目。 最多為 2000 個聯絡人(1500 個同步聯絡人 + 500 個手動輸入聯絡人)。


只會將電話清單項目新增至Webex聯絡人。 目錄同步中包含的純 BroadWorks 通話使用者和非使用者通話實體不會新增至聯絡人,除非Webex使用者將他們手動新增至聯絡人。

下表將Webex聯絡人類型與聯絡人來源 (從 BroadWorks 電話清單同步或手動新增) 對應:

表格 2. 目錄同步上限值和來源

Webex 聯絡人類型

聯絡人來源

最大值

已從 BroadWorks 同步...

用於同步的 API

組織聯絡人

目錄同步

30000 個聯絡人

企業常見電話清單

/directories/enterprisecommon

群組常用電話清單(對於服務提供者群組)**

/directories/groupcommon

使用者聯絡人

目錄同步

1500 個聯絡人

個人電話清單

/directories/personal

由使用者手動新增

500 個聯絡人

不適用

不適用

群組聯絡人

目錄同步

每組 30000 個聯絡人

群組常用電話清單(對於企業群組)**

/directories/groupcommon

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

  • True — 同步為群組聯絡人

  • False - 作為組織聯絡人同步

在目錄同步如何處理聯絡人數上限方面適用下列條件:

  • 如果組織超過同步允許的聯絡人數上限(每個群組 30000 個組織聯絡人或 30000 個群組普通聯絡人),目錄同步會排除超過最大臨界值的項目。 同步或遺漏的聯絡人不會套用特定順序。

  • 如果您的一個客戶超過任一類別中允許的聯絡人人數上限,我們建議您向Cisco報告案例,將該組織排除在目錄同步之外。

  • 手動聯絡人是使用者手動在 Webex 應用程式上新增的聯絡人。 使用者最多可以新增 500 個手動聯絡人。 手動聯絡屬於Webex上較大的使用者聯絡類別,但不會包含在同步中。

  • 組織聯絡 (30000) 和群組聯絡 (每個群組 30000) 的整體組合限制為 200000。

更新

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

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

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

管理員更新 BroadWorks 上的聯絡人之後,以下情況概述更新何時顯示在使用者的Webex應用程式中:

  • 如果更新適用於純 BroadWorks 呼叫使用者或非使用者呼叫實體,則在後續目錄同步之後,更新會立即顯示在使用者的Webex應用程式中。

  • 如果更新是針對 BroadWorks 電話清單項目:

    • 對於使用者聯絡人 - 在後續目錄同步之後,更新立即顯示在使用者的Webex應用程式中。

    • 對於群組聯絡人 - 在後續目錄同步之後,立即在使用者Webex應用程式中顯示更新。

    • 對於組織聯絡人 — 在後續目錄同步時會更新Webex目錄,但使用者在重新啟動Webex應用程式或本地 72 小時快取計時器到期之前不會在Webex應用程式中看到變更。


適用於Cisco BroadWorks 的Webex更新使用者資訊將作為佈建程序的一部分處理。

Control Hub 包含一個用於透過CSV 檔案在 Control Hub 中新增或編輯組織層級聯絡人的選項。 具有 Control Hub 存取權的合作夥伴管理員和客戶管理員可以存取此選項。 然而, Webex for Cisco BroadWorks 不支援透過 Control Hub 更新聯絡人。 套用在 Control Hub 中的聯絡人更新不會同步回 BroadWorks,並且無法從桌面電話進行目錄搜尋。

目錄同步先決條件

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


以下範例會假設您使用的是 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 部署,然後再啟用此功能:

啟用目錄同步(新範本)

合作夥伴管理員可以在建立新範本時為客戶範本啟用目錄同步。 指派給該範本的任何新客戶組織都將啟用目錄同步。 如需瞭解詳情,請參閱在 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 企業

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

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

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

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

此外,管理員還可以使用為單個使用者觸發目錄同步用於為單一使用者觸發隨選目錄同步的API 。

如需獲取詳細的 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 來觸發多個企業的目錄同步。

  • 目錄同步可讓您透過隨選同步一次僅同步 Broadworks 叢集中的單個企業。 如果您嘗試同步多個企業,您將收到 429 錯誤

  • 為單個企業觸發同步所需的時間根據企業的規模而有所不同。

1

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

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

  2. 按一下 執行.

2

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

  1. 輸入企業 ID

  2. syncStatus 設為 SYNC_NOW

  3. 按一下 執行.

    針對企業觸發即時同步。 根據 Broadworks 限制,此同步會計入單個隨選同步。
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 電話清單同步無法同步企業/組織聯絡人。

600020

無法停用 BroadWorks 外部目錄使用者同步,因為 CustomerConfig 同步進行中。

600022

無法進行 BroadWorks 外部目錄單一使用者同步,因為企業沒有佈建的使用者。

600023

無法實現 BroadWorks 外部目錄單一使用者同步,因為該使用者已存在於此組織中。

600024

無法進行「BroadWorks 外部目錄單一使用者同步」,因為在 BroadWorks 中找不到相符的使用者。

600025

BroadWorks 外部目錄使用者同步無法更新 CI 中的使用者帳戶。

600026

BroadWorks 外部目錄使用者同步無法在 CI 中更新機器帳戶。

600027

無法進行「BroadWorks 外部目錄單一使用者同步」,因為在 BroadWorks 中找到多個使用者。

600028

無法進行 BroadWorks 外部目錄單使用者同步,因為本應至少完成一個企業目錄同步。

600029

BroadWorks 外部目錄使用者同步失敗,因為企業沒有佈建的使用者。

變更歷史記錄

下表彙總了本文的更新。

日期

修訂版

2023 年 2 月 14 日

已更新目錄同步上限和來源區段。

2022 年 12 月 10 日

更新了術語完成立即同步觸發目錄同步

2022 年 7 月 19 日

對概觀資訊的說明與更正:

  • 已更新目錄同步概觀說明所涉及的不同同步以及如何為每個同步更新Webex目錄。

  • 已更新BroadWorks 電話清單和聯絡人上限說明只有電話清單會同步至聯絡人。

  • 更正為更新來說明Webex應用程式顯示更新的記錄需要多長時間。

2022 年 5 月 9 日

  • 輸入目錄同步概觀,已更正附註下目錄同步上限和來源表。 還更新了關於佈建流程的附註。

  • 語法編輯和修正

2022 年 4 月 7 日

  • 新增了附註更新中的區段目錄同步概觀圍繞在 Control Hub 中套用組織層級聯絡人編輯的限制。

2022 年 3 月 28 日

  • 已在下重新插入缺少內容啟用目錄同步(新範本)

  • 新增了有關同步最大值的資訊。 您可以從同一個叢集同時執行一個排定的同步和一個API同步。

  • 新增了關於為單個使用者觸發目錄同步API。

2022 年 3 月 24 日

新增了同步電話號碼類型的清單,目錄同步條件。 同步現在包括行動電話號碼。

2022 年 3 月 16 日

  • 新增了新的錯誤代碼。

  • 新增了介紹性說明,以提高 Web 搜尋的可用性。

2021 年 12 月 17 日

  • 稍加結構性編輯,以修正遺失 TOC 的問題。

2021 年 12 月 16 日

  • 已更新文章,增加了使用者聯絡人數的上限值。

2021 年 12 月 8 日

  • 新增區段目錄同步和聯絡人上限說明 Directory Sync 如何推導數目上限的組織和使用者聯絡。

  • 已修訂目錄同步的代碼錯誤中的表格格式,從而獲得更好的可讀性。