Generating Oracle database scripts using the BPMConfig command

You can use the BPMConfig command to generate the database scripts that are used to create your database tables. If you used the BPMConfig command to create the stand-alone profiles and database tables, the scripts were generated for you.

Before you begin

Prepare the following information:
  • Information about the database configuration that you are designing. This might be a document that describes the general purpose of the database configuration supplied by the database administrator or solution architect. Alternatively, it might be a description of required parameters and properties. This information must include:
    • The location of the databases.
    • The user ID and password for authenticating to the database.
  • Information about how IBM® Business Process Manager and its components have been installed, the database software used, and the properties required by that type of database.
  • Information about the topology pattern to be implemented, and an understanding of how the database design fits into the pattern that you plan to use.
Important: If you are using an Oracle database, you must include the database user name and password for all databases, including the optional ones.

Procedure

To generate the database SQL scripts that you can use to create your database tables, complete the following steps:

  1. On the computer where you installed IBM Business Process Manager, locate the appropriate sample properties file in the following path: install_root\BPM\samples\config.
  2. Find the sample properties file that most closely represents your target deployment environment and make a copy of this file.

    For more information about the sample configuration files, refer to Configuration properties for the BPMConfig command.

  3. Edit the copied properties file and update the values as required to reflect your profile and database configuration. When modifying the sample properties file, use the guidance provided within the file for specifying values.

    For more information about the available properties, see the BPMConfig command-line utility topic and the descriptions in the Configuration properties for the BPMConfig command topic.

  4. Run the BPMConfig command with the parameter -sqlfiles and the name of the equivalent properties file you choose.
    • To generate the database scripts in the dbscripts directory of the stand-alone profile, use the following syntax:
      install_root\bin\BPMConfig -create -sqlfiles my_environment.properties
      Note: The SQL scripts are generated in the STAND-ALONE_PROFILE/dbscripts folder by default. These scripts are deleted if you run the BPMConfig command again.
    • To generate the database scripts in an output directory of your choice, use the following syntax:
      install_root\bin\BPMConfig -create -sqlfiles my_environment.properties -outputDir MyBPMScriptDir

      In the above syntax, MyBPMScriptDir is the directory you specify.

Results

The database SQL scripts are generated in the STAND-ALONE_PROFILE\dbscripts folder by default. This folder includes the following sub-folders:

  • cell_name.deployment_environment_name - For each deployment environment, this folder will contain the SQL files that need to be run.

These subdirectories also contain a createDatabase.sql script, which you can use to run the database scripts to create the Oracle database tables.

A default configuration for an Express deployment environment with Oracle databases contains the following sub-folders and SQL scripts:
  • cell_name.deployment_environment_name
    • Oracle
      • orcl
        • cmnuser
          • createSchema_Express.sql
          • createSchema_Messaging.sql
        • psuser
          • createSchema_Express.sql
          • createProcedure_Express.sql
        • pdwuser
          • createSchema_Express.sql
In the above example, orcl is the Oracle instance, cmnuser is the deployment environment-level user, psuser is the Process Server user, and pdwuser is the Performance Data Warehouse user.