3Installing Siebel CRM Server Modules

Installing Siebel CRM Server Modules

About Installation Tasks for Siebel CRM

Use the Siebel Enterprise Server installer to install the Siebel CRM server modules, including Siebel Gateway, Siebel Server, Database Configuration Utilities, and Siebel Application Interface. Optionally, you can also install EAI Connector, Siebel Enterprise Cache, and Siebel Constraint Engine (which is available as a developer preview). This chapter describes both new installations and migration installations.

Before installing Siebel CRM modules, review the following and perform any necessary preinstallation tasks:

Use the instructions in this chapter to install the following Siebel CRM modules:

  • Siebel Application Interface

  • Siebel Gateway

  • Siebel Server

  • EAI Connector (optional)

  • Database Configuration Utilities (install with the first Siebel Server)

  • Siebel Enterprise Cache (optional)

  • Siebel Constraint Engine (optional, available as a developer preview; see also Siebel Product Administration Guide)

Various restrictions and guidelines apply regarding which Siebel CRM modules must be installed separately or are recommended to be installed separately from other modules. Note the following restrictions and guidelines for installing these modules:

  • Siebel Application Interface cannot be installed in the same location as the other Siebel CRM modules. You install Siebel Application Interface in the secured application intranet zone, in a different location on the same computer as the other Siebel CRM modules, or on a different computer.

  • Siebel Gateway cannot be installed with either of the following Siebel CRM modules:

    • Siebel Enterprise Cache

    • Siebel Constraint Engine

  • You cannot install Database Configuration Utilities without also installing a Siebel Server.

  • You can install EAI Connector with other Siebel Enterprise Server modules or install it a separate location.

  • If you are installing and deploying Siebel Constraint Engine (available as a developer preview), then you must also install and deploy Siebel Enterprise Cache somewhere in your Siebel deployment.

  • If you are installing Siebel Enterprise Cache, requirements apply for installing other modules, as noted in Requirements for AIX Only.

  • For Siebel CRM modules that are new in Siebel CRM 17.0, you must perform a new installation, because the migration installation option is not available. This requirement applies to Siebel Enterprise Cache and Siebel Constraint Engine.

  • Some installation combinations are strongly recommended against. The installer prevents installation combinations that are not allowed, and warns for installation combinations that are not recommended for production or other end-user environments.

  • You cannot install another Siebel CRM module into an existing installation of the same version. You must perform a new installation into a different location.

You can install and deploy multiple instances of Siebel CRM modules. For example:

For more information about different ways of deploying Siebel CRM modules, see Installation and Configuration Methods by Deployment Type.

After a new installation, you install the Siebel database and then you configure Siebel CRM modules using the Siebel Management Console. You perform the configuration tasks after installing Siebel CRM 17.0 and installing Siebel CRM 20.9 Update.

You perform migration installations using the same installer that you use for new installations. A migration installation replaces your existing installation with a new installation. However, the installation location, installation languages, server configuration data, and other settings from the existing installation are used for the new installation, where feasible. Before the new installation is performed, the existing installation is moved to a backup location and can no longer be used.

Note: In a migration installation case, you must install Siebel Application Interface before you install any other Siebel CRM modules. A migration installation of Siebel Application Interface does not copy customer configurations or files from your existing installation of SWSE to the new installation. After completing all of the migration installations, you must configure the Siebel Application Interface.
Caution: You must perform any necessary manual migration tasks prior to performing migration installations, as described in Additional Tasks for Migration Installations. For example, you must remove the existing configuration for the SWSE before you install Siebel Application Interface as a migration installation. If you are using data encryption, then you must back up the key file.

For client installation, see Installing Siebel Web Clients and Siebel Tools.

Related Topics

Installation-Related Changes for Siebel CRM 17.0

Installing Siebel CRM

Installing Siebel CRM in Unattended Mode

Additional Tasks for Migration Installations

Configuring Siebel CRM Server Modules

Installing Siebel Web Clients and Siebel Tools

Requirements for Installing and Configuring Siebel CRM

About Installing Siebel CRM

Installing Siebel CRM

Note: After you have installed Siebel CRM 17.0, as described in this topic, you then install Siebel CRM 20.9 Update, as described in Installing and Uninstalling Siebel CRM 20.x Update. For more information, see Installation-Related Changes for Siebel CRM 20.x Update.

This topic provides instructions for installing Siebel CRM modules, using the GUI installation method, as part of standard deployment. Use these instructions to install the following modules:

  • Siebel Application Interface

  • Siebel Gateway

  • Siebel Server

  • EAI Connector (optional)

  • Database Configuration Utilities (install with the first Siebel Server)

  • Siebel Enterprise Cache (optional)

  • Siebel Constraint Engine (optional, available as a developer preview; see also Siebel Product Administration Guide)

For more information about installing these modules, see About Installation Tasks for Siebel CRM. See also Requirements for Installing and Configuring Siebel CRM.

Note: This topic includes instructions for installing Siebel CRM modules in a new installation or in a migration installation. For an existing installation, you perform a migration installation instead of a new installation.

This topic contains the following information:

Related Topics

About Installation Tasks for Siebel CRM

Installing Siebel CRM in Unattended Mode

Configuring Siebel CRM Server Modules

Additional Postinstallation and Configuration Tasks

Verifying Installation for Siebel CRM

Uninstalling Siebel CRM

Requirements for Installing and Configuring Siebel CRM

Related Books

Siebel Security Guide

Siebel Deployment Planning Guide

Siebel Global Deployment Guide

Siebel Product Administration Guide

Installing Siebel CRM in a New Installation

Use the following procedure to install Siebel CRM modules in a new installation. This topic is part of Installing Siebel CRM.

Note: Use this procedure only where existing Siebel CRM modules are not already installed. Where an earlier version of a module is already installed, you perform a migration installation instead, as described in Installing Siebel CRM in a Migration Installation.

This task is a step in:

