Обзор синхронизации каталогов

Синхронизация каталогов обеспечивает пользователям Webex для Cisco BroadWorks возможность использования каталога Webex для вызова любого объекта, поддерживающего функции вызовов, с сервера BroadWorks. Когда эта функция включена, полный каталог вызовов с сервера BroadWorks синхронизируется с каталогом Webex. Пользователи могут получить доступ к каталогу из приложения Webex и совершить вызов любому объекту, поддерживающему функции вызовов, с сервера BroadWorks.

Синхронизация каталогов включает синхронизацию как информации о вызовах пользователя, так и списков телефонов. Синхронизированные записи списков телефонов записываются в один из двух типов контактов в каталоге Webex.

  • Контакты организации: эти контакты хранятся на уровне организации и доступны всем пользователям в организации.

  • Контакты пользователя: эти контакты хранятся на уровне пользователя и доступны только пользователю, который является владельцем контакта.


Подготовка Webex для Cisco BroadWorks включает синхронизацию по умолчанию пользователей обмена сообщениями и связанной с ними информации о вызовах на сервере BroadWorks с каталогом Webex. Однако синхронизация подготовки по умолчанию не учитывает пользователей, для которых не включена функция обмена сообщениями, а также объекты, не являющиеся пользователями (например, телефон в комнате для совещаний, факс или номер сервисной группы). Включение синхронизации каталогов гарантирует, что все объекты, поддерживающие функции вызовов, будут добавлены в каталог Webex.

Условия синхронизации каталогов

  • Администраторы партнеров должны включить эту функцию на уровне партнера. Администраторы партнеров могут включить или выключить эту функцию для нескольких клиентских организаций с помощью одной операции.

  • По умолчанию начальная синхронизация осуществляется через неделю после включения синхронизации (время для запуска синхронизации выбирается случайным образом). Однако для обхода недельного периода ожидания и выполнения немедленной синхронизации определенной клиентской организации клиентскими организациями может использоваться параметр Синхронизировать сейчас.

  • По умолчанию синхронизация каталогов запускается еженедельно для каждого клиента. Каждая синхронизация происходит через неделю после последней синхронизации, независимо от того, была ли эта синхронизация запланирована или инициирована вручную с помощью параметра Синхронизировать сейчас.

  • В случае сбоя синхронизации каждые 24 часа происходит автоматическая повторная попытка синхронизации до следующей запланированной синхронизации.

  • При синхронизации будут игнорироваться пользователи, у которых нет номера телефона.

  • В центре партнера можно просмотреть информацию о состоянии синхронизации для определенного клиента. Кроме того, можно экспортировать подробную информацию о последней синхронизации, выполнив запись в формате CSV. Запись в формате CSV является более подробной, чем данные, отображающиеся в Control Hub, и может помочь при устранении неполадок, анализе и аудите.

  • Контакты пользователя хранятся в зашифрованном формате. Ключ дешифрования доступен только пользователю, которому принадлежит контакт.

  • Эта функция синхронизирует перечисленные ниже типы списков телефонов на сервере BroadWorks.

    • Общие списки телефонов предприятия

    • Общие списки телефонов группы

    • Личные списки телефонов

Синхронизация каталогов и максимальное количество контактов

Ниже приведено максимальное количество контактов, допустимых функцией синхронизации каталогов для каждого типа контактов Webex.

  • 500 контактов организации

  • 500 контактов пользователя – максимальное количество контактов пользователя, синхронизированных и созданных вручную (контакты, добавленные пользователем вручную с помощью приложения Webex).

Применяются приведенные ниже ограничения.

  • Если в организации более 500 контактов в каждой из категорий, записи свыше ограничения будут исключены. К синхронизированным и пропущенным контактам не применяется какой-либо порядок.

  • Если пользователь добавляет контакты вручную в приложение Webex, максимальное количество контактов пользователя определяется вычитанием созданных вручную контактов пользователя из синхронизированных контактов пользователя. Например, если пользователь добавляет вручную 100 контактов в приложении Webex, синхронизация каталогов позволяет синхронизировать до 400 контактов пользователя из BroadWorks для этого пользователя.

  • Если в одной из ваших клиентских организаций более 500 контактов в какой-либо категории, рекомендуем обратиться в Cisco с запросом исключить эту организацию из синхронизации каталогов.

