SAP Workforce Performance Builder 9.5

Transcription

1 Installation Guide Workforce Performance Builder Document Version: SAP SE or an SAP affiliate company. All rights reserved. CUSTOMER Producer

2 Table of Contents 1 Introduction About this Document List of Documents General Information Identification System Requirements Dependencies Upgrades Technical Support New Features Before you start SAP Notes for the installation Preparation Installation Files File Types Shortcuts Pre-parameterization of the Installer Use Prerequisites Procedure Prerequisites Procedure Installing the Producer Notes on updating the Producer Creating a Workarea Integrating Resources Migrating a Workarea Settings for Recording and Playback Post-Installation Database Files Registry Additional Information Uninstalling Producer Working with the Producer under Citrix Customer Introduction

3 5.2.1 Installation on the Citrix terminal server Seamless Load-Balancing Citrix Setting up an author environment watchdog Configuration of the watchdog Introduction Customer 3

4 1 Introduction This installation guide will provide you administrative support in using the SAP Workforce Performance Builder Producer as well as the applications required for creating and playing learning content. Various prerequisites need to be complied with when installing the Producer and when recording and playing lessons and specific settings applied. Once the installation has been completed and the appropriate settings applied, work can begin immediately on producing learning content in the Producer. Should you require help with the installation or the applicable settings, please contact support, which is available to assist you with any questions. You will find the necessary information and contact data in the "Technical support" section of this manual. 1.1 About this Document Purpose This document is intend to guide you through all installation and configuration processes which are necessary to successfully run your component of the SAP Workforce Performance Builder for first time. Constraints This document is not intended to give you information about user processes or configuration methods within the installed Producer. Go the chapter List of Documents to find more related documentation. 1.2 List of Documents The following table lists all documents available guides and manuals of the SAP Workforce Performance Builder: Document Link Producer Installation Guide SAP Help Portal Manual Producer SAP Help Portal Producer Security Guide SAP Service Marketplace 4 Customer Introduction

5 Document Link Instant Producer Installation Guide SAP Help Portal Instant Producer Manual SAP Help Portal Manager Installation Guide SAP Service Marketplace Manager Operations Guide SAP Service Marketplace Manager Manual SAP Help Portal Manager Security Guide SAP Service Marketplace Navigator Installation Guide SAP Help Portal SLC Player Installation Guide SAP Help Portal System Requirements SAP Help Portal 1.3 General Information Identification Property Value Software Name SAP Workforce Performance Builder Software Version 9.5 Component Name Producer Component Version (Build number: see installation file) Software Language <LCID decimal: Identifier> : English : German : Spanish Introduction Customer 5

6 Property Value : French : Hebrew : Dutch : Portuguese (Brazil) : Japanese : Korean : Russian : Chinese (Simplified) : Chinese (Traditional) : Czech : Danish : Finnish : Hungarian : Italian : Polish : Thai : Turkish : Indonesian : Vietnamese : Hindi : Malay : Arabic (Saudi Arabia) : Serbian Software Manufacturer SAP Installer Size (MB) ~ 62 MB Operating System Microsoft Windows 7 Microsoft Windows 8 (without tile mode) Microsoft Windows 10 (without tile mode) Included in software packages SAP Workforce Performance Builder Producer Description The Producer provides the authoring environment 6 Customer Introduction

7 Property Value which enables content developers to create, edit, localize, update and deploy high quality simulations, documentation, soft skill trainings, and navigations for their end users System Requirements Type Specifications 32 & 64 bit version of Operating system Microsoft Windows 7 Microsoft Windows 8 (without tile mode) Microsoft Windows 10 (without tile mode) Processor Pentium IV, at least 1 GHz Memory A minimum of 1 GB Hard drive 200 MB of free space Browser Microsoft Internet Explorer 11 Microsoft Edge 25 Any soundcard Soundcard For production of audio lessons and book pages Any microphone Microphone For recording of audio Scenario Requirement SAP Business Suite SAP GUI Scripting activated (serversided and role-specific) Introduction Customer 7

8 Scenario Requirement Java Applications Java Access Bridge installed Documentation Generation Microsoft Office (Word and PowerPoint) Microsoft Office 2007 and Plug-In Microsoft Save as PDF Generation PDF Microsoft Office Aris Import Symbio 4.2 (license required) ViFlow ViFlow 5.0 HPQC HPQC Dependencies The package has dependencies: Software / Package Name Version Operation System 32 & 64 bit version of Microsoft Windows 7 Microsoft Windows 8 (without tile mode) Microsoft Windows 10 (without tile mode) Browser Internet Explorer 11 Documentation Generation (Microsoft Word / PowerPoint) Microsoft Office Documentation Generation (PDF) Microsoft Office 2007 and Plug-In Microsoft Save as PDF Microsoft Office Aris Import Symbio installation (license required) 8 Customer Introduction

