The following are guidelines for a Siebel Administrator to introduce a new menu item in Siebel Applications for the users to launch the Player in a context-sensitive manner. The recommended method is to ensure that the solution works as desired in a test environment, and then apply the changes to the production environment.
Important Upgrade Note: If you have already implemented this feature using version 11.1.0.2 and patch 18104838 of this product, then you must repeat all the steps in this section for the current solution to overwrite the scripts. Also, the siebel7_ias_agent.html and siebel7_ias_agent.js files should be removed from the Siebel server as they are no longer needed.
Prerequisites to implement and test help integration in Siebel:
Siebel Tools must be installed and configured.
Siebel Web Client is installed with remote access configured on the developer machine.
A URL where the Player content will be deployed. This is needed for the menu item to launch the Player content.
To complete the Siebel server customization steps, the content of the siebel7\agent directory is needed from the Developer installation folder. This directory is referenced below as <Siebel scripts directory>.
Before functional testing of the help integration implementation, the Player should be deployed to the web server.
To add the UPKContentURL property in the Siebel Web Client:
Select Administration - Application in the Site Map.
Select System Preferences.
Add a new record named UPKContentURL and set the value to the Player content URL. Be sure that the URL ends with a slash character.
To add the service initialization in the Siebel Web Client:
Select Administration - Runtime Events in the Site Map.
Select the Action Sets tab of the Runtime Events administration page.
Click New to add a new action set and set the name to UPK-Init.
Scroll down to the action set records and add a new record with the following properties:
The menu item is created using a Siebel server Business Service and should be applied to the Siebel server.
To add the In-Application Support menu item to the Help menu:
Open Siebel Tools and login as a developer.
Select menu View/Options...
Select the Object Explorer tab in the Development Tools Options dialog.
Ensure Command and Menu items are selected in the Object Explorer Hierarchy.
Click OK to save the options.
Select the Project tree item in the Object Explorer's Types panel.
Add a new record to the project list using the Edit/New Record menu.
Type UPK in the Project’s Namecolumn; ensure the Locked column is checked.
Select Business Service in the Object Explorer panel.
Add a new record to business services list using the Edit/New Record menu.
Type UPKService in the Business Services' Namecolumn; set the Project to UPK.
Open the Business Service tree item in the Object Explorer's Types panel.
Select the Business Service Method item.
Add a new record to the business service methods using the Edit/New Record menu.
Type UPKServiceInit to the Business Service Method’s Name column.
Add a new record to the business service methods using the Edit/New Record menu.
Type UPKServiceMethod to the Business Service Method’s Name column.
Right click on UPKService row header in the business services list.
Select the Edit Server Scripts menu.
Select the File/Import menu and browse for the <Siebel scripts directory>.
Select UPKService_ServerScript.js and click Open.
Click the Save toolbar button.
Right click on UPKService row header in the business services list.
Select the Edit Browser Scripts menu.
Select the File/Import menu and browse for the <Siebel scripts directory>.
Select UPKService_BrowserScript.js and click Open.
Click the Save toolbar button.
Select File/New Object menu.
Select Command in the New Object Wizards dialog.
Set command’s associated project to UPK.
Type UPKCommand to the command name.
Ensure the Browser is selected to handle the command; click Next.
Select the Business Service option.
Select UPKService in the business services list.
Enter UPKServiceMethod in the Method to be invoked field; click Next.
Unselect Execute this command in a new window option; click Next.
Click Finish.
Select the Menu tree item in the Object Explorer's Types panel.
Select the Generic WEB Menu project row in the Menus list.
Ensure Object Locked column is checked for the selected row.
Open the Menu tree item in the Object Explorer's Types panel.
Select the Menu Item item.
Add a new record to the menu items list using the Edit/New Record menu.
Type Help -UPK Sep in the Name column; set the Position to 7.199.
Add a new record to the menu items list using the Edit/New Record menu.
Type Help – UPK in the Name column; set Caption - String Override to any name at your choice to displayed, for example: In-Application Support, Help or Learn; set Position to 7.200; set Command to UPKServiceMethod.
Navigate to the next record to save the changes.
The UPKService service must be added to the application.
Select menu View/Options...
Select the Object Explorer tab in the Development Tools Options dialog.
Ensure Application item is selected in the Object Explorer Hierarchy.
Expand Application item and ensure that Application User Prop item is selected in the Object Explorer Hierarchy.
Click OK to save the options.
Follow the steps below for all required applications.
Select the Application tree item in the Object Explorer's Types panel.
Select the required application like Siebel Sales Enterprise for Siebel Sales or Siebel Universal Agent for Siebel Call Center, etc.
Ensure the Locked column is checked for the selected application.
Expand the Application tree item.
Select the Application User Prop item.
Notice the ClientBusinessServiceX entries in the Name column.
Add a new record to the application user props using the Edit/New Record menu.
Type ClientBusinessServiceZ in the Application User Prop’s Name column, where Z is X+1, where X is the largest number among the ClientBusinessService entries’ end.
Type UPKService in the Value column.
Step off the record to Save it.
Test and verify the changes in the local environment.
Check in the menu, UPK and all other locked projects to the server.
After the previous steps are applied a new menu item called In-Application Support should appear in the Siebel Help menu. You can test whether the menu item is functional by selecting it and verifying the URL that opens. If the Player content is already deployed to the location specified by UPKContentURL, then you can also check that the applicable topics are shown.
Language Segmentation
If you need a solution for multiple languages, then compile and deploy the server changes for each language and configure content segmentation in the main Player to which the UPKContentURL refers. See Configure Content for more information.
Troubleshooting
The following message can appear when the user is logged into Siebel Web Client:
Unable to create the Business Service 'UPKService'(SBL-DAT-00227)
The solution must be compiled and deployed to the current Seibel language.
The following message can appear when a user activates the new menu item in the Siebel application:
UPKService: UPKContentURL is not available!
The message appears when the UPKContentURL property is missing from System Preferences.
To add the UPKContentURL property in the Siebel Web Client: