目錄同步概觀

目錄同步可確保 Cisco BroadWorks 使用者的 Webex 可以使用 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 電話清單專案:

  • 企業常見電話清單

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

  • 個人電話清單

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


有關使用者供應的更多詳細資訊,請參閱 Webex for Cisco BroadWorks 解決方案指南

目錄同步情況

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

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

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

  • 每個 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 電話清單專案同步至 Webex 聯絡人。 同步專案會新加入以下聯絡人類型之一:

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

  • 使用者聯絡人 — Webex 針對使用者儲存這些聯絡人。 只有擁有該聯絡人的使用者才能存取聯絡人專案。 最多 2000 個聯絡人(1500 個同步的聯絡人 + 500 個手動輸入聯絡人)。


只有電話清單專案會新增加至 Webex 聯絡人。 僅 BroadWorks 通話使用者及目錄同步中包含的非使用者通話實體不會新加入聯絡人,除非 Webex 使用者手動將其新增加至聯絡人。

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

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

Webex 聯絡人類型

聯絡人來源

上限

已從 BroadWorks 同步...

用於同步的 API

組織聯絡人

目錄同步

500 個聯絡人

企業常見電話清單

/directories/enterprisecommon

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

/directories/groupcommon

使用者聯絡人

目錄同步

1500 個聯絡人

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

/directories/groupcommon

個人電話清單

/directories/personal

由使用者手動新增

500 個聯絡人

不適用

不適用


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

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

  • False — 同步為組織聯絡人

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

  • 如果組織超過允許的同步聯絡人數上限(500 個組織聯絡人或 1500 個同步的使用者聯絡人),則目錄同步會排除超過最大閾值的條目。 沒有適用于同步或省略聯絡人的特定順序。

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

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

更新

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

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

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

當管理員在 BroadWorks 上更新聯絡人後,使用者 Webex 應用程式中會顯示該更新時,下列條件概述:

  • 如果更新的是僅 BroadWorks 通話使用者或非使用者通話實體,則更新會在後續目錄同步後立即顯示在使用者的 Webex 應用程式中。

  • 若更新專案為 BroadWorks 電話清單專案:

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

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


Cisco BroadWorks 消費者資訊 Webex 的更新會作為供應流程的一部分進行處理。

Control Hub 包含透過 CSV 檔案在 Control Hub 中新增或編輯組織層級聯絡人的選項。 具有 Control Hub 存取權的合作夥伴管理員和客戶管理員可以存取此選項。 但是,Cisco BroadWorks 的 Webex 不支援透過 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 外部目錄使用者同步正在進行中,因此無法停用 BroadWorks 外部目錄使用者同步。

600022

由於企業沒有供應的使用者,BroadWorks 外部目錄單一使用者同步無法進行。

600023

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

600024

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

600025

BroadWorks 外部目錄使用者同步在 CI 中消費者帳戶使用者同步。

600026

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

600027

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

600028

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

600029

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

變更歷史記錄

下表彙總了本文的更新。

日期

修訂版

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 日

  • 新增了錯誤碼。

  • 新增了介紹性描述語句,從而從網路搜尋獲得更好的易用性。

2021 年 12 月 17 日

  • 次要結構編輯以修正缺少 TOC 的問題。

2021 年 12 月 16 日

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

2021 年 12 月 8 日

  • 新增了 目錄同步和聯絡人上限 區段,以說明目錄同步如何衍生組織和使用者聯絡人數上限。

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