Category Archives: Admin Guides

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.

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

Bynari Collaboration Suite Admin Guide

Bynari - www.bynari.net

Bynari IntelliPanel Administrator’s Guide

© 2011 Bynari

Table of Contents

Overview
Logging In
Manager Login
Home Tab
BCS Management
General Settings
Accounts
Server
Users

Copyright

Bynari owns the intellectual property (IP) rights to all HTML, text, images, video, audio, software and any other content available on this website. No part of this publication may be reproduced or transmitted in any form or by any means, electronic or mechanical, including photocopy, recording, or any information storage and retrieval system, without permission in writing from the publisher.The “Bynari” logo is the property of Bynari. IntelliPanel™ is a registered trademark of Bynari. You are not permitted to use or distribute this logo or trademark without the express written permission of Bynari.

Getting Started

IntelliPanel has been designed after years of feedback from our customers and evaluating what those needs truly are. It is a management interface for the BCS server, but it is far more than that. It empowers administrators with the tools necessary to quickly manage the tasks at hand, but it is far more than that too. IntelliPanel is a flexible framework designed to be manipulated around how you work. With published API’s, an administrator with mid-level programming or scripting experience can easily create additional plug-ins for IntelliPanel to manage other system on their network. Do you have a another server that you would like to integrate into a single management platform? IntelliPanel can make that dream a reality.Because IntelliPanel is browser-based, it is lightweight, fast, and accessible from any computer on your network with a browser. There are no special plug-ins necessary for IntelliPanel to function. It functions well on Internet Explorer, Firefox, and Safari with standard installations. Because IntelliPanel is browser-based, it is platform neutral. It works equally well on Windows, Linux, or Mac. Because it is lightweight, it will run properly on just about any hardware – even your older computers.

System Requirements

Because IntelliPanel is such a lightweight product – there are no minimum system requirements for it. It should run well on any modern computer. It does not require special graphics accelerators or high RAM/CPU configurations to function properly.
Supported Browsers Versions
Internet Explorer 8 – 9
Firefox 3.6.X – 4
Safari 3.X – 5.x
Google Chrome 10.0.X
Overview

Home Tab

The “Home” tab is primarily used for informational purposes. The majority of the work that will be accomplished with IntelliPanel will be performed in the “BCS Management” tab. The Home tab, by default displays a “Tip of the Day” that is customizable. For organizations that have junior administrators, this can be an effective way of passing helpful tips to them.The other components listed in the Home tab will be individually addressed in a subsequent chapter. Those components are: About, and License.
The “BCS Management” tab is where all of the server and user management happens. When you log into IntelliPanel, you will automatically be directed to the “Search” section of the BCS Management tab.The components listed in the BCS Management tab will be individually addressed in subsequent chapters. Those components are: General Settings, Accounts, and Server.

The following components are displayed in both the Home and BCS Management tabs: Groupware WebClient, Knowledge Database, and Contact Bynari. Each of these will be addressed in subsequent chapters.

Logging In

Manager Login

IntelliPanel Manager Login

After the BCS server has been installed, administrators can log into IntelliPanel as managerto begin creating their domain and setting up users.

NOTE: The manager account on the BCS server is similar to a Unix root or Windows administrator account. This user can do virtually anything on the BCS server. Great care and caution should be taken when giving out the manager credentials. It is a better practice to create administrator accounts and issue those out instead of granting everyone access to the manager account.

Log into IntelliPanel with the following URL: https://yourserverdomain/ipanel. Replace yourserverdomain with your actual server domain. For example, if your mail server’s domain name is mail.example.com, you would use this URL https://mail.example.com/ipanel

IntelliPanel is designed with security in mind. For this reason, you must log in using https.

User Login

IntelliPanel User Login

Users have the ability to log into IntelliPanel too. Users get the benefits of being able to change their own passwords, set vacation messages and other things from within IntelliPanel. User access to IntelliPanel is accomplished with the same URL as for administrators (see above). Users are required to log in with their full email address, as shown in the image above.
Manager Login

About

Manager - About

The About section contains important information in the event that you ever need technical support assistance. It contains the version numbers of the installed BCS server software, e.g. IntelliPanel, WebClient, and the Kolab server. It also contains other important information such as, server uptime, Linux Kernel version number, and your specific distribution of Linux. At the bottom of the About window is a hyperlink titled, “License Information”. Clicking on this link does the same thing as clicking on the “License” button – it displays the license information page.

License

Manager License IntelliPanel

The Licensesection contains information pertaining to the currently installed license on the BCS server. As shown in the image above, this page shows all products covered under the issued license certificate. It also shows details about the total number of licenses available (Users), and the amount currently being used (In Use). It also displays the license expiration date and support subscription expiration date.To grant end-users the right to use and individual product, like the Groupware WebClient, they must be given access here on the license page (see image above). To add users to the Groupware WebClient, for example, first click on the “Show users” hyperlink to the far right of the WebClient Product row.

Add Users to the WebClient

Select the “Search” button to retrieve all users or enter a search string to narrow your search. The returned results are users that can be added to the WebClient license to grant the right to access the WebClient. You can select a single user or multiple users. To select multiple users hold down either the “Shift” or “Ctrl” keys and use the mouse to click on the names. Once you have made your selection, click the >> button to add those users to the window on the right. When you are finished adding users, select the “Confirm” button at the bottom to finalize your changes.

NOTE: BCS license certificates are created with a domain name associated with it. For service providers that require a more complex licensing option, we can facilitate that too. For more information about complex, multi-domain, or unlimited domain certificates contact our sales department at sales@bynari.net
General Settings

Groupware Settings

IntelliPanel General Settings

