Visão geral da sincronização de diretórios

A sincronização de diretórios garante que os usuários Webex para Cisco BroadWorks possam usar o diretório Webex do aplicativo Webex para ligar para qualquer entidade de chamada do servidor BroadWorks. Esse recurso sincroniza as informações de chamada do BroadWorks que não faziam parte do provisionamento do usuário para o diretório Webex.

O provisionamento de usuários do Webex para Cisco BroadWorks atualiza o diretório Webex com detalhes de chamadas para Webex para usuários do Cisco BroadWorks (número de telefone principal, número de telefone celular, ramal), mas omite registros de chamadas externas. No entanto, quando a sincronização de diretórios está ativada, o recurso também sincroniza os seguintes registros de chamadas no diretório Webex.

  • Usuários de chamadas somente BroadWorks (que não estão integrados ao Webex)

  • Entidades de chamadas não pertencentes ao usuário (por exemplo, um telefone de sala de conferência, aparelho de fax, número de grupo de busca)

  • Entradas da Lista de Telefones BroadWorks

A tabela a seguir resume os registros de chamadas do BroadWorks e mostra como eles são adicionados ao diretório Webex.

Tabela 1. Atualizações de sincronização de diretórios no diretório Webex

Registros de chamadas BroadWorks

Descrição

Adicionado ao diretório Webex via...

Webex para usuários do Cisco BroadWorks

Os usuários estão habilitados para o Webex para Cisco BroadWorks

Provisionamento do usuário (por exemplo, provisionamento fluido)

Usuários de chamada somente BroadWorks

Usuários de chamadas que não estão integrados ao Webex

Sincronização de diretórios

Entidades de chamadas não pertencentes ao usuário

Por exemplo, um telefone de sala de conferência, aparelho de fax, número do grupo de busca

Sincronização de diretórios

Listas de telefones BroadWorks

Entradas da lista de telefones BroadWorks:

  • Listas de telefones comuns empresariais

  • Listas de telefones comuns de grupo (grupos de provedores de serviços ou grupos empresariais)

  • Listas de telefones pessoais

Sincronização de diretórios (sincronização da lista de telefones)

Para obter mais detalhes sobre o provisionamento de usuários, consulte o Guia de soluções Webex para Cisco BroadWorks .

Condições de sincronização de diretório

  • Os administradores de parceiros devem habilitar o recurso no nível de parceiro. Os administradores de parceiros podem ativar ou desativar o recurso para várias organizações de clientes em uma única operação.

  • Por padrão, a sincronização inicial ocorre uma semana após a habilitação da sincronização (a hora escolhida para iniciar a sincronização é aleatória). No entanto, as organizações de clientes podem usar a opção Sincronizar agora para ignorar o período de espera de uma semana e acionar uma sincronização imediata para uma determinada organização do cliente.

  • Por padrão, a Sincronização de diretórios é executada semanalmente para cada cliente. Cada sincronização ocorre uma semana após a última sincronização, independentemente de a última sincronização ter sido agendada ou acionada manualmente com Sync Now .

  • O número máximo de sincronizações simultâneas por grupo BroadWorks é dois: uma sincronização agendada e uma sincronização sob demanda (por meio da API ou GUI do Hub de parceiros). No entanto, os administradores não podem executar duas sincronizações sob demanda ao mesmo tempo do mesmo BroadWorks. Essa restrição existe independentemente de a sincronização ter sido iniciada por meio da API ou da opção Sincronizar agora no Partner Hub. Além disso, o Webex não agendará duas sincronizações agendadas para execução ao mesmo tempo do mesmo BroadWorks.

  • Se ocorrer uma falha na sincronização, o Webex tentará novamente a sincronização automaticamente a cada 24 horas até a próxima sincronização agendada.

  • A sincronização ignora os usuários que não têm um número de telefone.

  • No Partner Hub, você pode visualizar as informações de status de sincronização de um determinado cliente. Além disso, você pode exportar informações detalhadas sobre a última sincronização para um registro CSV. O registro CSV fornece mais detalhes do que a exibição do Control Hub e pode ajudar na solução de problemas, análise e auditoria.

  • O Webex armazena contatos do usuário em um formato criptografado. Somente o usuário que possui o contato tem acesso à chave de decodificação.

  • Para usuários de chamadas somente BroadWorks e entidades de chamadas que não sejam usuários, esse recurso sincroniza os seguintes tipos de números de telefone do BroadWorks:

    • Número de telefone principal

    • Número do Celular

    • Ramal

    No entanto, a sincronização excluirá usuários de chamadas somente BroadWorks e entidades de chamadas que não sejam usuários da sincronização se nenhum número de telefone ou ramal principal estiver presente.

    A configuração do serviço de privacidade no nível do usuário do BroadWorks não é suportada como parte da sincronização de diretórios.

