ディレクトリ同期の概要

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

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にオンボーディング済み

ディレクトリ同期

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

電話会議室の電話、FAX、ハント グループ番号など

ディレクトリ同期

BroadWorks の電話リスト

BroadWorks 電話リストのエントリ:

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

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

  • 個人電話リスト

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


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

ディレクトリ同期の条件

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

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

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

  • BroadWorks クラスタあたりの同時同期の最大数は 2 です。 1 つはスケジュールされた同期で、もう 1 つはオンデマンド同期 ( APIまたは Partner Hub GUI 経由) です。 ただし、管理者は、同じ BroadWorks から同時に 2 つのオンデマンド同期を実行できません。 この制限は、同期がAPI経由で開始されたか、今すぐ同期オプションを追加することができます。 また、 Webexはスケジュール2 つの同期が同じ BroadWorks から同時に実行されることはありません。

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

  • 同期では電話番号を持たないユーザーが無視されます。

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

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

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

    • 代表電話番号

    • 携帯電話番号

    • Extension

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


    BroadWorks ユーザー レベルプライバシーサービスの設定は、ディレクトリ同期の一部としてはサポートされていません。

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

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

  • 組織の連絡先- Webexは組織に対してこれらの連絡先を保存します。 各ユーザは、所属する組織の組織連絡先にアクセスできます。 最大には、最大 30,000 件の連絡先があります。

  • ユーザーの連絡先- Webexはユーザーに対してこれらの連絡先を保存します。 連絡先を所有するユーザのみが、連絡先エントリにアクセスできます。 最大は 2,000 件の連絡先です (同期された連絡先 1,500 件 + 手動入力の連絡先 500 件)。


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

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

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

Webex 連絡先タイプ

連絡先のソース

最大

BroadWorks から同期...

同期に使用される API

組織連絡先

ディレクトリ同期

30000 件の連絡先

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

/directories/enterprisecommon

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

/directories/groupcommon

ユーザー連絡先

ディレクトリ同期

1.500 件の連絡先

個人電話リスト

/directories/personal

ユーザにより手動で追加

500 件の連絡先

適用なし

適用なし

グループ連絡先

ディレクトリ同期

グループあたり 30000 件の連絡先

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

/directories/groupcommon

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

  • True - グループ連絡先として同期

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

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

  • 組織が同期で許可されている連絡先の最大数 (1 つのグループにつき 3 万の組織連絡先または 3 万のグループ共通連絡先) を超えた場合、ディレクトリ同期は最大しきい値を超えるエントリを除外します。 同期される連絡先と除外される連絡先に特定の順番は適用されません。

  • いずれかのカテゴリで許可された最大数を超える連絡先を持つ顧客がいる場合、 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 へのアクセス権を持つパートナー管理者と顧客管理者は、このオプションにアクセスできます。 ただし、Control Hub 経由での連絡先の更新は、 Webex for Cisco BroadWorks ではサポートされていません。 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 エンタープライズ

  • 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 を使用して複数のエンタープライズのディレクトリ同期をトリガーするには、この手順を実行します。

  • ディレクトリ同期では、Broadworks クラスタからオンデマンド同期で一度に 1 つのエンタープライズのみ同期できます。 複数のエンタープライズを同期しようとすると、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 の制限ごとの 1 回のオンデマンド同期にカウントされます。
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

少なくとも 1 回の企業ディレクトリの同期が完了している必要があるため、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 日

  • 追加されたセクションディレクトリの同期と連絡先の最大数ディレクトリ同期で組織とユーザーの連絡先の最大数を取得する方法を明確化。

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