To install Siebel CRM modules in a new installation

  1. Review Before You Install Siebel CRM and About Installation Tasks for Siebel CRM and observe the requirements and recommendations.

    For example, if you are installing a Siebel Server that will communicate with an existing configured installation of Siebel Gateway on another computer or operating system instance, then make sure that the Siebel Gateway is running.

  2. (AIX only) Do the following:

    • Verify that the login ID performing the installation has permission to run slibclean by asking the administrator to change the permission as follows:

      chmod 6555 /usr/sbin/slibclean
      
    • Execute the following command:

      /usr/sbin/slibclean
      
  3. Log on to the server, using the Siebel service owner account that you recorded in the copy that you made earlier of the worksheet in Siebel Deployment Planning Worksheet.

  4. Open a new shell, and navigate to the Siebel image location for Siebel CRM 17.0. Then navigate to the directory where the installer is located. For example, for Oracle Solaris, navigate to Siebel_Image/Solaris/Server/Siebel_Enterprise_Server/Disk1/install.

    In this path, Siebel_Image is the directory for your version-specific Siebel network image, such as /Siebel_Install_Image/17.0.0.0.

  5. Verify the permissions to the directory into which you will install Siebel CRM. You must have write and execute permission.

  6. To start the Siebel Enterprise Server installer, enter the following command:

    ./runInstaller -invPtrLoc inventory_location
    

    In this command, inventory_location is the full path of the oraInst.loc file (for example, /export/home/oraInst.loc), which points to the OUI inventory location. Use the -invPtrLoc option if you want to specify an inventory pointer file other than the default.

    Optionally, for an unattended installation, you can append the flags described in Installing Siebel CRM in Unattended Mode.

    The Select Installation Task screen appears. The New Installation task is selected by default.

  7. To perform a new installation of Siebel CRM where no existing installation of a prior release of Siebel CRM is present, click Next.

    The New Installation Details screen appears.

  8. Specify the installation location, and then click Next. (Note the installation location for future reference.)

    You might specify an installation path for a new installation like /Siebel, /Siebel_SES, /Siebel_AI, or a similar value. Accept the default path or specify a different fully qualified path by typing it directly or by clicking Browse. If you have an existing installation, then you must specify a new path for the new installation. For more information about installation path requirements, see File and Directory Naming Conventions.

    The Select Components screen appears.

  9. Select the Siebel Enterprise Server modules that you want to install. Choose one or more of the following options, as allowed or as appropriate for your deployment, and click Next:

    • Application Interface

    • Gateway

    • Siebel Server

    • EAI Connector (optional)

    • Database Configuration Utilities (install with the first Siebel Server)

    • Enterprise Cache (optional)

    • Constraint Engine (optional, available as a developer preview)

    For more information about installing these modules, see About Installation Tasks for Siebel CRM. See also Requirements for Installing and Configuring Siebel CRM.

    The specific screens that appear in the installer depend on the modules that you are installing.

    The Select Languages screen appears.

  10. Select the languages that you want to install, and click Next. You must select at least one language in order to proceed.

    All of the languages that were included in the Siebel network image for Siebel Enterprise Server are available for selection. To select a language, you click the name of the language in the Available box and then use the arrow controls to move it into the Selected box.

    You specify the languages to install in order to run Siebel applications using these languages. The files that are specific to the languages chosen in this step will be copied to your computer.

    If you install the software with a single language, then this language serves as the primary (base) language, in which your server messages and log files will display. If you install the software with multiple languages, then when you configure the Siebel Server or the Siebel Application Interface, you can specify which installed languages to deploy and which installed language is the primary language.

    For the Siebel Application Interface, you must install and deploy the superset of all of the languages required by the Application Object Manager components that connect to it.

    Note: You can add languages to an existing installation by running the installer in unattended mode (silent mode). For more information about installing and deploying languages, see Installing and Deploying Siebel CRM with Multiple Languages.

    The Application Container Port Configuration screen appears. This screen applies to all installable modules except EAI Connector and Database Configuration Utilities.

  11. Specify port numbers for this installation, and click Next. Specify the following:

    • HTTPS Redirect Port (default: 443, or example: 9011). Used for secure HTTPS connections to the application container, which can include connections redirected from the HTTP port.

    • HTTP Connection Port (default: 8080, or example: 9012). Incoming connections on the HTTP port are redirected to the secure HTTPS port.

    • Shutdown Port (default: 8005, or example: 9013). Used for management purposes by Siebel CRM, for local use only.

    Note: Specifying these port numbers allows the application containers and other parts of the configuration framework to work together during and after the configuration and deployment tasks you perform using Siebel Management Console. The port numbers must be unique on each installation computer or operating system instance. See also Configuring Siebel CRM Server Modules.

    If you are installing Siebel Application Interface, then the Application Interface Authentication screen appears.

  12. Specify the appropriate authentication credentials for access to Siebel Management Console, and click Next.

    • User Name. Specify the user name to use when you log in to Siebel Management Console, as described in Starting the Siebel Management Console.

    • Password. Specify the password for this user name.

    • Confirm Password

    Note: You use the credentials specified here when you first log in to Siebel Management Console, after installing the first Siebel Application Interface node. These credentials, which are stored in the applicationinterface.properties file, are valid only before you have configured the security profile. Once you have configured security, you must log in to Siebel Management Console again with valid credentials for the authentication method specified in the security profile. Then, when you install any subsequent instance of Siebel Application Interface, you would also specify those same valid credentials (that are used by the first Siebel Application Interface node) for the specified authentication method, for example, user name sadmin and password mypwd.

    The Client Authentication screen appears. This screen appears if you are installing Siebel Gateway, Siebel Server, Siebel Application Interface, Siebel Enterprise Cache, or Siebel Constraint Engine.

  13. Specify information that supports secure communications for the installed software. Specify the following:

    • Keystore Name. Specify a file (such as a JKS file) you have generated that will serve as the keystore.

    • Truststore Name. Specify a file (such as a JKS file) you have generated that will serve as the truststore.

    • Password. Specify the password for the specified keystore and truststore files.

    • Confirm Password

    Note: The keystore and truststore files are Java files containing certificates. These files are necessary for the application container to use secure two-way communications when connecting with other Siebel CRM modules, as occurs during Siebel Management Console configuration and in normal operation. These files must contain the server certificate chain and an imported CA certificate. Generate your files so that the keystore file references both the private key and the public key, while the truststore file references the public key only. Specify the password that was previously configured to open the certificate files. Use the same password for the keystore and truststore files. Use fully qualified domain names rather than IP addresses. If you do not configure these files correctly, then you will not be able to configure Siebel CRM, as described in Configuring Siebel CRM Server Modules. See also Siebel Security Guide.

    If you are installing Siebel Gateway, then the Gateway Port Configuration screen appears.

  14. Specify the TLS port number for the Siebel Gateway (default: 2320, or example: 9014).

    This port number is used for internal purposes, to provide access to the Siebel Gateway. You also include this port number when you specify the Siebel Gateway in the command to run srvrmgr.

    If you are installing Siebel Constraint Engine, then the Constraint Engine Port Configuration screen appears.

  15. Specify the TLS port number for the Siebel Constraint Engine (example: 9115).

    This port number is used for internal purposes, to provide access to the Siebel Constraint Engine.

    The Summary screen appears.

  16. In the Summary screen, review the information presented.

    This screen displays the location where Siebel CRM will be installed. Before you proceed, confirm that you have met all of the installation requirements, such as for disk space. Then do one of the following:

    • To begin installing Siebel CRM, click Install. You can also click Install after saving a response file.

    • To save a response file to use for an unattended installation later, click Save Response File, and then save the file from the dialog box that appears. If you are not also installing at this time, then click Cancel after you save the response file. For information about performing unattended installations, see Installing Siebel CRM in Unattended Mode.

    The Installation Progress screen appears. Siebel CRM is installed into the directory that you specified in Step 12.

    Note: For future reference, note that the Oracle Home Name is defined based on the installation directory. For example, for an installation directory of /Siebel, the Oracle Home Name is Siebel_Home_Siebel.
  17. When the Next button becomes available, the installation is complete. Click Next.

    The Finish Installation screen appears. This screen indicates whether the installation was successful and shows the location of the installer log file. You can access this file to review the installation results.

  18. To close the installer, click Close.

    This new installation of Siebel CRM is now finished. If you installed Database Configuration Utilities, then the shortcut for the Database Configuration Wizard is created in the program folder, which is created using a generated name.

  19. After installing Siebel CRM:

  20. Repeat this procedure, modifying selections as appropriate, on each computer or operating system instance where you are installing Siebel CRM server modules.