9 1.3.4 Upgrades Does the package upgrade existing package(s): Resource structure (workarea) Read according chapter Migration of a Workarea 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-PRO // Workforce Performance Builder Producer KM-WPB-IPR // Workforce Performance Builder Instant Producer KM-WPB-MGR // Workforce Performance Builder Manager KM-WPB-NAV // Workforce Performance Builder Navigator KM-WPB-CXH // Workforce Performance Builder Context Sensitive Help KM-WPB-APR // Workforce Performance Builder Application Profiles KM-WPB-SMI // Workforce Performance Builder Solution Manager Integration 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: Introduction Customer 9

10 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. 1.4 New Features Please read the What's New document according to your version to find out newly implemented functions as well as enhanced features in your component of the SAP Workforce Performance Builder. The What's New documents are to be find in the SAP Service Marketplace. 1.5 Before you start SAP Notes for the installation You must read the following SAP Notes before you start the installation. These SAP Notes contain the most recent information on the installation, as well as corrections to the installation documentation. Make sure that you have the up-to-date version of each SAP Note, which you can find in the SAP Support Portal at the Internet address: Use the following component identifiers to filter SAP Notes Search by filter Application Area: KM-WPB // Workforce Performance Builder KM-WPB-PRO // Workforce Performance Builder Producer KM-WPB-IPR // Workforce Performance Builder Instant Producer KM-WPB-MGR // Workforce Performance Builder Manager KM-WPB-NAV // Workforce Performance Builder Navigator KM-WPB-CXH // Workforce Performance Builder Context Sensitive Help KM-WPB-APR // Workforce Performance Builder Application Profiles KM-WPB-SMI // Workforce Performance Builder Solution Manager Integration 10 Customer Introduction

11 2 Preparation Recommendation Check the chapter Additional Information to avoid installation conflicts which might come up in a special scenario. Preparation Customer 11

12 3 Installation 3.1 Files Location Path Default application location %ProgramFiles%\SAP Workforce Performance Builder\Producer <Version> Default workarea location %USERPROFILE%\Producer Workareas 3.2 File Types The installation and the use of the Producer results in registration/existence of new file formats. File suffix Symbol Identification Archive to exchange contents and *.dkp resources between: Producer Instant Producer Self-starting deployment output *.exe containing contents and resources needed for playback. Deployment output for SAP *.slc Learning Center containing contents and resources needed for playback. *.dpr Project file containing project properties during editing. 12 Customer Installation

13 File suffix Symbol Identification *.dnt Desktop assistant file used for content playback. Deployment control file containing *.deploy list of assets to be used for deployment. Control file for communication with *.meta Manager workarea containing information about object state and ownership of write token. 3.3 Shortcuts Application Shortcut Producer 3.4 Pre-parameterization of the Installer Use Pre-parameterization of the Installer file will enable you to roll-out Producer in one or more central remote installation scenarios whereas you can predefine or restrict Producers behavior on workarea creation as well as on resource handling. Furthermore you can provide connection data to an already existing instance of the SAP Workforce Performance Builder Manager without the need to send it separately. Installation Customer 13

14 3.4.2 Prerequisites To pre-parameterize the installation process of the Producer you will need the following prerequisites: 1. Producer installation file, e.g. SAP-Workforce-Performance-Builder-Producer-<version>-<init. language>.msi. 2. Windows command line. Open the Run dialog (Windows key + R), type in CMD and press Enter. 3. In some cases a Text editor application like the Windows build-in "Notepad" Procedure The following cases show up scenarios to pre-parameterize the installation process of the Producer. You may combine given commands but note that some combinations will have side effects. To combine commands just add commands divided with a space character like in following syntax example. Syntax msiexec /i <path of msi file> INITWA=... ADDITIONAL_INITWA=... Recommendation Using a path which contains spaces you will have to declare the path in command line by enclosing it with quotation marks ("..."). Side effects of parameter combinations 1. Combination of wa_path_fixed with default_wa_path and/or initial_create_wa 1. wa_path_fixed will be taken, other parameters will be ignored 2. Combination of default_wa_path and initial_create_wa 1. initial_create_wa will be taken 2. if initial_create_wa is not accessible, default_wa_path will be taken Set default suggested workarea path Target Individualize workarea path suggested to the user on first run of Producer. Use 14 Customer Installation

15 Provide a suggestion to save the workarea at another path than default, e.g. to enable users to save their contents at a special storage indexed for backup policies. Users still are able to specify an individual path to store the workarea. Procedure 1. Open command line. 2. Type in the following command. Replace the <placeholders> with your individual values. Syntax msiexec /i <path of msi file> DEFAULT_WA_PATH=<default path> 3. Finish installation. Result On first run the Producer opens the select/create workarea dialog suggesting the individualized path by default. Registry Registry node Registry key HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\SA P WPB\Producer<version*> DefaultWAPath Set default workarea path without possibility to change Target Specify workarea path to be initially created and deny the individual creation of workarea at another path. Use Force users to use a specific storage path only and disallow the creation of other workareas not fulfilling the storage criteria. This might be useful in case of using Citrix environments with auto rollback function or for testing purpose. Procedure 1. Open command line. Installation Customer 15

