Installing and Deploying SAP Knowledge Acceleration (KA)

Transcription

1 SAP KNOWLEDGE ACCELERATION INSTALLATION AND DEPLOYMENT GUIDE In this guide, you will learn how to install and deploy Knowledge Acceleration (KA) product. Prior to beginning the installation, review hardware and software requirements and ensure that you have downloaded all required components for SAP Knowledge Acceleration (KA) product. The SAP Knowledge Acceleration is a web-based learning environment that uses software simulations for selfpaced tutorials as well as quick reference material. The content is authored using the SAP Productivity Composer (uperform Express). Installing and Deploying SAP Knowledge Acceleration (KA) The SAP Knowledge Acceleration (KA) is provided in two formats: Website Package LMS Package (AICC 2.2, SCORM 1.2, or SCORM 2004) You must choose one format to deploy and then download the relevant installation package from the Service Marketplace (SMP). The SAP Knowledge Acceleration can only be installed on the Microsoft Operating System (OS). After installation, the SAP Knowledge Acceleration files could be moved and deployed on any web server or Learning Management System (LMS), on any Operating System (OS). The SAP Knowledge Acceleration, website package, can be deployed to any web server, file server, CD-ROM, or a user workstation. The SAP Knowledge Acceleration, LMS package, can be deployed to any Learning Management System (LMS) that conforms to AICC 2.2, SCORM 1.2, or SCORM The SAP Knowledge Acceleration (website or LMS package) can be accessed by a URL link in a browser. It is recommended to deploy the SAP Knowledge Acceleration to a web server or Learning Management System (LMS) to allow multiple users to access the SAP Knowledge Acceleration from multiple sites or locations. Technical requirements for deploying the SAP Knowledge Acceleration (KA): 1.0 GHz processor or higher Between 300 MB and 600 MB average per SAP Knowledge Acceleration. Between 40 MB and 60 MB average per module without sound (Actual size depends on many factors including length of lesson, screen resolution, and colour depth). Workstations with faster processors, larger amounts of RAM, and larger amounts of disk space are highly recommended. Depending on content usage patterns, a server configured per minimum recommended requirements may support between 1,000 and 1,500 end users.

