- 首頁
- /
- 文章
適用於 Cisco BroadWorks 的 Webex 中的目錄同步
本文描述瞭如何在Webex for Cisco BroadWorks 中部署目錄同步。 本文適用於合作夥伴組織的服務提供者管理員。
目錄同步概觀
目錄同步可確保Cisco BroadWorksWebex使用者可以使用Webex應用程式中的Webex目錄從 BroadWorks 伺服器上呼叫任何呼叫實體。 此功能將不屬於使用者佈建一部分的 BroadWorks 通話資訊同步到Webex目錄。
適用於Cisco BroadWorks 的Webex使用者佈建使用Cisco BroadWorks 使用者的Webex的通話詳細資料(主要電話號碼、行動電話號碼、分機號)來更新Webex目錄,但會忽略外部通話記錄。 但是,當開啟目錄同步時,該功能還將以下通話記錄同步到Webex目錄。
純 BroadWorks 通話使用者(未加入Webex的使用者)
非使用者呼叫實體(例如會議室電話、傳真機、搜尋群組號碼)
BroadWorks 電話清單項目
下表總結了 BroadWorks 通話記錄,並顯示瞭如何將其新增至Webex目錄。
BroadWorks 通話記錄 | 說明 | 已透過以下方式新增至Webex目錄... |
---|---|---|
適用於Cisco BroadWorks 使用者的Webex | 已為Cisco BroadWorks 啟用Webex的使用者 | 使用者佈建(例如佈建流程) |
純 BroadWorks 通話使用者 | 執行下列作業的通話使用者:不已加入Webex | 目錄同步 |
非使用者通話實體 | 例如,會議室電話、傳真機、群組搜尋號碼 | 目錄同步 |
BroadWorks 電話清單 | 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 電話清單和聯絡人上限
目錄同步還將 BroadWorks 電話清單項目同步到Webex Contacts。 同步的項目會新增至以下其中一個聯絡人類型:
組織聯絡人— Webex針對組織儲存這些聯絡人。 每個使用者都可以存取其組織的組織聯絡人。 最多可以有 30000 個聯絡人。
使用者聯絡人— Webex儲存針對使用者的這些聯絡人。 僅擁有該聯絡人的使用者可以存取該聯絡人項目。 最多為 2000 個聯絡人(1500 個同步聯絡人 + 500 個手動輸入聯絡人)。
下表將Webex聯絡人類型與聯絡人來源 (從 BroadWorks 電話清單同步或手動新增) 對應:
Webex 聯絡人類型 | 聯絡人來源 | 最大值 | 已從 BroadWorks 同步... | 用於同步的 API |
---|---|---|---|---|
組織聯絡人 | 目錄同步 | 30000 個聯絡人 | 企業常見電話清單 |
|
群組常用電話清單(對於服務提供者群組)** |
| |||
使用者聯絡人 | 目錄同步 | 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應用程式中看到變更。
目錄同步先決條件
我們建議您使用以下設定:
速率限制值 — 設定下列 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 部署,然後再啟用此功能:
若版本為 R22:
AP.as.22.0.1123.ap368517
若版本為 R23:
AP.as.23.0.1075.ap368517
若版本為 R24: 不需要修補程式
啟用目錄同步(新範本)
合作夥伴管理員可以在建立新範本時為客戶範本啟用目錄同步。 指派給該範本的任何新客戶組織都將啟用目錄同步。 如需瞭解詳情,請參閱在 Partner Hub 中設定您的合作夥伴組織(位於《Webex for Cisco BroadWorks 的解決方案指南》)中的「設定客戶範本」。
後續動作
請務必讓使用者知道,必須至少按一次 Webex 應用程式上的聯絡人標籤才能在 Webex 應用程式上開啟該功能。 此動作只需完成一次。
啟用目錄同步(現有範本)
1 | 登入 Partner Hub 並選擇設定。 |
2 | 捲動至 BroadWorks Calling,然後按一下檢視範本。 |
3 | 選取適當的客戶範本,然後捲動至 BroadWorks 目錄同步。 |
4 | 若要依預設為使用此範本的新客戶組織啟用目錄同步,請執行下列操作: |
5 | 若要為使用此範本的現有客戶組織啟用目錄同步,請執行下列操作: 若要停用目錄同步,請遵循上述程序以及:
|
下一步
請務必讓使用者知道,必須至少按一次 Webex 應用程式上的聯絡人標籤才能在 Webex 應用程式上開啟該功能。 此動作只需完成一次。
觸發立即同步
1 | 登入 Partner Hub (http://admin.webex.com ) 並選擇設定。 |
2 | 捲動至 BroadWorks Calling,然後按一下檢視範本。 |
3 | 選取適當的客戶範本,然後捲動至 BroadWorks 目錄同步。 |
4 | 按一下顯示客戶同步狀態的清單。 |
5 | 對於您想要同步的客戶組織,請按一下最右邊的三個點並選取立即同步。 |
6 | 按一下重新整理以檢視結果。 |
將同步記錄匯出至 CSV
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 同步
目錄同步可讓您透過隨選同步一次僅同步 Broadworks 叢集中的單個企業。 如果您嘗試同步多個企業,您將收到 429 錯誤
為單個企業觸發同步所需的時間根據企業的規模而有所不同。
1 | 執行列出 BroadWorks 企業 API 以產生您要同步的企業清單。 |
2 | 針對清單中的第一個企業執行觸發企業目錄同步 API。 |
3 | 等待數秒,然後執行取得目錄同步狀態 API 以取得同步狀態。 |
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 日 | 對概觀資訊的說明與更正:
|
2022 年 5 月 9 日 |
|
2022 年 4 月 7 日 |
|
2022 年 3 月 28 日 |
|
2022 年 3 月 24 日 | 新增了同步電話號碼類型的清單,目錄同步條件。 同步現在包括行動電話號碼。 |
2022 年 3 月 16 日 |
|
2021 年 12 月 17 日 |
|
2021 年 12 月 16 日 |
|
2021 年 12 月 8 日 |
|