16 2. Type in the following command. Replace the <placeholders> with your individual values. Syntax msiexec /i <path of msi file> WA_PATH_FIXED=<fixed WA> 3. Finish installation. Result On first run the Producer doesn't show the select/create workarea dialog but automatically creates the workarea at the given path. The menu item to change/create workarea will be disabled. Registry Registry node Registry key HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\SA P WPB\Producer<version*> WAPathFixed Create initial workarea automatically Target Create initial workarea directly at specified path without displaying the select/create workarea dialog. Use Auto create a workarea at a special system path without needing the user to know where to store. Procedure 1. Open command line. 2. Type in the following command. Replace the <placeholders> with your individual values. Syntax msiexec /i <path of msi file> INITIAL_CREATE_WA=<INITCREATEWA> 3. Finish installation. 16 Customer Installation

17 Result No select/create workarea dialog will be shown on first run of the Producer but the initial workarea will be created automatically within the path specified. Registry Registry node Registry key HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\SA P WPB\Producer<version*> InitialCreateWA Individualize resource source location Target Individualize the path the Producer takes its resources from on initial workarea creation or edit configuration. Use Provide a set of initial resources independently from changes to initial resources which might come up with Producer updates. This will enable you to manage and roll-out initial resources globally. Procedure 1. Go to the installation directory of an already existing Producer installation (Default: C:\Program Files (x86)\sap Workforce Performance Builder\Producer<version*>). 2. Copy the content of the INITWA folder (..\initwa). 3. Create individual folder, e.g. "myinitwa", and paste the files from INITWA folder. 4. Open command line. 5. Type in the following command. Replace the <placeholders> with your individual values. Syntax msiexec /i <path of msi file> INITWA=<INITWA> 6. Finish installation. Result Installation Customer 17

18 On workarea creation or edit configuration the Producer will import its resources from individualized INITWA folder. Registry Registry node Registry key HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\SA P WPB\Producer<version*> InitialWA Specify additional resource source location Target Add an additional source path the Producer takes its resources from on initial workarea creation or edit configuration. Use Provide a set of custom resources to be included or restored on workarea creation or configuration. Procedure 1. Create individual folder and insert different resources as in INITWA folder. 2. Open command line. 3. Type in the following command. Replace the <placeholders> with your individual values. Syntax msiexec /i <path of msi file> ADDITIONAL_INITWA=<ADDTIONALINITWA> 4. Finish installation. Result On workarea creation or edit configuration the Producer will import its resources from individualized additional INITWA folder as well. Registry 18 Customer Installation

19 Registry node Registry key HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\SA P WPB\Producer<version*> AdditionalInitWA Specify path for automatical resource updates Target Specify resource path to automatically update resources if more recent versions are available. Use Force the user to use a custom set of resources and its most recent versions at any time. Procedure 1. Create individual folder and insert more recent resources as in Producers INITWA folder. 2. Open a text editor and create file update.xml like the following. Add one <Resource> line for each resource to be taken. Syntax <?xml version="1.0" encoding="utf-8"?> <root> <Application name="producer"> <AppVersion Minimum="9.2" Maximum="999" IncludeMinimum="true" IncludeMaximum="true"/> <Resource mandatory="true" method="auto" title="my settings">c:\autoupdateproducer\mysettings.dkp</resource> </Application> </root> 3. Save the XML file to the folder to be used as source for auto update. 4. Open command line. 5. Type in the following command. Replace the <placeholders> with your individual values. Syntax Installation Customer 19

20 msiexec /i <path of msi file> AUTOUPDATE_PATH=<AUTOUPDATEFOLDER> 6. Finish installation. Result The Producer will import the resources from individual specified folder on Producer startup, on workarea creation or when update-time-interval is expired. The updates path is shown within the Producer settings. Note If AUTOUPDATE_PATH is enabled, manual changes to according parameters in settings dialog are disallowed. Resources imported by auto update function cannot be deleted manually. If a resource specified in the XML file is not available within specified folder the Producer will display an error message on startup. Registry Registry node Registry key HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\SA P WPB\Producer<version*> AutoUpdatePath Predefine Manager connection Target Provide values for a connection to the Manager to prefill connection dialog. Use Enable users to easily connect with an existing Manager instance. Procedure 1. Download connection file from Manager (click on Connect Producer). 2. Open command line. 3. Type in the following command. Replace the <placeholders> with your individual values. 20 Customer Installation

