Introduction To Creating Context-Sensitive Help – uPerform On-Premise Manuals

You can present published content to your end users via online, Context-Sensitive Help integrated with SAP and other applications.

Context-Sensitive Help can open directly from the user's location in the application to the relevant topic or work instruction. After a Context-Sensitive Help search is conducted and the resulting document is opened, the content will automatically scroll to the first location in the document where the context matches the one from which help was called. If multiple documents match the search results, then the user will have to select to the appropriate document from the list of search results.

The auto-scroll functionality only applies to steps where the context data is captured by the recorder. To take advantage of the auto-scroll functionality, new or existing documents need to be published with version 5.20 or later.

The application can automatically scroll to content for only HTML-based published documents including:

Any document type published to HTML that contains steps
Simulation auto and standard playback modes
Guided help

Using the auto-scroll functionality requires an addition to the.xslt file used to generate the website. Refer to the section Enabling the Auto Scroll Functionality.

You can present published content to your end users via a website and online, Context-Sensitive Help. Via the website publishing process you can produce 'quick launch' pages which, in conjunction with the Help Launchpad product, are used to provide Context-Sensitive Help directly from your SAP R/3 system. Context-Sensitive Help via the SAP Enterprise Portal, Oracle, Siebel, and Microsoft Windows-based applications is also available.

NOTE:

For information on publishing quick-launch pages, refer to Publishing Quick Launch Pages.

Types of Help Available

The following subsections provide general information regarding establishing online, Context-Sensitive Help in the SAP, SAP Enterprise Portal, Oracle, Siebel and Microsoft Windows environments. Refer to the following user manuals and white papers for detailed instructions on establishing and maintaining Context-Sensitive Help:

Help Launchpad for ANCILE Info Pak
Context-Sensitive Help Solutions for Enterprise Systems (white paper)
Creating Content user manual

Enabling the Auto Scroll Functionality

To take advantage of the auto scroll functionality, new or existing websites and documents will have to be published with version 5.20 or later. The auto scroll functionality is only available with versions 5.2 and later.

Before enabling the auto scroll functionality, please note that your content and custom templates automatically upgrade when opened for editing. If they are published prior to being opened in the Editor, then your content and templates are temporarily upgraded during publishing. The temporary upgrades are deleted upon completion of publishing.

Existing templates are upgraded and placed in the current version’s Documents and Settings or Users folder the first time the Editor is launched after an upgrade.

NOTE:

If you have customized the website.xslt file located at "...\website\xml\assets" folder, we recommend making a copy of the .xslt file prior to republishing. Refer to Publishing the Website.

From the Editor, open the template you want to modify.
Click the General tab.
Select Data Files from the left pane.
Click the .xlst template file to modify.
Click Modify.
Navigate to the function: "changeDoc(selectControl, index)".

NOTE:

To locate this function, try searching for it using your text editor’s search feature.
Locate the line "document.getElementById('frameContent').src=newURL".

Replace with: document.getElementById('frameContent').src = newURL + window.location.search;

NOTE:

Add exactly this phrase: document.getElementById('frameContent').src = newURL + window.location.search; including the semicolon (;).

The image below shows an “after” view of what this part of the .xslt file should look like.

Navigate to the second "}" under the line you just added.

Copy the below code and paste it directly after the second "}".

NOTE:

This will insert a new function to enable the content to scroll to the relevant location in the file after the user calls help.

function finalizeIframeForUPEX()
{
  //Auto scroll
  var frameContent =  document.getElementById("frameContent");
  if (frameContent != null)
  {
    var contentWindow = frame
Content.contentWindow;
    if (contentWindow != null)
    {
      var scrollToHelpContentFunction = contentWindow.scrollToHelpContent;
      if (scrollToHelpContentFunction != null)
      {
        var getParameterByNameFunction = contentWindow.getParameterByName;
        if(getParameterByNameFunction != null)
        {
          var applicationName = getParameterByNameFunction('application');
          if (applicationName == "SAP+Portal")
          {
            var myVar = 
setTimeout(f
unction(){scrollToHelpContentFunction()},1);
          }
          else
          {
            scrollToHelpContentFunction();
          }
        }
        else
        {
          scrollToHelpContentFunction();
        }
      }
    }
  }
}

Navigate to the "init" function.

NOTE:

To locate this function, try searching for "function init()" using your text editor’s search feature.
Locate the line "Window.location = redirect.URL".

NOTE:

Note there are three instances of this line in the "init" function. Perform the following step for all three instances.

Above the line "Window.location = redirect.URL," insert a line with the following text including the semicolon: redirectURL = redirectURL + window.location.search;

NOTE:

Add exactly this phrase: redirectURL = redirectURL + window.location.search; including the semicolon (;).

The image below shows an “after” view of what this part of the .xslt file should look like.

Navigate to the iframe element with an id equal to:"frameContent".

NOTE:

To locate this function, try searching for id="frameContent" using your editor’s search feature.
Immediately before the closing > tag, insert onload="finalizeIframeForUPEX()".

NOTE:

Add exactly this phrase: onload="finalizeIframeForUPEX()".

The image below shows an “after” view of what this part of the .xslt file should look like.
Click File > Save from the text editor.
Close the file.
Click Yes to update the template when prompted.