Installing Siebel CRM in a Migration Installation

Use the following procedure to install Siebel CRM server modules in a migration installation.

Note: Use this procedure only when server modules for a prior release of Siebel CRM are already installed. Otherwise, you must follow the steps in Installing Siebel CRM in a New Installation instead.

During a migration installation, the original Siebel CRM installation directory is renamed from OriginalName to OriginalName_pre17.0. For example, if the original installation directory name was ses or sweapp, then this directory is renamed to ses_pre17.0 or sweapp_pre17.0. The new installation directory is named OriginalName, such as ses or sweapp. Retain the original installation directory, in case you choose to perform a rollback uninstallation later. For more information, see Rolling Back the Siebel CRM Server Modules.

For more information about migration installations, see About Installation Tasks for Siebel CRM.

Note: If you need to add any modules that were not present in your original installation, including, for example, new modules or additional instances of Siebel Server or Siebel Application Interface, then you must install them as a new installation, as described in Installing Siebel CRM in a New Installation.

This topic is part of Installing Siebel CRM.

This task is a step in Roadmap for Installing Siebel CRM in a Migration Installation Case (Existing Installation of Siebel CRM 16.x or Earlier).

Caution: You must perform the migration installation for Siebel Application Interface before you perform the migration installations for any other Siebel CRM server modules. When you do the migration installations for other Siebel Enterprise Server modules, the installer prompts you to provide the host name and installation location for the migrated installation of Siebel Application Interface. Without this information, the migration installations of Siebel Gateway, Siebel Server, or other modules cannot complete successfully.