21 Syntax msiexec /i <path of msi file> MANAGER_CONNECTION=<path to connection file> 4. Finish installation. Result On opening Connect with Manager... dialog the dialog fields are filled out with the connection values from the connection file. The user just has to enter password. On startup of Producer it will be checked if an URL mismatch between user/administrator setting exists and, if so, a message box will prompt for confirmation to keep user settings or re-apply administrative settings. Recommendation You may want to provide connection path only without individual username. In this case open the connection file with a text editor and empty or anonymize (e.g. "<enter your username here>") the parameter Authentication user. In this case no message will appear to user, since the URL settings check will fail in any case. Registry Registry node Registry key HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\SA P WPB\Producer<version*> ManagerConnection 3.5 Prerequisites You will need the ability to run the installer with administrator permissions for the PC on which the Producer is to be installed. Note To install on a Citrix terminal server please refer to the chapter on working under Citrix. Installation Customer 21

22 3.6 Procedure Installing the Producer To install Producer, perform the following steps: 1. Start the installation program by double-clicking the installation file program icon. 2. The installation program will guide you through all the steps for installing the Producer. Now follow the instructions in the displayed dialog. 1. A welcome dialog with the Producer version will be displayed. Click on the Next button. 2. Select the installation folder. This will be proposed to you by the Producer in C:/Program Files/SAP Workforce Performance Builder. The Browse... button allows you to change the installation location. A dialog will open allowing you to select a different folder. 3. Initiate the installation process by clicking on the Install button. The installation will now be executed. 3. Once the Producer has been installed, you can close the installation program by clicking on the Finish button. If the Run Producer setting is activated, the Producer will be opened when the dialog is closed. In general use, you can launch the Producer by double-clicking on the Producer icon on the desktop or via the start menu, from Programs -> SAP Workforce Performance Builder Notes on updating the Producer In case you update an already existing installation of the Producer note the following information Update Producer using a service release version (SP) If you want to update an already existing Producer installation to a newer service release (SP) without a change of the major version the installation program will recognize the existing installation and automatically overwrite existing program components within the installation process. Opening an already existing workarea as created with formerly installed version the migration assistant will appear, offering you to update your workarea resources to most recent resource version. Proceed as described in chapter Migrating a Workarea. 22 Customer Installation

23 Update Producer to next major version If you want to install a new major version (e.g Producer 9.2) note that any already installed previous major version (e.g. Producer 9.1) won't be uninstalled automatically. Both versions can be installed side by side in your system. This enables you to work on different workareas having different version requirements. However, consider to use only one Producer version on each workarea you have. Don't open workareas which have been created or migrated by your most recent Producer version with any older Producer version or vice versa when the workarea has to stay editable for other authors using the same older Producer version. In case the older Producer version is not required anymore you have to uninstall it manually. Read chapter Uninstalling Producer in Additional Information on how to do so. Consider to select the correct Producer version in the application list since at least two entries will be available Update Producer using a custom program path In case you installed your previous Producer version to a custom path like D:\programs\Producer and you want to install your new major Producer version by using the same custom path you should uninstall the previous Producer version before to avoid unnecessary entries in your systems program list. After uninstallation of the previous version you may use your custom installation path again Creating a Workarea To create a workarea, proceed as follows: 1. Select the Select or Create Workarea... in the toolbar. A dialog box is opened. 2. Select Create Workarea. The workarea selection dialog box is opened. 3. Enter the following: 1. Target Folder: Enter the target folder. Select Browse... button to open the Browse For Folder dialog box. The default folder for workareas is: %USERPROFILE%/Producer Workareas/Workarea 2. Description: Enter a description for the workarea. The description can be used to describe the content and the use of the workarea. The description is displayed when selecting a workarea. Installation Customer 23

24 3. Resources: The list displays the standard resources for workareas. You can change the selection to specify the resources to be used. 4. Select Create to set up the workarea. The required files are now copied into the target folder. Afterwards, you can finish the creation process by clicking on OK. The workarea is opened in the project explorer and the resources and Content group are now created within the tree structure. Note The standard installation resources are set up when a workarea is created. You can then insert individual resources, such as customized styles or application profiles, in your workarea by using Workarea -> Import Archive... Changing the workarea description The workarea description can be changed in the Workarea object of the tree. Change the text in the Description parameter Integrating Resources Individual Workarea resources can be integrated in the Producer. For example, these can be: Individual application profiles Customized styles (library, trainer, bubble type etc.) Customized document templates Text files for the project languages Importing resources The resources are imported as archive files in DKP format (*.dkp). 1. To do so, navigate in the Project Explorer to Import Archive... in the Workarea menu. 2. Select the archive file you want. You may select one or a number of files. 3. A dialog will then open at the same time as you are shown the contents of the archive file. Now select whether to import the entire archive or only part of it. Confirm your selection by clicking on OK. Your resources will now be imported into, and be available in, the Workarea. A number of resources need to be activated for use as the default. Select the appropriate resource in the Producer's resource tree and click on Set as default in the object editor. You will find additional information about the resources in the Producer Manual. 24 Customer Installation