“Groupware Settings” are where domains are added to the BCS server. It is also where specific server services (such as POP3, IMAP, Antivirus, etc.) are configured. If you are configuring a Master/Slaveenvironment it would be configured here as well.

NOTE: For detailed information on how Master/Slave environments function with Kolab, review the Kolab wiki page here:

Domains

In the image above, you can see that creating a domain in IntelliPanel is very easy. Simply enter your Fully Qualified Domain Name (FQDN) in the input filed titled, “Domains*”. For example, if your server domain name is example.com, you would enter example.com in the input field and click the “Add” button. All domains added to the BCS server are displayed in the text area below the input field.

To remove a domain from the BCS server, highlight the domain and click the “Remove” button. Once you are satisfied with your choices, select “Confirm” to finalize the changes.

NOTE: While working in the Groupware Settings interface, you can switch between tabs prior to selecting “Confirm”. Your other changes will not be discarded. You can confirm them all at the same time.

Services

Bynari IntelliPanel - Services

In the “Services” tab the following services can be either “enabled” or “disabled”: IMAP, IMAP over SSL, POP, POP over SSL, Sieve, or Antivirus (ClamAV). By default all of these services are on except for POP and POP/SSL Services.To enable or disable a service, select the enable or disable radio button and then click “Confirm”. Once the change has been confirmed, the status window will indicate those changes in green above. If any errors are encountered, those messages would be displayed in red in the message area. See the image below for an example of what this looks like.

Bynari IntelliPanel Status Window

Network

IntelliPanel - Network Settings

In the “Network” section you can define what networks should be trusted by your mail server. This would include trusted SMTP clients that are allowed to relay email through Postfix as well. The default value for this option is 127.0.0.1/8.In the “Smarthost (Relay/Host)” input field, enter the name of the SMTP relay server you want to accept relayed email from. In the “Smarthost (Relay/Host) port” enter the SMTP port number of the relay host. Be sure to check the “Accept incoming mail” checkbox and select “Confirm” to finalize your SMTP relay modifications.

NOTE: You MUST select the “Accept Incoming Mail” box to receive emails from the outside world.

Servers

IntelliPanel - General Settings - Servers

The “Servers” section is where you would set up “Master” and “Slave” servers. Master/Slave is often used for load balancing in environments where heavy webclient usage or large numbers of end-users is present. It is also a popular choice for large enterprises that have offices in multiple locations.The Master server contains all of the OpenLDAP data while each Slave server replicates their respective LDAP data locally. Any time changes are made, they must be made on the Master server. Those changes are then replicated out to the Slave servers.

To configure your Master/Slave environment, enter the FQDN domain names of your slave servers in the input field and click “Add”. You can add as many Slave servers as you need. Only one server can be the Master though. For more information on how the Master/Slave environment works with Kolab, visit the Kolab wiki page here.

Calendar

IntelliPanel - Calendar

The “Calendar” section is where you configure Free/Busy services. To enable Free/Busy services, select “Enable” and click “Confirm”. To enable Public Free/Busy information select “Enable” and click “Confirm”. Enter a numeric value under “Publish X days of old Free/Busy data” to specify how many days worth of past Free/Busy data you wish to publish.It should be noted that publishing Public Free/Busy data makes that calendar Free/Busy status viewable to all.

UCE Controls

IntelliPanel - UCE Controls

“Unsolicited Commercial Email” (UCE). The more common name for this type of email is Spam. With IntelliPanel you can configure how stringent you want your spam filtering to be.The first option, “Use the Sender header instead of From for…” verifies the sender’s identity using the data present in the header rather than assuming that the From address is the true identity of the sender.

the second option, “Check messages for mismatching From header…” looks for mismatched information between who the header says that the email is from versus what the email says.

The last two options describe what to do with incoming email if it fails the first two UCE checks.

Network TCP Settings

IntelliPanel - Network TCP Settings

The “Network TCP Settings” section gives administrators the ability to easily change default port settings to whatever settings are needed. These settings include: HTTP(S), SMTP(S), POP(S), Sieve, and Disclaimers.IntelliPanel - General Settings HTTP
IntelliPanel - General Settings SMTP
IntelliPanel - General Settings IMAP
IntelliPanel - General Settings POP
IntelliPanel - General Settings Sieve
IntelliPanel - General Settings Disclaimers

The “Service Spam/Filter” activates/deactivates the Global Disclaimers service. Because this service technically routes through the BCS AMaViS and ClamAV virus scanning software, it is properly titled “Spam/Filter”. When email messages are appended with a global disclaimer, they are being filtered.

Spam/Filter Settings

IntelliPanel - Spam Filter SettingsThe “Spam/Filter Settings” section is where you configure the score level at which email is suspected as spam and marked or discarded as blatant spam. You can also customize the subject line you want to be posted on suspected spam email. The “Banned Extensions” tab allows you to enable a ban on attachments with specific file extensions.

Filter Settings

Admin address for virus notification…

  • Configure the email address that virus notifications should be sent to in the input field provided.

Add spam info headers at this level or higher…

  • If this numeric value is met or exceeded, entries will be put into the email header, indicating that it has been scored for potential spam.
    Adjust the numeric value – lower numbers indicate a more stringent filtering and could result in “false positive” filtering.

Add “spam detected” headers…

  • If this numeric value is met or exceeded, the tag “spam detected” will be inserted into the email header.

Kill the message at this level…

  • If this numeric value is met or exceeded, the email will not be delivered to the intended recipient. It will be placed in the spam repository for eventual deletion.

Spam subject…

  • For email that is suspected as spam but does not meet the numeric level mentioned in the previous field, the subject line will be appended with whatever is written in this input field. The default value is ***SPAM***. This is commonly used by many mail servers.

Banned Extensions

