ディレクトリ同期の概要

ディレクトリ同期によって、Cisco BroadWorks の Webex ユーザーは Webex アプリから Webex ディレクトリを使用して、BroadWorks サーバーから任意の通話エンティティに電話することができます。 この機能は、Webex ディレクトリへのユーザープロビジョニングの一部ではない BroadWorks 通話情報を同期します。

Cisco BroadWorks の Webex ユーザープロビジョニングにより、Cisco BroadWorks ユーザーの Webex の通話詳細とともに Webex ディレクトリを更新します(プライマリ電話番号、携帯電話番号、内線番号)、外部通話記録は省略されます。 ただし、ディレクトリの同期がオンの場合、機能は次の通話記録も Webex ディレクトリに同期します。

  • BroadWorks 限定通話ユーザー (Webex がオンボーディングされていないユーザー)

  • 非ユーザーの通話エンティティ (例会議室電話、fax マシン、ハント グループ)

  • BroadWorks 電話リストへのエントリ

以下の表は、BroadWorks コール記録を要約し、Webex ディレクトリに追加する方法を示します。

表 1. ディレクトリ同期は、Webex Directory に対して更新されます。

BroadWorks 通話記録

説明

経由で Webex Directory に追加...

Cisco BroadWorks ユーザー用の Webex

ユーザーは Cisco BroadWorks の Webex で有効になっています

ユーザープロビジョニング (例えば、プロビジョニングに通したフロー)

BroadWorks 限定通話ユーザー

Webex を使用していない 通話ユーザー

ディレクトリ同期

非ユーザー通話エンティティ

例: 自動会議室、FAX、ハント グループ番号

ディレクトリ同期

BroadWorks 電話リスト

BroadWorks 電話リストエントリ:

  • エンタープライズ共通電話リスト

  • グループ共通電話リスト (サービス プロバイダー グループおよびエンタープライズ グループ)

  • 個人電話リスト

ディレクトリの同期(電話リストの同期)


ユーザープロビジョニングの詳細については、 Webex for Cisco BroadWorks ソリューションガイドを参照してください

ディレクトリ同期の条件

  • パートナー管理者は、パートナー レベルでこの機能を有効にする必要があります。 パートナー管理者は、一度の操作で複数の顧客組織に対してこの機能をオンまたはオフにできます。

  • デフォルトでは、同期を有効にしてから 1 週間後に最初の同期が行われます (同期開始のために選ばれる時間はランダムです)。 ただし顧客組織は [今すぐ同期] オプションを使用して、1 週間の待機期間を回避し、特定の顧客組織に対して即時に同期を完了できます。

  • デフォルトでは、ディレクトリ同期は各顧客に対して毎週実行されます。 最後の同期がスケジュールされた、または今すぐ同期で手動でトリガーされたかどうかに関わらず、各同期は最後の同期の 1 週間後に 実行されます

  • BroadWorks クラスターごとの同時同期の最大数は 2 つです。 1 回のスケジュールされた同期と 1 つのオンデマンド同期 (API またはパートナーハブ GUI 経由) しかし、管理者は同じ BroadWorks から 2 つのオンデマンド同期を同時に実行できない。 この制限は、同期が API 経由で開始されたか、パートナーハブの [今すぐ同期] オプションを使用して開始されたかどうかに関係なく存在します。 さらに、Webex は同じ BroadWorks から同時に実行される 2 つのスケジュールされた同期をスケジュールする必要があります。

  • 同期に失敗した場合、Webexは次回のスケジュールされた同期まで、24時間ごとに自動的に同期を再び行います。

  • 同期は電話番号を持つユーザーを無視します。

  • Partner Hub では、特定の顧客の同期ステータス情報を確認できます。 さらに、最後の同期の詳細情報を CSV レコードにエクスポートすることもできます。 CSV レコードは Control Hub の表示よりも詳細を提供し、トラブルシューティング、分析、および監査に役立ちます。

  • Webex はユーザーの連絡先を暗号化された形式で保存します。 連絡先を所有するユーザーだけが暗号鍵にアクセスできます。

  • BroadWorks 専用通話ユーザーと非ユーザー通話エンティティの場合、この機能は BroadWorks から次の電話番号タイプを同期します。

    • 代表電話番号

    • 携帯電話番号

    • Extension

    ただし、同期では、プライマリの電話番号または内線番号が存在しない場合、BroadWorks 限定通話ユーザーと非ユーザー通話エンティティは同期から除外されます。

