CommuniGate Pro
Version 5.1

XIMSS Module

The CommuniGate Pro XIMSS module implements an open XML API protocol. This protocol supports advanced clients allowing them to access all Server functions in a secure and effective way.

The CommuniGate Pro XIMSS module supports both clear text and secure (SSL/TLS) connections.

The the XIMSS Protocol section for more details on the protocol and its features.

The CommuniGate Pro XIMSS module requires either a Groupware-type License Key or a special XIMSS License Key. The Server accepts up to 5 concurrent XIMSS sessions without these Keys.

Configuring the XIMSS Module

Use the WebAdmin Interface to configure the XIMSS module. Open the Access page in the Settings realm:
Log Level: Channels: Listener

Use the Log setting to specify the type of information the XIMSS module should put in the Server Log. Usually you should use the Major (message transfer reports) or Problems (message transfer and non-fatal errors) levels. But when you experience problems with the XIMSS module, you may want to set the Log Level setting to Low-Level or All Info: in this case protocol-level or link-level details will be recorded in the System Log as well. When the problem is solved, set the Log Level setting to its regular value, otherwise your System Log files will grow in size very quickly.

The XIMSS module records in the System Log are marked with the XIMSSI tag.

When you specify a non-zero value for the Maximum Number of Channels setting, the XIMSS module creates a Listener. The module starts to accept all XIMSS connections that clients establish in order to communicate with your Server. The setting is used to limit the number of simultaneous connections the XIMSS module can accept. If there are too many incoming connections open, the module will reject new connections, and the client should retry later.

By default, the XIMSS module Listener accepts clear text connections on the TCP port 11024. Follow the Listener link to tune the XIMSS Listener.

XIMSS Connections to Other Modules

XIMSS connections can be made to TCP ports served with other CommuniGate Pro modules. If the first symbol received on a connection made to the HTTP module is the < symbol, the HTTP module passes the connection to the XIMSS module.

When a connection is passed:

When all users initiate XIMSS connections via other Module ports, you can disable the XIMSS Listener by settings all its ports to zero.

Flash Security

When a Flash client connects to an XMLSocket server (such as the CommuniGate Pro XIMSS module), it can send a special policy-file-request request. The XIMSS module replies with an XML document allowing the client to access any port on the Server.

Monitoring XIMSS Activity

You can monitor the XIMSS Module activity using the WebAdmin Interface.

Click the Access link in the Monitors realm to open the Access Monitoring page:
3 of 3 selected
ID IP Address Account Connected Status Running
9786[]user1@domain2.dom3minlisting messages2sec
9794[]user2@domain1.dom34secreading request 
This field contains the XIMSS numeric session ID. In the CommuniGate Pro Log, this session records are marked with the XIMSS-nnnnn flag, where nnnnn is the session ID.
IP Address
This field contains the IP address the client has connected from.
This field contains the name of the client Account (after successful authentication).
This field contains the connection time (time since the client opened this TCP/IP session).
This field contains either the name of the operation in progress or, if there is not pending operation, the current session status (Authenticating, Selected, etc.).
If there is an XIMSS operation in progress, this field contains the time since operation started.

The XIMSS activity statistics is available via the CommuniGate Pro SNMP agent.

CommuniGate® Pro Guide. Copyright © 1998-2007, Stalker Software, Inc.