How to create or upgrade a BlackBerry Configuration Database

Article ID: KB03640

Type: Support Content

Last Modified: 04-18-2013

 

Product(s) Affected:

  • BlackBerry Enterprise Server for Microsoft Exchange
Jump to: Environment | Overview
CollapseEnvironment
  • BlackBerry Enterprise Server for Microsoft Exchange 4.0 to 5.0 SP3
  • Microsoft SQL Server 2000 to 2008
CollapseOverview

The tool used to upgrade the BlackBerry Configuration Database depends on the database's location. The following two scenarios outline how to upgrade the BlackBerry Configuration Database and which tools to use.

Note: When installing or upgrading the BlackBerry Enterprise Server, the BlackBerry Configuration Database is created or updated automatically. The procedure below is only necessary when manually creating or upgrading the BlackBerry Configuration Database.


Scenario 1 - BlackBerry Configuration Database is installed on the same computer as the BlackBerry Enterprise Server

Complete the following steps:

  1. From the extracted BlackBerry Enterprise Server installation package, open the Database folder.
  2. Open the BlackBerry Configuration Database CFG file (for example, BESMgmt.cfg).
  3. Modify the command values as necessary for the environment, according to the following table and then save the file.



    Command Procedure
    Database_name Type the BlackBerry Configuration Database name. The default name is BESMgmt.
    CMD Create a new BlackBerry Configuration Database and verify that the command (CMD) option defined is Install.

    To upgrade a previously existing database, change the CMD option to Migrate for BlackBerry Enterprise Server 4.0, or change the CMD option to Upgrade for BlackBerry Enterprise Server 4.1 and higher. Use the Restore option to restore a previously backed up BlackBerry Configuration Database using RESTORE_FILENAME. Use the CatalogDatabase option (IBM DB2 only) to catalog a remote BlackBerry Configuration Database locally.
    Userid & Password This is the administration account and password used to create or update the BlackBerry Configuration Database. If this is not set, then the Userid will be the administration account using this tool.

    Note: This option is only available with BlackBerry Enterprise Server 4.1.

    Verbose Set this option to True to have information or error messages displayed on the computer.
    Version Specify the BlackBerry Configuration Database version to create or migrate to using one of the following: 3.5, 3.6, 4.0, or 4.1 (the most recent BlackBerry Enterprise Server version is the default).
    Create By default, this option is set to True. Set this option to False if no BlackBerry Configuration Database should be created.

    Note: This setting is ignored during a migration or upgrade.
    Backup By default, this is set to False. Set this to True to back up the existing BlackBerry Configuration Database.
    Drop By default, this option is set to False. Set this option to True to drop the existing BlackBerry Configuration Database.

    Note: This setting is ignored during a migration or upgrade.
    DB2NODE This is the local node name of the remote IBM DB2 server. If a BlackBerry Configuration Database is created locally, leave the node name blank. IBM DB2 has an 8 character limit for the node name.

    Note: This applies only to IBM DB2 for creating a new BlackBerry Configuration Database.
    DB2SERVER & DB2PORT This option is used to create the local node name if the DB2NODE value does not exist.
    DB2REMOTE_DB & DB2LOCAL_DB This option is used by the CatalogDatabase command. Leave the DB2LOCAL_DB option blank to create a local alias name that is the same as the remote BlackBerry Configuration Database name.
    Stop By default, this option is set to True. Set this to True if the process stops and an error is displayed.
    Script_root By default, this directory is in the same directory as the CreateDB tool. Specify the path to the DBInstallScripts directory.
    Log_dir By default, this directory is in the same directory as the CreateDB tool. Specify the path to the directory in which to create the log files. The directory should exist and there should be no trailing backward slash ( \ ).
    Timestamp By default, this is set to True. Set this to False to remove time stamps (in HHMMSS format) from the log files.
    Developer By default, this is set to False. If this is set to True, the Developer command creates a smaller BlackBerry Configuration Database.
    DBMS By default, this is set to SQLServer. Specify which database management system is used.
    DB2SCHEMA This is the owner of the IBM DB2 Schema. If DB2SCHEMA is not present, set the default to BESADMIN.
    Db_file_dir Specify a directory in which to save the BlackBerry Configuration Database files. The directory must already exist. For Microsoft SQL Server, the default is the same location as the Microsoft SQL Server TempDB database.
    Backup_dir Specify a directory in which to save the BlackBerry Configuration Database backup file. The directory must already exist. The default is the same location as the BlackBerry Configuration Database file.
    Restore_filename By default, this is <database_location>\<database_name>BKUP.dat, where <database_location> is the location of the BlackBerry Configuration Database and <database_name> is the name of the BlackBerry Configuration Database.

    Specify the file to use if a BlackBerry Configuration Database restore is required.

    Note: If more than one backup file exists, the most current version is used.
    GENERATE_EXECUTE By default this option is set to True. If this option is set to False, the Microsoft SQL Server files will be generated but not executed.
    Server By default, this option is set to Local. Specify the computer on which to install the BlackBerry Configuration Database.


  4. From a command prompt, navigate to the Database folder containing the modified .cfg file.
  5. Type CreateDB <filename.cfg> and press Enter (example: createdb besmgmt.cfg)
  6. When the procedure is complete, close the command prompt.

Scenario 2 - Upgrade a BlackBerry Configuration Database that is installed on a remote computer

Complete the following steps:

  1. On the BlackBerry Enterprise Server installation CD, copy and paste the Database folder to the hard disk drive of the remote Microsoft SQL Server.
  2. Configure the BESMgmt.cfg file to install or upgrade a BlackBerry Configuration Database.
  3. From a command prompt, run the CreateDB.exe tool on the computer containing the BlackBerry Configuration Database.

Note: The BESMgmt.cfg may need to be modified to meet the configuration of the Microsoft SQL Server database installation and BlackBerry Configuration Database. For instructions on configuring the BESMgmt.cfg file settings, see Scenario 1 of this article.

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.