6Installing Siebel CRM Desktop

Roadmap for Installing Siebel CRM Desktop

To install Siebel CRM Desktop, you do the following:

  1. Process of Preparing the Siebel Server

  2. Process of Installing the Siebel CRM Desktop Add-In

For information about ACR installation instructions, see Siebel Maintenance Release Guide on My Oracle Support.

Process of Preparing the Siebel Server

    Preparing the Implementation Environment for Siebel CRM Desktop

    This task is a step in Process of Preparing the Siebel Server.

    To prepare the implementation environment for Siebel CRM Desktop

    • Make sure Siebel CRM Desktop supports the environment where you implement Siebel CRM Desktop.

      You must verify that the supported environments are installed before you install Siebel CRM Desktop. For more information, see Siebel System Requirements and Supported Platforms on Oracle Technology Network.

      Administering Metadata Files

      This task is a step in Process of Preparing the Siebel Server.

      This topic describes how to administer predefined metadata files for Siebel CRM Desktop version 3.2and later. The client uses these files to determine the data to synchronize and the validation rules to apply.

      To administer metadata files

      1. Create a .zip file that includes the following files:

        • Every file listed in Metadata File Types.

        • Every language file that your implementation requires. If Siebel CRM Desktop must support a language other than English, then you must add the required language file. For example, the Ln_package_res.jp_JP.xml file. For more information, see Metadata File Types That Support Languages.

          Make sure every file in this .zip file is in the root directory in the zip file. This zip file must not contain a subdirectory.

      2. With administrator privileges, log in to Siebel Sales Enterprise through a Siebel Web Client that is connected to the Siebel Server.

      3. Navigate to the Administration - CRM Desktop screen and then the Metadata Files view.

      4. In the Metadata Files list, click New.

      5. In the Type list, choose IBM Notes Package.

      6. In the File Name field, locate the file you created in Step 1.

      7. Click Menu and then click Save Record.

        Creating and Publishing the Customization Package

        This task is a step in Process of Preparing the Siebel Server.

        You create a relationship between a responsibility and a customization package that determines the information that is available to the user. You can publish a package when Siebel CRM Desktop finishes the updates and it is ready to download this package to the client. Publishing makes a package read only so that you cannot make any more modifications on the package. For more information, see Relationships Between Users, Responsibilities, Customization Packages, and Metadata Files.

        To create and publish the customization package

        1. Navigate to the Administration - CRM Desktop screen, and then the Packages view.

        2. Create a new customization package, using values from the following table.

          Field Value

          Package Name

          Enter any value.

          It is recommended that you use a name that describes the purpose of the package configuration. For example, EMEA Sales Rep, or Field Sales Rep.

          Responsibility

          Choose the responsibility that is appropriate for the group of users that Siebel CRM Desktop uses with the package. Do not assign a user to more than one package. It is recommended that you maintain a separate set of Siebel CRM Desktop responsibilities where you can control the user assignment. This configuration helps to prevent creating relationships between a user and more than one responsibility and more than one package. If necessary, before you do this step, you can create a new responsibility and then assign specific users to this responsibility. For more information, see Guidelines for Assigning Responsibilities to Customization Packages.

        3. In the Metadata Files list, click Add, locate the .zip file that you added in Step 1 of the topic Administering Metadata Files, and then click OK.

        4. In the Packages list, click the link in the Package Name field for the customization package you created in Step 2.

        5. In the Package Details form, click Publish.

          Siebel CRM changes the Status field of the Package Details form to Published.

          For more information about how Siebel CRM Desktop uses a customization package, see Relationships Between Users, Responsibilities, Customization Packages, and Metadata Files.

          Guidelines for Assigning Responsibilities to Customization Packages

          If you develop a customization package, then you must make sure that you assign the user to only one customization package. Note the following guidelines:

          • You must assign only one responsibility to a customization package.

          • You must not assign more than one responsibility to a customization package.

          • You can assign multiple responsibilities to a user but you can create a relationship between only one of these responsibilities with an active customization package.

          • Make sure the responsibility and customization package that Siebel CRM Desktop assigns to the user is unique. For example, if Siebel CRM Desktop assigns two different responsibilities and two different customization packages to the same user, then a conflict might occur and your customizations might fail.

            Republishing Customization Packages

            If you change a metadata file, then you must republish the customization package that references this file. Siebel CRM Desktop downloads the changed metadata files as new metadata file records in the package.

            To republish a customization package, it is recommended that you unpublish the old package and then create a new package. This allows you to make sure the new package works as expected. If necessary, you can adjust the new package until it works correctly. To revert to the old package, you can unpublish the new package and then publish the old package.

            To republish a customization package
            1. Unpublish the old customization package:

              1. With administrator privileges, log in to a Siebel CRM client that is connected to the Siebel Server.

              2. Navigate to the Administration - CRM Desktop screen and then the Packages view.

              3. Query the Package Name field of the Packages list for the package you must republish.

              4. In the Packages list, click the link in the Package Name field.

              5. In the Package Details form, click Unpublish.

              6. Make sure Siebel CRM changes the Status field of the Package Details form to Unpublished.

            2. Create and publish a new customization package.

              For more information, see Creating and Publishing the Customization Package.

              Administering Server Variables

              This task is a step in Process of Preparing the Siebel Server.

              To administer server variables

              1. Set the maximum page size:

                1. Log in to a Siebel CRM client that is connected to the Siebel Server.

                2. Navigate to the Administration - Server Configuration screen and then the Servers view.

                3. In the Components list, query the Component field for EAI Object Manager.

                4. In the last applet, click the Parameters tab and then query the Parameter field for Maximum Page Size.

                5. In the Component Parameters list, configure the Maximum Page Size parameter using values from the following table.

                  Field Value

                  Default Value

                  1000

                  Value on Restart

                  1000

                6. In the Components list, click Manual Start.

              2. Set the DSMaxFetchArraySize parameter:

                1. Navigate to the Administration - Server Configuration screen and then the Enterprises view.

                2. Query the Profile field of the Profile Configuration view for Server Datasource.

                3. In the Profile Parameters list, click Advanced Profile Parameters, query the Alias field for DSMaxFetchArraySize, and then make sure the Value is set to the following:

                  -1
                  
              3. (Optional) Administer the Generic Siebel Owner system preference.

                For more information, see Controlling How Siebel CRM Desktop Assigns Calendar Entry Owners.

              4. Stop and then restart the Siebel Server.

                Overview of Installing the Siebel CRM Desktop Add-In

                This topic describes an overview of installing the Siebel CRM Desktop add-in. It includes the following topics:

                An installation package is a package that contains a Windows Installer (msi) file. Siebel CRM Desktop provides you with this file, and you can use it to install the Siebel CRM Desktop add-in on the client computer. It includes the following data:

                • The installation information for the Siebel CRM Desktop add-in

                • The predefined resource files and images for all languages that Siebel CRM Desktop supports

                You can deploy Siebel CRM Desktop through third-party deployment software that you choose. You can use the distribution criteria in these products to distribute software to any group of users, operating systems, domains, workgroups, and so on. System Center Configuration Manager (SCCM) from Microsoft is an example of deployment software. To deploy the Siebel CRM Desktop add-in to multiple users, you can use deployment software to create a collection and then distribute the distribution package. A collection is the list of users, computers, workgroups or domains where you must distribute the software.

                You can use third-party deployment software to do an installation in the background or to do a removal that uses the default installation parameters. With some deployment software, you can specify various installation parameters.

                Siebel CRM Desktop displays the First Run Assistant after you complete the installation and the user starts IBM Notes. For more information, see Customizing the First Run Assistant.

                For more information about using Systems Management Server, see the documentation at the Microsoft TechNet web site.

                  Changes That Siebel CRM Desktop Makes During Installation

                  This topic describes changes that Siebel CRM Desktop makes during installation. It makes these changes to the file system, Windows Registry, and settings in IBM Notes.

                    Where Siebel CRM Desktop Stores Data in the File System

                    Siebel CRM Desktop places most files that it requires in the following folder:

                    APPDATA\Oracle\CRM Desktopfor IBM Notes\Profile\
                    

                    where:

                    • APPDATA is an environment variable that the operating system automatically sets.

                    For example, in Windows XP, Siebel CRM Desktop places most files that it requires in the following folder:

                    \Documents and Settings\username\Application Data\Oracle\CRM Desktopfor IBM 
                    Notes\Profile
                    

                    You can change this directory. For more information, see Setting the Installation Directory of the Siebel CRM Desktop Add-In.

                    The following table describes where Siebel CRM Desktop stores data in the file system when the client runs on Windows XP.

                    Windows XP Folder on Client Description

                    \Documents and Settings\username\Application Data\Oracle\CRM Desktop for IBM Notes\bin

                    Siebel CRM Desktop saves the following information:

                    • Add-in dll files.

                    • Resources that binary files use.

                    • Microsoft Visual Studio run-time libraries.

                    • Help files.

                    \Documents and Settings\username\Application Data\Oracle\CRM Desktop for IBM Notes\Profile

                    Siebel CRM Desktop saves the following information:

                    • The Data folder. This folder includes package files.

                    • Siebel CRM Desktop log files.

                    • Various database files.

                    \Documents and Settings\username\Application Data\Oracle\CRM Desktopfor IBM Notes\Profile\Data

                    XML, DXL files, and JavaScript files of the customization package. For more information, see Files in the Customization Package.

                    \Documents and Settings\username\Application Data\Oracle\CRM Desktop for IBM Notes\Profile\Logs

                    For more information, see Log Files You Can Use with Siebel CRM Desktop.

                    Temp\
                    

                    When you download the customization package Siebel CRM Desktop places some files in a temporary directory.

                      Changes That Siebel CRM Desktop Makes in the Windows Registry

                      Siebel CRM Desktop adds registry entries differently depending on one of the following options that you choose when you install the Siebel CRM Desktop add-in:

                      • Anyone Who Uses This Computer. Siebel CRM Desktop adds registry entries in the following registry keys:

                        • HKEY_LOCAL_MACHINE\Software\Oracle\CRM Desktop

                        • HKEY_CURRENT_USER\Software\Oracle\CRM Desktop for the user who is currently logged in

                      • Only For Me. Siebel CRM Desktop adds registry entries only in the following registry key

                        • HKEY_CURRENT_USER\Software\Oracle\CRM Desktop

                      For more information, see Installing the Siebel CRM Desktop Add-In.

                      These settings include the following information:

                      • General settings for Siebel CRM Desktop, such as login information.

                      • In the Logging subkey, logging settings that Siebel CRM Desktop uses to tune logging behavior.

                      Siebel CRM Desktop registers COM classes in the Windows Registry when you install Siebel CRM Desktop. For more information about Windows Registry settings that Microsoft Windows requires to register COM classes, see the topic about Registering COM Applications at the Microsoft Developer Network Web site.

                      For more information, see Using the Windows Registry to Control Siebel CRM Desktop.

                        Changes That Siebel CRM Desktop Makes to Settings in IBM Notes

                        Siebel CRM Desktop adds the following items to the IBM Notes Personal Address Book (PAB) file, which is the local names.nsf file:

                        • Custom folders

                        • Custom views

                        • Custom objects

                        • Custom forms

                        • Custom Script libraries

                        • Custom agents

                        • Custom database script

                        • Custom image resources

                        Siebel CRM Desktop patches some of the existing views in the Personal Address Book and native forms in the Mail Database. It does this regardless if the database resides locally or on the Domino Server.

                        Siebel CRM Desktop runs as a IBM Notes add-in, so it must register with IBM Notes. For more information about registering a IBM Notes add-in, see the technical documentation at the IBM Notes web site at wwwsupport.ibm.com.

                        For more information, see How Siebel CRM Desktop Stores Siebel CRM Data.

                          Process of Installing the Siebel CRM Desktop Add-In

                          This process is a step in Roadmap for Installing Siebel CRM Desktop. You do the following work to install the Siebel CRM Desktop add-in:

                          1. Preparing Your Environment for Installation

                          2. Installing the Siebel CRM Desktop Add-In

                          For more information, see Options for Installing the Siebel CRM Desktop Add-In.

                            Preparing Your Environment for Installation

                            This task is a step in Process of Installing the Siebel CRM Desktop Add-In.

                            This topic describes how to make sure you configure the network and infrastructure to successfully install and start the Siebel CRM Desktop add-in.

                            To prepare your environment for installation

                            1. Choose your deployment software and review the conditions that apply for the installation.

                              For more information, see Overview of Installing the Siebel CRM Desktop Add-In.

                            2. Configure access permissions so that you can successfully install Siebel CRM Desktop.

                              For more information, see Configuring Access Permissions So That You Can Successfully Install Siebel CRM Desktop.

                            3. Make sure a direct connection to the Siebel Server is available.

                              Siebel CRM Desktop uses information from one of the following sources to connect to EAI (Enterprise Application Integration):

                            4. Make sure the EAI object manager on the Siebel Server is enabled and online.

                            5. Make sure only a single Position is defined for the user account.

                              The user cannot use IBM Notes to change the position. It is recommended that you use only a single Position for a given user account.

                            6. Make sure the customization package for the user position is published for only one of the user responsibilities.

                            7. Verify that the email address you use in the IBM Notes account in the location where you install Siebel CRM Desktop is the same as the email address for this employee record on the Siebel Server.

                            8. Make sure you uploaded and published the customization package on the Siebel Server.

                              For more information, see About the Customization Package.

                            9. Make sure the number of records for each type of Siebel object, such as accounts, is limited to an amount that the local Personal Address Book and Mail database can accommodate.

                              This amount depends on the following items:

                              • Size of the IBM Notes folder

                              • The IBM Notes version

                              • Where Siebel CRM Desktop stores the databases

                              • Connectivity

                              • Hard disk space on the client and on the computer

                              • Capabilities of the client computer

                              • And so on

                                It is recommended that you test these amounts in a test environment before you deploy Siebel CRM Desktop to all users. For more information, see Controlling the Number of Records That Synchronize.

                              Configuring Access Permissions So That You Can Successfully Install Siebel CRM Desktop

                              IBM Notes uses access permissions that allow the user to interact with the following items:

                              • Data. For example, email messages and contact records.

                              • Elements. For example, a field in the Email form or the Contact form. IBM Notes uses these elements to display data. You can use IBM Domino Designer to configure them.

                                You can configure IBM Notes to store the Mail database in the following locations. These locations can determine the access level that the user possesses to data and elements:

                              • Client. This Mail database might use POP3 or SMTP, so the user possesses administrator privileges to it.

                              • Domino Server. You can limit access to the Mail database according to the following roles:

                                • Administrator. User can interact with all elements. It is the highest level of user access.

                                • Designer. User can modify elements.

                                • Contributor. User can modify data. User can read but not modify elements. For example, the user can view and delete email data but cannot modify the Email form.

                                • Editor. The user can edit some data entries but cannot delete them. The user can only view elements.

                                • Reader. The user can only view data from the Mail database.

                              It is important that you configure your environment so the user can access the data and elements that they must interact with. For example, assume the following occurs:

                              • You configure Siebel CRM Desktop to store the Mail database on the Domino Server.

                              • You configure Siebel CRM Desktop to include a new, custom field on the Email form.

                              • A user who possesses the Reader, Contributor, or Editor access permission installs Siebel CRM Desktop. In this situation, the user cannot add the new, custom field to the Email form. If this user attempts to connect to the Mail database, then Siebel CRM Desktop displays an IBM Notes security error message.

                              Configuring Siebel CRM Desktop To Store Data and Elements

                              You must not configure Siebel CRM Desktop to store all elements only in the Personal Address Book or only in the Mail database. For example, Siebel CRM Desktop stores the Account form and the Opportunity form in the database that the Personal Address Book uses, and it stores the email form that displays email messages in the Mail database. It also stores email messages in the Mail database. You can configure Siebel CRM Desktop to store these items in various locations. For more information, see How Siebel CRM Desktop Stores Siebel CRM Data.

                                Installing the Siebel CRM Desktop Add-In

                                This topic describes how to manually install the Siebel CRM Desktop add-in.

                                To install the Siebel CRM Desktop add-in

                                1. Make sure requirements for the operating system are met.

                                  The CRMDesktopfor IBM Notes.msi installation package validates the operating system version and the IBM Notes version that is currently installed on the client computer. For more information, see Preparing the Implementation Environment for Siebel CRM Desktop.

                                2. Make sure IBM Notes is installed on the client computer and configured for use.

                                  If it is not, then an error occurs and Siebel CRM Desktop ends the installation.

                                3. Make sure you possess rights on the client computer so that you can run the executable file that Siebel CRM Desktop provides in the installation package.

                                4. Manually copy the CRMDesktopfor IBM Notes.msi file to the client computer.

                                  To use third-party deployment software to deploy the CRMDesktopfor IBM Notes.msi file to multiple users, see Installing Siebel CRM Desktop in the Background.

                                5. Locate the CRMDesktopfor IBM Notes.msi installation package on the client computer.

                                  The following directory is a typical location:

                                  C:\Documents And Settings\username\Desktop
                                  
                                6. Run the CRMDesktopfor IBM Notes.msi installer.

                                7. In the Welcome dialog box, click Next.

                                8. In the Customer Information dialog box, enter the user name and the organization.

                                9. Choose to install the add-in for one of the following, and then click Next:

                                  • Anyone Who Uses This Computer. Any user who logs on to this computer can use the Siebel CRM Desktop add-in.

                                  • Only For Me. Only the user who is logged on to the computer when Siebel CRM Desktop installs the Siebel CRM Desktop add-in can use this add-in.

                                10. In the Destination Folder dialog box, specify the folder where the installer must install Siebel CRM Desktop.

                                  You can specify any directory. For more information, see Setting the Installation Directory of the Siebel CRM Desktop Add-In.

                                11. In the Ready to Install the Program dialog box, click Install.

                                  You can install Siebel CRM Desktop for multiple users, so the user who is currently logged in can view the application files that it stores in the following default directory:

                                  c:\Documents and Settings\username1\Application Data\Oracle
                                  

                                  Siebel CRM Desktop stores the files for another user on this computer in the following directory:

                                  c:\Documents and Settings\username2\Application Data\Oracle
                                  

                                  How Siebel CRM Desktop Installs the Siebel CRM Desktop Location

                                  Siebel CRM Desktop displays a dialog box that allows the user to apply the Siebel CRM Desktop configuration to this IBM Notes location. It does this when IBM Notes runs for first time after you install the Siebel CRM Desktop add-in. The user can choose one of the following values:

                                  • Yes. Siebel CRM Desktop applies the configuration and then displays the First Run Assistant.

                                  • No. The Siebel CRM Desktop add-in closes. The dialog box that allows the user to apply the Siebel CRM Desktop configuration displays each time the user starts IBM Notes until the user chooses to apply this configuration.

                                    The following choice that you make in Step 9 in topic Installing the Siebel CRM Desktop Add-In determines if Siebel CRM Desktop applies this behavior:

                                    • Anyone Who Uses This Computer. This behavior applies to any user who logs on to this computer.

                                    • Only For Me. This behavior applies only to the user who is logged on to the computer when Siebel CRM Desktop installs the Siebel CRM Desktop add-in.

                                    Options for Installing the Siebel CRM Desktop Add-In

                                    This topic describes options that are available for installing the Siebel CRM Desktop add-in. It includes the following topics:

                                      Customizing the First Run Assistant

                                      This topic describes how to customize the First Run Assistant. It includes the following topics:

                                      The First Run Assistant is a wizard that guides the user through the first setup of the Siebel CRM Desktop add-in. Siebel CRM Desktop displays the CRM Desktop icon in the system tray and starts the First Run Assistant. It does this the first time the user starts IBM Notes after you install the Siebel CRM Desktop add-in. The user can begin using IBM Notes after the user finishes using this assistant.

                                      The First Run Assistant displays a dialog box at each step that allows the user to specify settings. This topic describes how you can customize the behavior of some of these dialog boxes. For more information, see Overview of How Siebel CRM Desktop Synchronizes Data.

                                        Customizing How First Run Assistant Uses the Customization Package

                                        The following table describes how you can customize the First Run Assistant to register and get the customization package. It lists work items in the order that the user performs them while the user uses this assistant. The user must install the Siebel CRM Desktop add-in first and then use the assistant. For more information, see Installing the Siebel CRM Desktop Add-In.

                                        Step Description Possible Customization

                                        1

                                        The user opens IBM Notes the first time after the Siebel CRM Desktop add-in is installed. It is the first time that IBM Notes is open after the add-in is installed, so First Run Assistant displays the welcome screen and then the user clicks it.

                                        Not applicable

                                        2

                                        Siebel CRM Desktop chooses the Use Internet Explorer Settings for Proxy-Server option, by default.

                                        The Manual Proxy-Server Configuration option allows the user to specify a proxy server. If your organization uses a proxy server, then you must provide the user with the following information:

                                        • The host name for the proxy server in the Server window.

                                        • The port number in the window that displays immediately next to the Server window.

                                        The proxy server requires a separate host name and a port number.

                                        For more information, see Customizing How Siebel CRM Desktop Connects to the Internet.

                                        3

                                        First Run Assistant displays the CRM Desktop-Login dialog box. The user enters the user name and password.

                                        This user name must include the First Name and Last Name or the User ID of the user record that resides in the Siebel database. The user can enter the First and Last name in any order.

                                        The USERID is the same user ID that the user uses for the Siebel Web Client. For example, Wasaka Takuda, or WTAKUDA.

                                        The password is the same password as the password that the user uses for the Siebel Web Client.

                                        For more information, see the following topics:

                                        4

                                        First Run Assistant automatically enters the URL that the Siebel Business Application uses to connect to the Siebel Server. It enters this URL in the Server URL window. For example:

                                        http://server_name/eai/enu

                                        You can specify the URL. For more information, see Setting the URL for the Siebel Server.

                                          Customizing How Siebel CRM Desktop Connects to the Internet

                                          You can customize how Siebel CRM Desktop connects to the Internet.

                                          To customize how Siebel CRM Desktop connects to the Internet
                                          1. Use an XML editor to open the platform_configuration.xml file.

                                            For more information, see Files in the Customization Package.

                                          2. Locate the platform section.

                                          3. Add the initialization_script section to the section that you located in Step 2:

                                            <platform>
                                              <initialization_script>
                                                <![CDATA[
                                                   application.settings.set("ProxyUsage", value);
                                                ]]>
                                              </initialization_script>
                                            </platform>
                                            

                                            where:

                                            • value is an integer. Use values from the following table.

                                              Value Description

                                              0

                                              Use the proxy server setting that is set in Internet Explorer.

                                              1

                                              Use a direct connection to the Internet. This option does not use a proxy server.

                                              2

                                              Use a manual proxy server configuration.

                                          4. Save and then close the platform_configuration.xml file.

                                          5. Test your work.

                                            Changing Behavior of the CRM Desktop-Login Dialog Box

                                            You can change the behavior of the CRM Desktop-Login dialog box. For information about authentication options, see Customizing Authentication.

                                            To change behavior of the CRM Desktop-Login dialog box
                                            • Hide the Save Password check box that Siebel CRM Desktop displays in the CRM Desktop-Login dialog box. You set the following Windows Registry key to 1:

                                              Siebel:HideSavePasswordOption
                                              

                                            If the user clicks Save Password in the CRM Desktop-Login dialog box, then Siebel CRM Desktop saves an encrypted copy of the password locally in the client computer. If you suppress display of the Save Password check box, then the user must enter the password every time the user logs into Siebel CRM Desktop. For more information, see Using the Windows Registry to Control Siebel CRM Desktop.

                                            • Prevent Siebel CRM Desktop from displaying the CRM Desktop-Login dialog box. You do the following:

                                              1. Set the following Windows Registry key to 1:

                                                SuppressLoginDialog
                                                
                                              2. Set the save_password parameter and the Login externally.

                                                If you do not set the save_password parameter, then Siebel CRM Desktop requires the user to enter the password every time the user opens IBM Notes and then synchronizes.

                                              For more information, see “How Siebel CRM Desktop Suppresses the Desktop-Login Dialog Box.”

                                            How Siebel CRM Desktop Suppresses the Desktop-Login Dialog Box

                                            If you suppress display of the Desktop-Login dialog box, then Siebel CRM Desktop does the following:

                                            • If the login, password, and URL connection parameters exist in the Windows Registry, and if save_password exists in the Windows Registry and is set to 1, then Siebel CRM Desktop attempts to validate the user credentials on the Siebel Server.

                                            • If the Siebel Server returns an error for this login, then Siebel CRM Desktop displays the Desktop-Login dialog box and allows the user to attempt to login or to cancel the login. If the Siebel Server cannot validate the login credentials, then it returns an error.

                                            • If a connection parameter is not present in the Windows Registry, or if save_password does not exist in the Windows Registry, or if it is set to 0, then the Siebel Server returns a Credentials Verification Failed error.

                                              Customizing How the First Run Assistant Performs the Initial Synchronization

                                              Siebel CRM Desktop applies custom design elements, as described in the table in the topic Customizing How First Run Assistant Uses the Customization Package, and then displays the second part of the First Run Assistant. It prompts the user to set preferences and to run the first synchronization session that downloads Siebel CRM records to IBM Notes.The following table describes the work that you can do to customize how the assistant does this initial synchronization. It lists work items in the order that the user does them while the user runs the assistant.

                                              Step Description Administrative Work

                                              1

                                              First Run Assistant applies custom design elements. It then displays the following choices in the Filter Records tab of the Synchronization Control Panel dialog box:

                                              • Leave the filters at their default settings.

                                              • Choose a filter from the predefined filter that Siebel CRM Desktop deploys with the Siebel CRM Desktop add-in.

                                              • Specify filter settings.

                                              The user can also specify the synchronization frequency and other settings that Siebel CRM Desktop uses.

                                              For more information, see the following topics:

                                              2

                                              The First Run Assistant displays a dialog box that allows the user to configure synchronization settings. Siebel CRM Desktop does the following, by default:

                                              • Enters a check mark in the Schedule for the Automatic Synchronization Interval check box

                                              • Enters a check mark in the Show Progress During Automatic Synchronization check box

                                              • Sets the frequency slide bar to Once an Hour

                                              For more information, see Controlling the Synchronization Intervals That Display in the Synchronization Tab.

                                              3

                                              The First Run Assistant displays a dialog box that allows the user to share with Siebel CRM Desktop each new native IBM Notes calendar entry, contact, or To Do item that the user creates in IBM Notes. Siebel CRM Desktop includes a check mark in the Calendar Entry, Contacts, and To Do items check boxes, by default.

                                              For more information, see Customizing How Siebel CRM Desktop Shares Native IBM Notes Items

                                              4

                                              The First Run Assistant displays the Siebel CRM Desktop dialog box. For more information, see Customizing How Siebel CRM Desktop Shares Native IBM Notes Items.

                                              For more information, see Controlling How Siebel CRM Desktop Assigns Calendar Entry Owners.

                                              The user finishes specifying the configuration settings, and then Siebel CRM Desktop automatically starts the synchronization and adds content to the Siebel CRM folders. This content depends on choices the user specifies in the First Run Assistant. The synchronization finishes, and then the user can find the Siebel CRM data that Siebel CRM Desktop downloaded in the corresponding Siebel CRM folders. The user can view Siebel contacts that Siebel CRM Desktop downloaded to the IBM Notes Contacts folders. Siebel CRM Desktop does not automatically share contacts that existed in IBM Notes before you installed Siebel CRM Desktop.

                                                Customizing How Siebel CRM Desktop Shares Native IBM Notes Items

                                                You can customize Siebel CRM Desktop to share or not share any new native IBM Notes items that the user creates in IBM Notes, such as a IBM Notes calendar entry, contact, or To Do item.

                                                To customize how Siebel CRM Desktopshares native IBM Notes items
                                                1. Use an XML editor to open the platform_configuration.xml.

                                                  For more information, see Files in the Customization Package.

                                                2. Locate the platform section.

                                                3. Add the following initialization_script section to the section that you located in Step 2:

                                                  <platform>
                                                    <initialization_script>
                                                      <![CDATA[
                                                         application.settings.set("SharedByDefault:NewItems", value);
                                                      ]]>
                                                    </initialization_script>
                                                  </platform>
                                                  

                                                  where:

                                                  • value is an integer. Use values from the following table.

                                                    Value Description

                                                    0

                                                    Do not share IBM Notes item.

                                                    1

                                                    Share IBM Notes item.

                                                4. Save and then close the platform_configuration.xml file.

                                                5. Test your work.

                                                Sharing a Calendar Entry, Contact, or To Do Item

                                                The user can determine how Siebel CRM Desktop shares records with the Siebel Server according to the following settings:

                                                • Set default sharing for all new records. The user can use the Advanced tab of the CRM Desktop - Options dialog box to change how Siebel CRM Desktop creates a new IBM Notes calendar entry, contact, or To Do item as shared or not shared.

                                                • Set sharing for individual records. The user can click the Sharing Bar that Siebel CRM Desktop displays at the start of a record form to share or unshare a single record.

                                                  Suppressing the Dialog Boxes That First Run Assistant Displays

                                                  This topic describes how to suppress the dialog boxes that First Run Assistant displays.

                                                  To suppress the dialog boxes that First Run Assistant displays
                                                  1. Use a JavaScript editor to open the application_script.js file.

                                                  2. Modify the following code:

                                                    var fra = application.fra; 
                                                    function fra_handler(fra) 
                                                    {
                                                      var current_form = null; 
                                                      var on_closed = function()
                                                      {
                                                        current_form = null;
                                                        fra.exit_current_step(false);
                                                      } 
                                                      function on_fra_step(id)
                                                      {
                                                        if (id == "advanced")
                                                        {
                                                          var xml = ui.get_dialog_xml("PropSheetHost");
                                                          xml = helpers.replace_all
                                                          ("$prop_sheet_layout", "options_advanced_page", xml);
                                                          current_form = ui.create_dialog_from_xml(0, xml);
                                                          current_form.on_closed.connect(on_closed)
                                                          current_form.visible = true;
                                                        }
                                                      }
                                                      fra.on_step.connect(on_fra_step);
                                                      fra.add_builtin_step("welcome");
                                                      fra.add_builtin_step("sync_filters");
                                                      fra.add_builtin_step("sync_schedule");
                                                      fra.add_step("advanced", session.res_string("sa-advanced_settings-caption"), 
                                                    session.res_string("sa-advanced_settings-description"), "sa-advanced_settings-
                                                    picture", true);
                                                      fra.add_builtin_step("convert_items");
                                                      fra.add_builtin_step("first_sync");
                                                    }
                                                      function create_fra_handler(fra)
                                                    {
                                                    return fra != null ? new fra_handler(fra) : null;
                                                    }
                                                    var g_fra_handler = create_fra_handler(application.fra); 
                                                    

                                                  where:

                                                  • bold indicates code you can modify, as described in the following table.

                                                  The following table describes the code that you can modify to suppress the dialog boxes that First Run Assistant displays.

                                                  Default Code Description
                                                  fra.add_builtin_step("welcome");
                                                  

                                                  This code displays the Welcome dialog box. It is recommended that you do not remove it.

                                                  fra.add_builtin_step("sync_filters
                                                  ");
                                                  

                                                  This code displays the default synchronization filters. You can remove this code to hide these filters.

                                                  fra.add_builtin_step("sync_schedul
                                                  e");
                                                  

                                                  This code displays the default synchronization schedule. You can remove this code to hide this schedule.

                                                  fra.add_step("advanced", 
                                                  session.res_string("sa-
                                                  advanced_settings-caption"), 
                                                  session.res_string("sa-
                                                  advanced_settings-description"), 
                                                  "sa-advanced_settings-picture", 
                                                  true);
                                                  

                                                  This code displays the default advanced settings. You can remove this code to hide the advanced settings.

                                                  fra.add_builtin_step("convert_item
                                                  s");
                                                  

                                                  This code displays the native contacts conversion. You can remove this code to hide the native contacts conversion.

                                                  fra.add_builtin_step("first_sync")
                                                  ;
                                                  

                                                  This code displays the first synchronization step, It is required. Almost no Siebel CRM Desktop functionality is available before the first synchronization. You must not remove this code.

                                                    Installing Siebel CRM Desktop in the Background

                                                    This topic describes how to install Siebel CRM Desktop in the background.

                                                      Using Microsoft System Center Configuration Manager to Install Siebel CRM Desktop

                                                      This topic describes how to use Microsoft System Center Configuration Manager to install Siebel CRM Desktop. For more information, see the documentation about using System Center Configuration Manager at the Microsoft TechNet Web site.

                                                      To use Microsoft System Center Configuration Manager to install Siebel CRM Desktop
                                                      1. Log on to the computer that includes System Center Configuration Manager, and then Open Microsoft System Center Configuration Manager 2007 or Microsoft Systems Management Server 2003.

                                                      2. Add all custom properties to the Windows Installer transform (.mst) file.

                                                        For more information, see: Adding Custom Properties to the Windows Installer Transform File.

                                                      3. Run the installer. Open a Windows command line and then enter the following command:

                                                        msiexec /I "CRMDesktopfor IBM Notes.msi" TRANSFORMS="crmdesktop.mst" ALLUSERS=1 
                                                        /qb!
                                                        

                                                        where:

                                                      • ALLUSERS=1 is an optional parameter. To install Siebel CRM Desktop for anyone who uses the client computer, you must include the ALLUSERS parameter.

                                                      Use the following guidelines:

                                                      • Run setup with one of the following administrative rights:

                                                        • Administrative rights. Installs Siebel CRM Desktop for anyone who uses the client computer.

                                                        • User rights. Installs Siebel CRM Desktop only for the person who is currently logged into Windows on the client computer. Make sure this user possesses the permissions that Windows requires to run the installer.

                                                      Adding Custom Properties to the Windows Installer Transform File

                                                      You must add all custom properties to the Windows Installer transform (.mst) file. A custom property is any property that MSDN (Microsoft Developer Network Platforms) does not describe. For example, SIEBEL_SERVER_PROTOCOL and SIEBEL_SERVER_PORT are custom properties. For a complete list of the custom properties you must add, see Setting the URL for the Siebel Server.

                                                        Using a Windows Group Policy to Install Siebel CRM Desktop

                                                        This topic describes how to use a Windows group policy to install Siebel CRM Desktop for each user. It includes an optional step that describes how to install it for anyone who uses the client computer. For more information, see the documentation about using group policies at the Microsoft TechNet Web site.

                                                        To use a Windows group policy to install Siebel CRM Desktop
                                                        1. Log on to the computer that includes your group policy manager.

                                                        2. Make sure the directory that stores the installer and the .mst file is available on the local network.

                                                        3. Open the Microsoft Group Policy Editor.

                                                        4. Create an installation package in the GPO snap-in in the following branch:

                                                          Computer Configuration - > Software Settings - > Software installation
                                                          
                                                        5. Set the Deployment type to Assigned.

                                                        6. Create a Windows Installer transform .mst file.

                                                        7. Add the path to the Windows Installer .mst transform file.

                                                        8. Add all custom properties to the transform file.

                                                          You cannot use the command line with a group policy object (GPO). You must specify all properties in the .mst file. For more information, see “Adding Custom Properties to the Windows Installer Transform File” in the topic Using Microsoft System Center Configuration Manager to Install Siebel CRM Desktop.

                                                        9. (Optional) To install Siebel CRM Desktop for anyone who uses the client computer, do the following:

                                                          1. Set the ALLUSERS property to 1 in the Property table. You set this property in the transform file that you create in Step 6.

                                                          2. Make sure each Siebel CRM Desktop user possesses the permissions to run this msi package.

                                                            An administrator might disallow the parameter that provides these permissions. If the user does not possess these permissions, then Siebel CRM Desktop does not run the installation when it creates the IBM Notes location.

                                                          Using the Windows Command Line to Set Optional Parameters

                                                          You can use the Windows command line to set optional parameters that affect installation. You can run the CRMDesktopfor IBM Notes.msi installation package from the Windows command line interface on the client computer. Siebel CRM Desktop supports all parameters that you can set in the Windows Installer msiexec command line. For more information, see the documentation about command line options for Windows Installer at the Microsoft TechNet Web site.

                                                          To use the Windows command line to set optional parameters

                                                          1. On the client computer, open a Windows command line:

                                                            1. In Windows, click Start and then click Run.

                                                            2. In the Run dialog box, enter cmd and then click OK.

                                                          2. Navigate to the directory that contains the CRMDesktopfor IBM Notes.msi file.

                                                            For example:

                                                            C:\Documents and Settings\username\Desktop
                                                            
                                                          3. Enter the Windows Installer command using the following format:

                                                            msiexec.exe /I CRMDesktopfor IBM Notes.msi optional_parameter_1 
                                                            optional_parameter_n
                                                            

                                                            where:

                                                            • optional_parameter is a parameter you can enter that Siebel CRM Desktop runs. For example:

                                                              msiexec /i "C:\Documents and Settings\username\Desktop\"CRMDesktopfor IBM 
                                                              Notes.msi" SIEBEL_SERVER_HOST="siebelserver.com" SIEBEL_SERVER_PORT="80" 
                                                              SIEBEL_SERVER_SUFFIX="SWEExtSource=WebService&SWEExtCmd=Execute&WSSOAP=1" 
                                                              SIEBEL_SERVER_PROTOCOL="http" SIEBEL_SERVER_COMPONENT="eai/enu" 
                                                              
                                                            • (Optional) Add the following optional parameter to enable the SOAP log:

                                                              SOAP_DUMP_ENABLED=1 
                                                              
                                                            • (Optional) Add the following optional parameter to enable the SYNC log:

                                                              SYNC_DUMP_ENABLED=1 
                                                              

                                                            For more information, see Guidelines for Using Synchronization Log Parameters

                                                            Note the following requirements:

                                                            • You must specify each optional parameter in the same command line after the name of the CRMDesktopfor IBM Notes.msi file.

                                                            • To separate each optional parameter, you must enter a space without a slash (/).

                                                            • You can arrange optional parameters in any order.

                                                            For information about how to set Siebel CRM Desktop SSO parameters, see Using the Windows Command Line to Set Optional Parameters for Siebel CRM SSO.

                                                          4. Press Enter.

                                                            The welcome dialog box of the Siebel CRM Desktop Setup wizard displays.

                                                            Guidelines for Using Synchronization Log Parameters

                                                            A synchronization log includes the following parameters. These parameters measure the average percentage of CPU load time that Siebel CRM Desktop uses during synchronization:

                                                            • kernel_cpu. Measures the entire system.

                                                            • process_cpu. Measures the process that runs Siebel CRM Desktop.

                                                            It is recommended that you do not use these parameters to debug Siebel CRM Desktop. Instead, it is recommended that you use other tools to measure CPU load time, such as the Process Explorer system utilities for Windows or the Windows Task Manager. Using these parameters consumes resources and might degrade performance.

                                                              Hiding Dialog Boxes That Require User Input

                                                              You can use the optional QR parameter to hide dialog boxes that require user input.

                                                              To hide dialog boxes that require user input
                                                              • Append the QR parameter to the msiexec command.

                                                                For example:

                                                                msiexec.exe /I CRMDesktopfor IBM Notes.msi INSTALLDIR=c:\My_Custom_Directory/QR
                                                                

                                                                If you add this parameter, then the CRMDesktopfor IBM Notes.msi installation package does not display dialog boxes that require user input.

                                                                Setting the Installation Directory of the Siebel CRM Desktop Add-In

                                                                You can use the optional INSTALLDIR parameter to change the default location where the CRMDesktopfor IBM Notes.msi installation package saves files during installation for a single user. CRMDesktopfor IBM Notes.msi installs to the following directory, by default:

                                                                c:\Documents and Settings\username\Application Data\Oracle\CRM Desktopfor IBM 
                                                                Notes\
                                                                
                                                                To set the installation directory of the Siebel CRM Desktop add-in
                                                                • Enter the following parameter on the msiexec command line anywhere after the mandatory CRMDesktopfor IBM Notes.msi name parameter:

                                                                  INSTALLDIR=directory_path
                                                                  

                                                                  For example:

                                                                  \Documents and Settings\username\Desktop\CCRMDesktopfor IBM Notes.msi
                                                                  

                                                                  where:

                                                                • user name is the name of the user, such as WTAKUDA.

                                                                  Setting the URL for the Siebel Server

                                                                  You can specify the URL that the Synchronization Engine uses to connect with the Siebel Server.

                                                                  To set the URL for the Siebel Server
                                                                  • Enter the following parameters on the msiexec command line anywhere after the mandatory CRMDesktopfor IBM Notes.msi name parameter:

                                                                  SIEBEL_SERVER_PROTOCOL=protocol SIEBEL_SERVER_HOST=host_name_or_address 
                                                                  SIEBEL_SERVER_PORT=server_port SIEBEL_SERVER_COMPONENT=component_name 
                                                                  SIEBEL_SERVER_SUFFIX=request_suffix
                                                                  

                                                                  where:

                                                                  • protocol is http. HTTP is the default value.

                                                                  • host_name_or_address is the computer name or IP address of the target server. This parameter is empty, by default. To use a fully qualified domain name for the server_address variable, you must set the EnableFQDN parameter in the configuration (cfg) file. For more information, see Siebel System Administration Guide.

                                                                  • server_port is 80. 80 is the default value.

                                                                  • component_name is eai/enu. eai/enu is the default value.

                                                                  • request_suffix is the following default value:

                                                                    ?SWEExtSource=WebService&SWEExtCmd=Execute&WSSOAP=1
                                                                    

                                                                    For example:

                                                                    msiexec.exe /I CRMDesktopfor IBM Notes.msi SIEBEL_SERVER_PROTOCOL=http 
                                                                    SIEBEL_SERVER_HOST=sdcv440s133.siebel.com SIEBEL_SERVER_PORT=80 
                                                                    SIEBEL_SERVER_COMPONENT=eai/enu SIEBEL_SERVER_SUFFIX= 
                                                                    SWEExtSource=WebService&SWEExtCmd=Execute&WSSOAP=1
                                                                    

                                                                    No parameters are required.

                                                                  Any information that you set in these parameters sets the parameter values in the Windows Registry, so the user is not required to set them. For example, the protocol variable of the SIEBEL_SERVER_PROTOCOL parameter overrides the Siebel:Protocol entry in the Windows Registry. For more information, see Using the Windows Registry to Control Siebel CRM Desktop .

                                                                    Troubleshooting Siebel CRM Desktop Installation

                                                                    Siebel CRM Desktop might display a message during installation that is similar to one of the following error messages:

                                                                    The System cannot open the device or file specified
                                                                    
                                                                    Error 2755.Server returned unexpected error 110 attempting to install package
                                                                    

                                                                    This problem might be due to the fact that the CRMDesktopfor IBM Notes.msi file is encrypted or is located in a directory where the user does not possess run permissions.

                                                                    To troubleshoot Siebel CRM Desktop installation
                                                                    1. Open Windows Explorer.

                                                                    2. Right-click the .msi installation file and then click Properties.

                                                                    3. In the General tab, click Advanced.

                                                                    4. Make sure the following option does not contain a check mark and then click OK.

                                                                      Encrypt contents to secure data

                                                                    5. Reinstall Siebel CRM Desktop.