$Rev: 534 $ - Release Date: 15 December 2009
Table of Contents
- Table of Contents
- Introduction
- Supported Setups and Licensing
- Supported Platforms
- Supported Devices
- Supported Functionality
- Changes and Fixes
- Installation
- Scalix Hosting Edition Configuration
- User Setup
- Operations
- Troubleshooting
- Support
- Known Issues and Workarounds
Introduction
Thank you for downloading Scalix Connect for Blackberry Enterprise Server 1.0.1.
Scalix Connect for Blackberry Enterprise Server 1.0.x ("Scalix
Connect
for
BES" or "SCBES") is a connector that links the Exchange
Edition of RIM's Blackberry Enterprise Server (BES) or Blackberry
Professional Software (BPS) products to Scalix. It provides Scalix
users with the full integrated Blackberry user experience including
push email, wireless calendar and contact synchronization, remote
address book lookup and more. It provides system administrators with
all the benefits of mobile device management available for BES and BPS.
Scalix Connect for BES works in combination with Scalix Server
release 11.4. Future releases of Scalix Connect for BES will be part of
Scalix Server releases, starting with Scalix Server release 11.5.
No Scalix Software is
required on the user's mobile device. All device types that are
supported for the BES and BPS will work with the Scalix Connect for BES
solution. The User Interface on the device will be fully
controlled by the device manufacturer.
The device needs a subscription from a Blackberry-enabled mobile
operator. The subscription must be enabled for Blackberry Enterprise
Activation. Please contact your mobile operator for details. Note that
the Blackberry protocol used by the device to communicate with the BES
requires the communication to go through a carrier network and a
Network Operations Center operated by RIM. Together, these components
make up "The Blackberry Infrastructure". Blackberry devices cannot
communicate with a BES or a BPS using a local wired or wireless
network.
This is the nature of the Blackberry solution and is outside Scalix'
control.
Supported Setups and
Licensing
Scalix Connect for BES will support different deployment
models together with Scalix 11.5:
- One-to-One: One dedicated BES/BPS system is used per Scalix server
- One-to-Many: One BES/BPS system services users on multiple Scalix servers
Scalix Connect for BES 1.0.x only supports the "One-to-One" model together with Scalix 11.4. You will have to install a separate BES/BPS server for each Scalix 11.4 Server. The One-to-Many model will be available with Scalix 11.5.
The following requirements need to be met to be able to run Scalix
Connect for BES 1.0.x:
- The Scalix Server needs to be running Scalix Server release 11.4.x.
- Scalix Server versions of 11.4.4 or before are not supported.
- For Scalix 11.4.5, any edition of Scalix, including Scalix
Community Edition, can be used. Scalix Connect for BES 1.0.1 will cease
to work with Scalix 11.4.5 on 2010-03-31. You will have to upgrade your
Scalix Server to Scalix 11.4.6 or higher before that date.
- For Scalix 11.4.6 or higher, Scalix Connect for BES 1.0.x can
automatically be used for all Premium Users on Scalix Enterprise and
Scalix Hosting editions. Scalix Connect for BES 1.0.x will not be
available for Scalix Community Edition. For Scalix Small Business
Edition, a license option must be purchased. Please contact Scalix
sales for details.
- A Blackberry Enterprise Server or a server running Blackberry Professional Software must be setup. These are Windows servers. System requirements should be as per BES/BPS documentation.
- Only BES V5.0, BES V4.1 and BPS V4.1 are supported for Scalix
Connect for BES 1.0.x
- Scalix requires the use of the Exchange Edition of BES/BPS.
Scalix does not work with Lotus Notes or GroupWise editions of the
product. There is no specific version of BES/BPS for Scalix.
- A virtual machine can be used for the BES/BPS server.
- Appropriate BES/BPS licenses and CALs or a trial license must be
acquired from your mobile operator or RIM
Supported Platforms
All Windows operating systems supported for the BES/BPS should work
with Scalix Connect for BES 1.0.x. Scalix internal testing has
been done with Windows Server 2003, both 32- and 64-bit as well as
Windows Server 2008.
Supported Devices
All Blackberry devices or other vendor's devices running Blackberry
Connect software that are supported by BES/BPS will work with
Scalix Connect for BES 1.0.x.
Supported
Functionality
Scalix Connect for BES 1.0.x supports the following aspects of the Blackberry solution:
- Sending and Receiving Email in Push mode
- Viewing Email attachments
- Viewing Email folders; note that by default, most folders are not subscribed, but this can be enabled on the device
- View, create, edit and delete Contact/Calendar/Task Items in the user's primary folder for each item type
- Participate in Meeting Scheduling
- Look up Email addresses in System Directory/Scalix GAL
- Out Of Office
- View Availability
Changes and Fixes
Scalix Connect for Blackberry Enterprise Server 1.0.1
Scalix Connect for Blackberry Enterprise Server
- Bug 20194 [Defect] Cross server recurring appointment invites do not work
- Bug 20477 [Defect] Updated appointment marked with Canceled in invitee's calendar
- Bug 20481 [Defect] Sometimes not all recurring occurrences are displayed in the invitee's calendar in BES Device
- Bug 20561 [Defect] BES logs report "Not MAPI_MESSAGE" when folder created by SWA
- Bug 20613 [Defect] Multiple appointment exception updates fail
- Bug 20680 [Defect] Adding picture to Contact via BB device does not work with Scalix
- Bug 20723 [Defect] Multiple attachments fail to send
- Bug 20733 [Defect] Calendar: Replies to exceptions do not send from Blackberry
- Bug 20734 [Defect] Blackberry fails to update canceled exceptions in Calendar
- Bug 20743 [Defect] UpdateFreeBusy errors for LocalFreebusy message
- Bug 20756 [Defect] Exception body contains master appointment body
- Bug 20893 [Improvement] Support PR_PROCESSED flag to help eliminate duplicate appointments
- Bug 20915 [Defect] Corruption of RIM props for RIM.BlackBerry.FolderIDs message
- Bug 21051 [Defect] Scalix Connect with BES is leaking memory
Scalix Connect for Blackberry Enterprise Server 1.0
Scalix Connect for Blackberry Enterprise Server
- Bug 19967 [Defect] Attachments do not show up with all information
- Bug 20171 [Defect] Exception order not properly displayed in Blackberry
- Bug 20446 [Defect] BES accept of ActiveSync invite does not work
- Bug 20478 [Defect] The content disappeared from the exception's notes in SWA
- Bug 20480 [Defect] Not all recurring occurrences are displayed in the invitee's calendar in SWA
- Bug 20485 [Defect] Renaming a Folder does not reflect the new folder name in BB device
- Bug 20492 [Defect] Cancelling an Exception from Recurring meeting from BB device does not delete it from server
- Bug 20577 [Defect] Blank subject for appointment exception created by Outlook
- Bug 20596 [Defect] BES 5.0 exceptions when user has PIM subfol1ders
Scalix Connect for Blackberry Enterprise Server Beta 2
Scalix Connect for Blackberry Enterprise Server
- Bug 19526 [Defect] Hard deletes not working in all circumstances
- Bug 19536 [Improvement] Support for Out of Office functionality
- Bug 19538 [Defect] BES search folder list is not dynamically updated
- Bug 19593 [Defect] Device-side folder list has duplicate folders
- Bug 19633 [Improvement] BES connector should be delivered as an MSI file, with version # and product name in the file name
- Bug 19637 [Defect] After Scalix server restart, device does not receive any new mail
- Bug 19754 [Improvement] Scalix Connect for BES should be supported with BES 5.0
- Bug 19855 [Defect] BES Connector does not work correctly for users with more than 1000 folders
- Bug 20033 [Defect] Messages not always updated in folders
- Bug 20159 [Improvement] Should be able to use custom profile names
- Bug 20161 [Defect] Calendar notes shows HTML encoded characters
- Bug 20162 [Defect] Calendar notes shows HTML encoded characters
- Bug 20165 [Defect] CMsgStore::OpenEntry always return MAPI_E_NO_ACCESS on failure for delegates
- Bug 20170 [Defect] Moving messages from Inbox to sub-folders does not show the messages in Blackberry
- Bug 20172 [Defect] Devices showing plain text versions of messages show too much whitespace
- Bug 20173 [Defect] Devices showing plain text versions of messages show raw CSS
- Bug 20210 [Defect] Cross server recurring appointment invites cause Null Move
- Bug 20242 [Defect] Hidden messages appear on device when OL setup after activation
- Bug 20243 [Defect] Folder moves do not propagate to device
- Bug 20247 [Defect] S/MIME signed messages become stuck on BES
- Bug 20298 [Defect] Message not removed from device inbox after Outlook resend and delete
- Bug 20331 [Defect] CDO DLL becomes incorrectly registered and bypasses Sx wrapper
- Bug 20400 [Defect] Scalix Connect for BES sometimes uses ambiguous user name in UAL_SIGNON
- Bug 20440 [Improvement] Support BES hosted mode
- Bug 20441 [Defect] Messages sent using SWA does not appear in device Sent folder
- Bug 20448 [Defect] BES 5 does not recover from Scalix server restart
Installation
For the purpose of these installation instructions we use the following sample hostnames:
- Existing Scalix Server: scalix.company.com
- New BES/BPS server: bes.company.com
To integrate Scalix with a Blackberry solution, you will need to perform these steps:
- Create BES admin user on the Scalix server
- Install BES Server OS
- Install Active Directory
- Install MAPI CDO
- Install Outlook
- Install Scalix Connect for BES
- Create the BES MAPI profiles
- Install BES/BPS
Creating the BESAdmin user on the Scalix server
You need to create a technical admin account with mboxadmin privileges on the Scalix server. This user is commonly called besadmin. To create such a user, execute the following command as "root":# omaddu -n "BESAdmin/company" -p bbpassword -c mboxadmin besadminIn this command, "company" is your primary mailnode, which can be determined with the "omshowmn" command, "bbpassword" is a freely chosen password that you should note. You can also freely choose both the User name ("BESAdmin") as well as the Authentication Id ("besadmin"). If you use a name different from this example, please also take a note.
Installing BES Server OS
Install the Windows operating system on the machine which is to become the BES server. We have tested using Windows Server 2003 and 2008, 32-bit or 64-bit, US/English. RIM provides a software compatibility matrix that should be checked to ensure that the Windows and BES versions are compatible.Installing Active Directory
An existing domain controller can be used, but for the purpose of these
instructions it is assumed that a new domain controller will be setup
on the BES server.- On the BES server run "dcpromo" to make the machine a domain
controller for the domain company.com
- Add an account called "BESAdmin" to the domain.
- Ensure the "BESAdmin" account has administrator privileges by
adding it to the "Domain Admins" group.
- Ensure the "BESAdmin" account has "Allow logon locally" and "log
on as a service" privileges enabled in the domain security policy.
Note: The assignment of "Send As", "Receive As", "Administer Information Store" and "ViewOnlyAdmin" privileges in the RIM BES documentation can be ignored.
It is important that the remainder of the install process be completed using the Active Directory "BESAdmin" account.
Installing MAPI CDO
Install the Microsoft Exchange MAPI/CDO client. This is available for download from Microsoft.Installing Outlook and create the BES MAPI profiles
Install Microsoft Outlook. We have tested using Outlook 2007, US/English, all Service Packs and Updates applied.Installing Scalix Connect for BES
Install Scalix Connect for BES. To do this, double-click on the provided MSI file and follow the on-screen instructions.Creating the BES MAPI Profiles
- Go to "Control Panel", "Mail".
- If they exist already, delete the "BlackBerryServer" and
"BlackBerryManager" MAPI profiles. This step is particularly important
when upgrading from BES V4.1 to BES V5.0 because it ensures that the
profiles contain extra information required by BES V5.0.
- Create new profiles under the same name. Make sure that you select "Scalix Server" from "Additional Server Types". Enter the name of the Scalix Server you want to connect to, e.g. "scalix.company.com". For Username and Password, use the Authentication Id and Password of the "BESAdmin" user you created before, i.e. "besadmin" and "bbpassword" in the example.
Installing BES/BPS
The installation works along the lines of the setup as outlined in the BES/BPS documentation. The following steps need to be executed:- Install BES/BPS as per RIM's instructions. During installation, you may be asked to provide Exchange Server details. Leave these details blank. Also, the BES/BPS installations may suggest alternate ways to install the CDO library. The only way supported for Scalix Connect for BES is to use the Exchange MAPI/CDO client as outlined in Step 1.
- At the start of a BES V5 install you will be reminded to
configure "Send As" permissions, this can be safely ignored.
- Towards the end of a BES V5 install you will prompted to provide LDAP settings; these should be configured to use the domain controller and not the Scalix server. BES should automatically populate the LDAP settings and only require the password to be entered.
Scalix Hosting Edition Configuration
When using Scalix Connect for BES with Scalix Hosting Edition, BES itself also needs to be configured to run in Hosted Mode. This is needed so that address book filtering takes place, otherwise BES users will see users on other mailnodes when doing address book lookup operations.BES Hosting Mode Prerequisites
Please make sure that the following is true:- BES in Hosting mode can only be run with Scalix Server 11.4.5 or higher
- Scalix Server needs to be properly setup and configured for Hosting Mode
- The BESAdmin user must be created on the Scalix Server's primary mailnode
Setting up BES for Hosted Mode
- After Installation, using regedit on the BES system, add the
following Registry Key:
HKEY_LOCAL_MACHINE\Software\Research In Motion\BlackBerry Enterprise Server\Agents\HostedServer
This should be setup as a DWORD with a value of "1" - Restart the BES using the Windows Services control panel
User Setup
To setup a user for BES, a number of things need to be done
Acquire a Blackberry Enterprise-enabled device
You will need a Blackberry device or a 3rd-party device running Blackberry Connect software (e.g. certain Nokia or Sony-Ericsson models) with an appropriate mobile subscription. The latter must be enabled with a Blackberry plan from your mobile operator. Terms, conditions and pricing differ in various markets. Make sure that the device is enabled for "Enterprise Use" or "Enterprise Activation", as the standard Blackberry service usually relates to the "Blackberry Internet Service", which is a simplified service for Push Email based on consumer IMAP accounts.Please note that if you have used the device before to receive your Scalix email using the Blackberry Internet Service (BIS), you will have to remove this configuration from the device before you activate it with the Blackberry Enterprise Server. Accessing the same email account on a single device using both methods in parallel is not supported. You can leave other email accounts like your personal Gmail or Hotmail account configured to deliver to the device using BIS.
Setting up the Scalix user
The Scalix user using the Blackberry connection needs to be setup as a Scalix Premium User. This can be done using the Scalix Admin Console (SAC) or the ommodu command (see the man page for details). See above for licensing requirements.Registering the User with BES/BPS
The user needs to be registered on the BES. Follow these steps for BES/BPS V4.1:- Start "Blackberry Manager"
- Select your BES Server and the "Users" tab
- Click on the "Add user" link and select one or multiple users
from the Address Book listing
- Set an Activation Password for the user(s). To do this, right click on the user. The Activation Password must be used by the user once during his Enterprise Activation.
- The Blackberry Infrastructure sends an Email to the user's account. This will disappear automatically as its being picked up by the BES. The user should not delete or modify this email.
Follow these steps for BES V5.0:
- Open Internet Explorer
- Go to the following URL: https://bes.company.com:443/webconsole/login
- Logon either using the "BlackBerry Administration Service" or "Active Directory" authentication (The authentication method is chosen during the install)
- On the "Home" screen click "Create A User" and type in a search string for the user
- Select the desired user from the search results
- Enter the activation password and create the user.
Note: If you are using Internet Explorer 8 you will need to enable compatibility view before logging onto the BlackBerry Administration Interface.
Enterprise Activation
Once the user is registered, he can perform device activation himself. To do this, execute these steps on the device:- Go to Settings/Advanced/Enterprise Activation. If this item is
not present, check with your mobile operator, this may be because your
plan is not activated for Enterprise use. You may also have to start
the device's "Setup Wizard" and tell the device to enable the use of a
"Corporate Account" for messaging.
- Enter your primary Email address, e.g. "This email address is being protected from spambots. You need JavaScript enabled to view it." and the activation password setup in step 4 of the registration.
- Activation will now proceed and the device will start synchronizing and receiving email. The process can take anywhere from few minutes to a couple hours, depending on the size of the users mailbox, calendar and contact listing.
Operations
Restarting BES/BPS
To restart the BES/BPS, go to the Windows "Services" Admin Panel, select the "Blackberry Controller" service and hit restart. All other services will be restarted as well.Log Files
- The BES logs are located in the BES installation directory
(typically C:\Program Files\Research In Motion\Blackberry Enterprise
Server\Logs). A set of logs is created per day. Logs levels may be set
in the Blackberry Server Configuration utility. The maximum value for
logging that can be set in the utility is 4. Editing the registry
"HKLM\Software\Research In Motion\Blackberry Enterprise Server\Logging
Info\Mailbox Agent" and setting the DebugLogLevel setting to 7 results
in a higher level of logging. The most important log file is the
Messaging Agent log. This is identified by the string MAGT in the
filename. Note it is possible to get multiple MAGT logs.
- On startup BES logs various version numbers. To confirm that the Scalix Blackberry connector is installed correctly the version number of the CDO library should be checked. This should match your Scalix connector version number.
- Scalix Connect for BES Enterprise Server provides for a number of
additional log files in the profile directory, similar to Scalix
Connect
for Outlook. These are used by the BES connector however due to the
fact that BES may keep MAPI connections open for extended periods the
log files are created daily and purged after 7 days. The settings can
be configured in the "Mail" control panel, under properties for the BES
profiles and the Scalix connection in these profiles, when starting
Outlook with these profiles and in Scalix Properties or by running the
sxlogconf.exe tool typically found in C:\Program Files\Scalix\Connect\.
Troubleshooting
Installation Failures
If Installation fails, the following items should be verified:- The order of installation is crucial to the process and the installation will fail if the order is not followed. E.g. if Outlook is installed before the Exchange CDO/MAPI client, the install for that component will not proceed.
- The Scalix Connect for BES product installs its own custom CDO
library, replacing the one provided by Microsoft and renaming it. The
original file is kept as
\Program Files\ExchangeMAPI\MSCDO.DLL while the Scalix version is installed as \Program Files\ExchangeMAPI\CDO.DLL. Both files are needed. If, for any reason, the Exchange CDO/MAPI client is re-installed, the Scalix file may be overwritten, resulting in issues. Again, order is critical here. - The use of other CDO-based applications on the BPS/BES system is not supported as the Scalix CDO library has been specifically designed to support BES/BPS only.
Device Enterprise Activation Failures
If Activation fails, the following things should be verified:- Check with your mobile operator whether the plan/SIM card used by the device is enterprise enabled
- Wipe the device as per the device's manual and re-run the Setup Wizard and Activation
- Retry activation when you have better network coverage
- Update the device to the latest software and firmware revisions
- Contact your mobile operator's support team. Device activation is mostly done between the BES/BPS server, the Blackberry infrastructure and the device
- Reset your activation password. The password is a one-time
password and expires after a certain time, by default after 2 and with
a maximum validity of 30 days. The user
will never need to enter their Scalix password on the device.
- Log messages should appear during Activation. Activation starts with an OTAKEYGEN messages being sent to the server by the device. Logging for this can be seen for the specific user in the MAGT log. 3 scenarios exist:
- Activation succeeds. In this case immediately following the initial OTAKEYGEN message further OTAKEYGEN logs will be seen as the client and server perform a handshake. This will be followed by a number of messages being queued and delivered to the device. At the end of the activation completed is logged. It is common for the server to report activation complete sometime before the client does.
- Activation fails. There are many reasons why an activation might fail. The most common to date is having the wrong mobile plan to allow BES usage or the plan being incorrectly setup by the mobile provider. In this case an OTAKEYGEN will be seen arriving at the server but no subsequent activity will be seen. Eventually the activation will usually be canceled by the user resulting in an OTAKEYGEN abort.
- Activation is canceled. If the user cancels the activation an OTAKEYGEN abort is logged.
User does not receive new Email
- Check whether there is a communication outage between device, infrastructure and BES/BPS. In the Blackberry Manager, check whether the device is listed as "Outside Coverage" or similar. Sometimes it helps to restart the device.
- Restart the BES/BPS. There is a known issue (see below) that requires a BES restart in certain situations
Issues with Device Behavior
By in large, Scalix Connect for BES is not responsible for device behavior. Users familiar with the Blackberry Enterprise Server solution connected to an Exchange server will find most behaviors expected. Users who have never worked in a BES environment may find the following awkward:- Timestamps on messages are when the device received the message. They are not related to the Sent or Received timestamps of the email message.
- Only messages added to a folder after BES is activated are pushed to the device. Old messages are never synced.
- By default, only messages arriving in Inbox are pushed to the device. Other folders must be subscribed to using the appropriate UI
- The main Email folder will show received as well as sent messages
- Deletions of messages through Outlook or another Scalix client are not reflected on the device by default. The BES/BPS can be setup to "Reconcile Deletes" so that this happens. Even in this case, the reconciliation of deletes will be delayed and not happen in real time.
- Read/Unread marks set through Outlook or another Scalix client are not reflected on the device immediately, reconciliation is delayed and lagging behind. The user can choose to "Reconcile Now" to accelerate this at the expense of additional network traffic.
- The Calendar Summary on the Home Screen does not show all-day
events. Only the next few non-all-day events are shown. All-day events
are shown correctly at the top of the screen in a day view.
Support
Please contact Scalix Technical Support to report product issues and
request help with Scalix Connect for BES 1.0. See http://www.scalix.com/support
for details. A commercial support entitlement is needed to use Scalix
Technical Support.
- Scalix version on Backend system
- Scalix Connect for BES version on BES/BPS server
- OS Version (including patch level) on Backend and BES/BPS systems
- Versions of Exchange MAPI/CDO client and Outlook and patch levels used
- Versions of BES used
- Type of Device used, Firmware/Software version of device
- Country and Name of mobile operator
Known Issues and Workarounds
Scalix Connect for Blackberry Enterprise Server
Bug |
Issue |
Comment/Solution/Workaround |
BES creates multiple sessions with Scalix server |
In certain situations, BES/BPS can create multiple connections to the Scalix backend server. It should only use one. The sessions are not used for anything and remain in the session list. Eventually and in rare cases this could lock out the user as there is a default maximum of 17 UAL sessions against a single mailbox in Scalix. The limit can be raised by setting the MAX_SIGNON_PER_USER parameter in general.cfg or user.cfg. The extra sessions can be cleared by restarting the BES/BPS. This will be fixed in a later release |
|
Single BES/BPS server should be able to connect to multiple Scalix servers |
This is a known limitation of Scalix Connect for Blackberry Enterprise Server together with Scalix 11.4.x. Configurations where a single BES/BPS system can be used to service users on multiple Scalix servers will be supported with Scalix 11.5 and the version of Scalix Connect for Blackberry Enterprise Server that ships with it |
|
Support for View Availability |
This is a known limitation of Scalix Connect for Blackberry Enterprise Server. The functionality will be supported in a later release |
|
Devices showing plain text versions of messages show too much whitespace |
This is a known issue with Scalix Connect for Blackberry Enterprise Server. It is benign in that all information is displayed. Message rendering will be improved in a future release of the product |
|
Out Of Office functionality logs errors |
These errors can be safely ignored and do not indicate any user-visible problem. Error handling will be improved in a future release |
|
Distribution Lists not supported on Blackberry devices. |
Distribution Lists in Outlook Contacts Folder are not available on the Blackberry device. This is a known limitation of Scalix Connect for Blackberry Enterprise Server. The functionality will be supported in a later release |
|
Japanese text message not showing up correctly in BB device. |
This is a known issue with Scalix Connect for Blackberry Enterprise Server. It will be fixed in a future release |
|
BB device showing wrong Folder Hierarchy. |
This is a known issue with Scalix Connect for Blackberry Enterprise Server. It will be fixed in a future release |
|
In multi-server environments, BES is intolerant to DRS connectivity issues |
While talking to it's associated Scalix Server, Scalix Connect for BES needs to find the home server of ever user in the SYSTEM address book. For this, all servers in the multi-server environment need to available in the mailnode mapping table, as seen as the output of the "omshowmn" command on the Scalix server. Firewalls between servers must allow free-flowing traffic on port 5757/UDP. In cases where this is not possible, the workaround may be to manually populate the mailnode mapping table using the "omaddmnmp" command. Future versions of Scalix Connect for BES will be more tolerant for environments with partial mailnode mapping tables |
|
Sometimes messages disappear from device after message moves between mailbox sub-folders. |
This is a known issue with Scalix Connect for Blackberry Enterprise Server. It will be fixed in a future release |
(c) Copyright 2009 Scalix Corporation. All rights reserved.