7Installing the Siebel Database on the DB2 Host

About the Siebel Database and the Database Configuration Utilities

The Siebel database on the DB2 host stores the data used by Siebel Business Applications. Siebel Server components (particularly Application Object Managers supporting Siebel Web Clients), Siebel Developer Web Clients and Siebel Tools Clients connect directly to the Siebel database and make changes in real time.

Siebel Mobile Web Clients download a subset of the server data to use locally, and periodically synchronize with the Siebel database through the Siebel Server (Siebel Remote components) to update both the local database and the Siebel database.

The Database Configuration Utilities (formerly Siebel Database Server) comprise a set of files that you install on a Siebel Server computer. These files are accessed when you run the Database Configuration Wizard and the Siebel Upgrade Wizard to install and configure the Siebel database (Siebel Schema and seed data) on the DB2 host, or to perform operations on the Siebel database after it is installed.

The Database Configuration Utilities must be installed in the same directory location as the Siebel Server. The Siebel Gateway can be installed in a different location on the same computer or on a different computer.

The topics in this chapter describe how to install the Siebel database using the Database Configuration Wizard and the Upgrade Wizard. It is assumed that:

  • You do not have an existing Siebel database installed.

  • You have already installed the Siebel Enterprise Server components (Siebel Gateway, Siebel Server, and Database Configuration Utilities).

  • You have configured the Siebel Gateway and the Siebel Enterprise.

After you have installed the Siebel database, you configure the Siebel Server. For information on these tasks, see Siebel Installation Guide for the operating system you are using. For information on starting the Database Configuration Wizard, see Running the Database Configuration Wizard.

Note: The Database Configuration Utilities installed software has no run-time role in managing database operations for users running Siebel Business Applications.

Some of the tasks you can perform with the Database Configuration Wizard are for upgrade scenarios only and are described in Siebel Database Upgrade Guide and Siebel Database Upgrade Guide for DB2 for z/OS. Upgrades to Siebel CRM version 8.2 are not supported on the DB2 for z/OS platform.

Running the Database Configuration Wizard

You run the Database Configuration Wizard to perform a number of the tasks involved in installing a standard or customized Siebel database on DB2 for z/OS, including the following:

  • Installing the Siebel database

  • Extracting and validating the storage control files used in performing a custom installation

  • Performing post-installation tasks, such as importing the Siebel Repository, installing multilingual seed data, and importing a new language to a repository.

The Database Configuration Wizard is also used when customizing development environments to perform tasks such as migrating a Siebel Repository, or synchronizing a Siebel Repository definition with the Siebel schema.

Note: Start the Siebel Gateway before running the Database Configuration Wizard. The Database Configuration Wizard runs in live mode only so you must be connected to the Siebel Gateway. For further information on Siebel Configuration Wizard running modes, see Siebel Installation Guide for the operating system you are using.