To install Siebel CRM in a migration installation

  1. Review Before You Install Siebel CRM and About Installation Tasks for Siebel CRM and observe the requirements and recommendations.

  2. Perform any premigration tasks that might be necessary, as noted in Additional Tasks for Migration Installations.

    Caution: For example, you must remove the existing configuration for the SWSE before you install Siebel Application Interface as a migration installation. If you are using data encryption, then you must back up the original key file.

    If you are installing a Siebel Server that will communicate with an existing configured installation of Siebel Gateway on another computer or operating system instance, then make sure that the Siebel Gateway is running.

  3. (Optional) Shut down the Siebel CRM modules to be updated on this computer.

  4. For example, stop any services (for the existing installed instance of a prior version) for the Siebel Gateway Name Server, Siebel Server, Siebel Management Agent, or Oracle Configuration Manager. Also shut down any running instances of the Siebel Server Manager (srvrmgr). If you do not shut down these services, then the installer shuts them down.
    Note: Siebel Management Agent and Oracle Configuration Manager are not installed or supported in the current Siebel CRM release.
  5. For a migration installation of Siebel Application Interface, stop the Web server for the existing installation of SWSE by running one of the following commands:

    • ompmnctl stopall – for Oracle HTTP Server (on supported Linux operating systems)

    • stopapa – for other Apache-based Web servers (on supported operating systems)

    • stop – for Oracle iPlanet Web Server (on Oracle Solaris)

  6. (AIX only) Do the following:

    • Verify that the login ID performing the installation has permission to run slibclean by asking the administrator to change the permission as follows:

      chmod 6555 /usr/sbin/slibclean
      
    • Execute the following command:

      /usr/sbin/slibclean
      
  7. Log on to the server, using the Siebel service owner account that you recorded in the copy that you made earlier of the worksheet in Siebel Deployment Planning Worksheet.

  8. Open a new shell, and navigate to the Siebel image location for Siebel CRM 17.0. Then navigate to the directory where the installer is located. For example, for Oracle Solaris, navigate to Siebel_Image/Solaris/Server/Siebel_Enterprise_Server/Disk1/install.

    In this path, Siebel_Image is the directory for your version-specific Siebel network image, such as /Siebel_Install_Image/17.0.0.0.

  9. Verify the permissions to the directory into which you will install the Siebel CRM software. You must have write and execute permission.

    Note: You must perform the migration installation of Siebel Application Interface before you migrate other modules, such as Siebel Gateway or Siebel Server.
  10. To start the Siebel Enterprise Server installer (to install any of the modules listed at the start of Installing Siebel CRM), enter the following command:

    ./runInstaller -invPtrLoc inventory_location
    

    In this command, inventory_location is the full path of the oraInst.loc file (for example, /export/home/oraInst.loc), which points to the OUI inventory location. Use the -invPtrLoc option if you want to specify an inventory pointer file other than the default.

    Optionally, for an unattended installation, you can append the flags described in Installing Siebel CRM in Unattended Mode.

    The Select Installation Task screen appears.

  11. To perform a migration installation of Siebel CRM where an existing prior installation is present, choose Migration Installation, and click Next.

    The Installation Migration Details screen appears.

  12. Confirm or select the name and location of your existing installation, and then click Next. Do the following:

    • Confirm the existing installation name, or select it from the drop-down list.

    • Confirm the existing installation location, or select it from the drop-down list. For more information about installation path requirements, see File and Directory Naming Conventions.

  13. The Application Container Port Configuration screen appears. This screen applies to all installable modules except EAI Connector and Database Configuration Utilities.

  14. Specify port numbers, and click Next. Specify the following:

    • HTTPS Redirect Port (default: 443, or example: 9011). Used for secure HTTPS connections to the application container, which can include connections redirected from the HTTP port.

    • HTTP Connection Port (default: 8080, or example: 9012). Incoming connections on the HTTP port are redirected to the secure HTTPS port.

    • Shutdown Port (default: 8005, or example: 9013). Used for management purposes by Siebel CRM, for local use only.

    Note: Specifying these port numbers allows the application containers and other parts of the configuration framework to work together during and after the configuration and deployment tasks you perform using Siebel Management Console. The port numbers must be unique on each installation computer or operating system instance. See also Configuring Siebel CRM Server Modules.

    The Client Authentication screen appears. This screen appears if you are installing Siebel Gateway, Siebel Server, or Siebel Application Interface.

  15. Specify information that supports secure communications for the installed software. Specify the following:

    • Keystore Name. Specify a file (such as a JKS file) you have generated that will serve as the keystore

    • Truststore Name. Specify a file (such as a JKS file) you have generated that will serve as the truststore.

    • Password. Specify the password for the specified keystore and truststore files.

    • Confirm Password

    Note: The keystore and truststore files are Java files containing certificates. These files are necessary for the application container to use secure two-way communications when connecting with other Siebel CRM modules, as occurs during Siebel Management Console configuration and in normal operation. These files must contain the server certificate chain and an imported CA certificate. Generate your files so that the keystore file references both the private key and the public key, while the truststore file references the public key only. Specify the password that was previously configured to open the certificate files. Use the same password for the keystore and truststore files. If you do not configure these files correctly, then you will not be able to configure Siebel CRM, as described in Configuring Siebel CRM Server Modules. See also Siebel Security Guide.

    If you are migrating an installation of Siebel Gateway, then the Gateway Port Configuration screen appears.

  16. Specify the TLS port number for the existing installation of Siebel Gateway Name Server (default: 2320, or example: 9014).

    Caution: The TLS port number for a migration installation must be the port number on which the Siebel Gateway Name Server was configured in the prior installation. Failing to enter the right port will result in failure of the migration installation.

    The Summary screen appears.

  17. In the Summary screen, review the information presented.

    This screen displays the location where the Siebel CRM software will be installed. Before you proceed, confirm that you have met all of the installation requirements, such as for disk space. Then do one of the following:

    • To begin installing Siebel CRM, click Install. You can also click Install after saving a response file.

    • To save a response file to use for an unattended installation later, click Save Response File, and then save the file from the dialog box that appears. If you are not also installing at this time, then click Cancel after you save the response file. For information about performing unattended installations, see Installing Siebel CRM in Unattended Mode.

    The Installation Progress screen appears. Siebel CRM is installed into the directory that you specified in a prior step.

  18. When the Next button becomes available, this installation is complete. Click Next.

    The Finish Installation screen appears. This screen indicates whether the installation was successful and shows the location of the installer log file. You can access this file to review the installation results. This screen also shows the new location of the original installation, which the installer moved before it performed the new installation.

  19. Review the report that is generated about any conflicts between your customized files and the files that are delivered by the Siebel Enterprise Server installer. As needed, copy any applicable customized files from the original installation to the new migrated installation.

    Conflicts are identified in the file overwrittenfiles_timestamp.log, which is created in the ORACLE_HOME/cfgtoollogs/oui directory (in the new migrated installation).

  20. To close the installer, click Close.

    This migration installation of Siebel CRM is now finished.

    After the migration process is complete, the installer starts applicable services, such as for the Siebel Gateway and Siebel Server. Note that the software that runs is part of the new installation you are migrating to, not part of the original installation.

  21. After installing Siebel CRM:

  22. Repeat this procedure, modifying selections as appropriate, on each computer or operating system instance with a Siebel CRM installation to be migrated.

Installing and Uninstalling Siebel CRM 20.x Update

Note: After you have installed Siebel CRM 17.0 for a new, migration, or upgrade installation, as described in Installing Siebel CRM, you then install Siebel CRM 20.9 Update. For more information, see Installation-Related Changes for Siebel CRM 20.x Update.

This topic describes how to install Siebel CRM 20.9 Update on top of an existing and valid installation of a prior release of Siebel CRM 17.x or later. Siebel CRM 20.9 Update can only be installed in the manner described, which is similar to installation for a prior Siebel CRM 20.x, 19.x, or 18.x Update release or a Siebel CRM 17.x patchset release.