Lista de telefones BroadWorks e Maximums de contato

A sincronização de diretórios também sincroniza as entradas da lista de telefones do BroadWorks com os Contatos Webex. As entradas sincronizadas são adicionadas a um dos seguintes tipos de contato:

  • Contatos da organização — o Webex armazena esses contatos em uma organização. Cada usuário pode acessar os contatos da organização para sua organização. O máximo é de até 30000 contatos.

  • Contatos do usuário — o Webex armazena esses contatos com um usuário. Somente o usuário que possui o contato poderá acessar a entrada do contato. O máximo é de até 2000 contatos (1500 contatos sincronizados + 500 contatos de entrada manual).

Apenas as entradas da Lista de telefones são adicionadas aos contatos Webex. Os usuários de chamadas somente BroadWorks e as entidades de chamadas que não são incluídas na sincronização de diretórios não são adicionados a Contatos, a menos que um usuário Webex os adicione aos Contatos manualmente.

A tabela a seguir mapeia os tipos de contato Webex em relação à fonte de contato (sincronizada de uma lista telefônica BroadWorks ou adicionada manualmente):

Tabela 2. Maximums e origem da sincronização de diretórios

Tipo de contato Webex

Origem do Contato

Máximo

Sincronizado do BroadWorks...

API usada para sincronização

Contatos da organização

Sincronização de diretórios

30000 contatos

Listas de telefones comuns empresariais

/directories/enterprisecommon

Listas de telefones comuns de grupo (para um grupo de provedores de serviços)**

/directories/groupcommon

Contatos do usuário

Sincronização de diretórios

1500 contatos

Listas de telefones pessoais

/directories/personal

Adicionado manualmente pelo usuário

500 contatos

N/D

N/D

Contatos do grupo

Sincronização de diretórios

30000 contatos por grupo

Listas de telefones comuns de grupo (para um grupo empresarial)**

/directories/groupcommon

**As entradas das listas de telefones comuns do grupo são sincronizadas de forma diferente, dependendo se o BroadWorks está no modo Empresarial ou no modo provedor de serviços. O valor do isBroadWorksEnterprise parâmetro (verdadeiro ou falso) determina como a lista é sincronizada:

  • Verdadeiro — Sincronizar como contato do grupo

  • Falso — Sincronizar como contato da organização

As seguintes condições se aplicam à maneira como a Sincronização de diretórios lida com os máximos de contato:

  • Se uma organização exceder o número máximo permitido de contatos para a sincronização (contatos da organização 30000 ou contatos comuns do grupo 30000 por grupo), a sincronização de diretórios excluirá entradas acima do limite máximo. Não há nenhuma ordem específica aplicada a contatos sincronizados ou omitidos.

  • Se um de seus clientes exceder o número máximo permitido de contatos em qualquer categoria, recomendamos que você crie um caso com a Cisco para que essa organização seja excluída da sincronização de diretórios.

  • Contatos manuais são contatos que um usuário adiciona manualmente no aplicativo Webex. Um usuário pode adicionar até 500 contatos manuais. Os contatos manuais se enquadram na categoria de Contatos do usuário maior no Webex, mas não estão incluídos na sincronização.

  • O limite total combinado para contatos da organização (30000) e contatos de grupo (30000 por grupo) é de 200000.

Atualizações

Veja a seguir como o diretório Webex lida com as atualizações:

  • Se o nome do contato mudar no BroadWorks, o contato existente será excluído do diretório Webex e um novo contato será criado.

  • Se o número de contato mudar no BroadWorks, o Webex atualizará o contato existente no diretório Webex com o novo número.