25 Managing resources in the Manager workarea In order to make certain resources available to all of a Manager workarea's users, save these resources from your Producer into the Manager workarea. To do so, select the resource and click on Store on the server... in the Manager Workarea menu. An author can store this resource in his local workarea using the Fetch objects... function in the Manager Workarea function Migrating a Workarea Migrating a workarea allows you to update the workarea resources to a newer Producer version. The migration is necessary, as a newer version of the Producer includes changes in the resources and the resource structure. During the migration the resources will be changed to the new requirements and your own resources will be converted. The migration does not change the content of the workarea. The migration of a workarea has to be done for: a new release (Major Release) a service pack The migration of a workarea depends on your SAP Workforce Performance Builder Edition and includes the following steps: Desktop Edition - local workareas 1. Backup of the workarea 2. Preparation of the migration 3. Installation of the new Producer version 4. Migration of the workarea Enterprise Edition - Manager and local workareas 1. Backup of the database and corresponding files 2. Backup of the local workareas 3. Preparation of the migration 4. Checkout of write permissions for the resources by the master author 5. Installation of the new Producer version 6. Upgrade to the new Manager version 7. Creation of a new Manager password (only Migration from 9.1) 8. Migration of the Manager workarea by the master author 9. Migration of the local workareas by the standard authors Installation Customer 25

26 Note The migration is only possible for workareas from the Producer version 9.1. Older workareas have to be updated at first in a Producer 9.1 and afterwards to be migrated into the current Producer version. Note After the migration it is not possible to use the workarea in an older Producer version. Migration of user-defined resources A workarea can include user-defined resources for the creation of individual learning content. Typical userdefined resources are bubble styles, settings or templates. During the migration, user-defined modifications and settings will be kept and converted into the new resource structure. The adaptations won t be deleted. In a workarea with an up-to-date resource structure imported resources have to be migrated individually. Migration of an Instant Producer workarea The workarea migration of an Instant Producer for the Enterprise Edition is executed automatically after the first start of the program. The workarea migration of an Instant Producer for the Desktop Edition can be done after the migration of the resources in the Manager workarea (see chapter Manager Workarea - Enterprise Edition). The synchronization is executed automatically after the first start of the program Local Workarea - Desktop Edition The migration of a workarea for the Desktop Edition allows you to update a local workarea of your Producer. Preparation for the migration Before migrating a workarea the following preparations and requirements are necessary: Backup workareas Before migrating a workarea make an archive, which you can revert to in the event of any problems. This can be done with the Export Archive... function in the menu Workarea -> Administration. Update workareas to version 9.1 The migration is only possible for workareas from the Producer version 9.1. Older workareas have to be updated at first in a Producer 9.1 and afterwards to be migrated into the current Producer version. Take a note of trainer Configurations (only Migration from 9.1) The settings of the trainer Configuration (old trainer) won't be converted. Before migrating the workarea take a note of your configurations. After the migration adapt the Playback Settings with your configurations. 26 Customer Installation

27 Migration of the workarea The migration of a workarea can be executed as follows: 1. Install the new Producer version. 2. Open the Producer. 3. Open the workarea by clicking on Workarea -> Select Workarea A dialog box is opened. Click on Migrate Workarea to migrate workarea with recommended settings. Click on Show Details. Afterwards the workarea migration dialog box opens. The dialog box shows the recommended migration action for each available resource group. Adapt the resource actions using the dropdown box. It is recommended that you keep the settings. Adaptations are only necessary in a few situations, if no changes should be made. For further information on the settings see the chapter Migration Dialog Box. Click Migrate Workarea to start the migration. 5. The migration will now be executed. 6. Click OK in the progress dialog, if the migration is completed. 7. With the finishing of the migration a folder with log files opens. The folder contains archives with the changed and removed resources, as well as log information. The folder is located in the workarea folder. 8. Click Restart in the dialog box. Restarting the Producer is necessary so that the new resources and configurations can take effect. Note Do not import the outdated resources of the log folder into your workarea again Manager Workarea - Enterprise Edition When updating the workarea in an authoring environment with a Manager workarea and a number of local workareas, it is necessary that the master author performs the update in one local workarea and afterwards deploys it to the other local workareas. This achieves a consistent use of the needed resources. Preparation for the migration Before migrating a Manager workarea the following preparations and requirements are necessary: Installation Customer 27

