目录同步概述

目录同步确保 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 是处于企业模式还是处于服务商模式。 参数值(true 或 false) isBroadWorksEnterprise 可确定列表的同步方式:

  • True - 同步为组织联系人

  • False - 同步为用户联系人

更新

在 BroadWorks 上更新联系人后,以下概述了更新何时显示在用户的 Webex 应用程序中:

  • 用户重启应用程序之后或应用程序本地 72 小时缓存定时器到期后,组织联系人更新会显示在 Webex 应用程序中。

  • 用户联系人更新会立即显示在该用户的 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—设置为空值。

    • globalDirectoryTransactionLimit—设置为空值。


    建议您将 userDirectoryTransactionLimit 和 globalDirectoryTransactionLimit 设置为空值。 但是,如果您决定分配值,则每个值都必须设置为至少五倍于 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

developer.webex.com 上提供了公共 API,允许合作伙伴管理员执行以下操作:更新其管理的客户组织的目录同步设置、触发即时同步,或者获取同步状态信息。 目录同步方法位于 BroadWorks 企业下。 有以下四种 API:

  • 列出 BroadWorks 企业 - 使用此 API 方法可获取给定服务商下的企业列表,以及各个企业 id 。 您必须输入 spEnterpriseId (预配置时指定)。

  • 更新 BroadWorks 企业的目录同步 - 输入企业 id 以更新该企业的目录同步状态,从而启用或禁用目录同步。

  • 触发企业的目录同步 - 如果要为给定企业触发即时同步,请使用此 API 方法 id 。 对于 syncStatus ,请输入 SYNC_NOW

  • 获取企业的目录同步状态 - 输入企业 id 并运行,以获取最新同步的状态和 trackingId 。 您可以使用 trackingID 通过 Kibana 和 Grafana 等工具运行其他分析。

有关 API 文档的详细信息,请参阅 https://developer.webex.com/docs/api/guides/webex-for-broadworks-developers-guide

您需要登录到 https://developer.webex.com/docs/api/v1/broadworks-subscribers 以阅读 API 规范。

将多个企业与 API 同步

完成本过程以使用公共 API 为多个企业完成目录同步。

  • 目录同步允许您一次仅同步一个企业。 如果您尝试同步多个企业,会收到 429 错误。

  • 单个企业完成同步所花的时间取决于企业规模。

1

运行列出 BroadWorks 企业 API,生成要同步的企业的列表。

  1. startWith 设置为企业或服务商标识的起始字符串。

  2. 单击 运行.

2

对列表中的第一个企业运行触发企业的目录同步 API。

  1. 输入企业标识

  2. syncStatus 设置为 SYNC_NOW

  3. 单击 运行.

    将为企业触发即时同步。 此同步按每个实例一次同步的限制计数。
3

等待几秒钟,然后运行获取目录同步状态 API 以获得同步状态。

  1. 输入企业标识

  2. 单击 运行.

4

同步完成后,对列表中的下一个企业完成步骤 2 到 4。 重复这些步骤,直至同步整个列表。

目录同步错误代码

以下错误代码适用于目录同步。

错误代码

错误消息

600000

发生 Broadworks 外部目录用户同步意外错误。

600001

Broadworks 外部目录用户同步失败。

600002

Broadworks 外部目录用户同步尚未完成,但必须终止。

600003

Broadworks 外部目录用户同步仅部分成功。 部分客户组织同步失败。

600004

没有为配置集启用 Broadworks 外部目录用户同步。

600005

正在进行配置集的 Broadworks 外部目录用户同步。

600006

Broadworks 外部目录用户同步线程正忙或已关闭,因此不会接受其他同步请求,请稍后重试。

600007

找不到客户配置的身份组织。

600008

在合作伙伴组织中找不到客户配置。

600009

无法运行 Broadworks 外部目录用户同步,因为与客户配置关联的 Broadworks 集群正忙

600010

无法运行 Broadworks 外部目录用户同步,因为没有任何 Broadworks 集群与客户配置关联。

600011

没有为客户配置启用 Broadworks 外部目录用户同步。

600012

无法运行 Broadworks 外部目录用户同步,因为已为客户配置启用混合目录同步。

600013

Broadworks 外部目录用户同步无法将用户和计算机帐户添加到身份存储库。

600014

尝试连接到 Broadworks 集群时,Broadworks 外部目录用户同步失败。 Broadworks 发生错误 - %s。

600015

Broadworks 外部目录用户同步在身份存储库中找不到任何匹配的用户。

600017

BroadWorks 电话列表同步无法同步所有用户和企业/组织联系人。

600018

对于企业/组织中的用户,BroadWorks 电话列表同步失败。

600019

BroadWorks 电话列表同步无法同步企业/组织联系人。