В таблице ниже сопоставлены типы контактов Webex со списком телефонов BroadWorks, из которого синхронизируются записи.

Таблица 1. Типы контактов и источник синхронизации для синхронизации каталогов

Тип контакта Webex

Синхронизировано из BroadWorks...

API синхронизации

Контакты организации

Общие списки телефонов предприятия

/directories/enterprisecommon

Общие списки телефонов группы (в режиме поставщика услуг)**

/directories/groupcommon

Контакты пользователя

Общие списки телефонов группы (в корпоративном режиме)**

/directories/groupcommon

Личные списки телефонов

/directories/personal


** Общие списки телефонов группы синхронизируются по-разному в зависимости от режима BroadWorks (корпоративный режим или режим поставщика услуг). Значение isBroadWorksEnterprise параметра (истина или ложь) определяет способ синхронизации списка.

  • Истина: синхронизировать как контакт организации.

  • Ложь: синхронизировать как контакт пользователя.

Обновления

После обновления контакта в BroadWorks отображение обновления в приложении Webex пользователя будет реализовано по приведенной ниже схеме.

  • Обновления контактов организации отображаются в приложении Webex после перезапуска приложения пользователем или по истечении 72-часового локального таймера кэша приложения.

  • Обновления контактов пользователя для этого пользователя отображаются в приложении Webex немедленно.

Ниже приведены условия обработки обновлений каталогом Webex.

  • Если имя контакта изменяется в BroadWorks, существующий контакт удаляется из каталога Webex и создается новый контакт.

  • При изменении номера контакта в BroadWorks существующий контакт в каталоге Webex будет обновлен с использованием нового номера.

Предварительные требования для синхронизации каталогов

Требования к переключателю

Для этой функции существуют приведенные ниже переключатели функций. Для их настройки обратитесь к своему представителю службы Webex для 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).
  • Значения ограничения скорости: задайте следующие свойства системы для управления устранением перегрузки (XSP_CLI/Applications/Xsi-Actions/OverloadControl):

    • userDirectoryTransactionLimit — Установите значение «null».

    • globalDirectoryTransactionLimit — Установите значение «null».


    Рекомендуется установить userDirectoryTransactionLimit и globalDirectoryTransactionLimit на нулевое значение. Но если вы решите установить значения, каждое из них должно быть как минимум в пять раз больше значения transactionLimitPeriodSecond (которое должно быть равным 1).
  • Ограничения транзакций – задайте следующие значения (XSP_CLI/System/CommunicationUtility/DefaultSettings):

    • userTransactionLimits – установите значение не менее "100".

    • transactionLimitPeriodSeconds – установите значение "1".

  • Значения пейджинга – задайте свойства системы пейджинга (XSP_CLI/Applications/Xsi-Actions/Paging):

    • defaultPageSize – Значение «50»

    • availableUserMaxLimit – Значение «100»

  • Интерфейс CTI — Убедитесь в том, что вы загрузили сертификаты Webex CA в trust store интерфейса CTI и в том, что вы включили аутентификацию клиента в интерфейсе CTI.

Кроме того, в зависимости от выпуска BroadWorks, рекомендуется применить указанные далее системные исправления к развертыванию BroadWorks перед тем, как включить эту функцию.


Полный список требований к исправлениям, которые образуют минимальные требования к Webex для Cisco BroadWorks, см. в разделе Требования BroadWorks к программному обеспечению в руководстве по решению Webex для Cisco BroadWorks.

Включение синхронизации каталогов (новый шаблон)

Администраторы партнеров могут включить функцию синхронизации каталогов для шаблона клиента при создании нового шаблона. Для всех новых клиентских организаций, которые назначены этому шаблону, будет включена синхронизация каталогов. Подробности см. в разделе "Настройка шаблонов клиентов" раздела Настройка партнерской организации в центре партнера в руководстве по решению Webex для Cisco BroadWorks.

