Follow

Managing Connection Profiles to the Server Print Friendly and PDF

  1. Click the Administration on the left menu cog on the navigation bar.
  2. Click Server Administration in the Administration area.
  3. Click Integration Settings in the Server Administration area.
  4. Click Context Sensitive Help Connection Profiles.
  5. Perform one of the following options:

    If You Want To

    Then

    Create a new connection profile
    1. Click New Connection Profile.

      NOTE: This profile is configurable and can be edited or deleted based upon your end user needs. You can specify as many connection profiles as necessary. You must specify a connection for each instance of the application for which you want to provide context-sensitive help.

    2. Go to the next step.

    View the connection
    1. Select the connection profile you want to view.
    2. Go to the next step.

    Edit the connection
    1. Select the connection profile you want to edit.
    2. Click Edit Settings.
    3. Go to the next step.

    Delete the connection
    1. Select the connection profile you want to delete.
    2. Click the drop-down arrow to the right of the action button.
    3. Click Delete in the left navigation pane.
    4. Click OKDelete to confirm the deletion.
  6. Complete/review the following as available:

    Field

    Description

    Name

    Enter the name of the connection profile.

    Description

    Enter details describing the profile.

    Application

    Select the application for context-sensitive help from the drop-down list.

    Applications Help Web Agent Profile Setting

    This field only displays when viewing connection profile information for Oracle.

    This value is pasted into the Applications Help Web Agent profile setting for the end user in Oracle E-Business. This value is generated by the application and is not configurable.

    Applications Help Web Agent Profile Setting for Authors

    This field only displays when viewing connection profile information for Oracle.

    This value is pasted into the Application Help Web Agent profile setting for the designated author in Oracle E-Business. This value is generated by the application and is not configurable.

    URL

    This field only displays when viewing connection profile information for Help Launchpad, PeopleSoft, SAP Portal, Siebel, and Web applications.

    This value is generated by the application and is not configurable.

    SR13 PlainHTML Server Name

    This field only displays when viewing connection profile information for SAP CRM.

    This value is generated by the application and is not configurable.

    SR13 PlainHTML Server Path

    This field only displays when viewing connection profile information for SAP CRM.

    This value is generated by the application and is not configurable.

    Base Help URL

    This option is not available for Help Launchpad, Web application or In-Application.

    Enter the URL of an alternate help content location the user can choose to view if no help is returned for their current context. Typically this would be the default help location provided by the application for which the connection profile was created. Populating this field will result in a base help link in the header bar of the website. The user may click this link to navigate to the alternate help content.

    NOTE: Any context information contained in the URL that receives in the initial help call will be appended to the help link URL value when the end user clicks the base help link. You should test the base help link to ensure alternate help content can either process or ignore the context information. The name of the base help link that displays in the end user website is the name of the connection profile.

    Search Method

    This option is only available for the Web application.

    Select Transaction Code to search by the transaction code property only, Full Text (All Words) to allow an AND search based on properties, or Full Text (Any Words) to allow an OR search based on properties.

    Application URLs

    This option is only available for In-Application.

    1. Enter the URL of the business application where you want in-application help enabled.
    2. Click the Add button.
    3. Repeat this process to add additional URLs.  

      NOTE: Separate multiple addresses with commas.

    The in-application help control will display in the browser when the current URL contains the value defined in this field. You can make this as broad or granular as you wish.

    • mydomain.com – Enables in-app help for all web applications running in the “mydomain” domain.
    • hostname.mydomain.com – Enables in-app help for all web applications running on a server with this hostname
    • hostname.mydomain.com/AppX – Enables in-app help only for pages containing AppX in the path part of the URL.

    This setting only controls whether the in-application help control displays within a given web application and whether a user can request help from within that application. The relevance of the help request results depend on how well a given web application’s characteristics match the context data the in-application help collects.

    Assigned URLs

    This option is only available for In-Application.

    URLs of the business applications where in-application help is enabled
  7. Complete/review the following as available in the Browser Settings area:

    Field

    Description

    Width

    This option is not available for In-Application.

    Set the width of the browser window in which the help will display.

    Height

    This option is not available for In-Application.

    Set the height of the browser window in which the help will display.

    Color

    This option is only available for In-Application.

    Select the color of the in-application context-sensitive help "question mark," which is what users click to access in-app CSH.

    This also controls the color of any status messages displayed by the in-application context-sensitive help solution.

    Location

    For all options except In-Application, sSpecify the location of the browser window in which the help will display.

    For In-Application, select the location where the in-application context-sensitive help control will appear in the web browser.

    The Top and Bottom options are offset by 100 pixels from the browser content top and bottom boundaries. 

    Snippet

    This field only displays when viewing connection profile information for In-Application.

    The Snippet information allows an administrator to embed the in-application context-sensitive help icon into a web application.  This value is generated by the application and is not configurable.

    Stay on Top (IE Only)

    This option is not available for In-Application.

    Select this option to allow the browser window containing help to display on top of all open applications.

    NOTE: This option is available for use only with Internet Explorer.

    Omit Tertiary Context

    This option is only available for In-Application.

    If you are using In-Application Help and not getting the search results you expect, try selecting this option.
  8. Complete/review the following as available in the Context String Substitution area:

    NOTE:

    This option is only available for Web and In-Application.

    NOTE:

    Use this option if there is a variance between the context data captured when creating documents and the context data that is accessed when calling context sensitive help. For example, documents are created in a non-production environment but context sensitive help is accessed within a different production environment.

    Field

    Description

    Find

    Enter the context string to find within the following values:

    • Primary (host name)
    • Secondary (screen title personalization)
    • Tertiary (different set of frames)

    Replace

    Enter the context string replacement for the following values:

    • Primary (host name)
    • Secondary (screen title personalization)
    • Tertiary (different set of frames)

    NOTE:

    Find and Replace is a simple string substitution. All found instances of the specified string will be replaced. The Find and Replace can be as specific or as general as needed to fit your scenario.

    For example:

    The recorded context is:

    • Primary: https://test.myapp.com/archprodsuio
    • Secondary: Customer Record

    An end user requests help from a business application https://prod.myapp.com/archprodsuio. You would need to do the following:

    • Find Primary: prod.myapp.com
    • Replace Primary: test.myapp.com
  9. Click Save if creating or editing a connection profile.
Was this article helpful?
0 out of 0 found this helpful