This topic applies to Siebel Mobile Web Client and Siebel Tools as well as to Siebel Enterprise Server installations.

This task is a step in:

This topic contains the following information:

The general installation steps for Siebel CRM 20.9 Update are as follows:

  1. Review all of the information relevant to your installation.

  2. Review and confirm the installation summary information displayed in the Siebel installation wizard. Click Save Response File if you want to record the installation steps to a response file to use for unattended installation.

    To do an unattended installation:

    1. Cancel the wizard after saving the response file.

    2. Run the installer again with a command that includes a pointer to the response file.

    When the installer runs, it uses the input data stored in the response file and gives no prompts.

  3. Monitor the progress of the installation using the Installation Details and Progress menu bar. The Installation Details window displays information about the modules that are being installed.

  4. After the installation is complete, click Close to exit the Siebel installation wizard.

    Note: As of Siebel CRM 20.3 Update, the installer also runs the PostInstallDBSetup utility. Other optional repository updates are also available. Some other postinstallation tasks for the Siebel database might also apply. For more information, see About Database Updates for Siebel CRM 20.x Update.

Preinstallation Tasks

Note the following information before you begin installing Siebel CRM 20.9 Update:

  • After downloading Siebel CRM 20.9 Update, run the Siebel Image Creator utility to create a network image for the release. Run the installers from this image. For more information, see Creating the Siebel Installation Image on the Network.

  • For Siebel Mobile Web Client installations, download the ZIP file for Oracle Database SE2. For more information, see Installing and Using Oracle Database SE2 for the Local Database.
  • Siebel Gateway and Siebel Server services are automatically stopped when you install or uninstall Siebel CRM 20.9 Update.

  • Auto-Start Services are now available for the Siebel Gateway Server and Siebel Server. To enable this functionality, set the AUTOSTART_SERVICES parameter to Yes or No in:

    • Disk1/install/oneclick.properties (to auto-start services after installing Siebel CRM 20.9 Update)

    • <PROD_HOME>/oui/bin/patchrollback.properties (to auto-start services after a rollback)

    Note: The AUTOSTART_SERVICES parameter setting also applies to uninstallation (rollback), where you want to auto-start services after a rollback to an earlier version.
  • Review the database-related tasks that might apply after you install Siebel CRM 20.9 Update. For more information, see Installing the Siebel Database on the RDBMS. See also Siebel Database Upgrade Guide.

Installing Siebel CRM 20.x Update

Use the following procedure to install Siebel CRM 20.9 Update for your installed Siebel CRM software. To install the release:

  1. Review all of the information in Preinstallation Tasks. For Siebel Web Client installations, see also Installing and Using Oracle Database SE2 for the Local Database.

  2. Depending upon your operating system, do one of the following:

    • Windows: For Siebel Enterprise Server and Siebel Application Interface instances, run setup.bat under Windows\Server\Siebel_Enterprise_Server\Disk1\install.

    • Windows: For Siebel Tools and the Siebel Web Client, run setup.bat under Windows\Client\Siebel_product\Disk1\install, where Siebel_product is Siebel_Tools or Siebel_Web_Client.

    • UNIX: Run the following command under UNIX_OS/Server/Siebel_Enterprise_Server/Disk1/install:

      ./runInstaller.sh -invPtrLoc ~/oraInst.loc
      
  3. As of Siebel CRM 20.8 Update, for Siebel Web Client installations, you are prompted for additional information for installing Oracle Database SE2.

    • For Mobile Web Client:

    • For Developer Web Client, choose this option and then click Next. Proceed to complete the installation. Siebel Developer Web Client is installed.

      Note: Oracle Database SE2 does not apply for Siebel Developer Web Client. It is not supported to attempt to install Oracle Database SE2 for this Siebel client type.

Verifying Installation

Use the following procedure to verify that Siebel CRM 20.9 Update installed successfully. For Microsoft Windows, use cmd.

To verify the installation

  1. Navigate to the directory represented by the ORACLE_HOME variable.

    For example, your top-level Siebel CRM installation directory on UNIX might be /siebel.

  2. Run the following command:

    • Windows: set ORACLE_HOME=Oracle_Home

    • UNIX: setenv ORACLE_HOME Oracle_Home

  3. Navigate to the opatch location, and run the opatch lsinventory command to check the version number.

    Note: The opatch command does not work on Linux platforms and the Siebel version number is updated in the Oracle_Home/Siebel_version.properties file after you install the release.
  4. If necessary, start the Siebel services and application containers. For more information, see Stopping and Starting the Siebel Application Container.

  5. Start the Siebel application in the browser to make sure that the application starts successfully.

  6. From the application-level menu, select the Help drop-down menu and open up the Technical Support dialog to check the version number.

Uninstalling Siebel CRM 20.x Update

The following procedure shows you how to uninstall Siebel CRM 20.9 Update.

For more information about uninstalling Siebel CRM software, see Uninstalling Siebel CRM.

To uninstall Siebel CRM 20.x Update

  • Depending upon your operating system, do one of the following:

    • Windows: Run patchrollback.bat under Oracle_Home\oui\bin for Siebel Enterprise Server or Siebel Application Interface, Siebel Tools, or Siebel Web Client.

    • UNIX: Run the following command under Oracle_Home/oui/bin for Siebel Enterprise Server modules or Siebel Application Interface:

      ./patchrollback.sh -invPtrLoc ~/oraInst.loc
      

Installing Siebel CRM in Unattended Mode

The installer for Siebel CRM server modules (Siebel Enterprise Server) supports an optional unattended installation, which is an installation that has been preconfigured to require no user input when the installation program runs. You can save a response file in a regular installer session. Then you can run the installer at the command line with certain flags appended to the installer command to execute the response file. Together, these tasks constitute installing in unattended mode.

You can perform unattended installations for better performance when installing software on multiple server computers. Or, you might perform unattended installations if user input during an installation is not allowed in your environment, as might be the case in some secure environments. An unattended installation prepackages all of the required parameters so that you only have to execute a command to perform the installation.