28 Caution Make sure, that the preparations and requirements are fulfilled before you perform the migration. This is necessary to avoid errors during the migration process as well as in the migrated workarea. Note Consider the SAP Note about the clean up of deleted files in a database of Manager 9.1. Backup Manager workareas and local workareas Before migrating a workarea make an archive, which you can revert to in the event of any problems. This should be done for the Manager workarea on the Manager as well as for the local workareas of the authors. Update workareas to version 9.1 The migration is only possible for workareas from the Producer version 9.1. Older workareas have to be updated at first in a Producer 9.1 and afterwards to be migrated into the current Producer version. The migration of a Manager workarea is only possible from the Manager version 9.2 or higher. Consider the following: Upgrade Manager Upgrade your Manager 9.1 to the version 9.2 or 9.x. The Manager can handle the new resources and resource structure. Create new passwords With the Manager 9.2 the password encryption is optimized and old passwords are expired. Create a new password for your login in Manager. This is necessary for all master and standard authors. The creation of a new password is only necessary for non LDAP-based users. Further information about the upgrade of a Manager is available in the Operations Guide. Save write permissions centrally Save all write permissions of the resources to the server. The write permissions are necessary for the master author to migrate the resources. This can be done by selecting a resource and clicking Finish editing. Take a note of trainer Configurations (only Migration from 9.1) The settings of the trainer Configuration (old trainer) won't be converted. Before migrating the workarea take a note of your configurations. After the migration adapt the Playback Settings with your configurations. Migration steps for the master author The migration can be executed by the master author as follows: Steps in old Producer and Manager version 1. Open the workarea in the old Producer version. 2. Open the workarea by clicking on Workarea -> Select Workarea... If the authentication dialog box appears, insert your user data with the new password. 28 Customer Installation

29 3. Start editing resources to get all write permissions. Select the Resources tree and click on Manager Workarea -> Start editing all objects Close the Producer. 5. Click Shut down in the opened dialog box. Do not return the write permissions. 6. In Manager delete all resources from the trash do avoid the restore of the objects. Steps in new Producer and Manager version 1. Upgrade the Manger to the new version. 2. Install the new Producer version. 3. Open the Producer. 4. Open the workarea by clicking on Workarea -> Select Workarea The authentication dialog appears. Insert your user data with the new password. Note Log on with the user data as used for the checkout of the write permissions to avoid permission errors. Through the switch of the Producer versions the authentication dialog may appear twice. Insert your user data again. 6. A dialog box is opened. Click on Migrate Workarea to migrate workarea with recommended settings. Click on Show Details. Afterwards the workarea migration dialog box opens. The dialog box shows the recommended migration action for each available resource group. Adapt the resource actions using the dropdown box. It is recommended that you keep the settings. Adaptations are only necessary in a few situations, if no changes should be made. For further information on the settings see the chapter Migration Dialog Box. Click Migrate Workarea to start the migration. 7. Click Migrate Workarea to start the migration. The migration will now be executed. During the migration the write permissions of the resources to be deleted are removed automatically. 8. Click OK in the progress dialog, if the migration is completed. 9. The synchronization of all resources with the Manager workarea is started automatically. Click OK in the progress dialog, if the synchronization is completed. 10. Click Restart in the opened dialog that the changes can take effect. Installation Customer 29

30 Recommendation The migrated resources have the synchronization status Edit and own. If you want to finish the editing change the status to Edit and share. Note Do not restore outdated resources from the trash of the Manager workarea in your local workarea. Migration steps for the standard author After the migration of the Manager workarea by the master author the standard author can migrate the local workarea as follows: 1. Install the new Producer version. 2. Open the Producer. 3. Open the workarea by clicking on Workarea -> Select Workarea The authentication dialog appears. Insert your user data with the new password. 5. After the workarea opens, the synchronization of the resources with the Manager workarea starts automatically. If the authors use an Instant Producer the synchronization of the workarea is executed automatically after the start of the program. Migration of unmanaged resources A local workarea can contain unmanaged resources. After migrating the managed resources the unmanaged resources are migrated. See Local Workarea Migration Dialog Box The migration dialog box opens automatically, if the workarea contains outdated resources. The dialog box contains different setting areas for structuring the resource groups. Each resource group has an individual migration action. Migration setting areas The migration dialog box contains the following setting areas: Required Resources: Contains resources, which have to be installed. The resources are necessary for content creation and playback. Incompatible Old Resources: Contains outdated resources, which have to be replaced with a newer resource type. 30 Customer Installation

31 Recommended Resources: Contains resources, which can be installed optionally. Compatible Old Resources: Contains resources of the same type, which have to be updated. Created User Resources: Contains created user resources, which have to be updated. Customized User Resources: Contains adapted user resources, which have to be updated. Same Version Read-Only: Contains migrated and managed resources. The areas that are shown depend on the available resources. Migration actions The following migration actions can be executed for a resource: Migrate: Migrates an available resource to the new version. Keeps all changed settings. Install: Integrates a new resource into the resource structure. Overwrite: Replaces the files of an available resource with the new version. Skip: Keeps the current resource status. Convert: Updates the files and structures of an available resource. Remove: Deletes an outdated resource from the structure. When selecting a resource, you will see the version and included sub-resources in the help box at the bottom of the dialog box Migration of Imported Resources (Conversion) Beside the migration of a complete workarea single outdated resources can be migrated after the import into an up-to-date workarea. This can be done for own styles or to use own settings of an older version. The resources will be inserted as additional resources in the structure and marked with converted. In the workarea available resources won't be overwritten. Migration of resources Installation Customer 31

