ZxChat Admin Guide/pt

From ZeXtras Suite Wiki

Jump to: navigation, search
Língua: English  • español • português
ZxChat logo box.png
Available since version: 1.6.4
Latest Version: 1.36
Released on: August 18th, 2016
Compatibility List
Admin Guide
XMPP Guide
Audit Logs
User Guide
FAQ

Compatibilidade

O zimlet ZxChat e o módulo para ZeXtras Suite foram desenvolvidos e estão certificados para funcionar em Zimbra 8 ou posterior. Se fossem instalados em versõres anteriores se poderiam experimentar comportamentos inesperados no cliente web dos usuários.

ZeXtras Chat é compatível com Zimbra Open Source Edition e com Zimbra Network Edition

Base de dados de ZeXtras Chat

ZeXtras Chat usa um esquema de base de dados dedicado e um motor para armazenar a informação. Quando se emite uma nova versão de tal esquema, se ativa automáticamente uma Atualização do mesmo.

Firewalls e Proxy

O zimlet ZeXtras Chat usa os mesmos portos que o webmail para se conectar com o módulo, e esta conexão deve permanecer ativa e será restabelecida num ciclo de 25 segundos, pelo que se houver má conexão o server "pensa" que o cliente se desconectou, afetando o uso do Chat. Além disso, a função XMPP de ZxChat requer o puerto 5222 (e 5223 para legacy SSL) então assegúre-se que essas portas possam aceitar conexões e que as mesmas sejam roteadas para o servidor apropriado.

Se tiver dificuldades com as videochamadas devido a problemas de roteamento ou NAT reverso procure utilizar um servidor TURN

Migração desde Instant Messaging do Zimbra

Se você tem Zimbra 7.x e quer usar ZeXtras Chat em vez das mensagens instantáneas incorporadas, ou se está planejando uma migração desde Zimbra 6 ou 7 para Zimbra 8.x, temos um comando disponível para migrar as listas de contatos para ZeXtras Chat.

 zxsuite chat doMigrateZimbraIMRoster

Este comando não necessita argumentos, e migrará todas as listas de mensagens do Zimbra para a base de dados do ZeXtras Chat. Os contatos com pedido pendentes de aceitação não serão migrados.

Função "View Mail" e ZeXtras Chat

Para proteger a privacidade dos usuários e evitar suplantação de identidade, o zimlet ZeXtras Chat somente estará disponível quando se ingressa na conta com nome de usuário e senha. Quando se loguear a través da função específica para ver o correio desde o console Zimbra aparecerá uma mensagem de advertência e o zimlet não se carregará.

Funções avançadas

Protocolo XMPP

ZeXtras Chat é 100% compatível com o protocolo XMPP, o que permite usar um cliente compatível para se conectar e enviar mensagens. Pode ver o guia com as funções XMPP em esta página: ZeXtras Chat XMPP

Registros de auditoría do módulo Zextras Chat

Os detalhes sobre como habilitar ou desabilitar os registros avançados de Zextras Chat podem achar-se aquí: Registros de auditoría de Zextras Chat

Gerenciamento do Chat de ZeXtras

Como acontece com os demáis módulos do Zextras, muitas das tarefas administrativas para o ZxChat se podem realizar desde o zimlet.

Também está disponível a interface CLI, mas todas as operações COS/Usuário com comandos se devem efetuar desde a linha de comandos do Zimbra (`zmprov` and `zmzimletctl`). Todos os comandos se devem executar como usuário "zimbra".

Iniciar ou deter o Servidor de Chat

Zimlet administrativo Zextras

Para iniciar o server ZxChat ingresse na seção "Core" do zimlet Zextras e pressione o botão "Iniciar" correspondente ao módulo ZxChat

Para deter o servidor de chat, pressione o botão "Parar" na mesma seção.

Console Zextras

O servidor ZxChat se inicia automáticamente após o primeiro reinicio, logo depois de instalar Zextras Suite.

O estado do serviço se pode gerenciar mediante os comandos "getService", "doStartService", "doStartServices" e "dotopService"