Дальнейшие действия

Не забудьте проинформировать пользователей о том, что для включения этой функции в приложении Webex необходимо хотя бы один раз перейти на вкладку Контакты в приложении Webex. Это действие необходимо выполнить только один раз.

Включение синхронизации каталогов (существующий шаблон)

Администраторы партнеров могут выполнить приведенные ниже шаги для включения синхронизации каталогов в существующем шаблоне клиента, чтобы включить функцию для клиентских организаций, которые используют этот шаблон.

1

Войдите в центр партнера и щелкните Настройки.

2

Прокрутите страницу до раздела Вызовы BroadWorks и щелкните Просмотр шаблонов.

3

Выберите соответствующий шаблон клиента и прокрутите страницу до раздела Синхронизация каталога BroadWorks.

4

Чтобы включить синхронизацию каталогов по умолчанию для новых клиентских организаций, использующих этот шаблон, выполните указанные ниже действия.

  1. Установите переключатель Включить синхронизацию каталога BroadWorks и списка телефонов для всех новых организаций клиента в положение Включено.

  2. Щелкните Сохранить.

5

Чтобы включить синхронизацию каталогов для существующих клиентских организаций, использующих этот шаблон, выполните указанные ниже действия.

  1. Щелкните Показать список состояний синхронизации клиентов.

  2. Установите флажки для каждой организации, для которой необходимо включить эту функцию.

  3. Щелкните Включить синхронизацию.


 

Чтобы отключить синхронизацию каталогов, выполните описанную выше процедуру с учетом указанного ниже.

  • На этапе 4a установите переключатель Включить синхронизацию телефонного справочника для всех новых организаций клиента в положение Выключено, чтобы отключить синхронизацию каталогов по умолчанию для новых клиентских организаций, которые используют этот шаблон.

  • На этапе 5c щелкните Отключить синхронизацию, чтобы отключить эту функцию для существующих организаций.

Дальнейшие действия

Не забудьте проинформировать пользователей о том, что для включения этой функции в приложении Webex необходимо хотя бы один раз перейти на вкладку Контакты в приложении Webex. Это действие необходимо выполнить только один раз.

Выполнение немедленной синхронизации

С помощью параметра Синхронизировать сейчас администраторы партнеров могут выполнить синхронизацию по запросу для определенной клиентской организации. Этот параметр можно выбрать только для отдельных клиентских организаций. В настоящий момент отсутствует параметр для выполнения массовой синхронизации.

1

