Zimbra Connector for Outlook 5.0
Table of Contents Previous Next


Zimbra Connector for Outlook

Zimbra Connector for Outlook
With the Zimbra™ Collaboration Suite Connector for Outlook (ZCO), users can use Microsoft® Outlook® 2003 and 2007 to access the Zimbra Collaboration Suite server and synchronize data with Outlook for offline use. ZCO is a MAPI service provider that is installed on users’ computers.
Important: Client computers must have Microsoft Office Outlook 2003 SP1 or later installed. See Microsoft’s support article http://support.microsoft.com/?id=823633.
Email messages, address books, tasks, personal calendars, and tags are synchronized with the Outlook 2003/2007 client. Zimbra Collaboration Suite server-side configuration for accounts is enforced for Outlook users.
Downloading ZCO Installation Program
The ZCO .msi file and user instructions can be downloaded from the ZCS administration console, Downloads page. The install program for ZCO is in the Windows Installer .msi format so that it can be easily deployed to individual computers using your group policy software deployment process. Alternately, you can copy the .msi file to a directory that users can access and instruct your users to download the file directly.
The ZCO Installation Program
When ZCO is installed, the server name, port, and whether to use a secure connection must be set for every user. Users enter this information when they create their profile.
Optionally, administrators can customize the ZCO .msi file, adding the server, port, and connection information to the install script. If the .msi file is customized, end users only need to enter their email address and password.
Optional step to modify the ZCO .msi file
To modify the .msi file, Zimbra created a Java Script file that runs under the Windows Scripting Host. This file, called ZmCustomizeMSI.js, can be found in the Zimbra download directory on the administration console.
1.
Copy the ZmCustomizeMSI.js file and the ZCO .msi file to a computer running the Windows platform.
Note: The ZCO .msi file name is different from the example shown here. Please note the exact file name when you download it.
2.
Open the Windows Command Prompt and go to the directory where the ZmCustomizeMSI.js file is saved. For example, if it is saved in the temp folder on your C drive, you would type cd c:\temp.
3.
cscript ZmCustomizeMSI.js <path/msi-filename> <servername> <port> <1 | 0>//nologo
Press Enter and the ZCO .msi file is modified.
The cscript command includes the following:
Name of the .js file (ZmCustomizeMSI.js)
Port number to be configured. For non-secured connections, the default is 80. For secured connection, the default is 443. Your configuration can be different. (port)
Whether User Secure Connection should be checked. Enter 1 for the secure connection using a HTTPS connection or enter 0 to use a HTTP connection. (1 | 0)
Example:
cscript ZmCustomizeMSI.js ZimbraOlkConnector.msi server.example.com 443 1
//nologo
4.
To verify that the modification is correct, you can run the .msi installer and create a dummy profile. The Zimbra Server Configuration Settings dialog should include the server name, server port, and the check box marked/unmarked.
This modified .msi file should be saved to a directory that users can access to download the file to their computers.
Steps to Install the ZCS Connector for Outlook
It only takes a few minutes for users to install ZCO on their computers and configure the connection to the Zimbra server. The user’s Zimbra account must be created, but no specific changes are required on the Zimbra server. Installing ZCO creates a mail profile named Zimbra and designates it as the default profile in Outlook.
If you did not modified the .msi file (as described in “Optional step to modify the ZCO .msi file” ), users will need to know the following in order to complete the installation:
Which server port is used. For non secured connections, the default is 80. For secured connection, the default is 443. Your configuration can be different.
Whether to check Use Secure Connection (SSL). This box is checked to establish a secure connection to that port.
The following describes the installation and configuration steps that are performed on each computer. User instructions can be downloaded from the administration console Download page. Save the user pdf file to a directory that users can access before they install ZCO.
1.
When the MSI installer starts, a Welcome dialog displays, followed by the End-user License Agreement. Users read the license agreement and click I accept the terms in the License Agreement, to continue.
2.
When the Confirm Installation page displays, click Next to begin the installation. The dialog displays the progress bar. When the installation is complete, Installation Complete dialog displays.
3.
Users open Outlook, and if you did not modify the .msi file, complete the Zimbra Server Configuration Settings dialog as follows.
Server Name. This is the Zimbra server domain name (DNS).
Server Port. Enter the port number for the server. For non secured connections, the standard port is 80. For secured connection, the standard port is 443. Your configuration can be different.
Use Secure Connection. Check this box to establish a secure connection to that port.
4.
Users enter their email address in the Email address field and their Zimbra account password in Password. The address should be entered as name@domain.com
5.
They click OK and the installation and configuration of ZCO is complete. The Zimbra profile is created.
Final Steps—Initial Sync
Users can now log on and use Outlook. The first time users work within Outlook’s mail, calendar, tasks, or contacts folders, Outlook automatically syncs with the Zimbra server. If users have been using the Zimbra Web Client and have email messages, tags, address books with contacts, and calendar appointments on the Zimbra server, this information is synchronized with their Zimbra profile in Outlook. The initial synchronization can take a few minutes.
If users create the default Zimbra profile, their synchronized files are saved in the zimbra.zdb file located in the user’s Local Settings\Application Data\Microsoft\Outlook folder. In Outlook 2007, this data is stored in the user’s Application Data\Microsoft\Outlook folder.
If users used Notes and Journal in Outlook, these items will be lost when an initial sync is performed. In order to keep their Notes and Journal entries, users should save these Outlook items in pst format before syncing and then import the pst file after the initial sync is performed.
Note: If you are running McAfee® Security On-Delivery E-mail Scanner feature, the initial sync is very slow. We recommend that this option be turned off for the initial sync with the Zimbra server.
Users can click Tools>Send/Receive>Send/Receive All (shortcut key F9) to update Outlook and the Zimbra server with changes made since the last sync.
Important: When the Zimbra server is restored from a Zimbra backup session, users will need perform an initial sync with the Outlook client when they log on.
ZDB Configuration Options
ZCO supports relocating a ZDB file, also known as a roaming profile, as well as ZDB file compaction. You must be logged in on the user’s account to configure their ZDB settings. Further instructions for configuring a user’s ZDB settings are in the How to Install and Use Zimbra Connector for Outlook end user guide.
Repairing ZCS Connector for Outlook
You can use the same version of the ZCO .msi file to repair the ZCO software on individual computers. When the .msi file is opened after ZCO is installed, it automatically opens with the options to repair the connector or to remove the software.
Repair will reinstall the software again.
Remove the Outlook Connector removes all components.
Note: You can also remove ZCO from the computer’s Control Panel, using the Add or Remove Programs tool.
Removing ZCO does not remove the profile or .zdb files. Users will need to delete these items manually.
Resolving Mailbox Sync Problems
In the event that a user’s mailbox cannot receive new mail, becomes out-of-sync, or the .zdb file becomes corrupted, you can either:
Choose to force an initial sync of the user’s mailbox. To do this, have the user create another profile, open Outlook, and click Tools>Send/Receive>Send/Receive All to sync with the Zimbra server.
Have the user delete the existing .zdb file and then click Tools>Send/Receive. This deletes all data on the user’s computer and recreates the mailbox from the data that is on the Zimbra server, but keeps the same profile.
In some cases, it may be necessary to uninstall the .msi file, delete the profile and .zdb file and start over.
Important: When the Zimbra server is restored from a Zimbra backup session, users should resync Outlook with the Zimbra server.
Removing ZCO files
To remove ZCO completely from the computer, delete the .zdb file and the user’s profile, and uninstall the ZCS Connector .msi file.
Note: Users can use the Outlook File>Import/Export feature to save their Outlook folders that do not sync with the Zimbra server. These files can be imported back into Outlook, using the ZCS Import Wizard for Outlook.
1.
Users must delete the .zdb file.The .zdb file includes all the Outlook data from the Zimbra server. The file is usually in the user’s Local Settings\Application Data\ Microsoft\ Outlook folder. In Outlook 2007, this is in the user’s Application Data\Microsoft\Outlook folder.
Note: If they cannot see this file, users should change the Folder Options/View to Show hidden files and folders.
2.
Users must delete their Zimbra profile. If users accept the defaults when they installed ZCO, a profile called Zimbra was created. To delete this file:
a.
Go to the Control Panel and select Mail.
b.
Click Show Profiles. The General tab lists all the profiles on the computer.
c.
d.
5.
Go to the Control Panel, select Add and Remove Programs and remove the ZCS Connector for Outlook program.
Troubleshooting Options
If the Outlook client is not synchronizing with the Zimbra server or if Outlook is not working correctly, several options are available to troubleshoot the problem:
If the initial sync did not work, run the .msi file again and select Repair to see if reinstalling ZCO resolves the problem.
If Outlook closes unexpectedly (e.g. with the warning “Outlook...needs to close”), generate core dumps for Outlook. Go to the Zimbra Wiki CoreDump page (located at http://wiki.zimbra.com/index.php?title=CoreDump) for directions. The core dump shows what Outlook was doing at the time of the crash. This file should be sent to Zimbra support, at support@zimbra.com.
If Outlook is hanging, or behaving strangely, run the Logging Control tool that is installed when ZCO was installed. See “Using ZCS Connector for Outlook Logging Control for Troubleshooting” . Send this file to Zimbra support, at support@zimbra.com.
Reviewing Sync Issues Folders
When ZCO is installed, a Sync Issues folder with subfolders is created in the user’s Folder List. If errors are found when Outlook with the Zimbra server, messages with attachments are automatically added to these folders. Users can tell when messages are in these folders if the folder is bold and the number of unread messages is displayed.
If users are having problems using Outlook and continuously receiving errors, the messages in these folders should be forwarded to sync_issues@ zimbra.com. These messages are created to help Zimbra technical support and engineering debug and fix errors.
Using ZCS Connector for Outlook Logging Control for Troubleshooting
If users encounter problems when logged on to Outlook, you can have them enable debug logging using the ZCS Connector for Outlook Logging Control. Logging Control should be used for all troubleshooting. Once you have enabled logging and have recreated the issue, you can then send this log to Zimbra Support for analysis.
ZCOLogCtl.exe is installed when ZCO is installed. Logging Control is in the local ID directory, \Program files\Common Files\System\MSMAPI\1033.
If users encounter problems with synchronization, such as not receiving their mail, system crashes, or other unusual behavior, you should direct users to open Logging Control and select Enable Logging in order to log internal API calls and communication between Outlook and the Zimbra Server.
Note: Enable Logging should be unchecked to disable logging when not being used for troubleshooting. If logging is on continuously, performance may be affected. Additionally, using options such as Verbose Logging and Keep Logging may adversely affect performance and disk space.
The following options can be specified:
HTTP Logging. Enabling HTTP logging will log any HTTP connections.
Verbose Logging. Enabling verbose logging will create more detailed logs, but may affect performance.
Keep Logging. When you enable this option, ZCO logging saves more than one backup log file. By default, only one backup log file is saved.
Log File Path. In this field, you can specify in what directory log files should be saved.
Log File Prefix. In this field, you can specify the prefix for log files.
Maximum Log File Size. You can indicate the maximum size of a log file. The default log file size is 10 megabytes. When the size of the log reaches the limit, the current log is set aside and a second log is created.
After enabling logging from the Logging Control dialog, direct users to restart Outlook. When users restart Outlook, all their activities are logged. Users should attempt to recreate activities that are causing the problems.
Important: Users must restart Outlook before errors and events can be logged.
When the problem has been recreated, you can then send the log files to Zimbra. Open Logging Control again and click Send Log to Zimbra.
Note: Outlook must be restarted when you make changes with the ZCOLogCtl.exe file.
Finding Previous Outlook Profiles after ZCO Installation
Installing the connector does not remove any email accounts. It creates a separate new mail profile, by default called Zimbra, which does not conflict with any existing profiles/accounts. To see existing account profiles, navigate to Start>ControlPanel>Mail>Show Profiles.
Zimbra Feature Differences for Outlook Users
Zimbra Collaboration Suite offers account configuration by Class of Service and by account. When the client uses Outlook, many of the features and options configured for the Zimbra account are not enforced in Outlook. Only restrictions that are controlled by the server are enforced.
Users can configure their own Outlook preferences. These are not synchronized with the Zimbra server.
Zimbra COS features and Global Settings that are enforced include the following:
Account quotas. Users can use Outlook Archiving to save files to their computer to prevent going over their quota limit. Archiving removes the messages from the Zimbra server.
When you view an account’s mailbox from the administration console, the view is from the Zimbra Web Client and may not contain files in Outlook that have not been synchronized.
Note: When items are archived in Outlook (Outlook auto archive or manually), the items are removed from the Zimbra server.
In addition, the following Zimbra features do not work in Outlook.
The Outlook Rules and Alerts feature does not work with the Zimbra server. Users can use Tools>Zimbra Server Rules to set up Rules and Alerts.
Out of Office Reply is not available from Outlook. Users can log on to the Zimbra Web Client to set up and turn off their out-of-office alerts.
If the Maximum size of an uploaded file (KB) field is set to 0 in the ZCS Global Settings>MTA tab, messages sent through Outlook cannot be delivered.
--------------------------------------------------------------------------------
Zimbra, Inc.
Copyright © Zimbra, Inc. 2005-2007. All rights reserved.
The Zimbra logo and logo type are trademarks of Zimbra, Inc. All other trademarks are the property of their respective owners.
12042007
 

Zimbra Connector for Outlook 5.0
Copyright © 2007 Zimbra Inc.