How to move the BlackBerry Configuration Database to a new Microsoft SQL Server instance

Article ID: KB03112

Type: Support Content

Last Modified: 09-17-2014

 

Product(s) Affected:

  • BlackBerry Enterprise Server for Microsoft Exchange
  • BlackBerry Enterprise Server for IBM Domino
  • BlackBerry Enterprise Server for Novell GroupWise
  • BlackBerry Enterprise Server for Microsoft Office 365
CollapseEnvironment
  • BlackBerry Enterprise Server 2.1 to 5.0 SP4
  • BlackBerry Enterprise Server for Office 365
  • Microsoft SQL Server 2000 SP3 to 2012
  • Microsoft SQL Server Desktop Engine (MSDE)
CollapseOverview

Confirm that the Database version is compatible with the Microsoft SQL Server version before moving the BlackBerry Configuration Database to a new Microsoft SQL Server instance. Refer to compatibility matrix at:

BlackBerry Enterprise Server Compatibility Matrix

The BlackBerry Enterprise Server services must be stopped during the process described in this article.

Important: Restarting certain BlackBerry Enterprise Server services might delay email message delivery to BlackBerry smartphones. For more information, see KB04789.

Note: In a Microsoft Exchange environment, complete the tasks using the BlackBerry Enterprise Server service account unless otherwise stated.

Complete the following tasks to move the BlackBerry Configuration Database to a new Microsoft SQL Server instance:

Prepare the new Microsoft SQL Server
Back up the BlackBerry Configuration Database
Restore the BlackBerry Configuration Database
Configure the BlackBerry Enterprise Server

Task 1 - Prepare the new Microsoft SQL Server

Note: Complete this task using an account with administrator access to the new Microsoft SQL Server. Microsoft SQL Server 2005 or 2008 requires the following server role permissions:
System Administrator, Database Creator.

Step 1: Assign the appropriate permissions based on the applicable environment

Microsoft SQL Server 2000 to 2012

  1. Open Enterprise Manager (Microsoft SQL Server 2000) or Microsoft SQL Server Management Studio (Microsoft SQL Server 2005 to 2012).
  2. Go to Microsoft Server Group > <SQL_Server_name> > Security.
  3. Right-click Logins and select New Login.
  4. From the General tab, click the double quotation marks ( "" ) button.
  5. From the Global Address List, select the name of the BlackBerry Enterprise Server service account.
  6. Click Add, then click OK.
  7. On the Server Roles tab, select Server Administrators and Database Creators.
    Note: In BlackBerry Enterprise Server 4.1, the System Administrator role is needed for role-based administration.
  8. Close Enterprise Manager (Microsoft SQL Server 2000) or Microsoft SQL Server Management Studio (Microsoft SQL Server 2005 to 2012).

Microsoft SQL Server Desktop Engine (MSDE)

  1. Log in to the new Microsoft SQL Server.
  2. Right-click My Computer, and click Manage.
  3. Expand Local Users and Groups.
  4. Select Groups and then click the Administrators group.
  5. Click Add.
  6. Type the name of the BlackBerry Enterprise Server service account and then click Check Name.
  7. Click OK.
  8. Close the Computer Management window.

Step 2: Turn on the correct server protocols based on the applicable the environment

Microsoft SQL Server 2008 to 2012 Express or Microsoft SQL Server 2008 to 2012

  1. Click Start > Microsoft SQL Server 20xx > Configuration Tools > SQL Server Configuration Manager.
  2. Expand SQL Server Network Configuration.
  3. Select the Microsoft SQL Server instance that will be used for the BlackBerry Configuration Database.
  4. If necessary, turn on the TCP/IP and Named Pipes protocols.
  5. If a protocol is turned on in the previous step, restart the Microsoft SQL Server services.

Microsoft SQL Server 2005 Express or Microsoft SQL Server 2005

  1. Click Start > Microsoft SQL Server 2005 > Configuration Tools > Microsoft Server Configuration Manager > Microsoft Server 2005 Network Configuration.
  2. Select the Microsoft SQL Server instance that will be used for the BlackBerry Configuration Database.
  3. If necessary, turn on the TCP/IP and Named Pipes protocols.
  4. If a protocol is turned on in the previous step, restart the Microsoft SQL Server services.