IntelliPanel - Banned ExtensionsThere are two options for “Banned Extensions”:
“Ban compressed files (zip, iha, tnef, cab)” and “Ban executable files”
Selecting “Enable” will enable the ban on these file types. The default setting is “Disable”.

Global Disclaimers

IntelliPanel - Global DisclaimersGlobal Disclaimers are controlled by the administrator and can be set on a “per domain” basis. When a global disclaimer is set, it appends each email as it leaves the server with whatever message was typed into the Global Disclaimer filed of IntelliPanel. It makes no difference whether the email was sent with Outlook and the Bynari Outlook Connector, with the Groupware WebClient, Thunderbird, or any other IMAP client – all will get appended with the global disclaimer message.

Creating a global disclaimer is a simple process.

  1. Select the domain you want to create the global disclaimer for from the pull down menu titled, “Domain”.
  2. Enter the text that you want appended to everyone’s email as it leaves the BCS server.
  3. Select “Confirm” to finalize the disclaimer.

To remove a previously created global disclaimer, select the disclaimer from the displayed list and then click the “Remove” button.

Accounts

Search Function

IntelliPanel - Manager Search PageIntelliPanel defaults to a useful search tool when you log in as manager. This search tool can quickly help you find the user, resource, or other entry in the LDAP database. You can narrow your search results by selecting what container you want to search in. Under, “Search in” select the container you wish to query. If you want to query the entire system, select “\”.

Use the “All Objects” pull down menu select the type of object you are looking for.
IntelliPanel - Search Options
The image above shows the various options to choose from for narrowing your search. If you wanted to search for all user accounts in all containers, you would select “\” from the Search In menu and “User Accounts” from this menu. Leaving an * asterisk in the search filter input field is a wild card search. This search filter is case insensitive.

A wild card search for all users would yeild results that look similar to this (see below):
IntelliPane - Manager User Search

Create Organization

IntelliPanel - Create Organizational UnitBefore creating users, an organization must be created first. An organization can be thought of as a company container within the LDAP directory. It helps to logically sort and store the users that we will be creating later. In the image above, there are two fields to enter data on the “General” tab. The first field is a mandatory field. Enter the Organization Name in the top input field. The information entered can be the name of your company or organization. For example, if your company/organization’s name is, “City of Dallas”, then enter City of Dallas in the space provided. The bottom input field is a descriptive field and is only there for your convenience – it is not required.

IntelliPanel - Create OrganizationOn the “Host” tab, select the domain that should be associated with the organization. Unless you are a service provider or have arranged for a multi-domain license, there will only be one domain listed here. Select that domain and then click “Add”. Once you are satisfied with your organizational selections, click “Confirm” to finalize your changes.

Create Organizational Unit

IntelliPanel - Create Organizational Unit

Organizational Units are essentially groups that are added into an Organization. With the creation of an Organization, the BCS server LDAP has been modified by IntelliPanel which has added some default Organizational Units (groups). You can choose to utilize these groups or create custom groups. Custom groups are created in this interface (see image above).Select the main Organizational Unit (OU) that you want your custom OU to reside under. Remember, some OU’s have already been created once the Organization was created. If you created an Organization named Widgets, the default groups (OU) would be:

  • / – domain root level
  • /external – designated for external contacts
  • /groups – generic container that can be used for any purpose
  • /internal – reserved for users that are permitted only local send/receive – e.g. these users cannot send mail to or receive mail from the outside world
  • /Widgets – organizational root that was created
  • /Widgets/external – designated for external contacts for the Widget’s organization only
  • /Widgets/groups – generic container for the Widget’s organization to use
  • /Widgets/internal – internal only mail for the Widget’s organization
  • /Widgets/people – generic container for the Widget’s organization
  • /resources – dedicated to resource accounts only

At this point, you may want to create a custom OU (group) for your organization. If you wanted a “sales” group under the Widgets root, this is what it would look like in the pull down menu:

Create User

IntelliPanel - Create User

Now that we have an organization (company) created and organizational units (OU) [groups], we need to create a user. As shown in the image above, using the pull down menu under “Department”, select which group (OU) you want this user to be in. For details about the various default groups, see the previous section.Enter the following information for this user:

  • First Name
  • Last Name
  • Email Address

The domain part of the email address should be filled in by default unless you have a special license for multi-domain or unlimited domain usage.

  • Password
  • Confirm Password

The “Address” and “Phone” tabs are not required fields. In fact, the only required fields for creating a user are on the “General” tab.

NOTE: User passwords must be at least 6 characters long. It is always a good practice to require strong passwords from your users. While we do not stipulate the content of the passwords, we do require them to be at least 6 characters in length.

IntelliPanel - Create User - AliasSome organizations use aliases for users. You may have a user that performs customer service duties but you do not want to use his/her corporate email address for that. You can create an alias for customer.service@example.com so that any mail sent to that address will get sent to your employee’s real address.

Enter the alias address name in the first input field. The domain name should already be filled in with your default domain name, unless you have a special license for multi-domain use. Click “Add” and then “Confirm” to create the alias.

IntelliPanel - Create User - Server

To set a user’s quota, select the “Server” tab. The Home Server should automatically be filled in with your default server. Enter the quota limit in MB and select “Confirm” to finalize your changes.

IntelliPanel - Create User - Groupware

IntelliPanel has the ability to automatically create Outlook default folders for you. Click the checkbox labelled, “Create Default Outlook Folders”.
You can also set your defaults for “Meeting Request Acceptance”. The available options are:

Manual is the default option. Always accept and always reject do exactly as their names imply. The last two, “Reject if conflict” and “Manual if conflict” depend on whether there is a conflict that already exists on your calendar.