BroadWorks 電話リストと連絡先の最大数

ディレクトリ同期はまた、BroadWorks の電話リストエントリも Webex 連絡先に同期します。 同期されたエントリは、以下の連絡先の種類の 1 つに追加されます。

  • 組織連絡先—Webex は、これらの連絡先を組織に保存します。 各ユーザーは組織の組織連絡先にアクセスできます。 連絡先の上限は 500 名です。

  • ユーザー連絡先—Webex はユーザーに対してこれらの連絡先を保存します。 連絡先を所有するユーザーだけが連絡先エントリにアクセスできます。 最大で 2000 人の連絡先までです (1500 の同期された連絡先 + 500 人の手動エントリ連絡先)。


電話リストエントリだけが Webex 連絡先に追加されます。 ディレクトリ同期に含まれる BroadWorks 専用通話ユーザーおよび非ユーザー通話エンティティは、Webex ユーザーが手動で連絡先に追加しない限り、連絡先に追加されません。

次の表は連絡先ソースに対して Webex 連絡先タイプをマッピングします (BroadWorks 電話リストから同期、または手動で追加された)。

表 2. ディレクトリ同期の最大値とソース

Webex 連絡先タイプ

連絡先のソース

最大

BroadWorks から同期...

同期に使用される API

組織連絡先

ディレクトリ同期

500 件の連絡先

エンタープライズ共通電話リスト

/directories/enterprisecommon

グループ共通電話リスト (サービス プロバイダー グループ)**

/directories/groupcommon

ユーザー連絡先

ディレクトリ同期

1.500 件の連絡先

グループ共通電話リスト (エンタープライズ グループ)**

/directories/groupcommon

個人電話リスト

/directories/personal

ユーザーが手動で追加

500 件の連絡先

適用なし

適用なし


**グループ共通電話リストエントリの同期は、BroadWorks が Enterprise Mode または サービス プロバイダー モードの場合によって異なります。 その isBroadWorksEnterprise パラメータの値 (true または false) により、リストの同期方法が決定されます。

  • True—ユーザー連絡先として同期します

  • False—組織連絡先として同期

ディレクトリ同期で連絡先の最大数を処理する際には、次の条件が適用されます。

  • 組織が同期に対して許可される最大連絡先数 (500 人の組織連絡先または 1500 人の同期されたユーザー連絡先) を超える場合、ディレクトリ同期は最大しきい値を超えるエントリを除外します。 同期された連絡先または省略された連絡先には、特定の順序は適用されません。

  • 顧客の 1 人が、いずれかのカテゴリで許可されている連絡先の最大数を超えた場合、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 アクセスを持つパートナー管理者と顧客管理者は、このオプションにアクセスできます。 しかし、Control Hub 経由での連絡先の更新は、Cisco BroadWorks の Webex ではサポートされていません。 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 のはずです) の少なくとも 5 倍に設定する必要があります。
  • トランザクション制限 - 次の値 (XSP_CLI/System/CommunicationUtility/DefaultSettings) を設定します。

    • userTransactionLimits-少なくとも 100 に設定します。

    • transactionLimitPeriodSeconds-1 に設定します。

  • ページング値 - Paging システム プロパティ (XSP_CLI/Applications/Xsi-Actions/Paging) を設定します。

    • defaultPageSize - 50 に設定します

    • availableUserMaxLimit - 100 に設定します

  • CTI インターフェイス - Webex CA 証明書を CTI インターフェイス信頼ストアにアップロードし、CTI インターフェイスでクライアント認証を有効にすることを確認してください。

