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.
Email messages, chat archives, folders, tags, contacts, personal distribution lists, personal calendars, appointment reminders, and tasks are synchronized with the Outlook 2003/2007 client. Zimbra Collaboration Suite server-side configuration for accounts is enforced for Outlook users.
The ZCO .msi file and user instructions can be downloaded from the ZCS Administration Console’s 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. Alternatively, you can copy the .msi file to a directory that users can access, and instruct your users to download the file directly.
When ZCO is installed, the server name and whether to use a secure connection must be set for every user. Users enter this information when they configure their account.
Optionally, administrators can customize the ZCO .msi file, adding the server and connection information to the install script. If the .msi file is customized, end users only need to enter their email address and password.
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.
Press Enter and the ZCO .msi file is modified.
The cscript command includes the following:
|
•
|
servername. Zimbra server domain name (DNS) to be configured in the .msi file .
|
|
•
|
port. 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.
|
|
•
|
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)
|
|
n
|
Password Required. Set the password rule to require users to log in every time they retrieve their email. 1 means that the encrypted password is saved in their profile. (default). Users do not need to enter their password when they open ZCO. 0 means that the password is not saved. Users are prompted to enter their passwords whenever they sync to the server.
|
|
n
|
GAL sync mode. 2 to disable GAL sync. 1 to make GAL sync a manual option only. 0 for GAL syncs to occur automatically every x days. The interval is controlled by the -gsr switch below. The default is every 7 days. Note that with this option, users can also sync the GAL manually.
|
Installing ZCO creates an Outlook mail profile named Zimbra and designates this profile as the default. This does not remove any previous profiles/accounts. Previous profiles can be viewed by navigating to
Start>ControlPanel>Mail>Show Profiles.
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.
|
n
|
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’s Download page. Save the user instructions to a directory that users can access before they install ZCO.
|
•
|
Server Name. This is the Zimbra server domain name (DNS).
|
|
•
|
Email address. This is their Zimbra account email address. The address should be entered as name@domain.com.
|
|
•
|
Password. This is their Zimbra account password.
|
|
4.
|
They click OK and the installation and configuration of ZCO is complete. The Zimbra profile is created.
|
The first time users open Outlook after ZCO is installed, their Outlook mailbox must synchronize with the Zimbra server. If users have been using the Zimbra Web Client and have email messages, chat archives, folders, tags, contacts, personal distribution lists, personal calendars, appointment reminders, and/or tasks on the Zimbra server, this information is synchronized with their Zimbra profile in Outlook. The initial synchronization can last a few minutes or longer, depending on the size of the mailbox being synchronized.
If users create the default Zimbra profile, their synchronized data is saved in the
zimbra.zdb file located in the user’s
Local Settings\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.
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 user guide.
|
n
|
Repair. This will reinstall the software.
|
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.
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.
|
n
|
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.
|
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:
When ZCO is installed, a Sync Issues folder with subfolders is created in the user’s Outlook Folder List. If errors are found when Outlook syncs with the Zimbra server, a sync failure notification is sent to both the user’s Inbox and the Sync Issues folder. To turn off local failure notifications to the user’s Inbox, deselect
Errors to Inbox under the
View menu.
To view the Sync Issues folder, click the Folder List icon in the Navigation Pane. The Sync Issues folder is displayed in the Folder List. Users can tell when new 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 submitted with a support case to Zimbra Support. These messages are created to help Zimbra technical support and engineering debug and fix errors.
ZCOLogCtl.exe is installed when ZCO is installed. If users encounter problems when accessing their Zimbra accounts using ZCO, you can enable the logging control tool to log errors and events that occur while they are using ZCB. 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 for analysis.
This logging control tool is in the local ID directory, \
Program files\Common Files\System\MSMAPI\<LCID> where LCID refers to the local ID of the user. For USA English, this ID is 1033.
|
n
|
Verbose Logging. Enabling verbose logging will create more detailed logs, but may affect performance.
|
|
n
|
Keep Logging. When you enable this option, the logging control tool saves more than one backup log file. By default, only one backup log file is saved.
|
|
n
|
Log File Path. In this field, you can specify in what directory log files should be saved.
|
|
n
|
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. If the log file size is set to 0, the size of the log file is unlimited.
|
Note: Enable Logging should be unchecked to disable logging when not being used for troubleshooting. If logging is on continuously, performance may be affected.
When ZCO is installed, the Zimbra Support Toolbar is added to the Outlook Views menu. If a user is having issues with specific emails or folders, you can use this toolbar to collect information to help debug the issue.
To access the Zimbra Support Toolbar, go to View>Toolbars>Zimbra Support. You can also access this toolbar by right-clicking the toolbar area and selecting
Zimbra Support from the Toolbar menu. The Zimbra Support Toolbar will be added to the Toolbar View.
The Show Properties button shows a subset of the MAPI properties of an item. You can view MAPI properties of a message and of the folder the message is in by selecting either
Message or
Folder in the lower left of the MAPI properties dialog. You can save the MAPI properties of an item to a file by clicking
Save to File.
The Show Original button opens the source of the original item in the default Internet browser. The browser will prompt you for the account login information before you can view the item. The source text includes the Zimbra Item ID, Folder ID, and any other information contained in the original item (such as tags, flags, header information, etc.).
The Open By Zimbra Id button allows you to view an email, appointment, task or other item in Outlook by its Zimbra Id. You can also find the Zimbra Id of an item by using the Show Original button in the Zimbra Support Toolbar, or by the number listed in a Local Failure Notice.
The Set Sync Token button allows you to set the Zimbra Sync Token. Sync Tokens track the syncs between an Outlook client and the Zimbra Server. Sync Tokens increase in numerical value between one sync and the next. Setting a Sync Token to an earlier number allows you to resync any items that failed to sync between the Sync Token you set and the current Sync Token.
For example, if an appointment fails to sync to a user’s Outlook client they will receive a Local Failure Notice in their
Inbox and
Sync Issues>Local Failures folders.
In this example, an appointment failed to sync. To resync this item and update the user’s Outlook client with the most information, the Sync Token must be set to before the request that failed. In this example, the Sync Token must be set to any token before or equal to 55080.
To set the Sync Token and attempt to resync an item that failed to sync, click Set Sync Token in the Zimbra Support Toolbar. The Update Sync Token dialog opens.
If your issue is not a known or common issue, or is persisting despite troubleshooting, you can use the following additional resources to search for information about your issue.
|
n
|
Web Search. If you cannot find a solution to your issue through the Zimbra Forums, you might be able to find other resources or information using a Web search. Go to http://search.yahoo.com and search for other resources by entering a brief description of your problem.
|
Zimbra Support can be contacted at support@zimbra.com. To provide the highest level of service, please gather the following information before contacting support.
|
n
|
Install logs. If you are experiencing issues with installing ZCO, please include the install logs. You can create install logs by running the following command.
|
|
n
|
Sync error messages. If you are experiencing issues with syncing, include any relevant error messages. You can find sync error messages in the Local Failures and Server Failures folders, located in the Sync Issues mail folder. For more information about the Sync Issues folder, see “Reviewing Sync Issues folders” .
|
Copyright © 2009 Zimbra Inc.
