Context-Sensitive Help for Siebel

Context-Sensitive Help allows you to provide end users with quick and convenient access to help via an online performance support system. End users request help from the Server via a direct link in Siebel. To implement and use Context-Sensitive Help for Siebel you will perform three procedures:

• Create a custom help menu in Siebel.
• Record a Siebel document with the application and make this document available for Context-Sensitive Help.
• Request help from Siebel. For information on supported versions of Siebel, refer to the Technical Specifications.

Obtaining the Siebel Custom Menu eScripts

Download the Siebel Custom Menu eScripts from the Intelligence Hub. The following scripts were authored by ANCILE for use only by customers and partners. These scripts contain JavaScript code that redirects Siebel's existing Help link to a help page created with the application.

1. uPerform_Service_PreCanInvokeMethod_Server.txt
2. uPerform_ServicePreInvokeMethod_Browser.txt

Creating a Custom Menu In Siebel

1. Create a new project to house changes needed to add a Context-Sensitive Help link from Siebel to the website. Be sure to include a name and description for the project.
2. Check out the Context-Sensitive Help project.
3. Check out the menu used in the target application.
4. Create a new symbolic string for the menu item using the following values:

   NOTE:

   A symbolic string must be created for each locale.

   Field	Description
   Name	Enter a name for the symbolic string.
   Current String Value	Enter the string value.
   Project	Enter the project name created in Step 1.
   Definition	Enter a definition.
   Comment	Enter any amplifying information about the string.

5. Save the string.
6. Create a new business service using the following values:

   Field	Description
   Name	Enter a name for the service.
   Project	Enter the project name created in Step 1.
   Class	Enter the class.
   Comment	Enter any amplifying information about the service.

7. Save the service.
8. Create a new Business Service Method called Uperform.
9. Right-click on the business service you created in Step 6.
10. Select Edit Server Scripts.
11. Select eScript.
12. Paste the provided script into the Service_PreCanInvokeMethod method.
13. Save the server script.
14. Right-click on the business service you created in Step 6.
15. Select Edit Browser Scripts.
16. Select eScript.
17. Paste the provided script into the Server_PreInvoke method.
18. Replace [Server Name] with the URL of the redirect.html page on the website.
19. Save the browser script.
20. Using Siebel Tools, create a new command using the following values:

    Field	Description
    Name	Enter a name for the command.
    Project	Enter the project name you created in Step 1.
    Business Service	Enter the business service you created in Step 6.
    Display Name	Enter a display name for the command.
    Show Pop-up	Ensure the Show Pop-up box is selected.

21. Save the command.
22. Create a new menu item for the menu project using the following values:

    Field	Description
    Name	Enter a name for the menu item.
    Caption	Enter the string reference created in Step 4.
    Command	Enter the command created in Step 20.
    Position	Select the appropriate position.

23. Save the menu project.
24. Compile, test, and migrate the changes to the production environment.

Publishing the Website

The website must be published to a web server that is accessible by Siebel before authors can record documents. As part of website publishing, you will also generate quick launch pages to enable communication between the website and Siebel.

For information on publishing the website, refer to Publishing the Website.

For information on supported versions of Siebel, refer to the Technical Specifications.

Recording and Publishing a Siebel Document

1. Record a Siebel document using the procedures described in Recording Procedural Content.

   NOTE:

   The recorder will automatically gather the view names for each screen as the author records the document and hard code the names into the document meta data.

2. Edit the document using the procedures described in Editing and Formatting: Basics and Editing and Formatting: Procedural Content.
3. Publish the document to the website using the procedures described in Building a Website.
4. Republish the website using the procedures described in Publishing the Website.

Requesting Help From Siebel

1. Log into Siebel as an end user.
2. Navigate to the desired screen.
3. Select Help > [Help Name].

   NOTE:

   The help name is specified when you create the help menu option. For more information, refer to Creating a Custom Menu In Siebel 8.

4. Siebel will open a new browser window displaying the following potential help options:
   1. If a single help document has been created, the document displays in the new browser window.
   2. If more than one help document has been created, a list of documents displays in the browser window.
   3. If no help document has been created, an HTTP 404 (Page Not Found) error displays in the new browser window.
5. Choose from the following options:

   If You Want To	Then
   Select a help document	Click on the hyperlink for the document you wish to view.
   Access the Siebel Help Center	Click Siebel Help in the upper left.
   Return to Siebel	Close the browser window.