ディレクトリ同期の概要

ディレクトリ同期により、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 ソリューション ガイド』を参照してください。

ディレクトリ同期の条件

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

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

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

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

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

  • 同期は、電話番号を持たないユーザーを無視します。

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

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

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

    • 代表電話番号

    • 携帯電話番号

    • Extension

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

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

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

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

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

  • ユーザー連絡先—Webex はこれらの連絡先をユーザーに対して保存します。 連絡先を所有しているユーザーのみが連絡先エントリにアクセスできます。 最大 2000 件の連絡先 (同期された連絡先 1500 件 + 手動入力連絡先 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:組織の連絡先として同期

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

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

  • 顧客の 1 人がいずれかのカテゴリの最大許容連絡先数を超える場合、その組織をディレクトリ同期から除外するように Cisco にケースを提起することを推奨します。

  • 手動連絡先は、ユーザーが Webex アプリに手動で追加する連絡先です。 ユーザーは手動連絡先を最大 500 件追加できます。 手動連絡先は、Webex の大きなユーザー連絡先カテゴリに含まれますが、同期には含まれません。

  • 組織連絡先(30000)とグループ連絡先(1グループあたり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 経由の連絡先の更新は、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 展開に以下のシステム パッチを適用することをおすすめします。

Cisco BroadWorks 版 Webex の最小要件を満たすパッチ要件の完全なリストについては、「BroadWorks のソフトウェア要件」を『Cisco BroadWorks 版 Webex ソリューション ガイド』で参照してください。

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

パートナー管理者は、新しいテンプレートの作成中に顧客テンプレートのディレクトリ同期を有効にできます。 このテンプレートに割り当てられた新しい顧客組織ではディレクトリ同期が有効になります。 詳細については、「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 などのツールで追加の分析ができます。

さらに、管理者はTrigger Directory Sync for a Single User APIを使用して、1 人のユーザーのオンデマンドディレクトリ同期をトリガーできます。

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

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 を実行します。 リスト全体を同期するまでこれらの手順を繰り返します。

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

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

エラーコード

エラーメッセージ

600000000

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

小惑星の一覧

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

60000000

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

60000000

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

60000000

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

60000000

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

600000000

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

60000000

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

60000000

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

60000000

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

600010 日

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

600000について

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 月 09 日

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

  • 文法の編集と修正

2022 年 4 月 07 日。

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

2022 年 3 月 28 日

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

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

  • 単一ユーザ API の Trigger Directory Sync に関する情報を追加しました。

2022 年 3 月 24 日

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

2022 年 3 月 16 日

  • 新しいエラー コードを追加しました。

  • Web検索からユーザビリティを向上させるための入門説明文を追加しました。

2021 年 12 月 17 日

  • TOCが欠落している問題を修正するための小さな構造編集。

2021 年 12 月 16 日

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

2021 年 12 月 8 日

  • 組織とユーザの連絡先の最大数をディレクトリ同期がどのように導き出すかを明確にするため、「ディレクトリ同期と連絡先の最大数」セクションを追加しました。

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