ディレクトリ同期の概要

ディレクトリを同期することで、Cisco BroadWorks 版 Webex のユーザーは Webex ディレクトリを使用して、BroadWorks サーバーから任意の通話エンティティに発信できるようになります。 この機能を有効にすると、BroadWorks サーバーからの完全な通話ディレクトリが Webex ディレクトリに同期されます。 ユーザーは Webex アプリからディレクトリにアクセスし、BroadWorks サーバーから任意の通話エンティティに発信できます。

ディレクトリ同期には、ユーザーの通話情報だけでなく電話リストの同期も含まれます。 同期された電話リストの記録は、Webex ディレクトリ内の 2 つの連絡先タイプの 1 つに書き込まれます。

  • 組織の連絡先: これらの連絡先は組織単位で保存され、組織内のすべてのユーザーが使用できます。

  • ユーザーの連絡先: これらの連絡先はユーザー単位で保存され、連絡先を所有するユーザーだけが使用できます。


Cisco BroadWorks 版 Webex のプロビジョニングには、メッセージング ユーザーとそれに関連する通話情報の、BroadWorks サーバーから Webex ディレクトリへのデフォルト同期が含まれます。 ただし、デフォルトのプロビジョニング同期では、非メッセージング ユーザーと非ユーザー エンティティ (例えば、会議室の電話、FAX、またはハント グループ番号) は対象になりません。 ディレクトリ同期を有効にすることで、すべての通話エンティティが Webex ディレクトリに確実に追加されるようになります。

ディレクトリ同期の条件

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

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

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

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

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

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

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

  • この機能では、BroadWorks サーバーの以下の電話リスト タイプが同期されます。

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

    • グループ共通電話リスト

    • 個人電話リスト

ディレクトリの同期と連絡先の最大数

Webex 連絡先タイプごとに、ディレクトリ同期が可能な最大数は次のとおりです。

  • 500 の組織連絡先

  • 500 のユーザー連絡先 - ユーザーの場合、最大数には同期されるユーザー連絡先と手動連絡先 (Webex アプリ経由でユーザーが手動で追加する連絡先) が含まれます

次の条件が適用されます。

  • どちらかのカテゴリに 500 以上の連絡先がある組織の場合、同期では上限の 500 を超えるエントリは除外されます。 同期される連絡先と除外される連絡先に特定の順番は適用されません。

  • ユーザーが Webex アプリを使って手動で連絡先を追加すると、ユーザー連絡先の最大数は、同期されるユーザーの連絡先から手動の連絡先を差し引くことで決まります。 例えば、Webex アプリでユーザーが 100 人の連絡先を手動で追加したとすると、ディレクトリ同期により、BroadWorks から最大 400 ユーザーの連絡先がそのユーザーに同期されます。

  • 顧客の組織の 1 つがいずれかのカテゴリで 500 以上の連絡先を持っている場合、Cisco に対してケースを開き、その組織をディレクトリ同期から除外するよう要請することをおすすめします。

次の表は Webex 連絡先タイプと、レコードの同期元となる BroadWorks 電話リストの対応関係を示しています。

表 1. ディレクトリ同期連絡先のタイプと同期ソース

Webex 連絡先タイプ

BroadWorks から同期...

同期に使用される API

組織連絡先

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

/directories/enterprisecommon

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

/directories/groupcommon

ユーザー連絡先

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

/directories/groupcommon

個人電話リスト

/directories/personal


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

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

  • False - ユーザー連絡先として同期

更新情報

BroadWorks で連絡先が更新されると、ユーザーの Webex アプリに更新が表示される際に次の情報が表示されます。

  • ユーザーがアプリを再起動した後、またはアプリのローカルの 72 時間キャッシュ タイマーが期限切れになった後、組織の連絡先の更新が Webex アプリに表示されます。

  • ユーザーの連絡先の更新は、そのユーザーの Webex アプリに即座に表示されます。

Webex ディレクトリにおける更新の処理方法は次のとおりです。

  • BroadWorks で連絡先名が変更されると、既存の連絡先が Webex ディレクトリから削除され、新しい連絡先が作成されます。

  • BroadWorks で連絡先番号が変更されると、Webex ディレクトリの既存の連絡先が新しい番号で更新されます。

ディレクトリ同期の前提条件

トグルの要件

この機能には次のフィーチャー トグルがあります。 これらを設定するには、Cisco BroadWorks 版 Webex 担当者に連絡してください。

フィーチャー トグル

適用先

説明

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 - 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 のエンタープライズ」にまとめられています。 以下 4 つの API があります。

  • 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 の詳細なドキュメントについては、https://developer.webex.com/docs/api/guides/webex-for-broadworks-developers-guide を参照してください。

https://developer.webex.com/docs/api/v1/broadworks-subscribers の API 仕様を読むには、サインインが必要です。

API による複数のエンタープライズの同期

公開 API を使用して複数のエンタープライズでディレクトリ同期を実行するには、この手順を実行します。

  • ディレクトリ同期で同期できるエンタープライズは一度に 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. [実行] をクリックします。

    エンタープライズに対して即時同期がトリガーされます。 この同期は、インスタンス 1 つあたりの制限の 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 の電話リストの同期でエンタープライズ/組織の連絡先を同期できませんでした。