NOTE: Email Extender is an upcoming project that will extend what you’re able to do with your IMAP email client. Email Extender is a completely standalone product that does not rely on “which” email client you use. It works equally well with webmail as it does with Thunderbird or Outlook. It gives users the ability to set IMAP ACLs on folders, set Vacation Messages, Email Forwarding, Change Passwords, and Check for new mail. All of this functionality will be manageable from within IntelliPanel. As an administrator sees that a service of Email Extender does not fit their policies, it can be removed.

Create External Contacts

IntelliPanel - Create External Contact

External contacts are shared contacts created and maintained by the administrator. These contacts are not users on the mail server, rather, they are external to the system. End-users will see external contacts in their address books in the webclient and, if configured, in their Bynari Outlook AddressBook. The real benefit of having an external contacts list is for collaboration. If you have external entities collaborating on a project, you may want everyone in your organization to have access to these external entities for the duration of the project. Other uses for external contacts may be discovered as you become more familiar with the product.The only required fields for external contacts are, “First Name” and “Last Name”. All other fields are optional.

Create Mailing List

IntelliPanel - Create Mailing List
IntelliPanel - Create Mailing List Members
IntelliPanel - Create Mailing List OwnerMailing Lists are an effective way to send email out to a large group of people with a single email address. They are effective in that the recipients can also reply to that single email address and all parties get copied every time.

To create a Mailing List first enter the “Name” of the mailing list on the General tab. The description field is optional. In the “Mail” field, enter the first part of the email address – note that the domain will automatically filled in for you. For service providers or customers with a custom license that allows for multiple domains, use the pull down menu to select the domain you want to associate the mailing list with.

Click on the “Members” tab. You can either click the search button to retrieve all users or type in part or all of a user’s name to search for them. For example, typing a “J” will return all users with a “j” in their name or email address. These search variables are case insensitive. The search results will appear in the left window pane. You can select multiple names by holding down either the Ctrl or Alt keys and clicking with your mouse. Once you have selected the users to add to the mailing list, click on the >> button. These users will be placed in the right window pane. To remove users from the right window pane highlight that user’s name and press the << button.

An Owner must also be created for the list. The owner can also be a member of the list. If you want the owner to receive mailings to the list, then add that person to the member list too. Adding a user as an owner is the same process as adding a member, but on the “Owners” tab. Owners can add/remove users from the list. They cannot create new lists or delete existing lists.

Create Public Folders

IntelliPanel - Create Public FoldersPublic folders are a useful collaboration tool. The ability to create a group calendar or group contact list can increase productivity and enhance communication.

Type the name of the public folder in the input field “Name”. For example, if you are creating a sales calendar you may want to enter sales in that field. The domain name should automatically be filled in for you unless you are a service provider or have a special license for multiple domains.

Using the “Folder Type” pull down menu, select the type of folder you are creating. In our example, we were creating a new calendar, so you would select calendar.

Click on the “ACL” tab.

IntelliPanel - Create Public Folder ACL

Type in the user’s name that you want to grant access to this public folder. If you want everyone to have access to the folder, type anyone. Otherwise, select the specific users you want to grant access to.

Using the “IMAP Rights” pull down menu, select the rights you want to give this user. The options are:

  • None
  • Read Only
  • Write Only
  • Read/Write
  • Admin

If you require a more customized set of ACL rights, you can use the checkboxes marked, “L,R,S,W,I,P,K,X,T,E,C,D,A” for each user. For more information about what each of these rights mean, refer to (RFC4314).

NOTE: The Bynari Collaboration Suite server is fully RFC 4314 compliant.

Create Resource

IntelliPanel - Create Resource

Resources are used for scheduling physical objects that are shared by others in an office setting. For example, a conference room may be created as a resource and then scheduled by users as part of their meeting request. When the conference room is added to that meeting request as a resource, that resource will show up a busy if someone else tries to schedule it at the same time.To create a resource enter the resource name, desired email address and password. The domain name should automatically be filled in for you unless you are a service provider or have a special license for multiple domains. The Kolab host section is for environments that have a Master/Slave server configuration. If you have a Master/Slave server configuration, select which server you want to create the resource for. Typically, a Master/Slave configuration is for office that are in different geographical locations. Select the server that is in your location. If you do not have a Master/Slave configuration, you will only have a single server to choose from. Select “Confirm” to create your resource.

External Directory

IntelliPanel - External Directory
IntelliPanel - External Directory Defaults

The BCS server has the capability of replicating your existing Active Directory (AD) or Samba LDAP directory (Samba). This is directory, once configured, is synchronized at customizable refresh intervals. It should be noted that, if you plan to use an AD or Samba LDAP, all future user maintenance must be done on those interface – NOT IntelliPanel. IntelliPanel gets synchronized to the other directory – it is a one-way synchronization.
Server

Mail Queue

IntelliPanel - Mail Queue

The Mail Queue manager is actually the core of the entire email delivery process. It contacts SMTP, LMTP (and others) delivery agents and sends a delivery request for one or more recipient addresses. The mail queue manager maintains a small active queue with messages that are opened for delivery. This active queueacts as a limited window of potentially large incoming or deferred items.

  • Select All – Selects all messages in the mail queue.
  • Deselect All – Deslectes all messages in the mail queue.
  • Hold – When an email is put on “Hold”, it remains in this state until the administrator releases or deletes it.
  • Release – When an email is “Released”, it is moved into the maildrop queue to be delivered. Essentially, the message has been re-queued for delivery.
  • Delete – Deletes the email message from the queue completely. A message that is deleted cannot be retrieved.

Task Scheduler

IntelliPanel - Task Scheduler