32 For the migration of imported resources, proceed as follows: 1. Open the Producer with an up-to-date workarea. 2. If you use a Manager workarea, start the editing of the resource group to get the write permission. 3. Import the resource archive by using the menu entry Workarea -> Administration -> Import Archive In the opened dialog select the archive and click Open. 5. In the import dialog select the resource and click Ok. 6. After the import of the resource the migration dialog opens automatically. Click Ok to start the migration. The migration will now be executed. 7. With the finishing of the migration a folder with log files opens. The resources are stored in the resource structure and marked as converted. 8. If you use a Manager workarea, save the resources to the server. Handling of migrated resources The screenshot shows an example for converted resources after the import of a Standard resource. The settings and documentation templates are created in the resource structure of a current version. The resources marked with converted and number 2 (or higher) for the second object of a resource type. The converted resources are additional resources and can be used as standard resources or can be deleted, if not required. In this case, the settings can be activated in the Configurations resource and the Documentation Style in the Documentation Settings. 32 Customer Installation

33 Note, that it is not possible to change the name of the resources. Import only needed resources to keep a clearly structure Settings for Recording and Playback Depending on your scenario the setup of some settings may be required for recording and rerecording applications as well as for the playback of recorded contents. Read the chapter "Settings" in the application help of the Producer for detailed instructions. Consider to check the application manual on SAP Help Portal for most recent instructions. Installation Customer 33

34 4 Post-Installation 4.1 Database The package does not connect to a database. 4.2 Files The package needs to add/replace/remove files: Filename/Directory Action Application installation folder (Default: %PROGRAMFILES(X86)%\SAP Workforce Performance Builder\Producer<version> ) Create folder and add anxillary structure Replace anxillary files (on update) Remove folder (on uninstallation) Workarea directory (Default: %USERPROFILE%\Producer Workareas\<name of workarea> ) Create folder Create anxillary folders and files Replace anxillary folders and files Remove anxillary folders and files Desktop Shortcut Create shortcut Remove shortcut (on uninstallation) 4.3 Registry The package needs to add/update/remove registry keys values: Registry Key Action HKEY_CURRENT_USER\Software\SAP 34 Customer Post-Installation

35 Registry Key Action WPB\Producer<version*>\install add entries (on installation) remove entries (on uninstallation) HKEY_CURRENT_USER\Software\SAP WPB\Expert add entries change entries remove entries HKEY_CURRENT_USER\Software\SAP WPB\FileControl add entries change entries remove entries HKEY_CURRENT_USER\Software\SAP WPB\FileSelector add entries change entries remove entries HKEY_CURRENT_USER\Software\SAP WPB\Producer<version*> add entries change entries remove entries HKEY_CLASSES_ROOT\.dnt add entries (on installation) remove entries (on uninstallation) HKEY_CLASSES_ROOT\.dpr add entries (on installation) remove entries (on uninstallation) HKEY_CLASSES_ROOT\.slc add entries (on installation) remove entries (on uninstallation) HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Wind ows\currentversion\installer\folders add entries (on installation) remove entries (on uninstallation) HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Wind Post-Installation Customer 35

36 Registry Key ows\currentversion\installer\userdata\<id> \Components Action add entries (on installation) remove entries (on uninstallation) HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\SA P WPB\Producer<version*> add entries (on installation) remove entries (on uninstallation) *In Windows Registry version numbers are written without periods. 36 Customer Post-Installation

37 5 Additional Information 5.1 Uninstalling Producer If you would like to uninstall the Producer, this is done from the Control Panel -> Programs -> Programs and Features menu: 1. A dialog will open listing all the programs on your PC. Select the Producer. 2. Click on the Remove button. 3. A dialog will open. Initiate the uninstallation process by clicking on the Yes button. 4. The Producer will be deleted from your PC. When uninstallation is complete you can close the Software dialog. Note When uninstalling the Producer only the program is deleted. The workareas that were created are retained for further use. Alternatively you can also perform the uninstallation using the installation file from the corresponding version of your Producer: 1. To do so, launch the installation program by double clicking on the installation file. 2. Then click on Next. 3. Select the option Remove and confirm your selection by clicking on the Remove button. The Producer will now be uninstalled. 5.2 Working with the Producer under Citrix Certain requirements and settings are necessary in order to be able to use the Producer in a Citrix environment to ensure that projects are successfully recorded. Note The Producer should preferably be installed on the terminal server as, with local installation, recording using the Citrix client is only possible with graphical object recognition. The Citrix clients So-called clients are required to access the Producer and the applications on the terminal server.lease note: Additional Information Customer 37

