Scalix ActiveSync 1.0 - Release and Installation Notes

Release Date: 2009-06-01  

Table of Contents

• Table of Contents
• Introduction
• Licensing
• Supported Setups and System Requirements
• Supported Devices
• Supported Functionality
• Installation
• Checking the License Key
• Enabling a User for ActiveSync
• Client Setup
• Support
• Known issues

Introduction

Thank you for downloading Scalix ActiveSync 1.0.

Scalix ActiveSync is a server-side wireless server implementation of the Microsoft Exchange 2003/2007 ActiveSync "Over-the-Air" (EAS) protocol specification licensed from Microsoft. The first release, Scalix ActiveSync 1.0, provides for push email, wireless calendar and contact synchronization. Other EAS functionality, such as device management, will be supported in the future.

No Scalix Software is required on the user's mobile device. Many devices already ship with a built-in ActiveSync client; for others it is available as an additional, no-cost install from the device vendor.

The Scalix ActiveSync solution utilizes a direct data channel between the mobile device and the Scalix ActiveSync-enabled server. No intermediary hosts are required. Scalix ActiveSync works over any data network, including GSM, GPRS, EDGE, UMTS, CDMA as well as LAN or Wireless Ethernet networks. Only a basic data plan is needed from the carrier. Communications employ strong SSL cryptography, so security and data privacy is assured.

Licensing

A per-user license is required to use Scalix ActiveSync. This is an optional add-on to a Scalix Server and Mailbox license key. Any Scalix Server can be activated for a number of named ActiveSync users. Once this is done, mailboxes on this server can be flagged to be ActiveSync-enabled. The ActiveSync server will check for this flag to be set and an available license when establishing the connection. The flag can be removed and the ActiveSync entitlement re-allocated to another user on the same server at any time.

Supported Setups and System Requirements

Scalix ActiveSync supports different deployment models:

• All-in-One: Scalix Server and Scalix ActiveSync running on a single system
• Dedicated Wireless Server: Separate systems for Scalix servers and the Scalix ActiveSync frontend server.
  
• Mixed: Scalix ActiveSync is running on one of the Scalix servers and provides service for users on this and other Scalix servers
• Multi-purpose frontend: Scalix ActiveSync is installed on a Scalix Web Access (SWA) frontend server.

The following needs to be true for the Scalix environment for running ActiveSync:

• Scalix servers hosting users whose mailboxes will be ActiveSync-enabled need to run Scalix 11.4.4 or higher.
• Any system on which Scalix ActiveSync is to be installed together with other Scalix components, either a message store or a Scalix Web Access frontend, must be running Scalix 11.4.4 or higher.

• Red Hat Enterprise Linux 5, 32- and 64-bit
  
• CentOS 5, 32- and 64-bit
  
• SuSE Linux Enterprise Server 10, 32- and 64-bit
  

• a minimum of 1 GB of RAM
• a single CPU
• 10 GB of diskspace
• a non-proxied Internet connection on port 443/tcp (https) and/or port 80/tcp (http). It is recommended to only use port 443/tcp (https) for security reasons.
  
• a local connection to the Scalix server(s), allowing for ports 143/tcp (imap), 25/tcp (smtp), 587/tcp (submission), 389/tcp (ldap) and 5768/tcp (Scalix Event Server) to be used
  

Supported Devices

Scalix ActiveSync 1.0 supports versions 2.5 and 12.0 of the Microsoft Exchange ActiveSync protocol. It has been tested and is certified to work with the following devices:

• Apple - iPhone*, iPhone 3G, iPod Touch*
• Microsoft - all smartphones and handhelds based on Windows Mobile 6 versions

*) Requires Apple iPhone/iPod Touch Software 2.0 or later

Other devices that support ActiveSync may also work but haven't been tested in full, e.g.:

• Motorola - A780, A910, Motorola Q
• Nokia - Series 60 Symbian devices, e.g. E50, E61, E61i, E62, E70, E90, N95
• Sony-Ericsson - Symbian devices, e.g. P990, M600, P1i, W950
• Palm - Treo and Centro smartphones
• Helio - Helio Ocean
• Microsoft - all smartphones and handhelds based on Windows Mobile 5 versions**

**) Need to have the Microsoft Feature Pack installed and will not support push email.

Supported Functionality

Scalix ActiveSync 1.0 supports the following aspects of the Exchange Active Sync (EAS) V2.5, V12 and V12.1 protocol versions:

• General
• Username/Password Basic Authentication
• Support for Scalix integrated Licensing
• Secure Sockets Layer SSL security for transport encryption
• Conflict resolution and error recovery
• Global Address List (GAL) lookup
  
• Email
• Send/Receive Polling
• Direct push email support
• Synchronization for Inbox and all private folders
• Filtering based on date
• Reply to email messages
• Forward email messages
• Compose/Send Email messages
• Download and view attachments
• HTML mail content support (12.0, 12.1)
  
