ZxChat Admin Guide

From ZeXtras Suite Wiki

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

Compatibility

The ZxChat Zimlet and the ZeXtras Chat Module for ZeXtras Suite are developed and certified to be functional when used on Zimbra 8+. Installing the ZxChat Zimlet older Zimbra versions might cause unexpected behaviours in your user's Zimbra Web Client.

ZeXtras Chat is compatible with both Zimbra Open Source Edition and Zimbra Network Edition

ZeXtras Chat Database

ZeXtras Chat uses a dedicated database schema and engine to store its data. When a new version of the Database Schema is released, an automatic Database Schema Upgrade will be triggered.

Firewalls and Proxy

The ZeXtras Chat Zimlet uses the same ports as Zimbra's webmail to connect to the ZeXtras Chat module, and this connection is meant to be kept alive and automatically re-established on a 25-seconds cycle, so having lower connection timeout values would make the server "think" that the client disconnected thus impairing the use of the ZeXtras Chat Zimlet.

Other than this, the XMPP feature of ZeXtras Chat requires port 5222 (and 5223 for legacy SSL), so make sure that this ports can accept connections and that such connections are routed to the appropriate server.

If you are having issues in using the Videocall feature due to routing/reverse NAT issues, try using a TURN server

Migration from Zimbra IM

If you are running Zimbra 7.x and wish to use ZeXtras Chat instead of the built-in IM feature, or if you are planning a migration from Zimbra 6.x/7.x to Zimbra 8.x, a CLI command is available to migrate all Zimbra IM rosters to ZeXtras Chat:

 zxsuite chat doMigrateZimbraIMRoster

This command requires no arguments, and will migrate all Zimbra IM rosters to the ZeXtras Chat Database. Pending buddy requests will not be migrated.

ZeXtras Chat and the "View Mail" feature

In order to protect the privacy of the users and avoid "impersonation", the ZeXtras Chat Zimlet is only available when logging into a mailbox using the appropriate username and password: when logging into a mailbox through the "View Mail" feature a warning message will be displayed and the ZeXtras Chat Zimlet will remain dormant.

Advanced Module features

XMPP Management

ZeXtras Chat is fully compatible with the XMPP protocol, meaning that you can use any XMPP client to connect to ZeXtras Chat. A comprehensive guide of the module's XMPP features and capabilites can be found on the ZeXtras Chat XMPP page.

ZeXtras Chat Audit Logs

Information about how to enable or disable ZeXtras Chat advanced logging can be found on the dedicated ZeXtras Chat Audit Logs page.

ZeXtras Chat Administration

Like all the ZeXtras Suite modules, many ZeXtras Chat administrative tasks can be performed through the ZeXtras Administration Zimlet.

A ZeXtras CLI command set is also available, while all COS/User operations CLI are to be performed through the Zimbra Commmand Line Interface (`zmprov` and `zmzimletctl`). All Command Line Interface commands must be executed as the "zimbra" user.

Starting and Stopping the ZeXtras Chat server

ZeXtras Administration Zimlet

In order to start the ZeXtras Chat server in the ZeXtras Administration Zimlet, enter the "Core" section of the ZeXtras Administration Zimlet and click on the "Start" button corresponding to the ZeXtras Chat module.

In order to stop the ZeXtras Chat server, click the "Stop" button in the very same section.

ZeXtras CLI

The ZeXtras Chat Server is automatically started upon the first restart after installing ZeXtras Suite.

The service status can be managed through the "getService", "doStartService", "doStartServices" and "doStopService" ZeXtras CLI commands:

Syntax:
   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

In order for the ZeXtras Chat module to be fully functionals, all services must have the "running" property set to "true".

doStartService

Syntax:
   zxsuite chat doStartService {service_name} 

PARAMETER LIST

NAME               TYPE      
service_name(M)    String    

(M) == mandatory parameter, (O) == optional parameter

doRestartService

Syntax:
   zxsuite chat doRestartService {service_name} 

PARAMETER LIST

NAME               TYPE      
service_name(M)    String    

(M) == mandatory parameter, (O) == optional parameter

doStopService

Syntax:
   zxsuite chat doStopService {service_name} 

PARAMETER LIST

NAME               TYPE      
service_name(M)    String    

(M) == mandatory parameter, (O) == optional parameter

Enabling the ZeXtras Chat Server autostart

ZeXtras Administration Zimlet

In order to enable ZeXtras Chat's autostart, tick the "Automatic module startup" option near the "ZxChat" button in the "Core" section of the ZeXtras Administration Zimlet.

ZeXtras CLI

In order to enable the ZeXtras Chat server, the "ZxChat_Enabled" property must be set to true through the "setPtoperty" command.

zxsuite chat setProperty ZxChat_ModuleEnabledAtStartup true

Disabling the ZeXtras Chat server

ZeXtras Administration Zimlet

In order to enable ZeXtras Chat's autostart, untick the "Automatic module startup" option near the "ZxChat" button in the "Core" section of the ZeXtras Administration Zimlet.

ZeXtras CLI

In order to disable the ZeXtras Chat server, the "ZxChat_Enabled" property must be set to false through the "setPtoperty" command.

zxsuite chat setProperty ZxChat_ModuleEnabledAtStartup false

Enabling the ZeXtras Chat Zimlet for a user

Zimbra Administration Console

Zxchat admin g 3.png

ZeXtras CLI

In order to enable the ZeXtras Chat Zimlet for a user, the standard Zimbra CLI is used:

 zmprov ma youraccount@domain.com +zimbraZimletAvailableZimlets com_zextras_chat


Disabling the ZeXtras Chat Zimlet for a user

Zimbra Administration Console

Zxchat admin g 4.png

ZeXtras CLI

In order to disable the ZeXtras Chat Zimlet for a user, the standard Zimbra CLI is used:

 zmprov ma youraccount@domain.com -zimbraZimletAvailableZimlets com_zextras_chat


Enabling the ZeXtras Chat Zimlet for a Class of Service

Zimbra Administration Console

Zxchat admin g 5.png

Zimbra CLI

In order to enable the ZeXtras Chat Zimlet for a Class of Service, the standard Zimbra CLI is used:

 zmzimletctl acl com_zextras_chat [your_cos_name] grant


Disabling the ZeXtras Chat Zimlet for a Class of Service

Zimbra Administration Console

Zxchat admin g 6.png

Zimbra CLI

In order to disable the ZeXtras Chat Zimlet for a Class of Service, the standard Zimbra CLI is used:

 zmzimletctl acl com_zextras_chat [your_cos_name] deny

ZeXtras Chat Database cleanup

A database cleanup is executed nightly, and the following items are removed:

  • Undelivered messages older than 30 days
  • Broken buddylist entries (e.g. pointing to nonexising accounts)
Personal tools