Sintaxe:
   zxsuite chat getServices
 
        services                               
            module                                 
                could_start                                                false
                could_stop                                                  true
                running                                                    true
            xmpp                                   
                could_start                                                false
                could_stop                                                  true
                running                                                    true
            soap                                   
                could_start                                                false
                could_stop                                                  true
                running                                                    true
            store-event-destination               
                could_start                                                false
                could_stop                                                  true
                running                                                    true
            user-events-destination               
                could_start                                                false
                could_stop                                                  true
                running                                                    true
            history-event-destination             
                could_start                                                false
                could_stop                                                  true
                running                                                    true
            session-cleaner                       
                could_start                                                false
                could_stop                                                  true
                running                                                    true
            local-server-destination               
                could_start                                                false
                could_stop                                                  true
                running                                                    true
            session-manager                       
                could_start                                                false
                could_stop                                                  true
                running                                                    true
            flush-db                               
                could_start                                                false
                could_stop                                                  true
                running                                                    true
 

Para que o módulo ZxChat seja completamente funcional todos os serviços devem ter a propriedade "running" estabelecida em "true".

doStartService

Sintaxe:
  zxsuite chat doStartService {service_name}  

LISTA DE PARÁMETROS

NOME               TIPO     
service_name(M)    String    

(M) == parámetro obrigatório (O) == parámetro opcional

doRestartService

Sintaxe:
  zxsuite chat doRestartService {service_name}

LISTA DE PARÁMETROS
 
NOME               TIPO     
service_name(M)    String   
 
(M) == parámetro obrigatório (O) == parámetro opcional

doStopService

Sintaxe:
   zxsuite chat doStopService {service_name}  

LISTA DE PARÁMETROS

NOME               TIPO     
service_name(M)    String    

(M) == parámetro obrigatório (O) == parámetro opcional

Habilitação do autostart no servidor ZeXtras Chat

Desde o zimlet

Marcar a opção "Automatic module startup" que presente ao lado do botão "ZxChat" na seção "Core" do módulo Zextras.

Desde a interface de linha de comandos

Para habilitar o servidor de Chat tem de se estabelecer a propriedade "ZxChat_Enabled" como true mediante o comando "setPtoperty"

zxsuite chat setProperty ZxChat_ModuleEnabledAtStartup true

Desabilitar o servidor de Chat

Desde o zimlet ZeXtras

Simplesmente desmarcar a casinha "Automatic module startup" que se encontra ao lado do botão "ZxChat" na aba "Core" em ZeXtras.

Desde a CLI

Para desabilitar o servidor ZeXtras chat a propriedade "ZxChat_Enabled" se deve estabelecer em false a través do comando "setPtoperty".

zxsuite chat setProperty ZxChat_ModuleEnabledAtStartup false

Habilitando ZeXtras Chat para um único usuário

Desde o console Zimbra

Zxchat admin g 3.png

Desde a CLI ZeXtras

Para habilitar o zimlet para um usuário em particular se usa a CLI de Zimbra:

 zmprov ma youraccount@domain.com +zimbraZimletAvailableZimlets com_zextras_chat

Desabilitando ZeXtras Chat para um usuário

Desde o console Zimbra

Zxchat admin g 4.png

Desde a linha de comandos ZeXtras

Para desabilitar o zimlet para um usuário se usa a CLI do Zimbra

 zmprov ma youraccount@domain.com -zimbraZimletAvailableZimlets com_zextras_chat

Habilitando ZeXtras Chat para uma Classe de Serviço

Desde o console Zimbra

Zxchat admin g 5.png

Desde a linha de comandos do Zimbra

Para habilitar o zimlet ZeXtras Chat para uma classe de serviço se usa a linha de comandos de Zimbra:

 zmzimletctl acl com_zextras_chat [nome_da_COS] grant

Desabilitando ZeXtras Chat para uma Classe de Serviço

Desde o console Zimbra

Zxchat admin g 6.png

Desde a linha de comandos do Zimbra

Para desabilitar o Zimlet ZeXtras Chat para uma COS, se usa a linha de comandos de Zimbra:

 zmzimletctl acl com_zextras_chat [nome_da_COS] deny

Gerenciamento de contatos no zimlet Zextras Chat

Existem várias formas de administrar a lista de contatos dos usuários: podem conectar-se dois contatos entre si nas suas respetivas listas de contatos, ou conectar todos os usuários entre si mediante listas de distribuição.