You can use unattended mode to perform a new installation or migration installation, or to add languages to an existing installation. To add languages, you must use this method.

Caution: Unattended installations provide no direct feedback or error notification. Therefore, you must test your settings in a development environment before system-wide deployment in a production environment. It is strongly recommended that you become thoroughly familiar with GUI installation and configuration for any Siebel CRM modules for which you intend to perform unattended installation or configuration.

This topic contains the following information:

Related Topics

About Installation Tasks for Siebel CRM

Installing Siebel CRM

About Configuring Siebel CRM

Installing and Deploying Additional Languages

Verifying Installation for Siebel CRM

Requirements for Installing and Configuring Siebel CRM

Guidelines for Installing Servers in Unattended Mode

Review the following guidelines for installing Siebel Enterprise Server or Siebel Application Interface in unattended mode:

  • Keep track of the response file results. Because the unattended installation session is controlled by the response file, you must keep careful track of the result each response file will yield when you perform an unattended installation.

    For example, depending on your selections when you generated a response file for Siebel Enterprise Server, the unattended installation performed with this file might install one or more of the following Siebel CRM server modules (subject to restrictions on installing modules together): Siebel Gateway, Siebel Server, Siebel Database Configuration Utilities, Siebel Enterprise Cache, EAI Connector, or Siebel Application Interface.

  • Create the response file on a computer similar to the target computer. When you run the installer as described in Saving an Installation Response File, installer validations are done as if you were performing a real installation. It is strongly recommended that you run the installer on a computer that has similar resources and configuration settings as the target computer on which the installation will be performed, as described in Performing an Installation in Unattended Mode. Unattended installations must meet all of the documented requirements, including those described in About Installation Tasks for Siebel CRM and in Requirements for Installing and Configuring Siebel CRM.

  • Validate the installation. Validate each installation after it has completed, as described in Verifying Installation for Siebel CRM.

To install Siebel CRM server modules and the specified Siebel language packs using unattended mode, perform the following tasks:

Saving an Installation Response File

Perform the following steps to save an installation response file to be used in an unattended installation of Siebel CRM server modules.

Note: If you are adding languages to an existing installation, then do not use this procedure. Instead, follow the procedure in Editing an Oracle-Provided Installation Response File.

To save an installation response file

  1. Navigate to the Siebel image location where the installer is located.

  2. Start the Siebel Enterprise Server installer.

    For information about starting this installer, see About Installation Tasks for Siebel CRM and Installing Siebel CRM.

  3. Provide input to the installer wizard, as in a normal GUI installation.

  4. In the Summary screen, click Save Response File.

  5. Specify the location of the response file, for example, /usr/tmp/sesinstall.rsp, and save the file.

    A response file is generated that includes data that is derived from the input that you made during the installer session.

  6. After the response file is saved, click Cancel.

    The installer session ends.

    In addition to saving the response file at the location that you specified at the command line, the installer creates the Siebel installation directory at the location that you specified in the installer session (for example, /usr/tmp/sesinstall.rsp). Although the Siebel CRM module is not installed (because you clicked Cancel), this directory contains a subdirectory called inventory, which includes information about the product inventory.

    For information about performing a Siebel Enterprise Server or Siebel Application Interface installation in unattended mode, using the response file that you just generated, see Performing an Installation in Unattended Mode.

Editing an Oracle-Provided Installation Response File

If you are adding languages to an existing Siebel CRM installation, then you must edit an Oracle-provided installation response file instead of saving a response file from the installer. For detailed information about the task of adding languages, see Installing and Deploying Additional Languages.

Performing an Installation in Unattended Mode

Perform the following steps to perform an unattended installation of Siebel CRM server modules.

First, you must save an installation response file as described in Saving an Installation Response File or prepare an installation response file for adding languages as described in Editing an Oracle-Provided Installation Response File. Then you run the installer command as shown in the following procedure. For detailed information about the task of adding languages, see Installing and Deploying Additional Languages.

To perform an installation in unattended mode

  1. (For add language operations only) Uninstall Siebel CRM 20.9 Update if you have installed it on top of Siebel CRM 17.x or later, for each installed Siebel CRM module for which you are adding languages.

  2. Navigate to the Siebel image location where the installer is located.

  3. Place the response file that you previously generated or edited into the correct Siebel image directory for the Siebel CRM module (where the installer program is located), so that the file can be read when you run the installer.

    Note: Always back up any existing valid response file before replacing it with a new file.
  4. Open a new shell.

  5. Run a command like the following to start the installer to install Siebel Enterprise Server or Siebel Application Interface:

    ./runInstaller ./runInstaller -silent -responseFile path_to_installation_response_file -invPtrLoc inventory_location
    

    where:

    • path_to_installation_response_file is the full path and name of a response file to be executed (for example, /usr/tmp/sesinstall.rsp).

    • inventory_location is the full path of the oraInst.loc file (for example, /export/home/oraInst.loc), which points to the OUI inventory location. Use the -invPtrLoc option if you want to specify an inventory pointer file other than the default.

    This command runs the installer in unattended mode and specifies the location of the response file to be executed. No installer screens are displayed, and no further user input is prompted for after the installer starts. The installation result depends on the content of the specified response file.

  6. Validate the installation after it has completed.

    For more information, see Verifying Installation for Siebel CRM.

  7. (For add language operations only) Reinstall Siebel CRM 20.9 Update, if you uninstalled it in Step 1. Then validate the installation again.

Additional Tasks for Migration Installations

Certain product changes that were made in Siebel CRM 17.0 (or in prior releases) can affect migration installations for existing customers. All customers performing migration installations must review the information in this topic before installing, to make sure that they can successfully migrate all custom files and settings to the current release and to avoid any of the issues described here. Some migration tasks previously documented for Siebel CRM 16.0 might not need to be done again for customers migrating from that release.

These product changes affect some of the files and directories of installations of Siebel Server, Siebel Application Interface, Siebel Web Client, and Siebel Tools. Also affected are some of the configuration settings for these modules. Many of the product changes described in this topic were made as part of consolidating support for Siebel Open UI and desupporting high interactivity and standard interactivity.

