SAP Workforce Performance Builder

Transcription

1 Additional Guides Workforce Performance Builder Document Version: SAP SE or an SAP affiliate company. All rights reserved. CUSTOMER SAP Help Extension ECC

2 Table of Contents 1 Introduction Integrating the Help File into SAP GUI Integrating the Menu Entry Editing the Menu Entry Creating a Context-Sensitive Help File Context Configuration Exporting a Context File Administration of the Context Using the Context-Sensitive Help File Technical Support Customer Introduction

3 1 Introduction This documentation shows the integration of Learning Content into the Help menu of SAP ECC. Introduction Customer 3

4 2 Integrating the Help File into SAP GUI After the export of a context-sensitive help file, the context.html can be integrated into the SAP GUI. With the integration the menu entry Learning Content will be activated in the Help menu of SAP GUI. The menu entry allows you, to open the context-sensitive help. Note Note, that you need maintenance authorizations for the integration. 2.1 Integrating the Menu Entry To integrate the context.html into the SAP GUI, proceed as follows: 1. Open your SAP GUI. 2. Insert the transaction SM30 into the transaction field. Click on Enter. The Maintain Table Views screen opens. 3. Insert WPBHELP_URL into the Table/View field. 4. Click on Maintain. The Change View screen opens. 5. Click on New Entries. The New Entries screen opens. 6. Edit the following parameters: Number: Insert the number of the URL (e.g. 1). Text: Insert the URL of the context.html. e.g.: URL active: Activate the setting, if the URL should be used for the menu entry. Note Enter a URL in lower case, because upper case letters are changed to lower case by the system. It is possible to insert several URL entries, but only one URL can be active for the menu entry. 7. Click on Save. The Maintain Table Views screen opens. 4 Customer Integrating the Help File into SAP GUI

5 Note Enter the context URL for all clients (mandant) that should use the context help. 8. Click on Save. The Maintain Table Views screen opens. 9. Now, restart the SAP GUI for the changes to take effect. Note If you don't see the Learning Content entry, add the same entry for client 0 in SM30 or see SAP Note Editing the Menu Entry To change the integration of the context.html, proceed as follows: 1. Open your SAP GUI. 2. Insert the transaction SM30 into the transaction field. Click on Enter. The Maintain Table Views screen opens. 3. Double-click the URL in the list. The Change View screen opens. 4. Edit the parameters. 5. Click on Save. The Maintain Table Views screen opens. Integrating the Help File into SAP GUI Customer 5

6 3 Creating a Context-Sensitive Help File In order to use the context-sensitive help file, you first have to define which specific information you would like to add to the help file. Linking information according to its contents allows users to quickly and easily search for and find the specific information they need for any given situation within the application. e.g., the current transaction (TCODE) or the mandant (MANDT). Once the context-sensitive help file has been created, it can be integrated directly into the help menu in your SAP system. The learners can then access this help file and its contents at any time. Supported applications The following applications are supported for the implementation of a context-sensitive help: Application Version Parameter SAP GUI for HTML Dependent on specific SAP kernel versions Client, Dynpro, Transaction SAP GUI for Windows Dependent on specific SAP kernel versions TCODE, DBSYS, DYNPRO, PROGRAM 3.1 Context Configuration During the recording, the Producer analyzes the existing SAP environment and extracts the relevant context information from the system. This information is then displayed in the Context setting. Note For the use of further context parameters contact your SAP consultant. The contextual information is entered under the Context setting which can be opened by clicking on the button Advanced Layout of the object editor in project explorer. The individual pieces of information contain a description of the type and its corresponding value, linked via an equal sign (PARAMETER=VALUE). Editing the context Additional information can be entered in the field, separated with a comma. For example: TCODE=SBWP,MANDT=906,DYNPRO=SAPLSINWP Multiple context parameters will be separated with a vertical bar: TCODE=SU01 SE80 SE63 6 Customer Creating a Context-Sensitive Help File

7 Wildcards can also be defined for any contextual information. Wildcards accelerate and facilitate searching for specific content within the help file. Example of a wildcard: TCODE=SU* Note The language of the context information depends on the language of learning content and is defined automatically. 3.2 Exporting a Context File Once the contextual information has been defined and the workarea has been published, the context file can be generated in the Producer. All the object information used for the help file content is entered into a context.html file. To export a context file, proceed as follows: 1. Select the root group of the content or a specific sub-group in the project explorer. 2. Choose Workarea -> Publish -> Export Context File The settings dialog box opens: Enter the Target Folder for storing the file. Enter the URL of the published workarea with the included content, for example Select a mode or the complete project in the Mode setting. The selected mode is started with the relevant context-sensitive information. 4. Click on OK. 5. The parameter dialog box opens and displays the available context parameters. Select the parameters that you want to include in the context file. 6. Click on OK to export the file. Note If a Webserver requires administrator permissions, then it is not possible to write directly to the target folder. Export the context.html to a local folder and then copy the file to the target folder. Manager workarea of a Manager The context.html can also be exported for the Manager workarea of a Manager. In the URL setting, enter the workarea location in this format: published content of the workarea by adding ~tag/published. To access the content of the Manager workarea, users need to log on. Activate the Anonymous user to allow users to bypass the logon. Creating a Context-Sensitive Help File Customer 7