2 Deploying KA to a Learning Management System (LMS) The SAP Knowledge Acceleration (KA), LMS package, can be deployed to any Learning Management System (LMS) that conforms to AICC 2.2, SCORM 1.2, or SCORM The SAP Knowledge Acceleration passes data via a POST command to the server script. The data that is passed: user name, simulation title, total number of questions, total number of correctly or incorrectly answered questions, score, and pass/fail. The SAP Knowledge Acceleration, accessed from any LMS system, will pass and save data into the LMS system. To deploy the SAP Knowledge Acceleration (KA) on an LMS system: Download and extract zip file Run the installation Locate and extract installed files Deploy LMS package Download and extract **.zip file for your SAP Knowledge Acceleration, LMS package. Double click on the **.msi file to install the SAP Knowledge Acceleration. Follow the installation wizard. Navigate to location where you installed SAP Knowledge Acceleration, LMS package and extract **.zip file. If LMS uses **.zip file, upload **.zip file for each course to your LMS. If LMS uses extracted **.zip file, upload required file(s) for each course to your LMS. Note: In most cases, the SAP Knowledge Acceleration is deployed to your LMS by your LMS administrator. Accessing SAP Knowledge Acceleration from you Learning Management System (LMS) When you launch a course from your LMS, it opens in a browser window. The title appears at the top and the Menu button appears at the top right corner. You can navigate to different lessons and assessments using the Menu button or you can navigate to the next or previous page using buttons on the bottom right corner. Navigating through the course pages, you will find Simulations in multiple modes, for example Demonstration or Tutorial, Self Test, or Evaluation. If you decide to customize the SAP Knowledge Acceleration and publish the content to an LMS package, you can specify which playback modes will be available to the user (Demonstration, Tutorial, Self Test, or Evaluation). Deploying KA to a Local Area Network (LAN) Deploying to a local area network will require you to create a shortcut, map a drive or create a UNC address (link) of the location where you installed SAP Knowledge Acceleration prior to granting access to users. To deploy the SAP Knowledge Acceleration (KA) on a local area network: Download and extract zip file Run the installation Access installed KA Grant access to users Download and extract the **.zip file for your SAP Knowledge Acceleration, website package. Double click on the **.msi file to install the SAP Knowledge Acceleration. Follow the installation wizard. Navigate to the folder where you installed the SAP Knowledge Acceleration, website package, extract **.zip file, and click on the index.htm file. Assign access rights to network users as required (users only require READ 2 Revised October 2010

3 access to the directory). Distribute the location (link) of the SAP Knowledge Acceleration to users. Deploying KA to a web sever Deploying the SAP Knowledge Acceleration to a web server allows multiple users to access the SAP Knowledge Acceleration from multiple sites or locations. The instructions below explain how to configure SAP Knowledge Acceleration on Microsoft Internet Information Server (ISS) v5 and Apache web server, although any supported platforms may be used. Download and extract zip file Download and extract the **.zip file for your SAP Knowledge Acceleration, website package. Run the installation Access installed KA Create Access Point Double click on the **.msi file to install the SAP Knowledge Acceleration. Follow the installation wizard. Navigate to the folder where you installed the SAP Knowledge Acceleration, website package, and click on the index.htm file. Create a link to the index.htm file from an existing website. or Create a standalone index.htm page. or Create a virtual directory on the web server. Configure IIS 1. Add a new virtual directory to the website and name it as required. 2. Enter the path to the location where you installed SAP Knowledge Acceleration (**.msi). 3. Set access permissions to the virtual directory (read and run required) 4. Set the default start page of the directory to be index.htm For Example: SAP Knowledge Acceleration should now be accessible via the address Configure Apache Web Server 1. Stop the Apache server 2. Add the following into the httpd.conf file within the Apache/Conf directory: Alias /ka/ "C:/KA/" <Directory "C:/KA"> Options Indexes FollowSymLinks </Directory> Note: The path in this example is C:/KA. Modify this path to point to the location where you have installed SAP Knowledge Acceleration. 3. Find the following line in the httpd.conf file: DirectoryIndex index.htmldefault.html and change this to read DirectoryIndex index.html. 4. Save changes and restart Apache. Note: If you are using Apache with UNIX operating system, there are some unique considerations as the UNIX operating system is case sensitive. SAP Knowledge Acceleration uses mixed case in its file structure. This generally does not cause a problem with UNIX because all calls to our files are in the correct case. (e.g., a file named "Test" will always be called as "Test", never "test"). However, there is an Apache module called "mod_rewrite" that automatically transforms URLs to lower-case (or upper case, depending on the configuration). Unfortunately, if your server is using this module, then calls to SAP Knowledge Acceleration files will now be called in lower-case, but since the file is mixed-case, it will generate an error 3 Revised October 2010