Microsoft SQL Server Desktop Engine (MSDE) or Microsoft SQL Server 2000

  1. Click Start > Run.
  2. Type svrnetcn.
  3. Click OK. The Microsoft Server Network Configuration Utility opens.
  4. Make sure that TCP/IP and Named Pipes are both listed as protocols that have been turned on.
  5. Close the Microsoft Server Network Configuration Utility.
  6. If a protocol is turned on in step 2, restart the Microsoft SQL services.

Step 3: Make sure that the Microsoft Server Agent service is running

Note: This service does not exist in Microsoft SQL Server 2005 Express or Microsoft SQL Server 2008 Express.

  1. Open the Windows Control Panel, then open Administrative Tools > Services.
  2. Make sure that the Microsoft Server Agent service is started and that the Startup type is set to Automatic.
  3. Close the Services window.

Step 4: Update the BlackBerry Configuration Database schema

Important: If the BlackBerry Enterprise Server software was installed to create a blank BlackBerry Configuration Database on a new Microsoft SQL Server instance, do not perform the following steps, because the schema has already been updated.

Note: If you are running BlackBerry Enterprise Server 5.0, CreateDB.exe is recommended, but not necessary to run prior to restoring the database backup.

  1. Download the installation package for the version of the BlackBerry Enterprise Server that is being used.
  2. Extract the contents of the installation package.
  3. Copy the Database folder to the new Microsoft SQL Server.
    Note: The default location of this folder is C:\Research In Motion\BlackBerry Enterprise Server 4.x.x\Database
  4. Go to the Database folder and open the BESMgmt.cfg file in a text editor, such as Notepad.
  5. Locate the DB_NAME=BESMgmt or (DATABASE_NAME=BESMgmt) line depending on the version of the upgrade and then make sure that the name specified matches the BlackBerry Configuration Database name.
  6. If using a named instance of Microsoft SQL Server, change the SERVER=local line to SERVER=<SQL_Server_Name>\< instance_name>.
  7. Close the file, and Save the changes.
  8. From a command prompt, navigate to the Database directory.
  9. Type createdb.exe BESMgmt.cfg and press Enter.
  10. After the command has finished executing, close the command prompt.

Task 2 - Back up the BlackBerry Configuration Database

Note: When backing up the BlackBerry Configuration Database, complete the steps based on the applicable environment.

Microsoft SQL Server 2000 to 2012

  1. Open Enterprise Manager (Microsoft SQL Server 2000) or Microsoft SQL Server Management Studio (Microsoft SQL Server 2005 or 2008).
  2. Right-click the BlackBerry Configuration Database (for example, BESMgmt).
  3. Select Backup Database.
  4. Click Add to specify the Directory Name and File Name.
  5. Click OK to accept the settings.
  6. Click OK again to start the backup process.
  7. Close Enterprise Manager (Microsoft SQL Server 2000) or Microsoft SQL Server Management Studio (Microsoft SQL Server 2005 or 2008) when the process is complete.

Microsoft SQL Server Desktop Engine (MSDE)

  1. From a command prompt, type osql -E and press Enter.
    Note: If logging in to a named instance of the Microsoft SQL Server, use the following command syntax to log in: osql -E -S <SQL_Server_name>\<instance_name>
  2. Type the following commands in the specified order:
    1. backup database <BlackBerry_Configuration_Database_name> to disk = 'C:\<BlackBerry_Configuration_Database_name>.bak'
    2. go
    3. quit
  3. Close the command prompt.

Task 3 - Restore the BlackBerry Configuration Database

There are two methods available to restore the BlackBerry Configuration Database and each are dependant upon the applicable environment:

  • Restore the BlackBerry Configuration Database from a backup
  • Detaching and re-attaching the BlackBerry Configuration Database files.