• Calendaring
• 2-way calendar synchronization
• Filtering based on date
• Accept, Decline and tentatively accept meeting requests
• Create Meeting requests
• Contacts
• 2-way contact synchronization
• Folder Management
• View folder hierarchy

The following EAS features are not supported in Scalix ActiveSync 1.0 and will be part of a later release:

• General
• Client certificate/SecurID authentication
• HTTP redirection and Autodiscovery, forwarding a user to another, closer server
• Optimized V12.1 Sync features, support for wait, limit and partial elements
• Optimized V12.1 HTTP use (URI format changes, elimination of HTTP headers)
• Accessing Documents on File Shares
• Browse File Shares and URIs
• Email
• Synchronization of public folders
• Flagging of Email messages
• Device-side Out-of-Office settings
• Secure MIME (S/MIME) support in synchronization (2.5, 12.0, 12.1)
  
• Calendaring
• Attachments for appointment objects
• View of attendee status for meetings
• Reply/Reply-All/Forward in an appointment
• Contacts
• Images and Pictures in Contacts
  
• Tasks
• Generally 2-way task synchronization
• Support Outlook 2007 To-Do list view
• Folder Management
• Create, edit, or delete folder hierarchy items
• Search
• Support for keyword mailbox search (12.0, 12.1)
• Support for advanced mailbox search (12.0, 12.1)
• Support for document library search (12.0, 12.1)
  
• Management
• User Policy settings for ActiveSync and Device settings including Password reset, Device wipe and attachment download controls
• Send device information to support user self-management (12.0, 12.1)
• Ensure compliance with reporting and monitoring functionality (2.5)
• Support Systems Management Server (SMS) notifications (2.5)
  

Installation

For the purpose of these installation instructions, a dedicated server setup is used. The example uses the following hostnames:

• Existing Scalix 11.4.4 server: scalix.company.com
• New Scalix ActiveSync 1.0 Server: activesync.company.com

Install Scalix ActiveSync

Transfer the Scalix ActiveSync binary to the destination machine (activesync.company.com). Login to the ActiveSync system as root and execute the installer:

$ bash ./scalix-activesync-1.0.0-GA-enterprise-linux-intel.bin

When prompted read and accept the license agreement.

The installer will now verify and extract the Archive Content:

Verifying Archive Contents...

Filesize: 58193630 - OK

SHA1 Checksum: 7db37120c9e07782b67b1dea501dd2aa4780e13f - OK

Extracting and unpacking file scalix-activesync-1.0.0-GA-enterprise-linux-intel.tgz

Archive extraction complete. Press <Return> to see the README. -->    
To install ActiveSync, either select to start installation automatically or
start the installation manually by executing the following commands:

   cd scalix-activesync-1.0.0-GA
   ./scalix-installer

After reading the README press <Return> to continue installation.

Do you want to run the package that was unpacked automatically? (yes/no) [yes] 

Scalix Installer - extracting archive, please wait...
Scalix Installer - starting version 11.4.4.2569...
Scalix Installer - using Python 2.4.3 (/usr/bin/python).
Scalix Installer - audit log file is /var/log/scalix-installer-20080710.log

The installer will gather some system information and prompt you to choose from:

Please choose an action from the list:
[1] Install all Scalix components (typical)
[2] Install one or more Scalix components (custom)
-> Please enter your choice [1]: 

Choose 1 to perform a typical installation. An overview of packages to install will be displayed. Confirm with yes to continue the installation:

=== Packages Installation ===

Searching for latest Scalix packages...    

Install the following components:
  * Scalix DB
    (version 11.4.4.2237-1)
  * Scalix Apache/Tomcat Connector
    (version 11.4.4.926-1.sles10 [1.sles10])
  * Scalix Tomcat
    (version 5.5.27-940)
  * Scalix Messaging Services
    (version 11.4.4.2281-1)
  * Scalix ActiveSync
    (version 1.0.0.253-1)

-> Do you want to continue installing the packages? (yes/no) [yes] 

Please note that the actual version numbers displayed here can be different.

The installer will perform some sanity checks. In case of an error you will get a detailed description of encountered problems. You will need to fix these errors before continuing the installation. In case there where not errors detect you can press <Return> to begin the installation:

Performing system check...

* Environment check... OK
* Filesystem check... OK
* Network check... OK
* Dependency check... OK
* Running services check... OK
* Community license check... OK

-> Press Enter to begin installation: 

After the installation finishes a couple of configuration questions must be answered:

Please wait while Scalix components are installed...    
Checking old Tomcat installations...    
Installing packages...    
Installing Scalix DB...    
Installing Scalix Apache/Tomcat Connector...    
Installing Scalix Tomcat...    
Installing Scalix Messaging Services...    
Installing Scalix ActiveSync...    
Done.