The BCS task scheduler is a GUI front-end to the Linux cron scheduler. Cron is a robust and flexible scheduling program that is readily available on most standard Linux distributions today.There are several scripts that BCS depends on, that must run in a scheduled, systematic manner. These scripts include standard backup routines and others.

As seen in the image above, all of the current tasks are listed in a table along with the time, day, and recurrence of the task. At the end of each listed task are both “Edit”, and “Delete” buttons. At the botton of the Task table is a “Create Scheduled Task” button. New tasks can be created and scheduled here.

IntelliPanel - Task EditExisting tasks can easily be edited. If you wanted to change the time of your LDAP Backup, select the “Edit” icon on the same line as LDAP Backup. The following explains how to interpret the editor values:

  • Enabled – [TRUE/FALSE]: Turns the task on or off. True enables the task.
  • Name- [LDAP Backup, Mail Backup, Configuration Backup, Server Cleanup]
    • LDAP Backup – Backup of LDAP directory
    • Mail Backup – Backup of all IMAP Mail directories
    • Configuration Backup – Backup of BCS configuration parameters
    • Server Cleanup – Removes old backups from the server
  • Minute – [0-59]: The numeric value means to execute the script every X minutes.
  • Hour – [0-23]: The numeric value means to execute the script every X hours.
  • Day of Month – [Every, 1-31]: Instructs the scheduler which numeric day of the month to run on – or to run daily.
  • Month – [Every, January-December]: Instructs the scheduler which month to run or to run every month.
  • Day of Week – [Every, Sunday-Saturday]: Instructs the scheduler which day of the week to run or to run everyday.

In the image above, the LDAP Backup will run at 04:00(AM) every day of the month, every month of the year, and every day of the week.

Backup & Restore

IntelliPanel - Server Backups

The BCS server comes with a Backup & Restore routine built in. BCS utilizes the built-in features of the Linux tar and gzipcommands for backups. Looking at the image above, each available backup is listed with file name, date and size information. There are also restore and delete buttons next to each backup. At the bottom of this page there is an individual button for each of the three types of backups we use – Configuration, LDAP, and Mail.IntelliPanel - RestoreAfter selecting “Restore” next to a backup file, you will see the “Restore in progress” scree, (above). This page will automatically revert back to the available backups page when the restore is complete. On this page, you can see exactly which file is being restored, when the restore started, and the elapsed time of the restore process.

Backup scripts are automatically created upon installation of BCS. As the administrator, you should adjust the times/frequency of these backups to reflect your policy for backups.

Groupware WebClient

Whether you log into IntelliPanel as an administrator or an end-user, the Groupware WebClient button is displayed. This button is simply a quick link to open up the BCS web email client with full groupware capabilities.

Knowledge Database

The administrator account displays this quick link to the Bynari Knowledge Database (KDB). This KDB offers helpful tips on various technical tweaks you may want to make to your server or client software. It is always a good idea to look here first.

Contact Bynari

IntelliPanel - Contact BynariAdministrators have been given a useful tool for contacting Bynari in the “Contact Bynari” section. We’ve created a simple interface for you to give us quick feedback, open a support ticket, contact sales, or even submit a tip of the day.

Users

IntelliPanel - User Login

Change my Password

IntelliPanel - Change PasswordUsers can change their password as often as is needed simply by logging into IntelliPanel and clicking on “Change my password”. They will be asked for their current password and then for the new one twice. Once they select “Change” their password will be changed.

Vacation Message

IntelliPanel - Vacation MessageThe Vacation Message feature of BCS will send an immediate email reply to any incoming message, notifying that sender that you are not available. The subject and body of the email message sent is fully customizable, according to what you wish to say. Vacation messages can be set by any user individually. To set the vacation message, it is a three step process.

  1. Activate – Select “Yes” to turn on vacation message notifications and “No” to turn it off.
  2. Subject – The subject line of the email auto-response you will be sending out.
  3. Message – The message body of the email auto-response you will be sending out.

My Mailing Lists

Mailing Lists are created by the administrator. Administrators can give users ownership of mailing lists for future editing of other users that belong to that list. These list owners can only add people to or remove people from the list. They cannot create new lists or delete lists.

If a users is not designated as the owner of any Mailing Lists, nothing will display in this section.

Mobile Sync

IntelliPanel - Mobile SyncBCS utilizes the built-in ActiveSync protocols of most major smart phones today to synchronize data between the mobile device and the server. When a user’s smart phone is configured for the BCS server and entry is created under IntelliPanel for this user in “Mobile Sync”. The phone will be listed in the pull down menu. If multiple mobile devices are configured for this user’s account, multiple devices will be listed in the pull down menu.

Depending on the mobile device, you can synchronize Calendar, Contacts and Tasks. If you have multiple calendars, contacts, or tasks, they will be displayed here as well. This gives you the ability to select which calendar(s) or which contact lists you want to sync with. When you are satisfied with your selections, click “Confirm” to finalize your configuration.

Reporting Problems

As with anything in life, there are occasionally problems that you will encounter along the way. We are here to help you with your BCS software. We have an award-winning technical support team that is eager to assist you. In order for our team to be able to serve you, you must have an active software support and maintenance agreement with Bynari. If you do not have one or are unsure, please feel free to contact our sales department for confirmation.

The following items will help us help you faster:

  • Server and client software versions. Server version information information can be found here:
  • Your software license number. This number can be found here:
  • Your name
  • Your company name – if you are a customer of a reseller, please contact your reseller for support questions. If your reseller has redirected you to Bynari, please provide your reseller’s company name, and your contact person’s name.
  • Contact Information: This includes a telephone number, email address, Skype ID or any other relevant contact information that will speed the process of contacting you.

United States Toll Free Telephone: 800-241-1086
International Telephone: 001-214-350-5772