8 3.3 Administration of the Context The Context Administration includes functions for the administration of the context information and context files. The following functions are available about the Tools -> Context Administration menu in the project explorer: Replace or Append Executables Replace Page Key Attributes Test Context File Search and Replace Replace or Append Executables The function allows you to replace an executable with a different executable or to append an executable with an additional name. This is required, if an application uses different executables or different applications need to be supported for the navigation content. To do so, proceed as follows: 1. Select a content structure or an object in the project explorer. OR Open a project in the project editor. 2. Start the function by choosing the Replace or Append Executables... menu entry. 3. A dialog box opens, which contains the following parameters: 1. Executables: The drop-down box displays the available executables of the selected contents. Select the executable that you want to replace or append. 2. New Executables: Enter one or more executable names into the text field. Use a semicolon ';' or a comma ',' (for example: name1.exe,name2.exe or name1.exe;name2.exe) to separate multiple executables. Do not enter a space before or after the semicolon or comma. 4. Click on Append or Replace. The executable names are replaced or appended. The dialog box opens again where you can adapt further executables. Click on Close to close the dialog box. To remove an executable leave the New Executable field empty and click on Replace. Replace Page Key Attributes The Replace Page Key Attribute function allows you to customize the page information of your content. To replace a page key attribute, proceed as follows: 8 Customer Creating a Context-Sensitive Help File

9 1. Select an object or group in the project explorer. or Open a project in the project editor. 2. Click on Replace Page Key Attributes... in the Tools -> Context Administration menu. 3. A dialog box opens with the following settings. Change the settings as required: Parameter: Select the parameter of the page key. The drop-down list displays all available parameters. Search Value: Select the attribute of the page key parameter to be replaced. The drop-down list displays all the available attributes of the selected parameter. Replace Value: Insert the attribute to be used in the page key. Regular Expression: Activate this option to create a regular expression. Preview Value: Displays a preview of an attribute with regular expression. 4. Click on Replace to replace the defined attributes wherever they occur. Next, the dialog box opens again with the changed attributes. You can replace further attributes or close the dialog box. When changing a page key the original attribute will be saved. This allows you to undo changes by using the Restore button. Test Context File The function Test Context File allows you to test a created context file. To do so, proceed as follows: 1. Start the function with the Tools -> Context Administration -> Test Context File menu entry. 2. Choose the context file in the opened dialog. 3. Confirm with OK. 4. The next dialog shows the available context information of the context file. Enter the test values. 5. Confirm the dialog with OK. Afterwards, the preview page opens and shows the available contents for the defined values. Search and Replace Parameter The function Search and Replace Parameter allows you to replace a specific attribute in the context parameters of the content. To do so, proceed as follows: 1. Start the function with the Search and Replace Parameter menu entry. 2. A dialog opens and includes the following parameters: Creating a Context-Sensitive Help File Customer 9

10 Search: Specify the entry that should be searched. Replace by: Specify the entry that should be replaced. 3. Confirm the dialog with Ok. Afterwards, the search entry is replaced. 10 Customer Creating a Context-Sensitive Help File

11 4 Using the Context-Sensitive Help File When users open the context file from the Help -> Learning Content menu, the contents of the current context are displayed in a list view of the HTML page. Users can start the displayed content or to search for further content. Starting content The way that content is started depends on how the mode was defined in the context file: Project: Clicking the entry opens the project in the library. The user can select the specific mode or documentation. Mode: Clicking the entry starts the mode in the trainer directly. When the library or trainer is closed, the context file is also closed. The user can start the context file for a specific context again. No content available If there is no content available, a note is shown in the content area. The user can use the library or the search to find required content in the workarea. Context file functions The header of the context file includes the following functions: Icon Name Description Open library Allows the user to open the library and display the complete content of the workarea. Allows the user to search for specific content of the workarea. The user can search for a Search term in the Title, Short Description, Description and Keywords of the content objects. Allows the user to change the language of the Language context file. All content languages of the content dictionaries can be used. Using the Context-Sensitive Help File Customer 11