This topic describes specific product changes, describes how these changes might affect migration installations, and provides steps you can take to avoid any issues and complete the migration successfully. Some of the tasks you perform before installation, but most of them you would perform after installation. Additional migration considerations are also provided.

This topic contains the following information:

Related Topics

About Installation Tasks for Siebel CRM

About Configuring Siebel CRM

About Installing the Siebel Web Client or Siebel Tools

Installing and Using Oracle Database SE2 for the Local Database

Uninstalling Siebel CRM

Process of Removing Configuration Data

Migration Issues and Solutions for Siebel CRM 17.0 and Later

Many product and support changes for Siebel CRM 17.0 (and other recent releases) make it necessary for you to perform certain migration-related tasks. Issues and possible solutions are provided for some items. Review all items before proceeding. This list is not comprehensive. Many of the tasks are interrelated and are not necessarily presented in the order in which you would perform them. Various dependencies apply that might not be fully explained. Some of these issues apply only to migrations from releases prior to Siebel CRM 16.0.

This topic is part of Additional Tasks for Migration Installations.

  • Synchronize local databases before migrating or doing other premigration tasks. Siebel Mobile Web Client users might need to synchronize their local database changes with the server, through Siebel Remote, as described in Siebel Remote and Replication Manager Administration Guide. Or, Siebel Tools developer users might need to check in any changes made to objects in the existing local database, as described in Using Siebel Tools for earlier releases of Siebel Tools.

  • Remove the Siebel Web Server Extension (SWSE) configuration before migrating, and then configure Siebel Application Interface after migrating. In Siebel CRM 16.0, the virtual directories, which formerly mapped to public/lang_code (such as ENU), were mapped directly to public. In Siebel CRM 17.0 and later, virtual directories are replaced by application configurations, which now map to applicationcontainer/webapps/siebel in the Siebel Application Interface installation. When you install the Siebel Application Interface as a migration installation, the existing virtual directories on the Web server that were configured for SWSE in a prior release are not migrated. After all of the migration installations are complete, you must configure the Siebel Application Interface to create the application configurations. For more information, see About Installation Tasks for Siebel CRM and About Configuring Siebel CRM.

    Caution: You must remove the configuration for the SWSE before you install Siebel CRM 17.0 as a migration installation, as described in Process of Removing Configuration Data.
  • When data encryption is enabled, you must back up the original key file (keyfile.bin) before performing a migration installation for Siebel Enterprise Server, and then copy it back after migrating. For more information, see General Requirements for Installing and Configuring Siebel Enterprise Server Modules.

    Caution: If data migration is enabled, then the migration installation overwrites your existing key file. If you have not backed up your existing key file and copied it back after the migration, then the encrypted columns will be inaccessible after the migration.
  • Preserve premigration installation. You might want to preserve your premigration installations, in case you need to roll back to your prior version after doing the migration installations and making the manual migration changes described here. It is recommended that you manage your migration tasks to make sure that you have not permanently deleted, moved, or renamed files or directories in these installations. Also keep track of changed requirements, so that you can restore the overall environment if you roll back. Additional requirements apply for rollbacks. For more information, see Uninstalling Siebel CRM.

  • Move files and directories or delete unnecessary files. Depending on the release you are migrating from and on your requirements, you might need to copy some files or directories from your existing installation into your new migrated installation, or you might need to delete some unnecessary files and directories from your new migrated installation. For example:

    • The webtempl directory on Siebel Server. As of Siebel CRM 17.0, the SIEBSRVR_ROOT/webtempl directory is not part of the Siebel Server installation and is not migrated. The Siebel Web templates are now located in the Siebel database. Custom Siebel Web templates for Siebel Open UI migrate into the database when you run Incremental Repository Merge, as described in Siebel Database Upgrade Guide.

      In order for this migration to succeed, you must copy all of the applicable custom Siebel Web template files into a directory. Then, when you run Incremental Repository Merge and the Database Configuration Wizard prompts for the Web Templates Directory, specify this new directory location.

      • If you are migrating from Siebel CRM 16.x, then the applicable Siebel Web template files to copy are those located in the SIEBSRVR_ROOT/webtempl/custom subdirectory in your prior installation.

      • If you are migrating from a release prior to Siebel CRM 16.0, then the applicable Siebel Web template files to copy are those located in the SIEBSRVR_ROOT/webtempl/ouiwebtempl/custom subdirectory in your prior installation.

        For Siebel Web Client and Siebel Tools installations, the webtempl directory has also been removed and Siebel Web templates are now provided in the Siebel database. A newly extracted local database for Siebel Mobile Web Client also includes your custom Siebel Web templates.

    • The webmaster directory on Siebel Server. As of Siebel CRM 16.0, the SIEBSRVR_ROOT/webmaster directory on the Siebel Server has been removed. If you are migrating from a release prior to Siebel CRM 16.0, then you can delete this directory from your migrated Siebel Server installation.

    • The public directory on Siebel Web Server Extension. As of Siebel CRM 17.0, the SWSE_ROOT/public directory is not part of the Siebel Application Interface installation. The equivalent location is SIEBEL_AI_ROOT/applicationcontainer/webapps/siebel. Files and directories are not automatically migrated for Siebel Application Interface. If you require any of the files from the public directory in your prior installation of SWSE, then you can copy them manually after completing installation and configuration tasks.

      Before you copy files, you must take into account the following changes that occurred in the structure of the public directory in Siebel CRM 16.0:

      • public/lang_code/build_number, where lang_code is an installed Siebel language (such as ENU) and build_number is one of the build numbers for the installed Siebel software. The applet subdirectory has been removed. The scripts subdirectory has moved under public. And the build_number directory has been removed.

      • public/lang_code/files. This directory has moved under public.

      • public/lang_code/fonts. This directory has moved under public.

      • public/lang_code/htmltemplates. This directory has moved under public.

      • public/lang_code/images. This directory has moved under public.

      • public/lang_code/webeditor. This directory has been removed.

      • public/lang_code/default.htm. This file has moved under public.

      • public/lang_code/blank.htm. This file has moved under public.

      • public/lang_code/wait.htm. This file has been removed.

      • public/lang_code/*.pcd. These files have been removed.

      • public/lang_code/*.manifest. The variable string %BuildNumber% has been removed from the .tmanifest files, from which the .manifest files are generated.

      Note: As of Siebel CRM 17.0, the Siebel application virtual directories, which formerly mapped to the public/lang_code directory on SWSE, are obsolete. Instead, the application configurations for Siebel Application Interface map to SIEBEL_AI_ROOT/applicationcontainer/webapps/siebel (without the lang_code element).
  • Move files and directories: Files and directories on Siebel Web Client and Siebel Tools have changed relative to equivalent locations for releases prior to Siebel CRM 16.0. Similar changes apply for migration installations of Siebel Web Client and Siebel Tools, as described above for migration installations of Siebel Application Interface. However, the files are copied into the new migration installations of Siebel Tools. Note also that Siebel Web Client still uses the public directory, as in Siebel CRM 16.0.

    Issue (for migrations from release prior to Siebel CRM 16.0). After a migration installation of Siebel Web Client or Siebel Tools (from a release prior to Siebel CRM 16.0), duplicate directories will exist, because some of the directories will be in new locations relative to those seen for the files and directories that migrated from the prior release. Your custom files will be in the wrong locations and cannot be used until you have moved them to the new locations.

    Solution. Reorganize the files and directories in SIEBEL_CLIENT_ROOT\public and SIEBEL_TOOLS_ROOT\public on the migrated installations to incorporate the migrated custom files that you require and to conform to the changes described earlier in this topic for Siebel Application Interface. Finally, remove all extraneous files and directories in SIEBEL_CLIENT_ROOT\public and SIEBEL_TOOLS_ROOT\public.

  • Upgrade the database client. In a migration installation case, after migrating, you must make sure that a supported version of the database client software is installed for use with Siebel CRM 20.x Update, as noted in the Certifications tab on My Oracle Support. You might also need to update the database client installation path in the defined environment variables. For more information, see About Configuring Siebel CRM.

    Using Oracle Database SE2 for Siebel Mobile Web Client requires a supported version of the Oracle Database Client, as noted in Installing and Using Oracle Database SE2 for the Local Database.

  • Edit configuration files for Siebel Web Client. After doing a migration installation for Siebel Web Client from Siebel CRM 16.0 or from a release prior to Siebel CRM 16.0, you might need to edit all applicable migrated configuration files, such as uagent.cfg for Siebel Call Center. For example:

    For a migration from a release prior to Siebel CRM 16.0, in the [Siebel] section of each applicable configuration file, the existing WebClientSiteDir parameter value will include a language element, which is no longer needed. For example, for a value like C:\Siebel\Client\public\enu, update the parameter value to C:\Siebel\Client\public.

  • Remove obsolete parameters. Several parameters for server components or in configuration files are now obsolete, as of Siebel CRM 17.0. To reduce confusion after migration installations, you might choose to delete some of the parameters that no longer apply, such as HighInteractivity and EnableOpenUI (which are obsolete as of Siebel CRM 16.0). For more information about obsolete parameters, see Siebel System Administration Guide.

  • Reset passwords on the Siebel Gateway and on the Siebel Server. After doing a migration installation from a release prior to Siebel CRM 16.0, you must reset any passwords on the Siebel Gateway that were previously encrypted using encryption other than AES. Such passwords are now encrypted using AES. For more information about reencrypting these passwords, see Siebel Security Guide. Furthermore, the Siebel Server system service and server components do not work after a migration installation until you have updated them to use AES password encryption. Make these changes in coordination, as described in Updating the Siebel Server System Service and Server Components to Use AES Password Encryption.

Updating the Siebel Server System Service and Server Components to Use AES Password Encryption

The Siebel Server system service and server components do not work after a migration installation until you have performed steps to update them to use AES password encryption, as described in the following procedure. Most of the command examples in the procedure are for UNIX operating systems, but the same issue applies on Microsoft Windows.

This topic is part of Additional Tasks for Migration Installations.

To update the Siebel Server system service and server components to use AES password encryption

  1. Unset any SIEBEL* environment variables.

  2. Source the siebenv script from the Siebel Gateway installation directory, as follows:

    ./siebenv.sh 
    
  3. Start the Siebel Gateway and make sure that it is running.

  4. Write down the old encrypted password from the current siebns.dat file. For example:

    [/enterprises/esia81/parameters/Password]
    Persistence=full
    Type=string
    Value="9ntkUOUf"
    Length=16
    
  5. Run a command like the following, using the old encrypted password value:

    $SIEBEL_ROOT/siebsrvr/lib/spu 9ntkUOUf 
    

    This command obtains a reencrypted value for the password, such as in the following output:

    ENPVR6S/HKgBncoAAA== 
    
  6. Delete the current svc* and osdf* files from the SIEBSRVR_ROOT/sys directory.

  7. Source the siebenv script from the SIEBSRVR_ROOT directory.

  8. Change directory to the SIEBSRVR_ROOT/bin directory and then run a command like the following:

    siebctl -S siebsrvr -i esia81:srvr1 -a -g "-g localhost:2320 -e esia81 -s srvr1 
    -u SADMIN -ep ENPVR6S/HKgBncoAAA==" 
    

    Note that the new encrypted string from Step 5 is used.

  9. Run the following command using the old encrypted password value, like the following:

    $SIEBEL_ROOT/siebsrvr/lib/gpu -g localhost:2320 -e esia81 -u SADMIN -p 9ntkUOUf 
    
  10. Customers who have overridden the user name or password at the component definition level must change the passwords again through srvrmgr in order to use the new encrypted password value. For example:

    change param password=<pwd_value> for compdef <comp_name>
    change param password=<pwd_value> for comp <comp_name> server <server_name>
    
  11. Update old encrypted passwords on the Siebel Gateway to use AES encryption.

    For more information, see Siebel Security Guide.

  12. Restart both the Siebel Gateway and the Siebel Server.