Restore database method for Microsoft SQL Server 2000 to 2012

  1. Open Enterprise Manager (Microsoft SQL Server 2000) or Microsoft SQL Server Management Studio (Microsoft SQL Server 2005 to 2012).
  2. Right-click the Databases (for example, BESMgmt).
  3. Select Tasks>Restore Database.
  4. Click From Device and browse for the .bak file.
  5. Select Options and ensure Overwrite the existing database is selected.
  6. Click OK to accept the selection.
  7. Close Enterprise Manager (Microsoft SQL Server 2000) or Microsoft SQL Server Management Studio (Microsoft SQL Server 2005 to 2012) when the process is complete.

Detach and re-attach database method for Microsoft SQL Server 2000 to 2012

  1. Open the Control Panel, and open Administrative Tools > Services.
  2. Stop each service that has a name that begins with BlackBerry.
  3. Log in to the existing Microsoft SQL Server.
  4. Open Enterprise Manager (Microsoft SQL Server 2000) or Microsoft SQL Server Management Studio (Microsoft SQL Server 2005 to 2012).
  5. Right-click the BlackBerry Configuration Database name.
  6. Select All Tasks, and click Detach Database for Microsoft SQL Server 2000 or for Microsoft SQL Server 2005 or 2008, select Tasks and click Detach.
  7. Close Enterprise Manager (Microsoft SQL Server 2000) or Microsoft SQL Server Management Studio (Microsoft SQL Server 2005 to 2012).
  8. Go to the Microsoft SQL Server Data directory and copy the MDF and LDF files.
    Note: The default path is C:\Program Files\Microsoft SQL Server\MSSQL\Data\ and the default filenames are BESMgmt.mdf and BESMgmt.ldf.
  9. Log in to the new Microsoft SQL Server.
  10. Open Enterprise Manager (Microsoft SQL Server 2000) or Microsoft SQL Server Management Studio (Microsoft SQL Server 2005 to 2012).
  11. Right-click the BlackBerry Configuration Database name.
  12. Select All Tasks, then click Detach Database for Microsoft SQL Server 2000 or for Microsoft SQL Server 2005 select Tasks and click Detach.
  13. Move the files that were copied in step 8 to the Microsoft SQL Server Data directory.
  14. When prompted to overwrite the files, click Yes.
  15. In Enterprise Manager (Microsoft SQL Server 2000) or Microsoft SQL Server Management Studio (Microsoft SQL Server 2005 or 2008), right-click the Database folder, then click All Tasks.
  16. Select Attach Database for Microsoft SQL Server 2000 or for Microsoft SQL 2005 to 2012 right-click the Database folder and select Attach.
  17. Select the MDF file to attach, then click OK.
  18. Close Enterprise Manager (Microsoft SQL Server 2000) or Microsoft SQL Server Management Studio (Microsoft SQL Server 2005 to 2012).

Restore database method for Microsoft SQL Server Desktop Engine on a Microsoft SQL Server having the same directory structure

  1. Copy the BlackBerry Configuration Database backup to the C:\ path of the new Microsoft SQL Server.
  2. From a command prompt, type osql -E and press Enter.
    Note: When logging in to a named instance of the Microsoft SQL Server, use the following command: osql -E -S <SQL_Server_name>\<instance_name>
  3. Type the following commands in the specified order:
    1. restore database <BlackBerry_Configuration_Database_name> from disk = 'c:\<BlackBerry_Configuration_Database_name>.bak' with recovery, replace
    2. go
    3. quit
  4. Close the command prompt.

