Chapter 14: Setting Up Online HelpConfiguring SAP Portal for Use with Context-Sensitive Help 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 uPerform 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 uPerform documents. Include the unique Help link identifier in uPerform documents. uPerform 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. 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: 1. Log into SAP Enterprise Portal with Content Administrator permission. 2. In the Portal Catalog, right-click on the desired iView/portal page and select Open > Object. 318 ANCILE Solutions, Inc. The Object ID is a string of alphanumeric characters. 6. 319 . Locating the iView/Portal Page ID Each iView and portal page in SAP EP has a unique alphanumeric identifier. Inc. You may choose to use the entire Object ID as the iView/portal page ID. To allow authors to easily locate an iView/portal page’s ID. which is registered in the portal content directory (PCD). click Yes. The author can specify an iView/portal page ID. select the Property Editor panel located to the right of the editing area. For the Show Tray option property. The uPerform server uses these properties to produce search results. Because identifiers are unique. For the Show 'Details' option property. For transaction-based SAP procedures. 5. they can be used as reliable links between an iView/portal page and its related help content. In the Property Category list. the "Create User" iView may be configured differently for Super Administrators than it is for Content Administrators. Including the iView/Portal Page ID in Documents ANCILE uPerform allows the author to populate properties within the document. select Show All. 8. For example. click Yes. This will display a new browser window containing the Portal Component and Object ID. the Details option must be enabled. the author can specify the SAP transaction code(s) to which the document applies. The identifier is assigned when a new iView/portal page is created in the Portal Content Studio. 3. To link an iView or portal page to help content. In addition. Click Save.Chapter 14: Setting Up Online Help An iView or portal page may display in several different contexts based on your role within the SAP EP. uPerform provide a Properties window for populating the Transaction Code(s) property within the document. click Yes. note the specific role(s) in which an iView/portal page is to be modified. In the editing area. An author can determine the iView/portal page ID via its details window by selecting the Details option within SAP EP. the iView/portal page must be edited for all roles. For the Show 'Help' option property. or simply use the segment of the Object ID that follows the last "/" divider. If more than one role applies. ANCILE Solutions. instead of a transaction code. 7. 4. the iView/portal page ID must be included in the properties of the applicable uPerform document(s). select Show All. if you wish to configure the help URL for iViews or portal pages for which the URL to Help Topic property is not available. For example. . 320 ANCILE Solutions. Inc.30 0 Setting the Help URL Using Portal Content Administration If you are setting the URL to Help Topic property for an iView/portal page. 3. 5. you may do so using Portal Content Administration. 2. If more than one role applies. however. the "Create User" iView may be configured differently for Super Administrators and Content Administrators. An iView or portal page may display in several different contexts based on role within the SAP EP.Chapter 14: Setting Up Online Help 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. In the Portal Catalog. 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 6 Service Pack (SP) Version Prior to SP17 SP 17-20 Set Help URL for iViews via PCD Inspector Portal Content Administrator PCD Inspector Portal Content Administrator Portal Content Administrator PCD Inspector Set Help URL for Portal Pages via PCD Inspector PCD Inspector PCD Inspector PCD Inspector Portal Content Administrator PCD Inspector 7 Prior to SP 10 SP 10-12 SP 13 7. then the iView/portal page must be edited for all roles. Log into SAP Enterprise Portal with Content Administrator permission. Locate the Property Editor panel to the right of the editing area. it is important to note the specific role(s) in which an iView/portal page is to be modified. 4. right-click on the desired iView/portal page and select OPEN > OBJECT. In the Property Category list. The procedure for determining which procedure to use for setting the help URL depends on the following criteria. In the list of properties. scroll to the URL to Help Topic property. you may do so by using the PCD Inspector. To set an iView/portal page URL to Help Topic property using Portal Content Administration: 1. Therefore. you may wish to have this Help link display the home page of your custom or uPerformgenerated website or display a specific page on your corporate intranet. In the Test and Configuration Tools list. click Portal Content Directory. ANCILE Solutions. Log into SAP Enterprise Portal with Content Administrator permission. Click Edit. click PCD Inspector.portal. however. the Portal Content Administrator can change the URL that is displayed by this Help link. the Help link in the SAP EP masthead launches the SAP Help Portal. From the Portal's top menu. Click Browse Into. 10.iview. 2. 11. For example. 7. Build the help call URL by appending the Object ID copied in the Locating the iView/Portal Page ID (on page 319) to the URL generated when you specified a connection to the server using the procedures found in Specifying a Connection with the uPerform Server. Select the checkbox next to the desired portal page. 321 . Paste the URL into the Property Value field. You may see warnings at this point. 9. 7. From the List of All Properties list. Repeat Step 6-7 as necessary until you reach the desired iView/portal page. Enter the connection profile URL. choose com. 12. check the box next to portal_content.HelpURL. 13. Click Save. confirm these warnings and continue. 3.sap. Modifying the Help Link in the Portal Masthead By default. 6. click System Administration. and click PropEditor. Click Switch to PCM.Chapter 14: Setting Up Online Help 6. Click Save. 4. 5. 15. From the PCD Inspector browser. 14. Inc. From the System Administration page. This will open a new browser window for the PCD Generic Layer Property Editor. click Support. From the Support page Top Level Areas list. 8. Setting the Help URL Using the PCD Inspector 1. Chapter 14: Setting Up Online Help To select the URL that is displayed by the Help link in the Portal masthead. locate the URL of Help Link property. Check the Masthead iView checkbox and click Properties. In the URL of Help Link property. Inc. 4. 3. Click Save. 6. In the Property Editor. Right-click on the Default Framework page and select OPEN > OBJECT. select Navigation. go to Portal Users > Standard Portal Users. 322 ANCILE Solutions. . enter the URL of the site you want to display. 7. from the Property Category drop-down list. perform the following steps: 1. 2. In the Portal Catalog. 5. In the Property Editor.
Report "Enabling Context sensitive help in SAP Portal"