12 5 Technical Support Please use the SAP Incident Wizard on the SAP Support Portal to submit your incidents on the following components: KM-WPB // Workforce Performance Builder KM-WPB-CXH // Workforce Performance Builder Context Sensitive Help Using the SAP Support Portal If you are not familiar with the SAP Support Portal, read the following information: To access the SAP Support Portal you need an S-user ID and password. You can request access data from your SAP Super Administrator or register online on the SAP Support Portal page under Registration. With this user, you have read-access to all the contents of the SAP Support Portal, you can use the SAP Community Network and SAP Help Portal, and you can also book courses under SAP Education. If you want to work with the support applications (Incident Wizard, license key request, system data maintenance, manage remote connections, software download and so on), you need the corresponding authorizations, which your SAP Super Administrator can give you. You can find information for new users and about support applications on the Support Portal Homepage under Learn More. There you can also register for a personal overview demonstration of the SAP Support Portal. In case of problems with SAP Support Portal contact your local Customer Interaction Center. An online web form is available on This web form should be used for all written communication with your local customer interaction center. More Details about Incident Processing, Support Addresses and Hotline Numbers can be found here: Are you interested in a tour through the SAP Support Portal? Register for an online demo. Diagnosis function in Producer The Producer diagnosis function can also be used to check the technical data of the installation on your computer (version, operating system, browser, etc.). Open Producer and select Diagnosis by using the Help menu. The Producer transmits the required information automatically and lists this in a corresponding dialog box. This information can also be saved as a text file and sent as an attachment to the SAP support staff. 12 Customer Technical Support

13 Typographic Conventions Type Style Description Words or characters quoted from the screen. These Example include field names, screen titles, pushbuttons labels, menu names, menu paths, and menu options. Textual cross-references to other documents. Example Emphasized words or expressions. Technical names of system objects. These include EXAMPLE report names, program names, transaction codes, table names, and key concepts of a programming language when they are surrounded by body text, for example, SELECT and INCLUDE. Output on the screen. This includes file and directory Example names and their paths, messages, names of variables and parameters, source text, and names of installation, upgrade and database tools. Example Exact user entry. These are words or characters that you enter in the system exactly as they appear in the documentation. <Example> Variable user entry. Angle brackets indicate that you replace these words and characters with appropriate entries to make entries in the system. Example Keys on the keyboard, for example, F2 or ENTER. Technical Support Customer 13

14 Important Disclaimers on Legal Aspects This document is for informational purposes only. Its content is subject to change without notice, and SAP does not warrant that it is error-free. SAP MAKES NO WARRANTIES, EXPRESS OR IMPLIED, OR OF MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE. Coding Samples Any software coding and/or code lines / strings ("Code") included in this documentation are only examples and are not intended to be used in a productive system environment. The Code is only intended to better explain and visualize the syntax and phrasing rules of certain coding. SAP does not warrant the correctness and completeness of the Code given herein, and SAP shall not be liable for errors or damages caused by the usage of the Code, unless damages were caused by SAP intentionally or by SAP's gross negligence. Accessibility The information contained in the SAP documentation represents SAP's current view of accessibility criteria as of the date of publication; it is in no way intended to be a binding guideline on how to ensure accessibility of software products. SAP specifically disclaims any liability with respect to this document and no contractual obligations or commitments are formed either directly or indirectly by this document. Gender-Neutral Language As far as possible, SAP documentation is gender neutral. Depending on the context, the reader is addressed directly with "you", or a gender-neutral noun (such as "sales person" or "working days") is used. If when referring to members of both sexes, however, the third-person singular cannot be avoided or a gender-neutral noun does not exist, SAP reserves the right to use the masculine form of the noun and pronoun. This is to ensure that the documentation remains comprehensible. Internet Hyperlinks The SAP documentation may contain hyperlinks to the Internet. These hyperlinks are intended to serve as a hint about where to find related information. SAP does not warrant the availability and correctness of this related information or the ability of this information to serve a particular purpose. SAP shall not be liable for any damages caused by the use of related information unless damages have been caused by SAP's gross negligence or willful misconduct. Regarding link classification, see: 14 Customer Technical Support

15 No part of this publication may be reproduced or transmitted in any form or for any purpose without the express permission of SAP SE or an SAP affiliate company. The information contained herein may be changed without prior notice. Some software products marketed by SAP SE and its distributors contain proprietary software components of other software vendors. National product specifications may vary. These materials are provided by SAP SE or an SAP affiliate company for informational purposes only, without representation or warranty of any kind, and SAP or its affiliated companies shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP or SAP affiliate company products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty. SAP and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP SE (or an SAP affiliate company) in Germany and other countries. All other product and service names mentioned are the trademarks of their respective companies. Please see for additional trademark information and notices.