The following topics describe how to run the Database Configuration Wizard and Upgrade Wizard from a Windows or UNIX platform. For information on performing a specific task using the utilities, see the relevant topic in the guide.

    Running the Database Configuration Wizard Under Windows

    The procedures in this topic describe how to do the following tasks on a Windows platform:

    • Start the Database Configuration Wizard under Windows

    • Save the configuration information you enter using the Database Configuration Wizard

    • Launch the Upgrade Wizard

    To run the Database Configuration Wizard under Windows

    1. From the Start menu, navigate to All Programs, Siebel Enterprise Server Configuration 8.1.1.0.0, and then Database Server Configuration.

    2. The first Database Configuration Wizard screen appears. Enter the information you are prompted for in this screen and click Next to continue.

    3. Enter the information you are prompted for in all subsequent screens. Use the Next and Back buttons to navigate to the next or previous screens.

    4. When the Configuration is complete screen appears, select one of the following options, and click Next:

      • Yes apply configuration changes now. The configuration information you entered is saved and the generated SQL is executed in the Siebel Upgrade Wizard.

      • No I will apply configuration changes later. The configuration information is saved but the generated SQL is not executed in the Siebel Upgrade Wizard. You can run the Upgrade Wizard manually later to execute the generated SQL.

    5. On the Configuration Parameter Review screen, review all the configuration values you have entered in the Database Configuration Wizard screens. To change any of the values, click Back to return to the screen with the parameter you need to change. If the values are correct, click Next to continue.

    6. Depending on the option you selected in Step 4, one of the following occurs:

      • If you selected the option, Yes apply configuration changes now, click OK and the Siebel Upgrade Wizard is launched. Click OK to proceed or click Cancel to cancel the Upgrade Wizard.

        If you click OK, the Upgrade Wizard runs the SQL scripts to perform the task you selected when you ran the Database Configuration Wizard. After the Siebel Upgrade Wizard has finished running, click Exit to exit the Database Configuration Wizard.

      • If you selected the option, No I will apply configuration changes later, a message appears saying that the Siebel Configuration Wizard completed successfully. Click OK to finish.

        The configuration information you entered in the Database Configuration Wizard is saved in a master file located in SIEBSRVR_ROOT\bin but the Upgrade Wizard is not launched. You can run the Upgrade Wizard later by entering the following command from the command line:

        SIEBSRVR_ROOT\bin\siebupg /m master_option_mf.ucf
        

        where:

        • master_option_mf is the name of the master file containing the configuration information you entered.

        • Option is the name of the Siebel database operation you selected.

          For example, enter the following command if you had selected the Install Database option:

          SIEBSRVR_ROOT\bin\siebupg /m master_install_mf.ucf
          

        This command is generated dynamically; the path name varies based on the location of your Siebel Server installation.

    Note: You can also launch the Database Configuration Wizard from the command line. For information on the command line syntax, see Siebel Installation Guide for Microsoft Windows.

      Running the Database Configuration Wizard Under UNIX

      The procedures in this topic describe how to do the following tasks on a UNIX platform:

      • Start the Database Configuration Wizard under UNIX

      • Save the configuration information you enter using the Database Configuration Wizard

      • Launch the Upgrade Wizard

      To run the Database Configuration Wizard under UNIX

      1. Before running the Database Configuration Wizard under UNIX, you must configure your environment by running the CreateDbSrvrEnvScript script. To run CreateDbSrvrEnvScript:

        1. Navigate to the SIEBSRVR_ROOT/install_script/install directory.

        2. Run CreateDbSrvrEnvScript as follows:

          CreateDbSrvrEnvScript SIEBEL_ROOT LANG Database_Platform
          

          where:

          • SIEBEL_ROOT is the top-level Siebel Enterprise Server installation directory, for example, /siebel/8.1.1.0.0/ses

          • LANG is the three-letter code for the primary language of your Siebel database, for example,ENU

          • Database_Platform is Db2.390

          CreateDbSrvrEnvScript creates two environment setup scripts, dbenv.sh and dbenv.csh, in the SIEBSRVR_ROOT/bin directory.

      2. Navigate to the SIEBSRVR_ROOT/bindirectory, and source either the dbenv.sh or the dbenv.csh file, according to the type of shell you use:

        • Korn or Bourne shell

          . ./dbenv.sh
          
          Tip: Make sure there is a space between the initial period and ./dbenv.sh.
        • C shell

          source dbenv.csh
          
      3. Review the values of the $SIEBEL_ROOT and LANGUAGE environment variables and verify that they are correct:

        • Set the LANGUAGE variable to the language in which the Database Configuration Wizard prompts appear, for example, ENU for U.S. English.

        • Set the $SIEBEL_ROOT variable to the path of your Siebel Server installation directory, for example, /siebel/8.1.1.0.0/ses/siebsrvr.

      4. Navigate to the config subdirectory of the SIEBEL_ROOT directory. For example, navigate to a location like /siebel/8.1.1.0.0/ses/config.

      5. Start the Database Configuration Wizard by running the following command:

        SIEBEL_ROOT/config/config -mode dbsrvr
        

        For a description of the command line syntax and options, see Siebel Installation Guide for UNIX.

      6. The first Database Configuration Wizard screen appears. Enter the information you are prompted for in this screen, and click Next to continue.

      7. Enter the information you are prompted for in all subsequent screens. Use the Next and Back buttons to navigate to the next or previous screens.

      8. After you have entered all the requested information, the following message is displayed:

        Configuration is complete: your output will be saved under $SiebelRoot/siebsrvr/bin/
        master_<process>_mf.ucf. Would you like to deploy the process you configured to the 
        database now or later?
        

        Choose one of the following options, then click Next:

        • Yes apply configuration changes now. The configuration information you entered is saved and the generated SQL is executed in the Siebel Upgrade Wizard.

        • No I will apply configuration changes later. The configuration information is saved but the generated SQL is not executed in the Siebel Upgrade Wizard. You can run the Upgrade Wizard manually later to execute the generated SQL.

      9. The utility displays the Parameter Review screen listing all the values you have entered. To amend any of the configuration values, click Back to return to the appropriate screen and make changes. Otherwise, click Next.

      10. Depending on the option you selected in Step 8, one of the following occurs:

        • If you selected the option, Yes apply configuration changes now, click OK and the Siebel Upgrade Wizard is launched. Click OK to proceed or click Cancel to cancel the Upgrade Wizard.

          If you click OK, the Upgrade Wizard runs the SQL scripts to perform the task you selected when you ran the Database Configuration Wizard. After the Siebel Upgrade Wizard has finished running, click Exit to exit the Database Configuration Wizard.

        • If you selected the option, No I will apply configuration changes later, a message appears saying that the Siebel Configuration Wizard completed successfully. Click OK to finish.

          The configuration information you entered in the Database Configuration Wizard is saved in a master file located in SIEBSRVR_ROOT/bin but the Upgrade Wizard is not launched. You can run the Upgrade Wizard later by entering the following command from the command line:

          srvrupgwiz /m master_process_mf.ucf 
          

          where master_process.ucf is the name of the master file containing the configuration information you entered and process is the name of the Siebel database operation you selected.

          For example, enter the following command if you had selected the Install Database option:

          srvrupgwiz /m master_install_mf.ucf
          

          The Upgrade Wizard runs the SQL scripts to perform the task you selected when you ran the Database Configuration Wizard.

        Roadmap for Installing the Siebel Database

        To install the Siebel database on the z/OS host, you must perform the following tasks in the order shown:

        1. Fill out your copy of the worksheet in Deployment Planning Worksheet with the parameter values that you need to perform the database installation and configuration.

        2. Perform the prerequisite installation tasks described in Required Tasks before the Siebel Database Installation.

        3. Review information about installing the tables, indexes, and seed data using either the standard or custom option as described in About the Database Installation Option.

        4. Install the Siebel Schema:

        5. Review the log files for any errors as described in Reviewing the Log Files for Errors.

        6. Import the Siebel Repository into the Siebel database and complete post-installation tasks as described in Importing the Repository and Performing Postinstallation Tasks

        When the Siebel database is successfully installed and you have imported the Siebel Repository, you can configure the Siebel Server. For information on this task, see Siebel Installation Guide for the operating system you are using.

        Required Tasks before the Siebel Database Installation

        Before installing and configuring the Siebel database on the z/OS host, make sure that you have the following resources available to you and have completed the following tasks.

        These tasks constitute a step in Roadmap for Installing the Siebel Database.

        • You have reviewed Siebel Installation Guide for the operating system you are using and have installed the following:

          • Siebel Gateway

          • Siebel Server

          • Database Configuration Utilities software on a Siebel Server computer, in the same top-level installation directory as the Siebel Server

        • You have configured the Siebel Gateway and the Siebel Enterprise.

        • You have designated a Siebel Server to act as a client to DB2. This server is where you installed the Database Configuration Utilities.

          Note: Verify that all the Siebel-supported languages you need are installed on the DB2-client Siebel Server. Otherwise, the installation program will not recognize the additional languages when you add them to the Siebel Schema.
        • You have installed DB2 Connect and tested ODBC connectivity between the computer on which the Siebel Server is installed and DB2, as described in Preparing for Implemention on the DB2 Host.

        • A security administrator (or someone with a logon that can create user IDs and security groups) is available to support your installation.

          • This administrator must have created the user ID that will act as the database user (for example, SADMIN). The database user must be a member of the security group with authorization to set the current SQLID to the schema name.

          • The security administrator must also create the groups needed for general Siebel application users (for example, SSEROLE).

            For more details on authorization requirements, see Security Concepts for a DB2 for z/OS Environment.

        • A database user (for example, SADMIN) with DBA or CREATEDBA authority exists. This user must also have TSO logon capability for the manual installation process.

        • Your system administrator (SYSADM) and database administrator (DBA) have set up the DB2 subsystem on the z/OS host.

          For information on this task, see Preparing for Implemention on the DB2 Host.

        • The SYSADM has created storage groups and activated and granted use of buffer pools in preparation for installation.

        • The Database Owner is a valid authorization ID.

        • (Optional) You have installed Microsoft Excel on the client computer to allow use of the Database Storage Configurator tool (dbconf.xls).

        About the Database Installation Option

        This topic constitutes a step in Roadmap for Installing the Siebel Database.

        When you choose the Install Siebel Database option from the Database Configuration Wizard, the utility performs several tasks within the database instance you created for your Siebel application:

        • It creates Siebel tables and indexes in a specified database storage layout

        • It installs Siebel triggers (optional) and views, packages, and procedures

        • It installs Siebel seed data specific to your database

        You can choose to run these operations directly against the database, or you can apply the install DDL manually on the z/OS host. You can also choose to perform a standard or custom Siebel database installation. This topic describes these installation options.

          About Database Installation Modes

          You can create the Siebel Schema using one of two modes: standard or customized.

          • Standard Install

            If you choose the standard installation option, you perform all installation tasks using the Database Configuration Wizard. A standard install creates a Siebel preconfigured database layout.

          • Customized Install

            If you choose the custom installation option, you provide a storage control file that specifies the custom database layout that is most suitable for your Siebel deployment. You must create and validate the custom storage control file before performing the Siebel Schema installation using the Database Configuration Wizard.

            About Database Installation Mechanisms

            You can choose whether the DDL used to create the Siebel Schema is automatically applied against the DB2 host or is applied manually. You can execute the DDL directly against the database by choosing the Run DDL Automatically option of the Database Configuration Wizard. Alternatively, by choosing the Generate DDL Into Files option, you can assign the DDL to an output file for later transfer to the DB2 host (using Oracle-provided scripts, your own FTP, or another file transport program) where the DBA applies the DDL using customary tools.

            Note: The Upgrade Wizard is the Siebel utility that performs Siebel database installation, upgrade, and database manipulations. The utility is launched by the Database Configuration Wizard. In Windows, the Siebel Upgrade Wizard is designated as siebupg.exe. In UNIX, it is designated as srvrupgwiz and is located in the SIEBSRVR_ROOT/ bin directory.

              Installing a New Database Language

              If you want to add a language to an existing Siebel database, you can do so by selecting the Install Siebel Database option on the Database Configuration Wizard, and then selecting the Add a language to an existing database option. Adding a language to an existing Siebel database installs seed data to support that language. For a description of this process, see Installing Multilingual Seed Data.

                About Standard Installations

                This task is a step in Roadmap for Installing the Siebel Database.

                You can use the standard install option as your sole installation procedure, or you can perform the standard installation as the first step of a custom installation, and then customize your deployment after you have completed the standard installation. To perform a custom installation, see Process of Performing a Custom Installation.

                The standard installation provides two schema layout options: Siebel Schema without Partitioning and Siebel Schema with Partitioning. As shown in the following table, the storage control file you use during the standard installation is determined by your preferred Siebel Schema layout and your encoding scheme. For additional information on the templates, see About Storage Control File Templates.

                Table Siebel Schema Layout and Storage Control File Templates

                Siebel Schema Layout Storage Control File Template to Use Storage Control File Description

                Siebel Schema without Partitioning

                storage_np.ctl

                Contains a database storage layout for a Siebel Schema that does not use Unicode encoding. No partitioned table spaces are provided in this storage control file.

                storage_np_u.ctl

                Contains a database storage layout for a Siebel Schema with Unicode encoding. No partitioned table spaces are provided in this storage control file.

                Siebel Schema with Partitioning

                storage_p.ctl

                Contains a partitioning scheme for a set of tables for ASCII.

                storage_p_u.ctl

                Contains a partitioning scheme for a set of tables for Unicode.

                storage_p_e.ctl

                Contains a partitioning scheme for a set of tables for EBCDIC.

                If you choose the Siebel partitioned layout, a selected subset of Siebel tables is defined as partitioned. For a discussion of partitioned table spaces, see About Siebel Table Partitioning.

                Performing a Standard Installation

                This task is a step in Roadmap for Installing the Siebel Database.

                This topic describes how to perform a standard Siebel database installation using the Database Configuration Wizard.

                When you select the Install Database option on the Database Configuration Wizard, you can choose the installation mechanism to use: either Run DDL Automatically or Generate DDL Into Files.

                If you select the Run DDL Automatically option, performing the steps in the following procedure completes a standard Siebel database installation.

                If you select the Generate DDL Into Files option, after performing the procedure in this topic, you must also complete the tasks described in Completing the Siebel Schema Installation Using Generated DDL to complete your standard Siebel database installation.

                To perform a standard installation

                1. Start the Siebel Gateway.

                2. Start the Database Configuration Wizard using one of the following methods:

                3. On the Siebel Server Directory screen, enter the directory path of the Siebel Server that the Siebel database will connect to. Do one of the following:

                  • Accept the default value displayed in the Siebel Server Directory field. (This value is the SIEBSRVR_ROOT directory, for example, C:\siebel\8.1.1.0.0\ses\siebsrvr(Windows) or siebel/8.1.1.0.0/ses/siebsrvr (UNIX).

                  • Use the Browse button to select the directory path where the Siebel Server is installed if it was not installed in the default directory.

                    To continue, click Next.

                4. On the Siebel Database Server Directory screen, enter the directory path to the Database Configuration Utilities software. Do one of the following:

                  • Accept the default path displayed in the Siebel Database Server Directory field. (This path is the DBSRVR_ROOT directory, for example, C:\siebel\8.1.1.0.0\ses\dbsrvr (Windows) or siebel/8.1.1.0.0/ses/dbsrvr (UNIX).

                  • Select Browse to select the directory path where the Database Configuration Utilities were installed if they were not installed in the default directory.

                    To continue, click Next.

                5. On the database platform screen, select your database platform, in this case, IBM DB2 UDB for z/OS, and then click Next.

                6. On the Siebel Database operation screen, select the Install Database option, and click Next.

                7. On the Select Installation Operation screen, select the Install Siebel Database option to install the Siebel Database Schema and populate it with seed data.

                  Note: If you have already installed your Siebel Database Schema in its base or primary language, and want to install a new language, select the option, Add a language to an existing Siebel Database. For further instructions, see Installing Multilingual Seed Data.
                8. Confirm that you want to install a new Siebel database, and click Next.

                9. Identify the appropriate database encoding method:

                  • UNICODE Database. If you select this option, click next and proceed to Step 11.

                  • Non-UNICODE Database. If you select this option, click next and proceed to Step 10.

                    Caution: Choose the correct option for your database to prevent installing the wrong data types. The database will not be able to create Unicode data types on a non-Unicode page setting, so check this setting carefully before choosing the option.
                10. If you previously indicated that your database is non-Unicode, the Database Encoding screen is displayed allowing you to indicate whether your DB2 subsystem is ASCII or EBCDIC. For more information about choosing the code page for your subsystem, see About Setting Up the DB2 Subsystem.

                  Select the appropriate option, and click Next.

                11. If you have installed more than one language pack onto the Siebel Server, the Base Language screen is displayed. Specify which language is the primary (base) language for the Siebel database, and click Next.

                12. Enter the following values for your Siebel database:

                  • ODBC Data Source Name. The Siebel Server installation process automatically creates the data source, using the format EnterpriseName_ DSN, for example, SBA_82_DSN or Siebel_DSN. Use the default name of the ODBC data source or enter the database alias you prefer to use for the data source.

                    Note: Database aliases must be registered within DB2 Connect. If you define database aliases, you must add the TXNISOLATION parameter to the database alias entry in the db2cli.ini file and set it to have a value of 1. For information on setting values in the db2cli.ini file, refer to the relevant IBM documentation.
                  • Source Database DB2 Subsystem Name. Enter the name of the DB2 database instance into which you will install the Siebel Schema, for example, Q20K.

                  To continue, click Next.

                13. On the Siebel Database User Name screen, enter a value for the Database User Name field.

                  Type the ID (for example, SADMIN) used to log into the Siebel database. This user ID must be part of the security group (secondary authorization group) with authorization to set the current SQLID to the schema name.

                14. On the Siebel Database Password screen, type the password for the ID used to log into the Siebel database. Retype the password to confirm it, then click Next.

                15. On the Siebel Schema Qualifier screen, enter the character ID that identifies the Siebel Schema owner, for example, SIEBTO. Click Next to continue.

                  Note: This ID can be up to eight characters in length, must be in uppercase, must start with a letter, and cannot include any special characters. This value is the SQL Authorization ID stored in the CURRENT SQLID special register.
                16. On the Security Group ID/Grantee screen, type the group ID for which schema access is being granted, for example, SSEROLE.

                  For more information about the group authorization ID privileges, see Security Concepts for a DB2 for z/OS Environment.

                17. On the Select Installation Type screen, choose one of the following install options:

                  • Standard Install. The standard installation option installs the database, using one of the Siebel-recommended default storage layouts.

                  • Customized Install. For a customized installation, you provide a custom storage control file, which you have created and validated prior to performing this installation. This option allows you to create the database layout that is best suited to your Siebel deployment. For information on the remaining steps in the custom installation process, see Process of Performing a Custom Installation.

                    Select the Standard Install option, click Next, and proceed to Step 18.

                18. In the Siebel Schema Layout screen, select one of the following layout options, then click Next:

                  • Siebel Schema without Partitioning. Choose this option if you want all tables in segmented table spaces.

                  • Siebel Schema with Partitioning. This layout includes a set of tables that are recommended for partitioning. The remaining nonpartitioned tables are in segmented table spaces. For more information on this option, see About Siebel Table Partitioning. For details about layout considerations, see Configuring the Siebel Database Layout.

                19. On the Storage Group for Table Spaces screen, enter the storage group name for table spaces, for example, SYSDEFLT, then click Next.

                20. Enter the storage group name for indexes, for example, SYSDEFLT, then click Next.

                21. The next four screens allow you to enter default names for the buffer pools assigned to table spaces. After entering a value on a screen, click Next to continue.

                  Note: Make sure that the buffer pools have previously been activated and that the DBA has granted access to them. For information about layout considerations, see Configuring the Siebel Database Layout.
                  • 4KB Buffer Pool Name. Type the 4-KB buffer pool name for your table spaces, or accept the default, BP1.

                  • 8KB Buffer Pool Name. Type the 8-KB buffer pool name for your table spaces, or accept the default, BP8K1.

                  • 16KB Buffer Pool Name. Type the 16-KB buffer pool name for your table spaces, or accept the default, BP16K1.

                  • 32KB Buffer Pool Name. Enter the 32-KB buffer pool name for your table spaces, or accept the default, BP32K1.

                22. Enter the name of a 4 KB buffer pool assigned to indexes, or accept the default name, BP2. This buffer pool must be activated and the DBA must have granted access to it. Click Next.

                23. Database Name Prefix. Type the prefix to assign to Siebel database names. The default value is SIDB. The prefix can consist of up to four characters, it must start with a letter, and it cannot contain any special characters.

                  Note: The database name prefix must be the same for all database objects in the Siebel schema because the prefix identifies an object as belonging to the Siebel schema. Siebel utilities can recognize and use Siebel objects only if they follow Siebel naming conventions.
                24. On the Select Installation Mechanism screen, indicate which of the following installation mechanisms you want to use:

                  • Generate DDL Into Files. Select this option to generate the DDL required to create the Siebel Schema into files. You must then transfer these files to the z/OS host where they can be applied by your DBA using customary methods, for example, SPUFI or DSNTEP2.

                    If you select this option, click Next and proceed to Step 25.

                  • Run DDL Automatically. Select this option to apply the DDL and DML required to create the Siebel Schema directly against the database, using ODBC to connect.

                    If you select this option, click Next and then proceed to Step 27.

                25. On the DDL Commit Frequency screen, select the number of DDL statements to be run before a COMMIT statement is issued. Click Next.

                26. On the Output Directory screen, specify the name of the directory where you want to save the Siebel Schema DDL files generated. Use lowercase characters for directory and path names unless directed otherwise. The default directory is DBSRVR_ROOT\db2390\dboutput\install (Windows) or DBSRVR_ROOT/db2390/dboutput/install (UNIX).

                27. On the Log Output Directory screen, accept the default log directory or enter a new directory name, and click Next.

                  By default, the files are created in SIEBSRVR_ROOT\log\install_mf (Windows) or SIEBSRVR_ROOT/log/install_mf (UNIX).

                28. Save the configuration information you have entered and launch the Siebel Upgrade wizard as described in the following relevant topic:

                29. Depending on whether you chose to Run DDL automatically or Generate DDL into files, do one of the following:

                  • If you selected the installation option Run DDL Automatically, the Siebel Upgrade Wizard applies the DDL commands to create the Siebel Schema directly against the database on the z/OS host. When you receive a message stating that the configuration was applied successfully, click OK. This step completes the Run DDL Automatically installation option.

                  • If you selected the installation option Generate DDL Into Files, the Siebel Upgrade Wizard is launched. Click OK and the Wizard generates the following files into the output directory that you designated in Step 26:

                    • schema.sql and ddlview.sql files. These contain the DDL to create the Siebel tables and indexes.

                    • instftp.bat. Use this batch file to run the Siebel-provided scripts, your own FTP, or a similar file transfer program to transport the DDL (schema.sql and ddlview.sql) to the DB2 host.

                    • instftp.txt. Use this file to transfer files to the mainframe.

                    • jobinstl.txt. Contains JCL and REXX execs to execute the DDL.

                30. To complete the installation process, you must now perform the steps in Completing the Siebel Schema Installation Using Generated DDL to apply the schema.sql and ddlview.sql files on the DB2 host.

                Completing the Siebel Schema Installation Using Generated DDL

                If you selected the installation option Generate DDL Into Files, the Siebel Upgrade Wizard generates the schema.sql and ddlview.sql files that contain the DDL to create the Siebel Schema. You must apply these files on the z/OS host, then return to your Windows or UNIX Siebel Server computer and restart the Upgrade Wizard to generate the additional files required to complete the database installation. These tasks are described in this topic.

                To complete the Siebel Schema installation using generated DDL

                1. After the Siebel Upgrade Wizard generates the schema.sql and ddlview.sql files that contain the DDL to create the Siebel Schema, the following message appears:

                  Pause #1: Please create Siebel Schema using schema.sql and ddlview.sql located in 
                  the Output Directory. Once the objects are created, please select Yes. To stop 
                  now and continue installation later please select No. (To resume, please start 
                  the Upgrade Wizard from the command line using option /m master_install_mf.ucf).
                  

                  Click No (Windows) or enter N (UNIX) to quit the Siebel Upgrade Wizard.

                2. Transfer the schema.sql and ddlview.sql files to z/OS, and have your DBA apply them to create the Siebel tables and indexes. For information on these tasks, see Applying Installation DDL on the DB2 Host.

                  The GRANT VIEW statements in ddlview.sql might cause SQL errors to be generated. For information on using GRANT VIEW statements with DB2 for z/OS, see Granting Authorization to Views in DB2.

                3. Now that you have created the Siebel Schema on the DB2 host, restart the Siebel Upgrade Wizard from the command line as described in the relevant topic:

                4. The Upgrade Wizard validates the schema, and generates the files that are used to create user-defined functions (UDFs). It then displays the following message:

                  Pause #2: Please inspect contents of schemvld.sql file to ensure that Siebel 
                  Schema was created successfully. There must be no DDL statements, only CREATE 
                  TRIGGER statements are allowed. If you find unacceptable statements in 
                  schemvld.sql file, please click "No" button, and take steps to correct the issue. 
                  Otherwise, click "Yes" and continue: ftp the files to install UDF functions. (To 
                  resume, please start the Upgrade Wizard from the command line using option /m 
                  master_install_mf.ucf). (Y/N)
                  

                  The second pause in the Siebel Schema installation process generates the schemvld.sql file. The schemvld.sql file contains SQL statements for missing Siebel Schema objects, if such objects are found. Normally, schemvld.sql contains triggers only.

                5. Click No (Windows) or enter N (UNIX) then review the schemvld.sql file to determine whether or not it contains DDL statements.

                  • If schemvld.sql does not contain SQL statements, this means the Siebel Schema was created successfully.

                  • If the file does contain SQL statements, the Siebel Schema was not created successfully, probably because the DBA missed a step during the manual schema creation process on the DB2 host. The schemvld.sql file contains the missing objects of the schema (the Delta schema). The DBA must apply the file with the missing objects to complete a full schema creation.

                    Note: If you are creating a Siebel Schema with partitioning, the generated schemvld.sql file contains triggers to remove and create objects; these are acceptable and can be ignored.
                6. Apply the user-defined functions on the DB2 host.

                  For information on this task, see Deploying User-Defined Functions.

                7. When the UDFs are deployed on the DB2 host, restart the Upgrade Wizard as described in the relevant topic:

                  The Siebel Upgrade Wizard performs the final step in the installation, that is, importing Siebel seed data.

                  Note: This operation fails if the Siebel Schema has not been created because there is no schema to populate.
                8. When you have successfully populated the schema with seed data, you are ready to carry out the final step in the Siebel Schema installation process, importing the Siebel Repository. For further information on this task, see Importing the Siebel Repository.

                Tip: To preserve a record of the values you entered during the installation, locate and print the master_install_mf.ucf file in the bin subdirectory of your Siebel Server installation directory.

                  Applying Installation DDL on the DB2 Host

                  When you install the Siebel Schema, if you select the Generate DDL Into Files option, the schema.sql and the ddlview.sql files are generated in the DDL output directory that you specified during the installation. Before continuing with the installation, you must transfer the DDL files to the DB2 host and then apply them. Both procedures are described in this topic (the instructions in this topic apply to both Windows and UNIX operating systems).

                  Note: Ensure that the tool you use (SPUFI or DSNTEP2) to apply the DDL on the DB2 host uses a slash as the SQL delimiter. For further information, see Setting Up the SQL Delimiter on DB2.

                    Transferring the DDL Files to the DB2 Host

                    The following procedure describes how to transfer the DDL files to the host.

                    To transfer the DDL files to the DB2 host
                    1. Navigate to the output directory (Windows: DBSRVR_ROOT\db2390\dboutput\install; UNIX: DBSRVR_ROOT/db2390/dboutput/install) and open the instftp.txt file.

                    2. Edit the instftp.txt file using the following information:

                      1. Change &IP into the IP address or domain name of your DB2 host, for example ZM01.

                      2. Change &Username to your user name on the z/OS host, for example SADMIN.

                      3. Change all occurrences of SIEBELQ1 to your own high-level qualifier (HLQ), for example, SADMIN. Save the file. The following is an example of the instftp.txt file.

                        open &IP 
                        
                        user &Username
                        quote site cylinders primary=1 secondary=1 
                        
                        quote site recfm=fb lrecl=80 blksize=0
                        send &directoryPath1/jobinstl.txt 'SIEBELQ1.SIEBEL.INST.JOBINSTL'
                        
                        send &directoryPath1/ddlview.sql 'SIEBELQ1.SIEBEL.INST.DDLVIEW'
                        
                        
                        
                        quote site cylinders primary=10 secondary=25 
                        
                        send &directoryPath1/schema.sql 'SIEBELQ1.SIEBEL.INST.SCHEMA'
                        
                        
                        
                        Quit
                        
                      Note: The &directoryPath1 variable is substituted with the appropriate UNIX or Windows path.
                    3. Save the changes you have made to instftp.txt.

                    4. Double-click instftp.bat from Windows or issue the following command from UNIX:

                      ftp -vn <instftp.txt> instftp.log
                      
                    5. Enter the password associated with the user name you entered in the instftp.txt file in Step 2.

                      Press any key to continue.

                    6. The files are sent to the DB2 host and the log file instftp.log is created in your DBSRVR_ROOT\db2390\dboutput\install directory (Windows) or your DBSRVR_ROOT/db2390/dboutput/install (UNIX) directory.

                    The log contains information on the file transfer, for example:

                    Connected to ZM01.siebel.com. 
                    
                    220-FTPD1 IBM FTP CS V1R4 at LOOPBACK, 22:44:26 on 2011-02-27.
                    220 Connection will close if idle for more than 5 minutes.
                    331 Send password please.
                    230 SADMIN is logged on.  Working directory is SADMIN.
                    200 SITE command was accepted
                    200 SITE command was accepted
                    200 Port request OK.
                    125 Storing data set SADMIN.SIEBEL.INST.JOBINSTL
                    250 Transfer completed successfully.
                    ftp: 45038 bytes sent in 0.00Seconds 45038000.00Kbytes/sec. 
                    200 Port request OK.
                    125 Storing data set SADMIN.SIEBEL.INST.DDLVIEW
                    250 Transfer completed successfully.
                    ftp: 1850 bytes sent in 0.00Seconds 1850000.00Kbytes/sec. 
                    200 SITE command was accepted
                    200 Port request OK.
                    125 Storing data set SADMIN.SIEBEL.INST.SCHEMA
                    250 Transfer completed successfully.
                    ftp: 8369624 bytes sent in 2.42Seconds 3452.82Kbytes/sec. 
                    221 Quit command received. Goodbye.
                    

                    You can now apply the DDL on the DB2 host.

                      Applying the DDL Files on the DB2 Host

                      The following procedure describes how to apply the DDL files on the host.

                      To apply the DDL files on the DB2 host
                      1. When the DDL file transfer is successfully completed, log on to the mainframe and navigate to the Data Set List Utility (DSLIST) panel.

                        The DSLIST panel reflects the data sets associated with the user ID you entered previously when logging on.

                      2. Edit the HLQ.SIEBEL.INST.JOBINSTL data set, for example, SIEBLQ1.SIEBEL.INST.JOBINSTL, by entering e to the left of the data set name and pressing Enter twice.

                        The Edit Entry Panel appears.

                      3. As instructed in the comments section, change all occurrences of SIEBELQ1 to your HLQ using the following command:

                        c SIEBELQ1 HLQ ALL 
                        
                        Note: Make sure that your entry is in capital letters.
                      4. Press Enter, and the changes are made.

                      5. Entersubmit on the Command line, and press Enter to submit the job.

                      6. Details of the job are displayed. Press Enter again and a new data set named HLQ.SIEBEL.INST.EXEC is created.

                      7. Press F3 to return to the DSLIST screen.

                      8. On the DSLIST screen, edit the HLQ.SIEBEL.INST.EXEC data set by entering e to the left of the data set name and pressing Enter.

                      9. Enter exec to the left of the SBLINST member and press Enter to start the installation.

                      10. On the Siebel Install Main Menu screen, you can select one of the following options:

                        • 1. Generate Siebel DDL - Generate JCL and DDL

                        • 2. Generate View DDL - Generate VIEW DDL

                        Enter 1 on the Command line to create the JCL and DDL used to generate the schema.

                      11. Enter the DDL input data set name, for example, HLQ.SIEBEL.INST.SCHEMA, and then press Enter.

                      12. Press Enter again and an SQL data set named HLQ.SIEBEL.INST.SCHEMA.SCH is created.

                      13. Press F3 to exit after the job completes.

                      14. On the DSLIST screen, enter e to the left of the HLQ.SIEBEL.INST.SCHEMA.SCH data set, and press Enter.

                        Note: If you use a tool other than the DSNTEP2 tool to create objects, specify the program and plan names of the tool you are using in the SIEBSQLA member, for example:
                      15. In the HLQ.SIEBEL.INST.SCHEMA.SCH data set, edit the following JCL members in the order shown. Run the GRJCL member last because it grants permissions to the objects (database, table spaces and tables) created when you run the other three members.

                        • DBJCL

                        • TSJCL

                        • TBJCL

                        • GRJCL

                        To edit and run each JCL member, do the following:

                        1. Enter e to the left of the JCL member, and press Enter.

                        2. Edit the job card parameters in each member, for example, specify the appropriate CLASS and MSGCLASS names:

                          // D2PUNL0 JOB ACCNT#,CLASS=S,MSGCLASS=X,MSGLEVEL=(1,1),
                          // TIME=1440,REGION=0M,NOTIFY=&SYSUID,LINES=9999
                          //*TYPRUN=SCAN
                          
                        3. Enter an asterisk (*) to the left of the TYPRUN parameter to comment out this command.

                        4. Enter submit on the Command line and press Enter to submit the job.

                          After each job is completed, verify that the return code is 0 (zero) to make sure that no errors occurred and that the job ran successfully.

                          The Siebel DDL is now generated.

                      16. To generate the View DDL file, follow the instruction to edit the HLQ.SIEBEL.INST.EXEC data set described in Step 8.

                      17. Select 2 on the Install Main Menu screen to generate the View DDL.

                      18. Enter the DDL file name, for example, HLQ.SIEBEL.INST.DDLVIEW, to specify the DDL input data set, then press Enter.

                      19. Press Enter to generate a DDLVIEW SQL data set named HLQ.SIEBEL.INST.DDLVIEW.VIE.

                      20. Press F3 to exit after the job completes.

                      21. On the DSLIST screen, enter e to the left of the HLQ.SIEBEL.INST.DDLVIEW.VIE data set, and press Enter.

                        Note: If you use a tool to create objects other than the DSNTEP2 tool, specify the program and plan names of the tool you are using in the SIEBSQLA member, for example:

                        DSN SYSTEM(Q109) RUN PROGRAM(MYTEP2) PLAN(MYTEP2) PARMS(‘ /SQLTERM(/) ‘) END

                      22. In the HLQ.SIEBEL.INST.DDLVIEW.VIE data set, edit the VIEJCL member:

                        1. Enter e to the left of the VIEJCL member, and press Enter.

                        2. Edit job card parameters in each member, for example, specify the appropriate CLASS and MSGCLASS names:

                          // D2PUNL0 JOB ACCNT#,CLASS=S,MSGCLASS=X,MSGLEVEL=(1,1),
                          // TIME=1440,REGION=0M,NOTIFY=&SYSUID,LINES=9999
                          //* TYPRUN=SCAN
                          
                        3. Enter an asterisk (*) to the left of the TYPRUN parameter to comment out this statement.

                        4. Enter an asterisk (*) to the left of the GRANT statements; GRANT statements on views are not required with DB2 for z/OS. If you do not comment out these statements, error messages are returned when you run the VIEJCL member; you can ignore these messages.

                        5. Enter submit on the Command line and press Enter to submit the job. Press Enter again.

                          After each job is completed, verify that the return code is 0 (zero), to make sure that no errors occurred and that the job ran successfully.

                      23. Return to the midtier to continue the Siebel Schema installation by verifying the schema that you have just created.

                        The schema.sql file is overwritten during the schema validation process. Therefore, if you would like to save the schema.sql file with the complete Siebel Schema DDL that was generated for the Siebel Schema, rename schema.sql (located in the DBSRVR_ROOT\db2390\dboutput\install directory on Windows or DBSRVR_ROOT/db2390/dboutput/install directory on UNIX) after you apply schema.sql on the mainframe.

                        Setting Up the SQL Delimiter on DB2

                        Because the file schema.sql uses a slash as a delimiter, you must set up the slash as the delimiter in the tool (SPUFI or DSNTEP2) you are using to apply the DDL. Siebel Business Applications ships files with slashes for delimiters because schema.sql might contain triggers for table partitioning that use semicolons. For example:

                        CREATE TRIGGER Q202999.PTH0393 NO CASCADE BEFORE INSERT ON Q202999.S_ACT_EMP 
                        REFERENCING NEW AS N FOR EACH ROW MODE DB2SQL WHEN (N.EMP_ID IS NOT NULL) BEGIN 
                        ATOMIC SET N.PARTITION_COLUMN=RIGHT(N.EMP_ID, 2); END
                        /
                        
                        Note: If you are not using table space partitioning, you can replace slashes with semicolons.

                        DSNTEP2

                        If you run the DDL in batch mode, use the DSNTEP2 tool. Perform the following procedure to set the delimiter in DSNTEP2.

                        To set the delimiter in DSNTEP2

                        • Use the SQLTERM(/) parameter to set the delimiter to a slash mark. The following example illustrates how this appears in the SYSTSIN DD statement.

                          Note: In the following example, Q202 is the subsystem name.

                        SPUFI

                        If you use SPUFI, perform the following procedure to set the delimiter.

                        To set the SQL delimiter in SPUFI

                        • Set CHANGE DEFAULTS to YES.

                          When the CURRENT SPUFI DEFAULTS panel appears, change the SQL TERMINATOR to a slash mark.

                        If you are not using triggers, you can change the slashes back to semicolons. If you use the TSO editor, do this by entering the following:

                        CHANGE X’61’ X’5E’ ALL
                        

                          Deploying User-Defined Functions

                          Two user-defined functions (UDFs) are provided in the Siebel application: nextseq and exrate. The nextseq() UDF generates sequential values for Enterprise Integration Manager (EIM) export and the exrate() UDF is used for currency aggregation functions. After the schema is validated, you must install the UDFs using the following instructions. These instructions are applicable to both Windows and UNIX operating systems.

                          Note: You must have Workload Manager (WLM) installed and configured to run the nextseq and exrate user-defined functions.

                          To deploy user-defined functions

                          1. Navigate to the output directory (DBSRVR_ROOT\db2390\dboutput\install on Windows or DBSRVR_ROOT/db2390/dboutput/install on UNIX) and modify the udfftp.txt FTP file as follows:

                            1. Change the &IP address to the IP address or domain name of your mainframe.

                            2. Change the &username to a valid TSO user ID.

                            3. Change the SIEBELQ1 high level DSN qualifier to your DSN qualifier.

                            4. Save the changes to the file.

                          2. Double-click DBSRVR_ROOT\db2390\dboutput\install\udfftp.bat (Windows) to execute the batch FTP script to send files to the mainframe, or issue the following command from UNIX:

                            ftp -vn <udfftp.txt> udfftp.log
                            

                            The script sends the following files to the mainframe from the DBSRVR_ROOT\db2390\storproc\zos directory on Windows or the DBSRVR_ROOT/db2390/storproc/zos directory on UNIX:

                            • SIEBEL.UDF.RECEIVE.JCL

                            • SIEBEL.UDF.LOAD.XMIT

                            • SIEBEL.UDF.CNTL.XMIT

                            • SIEBEL.UDF.DDL.XMIT

                            • SIEBEL.UDF.DBRM.XMIT

                          3. On the mainframe, navigate to the USER_ID.UDF.RECEIVE.JCL data set and edit the data set by typing e beside it, then press Enter.

                          4. Press Enter again.

                          5. Modify the job card parameters according to the instructions included in the JCL member.

                          6. To submit the job, type submit on the command line, and press Enter. The files you sent to the mainframe in Step 2 are received in a readable format.

                          7. Edit the HLQ.SIEBEL.UDF.DDL file by typing e to the left of the data set name, and pressing Enter.

                            1. Edit EXRATE by entering e to the left of the function name and pressing Enter. Set the Collid value in the EXRATE function to your table owner name and set the WLM environment variable to the name of your application environment.

                            2. Edit NEXTSEQ by entering e to the left of the function name and pressing Enter. Set the WLM environment variable to the name of your application environment.

                          8. Press F3 twice.

                          9. Edit the HLQ.SIEBEL.UDF.CNTL data set by typing e to the left of the data set name and pressing Enter.

                          10. In the HLQ.SIEBEL.UDF.CNTL data set, edit and run the following JCL members in the order shown:

                            • IEBCOPY

                            • CREATUDF

                            • BIND

                            • WLMRFSH

                            The WLMRFSH (refresh) job must be the last job run.

                            Edit and submit each JCL member in turn as follows:

                            1. Edit the member by entering e to the left of the member name and pressing Enter.

                            2. Edit the job card parameters according to the instructions in the member.

                            3. Submit the job by entering submit on the command line, and pressing Enter.

                            Make sure that the return code for each job equals 0.

                          Return to the midtier to continue the Siebel Schema installation by populating the schema with seed data.

                            Process of Performing a Custom Installation

                            This process is a step in Roadmap for Installing the Siebel Database.

                            You can use the Database Configuration Wizard option, Customized Install, to configure the Siebel database storage layout for the Siebel application installation.

                            To perform a custom installation, perform the following tasks:

                            Preparing a Storage Control File

                            This task is a step in Process of Performing a Custom Installation.

                            When you select the standard Siebel Schema installation method, the Database Configuration Wizard creates a storage control file based on the information that you provide in response to prompts.

                            When you select the custom installation method, you must first create the storage control file that is used as the basis of your Siebel Schema custom installation. You can choose from the following options:

                            • Use an existing storage control file in the custom installation.

                              You can specify the name of an existing storage control file in a custom installation.

                            • Modify one of the Siebel-provided storage control file templates and use it in the custom installation.

                              You can edit the storage control file template directly, or you can use the Siebel Database Storage Configurator (dbconf.xls) to modify the template. For more information, see Modifying a Storage Control File Using the Database Storage Configurator.

                            • Extract a storage control file based on the layout of the existing Siebel Schema using the Extract Storage File option of the Database Configuration Wizard. For more information, see Extracting a Storage Control File from the DB2 Catalog.

                              Extracting a Storage Control File from the DB2 Catalog

                              You can create a storage control file using the Siebel extract utility. This utility extracts the storage layout of your source database from the DB2 catalog and creates a new storage control file that you can use, for example, in performing a custom installation or in cloning an existing Siebel database. You can use the extract utility at any time.

                              Note: You must validate the storage control file after you extract it and after you modify it. For information on how to validate a storage control file, see Validating an Extracted or Modified Storage Control File.

                              Follow the instructions in the following procedure to extract a storage control file under Windows and UNIX.

                              To extract the storage control file

                              1. Launch the Database Configuration Wizard and follow the steps in Performing a Standard Installation until the Siebel Database Operation screen is displayed.

                              2. On the Siebel Database Operation screen, select Run Database Utilities, and click Next.

                              3. From the Database Utility Selection screen, select Configure Database, and click Next.

                              4. The following options are available on the Database Configuration Options screen:

                                • Extract Storage File. Extracts a storage control file based on the existing Siebel Schema layout.

                                • Validate Storage File. Validates that a specified template and a specified schema will work on the DB2 host.

                                Select the Extract Storage File option, and click Next.

                              5. The following Extract options are available:

                                • Extract from Catalog. This option extracts the storage layout of your source database from the DB2 catalog. The output is a new storage layout.

                                • Extract from Catalog and Merge with Template. Extracts the storage layout of your source database and merges it with a Siebel template storage control file. This preserves your schema layout. If a database object is specified in both the existing database and the template, the layout of the existing database is extracted as the default. If there are conflicts that cannot be resolved, the extract process fails. You must correct any errors and run the Extract process again.

                                Select the appropriate Extract option, and click Next.

                              6. If you have installed more than one language pack onto the Siebel Server, the Base Language screen is displayed. Specify which language is the primary (base) language for the Siebel database, and click Next.

                              7. On the ODBC Data Source Name screen, you can either select the default name of the ODBC data source or specify a different data source name.

                                Note: The Siebel Server installation process automatically creates the data source, using the format EnterpriseName_DSN.
                              8. On the Siebel Database User Name screen, type your source database user name, and then click Next.

                              9. On the Siebel Database Password screen, type the password associated with the source database user name, confirm the password by typing it again, and then click Next.

                              10. On the Siebel Schema Qualifier screen, type the schema qualifier for your existing database, and then click Next.

                                The schema qualifier is also an authorization ID. The schema qualifier must start with a letter and cannot contain special characters.

                              11. Identify the database encoding scheme; either Unicode or Non-Unicode.

                                If you selected the UNICODE Database option, proceed to Step 13.

                                Caution: Choose the correct option for your database to prevent installing the wrong data types. The database cannot create Unicode data types on a non-Unicode page setting, so check this setting carefully before choosing the option.
                              12. If you indicated that your database uses a non-Unicode encoding scheme, specify the code page encoding scheme you use, either ASCII or EBCDIC, and click Next.

                                For more information on choosing the database code page, see Considerations in Choosing the Database CCSID.

                              13. On the Default Database Name screen, enter the default name for Siebel databases (for example, SIDB), and click Next.

                              14. On the Default Table Space screen, enter the default name for Siebel table spaces (for example, SIEBTS), and click Next.

                              15. On the Default Storage Group screen, enter the default storage group name for Siebel table spaces, for example, SYSDEFLT. Click Next.

                              16. Enter the default storage group name for Siebel indexes, for example, SYSDEFLT. Click Next.

                              17. On the Default Buffer Pool Name screen, specify the default name of the buffer pool assigned to table spaces or accept the default, BP1. Your DBA must have previously activated the buffer pool and granted access to it.

                              18. Enter the default name of the 4 KB buffer pool assigned to indexes, or accept the default name, BP2. This buffer pool must be activated and the DBA must have granted access to it. Click Next.

                              19. In the Storage Control File screen, type the name you want to assign to the new storage control file generated, for example DBSRVR_ROOT\db2390\my_storage_file.ctl (Windows) or DBSRVR_ROOT/db2390/my_storage_file.ctl (UNIX). Click Next.

                              20. On the Log Output Directory screen, indicate the directory where you want the log files to be generated. The default directory is SIEBSRVR_ROOT\log\dbconfig_extract_catalog_mf (Windows) or SIEBSRVR_ROOT/log/dbconfig_extract_catalog_mf (UNIX).

                              21. Save the configuration information you have entered and launch the Siebel Upgrade wizard as described in the following topics:

                              22. Click OK.

                                The Upgrade Wizard connects to the z/OS host, extracts the storage control file from the DB2 catalog, and copies it to the file you specified.

                              23. Click Exit to exit the Database Configuration Wizard.

                                You must now validate the extracted storage control file as described in Validating an Extracted or Modified Storage Control File

                                Validating an Extracted or Modified Storage Control File

                                You must validate a storage control file after you extract it or after you modify it to ensure it has been correctly generated and will work with the Siebel Schema as defined in the schema.ddl file.

                                To validate a storage control file

                                1. Launch the Database Configuration Wizard and follow the steps in Performing a Standard Installation until the Siebel Database Operation screen is displayed (Step 6).

                                2. On the Siebel Database Operation screen, select Run Database Utilities, and click Next.

                                3. Choose the Configure Database option, and click Next.

                                4. On the Database Configuration Options screen, select the Validate Storage File option, and click Next. This option validates that a specified storage control file and a specified schema will work on the DB2 host.

                                5. Select one of the following options:

                                  • Batch - Generate Unload/Load. Select this option to validate the storage control file that you are going to use when upgrading to a new release of Siebel Business Applications.

                                  • Foreground - Generate Insert/Select. Select this option to validate the storage control file that you are going to use when migrating repositories or synchronizing Siebel Repository definitions with the Siebel Schema.

                                6. Identify the appropriate database encoding method, either Unicode or non-Unicode, and click Next.

                                  Caution: Choose the correct option for your database to prevent installing the wrong data types. The database cannot create Unicode data types on a non-Unicode page setting, so check this setting carefully before choosing the option.

                                  If you selected the UNICODE Database option, proceed to Step 8.

                                7. If you indicated that your database uses a non-Unicode encoding scheme, specify the code page encoding scheme for your Siebel database, either ASCII or EBCDIC.

                                  For more information on choosing the database code page, see Considerations in Choosing the Database CCSID.

                                8. If you have installed more than one language pack onto the Siebel Server, the Base Language screen is displayed. Specify which language is the primary (base) language for the Siebel database, and click Next.

                                9. On the ODBC Data Source screen, accept the default name of the ODBC data source, or enter a different data source name.

                                  Note: The Siebel Server installation process automatically creates the data source, using the format EnterpriseName_DSN.

                                  To continue, click Next.

                                10. On the Siebel Database User Name screen, indicate the source database user name. The user name must be an ID authorized to log in to the Siebel database and must have authorization to set the CURRENT SQLID.

                                  To continue, click Next.

                                11. On the Siebel Database Password screen, enter the password associated with the source database user name. Reenter the password to confirm it, then click Next.

                                12. On the Siebel Database Schema Qualifier screen, enter the identifier that designates the Siebel Schema for your database. This is also an authorization ID. The schema qualifier must start with a letter, can be up to 8 characters in length, and cannot contain special characters.

                                  To continue, click Next.

                                13. On the Security Group ID/Grantee screen, type the group ID for which schema access is being granted, for example, SSEROLE.

                                14. On the Schema File screen, specify the name and directory path of the schema file against which the extracted storage control file is to be validated. If your Siebel schema has been modified, use schema.ddl. For the Siebel preconfigured schema, use ddl.ctl.

                                15. On the Storage control file screen, enter the directory path and filename of the file you extracted (as described in Extracting a Storage Control File from the DB2 Catalog) and which you want to validate.

                                  To continue, click Next.

                                16. On the Log Output Directory screen, indicate the directory where you want the log files to be generated. The default directory is SIEBSRVR_ROOT\log\dbconfig_validate_mf\output (Windows) or SIEBSRVR_ROOT/log/dbconfig_validate_mf/output (UNIX).

                                17. Save the configuration information you have entered and launch the Siebel Upgrade wizard as described in the following topics:

                                18. Click OK to start the validation process.

                                19. When the validation process completes successfully, click Exit to exit the Database Configuration Wizard.

                                  If the validation process fails, errors are noted in the log files in the directory you specified in Step 16. Correct the errors noted and run the validation process again.

                                  If you chose the Batch - Generate Unload/Load validate option, the validation process generates the following additional files in the log output directory. Review these files to determine the cause of validation errors:

                                  • load.ldc

                                  • schema.db.sql

                                  • schema.grt.sql

                                  • schema.nuind.sql

                                  • schema.oind.sql

                                  • schema.sql

                                  • schema.tbl.sql

                                  • schema.tbsp.sql

                                  • schema.uind.sql

                                  • unload.ldc

                                  Performing a Custom Installation

                                  This task is a step in Process of Performing a Custom Installation.

                                  This topic describes how to perform a custom Siebel database installation using the Database Configuration Wizard.

                                  When you select the Install Database option on the Database Configuration Wizard, you can choose the installation mechanism to use: either Run DDL Automatically or Generate DDL Into Files. If you select the Run DDL Automatically option, performing the steps in the following procedure completes the custom Siebel database installation.

                                  If you select the Generate DDL Into Files option, after performing the procedure in this topic, you must also complete the tasks described in Completing the Siebel Schema Installation Using Generated DDL to complete your custom Siebel database installation.

                                  To perform a custom installation

                                  1. Launch the Database Configuration Wizard and follow the steps described in Performing a Standard Installation until the Select Installation Type screen appears (Step 17).

                                  2. Select the Customized Install option, and click Next.

                                  3. In the Storage Control File screen, enter the name of the customized storage control file that you want to use to configure storage on the DB2 host. You can use the Browse button to navigate to this file.

                                    To continue, click Next.

                                  4. In the Select Installation Mechanism screen, indicate which installation mechanism you want to use:

                                    • Generate DDL into Files

                                      Select this option to generate the DDL required to create the Siebel Schema into a file. You must later use Siebel-provided scripts, your own FTP, or a similar file transfer program to transport the DDL (schema.sql and ddlview.sql) to the DB2 host, where the DBA executes it, using customary methods, for example, SPUFI.

                                      To continue, click Next and proceed to Step 5.

                                    • Run DDL Automatically

                                      Select this mechanism to apply the DDL and DML required to create the Siebel Schema directly against the database.

                                      The Siebel application uses ODBC to apply all necessary steps in this installation method.

                                      To continue, click Next and proceed to Step 7.

                                  5. On the DDL Commit Frequency screen, choose the number of DDL statements to be run before a COMMIT statement is issued. Click Next.

                                  6. In the Output Directory screen, specify the name of the directory where you want to save the Siebel Schema DDL files that are generated. The default directory is DBSRVR_ROOT\db2390\dboutput\install (Windows) or DBSRVR_ROOT/db2390/dboutput/install (UNIX).

                                  7. On the Log Output Directory screen, indicate the directory where you want the install log files to be generated, and click Next.

                                    By default, the files are created in SIEBSRVR_ROOT\log\install_mf (Windows) or SIEBSRVR_ROOT/log/install_mf (UNIX).

                                  8. Save the configuration information you have entered and launch the Siebel Upgrade Wizard as described in the following topics:

                                  9. Press OK and the Upgrade Wizard is launched.

                                    • If you selected the Run DDL Automatically installation option, the Siebel Upgrade Wizard applies the DDL commands to create the Siebel Schema directly against the database on the z/OS host. When you receive a message stating that the configuration was applied successfully, click OK.

                                      This step completes the Run DDL Automatically installation option.

                                    • If you selected the Generate DDL Into Files installation option, click OK to continue, and the Siebel Upgrade Wizard generates the following files into the output directory that you designated in Step 6.

                                      • schema.sql and ddlview.sql files. These contain the DDL to create the Siebel tables and indexes.

                                      • instftp.bat. Use this batch file to run the Siebel-provided scripts, your own FTP, or a similar file transfer program to transport the DDL (schema.sql and ddlview.sql) to the DB2 host.

                                      • instftp.txt. Use this file to transfer files to the mainframe.

                                      • jobinstl.txt. Contains JCL and REXX execs to execute the DDL.

                                      To complete the installation process, you must now perform the steps in Completing the Siebel Schema Installation Using Generated DDL to apply the schema.sql and ddlview.sql files on the DB2 host.

                                  When you have successfully completed the installation, you are ready to import the Siebel Repository. For further information, see Importing the Siebel Repository.

                                  About the Siebel Log Files

                                  The Upgrade Wizard writes logs that provide detailed information on the installation and configuration processes you run, and they also list all errors. The Upgrade Wizard writes the logs for a process to one of the following directories by default:

                                  • Windows: SIEBSRVR_ROOT\LOG\process

                                  • UNIX:SIEBSRVR_ROOT/log/process

                                  where process is the name of the process you have run, for example, install_mf (install a Siebel database) or imprep (import repository).

                                  Note: You can select a different log directory name from the Log Output Directory screen when you run the Database Configuration Wizard.

                                  The process directory contains the following subdirectories:

                                  • Output. Directory containing the process log files

                                  • State. Directory containing the state.log file

                                  The output and state directories are automatically archived on subsequent runs of a process that completes successfully. (The names of subsequent log directories are appended with _1, _2, and so on.) To preserve disk space, periodically delete or save log directories to another location.

                                    About the State Log File

                                    Each installation and database configuration process consists of a series of steps, each of which must complete successfully. If the Upgrade Wizard cannot complete a step, it marks the step as incomplete in the state.log file and exits.

                                    You must correct the error and then run the Upgrade Wizard again. When you rerun the Upgrade Wizard, it refers to the state log and resumes at the incomplete step that contained the error.

                                      About Process Log Files

                                      You can identify errors you encounter during an upgrade by reviewing the process log files, named Upgwiz.log (Windows) or srvrupgwiz1.log (UNIX), in the output directory.

                                      The name of the log file increments for subsequent log files that are created if the Siebel Upgrade Wizard is run again for the same process.

                                        Reviewing the Log Files for Errors

                                        This task is a step in Roadmap for Installing the Siebel Database.

                                        Review the Siebel database installation and configuration log files to verify that the process you ran completed correctly, and to identify errors that must be resolved. The log files might include errors that are expected and benign. You must compare any error messages found in the log files to the sample error messages listed in the errors file, and correct any non-benign errors. For additional information about the log files, see About the Siebel Log Files.

                                        To manually review the log files for unacceptable errors

                                        1. Print the errors file. The errors file lists the benign and expected errors you might find in the log files; you can ignore these errors. The errors file is located in the installation subdirectory:

                                          Windows: DBSRVR_ROOT\DB2390\errors.rtf or errors.htm

                                          UNIX: DBSRVR_ROOT/DB2390/errors.txt

                                        2. Sort the log files in the following directory by date.

                                          Windows: SIEBSRVR_ROOT\LOG\process\output

                                          UNIX: SIEBSRVR_ROOT/LOG/process/output

                                        3. Open each log file, starting with the earliest, and search for errors. Starting with the earliest log file can shorten your research time.

                                          Log files are identified by the .log extension. Errors are either tagged with the word error or enclosed in square brackets [...].

                                        4. For each error found, compare the error description against the list of acceptable errors documented in the errors file.

                                          Identify errors as follows:

                                          • If you find the error in the errors file, errors of that type are acceptable and no action is required. Continue to review the errors found in the log file.

                                          • If a log file is not listed in the errors file, there are no acceptable error messages for that log file.

                                          • If you find an error that is not listed in the errors file, it is unacceptable. You must correct the condition that caused the error before you run the Siebel Upgrade Wizard again.

                                        5. Repeat Step 4 for each log file.

                                          For help with determining the cause of an error, create a service request (SR) on My Oracle Support.

                                          When reviewing error messages, be aware that error numbers can change after the installation of a new driver version. Compare the error descriptions to find out which are acceptable errors for the z/OS platform.

                                          Caution: Although you are unlikely to encounter errors other than those listed in the errors file (see Step 1), it is critical that you review the error messages. Certain errors, such as a failure to create indexes, can result in performance problems or anomalous behavior in Siebel Business Applications.

                                          About Identifying Errors Returned by Applications

                                          The process log files produced by the Siebel Upgrade Wizard (upgwiz.log on Windows and srvrupgwiz.log on UNIX) do not contain information on errors returned by applications. Review the end of the log file for details about the latest failure. If the step that failed was not a native SQL step (which would be listed in the log file), then it occurred as part of an external utility for which you need to review a corresponding log file, identified by the /L parameter.

                                          To find additional operation-specific log files, open upgwiz.log or srvrupgwiz.log using a text editor and search for a “.log” string or a “/L” string. The log file shows the names of log files produced during the installation operation; for example, if the configuration of the Siebel database fails, the upgwiz.log file contains the following information:

                                          GenericLog GenericError 1 2011-02-28 15:51:24 (err=1) was returned by application 
                                          (C:\siebel\8.2.2.0.0\ses\siebsrvr\bin\ddlimp.exe ...)
                                          GenericLog GenericError 1 2011-02-28 15:51:24 Execute file action failed 
                                          (err=Launching the application)
                                          

                                          In an example such as the previous one, the ddlimp.log file contains a detailed error message:

                                          DDLIMP-ERR-1071: Unable to build ddl statement "add col" (Open unloadtbl.jcl)
                                          

                                            Rerunning the Installation

                                            If you need to rerun the Siebel Schema installation from the beginning, either after completing an installation run or after starting but not finishing the run, enter a new log output directory name.

                                            You have to rerun the installation when you generate a new DDL file for the Siebel Schema based on a new or modified storage control file.