また、お使いの BroadWorks のリリースによっては、この機能を有効にする前に BroadWorks 展開に以下のシステム パッチを適用することをおすすめします。

ディレクトリ同期の有効化 (新しいテンプレート)

パートナー管理者は、新しいテンプレートの作成中に顧客テンプレートのディレクトリ同期を有効にできます。 このテンプレートに割り当てられた新しい顧客組織ではディレクトリ同期が有効になります。 詳細については、「Partner Hub でパートナー組織を構成する」(『Cisco BroadWorks 版 Webex ソリューション ガイド』) にある「顧客テンプレートを設定する」を参照してください。

次に行うこと

Webex アプリでこの機能を有効にするには、Webex アプリの [連絡先] タブを少なくとも 1 回クリックする必要があることをユーザーに周知する必要があります。 これは 1 回だけ完了する必要があります。

ディレクトリ同期の有効化 (既存のテンプレート)

パートナー管理者は以下の手順を実行することで、既存の顧客テンプレート内でディレクトリ同期をオンにして、テンプレートを使用する顧客組織でこの機能を有効にできます。

1

Partner Hub にサインインし、[設定] を選択します。

2

[BroadWorks Calling] までスクロールし、[テンプレートの表示] をクリックします。

3

適切な顧客テンプレートを選択し、[BroadWorks ディレクトリ同期] までスクロールします。

4

このテンプレートを使用する新しい顧客組織に対して、デフォルトでディレクトリの同期を有効にするには以下を行います。

  1. [すべての新しい顧客組織で BroadWorks ディレクトリと電話リストの同期を有効にする][オン] に切り替えます。

  2. [保存] をクリックします。

5

このテンプレートを使用する既存の顧客組織に対して、ディレクトリ同期を有効にするには以下を行います。

  1. [顧客の同期ステータスのリストを表示する] をクリックします。

  2. 機能を有効にする組織の隣にあるチェックボックスを選択します。

  3. [同期を有効にする] をクリックします。


 

ディレクトリ同期を無効にする場合は、上記の手順を行い、以下を実行します。

  • ステップ 4a で、[すべての新しい顧客組織に対して電話ディレクトリ同期を有効にする][オフ] に設定して、このテンプレートを使用する新しい顧客組織に対して、デフォルトでディレクトリ同期を無効にします。

  • ステップ 5c で、[同期を無効にする] をクリックして、既存の組織の機能をオフにします。

次に行うこと

Webex アプリでこの機能を有効にするには、Webex アプリの [連絡先] タブを少なくとも 1 回クリックする必要があることをユーザーに周知する必要があります。 これは 1 回だけ完了する必要があります。

即時同期の実行

[今すぐ同期] オプションを使用すると、パートナー管理者は特定の顧客組織のオンデマンド同期を実行できます。 このオプションは個々の顧客組織に対してのみ選択することができます。[今すぐ同期] には一括同期オプションがありません。

1