Depois que um administrador atualiza um contato no BroadWorks, as seguintes condições descrevem quando a atualização é exibida no aplicativo Webex de um usuário:

  • Se a atualização for para um usuário de chamadas somente BroadWorks ou para uma entidade de chamadas que não seja do usuário, a atualização será exibida no aplicativo Webex de um usuário imediatamente após a sincronização de diretório subsequente.

  • Se a atualização for para uma entrada de lista telefônica do BroadWorks:

    • Para contatos do usuário—As atualizações são exibidas no aplicativo Webex do usuário imediatamente após a sincronização do diretório subsequente.

    • Para contatos de grupo - as atualizações são exibidas no aplicativo Webex dos usuários imediatamente após a sincronização de diretório subsequente.

    • Para contatos da organização — O diretório Webex é atualizado na sincronização subsequente do diretório, mas os usuários não verão a alteração no aplicativo Webex até reiniciarem o aplicativo Webex ou até que o temporizador de cache local de 72 horas expire.

As atualizações do Webex para as informações do usuário do Cisco BroadWorks são tratadas como parte dos processos de provisionamento.
O Control Hub contém uma opção para adicionar ou editar contatos no nível da organização no Control Hub por meio de um arquivo CSV. Os administradores de parceiros e de clientes com acesso ao Control Hub podem acessar esta opção. No entanto, a atualização de contatos via Control Hub não é suportada pelo Webex para o Cisco BroadWorks. As atualizações de contato aplicadas no Control Hub não sincronizam novamente com o BroadWorks e não estão disponíveis para pesquisas de diretório de telefones fixos.

Pré-requisitos de sincronização de diretórios

Recomendamos que você use as seguintes configurações:

Os exemplos abaixo assumem que você está usando um servidor XSP. Para servidores ADP, substitua (XSP _ CLI) por (ADP _ CLI).

  • Valores de limitação de taxa — Defina as seguintes propriedades do sistema OverloadControl (XSP _ CLI/Applications/Xsi-Actions/OverloadControl):

    • userDirectoryTransactionLimit — definido como um valor nulo.

    • globalDirectoryTransactionLimit — definido como um valor nulo.

    É recomendado que você defina userDirectoryTransactionLimit e globalDirectoryTransactionLimit para um valor nulo. No entanto, se você decidir atribuir valores, cada um deve ser definido para pelo menos cinco vezes o valor de transactionLimitPeriodSeconds (que deve ser 1).

  • Limites de transação — defina os seguintes valores (XSP _ CLI/System/CommunicationUtility/DefaultSettings):

    • userTransactionLimit — definido para pelo menos 100.

    • transactionLimitPeriodSecs — definido para 1.

  • Valores de paginação — Defina as propriedades do sistema de paginação (XSP _ CLI/Applications/Xsi-Actions/Paging):

    • defaultPageSize — Definido como 50

    • availableUserMaxLimit - Definido como 100

  • Interface CTI — Certifique-se de carregar os certificados CA Webex no armazenamento confiável da interface CTI e para permitir a autenticação do cliente na interface CTI.

Além disso, dependendo da sua versão do BroadWorks, recomendamos que você aplique as seguintes patches do sistema à implantação do BroadWorks antes de ativar este recurso:

Para obter a lista completa dos requisitos de patch que formam o requisito mínimo do Webex para o Cisco BroadWorks, consulte Requisitos de software BroadWorks no Guia de soluções do Webex para o Cisco BroadWorks .

Ativar sincronização de diretórios (novo modelo)

Os administradores de parceiros podem ativar a Sincronização de diretórios para um modelo de cliente ao criar o novo modelo. Todas as novas organizações de clientes que forem atribuídas a esse modelo terão a sincronização de diretórios ativada. Para obter detalhes, consulte "Configurar seus modelos de cliente" em Configurar sua organização parceira no Hub de parceiros no Guia de soluções do Webex para Cisco BroadWorks .

O que fazer em seguida

Certifique-se de que seus usuários saibam que devem clicar na guia Contatos no aplicativo Webex pelo menos uma vez para ativar o recurso no aplicativo Webex. Isso precisa ser concluído apenas uma vez.