=== Java Runtime Configuration ===

JRE version 1.5.0_13-fcs already installed, skipping.

=== PostgreSQL Configuration ===

-> Enter database password: 

Choose a password to be used and reenter it when prompted.

-> Confirm password: 
Configuring PostgreSQL...    

Now enter the address of the Scalix backend server that hosts the messagestore and provides SMTP. In this example it is scalix.company.com. If you altered your LDAP setup on the backend machine you will also need to enter the changed port:

=== Messaging Services ===

-> Scalix Server hostname (IMAP) [activesync.company.com]: scalix.company.com

-> SMTP server hostname [activesync.company.com]: scalix.company.com

-> Enter LDAP port number: [389]: 389

After specifying the above parameters the installer will finish the installation and start all needed services:

Configuring Web applications...    
Cleaning up Tomcat......    
Configuring Tomcat...    
Configuring Scalix ActiveSync...    
Configuring Scalix Messaging Services...    
Configuring Tomcat service...    
Cleaning up Apache/Tomcat JK configuration......    
Configuring Apache/Tomcat JK connector...    
Restarting Scalix DB...    
Starting Tomcat...    
Installation finished.
Scalix Installer - cleaning up...
Scalix Installer - done.

Re-/uninstalling Scalix ActiveSync

If for any reason you want to re- or uninstall Scalix ActiveSync simply start the installer again.

Please note, in order to reinstall Scalix ActiveSync you must uninstall and delete the cache.

./scalix-installer --cli

Please choose an action from the list:
[1] Install/Upgrade one or more Scalix components (custom)
[2] Reconfigure Scalix components
[3] Uninstall Scalix components
-> Please enter your choice: 

Enter 3

Please choose one or more components to uninstall:
[1] Scalix DB
    (version 11.4.3.2237-1)
[2] Scalix Apache/Tomcat Connector
    (version 11.99.0.926-1.rhel5 [1.rhel5])
[3] Scalix Tomcat
    (version 5.5.27-940)
[4] Scalix Messaging Services
    (version 11.4.3.2281-1)
[5] Scalix ActiveSync
    (version 1.0.0.252-1)
-> Please enter comma-separated list of numbers: 

Enter 1,2,3,4,5

-> Are you sure you want to uninstall the selected components? (yes/no) [no] 

Enter yes

-> After uninstalling Scalix DB do you want to remove the cache data? (yes/no) [no] 

Enter yes

-> Press Enter to begin uninstallation: 
 
Stopping Tomcat...    
Please wait while Scalix components are uninstalled...    
Discovering instances...    
Reconfiguring Web Apps...    
Stopping PostgreSQL...    
Uninstalling Scalix ActiveSync...    
Uninstalling Scalix Messaging Services...    
Uninstalling Scalix Tomcat...    
Uninstalling Scalix Apache/Tomcat Connector...    
Uninstalling Scalix DB...    
Removing Web Apps configuration...    
Cleaning up Tomcat...    
Cleaning up Apache/Tomcat JK connector...    
Cleaning up orphaned files...    
All selected Scalix components have now been uninstalled.
Uninstallation finished.
Scalix Installer - cleaning up...
Scalix Installer - done.

Checking the License Key

Method 1 - Command Line

scalixmail:~ # sxlicense
   Scalix License Status

License Type: Permanent
Key Type: Scalix Standard
System Class: Multi-Server
Domain: scalix.com
ID: 42
LVID: 2010-12-31
Premium Users: 1000
Standard Users: 5000
Features: TNEF WIRELESS MIGRATION HIGH_AVAILABILITY MULTI_INSTANCE MULTI_SERVER RECOVERY_FOLDER ARCHIVER
Option: Name=ActiveSync;Expiry=2010-12-31;EnabledUsers=1000
License File: /var/opt/scalix/sl/s/LicenseKeys/permanent.lic
License Fingerprint (MD5): 28:4E:FD:FC:0D:5D:E4:9E:58:14:33:59:EA:33:CE:11

scalixmail:~ # sxlicense -u
   Scalix License Usage

Local Usage

  Premium Users:     56
  Standard Users:      3
  Can ActiveSync: 54

Totals
  Premium Users:     381
  Standard Users:      67
  Can ActiveSync: 54

Method 2 - SAC

1. Login to SAC as a Full administrator
2. Click on the "Settings" icon in the toolbar
3. Select your Scalix server from the list of mail servers in the tree view
4. Click on the "License" tab in the right pane

Enabling a User for ActiveSync

Method 1 - Command Line