Partner Hub (http://admin.webex.com) にサインインし、[設定] を選択します。

2

[BroadWorks Calling] までスクロールし、[テンプレートの表示] をクリックします。

3

適切な顧客テンプレートを選択し、[BroadWorks ディレクトリ同期] までスクロールします。

4

[顧客の同期ステータスのリストを表示する] をクリックします。

5

同期する顧客組織については、右端の 3 点ドットをクリックし [今すぐ同期] を選択します。

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 Enterprises の下 でグループ化されます

  • List BroadWorks Enterprises - この API メソッドを使用すると、指定されたサービス プロバイダー傘下の企業と各企業の id. プロビジョニングで割り当てられた spEnterpriseId を入力する必要があります。

  • Update Directory Sync for a BroadWorks Enterprise - エンタープライズ id を入力すると、そのenterpriseのディレクトリ同期のステータスを更新し、ディレクトリ同期を有効または無効にします。

  • Trigger Directory Sync for an Enterprise - 特定のエンタープライズ id. また、 syncStatus については、 SYNC_NOW します。

  • Get Directory Sync Status for an Enterprise - エンタープライズ id を入力して実行すると、ステータスと最新の同期の trackingId を取得できます。 また、 trackingID を使用して、Kibana や Grafana などのツールで追加の分析ができます。

さらに、管理者は単一ユーザー API のトリガー ディレクトリ同期を使用して、単一ユーザーのオンデマンド ディレクトリ同期をトリガできます。

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 つのエンタープライズの同期にかかる所要時間はエンタープライズのサイズによって異なります。

1

List BroadWorks Enterprises API を実行して、同期するエンタープライズのリストを生成します。

  1. startWith をエンタープライズまたはサービス プロバイダー識別子の開始文字列に設定します。

  2. [実行] をクリックします。

2

リストの最初のエンタープライズに対して Trigger Directory Sync for an Enterprise API を実行します。

  1. エンタープライズの ID を入力します。

  2. syncStatus を次に設定します: SYNC_NOW

  3. [実行] をクリックします。

    エンタープライズに対して即時同期がトリガーされます。 この同期は、Broadworks の制限ごとの単一のオンデマンド同期に対してカウントされます。
3

数秒待ってから、Get Directory Sync Status API を実行して同期ステータスを取得します。

  1. エンタープライズの ID を入力します。

  2. [実行] をクリックします。

4

同期が終了したら、リストの次のエンタープライズで手順 2 ~ 4 を実行します。 リスト全体を同期するまでこれらの手順を繰り返します。

ディレクトリ同期のエラー コード

ディレクトリ同期には次のエラー コードがあります。

エラーコード

エラーメッセージ

600000

Broadworks 外部ディレクトリユーザーの同期で予期しないエラーが発生しました。

600001

Broadworks 外部ディレクトリ ユーザーの同期が失敗しました。

600002

完了する前に、Broadworks 外部ディレクトリ ユーザーの同期を終了する必要があります。

600003

Broadworks 外部ディレクトリユーザーの同期が部分的に成功しました。 一部の顧客組織で同期に失敗しました。

600004

Broadworks 外部ディレクトリ ユーザーの同期が ConfigSet で有効になっていません。

600005

Broadworks 外部ディレクトリ ユーザーの同期が ConfigSet で進行中です。

600006

Broadworks 外部ディレクトリ ユーザーの同期スレッドがビジーまたはシャットダウンしています。そのため、同期リクエストは承認されません。後でもう一度試してください。

600007

CustomerConfig のアイデンティティ組織が見つかりませんでした。

600008

パートナー組織で CustomerConfig が見つかりませんでした。

600009

CustomerConfig に関連付けられた Broadworks クラスターがビジー状態のため、Broadworks 外部ディレクトリ ユーザーの同期を実行できません

600010

Broadworks クラスターが CustomerConfig に関連付けられていないため、Broadworks 外部ディレクトリ ユーザーの同期を実行できません。

600011

Broadworks 外部ディレクトリ ユーザーの同期が CustomerConfig で有効になっていません。

600012

ハイブリッド ディレクトリの同期が CustomerConfig ですでに有効になっているため、Broadworks 外部ディレクトリ ユーザーの同期を実行できません。

600013

Broadworks 外部ディレクトリ ユーザーの同期で、ID ストアにユーザー アカウントとマシン アカウントを追加できませんでした。

600014

Broadworks クラスターに接続しようとした際に、Broadworks 外部ディレクトリ ユーザーの同期に失敗しました。 Broadworks からのエラー - %s。

600015

Broadworks 外部ディレクトリ ユーザーの同期で、ID ストアに一致するユーザーが見つかりませんでした。

600017

BroadWorks の電話リストの同期ですべてのユーザーとエンタープライズ/組織の連絡先を同期できませんでした。

600018

BroadWorks の電話リストの同期がエンタープライズ/組織のユーザーで失敗しました。

600019

BroadWorks の電話リストの同期でエンタープライズ/組織の連絡先を同期できませんでした。

600020

CustomerConfig同期が進行中であるため、BroadWorks 外部ディレクトリユーザー同期を無効にすることはできません。

600022

BroadWorks 外部ディレクトリの単一ユーザー同期は、エンタープライズにプロビジョニングされたユーザーがいなされていないので、可能ではありません。

600023

BroadWorks 外部ディレクトリの単一ユーザー同期は使用できません。ユーザーはすでにこの組織に存在しています。

600024

BroadWorks に一致するユーザーが見つからないため、BroadWorks 外部ディレクトリの単一ユーザー同期は使用できない。

600025

BroadWorks 外部ディレクトリユーザー同期が CI の更新にユーザーアカウントしました。

600026

BroadWorks 外部ディレクトリユーザー同期が CI のマシンアカウントの更新に失敗しました。

600027

複数のユーザーが BroadWorks に存在していたため、BroadWorks 外部ディレクトリの単一ユーザー同期が利用できない。

600028

BroadWorks 外部ディレクトリの単一ユーザー同期は実行できない。少なくとも 1 つのエンタープライズディレクトリ同期が完了している必要があるからです。

600029

BroadWorks 外部ディレクトリユーザー同期に失敗しました。エンタープライズにはプロビジョニングされたユーザーがいなであるためです。

変更履歴

次の表は、この記事の更新情報の要約です。

日付

リビジョン

2022 年 7 月 19 日

概要情報の明確化と修正:

  • 関連する 異なる同期と Webex ディレクトリの更新方法を明確にするために、ディレクトリ同期の概要を更新しました。

  • BroadWorks の電話リストと連絡先の最大数を更新し 、電話リストだけが連絡先と同期されるということです。

  • アップデートの修正 を行 い、Webex アプリが更新された記録を表示するのにかかる時間を明確にします。

2022 年 5 月 9 日

  • ディレクトリ 同期の概要で、ディレクトリ同期の最大値とソース表 の下のメモを修正 しました。 また、プロビジョニングに関するフローに関するメモも更新しました。

  • 文法的な編集と修正

2022 年 4 月 7 日

  • コントロール ハブで組織レベルの 連絡先編集 を適用する制限に関して、ディレクトリ同期概要の更新セクションにメモを追加しました。

2022 年 3 月 28 日

  • [ディレクトリ同期を有効にする (新しいテンプレート) の下で 、欠落したコンテンツを再挿入しました

  • 同期最大数に関する情報を追加しました。 同じクラスターから 1 つのスケジュールされた同期と 1 つの API 同期を同時に実行できます。

  • 単一ユーザー API の トリガー ディレクトリ同期に関する情報を追加 しました。

2022 年 3 月 24 日

同期された電話番号タイプのリストをディレクトリ同期条件 に追加しました。 同期には携帯電話番号が含まれます。

2022 年 3 月 16 日

  • 新しいエラーコードが追加されました。

  • Web 検索からの使いやすさを向上向上した紹介文を追加しました。

2021 年 12 月 17 日

  • TOCの欠落に関する問題を修正するためのマイナーな構造的な編集。

2021 年 12 月 16 日

  • 記事を更新し、ユーザー連絡先の最大値が増加しました。

2021 年 12 月 8 日

  • ディレクトリ同期と連絡先 の最大数のセクションを 追加して、ディレクトリ同期が組織とユーザーの連絡先の最大数を導き出す方法を明確にします。

  • ディレクトリ同期のエラー コード」表の書式設定を変更し、読みやすくしました。