Follow

Providing Help to End Users

If anonymous access has not been enabled for the project containing the requested help content, tThe end user will have to login to the Server when requesting help. This login requirement can be avoided by enabling Single Sign-On. For additional information on enabling Single Sign-On, refer to the companion manual Administration.

Requesting Help

  1. Log into the application as an end user.
  2. Navigate to the desired screen.
  3. Perform one of the following options

    If You Want To

    Then

    View context-sensitive help for Oracle E-Business, SAP CRM Web Client, SAP Portal, Siebel, or PeopleSoft
    1. Click the help icon for a screen.
    2. Go to Step 4.

    View context-sensitive help for applications using Help Launchpad
    1. Refer to the companion manual Help Launchpad.
    2. Go to Step 4.

    View context-sensitive help for Generic Web Pages
    1. Click the Request Context-Sensitive Help toolbar button, or select Help > Request Context-Sensitive Help.
    2. Go to Step 4.

    NOTE: Context-sensitive help can be accessed from the right-click context menu in Internet Explorer.

    View In-Application context-sensitive help

    Once in-application help has been configured for a business application and help content has been published on the Server, the end user’s experience is straightforward.

    1. Click the Help button within the business application to display available help content based on your current location in the application.
    2. Go to Step 4.

    View context-sensitive help for Windows-based applications.
    1. Select the application's Help control.
    2. Go to Step 4.

    Modify Server URL for Generic CSH plug-in
    1. Click the Request Context-Sensitive Help toolbar button, or select Help > ANCILE uPerform Help Settings....
    2. Enter a URL in the uPerform Server URL: field.

    Exclude URLs from context-sensitive help for Generic CSH plug-in
    1. Click the Request Context-Sensitive Help toolbar button, or select Help > ANCILE uPerform Help Settings....
    2. Enter a URL in the URLs to Exclude From Context-Sensitive Help: field.
  4. Perform one of the following options

    If You Are

    Then

    NOT using In-Application Context-Sensitive Help

    A new browser window will open, displaying the following potential help options:

    • If a single help document has been created, the document displays in the new browser window.
    • If more than one help document has been created, a list of documents displays in the browser window.
    • If no help document has been created, a zero search result window displays.

    NOTE: If stay-on-top is enabled, the help document remains on top of the application screen.

    Using In-Application Context-Sensitive Help

    What displays next depends on the user authenticated state, Server project settings, and types of published content.

    • If the matching or selected item (if multiple matches) has been published to the In-Application format, the help content displays in-application. The user can scroll to view the content, and click on text entry field labels to toggle the user interface to view more information such as a definition or example value. If the user wants to view the content in a different format such as a simulation, work instruction, etc., click the View as Different Format button to open the default output format in a new browser window.
    • If the matching or selected item (if multiple matches) has not been published to the In-Application format, the user clicks on the help content title to display the default output format in a new browser window.

    NOTE:

    If you do not see the expected results after requesting Context-Sensitive Help, you should log into the Server.

    NOTE:

    For In-Application Context-Sensitive Help for single sign-on scenarios, or cases where you have already authenticated to the Server in the current browser session, you only need to click the Login button and you will be authenticated without prompt for credentials.
  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 [Application Name] Help Center

    Click [Application Name] Help in the upper left to display default help for the application.

    This option is available if a BaseHelp URL was specified when configuring the connection profile.

    Return to the application

    Close the browser window.

    Search for additional content
    1. Enter a search term(s) in the Search field.
    2. Click Search.

    Search for two terms

    Enter Term 1 followed by AND followed by Term 2.

    For example, Project AND accounting

    This would find all content that contains both Project and accounting.

    Search for one term or another

    Enter Term 1 followed by OR followed by Term 2.

    For example, Project OR accounting

    This would find all content that contains either Project or accounting.

    Search for literal string

    Enter the literal string in quotation marks.

    For example, "Project Accounting"

    This would find all content that contains the exact string "Project Accounting".

    NOTE:

    Literal search strings cannot contain either # or ! within the string. These are stripped out by the Server as non-allowed characters.
Was this article helpful?
0 out of 0 found this helpful