Category Archives: Documentation

Outlook Connector and AddressBook setup.ini Script


Bynari Outlook Connector/AddressBook

setup.ini Script

 

To run Outlook Connector and LDAP AddressBook installer to automatically create profile and configure Outlook Connector and LDAP AddressBook. Note, for LDAP AddressBook, the profile need to exists to automatically configure the address book.

The path to setup.ini must be specified so that the installer can open setup.ini.

  • OutlookConnector-Installer.exe /y “[Full Path]\setup.ini”
  • LDAPAddressBook-Installer.exe /y “[Full Path]\setup.ini”

The setup.ini file is broken down into several components:

  • Misc
  • License
  • Profile
  • Export
  • Common
  • Connector
  • Free/Busy
  • LDAP

Each of these components will configure the Connector or AddressBook with the specified information provided in the setup.ini file.

Component Descriptions

[Misc]

  • Verbose=No
    • Provides verbose output information when creating profiles and when configuring the Connector and/or AddressBook.
      A log file path must be specified when using this option.
       
      Values
      • Yes
      • No
  • LogFile=
    • Specify a path and filename for the verbose installation output.
  • ShellExecAsOriginalUser=No
    • Run the installer helper executable as the original user or as administrator.
       
      Values
      • Yes
      • No

[License]

  • LicenseKey=12345678901234567890123456789012

[Profile]

  • NewProfile=Yes
    • Creates a new profile in Outlook during the Connector or AddressBook installation.
       
      Values
      • Yes
      • No
  • ProfileName=Bynari Outlook Connector
    • Outlook profile name. This is a user defined field.
  • ProfilePassword=
    • Creates an Outlook profile password.
      When left blank no password is set.
  • Options=Default
    • Values
      • Prompt
        Sets Outlook to prompt the user to select a profile to be used.
      • Default
        Sets Outlook to use the variable ‘ProfileName’ as the default profile.
      • None
        Does not change the settings Outlook already has.

[Export]

    ;Either have ProfileName or ExportPSTFile, not both

  • ProfileName=Outlook
    • Sets an Outlook profile name. This will override the ‘ProfileName’ variable.
  • ExportPSTFile=C:\Documents and Settings\jdoe\Local Settings\Application Data\Microsoft\Outlook\Outlook.pst
    • Set this option for the location of your Outlook “.pst” file. The above example gives the default directory scheme for Outlook 2003.
  • Folders=All
    • Values
      • Inbox
        Exports the contents of the inbox folder only.
      • All
        Exports all folders and mail messages.
  • LoginAsManager=No
    • Log in as “manager” to export the profile or pst file.
       
      Values
      • Yes
      • No
  • AddOutlookFormat=Yes
    • Creates Microsoft TNEF format during the export process.
       
      Values
      • Yes
      • No
  • AddiCal=No
    • Creates iCal attachments during the export process.
       
      Values
      • Yes
      • No
  • AddiKolab=No
    • Creates Kolab attachments during the export process.
       
      Values
      • Yes
      • No
  • Options=Show
    • Display the ExportPST wizard page.
       
      Values
      • Show
      • Hide

    [Common]

  • InstallPath=C:\Program Files\Bynari, Inc\InsightConnector
    • This install path will override the install path under the [Connector] parameter.
  • [Connector]

  • DisplayUI=No
    • Displays the configuration dialog
       
      Values
      • Yes
      • No
  • EnableAutoRegistration=No
    • When enabled, this option verifies the Connector license with the user’s Insight Server automatically each time Outlook is started. This feature is only available for users of the Insight Server.
       
      Values
      • Yes
      • No
  • AutoRegistrationPort=80
    • The port that auto registration uses to contact the Insight Server for proper license validation.
  • AutoRegistrationSSL=No
    • Enables SSL for auto registration
       
      Values
      • Yes
      • No
  • InstallPath=c:\Program Files\Bynari, Inc\InsightConnector
    • Installation path for the Outlook Connector.
      Note: This path will be overruled by the path specified in the [Common] parameter.
  • UpdateConfig=No
    • Update the existing connector configuration with the parameters in this setup.ini file.
       
      Values
      • Yes
      • No
  • AllowFoldersUnderInboxFolder=No
    • Allow folders to be under Inbox folder in Outlook.
       
      Values
      • Yes
      • No
  • HideToolbar=No
    • Hide the Outlook Connector tool bar when Outlook is open.
       
      Values
      • Yes
      • No
  • customCache=0
    • Specify a custom local cache location
       
      Values
      • 0 – No
      • 1 – Yes
  • localCacheDir=
    • Specify the path to the custom local cache directory.
  • auto_send_recv=0
    • Configures Outlook for automatic sending and receiving of email.
       
      Values
      • 0 – No
      • 1 – Yes
  • auto_send_recv_timeout=0
    • Configures the number of minutes Outlook waits between performing a send/receive functions. The value represents the number of minutes.
  • receiptResponse=1
    • How to respond to requests for read receipts on incoming messages.
       
      Values
      • 0 – Always send a response
      • 1 – Never send a response
      • 2 – Prompt me before sending a response
  • progressDialogThreshhold=50
    • This numeric value represents the minimum number of messages needed for the progress indicator to display.
      Values – any numeric value.
  • showProgressDialog=1
    • Configures the Outlook Connector progress indicator
       
      Values
      • 0 – No
      • 1 – Yes
  • DefaultStore=Yes
    • Configures the Connector to be the default store.
       
      Values
      • 0 – No
      • 1 – Yes
  • AccountDisplayName=BCS Folders
    • Configures the display name for the user account.
      User defined field.
  • ShowAllFolders=1
    • Configures the Outlook Connector to display all folders in IMAP store.
       
      Values
      • 0 – No
      • 1 – Yes
  • SendReceiveAllFolders=0
    • Configures the Outlook Connector to perform a send/receive on all IMAP folders every time Outlook performs the send/receive function.
       
      Values
      • 0 – No
      • 1 – Yes
  • DownloadHeadersOnly=1
    • Configures the Outlook Connector to download only email headers when retrieving email.
       
      Values
      • 0 – No
      • 1 – Yes
  • YourName=John Doe
    • Configures the “Name” field in the Outlook Connector account.
      User defined field.
  • Organization=Example Company
    • User defined field.
  • EmailAddress=jdoe@example.com
    • Email address of the user being configured.
  • IMAPUserName=jdoe@example.net
    • Enter the IMAP login user name.
  • IMAPPassword=password
    • Enter the IMAP user’s password.
      Note: Leaving this field blank will prompt the user for the password when Outlook opens for the first time.
  • RememberPassword=1
    • Configures the Outlook Connector to remember the IMAP user’s password.
       
      Values
      • 0 – No
      • 1 – Yes
  • ServerTimeout=0
    • Configures the timeout value of when the server disconnects from the client. Values are: 0, 30-600.
  • UsePersistentConnection=1
    • Configures the Outlook Connector to use persistent connection. Using persistent connections will prevent the need for repetitive connecting and disconnecting of Outlook each time a send/receive function is performed.
       
      Values
      • 0 – No
      • 1 – Yes
  • IncomingPort=143
    • Configures the Outlook Connector IMAP port. Default is 143
  • IncomingServer=mail.example.com
    • IMAP server address
  • UseIncomingSSL=0
    • Configures the Outlook Connector to use IMAP SSL.
       
      Values
      • 0 – No
      • 1 – Yes
  • SMTPUserName=jdoe
    • Enter the SMTP user’s name.
  • SMTPPassword=password
    • Enter the SMTP user name’s password
  • RememberSmtpPassword=1
    • Configures the Outlook Connector to remember the SMTP password.
       
      Values
      • 0 – No
      • 1 – Yes
  • UseIMAPAuthForSMTP=1
    • Configures the Outlook Connector to require authorization for SMTP
       
      Values
      • 0 – No
      • 1 – Yes
  • OutgoingPort=25
    • Configures the SMTP (outgoing) port. Default is 25
  • OutgoingServer=mail.example.com
    • Enter the SMTP server address.
  • UseOutgoingSSL=0
    • Configures the Outlook Connector to use SMTP SSL
       
      Values
      • 0 – No
      • 1 – Yes
  • RequiredSMTPAuth=1
    • Configures the Outlook Connector to require SMTP authentication.
       
      Values
      • 0 – No
      • 1 – Yes
  • UseSMTP_Auth=0
    • Configures the Outlook Connector to use SMTP authentication. RequiredSMTPAuth must be enabled to use this feature.
       
      Values
      • 0 – No
      • 1 – Yes
  • UseSMTP_TLS=0
    • Configures the Outlook Connector to use Transaction Layer Security (TLS).
       
      Values
      • 0 – No
      • 1 – Yes

[FreeBusy]

  • PublishRange=2
    • Number of months of calendar free/busy information to keep on the server.
  • UpdateFreeBusy=10
    • Value represents the number of minutes between free/busy updates from the client to the server.
  • ReadURL=http://mail.example.com/freebusy/%NAME%.vcf
    • This value is equivalent to the “Search location” under free/busy configuration in Outlook.
  • WriteURL=ftp://mail.example.com/freebusy/%NAME%.vcf
    • This value is equivalent to the “Publish at my location” value under free/busy configuration in Outlook.

[LDAP]

  • DisplayUI=No
    • Display the configuration dialog
       
      Values
      • Yes
      • No
  • UpdateConfig=No
    • Update the existing connector configuration with the parameters in this setup.ini file.
  • DisplayName=LDAP Address Book
    • Configures the name of the AddressBook
      User-defined field.
  • ServerName=ldap.example.com
    • Configures the Fully Qualified Domain Name of the LDAP server.
  • ServerPort=389
    • Configures the LDAP server port.
  • UseSSL=No
    • Configures SSL over LDAP
       
      Values
      • Yes
      • No
  • LDAPUserName=cn=John Doe,ou=Organization,o=Example.net
    • Value is equivalent to the “User DN” in the AddressBook 3.0 configuration dialog window.
      The User DN is comprised of a unique identifier for the user and the domain controller.
    • Insight Server uses a “container name” + “organizational unit” + “organization” combination. See above example.
    • neonInsight Server uses a “uid” + “domain controller” combination. See example below:
      uid=jdoe,dc=example,dc=net
  • LDAPPassword=
    • Enter the LDAP user’s password.
  • RememberPassword=No
    • Configures the AddressBook 3.0 to remember the LDAP user’s password.
       
      Values
      • Yes
      • No
  • SendMessagesInRTF=Yes
    • Configures messages to be sent in Rich Text Format
       
      Values
      • Yes
      • No
  • BaseDN=
    • The BaseDN is the top level of the LDAP directory tree.
  • ContainerDNs=
    • The ContainerDNs are usually comprised of both the organizational units and the organization in the LDAP schema.
       
      Example: ou=Sales,o=domain
      Leaving this option blank will require post-installation configuration.
  • SearchSubContainers=No
    • Configures the AddressBook 3.0 to search the LDAP containers for sub-entries.
       
      Values
      • Yes
      • No
  • SortOrder=First Name
    • Configures the AddressBook 3.0 to return the LDAP queries in a specified order.
       
      Values

      • First Name
      • Last Name
      • Display Name
      • Email Address
  • DefaultSearch=(|(objectclass=organizationalPerson)(objectclass=person))
    • Default search to search for the LDAP attributes for a user or group.
  • LDAPVersion=2
    • Configures the version of the LDAP server, currently versions 2 or 3.
  • LDAPTimeout=60
    • Number of seconds the client will timeout waiting for a response from the server.
  • LDAPRequireLogin=No
    • Require login each time Outlook starts.
  • RefreshCachAtStartup=No
    • Removes local cache each time Outlook starts.
  • SchemaFile=c:\myschemas.xml
    • Enables use of custom schemas.xml file.

BCS vs MS Exchange & Google Apps

MS Exchange®, Google Apps®

and BCS® Comparison

Feature
Exchange 20071 and 20101
Google Apps
BCS
Operating System – Platform
Maintenance – In-place upgrades
2
Updates without reboot
3 3
Virtualization Support
OS Type
SVR2003/08
Google Server
Linux
Processor Type
64 bit
64 bit
32/64 bit
User Features
Mobile Device Sync with Active Sync
4
Global Signatures
5
Forward mail inline or as attachments
Delegation
Instant Messaging
6
Task Management
Contact Managment
Shared Address Books
Authentication Type
7 8
Web-based Administration
9
Free/Busy Support
10
Cross-browser compatible WebClient
11 11
Out of Office Notifications
12 13
WebClient Features
Mouse Drag-and-Drop
14
Mouse Right-Click
Arrange by (sort order)
Flagging Messages
15 16
Junk E-Mail
17
Explicit Login
18
Scheduling Assistant
File Sharing with WebDAV
19
Search
20
Reminders and Notifications
21 21
Mail Compose Options
22 22
Spell Check
Calendar Options
23 23
Out of Office Assistant
24
Search Folders
Password Change within Webclient
25
Empty Deleted Items on logoff
Distribution List Support
Server-side Rules
Deleted Item Recovery
WebReady document viewing
26
Public Folders
SSL Support
Folder Sharing (any folder)
27
Custom Color Categories
28
Color coded Mail view by sender and domain
Reading Pane View (right, bottom, off)
Shared Calendar Viewing
29
Side-by-side Calendar Views
30
Search Contacts
Save Contact from email header
RSS Feeds
Microsoft Outlook
Compose, send, receive and forward email
Email formatting and spell check
Encrypting mail within the organization
Delegating mailbox access
Spam Control
Virus Control
Integrated centralized directory services
Read receipt
Signatures
Voting buttons
Folders
Folders within folders
Search within folders
Sort
Custom Views (list view)
Share folders
Tags/Categories
Labels associated with multiple emails
Flag emails for follow-up
Maximum message size >= 50MB
Search message by read/unread status
Full desktop email client integration
Offline mode
Mark as read
Filtering
Out of office assistant
Regional settings (select languages, dates and time zone)
Set storage restrictions on an individual mailbox
Archiving
Conversation threads
Inbox preview
Productivity Tools
Task lists
Tasks lists integrate with email
Task lists integrate with calendars
Prioritize tasks
Sort tasks
Keyboard shortcuts
Recurring tasks
Task reminders
Search task lists
Assign tasks to contacts
Share task lists
Delegate task lists
Import task lists
Export task lists
Sync task lists
Notes
Share notes
Delegate control of notes
Journaling
RSS integration
Public folders
Server-side rules and alerts
Programmable/Customizable through APIs
Single Sign-On
Calendar and Contacts
Scheduling Assistant: attendees, rooms and resources
Personal, shared and public calendars
Updates calendar and changes
RSVP to meetings
Contact list/address book
Contact list search
Scheduling with groups
Fully customizable contact list and display
Offline address book
Delegate control for contacts
Delegate control to calendar
Import/Export contacts
Distribution lists and groups
One-click holiday inclusion
Display multiple time-zones simultaneously in calendar
Add contact picture
Separate first and last name fields
Sync contacts & calendars with birthday/anniversary dates
Add a business card to contact list
Track all Outlook items related to a contact
Mobile
Use with iPhone, Android, Windows Mobile and Blackberry
iPhone two-way sync of mail, calendar, notes and tasks
Android two-way sync of mail, calendar, notes and tasks
Windows Mobile two-way sync of mail, calendar, notes and tasks
Remote wipe supported for Mobile devices
Contact groups available on mobile device
Blackberry two-way sync of mail, calendar, contacts, notes and tasks
Blackberry support with universal connector without need for BES

  1. Assumed “Premium Accounts” for Comparison
  2. You can upgrade the software but cannot do a migration from Exchange 2007 to Exchange 2010 on the same server
  3. Windows almost always requires a reboot on upgrades, BCS/Linux almost NEVER requires a reboot – reduces downtime
  4. IntelliPanel let’s end-users select “which” secondary calendar, contacts, or tasks they want sync’d with ActiveSync
  5. BCS not only supports global signatures, but signatures by domain. This gives Service Providers and Admins greater flexibility
  6. Additional Cost, not native to the server
  7. Authentication Type supports Active Directory Only
  8. BCS connects to Active Directory, OpenLDAP or Samba LDAP directories for greater flexibility to a user’s existing structure
  9. IntelliPanel gives greater flexibility to administrators on the go through secure, web-based admin controls (full admin)
  10. Free/Busy can be viewed in either the Groupware WebClient or in Outlook with Outlook Connector installed
  11. Exchange 2007 only worked with IE. Exchange 2010 resolves this, but BCS has always had interoperability with all browsers
  12. Out of Office is set in Outlook/OWA on Exchange
  13. Out of Office is set in IntelliPanel on BCS and IntelliMail as well as in Outlook
  14. BCS only supports drag-and-drop on mail items
  15. Exchange – flagged messages show up in user’s tasks.
  16. BCS – Flagged messages display under “Top Flagged Items”
  17. BCS supports rules to move message to Junk Email, right-click to empty folder
  18. BCS utilizes Access Control Lists for more granular control over folders access instead of Explicit Login
  19. Coming in next releae
  20. Exchange only returns the first 100 results in a search
  21. Both Exchange and BCS use a browser overlay for reminders
  22. BCS allows you to select plain text or HTML emails, signatures and auto-save messages
  23. BCS allows you to select the default view (day, week, month)
  24. In BCS, Out of Office is set in the IntelliMail Webclient or through user’s login of IntelliPanel and through the connector in Outlook.
  25. BCS passwords can be changed in IntelliMail and IntelliPanel to give Administrator better control
  26. BCS will support viewing XML documents in WebClient in a future release.
  27. Exchange 2007 does not support folder sharing. Exchange 2010 requires additional steps to share folders. BCS is simple and identical to the process used in Outlook
  28. BCS with Outlook Connector supports colored categories. BCS IntelliMail WebClient supports categories for Events only. For all others category settings are preserved
  29. BCS currently does not display calendar side by side. This feature is in a future release
  30. Exchange 2007 cannot display Calendar side by side

WebDAV Collaborator Installation and Configuration Guide

Bynari WebDAV Collaborator

Installation and Configuration Guide

 

Trademarks

Bynari products are trademarks of Bynari, Inc.

Microsoft Windows, Windows Mobile, Outlook, Windows XP, Windows Vista are all registered trademarks of Microsoft Corporation in the United States, other countries, or both.

BlackBerry is a registered trademark of Research In Motion Limited in the United States, other countries, or both.

All other trademarks are the property of their respective owners.

Technical Support

The WebDAV Collaborator comes with a perpetual use license and a courtesy 30 day support.  Additional annual support and maintenance can be purchased here: http://www.bynari.net/product/renew-support/. For large volume purchases contact sales@bynari.net.

Customers who are current on support continue to receive product maintenance, upgrades and email support.

Support is available to customers worldwide.

To contact technical support:

To open a new support ticket email: support@bynari.net.

For FAQs: http://www.bynari.net/users/kb.php

Licensing

The Bynari WebDAV Collaborator utilizes a licensing key system that assigns and stores the number of licenses that have been purchased by the customer. When Outlook starts, Bynari WebDAV Collaborator (WC) will contact the Bynari license key server over the Internet to validate and activate the installed license. Activation will be attempted each time Outlook is started or until activation of the license is successful.

Note: The license key server URL is http://update.bynari.net.

 

If you encounter any issues while activating your Bynari WebDAV Collaborator license, please see below for a possible solution:

  • The client systems may be blocked from accessing the Internet, or Internet access is temporarily unavailable.
  • The license key entered during the installation of the Bynari WebDAV Collaborator may be invalid. This could include issues such as an incorrect key or incorrect key version.
  • The number of user IDs for the licenses has been exceeded. The Bynari License Server tracks how many user IDs have been activated for each valid license. If there are attempts to activate more user IDs than were purchased for that license, the Bynari WebDAV Collaborator will inform you that additional licenses need to be purchased.
  • If you need to reinstall the Bynari WebDAV Collaborator software on a new system due to either hardware failure or system upgrade and need to unregister, do the following (See section 4.3 for complete details):
    • Open Outlook
    • Click on “About” tab in the Bynari WebDAV Collaborator toolbar
    • Click on “License”
    • Click on “Unregister”

If you experience problems with license activation, please contact your reseller or Bynari support at support@bynari.net.

Important Notes:

  • This documentation applies to the latest 1.0 build of the Bynari WebDAV Collaborator available from Bynari.
  • Make sure that Outlook is setup as the default e-mail client. To verify this on the workstation, go to Control Panel > Internet Options > Programs and make sure that Outlook is selected in the drop down box next to E-mail.

Table of Contents



1 Bynari WebDAV Collaborator version 1.0

The Bynari WebDAV Collaborator acts as a Microsoft Outlook COM Add-In.

1.1 Features of Bynari WebDAV Collaborator

Bynari WebDAV Collaborator 1.0 offers the following features:

  • Full Outlook 2003-2010 Support
  • Manual or Automatic Synchronization Schedules
  • Intuitive Interface

1.2 Supported Platforms

Bynari WebDAV Collaborator 1.0 is compatible with the following software. If you are using a version that is not listed, or software that is not supported, upgrade to a supported version.

Supported Windows® Versions

Windows® XP

Windows® Vista

Windows® 7

Supported Outlook® Versions

Outlook® 2003

Outlook® 2007

Outlook® 2010 (32/64 bit)

Supported Languages

  • English
  • French
  • German
Note: Other languages are provided and may be used but are not formally supported. Problems with translation, spelling, grammar and proper character encoding may be encountered.

1.3 Supported Servers

List of supported servers and how to configure WebDAV Collaborator.

2 Installation

2.1 Preparing Your System (Pre-Installation)

Before you begin:

The WebDAV Collaborator 1.0 software must be installed by the Windows login user. Additionally, this user needs “administrator” rights to install the software. The users’ rights can be changed to install the WebDAV Collaborator and then reset to the original rights.

Before you begin the installation procedure, perform the following steps:

Step 1: Install Microsoft® Windows and/or Microsoft® Outlook

Supported Windows® Versions

Windows® XP

Windows® Vista

Windows® 7

 

Supported Outlook® Versions

Outlook® 2003 SP3+

Outlook® 2007 SP2+

Outlook® 2010 SP1+

Note: If you are using versions that are not listed, upgrade to a supported version.

Step 2: Install the Latest Updates for Microsoft® Windows and Outlook

Go to the Microsoft® website or check with your IT Administrator to verify that you have installed the most current critical updates and service packs for both your Windows operating system and Outlook.

http://update.microsoft.com – Microsoft® updates.

Outlook 2003 minimum required version to install

  • Click on “Help” > “About Microsoft Office Outlook”


Figure 1 – Outlook 2003 about dialog

Outlook 2007 minimum required version to install

  • Click on “Help” > “About Microsoft Office Outlook”


Figure 2 – Outlook 2007 about dialog

Outlook 2010 minimum required version to install

  • Click on “Help” > “About” and then click on “Additional Version and Copyright Information”


Figure 2.3 – Outlook 2010 about dialog

2.2 Installing Bynari WebDAV Collaborator – New Installation

The Bynari WebDAV Collaborator 1.0 Install Wizard standardizes the installation process for Outlook.

The following section explains how to install the Bynari WebDAV Collaborator 1.0 for the first time on a computer. The “upgrade” process is slightly different and available in the section 2.4 of this manual.

Note: The Bynari WebDAV Collaborator will only install on systems where the user has “administrative” rights. The users’ rights can be changed to install the Bynari WebDAV Collaborator and then reset to the original rights after the installation has completed.

 

Important Information: In some cases, virus scanning add-ins for Outlook may need to be disabled for the installation of the Bynari WebDAV Collaborator. Disabling the virus scanning Outlook add-in should not change the functionality of your antivirus software.

Before you begin:

  1. Verify that all steps in “Preparing Your System” (Pre-installation) section 2.1 are complete.
  2. Unzip the Bynari WebDAV Collaborator 1.0 compressed file by right-clicking and selecting “Extract All”.

    Figure 3 – Installation – Downloaded zipped Bynari WebDAV Collaborator
  3. Double Click on the installer.
    Figure 4 – Installation – Bynari WebDAV Collaborator Installer Package
  4. Welcome Dialog:
    Double click the installation setup file to start installation. The setup wizard will display the “Welcome Dialog” window. Select “Next” to continue with the installation process.
    Figure 5 – Installation – Bynari WebDAV Collaborator welcome dialog – Setup Wizard
  5. End User License Agreement:
    Read the license agreement. If you agree, select the button, “I accept the license agreement” and select “Next”.
  6. Select Destination Location:
    The default installation destination for the Bynari WebDAV Collaborator is:
    C:\Program Files\Bynari, Inc\InsightWebDAV Collaborator. A custom installation location may be used. Select the “Browse” button to choose an alternate location to install the Bynari WebDAV Collaborator. Click “Next” to continue the installation.

    Figure 6 – Bynari WebDAV Collaborator – Select Destination Location
  7. Ready to Install:
    Review configuration settings and select “Install” to install the Bynari WebDAV Collaborator. Click “Next” to continue the installation.
    Figure 7 – Bynari WebDAV Collaborator – Ready to Install
  8. Setup Complete:
    To automatically start Outlook, place a check in the box labeled “Run Outlook” and select “Finish”.
    Figure 8 – Bynari WebDAV Collaborator – Finish Install Wizard

2.3 Installation Logs

Error Logging

This feature is only activated during a new installation of the Bynari WebDAV Collaborator when a new profile is created. Error logging is not enabled during the upgrade process.

Viewing the Log File

The Bynari WebDAV Collaborator generates a log file named “Bynari.log” in the user’s %TEMP% directory during the installation process.

Viewing the Log File:

  1. Select “Start” > “Run”.
  2. Type %TEMP% on the Run input field and select “OK”.
  3. A new explorer window will open displaying the contents of the user’s %TEMP% directory.
  4. Browse this directory for a text file named “Bynari.log”. This file can be viewed with any text editor.

Technical Support Logging

The Bynari WebDAV Collaborator also offers additional logging capabilities for troubleshooting. These logs are located under: %AppData%\Local\Bynari\WebDAV Collaborator\

There are both “log” and “trace” directories located here.

To turn on logging, go to the WebDAV Collaborator toolbar and click on:

Settings

When working with Bynari Technical Support, “verbose” logging will be required for troubleshooting.

3 Basic Configuration

3.1 Configure

Begin the WebDAV Collaborator configuration process by selecting “Configure” from the “File” menu under “WebDAV Collaborator”. This will display the “WebDAV Folder Settings” window Collaborator Toolbar.

Figure 9 – Bynari WebDAV Collaborator Toolbar

3.1.1 WebDAV Folder Settings

In the “WebDAV Folder Settings” window click the “Add” button.

Figure 10 – Bynari WebDAV Collaborator – Folder

3.1.2 Folder List

You are now presented with a list of folders which the WebDAV Collaborator can sync for you. The configuration process is the same for each of the folders in this list. In the following steps we configure a calendar, as an example.

Figure 11 – Bynari WebDAV Collaborator – Folder List

3.1.3 Choose a Folder

Click on the desired folder, then click the “OK” button.

Figure 12 – Bynari WebDAV Collaborator Choose a Folder

3.1.4 Folder Settings

The folder settings window will display the folder mappings to the WebDAV server. Complete all fields required by your WebDAV server, then click the “Detect Account Settings” button. If you are unsure of the settings required by your server, contact your server administrator.

Figure 13 – Bynari WebDAV Collaborator Folder Settings

  • Folder Display Name
    Outlook folder name configured to WebDAV server.
  • Folder Type
    Type of folder.
  • Folder Path
    Folder path in Outlook local cache file.
  • Username
    WebDAV Server login user name
  • Password
    WebDAV Server user login password
  • E-Mail
    WebDAV Server e-mail associated with the account, can be different from Username
  • Server URL
    WebDAV Server URL to synchronize with. You can use a short URL for WebDAV Collaborator to figure out the URL if the server supports ‘Principal’ request.Default Server URL for BCS Server 7.4+ are:
    Calendars: http://server/dav/calendars/
    Contacts: http://server/dav/addressbooks/
  • Synchronize when Outlook shuts down
    If enabled, WebDAV Collaborator will synchronize the data before Outlook will exit
  • Detect Account Settings
    Button to detect the account settings and URL is correct or display a list of URL from the WebDAV Server principal request
  • Synchronize Interval in Minutes
    Select synchronization interval for this folder. See “Default Settings” for more information.
  • Conflict Resolution
    Select how to handle conflicts between client and server data. See “Default Settings” for more information.
  • Synchronization Modes
    Select how the synchronization will perform of merging data, client is master or server is master. See “Default Settings” for more information.
  • Default…
    Display Default WebDAV Collaborator Settings
  • Deleted
    Delete the currently selected folder mapping
  • Add…
    Add a new folder mapping
  • OK
    Accept to save the changes
  • Cancel
    Cancel any changes made to the folder mappings

3.1.5 Detect Account Settings

The “Detect Account Settings” window will attempt to detect and display calendar or contacts folders from the WebDAV server.


  • Figure 14 – Bynari WebDAV Collaborator – Detect Account SettingsIf the WebDAV Server returned a list of folders, you can select the folder to accept the full URL to map Outlook’s folder to the server.

  • Figure 23 – Bynari WebDAV Collaborator – Detect Account Settings ErrorIf the server could not resolve the URL, WebDAV Collaborator, contact your system administrator for assistance.

3.1.6 Create and Delete Folders on Server

WebDAV Collaborator can create and delete folders from the server. The URL must be part of the URL principals to be able create and delete folders.


Figure 15 – Bynari WebDAV Collaborator – Create Server Folder

Once the folder is created or deleted, the list of folders from the server will be updated.


Figure 16 – Bynari WebDAV Collaborator – Server Folders

When deleting a folder, WebDAV Collaborator will prompt you if you want to delete the folder from the server.


Figure 17 – Bynari WebDAV Collaborator – Delete Server Folder

3.1.7 Successful Test

If you have a reliable network connection to the server, and you have correctly entered the settings required by your WebDAV server, you will receive a “URL successfully detected” message. If you do not receive this message, contact your WebDAV server administrator.

Figure 19 – Bynari WebDAV Collaborator – URL successfully detected

3.1.8 Default Settings


Figure 30 – Bynari WebDAV Collaborator – Default Settings

  • Synchronization Interval in Minutes
    1. Manual
      Manually synchronize using WebDAV Collaborator’s “Synchronize” button
    2. In Minutes
      WebDAV Collaborator will automatically synchronize the data.
  • Synchronization Modes
    1. Outlook is the master, remove anything on the server not already in Outlook
    2. Merge Outlook data into the server
    3. Server is the master, remove anything in Outlook that is not on the server
    4. Merge server data into Outlook
    5. Keep both Outlook and the server data by merging data both ways
  • Conflict Resolutions
    1. Outlook always win
      All changes and new data is ignored on the server and will be removed from the server
    2. Server always win
      All changes and new data is ignored in Outlook and will be removed from the Outlook
    3. Ask Me
      WebDAV Collaborator will prompt what action to perform on each conflict.
  • Synchronization when Outlook shuts down
    If enabled, WebDAV Collaborator will synchronize the data before Outlook will exit
  • Timeout Value (in seconds)
    Connection time out value in seconds
  • Log Settings
    Select which level of logging to log to the log files.

3.1.9 Synchronize

Select Synchronize from the menu under “WebDAV Collaborator” to manually synchronize the data.

Figure 21 – Bynari WebDAV Collaborator – Synchronize

The synchronization progress window.


Figure 22 – Bynari WebDAV Collaborator – Synchronization Progress

3.1.10 Configuration Complete

Once the synchronization has completed, then you have successfully configured and synchronized your Calendar. Contacts, Journal, Notes and Tasks folders are configured using the same steps that we have just used to configure and synchronize the calendar folder.

3.2 Register the Bynari WebDAV Collaborator

  • Click on “About” in the Bynari WebDAV Collaborator Toolbar.
    Figure 23 – About
  • Click on “License”.



Figure 24 – Key Support button

  • Enter your product license key
    Copy/Paste your license key in the space provided.
  • Manual Registration
    See section “manual registration” below.
  • Enter the license certificate below:
    This is only used during manual registration.
  • Which port would you like to use for the registration?
    Bynari license key server listens on ports 80 and 3080. If port 80 is blocked, port 3080 can be used as an alternate port.

    Note: The license key server URL is http://update.bynari.net.
    Note: If you encounter any issues while activating your Bynari WebDAV Collaborator license, ping the license key server to verify proper internet connectivity.
  • Click “OK” to register Bynari WebDAV Collaborator.

 

Manual Registration

  • Enter your product license key
    Copy/Paste your license key in the space provided.
  • Manual Registration
    Contact Bynari Support at support@bynari.net and request a manual license certificate.
  • Enter the license certificate below:
    Paste entire certificate in the space provided. (See manual certificate example.)

    Figure 25 – Manual certificate example


    Figure 26 – Manually entering the information
  • Click “OK” to complete manual registration.

3.3 Registration Complete

After registering over the internet or manually, you should see the following screen.

Figure 28 – Manually entering the information

Bynari WebDAV Collaborator License Information

  • License Key
    This is the license key used to register Bynari WebDAV Collaborator.
  • License Expire
    This will display when your license expires.
  • Support Expires
    This option will show the date Bynari support expires.
  • Number of Licenses Used
    This displays the number of licenses used vs. the number of licenses that you have purchased.
  • Total License Available
    This displays the number of licenses available or purchased.
  • Supported Versions
    The WebDAV Collaborator version supported for this license key.
  • Supported Options
    Formats that are supported such as iCal or Kolab are listed.

Click “Refresh” to update dialog screen for license information.

3.4 Unregister Bynari WebDAV Collaborator

  • Click on “About” on the Bynari WebDAV Collaborator Toolbar.
  • Click on “License”.


Figure 29 – WebDAV Collaborator License information

  • Click on “Unregister”.
    This will unregister Bynari WebDAV Collaborator from your computer.

4 Reporting Problems

When reporting problems, be sure to include the following information:

  • Microsoft Windows version number and patch level.
    • Right click on “My Computer” icon on the Desktop and select Properties. The Windows version and patch level will be listed under System: in the General tab dialog.
  • Microsoft Outlook version and patch level.
    • Right click on Help in Outlook and select About Microsoft Outlook. The Outlook version and patch level will be listed.
  • The full version number of the Bynari WebDAV Collaborator.
    • Click “About” on the WebDAV Collaborator toolbar. The WebDAV Collaborator version and build number (1.0-xxxx) will be listed.

 

To contact technical support:

U.S. Toll Free Telephone: 1-800-241-1086
International Telephone: 001-214-350-5772

To open a new support ticket email: support@bynari.net

For FAQs: http://www.bynari.net/users/kb.php

Bynari WebDAV Collaborator

Installation and Configuration Guide

 

Trademarks

Bynari products are trademarks of Bynari, Inc.

Microsoft Windows, Windows Mobile, Outlook, Windows XP, Windows Vista are all registered trademarks of Microsoft Corporation in the United States, other countries, or both.

BlackBerry is a registered trademark of Research In Motion Limited in the United States, other countries, or both.

All other trademarks are the property of their respective owners.

Technical Support

When you purchase Bynari WebDAV Collaborator, it includes 30 days of free support and maintenance. To purchase additional yearly support and maintenance, please contact sales@bynari.net.

Customers who are current on support receive one year of product maintenance, upgrades and email and/or telephone matching the purchased support package.

Support is available to customers worldwide.

To contact technical support:

U.S. Toll Free Telephone: 1-800-241-1086
International Telephone: 001-214-350-5772

To open a new support ticket email: support@bynari.net.

For FAQs: http://www.bynari.net/users/kb.php

Licensing

The Bynari WebDAV Collaborator utilizes a licensing key system that assigns and stores the number of licenses that have been purchased by the customer. When Outlook starts, Bynari WebDAV Collaborator (WC) will contact the Bynari license key server over the Internet to validate and activate the installed license. Activation will be attempted each time Outlook is started or until activation of the license is successful.

Note: The license key server URL is http://update.bynari.net.

 

If you encounter any issues while activating your Bynari WebDAV Collaborator license, please see below for a possible solution:

  • The client systems may be blocked from accessing the Internet, or Internet access is temporarily unavailable.
  • The license key entered during the installation of the Bynari WebDAV Collaborator may be invalid. This could include issues such as an incorrect key or incorrect key version.
  • The number of user IDs for the licenses has been exceeded. The Bynari License Server tracks how many user IDs have been activated for each valid license. If there are attempts to activate more user IDs than were purchased for that license, the Bynari WebDAV Collaborator will inform you that additional licenses need to be purchased.
  • If you need to reinstall the Bynari WebDAV Collaborator software on a new system due to either hardware failure or system upgrade and need to unregister, do the following (See section 4.3 for complete details):
    • Open Outlook
    • Click on “About” tab in the Bynari WebDAV Collaborator toolbar
    • Click on “License”
    • Click on “Unregister”

If you experience problems with license activation, please contact your reseller or Bynari support at support@bynari.net.

Important Notes:

  • This documentation applies to the latest 1.0 build of the Bynari WebDAV Collaborator available from Bynari.
  • Make sure that Outlook is setup as the default e-mail client. To verify this on the workstation, go to Control Panel > Internet Options > Programs and make sure that Outlook is selected in the drop down box next to E-mail.

Table of Contents



1 Bynari WebDAV Collaborator version 1.0

The Bynari WebDAV Collaborator acts as a Microsoft Outlook COM Add-In.

1.1 Features of Bynari WebDAV Collaborator

Bynari WebDAV Collaborator 1.0 offers the following features:

  • Full Outlook 2003-2013 Support
  • Manual or Automatic Synchronization Schedules
  • Intuitive Interface

1.2 Supported Platforms

Bynari WebDAV Collaborator 1.0 is compatible with the following software. If you are using a version that is not listed, or software that is not supported, upgrade to a supported version.

Supported Windows® Versions

Windows® XP

Windows® Vista

Windows® 7

Windows® 8

Supported Outlook® Versions

Outlook® 2003

Outlook® 2007

Outlook® 2010/2013 (32/64 bit)

Supported Languages

  • English
  • French
  • German
Note: Other languages are provided and may be used but are not formally supported. Problems with translation, spelling, grammar and proper character encoding may be encountered.

1.3 Supported Servers

List of supported servers and how to configure WebDAV Collaborator.

2 Installation

2.1 Preparing Your System (Pre-Installation)

Before you begin:

The WebDAV Collaborator 1.0 software must be installed by the Windows login user. Additionally, this user needs “administrator” rights to install the software. The users’ rights can be changed to install the WebDAV Collaborator and then reset to the original rights.

Before you begin the installation procedure, perform the following steps:

Step 1: Install Microsoft® Windows and/or Microsoft® Outlook

Supported Windows® Versions

Windows® XP

Windows® Vista

Windows® 7

Windows® 8

 

Supported Outlook® Versions

Outlook® 2003 SP3+

Outlook® 2007 SP2+

Outlook® 2010 SP1+

Outlook® 2013

Note: If you are using versions that are not listed, upgrade to a supported version.

Step 2: Install the Latest Updates for Microsoft® Windows and Outlook

Go to the Microsoft® website or check with your IT Administrator to verify that you have installed the most current critical updates and service packs for both your Windows operating system and Outlook.

http://update.microsoft.com – Microsoft® updates.

Outlook 2003 minimum required version to install

  • Click on “Help” > “About Microsoft Office Outlook”


Figure 1 – Outlook 2003 about dialog

Outlook 2007 minimum required version to install

  • Click on “Help” > “About Microsoft Office Outlook”


Figure 2 – Outlook 2007 about dialog

Outlook 2010 minimum required version to install

  • Click on “Help” > “About” and then click on “Additional Version and Copyright Information”


Figure 2.3 – Outlook 2010 about dialog

2.2 Installing Bynari WebDAV Collaborator – New Installation

The Bynari WebDAV Collaborator 1.0 Install Wizard standardizes the installation process for Outlook.

The following section explains how to install the Bynari WebDAV Collaborator 1.0 for the first time on a computer. The “upgrade” process is slightly different and available in the section 2.4 of this manual.

Note: The Bynari WebDAV Collaborator will only install on systems where the user has “administrative” rights. The users’ rights can be changed to install the Bynari WebDAV Collaborator and then reset to the original rights after the installation has completed.

 

Important Information: In some cases, virus scanning add-ins for Outlook may need to be disabled for the installation of the Bynari WebDAV Collaborator. Disabling the virus scanning Outlook add-in should not change the functionality of your antivirus software.

Before you begin:

  1. Verify that all steps in “Preparing Your System” (Pre-installation) section 2.1 are complete.
  2. Unzip the Bynari WebDAV Collaborator 1.0 compressed file by right-clicking and selecting “Extract All”.

    Figure 3 – Installation – Downloaded zipped Bynari WebDAV Collaborator
  3. Double Click on the installer.
    Figure 4 – Installation – Bynari WebDAV Collaborator Installer Package
  4. Welcome Dialog:
    Double click the installation setup file to start installation. The setup wizard will display the “Welcome Dialog” window. Select “Next” to continue with the installation process.
    Figure 5 – Installation – Bynari WebDAV Collaborator welcome dialog – Setup Wizard
  5. End User License Agreement:
    Read the license agreement. If you agree, select the button, “I accept the license agreement” and select “Next”.
  6. Select Destination Location:
    The default installation destination for the Bynari WebDAV Collaborator is:
    C:\Program Files\Bynari, Inc\InsightWebDAV Collaborator. A custom installation location may be used. Select the “Browse” button to choose an alternate location to install the Bynari WebDAV Collaborator. Click “Next” to continue the installation.

    Figure 6 – Bynari WebDAV Collaborator – Select Destination Location
  7. Ready to Install:
    Review configuration settings and select “Install” to install the Bynari WebDAV Collaborator. Click “Next” to continue the installation.
    Figure 7 – Bynari WebDAV Collaborator – Ready to Install
  8. Setup Complete:
    To automatically start Outlook, place a check in the box labeled “Run Outlook” and select “Finish”.
    Figure 8 – Bynari WebDAV Collaborator – Finish Install Wizard

2.3 Installation Logs

Error Logging

This feature is only activated during a new installation of the Bynari WebDAV Collaborator when a new profile is created. Error logging is not enabled during the upgrade process.

Viewing the Log File

The Bynari WebDAV Collaborator generates a log file named “Bynari.log” in the user’s %TEMP% directory during the installation process.

Viewing the Log File:

  1. Select “Start” > “Run”.
  2. Type %TEMP% on the Run input field and select “OK”.
  3. A new explorer window will open displaying the contents of the user’s %TEMP% directory.
  4. Browse this directory for a text file named “Bynari.log”. This file can be viewed with any text editor.

Technical Support Logging

The Bynari WebDAV Collaborator also offers additional logging capabilities for troubleshooting. These logs are located under: %AppData%\Local\Bynari\WebDAV Collaborator\

There are both “log” and “trace” directories located here.

To turn on logging, go to the WebDAV Collaborator toolbar and click on:

Settings

When working with Bynari Technical Support, “verbose” logging will be required for troubleshooting.

3 Basic Configuration

3.1 Configure

Begin the WebDAV Collaborator configuration process by selecting “Configure” from the “File” menu under “WebDAV Collaborator”. This will display the “WebDAV Folder Settings” window Collaborator Toolbar.

Figure 9 – Bynari WebDAV Collaborator Toolbar

3.1.1 WebDAV Folder Settings

In the “WebDAV Folder Settings” window click the “Add” button.

Figure 10 – Bynari WebDAV Collaborator – Folder

3.1.2 Folder List

You are now presented with a list of folders which the WebDAV Collaborator can sync for you. The configuration process is the same for each of the folders in this list. In the following steps we configure a calendar, as an example.

Figure 11 – Bynari WebDAV Collaborator – Folder List

3.1.3 Choose a Folder

Click on the desired folder, then click the “OK” button.

Figure 12 – Bynari WebDAV Collaborator Choose a Folder

3.1.4 Folder Settings

The folder settings window will display the folder mappings to the WebDAV server. Complete all fields required by your WebDAV server, then click the “Detect Account Settings” button. If you are unsure of the settings required by your server, contact your server administrator.

Figure 13 – Bynari WebDAV Collaborator Folder Settings

  • Folder Display Name
    Outlook folder name configured to WebDAV server.
  • Folder Type
    Type of folder.
  • Folder Path
    Folder path in Outlook local cache file.
  • Username
    WebDAV Server login user name
  • Password
    WebDAV Server user login password
  • E-Mail
    WebDAV Server e-mail associated with the account, can be different from Username
  • Server URL
    WebDAV Server URL to synchronize with. You can use a short URL for WebDAV Collaborator to figure out the URL if the server supports ‘Principal’ request.Default Server URL for BCS Server 7.4+ are:
    Calendars: http://server/dav/calendars/
    Contacts: http://server/dav/addressbooks/
  • Synchronize when Outlook shuts down
    If enabled, WebDAV Collaborator will synchronize the data before Outlook will exit
  • Detect Account Settings
    Button to detect the account settings and URL is correct or display a list of URL from the WebDAV Server principal request
  • Synchronize Interval in Minutes
    Select synchronization interval for this folder. See “Default Settings” for more information.
  • Conflict Resolution
    Select how to handle conflicts between client and server data. See “Default Settings” for more information.
  • Synchronization Modes
    Select how the synchronization will perform of merging data, client is master or server is master. See “Default Settings” for more information.
  • Default…
    Display Default WebDAV Collaborator Settings
  • Deleted
    Delete the currently selected folder mapping
  • Add…
    Add a new folder mapping
  • OK
    Accept to save the changes
  • Cancel
    Cancel any changes made to the folder mappings

3.1.5 Detect Account Settings

The “Detect Account Settings” window will attempt to detect and display calendar or contacts folders from the WebDAV server.


  • Figure 14 – Bynari WebDAV Collaborator – Detect Account SettingsIf the WebDAV Server returned a list of folders, you can select the folder to accept the full URL to map Outlook’s folder to the server.

  • Figure 23 – Bynari WebDAV Collaborator – Detect Account Settings ErrorIf the server could not resolve the URL, WebDAV Collaborator, contact your system administrator for assistance.

3.1.6 Create and Delete Folders on Server

WebDAV Collaborator can create and delete folders from the server. The URL must be part of the URL principals to be able create and delete folders.


Figure 15 – Bynari WebDAV Collaborator – Create Server Folder

Once the folder is created or deleted, the list of folders from the server will be updated.


Figure 16 – Bynari WebDAV Collaborator – Server Folders

When deleting a folder, WebDAV Collaborator will prompt you if you want to delete the folder from the server.


Figure 17 – Bynari WebDAV Collaborator – Delete Server Folder

3.1.7 Successful Test

If you have a reliable network connection to the server, and you have correctly entered the settings required by your WebDAV server, you will receive a “URL successfully detected” message. If you do not receive this message, contact your WebDAV server administrator.

Figure 19 – Bynari WebDAV Collaborator – URL successfully detected

3.1.8 Default Settings


Figure 30 – Bynari WebDAV Collaborator – Default Settings

  • Synchronization Interval in Minutes
    1. Manual
      Manually synchronize using WebDAV Collaborator’s “Synchronize” button
    2. In Minutes
      WebDAV Collaborator will automatically synchronize the data.
  • Synchronization Modes
    1. Outlook is the master, remove anything on the server not already in Outlook
    2. Merge Outlook data into the server
    3. Server is the master, remove anything in Outlook that is not on the server
    4. Merge server data into Outlook
    5. Keep both Outlook and the server data by merging data both ways
  • Conflict Resolutions
    1. Outlook always win
      All changes and new data is ignored on the server and will be removed from the server
    2. Server always win
      All changes and new data is ignored in Outlook and will be removed from the Outlook
    3. Ask Me
      WebDAV Collaborator will prompt what action to perform on each conflict.
  • Synchronization when Outlook shuts down
    If enabled, WebDAV Collaborator will synchronize the data before Outlook will exit
  • Timeout Value (in seconds)
    Connection time out value in seconds
  • Log Settings
    Select which level of logging to log to the log files.

3.1.9 Synchronize

Select Synchronize from the menu under “WebDAV Collaborator” to manually synchronize the data.

Figure 21 – Bynari WebDAV Collaborator – Synchronize

The synchronization progress window.


Figure 22 – Bynari WebDAV Collaborator – Synchronization Progress

3.1.10 Configuration Complete

Once the synchronization has completed, then you have successfully configured and synchronized your Calendar. Contacts, Journal, Notes and Tasks folders are configured using the same steps that we have just used to configure and synchronize the calendar folder.

3.2 Register the Bynari WebDAV Collaborator

  • Click on “About” in the Bynari WebDAV Collaborator Toolbar.
    Figure 23 – About
  • Click on “License”.



Figure 24 – Key Support button

  • Enter your product license key
    Copy/Paste your license key in the space provided.
  • Manual Registration
    See section “manual registration” below.
  • Enter the license certificate below:
    This is only used during manual registration.
  • Which port would you like to use for the registration?
    Bynari license key server listens on ports 80 and 3080. If port 80 is blocked, port 3080 can be used as an alternate port.

    Note: The license key server URL is http://update.bynari.net.
    Note: If you encounter any issues while activating your Bynari WebDAV Collaborator license, ping the license key server to verify proper internet connectivity.
  • Click “OK” to register Bynari WebDAV Collaborator.

 

Manual Registration

  • Enter your product license key
    Copy/Paste your license key in the space provided.
  • Manual Registration
    Contact Bynari Support at support@bynari.net and request a manual license certificate.
  • Enter the license certificate below:
    Paste entire certificate in the space provided. (See manual certificate example.)

    Figure 25 – Manual certificate example


    Figure 26 – Manually entering the information
  • Click “OK” to complete manual registration.

3.3 Registration Complete

After registering over the internet or manually, you should see the following screen.

Figure 28 – Manually entering the information

Bynari WebDAV Collaborator License Information

  • License Key
    This is the license key used to register Bynari WebDAV Collaborator.
  • License Expire
    This will display when your license expires.
  • Support Expires
    This option will show the date Bynari support expires.
  • Number of Licenses Used
    This displays the number of licenses used vs. the number of licenses that you have purchased.
  • Total License Available
    This displays the number of licenses available or purchased.
  • Supported Versions
    The WebDAV Collaborator version supported for this license key.
  • Supported Options
    Formats that are supported such as iCal or Kolab are listed.

Click “Refresh” to update dialog screen for license information.

3.4 Unregister Bynari WebDAV Collaborator

  • Click on “About” on the Bynari WebDAV Collaborator Toolbar.
  • Click on “License”.


Figure 29 – WebDAV Collaborator License information

  • Click on “Unregister”.
    This will unregister Bynari WebDAV Collaborator from your computer.

4 Reporting Problems

When reporting problems, be sure to include the following information:

  • Microsoft Windows version number and patch level.
    • Right click on “My Computer” icon on the Desktop and select Properties. The Windows version and patch level will be listed under System: in the General tab dialog.
  • Microsoft Outlook version and patch level.
    • Right click on Help in Outlook and select About Microsoft Outlook. The Outlook version and patch level will be listed.
  • The full version number of the Bynari WebDAV Collaborator.
    • Click “About” on the WebDAV Collaborator toolbar. The WebDAV Collaborator version and build number (1.0-xxxx) will be listed.

 

To contact technical support:

U.S. Toll Free Telephone: 1-800-241-1086
International Telephone: 001-214-350-5772

To open a new support ticket email: support@bynari.net

For FAQs: http://www.bynari.net/users/kb.php

Bynari WebDAV Collaborator

Installation and Configuration Guide

 

Trademarks

Bynari products are trademarks of Bynari, Inc.

Microsoft Windows, Windows Mobile, Outlook, Windows XP, Windows Vista are all registered trademarks of Microsoft Corporation in the United States, other countries, or both.

BlackBerry is a registered trademark of Research In Motion Limited in the United States, other countries, or both.

All other trademarks are the property of their respective owners.

Technical Support

When you purchase any of Bynari’s products, the products include one year of free support and maintenance. To purchase additional yearly support and maintenance, please contact sales@bynari.net.

Customers who are current on support receive one year of product maintenance, upgrades and email and/or telephone matching the purchased support package.

Support is available to customers worldwide.

To contact technical support:

U.S. Toll Free Telephone: 1-800-241-1086
International Telephone: 001-214-350-5772

To open a new support ticket email: support@bynari.net.

For FAQs: http://www.bynari.net/users/kb.php

Licensing

The Bynari WebDAV Collaborator utilizes a licensing key system that assigns and stores the number of licenses that have been purchased by the customer. When Outlook starts, Bynari WebDAV Collaborator (WC) will contact the Bynari license key server over the Internet to validate and activate the installed license. Activation will be attempted each time Outlook is started or until activation of the license is successful.

Note: The license key server URL is http://update.bynari.net.

 

If you encounter any issues while activating your Bynari WebDAV Collaborator license, please see below for a possible solution:

  • The client systems may be blocked from accessing the Internet, or Internet access is temporarily unavailable.
  • The license key entered during the installation of the Bynari WebDAV Collaborator may be invalid. This could include issues such as an incorrect key or incorrect key version.
  • The number of user IDs for the licenses has been exceeded. The Bynari License Server tracks how many user IDs have been activated for each valid license. If there are attempts to activate more user IDs than were purchased for that license, the Bynari WebDAV Collaborator will inform you that additional licenses need to be purchased.
  • If you need to reinstall the Bynari WebDAV Collaborator software on a new system due to either hardware failure or system upgrade and need to unregister, do the following (See section 4.3 for complete details):
    • Open Outlook
    • Click on “About” tab in the Bynari WebDAV Collaborator toolbar
    • Click on “License”
    • Click on “Unregister”

If you experience problems with license activation, please contact your reseller or Bynari support at support@bynari.net.

Important Notes:

  • This documentation applies to the latest 1.0 build of the Bynari WebDAV Collaborator available from Bynari.
  • Make sure that Outlook is setup as the default e-mail client. To verify this on the workstation, go to Control Panel > Internet Options > Programs and make sure that Outlook is selected in the drop down box next to E-mail.

Table of Contents



1 Bynari WebDAV Collaborator version 1.0

The Bynari WebDAV Collaborator acts as a Microsoft Outlook COM Add-In.

1.1 Features of Bynari WebDAV Collaborator

Bynari WebDAV Collaborator 1.0 offers the following features:

  • Full Outlook 2003-2010 Support
  • Manual or Automatic Synchronization Schedules
  • Intuitive Interface

1.2 Supported Platforms

Bynari WebDAV Collaborator 1.0 is compatible with the following software. If you are using a version that is not listed, or software that is not supported, upgrade to a supported version.

Supported Windows® Versions

Windows® XP

Windows® Vista

Windows® 7

Supported Outlook® Versions

Outlook® 2003

Outlook® 2007

Outlook® 2010 (32/64 bit)

Supported Languages

  • English
  • French
  • German
Note: Other languages are provided and may be used but are not formally supported. Problems with translation, spelling, grammar and proper character encoding may be encountered.

1.3 Supported Servers

List of supported servers and how to configure WebDAV Collaborator.

2 Installation

2.1 Preparing Your System (Pre-Installation)

Before you begin:

The WebDAV Collaborator 1.0 software must be installed by the Windows login user. Additionally, this user needs “administrator” rights to install the software. The users’ rights can be changed to install the WebDAV Collaborator and then reset to the original rights.

Before you begin the installation procedure, perform the following steps:

Step 1: Install Microsoft® Windows and/or Microsoft® Outlook

Supported Windows® Versions

Windows® XP

Windows® Vista

Windows® 7

 

Supported Outlook® Versions

Outlook® 2003 SP3+

Outlook® 2007 SP2+

Outlook® 2010 SP1+

Note: If you are using versions that are not listed, upgrade to a supported version.

Step 2: Install the Latest Updates for Microsoft® Windows and Outlook

Go to the Microsoft® website or check with your IT Administrator to verify that you have installed the most current critical updates and service packs for both your Windows operating system and Outlook.

http://update.microsoft.com – Microsoft® updates.

Outlook 2003 minimum required version to install

  • Click on “Help” > “About Microsoft Office Outlook”


Figure 1 – Outlook 2003 about dialog

Outlook 2007 minimum required version to install

  • Click on “Help” > “About Microsoft Office Outlook”


Figure 2 – Outlook 2007 about dialog

Outlook 2010 minimum required version to install

  • Click on “Help” > “About” and then click on “Additional Version and Copyright Information”


Figure 2.3 – Outlook 2010 about dialog

2.2 Installing Bynari WebDAV Collaborator – New Installation

The Bynari WebDAV Collaborator 1.0 Install Wizard standardizes the installation process for Outlook.

The following section explains how to install the Bynari WebDAV Collaborator 1.0 for the first time on a computer. The “upgrade” process is slightly different and available in the section 2.4 of this manual.

Note: The Bynari WebDAV Collaborator will only install on systems where the user has “administrative” rights. The users’ rights can be changed to install the Bynari WebDAV Collaborator and then reset to the original rights after the installation has completed.

 

Important Information: In some cases, virus scanning add-ins for Outlook may need to be disabled for the installation of the Bynari WebDAV Collaborator. Disabling the virus scanning Outlook add-in should not change the functionality of your antivirus software.

Before you begin:

  1. Verify that all steps in “Preparing Your System” (Pre-installation) section 2.1 are complete.
  2. Unzip the Bynari WebDAV Collaborator 1.0 compressed file by right-clicking and selecting “Extract All”.

    Figure 3 – Installation – Downloaded zipped Bynari WebDAV Collaborator
  3. Double Click on the installer.
    Figure 4 – Installation – Bynari WebDAV Collaborator Installer Package
  4. Welcome Dialog:
    Double click the installation setup file to start installation. The setup wizard will display the “Welcome Dialog” window. Select “Next” to continue with the installation process.
    Figure 5 – Installation – Bynari WebDAV Collaborator welcome dialog – Setup Wizard
  5. End User License Agreement:
    Read the license agreement. If you agree, select the button, “I accept the license agreement” and select “Next”.
  6. Select Destination Location:
    The default installation destination for the Bynari WebDAV Collaborator is:
    C:\Program Files\Bynari, Inc\InsightWebDAV Collaborator. A custom installation location may be used. Select the “Browse” button to choose an alternate location to install the Bynari WebDAV Collaborator. Click “Next” to continue the installation.

    Figure 6 – Bynari WebDAV Collaborator – Select Destination Location
  7. Ready to Install:
    Review configuration settings and select “Install” to install the Bynari WebDAV Collaborator. Click “Next” to continue the installation.
    Figure 7 – Bynari WebDAV Collaborator – Ready to Install
  8. Setup Complete:
    To automatically start Outlook, place a check in the box labeled “Run Outlook” and select “Finish”.
    Figure 8 – Bynari WebDAV Collaborator – Finish Install Wizard

2.3 Installation Logs

Error Logging

This feature is only activated during a new installation of the Bynari WebDAV Collaborator when a new profile is created. Error logging is not enabled during the upgrade process.

Viewing the Log File

The Bynari WebDAV Collaborator generates a log file named “Bynari.log” in the user’s %TEMP% directory during the installation process.

Viewing the Log File:

  1. Select “Start” > “Run”.
  2. Type %TEMP% on the Run input field and select “OK”.
  3. A new explorer window will open displaying the contents of the user’s %TEMP% directory.
  4. Browse this directory for a text file named “Bynari.log”. This file can be viewed with any text editor.

Technical Support Logging

The Bynari WebDAV Collaborator also offers additional logging capabilities for troubleshooting. These logs are located under: %AppData%\Local\Bynari\WebDAV Collaborator\

There are both “log” and “trace” directories located here.

To turn on logging, go to the WebDAV Collaborator toolbar and click on:

Settings

When working with Bynari Technical Support, “verbose” logging will be required for troubleshooting.

3 Basic Configuration

3.1 Configure

Begin the WebDAV Collaborator configuration process by selecting “Configure” from the “File” menu under “WebDAV Collaborator”. This will display the “WebDAV Folder Settings” window Collaborator Toolbar.

Figure 9 – Bynari WebDAV Collaborator Toolbar

3.1.1 WebDAV Folder Settings

In the “WebDAV Folder Settings” window click the “Add” button.

Figure 10 – Bynari WebDAV Collaborator – Folder

3.1.2 Folder List

You are now presented with a list of folders which the WebDAV Collaborator can sync for you. The configuration process is the same for each of the folders in this list. In the following steps we configure a calendar, as an example.

Figure 11 – Bynari WebDAV Collaborator – Folder List

3.1.3 Choose a Folder

Click on the desired folder, then click the “OK” button.

Figure 12 – Bynari WebDAV Collaborator Choose a Folder

3.1.4 Folder Settings

The folder settings window will display the folder mappings to the WebDAV server. Complete all fields required by your WebDAV server, then click the “Detect Account Settings” button. If you are unsure of the settings required by your server, contact your server administrator.

Figure 13 – Bynari WebDAV Collaborator Folder Settings

  • Folder Display Name
    Outlook folder name configured to WebDAV server.
  • Folder Type
    Type of folder.
  • Folder Path
    Folder path in Outlook local cache file.
  • Username
    WebDAV Server login user name
  • Password
    WebDAV Server user login password
  • E-Mail
    WebDAV Server e-mail associated with the account, can be different from Username
  • Server URL
    WebDAV Server URL to synchronize with. You can use a short URL for WebDAV Collaborator to figure out the URL if the server supports ‘Principal’ request.Default Server URL for BCS Server 7.4+ are:
    Calendars: http://server/dav/calendars/
    Contacts: http://server/dav/addressbooks/
  • Synchronize when Outlook shuts down
    If enabled, WebDAV Collaborator will synchronize the data before Outlook will exit
  • Detect Account Settings
    Button to detect the account settings and URL is correct or display a list of URL from the WebDAV Server principal request
  • Synchronize Interval in Minutes
    Select synchronization interval for this folder. See “Default Settings” for more information.
  • Conflict Resolution
    Select how to handle conflicts between client and server data. See “Default Settings” for more information.
  • Synchronization Modes
    Select how the synchronization will perform of merging data, client is master or server is master. See “Default Settings” for more information.
  • Default…
    Display Default WebDAV Collaborator Settings
  • Deleted
    Delete the currently selected folder mapping
  • Add…
    Add a new folder mapping
  • OK
    Accept to save the changes
  • Cancel
    Cancel any changes made to the folder mappings

3.1.5 Detect Account Settings

The “Detect Account Settings” window will attempt to detect and display calendar or contacts folders from the WebDAV server.


  • Figure 14 – Bynari WebDAV Collaborator – Detect Account SettingsIf the WebDAV Server returned a list of folders, you can select the folder to accept the full URL to map Outlook’s folder to the server.

  • Figure 23 – Bynari WebDAV Collaborator – Detect Account Settings ErrorIf the server could not resolve the URL, WebDAV Collaborator, contact your system administrator for assistance.

3.1.6 Create and Delete Folders on Server

WebDAV Collaborator can create and delete folders from the server. The URL must be part of the URL principals to be able create and delete folders.


Figure 15 – Bynari WebDAV Collaborator – Create Server Folder

Once the folder is created or deleted, the list of folders from the server will be updated.


Figure 16 – Bynari WebDAV Collaborator – Server Folders

When deleting a folder, WebDAV Collaborator will prompt you if you want to delete the folder from the server.


Figure 17 – Bynari WebDAV Collaborator – Delete Server Folder

3.1.7 Successful Test

If you have a reliable network connection to the server, and you have correctly entered the settings required by your WebDAV server, you will receive a “URL successfully detected” message. If you do not receive this message, contact your WebDAV server administrator.

Figure 19 – Bynari WebDAV Collaborator – URL successfully detected

3.1.8 Default Settings


Figure 30 – Bynari WebDAV Collaborator – Default Settings

  • Synchronization Interval in Minutes
    1. Manual
      Manually synchronize using WebDAV Collaborator’s “Synchronize” button
    2. In Minutes
      WebDAV Collaborator will automatically synchronize the data.
  • Synchronization Modes
    1. Outlook is the master, remove anything on the server not already in Outlook
    2. Merge Outlook data into the server
    3. Server is the master, remove anything in Outlook that is not on the server
    4. Merge server data into Outlook
    5. Keep both Outlook and the server data by merging data both ways
  • Conflict Resolutions
    1. Outlook always win
      All changes and new data is ignored on the server and will be removed from the server
    2. Server always win
      All changes and new data is ignored in Outlook and will be removed from the Outlook
    3. Ask Me
      WebDAV Collaborator will prompt what action to perform on each conflict.
  • Synchronization when Outlook shuts down
    If enabled, WebDAV Collaborator will synchronize the data before Outlook will exit
  • Timeout Value (in seconds)
    Connection time out value in seconds
  • Log Settings
    Select which level of logging to log to the log files.

3.1.9 Synchronize

Select Synchronize from the menu under “WebDAV Collaborator” to manually synchronize the data.

Figure 21 – Bynari WebDAV Collaborator – Synchronize

The synchronization progress window.


Figure 22 – Bynari WebDAV Collaborator – Synchronization Progress

3.1.10 Configuration Complete

Once the synchronization has completed, then you have successfully configured and synchronized your Calendar. Contacts, Journal, Notes and Tasks folders are configured using the same steps that we have just used to configure and synchronize the calendar folder.

3.2 Register the Bynari WebDAV Collaborator

  • Click on “About” in the Bynari WebDAV Collaborator Toolbar.
    Figure 23 – About
  • Click on “License”.



Figure 24 – Key Support button

  • Enter your product license key
    Copy/Paste your license key in the space provided.
  • Manual Registration
    See section “manual registration” below.
  • Enter the license certificate below:
    This is only used during manual registration.
  • Which port would you like to use for the registration?
    Bynari license key server listens on ports 80 and 3080. If port 80 is blocked, port 3080 can be used as an alternate port.

    Note: The license key server URL is http://update.bynari.net.
    Note: If you encounter any issues while activating your Bynari WebDAV Collaborator license, ping the license key server to verify proper internet connectivity.
  • Click “OK” to register Bynari WebDAV Collaborator.

 

Manual Registration

  • Enter your product license key
    Copy/Paste your license key in the space provided.
  • Manual Registration
    Contact Bynari Support at support@bynari.net and request a manual license certificate.
  • Enter the license certificate below:
    Paste entire certificate in the space provided. (See manual certificate example.)

    Figure 25 – Manual certificate example


    Figure 26 – Manually entering the information
  • Click “OK” to complete manual registration.

3.3 Registration Complete

After registering over the internet or manually, you should see the following screen.

Figure 28 – Manually entering the information

Bynari WebDAV Collaborator License Information

  • License Key
    This is the license key used to register Bynari WebDAV Collaborator.
  • License Expire
    This will display when your license expires.
  • Support Expires
    This option will show the date Bynari support expires.
  • Number of Licenses Used
    This displays the number of licenses used vs. the number of licenses that you have purchased.
  • Total License Available
    This displays the number of licenses available or purchased.
  • Supported Versions
    The WebDAV Collaborator version supported for this license key.
  • Supported Options
    Formats that are supported such as iCal or Kolab are listed.

Click “Refresh” to update dialog screen for license information.

3.4 Unregister Bynari WebDAV Collaborator

  • Click on “About” on the Bynari WebDAV Collaborator Toolbar.
  • Click on “License”.


Figure 29 – WebDAV Collaborator License information

  • Click on “Unregister”.
    This will unregister Bynari WebDAV Collaborator from your computer.

4 Reporting Problems

When reporting problems, be sure to include the following information:

  • Microsoft Windows version number and patch level.
    • Right click on “My Computer” icon on the Desktop and select Properties. The Windows version and patch level will be listed under System: in the General tab dialog.
  • Microsoft Outlook version and patch level.
    • Right click on Help in Outlook and select About Microsoft Outlook. The Outlook version and patch level will be listed.
  • The full version number of the Bynari WebDAV Collaborator.
    • Click “About” on the WebDAV Collaborator toolbar. The WebDAV Collaborator version and build number (1.0-xxxx) will be listed.

 

To contact technical support:

U.S. Toll Free Telephone: 1-800-241-1086
International Telephone: 001-214-350-5772

To open a new support ticket email: support@bynari.net

For FAQs: http://www.bynari.net/users/kb.php

Bynari WebDAV Collaborator

Installation and Configuration Guide

 

Trademarks

Bynari products are trademarks of Bynari, Inc.

Microsoft Windows, Windows Mobile, Outlook, Windows XP, Windows Vista are all registered trademarks of Microsoft Corporation in the United States, other countries, or both.

BlackBerry is a registered trademark of Research In Motion Limited in the United States, other countries, or both.

All other trademarks are the property of their respective owners.

Technical Support

When you purchase any of Bynari’s products, the products include one year of free support and maintenance. To purchase additional yearly support and maintenance, please contact sales@bynari.net.

Customers who are current on support receive one year of product maintenance, upgrades and email and/or telephone matching the purchased support package.

Support is available to customers worldwide.

To contact technical support:

U.S. Toll Free Telephone: 1-800-241-1086
International Telephone: 001-214-350-5772

To open a new support ticket email: support@bynari.net.

For FAQs: http://www.bynari.net/users/kb.php

Licensing

The Bynari WebDAV Collaborator utilizes a licensing key system that assigns and stores the number of licenses that have been purchased by the customer. When Outlook starts, Bynari WebDAV Collaborator (WC) will contact the Bynari license key server over the Internet to validate and activate the installed license. Activation will be attempted each time Outlook is started or until activation of the license is successful.

Note: The license key server URL is http://update.bynari.net.

 

If you encounter any issues while activating your Bynari WebDAV Collaborator license, please see below for a possible solution:

  • The client systems may be blocked from accessing the Internet, or Internet access is temporarily unavailable.
  • The license key entered during the installation of the Bynari WebDAV Collaborator may be invalid. This could include issues such as an incorrect key or incorrect key version.
  • The number of user IDs for the licenses has been exceeded. The Bynari License Server tracks how many user IDs have been activated for each valid license. If there are attempts to activate more user IDs than were purchased for that license, the Bynari WebDAV Collaborator will inform you that additional licenses need to be purchased.
  • If you need to reinstall the Bynari WebDAV Collaborator software on a new system due to either hardware failure or system upgrade and need to unregister, do the following (See section 4.3 for complete details):
    • Open Outlook
    • Click on “About” tab in the Bynari WebDAV Collaborator toolbar
    • Click on “License”
    • Click on “Unregister”

If you experience problems with license activation, please contact your reseller or Bynari support at support@bynari.net.

Important Notes:

  • This documentation applies to the latest 1.0 build of the Bynari WebDAV Collaborator available from Bynari.
  • Make sure that Outlook is setup as the default e-mail client. To verify this on the workstation, go to Control Panel > Internet Options > Programs and make sure that Outlook is selected in the drop down box next to E-mail.

Table of Contents



1 Bynari WebDAV Collaborator version 1.0

The Bynari WebDAV Collaborator acts as a Microsoft Outlook COM Add-In.

1.1 Features of Bynari WebDAV Collaborator

Bynari WebDAV Collaborator 1.0 offers the following features:

  • Full Outlook 2003-2010 Support
  • Manual or Automatic Synchronization Schedules
  • Intuitive Interface

1.2 Supported Platforms

Bynari WebDAV Collaborator 1.0 is compatible with the following software. If you are using a version that is not listed, or software that is not supported, upgrade to a supported version.

Supported Windows® Versions

Windows® XP

Windows® Vista

Windows® 7

Supported Outlook® Versions

Outlook® 2003

Outlook® 2007

Outlook® 2010 (32/64 bit)

Supported Languages

  • English
  • French
  • German
Note: Other languages are provided and may be used but are not formally supported. Problems with translation, spelling, grammar and proper character encoding may be encountered.

1.3 Supported Servers

List of supported servers and how to configure WebDAV Collaborator.

2 Installation

2.1 Preparing Your System (Pre-Installation)

Before you begin:

The WebDAV Collaborator 1.0 software must be installed by the Windows login user. Additionally, this user needs “administrator” rights to install the software. The users’ rights can be changed to install the WebDAV Collaborator and then reset to the original rights.

Before you begin the installation procedure, perform the following steps:

Step 1: Install Microsoft® Windows and/or Microsoft® Outlook

Supported Windows® Versions

Windows® XP

Windows® Vista

Windows® 7

 

Supported Outlook® Versions

Outlook® 2003 SP3+

Outlook® 2007 SP2+

Outlook® 2010 SP1+

Note: If you are using versions that are not listed, upgrade to a supported version.

Step 2: Install the Latest Updates for Microsoft® Windows and Outlook

Go to the Microsoft® website or check with your IT Administrator to verify that you have installed the most current critical updates and service packs for both your Windows operating system and Outlook.

http://update.microsoft.com – Microsoft® updates.

Outlook 2003 minimum required version to install

  • Click on “Help” > “About Microsoft Office Outlook”


Figure 1 – Outlook 2003 about dialog

Outlook 2007 minimum required version to install

  • Click on “Help” > “About Microsoft Office Outlook”


Figure 2 – Outlook 2007 about dialog

Outlook 2010 minimum required version to install

  • Click on “Help” > “About” and then click on “Additional Version and Copyright Information”


Figure 2.3 – Outlook 2010 about dialog

2.2 Installing Bynari WebDAV Collaborator – New Installation

The Bynari WebDAV Collaborator 1.0 Install Wizard standardizes the installation process for Outlook.

The following section explains how to install the Bynari WebDAV Collaborator 1.0 for the first time on a computer. The “upgrade” process is slightly different and available in the section 2.4 of this manual.

Note: The Bynari WebDAV Collaborator will only install on systems where the user has “administrative” rights. The users’ rights can be changed to install the Bynari WebDAV Collaborator and then reset to the original rights after the installation has completed.

 

Important Information: In some cases, virus scanning add-ins for Outlook may need to be disabled for the installation of the Bynari WebDAV Collaborator. Disabling the virus scanning Outlook add-in should not change the functionality of your antivirus software.

Before you begin:

  1. Verify that all steps in “Preparing Your System” (Pre-installation) section 2.1 are complete.
  2. Unzip the Bynari WebDAV Collaborator 1.0 compressed file by right-clicking and selecting “Extract All”.

    Figure 3 – Installation – Downloaded zipped Bynari WebDAV Collaborator
  3. Double Click on the installer.
    Figure 4 – Installation – Bynari WebDAV Collaborator Installer Package
  4. Welcome Dialog:
    Double click the installation setup file to start installation. The setup wizard will display the “Welcome Dialog” window. Select “Next” to continue with the installation process.
    Figure 5 – Installation – Bynari WebDAV Collaborator welcome dialog – Setup Wizard
  5. End User License Agreement:
    Read the license agreement. If you agree, select the button, “I accept the license agreement” and select “Next”.
  6. Select Destination Location:
    The default installation destination for the Bynari WebDAV Collaborator is:
    C:\Program Files\Bynari, Inc\InsightWebDAV Collaborator. A custom installation location may be used. Select the “Browse” button to choose an alternate location to install the Bynari WebDAV Collaborator. Click “Next” to continue the installation.

    Figure 6 – Bynari WebDAV Collaborator – Select Destination Location
  7. Ready to Install:
    Review configuration settings and select “Install” to install the Bynari WebDAV Collaborator. Click “Next” to continue the installation.
    Figure 7 – Bynari WebDAV Collaborator – Ready to Install
  8. Setup Complete:
    To automatically start Outlook, place a check in the box labeled “Run Outlook” and select “Finish”.
    Figure 8 – Bynari WebDAV Collaborator – Finish Install Wizard

2.3 Installation Logs

Error Logging

This feature is only activated during a new installation of the Bynari WebDAV Collaborator when a new profile is created. Error logging is not enabled during the upgrade process.

Viewing the Log File

The Bynari WebDAV Collaborator generates a log file named “Bynari.log” in the user’s %TEMP% directory during the installation process.

Viewing the Log File:

  1. Select “Start” > “Run”.
  2. Type %TEMP% on the Run input field and select “OK”.
  3. A new explorer window will open displaying the contents of the user’s %TEMP% directory.
  4. Browse this directory for a text file named “Bynari.log”. This file can be viewed with any text editor.

Technical Support Logging

The Bynari WebDAV Collaborator also offers additional logging capabilities for troubleshooting. These logs are located under: %AppData%\Local\Bynari\WebDAV Collaborator\

There are both “log” and “trace” directories located here.

To turn on logging, go to the WebDAV Collaborator toolbar and click on:

Settings

When working with Bynari Technical Support, “verbose” logging will be required for troubleshooting.

3 Basic Configuration

3.1 Configure

Begin the WebDAV Collaborator configuration process by selecting “Configure” from the “File” menu under “WebDAV Collaborator”. This will display the “WebDAV Folder Settings” window Collaborator Toolbar.

Figure 9 – Bynari WebDAV Collaborator Toolbar

3.1.1 WebDAV Folder Settings

In the “WebDAV Folder Settings” window click the “Add” button.

Figure 10 – Bynari WebDAV Collaborator – Folder

3.1.2 Folder List

You are now presented with a list of folders which the WebDAV Collaborator can sync for you. The configuration process is the same for each of the folders in this list. In the following steps we configure a calendar, as an example.

Figure 11 – Bynari WebDAV Collaborator – Folder List

3.1.3 Choose a Folder

Click on the desired folder, then click the “OK” button.

Figure 12 – Bynari WebDAV Collaborator Choose a Folder

3.1.4 Folder Settings

The folder settings window will display the folder mappings to the WebDAV server. Complete all fields required by your WebDAV server, then click the “Detect Account Settings” button. If you are unsure of the settings required by your server, contact your server administrator.

Figure 13 – Bynari WebDAV Collaborator Folder Settings

  • Folder Display Name
    Outlook folder name configured to WebDAV server.
  • Folder Type
    Type of folder.
  • Folder Path
    Folder path in Outlook local cache file.
  • Username
    WebDAV Server login user name
  • Password
    WebDAV Server user login password
  • E-Mail
    WebDAV Server e-mail associated with the account, can be different from Username
  • Server URL
    WebDAV Server URL to synchronize with. You can use a short URL for WebDAV Collaborator to figure out the URL if the server supports ‘Principal’ request.Default Server URL for BCS Server 7.4+ are:
    Calendars: http://server/dav/calendars/
    Contacts: http://server/dav/addressbooks/
  • Synchronize when Outlook shuts down
    If enabled, WebDAV Collaborator will synchronize the data before Outlook will exit
  • Detect Account Settings
    Button to detect the account settings and URL is correct or display a list of URL from the WebDAV Server principal request
  • Synchronize Interval in Minutes
    Select synchronization interval for this folder. See “Default Settings” for more information.
  • Conflict Resolution
    Select how to handle conflicts between client and server data. See “Default Settings” for more information.
  • Synchronization Modes
    Select how the synchronization will perform of merging data, client is master or server is master. See “Default Settings” for more information.
  • Default…
    Display Default WebDAV Collaborator Settings
  • Deleted
    Delete the currently selected folder mapping
  • Add…
    Add a new folder mapping
  • OK
    Accept to save the changes
  • Cancel
    Cancel any changes made to the folder mappings

3.1.5 Detect Account Settings

The “Detect Account Settings” window will attempt to detect and display calendar or contacts folders from the WebDAV server.


  • Figure 14 – Bynari WebDAV Collaborator – Detect Account SettingsIf the WebDAV Server returned a list of folders, you can select the folder to accept the full URL to map Outlook’s folder to the server.

  • Figure 23 – Bynari WebDAV Collaborator – Detect Account Settings ErrorIf the server could not resolve the URL, WebDAV Collaborator, contact your system administrator for assistance.

3.1.6 Create and Delete Folders on Server

WebDAV Collaborator can create and delete folders from the server. The URL must be part of the URL principals to be able create and delete folders.


Figure 15 – Bynari WebDAV Collaborator – Create Server Folder

Once the folder is created or deleted, the list of folders from the server will be updated.


Figure 16 – Bynari WebDAV Collaborator – Server Folders

When deleting a folder, WebDAV Collaborator will prompt you if you want to delete the folder from the server.


Figure 17 – Bynari WebDAV Collaborator – Delete Server Folder

3.1.7 Successful Test

If you have a reliable network connection to the server, and you have correctly entered the settings required by your WebDAV server, you will receive a “URL successfully detected” message. If you do not receive this message, contact your WebDAV server administrator.

Figure 19 – Bynari WebDAV Collaborator – URL successfully detected

3.1.8 Default Settings


Figure 30 – Bynari WebDAV Collaborator – Default Settings

  • Synchronization Interval in Minutes
    1. Manual
      Manually synchronize using WebDAV Collaborator’s “Synchronize” button
    2. In Minutes
      WebDAV Collaborator will automatically synchronize the data.
  • Synchronization Modes
    1. Outlook is the master, remove anything on the server not already in Outlook
    2. Merge Outlook data into the server
    3. Server is the master, remove anything in Outlook that is not on the server
    4. Merge server data into Outlook
    5. Keep both Outlook and the server data by merging data both ways
  • Conflict Resolutions
    1. Outlook always win
      All changes and new data is ignored on the server and will be removed from the server
    2. Server always win
      All changes and new data is ignored in Outlook and will be removed from the Outlook
    3. Ask Me
      WebDAV Collaborator will prompt what action to perform on each conflict.
  • Synchronization when Outlook shuts down
    If enabled, WebDAV Collaborator will synchronize the data before Outlook will exit
  • Timeout Value (in seconds)
    Connection time out value in seconds
  • Log Settings
    Select which level of logging to log to the log files.

3.1.9 Synchronize

Select Synchronize from the menu under “WebDAV Collaborator” to manually synchronize the data.

Figure 21 – Bynari WebDAV Collaborator – Synchronize

The synchronization progress window.


Figure 22 – Bynari WebDAV Collaborator – Synchronization Progress

3.1.10 Configuration Complete

Once the synchronization has completed, then you have successfully configured and synchronized your Calendar. Contacts, Journal, Notes and Tasks folders are configured using the same steps that we have just used to configure and synchronize the calendar folder.

3.2 Register the Bynari WebDAV Collaborator

  • Click on “About” in the Bynari WebDAV Collaborator Toolbar.
    Figure 23 – About
  • Click on “License”.



Figure 24 – Key Support button

  • Enter your product license key
    Copy/Paste your license key in the space provided.
  • Manual Registration
    See section “manual registration” below.
  • Enter the license certificate below:
    This is only used during manual registration.
  • Which port would you like to use for the registration?
    Bynari license key server listens on ports 80 and 3080. If port 80 is blocked, port 3080 can be used as an alternate port.

    Note: The license key server URL is http://update.bynari.net.
    Note: If you encounter any issues while activating your Bynari WebDAV Collaborator license, ping the license key server to verify proper internet connectivity.
  • Click “OK” to register Bynari WebDAV Collaborator.

 

Manual Registration

  • Enter your product license key
    Copy/Paste your license key in the space provided.
  • Manual Registration
    Contact Bynari Support at support@bynari.net and request a manual license certificate.
  • Enter the license certificate below:
    Paste entire certificate in the space provided. (See manual certificate example.)

    Figure 25 – Manual certificate example


    Figure 26 – Manually entering the information
  • Click “OK” to complete manual registration.

3.3 Registration Complete

After registering over the internet or manually, you should see the following screen.

Figure 28 – Manually entering the information

Bynari WebDAV Collaborator License Information

  • License Key
    This is the license key used to register Bynari WebDAV Collaborator.
  • License Expire
    This will display when your license expires.
  • Support Expires
    This option will show the date Bynari support expires.
  • Number of Licenses Used
    This displays the number of licenses used vs. the number of licenses that you have purchased.
  • Total License Available
    This displays the number of licenses available or purchased.
  • Supported Versions
    The WebDAV Collaborator version supported for this license key.
  • Supported Options
    Formats that are supported such as iCal or Kolab are listed.

Click “Refresh” to update dialog screen for license information.

3.4 Unregister Bynari WebDAV Collaborator

  • Click on “About” on the Bynari WebDAV Collaborator Toolbar.
  • Click on “License”.


Figure 29 – WebDAV Collaborator License information

  • Click on “Unregister”.
    This will unregister Bynari WebDAV Collaborator from your computer.

4 Reporting Problems

When reporting problems, be sure to include the following information:

  • Microsoft Windows version number and patch level.
    • Right click on “My Computer” icon on the Desktop and select Properties. The Windows version and patch level will be listed under System: in the General tab dialog.
  • Microsoft Outlook version and patch level.
    • Right click on Help in Outlook and select About Microsoft Outlook. The Outlook version and patch level will be listed.
  • The full version number of the Bynari WebDAV Collaborator.
    • Click “About” on the WebDAV Collaborator toolbar. The WebDAV Collaborator version and build number (1.0-xxxx) will be listed.

 

To contact technical support:

U.S. Toll Free Telephone: 1-800-241-1086
International Telephone: 001-214-350-5772

To open a new support ticket email: support@bynari.net

For FAQs: http://www.bynari.net/users/kb.php

Bynari WebDAV Collaborator

Installation and Configuration Guide

 

Trademarks

Bynari products are trademarks of Bynari, Inc.

Microsoft Windows, Windows Mobile, Outlook, Windows XP, Windows Vista are all registered trademarks of Microsoft Corporation in the United States, other countries, or both.

BlackBerry is a registered trademark of Research In Motion Limited in the United States, other countries, or both.

All other trademarks are the property of their respective owners.

Technical Support

When you purchase any of Bynari’s products, the products include one year of free support and maintenance. To purchase additional yearly support and maintenance, please contact sales@bynari.net.

Customers who are current on support receive one year of product maintenance, upgrades and email and/or telephone matching the purchased support package.

Support is available to customers worldwide.

To contact technical support:

U.S. Toll Free Telephone: 1-800-241-1086
International Telephone: 001-214-350-5772

To open a new support ticket email: support@bynari.net.

For FAQs: http://www.bynari.net/users/kb.php

Licensing

The Bynari WebDAV Collaborator utilizes a licensing key system that assigns and stores the number of licenses that have been purchased by the customer. When Outlook starts, Bynari WebDAV Collaborator (WC) will contact the Bynari license key server over the Internet to validate and activate the installed license. Activation will be attempted each time Outlook is started or until activation of the license is successful.

Note: The license key server URL is http://update.bynari.net.

 

If you encounter any issues while activating your Bynari WebDAV Collaborator license, please see below for a possible solution:

  • The client systems may be blocked from accessing the Internet, or Internet access is temporarily unavailable.
  • The license key entered during the installation of the Bynari WebDAV Collaborator may be invalid. This could include issues such as an incorrect key or incorrect key version.
  • The number of user IDs for the licenses has been exceeded. The Bynari License Server tracks how many user IDs have been activated for each valid license. If there are attempts to activate more user IDs than were purchased for that license, the Bynari WebDAV Collaborator will inform you that additional licenses need to be purchased.
  • If you need to reinstall the Bynari WebDAV Collaborator software on a new system due to either hardware failure or system upgrade and need to unregister, do the following (See section 4.3 for complete details):
    • Open Outlook
    • Click on “About” tab in the Bynari WebDAV Collaborator toolbar
    • Click on “License”
    • Click on “Unregister”

If you experience problems with license activation, please contact your reseller or Bynari support at support@bynari.net.

Important Notes:

  • This documentation applies to the latest 1.0 build of the Bynari WebDAV Collaborator available from Bynari.
  • Make sure that Outlook is setup as the default e-mail client. To verify this on the workstation, go to Control Panel > Internet Options > Programs and make sure that Outlook is selected in the drop down box next to E-mail.

Table of Contents



1 Bynari WebDAV Collaborator version 1.0

The Bynari WebDAV Collaborator acts as a Microsoft Outlook COM Add-In.

1.1 Features of Bynari WebDAV Collaborator

Bynari WebDAV Collaborator 1.0 offers the following features:

  • Full Outlook 2003-2010 Support
  • Manual or Automatic Synchronization Schedules
  • Intuitive Interface

1.2 Supported Platforms

Bynari WebDAV Collaborator 1.0 is compatible with the following software. If you are using a version that is not listed, or software that is not supported, upgrade to a supported version.

Supported Windows® Versions

Windows® XP

Windows® Vista

Windows® 7

Supported Outlook® Versions

Outlook® 2003

Outlook® 2007

Outlook® 2010 (32/64 bit)

Supported Languages

  • English
  • French
  • German
Note: Other languages are provided and may be used but are not formally supported. Problems with translation, spelling, grammar and proper character encoding may be encountered.

1.3 Supported Servers

List of supported servers and how to configure WebDAV Collaborator.

2 Installation

2.1 Preparing Your System (Pre-Installation)

Before you begin:

The WebDAV Collaborator 1.0 software must be installed by the Windows login user. Additionally, this user needs “administrator” rights to install the software. The users’ rights can be changed to install the WebDAV Collaborator and then reset to the original rights.

Before you begin the installation procedure, perform the following steps:

Step 1: Install Microsoft® Windows and/or Microsoft® Outlook

Supported Windows® Versions

Windows® XP

Windows® Vista

Windows® 7

 

Supported Outlook® Versions

Outlook® 2003 SP3+

Outlook® 2007 SP2+

Outlook® 2010 SP1+

Note: If you are using versions that are not listed, upgrade to a supported version.

Step 2: Install the Latest Updates for Microsoft® Windows and Outlook

Go to the Microsoft® website or check with your IT Administrator to verify that you have installed the most current critical updates and service packs for both your Windows operating system and Outlook.

http://update.microsoft.com – Microsoft® updates.

Outlook 2003 minimum required version to install

  • Click on “Help” > “About Microsoft Office Outlook”


Figure 1 – Outlook 2003 about dialog

Outlook 2007 minimum required version to install

  • Click on “Help” > “About Microsoft Office Outlook”


Figure 2 – Outlook 2007 about dialog

Outlook 2010 minimum required version to install

  • Click on “Help” > “About” and then click on “Additional Version and Copyright Information”


Figure 2.3 – Outlook 2010 about dialog

2.2 Installing Bynari WebDAV Collaborator – New Installation

The Bynari WebDAV Collaborator 1.0 Install Wizard standardizes the installation process for Outlook.

The following section explains how to install the Bynari WebDAV Collaborator 1.0 for the first time on a computer. The “upgrade” process is slightly different and available in the section 2.4 of this manual.

Note: The Bynari WebDAV Collaborator will only install on systems where the user has “administrative” rights. The users’ rights can be changed to install the Bynari WebDAV Collaborator and then reset to the original rights after the installation has completed.

 

Important Information: In some cases, virus scanning add-ins for Outlook may need to be disabled for the installation of the Bynari WebDAV Collaborator. Disabling the virus scanning Outlook add-in should not change the functionality of your antivirus software.

Before you begin:

  1. Verify that all steps in “Preparing Your System” (Pre-installation) section 2.1 are complete.
  2. Unzip the Bynari WebDAV Collaborator 1.0 compressed file by right-clicking and selecting “Extract All”.

    Figure 3 – Installation – Downloaded zipped Bynari WebDAV Collaborator
  3. Double Click on the installer.
    Figure 4 – Installation – Bynari WebDAV Collaborator Installer Package
  4. Welcome Dialog:
    Double click the installation setup file to start installation. The setup wizard will display the “Welcome Dialog” window. Select “Next” to continue with the installation process.
    Figure 5 – Installation – Bynari WebDAV Collaborator welcome dialog – Setup Wizard
  5. End User License Agreement:
    Read the license agreement. If you agree, select the button, “I accept the license agreement” and select “Next”.
  6. Select Destination Location:
    The default installation destination for the Bynari WebDAV Collaborator is:
    C:\Program Files\Bynari, Inc\InsightWebDAV Collaborator. A custom installation location may be used. Select the “Browse” button to choose an alternate location to install the Bynari WebDAV Collaborator. Click “Next” to continue the installation.

    Figure 6 – Bynari WebDAV Collaborator – Select Destination Location
  7. Ready to Install:
    Review configuration settings and select “Install” to install the Bynari WebDAV Collaborator. Click “Next” to continue the installation.
    Figure 7 – Bynari WebDAV Collaborator – Ready to Install
  8. Setup Complete:
    To automatically start Outlook, place a check in the box labeled “Run Outlook” and select “Finish”.
    Figure 8 – Bynari WebDAV Collaborator – Finish Install Wizard

2.3 Installation Logs

Error Logging

This feature is only activated during a new installation of the Bynari WebDAV Collaborator when a new profile is created. Error logging is not enabled during the upgrade process.

Viewing the Log File

The Bynari WebDAV Collaborator generates a log file named “Bynari.log” in the user’s %TEMP% directory during the installation process.

Viewing the Log File:

  1. Select “Start” > “Run”.
  2. Type %TEMP% on the Run input field and select “OK”.
  3. A new explorer window will open displaying the contents of the user’s %TEMP% directory.
  4. Browse this directory for a text file named “Bynari.log”. This file can be viewed with any text editor.

Technical Support Logging

The Bynari WebDAV Collaborator also offers additional logging capabilities for troubleshooting. These logs are located under: %AppData%\Local\Bynari\WebDAV Collaborator\

There are both “log” and “trace” directories located here.

To turn on logging, go to the WebDAV Collaborator toolbar and click on:

Settings

When working with Bynari Technical Support, “verbose” logging will be required for troubleshooting.

3 Basic Configuration

3.1 Configure

Begin the WebDAV Collaborator configuration process by selecting “Configure” from the “File” menu under “WebDAV Collaborator”. This will display the “WebDAV Folder Settings” window Collaborator Toolbar.

Figure 9 – Bynari WebDAV Collaborator Toolbar

3.1.1 WebDAV Folder Settings

In the “WebDAV Folder Settings” window click the “Add” button.

Figure 10 – Bynari WebDAV Collaborator – Folder

3.1.2 Folder List

You are now presented with a list of folders which the WebDAV Collaborator can sync for you. The configuration process is the same for each of the folders in this list. In the following steps we configure a calendar, as an example.

Figure 11 – Bynari WebDAV Collaborator – Folder List

3.1.3 Choose a Folder

Click on the desired folder, then click the “OK” button.

Figure 12 – Bynari WebDAV Collaborator Choose a Folder

3.1.4 Folder Settings

The folder settings window will display the folder mappings to the WebDAV server. Complete all fields required by your WebDAV server, then click the “Detect Account Settings” button. If you are unsure of the settings required by your server, contact your server administrator.

Figure 13 – Bynari WebDAV Collaborator Folder Settings

  • Folder Display Name
    Outlook folder name configured to WebDAV server.
  • Folder Type
    Type of folder.
  • Folder Path
    Folder path in Outlook local cache file.
  • Username
    WebDAV Server login user name
  • Password
    WebDAV Server user login password
  • E-Mail
    WebDAV Server e-mail associated with the account, can be different from Username
  • Server URL
    WebDAV Server URL to synchronize with. You can use a short URL for WebDAV Collaborator to figure out the URL if the server supports ‘Principal’ request.Default Server URL for BCS Server 7.4+ are:
    Calendars: http://server/dav/calendars/
    Contacts: http://server/dav/addressbooks/
  • Synchronize when Outlook shuts down
    If enabled, WebDAV Collaborator will synchronize the data before Outlook will exit
  • Detect Account Settings
    Button to detect the account settings and URL is correct or display a list of URL from the WebDAV Server principal request
  • Synchronize Interval in Minutes
    Select synchronization interval for this folder. See “Default Settings” for more information.
  • Conflict Resolution
    Select how to handle conflicts between client and server data. See “Default Settings” for more information.
  • Synchronization Modes
    Select how the synchronization will perform of merging data, client is master or server is master. See “Default Settings” for more information.
  • Default…
    Display Default WebDAV Collaborator Settings
  • Deleted
    Delete the currently selected folder mapping
  • Add…
    Add a new folder mapping
  • OK
    Accept to save the changes
  • Cancel
    Cancel any changes made to the folder mappings

3.1.5 Detect Account Settings

The “Detect Account Settings” window will attempt to detect and display calendar or contacts folders from the WebDAV server.


  • Figure 14 – Bynari WebDAV Collaborator – Detect Account SettingsIf the WebDAV Server returned a list of folders, you can select the folder to accept the full URL to map Outlook’s folder to the server.

  • Figure 23 – Bynari WebDAV Collaborator – Detect Account Settings ErrorIf the server could not resolve the URL, WebDAV Collaborator, contact your system administrator for assistance.

3.1.6 Create and Delete Folders on Server

WebDAV Collaborator can create and delete folders from the server. The URL must be part of the URL principals to be able create and delete folders.


Figure 15 – Bynari WebDAV Collaborator – Create Server Folder

Once the folder is created or deleted, the list of folders from the server will be updated.


Figure 16 – Bynari WebDAV Collaborator – Server Folders

When deleting a folder, WebDAV Collaborator will prompt you if you want to delete the folder from the server.


Figure 17 – Bynari WebDAV Collaborator – Delete Server Folder

3.1.7 Successful Test

If you have a reliable network connection to the server, and you have correctly entered the settings required by your WebDAV server, you will receive a “URL successfully detected” message. If you do not receive this message, contact your WebDAV server administrator.

Figure 19 – Bynari WebDAV Collaborator – URL successfully detected

3.1.8 Default Settings


Figure 30 – Bynari WebDAV Collaborator – Default Settings

  • Synchronization Interval in Minutes
    1. Manual
      Manually synchronize using WebDAV Collaborator’s “Synchronize” button
    2. In Minutes
      WebDAV Collaborator will automatically synchronize the data.
  • Synchronization Modes
    1. Outlook is the master, remove anything on the server not already in Outlook
    2. Merge Outlook data into the server
    3. Server is the master, remove anything in Outlook that is not on the server
    4. Merge server data into Outlook
    5. Keep both Outlook and the server data by merging data both ways
  • Conflict Resolutions
    1. Outlook always win
      All changes and new data is ignored on the server and will be removed from the server
    2. Server always win
      All changes and new data is ignored in Outlook and will be removed from the Outlook
    3. Ask Me
      WebDAV Collaborator will prompt what action to perform on each conflict.
  • Synchronization when Outlook shuts down
    If enabled, WebDAV Collaborator will synchronize the data before Outlook will exit
  • Timeout Value (in seconds)
    Connection time out value in seconds
  • Log Settings
    Select which level of logging to log to the log files.

3.1.9 Synchronize

Select Synchronize from the menu under “WebDAV Collaborator” to manually synchronize the data.

Figure 21 – Bynari WebDAV Collaborator – Synchronize

The synchronization progress window.


Figure 22 – Bynari WebDAV Collaborator – Synchronization Progress

3.1.10 Configuration Complete

Once the synchronization has completed, then you have successfully configured and synchronized your Calendar. Contacts, Journal, Notes and Tasks folders are configured using the same steps that we have just used to configure and synchronize the calendar folder.

3.2 Register the Bynari WebDAV Collaborator

  • Click on “About” in the Bynari WebDAV Collaborator Toolbar.
    Figure 23 – About
  • Click on “License”.



Figure 24 – Key Support button

  • Enter your product license key
    Copy/Paste your license key in the space provided.
  • Manual Registration
    See section “manual registration” below.
  • Enter the license certificate below:
    This is only used during manual registration.
  • Which port would you like to use for the registration?
    Bynari license key server listens on ports 80 and 3080. If port 80 is blocked, port 3080 can be used as an alternate port.

    Note: The license key server URL is http://update.bynari.net.
    Note: If you encounter any issues while activating your Bynari WebDAV Collaborator license, ping the license key server to verify proper internet connectivity.
  • Click “OK” to register Bynari WebDAV Collaborator.

 

Manual Registration

  • Enter your product license key
    Copy/Paste your license key in the space provided.
  • Manual Registration
    Contact Bynari Support at support@bynari.net and request a manual license certificate.
  • Enter the license certificate below:
    Paste entire certificate in the space provided. (See manual certificate example.)

    Figure 25 – Manual certificate example


    Figure 26 – Manually entering the information
  • Click “OK” to complete manual registration.

3.3 Registration Complete

After registering over the internet or manually, you should see the following screen.

Figure 28 – Manually entering the information

Bynari WebDAV Collaborator License Information

  • License Key
    This is the license key used to register Bynari WebDAV Collaborator.
  • License Expire
    This will display when your license expires.
  • Support Expires
    This option will show the date Bynari support expires.
  • Number of Licenses Used
    This displays the number of licenses used vs. the number of licenses that you have purchased.
  • Total License Available
    This displays the number of licenses available or purchased.
  • Supported Versions
    The WebDAV Collaborator version supported for this license key.
  • Supported Options
    Formats that are supported such as iCal or Kolab are listed.

Click “Refresh” to update dialog screen for license information.

3.4 Unregister Bynari WebDAV Collaborator

  • Click on “About” on the Bynari WebDAV Collaborator Toolbar.
  • Click on “License”.


Figure 29 – WebDAV Collaborator License information

  • Click on “Unregister”.
    This will unregister Bynari WebDAV Collaborator from your computer.

4 Reporting Problems

When reporting problems, be sure to include the following information:

  • Microsoft Windows version number and patch level.
    • Right click on “My Computer” icon on the Desktop and select Properties. The Windows version and patch level will be listed under System: in the General tab dialog.
  • Microsoft Outlook version and patch level.
    • Right click on Help in Outlook and select About Microsoft Outlook. The Outlook version and patch level will be listed.
  • The full version number of the Bynari WebDAV Collaborator.
    • Click “About” on the WebDAV Collaborator toolbar. The WebDAV Collaborator version and build number (1.0-xxxx) will be listed.

 

To contact technical support:

U.S. Toll Free Telephone: 1-800-241-1086
International Telephone: 001-214-350-5772

To open a new support ticket email: support@bynari.net

For FAQs: http://www.bynari.net/users/kb.php

Outlook Connector User Guide

Bynari Outlook Connector

User’s Guide

Trademarks

 

Bynari products are trademarks of Bynari, Inc.

 

Microsoft Windows, Windows Mobile, Outlook, Windows XP, Windows Vista are all registered trademarks of Microsoft Corporation in the United States, other countries, or both.

 

BlackBerry is a registered trademark of Research In Motion Limited in the United States, other countries, or both.

All other trademarks are the property of their respective owners.

Technical Support

 

When you purchase any of Bynari’s products, the products include one year of free support and maintenance. To purchase additional yearly support and maintenance, please contact sales@bynari.net.

 

Customers who are current on support receive one year of product maintenance, upgrades and email and/or telephone matching the purchased support package.

Support is available to customers worldwide.

Contact technical support: support@bynari.net.

For FAQs: http://www.bynari.net/users/kb.php

Licensing

The Outlook Connector utilizes a licensing key system that assigns and stores the number of licenses that have been purchased by the customer. When Outlook starts, Outlook Connector (OC) will either contact the patched version of Insight Server 4.3, which allows auto-registration with OC 4.0, or Server 4.4. If you are using a 3rd party server, it will contact the Bynari license key server over the Internet to validate and activate the installed license. Activation will be attempted each time Outlook is started or until activation of the license is successful.

Note: The license key server URL is http://update.bynari.net.

 

If you encounter any issues while activating your Outlook Connector license, please see below for a possible solution:

  • The client systems may be blocked from accessing the Internet, or Internet access is temporarily unavailable.
  • The license key entered during the installation of the Outlook Connector may be invalid. This could include issues such as an incorrect key or incorrect key version.
  • The number of client licenses has been exceeded. The Bynari Key Server tracks how many systems have been activated using a given license. If the number of activated clients exceeds the total for the license, the Outlook Connector will inform you that additional licenses need to be purchased.
  • If you need to reinstall the Outlook Connector software on a new system due to either hardware failure or system upgrade and need to unregister, do the following (See section 4.3 for complete details):
    • Open Outlook
    • Click on “About” tab in the Outlook Connector toolbar
    • Click on “License”
    • Click on “Unregister”

If you experience problems with license activation, please contact your reseller or Bynari support at support@bynari.net.

Important Notes:

  • This documentation applies to the latest 4.0 build of the Outlook Connector available from Bynari.
  • Make sure that Outlook is setup as the default e-mail client. To verify this on the workstation, go to Control Panel > Internet Options > Programs and make sure that Outlook is selected in the drop down box next to E-mail.
  • Outlook Connector 4.0 has been tested with Bynari Server, Univention Corporate Server, Insight Server, and Bynari Collaboration Server, Cyrus, and Kolab IMAPv4 servers. Outlook Connector supports all base specifications as described in RFC 3501: Internet Message Access Protocol version 4rev1. If your IMAPv4 server supports the specifications in RFC 3501, Outlook Connector 4.0 may be compatible with your server. If you encounter issues with a different type of unsupported server, email support at support@bynari.net to create a support ticket. The Bynari support team will provide a reasonable effort in working with you.

 

Table of Contents



1 Outlook Connector version 4.0

The Outlook Connector acts as a MAPI transport for Microsoft Outlook. As a MAPI transport provider, the Connector interprets all the different types of folders used by Outlook.

When Outlook Connector is used in conjunction with the Bynari Server or Insight Server, a powerful collaboration environment is created. Users are able to share mail folders, contacts, tasks, and calendars with other individuals. Public folders of each type can also be created and maintained by system administrators through the web admin interface. All of these functions are supported through the familiar Outlook interface eliminating any need for costly end user training.

1.1 Architecture

Messaging Application Programming Interface or MAPI has two major components. Applications such as Microsoft Outlook use the client side interface to contact the MAPI subsystem for all communications with the message store. There is also a service interface which is used by programs such as Outlook Connector to provide the MAPI transport services for accessing the message store on the server.

Outlook Connector acts as the transport that provides messaging services directly to the MAPI subsystem and stores this information on Insight Server and Bynari Server via the IMAP protocol.

 

Figure 1 – MAPI Architecture

1.2 Features of Outlook Connector

Outlook Connector 4.0 offers the following features:

  • Native MAPI implementation
  • Mobile sync with Windows Mobile device
  • Mobile sync with Blackberry Mobile device
  • Mobile sync of contacts with iPhone
  • Support for new Microsoft PST architecture enables files larger than 2G
  • Simple click-and-go installation and configuration
  • SSL secure connection support
  • Mail, Calendar, Contacts, Journal, Notes and Task folder support
  • Native Outlook calendar functions
  • Free/Busy support
  • Shared folders including Calendars, Contacts, Tasks, Journals, Notes and Mail
  • Contact Distribution Lists
  • Outlook Rules Wizard
  • Read receipts
  • IMAP folder subscriptions
  • Shared access controls
  • Header only download
  • Offline support
  • Grouping
  • Multiple user accounts
  • Voting Buttons
  • Native iCalendar and vCard format support
  • IMAP IDLE support
  • Mailbox quotas
  • Ability to re-download messages
  • And more …

1.3 Supported Platforms

Outlook Connector 4.0 is compatible with the following software. If you are using a version that is not listed, or software that is not supported, upgrade to a supported version.

Supported Windows®Versions

Windows® XP

Windows® Vista

Windows® 7

Supported Outlook® Versions

Outlook® 2003

Outlook® 2007

Outlook® 2010 (32/64 bit)

Supported Languages

  • English
  • French
  • German
  • Italian
  • Spanish (Spain)
  • Portuguese (Brazil)
  • Dutch
  • Norwegian
  • Russian
  • Swedish
  • Taiwanese/Chinese
  • Czech
  • Hebrew
Note: Other languages are provided and may be used but are not formally supported. Problems with translation, spelling, grammar and proper character encoding may be encountered.

 

1.4 Supported IMAP Servers

  • Bynari Collaboration Server
  • Insight Server
  • Cyrus
  • Kolab

1.5 Supported mobility devices and software

Outlook Connector 4.0 includes mobility support for several devices including Blackberry, iPhone and Windows Mobile. The following versions are compatible with Outlook Connector 4.0.

1.6 Known Limitations

  • Microsoft Business Contact Manager is not compatible with Outlook Connector.
  • Smart Phone synchronization is dependent on the hardware and the software provider.
  • Slashes in folder names are not allowed.

2 Installation

2.1 Preparing Your System (Pre-Installation)

Before you begin:

The Connector 4.0 software must be installed by the Windows login user. Additionally, this user needs “administrator” rights to install the software. The users’ rights can be changed to install the Connector and then reset to the original rights.

Before you begin the installation procedure, perform the following steps:

Step 1: Install Microsoft® Windows and/or Microsoft® Outlook

Supported Windows® Versions

Windows® XP

Windows® Vista

Windows® 7

 

Supported Outlook® Versions

Outlook® 2003 SP3+

Outlook® 2007 SP2+

Outlook® 2010 SP1+

Note: If you are using versions that are not listed, upgrade to a supported version.

Step 2: Install the Latest Updates for Microsoft® Windows and Outlook

Go to the Microsoft® website or check with your IT Administrator to verify that you have installed the most current critical updates and service packs for both your Windows operating system and Outlook.

http://update.microsoft.com – Microsoft® updates.

Outlook 2003 minimum required version to install

  • Click on “Help” > “About Microsoft Office Outlook”


Figure 2 – Outlook 2003 about dialog

Outlook 2007 minimum required version to install

  • Click on “Help” > “About Microsoft Office Outlook”


Figure 3 – Outlook 2007 about dialog

Outlook 2010 minimum required version to install

  • Click on “Help” > “About” and then click on “Additional Version and Copyright Information”


Figure 2.3 – Outlook 2010 about dialog

Step 3: Backup “Rules and Alerts”

Outlook “Rules and Alerts” functions are used to organize incoming email. These functions allow users to set custom “actions” that will be performed automatically on incoming messages.

Important Information: “Rules and Alerts” will not transfer during new installation of Outlook Connector 4.x or when upgrading from Outlook Connector 3.x to 4.x. “Rules and Alerts” are stored locally on your computer. They are not uploaded to the server.

 

Export “Rules and Alerts”

  1. Open Outlook
  2. Click on “Tools” > “Rules and Alerts…”


Figure 4 –Installation – Tools – Rules and Alerts

  1. Under the “E-mail Rules” tab, click on “Options”.


Figure 5 –Installation – Tools – Rules and Alerts

  1. Under the “Import and export” area, click on the “Export Rules…” button.


Figure 6 –Installation – Tools – Rules and Alerts – Options

  1. Type a new name for the rules or keep the default.


Figure 7 –Installation – Tools – Rules and Alerts – Save Exported Rules as

  1. Click “Save”.
  2. Click “OK” to remove all dialog windows.
  3. Close Outlook to continue installing or updating Outlook Connector 4.0.

 

Note: In order to ensure proper Rules and Alerts functionality in Microsoft Outlook a check must be placed in the “Schedule an automatic send/receive every” checkbox under Tools>Options>Mail Setup>Send/Receive. Any amount of time may be specified in the associated “minutes” field.

 

2.2 Installing Outlook Connector – New Installation

The 4.0 Outlook Connector Install Wizard standardizes the installation process for Outlook.

The following section explains how to install the Outlook Connector 4.0 for the first time on a computer. The “upgrade” process is slightly different and available in the section 2.4 of this manual.

Note: The Outlook Connector will only install on systems where the user has “administrative” rights. The users’ rights can be changed to install the Outlook Connector and then reset to the original rights after the installation has completed.

 

Important Information: In some cases, virus scanning add-ins for Outlook may need to be disabled for the installation of the Outlook Connector. Disabling the virus scanning Outlook add-in should not change the functionality of your antivirus software.

 

Before you begin:

  1. Verify that all steps in “Preparing Your System” (Pre-installation) section 2.1 are complete.
  2. Unzip the Outlook Connector 4.0 compressed file by right-clicking and selecting “Extract All”.


Figure 8 – Installation – Downloaded zipped Outlook Connector

  1. Double Click on the installer.


Figure 9 – Installation Outlook Connector Installer Package

NOTE: For Windows Vista and Windows 7, you must run the installer as “Run as Administrator” to install Outlook Connector properly.

  1. Welcome Dialog:
    Double click the installation setup file to start installation. The setup wizard will display the “Welcome Dialog” window. Select “Next” to continue with the installation process.


Figure 10 – Installation Outlook Connector welcome dialog Setup Wizard

  1. End User License Agreement:
    Read the license agreement. If you agree, select the button, “I accept the license agreement” and select “Next”.
  2. Create New Outlook Profile:
    The Outlook Connector will automatically create a profile for Outlook. The default name for this profile is “Outlook Connector”. The “default name” is a user defined field and may be changed if needed. Place a check in the box labeled, “Prompt for which profile to use when starting Outlook (Recommended)”, if you have multiple profiles in Outlook. Selecting this will prompt for profile selection when Outlook starts. Click “Next” to continue installation.


Figure 11 – Installation Outlook Connector Create New Profile

  1. Account Information:
    This screen provides the Outlook Connector with the information needed to create the Outlook profile for your email account during the installation process.
    The following basic information is needed to complete this screen:

    • Your Name
    • E-mail Address
    • IMAP Server Address
    • SMTP Server Address
    • Username
    • Password


Figure 12 – Outlook Connector – Account Information

Note: Bynari Collaboration Server requires the entire email address to be used as the “username”. Insight Server only used the first part of the email address, leaving off “@domain.com”.
    • Fill in requested information.
    • Click “Next” to continue.
  1. Select Destination Location:
    The default installation destination for the Outlook Connector is:
    C:\Program Files\Bynari, Inc\InsightConnector.

A custom installation location may be used. Select the “Browse” button to choose an alternate location to install the Outlook Connector. Click “Next” to continue the installation.

Figure 13 – Outlook Connector – Select Destination Location

  1. Outlook Connector Toolbar Options:
    By default, the Outlook Connector Toolbar is configured to be displayed. Displaying the toolbar is the recommended configuration. Select “Yes” to hide the Outlook Connector toolbar. Click “Next” to continue.


Figure 14 – Outlook Connector – Display Toolbar

  1. Ready to Install:
    Review configuration settings and select “Install” to install the Outlook Connector. Click “Next” to continue the installation.


Figure 16 – Outlook Connector – Ready to Install

  1. Setup Complete:
    To automatically start Outlook, place a check in the box labeled “Run Outlook” and select “Finish”.


Figure 17 – Outlook Connector – Finish Install Wizard

 

2.3 Installing Outlook Connector – Upgrade

Upgrading the Outlook Connector is similar to the steps discussed under “Installing Outlook Connector – New Installation” in section 2.1.

In the upgrade process, no profile will be created and all of the original user data from the previous installation of the Outlook Connector is used. The Outlook Connector will automatically upgrade profiles from earlier Outlook Connector versions. Outlook Connector 3.x used a “local cache” data storage system while the Outlook Connector 4 uses a Microsoft PST file to store data.

When upgrading from any of the Outlook Connector 3.x versions, your profile will be upgraded to the new PST architecture. The Outlook Connector will need to perform an initial synchronization after the upgrade process completes.

Important Information: During the initial synchronization process, the Connector will download the newest emails first, and then it will continue to synchronize in the background. This allows the end-user to begin using Outlook immediately while synchronization continues.

 

Note: The Connector installer will automatically determine if your profile needs to be upgraded.

 

Before you begin:

  1. Verify that all steps in “Preparing Your System” (Pre-installation) section 2.1 are complete.
  2. Unzip the Outlook Connector 4.0 compressed file by right-clicking and selecting “Extract All”.


Figure 18 –Installation – Downloaded zipped Outlook Connector

  1. Double Click on the installer to start the installation process.


Figure 19 – Installation Outlook Connector – Installer Package

 

  1. Welcome Dialog:

Double click the installation setup file. The setup wizard will display the “Welcome Dialog” window. Select “Next” to continue with the installation.


Figure 20 – Installation – Outlook Connector welcome dialog – Setup Wizard

  1. End User License Agreement:

Accept the terms of the End User License Agreement to install the Outlook Connector. If you agree to the terms of the license, select “I accept the agreement” then select “Next” to proceed to the next step.

  1. Profile Upgrade
    If Outlook Connector finds any existing profiles, it will upgrade them to the latest version. Confirm that you would like to continue by selecting “Yes”.


Figure 21 – Outlook Connector – Prompt to upgrade profiles

  1. Select Destination Location:
    The default installation destination for the Outlook Connector is:
    C:\Program Files\Bynari, Inc\InsightConnector.

A custom installation location may be used. Select the “Browse” button to choose an alternate location to install the Outlook Connector. Select “Next” to continue the installation. If the existing installation location is used, the following informational window will be displayed. Select “Yes” to proceed to the next step.

Figure 22 – Outlook Connector – Upgrade Destination Location

  1. Outlook Connector Toolbar Options:
    By default, the Outlook Connector Toolbar is configured to be displayed. Displaying the toolbar is the recommended configuration. Select “Yes” to hide the Outlook Connector toolbar. Click “Next” to continue.


Figure 23 – Outlook Connector – Display Toolbar

  1. Ready to Install:
    Review configuration settings and select “Install” to install the Outlook Connector. Click “Next” to continue the installation.


Figure 24 – Outlook Connector – Ready to Install

  1. Setup Complete:
    To automatically start Outlook, place a check in the box labeled “Run Outlook” and select “Finish”.


Figure 25 – Outlook Connector – Upgrade Complete

2.4 Installation Logs

Error Logging

This feature is only activated during a new installation of the Outlook Connector when a new profile is created. Error logging is not enabled during the upgrade process.

Viewing the Log File

The Outlook Connector generates a log file named “Bynari.log” in the user’s %TEMP% directory during the installation process.

Viewing the Log File:

  1. Select “Start” > “Run”.
  2. Type %TEMP% on the Run input field and select “OK”.
  3. A new explorer window will open displaying the contents of the user’s %TEMP% directory.
  4. Browse this directory for a text file named “Bynari.log”. This file can be viewed with any text editor.

 

Technical Support Logging

The Outlook Connector also offers additional logging capabilities for troubleshooting. These logs are located under: %AppData%\Local\Bynari\Bynari Insight Connector 4.0\

There are both “log” and “trace” directories located here.

To turn on logging, go to the Connector toolbar and click on:

Account > More Settings… > Logging

When working with Bynari Technical Support, “verbose” logging will be required for troubleshooting.

3 Post Installation Configuration

3.1 Import “Rules and Alerts”

Important Information: “Rules and Alerts” will not transfer during new installation of Outlook Connector 4.x or when upgrading from Outlook Connector 3.x to 4.x. “Rules and Alerts” are stored locally on your computer. They are not uploaded to the server.
  1. Open Outlook
  2. Click on “Tools” > “Rules and Alerts…”


Figure 26 –Installation – Tools – Rules and Alerts

  1. Under the “E-mail Rules” tab, click on “Options”.


Figure 27 –Installation – Tools – Rules and Alerts

  1. Under the “Import and export” area, click on the “Import Rules…” button.


Figure 28 –Installation – Tools – Rules and Alerts – Options

  1. Type a new name for the rules or keep the default.


Figure 29 –Installation – Tools – Rules and Alerts – Import Rules from

  1. Click “Open”.
  2. Click “OK” to remove all dialog windows.
  3. Ensure that there is a check in the “Send immediately when connected” (labeled “Automatic Send/Receive” in Outlook 2003) checkbox. The checkbox is located on the “Mail Setup” tab, under “Options”, in the “Tools” menu. This is required in order to ensure proper rules functionality.

3.2 Outlook Connector Toolbar

All custom configuration settings can be made through the Outlook Connector Toolbar.

The Outlook Connector toolbar consists of five buttons:

  • Folder – Used for setting folder Access Control List (ACL) permissions and folder types.
  • Refresh Folders – Used to refresh the Outlook folder tree from the IMAP server.
  • Account – Used to modify account configuration settings.
  • Quota – Used to display the user’s current quota status.
  • About – Displays version number and licensing information.


Figure 30 – Outlook Connector Toolbar

3.2.1 Folder

Selecting the “Folder” button on the Outlook Connector Toolbar will open the “Folder Permissions” dialog window.

Figure 31 – Outlook Connector – Folder


Figure 32 – Outlook Connector – Inbox Folder Permissions

This feature is used to share folders with other users on the same system. It is also used to manage the permissions granted to other users using ACL. Folder types can also be changed.

Sharing Folders

Sharing folders using Outlook Connector 4.0.

Figure 33 – Outlook Connector – Folder sharing

Add New User

    Selecting the “Folder” button opens the “Folder Permissions” dialog window. From the “Folder Permissions” dialog window, additional users can be added by selecting the “Add” button


Figure 34 – Outlook Connector – Add New User

  • Set Specific Permissions
    Enter the appropriate username or full email address.
Note: As is the case with Bynari Collaboration Server, some servers require the entire email address to be used when adding a new user to a folder share while others only require the username. Check with your systems administrator for specific information about your server requirements.
  • Select “OK” to confirm adding the new user’s ACL to the specified folder.

    Figure 35 – Outlook Connector – Add New User

 

  • Search Corporate Directory
    This feature is used to search an LDAP directory to find users. Enter a value to search and then click “search”.In the “Search Results” field, select a user or multiple users by holding the control key and clicking on the listings to add and then click “OK”.
  • “Search by” option
    The pull-down list contains five ACL search settings:

    • Any – Search all fields.
    • First Name – Search by “First Name”
    • Last Name – Search by “Last Name”
    • Display Name – Search by “Display Name”
    • E-mail Address – Search by “E-mail Address”
  • ConfigurationThis button provides quick access to the LDAP configuration settings. See LDAP settings under section 2.5.4.2.
  • Select “OK” to confirm adding the new user’s ACL to the specified folder.

Folder Permissions

Figure 36 – Outlook Connector – Folder Permissions Dialog Window

ACL permissions can be adjusted at any time for every user added in the folder permission’s dialog. Users may only grant ACL permissions if they have been given the administrator permission. ACL permissions may not be changed for either the owner or the administrator of the account.

The main “Folder Permissions” dialog window is now displayed again. The username or email address that was just entered is now displayed in the user dialog box. The default permission given to all new users is “Guest”. This can be modified using the pull-down menu in the “Folder Permissions” dialog window.

The pull-down list contains four preconfigured ACL settings:

  • Guest
    Look up, Read, Set Seen Flag rights
  • User
    All rights except for “Create”, “Delete”, and “Administrator”
  • Power User
    All rights except “Administrator”
  • Administrator Full rights
    All rights

Advanced Permissions

More detailed permissions can be assigned by selecting the “Advanced” button.

Figure 37 – Outlook Connector – Folder Permissions Dialog Window


Figure 38 – Outlook Connector – Advanced Permissions

Each of the listed permissions can be set independently giving more granular control over folder sharing permissions.

Permissions

Description

Lookup

The user may see that the folder exists.

Read

The user may read the folder. The user may also select the folder, fetch data, perform searches, and copy messages from the folder.

Set Seen Flag

Keep, per-user, seen state. The “Seen” and “Recent” flags are preserved for the user.

Write

The user may modify flags and keywords other than “Seen” and “Deleted” (which are controlled by other sets of rights).

Insert

The user may insert new messages into the folder.

Post

A user may send a message to the folder. This right differs from the “Insert” right in that the delivery system inserts trace information into submitted messages so that you can filter address by user name, IP address or HTTP requests.

Create Folders

The user may create, delete or rename folders.

Delete Messages

The user may set a message as “Deleted” or permanently delete mail.

Delete Folders

The user may delete folder.

Perform Expunge

User can permanently expunge deleted messages from the folder.

Administrator

The user may change all the permissions on the folders.

Table 1

Folder Type

The “Folder Type” button gives the user the ability to select a specific “type” for any IMAP folder except for Inbox, Outbox, Deleted Items and Sent.


Figure 39 – Outlook Connector – Folder Type

This feature becomes useful if a user wants to create a second calendar to share with others rather than their standard calendar.

3.2.2 Refresh Folders

The “Refresh Folders” button refreshes the folder tree as seen when you press Alt + F1 (navigation pane). When pressed, the Outlook Connector actually scans each folder, not for contents but for the folders themselves. If folder changes are made on the server or if folders are shared to you from someone else, you would use the “Refresh Folders” to display those changes in Outlook.


Figure 40 – Outlook Connector – Refresh Folders

 

Note: The “Refresh Folders” button does not retrieve emails; it refreshes the IMAP folder tree only.

3.2.3 Account

Outlook Connector Account Settings

Figure 41 – Outlook Connector Account


Figure 42 – Outlook Connector – Settings Dialog Window

The Outlook Connector Settings dialog window will be displayed first when selecting “Account” from the Outlook Connector toolbar. All of the information displayed on this screen is entered and configured during the Outlook Connector installation process. Changes can be made to this information as needed.

3.2.4 More Settings

To learn more about the additional settings which are available for configuration, click on the “More Settings…” button.

Across the top of this new window, you will see eight tabs:
General, Connections, Download, Folders, Send/Receive, Other Settings, Format, and About.

3.2.4.1 General


Figure 43– Outlook Connector – More Settings – Connections IMAP

The General tab has two input fields. The first one is already filled in with a default value – “Insight Server Folders”. This is the name that will appear as the display name for “Outlook Today”. This is a user-defined field and can be changed.

The second field is labeled “Other User Information”. It is optional and has no effect on the functionality of the software. This is also a user-defined field.

 

3.2.4.2 Connections

The Connections tab is where IMAP, SMTP, LDAP and Timeout settings are configured.

IMAP

Figure 44 – Outlook Connector – More Settings – Connections IMAP

Incoming Server (IMAP)

  • Server name
    This is the IMAP server name that was entered during installation; it can be changed if needed.
  • Port
    By default, Bynari Server uses port 143.
  • Username
    This is the user name that was entered during installation; it can be changed if needed.
  • Password
    This is the password that was entered during installation; it can be changed if needed.
  • Do not use secure connection
    Default configuration is to not use a secure connection.
  • Use secured connection (SSL)
    Select this option if your server supports IMAP SSL. When selecting this option, the default port of 143 changes to port to 993. This value can be changed manually, if needed.
  • Use Transport Layer Security (TLS)
    Make sure that your server supports TLS before selecting this option. TLS provides endpoint encryption. This protocol allows all communication, including passwords, to be encrypted. TLS is the preferred and most secured method of SSL.
  • Use Persistent Connection
    The default and recommended selection is enabled.
    Important Information: Disabling the use of persistent connections will negatively affect the performance of the Outlook Connector. Persistent connections, also known as “keep alive” connections, reuse the same TCP connection for sending and receiving. This streamlines requests, reduces network traffic, network latency, CPU utilization and memory needs as it requires fewer resources.
  • Test IMAP Settings
    Click this button to test the new IMAP settings.

SMTP

Figure 45 – Outlook Connector – More Settings – Connections IMAP

Outgoing Server (SMTP):

  • Server name
    This is the SMTP server name that was entered during installation; it can be changed if needed.
  • Port
    By default, the Bynari Server uses port 25
  • Do not use secure connection
    Default configuration is to not use a secure connection.
  • Use secured connection (SSL)
    Select this option if your server supports IMAP SSL. When selecting this option, the default port of 143 changes to port to 993. This value can be changed manually, if needed.
  • Use Transport Layer Security (TLS)
    Make sure your server supports TLS before selecting this option. TLS provides endpoint encryption. This protocol allows all communication, including passwords, to be encrypted. TLS is the preferred and most secured method of SSL.

SMTP Authentication:

  • SMTP server requires Authentication
    Note: SMTP Authentication is sent in plain text. To encrypt the user ID and password – enable, “Use Transaction Layer Security (TLS)”.
  • Use Same Authentication as Incoming Server
    This uses your email username and password that you entered when you setup the account.
  • Use SMTP Authentication
    This option is used when sending email from an SMTP server that is not part of the normal mail server network. i.e. an external address or a remote user. Enabling this feature tells the client to authenticate with the server to relay messages to external domains.
  • Test SMTP Settings
    Click this button to test the new SMTP settings.

 

LDAP

Figure 46 – Outlook Connector – More Settings – Connections – LDAP

Note: The LDAP default options are configured for optimal use with Address Book 3.0 and Insight Server 4.3.

 

The Lightweight Directory Access Protocol or LDAP is an application protocol for querying and modifying directory services running over TCP/IP.

An LDAP directory is a set of objects with attributes organized in a logical and hierarchical manner. An example of LDAP could be an address book that consists of names organized alphabetically. Each name in the address book would have a corresponding email address and telephone number.

LDAP shared folder name resolution enables the Outlook Connector to display “actual names” instead of “user names” for shared IMAP folders.

  • Use LDAP to resolve shared folder names
    Place checkmark if you have an LDAP server.

LDAP Server (LDAP):

  • Server name
    This is the LDAP server name that was entered during installation; it can be changed if needed.
  • Port
    By default, the Bynari Server uses port 389.
  • Use SSL
    Select this option if your LDAP server supports IMAP Secured Socket Layer protocol.
  • Anonymous Login
    Select this if your LDAP server allows anonymous binds (anonymous searches).
  • User DN
    The User DN (Distinguished Name) is comprised of a unique identifier for the user and the domain container; the unique identifier is the container “cn=” in the LDAP database followed by the domain or organizational information.

Note: If you are using Insight Server, users can find their own “User DN” information. Log into the web management console as a user, then click on:

    1. Preferences > “Client Configuration”
    2. “Directory Server Account”, locate the field, “Account Name”.

Bynari Collaboration Server users must contact their administrator to retrieve the User DN.

An example DN might be: “cn=testuser1,o=example.net”

If you are not running the Bynari Server or Insight Server, please consult your LDAP administrator for your DN.

  • Use Incoming Server (IMAP) Password
    This uses the IMAP password from the Connections > IMAP field.
  • Password
    This is your password to the LDAP server.
  • Remember Password
    Remember the password so that you do not have to enter it every time it accesses the LDAP server.
  • Test LDAP Settings
    Click this button to test the new LDAP settings.

 

LDAP Advanced options

Figure 47 – Outlook Connector – More Settings – Connections – LDAP – Advanced Settings

 

Searching Options

  • Sort returned results by:

This option sorts the LDAP results by:

  • First Name
  • Last Name
  • Display Name
  • Email Address
  • Display all results in a single container (deep search)

Toggling this option will allow for custom LDAP searches to group level.

  • LDAP Filter for Users:

This option defines the LDAP attribute for users.

  • LDAP Filter for Groups:

This option defines the LDAP attribute for groups.

  • LDAP Search Attributes:

The criteria used in the search attribute can be changed to meet your LDAP structural needs. This information can be found with the user’s container name or unique identifier in the LDAP database. An LDAP browser can quickly display these parameters. In this example, the data refers to the following information:

  • cn = Container name. Typically this is the user’s full name.
  • mail = User’s mail address.
  • givenName = Typically, this is the first name of a user.
  • sn = Surname or last name.

Base DN

  • The top level of the LDAP directory tree is the base, referred to as the “base DN”.
  • By default Outlook Connector attempts to determine your LDAP base DN by your User DN, which you specified on the Connections > LDAP tab. Consult with your LDAP administrator for your DN if the Base DN was not determined automatically.

LDAP Server Version

  • Select LDAP version

Manually select version 2 or LDAP version 3.

  • Detect

This button will attempt to get the LDAP server version automatically.

LDAP attributes

Figure 48 – Outlook Connector – More Settings – Connections – LDAP – Advanced Settings – LDAP Attributes

The value of these attributes is used to perform the searches against the LDAP database. These are comma delimited and can be changed depending on your setup.

  • User Attributes
    The user attribute will search against “login” then “uid”.
  • User ID
    The user id attribute will search against the “login” attribute.
  • First Name
    The first name attribute will search against “givenName”.
  • Last Name
    The last name attribute will search against “sn”.
  • Display Name
    The display name attribute will search against “display-name”, “displayName”, and then “cn”.
  • E-mail Address
    The e-mail address attribute will search against “mail”.

 

Others



Figure 49 – Outlook Connector – More Settings – Connections IMAP

Timeout Setting

  • Server timeout value in number of seconds.
    The Timeout Setting tells the server how long to wait before it closes the session. The default value is “0”. Acceptable values are: “0”, “30-600” seconds. In a corporate environment where the user is on the same network as the mail server, a timeout value of “0” may be adequate.Users on a Wide Area Network (WAN) need to consider larger timeout settings. Setting this value is dependent on your Internet connection speeds. If you are on a dial-up connection, you may want to set this value to 600 seconds whereas if you are on a DSL connection or cable modem connection, 60 seconds may be acceptable.Having a value too low can cause uploading issues when sending large attachments where the Internet upload speeds are usually slow.
  • Auto Registration Port
    Auto registration is disabled by default. This option allows Outlook Connector to verify licensing with their local Insight Server or Bynari Server. If you do not use the Bynari Server or Insight Server, DO NOT enable the Auto Registration Port Checkbox. By default, port 80 is used. This option can be changed depending on your Bynari Server or Insight Server, and your firewall configuration.

    Important Information: The Outlook Connector was designed to function over LAN-based and high speed broadband connections. Many remote users are able to utilize the Outlook Connector as it was designed. For users on poor remote connections, utilizing the Bynari Web Client may be a better option.

 

  • Use SSL
    Use secure socket layer protocol to register.

3.2.4.3 Download


Figure 50 – Outlook Connector – More Settings – Download

 

Download Options

  • Download Headers Only
    Enabled by default, this option improves the performance of the initial synchronization of the emails downloaded for Outlook. It downloads the header only for email messages. When the message is selected for viewing, the entire message is downloaded.

    Note: Tasks, journals, contacts and calendar events are always set for full-content download when selected for viewing.

     

  • Download Contents of Message Only
    Disabled by default, this option downloads the entire message during the synchronization of emails. Attachments are downloaded when the message is selected for viewing.
  • Download Contents of Message and Attachments
    Disabled by default, this option downloads the entire message and associated attachments during the synchronization of emails.
  • Download All Attachments
    This option will download all attachments.
  • Download Attachment Limit
    This option will set the download attachment limit size in bytes. Any value is accepted in this field. The default is 50,000 bytes.

Download Message progress

  • Show progress indicator when loading messages
    When this box is checked, a progress indicator will appear when synchronizing any folder with more than 50 messages. This option is checked by default.
  • Indicator threshold (number of messages)
    This option allows you to modify when the indicator will appear. By default, this value is set to 50 messages, adjusting this to zero will display the indicator for every message.

3.2.4.4 Folders


Figure 51 – Outlook Connector – More Settings – Folders

Folder Type

  • Use ACL to set folder types
    Enabled by default, it allows the Outlook Connector to use custom IMAP folder ACLs to specify the specialized folder types used by Outlook. These are “Calendar”, “Contact”, “Task”, “Journal”, “Notes“, and “Mail”. This option increases performance since the Outlook Connector no longer has to locate a hidden synchronization message to determine a given folder’s type.

Folder List

  • Show All Folders
    This is enabled by default and tells the Outlook Connector to automatically subscribe to all folders found under the user’s folder list.
  • Show Only Subscribed Folders
    In large environments, the default value of “Show All Folders” may not be desirable. This option allows the users to individually select only the folders they want to see in Outlook.
Important Information: When manually selecting folders, make sure that default folders are checked. i.e. Calendar, Contacts, Deleted Items, Sent Items, Outbox and Tasks. If you uncheck them, it will cause Outlook to recreate them on the IMAP server. This is a default behavior of Outlook.

 

3.2.4.5 Send/Receive


Figure 52 – Outlook Connector – More Settings – Send/Receive

Outlook Connector utilizes IMAP IDLE to update the Inbox folder. For servers that do not support IMAP IDLE make sure that the Inbox folder is selected.

 

3.2.4.6 Other Settings


Figure 53 – Outlook Connector – More Settings – Miscellaneous

The Other Settings tab contains two sections; one for read receipt request options and the second for local cache options.

Message Receipt Options

How would you like to respond to requests for read receipts on incoming messages?

  • Prompt me before sending a response
    This option is the default setting. This setting “prompts” the user to choose between sending a read receipt or not.
  • Always send a response [default selection]
    This option automatically sends a response to the sender of a read receipt request.
  • Never send a response
    This option never sends a response to a read request sender.

Local Cache Options

Store local message cache in the following directory:

  • Default Location
    The default location for the local cache is:Windows XP:
    C:\Documents and Settings\[user name]\Local Settings\Application Data\Bynari\Outlook Connector 4.0\Accounts\[Outlook profile name]\[email address]\Windows 7:
    C:\Users\[user name]\AppData\Local\Bynari\Outlook Connector 4.0\Accounts\[Outlook profile name]\[email address]\The name of the local cache file is: LocalCache.ost
  • Custom Location
    This option allows you to change the location of the local cache. This enables the administrator to place the local cache on the network through a network share for user data backup if needed.

    Note: Read, Write, Delete and Change permissions within Microsoft Windows are required for any Custom Location.
    Note: Any changes made to the location of the local cache will require a restart of Outlook. If you do not restart Outlook, you may see errors, because the Outlook Connector must create the LocalCache.pst file.

 

3.2.4.7 Format


Figure 54 – Outlook Connector – More Settings – Format

Message Format Options

Note: “Use Kolab Format” option is available in the Kolab version of Outlook Connector 4.0.
  • Use Microsoft Message Format
    This is also known as “.tnef” formatting which stands for Transport Neutral Encapsulation Format. This allows files to contain rich text formatting used by e-mail messages, such as bold, italics, underlining, etc…
  • Use iCal Format
    This option is turned on by default in the “ical” or “iCalender” format version of Outlook Connector. iCalendar is a file format which allows sending meeting requests and tasks to other internet users via email or sharing files with an .ics extension.“iCal” format is significantly smaller than the “.tnef” format which can improve performance and save disk space.

    Note: If you use a Kolab server or an iCalendar compatible server, you may not need to select “Use Microsoft Message Format”. If you are unsure, it is best to select both options.
  • Use Kolab Format
    Use this option only if you are running a Bynari Collaborator Server or Kolab IMAP server. Kolab uses a unique XML format attached to email specifically for Kolab groupware servers. The XML holds information for contacts, calendar events, journals, etc.

 

3.2.4.8 Logging


Figure 55 – Outlook Connector – More Settings – Logging

Logging capabilities have been added to the Outlook Connector as a troubleshooting aid. By default, all logging is off. Log files can consume large amounts of disk space, and it is recommended that logging be left off, unless the user is experiencing problems.

When working with Bynari Technical Support on an issue, they may request that you enable logging. Verbose logging is the most thorough level of logging offered and will offer the most insight to the support technician.

 

3.2.4.9 About


Figure 56 – Outlook Connector – More Settings – About

About tab

The about tab provides information about the Outlook Connector. It contains the version number as well as all licensing information.

3.2.5 Quota

Used to display the user’s current quota status.

Figure 57 – Outlook Connector – Toolbar Quota button


Figure 58 – Outlook Connector Quota

3.2.6 About


Figure 59 – Outlook Connector – About

The “About” button on the Outlook Connector toolbar performs the same function as the “About” tab discussed above in section 2.5.4.9.

4 Using Outlook Connector

Outlook Connector 4.0 provides Outlook with a MAPI transport service that makes connecting to an IMAP server transparent to the end user. The following sections describe some of the additional dialogs introduced by the Connector such as Folder permissions as well as documenting configuration changes needed for features such as Free/Busy.

4.1 Viewing Shared Folders

Note: Private events (calendar, contacts, and tasks) are stored on the server. Only the folder owner will see private events.

Other users’ shared folders will appear under ‘Other Users’ in the folder list.


Figure 61 – “Other Users” shared folder list

Public folders created on the Bynari Server and Insight Server will display under ‘Shared Folders’ in Outlook.

 


Figure 62 – “Shared Folders” public folder list

 

Note: Upgrade your Insight Server to at least 4.2.2 to support private events.

4.2 Free/Busy Configuration

Outlook allows users to share free/busy information from their calendars with other users on their mail server. With the Microsoft Office Internet Free/Busy Service, users can publish their free/busy times to a shared Internet location. Members using this service can view each other’s free/busy information when viewing shared calendars or creating meeting requests.


Configure Free/Busy

  • Open Options in Outlook
    On the Outlook Toolbar, select Tools > Options.

    Figure 63 – Outlook Tools, Options
  • This opens a new window; select the Preferences option tab.

Options – Preferences

  • Click on “Calendar Options…”

    Figure 64 Tools Options

Calendar Options – Advanced options


Figure 65 – Tools – Options – Calendar Options

Note:When sending meeting requests over the Internet, use iCalendar format” option will likely be grayed out. This is normal.

 

  • Enable alternate calendar
    Select this option if you wish to enable an alternate calendar.
  • Click on “Free/Busy Options…”
    Select to change the Free/Busy Options.

 

Free/Busy Options

Figure 66 – Tools – Options – Calendar Options Free/Busy Options

Options

  • Publish “2” month(s) of Calendar free/busy information the server
    Enter the number of months of Free/Busy information to be published.The default interval is 2 months. This value represents the number of months from today’s date.
  • Update free/busy information on the sever every “15” minutes
    The default time is every 15 minutes. This value represents how often Outlook will update the user’s Free/Busy information on the server.

Internet Free/Busy

  • Publish at my location
    This option must be checked. In figure 66, a path name is shown. Insert your information in place of the variables, “%NAME%.vcf”.

    Note: If you are using Insight Server 4.3, use the below example by changing the server name and replacing %NAME% with your username.ftp://mail.example.net/freebusy/%NAME%.vcf
  • Search location
    Enter the URL for the shared free/busy search location.

    Note: If you are using Insight Server 4.3, use the below example by changing the server name and replacing %NAME% with your username.http://mail.example.net/freebusy/%NAME%.vcf
  • Click “OK” to apply the Free/Busy settings.

4.3 Show / Hide Toolbar

  • Toggle toolbar display

On the Outlook Toolbar, select View > Toolbars > Outlook Connector 4.0.

It places a check mark next to the name to show that the Connector is enabled.



Figure 67 Show/Hide Outlook Connector Toolbar

If you have hidden the Outlook Connector toolbar at the time of the installation, you can show the toolbar by following the above steps.

5 Registering and Unregistering Outlook Connector

Outlook Connector 4.0 is configured to use auto registration by default when “Insight Server” is selected during installation. Auto registration is designed for users of both the Outlook Connector and Insight Server or the Bynari Server. With auto registration enabled, the Outlook Connector will verify that an active license exists for the client when Outlook starts. It is recommended that users of the Insight Server or the Bynari Server utilize this feature of the Outlook Connector.

If you do not have an Insight Server or Bynari Server, or do not wish to use auto registration, you can register your copy of the Outlook Connector using the About tab of the Outlook Connector toolbar.

5.1 Auto Registration

Enable or disable auto registration

  • Click on the “Account” tab in Outlook Connector toolbar.


Figure 68 – Outlook Connector – Account

  • Select “Connections” > “Others”.


Figure 69 Outlook Connector – More Settings – Connections – IMAP

 

Important Information: Do not enable auto registration if you do not use the Insight Server or Bynari Collaborator Server (BCS).

 

  • Auto Registration Port
    Auto registration is either enabled or disabled depending on your Insight Server selection during installation. This option allows Outlook Connector to verify licensing with a local Bynari Server or Insight Server. By default, port 80 is used. This option can be changed depending on your Bynari Server or Insight Server, and your firewall configuration.
  • Use SSL
    Use secure socket layer protocol to register.

    Troubleshooting Tip: If you are experiencing trouble registering the connector and your server does not support auto-registration, make sure that the “Auto Registration Port” option is NOT checked. This option is being deprecated in future versions of the connector.

5.2 Register Outlook Connector

  • Click on “About” in the Outlook Connector Toolbar.

    Figure 70 – Outlook Connector About

 

  • Click on “License”.

    Figure 71 About
    Figure 682 Key Support button
  • Enter your product license key
    Copy/Paste your license key in the space provided.
  • Manual Registration
    See section “manual registration” below.
  • Enter the license certificate below:
    This is only used during manual registration.
  • Which port would you like to use for the registration?
    Bynari license key server listens on ports 80 and 3080. If port 80 is blocked, port 3080 can be used as an alternate port.

    Note: The license key server URL is http://update.bynari.net.
    Note: If you encounter any issues while activating your Outlook Connector license, ping the license key server to verify proper internet connectivity.
  • Click “OK” to register Outlook Connector.

Manual Registration

  • Enter your product license key
    Copy/Paste your license key in the space provided.
  • Manual Registration
    Contact Bynari Support at support@bynari.net and request a manual license certificate.
  • Enter the license certificate below:
    Paste entire certificate in the space provided. (See manual certificate example.)

    Figure 693 – Manual certificate example

    Figure 684 – Manually entering the information
  • Click “OK” to complete manual registration.

5.3 Registration Complete

  • After registering over the internet or manually, you should see the following screen.

    Figure 715 Manually entering the information

Outlook Connector License Information

  • License Key
    This is the license key used to register Outlook Connector.
  • License Expire
    This will display when your license expires.
  • Support Expires
    This option will show the date Bynari support expires.
  • Number of Licenses Used
    This displays the number of licenses used vs. the number of licenses that you have purchased.
  • Total License Available
    This displays the number of licenses available or purchased.
  • Supported Versions
    The Connector version supported for this license key.
  • Supported Options
    Formats that are supported such as iCal or Kolab are listed.

Click “Refresh” to update dialog screen for license information.

5.4 Unregister Outlook Connector

  • Click on “About” on the Outlook Connector Toolbar.
  • Click on “License”.

    Figure 726 – Connector License information
  • Click on “Unregister”.
    This will unregister Outlook Connector from your computer.



6 Reporting Problems

When reporting problems, be sure to include the following information:

  • Microsoft Windows version number and patch level.
    • Right click on “My Computer” icon on the Desktop and select Properties. The Windows version and patch level will be listed under System: in the General tab dialog.
  • Microsoft Outlook version and patch level.
    • Right click on Help in Outlook and select About Microsoft Outlook. The Outlook version and patch level will be listed.
  • The full version number of the Outlook Connector.
    • Click “About” on the Connector toolbar. The connector version and build number (4.Y-XXXX) will be listed.

 

To contact technical support:

U.S. Toll Free Telephone: 1-800-241-1086
International Telephone: 001-214-350-5772

To open a new support ticket email: support@bynari.net

For FAQs: http://www.bynari.net/users/kb.php

Bynari Outlook Connector

User’s Guide

Trademarks

 

Bynari products are trademarks of Bynari, Inc.

 

Microsoft Windows, Windows Mobile, Outlook, Windows XP, Windows Vista are all registered trademarks of Microsoft Corporation in the United States, other countries, or both.

 

BlackBerry is a registered trademark of Research In Motion Limited in the United States, other countries, or both.

All other trademarks are the property of their respective owners.

Technical Support

 

When you purchase any of Bynari’s products, all the products except the WebDAV Collaborator include one year of free support and maintenance. To purchase additional yearly support and maintenance, please contact sales@bynari.net.

 

Customers who are current on support receive one year of product maintenance, upgrades and email and/or telephone matching the purchased support package.

Support is available to customers worldwide.

To contact technical support:

U.S. Toll Free Telephone: 1-800-241-1086
International Telephone: 001-214-350-5772

To open a new support ticket email: support@bynari.net.

For FAQs: http://www.bynari.net/users/kb.php

Licensing

The Outlook Connector utilizes a licensing key system that assigns and stores the number of licenses that have been purchased by the customer. When Outlook starts, Outlook Connector (OC) will either contact the patched version of Insight Server 4.3, which allows auto-registration with OC 4.0, or Server 4.4. If you are using a 3rd party server, it will contact the Bynari license key server over the Internet to validate and activate the installed license. Activation will be attempted each time Outlook is started or until activation of the license is successful.

Note: The license key server URL is http://update.bynari.net.

 

If you encounter any issues while activating your Outlook Connector license, please see below for a possible solution:

  • The client systems may be blocked from accessing the Internet, or Internet access is temporarily unavailable.
  • The license key entered during the installation of the Outlook Connector may be invalid. This could include issues such as an incorrect key or incorrect key version.
  • The number of client licenses has been exceeded. The Bynari Key Server tracks how many systems have been activated using a given license. If the number of activated clients exceeds the total for the license, the Outlook Connector will inform you that additional licenses need to be purchased.
  • If you need to reinstall the Outlook Connector software on a new system due to either hardware failure or system upgrade and need to unregister, do the following (See section 4.3 for complete details):
    • Open Outlook
    • Click on “About” tab in the Outlook Connector toolbar
    • Click on “License”
    • Click on “Unregister”

If you experience problems with license activation, please contact your reseller or Bynari support at support@bynari.net.

Important Notes:

  • This documentation applies to the latest 4.0 build of the Outlook Connector available from Bynari.
  • Make sure that Outlook is setup as the default e-mail client. To verify this on the workstation, go to Control Panel > Internet Options > Programs and make sure that Outlook is selected in the drop down box next to E-mail.
  • Outlook Connector 4.0 has been tested with Bynari Server, Univention Corporate Server, Insight Server, and Bynari Collaboration Server, Cyrus, and Kolab IMAPv4 servers. Outlook Connector supports all base specifications as described in RFC 3501: Internet Message Access Protocol version 4rev1. If your IMAPv4 server supports the specifications in RFC 3501, Outlook Connector 4.0 may be compatible with your server. If you encounter issues with a different type of unsupported server, email support at support@bynari.net to create a support ticket. The Bynari support team will provide a reasonable effort in working with you.

 

Table of Contents



1 Outlook Connector version 4.0

The Outlook Connector acts as a MAPI transport for Microsoft Outlook. As a MAPI transport provider, the Connector interprets all the different types of folders used by Outlook.

When Outlook Connector is used in conjunction with the Bynari Server or Insight Server, a powerful collaboration environment is created. Users are able to share mail folders, contacts, tasks, and calendars with other individuals. Public folders of each type can also be created and maintained by system administrators through the web admin interface. All of these functions are supported through the familiar Outlook interface eliminating any need for costly end user training.

1.1 Architecture

Messaging Application Programming Interface or MAPI has two major components. Applications such as Microsoft Outlook use the client side interface to contact the MAPI subsystem for all communications with the message store. There is also a service interface which is used by programs such as Outlook Connector to provide the MAPI transport services for accessing the message store on the server.

Outlook Connector acts as the transport that provides messaging services directly to the MAPI subsystem and stores this information on Insight Server and Bynari Server via the IMAP protocol.

 

Figure 1 – MAPI Architecture

1.2 Features of Outlook Connector

Outlook Connector 4.0 offers the following features:

  • Native MAPI implementation
  • Mobile sync with Windows Mobile device
  • Mobile sync with Blackberry Mobile device
  • Mobile sync of contacts with iPhone
  • Support for new Microsoft PST architecture enables files larger than 2G
  • Simple click-and-go installation and configuration
  • SSL secure connection support
  • Mail, Calendar, Contacts, Journal, Notes and Task folder support
  • Native Outlook calendar functions
  • Free/Busy support
  • Shared folders including Calendars, Contacts, Tasks, Journals, Notes and Mail
  • Contact Distribution Lists
  • Outlook Rules Wizard
  • Read receipts
  • IMAP folder subscriptions
  • Shared access controls
  • Header only download
  • Offline support
  • Grouping
  • Multiple user accounts
  • Voting Buttons
  • Native iCalendar and vCard format support
  • IMAP IDLE support
  • Mailbox quotas

  • And more …

1.3 Supported Platforms

Outlook Connector 4.0 is compatible with the following software. If you are using a version that is not listed, or software that is not supported, upgrade to a supported version.

Supported Windows®Versions

Windows® XP

Windows® Vista

Windows® 7

Supported Outlook® Versions

Outlook® 2003

Outlook® 2007

Outlook® 2010 (32/64 bit)

Supported Languages

  • English
  • French
  • German
  • Italian
  • Spanish (Spain)
  • Portuguese (Brazil)
  • Dutch
  • Norwegian
  • Russian
  • Swedish
  • Taiwanese/Chinese
  • Czech
  • Hebrew
Note: Other languages are provided and may be used but are not formally supported. Problems with translation, spelling, grammar and proper character encoding may be encountered.

 

1.4 Supported IMAP Servers

  • Bynari Collaboration Server
  • Insight Server
  • Cyrus
  • Kolab

1.5 Supported mobility devices and software

Outlook Connector 4.0 includes mobility support for several devices including Blackberry, iPhone and Windows Mobile. The following versions are compatible with Outlook Connector 4.0.

1.6 Known Limitations

  • Microsoft Business Contact Manager is not compatible with Outlook Connector.
  • Smart Phone synchronization is dependent on the hardware and the software provider.
  • Slashes in folder names are not allowed.

2 Installation

2.1 Preparing Your System (Pre-Installation)

Before you begin:

The Connector 4.0 software must be installed by the Windows login user. Additionally, this user needs “administrator” rights to install the software. The users’ rights can be changed to install the Connector and then reset to the original rights.

Before you begin the installation procedure, perform the following steps:

Step 1: Install Microsoft® Windows and/or Microsoft® Outlook

Supported Windows® Versions

Windows® XP

Windows® Vista

Windows® 7

 

Supported Outlook® Versions

Outlook® 2003 SP3+

Outlook® 2007 SP2+

Outlook® 2010 SP1+

Note: If you are using versions that are not listed, upgrade to a supported version.

Step 2: Install the Latest Updates for Microsoft® Windows and Outlook

Go to the Microsoft® website or check with your IT Administrator to verify that you have installed the most current critical updates and service packs for both your Windows operating system and Outlook.

http://update.microsoft.com – Microsoft® updates.

Outlook 2003 minimum required version to install

  • Click on “Help” > “About Microsoft Office Outlook”


Figure 2 – Outlook 2003 about dialog

Outlook 2007 minimum required version to install

  • Click on “Help” > “About Microsoft Office Outlook”


Figure 3 – Outlook 2007 about dialog

Outlook 2010 minimum required version to install

  • Click on “Help” > “About” and then click on “Additional Version and Copyright Information”


Figure 2.3 – Outlook 2010 about dialog

Step 3: Backup “Rules and Alerts”

Outlook “Rules and Alerts” functions are used to organize incoming email. These functions allow users to set custom “actions” that will be performed automatically on incoming messages.

Important Information: “Rules and Alerts” will not transfer during new installation of Outlook Connector 4.x or when upgrading from Outlook Connector 3.x to 4.x. “Rules and Alerts” are stored locally on your computer. They are not uploaded to the server.

 

Export “Rules and Alerts”

  1. Open Outlook
  2. Click on “Tools” > “Rules and Alerts…”


Figure 4 –Installation – Tools – Rules and Alerts

  1. Under the “E-mail Rules” tab, click on “Options”.


Figure 5 –Installation – Tools – Rules and Alerts

  1. Under the “Import and export” area, click on the “Export Rules…” button.


Figure 6 –Installation – Tools – Rules and Alerts – Options

  1. Type a new name for the rules or keep the default.


Figure 7 –Installation – Tools – Rules and Alerts – Save Exported Rules as

  1. Click “Save”.
  2. Click “OK” to remove all dialog windows.
  3. Close Outlook to continue installing or updating Outlook Connector 4.0.

 

Note: In order to ensure proper Rules and Alerts functionality in Microsoft Outlook a check must be placed in the “Schedule an automatic send/receive every” checkbox under Tools>Options>Mail Setup>Send/Receive. Any amount of time may be specified in the associated “minutes” field.

 

2.2 Installing Outlook Connector – New Installation

The 4.0 Outlook Connector Install Wizard standardizes the installation process for Outlook.

The following section explains how to install the Outlook Connector 4.0 for the first time on a computer. The “upgrade” process is slightly different and available in the section 2.4 of this manual.

Note: The Outlook Connector will only install on systems where the user has “administrative” rights. The users’ rights can be changed to install the Outlook Connector and then reset to the original rights after the installation has completed.

 

Important Information: In some cases, virus scanning add-ins for Outlook may need to be disabled for the installation of the Outlook Connector. Disabling the virus scanning Outlook add-in should not change the functionality of your antivirus software.

 

Before you begin:

  1. Verify that all steps in “Preparing Your System” (Pre-installation) section 2.1 are complete.
  2. Unzip the Outlook Connector 4.0 compressed file by right-clicking and selecting “Extract All”.


Figure 8 – Installation – Downloaded zipped Outlook Connector

  1. Double Click on the installer.


Figure 9 – Installation Outlook Connector Installer Package

NOTE: For Windows Vista and Windows 7, you must run the installer as “Run as Administrator” to install Outlook Connector properly.

  1. Welcome Dialog:
    Double click the installation setup file to start installation. The setup wizard will display the “Welcome Dialog” window. Select “Next” to continue with the installation process.


Figure 10 – Installation Outlook Connector welcome dialog Setup Wizard

  1. End User License Agreement:
    Read the license agreement. If you agree, select the button, “I accept the license agreement” and select “Next”.
  2. Create New Outlook Profile:
    The Outlook Connector will automatically create a profile for Outlook. The default name for this profile is “Outlook Connector”. The “default name” is a user defined field and may be changed if needed. Place a check in the box labeled, “Prompt for which profile to use when starting Outlook (Recommended)”, if you have multiple profiles in Outlook. Selecting this will prompt for profile selection when Outlook starts. Click “Next” to continue installation.


Figure 11 – Installation Outlook Connector Create New Profile

  1. Account Information:
    This screen provides the Outlook Connector with the information needed to create the Outlook profile for your email account during the installation process.
    The following basic information is needed to complete this screen:

    • Your Name
    • E-mail Address
    • IMAP Server Address
    • SMTP Server Address
    • Username
    • Password


Figure 12 – Outlook Connector – Account Information

Note: Bynari Collaboration Server requires the entire email address to be used as the “username”. Insight Server only used the first part of the email address, leaving off “@domain.com”.
    • Fill in requested information.
    • Click “Next” to continue.
  1. Select Destination Location:
    The default installation destination for the Outlook Connector is:
    C:\Program Files\Bynari, Inc\InsightConnector.

A custom installation location may be used. Select the “Browse” button to choose an alternate location to install the Outlook Connector. Click “Next” to continue the installation.

Figure 13 – Outlook Connector – Select Destination Location

  1. Outlook Connector Toolbar Options:
    By default, the Outlook Connector Toolbar is configured to be displayed. Displaying the toolbar is the recommended configuration. Select “Yes” to hide the Outlook Connector toolbar. Click “Next” to continue.


Figure 14 – Outlook Connector – Display Toolbar

  1. Ready to Install:
    Review configuration settings and select “Install” to install the Outlook Connector. Click “Next” to continue the installation.


Figure 16 – Outlook Connector – Ready to Install

  1. Setup Complete:
    To automatically start Outlook, place a check in the box labeled “Run Outlook” and select “Finish”.


Figure 17 – Outlook Connector – Finish Install Wizard

 

2.3 Installing Outlook Connector – Upgrade

Upgrading the Outlook Connector is similar to the steps discussed under “Installing Outlook Connector – New Installation” in section 2.1.

In the upgrade process, no profile will be created and all of the original user data from the previous installation of the Outlook Connector is used. The Outlook Connector will automatically upgrade profiles from earlier Outlook Connector versions. Outlook Connector 3.x used a “local cache” data storage system while the Outlook Connector 4 uses a Microsoft PST file to store data.

When upgrading from any of the Outlook Connector 3.x versions, your profile will be upgraded to the new PST architecture. The Outlook Connector will need to perform an initial synchronization after the upgrade process completes.

Important Information: During the initial synchronization process, the Connector will download the newest emails first, and then it will continue to synchronize in the background. This allows the end-user to begin using Outlook immediately while synchronization continues.

 

Note: The Connector installer will automatically determine if your profile needs to be upgraded.

 

Before you begin:

  1. Verify that all steps in “Preparing Your System” (Pre-installation) section 2.1 are complete.
  2. Unzip the Outlook Connector 4.0 compressed file by right-clicking and selecting “Extract All”.


Figure 18 –Installation – Downloaded zipped Outlook Connector

  1. Double Click on the installer to start the installation process.


Figure 19 – Installation Outlook Connector – Installer Package

 

  1. Welcome Dialog:

Double click the installation setup file. The setup wizard will display the “Welcome Dialog” window. Select “Next” to continue with the installation.


Figure 20 – Installation – Outlook Connector welcome dialog – Setup Wizard

  1. End User License Agreement:

Accept the terms of the End User License Agreement to install the Outlook Connector. If you agree to the terms of the license, select “I accept the agreement” then select “Next” to proceed to the next step.

  1. Profile Upgrade
    If Outlook Connector finds any existing profiles, it will upgrade them to the latest version. Confirm that you would like to continue by selecting “Yes”.


Figure 21 – Outlook Connector – Prompt to upgrade profiles

  1. Select Destination Location:
    The default installation destination for the Outlook Connector is:
    C:\Program Files\Bynari, Inc\InsightConnector.

A custom installation location may be used. Select the “Browse” button to choose an alternate location to install the Outlook Connector. Select “Next” to continue the installation. If the existing installation location is used, the following informational window will be displayed. Select “Yes” to proceed to the next step.

Figure 22 – Outlook Connector – Upgrade Destination Location

  1. Outlook Connector Toolbar Options:
    By default, the Outlook Connector Toolbar is configured to be displayed. Displaying the toolbar is the recommended configuration. Select “Yes” to hide the Outlook Connector toolbar. Click “Next” to continue.


Figure 23 – Outlook Connector – Display Toolbar

  1. Ready to Install:
    Review configuration settings and select “Install” to install the Outlook Connector. Click “Next” to continue the installation.


Figure 24 – Outlook Connector – Ready to Install

  1. Setup Complete:
    To automatically start Outlook, place a check in the box labeled “Run Outlook” and select “Finish”.


Figure 25 – Outlook Connector – Upgrade Complete

2.4 Installation Logs

Error Logging

This feature is only activated during a new installation of the Outlook Connector when a new profile is created. Error logging is not enabled during the upgrade process.

Viewing the Log File

The Outlook Connector generates a log file named “Bynari.log” in the user’s %TEMP% directory during the installation process.

Viewing the Log File:

  1. Select “Start” > “Run”.
  2. Type %TEMP% on the Run input field and select “OK”.
  3. A new explorer window will open displaying the contents of the user’s %TEMP% directory.
  4. Browse this directory for a text file named “Bynari.log”. This file can be viewed with any text editor.

 

Technical Support Logging

The Outlook Connector also offers additional logging capabilities for troubleshooting. These logs are located under: %AppData%\Local\Bynari\Bynari Insight Connector 4.0\

There are both “log” and “trace” directories located here.

To turn on logging, go to the Connector toolbar and click on:

Account > More Settings… > Logging

When working with Bynari Technical Support, “verbose” logging will be required for troubleshooting.

3 Post Installation Configuration

3.1 Import “Rules and Alerts”

Important Information: “Rules and Alerts” will not transfer during new installation of Outlook Connector 4.x or when upgrading from Outlook Connector 3.x to 4.x. “Rules and Alerts” are stored locally on your computer. They are not uploaded to the server.
  1. Open Outlook
  2. Click on “Tools” > “Rules and Alerts…”


Figure 26 –Installation – Tools – Rules and Alerts

  1. Under the “E-mail Rules” tab, click on “Options”.


Figure 27 –Installation – Tools – Rules and Alerts

  1. Under the “Import and export” area, click on the “Import Rules…” button.


Figure 28 –Installation – Tools – Rules and Alerts – Options

  1. Type a new name for the rules or keep the default.


Figure 29 –Installation – Tools – Rules and Alerts – Import Rules from

  1. Click “Open”.
  2. Click “OK” to remove all dialog windows.
  3. Ensure that there is a check in the “Send immediately when connected” (labeled “Automatic Send/Receive” in Outlook 2003) checkbox. The checkbox is located on the “Mail Setup” tab, under “Options”, in the “Tools” menu. This is required in order to ensure proper rules functionality.

3.2 Outlook Connector Toolbar

All custom configuration settings can be made through the Outlook Connector Toolbar.

The Outlook Connector toolbar consists of five buttons:

  • Folder – Used for setting folder Access Control List (ACL) permissions and folder types.
  • Refresh Folders – Used to refresh the Outlook folder tree from the IMAP server.
  • Account – Used to modify account configuration settings.
  • Quota – Used to display the user’s current quota status.
  • About – Displays version number and licensing information.


Figure 30 – Outlook Connector Toolbar

3.2.1 Folder

Selecting the “Folder” button on the Outlook Connector Toolbar will open the “Folder Permissions” dialog window.

Figure 31 – Outlook Connector – Folder


Figure 32 – Outlook Connector – Inbox Folder Permissions

This feature is used to share folders with other users on the same system. It is also used to manage the permissions granted to other users using ACL. Folder types can also be changed.

Sharing Folders

Sharing folders using Outlook Connector 4.0.

Figure 33 – Outlook Connector – Folder sharing

Add New User

    Selecting the “Folder” button opens the “Folder Permissions” dialog window. From the “Folder Permissions” dialog window, additional users can be added by selecting the “Add” button


Figure 34 – Outlook Connector – Add New User

  • Set Specific Permissions
    Enter the appropriate username or full email address.
Note: As is the case with Bynari Collaboration Server, some servers require the entire email address to be used when adding a new user to a folder share while others only require the username. Check with your systems administrator for specific information about your server requirements.
  • Select “OK” to confirm adding the new user’s ACL to the specified folder.

    Figure 35 – Outlook Connector – Add New User

 

  • Search Corporate Directory
    This feature is used to search an LDAP directory to find users. Enter a value to search and then click “search”.In the “Search Results” field, select a user or multiple users by holding the control key and clicking on the listings to add and then click “OK”.
  • “Search by” option
    The pull-down list contains five ACL search settings:

    • Any – Search all fields.
    • First Name – Search by “First Name”
    • Last Name – Search by “Last Name”
    • Display Name – Search by “Display Name”
    • E-mail Address – Search by “E-mail Address”
  • ConfigurationThis button provides quick access to the LDAP configuration settings. See LDAP settings under section 2.5.4.2.
  • Select “OK” to confirm adding the new user’s ACL to the specified folder.

Folder Permissions

Figure 36 – Outlook Connector – Folder Permissions Dialog Window

ACL permissions can be adjusted at any time for every user added in the folder permission’s dialog. Users may only grant ACL permissions if they have been given the administrator permission. ACL permissions may not be changed for either the owner or the administrator of the account.

The main “Folder Permissions” dialog window is now displayed again. The username or email address that was just entered is now displayed in the user dialog box. The default permission given to all new users is “Guest”. This can be modified using the pull-down menu in the “Folder Permissions” dialog window.

The pull-down list contains four preconfigured ACL settings:

  • Guest
    Look up, Read, Set Seen Flag rights
  • User
    All rights except for “Create”, “Delete”, and “Administrator”
  • Power User
    All rights except “Administrator”
  • Administrator Full rights
    All rights

Advanced Permissions

More detailed permissions can be assigned by selecting the “Advanced” button.

Figure 37 – Outlook Connector – Folder Permissions Dialog Window


Figure 38 – Outlook Connector – Advanced Permissions

Each of the listed permissions can be set independently giving more granular control over folder sharing permissions.

Permissions

Description

Lookup

The user may see that the folder exists.

Read

The user may read the folder. The user may also select the folder, fetch data, perform searches, and copy messages from the folder.

Set Seen Flag

Keep, per-user, seen state. The “Seen” and “Recent” flags are preserved for the user.

Write

The user may modify flags and keywords other than “Seen” and “Deleted” (which are controlled by other sets of rights).

Insert

The user may insert new messages into the folder.

Post

A user may send a message to the folder. This right differs from the “Insert” right in that the delivery system inserts trace information into submitted messages so that you can filter address by user name, IP address or HTTP requests.

Create Folders

The user may create, delete or rename folders.

Delete Messages

The user may set a message as “Deleted” or permanently delete mail.

Delete Folders

The user may delete folder.

Perform Expunge

User can permanently expunge deleted messages from the folder.

Administrator

The user may change all the permissions on the folders.

Table 1

Folder Type

The “Folder Type” button gives the user the ability to select a specific “type” for any IMAP folder except for Inbox, Outbox, Deleted Items and Sent.


Figure 39 – Outlook Connector – Folder Type

This feature becomes useful if a user wants to create a second calendar to share with others rather than their standard calendar.

3.2.2 Refresh Folders

The “Refresh Folders” button refreshes the folder tree as seen when you press Alt + F1 (navigation pane). When pressed, the Outlook Connector actually scans each folder, not for contents but for the folders themselves. If folder changes are made on the server or if folders are shared to you from someone else, you would use the “Refresh Folders” to display those changes in Outlook.


Figure 40 – Outlook Connector – Refresh Folders

 

Note: The “Refresh Folders” button does not retrieve emails; it refreshes the IMAP folder tree only.

3.2.3 Account

Outlook Connector Account Settings

Figure 41 – Outlook Connector Account


Figure 42 – Outlook Connector – Settings Dialog Window

The Outlook Connector Settings dialog window will be displayed first when selecting “Account” from the Outlook Connector toolbar. All of the information displayed on this screen is entered and configured during the Outlook Connector installation process. Changes can be made to this information as needed.

3.2.4 More Settings

To learn more about the additional settings which are available for configuration, click on the “More Settings…” button.

Across the top of this new window, you will see eight tabs:
General, Connections, Download, Folders, Send/Receive, Other Settings, Format, and About.

3.2.4.1 General


Figure 43– Outlook Connector – More Settings – Connections IMAP

The General tab has two input fields. The first one is already filled in with a default value – “Insight Server Folders”. This is the name that will appear as the display name for “Outlook Today”. This is a user-defined field and can be changed.

The second field is labeled “Other User Information”. It is optional and has no effect on the functionality of the software. This is also a user-defined field.

 

3.2.4.2 Connections

The Connections tab is where IMAP, SMTP, LDAP and Timeout settings are configured.

IMAP

Figure 44 – Outlook Connector – More Settings – Connections IMAP

Incoming Server (IMAP)

  • Server name
    This is the IMAP server name that was entered during installation; it can be changed if needed.
  • Port
    By default, Bynari Server uses port 143.
  • Username
    This is the user name that was entered during installation; it can be changed if needed.
  • Password
    This is the password that was entered during installation; it can be changed if needed.
  • Do not use secure connection
    Default configuration is to not use a secure connection.
  • Use secured connection (SSL)
    Select this option if your server supports IMAP SSL. When selecting this option, the default port of 143 changes to port to 993. This value can be changed manually, if needed.
  • Use Transport Layer Security (TLS)
    Make sure that your server supports TLS before selecting this option. TLS provides endpoint encryption. This protocol allows all communication, including passwords, to be encrypted. TLS is the preferred and most secured method of SSL.
  • Use Persistent Connection
    The default and recommended selection is enabled.
    Important Information: Disabling the use of persistent connections will negatively affect the performance of the Outlook Connector. Persistent connections, also known as “keep alive” connections, reuse the same TCP connection for sending and receiving. This streamlines requests, reduces network traffic, network latency, CPU utilization and memory needs as it requires fewer resources.
  • Test IMAP Settings
    Click this button to test the new IMAP settings.

SMTP

Figure 45 – Outlook Connector – More Settings – Connections IMAP

Outgoing Server (SMTP):

  • Server name
    This is the SMTP server name that was entered during installation; it can be changed if needed.
  • Port
    By default, the Bynari Server uses port 25
  • Do not use secure connection
    Default configuration is to not use a secure connection.
  • Use secured connection (SSL)
    Select this option if your server supports IMAP SSL. When selecting this option, the default port of 143 changes to port to 993. This value can be changed manually, if needed.
  • Use Transport Layer Security (TLS)
    Make sure your server supports TLS before selecting this option. TLS provides endpoint encryption. This protocol allows all communication, including passwords, to be encrypted. TLS is the preferred and most secured method of SSL.

SMTP Authentication:

  • SMTP server requires Authentication
    Note: SMTP Authentication is sent in plain text. To encrypt the user ID and password – enable, “Use Transaction Layer Security (TLS)”.
  • Use Same Authentication as Incoming Server
    This uses your email username and password that you entered when you setup the account.
  • Use SMTP Authentication
    This option is used when sending email from an SMTP server that is not part of the normal mail server network. i.e. an external address or a remote user. Enabling this feature tells the client to authenticate with the server to relay messages to external domains.
  • Test SMTP Settings
    Click this button to test the new SMTP settings.

 

LDAP

Figure 46 – Outlook Connector – More Settings – Connections – LDAP

Note: The LDAP default options are configured for optimal use with Address Book 3.0 and Insight Server 4.3.

 

The Lightweight Directory Access Protocol or LDAP is an application protocol for querying and modifying directory services running over TCP/IP.

An LDAP directory is a set of objects with attributes organized in a logical and hierarchical manner. An example of LDAP could be an address book that consists of names organized alphabetically. Each name in the address book would have a corresponding email address and telephone number.

LDAP shared folder name resolution enables the Outlook Connector to display “actual names” instead of “user names” for shared IMAP folders.

  • Use LDAP to resolve shared folder names
    Place checkmark if you have an LDAP server.

LDAP Server (LDAP):

  • Server name
    This is the LDAP server name that was entered during installation; it can be changed if needed.
  • Port
    By default, the Bynari Server uses port 389.
  • Use SSL
    Select this option if your LDAP server supports IMAP Secured Socket Layer protocol.
  • Anonymous Login
    Select this if your LDAP server allows anonymous binds (anonymous searches).
  • User DN
    The User DN (Distinguished Name) is comprised of a unique identifier for the user and the domain container; the unique identifier is the container “cn=” in the LDAP database followed by the domain or organizational information.

Note: If you are using Insight Server, users can find their own “User DN” information. Log into the web management console as a user, then click on:

    1. Preferences > “Client Configuration”
    2. “Directory Server Account”, locate the field, “Account Name”.

Bynari Collaboration Server users must contact their administrator to retrieve the User DN.

An example DN might be: “cn=testuser1,o=example.net”

If you are not running the Bynari Server or Insight Server, please consult your LDAP administrator for your DN.

  • Use Incoming Server (IMAP) Password
    This uses the IMAP password from the Connections > IMAP field.
  • Password
    This is your password to the LDAP server.
  • Remember Password
    Remember the password so that you do not have to enter it every time it accesses the LDAP server.
  • Test LDAP Settings
    Click this button to test the new LDAP settings.

 

LDAP Advanced options

Figure 47 – Outlook Connector – More Settings – Connections – LDAP – Advanced Settings

 

Searching Options

  • Sort returned results by:

This option sorts the LDAP results by:

  • First Name
  • Last Name
  • Display Name
  • Email Address
  • Display all results in a single container (deep search)

Toggling this option will allow for custom LDAP searches to group level.

  • LDAP Filter for Users:

This option defines the LDAP attribute for users.

  • LDAP Filter for Groups:

This option defines the LDAP attribute for groups.

  • LDAP Search Attributes:

The criteria used in the search attribute can be changed to meet your LDAP structural needs. This information can be found with the user’s container name or unique identifier in the LDAP database. An LDAP browser can quickly display these parameters. In this example, the data refers to the following information:

  • cn = Container name. Typically this is the user’s full name.
  • mail = User’s mail address.
  • givenName = Typically, this is the first name of a user.
  • sn = Surname or last name.

Base DN

  • The top level of the LDAP directory tree is the base, referred to as the “base DN”.
  • By default Outlook Connector attempts to determine your LDAP base DN by your User DN, which you specified on the Connections > LDAP tab. Consult with your LDAP administrator for your DN if the Base DN was not determined automatically.

LDAP Server Version

  • Select LDAP version

Manually select version 2 or LDAP version 3.

  • Detect

This button will attempt to get the LDAP server version automatically.

LDAP attributes

Figure 48 – Outlook Connector – More Settings – Connections – LDAP – Advanced Settings – LDAP Attributes

The value of these attributes is used to perform the searches against the LDAP database. These are comma delimited and can be changed depending on your setup.

  • User Attributes
    The user attribute will search against “login” then “uid”.
  • User ID
    The user id attribute will search against the “login” attribute.
  • First Name
    The first name attribute will search against “givenName”.
  • Last Name
    The last name attribute will search against “sn”.
  • Display Name
    The display name attribute will search against “display-name”, “displayName”, and then “cn”.
  • E-mail Address
    The e-mail address attribute will search against “mail”.

 

Others



Figure 49 – Outlook Connector – More Settings – Connections IMAP

Timeout Setting

  • Server timeout value in number of seconds.
    The Timeout Setting tells the server how long to wait before it closes the session. The default value is “0”. Acceptable values are: “0”, “30-600” seconds. In a corporate environment where the user is on the same network as the mail server, a timeout value of “0” may be adequate.Users on a Wide Area Network (WAN) need to consider larger timeout settings. Setting this value is dependent on your Internet connection speeds. If you are on a dial-up connection, you may want to set this value to 600 seconds whereas if you are on a DSL connection or cable modem connection, 60 seconds may be acceptable.Having a value too low can cause uploading issues when sending large attachments where the Internet upload speeds are usually slow.
  • Auto Registration Port
    Auto registration is disabled by default. This option allows Outlook Connector to verify licensing with their local Insight Server or Bynari Server. If you do not use the Bynari Server or Insight Server, DO NOT enable the Auto Registration Port Checkbox. By default, port 80 is used. This option can be changed depending on your Bynari Server or Insight Server, and your firewall configuration.

    Important Information: The Outlook Connector was designed to function over LAN-based and high speed broadband connections. Many remote users are able to utilize the Outlook Connector as it was designed. For users on poor remote connections, utilizing the Bynari Web Client may be a better option.

 

  • Use SSL
    Use secure socket layer protocol to register.

3.2.4.3 Download


Figure 50 – Outlook Connector – More Settings – Download

 

Download Options

  • Download Headers Only
    Enabled by default, this option improves the performance of the initial synchronization of the emails downloaded for Outlook. It downloads the header only for email messages. When the message is selected for viewing, the entire message is downloaded.

    Note: Tasks, journals, contacts and calendar events are always set for full-content download when selected for viewing.

     

  • Download Contents of Message Only
    Disabled by default, this option downloads the entire message during the synchronization of emails. Attachments are downloaded when the message is selected for viewing.
  • Download Contents of Message and Attachments
    Disabled by default, this option downloads the entire message and associated attachments during the synchronization of emails.
  • Download All Attachments
    This option will download all attachments.
  • Download Attachment Limit
    This option will set the download attachment limit size in bytes. Any value is accepted in this field. The default is 50,000 bytes.

Download Message progress

  • Show progress indicator when loading messages
    When this box is checked, a progress indicator will appear when synchronizing any folder with more than 50 messages. This option is checked by default.
  • Indicator threshold (number of messages)
    This option allows you to modify when the indicator will appear. By default, this value is set to 50 messages, adjusting this to zero will display the indicator for every message.

3.2.4.4 Folders


Figure 51 – Outlook Connector – More Settings – Folders

Folder Type

  • Use ACL to set folder types
    Enabled by default, it allows the Outlook Connector to use custom IMAP folder ACLs to specify the specialized folder types used by Outlook. These are “Calendar”, “Contact”, “Task”, “Journal”, “Notes“, and “Mail”. This option increases performance since the Outlook Connector no longer has to locate a hidden synchronization message to determine a given folder’s type.

Folder List

  • Show All Folders
    This is enabled by default and tells the Outlook Connector to automatically subscribe to all folders found under the user’s folder list.
  • Show Only Subscribed Folders
    In large environments, the default value of “Show All Folders” may not be desirable. This option allows the users to individually select only the folders they want to see in Outlook.
Important Information: When manually selecting folders, make sure that default folders are checked. i.e. Calendar, Contacts, Deleted Items, Sent Items, Outbox and Tasks. If you uncheck them, it will cause Outlook to recreate them on the IMAP server. This is a default behavior of Outlook.

 

3.2.4.5 Send/Receive


Figure 52 – Outlook Connector – More Settings – Send/Receive

Outlook Connector utilizes IMAP IDLE to update the Inbox folder. For servers that do not support IMAP IDLE make sure that the Inbox folder is selected.

 

3.2.4.6 Other Settings


Figure 53 – Outlook Connector – More Settings – Miscellaneous

The Other Settings tab contains two sections; one for read receipt request options and the second for local cache options.

Message Receipt Options

How would you like to respond to requests for read receipts on incoming messages?

  • Prompt me before sending a response
    This option is the default setting. This setting “prompts” the user to choose between sending a read receipt or not.
  • Always send a response [default selection]
    This option automatically sends a response to the sender of a read receipt request.
  • Never send a response
    This option never sends a response to a read request sender.

Local Cache Options

Store local message cache in the following directory:

  • Default Location
    The default location for the local cache is:Windows XP:
    C:\Documents and Settings\[user name]\Local Settings\Application Data\Bynari\Outlook Connector 4.0\Accounts\[Outlook profile name]\[email address]\Windows 7:
    C:\Users\[user name]\AppData\Local\Bynari\Outlook Connector 4.0\Accounts\[Outlook profile name]\[email address]\The name of the local cache file is: LocalCache.ost
  • Custom Location
    This option allows you to change the location of the local cache. This enables the administrator to place the local cache on the network through a network share for user data backup if needed.

    Note: Read, Write, Delete and Change permissions within Microsoft Windows are required for any Custom Location.
    Note: Any changes made to the location of the local cache will require a restart of Outlook. If you do not restart Outlook, you may see errors, because the Outlook Connector must create the LocalCache.pst file.

 

3.2.4.7 Format


Figure 54 – Outlook Connector – More Settings – Format

Message Format Options

Note: “Use Kolab Format” option is available in the Kolab version of Outlook Connector 4.0.
  • Use Microsoft Message Format
    This is also known as “.tnef” formatting which stands for Transport Neutral Encapsulation Format. This allows files to contain rich text formatting used by e-mail messages, such as bold, italics, underlining, etc…
  • Use iCal Format
    This option is turned on by default in the “ical” or “iCalender” format version of Outlook Connector. iCalendar is a file format which allows sending meeting requests and tasks to other internet users via email or sharing files with an .ics extension.“iCal” format is significantly smaller than the “.tnef” format which can improve performance and save disk space.

    Note: If you use a Kolab server or an iCalendar compatible server, you may not need to select “Use Microsoft Message Format”. If you are unsure, it is best to select both options.
  • Use Kolab Format
    Use this option only if you are running a Bynari Collaborator Server or Kolab IMAP server. Kolab uses a unique XML format attached to email specifically for Kolab groupware servers. The XML holds information for contacts, calendar events, journals, etc.

 

3.2.4.8 Logging


Figure 55 – Outlook Connector – More Settings – Logging

Logging capabilities have been added to the Outlook Connector as a troubleshooting aid. By default, all logging is off. Log files can consume large amounts of disk space, and it is recommended that logging be left off, unless the user is experiencing problems.

When working with Bynari Technical Support on an issue, they may request that you enable logging. Verbose logging is the most thorough level of logging offered and will offer the most insight to the support technician.

 

3.2.4.9 About


Figure 56 – Outlook Connector – More Settings – About

About tab

The about tab provides information about the Outlook Connector. It contains the version number as well as all licensing information.

3.2.5 Quota

Used to display the user’s current quota status.

Figure 57 – Outlook Connector – Toolbar Quota button


Figure 58 – Outlook Connector Quota

3.2.6 About


Figure 59 – Outlook Connector – About

The “About” button on the Outlook Connector toolbar performs the same function as the “About” tab discussed above in section 2.5.4.9.

4 Using Outlook Connector

Outlook Connector 4.0 provides Outlook with a MAPI transport service that makes connecting to an IMAP server transparent to the end user. The following sections describe some of the additional dialogs introduced by the Connector such as Folder permissions as well as documenting configuration changes needed for features such as Free/Busy.

4.1 Viewing Shared Folders

Note: Private events (calendar, contacts, and tasks) are stored on the server. Only the folder owner will see private events.

Other users’ shared folders will appear under ‘Other Users’ in the folder list.


Figure 61 – “Other Users” shared folder list

Public folders created on the Bynari Server and Insight Server will display under ‘Shared Folders’ in Outlook.

 


Figure 62 – “Shared Folders” public folder list

 

Note: Upgrade your Insight Server to at least 4.2.2 to support private events.

4.2 Free/Busy Configuration

Outlook allows users to share free/busy information from their calendars with other users on their mail server. With the Microsoft Office Internet Free/Busy Service, users can publish their free/busy times to a shared Internet location. Members using this service can view each other’s free/busy information when viewing shared calendars or creating meeting requests.


Configure Free/Busy

  • Open Options in Outlook
    On the Outlook Toolbar, select Tools > Options.

    Figure 63 – Outlook Tools, Options
  • This opens a new window; select the Preferences option tab.

Options – Preferences

  • Click on “Calendar Options…”

    Figure 64 Tools Options

Calendar Options – Advanced options


Figure 65 – Tools – Options – Calendar Options

Note:When sending meeting requests over the Internet, use iCalendar format” option will likely be grayed out. This is normal.

 

  • Enable alternate calendar
    Select this option if you wish to enable an alternate calendar.
  • Click on “Free/Busy Options…”
    Select to change the Free/Busy Options.

 

Free/Busy Options

Figure 66 – Tools – Options – Calendar Options Free/Busy Options

Options

  • Publish “2” month(s) of Calendar free/busy information the server
    Enter the number of months of Free/Busy information to be published.The default interval is 2 months. This value represents the number of months from today’s date.
  • Update free/busy information on the sever every “15” minutes
    The default time is every 15 minutes. This value represents how often Outlook will update the user’s Free/Busy information on the server.

Internet Free/Busy

  • Publish at my location
    This option must be checked. In figure 66, a path name is shown. Insert your information in place of the variables, “%NAME%.vcf”.

    Note: If you are using Insight Server 4.3, use the below example by changing the server name and replacing %NAME% with your username.ftp://mail.example.net/freebusy/%NAME%.vcf
  • Search location
    Enter the URL for the shared free/busy search location.

    Note: If you are using Insight Server 4.3, use the below example by changing the server name and replacing %NAME% with your username.http://mail.example.net/freebusy/%NAME%.vcf
  • Click “OK” to apply the Free/Busy settings.

4.3 Show / Hide Toolbar

  • Toggle toolbar display

On the Outlook Toolbar, select View > Toolbars > Outlook Connector 4.0.

It places a check mark next to the name to show that the Connector is enabled.



Figure 67 Show/Hide Outlook Connector Toolbar

If you have hidden the Outlook Connector toolbar at the time of the installation, you can show the toolbar by following the above steps.

5 Registering and Unregistering Outlook Connector

Outlook Connector 4.0 is configured to use auto registration by default when “Insight Server” is selected during installation. Auto registration is designed for users of both the Outlook Connector and Insight Server or the Bynari Server. With auto registration enabled, the Outlook Connector will verify that an active license exists for the client when Outlook starts. It is recommended that users of the Insight Server or the Bynari Server utilize this feature of the Outlook Connector.

If you do not have an Insight Server or Bynari Server, or do not wish to use auto registration, you can register your copy of the Outlook Connector using the About tab of the Outlook Connector toolbar.

5.1 Auto Registration

Enable or disable auto registration

  • Click on the “Account” tab in Outlook Connector toolbar.


Figure 68 – Outlook Connector – Account

  • Select “Connections” > “Others”.


Figure 69 Outlook Connector – More Settings – Connections – IMAP

 

Important Information: Do not enable auto registration if you do not use the Insight Server or Bynari Collaborator Server (BCS).

 

  • Auto Registration Port
    Auto registration is either enabled or disabled depending on your Insight Server selection during installation. This option allows Outlook Connector to verify licensing with a local Bynari Server or Insight Server. By default, port 80 is used. This option can be changed depending on your Bynari Server or Insight Server, and your firewall configuration.
  • Use SSL
    Use secure socket layer protocol to register.

    Troubleshooting Tip: If you are experiencing trouble registering the connector and your server does not support auto-registration, make sure that the “Auto Registration Port” option is NOT checked. This option is being deprecated in future versions of the connector.

5.2 Register Outlook Connector

  • Click on “About” in the Outlook Connector Toolbar.

    Figure 70 – Outlook Connector About

 

  • Click on “License”.

    Figure 71 About
    Figure 682 Key Support button
  • Enter your product license key
    Copy/Paste your license key in the space provided.
  • Manual Registration
    See section “manual registration” below.
  • Enter the license certificate below:
    This is only used during manual registration.
  • Which port would you like to use for the registration?
    Bynari license key server listens on ports 80 and 3080. If port 80 is blocked, port 3080 can be used as an alternate port.

    Note: The license key server URL is http://update.bynari.net.
    Note: If you encounter any issues while activating your Outlook Connector license, ping the license key server to verify proper internet connectivity.
  • Click “OK” to register Outlook Connector.

Manual Registration

  • Enter your product license key
    Copy/Paste your license key in the space provided.
  • Manual Registration
    Contact Bynari Support at support@bynari.net and request a manual license certificate.
  • Enter the license certificate below:
    Paste entire certificate in the space provided. (See manual certificate example.)

    Figure 693 – Manual certificate example

    Figure 684 – Manually entering the information
  • Click “OK” to complete manual registration.

5.3 Registration Complete

  • After registering over the internet or manually, you should see the following screen.

    Figure 715 Manually entering the information

Outlook Connector License Information

  • License Key
    This is the license key used to register Outlook Connector.
  • License Expire
    This will display when your license expires.
  • Support Expires
    This option will show the date Bynari support expires.
  • Number of Licenses Used
    This displays the number of licenses used vs. the number of licenses that you have purchased.
  • Total License Available
    This displays the number of licenses available or purchased.
  • Supported Versions
    The Connector version supported for this license key.
  • Supported Options
    Formats that are supported such as iCal or Kolab are listed.

Click “Refresh” to update dialog screen for license information.

5.4 Unregister Outlook Connector

  • Click on “About” on the Outlook Connector Toolbar.
  • Click on “License”.

    Figure 726 – Connector License information
  • Click on “Unregister”.
    This will unregister Outlook Connector from your computer.



6 Reporting Problems

When reporting problems, be sure to include the following information:

  • Microsoft Windows version number and patch level.
    • Right click on “My Computer” icon on the Desktop and select Properties. The Windows version and patch level will be listed under System: in the General tab dialog.
  • Microsoft Outlook version and patch level.
    • Right click on Help in Outlook and select About Microsoft Outlook. The Outlook version and patch level will be listed.
  • The full version number of the Outlook Connector.
    • Click “About” on the Connector toolbar. The connector version and build number (4.Y-XXXX) will be listed.

 

To contact technical support:

U.S. Toll Free Telephone: 1-800-241-1086
International Telephone: 001-214-350-5772

To open a new support ticket email: support@bynari.net

For FAQs: http://www.bynari.net/users/kb.php

Bynari Outlook Connector

User’s Guide

Trademarks

 

Bynari products are trademarks of Bynari, Inc.

 

Microsoft Windows, Windows Mobile, Outlook, Windows XP, Windows Vista are all registered trademarks of Microsoft Corporation in the United States, other countries, or both.

 

BlackBerry is a registered trademark of Research In Motion Limited in the United States, other countries, or both.

All other trademarks are the property of their respective owners.

Technical Support

 

When you purchase any of Bynari’s products, the products include one year of free support and maintenance. To purchase additional yearly support and maintenance, please contact sales@bynari.net.

 

Customers who are current on support receive one year of product maintenance, upgrades and email and/or telephone matching the purchased support package.

Support is available to customers worldwide.

To contact technical support:

U.S. Toll Free Telephone: 1-800-241-1086
International Telephone: 001-214-350-5772

To open a new support ticket email: support@bynari.net.

For FAQs: http://www.bynari.net/users/kb.php

Licensing

The Outlook Connector utilizes a licensing key system that assigns and stores the number of licenses that have been purchased by the customer. When Outlook starts, Outlook Connector (OC) will either contact the patched version of Insight Server 4.3, which allows auto-registration with OC 4.0, or Server 4.4. If you are using a 3rd party server, it will contact the Bynari license key server over the Internet to validate and activate the installed license. Activation will be attempted each time Outlook is started or until activation of the license is successful.

Note: The license key server URL is http://update.bynari.net.

 

If you encounter any issues while activating your Outlook Connector license, please see below for a possible solution:

  • The client systems may be blocked from accessing the Internet, or Internet access is temporarily unavailable.
  • The license key entered during the installation of the Outlook Connector may be invalid. This could include issues such as an incorrect key or incorrect key version.
  • The number of client licenses has been exceeded. The Bynari Key Server tracks how many systems have been activated using a given license. If the number of activated clients exceeds the total for the license, the Outlook Connector will inform you that additional licenses need to be purchased.
  • If you need to reinstall the Outlook Connector software on a new system due to either hardware failure or system upgrade and need to unregister, do the following (See section 4.3 for complete details):
    • Open Outlook
    • Click on “About” tab in the Outlook Connector toolbar
    • Click on “License”
    • Click on “Unregister”

If you experience problems with license activation, please contact your reseller or Bynari support at support@bynari.net.

Important Notes:

  • This documentation applies to the latest 4.0 build of the Outlook Connector available from Bynari.
  • Make sure that Outlook is setup as the default e-mail client. To verify this on the workstation, go to Control Panel > Internet Options > Programs and make sure that Outlook is selected in the drop down box next to E-mail.
  • Outlook Connector 4.0 has been tested with Bynari Server, Univention Corporate Server, Insight Server, and Bynari Collaboration Server, Cyrus, and Kolab IMAPv4 servers. Outlook Connector supports all base specifications as described in RFC 3501: Internet Message Access Protocol version 4rev1. If your IMAPv4 server supports the specifications in RFC 3501, Outlook Connector 4.0 may be compatible with your server. If you encounter issues with a different type of unsupported server, email support at support@bynari.net to create a support ticket. The Bynari support team will provide a reasonable effort in working with you.

 

Table of Contents



1 Outlook Connector version 4.0

The Outlook Connector acts as a MAPI transport for Microsoft Outlook. As a MAPI transport provider, the Connector interprets all the different types of folders used by Outlook.

When Outlook Connector is used in conjunction with the Bynari Server or Insight Server, a powerful collaboration environment is created. Users are able to share mail folders, contacts, tasks, and calendars with other individuals. Public folders of each type can also be created and maintained by system administrators through the web admin interface. All of these functions are supported through the familiar Outlook interface eliminating any need for costly end user training.

1.1 Architecture

Messaging Application Programming Interface or MAPI has two major components. Applications such as Microsoft Outlook use the client side interface to contact the MAPI subsystem for all communications with the message store. There is also a service interface which is used by programs such as Outlook Connector to provide the MAPI transport services for accessing the message store on the server.

Outlook Connector acts as the transport that provides messaging services directly to the MAPI subsystem and stores this information on Insight Server and Bynari Server via the IMAP protocol.

 

Figure 1 – MAPI Architecture

1.2 Features of Outlook Connector

Outlook Connector 4.0 offers the following features:

  • Native MAPI implementation
  • Mobile sync with Windows Mobile device
  • Mobile sync with Blackberry Mobile device
  • Mobile sync of contacts with iPhone
  • Support for new Microsoft PST architecture enables files larger than 2G
  • Simple click-and-go installation and configuration
  • SSL secure connection support
  • Mail, Calendar, Contacts, Journal, Notes and Task folder support
  • Native Outlook calendar functions
  • Free/Busy support
  • Shared folders including Calendars, Contacts, Tasks, Journals, Notes and Mail
  • Contact Distribution Lists
  • Outlook Rules Wizard
  • Read receipts
  • IMAP folder subscriptions
  • Shared access controls
  • Header only download
  • Offline support
  • Grouping
  • Multiple user accounts
  • Voting Buttons
  • Native iCalendar and vCard format support
  • IMAP IDLE support
  • Mailbox quotas
  • Ability to re-download messages
  • And more …

1.3 Supported Platforms

Outlook Connector 4.0 is compatible with the following software. If you are using a version that is not listed, or software that is not supported, upgrade to a supported version.

Supported Windows®Versions

Windows® XP

Windows® Vista

Windows® 7

Supported Outlook® Versions

Outlook® 2003

Outlook® 2007

Outlook® 2010 (32/64 bit)

Supported Languages

  • English
  • French
  • German
  • Italian
  • Spanish (Spain)
  • Portuguese (Brazil)
  • Dutch
  • Norwegian
  • Russian
  • Swedish
  • Taiwanese/Chinese
  • Czech
  • Hebrew
Note: Other languages are provided and may be used but are not formally supported. Problems with translation, spelling, grammar and proper character encoding may be encountered.

 

1.4 Supported IMAP Servers

  • Bynari Collaboration Server
  • Insight Server
  • Cyrus
  • Kolab

1.5 Supported mobility devices and software

Outlook Connector 4.0 includes mobility support for several devices including Blackberry, iPhone and Windows Mobile. The following versions are compatible with Outlook Connector 4.0.

1.6 Known Limitations

  • Microsoft Business Contact Manager is not compatible with Outlook Connector.
  • Smart Phone synchronization is dependent on the hardware and the software provider.
  • Slashes in folder names are not allowed.

2 Installation

2.1 Preparing Your System (Pre-Installation)

Before you begin:

The Connector 4.0 software must be installed by the Windows login user. Additionally, this user needs “administrator” rights to install the software. The users’ rights can be changed to install the Connector and then reset to the original rights.

Before you begin the installation procedure, perform the following steps:

Step 1: Install Microsoft® Windows and/or Microsoft® Outlook

Supported Windows® Versions

Windows® XP

Windows® Vista

Windows® 7

 

Supported Outlook® Versions

Outlook® 2003 SP3+

Outlook® 2007 SP2+

Outlook® 2010 SP1+

Note: If you are using versions that are not listed, upgrade to a supported version.

Step 2: Install the Latest Updates for Microsoft® Windows and Outlook

Go to the Microsoft® website or check with your IT Administrator to verify that you have installed the most current critical updates and service packs for both your Windows operating system and Outlook.

http://update.microsoft.com – Microsoft® updates.

Outlook 2003 minimum required version to install

  • Click on “Help” > “About Microsoft Office Outlook”


Figure 2 – Outlook 2003 about dialog

Outlook 2007 minimum required version to install

  • Click on “Help” > “About Microsoft Office Outlook”


Figure 3 – Outlook 2007 about dialog

Outlook 2010 minimum required version to install

  • Click on “Help” > “About” and then click on “Additional Version and Copyright Information”


Figure 2.3 – Outlook 2010 about dialog

Step 3: Backup “Rules and Alerts”

Outlook “Rules and Alerts” functions are used to organize incoming email. These functions allow users to set custom “actions” that will be performed automatically on incoming messages.

Important Information: “Rules and Alerts” will not transfer during new installation of Outlook Connector 4.x or when upgrading from Outlook Connector 3.x to 4.x. “Rules and Alerts” are stored locally on your computer. They are not uploaded to the server.

 

Export “Rules and Alerts”

  1. Open Outlook
  2. Click on “Tools” > “Rules and Alerts…”


Figure 4 –Installation – Tools – Rules and Alerts

  1. Under the “E-mail Rules” tab, click on “Options”.


Figure 5 –Installation – Tools – Rules and Alerts

  1. Under the “Import and export” area, click on the “Export Rules…” button.


Figure 6 –Installation – Tools – Rules and Alerts – Options

  1. Type a new name for the rules or keep the default.


Figure 7 –Installation – Tools – Rules and Alerts – Save Exported Rules as

  1. Click “Save”.
  2. Click “OK” to remove all dialog windows.
  3. Close Outlook to continue installing or updating Outlook Connector 4.0.

 

Note: In order to ensure proper Rules and Alerts functionality in Microsoft Outlook a check must be placed in the “Schedule an automatic send/receive every” checkbox under Tools>Options>Mail Setup>Send/Receive. Any amount of time may be specified in the associated “minutes” field.

 

2.2 Installing Outlook Connector – New Installation

The 4.0 Outlook Connector Install Wizard standardizes the installation process for Outlook.

The following section explains how to install the Outlook Connector 4.0 for the first time on a computer. The “upgrade” process is slightly different and available in the section 2.4 of this manual.

Note: The Outlook Connector will only install on systems where the user has “administrative” rights. The users’ rights can be changed to install the Outlook Connector and then reset to the original rights after the installation has completed.

 

Important Information: In some cases, virus scanning add-ins for Outlook may need to be disabled for the installation of the Outlook Connector. Disabling the virus scanning Outlook add-in should not change the functionality of your antivirus software.

 

Before you begin:

  1. Verify that all steps in “Preparing Your System” (Pre-installation) section 2.1 are complete.
  2. Unzip the Outlook Connector 4.0 compressed file by right-clicking and selecting “Extract All”.


Figure 8 – Installation – Downloaded zipped Outlook Connector

  1. Double Click on the installer.


Figure 9 – Installation Outlook Connector Installer Package

NOTE: For Windows Vista and Windows 7, you must run the installer as “Run as Administrator” to install Outlook Connector properly.

  1. Welcome Dialog:
    Double click the installation setup file to start installation. The setup wizard will display the “Welcome Dialog” window. Select “Next” to continue with the installation process.


Figure 10 – Installation Outlook Connector welcome dialog Setup Wizard

  1. End User License Agreement:
    Read the license agreement. If you agree, select the button, “I accept the license agreement” and select “Next”.
  2. Create New Outlook Profile:
    The Outlook Connector will automatically create a profile for Outlook. The default name for this profile is “Outlook Connector”. The “default name” is a user defined field and may be changed if needed. Place a check in the box labeled, “Prompt for which profile to use when starting Outlook (Recommended)”, if you have multiple profiles in Outlook. Selecting this will prompt for profile selection when Outlook starts. Click “Next” to continue installation.


Figure 11 – Installation Outlook Connector Create New Profile

  1. Account Information:
    This screen provides the Outlook Connector with the information needed to create the Outlook profile for your email account during the installation process.
    The following basic information is needed to complete this screen:

    • Your Name
    • E-mail Address
    • IMAP Server Address
    • SMTP Server Address
    • Username
    • Password


Figure 12 – Outlook Connector – Account Information

Note: Bynari Collaboration Server requires the entire email address to be used as the “username”. Insight Server only used the first part of the email address, leaving off “@domain.com”.
    • Fill in requested information.
    • Click “Next” to continue.
  1. Select Destination Location:
    The default installation destination for the Outlook Connector is:
    C:\Program Files\Bynari, Inc\InsightConnector.

A custom installation location may be used. Select the “Browse” button to choose an alternate location to install the Outlook Connector. Click “Next” to continue the installation.

Figure 13 – Outlook Connector – Select Destination Location

  1. Outlook Connector Toolbar Options:
    By default, the Outlook Connector Toolbar is configured to be displayed. Displaying the toolbar is the recommended configuration. Select “Yes” to hide the Outlook Connector toolbar. Click “Next” to continue.


Figure 14 – Outlook Connector – Display Toolbar

  1. Ready to Install:
    Review configuration settings and select “Install” to install the Outlook Connector. Click “Next” to continue the installation.


Figure 16 – Outlook Connector – Ready to Install

  1. Setup Complete:
    To automatically start Outlook, place a check in the box labeled “Run Outlook” and select “Finish”.


Figure 17 – Outlook Connector – Finish Install Wizard

 

2.3 Installing Outlook Connector – Upgrade

Upgrading the Outlook Connector is similar to the steps discussed under “Installing Outlook Connector – New Installation” in section 2.1.

In the upgrade process, no profile will be created and all of the original user data from the previous installation of the Outlook Connector is used. The Outlook Connector will automatically upgrade profiles from earlier Outlook Connector versions. Outlook Connector 3.x used a “local cache” data storage system while the Outlook Connector 4 uses a Microsoft PST file to store data.

When upgrading from any of the Outlook Connector 3.x versions, your profile will be upgraded to the new PST architecture. The Outlook Connector will need to perform an initial synchronization after the upgrade process completes.

Important Information: During the initial synchronization process, the Connector will download the newest emails first, and then it will continue to synchronize in the background. This allows the end-user to begin using Outlook immediately while synchronization continues.

 

Note: The Connector installer will automatically determine if your profile needs to be upgraded.

 

Before you begin:

  1. Verify that all steps in “Preparing Your System” (Pre-installation) section 2.1 are complete.
  2. Unzip the Outlook Connector 4.0 compressed file by right-clicking and selecting “Extract All”.


Figure 18 –Installation – Downloaded zipped Outlook Connector

  1. Double Click on the installer to start the installation process.


Figure 19 – Installation Outlook Connector – Installer Package

 

  1. Welcome Dialog:

Double click the installation setup file. The setup wizard will display the “Welcome Dialog” window. Select “Next” to continue with the installation.


Figure 20 – Installation – Outlook Connector welcome dialog – Setup Wizard

  1. End User License Agreement:

Accept the terms of the End User License Agreement to install the Outlook Connector. If you agree to the terms of the license, select “I accept the agreement” then select “Next” to proceed to the next step.

  1. Profile Upgrade
    If Outlook Connector finds any existing profiles, it will upgrade them to the latest version. Confirm that you would like to continue by selecting “Yes”.


Figure 21 – Outlook Connector – Prompt to upgrade profiles

  1. Select Destination Location:
    The default installation destination for the Outlook Connector is:
    C:\Program Files\Bynari, Inc\InsightConnector.

A custom installation location may be used. Select the “Browse” button to choose an alternate location to install the Outlook Connector. Select “Next” to continue the installation. If the existing installation location is used, the following informational window will be displayed. Select “Yes” to proceed to the next step.

Figure 22 – Outlook Connector – Upgrade Destination Location

  1. Outlook Connector Toolbar Options:
    By default, the Outlook Connector Toolbar is configured to be displayed. Displaying the toolbar is the recommended configuration. Select “Yes” to hide the Outlook Connector toolbar. Click “Next” to continue.


Figure 23 – Outlook Connector – Display Toolbar

  1. Ready to Install:
    Review configuration settings and select “Install” to install the Outlook Connector. Click “Next” to continue the installation.


Figure 24 – Outlook Connector – Ready to Install

  1. Setup Complete:
    To automatically start Outlook, place a check in the box labeled “Run Outlook” and select “Finish”.


Figure 25 – Outlook Connector – Upgrade Complete

2.4 Installation Logs

Error Logging

This feature is only activated during a new installation of the Outlook Connector when a new profile is created. Error logging is not enabled during the upgrade process.

Viewing the Log File

The Outlook Connector generates a log file named “Bynari.log” in the user’s %TEMP% directory during the installation process.

Viewing the Log File:

  1. Select “Start” > “Run”.
  2. Type %TEMP% on the Run input field and select “OK”.
  3. A new explorer window will open displaying the contents of the user’s %TEMP% directory.
  4. Browse this directory for a text file named “Bynari.log”. This file can be viewed with any text editor.

 

Technical Support Logging

The Outlook Connector also offers additional logging capabilities for troubleshooting. These logs are located under: %AppData%\Local\Bynari\Bynari Insight Connector 4.0\

There are both “log” and “trace” directories located here.

To turn on logging, go to the Connector toolbar and click on:

Account > More Settings… > Logging

When working with Bynari Technical Support, “verbose” logging will be required for troubleshooting.

3 Post Installation Configuration

3.1 Import “Rules and Alerts”

Important Information: “Rules and Alerts” will not transfer during new installation of Outlook Connector 4.x or when upgrading from Outlook Connector 3.x to 4.x. “Rules and Alerts” are stored locally on your computer. They are not uploaded to the server.
  1. Open Outlook
  2. Click on “Tools” > “Rules and Alerts…”


Figure 26 –Installation – Tools – Rules and Alerts

  1. Under the “E-mail Rules” tab, click on “Options”.


Figure 27 –Installation – Tools – Rules and Alerts

  1. Under the “Import and export” area, click on the “Import Rules…” button.


Figure 28 –Installation – Tools – Rules and Alerts – Options

  1. Type a new name for the rules or keep the default.


Figure 29 –Installation – Tools – Rules and Alerts – Import Rules from

  1. Click “Open”.
  2. Click “OK” to remove all dialog windows.
  3. Ensure that there is a check in the “Send immediately when connected” (labeled “Automatic Send/Receive” in Outlook 2003) checkbox. The checkbox is located on the “Mail Setup” tab, under “Options”, in the “Tools” menu. This is required in order to ensure proper rules functionality.

3.2 Outlook Connector Toolbar

All custom configuration settings can be made through the Outlook Connector Toolbar.

The Outlook Connector toolbar consists of five buttons:

  • Folder – Used for setting folder Access Control List (ACL) permissions and folder types.
  • Refresh Folders – Used to refresh the Outlook folder tree from the IMAP server.
  • Account – Used to modify account configuration settings.
  • Quota – Used to display the user’s current quota status.
  • About – Displays version number and licensing information.


Figure 30 – Outlook Connector Toolbar

3.2.1 Folder

Selecting the “Folder” button on the Outlook Connector Toolbar will open the “Folder Permissions” dialog window.

Figure 31 – Outlook Connector – Folder


Figure 32 – Outlook Connector – Inbox Folder Permissions

This feature is used to share folders with other users on the same system. It is also used to manage the permissions granted to other users using ACL. Folder types can also be changed.

Sharing Folders

Sharing folders using Outlook Connector 4.0.

Figure 33 – Outlook Connector – Folder sharing

Add New User

    Selecting the “Folder” button opens the “Folder Permissions” dialog window. From the “Folder Permissions” dialog window, additional users can be added by selecting the “Add” button


Figure 34 – Outlook Connector – Add New User

  • Set Specific Permissions
    Enter the appropriate username or full email address.
Note: As is the case with Bynari Collaboration Server, some servers require the entire email address to be used when adding a new user to a folder share while others only require the username. Check with your systems administrator for specific information about your server requirements.
  • Select “OK” to confirm adding the new user’s ACL to the specified folder.

    Figure 35 – Outlook Connector – Add New User

 

  • Search Corporate Directory
    This feature is used to search an LDAP directory to find users. Enter a value to search and then click “search”.In the “Search Results” field, select a user or multiple users by holding the control key and clicking on the listings to add and then click “OK”.
  • “Search by” option
    The pull-down list contains five ACL search settings:

    • Any – Search all fields.
    • First Name – Search by “First Name”
    • Last Name – Search by “Last Name”
    • Display Name – Search by “Display Name”
    • E-mail Address – Search by “E-mail Address”
  • ConfigurationThis button provides quick access to the LDAP configuration settings. See LDAP settings under section 2.5.4.2.
  • Select “OK” to confirm adding the new user’s ACL to the specified folder.

Folder Permissions

Figure 36 – Outlook Connector – Folder Permissions Dialog Window

ACL permissions can be adjusted at any time for every user added in the folder permission’s dialog. Users may only grant ACL permissions if they have been given the administrator permission. ACL permissions may not be changed for either the owner or the administrator of the account.

The main “Folder Permissions” dialog window is now displayed again. The username or email address that was just entered is now displayed in the user dialog box. The default permission given to all new users is “Guest”. This can be modified using the pull-down menu in the “Folder Permissions” dialog window.

The pull-down list contains four preconfigured ACL settings:

  • Guest
    Look up, Read, Set Seen Flag rights
  • User
    All rights except for “Create”, “Delete”, and “Administrator”
  • Power User
    All rights except “Administrator”
  • Administrator Full rights
    All rights

Advanced Permissions

More detailed permissions can be assigned by selecting the “Advanced” button.

Figure 37 – Outlook Connector – Folder Permissions Dialog Window


Figure 38 – Outlook Connector – Advanced Permissions

Each of the listed permissions can be set independently giving more granular control over folder sharing permissions.

Permissions

Description

Lookup

The user may see that the folder exists.

Read

The user may read the folder. The user may also select the folder, fetch data, perform searches, and copy messages from the folder.

Set Seen Flag

Keep, per-user, seen state. The “Seen” and “Recent” flags are preserved for the user.

Write

The user may modify flags and keywords other than “Seen” and “Deleted” (which are controlled by other sets of rights).

Insert

The user may insert new messages into the folder.

Post

A user may send a message to the folder. This right differs from the “Insert” right in that the delivery system inserts trace information into submitted messages so that you can filter address by user name, IP address or HTTP requests.

Create Folders

The user may create, delete or rename folders.

Delete Messages

The user may set a message as “Deleted” or permanently delete mail.

Delete Folders

The user may delete folder.

Perform Expunge

User can permanently expunge deleted messages from the folder.

Administrator

The user may change all the permissions on the folders.

Table 1

Folder Type

The “Folder Type” button gives the user the ability to select a specific “type” for any IMAP folder except for Inbox, Outbox, Deleted Items and Sent.


Figure 39 – Outlook Connector – Folder Type

This feature becomes useful if a user wants to create a second calendar to share with others rather than their standard calendar.

3.2.2 Refresh Folders

The “Refresh Folders” button refreshes the folder tree as seen when you press Alt + F1 (navigation pane). When pressed, the Outlook Connector actually scans each folder, not for contents but for the folders themselves. If folder changes are made on the server or if folders are shared to you from someone else, you would use the “Refresh Folders” to display those changes in Outlook.


Figure 40 – Outlook Connector – Refresh Folders

 

Note: The “Refresh Folders” button does not retrieve emails; it refreshes the IMAP folder tree only.

3.2.3 Account

Outlook Connector Account Settings

Figure 41 – Outlook Connector Account


Figure 42 – Outlook Connector – Settings Dialog Window

The Outlook Connector Settings dialog window will be displayed first when selecting “Account” from the Outlook Connector toolbar. All of the information displayed on this screen is entered and configured during the Outlook Connector installation process. Changes can be made to this information as needed.

3.2.4 More Settings

To learn more about the additional settings which are available for configuration, click on the “More Settings…” button.

Across the top of this new window, you will see eight tabs:
General, Connections, Download, Folders, Send/Receive, Other Settings, Format, and About.

3.2.4.1 General


Figure 43– Outlook Connector – More Settings – Connections IMAP

The General tab has two input fields. The first one is already filled in with a default value – “Insight Server Folders”. This is the name that will appear as the display name for “Outlook Today”. This is a user-defined field and can be changed.

The second field is labeled “Other User Information”. It is optional and has no effect on the functionality of the software. This is also a user-defined field.

 

3.2.4.2 Connections

The Connections tab is where IMAP, SMTP, LDAP and Timeout settings are configured.

IMAP

Figure 44 – Outlook Connector – More Settings – Connections IMAP

Incoming Server (IMAP)

  • Server name
    This is the IMAP server name that was entered during installation; it can be changed if needed.
  • Port
    By default, Bynari Server uses port 143.
  • Username
    This is the user name that was entered during installation; it can be changed if needed.
  • Password
    This is the password that was entered during installation; it can be changed if needed.
  • Do not use secure connection
    Default configuration is to not use a secure connection.
  • Use secured connection (SSL)
    Select this option if your server supports IMAP SSL. When selecting this option, the default port of 143 changes to port to 993. This value can be changed manually, if needed.
  • Use Transport Layer Security (TLS)
    Make sure that your server supports TLS before selecting this option. TLS provides endpoint encryption. This protocol allows all communication, including passwords, to be encrypted. TLS is the preferred and most secured method of SSL.
  • Use Persistent Connection
    The default and recommended selection is enabled.
    Important Information: Disabling the use of persistent connections will negatively affect the performance of the Outlook Connector. Persistent connections, also known as “keep alive” connections, reuse the same TCP connection for sending and receiving. This streamlines requests, reduces network traffic, network latency, CPU utilization and memory needs as it requires fewer resources.
  • Test IMAP Settings
    Click this button to test the new IMAP settings.

SMTP

Figure 45 – Outlook Connector – More Settings – Connections IMAP

Outgoing Server (SMTP):

  • Server name
    This is the SMTP server name that was entered during installation; it can be changed if needed.
  • Port
    By default, the Bynari Server uses port 25
  • Do not use secure connection
    Default configuration is to not use a secure connection.
  • Use secured connection (SSL)
    Select this option if your server supports IMAP SSL. When selecting this option, the default port of 143 changes to port to 993. This value can be changed manually, if needed.
  • Use Transport Layer Security (TLS)
    Make sure your server supports TLS before selecting this option. TLS provides endpoint encryption. This protocol allows all communication, including passwords, to be encrypted. TLS is the preferred and most secured method of SSL.

SMTP Authentication:

  • SMTP server requires Authentication
    Note: SMTP Authentication is sent in plain text. To encrypt the user ID and password – enable, “Use Transaction Layer Security (TLS)”.
  • Use Same Authentication as Incoming Server
    This uses your email username and password that you entered when you setup the account.
  • Use SMTP Authentication
    This option is used when sending email from an SMTP server that is not part of the normal mail server network. i.e. an external address or a remote user. Enabling this feature tells the client to authenticate with the server to relay messages to external domains.
  • Test SMTP Settings
    Click this button to test the new SMTP settings.

 

LDAP

Figure 46 – Outlook Connector – More Settings – Connections – LDAP

Note: The LDAP default options are configured for optimal use with Address Book 3.0 and Insight Server 4.3.

 

The Lightweight Directory Access Protocol or LDAP is an application protocol for querying and modifying directory services running over TCP/IP.

An LDAP directory is a set of objects with attributes organized in a logical and hierarchical manner. An example of LDAP could be an address book that consists of names organized alphabetically. Each name in the address book would have a corresponding email address and telephone number.

LDAP shared folder name resolution enables the Outlook Connector to display “actual names” instead of “user names” for shared IMAP folders.

  • Use LDAP to resolve shared folder names
    Place checkmark if you have an LDAP server.

LDAP Server (LDAP):

  • Server name
    This is the LDAP server name that was entered during installation; it can be changed if needed.
  • Port
    By default, the Bynari Server uses port 389.
  • Use SSL
    Select this option if your LDAP server supports IMAP Secured Socket Layer protocol.
  • Anonymous Login
    Select this if your LDAP server allows anonymous binds (anonymous searches).
  • User DN
    The User DN (Distinguished Name) is comprised of a unique identifier for the user and the domain container; the unique identifier is the container “cn=” in the LDAP database followed by the domain or organizational information.

Note: If you are using Insight Server, users can find their own “User DN” information. Log into the web management console as a user, then click on:

    1. Preferences > “Client Configuration”
    2. “Directory Server Account”, locate the field, “Account Name”.

Bynari Collaboration Server users must contact their administrator to retrieve the User DN.

An example DN might be: “cn=testuser1,o=example.net”

If you are not running the Bynari Server or Insight Server, please consult your LDAP administrator for your DN.

  • Use Incoming Server (IMAP) Password
    This uses the IMAP password from the Connections > IMAP field.
  • Password
    This is your password to the LDAP server.
  • Remember Password
    Remember the password so that you do not have to enter it every time it accesses the LDAP server.
  • Test LDAP Settings
    Click this button to test the new LDAP settings.

 

LDAP Advanced options

Figure 47 – Outlook Connector – More Settings – Connections – LDAP – Advanced Settings

 

Searching Options

  • Sort returned results by:

This option sorts the LDAP results by:

  • First Name
  • Last Name
  • Display Name
  • Email Address
  • Display all results in a single container (deep search)

Toggling this option will allow for custom LDAP searches to group level.

  • LDAP Filter for Users:

This option defines the LDAP attribute for users.

  • LDAP Filter for Groups:

This option defines the LDAP attribute for groups.

  • LDAP Search Attributes:

The criteria used in the search attribute can be changed to meet your LDAP structural needs. This information can be found with the user’s container name or unique identifier in the LDAP database. An LDAP browser can quickly display these parameters. In this example, the data refers to the following information:

  • cn = Container name. Typically this is the user’s full name.
  • mail = User’s mail address.
  • givenName = Typically, this is the first name of a user.
  • sn = Surname or last name.

Base DN

  • The top level of the LDAP directory tree is the base, referred to as the “base DN”.
  • By default Outlook Connector attempts to determine your LDAP base DN by your User DN, which you specified on the Connections > LDAP tab. Consult with your LDAP administrator for your DN if the Base DN was not determined automatically.

LDAP Server Version

  • Select LDAP version

Manually select version 2 or LDAP version 3.

  • Detect

This button will attempt to get the LDAP server version automatically.

LDAP attributes

Figure 48 – Outlook Connector – More Settings – Connections – LDAP – Advanced Settings – LDAP Attributes

The value of these attributes is used to perform the searches against the LDAP database. These are comma delimited and can be changed depending on your setup.

  • User Attributes
    The user attribute will search against “login” then “uid”.
  • User ID
    The user id attribute will search against the “login” attribute.
  • First Name
    The first name attribute will search against “givenName”.
  • Last Name
    The last name attribute will search against “sn”.
  • Display Name
    The display name attribute will search against “display-name”, “displayName”, and then “cn”.
  • E-mail Address
    The e-mail address attribute will search against “mail”.

 

Others



Figure 49 – Outlook Connector – More Settings – Connections IMAP

Timeout Setting

  • Server timeout value in number of seconds.
    The Timeout Setting tells the server how long to wait before it closes the session. The default value is “0”. Acceptable values are: “0”, “30-600” seconds. In a corporate environment where the user is on the same network as the mail server, a timeout value of “0” may be adequate.Users on a Wide Area Network (WAN) need to consider larger timeout settings. Setting this value is dependent on your Internet connection speeds. If you are on a dial-up connection, you may want to set this value to 600 seconds whereas if you are on a DSL connection or cable modem connection, 60 seconds may be acceptable.Having a value too low can cause uploading issues when sending large attachments where the Internet upload speeds are usually slow.
  • Auto Registration Port
    Auto registration is disabled by default. This option allows Outlook Connector to verify licensing with their local Insight Server or Bynari Server. If you do not use the Bynari Server or Insight Server, DO NOT enable the Auto Registration Port Checkbox. By default, port 80 is used. This option can be changed depending on your Bynari Server or Insight Server, and your firewall configuration.

    Important Information: The Outlook Connector was designed to function over LAN-based and high speed broadband connections. Many remote users are able to utilize the Outlook Connector as it was designed. For users on poor remote connections, utilizing the Bynari Web Client may be a better option.

 

  • Use SSL
    Use secure socket layer protocol to register.

3.2.4.3 Download


Figure 50 – Outlook Connector – More Settings – Download

 

Download Options

  • Download Headers Only
    Enabled by default, this option improves the performance of the initial synchronization of the emails downloaded for Outlook. It downloads the header only for email messages. When the message is selected for viewing, the entire message is downloaded.

    Note: Tasks, journals, contacts and calendar events are always set for full-content download when selected for viewing.

     

  • Download Contents of Message Only
    Disabled by default, this option downloads the entire message during the synchronization of emails. Attachments are downloaded when the message is selected for viewing.
  • Download Contents of Message and Attachments
    Disabled by default, this option downloads the entire message and associated attachments during the synchronization of emails.
  • Download All Attachments
    This option will download all attachments.
  • Download Attachment Limit
    This option will set the download attachment limit size in bytes. Any value is accepted in this field. The default is 50,000 bytes.

Download Message progress

  • Show progress indicator when loading messages
    When this box is checked, a progress indicator will appear when synchronizing any folder with more than 50 messages. This option is checked by default.
  • Indicator threshold (number of messages)
    This option allows you to modify when the indicator will appear. By default, this value is set to 50 messages, adjusting this to zero will display the indicator for every message.

3.2.4.4 Folders


Figure 51 – Outlook Connector – More Settings – Folders

Folder Type

  • Use ACL to set folder types
    Enabled by default, it allows the Outlook Connector to use custom IMAP folder ACLs to specify the specialized folder types used by Outlook. These are “Calendar”, “Contact”, “Task”, “Journal”, “Notes“, and “Mail”. This option increases performance since the Outlook Connector no longer has to locate a hidden synchronization message to determine a given folder’s type.

Folder List

  • Show All Folders
    This is enabled by default and tells the Outlook Connector to automatically subscribe to all folders found under the user’s folder list.
  • Show Only Subscribed Folders
    In large environments, the default value of “Show All Folders” may not be desirable. This option allows the users to individually select only the folders they want to see in Outlook.
Important Information: When manually selecting folders, make sure that default folders are checked. i.e. Calendar, Contacts, Deleted Items, Sent Items, Outbox and Tasks. If you uncheck them, it will cause Outlook to recreate them on the IMAP server. This is a default behavior of Outlook.

 

3.2.4.5 Send/Receive


Figure 52 – Outlook Connector – More Settings – Send/Receive

Outlook Connector utilizes IMAP IDLE to update the Inbox folder. For servers that do not support IMAP IDLE make sure that the Inbox folder is selected.

 

3.2.4.6 Other Settings


Figure 53 – Outlook Connector – More Settings – Miscellaneous

The Other Settings tab contains two sections; one for read receipt request options and the second for local cache options.

Message Receipt Options

How would you like to respond to requests for read receipts on incoming messages?

  • Prompt me before sending a response
    This option is the default setting. This setting “prompts” the user to choose between sending a read receipt or not.
  • Always send a response [default selection]
    This option automatically sends a response to the sender of a read receipt request.
  • Never send a response
    This option never sends a response to a read request sender.

Local Cache Options

Store local message cache in the following directory:

  • Default Location
    The default location for the local cache is:Windows XP:
    C:\Documents and Settings\[user name]\Local Settings\Application Data\Bynari\Outlook Connector 4.0\Accounts\[Outlook profile name]\[email address]\Windows 7:
    C:\Users\[user name]\AppData\Local\Bynari\Outlook Connector 4.0\Accounts\[Outlook profile name]\[email address]\The name of the local cache file is: LocalCache.ost
  • Custom Location
    This option allows you to change the location of the local cache. This enables the administrator to place the local cache on the network through a network share for user data backup if needed.

    Note: Read, Write, Delete and Change permissions within Microsoft Windows are required for any Custom Location.
    Note: Any changes made to the location of the local cache will require a restart of Outlook. If you do not restart Outlook, you may see errors, because the Outlook Connector must create the LocalCache.pst file.

 

3.2.4.7 Format


Figure 54 – Outlook Connector – More Settings – Format

Message Format Options

Note: “Use Kolab Format” option is available in the Kolab version of Outlook Connector 4.0.
  • Use Microsoft Message Format
    This is also known as “.tnef” formatting which stands for Transport Neutral Encapsulation Format. This allows files to contain rich text formatting used by e-mail messages, such as bold, italics, underlining, etc…
  • Use iCal Format
    This option is turned on by default in the “ical” or “iCalender” format version of Outlook Connector. iCalendar is a file format which allows sending meeting requests and tasks to other internet users via email or sharing files with an .ics extension.“iCal” format is significantly smaller than the “.tnef” format which can improve performance and save disk space.

    Note: If you use a Kolab server or an iCalendar compatible server, you may not need to select “Use Microsoft Message Format”. If you are unsure, it is best to select both options.
  • Use Kolab Format
    Use this option only if you are running a Bynari Collaborator Server or Kolab IMAP server. Kolab uses a unique XML format attached to email specifically for Kolab groupware servers. The XML holds information for contacts, calendar events, journals, etc.

 

3.2.4.8 Logging


Figure 55 – Outlook Connector – More Settings – Logging

Logging capabilities have been added to the Outlook Connector as a troubleshooting aid. By default, all logging is off. Log files can consume large amounts of disk space, and it is recommended that logging be left off, unless the user is experiencing problems.

When working with Bynari Technical Support on an issue, they may request that you enable logging. Verbose logging is the most thorough level of logging offered and will offer the most insight to the support technician.

 

3.2.4.9 About


Figure 56 – Outlook Connector – More Settings – About

About tab

The about tab provides information about the Outlook Connector. It contains the version number as well as all licensing information.

3.2.5 Quota

Used to display the user’s current quota status.

Figure 57 – Outlook Connector – Toolbar Quota button


Figure 58 – Outlook Connector Quota

3.2.6 About


Figure 59 – Outlook Connector – About

The “About” button on the Outlook Connector toolbar performs the same function as the “About” tab discussed above in section 2.5.4.9.

4 Using Outlook Connector

Outlook Connector 4.0 provides Outlook with a MAPI transport service that makes connecting to an IMAP server transparent to the end user. The following sections describe some of the additional dialogs introduced by the Connector such as Folder permissions as well as documenting configuration changes needed for features such as Free/Busy.

4.1 Viewing Shared Folders

Note: Private events (calendar, contacts, and tasks) are stored on the server. Only the folder owner will see private events.

Other users’ shared folders will appear under ‘Other Users’ in the folder list.


Figure 61 – “Other Users” shared folder list

Public folders created on the Bynari Server and Insight Server will display under ‘Shared Folders’ in Outlook.

 


Figure 62 – “Shared Folders” public folder list

 

Note: Upgrade your Insight Server to at least 4.2.2 to support private events.

4.2 Free/Busy Configuration

Outlook allows users to share free/busy information from their calendars with other users on their mail server. With the Microsoft Office Internet Free/Busy Service, users can publish their free/busy times to a shared Internet location. Members using this service can view each other’s free/busy information when viewing shared calendars or creating meeting requests.


Configure Free/Busy

  • Open Options in Outlook
    On the Outlook Toolbar, select Tools > Options.

    Figure 63 – Outlook Tools, Options
  • This opens a new window; select the Preferences option tab.

Options – Preferences

  • Click on “Calendar Options…”

    Figure 64 Tools Options

Calendar Options – Advanced options


Figure 65 – Tools – Options – Calendar Options

Note:When sending meeting requests over the Internet, use iCalendar format” option will likely be grayed out. This is normal.

 

  • Enable alternate calendar
    Select this option if you wish to enable an alternate calendar.
  • Click on “Free/Busy Options…”
    Select to change the Free/Busy Options.

 

Free/Busy Options

Figure 66 – Tools – Options – Calendar Options Free/Busy Options

Options

  • Publish “2” month(s) of Calendar free/busy information the server
    Enter the number of months of Free/Busy information to be published.The default interval is 2 months. This value represents the number of months from today’s date.
  • Update free/busy information on the sever every “15” minutes
    The default time is every 15 minutes. This value represents how often Outlook will update the user’s Free/Busy information on the server.

Internet Free/Busy

  • Publish at my location
    This option must be checked. In figure 66, a path name is shown. Insert your information in place of the variables, “%NAME%.vcf”.

    Note: If you are using Insight Server 4.3, use the below example by changing the server name and replacing %NAME% with your username.ftp://mail.example.net/freebusy/%NAME%.vcf
  • Search location
    Enter the URL for the shared free/busy search location.

    Note: If you are using Insight Server 4.3, use the below example by changing the server name and replacing %NAME% with your username.http://mail.example.net/freebusy/%NAME%.vcf
  • Click “OK” to apply the Free/Busy settings.

4.3 Show / Hide Toolbar

  • Toggle toolbar display

On the Outlook Toolbar, select View > Toolbars > Outlook Connector 4.0.

It places a check mark next to the name to show that the Connector is enabled.



Figure 67 Show/Hide Outlook Connector Toolbar

If you have hidden the Outlook Connector toolbar at the time of the installation, you can show the toolbar by following the above steps.

5 Registering and Unregistering Outlook Connector

Outlook Connector 4.0 is configured to use auto registration by default when “Insight Server” is selected during installation. Auto registration is designed for users of both the Outlook Connector and Insight Server or the Bynari Server. With auto registration enabled, the Outlook Connector will verify that an active license exists for the client when Outlook starts. It is recommended that users of the Insight Server or the Bynari Server utilize this feature of the Outlook Connector.

If you do not have an Insight Server or Bynari Server, or do not wish to use auto registration, you can register your copy of the Outlook Connector using the About tab of the Outlook Connector toolbar.

5.1 Auto Registration

Enable or disable auto registration

  • Click on the “Account” tab in Outlook Connector toolbar.


Figure 68 – Outlook Connector – Account

  • Select “Connections” > “Others”.


Figure 69 Outlook Connector – More Settings – Connections – IMAP

 

Important Information: Do not enable auto registration if you do not use the Insight Server or Bynari Collaborator Server (BCS).

 

  • Auto Registration Port
    Auto registration is either enabled or disabled depending on your Insight Server selection during installation. This option allows Outlook Connector to verify licensing with a local Bynari Server or Insight Server. By default, port 80 is used. This option can be changed depending on your Bynari Server or Insight Server, and your firewall configuration.
  • Use SSL
    Use secure socket layer protocol to register.

    Troubleshooting Tip: If you are experiencing trouble registering the connector and your server does not support auto-registration, make sure that the “Auto Registration Port” option is NOT checked. This option is being deprecated in future versions of the connector.

5.2 Register Outlook Connector

  • Click on “About” in the Outlook Connector Toolbar.

    Figure 70 – Outlook Connector About

 

  • Click on “License”.

    Figure 71 About
    Figure 682 Key Support button
  • Enter your product license key
    Copy/Paste your license key in the space provided.
  • Manual Registration
    See section “manual registration” below.
  • Enter the license certificate below:
    This is only used during manual registration.
  • Which port would you like to use for the registration?
    Bynari license key server listens on ports 80 and 3080. If port 80 is blocked, port 3080 can be used as an alternate port.

    Note: The license key server URL is http://update.bynari.net.
    Note: If you encounter any issues while activating your Outlook Connector license, ping the license key server to verify proper internet connectivity.
  • Click “OK” to register Outlook Connector.

Manual Registration

  • Enter your product license key
    Copy/Paste your license key in the space provided.
  • Manual Registration
    Contact Bynari Support at support@bynari.net and request a manual license certificate.
  • Enter the license certificate below:
    Paste entire certificate in the space provided. (See manual certificate example.)

    Figure 693 – Manual certificate example

    Figure 684 – Manually entering the information
  • Click “OK” to complete manual registration.

5.3 Registration Complete

  • After registering over the internet or manually, you should see the following screen.

    Figure 715 Manually entering the information

Outlook Connector License Information

  • License Key
    This is the license key used to register Outlook Connector.
  • License Expire
    This will display when your license expires.
  • Support Expires
    This option will show the date Bynari support expires.
  • Number of Licenses Used
    This displays the number of licenses used vs. the number of licenses that you have purchased.
  • Total License Available
    This displays the number of licenses available or purchased.
  • Supported Versions
    The Connector version supported for this license key.
  • Supported Options
    Formats that are supported such as iCal or Kolab are listed.

Click “Refresh” to update dialog screen for license information.

5.4 Unregister Outlook Connector

  • Click on “About” on the Outlook Connector Toolbar.
  • Click on “License”.

    Figure 726 – Connector License information
  • Click on “Unregister”.
    This will unregister Outlook Connector from your computer.



6 Reporting Problems

When reporting problems, be sure to include the following information:

  • Microsoft Windows version number and patch level.
    • Right click on “My Computer” icon on the Desktop and select Properties. The Windows version and patch level will be listed under System: in the General tab dialog.
  • Microsoft Outlook version and patch level.
    • Right click on Help in Outlook and select About Microsoft Outlook. The Outlook version and patch level will be listed.
  • The full version number of the Outlook Connector.
    • Click “About” on the Connector toolbar. The connector version and build number (4.Y-XXXX) will be listed.

 

To contact technical support:

U.S. Toll Free Telephone: 1-800-241-1086
International Telephone: 001-214-350-5772

To open a new support ticket email: support@bynari.net

For FAQs: http://www.bynari.net/users/kb.php

Bynari Outlook Connector

User’s Guide

Trademarks

 

Bynari products are trademarks of Bynari, Inc.

 

Microsoft Windows, Windows Mobile, Outlook, Windows XP, Windows Vista are all registered trademarks of Microsoft Corporation in the United States, other countries, or both.

 

BlackBerry is a registered trademark of Research In Motion Limited in the United States, other countries, or both.

All other trademarks are the property of their respective owners.

Technical Support

 

When you purchase any of Bynari’s products, the products include one year of free support and maintenance. To purchase additional yearly support and maintenance, please contact sales@bynari.net.

 

Customers who are current on support receive one year of product maintenance, upgrades and email and/or telephone matching the purchased support package.

Support is available to customers worldwide.

To contact technical support:

U.S. Toll Free Telephone: 1-800-241-1086
International Telephone: 001-214-350-5772

To open a new support ticket email: support@bynari.net.

For FAQs: http://www.bynari.net/users/kb.php

Licensing

The Outlook Connector utilizes a licensing key system that assigns and stores the number of licenses that have been purchased by the customer. When Outlook starts, Outlook Connector (OC) will either contact the patched version of Insight Server 4.3, which allows auto-registration with OC 4.0, or Server 4.4. If you are using a 3rd party server, it will contact the Bynari license key server over the Internet to validate and activate the installed license. Activation will be attempted each time Outlook is started or until activation of the license is successful.

Note: The license key server URL is http://update.bynari.net.

 

If you encounter any issues while activating your Outlook Connector license, please see below for a possible solution:

  • The client systems may be blocked from accessing the Internet, or Internet access is temporarily unavailable.
  • The license key entered during the installation of the Outlook Connector may be invalid. This could include issues such as an incorrect key or incorrect key version.
  • The number of client licenses has been exceeded. The Bynari Key Server tracks how many systems have been activated using a given license. If the number of activated clients exceeds the total for the license, the Outlook Connector will inform you that additional licenses need to be purchased.
  • If you need to reinstall the Outlook Connector software on a new system due to either hardware failure or system upgrade and need to unregister, do the following (See section 4.3 for complete details):
    • Open Outlook
    • Click on “About” tab in the Outlook Connector toolbar
    • Click on “License”
    • Click on “Unregister”

If you experience problems with license activation, please contact your reseller or Bynari support at support@bynari.net.

Important Notes:

  • This documentation applies to the latest 4.0 build of the Outlook Connector available from Bynari.
  • Make sure that Outlook is setup as the default e-mail client. To verify this on the workstation, go to Control Panel > Internet Options > Programs and make sure that Outlook is selected in the drop down box next to E-mail.
  • Outlook Connector 4.0 has been tested with Bynari Server, Univention Corporate Server, Insight Server, and Bynari Collaboration Server, Cyrus, and Kolab IMAPv4 servers. Outlook Connector supports all base specifications as described in RFC 3501: Internet Message Access Protocol version 4rev1. If your IMAPv4 server supports the specifications in RFC 3501, Outlook Connector 4.0 may be compatible with your server. If you encounter issues with a different type of unsupported server, email support at support@bynari.net to create a support ticket. The Bynari support team will provide a reasonable effort in working with you.

 

Table of Contents



1 Outlook Connector version 4.0

The Outlook Connector acts as a MAPI transport for Microsoft Outlook. As a MAPI transport provider, the Connector interprets all the different types of folders used by Outlook.

When Outlook Connector is used in conjunction with the Bynari Server or Insight Server, a powerful collaboration environment is created. Users are able to share mail folders, contacts, tasks, and calendars with other individuals. Public folders of each type can also be created and maintained by system administrators through the web admin interface. All of these functions are supported through the familiar Outlook interface eliminating any need for costly end user training.

1.1 Architecture

Messaging Application Programming Interface or MAPI has two major components. Applications such as Microsoft Outlook use the client side interface to contact the MAPI subsystem for all communications with the message store. There is also a service interface which is used by programs such as Outlook Connector to provide the MAPI transport services for accessing the message store on the server.

Outlook Connector acts as the transport that provides messaging services directly to the MAPI subsystem and stores this information on Insight Server and Bynari Server via the IMAP protocol.

 

Figure 1 – MAPI Architecture

1.2 Features of Outlook Connector

Outlook Connector 4.0 offers the following features:

  • Native MAPI implementation
  • Mobile sync with Windows Mobile device
  • Mobile sync with Blackberry Mobile device
  • Mobile sync of contacts with iPhone
  • Support for new Microsoft PST architecture enables files larger than 2G
  • Simple click-and-go installation and configuration
  • SSL secure connection support
  • Mail, Calendar, Contacts, Journal, Notes and Task folder support
  • Native Outlook calendar functions
  • Free/Busy support
  • Shared folders including Calendars, Contacts, Tasks, Journals, Notes and Mail
  • Contact Distribution Lists
  • Outlook Rules Wizard
  • Read receipts
  • IMAP folder subscriptions
  • Shared access controls
  • Header only download
  • Offline support
  • Grouping
  • Multiple user accounts
  • Voting Buttons
  • Native iCalendar and vCard format support
  • IMAP IDLE support
  • Mailbox quotas
  • Ability to re-download messages
  • And more …

1.3 Supported Platforms

Outlook Connector 4.0 is compatible with the following software. If you are using a version that is not listed, or software that is not supported, upgrade to a supported version.

Supported Windows®Versions

Windows® XP

Windows® Vista

Windows® 7

Supported Outlook® Versions

Outlook® 2003

Outlook® 2007

Outlook® 2010 (32/64 bit)

Supported Languages

  • English
  • French
  • German
  • Italian
  • Spanish (Spain)
  • Portuguese (Brazil)
  • Dutch
  • Norwegian
  • Russian
  • Swedish
  • Taiwanese/Chinese
  • Czech
  • Hebrew
Note: Other languages are provided and may be used but are not formally supported. Problems with translation, spelling, grammar and proper character encoding may be encountered.

 

1.4 Supported IMAP Servers

  • Bynari Collaboration Server
  • Insight Server
  • Cyrus
  • Kolab

1.5 Supported mobility devices and software

Outlook Connector 4.0 includes mobility support for several devices including Blackberry, iPhone and Windows Mobile. The following versions are compatible with Outlook Connector 4.0.

1.6 Known Limitations

  • Microsoft Business Contact Manager is not compatible with Outlook Connector.
  • Smart Phone synchronization is dependent on the hardware and the software provider.
  • Slashes in folder names are not allowed.

2 Installation

2.1 Preparing Your System (Pre-Installation)

Before you begin:

The Connector 4.0 software must be installed by the Windows login user. Additionally, this user needs “administrator” rights to install the software. The users’ rights can be changed to install the Connector and then reset to the original rights.

Before you begin the installation procedure, perform the following steps:

Step 1: Install Microsoft® Windows and/or Microsoft® Outlook

Supported Windows® Versions

Windows® XP

Windows® Vista

Windows® 7

 

Supported Outlook® Versions

Outlook® 2003 SP3+

Outlook® 2007 SP2+

Outlook® 2010 SP1+

Note: If you are using versions that are not listed, upgrade to a supported version.

Step 2: Install the Latest Updates for Microsoft® Windows and Outlook

Go to the Microsoft® website or check with your IT Administrator to verify that you have installed the most current critical updates and service packs for both your Windows operating system and Outlook.

http://update.microsoft.com – Microsoft® updates.

Outlook 2003 minimum required version to install

  • Click on “Help” > “About Microsoft Office Outlook”


Figure 2 – Outlook 2003 about dialog

Outlook 2007 minimum required version to install

  • Click on “Help” > “About Microsoft Office Outlook”


Figure 3 – Outlook 2007 about dialog

Outlook 2010 minimum required version to install

  • Click on “Help” > “About” and then click on “Additional Version and Copyright Information”


Figure 2.3 – Outlook 2010 about dialog

Step 3: Backup “Rules and Alerts”

Outlook “Rules and Alerts” functions are used to organize incoming email. These functions allow users to set custom “actions” that will be performed automatically on incoming messages.

Important Information: “Rules and Alerts” will not transfer during new installation of Outlook Connector 4.x or when upgrading from Outlook Connector 3.x to 4.x. “Rules and Alerts” are stored locally on your computer. They are not uploaded to the server.

 

Export “Rules and Alerts”

  1. Open Outlook
  2. Click on “Tools” > “Rules and Alerts…”


Figure 4 –Installation – Tools – Rules and Alerts

  1. Under the “E-mail Rules” tab, click on “Options”.


Figure 5 –Installation – Tools – Rules and Alerts

  1. Under the “Import and export” area, click on the “Export Rules…” button.


Figure 6 –Installation – Tools – Rules and Alerts – Options

  1. Type a new name for the rules or keep the default.


Figure 7 –Installation – Tools – Rules and Alerts – Save Exported Rules as

  1. Click “Save”.
  2. Click “OK” to remove all dialog windows.
  3. Close Outlook to continue installing or updating Outlook Connector 4.0.

 

Note: In order to ensure proper Rules and Alerts functionality in Microsoft Outlook a check must be placed in the “Schedule an automatic send/receive every” checkbox under Tools>Options>Mail Setup>Send/Receive. Any amount of time may be specified in the associated “minutes” field.

 

2.2 Installing Outlook Connector – New Installation

The 4.0 Outlook Connector Install Wizard standardizes the installation process for Outlook.

The following section explains how to install the Outlook Connector 4.0 for the first time on a computer. The “upgrade” process is slightly different and available in the section 2.4 of this manual.

Note: The Outlook Connector will only install on systems where the user has “administrative” rights. The users’ rights can be changed to install the Outlook Connector and then reset to the original rights after the installation has completed.

 

Important Information: In some cases, virus scanning add-ins for Outlook may need to be disabled for the installation of the Outlook Connector. Disabling the virus scanning Outlook add-in should not change the functionality of your antivirus software.

 

Before you begin:

  1. Verify that all steps in “Preparing Your System” (Pre-installation) section 2.1 are complete.
  2. Unzip the Outlook Connector 4.0 compressed file by right-clicking and selecting “Extract All”.


Figure 8 – Installation – Downloaded zipped Outlook Connector

  1. Double Click on the installer.


Figure 9 – Installation Outlook Connector Installer Package

NOTE: For Windows Vista and Windows 7, you must run the installer as “Run as Administrator” to install Outlook Connector properly.

  1. Welcome Dialog:
    Double click the installation setup file to start installation. The setup wizard will display the “Welcome Dialog” window. Select “Next” to continue with the installation process.


Figure 10 – Installation Outlook Connector welcome dialog Setup Wizard

  1. End User License Agreement:
    Read the license agreement. If you agree, select the button, “I accept the license agreement” and select “Next”.
  2. Create New Outlook Profile:
    The Outlook Connector will automatically create a profile for Outlook. The default name for this profile is “Outlook Connector”. The “default name” is a user defined field and may be changed if needed. Place a check in the box labeled, “Prompt for which profile to use when starting Outlook (Recommended)”, if you have multiple profiles in Outlook. Selecting this will prompt for profile selection when Outlook starts. Click “Next” to continue installation.


Figure 11 – Installation Outlook Connector Create New Profile

  1. Account Information:
    This screen provides the Outlook Connector with the information needed to create the Outlook profile for your email account during the installation process.
    The following basic information is needed to complete this screen:

    • Your Name
    • E-mail Address
    • IMAP Server Address
    • SMTP Server Address
    • Username
    • Password


Figure 12 – Outlook Connector – Account Information

Note: Bynari Collaboration Server requires the entire email address to be used as the “username”. Insight Server only used the first part of the email address, leaving off “@domain.com”.
    • Fill in requested information.
    • Click “Next” to continue.
  1. Select Destination Location:
    The default installation destination for the Outlook Connector is:
    C:\Program Files\Bynari, Inc\InsightConnector.

A custom installation location may be used. Select the “Browse” button to choose an alternate location to install the Outlook Connector. Click “Next” to continue the installation.

Figure 13 – Outlook Connector – Select Destination Location

  1. Outlook Connector Toolbar Options:
    By default, the Outlook Connector Toolbar is configured to be displayed. Displaying the toolbar is the recommended configuration. Select “Yes” to hide the Outlook Connector toolbar. Click “Next” to continue.


Figure 14 – Outlook Connector – Display Toolbar

  1. Ready to Install:
    Review configuration settings and select “Install” to install the Outlook Connector. Click “Next” to continue the installation.


Figure 16 – Outlook Connector – Ready to Install

  1. Setup Complete:
    To automatically start Outlook, place a check in the box labeled “Run Outlook” and select “Finish”.


Figure 17 – Outlook Connector – Finish Install Wizard

 

2.3 Installing Outlook Connector – Upgrade

Upgrading the Outlook Connector is similar to the steps discussed under “Installing Outlook Connector – New Installation” in section 2.1.

In the upgrade process, no profile will be created and all of the original user data from the previous installation of the Outlook Connector is used. The Outlook Connector will automatically upgrade profiles from earlier Outlook Connector versions. Outlook Connector 3.x used a “local cache” data storage system while the Outlook Connector 4 uses a Microsoft PST file to store data.

When upgrading from any of the Outlook Connector 3.x versions, your profile will be upgraded to the new PST architecture. The Outlook Connector will need to perform an initial synchronization after the upgrade process completes.

Important Information: During the initial synchronization process, the Connector will download the newest emails first, and then it will continue to synchronize in the background. This allows the end-user to begin using Outlook immediately while synchronization continues.

 

Note: The Connector installer will automatically determine if your profile needs to be upgraded.

 

Before you begin:

  1. Verify that all steps in “Preparing Your System” (Pre-installation) section 2.1 are complete.
  2. Unzip the Outlook Connector 4.0 compressed file by right-clicking and selecting “Extract All”.


Figure 18 –Installation – Downloaded zipped Outlook Connector

  1. Double Click on the installer to start the installation process.


Figure 19 – Installation Outlook Connector – Installer Package

 

  1. Welcome Dialog:

Double click the installation setup file. The setup wizard will display the “Welcome Dialog” window. Select “Next” to continue with the installation.


Figure 20 – Installation – Outlook Connector welcome dialog – Setup Wizard

  1. End User License Agreement:

Accept the terms of the End User License Agreement to install the Outlook Connector. If you agree to the terms of the license, select “I accept the agreement” then select “Next” to proceed to the next step.

  1. Profile Upgrade
    If Outlook Connector finds any existing profiles, it will upgrade them to the latest version. Confirm that you would like to continue by selecting “Yes”.


Figure 21 – Outlook Connector – Prompt to upgrade profiles

  1. Select Destination Location:
    The default installation destination for the Outlook Connector is:
    C:\Program Files\Bynari, Inc\InsightConnector.

A custom installation location may be used. Select the “Browse” button to choose an alternate location to install the Outlook Connector. Select “Next” to continue the installation. If the existing installation location is used, the following informational window will be displayed. Select “Yes” to proceed to the next step.

Figure 22 – Outlook Connector – Upgrade Destination Location

  1. Outlook Connector Toolbar Options:
    By default, the Outlook Connector Toolbar is configured to be displayed. Displaying the toolbar is the recommended configuration. Select “Yes” to hide the Outlook Connector toolbar. Click “Next” to continue.


Figure 23 – Outlook Connector – Display Toolbar

  1. Ready to Install:
    Review configuration settings and select “Install” to install the Outlook Connector. Click “Next” to continue the installation.


Figure 24 – Outlook Connector – Ready to Install

  1. Setup Complete:
    To automatically start Outlook, place a check in the box labeled “Run Outlook” and select “Finish”.


Figure 25 – Outlook Connector – Upgrade Complete

2.4 Installation Logs

Error Logging

This feature is only activated during a new installation of the Outlook Connector when a new profile is created. Error logging is not enabled during the upgrade process.

Viewing the Log File

The Outlook Connector generates a log file named “Bynari.log” in the user’s %TEMP% directory during the installation process.

Viewing the Log File:

  1. Select “Start” > “Run”.
  2. Type %TEMP% on the Run input field and select “OK”.
  3. A new explorer window will open displaying the contents of the user’s %TEMP% directory.
  4. Browse this directory for a text file named “Bynari.log”. This file can be viewed with any text editor.

 

Technical Support Logging

The Outlook Connector also offers additional logging capabilities for troubleshooting. These logs are located under: %AppData%\Local\Bynari\Bynari Insight Connector 4.0\

There are both “log” and “trace” directories located here.

To turn on logging, go to the Connector toolbar and click on:

Account > More Settings… > Logging

When working with Bynari Technical Support, “verbose” logging will be required for troubleshooting.

3 Post Installation Configuration

3.1 Import “Rules and Alerts”

Important Information: “Rules and Alerts” will not transfer during new installation of Outlook Connector 4.x or when upgrading from Outlook Connector 3.x to 4.x. “Rules and Alerts” are stored locally on your computer. They are not uploaded to the server.
  1. Open Outlook
  2. Click on “Tools” > “Rules and Alerts…”


Figure 26 –Installation – Tools – Rules and Alerts

  1. Under the “E-mail Rules” tab, click on “Options”.


Figure 27 –Installation – Tools – Rules and Alerts

  1. Under the “Import and export” area, click on the “Import Rules…” button.


Figure 28 –Installation – Tools – Rules and Alerts – Options

  1. Type a new name for the rules or keep the default.


Figure 29 –Installation – Tools – Rules and Alerts – Import Rules from

  1. Click “Open”.
  2. Click “OK” to remove all dialog windows.
  3. Ensure that there is a check in the “Send immediately when connected” (labeled “Automatic Send/Receive” in Outlook 2003) checkbox. The checkbox is located on the “Mail Setup” tab, under “Options”, in the “Tools” menu. This is required in order to ensure proper rules functionality.

3.2 Outlook Connector Toolbar

All custom configuration settings can be made through the Outlook Connector Toolbar.

The Outlook Connector toolbar consists of five buttons:

  • Folder – Used for setting folder Access Control List (ACL) permissions and folder types.
  • Refresh Folders – Used to refresh the Outlook folder tree from the IMAP server.
  • Account – Used to modify account configuration settings.
  • Quota – Used to display the user’s current quota status.
  • About – Displays version number and licensing information.


Figure 30 – Outlook Connector Toolbar

3.2.1 Folder

Selecting the “Folder” button on the Outlook Connector Toolbar will open the “Folder Permissions” dialog window.

Figure 31 – Outlook Connector – Folder


Figure 32 – Outlook Connector – Inbox Folder Permissions

This feature is used to share folders with other users on the same system. It is also used to manage the permissions granted to other users using ACL. Folder types can also be changed.

Sharing Folders

Sharing folders using Outlook Connector 4.0.

Figure 33 – Outlook Connector – Folder sharing

Add New User

    Selecting the “Folder” button opens the “Folder Permissions” dialog window. From the “Folder Permissions” dialog window, additional users can be added by selecting the “Add” button


Figure 34 – Outlook Connector – Add New User

  • Set Specific Permissions
    Enter the appropriate username or full email address.
Note: As is the case with Bynari Collaboration Server, some servers require the entire email address to be used when adding a new user to a folder share while others only require the username. Check with your systems administrator for specific information about your server requirements.
  • Select “OK” to confirm adding the new user’s ACL to the specified folder.

    Figure 35 – Outlook Connector – Add New User

 

  • Search Corporate Directory
    This feature is used to search an LDAP directory to find users. Enter a value to search and then click “search”.In the “Search Results” field, select a user or multiple users by holding the control key and clicking on the listings to add and then click “OK”.
  • “Search by” option
    The pull-down list contains five ACL search settings:

    • Any – Search all fields.
    • First Name – Search by “First Name”
    • Last Name – Search by “Last Name”
    • Display Name – Search by “Display Name”
    • E-mail Address – Search by “E-mail Address”
  • ConfigurationThis button provides quick access to the LDAP configuration settings. See LDAP settings under section 2.5.4.2.
  • Select “OK” to confirm adding the new user’s ACL to the specified folder.

Folder Permissions

Figure 36 – Outlook Connector – Folder Permissions Dialog Window

ACL permissions can be adjusted at any time for every user added in the folder permission’s dialog. Users may only grant ACL permissions if they have been given the administrator permission. ACL permissions may not be changed for either the owner or the administrator of the account.

The main “Folder Permissions” dialog window is now displayed again. The username or email address that was just entered is now displayed in the user dialog box. The default permission given to all new users is “Guest”. This can be modified using the pull-down menu in the “Folder Permissions” dialog window.

The pull-down list contains four preconfigured ACL settings:

  • Guest
    Look up, Read, Set Seen Flag rights
  • User
    All rights except for “Create”, “Delete”, and “Administrator”
  • Power User
    All rights except “Administrator”
  • Administrator Full rights
    All rights

Advanced Permissions

More detailed permissions can be assigned by selecting the “Advanced” button.

Figure 37 – Outlook Connector – Folder Permissions Dialog Window


Figure 38 – Outlook Connector – Advanced Permissions

Each of the listed permissions can be set independently giving more granular control over folder sharing permissions.

Permissions

Description

Lookup

The user may see that the folder exists.

Read

The user may read the folder. The user may also select the folder, fetch data, perform searches, and copy messages from the folder.

Set Seen Flag

Keep, per-user, seen state. The “Seen” and “Recent” flags are preserved for the user.

Write

The user may modify flags and keywords other than “Seen” and “Deleted” (which are controlled by other sets of rights).

Insert

The user may insert new messages into the folder.

Post

A user may send a message to the folder. This right differs from the “Insert” right in that the delivery system inserts trace information into submitted messages so that you can filter address by user name, IP address or HTTP requests.

Create Folders

The user may create, delete or rename folders.

Delete Messages

The user may set a message as “Deleted” or permanently delete mail.

Delete Folders

The user may delete folder.

Perform Expunge

User can permanently expunge deleted messages from the folder.

Administrator

The user may change all the permissions on the folders.

Table 1

Folder Type

The “Folder Type” button gives the user the ability to select a specific “type” for any IMAP folder except for Inbox, Outbox, Deleted Items and Sent.


Figure 39 – Outlook Connector – Folder Type

This feature becomes useful if a user wants to create a second calendar to share with others rather than their standard calendar.

3.2.2 Refresh Folders

The “Refresh Folders” button refreshes the folder tree as seen when you press Alt + F1 (navigation pane). When pressed, the Outlook Connector actually scans each folder, not for contents but for the folders themselves. If folder changes are made on the server or if folders are shared to you from someone else, you would use the “Refresh Folders” to display those changes in Outlook.


Figure 40 – Outlook Connector – Refresh Folders

 

Note: The “Refresh Folders” button does not retrieve emails; it refreshes the IMAP folder tree only.

3.2.3 Account

Outlook Connector Account Settings

Figure 41 – Outlook Connector Account


Figure 42 – Outlook Connector – Settings Dialog Window

The Outlook Connector Settings dialog window will be displayed first when selecting “Account” from the Outlook Connector toolbar. All of the information displayed on this screen is entered and configured during the Outlook Connector installation process. Changes can be made to this information as needed.

3.2.4 More Settings

To learn more about the additional settings which are available for configuration, click on the “More Settings…” button.

Across the top of this new window, you will see eight tabs:
General, Connections, Download, Folders, Send/Receive, Other Settings, Format, and About.

3.2.4.1 General


Figure 43– Outlook Connector – More Settings – Connections IMAP

The General tab has two input fields. The first one is already filled in with a default value – “Insight Server Folders”. This is the name that will appear as the display name for “Outlook Today”. This is a user-defined field and can be changed.

The second field is labeled “Other User Information”. It is optional and has no effect on the functionality of the software. This is also a user-defined field.

 

3.2.4.2 Connections

The Connections tab is where IMAP, SMTP, LDAP and Timeout settings are configured.

IMAP

Figure 44 – Outlook Connector – More Settings – Connections IMAP

Incoming Server (IMAP)

  • Server name
    This is the IMAP server name that was entered during installation; it can be changed if needed.
  • Port
    By default, Bynari Server uses port 143.
  • Username
    This is the user name that was entered during installation; it can be changed if needed.
  • Password
    This is the password that was entered during installation; it can be changed if needed.
  • Do not use secure connection
    Default configuration is to not use a secure connection.
  • Use secured connection (SSL)
    Select this option if your server supports IMAP SSL. When selecting this option, the default port of 143 changes to port to 993. This value can be changed manually, if needed.
  • Use Transport Layer Security (TLS)
    Make sure that your server supports TLS before selecting this option. TLS provides endpoint encryption. This protocol allows all communication, including passwords, to be encrypted. TLS is the preferred and most secured method of SSL.
  • Use Persistent Connection
    The default and recommended selection is enabled.
    Important Information: Disabling the use of persistent connections will negatively affect the performance of the Outlook Connector. Persistent connections, also known as “keep alive” connections, reuse the same TCP connection for sending and receiving. This streamlines requests, reduces network traffic, network latency, CPU utilization and memory needs as it requires fewer resources.
  • Test IMAP Settings
    Click this button to test the new IMAP settings.

SMTP

Figure 45 – Outlook Connector – More Settings – Connections IMAP

Outgoing Server (SMTP):

  • Server name
    This is the SMTP server name that was entered during installation; it can be changed if needed.
  • Port
    By default, the Bynari Server uses port 25
  • Do not use secure connection
    Default configuration is to not use a secure connection.
  • Use secured connection (SSL)
    Select this option if your server supports IMAP SSL. When selecting this option, the default port of 143 changes to port to 993. This value can be changed manually, if needed.
  • Use Transport Layer Security (TLS)
    Make sure your server supports TLS before selecting this option. TLS provides endpoint encryption. This protocol allows all communication, including passwords, to be encrypted. TLS is the preferred and most secured method of SSL.

SMTP Authentication:

  • SMTP server requires Authentication
    Note: SMTP Authentication is sent in plain text. To encrypt the user ID and password – enable, “Use Transaction Layer Security (TLS)”.
  • Use Same Authentication as Incoming Server
    This uses your email username and password that you entered when you setup the account.
  • Use SMTP Authentication
    This option is used when sending email from an SMTP server that is not part of the normal mail server network. i.e. an external address or a remote user. Enabling this feature tells the client to authenticate with the server to relay messages to external domains.
  • Test SMTP Settings
    Click this button to test the new SMTP settings.

 

LDAP

Figure 46 – Outlook Connector – More Settings – Connections – LDAP

Note: The LDAP default options are configured for optimal use with Address Book 3.0 and Insight Server 4.3.

 

The Lightweight Directory Access Protocol or LDAP is an application protocol for querying and modifying directory services running over TCP/IP.

An LDAP directory is a set of objects with attributes organized in a logical and hierarchical manner. An example of LDAP could be an address book that consists of names organized alphabetically. Each name in the address book would have a corresponding email address and telephone number.

LDAP shared folder name resolution enables the Outlook Connector to display “actual names” instead of “user names” for shared IMAP folders.

  • Use LDAP to resolve shared folder names
    Place checkmark if you have an LDAP server.

LDAP Server (LDAP):

  • Server name
    This is the LDAP server name that was entered during installation; it can be changed if needed.
  • Port
    By default, the Bynari Server uses port 389.
  • Use SSL
    Select this option if your LDAP server supports IMAP Secured Socket Layer protocol.
  • Anonymous Login
    Select this if your LDAP server allows anonymous binds (anonymous searches).
  • User DN
    The User DN (Distinguished Name) is comprised of a unique identifier for the user and the domain container; the unique identifier is the container “cn=” in the LDAP database followed by the domain or organizational information.

Note: If you are using Insight Server, users can find their own “User DN” information. Log into the web management console as a user, then click on:

    1. Preferences > “Client Configuration”
    2. “Directory Server Account”, locate the field, “Account Name”.

Bynari Collaboration Server users must contact their administrator to retrieve the User DN.

An example DN might be: “cn=testuser1,o=example.net”

If you are not running the Bynari Server or Insight Server, please consult your LDAP administrator for your DN.

  • Use Incoming Server (IMAP) Password
    This uses the IMAP password from the Connections > IMAP field.
  • Password
    This is your password to the LDAP server.
  • Remember Password
    Remember the password so that you do not have to enter it every time it accesses the LDAP server.
  • Test LDAP Settings
    Click this button to test the new LDAP settings.

 

LDAP Advanced options

Figure 47 – Outlook Connector – More Settings – Connections – LDAP – Advanced Settings

 

Searching Options

  • Sort returned results by:

This option sorts the LDAP results by:

  • First Name
  • Last Name
  • Display Name
  • Email Address
  • Display all results in a single container (deep search)

Toggling this option will allow for custom LDAP searches to group level.

  • LDAP Filter for Users:

This option defines the LDAP attribute for users.

  • LDAP Filter for Groups:

This option defines the LDAP attribute for groups.

  • LDAP Search Attributes:

The criteria used in the search attribute can be changed to meet your LDAP structural needs. This information can be found with the user’s container name or unique identifier in the LDAP database. An LDAP browser can quickly display these parameters. In this example, the data refers to the following information:

  • cn = Container name. Typically this is the user’s full name.
  • mail = User’s mail address.
  • givenName = Typically, this is the first name of a user.
  • sn = Surname or last name.

Base DN

  • The top level of the LDAP directory tree is the base, referred to as the “base DN”.
  • By default Outlook Connector attempts to determine your LDAP base DN by your User DN, which you specified on the Connections > LDAP tab. Consult with your LDAP administrator for your DN if the Base DN was not determined automatically.

LDAP Server Version

  • Select LDAP version

Manually select version 2 or LDAP version 3.

  • Detect

This button will attempt to get the LDAP server version automatically.

LDAP attributes

Figure 48 – Outlook Connector – More Settings – Connections – LDAP – Advanced Settings – LDAP Attributes

The value of these attributes is used to perform the searches against the LDAP database. These are comma delimited and can be changed depending on your setup.

  • User Attributes
    The user attribute will search against “login” then “uid”.
  • User ID
    The user id attribute will search against the “login” attribute.
  • First Name
    The first name attribute will search against “givenName”.
  • Last Name
    The last name attribute will search against “sn”.
  • Display Name
    The display name attribute will search against “display-name”, “displayName”, and then “cn”.
  • E-mail Address
    The e-mail address attribute will search against “mail”.

 

Others



Figure 49 – Outlook Connector – More Settings – Connections IMAP

Timeout Setting

  • Server timeout value in number of seconds.
    The Timeout Setting tells the server how long to wait before it closes the session. The default value is “0”. Acceptable values are: “0”, “30-600” seconds. In a corporate environment where the user is on the same network as the mail server, a timeout value of “0” may be adequate.Users on a Wide Area Network (WAN) need to consider larger timeout settings. Setting this value is dependent on your Internet connection speeds. If you are on a dial-up connection, you may want to set this value to 600 seconds whereas if you are on a DSL connection or cable modem connection, 60 seconds may be acceptable.Having a value too low can cause uploading issues when sending large attachments where the Internet upload speeds are usually slow.
  • Auto Registration Port
    Auto registration is disabled by default. This option allows Outlook Connector to verify licensing with their local Insight Server or Bynari Server. If you do not use the Bynari Server or Insight Server, DO NOT enable the Auto Registration Port Checkbox. By default, port 80 is used. This option can be changed depending on your Bynari Server or Insight Server, and your firewall configuration.

    Important Information: The Outlook Connector was designed to function over LAN-based and high speed broadband connections. Many remote users are able to utilize the Outlook Connector as it was designed. For users on poor remote connections, utilizing the Bynari Web Client may be a better option.

 

  • Use SSL
    Use secure socket layer protocol to register.

3.2.4.3 Download


Figure 50 – Outlook Connector – More Settings – Download

 

Download Options

  • Download Headers Only
    Enabled by default, this option improves the performance of the initial synchronization of the emails downloaded for Outlook. It downloads the header only for email messages. When the message is selected for viewing, the entire message is downloaded.

    Note: Tasks, journals, contacts and calendar events are always set for full-content download when selected for viewing.

     

  • Download Contents of Message Only
    Disabled by default, this option downloads the entire message during the synchronization of emails. Attachments are downloaded when the message is selected for viewing.
  • Download Contents of Message and Attachments
    Disabled by default, this option downloads the entire message and associated attachments during the synchronization of emails.
  • Download All Attachments
    This option will download all attachments.
  • Download Attachment Limit
    This option will set the download attachment limit size in bytes. Any value is accepted in this field. The default is 50,000 bytes.

Download Message progress

  • Show progress indicator when loading messages
    When this box is checked, a progress indicator will appear when synchronizing any folder with more than 50 messages. This option is checked by default.
  • Indicator threshold (number of messages)
    This option allows you to modify when the indicator will appear. By default, this value is set to 50 messages, adjusting this to zero will display the indicator for every message.

3.2.4.4 Folders


Figure 51 – Outlook Connector – More Settings – Folders

Folder Type

  • Use ACL to set folder types
    Enabled by default, it allows the Outlook Connector to use custom IMAP folder ACLs to specify the specialized folder types used by Outlook. These are “Calendar”, “Contact”, “Task”, “Journal”, “Notes“, and “Mail”. This option increases performance since the Outlook Connector no longer has to locate a hidden synchronization message to determine a given folder’s type.

Folder List

  • Show All Folders
    This is enabled by default and tells the Outlook Connector to automatically subscribe to all folders found under the user’s folder list.
  • Show Only Subscribed Folders
    In large environments, the default value of “Show All Folders” may not be desirable. This option allows the users to individually select only the folders they want to see in Outlook.
Important Information: When manually selecting folders, make sure that default folders are checked. i.e. Calendar, Contacts, Deleted Items, Sent Items, Outbox and Tasks. If you uncheck them, it will cause Outlook to recreate them on the IMAP server. This is a default behavior of Outlook.

 

3.2.4.5 Send/Receive


Figure 52 – Outlook Connector – More Settings – Send/Receive

Outlook Connector utilizes IMAP IDLE to update the Inbox folder. For servers that do not support IMAP IDLE make sure that the Inbox folder is selected.

 

3.2.4.6 Other Settings


Figure 53 – Outlook Connector – More Settings – Miscellaneous

The Other Settings tab contains two sections; one for read receipt request options and the second for local cache options.

Message Receipt Options

How would you like to respond to requests for read receipts on incoming messages?

  • Prompt me before sending a response
    This option is the default setting. This setting “prompts” the user to choose between sending a read receipt or not.
  • Always send a response [default selection]
    This option automatically sends a response to the sender of a read receipt request.
  • Never send a response
    This option never sends a response to a read request sender.

Local Cache Options

Store local message cache in the following directory:

  • Default Location
    The default location for the local cache is:Windows XP:
    C:\Documents and Settings\[user name]\Local Settings\Application Data\Bynari\Outlook Connector 4.0\Accounts\[Outlook profile name]\[email address]\Windows 7:
    C:\Users\[user name]\AppData\Local\Bynari\Outlook Connector 4.0\Accounts\[Outlook profile name]\[email address]\The name of the local cache file is: LocalCache.ost
  • Custom Location
    This option allows you to change the location of the local cache. This enables the administrator to place the local cache on the network through a network share for user data backup if needed.

    Note: Read, Write, Delete and Change permissions within Microsoft Windows are required for any Custom Location.
    Note: Any changes made to the location of the local cache will require a restart of Outlook. If you do not restart Outlook, you may see errors, because the Outlook Connector must create the LocalCache.pst file.

 

3.2.4.7 Format


Figure 54 – Outlook Connector – More Settings – Format

Message Format Options

Note: “Use Kolab Format” option is available in the Kolab version of Outlook Connector 4.0.
  • Use Microsoft Message Format
    This is also known as “.tnef” formatting which stands for Transport Neutral Encapsulation Format. This allows files to contain rich text formatting used by e-mail messages, such as bold, italics, underlining, etc…
  • Use iCal Format
    This option is turned on by default in the “ical” or “iCalender” format version of Outlook Connector. iCalendar is a file format which allows sending meeting requests and tasks to other internet users via email or sharing files with an .ics extension.“iCal” format is significantly smaller than the “.tnef” format which can improve performance and save disk space.

    Note: If you use a Kolab server or an iCalendar compatible server, you may not need to select “Use Microsoft Message Format”. If you are unsure, it is best to select both options.
  • Use Kolab Format
    Use this option only if you are running a Bynari Collaborator Server or Kolab IMAP server. Kolab uses a unique XML format attached to email specifically for Kolab groupware servers. The XML holds information for contacts, calendar events, journals, etc.

 

3.2.4.8 Logging


Figure 55 – Outlook Connector – More Settings – Logging

Logging capabilities have been added to the Outlook Connector as a troubleshooting aid. By default, all logging is off. Log files can consume large amounts of disk space, and it is recommended that logging be left off, unless the user is experiencing problems.

When working with Bynari Technical Support on an issue, they may request that you enable logging. Verbose logging is the most thorough level of logging offered and will offer the most insight to the support technician.

 

3.2.4.9 About


Figure 56 – Outlook Connector – More Settings – About

About tab

The about tab provides information about the Outlook Connector. It contains the version number as well as all licensing information.

3.2.5 Quota

Used to display the user’s current quota status.

Figure 57 – Outlook Connector – Toolbar Quota button


Figure 58 – Outlook Connector Quota

3.2.6 About


Figure 59 – Outlook Connector – About

The “About” button on the Outlook Connector toolbar performs the same function as the “About” tab discussed above in section 2.5.4.9.

4 Using Outlook Connector

Outlook Connector 4.0 provides Outlook with a MAPI transport service that makes connecting to an IMAP server transparent to the end user. The following sections describe some of the additional dialogs introduced by the Connector such as Folder permissions as well as documenting configuration changes needed for features such as Free/Busy.

4.1 Viewing Shared Folders

Note: Private events (calendar, contacts, and tasks) are stored on the server. Only the folder owner will see private events.

Other users’ shared folders will appear under ‘Other Users’ in the folder list.


Figure 61 – “Other Users” shared folder list

Public folders created on the Bynari Server and Insight Server will display under ‘Shared Folders’ in Outlook.

 


Figure 62 – “Shared Folders” public folder list

 

Note: Upgrade your Insight Server to at least 4.2.2 to support private events.

4.2 Free/Busy Configuration

Outlook allows users to share free/busy information from their calendars with other users on their mail server. With the Microsoft Office Internet Free/Busy Service, users can publish their free/busy times to a shared Internet location. Members using this service can view each other’s free/busy information when viewing shared calendars or creating meeting requests.


Configure Free/Busy

  • Open Options in Outlook
    On the Outlook Toolbar, select Tools > Options.

    Figure 63 – Outlook Tools, Options
  • This opens a new window; select the Preferences option tab.

Options – Preferences

  • Click on “Calendar Options…”

    Figure 64 Tools Options

Calendar Options – Advanced options


Figure 65 – Tools – Options – Calendar Options

Note:When sending meeting requests over the Internet, use iCalendar format” option will likely be grayed out. This is normal.

 

  • Enable alternate calendar
    Select this option if you wish to enable an alternate calendar.
  • Click on “Free/Busy Options…”
    Select to change the Free/Busy Options.

 

Free/Busy Options

Figure 66 – Tools – Options – Calendar Options Free/Busy Options

Options

  • Publish “2” month(s) of Calendar free/busy information the server
    Enter the number of months of Free/Busy information to be published.The default interval is 2 months. This value represents the number of months from today’s date.
  • Update free/busy information on the sever every “15” minutes
    The default time is every 15 minutes. This value represents how often Outlook will update the user’s Free/Busy information on the server.

Internet Free/Busy

  • Publish at my location
    This option must be checked. In figure 66, a path name is shown. Insert your information in place of the variables, “%NAME%.vcf”.

    Note: If you are using Insight Server 4.3, use the below example by changing the server name and replacing %NAME% with your username.ftp://mail.example.net/freebusy/%NAME%.vcf
  • Search location
    Enter the URL for the shared free/busy search location.

    Note: If you are using Insight Server 4.3, use the below example by changing the server name and replacing %NAME% with your username.http://mail.example.net/freebusy/%NAME%.vcf
  • Click “OK” to apply the Free/Busy settings.

4.3 Show / Hide Toolbar

  • Toggle toolbar display

On the Outlook Toolbar, select View > Toolbars > Outlook Connector 4.0.

It places a check mark next to the name to show that the Connector is enabled.



Figure 67 Show/Hide Outlook Connector Toolbar

If you have hidden the Outlook Connector toolbar at the time of the installation, you can show the toolbar by following the above steps.

5 Registering and Unregistering Outlook Connector

Outlook Connector 4.0 is configured to use auto registration by default when “Insight Server” is selected during installation. Auto registration is designed for users of both the Outlook Connector and Insight Server or the Bynari Server. With auto registration enabled, the Outlook Connector will verify that an active license exists for the client when Outlook starts. It is recommended that users of the Insight Server or the Bynari Server utilize this feature of the Outlook Connector.

If you do not have an Insight Server or Bynari Server, or do not wish to use auto registration, you can register your copy of the Outlook Connector using the About tab of the Outlook Connector toolbar.

5.1 Auto Registration

Enable or disable auto registration

  • Click on the “Account” tab in Outlook Connector toolbar.


Figure 68 – Outlook Connector – Account

  • Select “Connections” > “Others”.


Figure 69 Outlook Connector – More Settings – Connections – IMAP

 

Important Information: Do not enable auto registration if you do not use the Insight Server or Bynari Collaborator Server (BCS).

 

  • Auto Registration Port
    Auto registration is either enabled or disabled depending on your Insight Server selection during installation. This option allows Outlook Connector to verify licensing with a local Bynari Server or Insight Server. By default, port 80 is used. This option can be changed depending on your Bynari Server or Insight Server, and your firewall configuration.
  • Use SSL
    Use secure socket layer protocol to register.

    Troubleshooting Tip: If you are experiencing trouble registering the connector and your server does not support auto-registration, make sure that the “Auto Registration Port” option is NOT checked. This option is being deprecated in future versions of the connector.

5.2 Register Outlook Connector

  • Click on “About” in the Outlook Connector Toolbar.

    Figure 70 – Outlook Connector About

 

  • Click on “License”.

    Figure 71 About
    Figure 682 Key Support button
  • Enter your product license key
    Copy/Paste your license key in the space provided.
  • Manual Registration
    See section “manual registration” below.
  • Enter the license certificate below:
    This is only used during manual registration.
  • Which port would you like to use for the registration?
    Bynari license key server listens on ports 80 and 3080. If port 80 is blocked, port 3080 can be used as an alternate port.

    Note: The license key server URL is http://update.bynari.net.
    Note: If you encounter any issues while activating your Outlook Connector license, ping the license key server to verify proper internet connectivity.
  • Click “OK” to register Outlook Connector.

Manual Registration

  • Enter your product license key
    Copy/Paste your license key in the space provided.
  • Manual Registration
    Contact Bynari Support at support@bynari.net and request a manual license certificate.
  • Enter the license certificate below:
    Paste entire certificate in the space provided. (See manual certificate example.)

    Figure 693 – Manual certificate example

    Figure 684 – Manually entering the information
  • Click “OK” to complete manual registration.

5.3 Registration Complete

  • After registering over the internet or manually, you should see the following screen.

    Figure 715 Manually entering the information

Outlook Connector License Information

  • License Key
    This is the license key used to register Outlook Connector.
  • License Expire
    This will display when your license expires.
  • Support Expires
    This option will show the date Bynari support expires.
  • Number of Licenses Used
    This displays the number of licenses used vs. the number of licenses that you have purchased.
  • Total License Available
    This displays the number of licenses available or purchased.
  • Supported Versions
    The Connector version supported for this license key.
  • Supported Options
    Formats that are supported such as iCal or Kolab are listed.

Click “Refresh” to update dialog screen for license information.

5.4 Unregister Outlook Connector

  • Click on “About” on the Outlook Connector Toolbar.
  • Click on “License”.

    Figure 726 – Connector License information
  • Click on “Unregister”.
    This will unregister Outlook Connector from your computer.



6 Reporting Problems

When reporting problems, be sure to include the following information:

  • Microsoft Windows version number and patch level.
    • Right click on “My Computer” icon on the Desktop and select Properties. The Windows version and patch level will be listed under System: in the General tab dialog.
  • Microsoft Outlook version and patch level.
    • Right click on Help in Outlook and select About Microsoft Outlook. The Outlook version and patch level will be listed.
  • The full version number of the Outlook Connector.
    • Click “About” on the Connector toolbar. The connector version and build number (4.Y-XXXX) will be listed.

 

To contact technical support:

U.S. Toll Free Telephone: 1-800-241-1086
International Telephone: 001-214-350-5772

To open a new support ticket email: support@bynari.net

For FAQs: http://www.bynari.net/users/kb.php

Bynari Outlook Connector

User’s Guide

Trademarks

 

Bynari products are trademarks of Bynari, Inc.

 

Microsoft Windows, Windows Mobile, Outlook, Windows XP, Windows Vista are all registered trademarks of Microsoft Corporation in the United States, other countries, or both.

 

BlackBerry is a registered trademark of Research In Motion Limited in the United States, other countries, or both.

All other trademarks are the property of their respective owners.

Technical Support

 

When you purchase any of Bynari’s products, the products include one year of free support and maintenance. To purchase additional yearly support and maintenance, please contact sales@bynari.net.

 

Customers who are current on support receive one year of product maintenance, upgrades and email and/or telephone matching the purchased support package.

Support is available to customers worldwide.

To contact technical support:

U.S. Toll Free Telephone: 1-800-241-1086
International Telephone: 001-214-350-5772

To open a new support ticket email: support@bynari.net.

For FAQs: http://www.bynari.net/users/kb.php

Licensing

The Outlook Connector utilizes a licensing key system that assigns and stores the number of licenses that have been purchased by the customer. When Outlook starts, Outlook Connector (OC) will either contact the patched version of Insight Server 4.3, which allows auto-registration with OC 4.0, or Server 4.4. If you are using a 3rd party server, it will contact the Bynari license key server over the Internet to validate and activate the installed license. Activation will be attempted each time Outlook is started or until activation of the license is successful.

Note: The license key server URL is http://update.bynari.net.

 

If you encounter any issues while activating your Outlook Connector license, please see below for a possible solution:

  • The client systems may be blocked from accessing the Internet, or Internet access is temporarily unavailable.
  • The license key entered during the installation of the Outlook Connector may be invalid. This could include issues such as an incorrect key or incorrect key version.
  • The number of client licenses has been exceeded. The Bynari Key Server tracks how many systems have been activated using a given license. If the number of activated clients exceeds the total for the license, the Outlook Connector will inform you that additional licenses need to be purchased.
  • If you need to reinstall the Outlook Connector software on a new system due to either hardware failure or system upgrade and need to unregister, do the following (See section 4.3 for complete details):
    • Open Outlook
    • Click on “About” tab in the Outlook Connector toolbar
    • Click on “License”
    • Click on “Unregister”

If you experience problems with license activation, please contact your reseller or Bynari support at support@bynari.net.

Important Notes:

  • This documentation applies to the latest 4.0 build of the Outlook Connector available from Bynari.
  • Make sure that Outlook is setup as the default e-mail client. To verify this on the workstation, go to Control Panel > Internet Options > Programs and make sure that Outlook is selected in the drop down box next to E-mail.
  • Outlook Connector 4.0 has been tested with Bynari Server, Univention Corporate Server, Insight Server, and Bynari Collaboration Server, Cyrus, and Kolab IMAPv4 servers. Outlook Connector supports all base specifications as described in RFC 3501: Internet Message Access Protocol version 4rev1. If your IMAPv4 server supports the specifications in RFC 3501, Outlook Connector 4.0 may be compatible with your server. If you encounter issues with a different type of unsupported server, email support at support@bynari.net to create a support ticket. The Bynari support team will provide a reasonable effort in working with you.

 

Table of Contents



1 Outlook Connector version 4.0

The Outlook Connector acts as a MAPI transport for Microsoft Outlook. As a MAPI transport provider, the Connector interprets all the different types of folders used by Outlook.

When Outlook Connector is used in conjunction with the Bynari Server or Insight Server, a powerful collaboration environment is created. Users are able to share mail folders, contacts, tasks, and calendars with other individuals. Public folders of each type can also be created and maintained by system administrators through the web admin interface. All of these functions are supported through the familiar Outlook interface eliminating any need for costly end user training.

1.1 Architecture

Messaging Application Programming Interface or MAPI has two major components. Applications such as Microsoft Outlook use the client side interface to contact the MAPI subsystem for all communications with the message store. There is also a service interface which is used by programs such as Outlook Connector to provide the MAPI transport services for accessing the message store on the server.

Outlook Connector acts as the transport that provides messaging services directly to the MAPI subsystem and stores this information on Insight Server and Bynari Server via the IMAP protocol.

 

Figure 1 – MAPI Architecture

1.2 Features of Outlook Connector

Outlook Connector 4.0 offers the following features:

  • Native MAPI implementation
  • Mobile sync with Windows Mobile device
  • Mobile sync with Blackberry Mobile device
  • Mobile sync of contacts with iPhone
  • Support for new Microsoft PST architecture enables files larger than 2G
  • Simple click-and-go installation and configuration
  • SSL secure connection support
  • Mail, Calendar, Contacts, Journal, Notes and Task folder support
  • Native Outlook calendar functions
  • Free/Busy support
  • Shared folders including Calendars, Contacts, Tasks, Journals, Notes and Mail
  • Contact Distribution Lists
  • Outlook Rules Wizard
  • Read receipts
  • IMAP folder subscriptions
  • Shared access controls
  • Header only download
  • Offline support
  • Grouping
  • Multiple user accounts
  • Voting Buttons
  • Native iCalendar and vCard format support
  • IMAP IDLE support
  • Mailbox quotas
  • Ability to re-download messages
  • And more …

1.3 Supported Platforms

Outlook Connector 4.0 is compatible with the following software. If you are using a version that is not listed, or software that is not supported, upgrade to a supported version.

Supported Windows®Versions

Windows® XP

Windows® Vista

Windows® 7

Supported Outlook® Versions

Outlook® 2003

Outlook® 2007

Outlook® 2010 (32/64 bit)

Supported Languages

  • English
  • French
  • German
  • Italian
  • Spanish (Spain)
  • Portuguese (Brazil)
  • Dutch
  • Norwegian
  • Russian
  • Swedish
  • Taiwanese/Chinese
  • Czech
  • Hebrew
Note: Other languages are provided and may be used but are not formally supported. Problems with translation, spelling, grammar and proper character encoding may be encountered.

 

1.4 Supported IMAP Servers

  • Bynari Collaboration Server
  • Insight Server
  • Cyrus
  • Kolab

1.5 Supported mobility devices and software

Outlook Connector 4.0 includes mobility support for several devices including Blackberry, iPhone and Windows Mobile. The following versions are compatible with Outlook Connector 4.0.

1.6 Known Limitations

  • Microsoft Business Contact Manager is not compatible with Outlook Connector.
  • Smart Phone synchronization is dependent on the hardware and the software provider.
  • Slashes in folder names are not allowed.

2 Installation

2.1 Preparing Your System (Pre-Installation)

Before you begin:

The Connector 4.0 software must be installed by the Windows login user. Additionally, this user needs “administrator” rights to install the software. The users’ rights can be changed to install the Connector and then reset to the original rights.

Before you begin the installation procedure, perform the following steps:

Step 1: Install Microsoft® Windows and/or Microsoft® Outlook

Supported Windows® Versions

Windows® XP

Windows® Vista

Windows® 7

 

Supported Outlook® Versions

Outlook® 2003 SP3+

Outlook® 2007 SP2+

Outlook® 2010 SP1+

Note: If you are using versions that are not listed, upgrade to a supported version.

Step 2: Install the Latest Updates for Microsoft® Windows and Outlook

Go to the Microsoft® website or check with your IT Administrator to verify that you have installed the most current critical updates and service packs for both your Windows operating system and Outlook.

http://update.microsoft.com – Microsoft® updates.

Outlook 2003 minimum required version to install

  • Click on “Help” > “About Microsoft Office Outlook”


Figure 2 – Outlook 2003 about dialog

Outlook 2007 minimum required version to install

  • Click on “Help” > “About Microsoft Office Outlook”


Figure 3 – Outlook 2007 about dialog

Outlook 2010 minimum required version to install

  • Click on “Help” > “About” and then click on “Additional Version and Copyright Information”


Figure 2.3 – Outlook 2010 about dialog

Step 3: Backup “Rules and Alerts”

Outlook “Rules and Alerts” functions are used to organize incoming email. These functions allow users to set custom “actions” that will be performed automatically on incoming messages.

Important Information: “Rules and Alerts” will not transfer during new installation of Outlook Connector 4.x or when upgrading from Outlook Connector 3.x to 4.x. “Rules and Alerts” are stored locally on your computer. They are not uploaded to the server.

 

Export “Rules and Alerts”

  1. Open Outlook
  2. Click on “Tools” > “Rules and Alerts…”


Figure 4 –Installation – Tools – Rules and Alerts

  1. Under the “E-mail Rules” tab, click on “Options”.


Figure 5 –Installation – Tools – Rules and Alerts

  1. Under the “Import and export” area, click on the “Export Rules…” button.


Figure 6 –Installation – Tools – Rules and Alerts – Options

  1. Type a new name for the rules or keep the default.


Figure 7 –Installation – Tools – Rules and Alerts – Save Exported Rules as

  1. Click “Save”.
  2. Click “OK” to remove all dialog windows.
  3. Close Outlook to continue installing or updating Outlook Connector 4.0.

 

Note: In order to ensure proper Rules and Alerts functionality in Microsoft Outlook a check must be placed in the “Schedule an automatic send/receive every” checkbox under Tools>Options>Mail Setup>Send/Receive. Any amount of time may be specified in the associated “minutes” field.

 

2.2 Installing Outlook Connector – New Installation

The 4.0 Outlook Connector Install Wizard standardizes the installation process for Outlook.

The following section explains how to install the Outlook Connector 4.0 for the first time on a computer. The “upgrade” process is slightly different and available in the section 2.4 of this manual.

Note: The Outlook Connector will only install on systems where the user has “administrative” rights. The users’ rights can be changed to install the Outlook Connector and then reset to the original rights after the installation has completed.

 

Important Information: In some cases, virus scanning add-ins for Outlook may need to be disabled for the installation of the Outlook Connector. Disabling the virus scanning Outlook add-in should not change the functionality of your antivirus software.

 

Before you begin:

  1. Verify that all steps in “Preparing Your System” (Pre-installation) section 2.1 are complete.
  2. Unzip the Outlook Connector 4.0 compressed file by right-clicking and selecting “Extract All”.


Figure 8 – Installation – Downloaded zipped Outlook Connector

  1. Double Click on the installer.


Figure 9 – Installation Outlook Connector Installer Package

NOTE: For Windows Vista and Windows 7, you must run the installer as “Run as Administrator” to install Outlook Connector properly.

  1. Welcome Dialog:
    Double click the installation setup file to start installation. The setup wizard will display the “Welcome Dialog” window. Select “Next” to continue with the installation process.


Figure 10 – Installation Outlook Connector welcome dialog Setup Wizard

  1. End User License Agreement:
    Read the license agreement. If you agree, select the button, “I accept the license agreement” and select “Next”.
  2. Create New Outlook Profile:
    The Outlook Connector will automatically create a profile for Outlook. The default name for this profile is “Outlook Connector”. The “default name” is a user defined field and may be changed if needed. Place a check in the box labeled, “Prompt for which profile to use when starting Outlook (Recommended)”, if you have multiple profiles in Outlook. Selecting this will prompt for profile selection when Outlook starts. Click “Next” to continue installation.


Figure 11 – Installation Outlook Connector Create New Profile

  1. Account Information:
    This screen provides the Outlook Connector with the information needed to create the Outlook profile for your email account during the installation process.
    The following basic information is needed to complete this screen:

    • Your Name
    • E-mail Address
    • IMAP Server Address
    • SMTP Server Address
    • Username
    • Password


Figure 12 – Outlook Connector – Account Information

Note: Bynari Collaboration Server requires the entire email address to be used as the “username”. Insight Server only used the first part of the email address, leaving off “@domain.com”.
    • Fill in requested information.
    • Click “Next” to continue.
  1. Select Destination Location:
    The default installation destination for the Outlook Connector is:
    C:\Program Files\Bynari, Inc\InsightConnector.

A custom installation location may be used. Select the “Browse” button to choose an alternate location to install the Outlook Connector. Click “Next” to continue the installation.

Figure 13 – Outlook Connector – Select Destination Location

  1. Outlook Connector Toolbar Options:
    By default, the Outlook Connector Toolbar is configured to be displayed. Displaying the toolbar is the recommended configuration. Select “Yes” to hide the Outlook Connector toolbar. Click “Next” to continue.


Figure 14 – Outlook Connector – Display Toolbar

  1. Ready to Install:
    Review configuration settings and select “Install” to install the Outlook Connector. Click “Next” to continue the installation.


Figure 16 – Outlook Connector – Ready to Install

  1. Setup Complete:
    To automatically start Outlook, place a check in the box labeled “Run Outlook” and select “Finish”.


Figure 17 – Outlook Connector – Finish Install Wizard

 

2.3 Installing Outlook Connector – Upgrade

Upgrading the Outlook Connector is similar to the steps discussed under “Installing Outlook Connector – New Installation” in section 2.1.

In the upgrade process, no profile will be created and all of the original user data from the previous installation of the Outlook Connector is used. The Outlook Connector will automatically upgrade profiles from earlier Outlook Connector versions. Outlook Connector 3.x used a “local cache” data storage system while the Outlook Connector 4 uses a Microsoft PST file to store data.

When upgrading from any of the Outlook Connector 3.x versions, your profile will be upgraded to the new PST architecture. The Outlook Connector will need to perform an initial synchronization after the upgrade process completes.

Important Information: During the initial synchronization process, the Connector will download the newest emails first, and then it will continue to synchronize in the background. This allows the end-user to begin using Outlook immediately while synchronization continues.

 

Note: The Connector installer will automatically determine if your profile needs to be upgraded.

 

Before you begin:

  1. Verify that all steps in “Preparing Your System” (Pre-installation) section 2.1 are complete.
  2. Unzip the Outlook Connector 4.0 compressed file by right-clicking and selecting “Extract All”.


Figure 18 –Installation – Downloaded zipped Outlook Connector

  1. Double Click on the installer to start the installation process.


Figure 19 – Installation Outlook Connector – Installer Package

 

  1. Welcome Dialog:

Double click the installation setup file. The setup wizard will display the “Welcome Dialog” window. Select “Next” to continue with the installation.


Figure 20 – Installation – Outlook Connector welcome dialog – Setup Wizard

  1. End User License Agreement:

Accept the terms of the End User License Agreement to install the Outlook Connector. If you agree to the terms of the license, select “I accept the agreement” then select “Next” to proceed to the next step.

  1. Profile Upgrade
    If Outlook Connector finds any existing profiles, it will upgrade them to the latest version. Confirm that you would like to continue by selecting “Yes”.


Figure 21 – Outlook Connector – Prompt to upgrade profiles

  1. Select Destination Location:
    The default installation destination for the Outlook Connector is:
    C:\Program Files\Bynari, Inc\InsightConnector.

A custom installation location may be used. Select the “Browse” button to choose an alternate location to install the Outlook Connector. Select “Next” to continue the installation. If the existing installation location is used, the following informational window will be displayed. Select “Yes” to proceed to the next step.

Figure 22 – Outlook Connector – Upgrade Destination Location

  1. Outlook Connector Toolbar Options:
    By default, the Outlook Connector Toolbar is configured to be displayed. Displaying the toolbar is the recommended configuration. Select “Yes” to hide the Outlook Connector toolbar. Click “Next” to continue.


Figure 23 – Outlook Connector – Display Toolbar

  1. Ready to Install:
    Review configuration settings and select “Install” to install the Outlook Connector. Click “Next” to continue the installation.


Figure 24 – Outlook Connector – Ready to Install

  1. Setup Complete:
    To automatically start Outlook, place a check in the box labeled “Run Outlook” and select “Finish”.


Figure 25 – Outlook Connector – Upgrade Complete

2.4 Installation Logs

Error Logging

This feature is only activated during a new installation of the Outlook Connector when a new profile is created. Error logging is not enabled during the upgrade process.

Viewing the Log File

The Outlook Connector generates a log file named “Bynari.log” in the user’s %TEMP% directory during the installation process.

Viewing the Log File:

  1. Select “Start” > “Run”.
  2. Type %TEMP% on the Run input field and select “OK”.
  3. A new explorer window will open displaying the contents of the user’s %TEMP% directory.
  4. Browse this directory for a text file named “Bynari.log”. This file can be viewed with any text editor.

 

Technical Support Logging

The Outlook Connector also offers additional logging capabilities for troubleshooting. These logs are located under: %AppData%\Local\Bynari\Bynari Insight Connector 4.0\

There are both “log” and “trace” directories located here.

To turn on logging, go to the Connector toolbar and click on:

Account > More Settings… > Logging

When working with Bynari Technical Support, “verbose” logging will be required for troubleshooting.

3 Post Installation Configuration

3.1 Import “Rules and Alerts”

Important Information: “Rules and Alerts” will not transfer during new installation of Outlook Connector 4.x or when upgrading from Outlook Connector 3.x to 4.x. “Rules and Alerts” are stored locally on your computer. They are not uploaded to the server.
  1. Open Outlook
  2. Click on “Tools” > “Rules and Alerts…”


Figure 26 –Installation – Tools – Rules and Alerts

  1. Under the “E-mail Rules” tab, click on “Options”.


Figure 27 –Installation – Tools – Rules and Alerts

  1. Under the “Import and export” area, click on the “Import Rules…” button.


Figure 28 –Installation – Tools – Rules and Alerts – Options

  1. Type a new name for the rules or keep the default.


Figure 29 –Installation – Tools – Rules and Alerts – Import Rules from

  1. Click “Open”.
  2. Click “OK” to remove all dialog windows.
  3. Ensure that there is a check in the “Send immediately when connected” (labeled “Automatic Send/Receive” in Outlook 2003) checkbox. The checkbox is located on the “Mail Setup” tab, under “Options”, in the “Tools” menu. This is required in order to ensure proper rules functionality.

3.2 Outlook Connector Toolbar

All custom configuration settings can be made through the Outlook Connector Toolbar.

The Outlook Connector toolbar consists of five buttons:

  • Folder – Used for setting folder Access Control List (ACL) permissions and folder types.
  • Refresh Folders – Used to refresh the Outlook folder tree from the IMAP server.
  • Account – Used to modify account configuration settings.
  • Quota – Used to display the user’s current quota status.
  • About – Displays version number and licensing information.


Figure 30 – Outlook Connector Toolbar

3.2.1 Folder

Selecting the “Folder” button on the Outlook Connector Toolbar will open the “Folder Permissions” dialog window.

Figure 31 – Outlook Connector – Folder


Figure 32 – Outlook Connector – Inbox Folder Permissions

This feature is used to share folders with other users on the same system. It is also used to manage the permissions granted to other users using ACL. Folder types can also be changed.

Sharing Folders

Sharing folders using Outlook Connector 4.0.

Figure 33 – Outlook Connector – Folder sharing

Add New User

    Selecting the “Folder” button opens the “Folder Permissions” dialog window. From the “Folder Permissions” dialog window, additional users can be added by selecting the “Add” button


Figure 34 – Outlook Connector – Add New User

  • Set Specific Permissions
    Enter the appropriate username or full email address.
Note: As is the case with Bynari Collaboration Server, some servers require the entire email address to be used when adding a new user to a folder share while others only require the username. Check with your systems administrator for specific information about your server requirements.
  • Select “OK” to confirm adding the new user’s ACL to the specified folder.

    Figure 35 – Outlook Connector – Add New User

 

  • Search Corporate Directory
    This feature is used to search an LDAP directory to find users. Enter a value to search and then click “search”.In the “Search Results” field, select a user or multiple users by holding the control key and clicking on the listings to add and then click “OK”.
  • “Search by” option
    The pull-down list contains five ACL search settings:

    • Any – Search all fields.
    • First Name – Search by “First Name”
    • Last Name – Search by “Last Name”
    • Display Name – Search by “Display Name”
    • E-mail Address – Search by “E-mail Address”
  • ConfigurationThis button provides quick access to the LDAP configuration settings. See LDAP settings under section 2.5.4.2.
  • Select “OK” to confirm adding the new user’s ACL to the specified folder.

Folder Permissions

Figure 36 – Outlook Connector – Folder Permissions Dialog Window

ACL permissions can be adjusted at any time for every user added in the folder permission’s dialog. Users may only grant ACL permissions if they have been given the administrator permission. ACL permissions may not be changed for either the owner or the administrator of the account.

The main “Folder Permissions” dialog window is now displayed again. The username or email address that was just entered is now displayed in the user dialog box. The default permission given to all new users is “Guest”. This can be modified using the pull-down menu in the “Folder Permissions” dialog window.

The pull-down list contains four preconfigured ACL settings:

  • Guest
    Look up, Read, Set Seen Flag rights
  • User
    All rights except for “Create”, “Delete”, and “Administrator”
  • Power User
    All rights except “Administrator”
  • Administrator Full rights
    All rights

Advanced Permissions

More detailed permissions can be assigned by selecting the “Advanced” button.

Figure 37 – Outlook Connector – Folder Permissions Dialog Window


Figure 38 – Outlook Connector – Advanced Permissions

Each of the listed permissions can be set independently giving more granular control over folder sharing permissions.

Permissions

Description

Lookup

The user may see that the folder exists.

Read

The user may read the folder. The user may also select the folder, fetch data, perform searches, and copy messages from the folder.

Set Seen Flag

Keep, per-user, seen state. The “Seen” and “Recent” flags are preserved for the user.

Write

The user may modify flags and keywords other than “Seen” and “Deleted” (which are controlled by other sets of rights).

Insert

The user may insert new messages into the folder.

Post

A user may send a message to the folder. This right differs from the “Insert” right in that the delivery system inserts trace information into submitted messages so that you can filter address by user name, IP address or HTTP requests.

Create Folders

The user may create, delete or rename folders.

Delete Messages

The user may set a message as “Deleted” or permanently delete mail.

Delete Folders

The user may delete folder.

Perform Expunge

User can permanently expunge deleted messages from the folder.

Administrator

The user may change all the permissions on the folders.

Table 1

Folder Type

The “Folder Type” button gives the user the ability to select a specific “type” for any IMAP folder except for Inbox, Outbox, Deleted Items and Sent.


Figure 39 – Outlook Connector – Folder Type

This feature becomes useful if a user wants to create a second calendar to share with others rather than their standard calendar.

3.2.2 Refresh Folders

The “Refresh Folders” button refreshes the folder tree as seen when you press Alt + F1 (navigation pane). When pressed, the Outlook Connector actually scans each folder, not for contents but for the folders themselves. If folder changes are made on the server or if folders are shared to you from someone else, you would use the “Refresh Folders” to display those changes in Outlook.


Figure 40 – Outlook Connector – Refresh Folders

 

Note: The “Refresh Folders” button does not retrieve emails; it refreshes the IMAP folder tree only.

3.2.3 Account

Outlook Connector Account Settings

Figure 41 – Outlook Connector Account


Figure 42 – Outlook Connector – Settings Dialog Window

The Outlook Connector Settings dialog window will be displayed first when selecting “Account” from the Outlook Connector toolbar. All of the information displayed on this screen is entered and configured during the Outlook Connector installation process. Changes can be made to this information as needed.

3.2.4 More Settings

To learn more about the additional settings which are available for configuration, click on the “More Settings…” button.

Across the top of this new window, you will see eight tabs:
General, Connections, Download, Folders, Send/Receive, Other Settings, Format, and About.

3.2.4.1 General


Figure 43– Outlook Connector – More Settings – Connections IMAP

The General tab has two input fields. The first one is already filled in with a default value – “Insight Server Folders”. This is the name that will appear as the display name for “Outlook Today”. This is a user-defined field and can be changed.

The second field is labeled “Other User Information”. It is optional and has no effect on the functionality of the software. This is also a user-defined field.

 

3.2.4.2 Connections

The Connections tab is where IMAP, SMTP, LDAP and Timeout settings are configured.

IMAP

Figure 44 – Outlook Connector – More Settings – Connections IMAP

Incoming Server (IMAP)

  • Server name
    This is the IMAP server name that was entered during installation; it can be changed if needed.
  • Port
    By default, Bynari Server uses port 143.
  • Username
    This is the user name that was entered during installation; it can be changed if needed.
  • Password
    This is the password that was entered during installation; it can be changed if needed.
  • Do not use secure connection
    Default configuration is to not use a secure connection.
  • Use secured connection (SSL)
    Select this option if your server supports IMAP SSL. When selecting this option, the default port of 143 changes to port to 993. This value can be changed manually, if needed.
  • Use Transport Layer Security (TLS)
    Make sure that your server supports TLS before selecting this option. TLS provides endpoint encryption. This protocol allows all communication, including passwords, to be encrypted. TLS is the preferred and most secured method of SSL.
  • Use Persistent Connection
    The default and recommended selection is enabled.
    Important Information: Disabling the use of persistent connections will negatively affect the performance of the Outlook Connector. Persistent connections, also known as “keep alive” connections, reuse the same TCP connection for sending and receiving. This streamlines requests, reduces network traffic, network latency, CPU utilization and memory needs as it requires fewer resources.
  • Test IMAP Settings
    Click this button to test the new IMAP settings.

SMTP

Figure 45 – Outlook Connector – More Settings – Connections IMAP

Outgoing Server (SMTP):

  • Server name
    This is the SMTP server name that was entered during installation; it can be changed if needed.
  • Port
    By default, the Bynari Server uses port 25
  • Do not use secure connection
    Default configuration is to not use a secure connection.
  • Use secured connection (SSL)
    Select this option if your server supports IMAP SSL. When selecting this option, the default port of 143 changes to port to 993. This value can be changed manually, if needed.
  • Use Transport Layer Security (TLS)
    Make sure your server supports TLS before selecting this option. TLS provides endpoint encryption. This protocol allows all communication, including passwords, to be encrypted. TLS is the preferred and most secured method of SSL.

SMTP Authentication:

  • SMTP server requires Authentication
    Note: SMTP Authentication is sent in plain text. To encrypt the user ID and password – enable, “Use Transaction Layer Security (TLS)”.
  • Use Same Authentication as Incoming Server
    This uses your email username and password that you entered when you setup the account.
  • Use SMTP Authentication
    This option is used when sending email from an SMTP server that is not part of the normal mail server network. i.e. an external address or a remote user. Enabling this feature tells the client to authenticate with the server to relay messages to external domains.
  • Test SMTP Settings
    Click this button to test the new SMTP settings.

 

LDAP

Figure 46 – Outlook Connector – More Settings – Connections – LDAP

Note: The LDAP default options are configured for optimal use with Address Book 3.0 and Insight Server 4.3.

 

The Lightweight Directory Access Protocol or LDAP is an application protocol for querying and modifying directory services running over TCP/IP.

An LDAP directory is a set of objects with attributes organized in a logical and hierarchical manner. An example of LDAP could be an address book that consists of names organized alphabetically. Each name in the address book would have a corresponding email address and telephone number.

LDAP shared folder name resolution enables the Outlook Connector to display “actual names” instead of “user names” for shared IMAP folders.

  • Use LDAP to resolve shared folder names
    Place checkmark if you have an LDAP server.

LDAP Server (LDAP):

  • Server name
    This is the LDAP server name that was entered during installation; it can be changed if needed.
  • Port
    By default, the Bynari Server uses port 389.
  • Use SSL
    Select this option if your LDAP server supports IMAP Secured Socket Layer protocol.
  • Anonymous Login
    Select this if your LDAP server allows anonymous binds (anonymous searches).
  • User DN
    The User DN (Distinguished Name) is comprised of a unique identifier for the user and the domain container; the unique identifier is the container “cn=” in the LDAP database followed by the domain or organizational information.

Note: If you are using Insight Server, users can find their own “User DN” information. Log into the web management console as a user, then click on:

    1. Preferences > “Client Configuration”
    2. “Directory Server Account”, locate the field, “Account Name”.

Bynari Collaboration Server users must contact their administrator to retrieve the User DN.

An example DN might be: “cn=testuser1,o=example.net”

If you are not running the Bynari Server or Insight Server, please consult your LDAP administrator for your DN.

  • Use Incoming Server (IMAP) Password
    This uses the IMAP password from the Connections > IMAP field.
  • Password
    This is your password to the LDAP server.
  • Remember Password
    Remember the password so that you do not have to enter it every time it accesses the LDAP server.
  • Test LDAP Settings
    Click this button to test the new LDAP settings.

 

LDAP Advanced options

Figure 47 – Outlook Connector – More Settings – Connections – LDAP – Advanced Settings

 

Searching Options

  • Sort returned results by:

This option sorts the LDAP results by:

  • First Name
  • Last Name
  • Display Name
  • Email Address
  • Display all results in a single container (deep search)

Toggling this option will allow for custom LDAP searches to group level.

  • LDAP Filter for Users:

This option defines the LDAP attribute for users.

  • LDAP Filter for Groups:

This option defines the LDAP attribute for groups.

  • LDAP Search Attributes:

The criteria used in the search attribute can be changed to meet your LDAP structural needs. This information can be found with the user’s container name or unique identifier in the LDAP database. An LDAP browser can quickly display these parameters. In this example, the data refers to the following information:

  • cn = Container name. Typically this is the user’s full name.
  • mail = User’s mail address.
  • givenName = Typically, this is the first name of a user.
  • sn = Surname or last name.

Base DN

  • The top level of the LDAP directory tree is the base, referred to as the “base DN”.
  • By default Outlook Connector attempts to determine your LDAP base DN by your User DN, which you specified on the Connections > LDAP tab. Consult with your LDAP administrator for your DN if the Base DN was not determined automatically.

LDAP Server Version

  • Select LDAP version

Manually select version 2 or LDAP version 3.

  • Detect

This button will attempt to get the LDAP server version automatically.

LDAP attributes

Figure 48 – Outlook Connector – More Settings – Connections – LDAP – Advanced Settings – LDAP Attributes

The value of these attributes is used to perform the searches against the LDAP database. These are comma delimited and can be changed depending on your setup.

  • User Attributes
    The user attribute will search against “login” then “uid”.
  • User ID
    The user id attribute will search against the “login” attribute.
  • First Name
    The first name attribute will search against “givenName”.
  • Last Name
    The last name attribute will search against “sn”.
  • Display Name
    The display name attribute will search against “display-name”, “displayName”, and then “cn”.
  • E-mail Address
    The e-mail address attribute will search against “mail”.

 

Others



Figure 49 – Outlook Connector – More Settings – Connections IMAP

Timeout Setting

  • Server timeout value in number of seconds.
    The Timeout Setting tells the server how long to wait before it closes the session. The default value is “0”. Acceptable values are: “0”, “30-600” seconds. In a corporate environment where the user is on the same network as the mail server, a timeout value of “0” may be adequate.Users on a Wide Area Network (WAN) need to consider larger timeout settings. Setting this value is dependent on your Internet connection speeds. If you are on a dial-up connection, you may want to set this value to 600 seconds whereas if you are on a DSL connection or cable modem connection, 60 seconds may be acceptable.Having a value too low can cause uploading issues when sending large attachments where the Internet upload speeds are usually slow.
  • Auto Registration Port
    Auto registration is disabled by default. This option allows Outlook Connector to verify licensing with their local Insight Server or Bynari Server. If you do not use the Bynari Server or Insight Server, DO NOT enable the Auto Registration Port Checkbox. By default, port 80 is used. This option can be changed depending on your Bynari Server or Insight Server, and your firewall configuration.

    Important Information: The Outlook Connector was designed to function over LAN-based and high speed broadband connections. Many remote users are able to utilize the Outlook Connector as it was designed. For users on poor remote connections, utilizing the Bynari Web Client may be a better option.

 

  • Use SSL
    Use secure socket layer protocol to register.

3.2.4.3 Download


Figure 50 – Outlook Connector – More Settings – Download

 

Download Options

  • Download Headers Only
    Enabled by default, this option improves the performance of the initial synchronization of the emails downloaded for Outlook. It downloads the header only for email messages. When the message is selected for viewing, the entire message is downloaded.

    Note: Tasks, journals, contacts and calendar events are always set for full-content download when selected for viewing.

     

  • Download Contents of Message Only
    Disabled by default, this option downloads the entire message during the synchronization of emails. Attachments are downloaded when the message is selected for viewing.
  • Download Contents of Message and Attachments
    Disabled by default, this option downloads the entire message and associated attachments during the synchronization of emails.
  • Download All Attachments
    This option will download all attachments.
  • Download Attachment Limit
    This option will set the download attachment limit size in bytes. Any value is accepted in this field. The default is 50,000 bytes.

Download Message progress

  • Show progress indicator when loading messages
    When this box is checked, a progress indicator will appear when synchronizing any folder with more than 50 messages. This option is checked by default.
  • Indicator threshold (number of messages)
    This option allows you to modify when the indicator will appear. By default, this value is set to 50 messages, adjusting this to zero will display the indicator for every message.

3.2.4.4 Folders


Figure 51 – Outlook Connector – More Settings – Folders

Folder Type

  • Use ACL to set folder types
    Enabled by default, it allows the Outlook Connector to use custom IMAP folder ACLs to specify the specialized folder types used by Outlook. These are “Calendar”, “Contact”, “Task”, “Journal”, “Notes“, and “Mail”. This option increases performance since the Outlook Connector no longer has to locate a hidden synchronization message to determine a given folder’s type.

Folder List

  • Show All Folders
    This is enabled by default and tells the Outlook Connector to automatically subscribe to all folders found under the user’s folder list.
  • Show Only Subscribed Folders
    In large environments, the default value of “Show All Folders” may not be desirable. This option allows the users to individually select only the folders they want to see in Outlook.
Important Information: When manually selecting folders, make sure that default folders are checked. i.e. Calendar, Contacts, Deleted Items, Sent Items, Outbox and Tasks. If you uncheck them, it will cause Outlook to recreate them on the IMAP server. This is a default behavior of Outlook.

 

3.2.4.5 Send/Receive


Figure 52 – Outlook Connector – More Settings – Send/Receive

Outlook Connector utilizes IMAP IDLE to update the Inbox folder. For servers that do not support IMAP IDLE make sure that the Inbox folder is selected.

 

3.2.4.6 Other Settings


Figure 53 – Outlook Connector – More Settings – Miscellaneous

The Other Settings tab contains two sections; one for read receipt request options and the second for local cache options.

Message Receipt Options

How would you like to respond to requests for read receipts on incoming messages?

  • Prompt me before sending a response
    This option is the default setting. This setting “prompts” the user to choose between sending a read receipt or not.
  • Always send a response [default selection]
    This option automatically sends a response to the sender of a read receipt request.
  • Never send a response
    This option never sends a response to a read request sender.

Local Cache Options

Store local message cache in the following directory:

  • Default Location
    The default location for the local cache is:Windows XP:
    C:\Documents and Settings\[user name]\Local Settings\Application Data\Bynari\Outlook Connector 4.0\Accounts\[Outlook profile name]\[email address]\Windows 7:
    C:\Users\[user name]\AppData\Local\Bynari\Outlook Connector 4.0\Accounts\[Outlook profile name]\[email address]\The name of the local cache file is: LocalCache.ost
  • Custom Location
    This option allows you to change the location of the local cache. This enables the administrator to place the local cache on the network through a network share for user data backup if needed.

    Note: Read, Write, Delete and Change permissions within Microsoft Windows are required for any Custom Location.
    Note: Any changes made to the location of the local cache will require a restart of Outlook. If you do not restart Outlook, you may see errors, because the Outlook Connector must create the LocalCache.pst file.

 

3.2.4.7 Format


Figure 54 – Outlook Connector – More Settings – Format

Message Format Options

Note: “Use Kolab Format” option is available in the Kolab version of Outlook Connector 4.0.
  • Use Microsoft Message Format
    This is also known as “.tnef” formatting which stands for Transport Neutral Encapsulation Format. This allows files to contain rich text formatting used by e-mail messages, such as bold, italics, underlining, etc…
  • Use iCal Format
    This option is turned on by default in the “ical” or “iCalender” format version of Outlook Connector. iCalendar is a file format which allows sending meeting requests and tasks to other internet users via email or sharing files with an .ics extension.“iCal” format is significantly smaller than the “.tnef” format which can improve performance and save disk space.

    Note: If you use a Kolab server or an iCalendar compatible server, you may not need to select “Use Microsoft Message Format”. If you are unsure, it is best to select both options.
  • Use Kolab Format
    Use this option only if you are running a Bynari Collaborator Server or Kolab IMAP server. Kolab uses a unique XML format attached to email specifically for Kolab groupware servers. The XML holds information for contacts, calendar events, journals, etc.

 

3.2.4.8 Logging


Figure 55 – Outlook Connector – More Settings – Logging

Logging capabilities have been added to the Outlook Connector as a troubleshooting aid. By default, all logging is off. Log files can consume large amounts of disk space, and it is recommended that logging be left off, unless the user is experiencing problems.

When working with Bynari Technical Support on an issue, they may request that you enable logging. Verbose logging is the most thorough level of logging offered and will offer the most insight to the support technician.

 

3.2.4.9 About


Figure 56 – Outlook Connector – More Settings – About

About tab

The about tab provides information about the Outlook Connector. It contains the version number as well as all licensing information.

3.2.5 Quota

Used to display the user’s current quota status.

Figure 57 – Outlook Connector – Toolbar Quota button


Figure 58 – Outlook Connector Quota

3.2.6 About


Figure 59 – Outlook Connector – About

The “About” button on the Outlook Connector toolbar performs the same function as the “About” tab discussed above in section 2.5.4.9.

4 Using Outlook Connector

Outlook Connector 4.0 provides Outlook with a MAPI transport service that makes connecting to an IMAP server transparent to the end user. The following sections describe some of the additional dialogs introduced by the Connector such as Folder permissions as well as documenting configuration changes needed for features such as Free/Busy.

4.1 Viewing Shared Folders

Note: Private events (calendar, contacts, and tasks) are stored on the server. Only the folder owner will see private events.

Other users’ shared folders will appear under ‘Other Users’ in the folder list.


Figure 61 – “Other Users” shared folder list

Public folders created on the Bynari Server and Insight Server will display under ‘Shared Folders’ in Outlook.

 


Figure 62 – “Shared Folders” public folder list

 

Note: Upgrade your Insight Server to at least 4.2.2 to support private events.

4.2 Free/Busy Configuration

Outlook allows users to share free/busy information from their calendars with other users on their mail server. With the Microsoft Office Internet Free/Busy Service, users can publish their free/busy times to a shared Internet location. Members using this service can view each other’s free/busy information when viewing shared calendars or creating meeting requests.


Configure Free/Busy

  • Open Options in Outlook
    On the Outlook Toolbar, select Tools > Options.

    Figure 63 – Outlook Tools, Options
  • This opens a new window; select the Preferences option tab.

Options – Preferences

  • Click on “Calendar Options…”

    Figure 64 Tools Options

Calendar Options – Advanced options


Figure 65 – Tools – Options – Calendar Options

Note:When sending meeting requests over the Internet, use iCalendar format” option will likely be grayed out. This is normal.

 

  • Enable alternate calendar
    Select this option if you wish to enable an alternate calendar.
  • Click on “Free/Busy Options…”
    Select to change the Free/Busy Options.

 

Free/Busy Options

Figure 66 – Tools – Options – Calendar Options Free/Busy Options

Options

  • Publish “2” month(s) of Calendar free/busy information the server
    Enter the number of months of Free/Busy information to be published.The default interval is 2 months. This value represents the number of months from today’s date.
  • Update free/busy information on the sever every “15” minutes
    The default time is every 15 minutes. This value represents how often Outlook will update the user’s Free/Busy information on the server.

Internet Free/Busy

  • Publish at my location
    This option must be checked. In figure 66, a path name is shown. Insert your information in place of the variables, “%NAME%.vcf”.

    Note: If you are using Insight Server 4.3, use the below example by changing the server name and replacing %NAME% with your username.ftp://mail.example.net/freebusy/%NAME%.vcf
  • Search location
    Enter the URL for the shared free/busy search location.

    Note: If you are using Insight Server 4.3, use the below example by changing the server name and replacing %NAME% with your username.http://mail.example.net/freebusy/%NAME%.vcf
  • Click “OK” to apply the Free/Busy settings.

4.3 Show / Hide Toolbar

  • Toggle toolbar display

On the Outlook Toolbar, select View > Toolbars > Outlook Connector 4.0.

It places a check mark next to the name to show that the Connector is enabled.



Figure 67 Show/Hide Outlook Connector Toolbar

If you have hidden the Outlook Connector toolbar at the time of the installation, you can show the toolbar by following the above steps.

5 Registering and Unregistering Outlook Connector

Outlook Connector 4.0 is configured to use auto registration by default when “Insight Server” is selected during installation. Auto registration is designed for users of both the Outlook Connector and Insight Server or the Bynari Server. With auto registration enabled, the Outlook Connector will verify that an active license exists for the client when Outlook starts. It is recommended that users of the Insight Server or the Bynari Server utilize this feature of the Outlook Connector.

If you do not have an Insight Server or Bynari Server, or do not wish to use auto registration, you can register your copy of the Outlook Connector using the About tab of the Outlook Connector toolbar.

5.1 Auto Registration

Enable or disable auto registration

  • Click on the “Account” tab in Outlook Connector toolbar.


Figure 68 – Outlook Connector – Account

  • Select “Connections” > “Others”.


Figure 69 Outlook Connector – More Settings – Connections – IMAP

 

Important Information: Do not enable auto registration if you do not use the Insight Server or Bynari Collaborator Server (BCS).

 

  • Auto Registration Port
    Auto registration is either enabled or disabled depending on your Insight Server selection during installation. This option allows Outlook Connector to verify licensing with a local Bynari Server or Insight Server. By default, port 80 is used. This option can be changed depending on your Bynari Server or Insight Server, and your firewall configuration.
  • Use SSL
    Use secure socket layer protocol to register.

    Troubleshooting Tip: If you are experiencing trouble registering the connector and your server does not support auto-registration, make sure that the “Auto Registration Port” option is NOT checked. This option is being deprecated in future versions of the connector.

5.2 Register Outlook Connector

  • Click on “About” in the Outlook Connector Toolbar.

    Figure 70 – Outlook Connector About

 

  • Click on “License”.

    Figure 71 About
    Figure 682 Key Support button
  • Enter your product license key
    Copy/Paste your license key in the space provided.
  • Manual Registration
    See section “manual registration” below.
  • Enter the license certificate below:
    This is only used during manual registration.
  • Which port would you like to use for the registration?
    Bynari license key server listens on ports 80 and 3080. If port 80 is blocked, port 3080 can be used as an alternate port.

    Note: The license key server URL is http://update.bynari.net.
    Note: If you encounter any issues while activating your Outlook Connector license, ping the license key server to verify proper internet connectivity.
  • Click “OK” to register Outlook Connector.

Manual Registration

  • Enter your product license key
    Copy/Paste your license key in the space provided.
  • Manual Registration
    Contact Bynari Support at support@bynari.net and request a manual license certificate.
  • Enter the license certificate below:
    Paste entire certificate in the space provided. (See manual certificate example.)

    Figure 693 – Manual certificate example

    Figure 684 – Manually entering the information
  • Click “OK” to complete manual registration.

5.3 Registration Complete

  • After registering over the internet or manually, you should see the following screen.

    Figure 715 Manually entering the information

Outlook Connector License Information

  • License Key
    This is the license key used to register Outlook Connector.
  • License Expire
    This will display when your license expires.
  • Support Expires
    This option will show the date Bynari support expires.
  • Number of Licenses Used
    This displays the number of licenses used vs. the number of licenses that you have purchased.
  • Total License Available
    This displays the number of licenses available or purchased.
  • Supported Versions
    The Connector version supported for this license key.
  • Supported Options
    Formats that are supported such as iCal or Kolab are listed.

Click “Refresh” to update dialog screen for license information.

5.4 Unregister Outlook Connector

  • Click on “About” on the Outlook Connector Toolbar.
  • Click on “License”.

    Figure 726 – Connector License information
  • Click on “Unregister”.
    This will unregister Outlook Connector from your computer.



6 Reporting Problems

When reporting problems, be sure to include the following information:

  • Microsoft Windows version number and patch level.
    • Right click on “My Computer” icon on the Desktop and select Properties. The Windows version and patch level will be listed under System: in the General tab dialog.
  • Microsoft Outlook version and patch level.
    • Right click on Help in Outlook and select About Microsoft Outlook. The Outlook version and patch level will be listed.
  • The full version number of the Outlook Connector.
    • Click “About” on the Connector toolbar. The connector version and build number (4.Y-XXXX) will be listed.

 

To contact technical support:

U.S. Toll Free Telephone: 1-800-241-1086
International Telephone: 001-214-350-5772

To open a new support ticket email: support@bynari.net

For FAQs: http://www.bynari.net/users/kb.php

AddressBook Admin Guide

Bynari AddressBook 3.0

Administrator’s Guide

Trademarks

Bynari products are trademarks of Bynari, Inc.

Microsoft Windows, Microsoft Outlook and Windows logos are trademarks of Microsoft Corporation in the United States, other countries, or both.

All other trademarks are the property of their respective owners.

Technical Support

When you purchase any of the Bynari’s products, the products include one year of free support and maintenance. To purchase additional yearly support and maintenance, please contact sales@bynari.net.

With Support, customers receive one year of product maintenance, upgrades and unlimited email and telephone support.

Support is available to customers worldwide.

To contact technical support:

U.S. Toll Free Telephone: 1-800-241-1086
International Telephone: 001-214-350-5772

To open a new support ticket: http://www.bynari.net/support/

For FAQs: http://www.bynari.net/users/kb.php

Table of Contents

Bynari AddressBook 3.0

The Bynari AddressBook is a fully LDAP 2 and LDAP 3 compliant query tool designed to integrate seamlessly with Microsoft Outlook™ (2003-2010).

The Bynari AddressBook is capable of querying any OpenLDAP, Active Directory, or LDAP 2/LDAP3 compliant database.

The Bynari AddressBook is fully compatible with, and certified for use on Univention Corporate Server.

1 Features

Here are some of the features found in the new Bynari AddressBook 3.0:

  • XML Schema file for quick global configuration

  • Automatic discovery of ObjectClass attributes (when using XML schema)

  • Detect Filters

  • LDAP attributes are now editable from within the Bynari AddressBook configuration dialog window.

  • Sort results by: First Name, Last Name, Display Name, or Email Address.

  • Auto-detection of LDAP version

  • Configurable display columns

  • Display “all user” feature

  • Full compatibility with Outlook 2007 and Outlook 2010

2 Supported Platforms

The Bynari AddressBook 3.0 is compatible with all current Microsoft Outlook™ versions from Outlook 2003 – 2010. The Bynari AddressBook 3.0 is also fully compatible with all current Microsoft operating systems:

  • Windows XP Pro

  • Windows 7/Vista

Note: Installation of the Bynari AddressBook requires administrator rights to the local desktop.

3 Prerequisites

Because Bynari AddressBook 3.0 is not resource intensive, the minimum system requirements needed to run your Windows’ operating system are more than sufficient. It is highly recommended that all Microsoft updates and Office patches and Service Packs be installed prior to installing the Bynari AddressBook 3.0.

Needed Information:

  • LDAP Server Fully Qualified Domain Name (FQDN) or IP Address

  • LDAP Port number (389 is the default)

  • User Distinguished Name (DN)

  • User Password

  • Container Distinguished Names

For the configuration of the schemas.xml file, the administrator will need to know the general architecture of your LDAP server. For administrators that are unfamiliar with their LDAP architecture, there are tools available that can simplify this task:

4 Installation and Configuration

4.1 Installing the Bynari AddressBook 3.0

The following steps will install the Bynari AddressBook 3.0.

  1. Unzip the compressed file.

  2. Double-click the executable that you just unzipped.

  3. Select “Next” on the welcome dialog window
    Figure 1 – Bynari AddressBook 3.0 – Installation
  4. Accept the End User License Agreement by selecting “I accept the agreement”

     

Figure 2 – Bynari AddressBook 3.0 – EULA

  1. Accept the default installation location or specify another location and select “Next”.

Figure 3 – Bynari AddressBook 3.0 – Installation Location

  1. Select the “Install” button. The necessary files will now be installed on your pc.

    Figure 4 – Bynari AddressBook 3.0 – Install

  2. Select “Run Outlook” to start Outlook.

    Figure 5 – Bynari AddressBook 3.0 – Installation Complete

  3. The Bynari AddressBook 3.0 registration page will display immediately after the “Finish” button is selected. For 30 day evaluation mode, fill in the information on the form and select “30 Days Evaluation”. For users with a license, select “Skip”.

4.2 Upgrading from previous versions

Upgrading from the Bynari AddressBook 2.0 is easy. The Bynari AddressBook 3.0 installation process automatically looks for previous versions of Bynari AddressBook. If a prior version is found the settings are retrieved from it and copied over to the new version. There is no need to reconfigure the newly installed Bynari AddressBook 3.0. When Outlook is restarted the new software will already be configured and ready for use.

NOTE: Bynari AddressBook 3.0 uses a completely different license code than Bynari AddressBook 2.0. You can get a new license, prior to installation, by contacting Bynari.

4.3 Configuring the Bynari AddressBook 3.0

The following steps will help you to configure the Bynari AddressBook 3.0 with your LDAP server.

  1. Open Outlook.

    1. Outlook 2003

      1. Select Tools > Email Accounts > Directory > Add a new directory or address book > Additional Address Books > Bynari AddressBook 3.0

    2. Outlook 2007 and 2010

      1. Select Tools > Account Settings > Address Books > New > Additional Address Books > Bynari AddressBook 3.0

  2. The Bynari AddressBook 3.0 configuration window is now displayed.

NOTE: the information entered in the figure below would not normally be displayed during this step of the installation process. It is displayed here as an example.

4.3.1 General Tab

Figure 6 – Bynari AddressBook 3.0 – LDAP Configuration

  1. LDAP Server:
    Enter the Fully Qualified Domain Name (FQDN) or IP Address for the LDAP server.

  2. Port: 389 by default

  3. Use SSL:
    If your LDAP server uses SSL, place a check in this box.

  4. Login Anonymously:
    If your LDAP server supports anonymous login, place a check in this box.

  5. User DN:
    The User DN (Distinguished Name) is comprised of a unique identifier for the user and the domain container. In the figure above, the unique identifier is the entry “cn=” in the LDAP database followed by the domain or organizational information. Some LDAP databases are configured with domain components (dc) while others are configured to utilize organizational units (ou).

  6. User Password: Enter the user’s password

  7. Select the checkbox next to “Remember Password”.

  8. Select the “Test LDAP” button. If your configuration parameters in steps 5-10 are correct, the “Successfully Connected” dialog window will be displayed:

Figure 7 – Bynari AddressBook 3.0 Test LDAP

  1. Select “OK” to close the “Successfully Connected” dialog window.

  2. Select the “Search” button to open the Container DN search dialog window.

  3. Figure 8 – Bynari AddressBook 3.0 Search Container
  1. Select the domain component (dc) or organizational unit as needed. Some LDAP structures use domain components while others utilize organizational units (ou). Data entered here will depend on your organization’s LDAP structure.

  2. Select “OK” when all required components have been selected.

  3. The “Container DNs:” window will display the domain component (dc) or organizational units (ou).

Figure 9 – Bynari AddressBook 3.0 Container DNs

4.3.2 Display Tab

On the “Display” tab, you can configure the actual Display Name of the address book. You can also modify the display columns as shown in the AddressBook by selecting “Configure Display Columns”.

Figure 10 – Bynari AddressBook 3.0 Configure Display Columns

  1. By default, all items are displayed in the address book view. To modify what content is displayed, select the items you want to remove and then press the “Delete” button in the center of this dialog window. You can also change the order of the displayed items by highlighting the item and using the “Move Up” or “Move Down” buttons.

  2. When finished modifying the column display, select “OK”.

  3. Display all users under “All Users” group container.
    By selecting this option, all users will be displayed within the AddressBook display pane. All groups, mailing lists, etc will be displayed when this option is selected.

Figure 11 – Bynari AddressBook 3.0 Display All Users

4.3.3 Advanced Tab

The Advanced tab contains all of the options for LDAP searches. By default, the AddressBook 3.0 will recognize both the Bynari Server 4.3 and neonBynari 5.0 LDAP schemas. It will also “auto-populate” the LDAP search filters with the correct objectClass information.

Figure 12 – Bynari AddressBook 3.0 Advanced Filters

  1. The “Sort returned results by:” the pull-down menu on the right side of this window allows you to select how you want the results to be displayed.
    Options are:

  1. First Name

  2. Last Name

  3. Display Name

  4. Email Address

  1. Display all results in a single container (deep search).
    This option will automatically turn on the deep search feature used with the Bynari AddressBook 3.0 search tool. For more information on the search tool see section 6.3 Search Feature.

  2. The LDAP Filters for Users, LDAP Filter for Groups, and LDAP Search Attributes can all be configured independently on this screen. These attributes can also be configured through the schemas.xml file that accompanies the installation of the Bynari AddressBook 3.0. This default location for the schemas.xml file is:
    C:\Program Files\Bynari, Inc\Bynari AddressBook For Outlook

  3. Editing the schemas.xml file requires an understanding of your LDAP structure. Utilizing tools such as LDAP browsers can be helpful during this part of the process. Once you have your objectClass parameters and LDAP Search Attributes configured in the schemas.xml file, the file can be utilized for all subsequent installations by copying it to the directory noted in step 2. More information about the schemas.xml structure can be found in section 5 of this manual.

  4. LDAP Attributes:

Figure 13 – Bynari AddressBook 3.0 LDAP Attributes

  1. All fields in the LDAP Attributes dialog window are configurable. In the example shown in the figure above, the “Last Name” attribute was changed to “sn” and the “Display Name” was changed to “cn” to match the LDAP directory structure. As mentioned in step 3, an LDAP browser can be very helpful in configuring these parameters. Select “OK” when finished editing.

  2. Reset Filters:
    This option will reset the filters in the “Filters for Users”, “LDAP Filter for Groups”, and “LDAP Search Attributes” to match the schemas.xml file.

  3. Detect Filters:
    This option will detect which LDAP server you are using – provided that it is already configured in the schemas.xml file. This can be very useful for installations where multiple LDAP directories are used. A single schemas.xml file can be configured for multiple servers and used for multiple installations. By default, “Detect Filters” automatically recognizes Bynari Server and neonBynari Server LDAP schemas.

  4. BaseDN:
    The top level of the LDAP directory tree is the base, referred to as the “base DN”

    By Default Bynari Addressbook attempts to determine your LDAP base DN by your User DN, which you specified on the “General” tab. Here you may specify your base DN, if Bynari Addressbook is unable to determine your base DN or you get results other than expected.

  5. LDAP Server Version:
    This feature automatically detects if the LDAP server is version 2 or 3 and adjusts accordingly when the “Detect” button is selected.

  6. Clear Cache Now:
    The Bynari AddressBook 3.0 keeps a local cache of the LDAP directory. The local cache increases performance and reduces network traffic to the LDAP server. If a user loses access to an LDAP server (server goes offline or network outage), the local cache will allow the user to continue to function. Selecting the “Clear Cache Now” button will clear the local cache.

  1. Select “OK” when finished editing configuration fields.

4.3.4 Cache Tab

Clear Cache Now:
The Bynari AddressBook 3.0 keeps a local cache of the LDAP directory. The local cache increases performance and reduces network traffic to the LDAP server. If a user loses access to an LDAP server (server goes offline or network outage), the local cache will allow the user to continue to function. Selecting the “Clear Cache Now” button will clear the local cache.

4.3.5 About Tab

The About tab contains software version information and licensing information.

5 The schemas.xml file

The Bynari AddressBook 3.0 is capable of manual configuration or configuration using the schemas.xml file. The schemas.xml file, by default, is preconfigured for both the Bynari Server 4.3 and the neonBynari 5.0 LDAP schemas. By default, the Bynari AddressBook 3.0 will automatically detect which version of LDAP server you are connecting to, Bynari Server 4.3 or neonBynari 5.0.

Customizing the schemas.xml file allows you to configure your LDAP server settings for use with the address book. Once customized, this file can be copied to the:

C:\Program Files\Bynari, Inc\Bynari AddressBook For Outlook

directory for each installation.

As mentioned in step 25 of section 4.2 (Configuring the Bynari AddressBook 3.0), it is recommended that a LDAP directory browser or similar tool be used to configure the schemas.xml file.

5.1 Schemas.xml structure

The schemas.xml file is organized into the following components:

  • objectClass value

    • userFilter

    • groupFilter

    • searchAttribute

    • attributes

5.1.1 objectClass

objectClasses are the means for including attributes – an “attribute container”. The objectClass is also an attribute itself and can be included in search queries. All attributes must be defined within an objectClass.

For the following description of the schemas.xml file, refer to the included schemas.xml file with the Bynari AddressBook 3.0.

The structure for the objectClass in the schemas.xml file:

<objectClass value=”neonBynariDomain description=”neonBynari Server”>

The Object Identifier (OID) is neonBynariDomain which is the global unique identifier for this objectClass.

5.1.2 userFilter

The userFilter is used to search for users in the LDAP database at the sub-domain level. Contained within the userFilter attribute is at least one objectClass.

The structure for the userFilter in the schemas.xml file:

<userFilter>(|(objectClass=neonPerson)(objectClass=groupOfNames))</userFilter>

The objectClass “neonPerson” refers to the actual username; the objectClass “groupOfNames” refers to the LDAP group where this user belongs.

5.1.3 groupFilter

The groupFilter is used to search for groups in the LDAP database at the domain level. Contained within the groupFilter attribute is at least one objectClass.

The structure for the groupFilter in the schemas.xml file:

<groupFilter>(|(objectClass=organization)(objectClass=neonBynariDomain)(objectClass=dcObject))</groupFilter>

The objectClasses “organization”, “neonBynariDomain”, and “dcObject” are all objectClass components of the Domain Component.

5.1.4 searchAttribute

The searchAttribute is a custom attribute developed for the purpose of name resolution in user-level queries. This attribute does not contain an objectClass attribute.

The structure for the searchAttribute in the schemas.xml file:

<searchAttribute>cn;mail;givenName;sn</searchAttribute>

The criteria used in the search attribute can be changed to meet your LDAP structural needs. This information can be found with the user’s container name or unique identifier in the LDAP database. An LDAP browser can quickly display these parameters. In this example, the data refers to the following information:

  • cn = Container Name. Typically, this is the user’s full name.

  • mail = User’s email address

  • givenName = Typically, this is the user’s first name.

  • sn = Surname or last name

5.1.5 attributes

The attributes section of the schemas.xml file contains information related to the specific user. The following is a list of the parameters of the attributes section:

<FirstName>givenName</FirstName>

<LastName>sn</LastName>

<DisplayName>cn</DisplayName>

<EmailAddress>mail</EmailAddress>

<Street>street</Street>

<PostOfficeBox>postOfficeBox</PostOfficeBox>

<City>l</City>

<State>st</State>

<PostalCode>postalCode</PostalCode>

<Department>departmentName</Department>

<HomePhone>homePhone</HomePhone>

<CellPhone>mobile</CellPhone>

<OfficePhone>employeeNumber</OfficePhone>

<PagerNumber>pager</PagerNumber>

<FaxNumber>facsimileTelephoneNumber</FaxNumber>

<TelexNumber>telexNumber</TelexNumber>

<Title>title</Title>

<OfficeName>departmentNumber</OfficeName>

<Description>description</Description>

<Server>mailHost</Server>

<Alias>mailAlias</Alias>

<DistinguishedName>dn</DistinguishedName>

6 Using the Bynari AddressBook 3.0

To use the Bynari AddressBook 3.0, go to the same standard Outlook address book. The Bynari AddressBook 3.0 is accessed by selecting the address book icon in the Outlook tool bar or by using the “To…”, “CC…”, or “BCC…” options when composing an email.

6.1 Outlook address book icon

Using the address book icon will open the Bynari AddressBook 3.0 dialog window.

Figure 14 – Bynari AddressBook 3.0 dialog

In this dialog window, all of the users within the LDAP searchAttribute (for details see section 5.1.4) are displayed. This dialog window also gives you the ability to view detailed, published user information. By double-clicking on a username, a properties dialog window will open displaying further details about the user, if provided.

Figure 15 – Bynari AddressBook 3.0 user properties

Selecting the “Add to Contacts” button will automatically insert the displayed information into a Microsoft Outlook™ contact form. Information can be quickly transferred into your personal contacts from the LDAP server.

6.2 Using To, CC, BCC

When composing an email and using the “To…”, “CC…”, or “BCC…” options, a different Bynari AddressBook 3.0 dialog window will open.

Figure 16 – Bynari AddressBook 3.0 Using To…, CC…, or BCC…

To address your email, select the person’s name and press either the “To ->”, “Cc ->”, or “Bcc ->” buttons at the bottom. To select multiple names, hold down the Ctrl key and select with the mouse.

6.3 Search Feature

The search feature of AddressBook 3.0 allows for custom searching of users within their groups or searches throughout the LDAP directory (deep search).

To perform a search, the Outlook address book dialog window must be opened. Below are examples of what Outlook 2003-2007 address book windows looks like. The search button has been highlighted in each of the following examples as well.

Figure 17 – Bynari AddressBook 3.0 – Outlook 2003 address book

Figure 18 – Bynari AddressBook 3.0 – Outlook 2007 address book

Selecting the search button in the Outlook address book window will display the Bynari AddressBook 3.0 deep search tool.

Figure 19 – Bynari AddressBook 3.0 – Search Tool

The search tool will search within the container that is displayed in the Outlook address book. For example, if the “All Users” container is selected, the search tool will search through all users. If the “Sales” container was selected, then the search would be limited to the “Sales” container.

Figure 20 – Bynari AddressBook 3.0 – All User Container

When entering search criteria, partial names or even single letters can be used to broaden the search. Search results will be displayed in the Outlook address book under the heading, “Search Results” (see figure below).

NOTE: The deep search tool searches the actual LDAP database NOT the local cache. Network connectivity to the LDAP database is required when using the search tool.

“Search All Subcontainers” is the component that actually performs the deep search function. For best results, leave this feature enabled.

6.4 Outlook Contacts

The Bynari AddressBook 3.0 also gives you the ability to select contacts from the Outlook Contacts folder.

Figure 21 – Bynari AddressBook 3.0 Outlook Contacts

Once the names have been selected, press “OK” to insert them into the email you are composing.

7 Registering Bynari AddressBook 3.0

The Bynari AddressBook 3.0 requires a license key for proper registration. License keys can be obtained by contacting sales@bynari.net.

NOTE: The license key for Bynari AddressBook 3.0 is different from the license key in Bynari AddressBook 2.0. If you are upgrading from Bynari AddressBook 2.0, please contact sales@bynari.net for a new license key.

To register the Bynari AddressBook 3.0, open the Bynari AddressBook 3.0 configuration window. For details on locating the configuration window, see section 4.3 “Configuring the Bynari AddressBook 3.0” in this guide. Once the configuration window is open, select the “About” tab.

Figure 22 – Bynari AddressBook 3.0 – Registration

Selecting the “License” button will open a new dialog window.

Figure 23 – Bynari AddressBook 3.0 – Registration

In this dialog window, enter the Bynari AddressBook 3.0 license key code and select “OK”. Selecting “OK” will display a license key confirmation dialog window.

If the workstation being registered is behind a firewall or if port 80 is blocked, port 3080 can be configured by using the pull-down menu.

Figure 24 – Bynari AddressBook 3.0 – Registration

The Bynari AddressBook 3.0 can also be unregistered from this window by selecting the “Unregister” button. Select “OK” to close this window and finish the registration process.

Figure 25 – Bynari AddressBook 3.0 – Registration

When the Bynari AddressBook 3.0 is fully registered, it displays the expiration date on the “About” tab as seen above.

NOTE: If technical assistance is required, Bynari technical support staff will ask for the software version number. This number is located on the “About” tab. In the figure above, it is highlighted in red.

7.1 Manual Registration

If the product fails to register through the normal registration process, manual registration will be required.

Following the steps outlined in section 4.3 “Configuring the Bynari AddressBook 3.0”, open the Bynari AddressBook 3.0 configuration window. Select the “About” tab and then select the “License” button.

NOTE: Manual registration requires a certificate. This certificate is obtained through Bynari support. Email your license key to support@bynari.net and request a manual registration certificate.

Figure 26 – Bynari AddressBook 3.0 – Manual Registration

To enable manual registration, select the “Manual Registration” checkbox as shown in the figure above. This will make the area titled, “Enter the license certificate below:”, active.

Enter the license key on the line titled, “Enter your product license key:”. In the certificate window at the bottom, enter the entire license certificate starting with:

—–BEGIN PGP SIGNED MESSAGE—–

and ending with:

—–END PGP SIGNATURE—–

Select “OK” when all of the information has been entered. Confirm the license as in the steps above by selecting “OK” on the license confirmation window. Select “OK” to close the Bynari AddressBook 3.0 configuration dialog window. Select “Finish” to close the Outlook E-mail Accounts dialog window.

8 Reporting Problems

When reporting problems, be sure to include the following information:

  • Microsoft Windows version number and patch level.

    • Right-click the My Computer icon on the Desktop and select Properties. The Windows version and patch level will be listed under System: in the General tab dialog.

  • Microsoft Outlook version and patch level.

    • Right-click Help in Outlook and select About Microsoft Outlook. The Outlook version and patch level will be listed.

  • The full version number of the Bynari AddressBook.

    • In Outlook select Tools > Email Accounts > View or change existing directories or address books.

    • Next > Bynari AddressBook 3.0 > Change

    • Select the About tab.

    • The AddressBook version number will be listed.

To contact technical support:

U.S. Toll Free Telephone: 1-800-241-1086
International Telephone: 001-214-350-5772

To open a new support ticket: http://www.bynari.net/support/

For FAQs: http://www.bynari.net/users/kb.php

Bynari AddressBook 3.0

Administrator’s Guide

Trademarks

Bynari products are trademarks of Bynari, Inc.

Microsoft Windows, Microsoft Outlook and Windows logos are trademarks of Microsoft Corporation in the United States, other countries, or both.

All other trademarks are the property of their respective owners.

Technical Support

When you purchase any of Bynari’s products, all the products except the WebDAV Collaborator include one year of free support and maintenance. To purchase additional yearly support and maintenance, please contact sales@bynari.net.

With Support, customers receive one year of product maintenance, upgrades and unlimited email and telephone support.

Support is available to customers worldwide.

To contact technical support:

U.S. Toll Free Telephone: 1-800-241-1086
International Telephone: 001-214-350-5772

To open a new support ticket: http://www.bynari.net/support/

For FAQs: http://www.bynari.net/users/kb.php

Table of Contents

Bynari AddressBook 3.0

The Bynari AddressBook is a fully LDAP 2 and LDAP 3 compliant query tool designed to integrate seamlessly with Microsoft Outlook™ (2003-2010).

The Bynari AddressBook is capable of querying any OpenLDAP, Active Directory, or LDAP 2/LDAP3 compliant database.

The Bynari AddressBook is fully compatible with, and certified for use on Univention Corporate Server.

1 Features

Here are some of the features found in the new Bynari AddressBook 3.0:

  • XML Schema file for quick global configuration

  • Automatic discovery of ObjectClass attributes (when using XML schema)

  • Detect Filters

  • LDAP attributes are now editable from within the Bynari AddressBook configuration dialog window.

  • Sort results by: First Name, Last Name, Display Name, or Email Address.

  • Auto-detection of LDAP version

  • Configurable display columns

  • Display “all user” feature

  • Full compatibility with Outlook 2007 and Outlook 2010

2 Supported Platforms

The Bynari AddressBook 3.0 is compatible with all current Microsoft Outlook™ versions from Outlook 2003 – 2010. The Bynari AddressBook 3.0 is also fully compatible with all current Microsoft operating systems:

  • Windows XP Pro

  • Windows 7/Vista

Note: Installation of the Bynari AddressBook requires administrator rights to the local desktop.

3 Prerequisites

Because Bynari AddressBook 3.0 is not resource intensive, the minimum system requirements needed to run your Windows’ operating system are more than sufficient. It is highly recommended that all Microsoft updates and Office patches and Service Packs be installed prior to installing the Bynari AddressBook 3.0.

Needed Information:

  • LDAP Server Fully Qualified Domain Name (FQDN) or IP Address

  • LDAP Port number (389 is the default)

  • User Distinguished Name (DN)

  • User Password

  • Container Distinguished Names

For the configuration of the schemas.xml file, the administrator will need to know the general architecture of your LDAP server. For administrators that are unfamiliar with their LDAP architecture, there are tools available that can simplify this task:

4 Installation and Configuration

4.1 Installing the Bynari AddressBook 3.0

The following steps will install the Bynari AddressBook 3.0.

  1. Unzip the compressed file.

  2. Double-click the executable that you just unzipped.

  3. Select “Next” on the welcome dialog window
    Figure 1 – Bynari AddressBook 3.0 – Installation
  4. Accept the End User License Agreement by selecting “I accept the agreement”

     

Figure 2 – Bynari AddressBook 3.0 – EULA

  1. Accept the default installation location or specify another location and select “Next”.

Figure 3 – Bynari AddressBook 3.0 – Installation Location

  1. Select the “Install” button. The necessary files will now be installed on your pc.

    Figure 4 – Bynari AddressBook 3.0 – Install

  2. Select “Run Outlook” to start Outlook.

    Figure 5 – Bynari AddressBook 3.0 – Installation Complete

  3. The Bynari AddressBook 3.0 registration page will display immediately after the “Finish” button is selected. For 30 day evaluation mode, fill in the information on the form and select “30 Days Evaluation”. For users with a license, select “Skip”.

4.2 Upgrading from previous versions

Upgrading from the Bynari AddressBook 2.0 is easy. The Bynari AddressBook 3.0 installation process automatically looks for previous versions of Bynari AddressBook. If a prior version is found the settings are retrieved from it and copied over to the new version. There is no need to reconfigure the newly installed Bynari AddressBook 3.0. When Outlook is restarted the new software will already be configured and ready for use.

NOTE: Bynari AddressBook 3.0 uses a completely different license code than Bynari AddressBook 2.0. You can get a new license, prior to installation, by contacting Bynari.

4.3 Configuring the Bynari AddressBook 3.0

The following steps will help you to configure the Bynari AddressBook 3.0 with your LDAP server.

  1. Open Outlook.

    1. Outlook 2003

      1. Select Tools > Email Accounts > Directory > Add a new directory or address book > Additional Address Books > Bynari AddressBook 3.0

    2. Outlook 2007 and 2010

      1. Select Tools > Account Settings > Address Books > New > Additional Address Books > Bynari AddressBook 3.0

  2. The Bynari AddressBook 3.0 configuration window is now displayed.

NOTE: the information entered in the figure below would not normally be displayed during this step of the installation process. It is displayed here as an example.

4.3.1 General Tab

Figure 6 – Bynari AddressBook 3.0 – LDAP Configuration

  1. LDAP Server:
    Enter the Fully Qualified Domain Name (FQDN) or IP Address for the LDAP server.

  2. Port: 389 by default

  3. Use SSL:
    If your LDAP server uses SSL, place a check in this box.

  4. Login Anonymously:
    If your LDAP server supports anonymous login, place a check in this box.

  5. User DN:
    The User DN (Distinguished Name) is comprised of a unique identifier for the user and the domain container. In the figure above, the unique identifier is the entry “cn=” in the LDAP database followed by the domain or organizational information. Some LDAP databases are configured with domain components (dc) while others are configured to utilize organizational units (ou).

  6. User Password: Enter the user’s password

  7. Select the checkbox next to “Remember Password”.

  8. Select the “Test LDAP” button. If your configuration parameters in steps 5-10 are correct, the “Successfully Connected” dialog window will be displayed:

Figure 7 – Bynari AddressBook 3.0 Test LDAP

  1. Select “OK” to close the “Successfully Connected” dialog window.

  2. Select the “Search” button to open the Container DN search dialog window.

  3. Figure 8 – Bynari AddressBook 3.0 Search Container
  1. Select the domain component (dc) or organizational unit as needed. Some LDAP structures use domain components while others utilize organizational units (ou). Data entered here will depend on your organization’s LDAP structure.

  2. Select “OK” when all required components have been selected.

  3. The “Container DNs:” window will display the domain component (dc) or organizational units (ou).

Figure 9 – Bynari AddressBook 3.0 Container DNs

4.3.2 Display Tab

On the “Display” tab, you can configure the actual Display Name of the address book. You can also modify the display columns as shown in the AddressBook by selecting “Configure Display Columns”.

Figure 10 – Bynari AddressBook 3.0 Configure Display Columns

  1. By default, all items are displayed in the address book view. To modify what content is displayed, select the items you want to remove and then press the “Delete” button in the center of this dialog window. You can also change the order of the displayed items by highlighting the item and using the “Move Up” or “Move Down” buttons.

  2. When finished modifying the column display, select “OK”.

  3. Display all users under “All Users” group container.
    By selecting this option, all users will be displayed within the AddressBook display pane. All groups, mailing lists, etc will be displayed when this option is selected.

Figure 11 – Bynari AddressBook 3.0 Display All Users

4.3.3 Advanced Tab

The Advanced tab contains all of the options for LDAP searches. By default, the AddressBook 3.0 will recognize both the Bynari Server 4.3 and neonBynari 5.0 LDAP schemas. It will also “auto-populate” the LDAP search filters with the correct objectClass information.

Figure 12 – Bynari AddressBook 3.0 Advanced Filters

  1. The “Sort returned results by:” the pull-down menu on the right side of this window allows you to select how you want the results to be displayed.
    Options are:

  1. First Name

  2. Last Name

  3. Display Name

  4. Email Address

  1. Display all results in a single container (deep search).
    This option will automatically turn on the deep search feature used with the Bynari AddressBook 3.0 search tool. For more information on the search tool see section 6.3 Search Feature.

  2. The LDAP Filters for Users, LDAP Filter for Groups, and LDAP Search Attributes can all be configured independently on this screen. These attributes can also be configured through the schemas.xml file that accompanies the installation of the Bynari AddressBook 3.0. This default location for the schemas.xml file is:
    C:\Program Files\Bynari, Inc\Bynari AddressBook For Outlook

  3. Editing the schemas.xml file requires an understanding of your LDAP structure. Utilizing tools such as LDAP browsers can be helpful during this part of the process. Once you have your objectClass parameters and LDAP Search Attributes configured in the schemas.xml file, the file can be utilized for all subsequent installations by copying it to the directory noted in step 2. More information about the schemas.xml structure can be found in section 5 of this manual.

  4. LDAP Attributes:

Figure 13 – Bynari AddressBook 3.0 LDAP Attributes

  1. All fields in the LDAP Attributes dialog window are configurable. In the example shown in the figure above, the “Last Name” attribute was changed to “sn” and the “Display Name” was changed to “cn” to match the LDAP directory structure. As mentioned in step 3, an LDAP browser can be very helpful in configuring these parameters. Select “OK” when finished editing.

  2. Reset Filters:
    This option will reset the filters in the “Filters for Users”, “LDAP Filter for Groups”, and “LDAP Search Attributes” to match the schemas.xml file.

  3. Detect Filters:
    This option will detect which LDAP server you are using – provided that it is already configured in the schemas.xml file. This can be very useful for installations where multiple LDAP directories are used. A single schemas.xml file can be configured for multiple servers and used for multiple installations. By default, “Detect Filters” automatically recognizes Bynari Server and neonBynari Server LDAP schemas.

  4. BaseDN:
    The top level of the LDAP directory tree is the base, referred to as the “base DN”

    By Default Bynari Addressbook attempts to determine your LDAP base DN by your User DN, which you specified on the “General” tab. Here you may specify your base DN, if Bynari Addressbook is unable to determine your base DN or you get results other than expected.

  5. LDAP Server Version:
    This feature automatically detects if the LDAP server is version 2 or 3 and adjusts accordingly when the “Detect” button is selected.

  6. Clear Cache Now:
    The Bynari AddressBook 3.0 keeps a local cache of the LDAP directory. The local cache increases performance and reduces network traffic to the LDAP server. If a user loses access to an LDAP server (server goes offline or network outage), the local cache will allow the user to continue to function. Selecting the “Clear Cache Now” button will clear the local cache.

  1. Select “OK” when finished editing configuration fields.

4.3.4 Cache Tab

Clear Cache Now:
The Bynari AddressBook 3.0 keeps a local cache of the LDAP directory. The local cache increases performance and reduces network traffic to the LDAP server. If a user loses access to an LDAP server (server goes offline or network outage), the local cache will allow the user to continue to function. Selecting the “Clear Cache Now” button will clear the local cache.

4.3.5 About Tab

The About tab contains software version information and licensing information.

5 The schemas.xml file

The Bynari AddressBook 3.0 is capable of manual configuration or configuration using the schemas.xml file. The schemas.xml file, by default, is preconfigured for both the Bynari Server 4.3 and the neonBynari 5.0 LDAP schemas. By default, the Bynari AddressBook 3.0 will automatically detect which version of LDAP server you are connecting to, Bynari Server 4.3 or neonBynari 5.0.

Customizing the schemas.xml file allows you to configure your LDAP server settings for use with the address book. Once customized, this file can be copied to the:

C:\Program Files\Bynari, Inc\Bynari AddressBook For Outlook

directory for each installation.

As mentioned in step 25 of section 4.2 (Configuring the Bynari AddressBook 3.0), it is recommended that a LDAP directory browser or similar tool be used to configure the schemas.xml file.

5.1 Schemas.xml structure

The schemas.xml file is organized into the following components:

  • objectClass value

    • userFilter

    • groupFilter

    • searchAttribute

    • attributes

5.1.1 objectClass

objectClasses are the means for including attributes – an “attribute container”. The objectClass is also an attribute itself and can be included in search queries. All attributes must be defined within an objectClass.

For the following description of the schemas.xml file, refer to the included schemas.xml file with the Bynari AddressBook 3.0.

The structure for the objectClass in the schemas.xml file:

<objectClass value=”neonBynariDomain description=”neonBynari Server”>

The Object Identifier (OID) is neonBynariDomain which is the global unique identifier for this objectClass.

5.1.2 userFilter

The userFilter is used to search for users in the LDAP database at the sub-domain level. Contained within the userFilter attribute is at least one objectClass.

The structure for the userFilter in the schemas.xml file:

<userFilter>(|(objectClass=neonPerson)(objectClass=groupOfNames))</userFilter>

The objectClass “neonPerson” refers to the actual username; the objectClass “groupOfNames” refers to the LDAP group where this user belongs.

5.1.3 groupFilter

The groupFilter is used to search for groups in the LDAP database at the domain level. Contained within the groupFilter attribute is at least one objectClass.

The structure for the groupFilter in the schemas.xml file:

<groupFilter>(|(objectClass=organization)(objectClass=neonBynariDomain)(objectClass=dcObject))</groupFilter>

The objectClasses “organization”, “neonBynariDomain”, and “dcObject” are all objectClass components of the Domain Component.

5.1.4 searchAttribute

The searchAttribute is a custom attribute developed for the purpose of name resolution in user-level queries. This attribute does not contain an objectClass attribute.

The structure for the searchAttribute in the schemas.xml file:

<searchAttribute>cn;mail;givenName;sn</searchAttribute>

The criteria used in the search attribute can be changed to meet your LDAP structural needs. This information can be found with the user’s container name or unique identifier in the LDAP database. An LDAP browser can quickly display these parameters. In this example, the data refers to the following information:

  • cn = Container Name. Typically, this is the user’s full name.

  • mail = User’s email address

  • givenName = Typically, this is the user’s first name.

  • sn = Surname or last name

5.1.5 attributes

The attributes section of the schemas.xml file contains information related to the specific user. The following is a list of the parameters of the attributes section:

<FirstName>givenName</FirstName>

<LastName>sn</LastName>

<DisplayName>cn</DisplayName>

<EmailAddress>mail</EmailAddress>

<Street>street</Street>

<PostOfficeBox>postOfficeBox</PostOfficeBox>

<City>l</City>

<State>st</State>

<PostalCode>postalCode</PostalCode>

<Department>departmentName</Department>

<HomePhone>homePhone</HomePhone>

<CellPhone>mobile</CellPhone>

<OfficePhone>employeeNumber</OfficePhone>

<PagerNumber>pager</PagerNumber>

<FaxNumber>facsimileTelephoneNumber</FaxNumber>

<TelexNumber>telexNumber</TelexNumber>

<Title>title</Title>

<OfficeName>departmentNumber</OfficeName>

<Description>description</Description>

<Server>mailHost</Server>

<Alias>mailAlias</Alias>

<DistinguishedName>dn</DistinguishedName>

6 Using the Bynari AddressBook 3.0

To use the Bynari AddressBook 3.0, go to the same standard Outlook address book. The Bynari AddressBook 3.0 is accessed by selecting the address book icon in the Outlook tool bar or by using the “To…”, “CC…”, or “BCC…” options when composing an email.

6.1 Outlook address book icon

Using the address book icon will open the Bynari AddressBook 3.0 dialog window.

Figure 14 – Bynari AddressBook 3.0 dialog

In this dialog window, all of the users within the LDAP searchAttribute (for details see section 5.1.4) are displayed. This dialog window also gives you the ability to view detailed, published user information. By double-clicking on a username, a properties dialog window will open displaying further details about the user, if provided.

Figure 15 – Bynari AddressBook 3.0 user properties

Selecting the “Add to Contacts” button will automatically insert the displayed information into a Microsoft Outlook™ contact form. Information can be quickly transferred into your personal contacts from the LDAP server.

6.2 Using To, CC, BCC

When composing an email and using the “To…”, “CC…”, or “BCC…” options, a different Bynari AddressBook 3.0 dialog window will open.

Figure 16 – Bynari AddressBook 3.0 Using To…, CC…, or BCC…

To address your email, select the person’s name and press either the “To ->”, “Cc ->”, or “Bcc ->” buttons at the bottom. To select multiple names, hold down the Ctrl key and select with the mouse.

6.3 Search Feature

The search feature of AddressBook 3.0 allows for custom searching of users within their groups or searches throughout the LDAP directory (deep search).

To perform a search, the Outlook address book dialog window must be opened. Below are examples of what Outlook 2003-2007 address book windows looks like. The search button has been highlighted in each of the following examples as well.

Figure 17 – Bynari AddressBook 3.0 – Outlook 2003 address book

Figure 18 – Bynari AddressBook 3.0 – Outlook 2007 address book

Selecting the search button in the Outlook address book window will display the Bynari AddressBook 3.0 deep search tool.

Figure 19 – Bynari AddressBook 3.0 – Search Tool

The search tool will search within the container that is displayed in the Outlook address book. For example, if the “All Users” container is selected, the search tool will search through all users. If the “Sales” container was selected, then the search would be limited to the “Sales” container.

Figure 20 – Bynari AddressBook 3.0 – All User Container

When entering search criteria, partial names or even single letters can be used to broaden the search. Search results will be displayed in the Outlook address book under the heading, “Search Results” (see figure below).

NOTE: The deep search tool searches the actual LDAP database NOT the local cache. Network connectivity to the LDAP database is required when using the search tool.

“Search All Subcontainers” is the component that actually performs the deep search function. For best results, leave this feature enabled.

6.4 Outlook Contacts

The Bynari AddressBook 3.0 also gives you the ability to select contacts from the Outlook Contacts folder.

Figure 21 – Bynari AddressBook 3.0 Outlook Contacts

Once the names have been selected, press “OK” to insert them into the email you are composing.

7 Registering Bynari AddressBook 3.0

The Bynari AddressBook 3.0 requires a license key for proper registration. License keys can be obtained by contacting sales@bynari.net.

NOTE: The license key for Bynari AddressBook 3.0 is different from the license key in Bynari AddressBook 2.0. If you are upgrading from Bynari AddressBook 2.0, please contact sales@bynari.net for a new license key.

To register the Bynari AddressBook 3.0, open the Bynari AddressBook 3.0 configuration window. For details on locating the configuration window, see section 4.3 “Configuring the Bynari AddressBook 3.0” in this guide. Once the configuration window is open, select the “About” tab.

Figure 22 – Bynari AddressBook 3.0 – Registration

Selecting the “License” button will open a new dialog window.

Figure 23 – Bynari AddressBook 3.0 – Registration

In this dialog window, enter the Bynari AddressBook 3.0 license key code and select “OK”. Selecting “OK” will display a license key confirmation dialog window.

If the workstation being registered is behind a firewall or if port 80 is blocked, port 3080 can be configured by using the pull-down menu.

Figure 24 – Bynari AddressBook 3.0 – Registration

The Bynari AddressBook 3.0 can also be unregistered from this window by selecting the “Unregister” button. Select “OK” to close this window and finish the registration process.

Figure 25 – Bynari AddressBook 3.0 – Registration

When the Bynari AddressBook 3.0 is fully registered, it displays the expiration date on the “About” tab as seen above.

NOTE: If technical assistance is required, Bynari technical support staff will ask for the software version number. This number is located on the “About” tab. In the figure above, it is highlighted in red.

7.1 Manual Registration

If the product fails to register through the normal registration process, manual registration will be required.

Following the steps outlined in section 4.3 “Configuring the Bynari AddressBook 3.0”, open the Bynari AddressBook 3.0 configuration window. Select the “About” tab and then select the “License” button.

NOTE: Manual registration requires a certificate. This certificate is obtained through Bynari support. Email your license key to support@bynari.net and request a manual registration certificate.

Figure 26 – Bynari AddressBook 3.0 – Manual Registration

To enable manual registration, select the “Manual Registration” checkbox as shown in the figure above. This will make the area titled, “Enter the license certificate below:”, active.

Enter the license key on the line titled, “Enter your product license key:”. In the certificate window at the bottom, enter the entire license certificate starting with:

—–BEGIN PGP SIGNED MESSAGE—–

and ending with:

—–END PGP SIGNATURE—–

Select “OK” when all of the information has been entered. Confirm the license as in the steps above by selecting “OK” on the license confirmation window. Select “OK” to close the Bynari AddressBook 3.0 configuration dialog window. Select “Finish” to close the Outlook E-mail Accounts dialog window.

8 Reporting Problems

When reporting problems, be sure to include the following information:

  • Microsoft Windows version number and patch level.

    • Right-click the My Computer icon on the Desktop and select Properties. The Windows version and patch level will be listed under System: in the General tab dialog.

  • Microsoft Outlook version and patch level.

    • Right-click Help in Outlook and select About Microsoft Outlook. The Outlook version and patch level will be listed.

  • The full version number of the Bynari AddressBook.

    • In Outlook select Tools > Email Accounts > View or change existing directories or address books.

    • Next > Bynari AddressBook 3.0 > Change

    • Select the About tab.

    • The AddressBook version number will be listed.

To contact technical support:

U.S. Toll Free Telephone: 1-800-241-1086
International Telephone: 001-214-350-5772

To open a new support ticket: http://www.bynari.net/support/

For FAQs: http://www.bynari.net/users/kb.php

Bynari AddressBook 3.0

Administrator’s Guide

Trademarks

Bynari products are trademarks of Bynari, Inc.

Microsoft Windows, Microsoft Outlook and Windows logos are trademarks of Microsoft Corporation in the United States, other countries, or both.

All other trademarks are the property of their respective owners.

Technical Support

When you purchase any of the Bynari’s products, the products include one year of free support and maintenance. To purchase additional yearly support and maintenance, please contact sales@bynari.net.

With Support, customers receive one year of product maintenance, upgrades and unlimited email and telephone support.

Support is available to customers worldwide.

To contact technical support:

U.S. Toll Free Telephone: 1-800-241-1086
International Telephone: 001-214-350-5772

To open a new support ticket: http://www.bynari.net/support/

For FAQs: http://www.bynari.net/users/kb.php

Table of Contents

Bynari AddressBook 3.0

The Bynari AddressBook is a fully LDAP 2 and LDAP 3 compliant query tool designed to integrate seamlessly with Microsoft Outlook™ (2003-2010).

The Bynari AddressBook is capable of querying any OpenLDAP, Active Directory, or LDAP 2/LDAP3 compliant database.

The Bynari AddressBook is fully compatible with, and certified for use on Univention Corporate Server.

1 Features

Here are some of the features found in the new Bynari AddressBook 3.0:

  • XML Schema file for quick global configuration

  • Automatic discovery of ObjectClass attributes (when using XML schema)

  • Detect Filters

  • LDAP attributes are now editable from within the Bynari AddressBook configuration dialog window.

  • Sort results by: First Name, Last Name, Display Name, or Email Address.

  • Auto-detection of LDAP version

  • Configurable display columns

  • Display “all user” feature

  • Full compatibility with Outlook 2007 and Outlook 2010

2 Supported Platforms

The Bynari AddressBook 3.0 is compatible with all current Microsoft Outlook™ versions from Outlook 2003 – 2010. The Bynari AddressBook 3.0 is also fully compatible with all current Microsoft operating systems:

  • Windows XP Pro

  • Windows 7/Vista

Note: Installation of the Bynari AddressBook requires administrator rights to the local desktop.

3 Prerequisites

Because Bynari AddressBook 3.0 is not resource intensive, the minimum system requirements needed to run your Windows’ operating system are more than sufficient. It is highly recommended that all Microsoft updates and Office patches and Service Packs be installed prior to installing the Bynari AddressBook 3.0.

Needed Information:

  • LDAP Server Fully Qualified Domain Name (FQDN) or IP Address

  • LDAP Port number (389 is the default)

  • User Distinguished Name (DN)

  • User Password

  • Container Distinguished Names

For the configuration of the schemas.xml file, the administrator will need to know the general architecture of your LDAP server. For administrators that are unfamiliar with their LDAP architecture, there are tools available that can simplify this task:

4 Installation and Configuration

4.1 Installing the Bynari AddressBook 3.0

The following steps will install the Bynari AddressBook 3.0.

  1. Unzip the compressed file.

  2. Double-click the executable that you just unzipped.

  3. Select “Next” on the welcome dialog window
    Figure 1 – Bynari AddressBook 3.0 – Installation
  4. Accept the End User License Agreement by selecting “I accept the agreement”

     

Figure 2 – Bynari AddressBook 3.0 – EULA

  1. Accept the default installation location or specify another location and select “Next”.

Figure 3 – Bynari AddressBook 3.0 – Installation Location

  1. Select the “Install” button. The necessary files will now be installed on your pc.

    Figure 4 – Bynari AddressBook 3.0 – Install

  2. Select “Run Outlook” to start Outlook.

    Figure 5 – Bynari AddressBook 3.0 – Installation Complete

  3. The Bynari AddressBook 3.0 registration page will display immediately after the “Finish” button is selected. For 30 day evaluation mode, fill in the information on the form and select “30 Days Evaluation”. For users with a license, select “Skip”.

4.2 Upgrading from previous versions

Upgrading from the Bynari AddressBook 2.0 is easy. The Bynari AddressBook 3.0 installation process automatically looks for previous versions of Bynari AddressBook. If a prior version is found the settings are retrieved from it and copied over to the new version. There is no need to reconfigure the newly installed Bynari AddressBook 3.0. When Outlook is restarted the new software will already be configured and ready for use.

NOTE: Bynari AddressBook 3.0 uses a completely different license code than Bynari AddressBook 2.0. You can get a new license, prior to installation, by contacting Bynari.

4.3 Configuring the Bynari AddressBook 3.0

The following steps will help you to configure the Bynari AddressBook 3.0 with your LDAP server.

  1. Open Outlook.

    1. Outlook 2003

      1. Select Tools > Email Accounts > Directory > Add a new directory or address book > Additional Address Books > Bynari AddressBook 3.0

    2. Outlook 2007 and 2010

      1. Select Tools > Account Settings > Address Books > New > Additional Address Books > Bynari AddressBook 3.0

  2. The Bynari AddressBook 3.0 configuration window is now displayed.

NOTE: the information entered in the figure below would not normally be displayed during this step of the installation process. It is displayed here as an example.

4.3.1 General Tab

Figure 6 – Bynari AddressBook 3.0 – LDAP Configuration

  1. LDAP Server:
    Enter the Fully Qualified Domain Name (FQDN) or IP Address for the LDAP server.

  2. Port: 389 by default

  3. Use SSL:
    If your LDAP server uses SSL, place a check in this box.

  4. Login Anonymously:
    If your LDAP server supports anonymous login, place a check in this box.

  5. User DN:
    The User DN (Distinguished Name) is comprised of a unique identifier for the user and the domain container. In the figure above, the unique identifier is the entry “cn=” in the LDAP database followed by the domain or organizational information. Some LDAP databases are configured with domain components (dc) while others are configured to utilize organizational units (ou).

  6. User Password: Enter the user’s password

  7. Select the checkbox next to “Remember Password”.

  8. Select the “Test LDAP” button. If your configuration parameters in steps 5-10 are correct, the “Successfully Connected” dialog window will be displayed:

Figure 7 – Bynari AddressBook 3.0 Test LDAP

  1. Select “OK” to close the “Successfully Connected” dialog window.

  2. Select the “Search” button to open the Container DN search dialog window.

  3. Figure 8 – Bynari AddressBook 3.0 Search Container
  1. Select the domain component (dc) or organizational unit as needed. Some LDAP structures use domain components while others utilize organizational units (ou). Data entered here will depend on your organization’s LDAP structure.

  2. Select “OK” when all required components have been selected.

  3. The “Container DNs:” window will display the domain component (dc) or organizational units (ou).

Figure 9 – Bynari AddressBook 3.0 Container DNs

4.3.2 Display Tab

On the “Display” tab, you can configure the actual Display Name of the address book. You can also modify the display columns as shown in the AddressBook by selecting “Configure Display Columns”.

Figure 10 – Bynari AddressBook 3.0 Configure Display Columns

  1. By default, all items are displayed in the address book view. To modify what content is displayed, select the items you want to remove and then press the “Delete” button in the center of this dialog window. You can also change the order of the displayed items by highlighting the item and using the “Move Up” or “Move Down” buttons.

  2. When finished modifying the column display, select “OK”.

  3. Display all users under “All Users” group container.
    By selecting this option, all users will be displayed within the AddressBook display pane. All groups, mailing lists, etc will be displayed when this option is selected.

Figure 11 – Bynari AddressBook 3.0 Display All Users

4.3.3 Advanced Tab

The Advanced tab contains all of the options for LDAP searches. By default, the AddressBook 3.0 will recognize both the Bynari Server 4.3 and neonBynari 5.0 LDAP schemas. It will also “auto-populate” the LDAP search filters with the correct objectClass information.

Figure 12 – Bynari AddressBook 3.0 Advanced Filters

  1. The “Sort returned results by:” the pull-down menu on the right side of this window allows you to select how you want the results to be displayed.
    Options are:

  1. First Name

  2. Last Name

  3. Display Name

  4. Email Address

  1. Display all results in a single container (deep search).
    This option will automatically turn on the deep search feature used with the Bynari AddressBook 3.0 search tool. For more information on the search tool see section 6.3 Search Feature.

  2. The LDAP Filters for Users, LDAP Filter for Groups, and LDAP Search Attributes can all be configured independently on this screen. These attributes can also be configured through the schemas.xml file that accompanies the installation of the Bynari AddressBook 3.0. This default location for the schemas.xml file is:
    C:\Program Files\Bynari, Inc\Bynari AddressBook For Outlook

  3. Editing the schemas.xml file requires an understanding of your LDAP structure. Utilizing tools such as LDAP browsers can be helpful during this part of the process. Once you have your objectClass parameters and LDAP Search Attributes configured in the schemas.xml file, the file can be utilized for all subsequent installations by copying it to the directory noted in step 2. More information about the schemas.xml structure can be found in section 5 of this manual.

  4. LDAP Attributes:

Figure 13 – Bynari AddressBook 3.0 LDAP Attributes

  1. All fields in the LDAP Attributes dialog window are configurable. In the example shown in the figure above, the “Last Name” attribute was changed to “sn” and the “Display Name” was changed to “cn” to match the LDAP directory structure. As mentioned in step 3, an LDAP browser can be very helpful in configuring these parameters. Select “OK” when finished editing.

  2. Reset Filters:
    This option will reset the filters in the “Filters for Users”, “LDAP Filter for Groups”, and “LDAP Search Attributes” to match the schemas.xml file.

  3. Detect Filters:
    This option will detect which LDAP server you are using – provided that it is already configured in the schemas.xml file. This can be very useful for installations where multiple LDAP directories are used. A single schemas.xml file can be configured for multiple servers and used for multiple installations. By default, “Detect Filters” automatically recognizes Bynari Server and neonBynari Server LDAP schemas.

  4. BaseDN:
    The top level of the LDAP directory tree is the base, referred to as the “base DN”

    By Default Bynari Addressbook attempts to determine your LDAP base DN by your User DN, which you specified on the “General” tab. Here you may specify your base DN, if Bynari Addressbook is unable to determine your base DN or you get results other than expected.

  5. LDAP Server Version:
    This feature automatically detects if the LDAP server is version 2 or 3 and adjusts accordingly when the “Detect” button is selected.

  6. Clear Cache Now:
    The Bynari AddressBook 3.0 keeps a local cache of the LDAP directory. The local cache increases performance and reduces network traffic to the LDAP server. If a user loses access to an LDAP server (server goes offline or network outage), the local cache will allow the user to continue to function. Selecting the “Clear Cache Now” button will clear the local cache.

  1. Select “OK” when finished editing configuration fields.

4.3.4 Cache Tab

Clear Cache Now:
The Bynari AddressBook 3.0 keeps a local cache of the LDAP directory. The local cache increases performance and reduces network traffic to the LDAP server. If a user loses access to an LDAP server (server goes offline or network outage), the local cache will allow the user to continue to function. Selecting the “Clear Cache Now” button will clear the local cache.

4.3.5 About Tab

The About tab contains software version information and licensing information.

5 The schemas.xml file

The Bynari AddressBook 3.0 is capable of manual configuration or configuration using the schemas.xml file. The schemas.xml file, by default, is preconfigured for both the Bynari Server 4.3 and the neonBynari 5.0 LDAP schemas. By default, the Bynari AddressBook 3.0 will automatically detect which version of LDAP server you are connecting to, Bynari Server 4.3 or neonBynari 5.0.

Customizing the schemas.xml file allows you to configure your LDAP server settings for use with the address book. Once customized, this file can be copied to the:

C:\Program Files\Bynari, Inc\Bynari AddressBook For Outlook

directory for each installation.

As mentioned in step 25 of section 4.2 (Configuring the Bynari AddressBook 3.0), it is recommended that a LDAP directory browser or similar tool be used to configure the schemas.xml file.

5.1 Schemas.xml structure

The schemas.xml file is organized into the following components:

  • objectClass value

    • userFilter

    • groupFilter

    • searchAttribute

    • attributes

5.1.1 objectClass

objectClasses are the means for including attributes – an “attribute container”. The objectClass is also an attribute itself and can be included in search queries. All attributes must be defined within an objectClass.

For the following description of the schemas.xml file, refer to the included schemas.xml file with the Bynari AddressBook 3.0.

The structure for the objectClass in the schemas.xml file:

<objectClass value=”neonBynariDomain description=”neonBynari Server”>

The Object Identifier (OID) is neonBynariDomain which is the global unique identifier for this objectClass.

5.1.2 userFilter

The userFilter is used to search for users in the LDAP database at the sub-domain level. Contained within the userFilter attribute is at least one objectClass.

The structure for the userFilter in the schemas.xml file:

<userFilter>(|(objectClass=neonPerson)(objectClass=groupOfNames))</userFilter>

The objectClass “neonPerson” refers to the actual username; the objectClass “groupOfNames” refers to the LDAP group where this user belongs.

5.1.3 groupFilter

The groupFilter is used to search for groups in the LDAP database at the domain level. Contained within the groupFilter attribute is at least one objectClass.

The structure for the groupFilter in the schemas.xml file:

<groupFilter>(|(objectClass=organization)(objectClass=neonBynariDomain)(objectClass=dcObject))</groupFilter>

The objectClasses “organization”, “neonBynariDomain”, and “dcObject” are all objectClass components of the Domain Component.

5.1.4 searchAttribute

The searchAttribute is a custom attribute developed for the purpose of name resolution in user-level queries. This attribute does not contain an objectClass attribute.

The structure for the searchAttribute in the schemas.xml file:

<searchAttribute>cn;mail;givenName;sn</searchAttribute>

The criteria used in the search attribute can be changed to meet your LDAP structural needs. This information can be found with the user’s container name or unique identifier in the LDAP database. An LDAP browser can quickly display these parameters. In this example, the data refers to the following information:

  • cn = Container Name. Typically, this is the user’s full name.

  • mail = User’s email address

  • givenName = Typically, this is the user’s first name.

  • sn = Surname or last name

5.1.5 attributes

The attributes section of the schemas.xml file contains information related to the specific user. The following is a list of the parameters of the attributes section:

<FirstName>givenName</FirstName>

<LastName>sn</LastName>

<DisplayName>cn</DisplayName>

<EmailAddress>mail</EmailAddress>

<Street>street</Street>

<PostOfficeBox>postOfficeBox</PostOfficeBox>

<City>l</City>

<State>st</State>

<PostalCode>postalCode</PostalCode>

<Department>departmentName</Department>

<HomePhone>homePhone</HomePhone>

<CellPhone>mobile</CellPhone>

<OfficePhone>employeeNumber</OfficePhone>

<PagerNumber>pager</PagerNumber>

<FaxNumber>facsimileTelephoneNumber</FaxNumber>

<TelexNumber>telexNumber</TelexNumber>

<Title>title</Title>

<OfficeName>departmentNumber</OfficeName>

<Description>description</Description>

<Server>mailHost</Server>

<Alias>mailAlias</Alias>

<DistinguishedName>dn</DistinguishedName>

6 Using the Bynari AddressBook 3.0

To use the Bynari AddressBook 3.0, go to the same standard Outlook address book. The Bynari AddressBook 3.0 is accessed by selecting the address book icon in the Outlook tool bar or by using the “To…”, “CC…”, or “BCC…” options when composing an email.

6.1 Outlook address book icon

Using the address book icon will open the Bynari AddressBook 3.0 dialog window.

Figure 14 – Bynari AddressBook 3.0 dialog

In this dialog window, all of the users within the LDAP searchAttribute (for details see section 5.1.4) are displayed. This dialog window also gives you the ability to view detailed, published user information. By double-clicking on a username, a properties dialog window will open displaying further details about the user, if provided.

Figure 15 – Bynari AddressBook 3.0 user properties

Selecting the “Add to Contacts” button will automatically insert the displayed information into a Microsoft Outlook™ contact form. Information can be quickly transferred into your personal contacts from the LDAP server.

6.2 Using To, CC, BCC

When composing an email and using the “To…”, “CC…”, or “BCC…” options, a different Bynari AddressBook 3.0 dialog window will open.

Figure 16 – Bynari AddressBook 3.0 Using To…, CC…, or BCC…

To address your email, select the person’s name and press either the “To ->”, “Cc ->”, or “Bcc ->” buttons at the bottom. To select multiple names, hold down the Ctrl key and select with the mouse.

6.3 Search Feature

The search feature of AddressBook 3.0 allows for custom searching of users within their groups or searches throughout the LDAP directory (deep search).

To perform a search, the Outlook address book dialog window must be opened. Below are examples of what Outlook 2003-2007 address book windows looks like. The search button has been highlighted in each of the following examples as well.

Figure 17 – Bynari AddressBook 3.0 – Outlook 2003 address book

Figure 18 – Bynari AddressBook 3.0 – Outlook 2007 address book

Selecting the search button in the Outlook address book window will display the Bynari AddressBook 3.0 deep search tool.

Figure 19 – Bynari AddressBook 3.0 – Search Tool

The search tool will search within the container that is displayed in the Outlook address book. For example, if the “All Users” container is selected, the search tool will search through all users. If the “Sales” container was selected, then the search would be limited to the “Sales” container.

Figure 20 – Bynari AddressBook 3.0 – All User Container

When entering search criteria, partial names or even single letters can be used to broaden the search. Search results will be displayed in the Outlook address book under the heading, “Search Results” (see figure below).

NOTE: The deep search tool searches the actual LDAP database NOT the local cache. Network connectivity to the LDAP database is required when using the search tool.

“Search All Subcontainers” is the component that actually performs the deep search function. For best results, leave this feature enabled.

6.4 Outlook Contacts

The Bynari AddressBook 3.0 also gives you the ability to select contacts from the Outlook Contacts folder.

Figure 21 – Bynari AddressBook 3.0 Outlook Contacts

Once the names have been selected, press “OK” to insert them into the email you are composing.

7 Registering Bynari AddressBook 3.0

The Bynari AddressBook 3.0 requires a license key for proper registration. License keys can be obtained by contacting sales@bynari.net.

NOTE: The license key for Bynari AddressBook 3.0 is different from the license key in Bynari AddressBook 2.0. If you are upgrading from Bynari AddressBook 2.0, please contact sales@bynari.net for a new license key.

To register the Bynari AddressBook 3.0, open the Bynari AddressBook 3.0 configuration window. For details on locating the configuration window, see section 4.3 “Configuring the Bynari AddressBook 3.0” in this guide. Once the configuration window is open, select the “About” tab.

Figure 22 – Bynari AddressBook 3.0 – Registration

Selecting the “License” button will open a new dialog window.

Figure 23 – Bynari AddressBook 3.0 – Registration

In this dialog window, enter the Bynari AddressBook 3.0 license key code and select “OK”. Selecting “OK” will display a license key confirmation dialog window.

If the workstation being registered is behind a firewall or if port 80 is blocked, port 3080 can be configured by using the pull-down menu.

Figure 24 – Bynari AddressBook 3.0 – Registration

The Bynari AddressBook 3.0 can also be unregistered from this window by selecting the “Unregister” button. Select “OK” to close this window and finish the registration process.

Figure 25 – Bynari AddressBook 3.0 – Registration

When the Bynari AddressBook 3.0 is fully registered, it displays the expiration date on the “About” tab as seen above.

NOTE: If technical assistance is required, Bynari technical support staff will ask for the software version number. This number is located on the “About” tab. In the figure above, it is highlighted in red.

7.1 Manual Registration

If the product fails to register through the normal registration process, manual registration will be required.

Following the steps outlined in section 4.3 “Configuring the Bynari AddressBook 3.0”, open the Bynari AddressBook 3.0 configuration window. Select the “About” tab and then select the “License” button.

NOTE: Manual registration requires a certificate. This certificate is obtained through Bynari support. Email your license key to support@bynari.net and request a manual registration certificate.

Figure 26 – Bynari AddressBook 3.0 – Manual Registration

To enable manual registration, select the “Manual Registration” checkbox as shown in the figure above. This will make the area titled, “Enter the license certificate below:”, active.

Enter the license key on the line titled, “Enter your product license key:”. In the certificate window at the bottom, enter the entire license certificate starting with:

—–BEGIN PGP SIGNED MESSAGE—–

and ending with:

—–END PGP SIGNATURE—–

Select “OK” when all of the information has been entered. Confirm the license as in the steps above by selecting “OK” on the license confirmation window. Select “OK” to close the Bynari AddressBook 3.0 configuration dialog window. Select “Finish” to close the Outlook E-mail Accounts dialog window.

8 Reporting Problems

When reporting problems, be sure to include the following information:

  • Microsoft Windows version number and patch level.

    • Right-click the My Computer icon on the Desktop and select Properties. The Windows version and patch level will be listed under System: in the General tab dialog.

  • Microsoft Outlook version and patch level.

    • Right-click Help in Outlook and select About Microsoft Outlook. The Outlook version and patch level will be listed.

  • The full version number of the Bynari AddressBook.

    • In Outlook select Tools > Email Accounts > View or change existing directories or address books.

    • Next > Bynari AddressBook 3.0 > Change

    • Select the About tab.

    • The AddressBook version number will be listed.

To contact technical support:

U.S. Toll Free Telephone: 1-800-241-1086
International Telephone: 001-214-350-5772

To open a new support ticket: http://www.bynari.net/support/

For FAQs: http://www.bynari.net/users/kb.php

Bynari AddressBook 3.0

Administrator’s Guide

Trademarks

Bynari products are trademarks of Bynari, Inc.

Microsoft Windows, Microsoft Outlook and Windows logos are trademarks of Microsoft Corporation in the United States, other countries, or both.

All other trademarks are the property of their respective owners.

Technical Support

When you purchase any of the Bynari’s products, the products include one year of free support and maintenance. To purchase additional yearly support and maintenance, please contact sales@bynari.net.

With Support, customers receive one year of product maintenance, upgrades and unlimited email and telephone support.

Support is available to customers worldwide.

To contact technical support:

U.S. Toll Free Telephone: 1-800-241-1086
International Telephone: 001-214-350-5772

To open a new support ticket: http://www.bynari.net/support/

For FAQs: http://www.bynari.net/users/kb.php

Table of Contents

Bynari AddressBook 3.0

The Bynari AddressBook is a fully LDAP 2 and LDAP 3 compliant query tool designed to integrate seamlessly with Microsoft Outlook™ (2003-2010).

The Bynari AddressBook is capable of querying any OpenLDAP, Active Directory, or LDAP 2/LDAP3 compliant database.

The Bynari AddressBook is fully compatible with, and certified for use on Univention Corporate Server.

1 Features

Here are some of the features found in the new Bynari AddressBook 3.0:

  • XML Schema file for quick global configuration

  • Automatic discovery of ObjectClass attributes (when using XML schema)

  • Detect Filters

  • LDAP attributes are now editable from within the Bynari AddressBook configuration dialog window.

  • Sort results by: First Name, Last Name, Display Name, or Email Address.

  • Auto-detection of LDAP version

  • Configurable display columns

  • Display “all user” feature

  • Full compatibility with Outlook 2007 and Outlook 2010

2 Supported Platforms

The Bynari AddressBook 3.0 is compatible with all current Microsoft Outlook™ versions from Outlook 2003 – 2010. The Bynari AddressBook 3.0 is also fully compatible with all current Microsoft operating systems:

  • Windows XP Pro

  • Windows 7/Vista

Note: Installation of the Bynari AddressBook requires administrator rights to the local desktop.

3 Prerequisites

Because Bynari AddressBook 3.0 is not resource intensive, the minimum system requirements needed to run your Windows’ operating system are more than sufficient. It is highly recommended that all Microsoft updates and Office patches and Service Packs be installed prior to installing the Bynari AddressBook 3.0.

Needed Information:

  • LDAP Server Fully Qualified Domain Name (FQDN) or IP Address

  • LDAP Port number (389 is the default)

  • User Distinguished Name (DN)

  • User Password

  • Container Distinguished Names

For the configuration of the schemas.xml file, the administrator will need to know the general architecture of your LDAP server. For administrators that are unfamiliar with their LDAP architecture, there are tools available that can simplify this task:

4 Installation and Configuration

4.1 Installing the Bynari AddressBook 3.0

The following steps will install the Bynari AddressBook 3.0.

  1. Unzip the compressed file.

  2. Double-click the executable that you just unzipped.

  3. Select “Next” on the welcome dialog window
    Figure 1 – Bynari AddressBook 3.0 – Installation
  4. Accept the End User License Agreement by selecting “I accept the agreement”

     

Figure 2 – Bynari AddressBook 3.0 – EULA

  1. Accept the default installation location or specify another location and select “Next”.

Figure 3 – Bynari AddressBook 3.0 – Installation Location

  1. Select the “Install” button. The necessary files will now be installed on your pc.

    Figure 4 – Bynari AddressBook 3.0 – Install

  2. Select “Run Outlook” to start Outlook.

    Figure 5 – Bynari AddressBook 3.0 – Installation Complete

  3. The Bynari AddressBook 3.0 registration page will display immediately after the “Finish” button is selected. For 30 day evaluation mode, fill in the information on the form and select “30 Days Evaluation”. For users with a license, select “Skip”.

4.2 Upgrading from previous versions

Upgrading from the Bynari AddressBook 2.0 is easy. The Bynari AddressBook 3.0 installation process automatically looks for previous versions of Bynari AddressBook. If a prior version is found the settings are retrieved from it and copied over to the new version. There is no need to reconfigure the newly installed Bynari AddressBook 3.0. When Outlook is restarted the new software will already be configured and ready for use.

NOTE: Bynari AddressBook 3.0 uses a completely different license code than Bynari AddressBook 2.0. You can get a new license, prior to installation, by contacting Bynari.

4.3 Configuring the Bynari AddressBook 3.0

The following steps will help you to configure the Bynari AddressBook 3.0 with your LDAP server.

  1. Open Outlook.

    1. Outlook 2003

      1. Select Tools > Email Accounts > Directory > Add a new directory or address book > Additional Address Books > Bynari AddressBook 3.0

    2. Outlook 2007 and 2010

      1. Select Tools > Account Settings > Address Books > New > Additional Address Books > Bynari AddressBook 3.0

  2. The Bynari AddressBook 3.0 configuration window is now displayed.

NOTE: the information entered in the figure below would not normally be displayed during this step of the installation process. It is displayed here as an example.

4.3.1 General Tab

Figure 6 – Bynari AddressBook 3.0 – LDAP Configuration

  1. LDAP Server:
    Enter the Fully Qualified Domain Name (FQDN) or IP Address for the LDAP server.

  2. Port: 389 by default

  3. Use SSL:
    If your LDAP server uses SSL, place a check in this box.

  4. Login Anonymously:
    If your LDAP server supports anonymous login, place a check in this box.

  5. User DN:
    The User DN (Distinguished Name) is comprised of a unique identifier for the user and the domain container. In the figure above, the unique identifier is the entry “cn=” in the LDAP database followed by the domain or organizational information. Some LDAP databases are configured with domain components (dc) while others are configured to utilize organizational units (ou).

  6. User Password: Enter the user’s password

  7. Select the checkbox next to “Remember Password”.

  8. Select the “Test LDAP” button. If your configuration parameters in steps 5-10 are correct, the “Successfully Connected” dialog window will be displayed:

Figure 7 – Bynari AddressBook 3.0 Test LDAP

  1. Select “OK” to close the “Successfully Connected” dialog window.

  2. Select the “Search” button to open the Container DN search dialog window.

  3. Figure 8 – Bynari AddressBook 3.0 Search Container
  1. Select the domain component (dc) or organizational unit as needed. Some LDAP structures use domain components while others utilize organizational units (ou). Data entered here will depend on your organization’s LDAP structure.

  2. Select “OK” when all required components have been selected.

  3. The “Container DNs:” window will display the domain component (dc) or organizational units (ou).

Figure 9 – Bynari AddressBook 3.0 Container DNs

4.3.2 Display Tab

On the “Display” tab, you can configure the actual Display Name of the address book. You can also modify the display columns as shown in the AddressBook by selecting “Configure Display Columns”.

Figure 10 – Bynari AddressBook 3.0 Configure Display Columns

  1. By default, all items are displayed in the address book view. To modify what content is displayed, select the items you want to remove and then press the “Delete” button in the center of this dialog window. You can also change the order of the displayed items by highlighting the item and using the “Move Up” or “Move Down” buttons.

  2. When finished modifying the column display, select “OK”.

  3. Display all users under “All Users” group container.
    By selecting this option, all users will be displayed within the AddressBook display pane. All groups, mailing lists, etc will be displayed when this option is selected.

Figure 11 – Bynari AddressBook 3.0 Display All Users

4.3.3 Advanced Tab

The Advanced tab contains all of the options for LDAP searches. By default, the AddressBook 3.0 will recognize both the Bynari Server 4.3 and neonBynari 5.0 LDAP schemas. It will also “auto-populate” the LDAP search filters with the correct objectClass information.

Figure 12 – Bynari AddressBook 3.0 Advanced Filters

  1. The “Sort returned results by:” the pull-down menu on the right side of this window allows you to select how you want the results to be displayed.
    Options are:

  1. First Name

  2. Last Name

  3. Display Name

  4. Email Address

  1. Display all results in a single container (deep search).
    This option will automatically turn on the deep search feature used with the Bynari AddressBook 3.0 search tool. For more information on the search tool see section 6.3 Search Feature.

  2. The LDAP Filters for Users, LDAP Filter for Groups, and LDAP Search Attributes can all be configured independently on this screen. These attributes can also be configured through the schemas.xml file that accompanies the installation of the Bynari AddressBook 3.0. This default location for the schemas.xml file is:
    C:\Program Files\Bynari, Inc\Bynari AddressBook For Outlook

  3. Editing the schemas.xml file requires an understanding of your LDAP structure. Utilizing tools such as LDAP browsers can be helpful during this part of the process. Once you have your objectClass parameters and LDAP Search Attributes configured in the schemas.xml file, the file can be utilized for all subsequent installations by copying it to the directory noted in step 2. More information about the schemas.xml structure can be found in section 5 of this manual.

  4. LDAP Attributes:

Figure 13 – Bynari AddressBook 3.0 LDAP Attributes

  1. All fields in the LDAP Attributes dialog window are configurable. In the example shown in the figure above, the “Last Name” attribute was changed to “sn” and the “Display Name” was changed to “cn” to match the LDAP directory structure. As mentioned in step 3, an LDAP browser can be very helpful in configuring these parameters. Select “OK” when finished editing.

  2. Reset Filters:
    This option will reset the filters in the “Filters for Users”, “LDAP Filter for Groups”, and “LDAP Search Attributes” to match the schemas.xml file.

  3. Detect Filters:
    This option will detect which LDAP server you are using – provided that it is already configured in the schemas.xml file. This can be very useful for installations where multiple LDAP directories are used. A single schemas.xml file can be configured for multiple servers and used for multiple installations. By default, “Detect Filters” automatically recognizes Bynari Server and neonBynari Server LDAP schemas.

  4. BaseDN:
    The top level of the LDAP directory tree is the base, referred to as the “base DN”

    By Default Bynari Addressbook attempts to determine your LDAP base DN by your User DN, which you specified on the “General” tab. Here you may specify your base DN, if Bynari Addressbook is unable to determine your base DN or you get results other than expected.

  5. LDAP Server Version:
    This feature automatically detects if the LDAP server is version 2 or 3 and adjusts accordingly when the “Detect” button is selected.

  6. Clear Cache Now:
    The Bynari AddressBook 3.0 keeps a local cache of the LDAP directory. The local cache increases performance and reduces network traffic to the LDAP server. If a user loses access to an LDAP server (server goes offline or network outage), the local cache will allow the user to continue to function. Selecting the “Clear Cache Now” button will clear the local cache.

  1. Select “OK” when finished editing configuration fields.

4.3.4 Cache Tab

Clear Cache Now:
The Bynari AddressBook 3.0 keeps a local cache of the LDAP directory. The local cache increases performance and reduces network traffic to the LDAP server. If a user loses access to an LDAP server (server goes offline or network outage), the local cache will allow the user to continue to function. Selecting the “Clear Cache Now” button will clear the local cache.

4.3.5 About Tab

The About tab contains software version information and licensing information.

5 The schemas.xml file

The Bynari AddressBook 3.0 is capable of manual configuration or configuration using the schemas.xml file. The schemas.xml file, by default, is preconfigured for both the Bynari Server 4.3 and the neonBynari 5.0 LDAP schemas. By default, the Bynari AddressBook 3.0 will automatically detect which version of LDAP server you are connecting to, Bynari Server 4.3 or neonBynari 5.0.

Customizing the schemas.xml file allows you to configure your LDAP server settings for use with the address book. Once customized, this file can be copied to the:

C:\Program Files\Bynari, Inc\Bynari AddressBook For Outlook

directory for each installation.

As mentioned in step 25 of section 4.2 (Configuring the Bynari AddressBook 3.0), it is recommended that a LDAP directory browser or similar tool be used to configure the schemas.xml file.

5.1 Schemas.xml structure

The schemas.xml file is organized into the following components:

  • objectClass value

    • userFilter

    • groupFilter

    • searchAttribute

    • attributes

5.1.1 objectClass

objectClasses are the means for including attributes – an “attribute container”. The objectClass is also an attribute itself and can be included in search queries. All attributes must be defined within an objectClass.

For the following description of the schemas.xml file, refer to the included schemas.xml file with the Bynari AddressBook 3.0.

The structure for the objectClass in the schemas.xml file:

<objectClass value=”neonBynariDomain description=”neonBynari Server”>

The Object Identifier (OID) is neonBynariDomain which is the global unique identifier for this objectClass.

5.1.2 userFilter

The userFilter is used to search for users in the LDAP database at the sub-domain level. Contained within the userFilter attribute is at least one objectClass.

The structure for the userFilter in the schemas.xml file:

<userFilter>(|(objectClass=neonPerson)(objectClass=groupOfNames))</userFilter>

The objectClass “neonPerson” refers to the actual username; the objectClass “groupOfNames” refers to the LDAP group where this user belongs.

5.1.3 groupFilter

The groupFilter is used to search for groups in the LDAP database at the domain level. Contained within the groupFilter attribute is at least one objectClass.

The structure for the groupFilter in the schemas.xml file:

<groupFilter>(|(objectClass=organization)(objectClass=neonBynariDomain)(objectClass=dcObject))</groupFilter>

The objectClasses “organization”, “neonBynariDomain”, and “dcObject” are all objectClass components of the Domain Component.

5.1.4 searchAttribute

The searchAttribute is a custom attribute developed for the purpose of name resolution in user-level queries. This attribute does not contain an objectClass attribute.

The structure for the searchAttribute in the schemas.xml file:

<searchAttribute>cn;mail;givenName;sn</searchAttribute>

The criteria used in the search attribute can be changed to meet your LDAP structural needs. This information can be found with the user’s container name or unique identifier in the LDAP database. An LDAP browser can quickly display these parameters. In this example, the data refers to the following information:

  • cn = Container Name. Typically, this is the user’s full name.

  • mail = User’s email address

  • givenName = Typically, this is the user’s first name.

  • sn = Surname or last name

5.1.5 attributes

The attributes section of the schemas.xml file contains information related to the specific user. The following is a list of the parameters of the attributes section:

<FirstName>givenName</FirstName>

<LastName>sn</LastName>

<DisplayName>cn</DisplayName>

<EmailAddress>mail</EmailAddress>

<Street>street</Street>

<PostOfficeBox>postOfficeBox</PostOfficeBox>

<City>l</City>

<State>st</State>

<PostalCode>postalCode</PostalCode>

<Department>departmentName</Department>

<HomePhone>homePhone</HomePhone>

<CellPhone>mobile</CellPhone>

<OfficePhone>employeeNumber</OfficePhone>

<PagerNumber>pager</PagerNumber>

<FaxNumber>facsimileTelephoneNumber</FaxNumber>

<TelexNumber>telexNumber</TelexNumber>

<Title>title</Title>

<OfficeName>departmentNumber</OfficeName>

<Description>description</Description>

<Server>mailHost</Server>

<Alias>mailAlias</Alias>

<DistinguishedName>dn</DistinguishedName>

6 Using the Bynari AddressBook 3.0

To use the Bynari AddressBook 3.0, go to the same standard Outlook address book. The Bynari AddressBook 3.0 is accessed by selecting the address book icon in the Outlook tool bar or by using the “To…”, “CC…”, or “BCC…” options when composing an email.

6.1 Outlook address book icon

Using the address book icon will open the Bynari AddressBook 3.0 dialog window.

Figure 14 – Bynari AddressBook 3.0 dialog

In this dialog window, all of the users within the LDAP searchAttribute (for details see section 5.1.4) are displayed. This dialog window also gives you the ability to view detailed, published user information. By double-clicking on a username, a properties dialog window will open displaying further details about the user, if provided.

Figure 15 – Bynari AddressBook 3.0 user properties

Selecting the “Add to Contacts” button will automatically insert the displayed information into a Microsoft Outlook™ contact form. Information can be quickly transferred into your personal contacts from the LDAP server.

6.2 Using To, CC, BCC

When composing an email and using the “To…”, “CC…”, or “BCC…” options, a different Bynari AddressBook 3.0 dialog window will open.

Figure 16 – Bynari AddressBook 3.0 Using To…, CC…, or BCC…

To address your email, select the person’s name and press either the “To ->”, “Cc ->”, or “Bcc ->” buttons at the bottom. To select multiple names, hold down the Ctrl key and select with the mouse.

6.3 Search Feature

The search feature of AddressBook 3.0 allows for custom searching of users within their groups or searches throughout the LDAP directory (deep search).

To perform a search, the Outlook address book dialog window must be opened. Below are examples of what Outlook 2003-2007 address book windows looks like. The search button has been highlighted in each of the following examples as well.

Figure 17 – Bynari AddressBook 3.0 – Outlook 2003 address book

Figure 18 – Bynari AddressBook 3.0 – Outlook 2007 address book

Selecting the search button in the Outlook address book window will display the Bynari AddressBook 3.0 deep search tool.

Figure 19 – Bynari AddressBook 3.0 – Search Tool

The search tool will search within the container that is displayed in the Outlook address book. For example, if the “All Users” container is selected, the search tool will search through all users. If the “Sales” container was selected, then the search would be limited to the “Sales” container.

Figure 20 – Bynari AddressBook 3.0 – All User Container

When entering search criteria, partial names or even single letters can be used to broaden the search. Search results will be displayed in the Outlook address book under the heading, “Search Results” (see figure below).

NOTE: The deep search tool searches the actual LDAP database NOT the local cache. Network connectivity to the LDAP database is required when using the search tool.

“Search All Subcontainers” is the component that actually performs the deep search function. For best results, leave this feature enabled.

6.4 Outlook Contacts

The Bynari AddressBook 3.0 also gives you the ability to select contacts from the Outlook Contacts folder.

Figure 21 – Bynari AddressBook 3.0 Outlook Contacts

Once the names have been selected, press “OK” to insert them into the email you are composing.

7 Registering Bynari AddressBook 3.0

The Bynari AddressBook 3.0 requires a license key for proper registration. License keys can be obtained by contacting sales@bynari.net.

NOTE: The license key for Bynari AddressBook 3.0 is different from the license key in Bynari AddressBook 2.0. If you are upgrading from Bynari AddressBook 2.0, please contact sales@bynari.net for a new license key.

To register the Bynari AddressBook 3.0, open the Bynari AddressBook 3.0 configuration window. For details on locating the configuration window, see section 4.3 “Configuring the Bynari AddressBook 3.0” in this guide. Once the configuration window is open, select the “About” tab.

Figure 22 – Bynari AddressBook 3.0 – Registration

Selecting the “License” button will open a new dialog window.

Figure 23 – Bynari AddressBook 3.0 – Registration

In this dialog window, enter the Bynari AddressBook 3.0 license key code and select “OK”. Selecting “OK” will display a license key confirmation dialog window.

If the workstation being registered is behind a firewall or if port 80 is blocked, port 3080 can be configured by using the pull-down menu.

Figure 24 – Bynari AddressBook 3.0 – Registration

The Bynari AddressBook 3.0 can also be unregistered from this window by selecting the “Unregister” button. Select “OK” to close this window and finish the registration process.

Figure 25 – Bynari AddressBook 3.0 – Registration

When the Bynari AddressBook 3.0 is fully registered, it displays the expiration date on the “About” tab as seen above.

NOTE: If technical assistance is required, Bynari technical support staff will ask for the software version number. This number is located on the “About” tab. In the figure above, it is highlighted in red.

7.1 Manual Registration

If the product fails to register through the normal registration process, manual registration will be required.

Following the steps outlined in section 4.3 “Configuring the Bynari AddressBook 3.0”, open the Bynari AddressBook 3.0 configuration window. Select the “About” tab and then select the “License” button.

NOTE: Manual registration requires a certificate. This certificate is obtained through Bynari support. Email your license key to support@bynari.net and request a manual registration certificate.

Figure 26 – Bynari AddressBook 3.0 – Manual Registration

To enable manual registration, select the “Manual Registration” checkbox as shown in the figure above. This will make the area titled, “Enter the license certificate below:”, active.

Enter the license key on the line titled, “Enter your product license key:”. In the certificate window at the bottom, enter the entire license certificate starting with:

—–BEGIN PGP SIGNED MESSAGE—–

and ending with:

—–END PGP SIGNATURE—–

Select “OK” when all of the information has been entered. Confirm the license as in the steps above by selecting “OK” on the license confirmation window. Select “OK” to close the Bynari AddressBook 3.0 configuration dialog window. Select “Finish” to close the Outlook E-mail Accounts dialog window.

8 Reporting Problems

When reporting problems, be sure to include the following information:

  • Microsoft Windows version number and patch level.

    • Right-click the My Computer icon on the Desktop and select Properties. The Windows version and patch level will be listed under System: in the General tab dialog.

  • Microsoft Outlook version and patch level.

    • Right-click Help in Outlook and select About Microsoft Outlook. The Outlook version and patch level will be listed.

  • The full version number of the Bynari AddressBook.

    • In Outlook select Tools > Email Accounts > View or change existing directories or address books.

    • Next > Bynari AddressBook 3.0 > Change

    • Select the About tab.

    • The AddressBook version number will be listed.

To contact technical support:

U.S. Toll Free Telephone: 1-800-241-1086
International Telephone: 001-214-350-5772

To open a new support ticket: http://www.bynari.net/support/

For FAQs: http://www.bynari.net/users/kb.php

Bynari AddressBook 3.0

Administrator’s Guide

Trademarks

Bynari products are trademarks of Bynari, Inc.

Microsoft Windows, Microsoft Outlook and Windows logos are trademarks of Microsoft Corporation in the United States, other countries, or both.

All other trademarks are the property of their respective owners.

Technical Support

When you purchase any of the Bynari’s products, the products include one year of free support and maintenance. To purchase additional yearly support and maintenance, please contact sales@bynari.net.

With Support, customers receive one year of product maintenance, upgrades and unlimited email and telephone support.

Support is available to customers worldwide.

To contact technical support:

U.S. Toll Free Telephone: 1-800-241-1086
International Telephone: 001-214-350-5772

To open a new support ticket: http://www.bynari.net/support/

For FAQs: http://www.bynari.net/users/kb.php

Table of Contents

Bynari AddressBook 3.0

The Bynari AddressBook is a fully LDAP 2 and LDAP 3 compliant query tool designed to integrate seamlessly with Microsoft Outlook™ (2003-2010).

The Bynari AddressBook is capable of querying any OpenLDAP, Active Directory, or LDAP 2/LDAP3 compliant database.

The Bynari AddressBook is fully compatible with, and certified for use on Univention Corporate Server.

1 Features

Here are some of the features found in the new Bynari AddressBook 3.0:

  • XML Schema file for quick global configuration

  • Automatic discovery of ObjectClass attributes (when using XML schema)

  • Detect Filters

  • LDAP attributes are now editable from within the Bynari AddressBook configuration dialog window.

  • Sort results by: First Name, Last Name, Display Name, or Email Address.

  • Auto-detection of LDAP version

  • Configurable display columns

  • Display “all user” feature

  • Full compatibility with Outlook 2007 and Outlook 2010

2 Supported Platforms

The Bynari AddressBook 3.0 is compatible with all current Microsoft Outlook™ versions from Outlook 2003 – 2010. The Bynari AddressBook 3.0 is also fully compatible with all current Microsoft operating systems:

  • Windows XP Pro

  • Windows 7/Vista

Note: Installation of the Bynari AddressBook requires administrator rights to the local desktop.

3 Prerequisites

Because Bynari AddressBook 3.0 is not resource intensive, the minimum system requirements needed to run your Windows’ operating system are more than sufficient. It is highly recommended that all Microsoft updates and Office patches and Service Packs be installed prior to installing the Bynari AddressBook 3.0.

Needed Information:

  • LDAP Server Fully Qualified Domain Name (FQDN) or IP Address

  • LDAP Port number (389 is the default)

  • User Distinguished Name (DN)

  • User Password

  • Container Distinguished Names

For the configuration of the schemas.xml file, the administrator will need to know the general architecture of your LDAP server. For administrators that are unfamiliar with their LDAP architecture, there are tools available that can simplify this task:

4 Installation and Configuration

4.1 Installing the Bynari AddressBook 3.0

The following steps will install the Bynari AddressBook 3.0.

  1. Unzip the compressed file.

  2. Double-click the executable that you just unzipped.

  3. Select “Next” on the welcome dialog window
    Figure 1 – Bynari AddressBook 3.0 – Installation
  4. Accept the End User License Agreement by selecting “I accept the agreement”

     

Figure 2 – Bynari AddressBook 3.0 – EULA

  1. Accept the default installation location or specify another location and select “Next”.

Figure 3 – Bynari AddressBook 3.0 – Installation Location

  1. Select the “Install” button. The necessary files will now be installed on your pc.

    Figure 4 – Bynari AddressBook 3.0 – Install

  2. Select “Run Outlook” to start Outlook.

    Figure 5 – Bynari AddressBook 3.0 – Installation Complete

  3. The Bynari AddressBook 3.0 registration page will display immediately after the “Finish” button is selected. For 30 day evaluation mode, fill in the information on the form and select “30 Days Evaluation”. For users with a license, select “Skip”.

4.2 Upgrading from previous versions

Upgrading from the Bynari AddressBook 2.0 is easy. The Bynari AddressBook 3.0 installation process automatically looks for previous versions of Bynari AddressBook. If a prior version is found the settings are retrieved from it and copied over to the new version. There is no need to reconfigure the newly installed Bynari AddressBook 3.0. When Outlook is restarted the new software will already be configured and ready for use.

NOTE: Bynari AddressBook 3.0 uses a completely different license code than Bynari AddressBook 2.0. You can get a new license, prior to installation, by contacting Bynari.

4.3 Configuring the Bynari AddressBook 3.0

The following steps will help you to configure the Bynari AddressBook 3.0 with your LDAP server.

  1. Open Outlook.

    1. Outlook 2003

      1. Select Tools > Email Accounts > Directory > Add a new directory or address book > Additional Address Books > Bynari AddressBook 3.0

    2. Outlook 2007 and 2010

      1. Select Tools > Account Settings > Address Books > New > Additional Address Books > Bynari AddressBook 3.0

  2. The Bynari AddressBook 3.0 configuration window is now displayed.

NOTE: the information entered in the figure below would not normally be displayed during this step of the installation process. It is displayed here as an example.

4.3.1 General Tab

Figure 6 – Bynari AddressBook 3.0 – LDAP Configuration

  1. LDAP Server:
    Enter the Fully Qualified Domain Name (FQDN) or IP Address for the LDAP server.

  2. Port: 389 by default

  3. Use SSL:
    If your LDAP server uses SSL, place a check in this box.

  4. Login Anonymously:
    If your LDAP server supports anonymous login, place a check in this box.

  5. User DN:
    The User DN (Distinguished Name) is comprised of a unique identifier for the user and the domain container. In the figure above, the unique identifier is the entry “cn=” in the LDAP database followed by the domain or organizational information. Some LDAP databases are configured with domain components (dc) while others are configured to utilize organizational units (ou).

  6. User Password: Enter the user’s password

  7. Select the checkbox next to “Remember Password”.

  8. Select the “Test LDAP” button. If your configuration parameters in steps 5-10 are correct, the “Successfully Connected” dialog window will be displayed:

Figure 7 – Bynari AddressBook 3.0 Test LDAP

  1. Select “OK” to close the “Successfully Connected” dialog window.

  2. Select the “Search” button to open the Container DN search dialog window.

  3. Figure 8 – Bynari AddressBook 3.0 Search Container
  1. Select the domain component (dc) or organizational unit as needed. Some LDAP structures use domain components while others utilize organizational units (ou). Data entered here will depend on your organization’s LDAP structure.

  2. Select “OK” when all required components have been selected.

  3. The “Container DNs:” window will display the domain component (dc) or organizational units (ou).

Figure 9 – Bynari AddressBook 3.0 Container DNs

4.3.2 Display Tab

On the “Display” tab, you can configure the actual Display Name of the address book. You can also modify the display columns as shown in the AddressBook by selecting “Configure Display Columns”.

Figure 10 – Bynari AddressBook 3.0 Configure Display Columns

  1. By default, all items are displayed in the address book view. To modify what content is displayed, select the items you want to remove and then press the “Delete” button in the center of this dialog window. You can also change the order of the displayed items by highlighting the item and using the “Move Up” or “Move Down” buttons.

  2. When finished modifying the column display, select “OK”.

  3. Display all users under “All Users” group container.
    By selecting this option, all users will be displayed within the AddressBook display pane. All groups, mailing lists, etc will be displayed when this option is selected.

Figure 11 – Bynari AddressBook 3.0 Display All Users

4.3.3 Advanced Tab

The Advanced tab contains all of the options for LDAP searches. By default, the AddressBook 3.0 will recognize both the Bynari Server 4.3 and neonBynari 5.0 LDAP schemas. It will also “auto-populate” the LDAP search filters with the correct objectClass information.

Figure 12 – Bynari AddressBook 3.0 Advanced Filters

  1. The “Sort returned results by:” the pull-down menu on the right side of this window allows you to select how you want the results to be displayed.
    Options are:

  1. First Name

  2. Last Name

  3. Display Name

  4. Email Address

  1. Display all results in a single container (deep search).
    This option will automatically turn on the deep search feature used with the Bynari AddressBook 3.0 search tool. For more information on the search tool see section 6.3 Search Feature.

  2. The LDAP Filters for Users, LDAP Filter for Groups, and LDAP Search Attributes can all be configured independently on this screen. These attributes can also be configured through the schemas.xml file that accompanies the installation of the Bynari AddressBook 3.0. This default location for the schemas.xml file is:
    C:\Program Files\Bynari, Inc\Bynari AddressBook For Outlook

  3. Editing the schemas.xml file requires an understanding of your LDAP structure. Utilizing tools such as LDAP browsers can be helpful during this part of the process. Once you have your objectClass parameters and LDAP Search Attributes configured in the schemas.xml file, the file can be utilized for all subsequent installations by copying it to the directory noted in step 2. More information about the schemas.xml structure can be found in section 5 of this manual.

  4. LDAP Attributes:

Figure 13 – Bynari AddressBook 3.0 LDAP Attributes

  1. All fields in the LDAP Attributes dialog window are configurable. In the example shown in the figure above, the “Last Name” attribute was changed to “sn” and the “Display Name” was changed to “cn” to match the LDAP directory structure. As mentioned in step 3, an LDAP browser can be very helpful in configuring these parameters. Select “OK” when finished editing.

  2. Reset Filters:
    This option will reset the filters in the “Filters for Users”, “LDAP Filter for Groups”, and “LDAP Search Attributes” to match the schemas.xml file.

  3. Detect Filters:
    This option will detect which LDAP server you are using – provided that it is already configured in the schemas.xml file. This can be very useful for installations where multiple LDAP directories are used. A single schemas.xml file can be configured for multiple servers and used for multiple installations. By default, “Detect Filters” automatically recognizes Bynari Server and neonBynari Server LDAP schemas.

  4. BaseDN:
    The top level of the LDAP directory tree is the base, referred to as the “base DN”

    By Default Bynari Addressbook attempts to determine your LDAP base DN by your User DN, which you specified on the “General” tab. Here you may specify your base DN, if Bynari Addressbook is unable to determine your base DN or you get results other than expected.

  5. LDAP Server Version:
    This feature automatically detects if the LDAP server is version 2 or 3 and adjusts accordingly when the “Detect” button is selected.

  6. Clear Cache Now:
    The Bynari AddressBook 3.0 keeps a local cache of the LDAP directory. The local cache increases performance and reduces network traffic to the LDAP server. If a user loses access to an LDAP server (server goes offline or network outage), the local cache will allow the user to continue to function. Selecting the “Clear Cache Now” button will clear the local cache.

  1. Select “OK” when finished editing configuration fields.

4.3.4 Cache Tab

Clear Cache Now:
The Bynari AddressBook 3.0 keeps a local cache of the LDAP directory. The local cache increases performance and reduces network traffic to the LDAP server. If a user loses access to an LDAP server (server goes offline or network outage), the local cache will allow the user to continue to function. Selecting the “Clear Cache Now” button will clear the local cache.

4.3.5 About Tab

The About tab contains software version information and licensing information.

5 The schemas.xml file

The Bynari AddressBook 3.0 is capable of manual configuration or configuration using the schemas.xml file. The schemas.xml file, by default, is preconfigured for both the Bynari Server 4.3 and the neonBynari 5.0 LDAP schemas. By default, the Bynari AddressBook 3.0 will automatically detect which version of LDAP server you are connecting to, Bynari Server 4.3 or neonBynari 5.0.

Customizing the schemas.xml file allows you to configure your LDAP server settings for use with the address book. Once customized, this file can be copied to the:

C:\Program Files\Bynari, Inc\Bynari AddressBook For Outlook

directory for each installation.

As mentioned in step 25 of section 4.2 (Configuring the Bynari AddressBook 3.0), it is recommended that a LDAP directory browser or similar tool be used to configure the schemas.xml file.

5.1 Schemas.xml structure

The schemas.xml file is organized into the following components:

  • objectClass value

    • userFilter

    • groupFilter

    • searchAttribute

    • attributes

5.1.1 objectClass

objectClasses are the means for including attributes – an “attribute container”. The objectClass is also an attribute itself and can be included in search queries. All attributes must be defined within an objectClass.

For the following description of the schemas.xml file, refer to the included schemas.xml file with the Bynari AddressBook 3.0.

The structure for the objectClass in the schemas.xml file:

<objectClass value=”neonBynariDomain description=”neonBynari Server”>

The Object Identifier (OID) is neonBynariDomain which is the global unique identifier for this objectClass.

5.1.2 userFilter

The userFilter is used to search for users in the LDAP database at the sub-domain level. Contained within the userFilter attribute is at least one objectClass.

The structure for the userFilter in the schemas.xml file:

<userFilter>(|(objectClass=neonPerson)(objectClass=groupOfNames))</userFilter>

The objectClass “neonPerson” refers to the actual username; the objectClass “groupOfNames” refers to the LDAP group where this user belongs.

5.1.3 groupFilter

The groupFilter is used to search for groups in the LDAP database at the domain level. Contained within the groupFilter attribute is at least one objectClass.

The structure for the groupFilter in the schemas.xml file:

<groupFilter>(|(objectClass=organization)(objectClass=neonBynariDomain)(objectClass=dcObject))</groupFilter>

The objectClasses “organization”, “neonBynariDomain”, and “dcObject” are all objectClass components of the Domain Component.

5.1.4 searchAttribute

The searchAttribute is a custom attribute developed for the purpose of name resolution in user-level queries. This attribute does not contain an objectClass attribute.

The structure for the searchAttribute in the schemas.xml file:

<searchAttribute>cn;mail;givenName;sn</searchAttribute>

The criteria used in the search attribute can be changed to meet your LDAP structural needs. This information can be found with the user’s container name or unique identifier in the LDAP database. An LDAP browser can quickly display these parameters. In this example, the data refers to the following information:

  • cn = Container Name. Typically, this is the user’s full name.

  • mail = User’s email address

  • givenName = Typically, this is the user’s first name.

  • sn = Surname or last name

5.1.5 attributes

The attributes section of the schemas.xml file contains information related to the specific user. The following is a list of the parameters of the attributes section:

<FirstName>givenName</FirstName>

<LastName>sn</LastName>

<DisplayName>cn</DisplayName>

<EmailAddress>mail</EmailAddress>

<Street>street</Street>

<PostOfficeBox>postOfficeBox</PostOfficeBox>

<City>l</City>

<State>st</State>

<PostalCode>postalCode</PostalCode>

<Department>departmentName</Department>

<HomePhone>homePhone</HomePhone>

<CellPhone>mobile</CellPhone>

<OfficePhone>employeeNumber</OfficePhone>

<PagerNumber>pager</PagerNumber>

<FaxNumber>facsimileTelephoneNumber</FaxNumber>

<TelexNumber>telexNumber</TelexNumber>

<Title>title</Title>

<OfficeName>departmentNumber</OfficeName>

<Description>description</Description>

<Server>mailHost</Server>

<Alias>mailAlias</Alias>

<DistinguishedName>dn</DistinguishedName>

6 Using the Bynari AddressBook 3.0

To use the Bynari AddressBook 3.0, go to the same standard Outlook address book. The Bynari AddressBook 3.0 is accessed by selecting the address book icon in the Outlook tool bar or by using the “To…”, “CC…”, or “BCC…” options when composing an email.

6.1 Outlook address book icon

Using the address book icon will open the Bynari AddressBook 3.0 dialog window.

Figure 14 – Bynari AddressBook 3.0 dialog

In this dialog window, all of the users within the LDAP searchAttribute (for details see section 5.1.4) are displayed. This dialog window also gives you the ability to view detailed, published user information. By double-clicking on a username, a properties dialog window will open displaying further details about the user, if provided.

Figure 15 – Bynari AddressBook 3.0 user properties

Selecting the “Add to Contacts” button will automatically insert the displayed information into a Microsoft Outlook™ contact form. Information can be quickly transferred into your personal contacts from the LDAP server.

6.2 Using To, CC, BCC

When composing an email and using the “To…”, “CC…”, or “BCC…” options, a different Bynari AddressBook 3.0 dialog window will open.

Figure 16 – Bynari AddressBook 3.0 Using To…, CC…, or BCC…

To address your email, select the person’s name and press either the “To ->”, “Cc ->”, or “Bcc ->” buttons at the bottom. To select multiple names, hold down the Ctrl key and select with the mouse.

6.3 Search Feature

The search feature of AddressBook 3.0 allows for custom searching of users within their groups or searches throughout the LDAP directory (deep search).

To perform a search, the Outlook address book dialog window must be opened. Below are examples of what Outlook 2003-2007 address book windows looks like. The search button has been highlighted in each of the following examples as well.

Figure 17 – Bynari AddressBook 3.0 – Outlook 2003 address book

Figure 18 – Bynari AddressBook 3.0 – Outlook 2007 address book

Selecting the search button in the Outlook address book window will display the Bynari AddressBook 3.0 deep search tool.

Figure 19 – Bynari AddressBook 3.0 – Search Tool

The search tool will search within the container that is displayed in the Outlook address book. For example, if the “All Users” container is selected, the search tool will search through all users. If the “Sales” container was selected, then the search would be limited to the “Sales” container.

Figure 20 – Bynari AddressBook 3.0 – All User Container

When entering search criteria, partial names or even single letters can be used to broaden the search. Search results will be displayed in the Outlook address book under the heading, “Search Results” (see figure below).

NOTE: The deep search tool searches the actual LDAP database NOT the local cache. Network connectivity to the LDAP database is required when using the search tool.

“Search All Subcontainers” is the component that actually performs the deep search function. For best results, leave this feature enabled.

6.4 Outlook Contacts

The Bynari AddressBook 3.0 also gives you the ability to select contacts from the Outlook Contacts folder.

Figure 21 – Bynari AddressBook 3.0 Outlook Contacts

Once the names have been selected, press “OK” to insert them into the email you are composing.

7 Registering Bynari AddressBook 3.0

The Bynari AddressBook 3.0 requires a license key for proper registration. License keys can be obtained by contacting sales@bynari.net.

NOTE: The license key for Bynari AddressBook 3.0 is different from the license key in Bynari AddressBook 2.0. If you are upgrading from Bynari AddressBook 2.0, please contact sales@bynari.net for a new license key.

To register the Bynari AddressBook 3.0, open the Bynari AddressBook 3.0 configuration window. For details on locating the configuration window, see section 4.3 “Configuring the Bynari AddressBook 3.0” in this guide. Once the configuration window is open, select the “About” tab.

Figure 22 – Bynari AddressBook 3.0 – Registration

Selecting the “License” button will open a new dialog window.

Figure 23 – Bynari AddressBook 3.0 – Registration

In this dialog window, enter the Bynari AddressBook 3.0 license key code and select “OK”. Selecting “OK” will display a license key confirmation dialog window.

If the workstation being registered is behind a firewall or if port 80 is blocked, port 3080 can be configured by using the pull-down menu.

Figure 24 – Bynari AddressBook 3.0 – Registration

The Bynari AddressBook 3.0 can also be unregistered from this window by selecting the “Unregister” button. Select “OK” to close this window and finish the registration process.

Figure 25 – Bynari AddressBook 3.0 – Registration

When the Bynari AddressBook 3.0 is fully registered, it displays the expiration date on the “About” tab as seen above.

NOTE: If technical assistance is required, Bynari technical support staff will ask for the software version number. This number is located on the “About” tab. In the figure above, it is highlighted in red.

7.1 Manual Registration

If the product fails to register through the normal registration process, manual registration will be required.

Following the steps outlined in section 4.3 “Configuring the Bynari AddressBook 3.0”, open the Bynari AddressBook 3.0 configuration window. Select the “About” tab and then select the “License” button.

NOTE: Manual registration requires a certificate. This certificate is obtained through Bynari support. Email your license key to support@bynari.net and request a manual registration certificate.

Figure 26 – Bynari AddressBook 3.0 – Manual Registration

To enable manual registration, select the “Manual Registration” checkbox as shown in the figure above. This will make the area titled, “Enter the license certificate below:”, active.

Enter the license key on the line titled, “Enter your product license key:”. In the certificate window at the bottom, enter the entire license certificate starting with:

—–BEGIN PGP SIGNED MESSAGE—–

and ending with:

—–END PGP SIGNATURE—–

Select “OK” when all of the information has been entered. Confirm the license as in the steps above by selecting “OK” on the license confirmation window. Select “OK” to close the Bynari AddressBook 3.0 configuration dialog window. Select “Finish” to close the Outlook E-mail Accounts dialog window.

8 Reporting Problems

When reporting problems, be sure to include the following information:

  • Microsoft Windows version number and patch level.

    • Right-click the My Computer icon on the Desktop and select Properties. The Windows version and patch level will be listed under System: in the General tab dialog.

  • Microsoft Outlook version and patch level.

    • Right-click Help in Outlook and select About Microsoft Outlook. The Outlook version and patch level will be listed.

  • The full version number of the Bynari AddressBook.

    • In Outlook select Tools > Email Accounts > View or change existing directories or address books.

    • Next > Bynari AddressBook 3.0 > Change

    • Select the About tab.

    • The AddressBook version number will be listed.

To contact technical support:

U.S. Toll Free Telephone: 1-800-241-1086
International Telephone: 001-214-350-5772

To open a new support ticket: http://www.bynari.net/support/

For FAQs: http://www.bynari.net/users/kb.php

ExportPST User Guide

Bynari Export PST

User’s Guide

 

Trademarks

 

Bynari products are trademarks of Bynari, Inc.

 

Microsoft Windows, Microsoft Outlook and Windows logos are trademarks of Microsoft Corporation in the United States, other countries, or both.

All other trademarks are the property of their respective owners.

Technical Support

 

With the purchase of Bynari products, one year of support and maintenance is included.

Support and Maintenance includes product maintenance, upgrades, and unlimited email and telephone support.

 

To contact technical support:

U.S. Toll Free Telephone: 1-800-241-1086
International Telephone: 001-214-350-5772

To open a new support ticket: http://www.bynari.net/support/

For FAQs: http://www.bynari.net/users/kb.php

Table of Contents

 

Overview

 

ExportPST exports Microsoft Personal Storage Table (PST) files to IMAP servers. This simplifies the process of migrating between PST files, and from one email server to another. Single or multiple PST files can be exported for a single or multiple users. Export tasks can be configured to run immediately, or scheduled to run at a later time.

 

Supported formats:

  • Microsoft’s native format
  • iCalendar
  • vCard
  • Kolab

 

Download URLs:

 

1.Installation

 

Once the installation file has been downloaded, extract the installer from within the .zip file. After the installer has been extracted from the .zip file, double-click on the Installer’s icon to begin the installation process.

 


Figure 1- Installer Icon

 

Welcome

On the installer’s Welcome screen, click the “Next” button to begin the installation.

 

 


Figure 2 – Welcome

 

License Agreement

If you choose to accept the terms of the license agreement, select the “I accept the agreement” radio button then click the “Next” button. If you choose not to accept the terms of the agreement, the installation will be cancelled.


Figure 3 – License Agreement

 

Select Destination Location

On the “Select Destination Location” window, select the folder in which you would like to install ExportPST. In most situations, selecting the default location is recommended.

 

Once the installation location has been selected, click the “Next” button.


Figure 4 – Select Destination Location

 

Select Start Menu Folder

On the “Select Start Menu Folder” window, select the location of the ExportPST Start Menu folder. In most situations, selecting the default location is recommended.

 

Once the location for the Start Menu folder has been selected, click the “Next” button.


Figure 5 – Start Menu Folder

 

Ready to Install

On the “Ready to Install” screen, click the “Install” button to begin installing ExportPST on your computer.


Figure 6 – Ready to Install

 

Installation Complete

On the final screen of the installation, click the “Finish” button to complete the process. Placing a check in the “Run Export PST” checkbox will start ExportPST immediately after clicking the “Finish” button.


Figure 7 – Installation Complete

 

The installation is complete. ExportPST can now be opened by selecting its icon in the Windows Start menu.

 

2.Exporting Email Data

 

2.1.Getting Started

 

After ExportPST is launched, the main configuration window (figure 8) is presented. From here one or more user accounts can be added, edited or removed. From this window PST files can also be modified, previously configured export schedules can be accessed, and information about the ExportPST installation can be viewed.

 

Figure 8 – Configuration Window

 

View Schedule

Clicking the “View Schedule” button presents a window (figure 12) displaying the schedule of currently queued export tasks.

 

User Accounts

The “User Accounts” window displays a list of all user accounts currently configured.

 

PST Files

The “PST Files” window displays a list of all PST files which have been added for whichever user has been selected, and is currently highlighted in the “User Accounts” window.

 

Add

Clicking the “Add” button allows the user to browse for and select both user accounts and their associated PST files for export to the server. Files may be selected from either the user’s local system, or a network share.

 

Edit

Clicking on a user account, to highlight it in the list, then clicking the “Edit” button will allow editing of the configuration information related to that user.

 

Remove

The “Remove” button is used to remove user accounts by clicking on the desired user account, to highlight it in the list, then clicking the “Remove” button.

 

Modify

The “Modify” button is used to make changes to PST data intended for export. The PST data is modified by clicking on the PST file, to highlight it in the list, then clicking the “Modify” button. Changes that can be made include selecting only certain mail folders for export rather than exporting all of the email data contained within the PST file.

 

About

Clicking the “About” button presents a screen with basic information about ExportPST, as well as access to the software registration information (section 4, Product Registration).

 

Exit

Clicking the “Exit” button will close ExportPST without exporting any PST data to the server.

 

Previous

The “Previous” button takes the user to the previous screen in the configuration. The “Previous” button is only accessible when user accounts and PST files from a previous session already exist in the in the “User Accounts” and “PST Files” windows.

 

Next

Clicking the “Next” button presents the next step in the configuration.

 

2.2.Adding Users

 

Clicking the “Add” or “Edit” (when at least one account already exists) buttons on the main configuration screen presents an window (figure 9) from which details about the user account being added (or edited) may be entered.

 

Figure 9 – Configuration Window

 

IMAP Username

In the “IMAP Username” field enter the username for the email account to which the PST data is being exported.

 

IMAP Password

Enter the password for the email account to which the PST data is being exported, in the “IMAP Password” field.

 

Use Global Administrator Account

The “Use Global Administrator Account” feature allows server administrators with access to a global administrator account to export on behalf of any user on the server by using that user’s username in conjunction with the global administrator accounts user’s password.

 

Note: The “Use Global Administrator Account” feature is currently tested and supported only for users who are exporting PST files to a Bynari Server, and using the Bynari Server’s “manager” password as the global administrator account password.

 

Server Address
In the “Server Address” field place the IP (Internet Protocol) address or fully qualified domain name of email server to which the data is to be exported.

 

Note: If you do not know the IP address or fully qualified domain name of the email server, it can be provided by the email server administrator.

 

Server Port

Enter the port number for the mail server in the “Server Port” field. Port 143 is the default value for this field.

 

Note: If you do not know the email server’s server port number, it can be provided by the email server administrator.

 

Use secured connection (SSL)

Place a check mark in the “Use secured connection (SSL)” checkbox if the email server requires a secured connection (SSL).

 

Note: If you are unsure whether or not the email server requires a secured connection, contact the email server administrator.

 

Note: Placing a check in the “Use secured connection (SSL)” checkbox will automatically change the Incoming Mail Port field to 993 (the default SSL port). If you are unsure the port required by the server for SSL, contact the email server administrator.

 

Test Account Settings

It is recommended that when account information is edited or entered for the first time that the account information is tested by clicking the “Test Account Settings” button before configuring additional accounts or proceeding to the next stage of the export process.

 

2.3.Adding PST Files

 

After adding a user and clicking the “Next” button a window (figure 10) from which you can to add one or more PST files to be exported for the user is presented.

 

Figure 10 Adding PST Files

 

PST Files

The “PST Files” window displays all PST files which have been added for the user.

 

Add

Clicking the “Add” button allows you to browse your computer for PST files to export.

 

Remove

Clicking on a PST file, to highlight it in the list, then clicking the “Remove” button will remove the selected PST file from the list.

 

Export Folder Type

In order to select which portion of a particular PST is to be exported, select the PST in the “PST Files” window, to highlight it within the list, then select from the “Export Folder Type” drop-down menu the portion of the PST file that you would like to have exported to the email server. The “Export Folder Type” drop-menu options are: “Inbox Folder Only”, “All Folders”, “All Calendars”, “All Contacts”, “All Tasks”, and “Select Folders”, which allows selecting one or more specific folders (including custom folders) from within the PST file.

 

Use global settings for folder type

Placing a check mark in the “Use global settings for folder type” checkbox allows you to use the menu to the right of the checkbox to make a single selection about which part of a PST file to export, and have that selection automatically applied to every PST file in the list.

 

Add User

The “Add User” button presents the Add User configuration window (figure 9).

 

Next

Clicking the “Next” button presents a new window (figure 11) from which the Export task can be set to initiate immediately, or scheduled to run at a later time.

 

Exit

Clicking the “Exit” button will exit the program, discarding all settings.

 

About

Clicking the “About” button presents a screen with basic information about ExportPST, as well as access to the software registration information (section 4, Product Registration).

 

2.4.Initiating the Export

 

Once at least one user has been added with at least one PST file added for that user, clicking the “Next” button will present the scheduling screen (figure 11). From this screen the export can be either initiated immediately, or scheduled for a later time.

 

Figure 11 Scheduling the Export

 

Schedule Name

The “Schedule Name” field can be populated with any name that you wish to use for identifying the export task, whether initiated immediately, or scheduled to run at a later time.

 

Run Now

Placing a check in the “Run Now” checkbox will disable all schedule-related settings and prepare ExportPST for immediate initialization of the configured export task.

 

Start Date

In the “Start Date” field select the date on which you would like to run the configured export task.

 

Start Time

In the “Start Time” field select the time at which you would like to run the configured export task.

 

Administrator Username

In the “Administrator Username” field, enter the username for any user with Administrator privileges on the computer where ExportPST is installed.

 

Administrator Password

In the “Administrator Password” field enter the password associated with the user whose username was entered in the “Administrator Username” field.

 

Previous

The “Previous” button presents the previous screen in the configuration (figure 10), where users and PST files can be added, edited and removed.

 

Next

Clicking the “Next” button presents a new window (figure 12) in which a list of scheduled exports can be viewed.

 

Exit

Clicking the “Exit” button will exit the program, discarding all settings.

 

About

Clicking the “About” button presents a screen with basic information about ExportPST, as well as access to the software registration information (section 4, Product Registration).

 

Log Settings

Clicking the “Log Settings” button presents the configuration options for ExportPST’s logging capabilities (section 3, Log Settings).

 

2.5.Scheduled Exports

A window displaying scheduled exports (figure 12) is displayed when ExportPST first starts, if exports have been previously scheduled and are currently queued. This same window is also displayed following the configuration of a new export task.

Figure 12 Saved Schedules

 

Schedule Exports

The “Schedule Exports” window displays a list of the currently queued export tasks.

 

Schedule Details

The “Schedule Details” window provides detailed information about the currently scheduled exports.

 

Add

Clicking the “Add” button allows you to add a new schedule.

 

Edit

Clicking on a queued schedule, to highlight it in the list, then clicking the “Edit” button allows you to edit the selected schedule.

 

Remove

Clicking on a queued schedule, to highlight it in the list, then clicking the “Remove” button will remove the selected schedule from the queue.

 

Select your network speed

The “Select your network speed” drop-down menu allows you to set the maximum network speed with which ExportPST should attempt to execute the export task. The “Select your network speed” drop-down menu options are: “56k”, “T1”, “10mb”, “100mb”, “1000mb”, and “E1”.

 

About

Clicking the “About” button presents a screen with basic information about ExportPST, as well as access to the software registration information (section 4, Product Registration).

 

Previous

Clicking “Previous” returns you to the previous screen.

 

Save/Close

Clicking the “Save/Close” button will begin the export, if an export has been configured with the “Run Now” (section 2.4, Initiating the Export) option selected. If the “Run Now” option has not been selected for any currently queued export tasks, clicking the “Save/Close” button will close ExportPST, saving all configuration and schedule information.

 

Exit

Clicking the “Exit” button will exit the program, discarding all settings.

 

3.Log Settings

 

Clicking the “Log Settings” button on the main ExportPST configuration window provides access to the various ExportPST log-related features.

 

Figure 13 Log Settings

 

 

Log File

In the “Log File” field choose the desired log file name and location by entering a complete path to the file (including the filename). The browse button may also be used to select a location for the log file. The example in figure 13 creates a log file named “SampleLog.log” and places it in the top level of the C drive.

 

Maximum log size

The “Maximum Log Size” drop-down menu provides six options for controlling the size of the logs generated by ExportPST.

 

The six different log size options are:

 

  • None
  • 100kb
  • 200kb
  • 300kb
  • 400kb
  • 500kb

 

Selecting “None” from the “Maximum Log Size” drop-down menu will place no restrictions on the maximum size of the log file.

 

Log level

The “Log Level” drop-down menu provides a choice between writing all ExportPST activity to the log, or writing only error-related activity to the log.

 

OK

Clicking the “OK” button will close the log configuration window, and save all changes.

 

Cancel

Clicking the “Cancel” button will close the log configuration window without saving any changes.

 

4.Product Registration