Console de administração Zimbra

conectar dois contatos entre si

Chat connect user.png


Conectar todos os contatos entre si mediante uma lista de distribuição

Em primeiro lugar é necessário adicionar todos os usuários a uma lista de distribuição. Posteriormente, para completar a lista de contato dos usuários automáticamente con todos os contatos, tem que estabelecer o valor da função allowDlMemberAddAsFriend en true.

Warning.png Atenção!

Os contatos adicionado com este método não podem ser removidos

Friend chat dl.png

CLI de Zimbra

doAddBuddies

Sintaxe:
   zxsuite chat doAddBuddies {user1} {user2} [attr1 value1 [attr2 value2...]]
LISTA DE PARÁMETROS
NOMBRE          TIPO
user1(M)        Nome da conta
user2(M)        Nome da conta
user1nick(O)    String
user2nick(O)    String
(M) == parámetro obrigatório, (O) == parámetro opcional

Exemplo de uso:
zxsuite chat doAddBuddies joao@example.com luiz@example.com user1nick "Meu Melhor Amigo"
Adiciona João e Luis entre si. Luiz vai ver João como "Meu Melhor Amigo" na lista de contatos.

doRemoveBuddies

Sintaxe:
   zxsuite chat doRemoveBuddies {user1} {user2}
LISTA DE PARÁMETROS
NOME        TIPO
user1(M)    Nome da conta
user2(M)    Nome da conta
(M) == parámetro obrigatório, (O) == parámetro opcional

Exemplo de uso:
zxsuite chat doRemoveBuddies juan@example.com Pablo@example.com
Remove João da lista de Luiz e vice-versa.

getBuddyList


Sintaxe:
   zxsuite chat getBuddyList {account}
LISTA DE PARÁMETROS
NOME          TIPO
account(M)    Nome da conta
(M) == parámetro obrigatório, (O) == parámetro opcional

Exemplo de uso:
zxsuite chat getBuddyList joao@example.com
Mostra a lista de contatos de João.

Lista de distribuição de contatos Para adicionar todos os membros de uma lista de distribuição à lista de contatos dos usuários, deve estabelecerse o valor allowDlMemberAddAsFriend em true

<config>
zxsuite config distributionlist set friends@zimbra.local attribute allowDlMemberAddAsFriend value true
</config>
Warning.png ¡Atención!

Os contatos da lista não podem eliminar-se

doMakeBuddies Adiciona todos os membros de uma lista de distribuição à lista de contatos dos usuários.


Sintaxe:
   zxsuite chat doMakeBuddies {distribution_list}
LISTA DE PARÁMETROS
NOME                    TIPO
distribution_list(M)    String
(M) == parámetro obrigatório, (O) == parámetro opcional

Exemplo de uso:
zxsuite chat doMakeBuddies example_list@example.com
Adiciona todos os contatos na lista entre si.

** NOTA ** Esse comando pode criar muitas entrada na base de dados de ZxChat.
           Por exemplo, se houver 100 membros na lista, as entradas
           agregadas à base de dados serão 100 * 99 = 9900
Warning.png Atenção!

Esse comando é obsoleto em Zextras Suite 2.6 e funciona apenas na versão Legada


Limpeza do database de ZeXtras Chat

A limpeza se executa de noche, e são removidos os seguintes elementos:

  • Mensagens não enviadas nos últimos 30 dias
  • Entradas de contatos quebradas (ex. nexos a contas não existentes)

Enviar uma mensagem para todos os usuários "on line"

Desde o zimlet ZeXtras

Esta função não está disponível desde o zimlet ZeXtras.

Desde a linha de comandos do ZeXtras

Para poder enviar uma mensságem a todos os usuários, se dispõe do comando "broadcastMessage":


Sintaxe:
   zxsuite chat broadcastMessage {message} [attr1 value1 [attr2 value2...]]

LISTA DE PARÂMETROS

NOME            TIPO                
message(M)    String              
domains(O)    Domain Name[,..]    

(M) == parâmetro obrigatorio, (O) == parâmetro opcional

Exemplo de uso:

zxsuite chat broadcastMessage "Broadcasted message" domains example1.com,example2.com
Envia uma mensságem a todos os usuários conectados nos domínios example1.com e example2.com
Personal tools