Bynari Website ©2011 Bynari, Inc.

Bynari Collaboration Suite Installation Guide

Bynari - www.bynari.net

Bynari Collaboration Suite Installation Guide

© 2011 Bynari

Overview

The Bynari Collaboration Server (BCS) includes:

  • Bynari IntelliPanelAn indispensable configuration tool for the Kolab groupware server.The Bynari IntelliPanel component of the Bynari Collaboration server adds to the power, reliable, and widely used Kolab groupware server a user-friendly, extremely intuitive interface for configuring and maintaining the server. The Kolab groupware server’s command line configuration options are still available to server administrators, while all of the most common options–as a well as a few new ones–are also available through the IntelliPanel application. This gives information technology managers the option to have their most common server administration tasks performed by administrators without the prerequisite of Linux command line expertise.

    IntelliPanel greatly improves the productivity of server administrators of all experience level by providing a server configuration tool that is fast, efficient, and easy to understand, and easy to use. Because IntelliPanel run completely within the web browser, the server can be configured and maintained locally or remotely using the exact same interface, and all changes take effect in real time.

  • Bynari WebClientA powerful web-based email and groupware application.WebClient, allows collaboration with Outlook, Sunbird, and Evolution. It supports calendar sharing, contacts sharing, folder sharing, and resource scheduling natively with Outlook clients. For customers with native iCalendar supported email clients, test it with your web mail and Outlook for calendar sharing, contacts sharing, and other sharing features. Users authenticating with Active Directory or OpenLDAP can use Access for the corporate address book directory.

    WebClient comes integrated with Bynari’s mail server. It can also be customized to work with other IMAP servers or Linux email servers. Whether you are a hosting company or a business looking for a more robust web mail client, Bynari’s web client provides the ability to share without changing out your desktop client, Outlook.

  • Kolab Groupware ServerAn extremely stable and widely used open-source email and groupware server.

 

Pre-Installation

BCS is fully tested and compatible with both Debian-based and Red Hat-based servers.

 

NOTE:The results of a BCS installation on other Linux distributions is unknown.

 

The following items are required by BCS and must be installed on your Linux server prior to installing BCS. If an installation of BCS is attempted with one or more of the following components not already installed on the system, the BCS installation script will stop. The script will then prompt for the installation of the missing component.

Pre-Installation Minimum Requirements:

  • Red Hat-based or Debian-based Linux operating system with…
    • Sudo
    • OpenSSL
    • libltdl

 

 

Recommended Partitioning:

You may choose to either create subsequent partitions or install BCS in the root partition. If you choose to create subsequent partitions please keep the following in mind:

/kolab 8 Gigabytes Allocate more space if you choose not to create any other subsequent partitions.
/kolab/var/imapd/spool Partition as required for user data This path is were user mail data is stored. Calculate your partition space requirements by multiplying the number of users by estimated “per user” storage.
/kolab/icc/scheduler/backups Partition as required for backup data. This path is were backup data is stored.
NOTE: The default configuration for backup retention is 14 days, backups older than this are removed. By default, LDAP backups are performed daily, configuration (CFG) and mail backups are performed weekly. It is important to allocate enough disk space for these backups or disable them in favor of another backup solution.

 

Installation on a New System

The following procedure us for a first-time installation of BCS, on a new Linux server.

  1. Install the package
    NOTE: The following examples use “bynari-collab-suite_1.0-k2.2.4_20101109_ip212_wc142_i386″ as an example. Depending on the version of the software you download and install, your terminal window may display different version information here.
    IMPORTANT NOTE: The installation and configuration of BCS must be done by a user with super user privileges (e.g root).

     

    • On Debian
      # dpkg -i bynari-collab-suite_1.0-k2.2.4_20101109_ip212_wc142_i386.deb

       

    • On Red Hat
      # rpm -ivh bynari-collab-suite-1.0-k2.2.4_20101109_ip212_wc142.i386.rpm

       

  2. Run the configuration script
    # /kolab/etc/kolab/setup.sh

     

    There are several prompts within the configuration script to which the user must respond. They are as follows:

    1. The installer will attempt to configure your system to start the server when the computer boots up. Would you like the server to start automatically at boot time [y/n]?

       

      The default response is “y”. Responding to this prompt with an “n” will render BCS unable to auto-start when the system boots, unless the user manually configures their server to automatically start the necessary services.

    2. The mail queue manager component of this package
       needs the following lines added to /etc/sudoers:
       Cmnd_Alias SP=/kolab/sbin/postsuper
       Defaults:kolab-n !requiretty
       kolab-n ALL=NOPASSWD: SP
      Do you want the installer to attempt to add these lines to /etc/sudoers [y/n]?

       

      The default response is “y”. Responding to this prompt with an “n” will render the Mail Queue Manager inoperable.

    3. Please enter Hostname including Domain Name (e.g. thishost.domain.com) [demoserver.example.net]:

       

      You may choose to accept the default hostname by pressing “enter”, or you can enter a hostname of your choice.

    4. Do you want to set up (1) a master Kolab server or (2) a slave [1] (1/2):

       

      The default response is “1”, to set up a master Kolab server. In a single-server environment choose “1”, or simply press enter to accept the default.

       

      NOTE: Selecting “2”, to set up a slave Kolab server, is considered an advanced configuration. Setting up a slave Kolab server is recommended only for advanced Kolab server administrators.

       

    5. Please enter your Maildomain - if you do not know your mail domain use the fqdn from above [example.net]:

       

      You may choose to accept the default mail domain by pressing “enter”, or you may enter the mail domain of your choice.

    6. Please choose a manager password [hbQXSJerHZUSGEtO]:

       

      A password for the manager’s (the primary administrator’s) account must be entered here.

    7. Enter fully qualified hostname of slave kolab server e.g. thishost.domain.tld [empty when done]:

       

      If you are configuring a master server, or you are configuring the only server in a single-server environment, press enter at this prompt.

    8. Do you want to create CA and certificates [y] (y/n):

       

      Unless you will be importing your own certificates, entering “y” is the correct response to this prompt. Entering “y” at this prompt will create the CA and certificates. The default option for this prompt is “y”.

       

      NOTE: If your select “n” at this prompt, your installation is complete, and you must now import your own CA and certificates.

       

    9. Enter organization name [Kolab]:

       

      Selecting the default organization name will work in all situations. However, advanced users have the option to customize their installation by entering their own organization name here.

    10. Enter organizational unit [Test-CA]:

       

      As with the the organization name, selecting the default organizational unit will work in all situations. However, advanced users have the option to customize their installation by entering their own organization unit value at this prompt.

    11. CA certificate filename (or enter to create):

       

      Pressing enter will now create the CA certificate.

    12. Enter PEM pass phrase:

       

      The pass phrase entered here is used only for the creation of the private key associated with your new CA certificate.

    13. Verifying - Enter PEM pass phrase:

       

      Verify the pass phrase entered in the previous step, by re-entering it here.

    14. Sign the certificate? [y/n]:

       

      Enter “y” at this prompt in order to sign your certificate. This is required, unless you choose to abort the CA certificate creation process.

    15. 1 out of 1 certificate requests certified, commit? [y/n]:

       

      Entering “y” at this prompt will complete the CA and certificate creation process. This is the final opportunity to abort the CA and certificate creation process. Entering “n” at the prompt will abort the CA and certificate creation process, and you will be responsible for importing your own CA and certificate.

  3. Installation complete!

     

    Congratulations! Your new BCS server is now installed with your manager (the primary administrator) account created, and ready for use.

  4. You can now direct your browser to your web server’s IP address or domain name, and log in with your manager account to begin configuring your server.BCS Login Screenshot

 

