SAP EP is a web-based platform for delivering information from various sources to end users. Using the URL to Help Topic setting, the SAP EP can display the correct content for each iView/Portal Page in a browser window that displays on top of the SAP EP application.
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 the SAP EP application.
When creating custom Help links in an application that will be hosted in an iView, consider using an approach similar to that used in the context-sensitive solution for the iView itself.
- Assign a unique identifier to each Help link. Recall that each iView in an SAP EP system has a unique alphanumeric identifier (for example, "com.sap.portal.createNewUser") that can be used as a reliable link between an iView and its related help content. Each custom Help link should also have a unique identifier that can be included in the properties of applicable documents.
- Include the unique Help link identifier in documents. The application allows the author to specify the iView ID(s) to which the document applies. The Help link unique identifier should also be specified in the document.
Creating a Template for Use with SAP Portal
Context-sensitive help for SAP Portal is driven by context identifiers. Each screen in SAP Portal has a unique context identifier and these are gathered collectively for a procedure and automatically inserted into the transaction code property of a document. Context identifiers are used to call context-specific help on the screen in which the end user is working.
Transaction code is a term and property used to identify a process. It is used in two separate instances:
- Transaction code property: The Server matches this document property to the associated SAP CRM 2007 screen when a call for help is made from SAP Portal.
- Transaction code block: In a document, this block displays the transaction code pertaining to the document created.
- Create a template.
|
NOTE:
|
A project administrator typically creates and customizes templates. For more information, refer to Using Author Templates.
|
- Select the Blocks tab.
- Select PurposeOverview.
|
NOTE:
|
If the template was created in an older version of the application, then the block name may display as Purpose.
|
- Turn off the display of the Transaction Code block in a document.
- Select the Properties tab.
- Enable the Transaction Code property.
- Select .
- Click the Publications tab.
- Select Website.
- Select Transaction Code(s) from the Build from Property field.
- Select Comma(,) from the Multiple Values Separated By field.
- Select .
Publishing the Website
As part of website publishing, you will also generate quick launch pages to enable communication between the website and SAP Portal. For information on publishing the website, refer to Publishing the Website.
Configuring SAP Portal to Send a Help Request to the Website
|
NOTE:
|
The SAP system administrator must configure SAP Portal to send help requests to the Server. This configuration is specified by adding links to the web dynpro page for which you want to provide context-sensitive help.
|
- Log into SAP Portal.
- Locate the SAP Portal Business Package iView for which you want to create context-sensitive help.
- Right-click on the iView.
- Select .
- Locate the Show Help Menu item.
- Select the Yes radio button.
- Open a new browser instance, and run the iView as a Portal end user.
- Copy the Object ID from the pop-up Details screen, omitting the pcd portion of the ID.
- Build the help call URL as [web server]/[website name]/website/website/xml/assets/redirect.html?iViewID=[iView ID].
- Paste the URL into the URL to Help Topic property of the iView.
- Click Save.
Recording an SAP Portal Document
- Log into SAP Portal.
- Perform one of the following options:
|
NOTE:
|
The recorder does not automatically gather transaction codes for screens containing an embedded SAP HTML GUI; however, you can obtain the transaction codes in this environment if you have integrated Help Launchpad with the SAP system you are displaying within the embedded HTML GUI.
In the above scenario, select within the transaction displayed in the HTML GUI. Review the web address field displayed in the new browser window, and identify the transaction code for this transaction. Copy the code and paste it into the Transaction Code property of the document you are currently recording.
|
- In the application, select .
- Select Properties.
- Ensure the context identifier(s) have been inserted into the Transaction Code value field.
- Click OK.
- Save the document.
- Add the document to the website using the procedures described in Building a Website.
- Publish the document using the procedures described in Previewing and Publishing Content.
- Republish the website using the procedures described in the Building a Website.
|
NOTE:
|
When the website is republished, the document will be available for the end user via the help icon in SAP Portal.
|
Enabling the Required iView/Portal Page Options
To enable end users to access context-sensitive help for an iView/portal page, the Help option must be enabled. Each iView/portal page Help option is disabled by default; however, an SAP EP user with the appropriate permission to edit an iView/portal page can enable the Help option via the Property Editor.
Each iView and portal page in a portal system can be contained in a tray. The tray includes the name of the iView/portal page and a drop-down menu of options such as Refresh, Open in New Window, Personalize, Details, and Help.
To enable the iView/portal page required options:
- Log into SAP Enterprise Portal with Content Administrator permission.
- In the Portal Catalog, right-click on the desired iView/portal page and select .
|
NOTE:
|
An iView or portal page may display in several different contexts based on your role within the SAP EP. For example, the "Create User" iView may be configured differently for Super Administrators than it is for Content Administrators. In addition, note the specific role(s) in which an iView/portal page is to be modified. If more than one role applies, the iView/portal page must be edited for all roles.
|
- In the editing area, select the Property Editor panel located to the right of the editing area.
- In the Property Category list, select Show All.
- For the Show 'Details' option property, click Yes.
- For the Show 'Help' option property, click Yes.
- For the Show Tray option property, click Yes.
- Click Save.
Locating the iView/Portal Page ID
Each iView and portal page in SAP EP has a unique alphanumeric identifier, which is registered in the portal content directory (PCD). The identifier is assigned when a new iView/portal page is created in the Portal Content Studio. Because identifiers are unique, they can be used as reliable links between an iView/portal page and its related help content.
To link an iView or portal page to help content, the iView/portal page ID must be included in the properties of the applicable document(s). To allow authors to easily locate an iView/portal page’s ID, the Details option must be enabled. An author can determine the iView/portal page ID via its details window by selecting the Details option within SAP EP. This will display a new browser window containing the Portal Component and Object ID.
The Object ID is a string of alphanumeric characters. You may choose to use the entire Object ID as the iView/portal page ID, or simply use the segment of the Object ID that follows the last "/" divider.
Including the iView/Portal Page ID in Documents
The application allows the author to populate properties within the document. These properties are leveraged when building website navigation and quick launch pages.
The application provide a Properties window for populating the Transaction Code(s) property within the document.
To map a document to an iView/portal page via the Properties tab:
- Ensure that the Transaction Code(s) built-in property is marked as visible in the template. By default, the display of all built-in properties is disabled in the template.
- Open the desired document associated with the template.
- Select .
- Click Properties on the left pane.
- Select the Transaction Code(s) field.
- Enter the iView/portal page ID in the Transaction Code(s) field. For multiple IDs, separate each with a comma.
- Click OK.
- Select to save your document.
Setting the Help URL for an iView/Portal Page
The URL to Help Topic property was introduced in EP6 SP17 and EP7 SP10 as a simple way to direct end users to the correct help URL; however, if you wish to configure the help URL for iViews or portal pages for which the URL to Help Topic property is not available, you may do so by using the PCD Inspector. The procedure for determining which procedure to use for setting the help URL depends on the following criteria.
- The version and service pack (SP) of your SAP EP system
- Whether you wish to enable the Help option on an iView or portal page
|
SAP EP Version
|
Service Pack (SP) Version
|
Set Help URL for iViews via
|
Set Help URL for Portal Pages via
|
|
6
|
Prior to SP17
|
PCD Inspector
|
PCD Inspector
|
|
SP 17-20
|
Portal Content Administrator
|
PCD Inspector
|
|
|
7
|
Prior to SP 10
|
PCD Inspector
|
PCD Inspector
|
|
SP 10-12
|
Portal Content Administrator
|
PCD Inspector
|
|
|
SP 13
|
Portal Content Administrator
|
Portal Content Administrator
|
|
|
7.30
|
0
|
PCD Inspector
|
PCD Inspector
|
Setting the Help URL Using Portal Content Administration
If you are setting the URL to Help Topic property for an iView/portal page, you may do so using Portal Content Administration.
To set an iView/portal page URL to Help Topic property using Portal Content Administration:
- Log into SAP Enterprise Portal with Content Administrator permission.
- In the Portal Catalog, right-click on the desired iView/portal page and select .
|
NOTE:
|
An iView or portal page may display in several different contexts based on role within the SAP EP. For example, the "Create User" iView may be configured differently for Super Administrators and Content Administrators. Therefore, it is important to note the specific role(s) in which an iView/portal page is to be modified. If more than one role applies, then the iView/portal page must be edited for all roles.
|
- Locate the Property Editor panel to the right of the editing area.
- In the Property Category list, select Show All.
- In the list of properties, scroll to the URL to Help Topic property, and enter the help topic location. Refer to Setting Up Stay-On-Top and Browser Controlled with ActiveX Mode in the Help Launchpad for ANCILE uPerform user manual.
- Enter the complete address of the website/xml/qlaunch folder in the published website, followed by the iView/portal page ID and "/index.xml". For example: http://[server]/website/sml/qlaunch/[iView/portalpage ID]/index.xm.
|
NOTE:
|
Only http addresses will produce the desired help results. For example, an iView with an ID of "com.sap.portal.usersInLast3Hours", the following address would be used: http://[server]/website/xml/qlaunch/com.sap.portal.usersInLast3Hours/index.xml.
|
|
NOTE:
|
Use a forward slash (/) to indicate path separator.
|
- Click Save.
Setting the Help URL Using the PCD Inspector
- Log into SAP Enterprise Portal with Content Administrator permission.
- From the Portal's top menu, click System Administration.
- From the System Administration page, click Support.
- From the Support page Top Level Areas list, click Portal Content Directory.
- In the Test and Configuration Tools list, click PCD Inspector. You may see warnings at this point; confirm these warnings and continue.
- From the PCD Inspector browser, check the box next to portal_content.
- Click Browse Into.
- Repeat Step 6-7 as necessary until you reach the desired portal page.
- Select the checkbox next to the desired portal page, and click PropEditor. This will open a new browser window for the PCD Generic Layer Property Editor.
- Click Switch to PCM.
- From the List of All Properties list, choose com.sap.portal.iview.HelpURL.
- Click Edit.
- In the Property Value field, enter the complete address of the website/xml/qlaunch folder in the published website, followed by the iView/portal page ID and "/index.xml": http://[server]/website/xml/qlaunch/[iView/portal page ID]/index.xml.
|
NOTE:
|
Only http addresses will produce the desired help results. For example, an iView with an ID of "com.sap.portal.usersInLast3Hours", the following address would be used: http://[server]/website/xml/qlaunch/com.sap.portal.usersInLast3Hours/index.xml.
|
|
NOTE:
|
Use a forward slash (/) to indicate path separator.
|
- Click Save.
Modifying the Help Link in the Portal Masthead
By default, the Help link in the SAP EP masthead launches the SAP Help Portal; however, the Portal Content Administrator can change the URL that is displayed by this Help link. For example, you may wish to have this Help link display the home page of your custom or application-generated website or display a specific page on your corporate intranet.
To select the URL that is displayed by the Help link in the Portal masthead, perform the following steps:
- In the Portal Catalog, go to Portal Users > Standard Portal Users.
- Right-click on the Default Framework page and select .
- Check the Masthead iView checkbox and click Properties.
- In the Property Editor, from the Property Category drop-down list, select Navigation.
- In the Property Editor, locate the URL of Help Link property.
- In the URL of Help Link property, enter the URL of the site you want to display.
- Click Save.
Requesting Help from SAP Portal
- Log into SAP Portal as an end user.
- Navigate to the desired screen.
- Click the help icon (?) for the screen.
|
NOTE:
|
The website searches for available help for the screen based on the context identifier specified in the document.
|
- SAP Portal will open a new browser window 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, an HTTP 404 (Page Not Found) error displays in the new browser window.