7Installing Siebel Web Clients and Siebel Tools
Installing Siebel Web Clients and Siebel Tools
This chapter describes the tasks that you must perform to install Siebel Web Clients and Siebel Tools, and optionally the local database or sample database, and to start Siebel applications. Both new installations and migration installations are described. Additional tasks for the client computer are also described. This chapter includes the following topics:
Installing and Using Oracle Database XE for the Local or Sample Database
Installing Siebel Web Clients and Siebel Tools in Unattended Mode
About Workspaces in Siebel Tools and the Siebel Runtime Repository
Installing Desktop Integration Siebel Agent on Client Computers
Installing Outlook to Siebel Drag and Drop on Client Computers
Siebel Client Deployment Requirements When Using Firewalls or Proxy Servers
About Installing the Siebel Web Client or Siebel Tools
This chapter describes how to install Siebel Web Clients (for Siebel Mobile Web Clients) and Siebel Tools, and optionally the local database or sample database, with specified Siebel language packs. Before installing, review all documented requirements.
The software that is installed on the user’s computer for Siebel Mobile Web Client and Developer Web Client is identical. A single installer provides the software necessary to install and run either of these client types. For general information about these client types, see Siebel Deployment Planning Guide. Information in this guide about installing the Siebel Web Client refers to either or both of these two client types. (Siebel Developer Web Client installation is covered with the Siebel Mobile Web Client.) See also Deploying Siebel Open UI.
Note the following about Siebel Web Client and Siebel Tools:
Each Siebel Web Client is designed to be used within a single Siebel Enterprise by a single local user.
Each Siebel Tools client is designed to be used within a single Siebel Enterprise by a single local developer user.
It is recommended to install the Siebel Developer Web Client with Siebel Tools. The Siebel Developer Web Client has specific requirements for connectivity to the enterprise database. For information about the relational database management systems (RDBMS) that you might need to install on client computers running Siebel Developer Web Clients, see the Certifications tab on My Oracle Support. RDBMS products are not provided by Oracle; you must obtain them based on your database-connection requirements.
Oracle Database XE is always installed for Siebel Mobile Web Client and Siebel Tools, for a new or migration installation. You can optionally install the sample database for Siebel Mobile Web Client, or optionally install the local database for Siebel Tools. However, do not install the local database or the sample database if you plan to initialize a local database through Siebel Remote. For more information, see Installing and Using Oracle Database XE for the Local or Sample Database.
You perform migration installations using the same Siebel Web Client and Siebel Tools installers (for Siebel CRM 17.0) that you use for new installations. A migration installation applies settings from your existing installation to a new installation. The existing Oracle home name, installation location, installation languages, configuration data, and other settings are used for the new installation. Before the new installation is performed, the existing installation is moved to a backup location and can no longer be used.
The language that the installer displays is the one that corresponds to the current regional settings on the installation client computer.
This chapter also includes information about installing additional modules on client computers, for use with any Siebel Web Client.
Siebel Web Client and Siebel Tools Installer Flow
In general, the installer for Siebel Web Client or Siebel Tools does the following:
Checks the client computer to verify whether required components have already been installed.
Creates all of the required ODBC data sources.
Installs the Siebel CRM software and specified Siebel language packs.
(Siebel Mobile Web Client and Siebel Tools only) Installs Oracle Database XE, and optionally installs the sample database or local database. For more information, see Installing and Using Oracle Database XE for the Local or Sample Database.
Creates Siebel shortcuts.
Writes data to installation log files.
Related Topics
Installation-Related Changes for Siebel CRM 17.0
Installing the Siebel Web Client
Installing and Using Oracle Database XE for the Local or Sample Database
Requirements for Installing Siebel Web Clients
Related Books
Siebel Deployment Planning Guide
Deploying Siebel Open UI
Siebel Remote and Replication Manager Administration Guide
Configuring Siebel Business Applications
Using Siebel Tools
Installing the Siebel Web Client
This topic provides instructions for installing the Siebel Mobile Web Client or Developer Web Client and specified Siebel language packs.
The language that the installer displays is the one that corresponds to the current regional settings on the installation client computer.
This topic contains the following information:
Related Topics
About Installing the Siebel Web Client or Siebel Tools
Installing Siebel Web Clients and Siebel Tools in Unattended Mode
Installing and Using Oracle Database XE for the Local or Sample Database
Verifying Installation for the Siebel Web Client
Verifying Installation for Oracle Database XE
Uninstalling Siebel Web Clients or Siebel Tools
Related Books
Siebel Remote and Replication Manager Administration Guide
Installing the Siebel Web Client as a New Installation
Use the following procedure to install the Siebel Web Client as a new installation. Some of the information applies to only the Siebel Mobile Web Client or only the Siebel Developer Web Client.
Oracle Database XE is always installed for Siebel Mobile Web Client. You can optionally install the sample database for a new installation. Alternatively, you can use this procedure to install the sample database for an existing installation of Siebel Mobile Web Client of the same version, if you had not previously installed the sample database. Do not install the sample database if you plan to initialize a local database through Siebel Remote. For more information, see Installing and Using Oracle Database XE for the Local or Sample Database.
This topic is part of Installing the Siebel Web Client.
This task is a step in:
To install the Siebel Web Client as a new installation
Review About Installing the Siebel Web Client or Siebel Tools. See also Installing and Using Oracle Database XE for the Local or Sample Database.
Uninstall your existing sample database from a previous Siebel CRM release, where applicable.
Note: The Siebel Installation Guides for prior releases of Siebel CRM are available on My Oracle Support, at 1461732.1 (Article ID).In Windows Explorer, navigate to the Siebel image location for Siebel CRM 17.0. Then navigate to the directory where the installer is located. Navigate to
Siebel_Image\Windows\Client\Siebel_Web_Client\Disk1\install
.In this path, Siebel_Image is the directory for your version-specific Siebel network image, such as
C:\Siebel_Install_Image\17.0.0.0
.To start the Siebel Web Client installer, double-click setup.bat.
The Siebel Web Client installer displays the Welcome screen.
Click Next.
The Select Installation Task screen appears. The New Installation task is selected by default.
To perform a new installation of Siebel Web Client software where no existing installation of a prior release of Siebel CRM is present, click Next. Also click Next if you are installing the sample database into an existing installation of Siebel Mobile Web Client of the same version.
The New Installation Details screen appears.
Enter a name for your installation and specify the installation location, and then click Next. (Note the installation name and location for future reference.) Note the following:
The default installation name (Oracle Home Name) is CLIENT_HOME. The value that you specify is used in the parent program folder name for the Siebel application client shortcuts. (A separate program folder is created for the Oracle Universal Installer software.) If you have an existing installation, then you must specify a new name for the new installation.
The default installation path (Oracle Home Location) for a new installation is
C:\Siebel\Client
or a similar value. Accept the default path or specify a different location 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 Oracle home and installation path requirements, see File and Directory Naming Conventions.
If you specified an existing installation of Siebel Mobile Web Client for the current release in this screen, then the installer gives you the option of installing the sample database into your existing installation. Go to Step 18. Otherwise, go to the next step.
For a new installation, the Select Languages screen appears. All of the languages that were included in the Siebel network image for Siebel Web Client are available for selection.
Select the languages that you want to install, and click Next. You must select at least one language in order to proceed.
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 languages to install in order to run Siebel CRM using these languages. The files that are specific to the languages chosen in this step will be copied to your computer.
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 Client Type screen appears.
Specify the type of Siebel Web Client that you are installing: either Siebel Mobile Web Client or Siebel Developer Web Client. Do one of the following:
For Siebel Mobile Web Client, go to the next step.
For Siebel Developer Web Client, go to Step 11.
(Siebel Mobile Web Client only) In the Remote Server Information screen, specify the name of the Siebel Server on which you are running the Siebel Remote Server components. Then click Next. Go to Step 19.
The Siebel Remote Server components are required for initializing and synchronizing the local database on the Siebel Mobile Web Client computer.
(Siebel Developer Web Client only) In the Database Server screen, select the type of database server that you are using for Siebel CRM. Choose one of the following, and click Next:
Oracle Database Server
IBM DB2 UDB for Windows and UNIX
Microsoft SQL Server
IBM DB2 UDB for z/OS
Note: Depending on your selection, the Siebel Web Client installer validates that the correct database connectivity software has been installed. If it has not been installed, then you must exit the Siebel Web Client installer, install the required software, and then restart the Siebel Web Client installer.(Siebel Developer Web Client only) In the Database Identification screen, enter the following information, and click Next. Specify information for the database that you specified in Step 11:
For Oracle Database, specify the Database Alias and Table Owner.
For IBM DB2, specify the Database Alias and Table Owner.
For Microsoft SQL Server, specify the Database Server Host Name and Database Instance Name.
For IBM DB2 for z/OS, specify the Database Alias (as defined in DB2 Connect) and Table Owner or Schema Qualifier.
Enter the data that you previously specified in the worksheet in Siebel Deployment Planning Worksheet.
(Siebel Developer Web Client only) In the File System Server Information screen, specify the directory path for a network-based Siebel File System by typing it directly or by clicking Browse. Then click Next.
Note: For the Siebel File System path, you can use a UNC share name (for example,\\SRV1\siebfile
) or a mapped drive (for example,K:\siebelFS
). For more information, see File and Directory Naming Conventions. See also Creating the Siebel File System.(Siebel Developer Web Client only) In the Remote Server Information screen, click Next to accept the default. (This screen is primarily for Siebel Mobile Web Client.)
(Siebel Developer Web Client only) In the Enterprise Server Information screen, specify the address of the Siebel Gateway and the name of the Siebel Enterprise to which this Siebel Developer Web Client will connect for administration. Then click Next.
The Gateway Address is the network name or the IP address of the computer on which the Siebel Gateway is installed. To enter a specific port number, append the Gateway Address string with a colon and the desired port number.
The Enterprise Server name is the name of the Siebel Enterprise under which the Siebel Servers that support the server database were installed.
(Siebel Developer Web Client only) In the Server Request Broker Information screen, specify the Request Server Name, and click Next.
This value is the name of the Siebel Server on which the Server Request Broker component is operating. This component is used for dynamic assignment and other interactive operations.
(Siebel Developer Web Client only) In the Search Server Information screen, if you will use a search server, then enter the following for the server computer where the search server operates. Then click Next.
Search Server Hostname. The default value is localhost.
Search Server Port Number. The default value is 2048.
Note: For system requirements and other information about deploying a search server, see Siebel Search Administration Guide.(Siebel Mobile Web Client only) In the Sample DB Selection screen of the Siebel Web Client installer, you can optionally specify that you want to install the sample database. Specify the path to the installed 32-bit Oracle Database Client, whether or not you install the sample database.
For example, if the Oracle Database Client was installed at a location like
C:\app\client\username\product\12.1.0\client_1
, then you would specify that location during Siebel Mobile Web Client installation.In the Summary screen, review the information presented.
This screen displays the location where the Siebel Web Client 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 the Siebel Web Client software, 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. 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 Web Clients and Siebel Tools in Unattended Mode.
The Installation Progress screen appears. The Siebel Web Client software is installed into the directory that you specified in Step 7.
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.
To close the installer, click Close.
The Siebel Web Client installation is now finished. Siebel application shortcuts are created in the program folder. For more information about these shortcuts, see Siebel Web Client Shortcuts.
After installing the Siebel Web Client software:
Verify the Siebel Web Client installation, as described in Verifying Installation for the Siebel Web Client.
Install Siebel CRM 19.12 Update, as described in Installing and Uninstalling Siebel CRM 19.x Update. Then verify the installation again.
Perform any additional postinstallation steps, as described in Additional Postinstallation and Configuration Tasks.
Repeat this procedure on each computer where you are installing Siebel Web Client.
Installing the Siebel Web Client as a Migration Installation
Use the following procedure to install the Siebel Web Client as a migration installation. The information applies to both the Siebel Mobile Web Client and the Siebel Developer Web Client.
During a migration installation, the original Siebel Web Client installation directory is renamed from OriginalName
to OriginalName_pre17.0
. For example, if the original installation directory name (OriginalName
) was Client_1
, then this directory is renamed to Client_1_pre17.0
. The new Siebel Web Client installation directory is named OriginalName
, such as Client_1
. Retain the original installation directory, in case you choose to perform a rollback uninstallation later. For more information, see Rolling Back the Siebel Web Client.
Oracle Database XE is always installed for Siebel Mobile Web Client. You can optionally install the sample database in a migration installation of Siebel Mobile Web Client. Do not install the sample database if you plan to initialize a local database through Siebel Remote. For more information, see Installing and Using Oracle Database XE for the Local or Sample Database.
This topic is part of Installing the Siebel Web Client.
This task is a step in Roadmap for Installing Siebel CRM in a Migration Installation Case (Existing Installation).
To install the Siebel Web Client as a migration installation
Review About Installing the Siebel Web Client or Siebel Tools. See also Installing and Using Oracle Database XE for the Local or Sample Database.
Perform any premigration tasks that might be necessary, as noted in Additional Tasks for Migration Installations.
Exit any Siebel software on the client computer where you are installing the Siebel Web Client.
Note: For a Siebel Mobile Web Client using the Siebel QuickStart feature, you must also exit the QuickStart agent if it is running. To do this, right-click the QuickStart icon in the system tray, and then choose Exit. Siebel QuickStart is no longer supported, as of Siebel CRM 16.0.Perform any additional premigration tasks that might be necessary. For example, you might need to upgrade the 32-bit Oracle Database Client version installed on your computer.
In Windows Explorer, navigate to the Siebel image location for Siebel CRM 17.0, and then to the directory where the installer is located. Navigate to
Siebel_Image \Windows\Client\Siebel_Web_Client\Disk1\install
.In this path, Siebel_Image is the directory for your version-specific Siebel installation image, such as
C:\Siebel_Install_Image\17.0.0.0
.Before you run the installer to perform the migration installation of the Siebel Web Client, run the following command:
module.exe -debug -silent -attachhome ORACLE_HOME_NAME=Oracle_Home_Name ORACLE_HOME=Oracle_Home
For example, you might enter a command like this, depending on the Oracle home name and on the original installation directory:
module.exe -debug -silent -attachhome ORACLE_HOME_NAME=CLIENT_HOME ORACLE_HOME=c:\Siebel\Client
To start the Siebel Web Client installer, double-click setup.bat.
The Siebel Web Client installer displays the Welcome screen.
Click Next.
The Select Installation Task screen appears.
To perform a migration installation of Siebel Web Client where an existing prior release is present, choose Migration Installation, and click Next.
The Installation Migration Details screen appears.
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 Oracle home and installation path requirements, see File and Directory Naming Conventions.
(Siebel Mobile Web Client only) In the Sample DB Selection screen of the Siebel Web Client installer, you can optionally specify that you want to install the sample database. Specify the path to the installed 32-bit Oracle Database Client, whether or not you install the sample database.
For example, if the Oracle Database Client was installed at a location like
C:\app\client\username\product\12.1.0\client_1
, then you would specify that location during Siebel Mobile Web Client installation.
In the Summary screen, review the information presented.
This screen displays the location where the Siebel Web Client 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 the Siebel Web Client software, 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. 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 Web Clients and Siebel Tools in Unattended Mode.
The Installation Progress screen appears. The Siebel Web Client software is installed into the directory that you specified in Step 10.
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. This screen also shows the new location of the original installation, which the installer moved before it performed the new installation.
Review the report that is generated about any conflicts between your customized files and the files that are delivered by the Siebel Web Client 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
SIEBEL_CLIENT_ROOT\cfgtoollogs\oui
directory (in the new Siebel Web Client installation).To close the installer, click Close.
The Siebel Web Client installation is now finished. Siebel application shortcuts are created in the program folder. For more information about these shortcuts, see Siebel Web Client Shortcuts.
After installing the Siebel Web Client software:
Verify the Siebel Web Client installation, as described in Verifying Installation for the Siebel Web Client.
Install Siebel CRM 19.12 Update, as described in Installing and Uninstalling Siebel CRM 19.x Update. Then verify the installation again.
Perform any additional postinstallation steps, as described in Additional Postinstallation and Configuration Tasks. See also Additional Tasks for Migration Installations.
Repeat this procedure on each computer with a Siebel Web Client installation to be migrated.
Installing Siebel Tools
This topic provides instructions for installing the Siebel Tools Client and specified Siebel language packs. Siebel Tools is an integrated environment used by developers for configuring Siebel CRM.
The language that the installer displays is the one that corresponds to the current regional settings on the installation client computer.
This topic contains the following information:
Related Topics
About Installing the Siebel Web Client or Siebel Tools
Installing and Using Oracle Database XE for the Local or Sample Database
Installing Siebel Web Clients and Siebel Tools in Unattended Mode
About Workspaces in Siebel Tools and the Siebel Runtime Repository
Verifying Installation for Siebel Tools
Related Books
Using Siebel Tools
Configuring Siebel Business Applications
Siebel Remote and Replication Manager Administration Guide
Configuring Siebel Open UI
Siebel Developer's Reference
Installing Siebel Tools as a New Installation
Use the following procedure to install Siebel Tools as a new installation for Siebel CRM 17.0.
Oracle Database XE is always installed for Siebel Tools. You can optionally install the local database for a new installation. Alternatively, you can use this procedure to install the local database for an existing installation of Siebel Tools, if you had not previously installed the local database. Do not install the local database if you plan to initialize a local database through Siebel Remote. For more information, see Installing and Using Oracle Database XE for the Local or Sample Database.
This topic is part of Installing Siebel Tools.
This task is a step in:
To install Siebel Tools as a new installation
Review About Installing the Siebel Web Client or Siebel Tools. See also Installing and Using Oracle Database XE for the Local or Sample Database.
In Windows Explorer, navigate to the Siebel image location for Siebel CRM 17.0. Then navigate to the directory where the installer is located. Navigate to
Siebel_Image\Windows\Client\Siebel_Tools\Disk1\install
.In this path,
Siebel_Image
is the directory for your version-specific Siebel network image, such asC:\Siebel_Install_Image\17.0.0.0
.To start the Siebel Tools installer, double-click setup.bat.
The Siebel Tools installer displays the Welcome screen.
Click Next.
The Select Installation Task screen appears. The New Installation task is selected by default.
To perform a new installation of Siebel Tools software where no prior release of Siebel CRM is present, click Next. Also click Next if you are installing the local database into an existing installation of Siebel Tools.
The New Installation Details screen appears.
Enter a name for your installation and specify the installation location, and then click Next. (Note the installation name and location for future reference.) Note the following:
The default installation name (Oracle Home Name) is TOOLS_HOME. The value that you specify is used in the parent program folder name for the Siebel Tools client shortcut. (A separate program folder is created for the Oracle Universal Installer software.) If you have an existing installation, then you must specify a new name for the new installation.
The default installation path (Oracle Home Location) for a new installation is
C:\Siebel\Tools
or a similar value. Accept the default path or specify a different location 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 Oracle home and installation path requirements, see File and Directory Naming Conventions.
If you specified an existing installation of Siebel Tools for the current release in this screen, then the installer gives you the option of installing the local database into your existing installation. Go to Step 13. Otherwise, go to the next step.
For a new installation, the Select Languages screen appears. All of the languages that were included in the Siebel network image for Siebel Tools are available for selection.
Select the languages that you want to install, and click Next. You must select at least one language in order to proceed.
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 languages to install in order to run applications using these languages. The files that are specific to the languages chosen in this step will be copied to your computer.
Note: You must install Siebel Tools with the U.S. English (ENU) language pack. You can also install other Siebel language packs.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.In the Database Server screen, select the type of database server that you are using for Siebel CRM. Choose one of the following, and click Next:
Oracle Database Server
IBM DB2 UDB for Windows and UNIX
Microsoft SQL Server
IBM DB2 UDB for z/OS
In the Database Identification screen, enter the following information, and click Next. Specify information for the database that you specified in Step 8:
For Oracle Database, specify the Database Alias and Table Owner.
For IBM DB2, specify the Database Alias and Table Owner.
For Microsoft SQL Server, specify the Database Server Host Name and Database Instance Name.
For IBM DB2 for z/OS, specify the Database Alias (as defined in DB2 Connect) and Table Owner or Schema Qualifier.
Enter data that you previously specified in the worksheet in Siebel Deployment Planning Worksheet.
In the File System Server Information screen, specify the directory path for a network-based Siebel File System by typing it directly or by clicking Browse. Then click Next.
Note: For the Siebel File System path, you can use a UNC share name (for example,\\SRV1\siebfile
) or a mapped drive (for example,K:\siebelFS
). For more information, see File and Directory Naming Conventions. See also Creating the Siebel File System.In the Remote Server Information screen, specify the name of the Siebel Server on which you are running the Siebel Remote Server components. Then click Next.
The Siebel Remote Server components are required for initializing and synchronizing the local database on the Siebel Tools computer.
In the Enterprise Server Information screen, specify the address of the Siebel Gateway and the name of the Siebel Enterprise to which Siebel Tools will connect for administration. Then click Next.
The Gateway Address is the network name or the IP address of the computer on which the Siebel Gateway is installed. To enter a specific port number, append the Gateway Address string with a colon and the desired port number.
The Enterprise Server is the name of the Siebel Enterprise under which the Siebel Servers that support the server database were installed.
In the Local DB Selection screen of the Siebel Tools installer, you can optionally specify that you want to install the local database. If you checked Install Local DB, then you must also specify an appropriate user name and password. Also specify the path to the installed 32-bit Oracle Database Client, whether or not you install the local database.
For example, if the Oracle Database Client was installed at a location like
C:\app\client\username\product\12.1.0\client_1
, then you would specify that location during Siebel Tools installation.In the Summary screen, review the information presented.
This screen displays the location where Siebel Tools 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 the Siebel Tools software, 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. 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 Web Clients and Siebel Tools in Unattended Mode.
The Installation Progress screen appears. The Siebel Tools software is installed into the directory that you specified in Step 6.
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.
To close the installer, click Close.
Siebel Tools installation is now finished. The Siebel Tools shortcut was created in the program folder.
After installing the Siebel Tools software:
Verify the Siebel Tools installation, as described in Verifying Installation for Siebel Tools.
Install Siebel CRM 19.12 Update, as described in Installing and Uninstalling Siebel CRM 19.x Update. Then verify the installation again.
Perform any additional postinstallation steps, as described in Additional Postinstallation and Configuration Tasks.
Repeat this procedure on each computer where you are installing Siebel Tools.
Installing Siebel Tools as a Migration Installation
Use the following procedure to install Siebel Tools as a migration installation.
During a migration installation, the original Siebel Tools installation directory is renamed from OriginalName
to OriginalName_pre17.0
. For example, if the original installation directory name (OriginalName
) was Tools_1
, then this directory is renamed to Tools_1_pre17.0
. The new Siebel Tools installation directory is named OriginalName
, such as Tools_1
. Retain the original installation directory, in case you choose to perform a rollback uninstallation later. For more information, see Rolling Back Siebel Tools.
Oracle Database XE is always installed for Siebel Tools. You can optionally install the local database in a migration installation of Siebel Tools. Do not install the local database if you plan to initialize a local database through Siebel Remote. For more information, see Installing and Using Oracle Database XE for the Local or Sample Database.
This topic is part of Installing Siebel Tools.
This task is a step in Roadmap for Installing Siebel CRM in a Migration Installation Case (Existing Installation).
To install Siebel Tools as a migration installation
Review About Installing the Siebel Web Client or Siebel Tools. See also Installing and Using Oracle Database XE for the Local or Sample Database.
Perform any premigration tasks that might be necessary, as noted in Additional Tasks for Migration Installations. For example, your administrator might want you to check in any changes you have made to objects in your existing local database.
Exit any Siebel software on the developer client computer where you are installing Siebel Tools.
Perform any additional premigration tasks that might be necessary. For example, you might need to upgrade the 32-bit Oracle Database Client version installed on your computer.
In Windows Explorer, navigate to the Siebel image location for Siebel CRM 17.0, and then to the directory where the installer is located. Navigate to
Siebel_Image\Windows\Client\Siebel_Tools\Disk1\install
.In this path,
Siebel_Image
is the directory for your version-specific Siebel installation image, such asC:\Siebel_Install_Image\17.0.0.0
.Before you run the installer to perform the migration installation of Siebel Tools, run the following command:
module.exe -debug -silent -attachhome ORACLE_HOME_NAME=Oracle_Home_Name ORACLE_HOME=Oracle_Home
For example, you might enter a command like this, depending on the Oracle home name and on the original installation directory:
module.exe -debug -silent -attachhome ORACLE_HOME_NAME=TOOLS_HOME ORACLE_HOME=c:\Siebel\Tools
To start the Siebel Tools installer, double-click setup.bat.
The Siebel Tools installer displays the Welcome screen.
Click Next.
The Select Installation Task screen appears.
To perform a migration installation of Siebel Tools where an existing prior release is present, choose Migration Installation, and click Next.
The Installation Migration Details screen appears.
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 Oracle home and installation path requirements, see File and Directory Naming Conventions.
In the Local DB Selection screen of the Siebel Tools installer, you can optionally specify that you want to install the local database. If you checked Install Local DB, then you must also specify an appropriate user name and password. Also specify the path to the installed 32-bit Oracle Database Client, whether or not you install the local database.
For example, if the Oracle Database Client was installed at a location like
C:\app\client\username\product\12.1.0\client_1
, then you would specify that location during Siebel Tools installation.In the Summary screen, review the information presented.
This screen displays the location where Siebel Tools 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 the Siebel Tools software, 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. 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 Web Clients and Siebel Tools in Unattended Mode.
The Installation Progress screen appears. The Siebel Tools software is installed into the directory that you specified in Step 10.
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. This screen also shows the location of the original installation, which the installer moved before it performed the new installation.
Review the report that is generated about any conflicts between your customized files and the files that are delivered by the Siebel Tools 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
SIEBEL_TOOLS_ROOT\cfgtoollogs\oui
directory (in the new Siebel Tools installation).To close the installer, click Close.
The Siebel Tools installation is now finished. The Siebel Tools shortcut was created in the program folder.
After installing the Siebel Tools software:
Verify the Siebel Tools installation, as described in Verifying Installation for Siebel Tools.
Install Siebel CRM 19.12 Update, as described in Installing and Uninstalling Siebel CRM 19.x Update. Then verify the installation again.
Perform any additional postinstallation steps, as described in Additional Postinstallation and Configuration Tasks. See also Additional Tasks for Migration Installations.
Repeat this procedure on each computer with a Siebel Tools installation to be migrated.
Installing and Using Oracle Database XE for the Local or Sample Database
Oracle Database XE is provided as the database platform for the local database for Siebel Tools and for Siebel Mobile Web Client, or for the sample database for Siebel Mobile Web Client. Oracle Database XE software is always installed for Siebel Tools or Siebel Web Client (Siebel Mobile Web Client only), for a new or migration installation.
Oracle Database XE is installed and used in the following cases:
Local database for Siebel Tools. The Siebel Tools installer installs Oracle Database XE and provides the option to install the local database, as described in Installing Siebel Tools. Alternatively, the installer installs a database template, and you initialize the local database through the Siebel Remote server.
Local database for Siebel Mobile Web Client. The Siebel Web Client installer installs Oracle Database XE and a database template (if you do not install the sample database instead), and you initialize the local database through the Siebel Remote server. Support for the local database for this client was added in Siebel CRM 16.0 and later. This local database is also called the remote database.
Sample database for Siebel Mobile Web Client. The Siebel Web Client installer installs Oracle Database XE and provides the option to install the sample database, as described in Installing the Siebel Web Client.
Requirements for Installing and Using Oracle Database XE
For platform requirements for installing and using Siebel Tools and Siebel Web Clients, see the Certifications tab on My Oracle Support. See also Requirements for Installing Siebel Web Clients and Requirements for Installing Siebel Tools. See also the documentation for Oracle Database Express Edition on Oracle Help Center.
Siebel image requirement. For your users to be able to install the local database or sample database on client computers, you must include the necessary JAR file in the Siebel image for Siebel CRM 17.0. When you create the Siebel image, you can select the options that will support users of 64-bit versions of Microsoft Windows. For more information, see About the Siebel Network Image. See also About Siebel CRM Releases.
Oracle Database Client requirement. For your users to be able to use Oracle Database XE on the client computer, the 32-bit Oracle Database Client must be installed. The Siebel Tools and Siebel Web Client installers prompt for the installed location of this database client, which must have been installed at the location you specified in order for users to be able to access the local or sample database.
For example, if the Oracle Database Client was installed at a location like
C:\app\client\username\product\12.1.0\client_1
, then you would specify that location during Siebel Tools or Siebel Web Client installation.Because Oracle Database XE is always installed for Siebel Tools or Siebel Mobile Web Client, the same Oracle Database Client requirement also applies if you plan to initialize a local database through Siebel Remote.
For the version of Oracle Database XE that is installed and used with Siebel Web Client and Siebel Tools, see the Certifications tab on My Oracle Support.
Disable antivirus software. You might need to disable antivirus software while installing Oracle Database XE and the local database or sample database for Siebel Tools or Siebel Mobile Web Client.
About Installing the Local Database or Sample Database
You can install the local database in a new or migration installation of Siebel Tools or install the sample database in a new or migration installation of Siebel Mobile Web Client. For existing installations of the current release, the installers also provide the option of installing the local database or the sample database, if you had not previously installed it.
When you specify to install the local or sample database, the installation is done silently: no separate screens are displayed for this purpose. If Oracle Database XE is already installed, then it is not installed again, but the local database or sample database is still installed.
You can optionally install Siebel Tools and the local database or install Siebel Web Client and the sample database in unattended mode, as described in Installing Siebel Web Clients and Siebel Tools in Unattended Mode.
Installing the local database for Siebel Tools requires you to provide an appropriate user name and password when the installer prompts for them. For unattended installation, include the user name in the response file and specify the password at the command line when you execute the response file.
Only one instance of Oracle Database XE and one database are valid on a single computer. Installing a new database overwrites an existing database. For example, on the Siebel Mobile Web Client, if the local database or the sample database is already present, then this database’s DBF files are overwritten if you add the other database. However, you can support multiple instances of Oracle Database XE databases by using the OracleXEConfig.bat utility.
SIEBEL_TOOLS_ROOT\bin
directory contains the files OracleXEConfig.bat and XEConfig.jar. To run OracleXEConfig.bat on a Siebel Mobile Web Client installation, you can also copy these files to the
SIEBEL_CLIENT_ROOT\bin
directory.
If you did not install the local database when you installed Siebel Tools or install the sample database when you installed Siebel Web Client for the current release, then you can add it to the existing installation later. To do this, start the Siebel Tools or Siebel Web Client installer as if for a new installation, and then provide the existing Oracle home information.
After you install the Siebel Web Client or Siebel Tools, verify the installation, as described in Verifying Installation for the Siebel Web Client or Verifying Installation for Siebel Tools. Also verify the Oracle Database XE installation, as described in Verifying Installation for Oracle Database XE.
About Data Sources for the Local Database or Sample Database
The Siebel Tools and Siebel Web Client installers also create data sources as follows, if they did not already exist:
When you install Siebel Tools, the LOCAL_XE data source is created in all cases (whether or not you install the local database). You use this data source for connections to the local database that you installed, or to connect to a local database that you initialize through Siebel Remote. The corresponding section of the tools.cfg file is [LOCAL_XE].
If the local database has been extracted for the user on the Siebel Remote server, then you initialize this database by logging in using LOCAL_XE, as described in Configuring Siebel Business Applications and Using Siebel Tools.
When you install Siebel Mobile Web Client without installing the sample database, the LOCAL_XE data source is created, which you use for connections to a local database. The corresponding section of the Siebel application configuration file is [LOCAL_XE].
If the local database has been extracted for the user on the Siebel Remote server, then you initialize this database by logging in using LOCAL_XE, as described in Siebel Remote and Replication Manager Administration Guide.
When you install Siebel Mobile Web Client with the sample database, the SAMPLE_XE data source is created, which you use for connections to the sample database. The corresponding section of the Siebel application configuration file is [SAMPLE_XE].
About Migration Installations
Before any migration installation tasks are performed, local database users must synchronize any changes that must be preserved.
In a migration installation where Oracle Database XE and the local or sample database were previously installed, this instance of Oracle Database XE software migrates to the new installation. No database from the prior release is migrated. A new database and data source is created under the new instance according to the installer selections the user made, as in a new installation.
About the Local Database for Siebel Tools
As noted, you use the procedure in Installing Siebel Tools to install the local database for Siebel Tools in a new or migration installation. The user connects to the LOCAL_XE data source to log in to this local database. The data in each local database is a subset of the server database, as determined by each user’s visibility rules.
Additional steps are necessary to prepare the local database for use by the Siebel Tools developer. After installing Oracle Database XE and the local database for Siebel Tools, you must set up this database based on your company’s database customizations and based on the particular developer who will use this local database. For example, to prepare the local database for use by the developer user, you can run the local database setup script. For more information about this task, see Configuring Siebel Business Applications.
Alternatively, you might choose to initialize the local database through Siebel Remote, as described in Configuring Siebel Business Applications and Using Siebel Tools. In this case, do not install the local database with Siebel Tools. The user connects to the LOCAL_XE data source to initialize the local database. When logging in to a local database for the first time, the user is automatically prompted to connect to the Siebel Server and download the local database. Users must attempt this only after a local database has been extracted for them by the system administrator.
About the Local Database for Siebel Mobile Web Client
For information about initializing the local database for Siebel Mobile Web Client through Siebel Remote, see Siebel Remote and Replication Manager Administration Guide. In this case, do not install the sample database with Siebel Mobile Web Client. The data in each local database is a subset of the server database, as determined by each user’s visibility rules.
The user connects to the LOCAL_XE data source to initialize the local database. When logging in to a local database for the first time, the user is automatically prompted to connect to the Siebel Server and download the local database. Users must attempt this only after a local database has been extracted for them by the system administrator.
About the Sample Database for Siebel Mobile Web Client
As noted, you use the procedure in Installing the Siebel Web Client to install the sample database for Siebel Mobile Web Client in a new or migration installation. Connect to the SAMPLE_XE data source to log in to this sample database.
The sample database contains example data of various kinds to help you understand how Siebel applications work. The sample database contains schema changes, repository changes, and seed data for Siebel CRM functionality through the current release. For more information about some of the content in the sample database, see Siebel Demo Users Reference.
After you have installed the sample database, you can run Siebel demo applications, such as those described in Siebel Web Client Shortcuts and Startup Options. You can also customize shortcuts, as described in the same topic.
About Uninstalling Oracle Database XE
Oracle Database XE and the local database or sample database are not uninstalled when you uninstall the Siebel Web Client or Siebel Tools software, in either a full uninstallation or a rollback uninstallation. For information about uninstalling Oracle Database XE, see Uninstalling Oracle Database XE.
Installing Siebel Web Clients and Siebel Tools in Unattended Mode
The installer programs for Siebel Mobile or Developer Web Client and Siebel Tools support 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 client 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 of the same version. To add languages, you must use this method.
This topic contains the following information:
Guidelines for Installing Siebel Web Clients and Siebel Tools in Unattended Mode
Installation Response File Entries for Installing Oracle Database XE
Related Topics
Installing and Deploying Additional Languages
Installing the Siebel Web Client
Installing and Using Oracle Database XE for the Local or Sample Database
Verifying Installation for the Siebel Web Client
Verifying Installation for Siebel Tools
Guidelines for Installing Siebel Web Clients and Siebel Tools in Unattended Mode
Review the following guidelines for installing Siebel Web Clients and Siebel Tools 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 that each response file will yield when you perform an unattended installation.
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, validations are performed 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 Requirements for Installing Siebel Web Clients and Requirements for Installing Siebel Tools.
Validate the installation. Validate each installation after it has completed, as described in Verifying Installation for the Siebel Web Client and Verifying Installation for Siebel Tools.
To install Siebel Web Client or Siebel Tools 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 Web Client or Siebel Tools.
To save an installation response file
Navigate to the Siebel image location where the installer is located.
Start the installer for Siebel Web Client or Siebel Tools.
For information about starting these installers, see Installing the Siebel Web Client and Installing Siebel Tools.
Provide input to the installer wizard, as in a normal GUI installation.
In the Summary screen, click Save Response File.
Specify the location of the response file, for example,
C:\temp\clientinstall.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.
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,
C:\temp\clientinstall.rsp
). Although the Siebel CRM module is not installed (because you clicked Cancel), this directory contains a subdirectory calledinventory
, which includes information about the product inventory.Note: You might also edit the response file to add entries for different cases of installing Oracle Database XE for the local or sample database for Siebel Tools or Siebel Web Client, as described in Installation Response File Entries for Installing Oracle Database XE.See Performing an Installation in Unattended Mode for information about performing a Siebel Web Client or Siebel Tools installation in unattended mode, using the response file that you just generated.
Editing an Oracle-Provided Installation Response File
If you are adding languages to an existing Siebel Web Client or Siebel Tools 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.
Installation Response File Entries for Installing Oracle Database XE
You use different response file options for different cases of installing Oracle Database XE for the local or sample database for Siebel Tools or Siebel Web Client, as described here. For more information, see Installing and Using Oracle Database XE for the Local or Sample Database.
To install Siebel Tools with a local database, add entries like the following to your installation response file. Specify the same user name that you will use when you execute the response file (you must also use the
-passwd
option).INSTALL_LOCAL_OR_SAMPLE_DB="true" LOCAL_DB_USERNAME="username" ORACLE_CLIENT_PATH="Oracle_DB_install_path"
To install Siebel Tools without installing a local database (for example, where you plan to initialize a local database through Siebel Remote), add entries like the following to your installation response file:
INSTALL_LOCAL_OR_SAMPLE_DB="false" LOCAL_DB_USERNAME="" ORACLE_CLIENT_PATH="Oracle_DB_install_path"
To install Siebel Web Client where you plan to initialize a local database through Siebel Remote, add entries like the following to your installation response file:
INSTALL_LOCAL_OR_SAMPLE_DB="false" ORACLE_CLIENT_PATH="Oracle_DB_install_path"
To install Siebel Web Client with the sample database, add entries like the following to your installation response file:
INSTALL_LOCAL_OR_SAMPLE_DB="true" ORACLE_CLIENT_PATH="Oracle_DB_install_path"
Performing an Installation in Unattended Mode
Perform the following steps to perform an unattended installation of Siebel Web Client or Siebel Tools.
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
(For add language operations only) Uninstall Siebel CRM 19.12 Update if you have installed it on top of Siebel CRM 17.0, for each installed Siebel CRM module for which you are adding languages.
Navigate to the Siebel image location where the installer is located.
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 editing it or replacing it with a newly generated file or an edited version of the file.Open a DOS command window.
Run a command like the following to run the Siebel Web Client or Siebel Tools installer in unattended mode:
setup.bat -silent -responseFile path_to_installation_response_file -passwd password
where:
path_to_installation_response_file is the full path and name of a response file to be executed (for example,
C:\temp\clientinstall.rsp
).password is the password for the user name of the developer for this existing installation of Siebel Tools.
Note: The-passwd
option applies only to Siebel Tools installation with Oracle Database XE. See also Installation Response File Entries for Installing Oracle Database XE.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.
Validate the installation after it has completed.
For more information, see Verifying Installation for the Siebel Web Client and Verifying Installation for Siebel Tools. See also Verifying Installation for Oracle Database XE.
(For add language operations only) Reinstall Siebel CRM 19.12 Update, if you previously uninstalled it in Performing an Installation in Unattended Mode. Then validate the installation again.
About Workspaces in Siebel Tools and the Siebel Runtime Repository
Workspaces in Siebel Tools and Siebel Web Tools provide a developer user with a sandbox in which to make and test changes to repository data. This feature allows multiple developers to work against the same repository objects in the Siebel database. The feature makes sure that a developer’s work is isolated from that of other developers making changes to either the same objects or other objects of the application. Repository updates made in the developer’s environment can be published and tested without affecting other developers, until all updates are coordinated and published and delivered to the runtime repository for all Siebel Servers and Siebel Mobile Web Clients in test and production environments. For more information, see Using Siebel Tools.
As of Siebel CRM 17.0, the Siebel Repository File (SRF) is no longer applicable, and is replaced by the Siebel runtime repository in the Siebel database.
Related Topics
Related Books
Configuring Siebel Business Applications
Using Siebel Tools
Installing Desktop Integration Siebel Agent on Client Computers
This topic provides information about installing software on user computers that enables users to use certain features in Siebel applications that formerly were based on Java applets. This software is called Desktop Integration Siebel Agent, which is sometimes called DISA.
Customers can install and deploy Desktop Integration Siebel Agent on user computers for use with employee applications such as Siebel Call Center. Desktop Integration Siebel Agent supports inline editing of attachments, CTI hoteling, Send Email (F9) integration with Microsoft Outlook, and batch fulfillment printing.
For more information about installing and deploying Desktop Integration Siebel Agent, see Desktop Integration Siebel Agent Guide. See also 2107511.1 (Article ID) on My Oracle Support. For information about hoteling, see Siebel CTI Administration Guide. For more information about using Desktop Integration Siebel Agent for the Send Email (F9) integration with Microsoft Outlook, see 2117013.1 (Article ID) on My Oracle Support.
Related Books
Desktop Integration Siebel Agent Guide
Siebel CTI Administration Guide
2117011.1 (Article ID) on My Oracle Support (about DISA)
2117013.1 (Article ID) on My Oracle Support (about Send Email integration with DISA)
Siebel CRM Update Guide and Release Notes on My Oracle Support
Installing Outlook to Siebel Drag and Drop on Client Computers
This topic provides information about installing an addin for Microsoft Outlook on user computers that enables users to drag and drop email messages or email attachments into Siebel applications.
Customers can install the addin Outlook to Siebel Drag and Drop on user computers for use with employee applications. Installing this software enables a user to drag one or more email messages or email attachments from a Microsoft Outlook client and drop it onto a Siebel attachment applet. Each item is saved in an attachment record in the Siebel File System. You can then open this attachment like any other similar type of attachment that you have added to Siebel applications. Outlook to Siebel Drag and Drop is sometimes abbreviated as SODD.
For more information about installing and deploying Outlook to Siebel Drag and Drop, see Desktop Integration Siebel Agent Guide. See also 2117212.1 (Article ID) on My Oracle Support.
Outlook to Siebel Drag and Drop supports the following use cases:
Drag one email message from the Microsoft Outlook client and drop it into the Siebel CRM application. The email message is saved in a single attachment record. Or drag multiple email messages, which are saved in multiple attachment records.
Drag one email attachment from the Microsoft Outlook client and drop it into the Siebel CRM application. The email attachment is saved in a single attachment record. Or drag multiple email attachments, which are saved in multiple attachment records.
Related Books
Desktop Integration Siebel Agent Guide
Siebel Fundamentals Guide
2117212.1 (Article ID) on My Oracle Support (about Outlook to Siebel Drag and Drop)
Siebel CRM Update Guide and Release Notes on My Oracle Support
Siebel Client Deployment Requirements When Using Firewalls or Proxy Servers
This topic describes Siebel client deployment requirements that apply when you use firewalls or proxy servers, such as reverse proxy servers. This topic applies to all Siebel applications that are deployed inside the firewall or using a proxy server.
Deploying Siebel Applications Accessed Through a Firewall
When deploying Siebel applications that are accessed through a firewall, if you are planning to enable compression for traffic between the Siebel Application Interface and the Web browser, then your firewall must support the HTTP 1.1 protocol.
If your firewall does not support HTTP 1.1, then do not set HTTP 1.1-Compliant Firewall / Enable Web Compression to False for the Siebel Application Interface. In addition, disable HTTP 1.1 for proxy connections on each client computer. Follow instructions for your browser for this purpose. For example, for Microsoft Internet Explorer, you uncheck the option Use HTTP 1.1 Through Proxy Connections.
Bypassing the Proxy Server for Local Addresses
If your LAN uses a proxy server, then adjust your browser settings to bypass the proxy server for local (internal) addresses. This setting provides better performance for Siebel employee applications deployed on the LAN, and is required for the Siebel Mobile Web Client.
Follow instructions for your browser for this purpose. For example, for Microsoft Internet Explorer, you check the options Use a Proxy Server for Your LAN and Bypass Proxy Server for Local Addresses. For Siebel Web Clients, you also specify the proxy server address and port number.
Configuring Siebel CRM for Pop-Up Blocker Compatibility
Pop-up blocking software can sometimes cause Siebel applications not to work, because such software might block required Siebel application functionality. Such blocking software typically blocks processes or pop-up windows that originate from particular computer host names or domain names.
Siebel applications that you run on a LAN (Siebel Web Client) or that run on local client computers (Siebel Mobile Web Client) might be affected by pop-up blockers. Configuring the Siebel application to use a fully qualified domain name (FQDN), as described in this topic, might prevent such problems and allow you to use pop-up blockers safely. See also Configuring the Siebel Application Interface. It is strongly recommended to use the fully qualified domain name feature.
For example, the URL http://ebiz.example.com uses FQDN, while http://ebiz does not.
Parameters to configure fully qualified domain names are located in multiple places. How you set these parameters depends on the Siebel client that you are using. Specified host names or domain names must meet all of the applicable requirements, for example, underscores cannot be used.
Siebel Web Client. To use FQDN for this client type, set Configure Fully Qualified Domain Name to True when you configure the Siebel Application Interface instance, and set Fully Qualified Domain Name to the fully qualified domain name. For more information, see Configuring the Siebel Application Interface.
For example, you might set the fully qualified domain name to corp.example.com or server1.corp.example.com.
Siebel Mobile Web Client. To use FQDN for this client type, configure the following parameters in the Siebel application configuration file, such as uagent.cfg for Siebel Call Center, on each local client computer.
[Siebel] EnableFQDN = True
EnableFQDN is set to True by default for the Siebel Mobile Web Client.
If you do not also specify the FQDN parameter, then the URL is constructed automatically. For example, the FQDN for CCHENG might be constructed as ccheng.corp.example.com. Optionally, you can explicitly provide similar information, by using the FQDN parameter, as follows:
FQDN = hostname.primaryDNS.domainsuffix
where:
hostname is the name of the local client computer
primaryDNS is the primary part of the domain name (such as example)
domainsuffix is the domain type (such as com)
For example, you might set FQDN to ccheng.corp.example.com.
Caution: When you explicitly configure an FQDN for use with the Siebel Mobile Web Client, you must specify the local computer name. The localhost string from the default Siebel Mobile Web Client URL (which is used when EnableFQDN is False) cannot be used as an element in an FQDN. The localhost string is only functional when used by itself, with no additional qualifying elements.
Logging in to Your Siebel Application
This topic provides basic instructions for logging in to your Siebel application using one of the Siebel Web Client types. It contains the following information:
Before Logging in to Your Siebel Application
This topic contains information that you must know before you log in to your Siebel application.
This topic is part of Logging in to Your Siebel Application.
Review the following issues:
User rights to read and write in Siebel Web Client installation directories are required for running the Siebel Mobile Web Client or Developer Web Client. For information about setting user rights, consult the operating system manuals for the version of Microsoft Windows on which the application is installed.
After the Siebel database has been installed, as described in Installing the Siebel Database on the RDBMS and the server modules have been configured and you activate the license keys, users can access the Siebel CRM applications. For information about activating the license keys in the Siebel database, see Activating License Keys.
The user name and password used to log in to Siebel applications must be those of an employee with a valid position and division defined in the Siebel database.
You must log in to Siebel applications (using the Server database option in the login screen) as the Siebel administrator before anyone else can log in. Log in using the SADMIN user name or using other credentials as defined by your database administrator. Then you or other administrators can set up more users as employees with defined positions and responsibilities and other settings suitable for your access control policies. For more information about setting up employees, see Siebel Security Guide.
For the Siebel Developer Web Client, you must edit the application configuration file, such as uagent.cfg for Siebel Call Center, as follows:
In the [Siebel] section of the file, add the parameter ServerDbODBCDataSource, and set it to the ODBC data source that you are using for the server database.
In the [ServerDataSrc] section of the file, set the parameter ConnectString to the necessary value. For Oracle Database, set it to the alias defined in the tnsnames.ora file.
Tabbed browsing is supported with Siebel applications for one active session. Multiple Web pages can be opened using tabbed browsing, but only one tab can have a live connection to a Siebel application at a given time.
Logging in Using the Siebel Developer Web Client
You can use the Siebel Developer Web Client to log in to the Siebel application.
This topic is part of Logging in to Your Siebel Application.
To log in to your Siebel application using the Siebel Developer Web Client
Double-click one of the Siebel shortcuts in the program folder, such as Siebel Call Center for the language you are using.
Log in using a valid user ID and password.
Specify the Server database, and click OK.
Logging in Using the Siebel Mobile Web Client
You can use the Siebel Mobile Web Client to log in to the Siebel application.
This topic is part of Logging in to Your Siebel Application.
To log in to your Siebel application using the Siebel Mobile Web Client
Double-click one of the Siebel shortcuts in the program folder, such as Siebel Call Center for the language you are using.
Log in using a valid user ID and password.
Specify the Local database, and click OK.
Note: When logging in to a local database for the first time, users are automatically prompted to connect to the Siebel Server and download the local database. Users must attempt this only after a local database has been extracted for them by the system administrator. For more information, see Installing and Using Oracle Database XE for the Local or Sample Database.For more information about Siebel Remote and extracting local databases, see Siebel Remote and Replication Manager Administration Guide.
Logging in Using the Siebel Web Client
You can use the Siebel Web Client to log in to the Siebel application. (In this context, Siebel Web Client refers to the client type that is not installed locally, except for the browser itself.)
This topic is part of Logging in to Your Siebel Application.
To log in to your Siebel application using the Siebel Web Client
Open your Web browser.
Go to the URL for your Siebel application.
Log in using a valid user ID and password.
The Siebel application that you are connecting to is already configured to work with a specific database. When using this client type, you do not specify a database to connect to.
Siebel Web Client Shortcuts and Startup Options
This topic provides information about the shortcuts installed in the Siebel program folder when you install the Siebel Web Client, and about command-line options used in these shortcuts.
This topic also provides information about creating custom shortcuts to access Siebel applications using demo users provided with the sample database. For the demo users provided with the sample database, by Siebel application, see Siebel Demo Users Reference.
This topic contains the following information:
Siebel Web Client Shortcuts
The Siebel Web Client installer creates shortcuts in the Siebel program folder for the modules that you have installed. Separate shortcuts are installed for each installed language. Which shortcuts are installed depends on your installation choices and is also subject to the settings in the siebel.ini file at the time of installation. Most of the shortcuts are installed in the program group (program folder); some are installed in the startup group.
For information about customizing the shortcuts or creating new ones, see Siebel Web Client Startup Options and Creating Custom Siebel Application Shortcuts.
Siebel application shortcuts are created by the Siebel Web Client installer. When you run a shortcut to start a Siebel application, you can connect to the Siebel database (for LAN-connected users of the Siebel Developer Web Client), or to an initialized local database on the local computer (for Mobile Web Client). Each application shortcut loads the Siebel configuration file for that application; for example, Siebel Call Center uses the file uagent.cfg.
Where the sample database has been installed on the local computer, you can log in and connect to the sample database, using predefined demonstration users. For example, CCHENG is a demo user for Siebel Call Center. Many other demo users are available in the sample database that illustrate a particular Siebel application as it would appear for a user with certain predefined responsibilities. For more information about these users, see Siebel Demo Users Reference.
This topic is part of Siebel Web Client Shortcuts and Startup Options.
Siebel Application Shortcuts
Several Siebel application shortcuts are created in the Siebel Web Client program folder. All demo applications use the sample database. You can create shortcuts for any valid Siebel application for which no shortcut is created by the installer.
Related Books
Siebel Demo Users Reference
Siebel Security Guide
Utility and Synchronization Program Shortcuts
The following are some of the additional shortcuts created in the Siebel Web Client program folder. These shortcuts run utilities or synchronization programs.
Siebel Remote. Starts the Siebel Remote stand-alone synchronization program (siebsync.exe).
Siebel TrickleSync. Starts the Siebel TrickleSync program (autosync.exe). This shortcut is created in both the program group and the startup group.
Related Books
Siebel Remote and Replication Manager Administration Guide
Siebel Web Client Startup Options
The application shortcuts described in Siebel Web Client Shortcuts run an executable program called siebel.exe, followed by various startup options. For example, the shortcut for Siebel Call Center - ENU might be defined as shown in the following example (depending on your installation location). For this example, the only option used is /c
, to specify the configuration file.
"C:\Siebel\Client\BIN\siebel.exe" /c CFG_FILE_PATH\uagent.cfg
You can also create demo application shortcuts that specify the sample database and user and password information. For this example, you might define a shortcut like Siebel Call Center Demo - ENU as shown in the following:
"C:\Siebel\Client\BIN\siebel.exe" /c CFG_FILE_PATH\uagent.cfg /d sample /u CCHENG /p CCHENG
In the preceding examples, CFG_FILE_PATH
represents the full path to the configuration file. This file is located in BIN\LANGUAGE
in the SIEBEL_CLIENT_ROOT
directory. In this path, LANGUAGE is a language code, such as ENU for U.S. English.
For example, the target definition for the Siebel Call Center - ENU shortcut might resemble the following example:
"C:\Siebel\Client\BIN\siebel.exe" /c "C:\Siebel\Client\bin\ENU\uagent.cfg"
The siebel.exe program can also be run from a DOS command window. In this case, the startup options would be entered directly on the command line. For information about creating custom shortcuts, see Creating Custom Siebel Application Shortcuts.
This topic is part of Siebel Web Client Shortcuts and Startup Options.
The available startup options are described in the following table.
Table Siebel Web Client Startup Options
Startup Option | Description |
---|---|
|
Required. Specifies the path and file name for the configuration file to use, such as siebel.cfg for Siebel Sales or uagent.cfg for Siebel Call Center. |
|
Specifies the data source to connect to, as defined in the configuration file. The demo application shortcuts specify
|
|
Specifies the three-letter code for the language to use for this Siebel Web Client session, such as ENU for U.S. English. The applicable Siebel language pack must have been installed for the Siebel Web Client. If you do not use |
|
Specifies the user name. The demo application shortcuts specify predefined demo users using If you do not use For lists of demo users provided with the sample database, by Siebel application, see Siebel Demo Users Reference.
Caution: Consider the security issues when using
/u and
/p options (in particular
/p ) to access a live, production system. These values are not encrypted.
|
|
Specifies the password for the user specified using |
|
Specifies the path and file name for the browser executable program to use for the Siebel Web Client session. The For more information about the supported browsers for Siebel CRM, see the Certifications tab on My Oracle Support. |
|
Specifies spooling SQL to a specified output file. This option can be useful for troubleshooting purposes. For more information, see Siebel Performance Tuning Guide. |
Creating Custom Siebel Application Shortcuts
If you want to customize any of the Siebel application shortcuts described in Siebel Web Client Shortcuts, then you can do so by modifying shortcut properties and changing the value for the Target field. Generally, rather than modifying existing shortcuts or creating them from scratch, it is recommended that you copy existing ones and rename and modify the copies.
Observe the following requirements for creating or modifying shortcuts:
Do not modify the location displayed in the shortcut property labeled Start in.
When defining the Target value for a shortcut, follow the guidelines for using the options described in Siebel Web Client Startup Options.
This topic is part of Siebel Web Client Shortcuts and Startup Options.
To create custom Siebel application shortcuts
Copy existing Siebel application shortcuts.
Modify the copies, for example, by changing the value for the Target field.