4 (web error number 404.) Please note, this is a well known module in Apache and information on mod_rewrite can be found at: Information on creating a htaccess file for Apache All deployment options use UTF-8 encoding. The Developer sets the encoding by using the HTML "encoding" META tag. By default, Apache on non-windows operating systems does not honor UTF-8 META tags without the 3 byte order mark (BOM). If you encounter this problem, an.htaccess file can be created in the Player directory to allow Apache to correctly serve UTF-8 pages. To do so, create an.htaccess file that contains the following line: "AddDefaultCharset UTF-8". The httpd.conf must be configured to allow.htaccess override. If "AllowOverride None" is set in the httpd.conf, then the.htaccess file is ignored. This needs to be set to allow the.htaccess file to override the httpd.conf for this particular directory. After doing this, restart the Apache service and then the IE cache *must* be cleared if the content was accessed before this change. (This is because file dates do not change, only the Apache is serving the files change. Therefore, IE will not realize it needs to get the file again unless the cache is cleared.) Deploying KA to a stand-alone computer Deploying the SAP Knowledge Acceleration to a stand-alone computer is not recommended. To deploy the SAP Knowledge Acceleration (KA) on a stand-alone workstation: Download and extract zip file Run the installation Access installed KA Download and extract the **.zip file for your SAP Knowledge Acceleration, website package. Double click on the **.msi file to install the SAP Knowledge Acceleration. Follow the installation wizard. Navigate to the folder where you installed the SAP Knowledge Acceleration, website package, extract the **.zip file, and click on the index.htm file. Viewing SAP Knowledge Acceleration (KA) The following requirements are for viewing the SAP Knowledge Acceleration from a local workstation: 1.0 GHz processor or higher 512 MB RAM or higher 2 MB Video card with 16 million colors at 1024 x 768 resolution Microsoft Windows 2000 SP4, XP Professional SP3, or Vista Business SP1 Support for Federal Desktop Core Configuration (FDCC) Major version 1.2 (2009 Q1) of Microsoft Windows XP Professional SP2/SP3 or Vista Business SP1 Microsoft Internet Explorer 6.0, 7.0, or 8.0 or Mozilla Firefox 2.0 or 3.0 to view HTML output Microsoft Office XP, 2003 SP3, or 2007 SP1 to view Microsoft Office output Adobe Acrobat Reader 8.0, 9.0, or 9.1 to view PDF output Adobe Flash Player 8.0, 9.0, or 10.0 to view Flash output For optimum performance, viewing the SAP Knowledge Acceleration over a modem connection (56K) is not recommended. 4 Revised October 2010

5 Pop-up Blocker and Trusted Sites When you access content from the public Internet or from a Web site in the Restricted Security zone, you will notice the following behaviour: The pop-up blocker prevents the main Table of Contents window from launching. When attempting to launch, an information box will appear below the Address Bar, stating a pop-up has been blocked. In addition, an Information Bar dialog box may appear. Clicking in the Information Bar will allow you to Temporarily Allow Pop-ups, Always Allow Pop-ups from This Site, or change Settings. The settings changes are: turn off Pop-up Blocker: enable/disable Show Information Bar for Pop-ups; or More Settings. Selecting More Settings will open the Pop-up Blocker Settings dialog box. It is recommended that you don t make changes using these options. You should instead put the Web site with the content into a Trusted zone, as described below. Note: If you select Always Allow Pop-ups from This Site the site is automatically added to the allowed sites in the Pop-up Blocker Settings dialog box. You can access this dialog box from the Tools menu in Internet Explorer. Open Internet Explorer Add the site to the Trusted Sites list 1. Click on the Tools menu 2. Click on the Internet Options command 3. Click on the Security tab 4. Click the Trusted Sites icon 5. Click Sites 6. In the Add This Site to the Zone field, enter the URL for the website 7. Deselect Require server verification ( for all sites in this zone option, if necessary 8. Click Add 9. Click OK Running scripts and ActiveX controls on your computer: When you encounter a Web page that is trying to run active content on your computer, you will receive a message prompting you to indicate whether you want to allow this. To allow any Web site to run scripts and ActiveX controls on your computer: In Internet Explorer, on the Tools menu, click Internet Options. On the Advanced tab, scroll down to the Security section of the list. Select the Allow active content to run in files on My Computer check box, and then click OK. 5 Revised October 2010

6 Enabling Flash Player To view SAP Knowledge Acceleration (Flash output, simulations and modules), Adobe Flash Player 8.0, 9.0, or 10 is required (Internet Explorer or FireFox). To check if you have a Flash player installed, use Add\Remove programs in the Control Panel and check to see if the Adobe Flash Player appears in the list of installed programs: You will need to configure the Flash Player using the Flash Global Settings website Ensure that Always allow option is selected. 6 Revised October 2010

7 APPENDIX A Deploying KA Content using SAP Productivity Pak Help LaunchPad or SAP Productivity Composer Help LaunchPad Understanding SAP Productivity Pak/Composer Help LaunchPad Note: The context-sensitive help (Help LaunchPad) is to be used only for SAP Knowledge Acceleration products developed for SAP systems. The SAP Productivity Pak Help LaunchPad for SAP Productivity Composer by RWD and documentation can be found and downloaded from the Service Marketplace (SMP). The SAP Productivity Pak Help LaunchPad installation includes.zip files containing a 2.4 MB library directory that contains a Microsoft Visual Basic (VB) application and all necessary VB dlls; an ActiveX control; and the files to be transported into SAP system. There are two methods for installing the SAP Productivity Pak Help LaunchPad into the SAP system are: ABAP Add-On using SAINT or Transport. The SAP Productivity Pak Help LaunchPad for SAP Productivity Composer by RWD can be installed in the SAP 4.6, 4.7, 5.0, and 6.0 (Enterprise) systems and the SAP APO and SAP CRM systems. The recommended method for providing stay-on-top functionality uses an ActiveX control downloaded to the user workstation inside Microsoft Internet Explorer. An alternative method uses an application to launch the browser; this application must reside on a Windows-based server on the Intranet/LAN or on the users' Windows-based PCs. Unix-based workstations can call custom help, but cannot deploy the stay-on-top view of the documentation. For more information about the SAP Productivity Pak Help LaunchPad, refer to the users guide for the SAP Productivity Pak Help LaunchPad. Installing and Configuring Context Sensitive Help The SAP Productivity Pak Help LaunchPad component is typically installed via the transport of a custom ABAP routine into the Development instance of SAP and then migrated to the Production instance. The custom ABAP routine is invoked directly from the standard SAP Help pull-down menu. This configuration requires a minor modification (single line entry) of the standard help menu and associated algorithm (standard SAP menu program MENU_SYST and function module HELP_START). All SAP Productivity Pak Help LaunchPad administration and user dialogs are delivered in U.S. English. Workstations supporting the SAP Productivity Pak Help LaunchPad installation must meet the specifications for author/administrator workstations plus the following requirements to facilitate implementation: Appropriate developer access rights to the SAP system to create custom objects, modify SAP objects, etc. Account on the SAP Online Service System (OSS) to register SAP objects. All SAP backend systems support custom help from the SAP GUI Help menu. The SAP Productivity Pak Help LaunchPad does not support SAP 4.5B Systems. SAP 4.5B backend systems do not support the following features: statistics, alerts, auto notifications, and auto upload. SAP 4.6, 4.7, ECC 5.0, and ECC 6.0 backend systems have no the SAP Productivity Pak Help LaunchPad feature restrictions. 7 Revised October 2010

8 SAP Enterprise Portal SAP Productivity Composer provides context-sensitive help for SAP Enterprise Portal 6.0 and 7.0 iviews. This solution is implemented by administrator-level users of the Portal who are familiar with Enterprise Portal framework installation and Portal Content Administration. This solution has been tested in the following specifications: SAP Enterprise Portal 6.0 SP17-20 and SAP Enterprise Portal 7.0 SP10-13 platforms Internet Explorer 6.0 SP1, 7.0, or 8.0 SAP Supplier Relationship Management SAP Productivity Composer provides context-sensitive help for SAP Supplier Relationship Management (SRM) 4.0, 5.0, and 6.0. This solution is implemented by administrator-level users of SAP SRM who are familiar with modifying objects via the ABAP Workbench Object Navigator (transaction SE80). This context-sensitive help solution supports only Microsoft Internet Explorer web browsers. SAP CRM Interaction Center Web Client SAP Productivity Composer provides context-sensitive help for the SAP CRM 2007 or 7 IC Web Client. This contextsensitive help solution uses SAP transaction SR13 to direct CRM 2007 or 7 page-specific help requests to the SAP Productivity Composer website. Web Applications SAP Productivity Composer content can be linked to web-based applications using unique screen identifiers (IDs) in the application. Deploying KA content using SAP Productivity Pak/Composer Help LaunchPad Note: The context-sensitive help (Help LaunchPad) is to be used only for SAP Knowledge Acceleration products developed for SAP systems. Before you can deploy the Knowledge Accelerator as context-sensitive help in SAP system, three activities must occur: SAP Productivity Pak Help LaunchPad must be installed on SAP system SAP Productivity Pak Help LaunchPad transports must be transported into the SAP system. The SAP Productivity Pak Help LaunchPad transports make use of SAP development namespaces. After transport, the SAP Help Menu and HELP_START function module must be customized. The Knowledge Acceleration source files have assigned SAP transaction code(s) that will be used to launch relevant content from the Help menu of the SAP system. Configure the Custom Help The transaction RWD/ZF0 is used to configure the Custom Help using the SAP Productivity Pak Help LaunchPad. Your SAP Basis Administrator must already have completed installation and configuration of the SAP Productivity Pak Help LaunchPad as a prerequisite for the subsequent steps. To launch the transaction, enter /n/rwd/zf0 and press Enter. 8 Revised October 2010

9 Creating a Help Server When deploying the custom help (Knowledge Acceleration published context) to the SAP system, you can choose an existing Help Server or you can choose to create a new Help Server. To create a new Help Server, click Server Setup. Enter a name for the new Help Server and click Create Server. 9 Revised October 2010

10 Fill in the required fields. Server Location: Location of the fastpaths folder. Example: Server Description: Text describing the help server Executable Location If you are using the Visual Basic application, enter the network or local location of the Visual Basic application. Example://server/directory/directory/ Adding Help for Transactions There are two options for uploading custom help using the /RWD/ZF0 transaction: single upload or batch upload. Single upload Can you add single and multiple files (multiple transactions)? Yes. If a transaction code has only one associated help content, you may choose to upload it individually. 1) Published the Knowledge Acceleration content deploy to your server (the Server Location specified in the Help Server configuration). 2) From the /RWD/ZFO transaction, click Transaction Setup 3) Enter the Transaction on the Work with Tcodes tab. 10 Revised October 2010

11 4) Click Execute 5) Specify the relative path to the content in the Fastpath Page field. Specify the Help Server in the Server field and click Execute Batch upload using Quick Launch pages Quick launch pages are created by SAP Productivity Composer by RWD during website publishing and are used in conjunction with the SAP Productivity Pak Help LaunchPad to provide context-sensitive help directly from SAP system. The quick launch pages are summarized in a text file (fp_upload.txt), which is uploaded into your SAP system. Quick launch pages are intermediate web pages listing content files with a common property, typically the transaction code. If only one content file contains a unique property, then the quick launch page is an HTML redirect to the content. If multiple content files contain a common property, SAP Productivity Composer by RWD builds an intermediate web page listing all content with this property. The Quick launch pages are uploaded using the batch upload with the fp_upload.txt file. 1. From the /RWD/ZF0 start page, click Transaction Setup. 2. Click Batch Upload/Download Transactions 3. Select Upload CSH Transactions with a file and leave the default settings. Click Execute. 4. Browse to the location of the fp_upload.txt file and click Open. 11 Revised October 2010

