|
Siebel CRM Desktop for IBM Notes Administration Guide > Installing Siebel CRM Desktop > Options for Installing the CRM Desktop Add-In >
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 CRM Desktop add-in. 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 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
Table 5 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 CRM Desktop add-in first and then use the assistant. For more information, see Installing the CRM Desktop Add-In.
Table 5. How First Run Assistant Registers and Gets the Customization Package
|
|
|
1 |
The user opens IBM Notes the first time after the 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 |
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 to the right of 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
- Use an XML editor to open the platform_configuration.xml file.
For more information, see Files in the Customization Package.
- Locate the platform section.
- 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.
|
|
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. |
- Save and then close the platform_configuration.xml file.
- 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 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 CRM Desktop. For more information, see Using the Windows Registry to Control Siebel CRM Desktop.
- Prevent CRM Desktop from displaying the CRM Desktop-Login dialog box. You do the following:
- Set the following Windows Registry key to 1:
SuppressLoginDialog
- Set the save_password parameter and the Login externally.
If you do not set the save_password parameter, then 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 CRM Desktop attempts to validate the user credentials on the Siebel Server.
- If the Siebel Server returns an error for this login, then 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 Table 5, 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. Table 6 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.
Table 6. How First Run Assistant Performs the Initial Synchronization
|
|
|
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:
|
For more information, see the following topics:
|
2 |
The First Run Assistant displays a dialog box that allows the user to configure synchronization settings. 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 CRM Desktop each new native IBM Notes calendar entry, contact, or To Do item that the user creates in IBM Notes. 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 Sharing a Calendar Entry, Contact, or To Do Item. |
For more information, see Controlling How Siebel CRM Desktop Assigns Calendar Entry Owners. |
The user finishes specifying the configuration settings, and then 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 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. CRM Desktop does not automatically share contacts that existed in IBM Notes before you installed 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 Desktop shares native IBM Notes items
- Use an XML editor to open the platform_configuration.xml.
For more information, see Files in the Customization Package.
- Locate the platform section.
- 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.
|
|
0 |
Do not share IBM Notes item. |
1 |
Share IBM Notes item. |
- Save and then close the platform_configuration.xml file.
- 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 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
- Use a JavaScript editor to open the application_script.js file.
- 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 Table 7.
Table 7 describes the code that you can modify to suppress the dialog boxes that First Run Assistant displays.
Table 7. Code That Displays the Dialog Boxes That First Run Assistant Displays
|
|
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_schedule");
|
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_items");
|
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 CRM Desktop functionality is available before the first synchronization. You must not remove this code. |
|