Upgrading an Existing BCS Installation

The following procedure us for upgrading an existing installation of BCS.

WARNING: If you are upgrading from BCS 6.0 to a newer release, contact the Bynari Sales Department sales@bynari.net to have your license key modified, FIRST. Your existing license key will be associated to your domain. If you attempt to upgrade your server without first getting an updated license key, you will experience problems with your BCS server.
  1. Upgrade the package
    NOTE: The following examples use “bynari-collab-suite-6.0-k2.2.4_20101112_ip230_wc152.i386″ as an example. Depending on the version of the software you download and install, your terminal window may display different version information here.
    IMPORTANT NOTE: The installation and configuration of BCS must be done by a user with super user privileges (e.g root).

     

    • On Debian
      # dpkg -i bynari-collab-suite-6.0-k2.2.4_20101112_ip230_wc152.i386.deb

       

    • On Red Hat
      # rpm -Uvh bynari-collab-suite-6.0-k2.2.4_20101112_ip230_wc152.i386.rpm

       

  2. Run the configuration script and follow Step-2 as documented in the Section above – “Installation on New System”
    # /kolab/etc/kolab/setup.sh

     

 

NOTE: If a Bynari Server or Insight Server is found, you will receive the following informational prompt.

Notice: Found an existing Insight Server installation in /opt/insight If you are upgrading Insight Server to Bynari Collaboration Suite, this installation will not migrate your existing users or data. Continue with the installation. Once the installation has finished if you wish to migrate your existing users and data, please see the Bynari Collaboration Suite documentation for migration instructions. Press [Enter] to continue

 

If you receive the prompt above, press “enter” to continue with the upgrade.

 

  1. Installation complete!

     

    Congratulations! Your new BCS server is now installed with your manager (the primary administrator) account created, and ready for use.

  2. You can now direct your browser to your web server’s IP address or domain name, and log in with your manager account to begin configuring your server.BCS Login Screenshot

 

Migrating from Bynari Server or Insight Server to BCS