38 Use a version 11.0 Citrix client or later. With older versions, there can be no guarantee that working with the Producer will be trouble-free Installation on the Citrix terminal server You can install the Producer directly on a terminal server, thereby making it available to the authors. This is the recommended installation as it allows the Producer to access the various object recognition interfaces instead of being blocked by the Citrix client when installed locally. Internet Explorer, for postprocessing of the projects, as well as Microsoft Office for generating documentation are also to be installed on the same server and started in the same session. Note When working with Producer, ensure that you always implement each application you are using on the same server and start it in the same session. This is necessary for trouble-free recording, postprocessing and publication of the projects. Customizing display characteristics The following system settings are also to be applied: Set a color depth of 24 bits for the terminal server, workstation and Citrix client. Ensure that you apply matching settings for the systems. Deactivate Screen font anti-aliasing on the terminal server and author workstation Seamless Load-Balancing Citrix With a seamless transmission and for load-balancing, take care to ensure that the Producer and the application to be recorded are launched in one session from the same server. Special attributes when using load-balancing: The Producer has to be installed on each server in the cluster. Do not install the Producer on the virtual server, which is there to balance the load between the servers. Special attributes when using seamless: Set the same parameters (resolution, color depth, encryption) when publishing the Producer via Citrix and for the target application. Functional test for seamless transmission Once the Producer has been provided via seamless transmission, a test should be run to establish whether Internet Explorer can be launched from within the Producer. 38 Customer Additional Information

39 If the Producer cannot be launched, seamless transmission must be converted to desktop for each author on a one-time basis. The Producer is then launched using desktop transmission and Internet Explorer is started. If launch is possible, the transmission can be switched back to seamless Setting up an author environment When creating projects, it is recommended that an author environment be set up for the authors on a separate server on which the authors are given access to all the necessary applications, settings and rights. This ensures that the Producer will operate smoothly and free from errors. Also pay attention here to the section: Installation on the Citrix terminal server. The author workstations can be regular workstations or else be set up as thin PCs. Thin PCs are workstations on which only one operating system is installed and which draw their data and applications from a server. The following overview summarizes the necessary requirements to be borne in mind for an author environment: Author workstations & Terminal server Author environment Producer installation Installation of applications to be recorded Internet Explorer with corresponding access rights Microsoft Office for creating documentation Matching settings for color depth and resolution Deactivation of screen font anti-aliasing. For the recording: Launching of the Producer and target application in the same session 5.3 watchdog The watchdog is a functionality of SAP Workforce Performance Builder and is used to show a feedback to the user if a product component is not responding during a process. Additional Information Customer 39

40 In such a case a dialog box with a hint is opened. The dialog box contains the following buttons: Restart: Restarts the Producer. Please Wait: Waits for finishing the process. The Producer will not be closed. Close: Closes the product component. In case of an exception the button is displayed instead of Please Wait. Open Log Folder: Opens a folder with a log file and closes the Producer. The log file contains information about the executed processes and can be used by the support to analyze the occurred problem. The log files are stored in the folder: C:\Users\User\AppData\Local\Temp\Low\watchdog_logfiles Configuration of the watchdog You can adapt the configuration of the watchdog to influence the behavior and the usage of the JavaScript Console. This allows you to change the response time or to specify the log information. The configuration can be changed in the file watchdog.xml. The file is stored in the installation folder of the product component. Open the file to adapt the parameters. The XML structure is defined as follows: <?xml version="1.0" encoding="utf-8"?> <Settings> <General SleepMode="0" DebugMode="0"/> <Log Console="1" Display="0" OPT_Size="20" WatchDogLog="0" /> <Heartbeat Pulse="60000" Threshold="1" /> <TopWindows List="#32770,ipro.basewnd" /> <ExcludeWindows List="dgoEffectWindow" /> </Settings> The XML contains the following parameters: Parameter Description General 40 Customer Additional Information

41 Parameter Description Specifies if the JavaScript Console is shown. The Producer will not be closed, if the window is opened. The JavaScript Console shows details about the last DebugMode steps. Set to: 1 - JavaScript Console is activated 0 - JavaScript Console is deactivated (default) Defines, if the watchdog is displayed. SleepMode Set to: 1 - watchdog is activated (default) 0 - watchdog is deactivated Log Specifies that the trace is displayed in the JavaScript Console. Console Set to: 1 - activated (default) 0 - deactivated Specifies if the JavaScript Console is opened when the program starts. Display Set to: 1 - JavaScript Console will be opened 0 - JavaScript Console will not be opened (default) Specifies the maximum size of tracked operations OPT_Size (OpTracker). Set to: define a value - default is 20 Specifies if further technical details of the watchdog WatchDogLog are inserted into the log files. Set to: Additional Information Customer 41

42 Parameter Description 1 - activated 0 - deactivated (default) Heartbeat Defines the interval of checks in milliseconds. The Pulse default value is 6000 ms (1 min). Set to: define a value: e.g ms (5 min) Specifies the number of tries, before the watchdog Threshold appears. Set to: define a value - default is 1 TopWindows List Specifies the top-level window, which is checked if a thread is frozen. ExcludeWindows List Specifies the excluded window, which is ignored for the check. 42 Customer Additional Information

43 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. Additional Information Customer 43

44 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: 44 Customer Additional Information

45 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.