scalixmail:~ # omshowu -n "Joe User"
Authentication ID: joeuser
Globally Unique ID: 19b10000daaa2864-9.0.61.271
User Name : Joe User /CN=Joe User
MailNode : scalix1
Internet Address : "Joe User" <Joe.User@scalix.com>
System Login : 60588
Password : set
Admin Capabilities : NO
Mailbox Admin Capabilities : NO
Language : C
Mail Account: Unlocked
Last Signon : 04.24.09 16:44:19
Receipt of mail : ENABLED
Service level : 0
Excluded from Tidyall : NO
Recovery Folder visible : NO
User Class : Full
ActiveSync : YES
SIS URL : sxidx://scalix1.scalix.com/09b10000daaa2864-9.0.61.271

scalixmail:~ # ommodu -n "Joe User" --activesync yes
ommodu: The user was modified successfully

scalixmail:~ # ommodu -n "Joe User" --activesync no
ommodu: The user was modified successfully

Method 2 - SAC

1. Login to SAC as a Full, Mailnode or User Administrator
2. Click on the "Users" icon in the toolbar
3. Select the user from the list of users in the tree view
4. Click on the "Mobile" tab in the right pane

Client Setup

The following section contains a Quick Configuration Guide for several Client devices. Please note that only the mandatory settings are mentioned. For a complete documentation of available options please refer to the clients documentation.

All examples are based on the following setup:

• Scalix ActiveSync Server: activesync.company.com (available via SSL, port 443)
• Authentication Id: active.sync@company.com
• Password: Wireless
  
• E-mail address: active.sync@company.com

Windows Mobile

Please note that Windows Mobile devices need an SSL enabled Scalix ActiveSync server as they refuse to use plain HTTP. If you are using a self signed certificate you will need to install it on your device by downloading the certificate to your computer, transferring it to the device and open it. The procedure can vary slightly based on the Windows Mobile version and device make and model used.

• Select "Start/Applications/ActiveSync" or "Start/Programs/ActiveSync"
  
• Select "set up your device to sync with it" or click on menu and select "Add Server Source"

• If screen asking for Email address is displayed:
• De-select "Attempt to detect Exchange Server Settings automatically"
• Click Next

• Edit Server Settings
• Server address: activesync.company.com
• Select or De-Select "This server requires an encrypted (SSL) connection" as desired
  
• Click "Next"

• User Information
• User Name: active.sync@company.com
• Password: Wireless
• Domain: <any value> (including an empty value; this will be ignored by the Scalix ActiveSync server)
  
• Click "Next"

• Choose the data you want to synchronize
• Select or De-Select "Contacts"
• Select or De-Select "Calendar"
• Select "E-mail"
• De-Select Tasks
• Click "Finish"
  

Apple iPhone

• Select Settings from the default screen
• Select Mail, Contacts, Calendars
• Select Add Account
• Select Microsoft Exchange
• Email: active.sync@company.com
• Username: active.sync@company.com
• Password: Wireless
• Select "Next"
• Server: activesync.company.com
• Select "Next"
• Synchronize settings
  
• Mail: On
• Contacts: On/Off
• Calendar: On/Off

Nokia E61i (Symbian)

To use ActiveSync on your Symbian device you will first need to install the Mail for Exchange application. Please note that you can only use one Push Mail provider at any given time, e.g. Blackberry Sync or Mail for Exchange. You can download Mail for Exchange from your device manufacturer's website. For Nokia devices you will find it here:

After finishing the installation create a new Mail for Exchange profile:

• Connection Tab:
• Exchange Server: activesync.company.com
• Secure connection: Yes
• Access point: <choose one (see below)>
• Use default port: Yes
• Credentials Tab
• Username: active.sync@company.com
• Password: Wireless
• Domain: None
• Sync content
• Synchronize calendar: Yes
• Synchronize tasks: No
• Synchronize contacts: Yes
  
• Synchronize e-mail: Yes
• Sync schedule (Choose appropriate values)
• E-mail
• E-mail address: active.sync@company.com

After creating the profile you will see an status overview similar to this:

Sync mode
 Off-peak: Every 30 minutes

Current status
 Idle

Last sync
 12/08/2008 17:58 Complete

Content synced
 E-mail

As you can see above the device is in Off-peak mode and will sync only every 30 minutes. You can force a sync either via Options/Synchronize or by selecting the "Current status" line.

Additionally you can access log data by activating the "Last sync" line.

Choose an Access Point that enables you to reach your Scalix ActiveSync machine. Depending in your setup this may either be a WIFI or 3G/GPRS.

Support

Scalix ActiveSync is covered by commercial Scalix Support Entitlements. Please see http://www.scalix.com/support for details. The page also contains a link to the Support Case request form.

If you make use of the above link to report an issue, please provide us with as much information as possible, e.g.:

• Scalix version on Back end system
• Scalix version on ActiveSync server
• OS Version (including patch level) on Backed and ActiveSync system
  
• Device used
  
• Firmware version of device
• Version of used ActiveSync Software on device (if any)
  
• Type of connection used (wifi, gprs, 3g, ...)

Known issues