Ativar sincronização de diretórios (modelo existente)

Os administradores de parceiros podem concluir as seguintes etapas para ativar a Sincronização de diretórios em um modelo de cliente existente a fim de ativar o recurso para as organizações de clientes que usam o modelo.
1

Inicie sessão no Hub de parceiros e escolha Configurações .

2

Role até BroadWorks Calling e clique em Exibir modelos .

3

Selecione o modelo de cliente apropriado e role até BroadWorks Directory Sync .

4

Para habilitar a sincronização de diretório por padrão para novas organizações de clientes que usam este modelo:

  1. Defina a opção Ativar a sincronização do diretório BroadWorks e da lista de telefones para todas as novas organizações de clientes alternar para On .

  2. Clique em Salvar.

5

Para habilitar a sincronização de diretório para organizações de clientes existentes que usam este modelo:

  1. Clique em Mostrar lista de status de sincronização de clientes .

  2. Marque as caixas de seleção adjacentes para cada organização para a qual você deseja ativar o recurso.

  3. Clique em Ativar sincronização .

Se você quiser desativar a sincronização de diretório, siga o procedimento acima e:

  • Na etapa 4a, defina a sincronização Habilitar diretório de telefone para todas as novas organizações de clientes alterne para Off para desativar a sincronização de diretório por padrão para novas organizações de clientes que usam este modelo.

  • Na etapa 5c, clique em Desativar sincronização para desativar o recurso para organizações existentes.

O que fazer em seguida

Certifique-se de que seus usuários saibam que devem clicar na guia Contatos no aplicativo Webex pelo menos uma vez para ativar o recurso no aplicativo Webex. Isso precisa ser concluído apenas uma vez.

Iniciar sincronização imediata

A opção Sincronizar agora permite que o administrador do parceiro acione uma sincronização sob demanda para uma determinada organização do cliente. Essa opção pode ser selecionada apenas para organizações de clientes individuais — não há nenhuma opção em massa para o Sync Now.
1