Войдите в центр партнера (http://admin.webex.com) и щелкните Настройки.

2

Прокрутите страницу до раздела Вызовы BroadWorks и щелкните Просмотр шаблонов.

3

Выберите соответствующий шаблон клиента и прокрутите страницу до раздела Синхронизация каталога BroadWorks.

4

Щелкните Показать список состояний синхронизации клиентов.

5

Для клиентской организации, которую необходимо синхронизировать, щелкните троеточие справа и выберите Синхронизировать сейчас.

6

Чтобы отобразить результат синхронизации, щелкните Обновить.

Экспорт записей синхронизации в файл CSV

Администраторы партнеров могут экспортировать подробную информацию о последней синхронизации в файл CSV. Файл CSV содержит более подробные сведения о записи синхронизации, чем интерфейс пользователя в Control Hub, и может помочь при устранении неполадок и анализе.

1

Войдите в центр партнера (http://admin.webex.com) и щелкните Настройки.

2

Прокрутите страницу до раздела Вызовы BroadWorks и щелкните Просмотр шаблонов.

3

Выберите соответствующий шаблон клиента и прокрутите страницу до раздела Синхронизация каталога BroadWorks.

4

Щелкните Показать список состояний синхронизации клиентов.

5

Установите флажки для каждой организации, которую необходимо включить в экспорт.

6

Щелкните Результаты экспорта.

Общедоступные API для синхронизации каталогов

Общедоступные API размещены на веб-сайте developer.webex.com. С их помощью администраторы партнеров могут обновлять настройки синхронизации каталогов для клиентских организаций, которыми они управляют, запускать немедленную синхронизацию или получать информацию о состоянии синхронизации. Методы синхронизации каталогов сгруппированы в разделе Предприятия BroadWorks. Доступны четыре API.

  • List BroadWorks Enterprises (Перечисление предприятий BroadWorks). Используйте этот метод API для получения списка предприятий у определенного поставщика услуг, а также отображения для каждого предприятия его id. Необходимо ввести значение spEnterpriseId, назначенное при подготовке.

  • Update Directory Sync for a BroadWorks Enterprise (Обновление синхронизации каталогов для предприятия BroadWorks). Введите id предприятия, чтобы обновить состояние синхронизации каталога для этого предприятия, включая или отключая синхронизацию каталогов.

  • Trigger Directory Sync for an Enterprise (Запуск синхронизации каталогов для предприятия). Используйте этот метод API, чтобы инициировать немедленную синхронизацию для определенного 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.

Чтобы ознакомиться с спецификацией API, необходимо войти в https://developer.webex.com/docs/api/v1/broadworks-subscribers.

Синхронизация нескольких предприятий с помощью API

Выполните эту процедуру, чтобы использовать общедоступные API для выполнения синхронизации каталогов для нескольких предприятий.

  • Функция синхронизации каталогов позволяет синхронизировать одновременно только одно предприятие. При попытке синхронизировать несколько предприятий будет возвращена ошибка 429.

  • Время, которое требуется для выполнения синхронизации одного предприятия, зависит от размера предприятия.

1

Запустите API List BroadWorks Enterprises (Перечисление предприятий BroadWorks), чтобы создать список предприятий, которые необходимо синхронизировать.

  1. Для параметра startWith установите значение, соответствующее начальной строке идентификатора предприятия или поставщика услуг.

  2. Нажмите кнопку Запуск.

2

Запустите API Trigger Directory Sync for an Enterprise (Запуск синхронизации каталогов для предприятия) на первом предприятии в списке.

  1. Введите идентификатор предприятия.

  2. Для параметра syncStatus задайте значение SYNC_NOW

  3. Нажмите кнопку Запуск.

    Для предприятия будет запущена немедленная синхронизация. Эта синхронизация учитывается в рамках ограничения одной синхронизации для каждого экземпляра.
3

Подождите несколько секунд и запустите API Get Directory Sync Status (Получение данных о состоянии синхронизации каталогов для предприятия), чтобы получить сведения о состоянии синхронизации.

  1. Введите идентификатор предприятия

  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

Невозможно запустить синхронизацию пользователей внешнего каталога Broadworks, поскольку кластер Broadworks, связанный с CustomerConfig, занят.

600010

Не удается запустить синхронизацию пользователей внешнего каталога Broadworks, поскольку отсутствует кластер BroadWorks, связанный с CustomerConfig.

600011

Синхронизация пользователей внешнего каталога Broadworks не включена для CustomerConfig.

600012

Не удается запустить синхронизацию пользователей внешнего каталога Broadworks, поскольку синхронизация каталогов гибридного типа уже включена для CustomerConfig.

600013

Во время синхронизации пользователей внешнего каталога Broadworks не удалось добавить учетные записи пользователей и компьютеров в хранилище удостоверений.

600014

Ошибка синхронизации пользователей внешнего каталога Broadworks при попытке подключения к кластеру Broadworks. Ошибка Broadworks: %s.

600015

При синхронизации пользователей внешнего каталога Broadworks не найдены соответствующие пользователи в хранилище удостоверений.

600017

При синхронизации списка телефонов BroadWorks не удалось синхронизировать все контакты пользователя и предприятия/организации.

600018

Синхронизация списка телефонов BroadWorks не удалась для пользователей в предприятии/организации.

600019

При синхронизации списка телефонов BroadWorks не удалось синхронизировать контакты предприятия/организации.