12 5. The batch upload will now complete. Accessing KA from Help menu of the SAP system To access Knowledge Acceleration from the help menu of the SAP system: 1. Start the transaction using the menu path or transaction code. 2. Select HELP > CUSTOM HELP to display the context-sensitive help in a browser window on top of the SAP application. Using KA with SAP Productivity Pak (SPP) There are two parts to the SAP Productivity Pak by RWD: Editor (Client): used to record, create, and edit content. Server: used to configure and manage the document library, website, glossary, and workflow functionality. This server interface is available via the Internet Explorer or Mozilla Firefox web browsers. 12 Revised October 2010

13 The server workspace provides access to several functions, including project and user account creation, workflow setup, glossary and publishing maintenance, reporting, and website setup, configuration, and customization. The following functionality is available via the server workspace: Create favorites, subscriptions, and tell others notices Participate in discussions Create and maintain user accounts Manage role and group assignments Create and maintain projects, document libraries, and websites Create and maintain the glossary Create and maintain publishing settings Create workflow routings Generate reports 13 Revised October 2010

14 Q: How can I access SAP Productivity Pak by RWD to check in content? A: You will need to have Client installed. The server administrator will provide you with required information to connect the Client to the server. From your Client, click Tools > Options and then General Settings under RWD uperform Server to establish connection to the server. Select Use RWD uperform Server and fill out Username and Password fields. Test Connection and if you get connection successful message, click OK. Note: You will need to ensure that the KA template is uploaded to the server before you can upload other KA source files. This step is required to be able to view any KA content on RWD Server (SPP). 14 Revised October 2010

