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 entire 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 of this product and patch 18104838, then you must repeat steps 8, 12, 13, 18, 19 and 30-35 for the current solution to overwrite the scripts.

Prerequisites to implement and test help integration in Siebel:

1. Siebel Tools must be installed and configured.
    
2. Siebel Web Client must be installed with remote access configured on the developer machine.
    
3. A URL where the Player content will be deployed. This is needed for the menu item to launch the Player content.
    
4. To complete the Siebel server customization steps, the content of the siebel7\agent directory is needed from the Developer installation folder or the content of the patchfiles\Content\ClientOnly\siebel7\agent directory on the media pack of your latest ESP. This directory is referenced below as <Siebel agent directory>.
    
5. Before functional testing of the help integration implementation, the Player should be deployed to the web server.

If the deployed URL of the Player is known you can add the UPKContentURL property in Siebel preferences.

To set the UPKContentURL property in Siebel System Preferences:

1. In the Siebel application, navigate to Site Map.
    
2. Select Administration - Application.
    
3. Select System Preferences.
    
4. Add a new record named UPKContentURL and set the value to the Player content URL. Be sure that the URL ends in a slash character.

The menu item is created using a Siebel server Business Service and should be applied to the Siebel server.

To add the User Productivity Kit menu item to the Help menu:

1. Open Siebel Tools and login as a developer.
    
2. Navigate to the Project object type in Siebel Tools.
    
3. Create a new project named UPK and lock it.
    
4. In the Object Explorer, select the Business Service type.
    
5. In the Business Services list create a new record with the Name property value of UPKService and the Project property value of UPK.
    
6. In the Object Explorer, expand the Business Service type and select the Business Service Method type.
    
7. In the Business Service Method list, create a new record with the Name property value of UPKServiceMethod.
    
8. In the Business Service Method list, create another new record with the Name property value of GetUPKContentURL.
    
9. In the Object Explorer, select the Business Service type.
    
10. Right-click the UPKService business service and select Edit Server Scripts.
     
11. When prompted, set the script type to Siebel eScript.
     
    Note: This step is optional and may not appear.
     
12. Replace the Service_PreCanInvokeMethod function. Copy the code from  <Siebel agent directory>\step12.txt.
     
13. Replace the Service_PreInvokeMethod function. Copy the code from <Siebel agent directory>\step13.txt.
     
14. Save the changes.
     
15. Close the window.
     
16. In the Object Explorer, select the Business Service type.
     
17. Right-click the UPKService business service and select Edit Browser Scripts.
     
18. Replace the Service_PreInvokeMethod function. Copy the code from <Siebel agent directory>\step18.txt.
     
19. Add the required code to the general/declarations section. Copy the code from <Siebel agent directory>\step19.txt.
     
20. Save the changes.
     
21. Close the window.
     
22. Navigate to the Command object type in Siebel Tools.
     
23. In the Commands list, create a new record with the following property values:
     
    Name: UPK Command
    Project: UPK
    Business Service: UPKService
    Target: Browser
    Method: UPKServiceMethod
     
24. In the Object Explorer, select the Menu object type, then select Generic WEB from the Menus list.
     
25. Check out or lock the menu if necessary.
     
26. In the Object Explorer, expand the Menu type and select the Menu Item type.
     
27. In the Menu Items list, create a new record with the following property values:
     
    Name: Help - UPK Sep
    Position: 7.199
     
    Note: The position of the menu item can be different. This step creates a separator line only.
     
28. Create another record with the following property values:
     
    Name: Help - UPK
    Caption-String Override: User Productivity Kit
    Position: 7.200
    Command: UPKCommand
     
29. Now the UPKService business service needs to be enabled to run on the clients for the affected application(s).
     
30. Navigate to the Application object type in Siebel Tools.
     
31. Query for the application, for example Siebel Sales Enterprise.
     
32. Check out or lock the affected project(s), if necessary.
     
33. In the Object Explorer, expand the Application type and select the Application User Prop type.
     
34. In the Application User Props list, create a new record with the following property values:
     
    Name: ClientBusinessServiceN, where N is a sequential number. Check all other ClientBusinessService entries and choose an unused value for N.
    Value: UPKService
     
35. Compile the Menu, UPK  and all other locked projects.
     
36. Test and verify the changes in the local environment.
     
37. Check in the Menu, UPK  and all other locked projects to the server.

After the previous steps are applied a new menu item called User Productivity Kit should appear in the Help menu on your Siebel user interface. You can test if 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 for the screens.

Language Segmentation

If you need a solution for multiple languages, then compile and deploy the server changes for each desired language and optionally configure content segmentation in the main Player to which the UPKContentURL refers.

To configure content language segmentation:

1. In the Developer, create and IASConfiguration document.
    
2. In the Sources section, click Select outline and select the outline with the content you created for Siebel. In the Caption field, enter a title to show on the tab or link.
    
   Note: If you choose Web Server as the deployment type, you must specify the URL where you deploy the content.
    
3. In the Application Instances section, in the Type list choose Siebel CRM (On Premise) with HINT Agent and select the Configure Help Integration option.
    
4. Select the source you defined in step 2 as the Default Player.
    
5. Optional: If you are configuring help integration for more than one language, click the add new button under Segment Players for each language and specify the appropriate language code.
    
6. Save the IAS configuration document.

After the configuration is completed, the Player should be published and re-deployed to the web server.

Troubleshooting

If the users see the following messages when they click the menu item in the Siebel application:

• Cannot get service: UPKService.(SBL-UIF-00275)
  The reason is that steps 30 - 35 were not applied to the current Siebel instance.
   
• UPKService: UPKContentURL is not available!
  The reason is that the UPKContentURL property is missing from the System Preferences, or steps 30 - 35 were not applied to the current Siebel instance.

Table of Contents  Back