Restore database method for Microsoft SQL Server Desktop Engine on a Microsoft SQL Server having a different directory structure

  1. Copy the BlackBerry Configuration Database backup to the C:\ path of the new Microsoft SQL Server.
  2. From a command prompt, type osql -E and press Enter.
    Note: When logging in to a named instance of the Microsoft SQL Server, use the following command: osql -E -S <SQL_Server_name>\<instance_name>
  3. Type the following commands in the specified order:
    1. restore database <BlackBerry_Configuration_Database_name> from disk =
      "C:\<BlackBerry_Configuration_Database_name>.bak" with move
      "<BlackBerry_Configuration_Database_name>_data" to
      "<new_path>\MSSQL\Data\<BlackBerry_Configuration_Database_name>.mdf", move
      "<BlackBerry_Configuration_Database_name>_log" to "<new_path>\MSSQL\Data\<BlackBerry_Configuration_Database_name>.ldf"
       
      Note: To determine the logical file names <BlackBerry_Configuration_Database_name>_data and <BlackBerry_Configuration_Database_name>_log for the BlackBerry Configuration Database, complete the following steps:
      1. On the Microsoft SQL Server hosting the BlackBerry Configuration Database, open a command prompt and type the following command:
        OSQL -E or OSQL -E -S <SQL_Server_name>\<instance_name>
      2. Type the following commands in the specified order, pressing Enter after each command:
        exec sp_helpdb <BlackBerry_Configuration_Database_Name>
        go
        The two logical file names for the BlackBerry Configuration Database are BESMgmt_data and BESMgmt_log.
      3. Close the command prompt.
    2. go
    3. quit
  4. Close the command prompt.

Detach and re-attach database method for Microsoft SQL Server Desktop Engine

  1. Open the Control Panel, and open Administrative Tools > Services.
  2. Stop each service that has a name that begins with BlackBerry.
  3. Log in to the existing MSDE Server.
  4. From a command prompt, type osql -E and press Enter.
    Note: When logging in to a named instance of the Microsoft SQL Server, use the following command: osql -E -S <SQL_Server_name>\<instance_name>
  5. Type the following commands in the specified order:
    1. exec sp_detach_db @dbname = "<BlackBerry_Configuration_Database_name>"
    2. go
    3. quit
  6. Go to the Microsoft SQL Server Data directory and copy the MDF and LDF files.
    Note: The default path is C:\Program Files\Microsoft SQL Server\MSSQL\Data\ and the default filenames are BESMgmt.mdf and BESMgmt.ldf.
  7. Move the files that were copied in step 6 to the new Microsoft SQL Server.
  8. Log in to the new MSDE Server.
  9. From a command prompt, type osql -E and press Enter.
    Note: When logging in to a named instance of Microsoft SQL Server, use the following command: osql -E -S <SQL_Server_name>\<instance_name>
  10. Type the following commands in the specified order:
    1. exec sp_detach_db @dbname = "<BlackBerry_Configuration_Database_name>"
    2. go
    3. quit
  11. Move the files that were copied in step 6 to the Microsoft SQL Server Data directory. When prompted to overwrite the files, click Yes.
  12. From a command prompt, type osql -E and press Enter.
    Note: If logging in to a named instance of Microsoft SQL Server, use the following command syntax to log in: osql -E -S <SQL_Server_name>\<instance_name>
  13. Type the following commands in the specified order:
    1. exec sp_attach_db @dbname = "<BlackBerry_Configuration_Database_name>"
    2. @filename1 = "C:\Program Files\Microsoft SQL Server\MSSQL\Data\<BlackBerry_Configuration_Database_name>.mdf",
    3. @filename2 = "C:\Program Files\Microsoft SQL Server\MSSQL\Data\<BlackBerry_Configuration_Database_name>.ldf"
    4. go
    5. quit
  14. Close the command prompt.

Task 4 - Configure the BlackBerry Enterprise Server

To configure the BlackBerry Enterprise Server to connect to the new BlackBerry Configuration Database, complete the following steps:

For BlackBerry Enterprise Server for Office 365

Note: BlackBerry Enterprise Server for Office 365 does not have a change database option like previous versions.

  1. Manually update the BESMgmt database with the new SQL instance name by running the following Transact-SQL command against the BESMgmt database:
    UPDATE DatabaseServer SET Name = 'SQLServer\SQLInstance'
    Where SQLServer\SQLInstance is the SQL server and SQL instance information for the new destination SQL server.
  2. Then continue with following KB18129 that explains the configuration and connect process for BlackBerry Enterprise Server 5.0.

For BlackBerry Enterprise Server 5.0

BlackBerry Enterprise Server 5.0 does not have a change database option like previous versions. KB18129 explains the configuration and connect process for BlackBerry Enterprise Server 5.0.