Inicie sessão no Partner Hub ( http://admin.webex.com) e escolha Configurações .

2

Role até BroadWorks Calling e clique em Exibir modelos .

3

Selecione o modelo de cliente apropriado e role até BroadWorks Directory Sync .

4

Clique em Mostrar lista de status de sincronização de clientes .

5

Para a organização do cliente que você deseja sincronizar, clique nos três pontos na extrema direita e selecione Sincronizar agora .

6

Clique em Atualizar para ver os resultados da sincronização.

Exportar registros de sincronização para CSV

Os administradores de parceiros podem exportar informações detalhadas sobre a última sincronização para um arquivo CSV. O CSV contém uma exibição mais detalhada do registro de sincronização do que a GUI do Control Hub e pode ajudar na solução de problemas e análises.
1

Inicie sessão no Partner Hub ( http://admin.webex.com) e escolha Configurações .

2

Role até BroadWorks Calling e clique em Exibir modelos .

3

Selecione o modelo de cliente apropriado e role até BroadWorks Directory Sync .

4

Clique em Mostrar lista de status de sincronização de clientes .

5

Marque as caixas de seleção adjacentes para cada organização que você deseja incluir na exportação.

6

Clique em Exportar resultados .

APIs públicas para sincronização de diretórios

As APIs públicas estão disponíveis em developer.webex.com que permitem aos administradores de parceiros atualizar as configurações de Sincronização de diretórios para as organizações de clientes que gerenciam, acionar uma sincronização imediata ou obter informações de status de sincronização. Os métodos de sincronização de diretório são agrupados em BroadWorks Enterprises :

  • Listar empresas BroadWorks —Use este método de API para obter uma lista de empresas em um determinado provedor de serviços e em cada empresa id. Você deve inserir o spEnterpriseId como atribuído no provisionamento.

  • Atualizar sincronização de diretórios para uma empresa BroadWorks —Insira a empresa id para atualizar o status de syc do diretório dessa empresa, ativando ou desativando a sincronização do diretório.

  • Trigger Directory Sync para uma empresa —Use este método de API se desejar acionar uma sincronização imediata para uma determinada empresa id. Para o syncStatus, insira o SYNC_NOW comando.

  • Obter status de sincronização de diretório para uma empresa —Insira a empresa id e executar a fim de obter um status e trackingId da sincronização mais recente. Você pode usar o trackingID para executar análises adicionais através de ferramentas como Kibana e Grafana.

Além disso, os administradores podem usar a Trigger Directory Sync para um único usuário API para acionar uma sincronização de diretório sob demanda para um único usuário.

Para obter documentação detalhada da API, consulte https://developer.webex.com/docs/api/guides/webex-for-broadworks-developers-guide.

Você precisa iniciar sessão para ler a especificação da API em https://developer.webex.com/docs/api/v1/broadworks-subscribers.

Sincronizar várias empresas com a API

Conclua este procedimento para usar as APIs públicas para acionar a sincronização de diretório de várias empresas.

  • A sincronização de diretórios permite sincronizar apenas uma única empresa de um grupo Broadworks por vez por meio de uma sincronização sob demanda. Se você tentar sincronizar mais de uma empresa, você receberá um erro 429

  • O tempo que leva para acionar uma sincronização para uma única empresa varia dependendo do tamanho da empresa.

1

Execute a API List BroadWorks Enterprises para gerar uma lista de empresas que você deseja sincronizar.

  1. Defina startWith para a sequência inicial do identificador da empresa ou do provedor de serviços.

  2. Clique em Executar.

2

Execute a Trigger Directory Sync para uma API Empresarial na primeira empresa da lista.

  1. Insira a empresa id .

  2. Definir syncStatus para SYNC_NOW

  3. Clique em Executar.

    Uma sincronização imediata é acionada para a empresa. Essa sincronização conta com a sincronização única sob demanda por limite do Broadworks.
3

Aguarde alguns segundos e execute a API Obter status de sincronização do diretório para obter o status de sincronização.

  1. Insira o Enterprise id

  2. Clique em Executar.

4

Após a conclusão da sincronização, conclua as etapas 2 a 4 na próxima empresa na lista. Repita estas etapas até que você tenha sincronizado toda a lista.

Códigos de erro para sincronização de diretórios

Os seguintes códigos de erro se aplicam à Sincronização de diretórios.

Código do erro

Mensagem de erro

600000

Erro inesperado de Sincronização do Usuário do Diretório Externo do Broadworks.

600001

Falha na Sincronização do usuário do diretório externo do BroadWorks.

600002

A Sincronização do usuário do diretório externo do BroadWorks teve que ser encerrada antes da conclusão.

600003

A Sincronização do usuário do diretório externo do Broadworks foi bem-sucedida apenas parcialmente. Algumas Organizações de clientes falharam ao sincronizar.

600004

A Sincronização do usuário do diretório externo do BroadWorks não está habilitada no ConfigSet.

600005

A Sincronização do usuário do diretório externo do BroadWorks está em andamento no ConfigSet.

600006

As threads de Sincronização do usuário do diretório externo do BroadWorks estão ocupadas ou desligando, por isso, não aceitarão mais solicitações de sincronização. Tente novamente mais tarde.

600007

A Organização da identidade do CustomerConfig não foi encontrada.

600008

O CustomerConfig não foi encontrado na organização parceira.

600009

A Sincronização do usuário do diretório externo do Broadworks não pode ser executada porque o grupo do Broadworks associado ao CustomerConfig está ocupado

600010

A Sincronização do usuário do diretório externo do BroadWorks não pode ser executada porque não há um grupo do Broadworks associado ao CustomerConfig.

600011

A Sincronização do usuário do diretório externo do BroadWorks não está ativada no CustomerConfig.

600012

A Sincronização do Usuário do Diretório Externo do Broadworks não pode ser executada já que a sincronização do Diretório Híbrido já está ativada para o CustomerConfig.

600013

A Sincronização do usuário do diretório externo do BroadWorks falhou ao adicionar usuários e contas de máquina ao armazenamento de identidade.

600014

Falha de Sincronização do Usuário do Diretório Externo do Broadworks ao tentar conectar ao grupo Bradworks. Erro do Broadworks - %s.

600015

A Sincronização do Usuário do Diretório Externo do Broadworks não encontrou nenhum usuário correspondente no armazenamento de identidade.

600017

A Sincronização da lista telefônica do BroadWorks falhou ao sincronizar todos os contatos de usuário e empresa/organização.

600018

Falha na sincronização da lista de telefones BroadWorks para usuários na empresa/organização.

600019

Falha ao sincronizar a lista de telefones do BroadWorks ao sincronizar contatos corporativos/da organização.

600020

A Sincronização do usuário do diretório externo do BroadWorks não pode ser desativada porque a sincronização do CustomerConfig está em andamento.

600022

A Sincronização de usuário único do diretório externo do BroadWorks não é possível, pois a empresa não tem usuário provisionado.

600023

A Sincronização de usuário único do diretório externo do BroadWorks não é possível porque o usuário já existe nesta organização.

600024

A Sincronização do usuário único do diretório externo do BroadWorks não é possível porque nenhum usuário correspondente foi encontrado no BroadWorks.

600025

A Sincronização do usuário do diretório externo do BroadWorks falhou ao atualizar a conta de usuário no CI.

600026

A Sincronização do usuário do diretório externo do BroadWorks falhou ao atualizar a conta da máquina no CI.

600027

A Sincronização de usuário único do diretório externo do BroadWorks não é possível porque vários usuários foram encontrados no BroadWorks.

600028

A Sincronização do usuário único do diretório externo do BroadWorks não é possível porque pelo menos uma sincronização do diretório corporativo deve ter sido concluída.

600029

A sincronização do usuário do BroadWorks External Directory falhou, pois a empresa não tem nenhum usuário provisionado.

Histórico de alterações

A tabela a seguir resume as atualizações deste artigo.

Data

Revisão

14 de fevereiro de 2023

Seção Maximums de sincronização de diretório e fonte atualizada.

10 de dezembro de 2022

Atualizado o termo Concluir sincronização imediata para Sincronização do diretório de disparo

19 de julho de 2022

Clarificações e correções para obter informações de visão geral:

  • Visão geral da sincronização de diretórios atualizada para esclarecer as diferentes sincronizações envolvidas e como o diretório Webex é atualizado para cada uma delas.

  • Atualizado Lista de telefones BroadWorks e Maximums de contato para esclarecer que apenas as listas telefônicas são sincronizadas com os Contatos.

  • Correções para Atualizações para esclarecer quanto tempo leva para o aplicativo Webex exibir registros atualizados.

09 de maio de 2022

  • Na Visão geral da sincronização de diretórios , nota corrigida na tabela Maximums de sincronização de diretórios e Fonte . Nota também atualizada sobre o provisionamento do fluxo contínuo.

  • Edições e correções gramaticais

07 de abril de 2022

  • Nota adicionada à seção Updates na Visão geral da sincronização de diretórios em torno da limitação de aplicar edições de contato no nível da organização no Control Hub.

28 de março de 2022

  • Conteúdo perdido reinserido em Ativar sincronização de diretórios (novo modelo) .

  • Informações adicionadas sobre os máximos de sincronização. Você pode executar uma sincronização agendada e uma sincronização de API simultaneamente no mesmo grupo.

  • Informações adicionadas sobre Trigger Directory Sync para uma única API de usuário.

24 de março de 2022

Adicionada lista de tipos de números de telefone sincronizados para Condições de sincronização de diretório . A sincronização agora inclui números de telefone celular.

16 de março de 2022

  • Novos códigos de erro adicionados.

  • Adição da declaração de descrição introdutória para melhor usabilidade a partir de pesquisas na web.

17 de dezembro de 2021

  • Edições estruturais secundárias para corrigir o problema com o TOC ausente.

16 de dezembro de 2021

  • Artigo atualizado com valores máximos aumentados para Contatos do usuário.

08 de dezembro de 2021

  • Seção adicionada Sincronização de diretórios e Maximums de contato para esclarecer como a Sincronização de diretórios deriva o número máximo de contatos da organização e do usuário.

  • Formatação de tabela revisada em Códigos de erro para sincronização de diretório para melhor legibilidade.