15 Q: What KA content can be uploaded to SPP? A: Provided you have installed Client and correctly connected to the server, you can upload (Check in) the KA templates, simulations and courses. Once content is uploaded, you will be able to leverage the RWD uperform check in/checkout, versioning, workflow, and collaboration functionality. If you also have end user rights, you can access content via a standard web browser, provide feedback to authors, and collaborate with other users to share knowledge. Q: What are my options for deploying KA content to the SPP server? A: There are 3 options: 1. Import source files and assign them to the website (only simulations and courses) 2. Add managed documents (single files) 3. Add Web document (web link) (just point to web server where you have KA deployed); Example of web link: Note: You might ask administrator to add KA content on the web server (MS IIS) if you want to have all content on the same server. Q: What is the recommended best practice for deploying KA content to SPP? A: Assuming you want to keep all of the KA content together, it is recommended that you deploy the KA website package (from SAP Service Market Place) to any web server and simply add the URL to the SPP server. Note: All KA website packages that you download from SAP Service Market Place are published using SPC. Q: Could I be able to republish the original KA website that I have downloaded from SMP? A: You need to have SPC in order to republish KA website. However, if you pull in all content source files into SPP, you can re-architect a new website from within SPP. Q: How do I upload (Check-in) individual KA files to the server? A: Click File > Check in. You can import (Check-in) single (Check in Single File) or multiple files (Check in Multiple Files). Q: If I import the KA content individually, can I have additional simulations or courses from different courses assigned to KA? A: Yes, you can assign any course or simulation that resides on the RWD Server to your KA website. However, you will need to re-build that KA website. Q: How can I organize content for a new website using server? A: Upon import, all files are organized in alphabetical order by default. You can create folders and subfolders or you can name your files with numbers. For example, if you want to build a website on the RWD server, you can organize the modules in lessons. Be aware that content will be organized in folders, but in the folders they are sorted alphabetically. So you may have a structure like: Course 15 Revised October 2010

16 Lesson 1 <module name> Simulations S1: Working with S2: Changing a S3: Assessment Lesson 2 <module name> Simulations Note: That the simulation names will need to be pre-appended to sort correctly into the original KA order. This would need to be done from Client choosing File > Properties and then adding a file name (ex: S1: <sim name>). Q: Can I publish from server to an LMS? A: Yes, if your LMS is PENS compliant. If it is not PENS compliant, you can publish to LMS package, deploy it to the LMS, and then put the web link in the SPP server. Q: How do I create a new website on the SPP server? A: You need to go to the website folder (already created as part of your project) and then create folders or subfolders for your website content. You need to navigate to your document inside Document Library and then click Assign Website Context. After, you will need to publish your documents. Q: Can my KA users have single sign on? A: Only in SPP. SPC does not offer access control with a named user account. Q: Can I import and export Glossary and translation source files into SPP server for each KA? A: Yes, this can be done. You can export each glossary from SPC to a tabs delimited text file (standard functionality in SPC since version 3.1). Then you can import the glossary into the SPP server and assign a specific glossary to a specific context (project or folder). Copyright/Trademark 16 Revised October 2010