For BlackBerry Enterprise Server 4.0 to 4.1

  1. On the BlackBerry Enterprise Server, click Start > Programs > BlackBerry Enterprise Server > BlackBerry Server Configuration.
  2. On the Database Connectivity tab, click Change Database.
  3. In the Change Database Wizard, specify the new Microsoft SQL Server name and the existing BlackBerry Configuration Database name.
  4. Complete the wizard. Make sure that the Start Services check box is selected and click Finish.
  5. Open Administrative Tools > Services and make sure that all of the BlackBerry Enterprise Server services started successfully.
    Note: The BlackBerry Database Consistency Service might be unavailable, this is normal.
  6. Open BlackBerry Manager and make sure that the correct database is set up by completing the following:
    1. For BlackBerry Enterprise Server 4.0
      1. Right-click BlackBerry Manager, and click Properties.
      2. Select the Properties tab and verify that the Microsoft SQL Server information and BlackBerry Configuration Database name are correct.
    2. For BlackBerry Enterprise Server 4.1
      1. Go to Tools > Options > Database and verify that the Microsoft SQL Server information and BlackBerry Configuration Database name are correct.
      2. Verify that all of the BlackBerry smartphone user accounts appear on BlackBerry Manager.
      3. If there is a remote BlackBerry Manager, make sure to check the settings from step 6.
      4. Test email message flow from the BlackBerry smartphone.
      5. For BlackBerry Enterprise Server 4.1, install the database notification system.
        Note: This is only required in smaller environments running a maximum of 3 BlackBerry Enterprise Server instances.
      6. Copy the RimEsp.dll file to the C:\Program Files\Microsoft SQL Server\MSSQL\Binn folder on the new Microsoft SQL Server.
      7. In Microsoft Query Analyzer, go to the Database\DBInstallScripts\SQLServer\4.1 folder on the installation media.
      8. Open the NotifyInstall.sql file and replace <_databasename> with the name of the BlackBerry Configuration Database.
      9. Run the script.
  7. Verify that the Microsoft Query Analyzer displays the following message:  Function dbo.xp_RIM_xxxx registered
CollapseAdditional Information

When moving from a Microsoft SQL Server Desktop Engine (MSDE) server instance to a full Microsoft SQL Server instance on a separate computer, see KB04039 for information on how to increase the mail agent limitation on the BlackBerry Enterprise Server.

If receiving an error that the BlackBerry Configuration Database is in use, complete the following steps:

  1. Remove all the BlackBerry smartphone user accounts from the BlackBerry Configuration Database by typing the following commands at a command prompt:
    1. OSQL -E
    2. use master
    3. alter database <BlackBerry_Configuration_Database_name> set single_user with rollback immediate
    4. go
    5. use <BlackBerry_Configuration_Database_name>
    6. go
    7. exit
  2. Detach the BlackBerry Configuration Database by typing the following commands at a command prompt:
    1. OSQL -E
    2. use master
    3. sp_detach_db @dbname = <BlackBerry_Configuration_Database_name>
    4. go
    5. exit
  3. Attach the BlackBerry Configuration Database by typing the following commands at a command prompt:
    1. OSQL -E
    2. use master
    3. exec sp_attach_db @dbname = "<BlackBerry_Configuration_Database_name>",
    4. @filename1 = "C:\<Path_to_database_file>\<BlackBerry_Configuration_Database_name>.mdf",
    5. @filename2 = "C:\<Path_to_transaction_log_file>\<BlackBerry_Configuration_Database_name>.ldf"
    6. go
    7. exit
      Note: The default path is C:\Program Files\Microsoft SQL Server\MSSQL\Data and the default filenames are BESMgmt.mdf and BESMgmt.ldf.

Disclaimer

By downloading, accessing or otherwise using the Knowledge Base documents you agree:

   (a) that the terms of use for the documents found at www.blackberry.com/legal/knowledgebase apply to your use or reference to these documents; and

   (b) not to copy, distribute, disclose or reproduce, in full or in part any of the documents without the express written consent of RIM.


Visit the BlackBerry Technical Solution Center at www.blackberry.com/btsc.