The following procedure is for migrating an existing installation of Bynari Server or Insight Server to BCS.

  1. Stop the Bynari Server or Insight Server services.
    # /etc/init/d/insightserver stop

     

  2. Install the package
    • On Debian
      # dpkg -i bynari-collab-suite_1.0-k2.2.4_20101109_ip212_wc142_i386.deb

       

    • On Red Hat
      # rpm -ivh bynari-collab-suite-1.0-k2.2.4_20101109_ip212_wc142.i386.rpm

       

     

  3. Run the configuration script
    # /kolab/etc/kolab/setup.sh

     

    There are several prompts within the configuration script to which the user must respond. They are as follows:

    1. Notice: Found an existing Insight Server installation in /opt/insight If you are upgrading Insight Server to Bynari Collaboration Suite, this installation will not migrate your existing users or data. Continue with the installation. Once the installation has finished if you wish to migrate your existing users and data, please see the Bynari Collaboration Suite documentation for migration instructions. Press [Enter] to continue

       

      The default response is “Enter”.

    2. The installer will attempt to configure your system to start the server when the computer boots up. Would you like the server to start automatically at boot time [y/n]?
      
      

      The default response is “y”. Responding to this prompt with an “n” will render BCS unable to auto-start when the system boots, unless the user manually configures their server to automatically start the necessary services.

    3. Please enter Hostname including Domain Name (e.g. thishost.domain.com) [demoserver.example.net]:
      
      

      You may choose to accept the default hostname by pressing “enter”, or you can enter a hostname of your choice.

    4. Do you want to set up (1) a master Kolab server or (2) a slave [1] (1/2):

       

      The default response is “1”, to set up a master Kolab server. In a single-server environment choose “1”, or simply press enter to accept the default.

       

      NOTE: Selecting “2”, to set up a slave Kolab server, is considered an advanced configuration. Setting up a slave Kolab server is recommended only for advanced Kolab server administrators.

       

    5. Please enter your Maildomain - if you do not know your mail domain use the fqdn from above [example.net]:

       

      You may choose to accept the default mail domain by pressing “enter”, or you may enter the mail domain of your choice.

    6. Please choose a manager password [hbQXSJerHZUSGEtO]:

       

      A password for the manager’s (the primary administrator’s) account must be entered here.

    7. Enter fully qualified hostname of slave kolab server e.g. thishost.domain.tld [empty when done]:

       

      If you are configuring a master server, or you are configuring the only server in a single-server environment, press enter at this prompt.

    8. Do you want to create CA and certificates [y] (y/n):

       

      Unless you will be importing your own certificates, entering “y” is the correct response to this prompt. Entering “y” at this prompt will create the CA and certificates. The default option for this prompt is “y”.

       

      NOTE: If your select “n” at this prompt, your installation is complete, and you must now import your own CA and certificates.

       

    9. Enter organization name [Kolab]:

       

      Selecting the default organization name will work in all situations. However, advanced users have the option to customize their installation by entering their own organization name here.

    10. Enter organizational unit [Test-CA]:

       

      As with the the organization name, selecting the default organizational unit will work in all situations. However, advanced users have the option to customize their installation by entering their own organization unit value at this prompt.

    11. CA certificate filename (or enter to create):

       

      Pressing enter will now create the CA certificate.

    12. Enter PEM pass phrase:

       

      The pass phrase entered here is used only for the creation of the private key associated with your new CA certificate.

    13. Verifying - Enter PEM pass phrase:

       

      Verify the pass phrase entered in the previous step, by re-entering it here.

    14. Sign the certificate? [y/n]:

       

      Enter “y” at this prompt in order to sign your certificate. This is required, unless you choose to abort the CA certificate creation process.

    15. 1 out of 1 certificate requests certified, commit? [y/n]:

       

      Entering “y” at this prompt will complete the CA and certificate creation process. This is the final opportunity to abort the CA and certificate creation process. Entering “n” at the prompt will abort the CA and certificate creation process, and you will be responsible for importing your own CA and certificate.

  4. Installation complete!

     

    Congratulations! Your new BCS server is now installed with your manager (the primary administrator) account created, and ready for use.

  5. Download the migration script.
    # wget http://www.bynari.net/support-files/BCS/Insight-to-BCS.tar.gz

     

  6. Extract the migration script.
    # tar -xzf Insight-to-BCS.tar.gz -C /

     

  7. Run the migration script.
    # /opt/insight/Insight-to-BCS/Insight-to-BCS.sh

     

  8. Start the services.
    # /kolab/bin/openpkg rc all start

     

  9. Congratulations! Your new BCS server is now installed with your manager (the primary administrator) account created, and ready for use.You can now direct your browser to your web server’s IP address or domain name, and log in with your manager account to begin configuring your server.To get started with BCS’ basic configuration continue to the following sections.

    BCS Login Screenshot

 

Creating an Organization

Although users can be added to and used in BCS immediately following installation, the recommended procedure is to first create an organization, add a domain to that organization, and then create users within that domain. In this section we will create an organization. In the following sections we will add a domain to our organization, and creating users and mailing lists within that domain.

  1. Create the OrganizationClick the “Create Organization” button in the left-side navigation area, under “Accounts”, and under the “General” tab, enter an organization name in the “Organization Name” field. A short description of the organization may also be entered in the “Description” field, if desired.Organization Creation Screenshot
  2. Add the DomainUnder the “Domains” tab enter a domain name and add it to the Domains list for the organization, by clicking the “Add” button. Next, select your host from the “Kolab Hosts” drop-down menu and add it to the list for the organization,by clicking the “Add” button.Add Domain Screenshot
  3. ConfirmationClick the “Confirm” button. If all information has been added correctly, the confirmation message will appear, in green, in the BCS alert area.Confirmation Screenshot

 

Creating a User

This is the description of this section.

  1. Create UserClick the “Create User” button in the left-side navigation area, under “Accounts”, and under the “General” tab, complete all fields. The user-related fields under the “Address”, “Phone”, “Alias”, “Server”, “Groupware”, and “Email Extender” tabs are optional.Create User Screenshot
  2. ConfirmationClick the “Confirm” button. If all information has been added correctly, the confirmation message will appear, in green, in the BCS alert area.Confirmation Screenshot

 

Creating a Mailing List

This is the description of this section.

  1. Create Mailing ListClick the “Create Mailing List” button in the left-side navigation area, under “Accounts”, and under the “General” tab, complete all fields.Create Mailing List Screenshot
  2. Add List MembersClick on the “Members” tab, and search for a users to add to the list. Found users will be listed in the left-side window. Selecting a user, to highlight it, in the left-side window then clicking the “>>” button will add that user to the mailing list. Selecting a previously added user, to highlight it, in the right-side window then clicking the “<<” button will remove that user from the list.Add List Members Screenshot
  3. Add List OwnerClick on the “Owners” tab, and search for a users to add to the list. Found users will be listed in the left-side window. Selecting a user, to highlight it, in the left-side window then clicking the “>>” button will make that user an owner of the mailing list. Selecting a previously added user, to highlight it, in the right-side window then clicking the “<<” button will remove that user from the list of owners.Add List Owner Screenshot
  4. ConfirmationClick the “Confirm” button. If all information has been added correctly, the confirmation message will appear, in green, in the BCS alert area.Confirmation Screenshot

 

Bynari Website©2010 Bynari, Inc.