SAP Workforce Performance Builder 9.3 Producer Manual

SAP Workforce Performance Builder 9.3 Producer  Manual
Manual
Workforce Performance Builder
Document Version: 1.0 – 2014-10-15
SAP Workforce Performance Builder 9.3
Producer
CUSTOMER
Typographic Conventions
Type Style
Description
Example
Words or characters quoted from the screen. These include field names, screen titles,
pushbuttons labels, menu names, menu paths, and menu options.
Textual cross-references to other documents.
2
Example
Emphasized words or expressions.
EXAMPLE
Technical names of system objects. These include 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.
Example
Output on the screen. This includes file and directory 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, F 2 or E N T E R .
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Typographic Conventions
Table of Contents
1
1.1
1.2
1.3
SAP Workforce Performance Builder Producer ....................................................................................... 14
Technical Support .......................................................................................................................................... 14
System Requirements .................................................................................................................................... 15
Uninstalling Producer ..................................................................................................................................... 16
2
2.1
Settings ......................................................................................................................................................... 17
Authoring settings .......................................................................................................................................... 17
2.1.1
Required System Settings .............................................................................................................. 17
2.1.2
Settings for Recording .................................................................................................................... 19
2.1.3
Settings for Editing ......................................................................................................................... 25
2.1.4
Playback settings ............................................................................................................................ 25
Learner settings.............................................................................................................................................. 25
2.2.1
Browser Requirements ...................................................................................................................26
2.2.2
Settings for Internet Explorer ......................................................................................................... 27
2.2.3
Settings for Mozilla Firefox ............................................................................................................. 32
2.2.4
Safari Settings.................................................................................................................................33
2.2.5
Settings on iPad ..............................................................................................................................33
2.2.6
Settings for E-Mails .........................................................................................................................34
2.2
3
3.1
3.2
3.3
4
4.1
4.2
4.3
4.4
4.5
Simulations - Recording ............................................................................................................................. 35
Recording a Simulation .................................................................................................................................. 35
3.1.1
Starting the Recording.................................................................................................................... 35
3.1.2
Executing the Recording .................................................................................................................36
3.1.3
Fallback Method for Object Recognition ........................................................................................38
3.1.4
Recording in Internet Explorer........................................................................................................ 41
3.1.5
Recording of Microsoft Excel ..........................................................................................................42
ReRecording a Simulation ..............................................................................................................................43
3.2.1
Project changes ..............................................................................................................................43
3.2.2
ReRecording functionality ..............................................................................................................45
3.2.3
Preparations for ReRecording ........................................................................................................45
3.2.4
Central Settings for ReRecording ................................................................................................... 47
3.2.5
Starting the Rerecording ................................................................................................................48
3.2.6
Executing the ReRecording............................................................................................................ 50
3.2.7
ReRecording of Projects with Branches .........................................................................................54
Recording an eCATT File ................................................................................................................................56
Simulations - Editing .................................................................................................................................... 57
Simulation Modes ........................................................................................................................................... 57
4.1.1
Playing back a simulation ...............................................................................................................58
4.1.2
Mouse simulation ............................................................................................................................58
Designing Simulation Pages ...........................................................................................................................58
Editing the Simulation Macros .......................................................................................................................59
Field name and field icon parameters ........................................................................................................... 60
Editing highlights and bubbles........................................................................................................................ 61
SAP Workforce Performance Builder 9.3
Table of Contents
Customer
© 2014 SAP AG. All rights reserved.
3
4.6
4.7
4.8
4.9
4.10
4.11
4.12
4.13
4.14
4.15
4.16
5
5.1
5.2
5.3
5.4
5.5
5.6
4
4.5.1
Properties of highlights................................................................................................................... 61
4.5.2
Positioning the highlights and bubbles........................................................................................... 62
4.5.3
Editing bubble text .......................................................................................................................... 63
Intro and End Pages........................................................................................................................................ 63
Audio in Simulations ....................................................................................................................................... 64
4.7.1
Importing Audio .............................................................................................................................. 65
4.7.2
Recording Audio ............................................................................................................................. 65
4.7.3
Creating Text to Speech .................................................................................................................66
4.7.4
Editing Audio ................................................................................................................................... 67
Form Structure ............................................................................................................................................... 68
4.8.1
Create Form Structure ...................................................................................................................69
4.8.2
Bubbles in the Form Structure ....................................................................................................... 70
4.8.3
Remove Form Structure ................................................................................................................. 70
Branches......................................................................................................................................................... 70
4.9.1
Create a branch .............................................................................................................................. 71
4.9.2
Edit a branch ................................................................................................................................... 72
4.9.3
Remove a branch ............................................................................................................................ 72
4.9.4
Branches in documentation ........................................................................................................... 72
Mode Change.................................................................................................................................................. 73
Page macros ................................................................................................................................................... 73
Anonymize Screen Area ................................................................................................................................. 74
Link actions for trainer and book reader ........................................................................................................ 75
Creating iPad Simulations .............................................................................................................................. 76
4.14.1
Creating Field Icon and Field Name ................................................................................................ 77
Paramaters of the Macro Editor ..................................................................................................................... 77
4.15.1
Subcategory Bubble ....................................................................................................................... 78
4.15.2
Subcategory Documentation ......................................................................................................... 78
4.15.3
Subcategory Rerecord.................................................................................................................... 79
4.15.4
Subcategory Advanced .................................................................................................................. 79
4.15.5
Subcategory Control....................................................................................................................... 79
Macros of the Simulations.............................................................................................................................. 79
4.16.1
Special Macros................................................................................................................................80
4.16.2
Interactions ..................................................................................................................................... 84
4.16.3
Page Macros ................................................................................................................................... 89
4.16.4
Documentation Macros .................................................................................................................. 93
Navigations - Recording and Editing ....................................................................................................... 102
The Navigator ............................................................................................................................................... 102
5.1.1
Status icons .................................................................................................................................. 103
5.1.2
Functions of the Navigator ........................................................................................................... 104
Prerequisites for Target Applications .......................................................................................................... 104
Variants of Creating Navigations.................................................................................................................. 105
Creation using Existing Simulations............................................................................................................. 106
5.4.1
Converting the Simulation ............................................................................................................ 106
Context Assistant ......................................................................................................................................... 107
5.5.1
Context Types ............................................................................................................................... 107
5.5.2
Manual creation ............................................................................................................................ 108
Process Assistant .......................................................................................................................................... 111
5.6.1
Manual creation ............................................................................................................................. 111
5.6.2
Subcategory: Next Process Step................................................................................................... 113
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Table of Contents
5.7
5.8
5.9
5.10
5.11
5.12
6
6.1
6.2
5.6.3
Further Properties of the Macros .................................................................................................. 113
5.6.4
Process Branches ..........................................................................................................................114
5.6.5
Form in a Process ..........................................................................................................................114
Desktop Assistant.......................................................................................................................................... 115
5.7.1
Desktop assistant components .....................................................................................................116
5.7.2
Desktop assistant resources ......................................................................................................... 117
5.7.3
Creating a desktop assistant ......................................................................................................... 117
5.7.4
Desktop assistant settings ............................................................................................................119
5.7.5
Requesting Content .......................................................................................................................119
Object Bubble ............................................................................................................................................... 120
5.8.1
Variants of the object bubble ........................................................................................................ 120
5.8.2
Central Settings for Object Bubbles .............................................................................................. 121
5.8.3
Hide an object bubble .................................................................................................................... 121
Edit Navigations ............................................................................................................................................ 122
5.9.1
Defining the display....................................................................................................................... 122
5.9.2
Post processing after converting.................................................................................................. 122
5.9.3
Inserting an explanation................................................................................................................ 123
5.9.4
Recording an Active Area.............................................................................................................. 124
5.9.5
Customizing Page Information ..................................................................................................... 124
5.9.6
Updating navigations .................................................................................................................... 125
5.9.7
Editing bubbles ............................................................................................................................. 126
5.9.8
Merging navigation projects ......................................................................................................... 127
Playing back navigations .............................................................................................................................. 128
5.10.1
Previewing a navigation ................................................................................................................ 128
5.10.2
Starting a navigation in the Producer ........................................................................................... 128
5.10.3
Playing back without the Producer ............................................................................................... 129
5.10.4
Playing Back the Desktop Assistant ............................................................................................. 129
5.10.5
Displaying the process assistant .................................................................................................. 130
Publishing navigations .................................................................................................................................. 132
5.11.1
Publishing a Workarea .................................................................................................................. 132
5.11.2
Playing back navigations locally ................................................................................................... 132
5.11.3
Publishing navigations centrally ................................................................................................... 132
Macros of the navigations ............................................................................................................................ 134
5.12.1
Context Assistant Style ................................................................................................................ 135
5.12.2
Process Assistant Style ................................................................................................................ 135
5.12.3
Process Step ................................................................................................................................. 137
Quizzes......................................................................................................................................................... 138
Quizzes in Projects ....................................................................................................................................... 138
6.1.1
Central Settings for Quizzes ......................................................................................................... 139
6.1.2
Creating a Quiz.............................................................................................................................. 140
6.1.3
Editing the Quiz Items ................................................................................................................... 144
6.1.4
Quiz Playback................................................................................................................................ 146
Quiz Items ..................................................................................................................................................... 146
6.2.1
Multiple Choice ............................................................................................................................. 147
6.2.2
Fill in the Fields .............................................................................................................................. 148
6.2.3
Fill in the Blanks ............................................................................................................................ 149
6.2.4
Matching ....................................................................................................................................... 150
6.2.5
Connection ..................................................................................................................................... 151
6.2.6
Sorting ........................................................................................................................................... 152
SAP Workforce Performance Builder 9.3
Table of Contents
Customer
© 2014 SAP AG. All rights reserved.
5
6.2.7
6.2.8
6.2.9
6.2.10
7
7.1
7.2
7.3
7.4
7.5
7.6
7.7
7.8
7.9
7.10
7.11
8
8.1
8.2
8.3
6
Slide Control ................................................................................................................................. 152
Grid................................................................................................................................................ 153
Puzzle............................................................................................................................................ 154
Hotspot ......................................................................................................................................... 155
Books and Book Pages .............................................................................................................................. 156
Basic principle and structure ....................................................................................................................... 156
Creating a book............................................................................................................................................. 157
7.2.1
Defining a book page as a content page ....................................................................................... 157
7.2.2
Subcategory sound effects........................................................................................................... 157
7.2.3
Subcategory book reader ............................................................................................................. 158
7.2.4
Alternative navigations on book pages......................................................................................... 158
Creating a book page.................................................................................................................................... 159
7.3.1
Defining the design ....................................................................................................................... 159
7.3.2
Inserting objects ........................................................................................................................... 160
7.3.3
Table of contents for book pages .................................................................................................. 161
7.3.4
Further properties of a book page ................................................................................................ 162
7.3.5
Merging book pages...................................................................................................................... 162
7.3.6
Templates for Book Pages............................................................................................................ 163
Objects of the Book Pages ........................................................................................................................... 165
7.4.1
Object Overview ............................................................................................................................ 165
Object editing.................................................................................................................................................177
7.5.1
Editing parameters ....................................................................................................................... 178
7.5.2
Advanced functions ...................................................................................................................... 179
7.5.3
Inserting an image ........................................................................................................................ 180
7.5.4
New window properties ................................................................................................................ 180
7.5.5
Duplicate object ............................................................................................................................. 181
7.5.6
Using guides................................................................................................................................... 181
7.5.7
Aligning objects............................................................................................................................. 182
7.5.8
Customizing object dimensions ................................................................................................... 182
7.5.9
Arranging objects.......................................................................................................................... 182
7.5.10
Changing the level of objects ........................................................................................................ 183
7.5.11
Creating a Flash button ................................................................................................................ 183
Actions and effects on book pages .............................................................................................................. 184
7.6.1
Object actions ............................................................................................................................... 184
7.6.2
Create effects and animation ....................................................................................................... 187
Templates for Text Units and Projects......................................................................................................... 193
Modeling business processes ...................................................................................................................... 194
7.8.1
Creating processes ....................................................................................................................... 194
7.8.2
Connecting objects ....................................................................................................................... 195
Global settings for book pages ..................................................................................................................... 196
Books and book page view ........................................................................................................................... 197
7.10.1
Preview in the book page editor ................................................................................................... 197
Supported file formats on book pages ......................................................................................................... 198
7.11.1
Requirements for video formats................................................................................................... 198
Text Units ................................................................................................................................................... 200
Structure...................................................................................................................................................... 200
Content-based separation through typification.......................................................................................... 202
Sample applications .................................................................................................................................... 204
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Table of Contents
9
9.1
9.2
9.3
9.4
9.5
9.6
9.7
9.8
10
10.1
Documentation .......................................................................................................................................... 207
Requirements for documentation ............................................................................................................... 207
Documentation Settings.............................................................................................................................. 208
9.2.1
Selecting documentation templates ........................................................................................... 208
9.2.2
Basic Settings and Fragments ..................................................................................................... 209
9.2.3
Subcategory Settings ................................................................................................................... 210
9.2.4
Subcategory: Quiz......................................................................................................................... 210
9.2.5
Subcategory: Action Table ............................................................................................................ 211
9.2.6
Compound document settings ..................................................................................................... 212
9.2.7
Customizing Documentation Naming .......................................................................................... 212
9.2.8
Documentation for Right-to-Left Languages ............................................................................... 214
Generating single documents....................................................................................................................... 214
9.3.1
Types of Single Documents .......................................................................................................... 215
Editing single documents ............................................................................................................................. 216
9.4.1
Documentation Macros ................................................................................................................ 216
9.4.2
Macro Parameters ........................................................................................................................ 217
9.4.3
Process Flow ................................................................................................................................. 218
9.4.4
Heading Levels .............................................................................................................................. 219
9.4.5
Process documents ..................................................................................................................... 220
Compound Document ..................................................................................................................................223
9.5.1
Generating the Compound Document .........................................................................................224
Master document .........................................................................................................................................224
9.6.1
Generating the master document ................................................................................................225
9.6.2
Settings for the master document ...............................................................................................225
9.6.3
Displaying the master document in Word ................................................................................... 226
Documentation Templates ........................................................................................................................... 227
9.7.1
Editing a Word Template ............................................................................................................. 228
9.7.2
Editing a PowerPoint Template ................................................................................................... 228
9.7.3
Explanation Icons ......................................................................................................................... 229
Special documentation fonts ...................................................................................................................... 230
10.5
Content Languages and Translation ........................................................................................................ 231
Content Languages and Dictionaries ........................................................................................................... 231
10.1.1
Generating Texts in Projects.........................................................................................................232
10.1.2
Overview content languages.........................................................................................................232
Translating Learning Contents .................................................................................................................... 234
Translating Using Translation Templates ................................................................................................... 234
10.3.1
Exporting a Translation File ..........................................................................................................235
10.3.2
Importing a Translation File ......................................................................................................... 236
Dictionary Editor .......................................................................................................................................... 236
10.4.1
Structure and Functions ............................................................................................................... 237
10.4.2
Setting up a Dictionary................................................................................................................. 238
10.4.3
Editing an Entry ............................................................................................................................ 238
10.4.4
Creating a New Entry ................................................................................................................... 239
10.4.5
Creating a New Language ............................................................................................................ 239
10.4.6
Activating a Dictionary ................................................................................................................. 240
Spell checker ............................................................................................................................................... 240
11
11.1
Publication ................................................................................................................................................. 242
Publication Types .........................................................................................................................................242
10.2
10.3
10.4
SAP Workforce Performance Builder 9.3
Table of Contents
Customer
© 2014 SAP AG. All rights reserved.
7
11.2
11.3
11.4
11.5
11.6
11.7
11.8
11.9
11.10
11.11
11.12
11.13
12
12.1
12.2
12.3
8
Preparation for the Publishing .....................................................................................................................243
Publishing a Workarea..................................................................................................................................243
11.3.1
Incremental Publishing in Standard Format ................................................................................244
Publishing Rules ........................................................................................................................................... 245
11.4.1
Creating Publishing Rules ............................................................................................................. 245
11.4.2
Publishing Settings .......................................................................................................................246
11.4.3
Publishing Navigations ................................................................................................................. 247
11.4.4
Publishing Documents.................................................................................................................. 247
11.4.5
Multifile for Optimized Playback................................................................................................... 247
11.4.6
Publishing Rules Resource ...........................................................................................................249
Publishing Individual Objects .......................................................................................................................249
Publication on a Server................................................................................................................................ 250
Publication on an Intranet Share ................................................................................................................. 250
Generating a Simulation Video .................................................................................................................... 250
11.8.1
Generate Video Dialog Box ........................................................................................................... 251
11.8.2
Crop Size and Video Size .............................................................................................................. 253
Publication on SAP Mobile Documents ........................................................................................................ 254
Local Playback .............................................................................................................................................. 255
Defining a start link ....................................................................................................................................... 255
11.11.1
Selecting an object's start link ...................................................................................................... 256
Publishing SCORM/AICC ............................................................................................................................. 256
11.12.1
Preparation ................................................................................................................................... 257
11.12.2 Central configuration .................................................................................................................... 257
11.12.1
Publishing Rules for SCORM/AICC .............................................................................................. 261
11.12.2 Using SAVE 1.0..............................................................................................................................264
Creating a Context-Sensitive Help File......................................................................................................... 265
11.13.1
Context Configuration ..................................................................................................................266
11.13.2 Exporting a Context File ................................................................................................................ 267
11.13.3 Administration of the Context ...................................................................................................... 267
Workarea and Administration.................................................................................................................. 269
The Workarea ...............................................................................................................................................269
12.1.1
Structure and Objects of the Tree Structure ...............................................................................269
12.1.2
The Resources .............................................................................................................................. 272
12.1.3
The Learning Content ................................................................................................................... 276
12.1.4
Folder Structure in the Workarea ................................................................................................ 280
12.1.5
Creating a Workarea .....................................................................................................................282
12.1.6
Shortcut on Desktop .....................................................................................................................282
12.1.7
Multi-User Capability in Workareas ..............................................................................................283
Migrating a Workarea ...................................................................................................................................283
12.2.1
Local Workarea - Desktop Edition ................................................................................................284
12.2.2
Central Workarea - Enterprise Edition.......................................................................................... 285
12.2.3
Migration Dialog Box..................................................................................................................... 287
12.2.4
Migration of Imported Resources (Conversion) ..........................................................................289
12.2.5
Differences in Resource Structure .............................................................................................. 290
Synchronization of a Central Workarea .......................................................................................................292
12.3.1
Synchronization behavior of an Object ........................................................................................292
12.3.2
Setting the synchronization behavior...........................................................................................293
12.3.3
Synchronizing a Workarea............................................................................................................294
12.3.4
Samples for using synchronization .............................................................................................. 295
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Table of Contents
12.4
12.5
12.6
12.7
12.8
12.9
12.10
12.11
12.12
13
13.1
13.2
13.3
13.4
13.5
12.3.5
Managing central workarea without synchronization ................................................................. 296
Refreshing Workarea and Objects............................................................................................................... 296
Adapting the workarea structure externally ................................................................................................297
12.5.1
Editing a structure.........................................................................................................................297
12.5.2
Structure of the CSV file .............................................................................................................. 298
Filters and Search in the Workarea ............................................................................................................. 299
12.6.1
Master Tags and Tags .................................................................................................................. 299
12.6.2
Creating Filters.............................................................................................................................. 301
12.6.3
Filter Resource ............................................................................................................................. 303
12.6.4
Search Function ........................................................................................................................... 303
Glossary of Terms........................................................................................................................................ 304
12.7.1
Creating a Glossary...................................................................................................................... 304
12.7.2
Removing a Glossary ................................................................................................................... 305
12.7.3
Importing a Glossary.................................................................................................................... 305
12.7.4
Glossary View in library................................................................................................................ 306
12.7.5
Glossary Styles ............................................................................................................................ 306
BPM Import.................................................................................................................................................. 307
12.8.1
Importing a BPM Structure .......................................................................................................... 307
12.8.2
Settings for Aris Import ............................................................................................................... 308
12.8.3
Updating a BPM Structure ........................................................................................................... 308
12.8.4
Exporting Symbio Links ............................................................................................................... 308
Insert a file ................................................................................................................................................... 309
Reference Counter ....................................................................................................................................... 310
Dependencies ............................................................................................................................................... 310
Reducing the File Size of the Content ........................................................................................................... 311
Interface and Components........................................................................................................................ 313
Project Explorer ............................................................................................................................................ 314
13.1.1
Administration in the Tree Structure............................................................................................ 314
13.1.2
Object Editor in the Project Explorer ............................................................................................ 315
13.1.3
Parameters of the Macro Editor ................................................................................................... 315
Project Editor ................................................................................................................................................ 316
13.2.1
Thumbnail View............................................................................................................................. 317
13.2.2
Steps of a project .......................................................................................................................... 318
13.2.3
Step View ...................................................................................................................................... 319
13.2.4
Documentation View.................................................................................................................... 320
13.2.5
Macro Editor.................................................................................................................................. 321
13.2.6
History ........................................................................................................................................... 321
Book Page Editor ..........................................................................................................................................322
13.3.1
Object list ......................................................................................................................................323
HTML Editor ..................................................................................................................................................323
13.4.1
Features of the HTML Editor........................................................................................................ 324
13.4.2
Inserting a placeholder .................................................................................................................325
13.4.3
Inserting a screenshot or image .................................................................................................. 326
13.4.4
Inserting a link ............................................................................................................................... 327
13.4.5
New window options .................................................................................................................... 328
13.4.6
Searching for text strings ............................................................................................................ 328
13.4.7
Overview of supported HTML tags .............................................................................................. 329
Audio Editor ................................................................................................................................................. 330
13.5.1
Text to Speech Dialog .................................................................................................................. 330
SAP Workforce Performance Builder 9.3
Table of Contents
Customer
© 2014 SAP AG. All rights reserved.
9
13.6
13.7
13.8
13.9
13.10
13.11
13.12
14
14.1
14.2
10
13.5.2
Recording Dialog ........................................................................................................................... 331
13.5.3
Dynamic Editor ............................................................................................................................. 331
Color Selection Dialog Box ........................................................................................................................... 333
Style Editor ................................................................................................................................................... 333
13.7.1
Structure and Functions ............................................................................................................... 335
13.7.2
Creating a New Style.....................................................................................................................336
13.7.3
Style Attributes .............................................................................................................................336
13.7.4
trainer Style (including library and book reader) ......................................................................... 337
13.7.5
Navigator Style ............................................................................................................................ 340
13.7.6
Book Page Style ............................................................................................................................342
13.7.7
Bubble Styles ................................................................................................................................343
13.7.8
Border Styles ................................................................................................................................ 345
13.7.9
Manager Style ............................................................................................................................... 347
Text Style Editor .......................................................................................................................................... 350
13.8.1
Structure and Functions .............................................................................................................. 350
13.8.2
Text Style Categories.................................................................................................................... 351
13.8.3
Creating a Text Style..................................................................................................................... 351
13.8.4
Editing a Text Style ....................................................................................................................... 352
Bubble Style Editor ....................................................................................................................................... 352
13.9.1
Bubble Style Attributes................................................................................................................. 353
13.9.2
Bubble Style Templates................................................................................................................ 354
Using an External Editor for Images .............................................................................................................359
Toolbars ........................................................................................................................................................359
Recording Bar for Recording ....................................................................................................................... 360
13.12.1 Recording Bar for ReRecording ....................................................................................................362
Menu Overview........................................................................................................................................... 365
Workarea Menu ............................................................................................................................................365
14.1.1
Select Workarea............................................................................................................................365
14.1.2
Export Archive…............................................................................................................................365
14.1.3
Import Archive… ...........................................................................................................................366
14.1.4
Administration ..............................................................................................................................366
14.1.5
Publish ..........................................................................................................................................368
14.1.6
New Group ....................................................................................................................................369
14.1.7
New Project ...................................................................................................................................369
14.1.8
New Book ...................................................................................................................................... 371
14.1.9
New Book Page ............................................................................................................................. 371
14.1.10 New Text Unit................................................................................................................................ 372
14.1.11 Open Base Directory ..................................................................................................................... 373
14.1.12 Preview library .............................................................................................................................. 373
14.1.13 Generate All Contents... ................................................................................................................ 373
14.1.14 Exit ................................................................................................................................................ 374
Central Workarea Menu ............................................................................................................................... 374
14.2.1
Check out Objects......................................................................................................................... 374
14.2.2
Synchronize Workarea.................................................................................................................. 374
14.2.3
Save to server (without synchronization) .................................................................................... 375
14.2.4
Update from server....................................................................................................................... 375
14.2.5
Revert object... .............................................................................................................................. 375
14.2.6
Start editing .................................................................................................................................. 375
14.2.7
Finish editing ................................................................................................................................. 375
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Table of Contents
14.3
14.4
14.5
14.6
14.7
14.2.8
Change workflow...........................................................................................................................376
14.2.9
Add comment................................................................................................................................376
14.2.10 Save all objects to server... (without synchronization) ...............................................................376
14.2.11 Update all objects from server... (without synchronization) ........................................................376
14.2.12 Start editing all objects... ..............................................................................................................376
14.2.13 Finish editing all objects... ............................................................................................................. 377
14.2.14 Change workflow for all objects... ................................................................................................. 377
14.2.15 Manage.......................................................................................................................................... 377
14.2.16 Manage tasks... .............................................................................................................................378
14.2.17 Work offline ...................................................................................................................................378
14.2.18 Open Manager...............................................................................................................................378
Project Menu.................................................................................................................................................378
14.3.1
Save...............................................................................................................................................378
14.3.2
Export Archive...............................................................................................................................379
14.3.3
Publish...........................................................................................................................................379
14.3.4
Open Project Directory .................................................................................................................379
14.3.5
Duplicate... ....................................................................................................................................379
14.3.6
Convert to Audio Project.............................................................................................................. 380
14.3.7
Close............................................................................................................................................. 380
Book Page Menu .......................................................................................................................................... 380
14.4.1
New Book Page ............................................................................................................................. 381
14.4.2
Save Book Page ............................................................................................................................ 381
14.4.3
Duplicate... ................................................................................................................................... 382
14.4.4
Export Archive.............................................................................................................................. 382
14.4.5
Publish.......................................................................................................................................... 382
14.4.6
Open Folder.................................................................................................................................. 382
14.4.7
Close............................................................................................................................................. 382
Edit Menu ..................................................................................................................................................... 383
14.5.1
Undo ............................................................................................................................................. 383
14.5.2
Redo ............................................................................................................................................. 383
14.5.3
Cut ................................................................................................................................................ 383
14.5.4
Copy ............................................................................................................................................. 383
14.5.5
Paste ............................................................................................................................................ 383
14.5.6
Delete ........................................................................................................................................... 384
14.5.7
Select All....................................................................................................................................... 384
14.5.8
Select Macros by Type................................................................................................................. 384
14.5.9
Search & Replace Bubble Content .............................................................................................. 384
Audio Menu ...................................................................................................................................................385
14.6.1
Play Audio .....................................................................................................................................385
14.6.2
Stop Audio.....................................................................................................................................385
14.6.3
Record Audio.................................................................................................................................385
14.6.4
Pause Audio ..................................................................................................................................385
14.6.5
Repeat Audio .................................................................................................................................385
14.6.6
Import Audio File... ....................................................................................................................... 386
14.6.7
Import Audio Again ...................................................................................................................... 386
14.6.8
Export all Audio Files... ................................................................................................................. 386
14.6.9
Delete Audio ................................................................................................................................. 386
14.6.10 Change Audio Format... ................................................................................................................387
14.6.11 Convert Text to Speech ................................................................................................................387
Menu Recording (Simulation) ......................................................................................................................387
SAP Workforce Performance Builder 9.3
Table of Contents
Customer
© 2014 SAP AG. All rights reserved.
11
14.8
14.9
14.10
14.11
14.12
14.13
14.14
15
15.1
15.2
12
14.7.1
Record Application ....................................................................................................................... 387
14.7.2
Rerecord Application ....................................................................................................................388
Action Menu (Navigation) ............................................................................................................................388
Insert Menu...................................................................................................................................................388
14.9.1
Insert Special Macro .....................................................................................................................388
14.9.2
Insert Interactions.........................................................................................................................388
14.9.3
Insert Page Makro .........................................................................................................................389
14.9.4
Insert Quiz Item.............................................................................................................................389
14.9.5
Insert Documentation Macro........................................................................................................389
14.9.6
Add Step .......................................................................................................................................389
Documentation Menu ...................................................................................................................................389
14.10.1 Generate Master Document ........................................................................................................ 390
14.10.2 Generate Word Document........................................................................................................... 390
14.10.3 Generate PDF Document ............................................................................................................. 390
14.10.4 Generate HTML Document........................................................................................................... 391
14.10.5 Generate PowerPoint Document.................................................................................................. 391
View Menu .................................................................................................................................................... 391
14.11.1 JavaScript Console ....................................................................................................................... 391
14.11.2 Layout & Components in the Project Editor ................................................................................. 391
14.11.3 Floating Windows (Project Editor)................................................................................................392
14.11.4 Zoom .............................................................................................................................................393
14.11.5 Set Preview Mode (Project Editor) ...............................................................................................393
14.11.6 Show/Hide Macros (Project Editor) .............................................................................................393
14.11.7 Show Unknown References (Project Explorer) ............................................................................393
14.11.8 Show UIDs (Project Explorer).......................................................................................................393
14.11.9 Show Language (Project Explorer)...............................................................................................393
14.11.10 Show Language Icons (Project Explorer) .....................................................................................394
14.11.11 Show Reference Counter (Project Explorer) ................................................................................394
Tools Menu ...................................................................................................................................................394
14.12.1 Settings... ......................................................................................................................................394
14.12.2 Keyboard Settings... .....................................................................................................................394
14.12.3 Localization ...................................................................................................................................395
14.12.4 Edit Bubble Styles... ...................................................................................................................... 397
14.12.5 Edit Master Tags... ........................................................................................................................ 397
14.12.6 Bulk Changes ................................................................................................................................ 397
14.12.7 Import .......................................................................................................................................... 400
14.12.8 Workarea Structure ..................................................................................................................... 404
14.12.9 Replace Bubble Styles... .............................................................................................................. 404
Window Menu .............................................................................................................................................. 405
Help Menu.................................................................................................................................................... 405
14.14.1 Diagnosis...................................................................................................................................... 406
Central Configuration Dialog ................................................................................................................... 407
Initialization and fallback default parameters ..............................................................................................407
15.1.1
Use in the macro settings ............................................................................................................ 408
15.1.2
Application example .................................................................................................................... 408
Application ................................................................................................................................................... 409
15.2.1
General.......................................................................................................................................... 410
15.2.2
Central Workarea ........................................................................................................................... 411
15.2.3
Directories...................................................................................................................................... 411
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Table of Contents
15.3
15.4
15.5
15.6
15.7
15.2.4
Save................................................................................................................................................411
15.2.5
Templates ..................................................................................................................................... 412
15.2.6
Expert Features............................................................................................................................. 412
Authoring Settings........................................................................................................................................ 412
15.3.1
Recording - General ...................................................................................................................... 413
15.3.2
Macro Initialization ........................................................................................................................ 415
15.3.3
Book Page Editor........................................................................................................................... 415
15.3.4
Book Page Initialization................................................................................................................. 416
Playback Settings ......................................................................................................................................... 416
15.4.1
General .......................................................................................................................................... 417
15.4.2
Macro Fallback Defaults ............................................................................................................... 418
15.4.3
Book Page Fallback Defaults ........................................................................................................ 418
15.4.4
Settings of trainer, book reader, library and Modes ..................................................................... 419
Navigation Authoring Settings .................................................................................................................... 420
15.5.1
Macro Initialization ....................................................................................................................... 420
Navigation Playback Settings ....................................................................................................................... 421
15.6.1
Macro Fallback Defaults ............................................................................................................... 421
Documentation Settings............................................................................................................................... 421
SAP Workforce Performance Builder 9.3
Table of Contents
Customer
© 2014 SAP AG. All rights reserved.
13
1
SAP Workforce Performance Builder
Producer
Welcome to Producer, the SAP Workforce Performance Builder tool that enables you the creation of web-based
learning content that will take the user step by step through the contents of your web or Windows application.
1.1
Technical Support
Please use the SAP Incident Wizard on the SAP Service Marketplace 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
If you are not familiar with the SAP Service Marketplace, read the following information:


14
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 Service Marketplace 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.
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
SAP Workforce Performance Builder Producer




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 Service Marketplace contact your local Customer Interaction Center.
An online webform is available on http://support.sap.com/contactus. This webform should be used for all
written communication with your local customer interaction center. More Details about Incident
Processing, Support Adresses and Hotline Numbers can be found here:
http://service.sap.com/sap/support/notes/560499
Are you interested in a tour through the SAP Support Portal? Register for an online demo.
Note
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… over 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 E-mail attachment to the SAP
support staff.
1.2
System Requirements
In order to successfully install and use Producer, your computer must fulfill the following requirements:
Type
Specifications
Operating system
Microsoft Windows Vista, Windows 7 and Windows 8
(without tile view)
64 & 32 bit version
Processor
Pentium IV, at least 1 GHz
Memory
A minimum of 4 GB
Hard drive
200 MB of free space
Browser
Internet Explorer 7.0 – 11.0
Soundcard
Any soundcard
For production of audio projects and book pages
Microphone
Any microphone
For recording of audio
SAP Workforce Performance Builder 9.3
SAP Workforce Performance Builder Producer
Customer
© 2014 SAP AG. All rights reserved.
15
Scenario
Requirement
SAP Business Suite
SAP GUI Scripting activated
Java Applications
Java Access Bridge installed
Windows Vista
Windows Automation API
Documentation Generation
MS Office (Word and PowerPoint) 2003 - 2013
PDF Generation
MS Office 2007 and Plug-In Microsoft Save as PDF
MS Office 2010 / MS Office 2013
1.3
Uninstalling Producer
If you would like to uninstall the Producer, this is done from the Settings -> System control -> Software menu:
1.
2.
3.
4.
A dialog will open listing all the programs on your PC. Select the Producer.
Click on the Remove button.
A dialog will open. Initiate the uninstallation process by clicking on the Yes button.
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 Producer.msi installation file from the
corresponding version of your Producer:
To do so, launch the installation program by double clicking on the installation file. Then click on Next. Select the
option Remove and confirm your selection by clicking on the Remove button. The Producer will now be
uninstalled.
16
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
SAP Workforce Performance Builder Producer
2
Settings
The following chapters handle the required settings for recording and editing contents within the Producer as well
as for playing back contents using the trainer, library and book reader functionalities.
2.1
Authoring settings
Recording, editing and previewing contents with the SAP Workforce Performance Builder may need some
preparations to your authoring environment. Read the following chapters according to your operating system and
recording scenario to make your setup running perfectly.
2.1.1
Required System Settings
A few system settings are necessary for Windows operating systems to allow the recording function to flawlessly
identify Windows application objects.
If an existing setting does not match the required settings for the application profile, a dialog box will appear to
warn you when you start the recording. Facing this warning you should cancel the recording and configure the
required settings.
The following chapters describe how to configure the required system settings for each Windows operating
system. Also note the system requirements for Producer.
2.1.1.1
Windows Vista
Define the correct settings for the Windows Vista operating system within the Personalization dialog.
To open this dialog right-click the desktop wallpaper and select Personalize within the context menu. Alternatively
you can access this dialog by opening the Control Panel > Appearance and Personalization.
Set parameters as specified in table below:
Section/Parameter
Set to
Window Color and Appearance
Windows Design
Select Windows Vista Basic as scheme.
Font smoothing
Disable font smoothing within the selection Use the
following method to smooth edges of screen fonts.
Display Settings
SAP Workforce Performance Builder 9.3
Settings
Customer
© 2014 SAP AG. All rights reserved.
17
Section/Parameter
Set to
Color depth
Select Highest (32bit) in Color dropdown.
Adjust font size (DPI) (in left sidebar)
DPI scaling
2.1.1.2
Set to Default scale (96 DPI).
Windows 7
Define the correct settings for the Windows 7 operating system within the Appearance and Personalization dialog.
You can access this dialog by opening the Control Panel. Consider to change the View by: option in upper right
corner to Category. Click Appearance and Personalization.
Set parameters as specified in table below:
Section/Parameter
Set to
Personalization
Change the theme
Select Windows 7 Basic.
Adjust screen resolution
1.
Click Advanced settings.
2.
Select Tab Monitor.
3.
In the Colors dropdown select True Color (32bit).
Display
Make text and other items larger or smaller
Set text to value Smaller - 100% (default).
Fonts
Adjust ClearType text
1.
Uncheck the option Turn on ClearType
2.
Click Next.
3.
Select Yes, I want to tune all monitors now.
4.
Verify the native resolution for your monitor and
click on Next.
5.
The following four pages will provide you with
examples of the font display. Select the best
version to meet your needs and click on Next.
6.
Repeat steps for each of your monitors.
7.
In the last dialog box, click on Finish to confirm
the changes.
Disabling font smoothing system-wide
In some cases, deactivating the ClearType may not be sufficient for achieving error-free graphic object
recognition. If this happens, you can disable the smoothing option for screen fonts system-wide. First consult your
customer advisor before deactivating this option on your own.
The option to disable is Smooth edges of screen fonts which is found under Control panel -> System and Security > System -> Advanced System Settings -> Settings (Performance).
18
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Settings
2.1.2
Settings for Recording
According to your operating system, certain preparations and practices for recording have to be considered.
2.1.2.1
Recording under Windows Vista and 7
Windows Vista and Windows 7 allows you to run an application as a user or administrator. This is done via the
command Launch as administrator in an application link's shortcut menu.
To allow applications to be recorded free from errors, you should ensure that the Producer and application to be
recorded are called with matching rights.
2.1.2.2
Settings for the SAP Client
If projects are to be recorded via an SAP ECC client, certain settings need to be applied if the recording is to
proceed without a hitch.
2.1.2.2.1
SAP GUI Scripting
The SAP GUI Scripting is necessary for the recording that the objects in the ECC window can be properly
recognized via the scripting interface from SAP. The SAP GUI Scripting should be activated on the server side so
that the object information can be extracted.
In some cases is an activation on client side necessary (see scenario). If the scripting is activated on both sides, a
red/white symbol will appear in the bottom right-hand corner.
The table gives you an overview of the recording scenarios and the necessary SAP GUI Scripting setting:
Scenario
Set to (Client)
Set to (Server)
Profound Recognition (Standard)
Deactivated
Activated
Simple Recognition
Activated
Activated
Note
NWBC with embedded SAP GUI: For the recording with with profound recognition activate the SAP GUI
Scripting also on client side.
The SAP GUI Scripting on Client side can be set under the Customize Local Layout -> Options menu:
Area / Setting
Sceanario Activated
Sceanario Deactivated
SAP GUI up to 7.1:
Scripting
SAP Workforce Performance Builder 9.3
Settings
Customer
© 2014 SAP AG. All rights reserved.
19
Area / Setting
Sceanario Activated
Sceanario Deactivated
Enable Scripting
Activate
Deactivate
Notify when a script attaches to a
Running GUI
Off
Disabled
Notify when a script opens a
connection
Off
Disabled
SAP GUI 7.2 and higher:
Accessibility & Scripting -> Scripting
Enable Scripting
Activate
Deactivate
Notify when a script attaches to a
Running GUI
Off
Disabled
Notify when a script opens a
connection
Off
Disabled
Note
Note that graphical object recognition is not possible when scripting is active. For graphical object
recognition, additional requirements are necessary which are not standard. Contact your SAP consultant
if you have any questions regarding this.
2.1.2.2.2
Settings up to SAP GUI 7.1
The following settings refer exclusively to the SAP client and are to be applied in Customizing the local layout in the
New design and Options menus.
Settings under New Design
Area / Setting
Set to
General
Active theme
Select theme as application profile will be used by you,
i.e. Tradeshow for using SAP GUI Tradeshow
Font size
100%
Color settings
Theme
20
Customer
© 2014 SAP AG. All rights reserved.
Select exact the same theme as chosen in General.
SAP Workforce Performance Builder 9.3
Settings
Settings within the Options dialog
Area/Setting
Set to
Options
Quick info
None
Local data
History
Off
I18N
Activate the multi-byte functionalities to support
Off
Cursor
Narrow cursor
2.1.2.2.3
Enabled
Settings for SAP GUI 7.2 and higher
As of SAP GUI 7.2, there are several differences in the settings when compared to previous versions.
The following settings can be defined from the option Customize Local Layout .
Area / Setting
Set to
Theme
Active theme
Select a theme for the corresponding application
profile, such as SAP signature, tradeshow…
Visual Design
Font settings
Default settings
Interaction Design > Vizualisation & Interaction
Cursor Width for Input Fields on Screens
Narrow cursor
Interaction Design > Notifications
Tooltip Delay
No Tooltip
Local data
History
2.1.2.2.4
Off
Settings for modal dialogs
The option Dialog (modal) is to be activated for optimal recognition of objects on modal dialogs. The setting is
located on the F4 Help tab of the settings dialog, which can be launched from the Help -> Settings menu.
SAP Workforce Performance Builder 9.3
Settings
Customer
© 2014 SAP AG. All rights reserved.
21
2.1.2.2.5
Font settings
Position-based objects such as explanation bubbles, interactive surfaces and highlights are dependent on the
predefined font properties in SAP; having differing settings can change the layout of the interface. It is important
that the settings are the same when recording as well as when playing back the simulations (on users’ PCs) in
order to ensure that the objects are displayed properly at all times.
In order to adjust the font in your SAP system, go to the font settings in your SAP GUI:

Font settings (up to SAP GUI 7.1)
The settings can be changed from the menu Options -> Font (I18N)...
If this menu entry is not enabled, you can activate the setting Activate Multi-Byte Functions under I18N.

Font settings (SAP GUI 7.2 and higher)
You can adjust the settings under Visual Design -> Font Settings.
2.1.2.2.6
Page titles in page keys for SAP ECC
In the recording of SAP ECC it may be possible that advanced system information will be included in the page key
(e.g.: WA1(1)/000 SAP Easy Access instead of SAP Easy Access). By performing a rerecording or playback a
navigation this can result in an incorrect page recognition. To avoid additional information in the page key, the
following adjustment in the registry of the operating system should be done:
1.
Open the registry editor with the command regedit about the Run… dialog.
2.
Select the entry HKEY_CURRENT_USER -> SOFTWARE -> SAP -> SAPGUI Front -> SAP Frontend Server ->
Administration in the editor.
3.
Create a new DWORD value about Edit -> New:
Value name: ShowAdditionalTitleInfo
Value data: 1
4.
Restart your SAP system so that the registry entry can take effect.
5.
Change the value in the registry to 0.Thus you can deactivate the display of the title information.
Note
Changes in the registry of the operating system should only be done by administrators.
2.1.2.3
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.
22
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Settings
The Citrix clients
So-called clients are required to access the Producer and the applications on the terminal server.lease note:

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.
2.1.2.3.1
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.
The authors should also possess user rights for the Producer BHO, required for postprocessing.
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.
2.1.2.3.2
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.
SAP Workforce Performance Builder 9.3
Settings
Customer
© 2014 SAP AG. All rights reserved.
23
2.1.2.3.2.1
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.
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.
2.1.2.3.3
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
24
Customer
© 2014 SAP AG. All rights reserved.
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
SAP Workforce Performance Builder 9.3
Settings
2.1.2.4
Settings for Microsoft Excel
The following setting is necessary for optimal object recognition for Excel recordings:

Disable the setting Window in the menu Freeze panes. This prevents incorrect recognition of cell positions.
2.1.2.5
Java Applications
In case the target application is a Java application, it is necessary to install Java Access Bridge on your system.
2.1.3
Settings for Editing
According to your operating system, certain preparations for editing projects have to be considered.
2.1.3.1
Editing highlights
In certain cases, it may possible that highlights for controls are not properly displayed during the recording or the
rerecording and therefore cannot be edited. In such instances, it is recommended to activate the option Show
windows content while dragging, which is found under System Properties -> Advanced -> Performance.
2.1.4
Playback settings
Previewing local authored contents will call Internet Explorer in every case. To preview your contents created on
your local machine you have to enable Internet Explorer's ability to run local active contents. No more settings are
needed in this case.
If you edit and preview contents on a network share or on the Manager check necessary settings for your browser
as given within the chapter Learner settings.
Enable playback of local contents as follows:
1.
Open Internet Explorer and navigate to the Internet Options command in the Tools menu.
2.
Click on the Tab Advanced and scroll to the section Security.
3.
Enable setting Allow active content to run in files on My Computer*
2.2
Learner settings
A few changes are required to the settings of your browser to work perfectly with SAP Workforce Performance
Builder functionalities.
SAP Workforce Performance Builder 9.3
Settings
Customer
© 2014 SAP AG. All rights reserved.
25
Independent from your preferred browser the playback functionalities require following settings:
Requirement
Why?
Enabled JavaScript
All functionalities are based on the use of JavaScript.
You must enable it.
Deactivated Pop-up blocker
No matter which Pop-up blocker you use, you must
disable the blocking of Pop-ups for the location you
are loading your contents from. Read browser-specific
chapters to get instructions how to disable built-in
Pop-up blocker functionalities.
Activated cookies
The attributes and settings for displaying and
executing library, trainer and book reader are stored
in cookies. You should therefore activate cookies in
your browser to ensure that these functionalities run
accurately.
Recommendation
Possibly it may happen that Flash contents are displayed incorrect. In this case uninstall and reinstall the
Flash plugin (do not do update only).
2.2.1
Browser Requirements
The following requirements are to be considered to ensure an error-free use of the trainer, library and book reader
functionalities, thus ensuring that contents are played back successfully.
Browser
Version
Operating system
Internet Explorer
7.0 – 11.0
Windows Vista, Windows 7 or
Windows 8
Firefox
17.0.9 ESR - 27.0
Windows Vista, Windows 7,
Windows 8 or Mac OS X 10.5.x
Safari
4.0 – 5.1
Windows Vista, Windows 7,
Windows 8, Mac OS X 10.5.x
Supported mobile platforms
Content playback has been tested for the system built-in browsers of the following mobile device platforms. Keep
in mind, that playback on mobile devices usually requires an online connection to published contents (Manage r or
shared network storage).
26
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Settings
Platform
OS version
Browser
Apple iOS
6, 7
Safari Mobile
Google Android
4.1.2
Stock Browser (AOSP)
(with deactivated Desktop View)
Windows Mobile
2.2.2
8
Internet Explorer 10
Settings for Internet Explorer
To enjoy a flawless experience of the trainer, library and book reader functions, you may have to enable additional
security settings in Internet Explorer.
Note that your configuration requirements are highly dependent on the location you are playing your contents
from. This is due to the zone model in Internet Explorer (see the next chapter for more details). However, all
functions will run almost perfectly using the Internet Explorer default settings.
Note
If you are using Internet Explorer 8 or 9, ensure that you deactivate the standard use of Compatibility
Mode to avoid display problems. To do so, open Tools >Compatibility View Settings (in Internet Explorer 9
press ALT to display the toolbar) and deselect one or both of the following parameters, depending on your
location you are playing back contents from.
o
Display all websites in Compatibility Mode
o
Display intranet sites in Compatibility View
2.2.2.1
Basic Setup
Note
The settings configuration as handled in this chapter is based on the assumption that you use Internet
Explorer's default settings and default security levels. If you use a custom security level, read the chapter
Custom Setup to ensure your settings match the requirements.
Playback of contents located on the Internet/intranet
1.
To apply Internet Explorer Security Settings, open Internet Explorer and navigate to the Internet Options
command in the Tools menu.
2.
Click on the Tab Security and select Local Intranet or Internet, depending on where your contents are located.
3.
Click on Custom level... to open the Security Settings dialog. Enable the settings shown below.
SAP Workforce Performance Builder 9.3
Settings
Customer
© 2014 SAP AG. All rights reserved.
27
1.
Contents located on your intranet (Default security level: Medium-low)
Section/Setting
Set to
Why?
Enable
Playback videos and animations
embedded in book pages and
quizzes directly with the browser,
without loading an installed media
player.
ActiveX controls and plug-ins
Display video and animation on a
webpage that does not use external
media player
2.
Contents located on the Internet (Default security level: Medium-high)
Section/Setting
Set to
Why?
Enable
Playback videos and animations
embedded in book pages and
quizzes directly with the browser,
without loading an installed media
player.
Allow script-initiated windows
without size or position constraints
Enable
Display simulation modes in trainer
and book pages in book reader with
correctly positioned control
elements.
Allow websites to open windows
without address or status bars
Enable
Display the frameless top-mostwindow of the Concurrent Mode.
ActiveX controls and plug-ins
Display video and animation on a
webpage that does not use external
media player
Miscellaneous
Tip:
In Internet Explorer 9, turn off the Protected Mode for the network zone that is the source of the
contents. This ensures correct window handling for links that open content in a new window. Not
doing so might result in the window being opened in full screen mode, without the possibility to close
the simulation before it is finished.
Note
Using Internet Explorer 8 you have to activate the Protected Mode for your Intranet Zone to gain full
playback functionality for contents played back from Intranet Zone.
Playback of local contents
If your contents are stored on a local hard drive or if your contents were delivered on a CD/DVD, you have to allow
active contents to be run locally.
1.
Open Internet Explorer and navigate to the Internet Options command in the Tools menu.
2.
Click on the Advanced tab and scroll to the Security section. Enable the settings as described in the following
table.
28
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Settings
Section/Setting
Why?
Allow active content to run in files on My Computer*
Playback contents from your local hard drive(s). This
is especially important if you want to preview your
authored contents from Producer or Instant Producer.
Allow active content from CDs to run on My Computer*
Playback published contents on CD/DVD.
Common settings

Configure Internet Explorer's pop-up blocker
The pop-up blocker needs to be deactivated to display simulations in the trainer. This option can be accessed
using the Tools -> Pop-up blocker menu.
Alternatively, you can input the corresponding URL in the pages that are enabled for pop-ups, in the Pop-up
blocker settings.

Print the stop page
To print the stop page of the trainer correctly you have to allow background elements to be printed. You will
find the relevant settings as follows:
o
Internet Explorer 7:
Go to Tools -> Internet options and click the Advanced tab. Scroll down to the Printing section. Activate
the setting Print background colors and images.
o
Internet Explorer 8 and higher:
Press the key ALT to display the menu bar. Select File > Page Setup and activate the setting Print
background colors and images.
2.2.2.2
Custom Setup
Using a custom configuration hat has been modified by you or your company’s network policy might result in
problems when playing back contents.Check that your security settings match the settings in the following table
and check that the additional settings (listed below the table) are configured correctly.
Recommendation
o
Note the dependencies given to different content types and the necessary settings.
o
Ensure that you configure these settings for the correct zone (where your contents are located).
Security settings
1.
To apply Internet Explorer Security Settings, open Internet Explorer and navigate to the Internet Options
command in the Tools menu.
2.
Click on the Security tab and select Local Intranet or Internet, depending on where your contents are located.
3.
Click on Custom level... to open the Security Settings dialog. Enable the settings for the functions you use.
See the following table for function-specific settings.
To avoid display errors, column headers are displayed with a numeric icon that represents one of the following
functions/content types:
num. 1 - library
num. 2 - demo, test and practice mode
SAP Workforce Performance Builder 9.3
Settings
Customer
© 2014 SAP AG. All rights reserved.
29
num. 3 - concurrent mode
num. 4 - book pages
num. 5 - quizzes
Section/Setti
ng
Set to
num. 1
num. 2
num. 3
num. 4
num. 5
ActiveX
controls and
plug-ins
Binary and
script
behavior
Enable
Display video
and
animation on
a webpage
that does not
use external
media player
Enable
Miscellaneou
s
Allow scriptinitiated
windows
without size
or position
constraints
Enable
Allow
websites to
open
windows
without
address or
status bars
Enable
Submit nonencrypted
form data
Enable
Scripting
Active
scripting
Enable
Additional settings within the Advanced tab
Settings on the Advanced tab might block playback functions, regardless where the contents are stored. Check
the table below if you experience problems not described in the previous settings table.
30
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Settings
1.
Open Internet Explorer and navigate to the Internet Options command in the Tools menu.
2.
Click on the Advanced tab and configure the settings as described in following table.
Section/Setting
Set to
Why?
Enable
Enable audio simulations and
automatic playback of book page
sounds.
Multimedia
Play sounds in webpages
Additional settings within the General tab
Settings on the General tab influence the basic behaviour of the browser. Check the table below if you experience
problems not described in the previous settings table.
1.
Open Internet Explorer and navigate to the Internet Options command in the Tools menu.
2.
Click on the General tab and configure the settings as described in following table.
Section/Setting
Set to
Why?
Enable
Opens the window of the
concurrent mode in a new browser
window.
Tabs -> Settings
Always open pop-ups in a new
window
(When a pop-up is encountered)
2.2.2.3
Internet Explorer’s zone model
Security settings are divided into specific zones in Internet Explorer. Internet Explorer distinguishes between four
zones: Internet, Local Intranet, Trusted sites and Restricted sites. It is possible to configure the settings in detail for
the permitted actions within each zone. In corporate networks, it is generally the administrator who configures
these settings in accordance with the company policy. Otherwise, users may also define the settings themselves.
A document is assigned to a specific zone based on two characteristics:

Path / URL for documents – The paths/URLs for documents can be configured in Internet Explorer for each
of the four zones (Internet, Local Intranet, Trusted sites and Restricted sites). All other paths/URLs are
automatically allocated to the zone Internet.

The file's source (when downloading via the Windows file system) - When a document is downloaded from an
external source, the zone that the file was in upon downloading is automatically allocated to the file. In this
case, Internet Explorer’s security settings for the zone (ZoneID) detected in the file will apply.
Caution
To ensure that everything runs smoothly, it is recommended that you verify that the security zone
settings for the server as well as for the published contents and the trainer on the end user's side allow
the contents to be played back without any problems.
SAP Workforce Performance Builder 9.3
Settings
Customer
© 2014 SAP AG. All rights reserved.
31
2.2.3
Settings for Mozilla Firefox
The following settings are required for a flawless playback experience in Mozilla Firefox.
1.
Changes in the settings dialog
Select the Settings item in the Tools menu in the open browser. Now go to the Content item in the settings
dialog to see the required options.
Setting
Set to
Block pop-up windows
Deactivate
Activate JavaScript
Activate
Advanced JavaScript settings
1.
Click on the Advanced button to open
Advanced JavaScript settings. Activate the
following options:
o
Position window before or after other windows
o
Hide status bar
3.
2.
Change status bar text
Settings using about:config
Additional browser configuration settings are available to you in Firefox. You can access these settings by
entering about:config in the address bar and confirming with Enter.
Enter setting name into Search field. A setting can be activated by double-clicking on it. It is then displayed in
bold text and the value true is set.
The following settings are to be set to the value true:
Setting
What does it do?
dom.allow_scripts_to_close_windows
This setting allows the browser windows to be closed.
signed.applets.codebase_principal_support
This setting displays browser windows in fullscreen
mode.
dom.disable_window_open_feature.resizable
This setting prevents the size of an open browser
window from being changed.
security.fileuri.strict_origin_policy
This setting allows links to be executed if an HTML
page is launched from a local drive.
3.
Printing the stop page
To print the stop page of the trainer correctly you have to allow the print of background elements. Activate
the setting Print background (Colors and Images) which is to be find within the page setup dialog under File ->
Page setup.
Note
o Caused by the settings that have been activated, you will face a security message when starting the
library or a content in the trainer. Confirm this message with Allow.
Activate the option Remember this decision so that the security message will not be displayed each
time the library starts.
o The default bubble audio effects in simulations and in the book reader actions are in WAV format. A
Windows Media Player plugin is required in order to be able to play back the files in Firefox.
32
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Settings
You will find further information on the subject at: https://addons.mozilla.org/enUS/firefox/browse/type:7
2.2.4
Safari Settings
The following settings are required for a flawless playback experience in Safari.
1.
Playback settings
Open the browser's settings dialog using the Edit -> Preferences menu. In this menu, select the Security area
and apply the following settings:
Section/Setting
Set to
Security
Activate JavaScript
Activate
Block pop-up windows
Deactivate
Privacy
Block cookies
2.
From third parties and advertisers
Printing the stop page (OS X only)
To print the stop page of the trainer correctly you have to allow the print of background elements. Activate
the option Print background in print dialog.
2.2.5
Settings on iPad
Specific browser settings are required for trouble-free display on an iPad. Tap Settings > Safari to change settings:
Section/Setting
Set to
Privacy
Accept Cookies
Always or From visited
Security
Block Pop-ups
Disable
Note
o
To use the trainer, library and book reader functions on an iPad, you need an active Internet
connection with access to a central server hosting the published content.
o
Playback performance relies on connection speed. If the connection is too slow, images might not be
loaded in time.
SAP Workforce Performance Builder 9.3
Settings
Customer
© 2014 SAP AG. All rights reserved.
33
o The iPad does not support Adobe Flash and therefore book elements containing flash animations are
not displayed.
2.2.6
Settings for E-Mails
When using the Send Content function of the library it is required that the e-Mail program uses UTF-8 character
encoding. This avoids an incorrect display of the e-Mail text in a specific language.
Microsoft Outlook
For Microsoft Outlook UTF-8 can be activated in the Outlook Options:
Section / Setting
Set to
Advanced -> International options
Allow UTF-8 support for the mailto: protocol
34
Customer
© 2014 SAP AG. All rights reserved.
Activate
SAP Workforce Performance Builder 9.3
Settings
3
Simulations - Recording
In this chapter, the basic procedures of the recording and rerecording of simulations with the Producer are
explained.
3.1
Recording a Simulation
The following sections describe the procedure for using the Producer's recording function for applications.
Requirements for Recording
For recording to take place fully automatically, a workarea must be selected, a new project with the type
Simulation set up.
Note
Recordings in the browser should only use Internet Explorer as the recording application profiles are
envisioned for this browser.
Recording Settings
In the central configuration dialog under the category Authoring Settings -> Recording - General you can define
specific settings for the recording. The configurations can be opened about the Tools -> Settings menu.
3.1.1
Starting the Recording
To start the recording, proceed as follows:
1.
Open the application to be recorded.
Choose the application page where you want to start recording and make any necessary changes.
2.
Open the Producer and create a new project. See also the chapter New Project.
3.
Click on the Record Application button in the project editor. The select application dialog opens.
4.
Select the application that you want to record from the Running Applications list. The selected application
appears in the foreground.
5.
The following additional settings can be configured in the dialog:
o
Profiles:
The Producer will attempt to recognize the correct application profile for the recording. The chosen
application profile will be displayed in the Profiles setting.
If you want to use another profile, you can change it using the dropdown box.
o
Associate with selected application:
The setting specifies that the profile will always be used for the selected application.
SAP Workforce Performance Builder 9.3
Simulations - Recording
Customer
© 2014 SAP AG. All rights reserved.
35
o Record Audio:
Activate the setting, if you want to record an audio during the recording of the simulation.
See also the chapter Recording Audio.
6.
Start the recording using the Record button.
Click on the Cancel button, if you want to cancel the recording.
Now the record bar opens and appears at the upper edge of the screen.
Application profile for recording
If a suitable application profile could not be identified, the Producer will use the default profile. Note that in this
case, the recognition accuracy of the interactions and controls in the application window might be limited,
depending on the application.
The used profile can be modified manually in the recording bar at any time. This may be necessary, for example, if
a change was made to the application.
Recording settings
Any problems with the recording settings are displayed in a dialog.
Click Cancel to resolve the problems. Then restart the recording.
To proceed with the recording, click Ignore. However due to the problems specified, recording may not be
possible or object recognition may be restricted.
3.1.2
Executing the Recording
To record with an application, proceed as follows:
1.
Navigate through the application as needed for the simulation. Your actions will be recorded automatically.
2.
Execute the actions slowly so that the Producer can correctly record the individual actions.
The basis of recording is the recognition of objects and controls. Algorithms are used to try to recognize
each object that you click on in an application.
o When an object is recognized, a corresponding macro (e.g. Input Text or Mouse Action) is generated.
o If an object is not recognized, it is recorded with the Fallback method setting in the Central
Configuration Dialog:
Hotspot recognition
Recognition of the Hotspot creates a Click macro or a Input Text macro that can be edited once
recording has been completed. This defines a specific area which was clicked on and populates the
macro parameters with standard values.
Control Selection Dialog
The Control Selection Dialog is where the control and text module to be used can be defined.
o You have the possibility to influence the automatic recognition of macros during recording, should
you not be satisfied with the results. Click on the Edit Control button
from the Tools menu. This
opens the Control Selection Dialog.
7.
36
To end the recording of a project, click on the Stop button in the recording bar.
This causes the Simulation End macro to be inserted automatically at the end of the project. That makes sure
that the playback of the simulation in ends correctly.
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Simulations - Recording
The recording bar will be closed.
Undo an action
If an error has been made during the recording, it is now possible to undo this action. By clicking on Undo , the
macro created for the action is deleted, then you can simply proceed with your recording as desired. Note that the
Undo function will only work with the last action made. You cannot delete multiple actions.
In some instances it may be necessary to manually reset the data entered in the application or change back to a
previous application. To do so, simply pause the recording, make the necessary changes and then proceed with
the recording.
Interrupt a Recording
Automated recording can be interrupted using the Pause
also the audio recording is paused.
Recording can be resumed using the Record
was interrupted.
3.1.2.1
button in the recording bar. If you record an audio,
button. The recording is picked up at the exact point at which it
Inserting additional macros
You can influence the design of your simulations even while recording is in progress. For example, you have the
opportunity to insert an additional screenshot in the form of a Screen macro or Explanation macro.
To do this, you have at your disposal in the recording bar at the menu Insert the Insert explanation and Insert
screenshot buttons. Clicking on one of the buttons inserts the corresponding macro in the project. Then continue
as usual with your recording. Upon completion of the recording you can continue editing the macros as
appropriate.
These functions can also be used in combination by you inserting a screenshot and then, superimposed on it, an
explanation in order to clarify a particular fact.
If you have minimized the recording bar, you can invoke these functions via the icon's context menu in the
taskbar.
Inserting an explanation
An explanation can draw attention to a specific situation. Insertion while recording is in progress makes it easier
for you to take immediate account of specific content and not have to look it up at a later date.
Selecting the function inserts an Explanation macro for the current step.
Inserting a screenshot
The Insert screenshot (Ctrl+Shift+b) function allows you, while recording is in progress, manually to set up an
additional screenshot for the application page currently being displayed without having to take any action in the
application. This sets up a step with a Screen macro.
SAP Workforce Performance Builder 9.3
Simulations - Recording
Customer
© 2014 SAP AG. All rights reserved.
37
You can use this screenshot for additional information between actions or else separately to draw attention to
particular functions on the application page.
3.1.2.2
Change application
You can change the application during recording if required by your process cycle.
Options in the central configuration dialog
If a change of application is intended for a recording you have the opportunity to prepare it beforehand in the
central settings under Record applications:

With the option Automatic profile change, it is possible to switch applications. This option can be activated
from the main configuration dialog box. When choosing another application during the recording, this
setting allows you to define whether or not the corresponding profile should be automatically chosen.
If you would like to show the change of application in the task bar of the tutorial, the recording area needs
to be enlarged for the task bar. In order to do so change the Sizeoption.

Recording change of application
1.
2.
3.
4.
First of all, click on the Pause button
to accomplish a change of application during recording.
Then go to the Tools menu in the recording bar and click the Choose application
function.
Click on the new application in order to select the application and determine the application profile.
Continue the recording by selecting the Recording
function in the recording bar.
3.1.3
Fallback Method for Object Recognition
It may happen during recording that one control cannot clearly be recognized. In this eventuality there are two
methods for manually defining and recording the control:

Recognizing and recording the Hotspot

Defining the controlled using the control selection dialog
The particular method can be defined in the Central Configuration Dialog using the Fallback method option. This is
located in the Authoring Settings -> Recording - General -> Fallback Method for Object Recognition area.
3.1.3.1
Recording a Hotspot
Recording the Hotspot defines an area for a control in respect of an unrecognized control at the point that has
been clicked. The Producer creates a Mouse Action macro or where text entry is involved a Input Text macro and
populates the relevant macro's parameters with standard values. This does not involve any object information
being read out of the application.
Recognition of the Hotspot allows the recording to proceed without interruption and post-editing can then be
carried out in the macro editor and in the step view.
38
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Simulations - Recording
Note
There is no visible difference between a recorded Hotspot macro and a regular control. A Hotspot can be
recognized from the macro type that can be read out of the macro editor in the Rerecord subcategory. A
Mouse Action macro has the value WINHotspotArea and a Input Text macro has the value
WINHotspotEdit.
Activating Hotspot Recognition
Hotspot recording is to be activated in the Central Configuration Dialog using the Fallback method option. To do
so, select the menu item Recognize Hotspot.
Note
Note that recorded Hotspots will affect a possible ReRecording of a project. As the Producer does not
save any object information for the control, the Hotspot itself is rerecorded during ReRecording even if
there is no control at this point.
In this regard consult the section on Interactive ReRecording.
Note
Before creating a Hotspot the Producer first performs a graphical object recognition. It is therefore
possible that the size used will not be the one defined for the Hotspot but the size of an object area
identified during recognition.
3.1.3.2
Control Selection Dialog
If while recording is in progress, the Producer fails to recognize one of the controls you have selected, a control
selection dialog will appear. This dialog allows you to define the control for the application manually.
SAP Workforce Performance Builder 9.3
Simulations - Recording
Customer
© 2014 SAP AG. All rights reserved.
39
To define a control manually, proceed as follows:
1.
Highlight the control to select it. The selected area will be displayed in close-up in the dialog window, allowing
you to align it with precision.
The screenshot thus created will be set up as the Field icon.
2.
Enter a name for the control in the Name field. This will then appear in the macro as Field Name.
3.
Select under Type which type of control you would like to define.
4.
Then set the Subtype for a more accurate definition. The available selection is a function of the specified Type.
The automatically generated text will be set up in accordance with the Subtype.
5.
You can use Value and End Value to define an initial and, if so required, an end value for a control. This is only
necessary for certain controls where a value is required. As a rule you can ignore these fields.
6.
Click on OK to confirm the dialog. The recording or ReRecording will then continue.
The Move button allows you to relocate the dialog on the screen view to give you an uninterrupted view of the
application user interface.
Activate Control Selection Dialog
The control selection dialog can be activated in the Central Configuration Dialog in the Authoring Settings ->
Recording - General area. To do so, go to the Fallback Method for Object Recognition subcategory and select the
Control Selection Dialog option in the selection menu.
40
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Simulations - Recording
Editing a control while recording is in progress
You can customize a selected control and its automatically generated text even while automated recording is in
progress. This requires you to click on the Edit Control
button in the recording bar once you have executed a
control. The control selection dialog will then open.
You can use this to influence the Field icon selection or customize the Field name. Then click on OK to resume
recording.
Note
In order to be able to edit the control using the control selection dialog while recording is in progress it is
not necessary to activate the Control selection dialog option as a Fallback method in the central settings.
This is the case as the Edit control option is not a Fallback method for an unrecognized control but merely
enables editing of a control during recording.
3.1.4
Recording in Internet Explorer
Recording in Internet Explorer requires a distinction to be made between whether the displayed browser content
or the browser content and browser interface are to be recorded. Optimal recognition of the controls requires
specific settings to be applied in the configuration dialog (area Authoring Settings -> Recording) depending on the
variant in question.
Note
When recording in the Internet Explorer make sure, that the zoom setting is set to 100%. Other settings
can lead to errors during recording.
Note
When recording web applications in Internet Explorer version 7 and higher, fonts may not be displayed in
the clear type format. This is necessary to make it possible for fonts to be correctly identified. To do this,
deactivate the Always use ClearType for HTML setting in the Internet options under Advanced ->
Multimedia.
Recording the browser content
You can only record the browser content i. e. only the actual webpage or application. The browser's user interface
is not recorded during the process and is therefore not visible on the screenshot. This requires the following
setting to be applied:

Select the Foreground window setting in the Area parameter.
Recording the browser content and browser user interface
Apply the following settings if you want to record the browser window content as well as the browser user
interface, to display menus and settings for example:

Select the Screen area setting in the Area parameter.

Activate the Customize application window setting.
SAP Workforce Performance Builder 9.3
Simulations - Recording
Customer
© 2014 SAP AG. All rights reserved.
41
3.1.5
Recording of Microsoft Excel
For the recording of Microsoft Excel there are several recommendations to support a correct object recognition:
Preparations
Open only one workbook in Excel.
Recording an Excel cell
To record a cell entry, proceed as follows:
1.
Select a cell with a left mouse click.
2.
Enter the values.
3.
Confirm with Enter or Tab key.
4.
Click in the next cell or on a control.
Repeat these steps for each needed cell entry.
Excel shortcuts
The following shortcuts can be used during recording:
Shortcut
Description
Enter
Completes a cell entry from the cell or the Formula
Bar, and selects the cell below (by default).
Shift + Enter
Completes a cell entry and selects the cell above. This
is recorded as Enter.
Tab
Moves one cell to the right in a worksheet.
Shift + Tab
Moves to the previous cell in a worksheet or the
previous option in a dialog box. This is recorded as
Tab.
Rerecording Excel
For the rerecording of Excel use the interactive Rerecording. This allows you to access at any situation and to
execute the actions manually.
If at any point during interactive Rerecording the application is not in the desired state for the next step, proceed
as follows:
1.
Click on Show Control.
2.
Navigate to the next step while holding the Ctrl key.
3.
Record the correct step without holding Ctrl.
No Rerecording will take place while Ctrl is pressed. This is useful when menus disappear after a click to show the
control in the previous step.
42
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Simulations - Recording
3.2
ReRecording a Simulation
When using various applications, companies often encounter a variety of problems when creating the
corresponding training material.
The applications are often used across locations in different countries and language regions and therefore consist
of multiple language versions. However, the processes and operations when using the applications in the various
language versions are more or less identical.
Therefore, it is necessary that companies have consistent training material explaining a particular process
available in the relevant languages in which the task is to be carried out.
Another problem lies in the new versions of an application and the changes to its interface that come part and
parcel with these newer versions. This requires a fast and simple update of the existing training material in order
to be able to describe processes according to the current version of the relevant application.
Problem definition
The following problems arise:

Localization: The goal is to create a language variant for the corresponding project based on a target
application in a different language.

Program update: The goal is to update the project based on a new version of the target application.
Troubleshooting in the Producer
The Producer offers the possibility of ReRecording. With this method it is possible to rerecord a project in a
different language as well as update the screenshots so that they correspond to new versions of the application.
This process is executed automatically by the Producer and has the advantage that a project does not have to be
manually recorded once again by the author.
ReRecording thus greatly simplifies coherent creation and updating of training material, thereby drastically
reducing the amount of effort needed when making a revised version.
3.2.1
Project changes
The following is some but not all of the information saved in the macros after a project has been recorded:
1. Automatically generated instruction text
2. Field Name / Identifier
3. Field Icon / Graphic
SAP Workforce Performance Builder 9.3
Simulations - Recording
Customer
© 2014 SAP AG. All rights reserved.
43
4. Screenshot application page
This information has to be customized to update or localize a project. The corresponding changes can be
automated to a large extent using ReRecording:
Area
Example
Description
Automatically generated
instruction texts
Click on...
The instructions generated while
recording have to be customized
according to the target application,
e.g. translated into a different
language.
Identifier of the recognized objects
/ Field Name
Save
ReRecording automatically
modifies the recognized objects’
identifiers.
Generated graphics / Field Icons
ReRecording automatically
customizes the graphics of the
objects contained in the bubble
texts.
Generated screenshots
ReRecording automatically
localizes the application page
screenshots into a different
language or a new version of the
target application.
Manually edited instruction texts
44
Customer
© 2014 SAP AG. All rights reserved.
This function applies your inputs to
the system.
Manually edited texts cannot
automatically be translated with
ReRecording. These texts will be
exported in translation templates
in XLIFF or Word format, translated
externally and then re-imported.
SAP Workforce Performance Builder 9.3
Simulations - Recording
3.2.2
ReRecording functionality
During the original automated recording of an application, the Producer creates a macro for each executed action.
This way, a project contains a sequence of macros, which when put together describe the process.
When ReRecording takes place, the Producer repeats in this process in the recorded application. Here a project is
gone through macro by macro and each action is executed and recorded once again in the corresponding
application.
This process is usually automatic and, depending on the settings actions, can also be executed manually. This way
the user can select a control during the ReRecording process and thus has the option of changing the recording
process. To recognize and execute the recorded control of an action during ReRecording, the Producer compares
the object parameters such as position, identifier and size.
Manual intervention by the author is necessary in some cases, if for example there is too much of a difference
between a control and the originally recorded object following a program update or if there are process changes
as a result of new or remote process steps. An action can also be executed manually if it was previously defined
for a control. This allows the user during ReRecording to select a control and optionally influence the ReRecording
process.
Translating a project
When the language of a project is changed using ReRecording, the project will be translated into one of the project
languages available in the Producer. Here, the automatically generated bubble texts of the macros are replaced by
text segments in the previously specified new project language. The original screenshots are updated with
screenshots from the other language version of the application.
However, projects also usually contain individually inserted texts. With the help of translation templates the text
segments can be customized before ReRecording.
Note
If only the texts of the bubbles are to be translated into a different language, without ReRecording the
project, this can be done by using the Automated Translation function.
Automatic translation makes sense if an application is only available in one language, but is needed in a
number of different languages.
Updating a project
When updating a project as a result of the production of a new version of an application, the corresponding
screenshots of the interface and buttons are rerecorded. The relevant bubble texts can be kept or updated as
required.
3.2.3
Preparations for ReRecording
Before being able to start ReRecording, a number of preparations must be made.
Note
ReRecording the projects with branches is not possible. A project will go through the ReRecording
process macro by macro in a linear fashion. However, branches provide multiple options for the path of a
project which the Producer cannot automatically follow. Branches should therefore only be integrated
into a project after ReRecording.
SAP Workforce Performance Builder 9.3
Simulations - Recording
Customer
© 2014 SAP AG. All rights reserved.
45
To be able to rerecord projects with branches, consult the ReRecording the Projects with Branches
section.
3.2.3.1
Preparing the application for ReRecording
Before starting the ReRecording some preparations are necessary in the application to be rerecorded so that the
ReRecording can be carried out in accordance with the originally recorded project:

To localize a project select the application in the desired language.

Open the application page containing the first step and ensure that the same status as in the original
recording is available (e.g. same tree structure).

Make sure that the dates and entries correspond to the system of the original recording. It might be advisable
to log off and log on to the system in order to reset existing values. If a project needs to be localized the
entries for the recording should be adjusted to the particular language.

When using dynamic pages, make sure that the state is according to the original recording. If so required the
application should be closed and reopened to remove all changes.

When localizing a project, make sure that the design of the application (e.g. SAP GUI) is the same as in the
recording.

To be able to rerecord a process, this should be repeated multiple times in the application, e.g. creating bill of
materials or routings in SAP. Creating alternative recordings usually results in a divergent process. If
necessary the created macro must be deleted or the material copied in order to enable a new recording.
Note
Macros may be deleted when working in the test system only!

When ReRecording SAP applications ensure that you are only logged on to one SAP system. If applicable, first
close all the sessions that are not required for the ReRecording.
3.2.3.2
Interactive selecting the control element
During the ReRecording process, a control can be selected interactive instead of automatically by the Producer.
This can be useful if the control is located at a different position in the application or a different control is to be
chosen for ReRecording.
This option should be applied to controls which were often not recognized during previous ReRecording attempts.
This way, the Producer does not have to look for them first.
To be able to interactive select a control when ReRecording, activate the Interactive setting in the corresponding
macro for the control. This can be done in the Subcategory Rerecord of the macro editor.
46
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Simulations - Recording
During ReRecording the Producer stops at the corresponding macro. You can now select the matching control.
Consult the Executing ReRecording section as well.
It is also possible to use the Interactive setting when switching between applications during ReRecording. This way
a recording can be stopped in order to select the application.
Activate the Interactive setting for the first executable macro of the new application.
Note
An application change must be carried out during the ReRecording process as the Producer cannot
automatically select an application.
3.2.4
Central Settings for ReRecording
A number of different settings can be made for ReRecording in the central configuration dialog. The central
configuration dialog can be opened from the menu Tools -> Settings... From here, select Authoring Settings ->
ReRecording.
The following settings can be adjusted:
General

Response Time:
This value entered here defines how long the Producer waits during the ReRecording process for a new screen
to be rendered before performing and recording the next action in the application. The value is entered in
milliseconds. Should the default value of 2 seconds (2000ms) not be sufficient because your application
response time is longer, you should increase this value.

Keep Crop:
This setting specifies that a layout that was set up for a Screen macro is to be kept intact.
If this setting is deactivated, the layout will not be applied during ReRecording. This can be necessary if a
control is at a different position in the new version of an application and the layout has to be reset.

Keep bubble orientation:
Activating this setting retains the selected bubble orientation. If this option is deactivated the orientation of
the bubble may change relative to the original project according to the position and size of the object to be
rerecorded.

Language dependent type:
If this parameter has been activated, the name of the Control is a clue that can be used to recognize it during
ReRecording. This is useful in new versions of an application in which corresponding Controls occupy a
different position or are differently designed. A search then takes place for this Control via the relevant
interface using the associated name.
Automatic Mode

Hotspot Handling:
This setting defines how a click range is to be edited during automatic ReRecording of a project.
o
No Editing:
If this option is selected a Hotspot is recorded automatically by Producer. In the process the Producer
uses the recorded position to identify a control device at this position. If no control device is identified a
Hotspot is recorded at this point.
SAP Workforce Performance Builder 9.3
Simulations - Recording
Customer
© 2014 SAP AG. All rights reserved.
47
o Interactive:
With this option the rerecording changes at a Hotspot from the automatic to the interactive mode. As a
result it is possible to edit the Hotspot. Refer to the chapter on interactive ReRecording for this.

Drop down list interactive:
Activate this setting to rerecord the drop down lists of your project interactively during the automatic
ReRecording. Thus the particular choice can be influenced manually.
Interactive mode

Bubble Style:
This parameter defines which bubble is displayed in the editor during ReRecording when a control device is
edited.
3.2.5
Starting the Rerecording
Rerecording can start once the necessary preparation is complete. To start rerecording, proceed as follows:
1.
Open the application to be rerecorded. Modify the application as necessary as described in the preparation
for rerecording.
2.
Open the project to be rerecorded in the project editor of the Producer.
3.
Click on the Rerecord Application button in the project editor. The select application dialog opens.
4.
The record application and profile is selected automatically.
If not, select the application that should be rerecorded from the Running Applications list. The selected
application appears in the foreground.
5.
The following additional settings can be adjusted in the dialog:
o Name:
Specifies the name of the project. This is recommended if you duplicate the project.
o Language:
Specifies a new language for the project. All of the project languages available in Producer can be selected
from a drop-down menu.
o Profiles:
The Producer will attempt to recognize the correct application profile for the recording. The chosen
application profile will be displayed in the Profiles setting.
If you want to use another profile, you can change it using the dropdown box.
o Associate with selected application:
Specifies that the profile will always be used for the selected application.
o Revise Values:
If you select this option, you can modify the text box inputs or selections you have made in drop-down
lists after you have applied settings in a dialog. This allows you, for example, to modify inputs for your
selected language or application version. The dialog is displayed after the relevant rerecording type has
started.
o Ducplicate Project:
Selecting this option duplicates the project before rerecording begins. The rerecording is performed in
the duplicated project.
The project needs to be duplicated because the rerecording is based on the original project that is
overwritten during rerecording.
48
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Simulations - Recording
6.
After you have applied your settings, decide on the rerecording type by selecting the relevant button. The
type defines how you can intervene for unrecognized controls. Choose between:
o
Automatic ReRecording
o
Interactive ReRecording
For further information, refer to the chapter ReRecording types.
Now the record bar opens and appears at the upper edge of the screen.
Recording settings
Any problems with the recording settings are displayed in a dialog.
Click Cancel to resolve the problems. Then restart the recording.
To proceed with the recording, click Ignore. However, due to the problems specified, recording may not be
possible or object recognition may be restricted.
3.2.5.1
ReRecording types
In the start dialog you have two buttons available you can use to start an appropriate type for the ReRecording.
The types define what to do when dealing with unrecognized controls.

Automatic
This button starts the Automatic ReRecording. With this recording method, an unrecognized control is
recorded as a Hotspot.
It is also possible to define how the method will deal with a recorded Hotspot. That means that this recorded
Hotspot can be edited with an editor or else use the wizard for the ReRecording.

Interactive
This button starts the Interactive ReRecording. This recording method can be used to edit unrecognized
controls as a Hotspot directly on the application. This involves opening an Editor which makes it possible to
position and edit the range of the object area and the bubble.
During Interactive ReRecording each control found is to be confirmed by pressing the Enter key in order to
resume ReRecording.
The interactive ReRecording still serves as a fallback method in a situation where a conflict occurs during
automatic rerecording. In a conflict situation the mode is changed to interactive mode and after the conflict
situation was resolved it is changed to automatic mode again.
3.2.5.2
Partial ReRecording
In addition to the normal ReRecording you can also launch ReRecording from a specific step or for specific,
selected steps. This allows projects to be partially recorded and it is thus not necessary to rerecord the entire
project.
SAP Workforce Performance Builder 9.3
Simulations - Recording
Customer
© 2014 SAP AG. All rights reserved.
49
Rerecord selected steps
This selection allows you to rerecord several related project steps. This is useful, for example, if a partial update of
associated projects is required as a result of changes within an application.
Before starting to rerecord, highlight the desired steps in the thumbnail view. Then select the option Rerecord
selected steps.
Rerecord from current step
This selection allows you to start ReRecording from a specific step. This setting is useful if you are only supposed
to rerecord from a particular section of a project. The step must be selected in the Producer thumbnail view prior
to ReRecording. Then select the option Rerecord from current step.
3.2.6
Executing the ReRecording
Once the ReRecording has been started the Producer executes it automatically:
1.
When ReRecording a project, the Producer goes through the macros from the original recording step by step.
The actions of the individual macros are executed in the application and recorded.
While this is happening, the recording bar is displayed in red, showing the recording and thereby the
recognition and execution of the controls.
2.
According to the type selected in the start dialogue the ReRecording is accomplished as described in the
respective chapters:
o Automatic ReRecording
o Interactive ReRecording
Now record the project as described in the particular subchapters.
Note
If an action was incorrectly executed during ReRecording it is advisable to terminate the ReRecording and
use the selection Rerecord from current step to resume ReRecording the remainder of the project from
this step.
3.
If ReRecording was executed successfully, a dialog will appear. Confirm it with OK.
The recording bar will be closed.
50
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Simulations - Recording
3.2.6.1
Automatic ReRecording
When rerecording in automatic mode every step is recorded automatically by Producer. An intervention by the
user is only necessary if a conflict situation occurs. In this event the rerecording changes into interactive mode
and after the conflict situation was resolved it changes back to automatic mode.
If a conflict situation occurs during rerecording you are informed by means of an explanation bubble. Such a
conflict can be:

A control device does not match the originally recorded control device

A control device could not be identified

The Interactive option was activated for a macro
In addition to the occurring conflict situation the bubble text informs you how to resolve it.
Conflict approach
If one of these cases occurs, the automatic mode changes into interactive mode. By selecting the Show Control
function in the recording bar the designated control device can be recorded interactively. Click on it in order to do
so.
If a control device matches the originally recorded one you can also confirm it under Accept Control
.
Control device was set interactive
If the macro setting Interactive is applied in the subcategory Rerecord before the rerecording takes place, the
Producer stops at this point and changes to interactive mode. Now the object can be edited. After confirming
Accept control device in the recording bar the rerecording is resumed.
This procedure is also executed if the interactive rerecording was activated in order to rerecord Hotspots. The
particular Hotspot handling setting can be defined in the area Authoring Settings -> ReRecording in the central
configuration dialogue.
3.2.6.2
Interactive ReRecording
The interactive ReRecording allows checking the control devices which need to be rerecorded and to influence
them directly during the recording process. Furthermore, steps can be rerecorded, deleted or skipped.
Using the interactive ReRecording makes sense when many modifications need to be made, several objects were
recorded as Hotspot or major alterations were introduced to the application with regard to the original tutorial.
Accomplishing interactive ReRecording
Interactive ReRecording stops at every object and displays it including its mark and bubble during the process.
Now you can edit the object or, if it is correct, resume rerecording directly. Confirm the object via the Accept
Control
button in the recording bar. As a result the rerecording is resumed.
Conflict approach
If a conflict situation occurs during ReRecording you are informed by means of an explanation bubble. Such a
conflict can be:

A control device does not match the originally recorded control device

A control device could not be identified
SAP Workforce Performance Builder 9.3
Simulations - Recording
Customer
© 2014 SAP AG. All rights reserved.
51

The Interactive option was activated for a macro
In addition to the occurring conflict situation the bubble text informs you how to resolve it.
By selecting the Show Control
function in the recording bar the designated control device can be recorded
interactively. Click on it in order to do this.
If a control device matches the originally recorded one you can also confirm it under Accept Control.
3.2.6.3
Editing in interactive mode
If an object is rerecorded interactively it appears within a selection frame and with the corresponding bubble. The
selection frame can be moved within the application, adjusted in size via the handles and positioned above the
control. The bubble can also be moved to the designated position; a click in the bubble allows editing the
particular bubble text.
It is possible to navigate in the target application during interactive ReRecording in order to select a certain page
or to make required adjustments in the application.
Confirm the designated adjustments when completed under Accept Control
in order to resume rerecording.

Show Control
If a control is not displayed correctly you can directly rerecord it via the Show Control function. Select the
function and click on the control.

Step Preview
The Step Preview displays the originally recorded step so that it can be reproduced and the object adjusted
accordingly.
Further functions
The Tools and Insert menus allow you to select further functions for editing the tutorial during ReRecording:

Insert Explanation (Insert)
This button allows you to add an Explanation macro during ReRecording. After clicking the button select the
position for the bubble, then define the explanation text and confirm it with Ok.

Delete Control (Tools)
This function offers the opportunity to delete the currently selected object. Then the ReRecording is resumed
using the following object in the tutorial.

Skip Control (Tools)
This function allows skipping a recorded control if it does not need to be taken into account for the
ReRecording and thus remains unmodified.
Note
The bubble displayed in interactive mode corresponds to the setting in the central configuration dialogue.
It can be either the Demo or the Practice bubble.
52
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Simulations - Recording
3.2.6.4
Recording additional steps
While ReRecording is in progress you can use automated recording to record additional steps and add them to
your project. This comes in useful, for example, for creating additional inputs in a form.
To record additional steps you need to run ReRecording interactive. Subsequently, ReRecording comes to a halt
at each step to be rerecorded with the control that has been found requiring confirmation. This enables you to edit
the control that has been found as well as access the recording bar functions and launch automated recording.
Newly recorded steps are inserted in front of the current step to be rerecorded at which automated recording was
started. This is necessary so that once inputs have been committed ReRecording means that they are displayed
on their respective screenshots in subsequent steps.
This is how you record additional steps:
1.
If you arrive at a step before which you would like to insert other steps, start the recording at this stop. In
order to do so select the Record Control
button at the menu Insert in the recording bar.
Note
Do not confirm the step in front of which you would like to record additional steps by pressing on the
Enter key. Start recording directly as otherwise ReRecording will continue.
2.
Record the designated control devices in the same way as during regular recording. Refer to the chapter on
accomplishing recording.
3.
If you would like to resume rerecording afterwards press the ESC key. The rerecording is resumed at the step
where you started the recording.
3.2.6.5
Change of application
If a change of application takes place in a project a particular procedure is required in order to accomplish the
change during ReRecording. This procedure applies to the automatic mode as well as to the interactive mode.
At the point of the application change the ReRecording displays a note window to inform you that the application
does not match. Now proceed as follows to accomplish the change of application:
1.
Click on Choose in the note window.
The Choose Application dialog is opened.
2.
Select the required application from the Running Applications list.
3.
Click on Choose.
Afterwards, the rerecording continues with the required application.
SAP Workforce Performance Builder 9.3
Simulations - Recording
Customer
© 2014 SAP AG. All rights reserved.
53
3.2.6.6
Key functions for ReRecording
During ReRecording different actions can be performed using key functions. They depend on the particular type:
Automatic mode
Keys
Definition
Pause
With the Pause key ReRecording can be paused.
Esc
With the Esc key ReRecording can be cancelled.
Interactive mode
Keys
Definition
Enter
With this key you can confirm a displayed control
device and continue ReRecording.
Ctrl + Enter
With this key you can confirm a displayed control
device and continue ReRecording if the bubble is
displayed in edit view.
Ctrl
With a pressed Ctrl key you can navigate freely in the
application without an action being recorded.
This is useful for instance for selecting lists, in order to
open them and record the selection.
Esc
Terminates recording if further steps are inserted via
the recording function.
3.2.7
ReRecording of Projects with Branches
ReRecording the projects with branches is not possible. A project will go through the ReRecording process macro
by macro in a linear fashion. However, branches do provide a number of options for progression, wh ich is why
some controls of a branch cannot be found during ReRecording.
As a general rule, branches should therefore only be integrated into the corresponding project after ReRecording.
If a project with branches exists, it will require a different procedure for ReRecording:
When working with branches, it is necessary to partially execute the ReRecording of a project. This entails the
corresponding project being split up in order to be able to rerecord steps that run linear to one another. Here, only
the corresponding step with the branch will need to be edited.
When working with branches, it is necessary to remove them after ReRecording so that they can reattached.
54
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Simulations - Recording
3.2.7.1
Partial ReRecording of Linear Steps
The following chapter describes how to carry out ReRecording for a project with branches.
Select the corresponding page of the project.
If required, make sure that all necessary preparations described in the Preparations for ReRerecording section
have been made.
1.
Now select the related steps you want that do not have a branch.
2.
Start ReRecording in the toolbar by selecting the option Rerecord selected steps.
Begin ReRecording as you would normally. Here you should consult the Executing ReRecording section.
Repeat this step for additional sections of the project if required.
3.2.7.2
Editing the Branches
The branches can be edited once the recording of the sections that run parallel to one another has finished. To do
so, they have to be deleted and set up again. If possible, take note of the branch structure before removal so that
you can set the branches up again in a way similar to their original form.
1.
Delete the branch. To do so, select the corresponding Screen macro and click on the Remove Branch button
in the macro editor.
Also delete the subsequent macros belonging to the branch, except for the first macro with a control under
the Screen macro.
2.
Recording the controls for the alternative paths can be done using automated recording. You should proceed
as follows:
1.
Select a step for the branch from within the Producer.
2.
Go to the application and select the position in the project where this branch occurs.
3.
Start recording in the Producer by pressing the Record Application button .
4.
Click the control for the other path in the application.
5.
End the recording process once this has been completed by pressing the Stop button in the recording bar.
3.
Carry out these actions for each control you wish to integrate into the branch that is to be created. To do so,
go back a step in the application if required.
4.
Each control belonging to the branch must now be compiled in the project.
To do this, select the corresponding Screen macros. Compile these using the Merge selected Screens
function in the menu Tools -> Automation.
5.
Once you have finished recording the additional controls you will now be able to create the branch. Consult
the create branch section for further information.
6.
To finish, edit the corresponding bubble text if required.
Repeat this step for all of the other branches in the project.
SAP Workforce Performance Builder 9.3
Simulations - Recording
Customer
© 2014 SAP AG. All rights reserved.
55
3.3
Recording an eCATT File
When recording a simulation, you can create an eCATT file (eCATT.xml). eCATT (extended Computer Aided Test
Tool) files are used for importing data into test automation software.
An eCATT file can be created when recording an SAP system with SAP GUI. This file allows you to use a recorded
process for an automated test with eCATT in the live system.
For further information on using eCATT, read the specific eCATT documentation.
Activating eCATT generation
eCATT files are generated in addition to the simulation modes. To generate the files, you have to activate the
eCATT setting in the central configuration dialog box (Tools -> Settings...) under Producer -> Save -> Standard.
Recording an eCATT file
To record an eCATT file, use the project type Simulation. The information required for the eCATT file is collected
during recording. The eCATT file is generated when the project is saved.
If a project is rerecorded, the eCATT file information is updated.
When a workarea is published, eCATT files are not exported because the files are not required for content
playback.
Handling an eCATT file
Once the project has been saved, the eCATT file is generated and stored in the project folder. eCATT objects are
displayed in in the object structure of the project explorer.
The eCATT file is stored in the project folder. Open the project folder by using the Open Folder menu entry in the
context menu of the project.
You can import the eCATT.xml into your eCATT system and test the recorded process.
Note
eCATT files use always the file name eCATT.xml. If you want to use and store multiple files in a folder,
rename the files using different names.
56
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Simulations - Recording
4
Simulations - Editing
Once a simulation has been recorded in the Producer it can be edited in numerous ways. For example, so as to
enhance the didactic benefit of the projects and promote a more diverse presentation of the content. As before,
translation templates can be used to render the content into any desired language.
In addition to deleting and adding content in the form of steps or recording macros, and completing
documentation macros, the content of macros themselves can be changed and parameterized.
Take care at all times when editing that the changes you make do not compromise the consistency of the project
in relation to teaching material that has yet to be added.
Recommendation
Make sure you save the project at regular intervals. You can also use the Save Automatically option.
Recommendation
If you start the playback of a simulation in the Producer to check it, you can follow the progress of the
playback within trainer by looking at Producer thumbnail view. This simplifies the localization of errors
since it provides direct, visual identification of the corresponding macro and thus facilitates the user's
orientation within the project.
4.1
Simulation Modes
For simulations you can generate the following modes:

Demo mode
Demo mode generates a simulation that plays the recorded process like a simulation and does not expect any
interaction by the user. Explanations are given as examples using the actions and data generated during the
recording process.

Practice mode
In Practice mode, trainer expects the user to act within the simulated environment in the same way as with the
live application. The simulation will only be continued after the user has obeyed the instructions in the proper
order as presented by the bubbles

Test mode
Test mode is based on Practice mode. The instructions in the bubbles are not displayed and the user has to
find the right way through the application alone. This mode is especially useful for test scenarios following
training.

Concurrent mode
In turn, Concurrent mode is based on Demo mode, but works with an additional smaller browser window
parallel to the live application. This supports the user by offering help during the live process. The user can
copy the actions step by step as indicated in the help window. The same text is displayed in the bubbles as in
the Demo mode. In this mode, the trainer window is always in the foreground. The next step is displayed only
after the user has confirmed this change by clicking on the Continue link.
SAP Workforce Performance Builder 9.3
Simulations - Editing
Customer
© 2014 SAP AG. All rights reserved.
57
Note
Only the Internet Explorer does support the top-most window implementation of the Concurrent mode.
That is why opening Concurrent mode in another browser automatically uses the simple window view.
Start and stop pages
When playing back a simulation with trainer, for each mode a start page is displayed which explains the mode the
simulation will be played back in and what the user has to expect. When the simulation is over or was closed prior
to completion, a stop page is displayed in order to indicate that the mode has been terminated. In Test mode the
stop page also informs the user if he passed the test or not.
4.1.1
Playing back a simulation
To call up a recorded simulation directly from Producer, click on the Playback button in the toolbar of the project
editor. You can change the mode about the dropdown menu:

Demo mode

Practice mode

Test mode

Concurrent mode
The mode is then opened in trainer and played back.
4.1.2
Mouse simulation
You have the facility available in the Producer to simulate mouse movements and actions while playing back
simulations in the trainer. This enables a greater emphasis to be given to actions, for displaying single and double
clicks visually, for example. You will see the mouse simulation displayed in Demo mode and Concurrent mode.
Activating mouse simulation
The mouse simulation is activated in the central configuration dialog from the Show Mouse option. You will find
this in the Playback Settings -> General area.
Changing the mouse pointer
In the Visual properties area of the Playback Settings -> trainer settings you can apply the Big mouse pointers
setting for defining the mouse pointer. This option defines, that the big mouse pointers will be shown for the
visualization of a simulation.
4.2
Designing Simulation Pages
You can design the pages in your simulations any way you want. This can be useful if the screenshots of the
recording do not take up the entire screen area or if you are using imported pages.
58
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Simulations - Editing
The pages are designed on the basis of the book page design so that the book page styles available in the
workarea can be used. You can find the respective settings under Playback Settings -> General -> Page Style in the
central configuration dialog (Tools -> Settings... menu).
You can create the design as the default design for your workarea or for a specific project. A specific project can
be defined as template for other projects.
Settings

Style:
The setting defines the page design. A book style that uses the macro can be selected for this from the dropdown list.
The setting also affects the book page objects inserted in a simulation.

Centered background image:
This setting centers the background image or the simulation screenshot. If the option is deactivated, it is
positioned in the upper left-hand corner.

Page color:
Determines the color of the page. The Select color... function can be used to define an appropriate value. This
can be specified using the RGB or HSV color space or as a hexadecimal value. If no background color is to be
displayed, click the Transparent button.

Background color:
Determines the color of the background. The Select color... function can be used to define an appropriate
value. This can be specified using the RGB or HSV color space or as a hexadecimal value. If no background
color is to be displayed, click the Transparent button.

Border:
Defines the thickness of the border in pixels. If no border is to be displayed, the value is to be set to '0'.

Border color:
Defines the color of an object's border. The Select color... function can be used to define an appropriate value.
This can be specified using the RGB or HSV color space or as a hexadecimal value.

Border style:
Determines the style of the border that you can select from the drop-down list.
4.3
Editing the Simulation Macros
The upper portion of the macro editor provides additional commands you can use to edit the screenshot or step
content.
Page macro

Manual Crop (Documentation):
This command makes it possible to define a section of the screenshot for use in the documentation instead of
using the entire screenshot. This entails opening a dialog window in which the section can be defined using a
selection frame.

Auto Crop (Documentation):
This command can be used to crop a screenshot automatically for the documentation. This entails setting up
the range of the selected control as a crop with a defined distance separating it from the associated highlight.
This distance can be set up in the central configuration dialog under Authoring Settings -> Auto Crop.
SAP Workforce Performance Builder 9.3
Simulations - Editing
Customer
© 2014 SAP AG. All rights reserved.
59
You have the option to retain this crop when ReRecording an application. Be mindful of the setting Keep Crop
in the Parameter dialog for ReRecording.
Note
While ReRecording a project, you can retain the crop you have applied. To do so, activate the Keep Crop
option when starting the ReRecording. Pay attention in this regard to the section Central settings for
ReRecording.

Uncrop (Documentation):
If a section of the screenshot was manually or automatically cropped, this function allows the crop to be
removed again.
Recommendation
If you would like to automatically crop all of the screenshots in a project or remove the crops that have
been applied, then note the Auto Crop all Screens and Uncrop all Screens functions in the Tools ->
Automation menu.
Macros for interactions

Update Field Icon:
If changes have been made to the highlights on a screenshot, it may be necessary to modify its field icon as
well. You can do so by clicking on the option Update Field Icon in the macro editor. An editing window will then
appear in which you can make the necessary changes to the icon. Drag the highlight to the desired position
and confirm by clicking on OK.
4.4
Field name and field icon parameters
The Field Name and Field Icon parameters are present in all interaction macros. If a control is recorded, the
Producer inserts the name in the Field Name parameter and the screenshot of the action that has been carried out
in Field Icon.
The contents of both parameters are used for the bubble text when automatically generating the text modules
and inserted at an appropriate point in the text.
Altering values
It may in certain circumstances be necessary to alter the name or screenshot of the parameters. For example, this
will be the case if a control in an application has changed but it is not worth ReRecording a project.
Any change to the parameters is automatically incorporated in the bubble texts forDemo mode and Practice
mode.

You can change a name by making an input in the text box. This will automatically amend the associated
bubble text.

You can use the function Replace image…
function to alter the screenshot. Clicking on the button opens an
option menu offering you functions for creating or inserting a screenshot. Select the appropriate method.
Once the screenshot has been altered, it will also appear in altered form in the bubble text.
Updating a field icon
If changes have been made to the highlights on a screenshot, it may be necessary to modify its field icon as well.
You can do so by clicking on the option Update Field Icon
in the macro editor. An editing window will then
60
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Simulations - Editing
appear in which you can make the necessary changes to the icon. Drag the highlight to the desired position and
confirm by clicking on OK.
Note
Note, that field icons cannot be exported into a PowerPoint document. In MS PowerPoint it is not possible
to insert an image within a text.
4.5
Editing highlights and bubbles
You can enhance interaction macros with highlights and bubbles. The highlights outline the recording control and
the bubbles display text with instructions, tips, etc.
The highlights and bubbles can be edited from the Step view. For example, you can choose a macro from the
thumbnail view, such as Click. Then in the step view, the highlights and bubbles for the recorded control will be
displayed on the screenshot for the macro Screen.
There are options on the toolbar that allow you to switch between demo and concurrent modes to display the
bubbles. This allows the bubbles to be viewed and edited for the respective mode.
4.5.1
Properties of highlights
Main differentiations for the use of highlights are:

Standard Highlight:
The highlight is generally used for the visualization of actions and explanations.

Help Highlight:
The highlight is used in case that the user asks for help during playback of a test mode.
In accordance to the use the settings can be set individually.
Settings in central configurations
The settings can be set globally or project specific in the central configuration dialog in the area Playback Settings
-> General -> Highlights.

Border:
This parameter defines the thickness of the project highlight frame in pixels. Pixel widths available are from 1
to 10.

Color:
This defines the color of the highlight border. The color may be entered directly as an RGB value in HEX
format or selected from out of the Color Picker dialog box.

Help Color:
This highlight color will be used in practice or test mode in case that the user is asking for help. The highlight
will be used to show areas of correct action.

Form Structure Color for Correct Answer:
This highlight color will be used in practice or test mode in case that the user is asking for help. The highlight
will be used to show areas of correct actions in a form structure.
SAP Workforce Performance Builder 9.3
Simulations - Editing
Customer
© 2014 SAP AG. All rights reserved.
61

Type:
This option defines the form of the highlights used in the simulation.
o Rectangle
o Ellipse
o Underline
Note
The highlight types Ellipse and Underline are only displayed during playback. In step view and in
documentation the highlights are always use the type Rectangle.

Effect / Help Effect:
This option defines the kind of effect used for highlights.
o Show
o Animate
o Pulsate
o Frame Flashing
o Focus Zoom
4.5.2
Positioning the highlights and bubbles
From the step view, you can change the size and positioning of the bubbles and highlights for the respective mode
as follows:
Positioning the highlights and bubbles
1.
Click on the object you would like to edit.
2.
A red line will appear around the object. Click on the object again, this time holding the mouse button down.
3.
With the mouse button still pressed, drag the object to the desired position.
4.
Release the mouse button and the object is now positioned.
Changing the size of the highlights and bubbles
1.
Click on the object you would like to edit.
2.
Dots appear around the object so that you can change its size. Click on one of the dots and hold the mouse
button down.
3.
With the mouse button still pressed, drag the dot inwards or outwards to the desired size.
4.
Release the mouse button to set the new size.
Changing text bubble alignments
1.
Click on the object you would like to edit.
2.
A square will appear at the tip of the bubble, which you can use to turn the object. With bubbles that do not
have a tip, the square will appear in the middle of the bubble. Click on the dot and hold the mouse button
down.
3.
With the mouse button still pressed, pull the dot away from the bubble and until you have reached the desired
position. Pull the dot towards the middle of the bubble if you wish to hide the tip.
62
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Simulations - Editing
4.
Release the mouse button to set the new position.
4.5.3
Editing bubble text
Bubble text for the macros for each mode can be directly edited in the bubble or in the macro editor.

Editing in the step view
Double-click on a bubble and an HTML editor will appear with various options for editing the content. For
more information on the HTML editor, refer to the HTML Editor section of the document. Edit your text as
desired and click on OK to confirm your changes.
Editing in the macro editor
Changes can be made in the macro editor using the two options Text (Demo Mode) and Text (Practice
Mode). Click on the respective text field and the HTML editor will appear. You can now edit the text.

Note
Note that when changes are made to the text, this text can no longer be automatically translated into
another language (Automated Translation and ReRecording). All customized text must be manually
translated or exported into a translation template to be translated externally.
4.6
Intro and End Pages
The intro page shows an introduction to the learner at the beginning of a simulation. It is also possible to start the
simulation at a specific step and to guide the learners through this chosen step. At the end of a simulation, the end
page shows a texts or a summary for the test mode result.
The intro and end pages can be used for the demo, practice and test mode as alternatives to the general start and
stop pages for simulations.
Intro Page macros
Several macros are available to define an intro page. The macros can be inserted via the Insert -> Insert Special
Macro menu. More information can be found in the macro overview chapter. The following macros have to be
inserted in this structure:

Intro Page

Intro Page Start Link
Parameters of the End Page
To define the behavior of the end page, use the associated parameters in the Simulation End macro. For more
information, refer to the Simulation End chapter.
SAP Workforce Performance Builder 9.3
Simulations - Editing
Customer
© 2014 SAP AG. All rights reserved.
63
Hide the start and stop pages
To use only the intro and end pages for a simulation, the start and stop pages should be deactivated in Playback
Settings -> trainer of the central configuration dialog. Disable the Show start page and Show stop page settings in
the Visual properties subcategory.
4.7
Audio in Simulations
The Producer supports several ways to integrate audio into simulations and to enrich the information. This allows
information to be presented using visual and audio material, thus stimulating more of the learner's senses. This
facilitates a heightened awareness and superior assimilation of the content.
Note
Audio files in simulations are only played back for the demo mode.
Prerequisite
A special audio project is required to use audio in simulations. You can either define this when setting up the
project by selecting the parameter Use audio, or you can convert the project later on from the menu Project ->
Convert to Audio Project.
Creating audio
Audio files for simulations can be created in the following ways:

Importing of audio files

Recording of spoken texts

Conversion of Text to Speech
The audio editor (in the project editor of the Producer) allows you to create and edit audio files.
Refer to the section on audio editor.
If an audio file is available in a step, you will see an audio icon in the step's thumbnail view.
Functions in the menus
In the Audio menu, there are several functions for editing audio. Refer to the relevant sections for further
information. The menu is only available for an audio project.
Supported file formats
The following audio file formats are supported:

Import of audio files
o Sound file - wav
o AVI sound file - avi
o MP3 Sound file - mp3

Editing of audio in project
o Sound file - wav
64
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Simulations - Editing
4.7.1
Importing Audio
Importing audio files allows you to easily integrate audio files into a simulation.
Note
By importing an audio file, the existing audio of a step will be overwritten.
Proceed as follows to import an audio file:
1.
Select the step for which you want to import an audio file.
2.
In Audio Editor, click the button Import Audio File…
The Choose File dialog opens.
Alternatively you can use the Audio menu.
3.
Select the file.
4.
Click Open to insert the file.
4.7.2
Recording Audio
Audio recording allows you to narrate your own texts with the microphone. The texts can be played back as
explanations for the relevant steps.
There are two ways to record an audio:

during the recording of a simulation

during the editing of a simulation
Requirement
For audio recording, a microphone is necessary. Connect this first before starting to record.
Audio recording during recording of a simulation
During the recording of a simulation you are able to record an audio directly. When starting the recording of a
simulation the Select Application dialog includes a setting Record Audio. Activate the setting, to execute the
recording.
See also the chapter Starting the recording.
The recording of audio is only possible during the recording and not for the rerecording of a simulation.
Audio recording during editing of a simulation
Proceed as follows to execute the recording:
1.
Click on the Record Audio… button. The recording dialog opens.
Alternatively you can use the Audio menu.
2.
Click on Start Recording.
3.
Read out your text.
During the recording, a sound level meter shows the volume. You also see the spoken text as an audio track.
4.
Click on End Recording. The recording dialog closes.
For more information, refer to the Recording Dialog chapter.
SAP Workforce Performance Builder 9.3
Simulations - Editing
Customer
© 2014 SAP AG. All rights reserved.
65
Note
During the recording of an audio file, the existing audio of a step will be overwritten.
Read out the full text for your recording because it is not possible to record the text in sections. Any unwanted
parts can be cut out afterwards. If you are not satisfied with the outcome, record the text again.
Recommendation
If the recording contains background noise, then it is recommended that you edit the audio file with the
dynamic editor to improve the sound.
4.7.3
Creating Text to Speech
The Text-to-Speech functionality converts written text into digitized speech. This makes it possible to play back a
simulation's bubble texts in spoken form. During the conversion process, the simulation macros bubble text is
converted into an audio file. The actual bubble continues to be displayed when playing the simulation back in the
trainer so that the two formats provide mutual support.
The recommended quality for an audio project with spoken text is: 22kHz Mono.
Changing the voice
The Producer uses the Text-To-Speech voice available on your operating system. If you want to use a different
voice, this must be changed in the Text-To-Speech settings in your operating system.
Creation of text to speech
We recommend that you convert text to speech after a project has been edited. Steps should be converted
individually. If a step contains several macros (for example, several steps are connected), then the texts will be
read out one after the other in the order in which the macros are arranged.
If the bubble texts of a simulation are already converted into text to speech, they are available when you open the
editor.
Proceed as follows to create a text to speech:
1.
Open the text to speech editor using the Edit Text to Speech… button in the audio editor or Audio menu.
Refer to the chapter Text to Speech Dialog.
2.
Insert a text in the text field or edit the available text.
3.
Define the duration of the silence to be inserted at the beginning of the audio file.
4.
Confirm the input with OK. The dialog is closed and the audio file generated.
Note
If a step contains several macros, the individual actions and associated spoken texts will run
asynchronously in relation to one another. This is because the texts are converted into an audio file and
are not linked to the actions. It is therefore advisable to only use one macro per step.
66
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Simulations - Editing
4.7.4
Editing Audio
The audio track can be edited in various ways to optimize the output. There are different functions available in the
audio editor.
For more information, refer to the Audio Editor chapter.
4.7.4.1
Inserting a Silence
This function inserts a silence with a defined length into a specific part of your audio.
The silence will be inserted at the position of the red marker. If an area is marked, it will be overwritten with silence
completely.
1.
Select the point of the audio track with the marker for the beginning of the silence.
2.
Click the Insert Silence… button.
3.
Define a value in milliseconds in the editing dialog. Only positive integer values can be used.
4.
Confirm the dialog with OK.
If an area should be converted into silence, mark the relevant area on the audio track. Click the Insert Silence…
button and silence will be included immediately.
4.7.4.2
Normalizing Audio
The function Normalize allows you to equalize the volume of all audio files and thereby make audio files with
different properties consistent. The amplitude of an audio track will be increased consistently.
Recommendation
If the amplitude has big differences in the highs and lows due to normalization, it is recommended that
you edit the dynamic of the audio with the dynamic editor.
Normalization can be applied to the entire audio track or a particular area.
1.
Select an audio track and go to the audio editor.
2.
Highlight the area you want to normalize.
3.
Click the Normalize… button.
4.7.4.3
Trimming Audio
The Trim Audio function allows you to cut an audio track down to a specific part. Unnecessary parts can be
deleted to reduce the playback time and the size of the audio file.
SAP Workforce Performance Builder 9.3
Simulations - Editing
Customer
© 2014 SAP AG. All rights reserved.
67
To trim an audio track, proceed as follows:
1.
Mark the area of the audio track that you want to keep.
2.
Click the Trim button in the toolbar.
The parts left and right of the highlight will be removed.
4.7.4.4
Fading Audio
Using the functions Fade In and Fade Out, you can fade a part of the audio track from mute to full volume or the
other way around.This makes the audio track much more effective and ensures smooth transitions.
In general, it is recommended that you use fading at the beginning and at the end of an audio track.
To use fading for an audio track, proceed as follows:
1.
Mark an area of the audio track, to define the position and length.
2.
Click the Fade In or Fade Out button in the toolbar.
4.8
Form Structure
The Producer provides you with the Form Structure function for displaying forms realistically in Practice mode or
Test mode. While a simulation is in progress, the user can fill in the interactions contained within the form
structure in an individually chosen sequence and then confirm the inputs as a whole. This does not display a
confirmation immediately after an action has been inputted but only once all actions have been performed.
A Form Structure is made up as follows:

it is positioned under a Screen macro

it has a start and end macro

the associated interactions are to be found between the two Form Structure macros.
68
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Simulations - Editing
At least two interactions should generally be available for a Form Structure.
4.8.1
Create Form Structure
After recording a project, you can create a Form Structure in it:
1.
For the Form Structure the Screen macros are to be combined in a step with the associated actions contained
in the form. This is required as the Form Structure cannot be created in a way that spans steps.
1.
Select the Screen macros belonging to the steps whose interactions are to be used for the Form Structure.
2.
Now click on the function Merge selected Screens
in the menu Tools -> Bulk Changes.
The first macro Screen is retained and the others that are highlighted are deleted. The previous steps'
macros are arranged in the merged step.
Note
A Click macro is required as the last macro of a form structure in order to be able to complete the form
correctly. For example, this can be an OK or dialog box Save button enabling the form inputs to be
confirmed.
Now create the Form Structure.
2.
Select the Screen macro of the merged step.
3.
In the toolbar, click on the Create Form Structure button
(menu Insert -> Insert Special Macro).
In the Producer thumbnail view, you will now see that all of the step macros are incorporated within the Form
Structure macros.
SAP Workforce Performance Builder 9.3
Simulations - Editing
Customer
© 2014 SAP AG. All rights reserved.
69
Documentation macros contained within a step are also integrated into the form structure. But these do not affect
the sequence of the simulation and the function of the form structure as they are only used for creating
documentation.
4.8.2
Bubbles in the Form Structure
The bubble texts are presented in summary form in the Form Structure for the Practice mode. This provides you
with an overview that illustrates how to fill out a form and the linkages between the inputs.
In Demo mode and Concurrent mode, the bubbles are displayed side by side as the processes are played back as a
simulation meaning that there are no inputs by the user.
The appearance of the bubbles can be edited in the Form End macro. The individual texts accompanying the
actions can be changed within the respective macros, as before.
4.8.3
Remove Form Structure
If a Form Structure is no longer required in a project, it can be removed. Only the start and end macros of the Form
Structure are deleted in the process; the remaining macros in the step are retained.
Note
Do not remove the macros for the Form Structure using the Delete command so as to avoid errors in the
project. Always remove the Form Structure using the corresponding functionality.
This is how to remove the form structure:
1.
Select the Form Begin or Form End macro.
2.
Then click on the Remove Form Structure button.
4.9
Branches
Using branches will allow the user to digress from the sequential path within a simulation. This gives the user
much more flexibility and portrays a more realistic process workflow. Two or more branches can be added to a
simulation so that the user has a choice of where to go to next.
A branch consists of several macros:

A branch is positioned under the macro Screen.

It needs a start and an end macro.

Between the start and end macro, there are two macros that contain actions leading to different workflows.
70
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Simulations - Editing
Note
If you would like to create branches in a project then make sure that projects containing branches cannot
be rerecorded. The reason for this is that with ReRecording a project will run through in a linear manner.
But branches can operate in a number of different ways that the Producer cannot automatically follow.
Should you be contemplating ReRecording a project we recommend that it be duplicated, thus backing it
up for ReRecording. The branch can then be created in the original project.
4.9.1
Create a branch
Once a project has been recorded, you can create a branch for it. To do so, proceed as follows:
1.
Screen macros are combined into one step in which their corresponding actions should serve as buttons for
the branches. This is important so that the buttons can be displayed properly on the page.
1.
Select the Screen macros for the step for which the macros should be used for the branch. When doing so,
make sure that these actions are located on the same application page.
2.
Then select Tools -> Bulk Changes -> Merge selected Screens.
The first macro Screen will remain and all the other highlighted macros will be deleted. The macros for the
existing step will then be merged into the step accordingly.
2.
Select the macro Screen for the merged step.
3.
From the macro editor, click on the button Create branch
4.
A dialog box will appear in which you can defined specific steps for individual macros. The order of the
selection list corresponds with the order of the macros in the project.
Confirm by clicking on Ok.
(or Insert -> Insert Special Macro menu).
From the thumbnail view in the Producer, you can see that all the macros for the step are integrated into the
macros for the branch.
All macros that have been assigned a branch target will have an arrow. When the mouse moves over the arrow,
SAP Workforce Performance Builder 9.3
Simulations - Editing
Customer
© 2014 SAP AG. All rights reserved.
71
the corresponding step will be highlighted in orange in the thumbnail view and the name of the step will be
displayed in a tool tip.
4.9.2
Edit a branch
Editing a branch target
If you would like to change the target of your branch at a later time, you can open the editing dialog box by clicking
on the button Edit branch in the macro editor. Change the target for the respective actions and confirm the
changes by clicking on OK.
Bubbles in a branch
At the end of a mode, a summary of all the bubble text is displayed in one bubble within a branch. This serves as
an overview of all the possible target steps. The individual text blocks are separated with an `or` to make it easier
to differentiate between the different targets.
The bubble's appearance can be edited in the macro Branch End. To do so, from the macro editor, set the Layout
selection to Advanced layout. The individual text blocks for the actions can be changed in the respective macro.
4.9.3
Remove a branch
If a branch is no longer needed in a project, it can be removed. Only the starting and ending macros of the branch
are deleted; the other macros will remain in the step.
Note
Do not remove the macros for the branch by using the Delete command - this could cause errors in the
project itself. Always remove a branch in accordance with its functionality.
To remove a branch, proceed as follows:
1.
2.
Select either the macro Branch Begin or Branch End.
Then click on the button Remove Branch.
4.9.4
Branches in documentation
Branches found in a project will also be displayed as such in the documentation. A subheading will be inserted to
indicate that there is a branch. Underneath the subheadings, there are additional actions which have been
allocated links for the respective steps.
Branches appear in Word, PDF and HTML generated formats. Branches are displayed in the following types of
documentation: standard documentation and work documents.
72
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Simulations - Editing
4.10 Mode Change
The change of mode makes it possible, at a specific step, to switch to another mode while a mode is being played
back. If the step in question was completed it switches back to the original mode. For example, while a Demo
mode is in progress, a step can be displayed as a Test mode, allowing users as well to take an active part while
viewing the simulation.
Creating a change of mode

The Mode Change Start and

Mode Change End
macros are available for the change of mode. These are incorporated into the project using the Insert -> Insert
Special Macro menu. The Mode Change Start macro is located in front of the Page macro and the Mode Change
End macro is situated below the final macro of the step.
It can then be specified in the Mode Change Start macro from which mode and into which mode the switch is to
take place when playing back the simulation.
4.11
Page macros
Page macros can be inserted into simulations, which will allow you to create simulations with greater flexibility.
These can be positioned directly on screenshots, images, PowerPoint slides and book pages and can be activated
for being displayed in a specific mode. In this way, simulations can be easily enriched with additional information,
reference material and visual aids.
Inserting page macros
Page macros can be inserted from the toolbar or from the menu: Insert -> Insert Page Macro.
The following macros are available:
Icon
Name
Arrow
Shape
Highlighthttps://wpb-mgr/wpbdocumentation/wa/maindocu/index.html?show=cdoc
!CD_1646F41FC4C962A5:
SAP Workforce Performance Builder 9.3
Simulations - Editing
Customer
© 2014 SAP AG. All rights reserved.
73
Icon
Name
Text Pop Up
Image
Icon Link
Text Link
Book Page
For a detailed description of each of the macros, refer to the sections linked in this document.
Note
Note that page macros cannot be used for documentation and can only be used for playing simulations.
The only macro that can be used in combination with documentation is Book Page Link, which appears as
a graphic image.
4.12 Anonymize Screen Area
If a simulation screenshot contains information which should not be displayed to the users (e.g. passwords, file
paths, datas) you are able to anonymize the areas with a color field. This can be done for a single screenshot or for
a number of screenshots in a project.
Note
The covering with a color will be done on the screenshot file and cannot be changed, after saving and
closing the project.
To anonymize screenshot areas of a simulation, proceed as follows:
1.
Select a Screen macro.
or
Select all Screen macros, which should be changed with the same area.
2.
Click on the menu entry Tools -> Bulk Changes -> Anonymize Screen Area...
A dialog opens, displaying the screenshot or the first screenshot of the selection.
3.
Position the selection border on the control or area, which should be anonymized.
74
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Simulations - Editing
4.
Click on Confirm Selection (green Icon).
Click on Selection Invalid (red Icon), if the changes should be discarded.
The dialog closes and the areas of the screenshots are covered with a color. If an area contains different colors,
the most frequent color is used.
4.13 Link actions for trainer and book reader
To control the trainer or book reader instead of the control bar via objects or bubbles, actions can be defined as
link targets. These are universally valid and make it possible, for example, to jump between book pages and
chapters independently of their name. They are selected in the link dialog.
If you want to use these types of navigations for book pages, we recommend inserting the objects in a template
for book pages. These are available by default for an entire book.
Defining a link action
1.
You can define the link target in accordance with your objects as follows:
o
Via the HTML Editor
Mark the text to be linked and open the Link dialog by clicking Insert object -> Insert link...
o
For book page objects
Select Edit link... in the Link to setting to open the Link dialog.
For some objects, this setting is found in the Link area.
2.
Click the Actions button in the Link dialog.
3.
You can then define the link action using the drop-down list.
4.
Click Ok to confirm the dialog.
Overview of actions

Exit

Show help

Play simulation

Pause simulation

Next step

Previous step

Next book page

Previous book page

Next chapter

Previous chapter

First book page

Last book page

Show index

Show search

Activate audio

Deactivate audio

Play/stop audio
SAP Workforce Performance Builder 9.3
Simulations - Editing
Customer
© 2014 SAP AG. All rights reserved.
75

Stop complete audio – (if several audio objects are contained)

Mute complete audio – (if several audio objects are contained)

Unmute complete audio – (if several audio objects are contained)

Mute

Unmute
The other actions offered correspond to those mentioned but have an outdated form and are thus offered to be
downward compatible.
4.14 Creating iPad Simulations
With the Producer it is possible to create simple simulations of iPad apps. For that create screenshots on your
iPad, import them into the Producer and edit the simulation project.
To create an iPad simulation, proceed as follows:
1.
Open your iPad app.
2.
Press the On/Off button and the Home button of your iPad at once to create a screenshot.
Repeat this for each process step.
3.
The screenshots are saved in the Photos folder of the device.
4.
Save the images on your PC to import them into the Producer.
Do not import the images from the iPad directly.
5.
Open the Producer.
6.
Create a project using the New Project toolbar button.
The empty project opens in the project editor.
7.
Select Tools -> Import -> Import Images...
The import dialog box will appear.
8.
Select the images. Then click on Open.
9.
You can now edit your image if desired. See also the chapter Import images.
The important options of this dialog are:
o Import as Screen:
Activate this option, to insert the images as Screen macros.
o Insert Mouse Action Macro:
With this option, a Mouse Action macro will be inserted in the step additionally.
10. Confirm the changes by clicking on OK.
Afterwards the images will be imported.
The images will be inserted in the order as sorted in the folder. Each image will be inserted as Screen macro in a
step with a Mouse Action macro.
Afterwards position the highlight about the control on the screenshot and insert a text into the bubble.
Inserting additional macros
Further macros can be inserted about the Insert Interaction toolbar. The macros also contain text modules of the
Recording Dictionary.
76
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Simulations - Editing
4.14.1
Creating Field Icon and Field Name
The field name and field icon of an app control can be created manually and inserted into a bubble text. This allows
you to add this information to a text.
For the field name insert a text into the Field Name parameter.
To create a field icon from the screenshot, proceed as follows:
1.
Position the highlight of a Mouse Action macro about the control on the screenshot.
2.
Click the Update Field Icon button in the macro editor.
A dialog for the editing of the field icon opens.
3.
Adapt the field icon position, if needed.
4.
Click on Confirm Selection, to create the field icon.
The dialog closes and the field icon is inserted into the Field Icon parameter.
Now you can insert the field icon and field name into a bubble as placeholder:
1.
Click in a text field of a bubble.
The HTML editor opens.
2.
Click on Insert Object.
3.
In the menu click on the entry Insert Placeholder...
A dialog with placeholders opens.
4.
Select one of the placeholders:
5.
o
Macro: Field Icon
o
Macro: Field Name
Click on Insert.
4.15 Paramaters of the Macro Editor
The display in the macro editor of the project editor for simulations is divided into different sections. The
parameters are grouped into subcategories, depending on the complexity and number of parameters in the
macros.
Clicking on a parameter's names displayes an explanation about the parameter in the yellow field at the foot of the
macro editor.
A subcategory can be opened or closed using minimizing and expanding icons at the beginning of the title line. The
corresponding setting applies to the display of all macros in a project.
As a rule, the logical parameter allocation found in a specific subcategory is identical throughout all macros. The
number of parameters displayed depends however on the macros, since only those parameters relative to the
macro are displayed. This relates also to the subcategory itself. Should there be no parameters in a specific
subcategory, then these will not be displayed.
In macros that contain bubbles, HTML Editors for bubbles content are displayed in the main area beside the other
main parameters to enable immediate check and revision.
While editing a project the macro editor offers a button for showing and hiding additional parameters for a macro
in the editor. The advanced parameters are mainly interesting for advanced users who need more detailed
possibilities to edit the recorded content of a project.
SAP Workforce Performance Builder 9.3
Simulations - Editing
Customer
© 2014 SAP AG. All rights reserved.
77
4.15.1
Subcategory Bubble
All parameters are listed in the Demo Bubble and Practice Bubble subcategory, which are used for the display of
bubbles created by macros that are not displayed in the upper main area level.
The settings provide the possibility to define different appearances for the bubble in the different modes.

Style:
Here you can choose which bubble style you would like to use. To edit your bubble, go to the menu Tools and
open the editing dialog box for your bubble style.

Alignment:
Here you can specify in which direction the tip of your bubble should be pointing. If you choose the option
Center – the bubble will have no point and it will be positions in the middle of the chosen area.

Translate Manually:
The option Translate Manually option ensures that customized bubble content is not replaced by text
automatically generated by Automated Translation or a ReRecording. The options are activated as soon as
the contents of a bubble is edited manually or is altered by the function Search & Replace Bubble Content. In
this case the contents can be exported in a word file by Export Translatable in order to be translated manually
by a translator.
In addition, bubble dimensions in pixels as well as bubble duration (in seconds) can be defined here.
4.15.2 Subcategory Documentation
The macro parameters required for documentation creation are found in the subcategory Documentation.

Show In Documentation:
You may define over the Show In Documentation option whether this macro is to be taken into consideration
during the creation of documentation. Disabling this parameter makes it possible to hide certain, specific
actions described by macros in the documentation.
There are even more parameters available for the Page macro:

Screenshot Position:
Screenshot Position shows which area of the screen was used for the screenshot. As a rule, you should not
need manually to edit this value.

Show in Process:
The Show in Process setting can be used to activate or deactivate a step for output to the process sequence
of documentation.

Heading in Documentation:
As Heading in Documentation allows the use of the Name of Step to be used as the heading in the
documentation.
78
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Simulations - Editing

Screenshot Border:
Screenshot Border puts a border at your defined pixel width around the screenshot. The standard color is
white. You may however choose a different general color in the Documentation Settings.
4.15.3 Subcategory Rerecord
The subcategory Rerecord contains parameters that Producer requires for an automated ReRecording.
The option Interactive means that when a recording is being repeated, the Producer will stop at this macro and
manual recording of the macro will resume. Automatic ReRecording will continue thereafter. This option is
particularly important at those points in the project where it is known that the desired object for the action to be
recorded is to be found in another position or a different object for the recording must be selected.
The parameters Object Type and Click Position should as a rule not be manually changed.
4.15.4 Subcategory Advanced
The subcategory Advanced contains the parameter Jump Target. This displays the selected jump target after the
creation of a branch.
4.15.5 Subcategory Control
The parameters governing how a control is displayed and executed in the project can be defined in the Control
subcategory.
The Position and size parameter defines how a control is orientated in the screen view in relation to the upper lefthand corner as well as the width and height of the control. The Edit button can be used to open an editing dialog
box in which the parameter values can be edited.
Various individual parameters are available for the different interactions.



The color and text design of the Text input macro can be defined. It can also be defined whether the text
entry is to be portrayed as a password.
For the Mouse Action macro it is possible to define both the cursor type and the state of the button when it
is clicked.
For the Checkbox macro it is possible to define both the cursor type and the type of checkbox, whether the
latter is to be used as a radio button.
Refer to the yellow help boxes in the Producer macro editor for additional information about the individual
parameters.
4.16 Macros of the Simulations
Fundamentally, there are the following types of macros for simulations:
SAP Workforce Performance Builder 9.3
Simulations - Editing
Customer
© 2014 SAP AG. All rights reserved.
79

Special Macros

Simulation Macros

Page Macros

Quiz Items

Documentation Macros
The macros can be inserted by using the toolbar of the project editor.
4.16.1
Special Macros
The special macros are:
Icon
Name
Simulation Start
Simulation End
Intro Page
Intro Page Start Item
Imported Page
Create Form Structure
Create Branch
Jump to Step
80
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Simulations - Editing
Icon
Name
Mode Change Start
Mode Change End
Text-to-Speech Override
4.16.1.1
Simulation Start
This macro is required for the initialization of the simulation in the trainer. It should always be at the beginning of a
project. When using the recording, this macro is embedded into a dedicated step, which has been set to hide and
also cannot be selected as a Jump Target in the trainer progress display.
The points
In the event that the user is to be rewarded with points, the parameters Maximum Score and Required Score may
be entered. The values are calculated from the number of single actions (always 3 points) and the percentages
that have been entered in the Project Explorer for the project. The command Update is applied for automatic
calculation and actualization.
The task description
A task may be displayed in a separate browser popup window in Practice mode and Test mode. This can be
created in the Task Description subcategory and activated for the mode in question.
The Generate values for task description option is used to insert the values from the Input Text and Select Single
macros into the task. This is of use, for example, so as to have the necessary data available when creating a user
or logging in.
The position of the task description window on the screen is set by the parameter Orientation. In addition a
background color for the window can be selected via Background.
4.16.1.2
Simulation End
The macor is located at the end of a simulation and is used by the trainer to end the simulation correctly.
SAP Workforce Performance Builder 9.3
Simulations - Editing
Customer
© 2014 SAP AG. All rights reserved.
81

Pause (seconds):
The parameter defines the display duration of the last step during the playback of the simulation.
Settings of the End Page
Once a simulation is completed, an end page with a summary appears as well as the button to restart the
simulation.
The end page uses the preset that is defined in the Intro Page macro.
The following parameters can be defined:

Show End Page:
The parameter defines that the end page will be shown during playback.

Title End:
The title will be shown for the relevant mode.
Modes: Demo Mode, Practice Mode, Test Mode

Description End:
The description will be shown for the relevant mode.
Modes: Demo Mode, Practice Mode, Test Mode passed, Test Mode failed
For further information, refer also to the chapter Intro and End Pages.
4.16.1.3
Intro Page
The macro specifies that an intro page is shown in the simulation. It has to be included in the first step after the
Simulation Start and the Intro Page Start Link macro.
The following parameters can be defined:

Title:
The parameter defines the title for the relevant mode.
Modes: Demo Mode, Practice Mode, Test Mode

Description:
The parameter defines the description for the relevant mode.
Modes: Demo Mode, Practice Mode, Test Mode

Preset:
The parameter defines the design of the start and end page. The available presets are part of the
Configuration/Style resources.

Page Size (Advanced Layout):
The parameter defines the page width and height in pixels.
For further information, refer also to the chapter Intro and End Pages.
4.16.1.4
82
Intro Page Start Link
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Simulations - Editing
The macro defines a start link for the intro page. This makes it possible to jump to different steps in a complex
simulation and to guide the learners. The link has to be included in the first step after the Simulation Start macro
and before the Intro Page Start Link macro. To create several links, insert an Intro Page Start Link macro for each
link.
The following parameters can be defined:

Description:
The parameter defines a description for the start link.

Link Text:
The parameter defines a text for the start link.

Target Step:
The parameter defines a target for the start link. A step can be chosen from the drop-down-box.
For further information, refer also to the chapter Intro and End Pages.
4.16.1.5
Jump to Step
This macro makes the trainer jump to a specific step in the simulation. The only parameter that can be selected
from the dropdown list is the desired step under Jump Target.
This macro is meant mainly for the use of alternative paths in a simulation.
4.16.1.6
Mode Change Start
This macro forces a mode change when playing back the simulation in a certain mode. For example, if the macro
defines that Test mode is to be used instead of Demo mode, this means that later on while playing back the
simulation in Demo mode the Test mode will be used instead after the point where the macro Mode Change Start
was inserted, until the macro Mode Change End switches back to the original mode.
Note
A change of mode can only ever be performed within a step. So ensure that the Mode Change Start and
Mode Change End macros are within the same step.
4.16.1.7
Mode Change End
The macro Mode Change End terminates the mode change started by the macro Mode Change Start.
SAP Workforce Performance Builder 9.3
Simulations - Editing
Customer
© 2014 SAP AG. All rights reserved.
83
Note
A change of mode can only ever be performed within a step. So ensure that the Mode Change Start and
Mode Change End macros are within the same step.
4.16.1.8
Text-to-Speech Override
You can use the Text-to-Speech Override macro to replace the prescribed spoken text for a step with a text of
your own.
Insert the Text-to-Speech Override macro in a step once you have converted the associated spoken text. This
preallocates the bubble text as the spoken text. You can now change the text in accordance with your own ideas.
Would you like to restore the original bubble text in the text box, then you can use the control Insert text from
bubble to overwrite the current text with that.
4.16.2 Interactions
Interactions are for the recording, display and control of the simulation contents in a browser window. They
portray all the usual actions that a user can carry out in an application.
Icon
Name
Page
Explanation
Mouse Action
Key Stroke
Input Text
84
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Simulations - Editing
Icon
Name
Select Single
Radio / Checkbox
4.16.2.1
Screen
As a rule, a macro always marks the beginning of each step, since all subsequent actions are based on this macro
until the displayed content changes and therefore a new step and a new Screen macro will be recorded. When
using the recording, this macro is created together with every new step as soon as an action is executed.
Aside from the Step name the macro also contains documentation parameters that influence the layout of the
potential document file.
Recommendation
If you want to edit the screenshot for the Screen macro, it is possible to open it in an external image
editor. To do this, click on Page -> Replace Image -> External Editor...
4.16.2.2
Explanation
The Explanation macro will display a global description on the current page in either Demo, Practice or Concurrent
mode, when so desired, and highlights the area.
The macro Explanation can be inserted during recording or ReRecording via the Recording Bar or from the toolbar
in project editor.
In order to reduce editing time, the option Explanation Practice as Demo makes the macro use the same text
entered for Text (Demo Mode) for the bubble in Practice mode as well without the necessity to enter it again.
The macro Explanation can be inserted during recording or ReRecording via the Recording Bar or from the toolbar
in project editor.
The position of the explanation area and the bubble and the texts to be used in the Demo mode and Practice mode
are defined in the macro editor. These positions are the same in Demo, Practice, Test and Concurrent mode. It is
also possible to define whether the explanation should be displayed in Demo mode or Practice mode. Care should
be taken here to ensure that the Demo mode selection also applies to Concurrent mode and that the Practice
mode selection applies also to Test mode.
Use Document Highlight to improve the marker position in a generated documentation within an editor.
SAP Workforce Performance Builder 9.3
Simulations - Editing
Customer
© 2014 SAP AG. All rights reserved.
85
Use Show Control to show navigation controls within a bubble. When activated, the simulation pauses and
displays the bubbles to enable the user to read them at his or her leisure and only resumes when the Next button
is clicked on.
Icon
In addition a Type (Icon) can be assigned to the bubble, which can be selected from four different types, each
represented by a different icon:
Icon
Type
Remark
Tip
Info
Warning
The icons are also added to the documentation generated for a project. The images to be used are located in the
resource Configurations/Styles. You may replace these with your own images.
4.16.2.3
Mouse Action
This macro simulates a mouse action on a button or link in Demo mode. In Practice mode the user is prompted to
click on the highlighted link or button. A bubble is displayed in both modes containing an explanation.
If the action can also be activated by a keyboard shortcut, then the corresponding key combination may be
entered in Hotkey. In this connection, the key names are separated by spaces, for example: ctrl k. The Action
parameter defines what type of action is to be carried out with the mouse. The option Highlight in Practice
highlights the clicked object in Demo mode.
86
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Simulations - Editing
4.16.2.4
Keystroke
This macro can require the user to press a key or combination of keys to continue the simulation.
This macro simulates a keystroke or keyboard combination in Demo mode. In Practice mode the user is prompted
to click on the highlighted link or button. A bubble is displayed in both modes containing an explanation.
To define a hotkey, proceed as follows:
1.
Select the Hotkey parameter.
2.
Click on the Edit button.
A dialog opens.
3.
Press the key or the keyboard combination, which should be inserted.
The text field is filled automatically.
4.
Confirm the dialog with OK.
The key or keyboard combination is entered in Hotkey.
4.16.2.5
Input Text
This macro simulates text being entered into a specific text field in Demo mode. In Practice mode the user is
prompted to enter a specific text into the field. A bubble is displayed in both modes containing an explanation.
Additional parameters, which also have to be entered into a dialog box when recording the macro manually, are
the Input Text as well as the manner in which the entry is to be confirmed. Three options are available: Confirm
with Tab, Confirm with Enter, and Confirm with Button. More than one option may be selected.
If the option Confirm with Button has been selected, then it also needs to be assigned an object position. It is also
possible to select an entry without confirming it Enter, Tab, Button.
In this case, the three confirmation options must be disabled.
Note
If the Confirmation parameter for inputting a text is altered or an input is read out without being
confirmed, then the instruction in the Practice bubble for confirming the input is to be aligned manually.
The dialog box also asks for the name of the Input Field as it will be used to automatically generate the explanatory
text in the text bubbles.
The option Highlight in Practice highlights the input field in Demo mode, if this is required.
In addition to the Simulation parameters in the macro editor, the parameter Set Focus is offered. This determines
whether the focus is automatically set on the corresponding input field within the simulation page during
playback, or if the user should define this him- or herself, which actually corresponds to the behavior of a live
application.
SAP Workforce Performance Builder 9.3
Simulations - Editing
Customer
© 2014 SAP AG. All rights reserved.
87
The text entered in the Input Text field contains the value given during the automatic recording process. This is
used as a text module for the automatically generated bubble text. Changes to this field are transferred into the
automatically generated bubble text.
This parameter End Value supports the inputting of text in multiline text boxes. Whereas only single line texts can
be entered using the text input parameter, the End Value parameter generates wordwraps, thus displaying the
complete text in the text input box.
If for an application a drop-down box is included, then the Producer saves all of the drop-down box's options in the
parameter All Values. The chosen entry is flagged with an asterisk {*}. While the project is being edited, the value
can be changed by assigning the flag to the corresponding entry.
Regular Expression
A Regular Expression is an exactly defined search pattern for which a match is sought (pattern matching). When
using a regular expression with an input field, the value entered during a simulation does not need to match
exactly the value that was originally recorded. The value needs instead to correspond to a value described by the
regular expression and is thus valid. The regular expression must be JavaScript compliant. Examples:
any input: /.*/
not case-sensitive input: /input/i
valid alternatives: /^kg$|^kilogram$|^kilogramme$/
five-digit number: /^[0-9]{5} $/
four-digit number with 2 decimal places: /^[0-9]{4}[,\.]{1}[0-9]{2} $/
date: /^[0-9]{1,2}(-|/|\.)[0-9]{1,2}(-|/|\.)([0-9]{4} $|[0-9]{2} $)/
currency: /^-?[0-9]+$|^(-?[0-9]+)?[,\.]{1}[-0-9]{1,2} $/
e-mail address: /[email protected]\[?[a-zA-Z0-9-\.]+\.([a-zA-Z]{2,4}|[0-9]{1,3})\]?/
4.16.2.6
Select Single
The macro Select Single simulates the selection of a macro by the user (e.g. a list boxes or a selection list) in
Demo mode. In Practice mode, the user is prompted to make a selection in a specific field. A bubble is displayed in
both modes containing an explanation.
When recording the macro, the choices are offered in a dialog box under Value. In addition, you will be prompted
to enter a Field Name required for the automatic text generation.
In the macro editor, the Value when recording is taken as the Selected Value. Additionally, the index number of the
entry is displayed under Index Selected.
The Selected Value is used as a text module for the automatically generated bubble text. Changes to this field are
transferred into the automatically generated bubble text.
The option Highlight in Practice highlights the object as in Demo mode, when required.
4.16.2.7
88
Radio/Checkbox
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Simulations - Editing
This macro simulates the activation of an option field by the user (radio button or check box) in Demo mode. In
Practice mode the user is prompted to activate a specific option field. A bubble containing an explanation is
displayed in both modes.
The option Highlight in Practice highlights the object as in Demo mode, when required.
4.16.3 Page Macros
The following section describes page macros which can be inserted into simulations.
Icon
Name
Arrow
Shape
Highlight
Text Pop Up
Image
Icon Link
Text Link
Book Page
Also refer to the descriptions of the objects for book pages.
Subcategory Simulation
From the macro editor, the setting Simulation is available for all book page objects. The following settings can be
defined here:
SAP Workforce Performance Builder 9.3
Simulations - Editing
Customer
© 2014 SAP AG. All rights reserved.
89

In Mode:
These settings allow you to specify in which of the four modes the object should be displayed when being
played back in the trainer.
4.16.3.1
Shape
The Shape macro creates objects in a variety of shapes and directions. These shapes are especially useful for
visualizing process workflows and sequences. It is also possible to add text to the shapes.
Editing shapes
You can choose one of the following types under the option Type & Direction:



Arrow
Chevron
Pentagon
You can specify which way the shape should point:




Left
Right
Top
Bottom
Further parameters

Changing the shape’s size:
You can change the size of your shape by pulling on the object’s frame or by manually entering the desired
values for the width and length under the option Position.

Shape color:
Click on the option Select color to specify what color the shape should be.

Thickness:
You can specify how thick or thin the line for the shape should be. Note that this only affects the shape’s body.

Text:
You can add text to your shape, e.g., a description of a process step or a link. You can adjust the size of your
shape to ensure that the text fits entirely within the space provided.
4.16.3.2
Icon Link
The Icon Link allows you to link content found in the work area or to create a link to an external source, such as a
website. An icon will then be inserted, to which a link can then be assigned. The icon is customizable. You can
insert an image as well as a tooltip for the target link.
The design of the icon is based on the Style selected for the simulation that can be defined in the master
configuration dialog in Authoring Settings -> General-> Page style.
90
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Simulations - Editing
Defining an icon
The look of the icon will depend on what book style has been chosen, which can be defined in the Style settings.
For your defined target link, from the option Type, you can choose what kind of icon you would like to use:

Demo Mode

Practice Mode

Test Mode

Concurrent Mode

Quiz

Book page

Book

Document
Alternatively, your own icon can be inserted using the option Image. It is recommended that you use your own
icon when linking to an external source or when the icon should not have the same look as the book style itself.
4.16.3.3
Highlight
This macro makes it possible to locate an additional highlight on a screenshot. The highlight is independent of a
bubble and can be used to support an explanation. As only one highlight can ever be used for a macro, whereas it
may be necessary for a number of highlight frames to describe a situation, this macro can be used in addition to
the already existing highlight frame.
Inserting and positing a highlight
1.
2.
3.
From the Thumbnail View, highlight the macro Page to which you would like to add your highlight.
Then click on Insert -> Insert Page Macro -> Highlight.
The default position for the highlight macro is directly under the macro Page to ensure that it is displayed
throughout the entire duration of the step's recording. If the highlight should be displayed with a particular
macro, you can simply drag the highlight in front of the desired macro.
From the step view, you can now position (drag & drop) the highlight on the screenshot. To adjust the size
of the highlight, click on one of the frame's points and with the mouse held down, drag the frame to the
desired size. Release the mouse button to confirm the changes.
Macro options

Display in Mode:
You can use the various options to define the mode in which the highlight is to be displayed.

Hide Highlight:
Activate this parameter if you want to hide the highlight in the simulation.
This setting has no impact on the highlight being displayed in the documentation if the parameter Show in
Documentation is activated.

Object Name:
You can use this parameter to specify a name for the object. If you have two Highlight macros in a step, you
SAP Workforce Performance Builder 9.3
Simulations - Editing
Customer
© 2014 SAP AG. All rights reserved.
91
will need to change the name. In the event of highlight sharing the same name, only the second one in the
sequence will be displayed.

Show in Documentation:
If you activate this parameter, the highlight you have created will be displayed in the documentation.

Highlight Color:
Defines the color of the highlight border.

Highlight Position (Documentation):
Defines the position (left, top) and the size (width, height) of the highlight on the screenshot in pixel.
4.16.3.4
Text Link
Text Link is a text field to which you can add text and links. The entire surface area is actually a button that can be
easily linked to an external Internet page or an object from the workarea. This allows you to display additional
information if desired.
To create a link, go to the Insert link...
function. A dialog will then open in which you can specify a link or select
an object from the Workarea. A link to a web page or similar is to be entered in the text field under Available. This
should be in the format http://www... Confirm your entry by clicking on OK.
When launched, the linked page is automatically opened in a new browser window. If you would like to open the
page in the same window, you need to deactivate the setting Open in a new window.
If the linked page or object from the Workarea is opened in a new window, you can define properties for displaying
the browser window that has been opened.
4.16.3.5
Book Page
An existing book page can be inserted into a simulation with a link using the Book Page macro. Changes made to
the book page also affect the link in the simulation.
Insert a book page as follows:
1.
Use the toolbar to insert the Book Page macro into the project. You can select this macro from the drop-down
list for the book page objects.
When the macro is inserted, a new step is automatically created.
2.
You can then link the book page you want using the Book Page parameter. Click Edit link... to open the link
dialog where you can select the book page.
3.
You can activate the book page for the mode you want under Simulation.
Keep in mind that the objects available on the book page cannot be edited. It is only possible to add additional
objects within the project editor or to edit the book page directly in the book page editor.
92
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Simulations - Editing
4.16.4 Documentation Macros
Documentation macros enable the compilation of extensive process documentation in addition to the simulation.
These macros are available to document the recorded project accordingly and to supplement the content relevant
to the documentation, as well as to structure the content. As a rule, they are manually added after the recording is
finished.
To do so, all you have to do is highlight the macro in the thumbnail view after which the new macro is to be
inserted. The desired new macro is then inserted by selecting the relevant macro from the menu Documentation > Insert Documentation Macro. The new macro is now positioned in the appropriate place in the thumbnail view.
Icon
Name
Header Information
Transaction Code
Partial Screenshot
Note
Description
Heading
Highlight
Arrow
Page Break
Document Properties
SAP Workforce Performance Builder 9.3
Simulations - Editing
Customer
© 2014 SAP AG. All rights reserved.
93
Icon
Name
Revision Entry
Input Values
Logon Values
HPQC Header
The structural order of the documentation is identical to the recorded project. For this reason, the documentation
macros have to be added into the thumbnail view in exactly the relevant locations within the documentation.
4.16.4.1
Header Information
The macro Header Information allows you to insert a Title as well as a Description in the document. The Title
entered will be allocated the style sheet Title in the MS Word document. The Description can contain a subtitle or
additional text and is formatted with the style sheet Normal in MS Word.
The macro can be used for single documents that are not intended to be used as a master document. In this case,
a heading is generated without numbering (instead of the project title). It is recommended that you hide the
project title in the documentation settings (fragments) since this would appear over the title itself.
4.16.4.2
Transaction Code
The Transaction code refers specifically to recording SAP applications and is created when you select a
transaction in SAP. The Transaction code is automatically parsed for the documentation view. In addition to this,
you can enter the SAP Menu Path for the transaction to be able to find it in the SAP system menu.
When you generate documentation, a table with details of the transaction code, and the menu path if available, is
created.
94
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Simulations - Editing
4.16.4.3
Partial Screenshot
This macro enables the definition of a specific area of the current screenshot displayed in the browser, which will
be subsequently inserted at the specified position. As soon as the macor is activated in the control bar, an editor
window opens in order to define the screenshot area.
The full screen is selected as default. The selection is framed in red, which can be adjusted by moving the anchors.
The screenshot view can be scaled using the loupes. The loupe in the middle resets the selection to full
screenshot. To accept the partial screenshot, you must click on the green tick to confirm. But the editing can also
be cancelled by clicking on the red X.
You may add a description of the screenshot to serve as a caption in the documentation in Title. When no caption
has been entered, a consecutive image numbering system will be used in the documentation. Screenshot Position
enables an additional specified area of the screenshot to be used in addition to the already generated screenshot.
The option Show Actions allows that subsequent actions in the documentation are displayed on the partial
screenshot instead of the last macro Page. Screenshot Border adds a white frame around the screenshot, the
frame is defined in pixels. Both the color and width of the frame can be customized in the main settings.
Via the command Manual Crop the screenshot can be edited. The Screenshot Position therefore does not have to
be entered manually.
4.16.4.4
Note
This macro inserts a highlighted text box at a selected position in the documentation. The text box can be selected
from four different types, each represented by a different icon:
Icon
Type
Remark
Tip
Info
Warning
SAP Workforce Performance Builder 9.3
Simulations - Editing
Customer
© 2014 SAP AG. All rights reserved.
95
The desired text is entered and formatted in the corresponding text field in the HTML Editor.
Images are found in the resource Configuration/Styles of your actual workarea. You may replace these with your
own images.
4.16.4.5
Description
This macro inserts continuous text at the corresponding position of the documentation. It also can edit and
format the text in the HTML Editor. This editor can also be used to insert screenshots or other images.
4.16.4.6
Heading
This macro starts a new section with the Title you entered as the heading. The result is a new chapter on a new
page in the documentation. The chapter uses the heading that was entered Title and formats it in the style
selected under Format Template. The new chapter also influences chapter pagination of the created
documentation.
4.16.4.7
Highlight
The Highlight macro adds a scalable selection border to the preceding screenshot of the Screenmacro in the
documentation. A description text must be entered. The border and the description text are automatically
inserted into the documentation with the next sequential number in the current process step.
When the macro is being inserted, an editor window opens in which the scalable selection border may be precisely
positioned within the screenshot. The selection is framed in red, which can be adjusted over the anchors. The
screenshot view can be scaled using the loupes. The loupe in the middle sets the selection to the full screen. To
apply the frame, you must click on the green tick to confirm. But the editing can also be cancelled by clicking on
the red X.
96
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Simulations - Editing
The description text may now be revised and added to in the macro editor. In addition, the numbering of the
border can be manually defined, i.e.: which Orientation should the border have. This is automatically defined while
the macro is being recorded, yet can be changed according to your own wishes.
Positioning and alignment of the selection border can subsequently be revised in the editor at any time using the
Edit command. Therefore the Screenshot Position does not have to be entered manually.
4.16.4.8
Arrow
The Arrow macro adds an arrow to the preceding screenshot of the Screenmacro to call attention to an object on
the page.
When this macro is activated, an editor window opens in which the arrow can be precisely positioned within the
screenshot. The selection is framed in red, which can be adjusted using the anchors.
Position the anchor exactly where you want the arrow to point. The orientation of the arrow can be rotated with
the R key, or you may define its position later. The screenshot view can be scaled using the loupes. The loupe in
the middle resets the selection to the full screenshot. To accept the position of the arrow, you must click on the
green tick to confirm. But the editing can also be cancelled by clicking on the red X.
SAP Workforce Performance Builder 9.3
Simulations - Editing
Customer
© 2014 SAP AG. All rights reserved.
97
The orientation of the arrow can be modified in the macro editor using the Orientation dropdown list. Additionally,
you can use the Edit command to open the editor window where you can modify the position and direction of the
arrow on the screenshot.
Text
An additional explanation about the arrow or object to which the arrow is pointing can be entered in the Text field.
This is inserted below the screenshot when generating documentation. An arrow symbol in front of the text
establishes the connection to the arrow on the screenshot.
4.16.4.9
Page Break
This macro inserts a page break in the created documentation. It does not have other configurable parameters.
4.16.4.10 Document Properties
The Document Properties macro assigns contents to field functions. This requires defining these field functions in
the template.
98
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Simulations - Editing
In the macro you can now assign the designated content to the field function. In order to do so insert the field
function contained in the template under Name. Define the content which is to be displayed in the Value field.
Defining a field function in MS Word
A field function in MS Word is defined as follows:
1.
2.
3.
4.
5.
6.
Open the template the field function is supposed to be inserted into.
Now open the document properties and navigate to the Adjust tab.
Insert the field function into the Name field and the corresponding content into the Value field. The content
can be replaced by the macro.
Confirm the dialogue with OK.
Then insert the field function into the template under Insert -> Quick Parts -> Field...
Select as a field DocProperty and as a Field property your defined field function.
Now save your template.
Note
If you insert the Document Properties macro for a BPP or Audit & Compliance document in your tutorial
the field functions which are contained in the particular templates are read out automatically and
displayed in the macro editor.
Generation settings
The settings in the macro editor determine in which documentation type the documentation macro is displayed.
In order to do so display the Extended settings and activate the particular type.
Note
Note that the variables cannot be executed in HTML documents as these field functions are Word
specific.
Note
The Document properties can only be output for single documents as they relate to the corresponding
document templates. Avoid the use of this macro in a master document for this reason.
4.16.4.11 Revision entry
The Revision entry macro documents modifications in processes. In order to do so a table is created when the
document is generated which displays the following contents:

Revision date:
Indicates the revision date.

Change:
Allows describing the revision.

Changed by:
Indicates by whom the revision was made.
SAP Workforce Performance Builder 9.3
Simulations - Editing
Customer
© 2014 SAP AG. All rights reserved.
99

Revision ID:
Allows defining a reference number for the particular revision.
A revision entry is specified with a macro. If several revision entries are to be created as a revision history,
individual macros are to be grouped below one another for this purpose. They are listed in the table when
exported to a document.
Generation settings
The settings in the macro editor determine the documentation type the documentation macro is displayed in. In
order to do so display the Extended settings and activate the particular type.
Documentation Settings
Settings for the macros can be defined in the Documentation Settings for every document type in the Revision
history area:

Hide in Project Content:
Defines whether the macros within the project document are to be displayed in the position inserted in the
project or displayed as a fragment in any position of the document.

Sorting:
Defines the sort order of the table if several revision entries have been created.
4.16.4.12 Input Values
The Input values macro creates a table including all available entries of the Input Text macros in a project. As a
result they can e.g. be clearly subdivided at the beginning of a document to make them directly available in a work
process.
The following columns can be defined to display them:

Show Field Name

Show Value

Show Bubble Text

Show ROC

Show Description
Activate the particular option in the macro editor to display them.
Generation settings
The settings in the macro editor determine the documentation type the documentation macro is displayed in. In
order to do so display the Advanced settings and activate the particular type.
Input values as fragments
Instead of this macro, you can also insert the input values as documentation fragments. You can make the
respective settings for the documentation type you want in the master configuration dialog.
100
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Simulations - Editing
4.16.4.13 Logon Values
The Logon Values macro allows creating a table including the necessary data requested by a process to log on to
the particular system.
The following definitions can be made:

User ID:
In this column the ID or ID number of the user can be defined.

Role:
In this column the role of the user, e.g. administrator, learner etc. is established.

Application:
In this column the application or system to log on to is defined.

View:
In this column the corresponding application page or view, which has to be selected for the process, can be
defined.
Generation settings
The settings in the macro editor determine the documentation type the documentation macro is displayed in. In
order to do so display the Extended settings and activate the particular type.
4.16.4.14 HPQC Header
The HPQC Header macro is used to define the folder to be created in the HP Quality Center when importing the
data of a HPQC document. Insert the macro at the beginning of an project.
The macro includes the following parameters:

HPQC Directory/Path:
Defines the folder of the HP Quality Center.

Status:
The option allows you to define the current status of a process. You can either selection the processes' status
from a list of predefined possibilities.

Description:
The field allows you to add information or comments on the process. They are inserted into the HPQC
document below the title.
SAP Workforce Performance Builder 9.3
Simulations - Editing
Customer
© 2014 SAP AG. All rights reserved.
101
5
Navigations - Recording and Editing
Navigations are an EPSS solution which is available at the end of the learning process to provide your users direct
support in your enterprise application. If previously learned processes or process steps are no longer sufficiently
front of mind, the user can request support as and when required and have himself prompted within the live
application or obtain explanations on areas of the application user interface that are relevant to the process or
especially prone to error. This optional assistance boosts your users confidence in using the application and
gradually ensures optimal performance in handling the process. It also enables your users to execute seldom used
processes with the greatest possible accuracy, for example when having to stand in for someone without notice.
The navigation runs discreetly in the background in your application and indicates by means of an icon in the
information area whether there is information available on the application page in question. Should he need to, the
user can use this icon to launch the support and return it to the standby state when the need no longer exists.
The degree of support available here is very variable. Navigations can accompany the user in detail through
established processes, explain entire application interfaces specific to a particular process and object and prevent
departures from predefined processes. If there are process-related simulations available, these too are offered to
the user to give him the opportunity to have knowledge of process routines or steps demonstrated to him in the
simulation environment or to work through them without affecting the live application.
Producer and Navigator
What one needs to bear in mind when dealing with navigations is that both the Producer and Navigator are
involved in creating and using navigations:

Producer - used for the creation and editing of navigations

Navigator - used for the playback of navigations
5.1
The Navigator
The Navigator is mandatory for playing back navigations. You install using the installation file you have been
provided with Navigator.msi. Note the following minimum system requirements for installation:
Type
Specifications
Operating system
Windows Vista or Windows 7
64 & 32 bit version
Memory
A minimum of 1 GB
Hard drive
10 MB of free space
Browser
Internet Explorer 7.0 – 10.0
102
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Navigations - Recording and Editing
Scenario
Requirement
SAP Business Suite
SAP GUI Scripting activated
Windows Vista
Windows Automation API
5.1.1
Status icons
The Navigator is a background application the presence of which is not indicated to the user by a graphical user
interface as such. Nevertheless, the application's various activity statuses are displayed to the user by status
icons in the task bar's information area.
The following table gives you an overview of the various icons and what they mean. For greater clarity, the table is
divided into Active and Passive. Active stands for a visible display of help objects, where these are available.
Passive on the other hand, means that the Navigator is in standby-mode, namely has been minimized to the info
area.
Active
The Navigator is active and checks the current
application page for help content to display.
The Navigator is active; there are no help content
available for the current application page.
The Navigator is active; help content are available for
the current application page and are displayed.
Passive
The Navigator is in standby mode and checks the
current application page for help content.
The Navigator is in standby mode; there are no help
content available for the current application page.
The Navigator is in standby mode; help content are
available for the current application page but are not
displayed.
SAP Workforce Performance Builder 9.3
Navigations - Recording and Editing
Customer
© 2014 SAP AG. All rights reserved.
103
5.1.2
Functions of the Navigator
Standby
A click on the status icon or the shortcut CTRL + F11 activates or deactivates the Navigator's standby status. No
support is indicated when in standby status. The check for any available support for application pages goes ahead
regardless and if any is found is indicated by the status icon.
Options
A shortcut menu, which opens by right clicking on the status icon, offers you further options. The following
options are at your disposal:

Show Version...
This menu option allows you to view the version number of the Navigator currently in use. Make a note of this
if you would like to get in contact with support in the event of problems.

JavaScript Console
Use this menu option to launch the JavaScript console. As a rule this should not be necessary but is of benefit
in order to be able to provide detailed error messages to SAP support should any errors occur.

Reset Hidden Info Element / Reset all Hidden Info Elements
Resets the elements that are hidden by the user.

Exit
Use this menu option to exit Navigator.
5.2
Prerequisites for Target Applications
The Producer ensures the creation and the playback of navigations for the following applications:
Applications
Types and Versions
SAP
SAP GUI for Windows from 7.2
SAP GUI for HTML from Kernel version 7.2
NW Enterprise Portal from 7.3
NWBC for Windows 3.5 with embedded SAP GUI
NWBC for Windows 4.0 with embedded SAP GUI
NWBC for Windows 4.0 with embedded WebDynpro
Business One 9.0
WebDynpro
Microsoft Office
MSOffice 2003, 2007, 2010 and 2013
(Word, Excel, Outlook and PowerPoint)
Detailed information is available in the Product Availability Matrix (PAM) of the SAP Workforce Performance
Builder.
104
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Navigations - Recording and Editing
Navigations under SAP
The following recommendations are necessary for the recording and playback of navigations under SAP:

Consider for the recording and the playback the settings for the SAP Client.

When recording SAP applications ensure that you are only opened one SAP session. First close all the
sessions that are not required for the recording.

The playback of the navigation requires the corresponding GUI Theme (e.g. SAP Tradeshow) used for the
recording.
The support of additional applications for navigations has to be verified previous according to the technical
feasibility. Support for additional applications for navigations should be checked in advance for technical
feasibility. Contact your SAP account Manager for the necessary support.
Caution
Navigations do not support multi monitor environments. Therefore ensure when creating the navigations
that the Producer and your target application are situated on the screen registered on the system as the
main monitor.
Note
SAP NetWeaver - Update
When updating SAP NetWeaver (including SAP_Basis), note that the release versions can include
different page key information for specific objects. This can result in a partial mismatch of your navigation
content during playback.
Once the SAP NetWeaver update is finished, play back your navigations and check your content
matching. Update the missing objects or replace the page key attributes with regular expressions, if
required.
5.3
Variants of Creating Navigations
Navigations can be created in two ways:
Creation using existing simulations
The Producer enables you to create navigations from prerecorded simulations.
Using this method can reduce the effort of creating a navigation by about 80%, because application pages and
their corresponding objects do not have to be manually rerecorded.
During a conversion, only Page macros and associated interactions will be converted. Manually inserted
PowerPoint slides, quiz and explanation macros etc. will be disregarded during the conversion process as well as
branches integrated into projects.
Manual creation
Creating navigations manually offers you the opportunity of providing an application with EPSS support
individually and independently of pre-existing simulations. You can identify the objects required for your
processes on each application page and assign them help texts. To simplify the creation of the required objects,
the Producer will use wizards to guide you through the necessary steps.
SAP Workforce Performance Builder 9.3
Navigations - Recording and Editing
Customer
© 2014 SAP AG. All rights reserved.
105
5.4
Creation using Existing Simulations
When simulations are converted to navigations, they are converted to a selected navigation type and the projects
adjusted to correspond to the necessary properties:
Conversion in the context assistant
When converting a simulation into a context assistant, the application, page and object contexts are automatically
created as a function of the information saved during the recording. In the process, the objects are arranged
based on their page affiliation. The objects are merged and arranged based on their page affiliation here.
The advantage of converting simulations into a context assistant is that it is possible to use controls that have
already been recorded and which are familiar to the user from the simulations as object contexts. An additional
benefit is that no objects that are required for a process are lost in a manual recording as they already exist in a
simulation.
Conversion in the process assistant
The process assistant is created on the basis of existing process simulations. The simulations are converted to a
navigation project for this purpose.
The object bubbles are always displayed for a step when the process assistant is running. To convert a simulation,
it is therefore recommended using projects where the Page macros were not merged, i.e. for every action there is
a separate step. The bubbles are thus displayed one after another for every action in the process sequence .
5.4.1
Converting the Simulation
This is how you convert a simulation into a navigation - by default into a context assistant:
1.
Open a project recording in the Project Editor.
2.
Click the Generate Navigation button in the toolbar.
3.
Afterwards, a dialog opens where you can make the following settings:
1.
You can enter a name in the Project title field.
2.
You can also use the checkbox to define whether recorded hotspots are to be converted to active areas. If
the option is deactivated, the objects recorded as hotspots are rendered redundant.
Note
Active Areas depend purely on position and do not use any object information to recognize a control
within the application. That is why it is advisable only to use Active Areas for static objects in an
application. With dynamic objects, the Active Area does not change dynamically either.
3.
4.
The Process oriented option defines that a process assistant is to be generated. This option should thus
be activated.
With deactivated option a context assistant is generated.
Click on Ok to confirm the dialog. The simulation is then converted into the selected navigation.
After the navigation has been created, the project is opened in the project editor. Now, you can edit it further.
106
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Navigations - Recording and Editing
5.5
Context Assistant
The context assistant helps users to work with an application by offering help descriptions of issues and
functionality independently of process. The information can be presented in relation to different contexts, thus
providing specific information the user can access individually.
The context assistant thereby enables the user to orientate himself quickly in complex application interfaces and
use the explanations to refresh and apply what he has learnt.
Furthermore, presenting context-related information makes it possible to highlight frequently occurring
problems, explain changes in the application or emphasize information that is important for the process.
Use cases
A context assistant lends itself for example to the following use cases:

For information about system changes on an object or an application page, for example during maintenance
work.

For fading in additional problem-related explanations for individual objects, for example in order to prevent
incorrect inputs by providing notes and explanations for the objects in question.
5.5.1
Context Types
The context assistant recognizes three context types. These can be used in combination but can also be used
individually in a navigation. This allows all sorts of information to be presented in different circumstances, thus
providing users with the necessary specific information.
A context refers to a specific issue in an application so as to describe it and support the user with the appropriate
context-related information.

Application Context
This context offers general information about the application as well as more in-depth information or links.
The application context underpins the navigation and serves to recognize the displayed application and call
corresponding learning content.
This context can also be used on its own.
The macros for the application context are held in the second step of a project.

Screen Context
Describes an application page in greater detail. This can be for example: describe its use in general terms,
draw attention to problem areas or else highlight changes in the event of a new version.

Object Context
Defines a specific object. This can be a Mouse Action macro for example or a Input Text macro. This enables
the function of the object to be described, points out things worthy of note or else elucidate relationships with
other objects.
SAP Workforce Performance Builder 9.3
Navigations - Recording and Editing
Customer
© 2014 SAP AG. All rights reserved.
107
5.5.2
Manual creation
Creating a context assistant manually enables you to assign context information to an application individually and
independently of pre-existing simulations. You can record the macros required for your processes on each
application page and create the help texts.
In a project the different context types build on one another, i.e. the application is defined first, then the page and
finally the object, thus proceeding from the general to the specific. The recording of the respective contexts
behaves accordingly. An object requires all three macros of context information whereas an application context
can also stand in its own right. The contexts that are to be displayed thereafter can be defined in the Context
Assistant Style macro.
5.5.2.1
Creating a navigation project
First create a navigation project so that you can then record your context information in it. Proceed as follows:
1.
In the Project Explorer view click on New Project
the following settings are to be applied:
to create a new project. This will open a dialog in which
o Enter a Project title.
o In the Project type drop-down list, select the type Navigation.
o Select the project Language. The automatically created explanatory content is generated in the language
corresponding to your selection.
2.
Click on OK to create the project.
The navigation project you have created now opens in the Project Editor and is ready to record context
information. Read the following chapters on this subject.
5.5.2.2
Recording an application context
Recording the application context determines the application as well as the interface to be used for reading out
the object information. This is the basis of a navigation in order to assign the help content that exists for an
application. This also provides general information about an application.
The application context for an application can only ever be set up once in a project as it must only be defined once.
But a number of corresponding application contexts can be created for multiple applications that are recorded for
a navigation.
Record an application context as follows:
1.
Select the Record application context
function in the toolbar.
2.
A settings dialog box for the selection of the application appears.
In the dialog box you can define the following:
o Running Applications:
Here you can select the target application for the recording.
o Profiles:
Shows the application profile for the target application.
108
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Navigations - Recording and Editing
o
Associate with selected application:
Defines, that the profile will always be used for the target application.
Click on the Choose button.
3.
A dialog now appears that displays the EXE name for the program.
You can define a name for the display in the navigation in the Display Name parameter.
4.
Confirm the dialog by clicking OK if you want to finish the recording or click Next to record another application
context.
The application context recording is now available in the second step in the project editor.
Recommendation
If you want to create an explanation for a specific context, use the Insert Explanation function. For more
information, see the section on Inserting an explanation.
5.5.2.3
Recording a screen context
A screen context can be recorded several times in a navigation and spread over several steps. This may be of
assistance, for example, if numerous objects on a screen are to be recorded and sorted as a result. If you record a
screen context you will also automatically record an associated application context, if one does not already exist.
Record a page context as follows:
1.
Select the Record screen context
function in the toolbar.
2.
A settings dialog box for the selection of the application appears.
In the dialog box you can define the following:
o
Running Applications:
Here you can select the target application for the recording.
o
Profiles:
Shows the application profile for the target application.
o
Associate with selected application:
Defines, that the profile will always be used for the target application.
Click on the Choose button.
3.
After you have selected the application, a dialog appears where you can change the Screen title for the page
context.
4.
Confirm the dialog by clicking on OK to complete the recording.
The screen context recording is now available in a new step in the project editor.
5.5.2.4
Recording an object context
If you record an object context you will also automatically record an associated application and page context, if
they do not already exist. Record an object context as follows:
1.
Select the Record object context
2.
A settings dialog box for the selection of the application appears.
In the dialog box you can define the following:
SAP Workforce Performance Builder 9.3
Navigations - Recording and Editing
function in the toolbar.
Customer
© 2014 SAP AG. All rights reserved.
109
o Running Applications:
Here you can select the target application for the recording.
o Profiles:
Shows the application profile for the target application.
o Associate with selected application:
Defines, that the profile will always be used for the target application.Click on the Choose button.
3.
The next step is that a dialog will appear requesting you to select a page context. You have the following
option:
o The New Screen Context option creates a new page context in a new step.
o You can select a prerecorded application page page context to which the object context to be recorded is
to be added.
4.
Confirm your selection by clicking on OK.
5.
Now click on the desired object. You will be prompted by a note on the cursor.
6.
After you have selected the object a dialog will appear in which you can define the Text as well as other object
context attributes.
You will find further explanations about the settings in the settings section in the Record object context dialog.
Depending on the object selected the following specific settings will be displayed:
o If you select a Text box then you must input the text content using the Input text parameter.
o If you click on Select Single you will then make the appropriate selection using the Selected value
parameter.
7.
Confirm the dialog by clicking on OK if you would like to complete the recording or click on Next to record
another object.
The object context recording is now available from the associated page context in the project editor.
5.5.2.5
Recording settings in the object context dialog
The following settings are available to you in the Record object context dialog that you can use to define an object
context during recording for displaying in the context assistant:
General options


110
Text
The information about the object context is entered in the text box. This can be texts, links, images or
similar content. You can design the text accordingly using the toolbar in the HTML Editor.
Show Highlight directly
This option determines whether the object is to be highlighted the moment the application page is called.
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Navigations - Recording and Editing

Leaves Screen
This option tells the Navigator that executing the object changes the application page or calls a new
application. This initiates a new page analysis as soon as the action has been carried out on the object and
the new page has finished loading so that the associated page or application context can be displayed.
Note
The object name cannot be amended using this dialog as the name is irrevocably associated with the
object and clearly defines it. If however, notwithstanding that, you would still like to change the object
name you can do so when selecting the object in the macro editor.
Object-specific options


If you select a Text box then you can input the text content using the Input text parameter.
If you click on Single selection you can then select the corresponding option using the Selected value
parameter.
5.6
Process Assistant
The process assistant offers user support in carrying out predefined processes in an application. Users are guided
through the process step-by-step with instructions, making it possible for them to carry out the displayed actions
properly right in the live application. The instructions are collocated with the objects to be used.
Sample applications
A process assistant is suited, for example, to be used as follows:

To train new employees (beginners) to learn the required processes on existing systems.

To introduce a new system for users or to learn new business processes.

To learn about or reference business processes that have been in use for a long time or are rarely used.

The changes in the process when the system is changed.
Structure of the process assistant
The structure of the process assistant is different from the structure of the context assistant in just a few areas.

The subcategory Process End, which is found in the macro Process Assistant Style, specifies the information
that should be displayed at the end of the process.

Every step contains a macro Process Step that defines each individual step.

Every action macro contains a subcategory Next Process Step that specifies the course of the process.
5.6.1
Manual creation
You can record your process or expand or update an existing process independent of existing simulations by
manually creating a process assistant.
Recording is similar to the recording of simulations. You follow the process step-by-step and thus record the
entire sequence.
SAP Workforce Performance Builder 9.3
Navigations - Recording and Editing
Customer
© 2014 SAP AG. All rights reserved.
111
5.6.1.1
Recording a process step
To record a process step, proceed as follows:
1.
Open the process assistant project you want to add additional steps to and select the desired position in the
project
or
create a new project.
2.
Select the Record Process Step function on the toolbar.
3.
You will be requested to Choose application. Click on the application window to be recorded.
4.
From the following dialog box, select the corresponding application profile for the application. Confirm by
clicking on OK.
5.
A dialog box will appear in which you can specify what you would like to record. From the selection menu,
choose:
o Object Context
o ExplanationConfirm by clicking on OK.
o Recording explanations
Click on the area where you would like to position your explanation. The mouse pointer will indicate the
position.
Then enter the text for your explanation. Confirm by clicking on Ok.
o Recording object context
Now click on the desired object. You will be prompted by a note on the cursor.
6.
After an object is selected, a dialog appears where you can define the text for the process step and the
process sequence.
Here you can edit the context information for an object context.
For more information, see also the following section.
7.
Confirm the dialog by clicking OK if you want to finish the recording or click Next to record another object. The
option Explanation allows you to record an additional explanation.
The recorded process step is now available in a new step in the project editor.
5.6.1.2
Recording settings in the process step dialog
The following settings, which you can use to define a process step during recording, are available in the Record
Process Step dialog:




112
Text:
The information about the object context is entered in the text box. This can be texts, links, images or
similar content. You can design the text accordingly using the toolbar in the HTML Editor.
Previous Process Step:
The step found in the position in the project is automatically used as the previous process step. You can
define a different step using the drop-down list.
Next Process Step:
The next process step is the next step in recording or can be determined manually if the process is to have
an individual sequence.
Optional:
The option defines whether the process step is optional for the user in a process.
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Navigations - Recording and Editing
During playback a different icon will be shown in the step list. If the control is not visible on the page or if
the page is wrong the step will be skipped.
5.6.2
Subcategory: Next Process Step
Next Process Step is located in an interaction macro and defines the process flow based on the process steps. The
subcategory contains the following settings:

Action:
Specifies the action that triggers a jump to the next process step.

Next Process Step:
Specifies the process step that the process jumps to.

Alternative Step 1-3:
Defines alternative process steps for the process sequence.
If the process cannot jump to a defined process step because the application page is not available, then the
process jumps to the specified alternative steps - one after the other. If no application page is found, the
process assistant terminates.

Step on Same Page:
This option specifies that the next process step is on the same page as the current one. This prevents the
identification of the application page and allows faster recognition.
This option should only be deactivated if the specified alternative steps do not reference other application
pages.
5.6.3
Further Properties of the Macros
The interaction macros contain further properties which are used for the playback of a process assistant:

Optional:
The option defines whether the process step is optional for the user in a process.
During playback a different icon will be shown in the step list. If the control is not visible on the page or if the
page is wrong the step will be skipped.

Show Confirmation Button:
The option defines whether a confirmation button is shown in the object bubble during playback. The button
allows the user to confirm an executed action and afterwards the next step is shown.

Show Execute Button:
The option defines whether an execute button is shown in the object bubble during playback. The button
allows the user to execute an action in the application and afterwards the next step is shown.
The option can be used for Mouse Action macros.
SAP Workforce Performance Builder 9.3
Navigations - Recording and Editing
Customer
© 2014 SAP AG. All rights reserved.
113
5.6.4
Process Branches
Branches allow the user to digress from the sequential path within a process. This gives the user much more
flexibility and portrays a more realistic process workflow, which means that the user has a choice of where to go to
next.
During playback, the branch actions of the step are displayed as sub steps with radio buttons in the step list. Once
you have selected an action, the sub-steps of the branch process are displayed.
A branch is located in a step of a process and is structured as follows:

Process Step macro

Screen macro

Object macro 1 with individual Next Process Step

Object macro 2 with individual Next Process Step

Object macro 3... or further objects
Note
Branches are only recommended for use in a process assistant because they support a process. They do
not explain a single object, unlike in the context assistant.
5.6.4.1
Creating a Branch
Combine the macros of the branch in one step. This is necessary because the branch cannot be created in a way
that spans multiple steps.
To create a branch, proceed as follows:
1.
Move all required action macros into one step with the same screen.
2.
Delete the unused steps, process steps and screens.
3.
For every branch action, set the Next Process Step with the required next step of the process branch. As a
result, the steps are displayed in the process assistant window after you select a branch action.
4.
Correct the numbering in the last steps of the process to match the new order.
5.6.5
Form in a Process
The form allows the user to fill in an on-screen form in an individually chosen sequence and then confirm all data
entries. During playback, the form step is displayed as a standard step in the step list. Once the step is selected, a
bubble is displayed that includes all the form actions.
A form is located in a process step and is structured as follows:

Process Step macro

Screen macro

Action macro 1 with individual Next Process Step

Action macro 2 with individual Next Process Step
114
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Navigations - Recording and Editing

Action macro 3... or further objects
Note
Forms are only recommended for use in a process assistant because they support a process. They do not
explain a single object, unlike in the context assistant.
5.6.5.1
Creating a Form
To create a form, proceed as follows:
1.
Combine the macros of the form in one step. This is necessary because the form cannot be created in a way
that spans multiple steps.
o
Move all interaction macros into the step with the first action of the form. Arrange the actions in the
required order in the relevant process structure.
o
Delete the unused steps, process steps and screens.
o
For the last action of the form, set the Next Process Step setting in the process. As a result, the steps of
the project are displayed in the process assistant window.
For the other actions of the form, deactivate the setting Next Process Step (green Button).
2.
For the form screen, select the setting Activate Form in the subcategory Advanced (Advanced Layout) .
3.
Correct the numbering in the last steps of the process to match the new order.
Form structure settings
There are general settings available for defining the display of the form bubble. The following settings are available
in the central configuration dialog box (menu Tools -> Settings... ) under Navigation Playback Settings -> General > Advanced:

Form Bubble Alignment

Form Bubble Position

Form Bubble Width

Form Bubble Height
5.7
Desktop Assistant
The desktop assistant is a specific navigation mode that allows context-based content delivery. The navigation
combines different content types and can be understood as a content library for a group or a complete workarea.
The required contexts of the application pages are saved automatically when a project is recorded and the
desktop assistant uses them to assign content during playback.
The desktop assistant can include the following content types:

Simulation modes
demo, test, practice and concurrent mode

Documentation
all types and formats (DOC, PDF, HTML, PPT)
SAP Workforce Performance Builder 9.3
Navigations - Recording and Editing
Customer
© 2014 SAP AG. All rights reserved.
115

Navigation modes
process assistant, context assistant
5.7.1
Desktop assistant components
The desktop assistant has three main components that are used during the playback:

Main window
The main window shows the available contents for a specific page context.
During the playback of a process assistant, the window shows the process step list.
Header / Status Icon:
The status icon in the header of the main window indicates if content is available for the current context. The
header also shows the style logo.
Show Instant Help:
This option allows the user to activate the available contents of the context assistant for the current context.
The setting is enabled by default.

Content window
The content window shows the available modes and documentation for the selected content as well as the
short description. The content window can be docked onto the main window, which allows you to move both
windows together on the screen.

Status icon
The status icon is displayed if the main window is closed. A symbol indicates if content is available for the
current context.
If there is no content for a context available, the list is empty and a hint is shown. If the user changes from a page
with an available context to a page without an available context, the desktop assistant shows the content of the
page with the last available context.
5.7.1.1
Main Window Tabs
The main window of the desktop assistant includes the following tabs:

Content:
The Content tab displays the available content for the current context.

Search:
The Search tab allows the users to search specific content for a description and short description.

Info:
The Info tab allows you to provide general information about the desktop assistant for the user. The
information is always available and is not context-specific.
The tab uses the text in the Short description parameter of the desktop assistant’s root group.
Activate Info and Search tabs
The Content tab is the standard tab of the desktop assistant. The other tabs can be displayed or hidden by using
the following settings in the central configuration dialog box (menu Tools -> Settings...) under Navigation Playback
Settings -> Navigator:

116
Enable Search Tab
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Navigations - Recording and Editing

Enable Info Tab
5.7.2
Desktop assistant resources
For the desktop assistant, there are the resources Desktop Assistant Settings and Desktop Assistant Style. The
resources are located in the Adaptable Resources section of the workarea.
Desktop Assistant Settings
The Desktop Assistant Settings resource includes the settings to define the desktop assistant’s style and the
behavior of the components. The settings can be used in the central configuration dialog as part of the Navigation
Playback Settings.
For further information, see the chapter 'Desktop assistant settings'.
Desktop Assistant Style
The Navigation Style resource includes the style for the desktop assistant’s components main window, content
window and status icon. The resource includes the default style of the desktop assistant.
An own style can be created by using the style editor. The style editor dialog can be opened about the menu Tools
-> Edit Style Resources... Create a new style and use the Navigator Style as template.
For further information, see the chapter Navigator Style.
5.7.3
Creating a desktop assistant
To create a desktop assistant, you first need to perform various preparation steps before configuring and
generating the mode.
Preparation
The following preparation is recommended:
1.
Create a group in the content tree of the project explorer. It is also possible to use the root group of the
complete tree with different sub groups.
2.
Include the required content in the group. The order of the content is not relevant for the display in the
desktop assistant, as the content is displayed according to context. Additional groups allow you to structure
the content in the tree.
If you do not want to show a specific content object, hide the object in the tree.
3.
Set the relevant settings for navigation appearance in the desktop assistant settings page on the central
configuration screen. See also the chapter Desktop assistant settings.
Generation of the desktop assistant
To generate a desktop assistant, proceed as follows:
1.
Select the group with the content.
2.
Click on the Generate Desktop Assistant button in the macro editor.
The desktop assistant configuration dialog opens. The dialog shows the available content types of the group.
Select the desired contents.
SAP Workforce Performance Builder 9.3
Navigations - Recording and Editing
Customer
© 2014 SAP AG. All rights reserved.
117
The context assistant will be shown only during the playback, if the setting Show Instant Help is activated by
the user in the main window. See also the chapter Desktop assistant components.
3.
Confirm the dialog with the Ok button.
A generated desktop assistant group shows a special icon and has the subtype Desktop Assistant.
5.7.3.1
Recording a context for additional content
Additionally to projects you are able to add further objects into a desktop assistant. For objects in navigations it is
necessary, that the objects have context information. The context information of projects are added during
recording, for other objects each context has to be recorded individually. The context can be an application with
the current application page and is stored in the Context parameter.
The recording of a context can be done for the objects:

Groups

Books

Book Pages

Text Units
Recording a context
To record a context, proceed as follows:
1.
Open the application with the needed application page.
2.
Select an object in the content tree of the Producer.
3.
Click on Record Context in the object editor.
4.
The settings dialog box for the selection of the application appears.
In the dialog box you can define the following parameters:
o Running Applications:
Here you can select the target application for the recording.
o Profiles:
Shows the application profile for the target application.
o Associate with selected application:
Defines, that the profile will always be used for the target application.Click on the Choose.
The recorded context information is inserted into the Context parameter of the object.
Note
An object can have only one context information. If you record a new context for an object, the available
context will be replaced.
118
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Navigations - Recording and Editing
5.7.4
Desktop assistant settings
The desktop assistant settings are a resource of the workarea. They include settings for the appearance of the
desktop assistant during playback.
The settings can be changed in the central configuration screen. Open the screen from the Tools -> Settings…
menu.
The following settings are available:

Style:
Defines the appearance of the desktop assistant.

Show Status Icon on Start:
Specifies if the status icon is displayed instead of the main window when the desktop assistant is started.
Main Window
The settings for the appearance of the main window are:

Alignment:
Defines the alignment of the main window on the screen. The option Free allows you to define a position in the
associated parameter.

Position (Free):
Defines the main window's position (left, top) for free alignment on the screen. The values are given in pixels.

Size:
Defines the size (width, height) of the main window in pixels.
Content Window
The settings for the appearance of the content window are:

Alignment:
Defines the alignment of the content window on the screen and if it can be docked on the main window.

Size:
Defines the size (width, height) of the content window in pixels.
5.7.5
Requesting Content
In productive use of the desktop assistant, users require specific content. A function is available that allows users
to send a message to the author, in order to specify their needs.
Content can be requested using a button in the footer of the main window.
Settings
The following settings are available in the central configuration dialog box under Navigator -> Playback Settings ->
Navigator:

Enable Request Content:
Activate this option to display the Request Content button in the desktop assistant.

Author E-Mail:
Insert a recipient e-mail address.
SAP Workforce Performance Builder 9.3
Navigations - Recording and Editing
Customer
© 2014 SAP AG. All rights reserved.
119
Texts
The e-mail contains a standard text, which is located in the Playback Dictionary of the Navigator. You can change
the text as required by using the dictionary editor.
The texts have the IDs MAIL_SUBJECT, MAIL_HEADER, MAIL_FOOTER, MAIL_DATA and MAIL_TOOLTIP.
5.8
Object Bubble
The object bubble displays specific information about an object in a dedicated bubble. This bubble is used for both
the context assistant and the process assistant.
Depending on the setting the bubbles are displayed in miniature with a question mark and open as soon as they
are clicked. In this way the bubbles do not obscure the application interface. Furthermore, the button in the
header area can be used to minimize the bubbles again after they have been called.
But the object bubble is also used as a bubble for an inserted Explanation macro. This bubble is displayed on the
application depending on its position and settings and offers alternative page or object related information.
When used inside the process assistant, the object bubble also contains an OK button to confirm actions and go to
the next process step.
Design and position
The object bubble design is predefined in the central settings. This is where changes to the way information is
displayed can be made. The bubble position is dictated by the position of the object and the orientation setting.
These can be changed in the respective object's macro editor in the Advanced subcategory.
5.8.1
Variants of the object bubble
Two different display variants can be distinguished for the object bubble. These can be defined in the Style macro
that is set up when creating a navigation in the first step of the project or individual for a macro in the setting
Display Variant of the macro editor.
Help besides Object
A small note is assigned on the application page to all objects provided with an explanation. This will open when
clicking with the mouse on a bubble containing the object specific explanation.
120
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Navigations - Recording and Editing
Help as Tooltip
This option displays the object bubble when the mouse cursor rolls over an object and hides the bubble when the
user rolls the cursor away from the object. In this way, the information is only visible to the users when they
actually need it.
With this display variant, no highlights will be displayed for the object.
Global option
For a single macro also the option Global can be selected in the setting Display Variant. This defines, that the
active setting of the project is used.
5.8.2
Central Settings for Object Bubbles
In the central settings, you can configure the appearance and functionality of object bubbles. The settings are
available in the central configuration dialog box (menu Tools -> Settings) under Navigation Playback Settings ->
General -> Object Bubble. These settings are either project-specific or generic, depending on the selection.
5.8.3
Hide an object bubble
For object bubbles, it is possible to display an option for the user to use in order to be able to actively hide bubbles
and their highlights. This allows users to hide any information they do not need, thereby personalizing their
projects to tailor to their specific needs. The author can activate this option so that it appears in the bubbles.
Displaying the Hide Option in a bubble
In order to make this option visible to the user in the object bubble, click on Hide Option. You can define this
individually for a macro or for the entire project:

Define for an Object Bubble:
To define the settings for a specific macro, choose Object Context and then go to the Object Bubble area in
the macro editor. Activate the setting Hide Option.

Define for all Object Bubbles:
To define the setting for all macros, open the global configuration dialog box under Navigation Playback
Settings -> General -> Object Bubble. Activate the setting Show hide option.
Allowing the user to display bubbles
If a user hides one or several object bubbles during a navigation and would like to make the information reappear,
there are two options to do so via the context menu from the taskbar in the Navigator:

Reset hidden bubble – for one specific bubble

Reset all hidden bubbles – for all the Bubbles
SAP Workforce Performance Builder 9.3
Navigations - Recording and Editing
Customer
© 2014 SAP AG. All rights reserved.
121
5.9
Edit Navigations
Various functions for editing how your navigation is displayed, its functionality and design are available to you in
the project editor. These can be called when selecting a macro via the macro editor or the context menu.
5.9.1
Defining the display
After creating the process assistant, you can define how it is displayed during playback. Therefore, the Producer
automatically inserts a Style macro for the respective navigation type in the first step:

Context Assistant Style

Process Assistant Style
5.9.2
Post processing after converting
To customize and design a navigation according to the specific requirements, manual editing is possible after
automatic conversion of a simulation.
Necessary customization
The following post editing will be required as a result of the technical specifics of the recorded application:



If page keys were recorded with a regular expression, these page key attributes have to be customized as
otherwise the Navigator cannot display the associated application pages. The Replace Key Page Attribute
function is available for this purpose. Selecting this option, displays a dialog allowing you to select all the
page key attributes. Now select the attribute with a regular expression and click Next. With the option
Regular Expression enabled, the selected page key attribute will be converted accordingly, so that the
Navigator will be able to interpret it. Click on Replace to customize the regular expression.
For an application with dynamic page keys the page key has to be edited manually, so that the recording’s
page key is not used in the navigation. For this purpose the page key can be rerecorded using the function
Update Screen Context.
Context assistants are strongly dependent on the differentiation of the application pages’ page keys. In
applications such as Word or Outlook 2007, this differentiation may not be sufficiently clear because the
application only has one view and and a process does not therefore take place on several application
pages. To be able to differentiate the pages exactly, other controls have to be added to the context
assistant using the Record Page Specifierfunction. To do this, select the Screen Context macro on which
the desired control is displayed. Now click on the function Record Page Specifier, select the desired control
and confirm with Ok.
Further customization
The following post processing can be performed:

122
Additional application page objects can be recorded manually for a context assistant to explain objects of
an application page in further detail.
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Navigations - Recording and Editing



To provide users with additional information general notes can be created that will be faded in while a
navigation is in progress. This is accomplished using the Record Explanation function, which can be
selected in the macro editor after selecting the Screen Context macro.
As regards visual presentation layout changes and position changes can be applied to the highlights and
bubbles. As the bubbles are inserted directly at the clicked position, it is recommended standard practice
to review them to ensure an optimal view.
As the text modules are adopted directly from the simulations, they should be reviewed for use in the
navigation and modified if so required. For example, this is necessary in process orientated descriptions
such as Click on Next, to obtain generic information in a context assistant.
5.9.3
Inserting an explanation
You can insert additional information into your navigation and use it in a variety of different ways with the
Explanation macro. This information can relate, for example, to an application or page. System-wide explanations
can also be used for generally valid information.
System-wide explanations are applicable to all applications and processes. They make it possible to communicate
general information quickly and directly to users, for example, information about upcoming work on a server.
Displaying explanations
An explanation is displayed as follows depending on the navigation type and the position in the project:

Explanations in the first step can be used system-wide

Explanations under the application context are displayed for the respective application

Context assistant: explanations in the step of a context assistant are displayed for an entire page

Process assistant: explanations in the first step of a process assistant are displayed as start bubble - a
confirmation button for the start of the process is displayed

Process assistant: explanations in the step of a process assistant are displayed for a process step
Inserting an explanation
The explanation is to be inserted as follows for the application context and the Style macro:
1.
Select the macro for which the explanation is to be inserted.
2.
Then click the Insert Explanation function in the header of the macro editor.
3.
The explanation bubble is inserted in the step and you can now enter a text and position the bubble.
Note
When using an explanation within the application context of a context assistant, the bubble is always
visible in the desktop assistant for a displayed Inline Help. The explanation has to be minimized or hidden
by the user.
Adding an explanation for screen context
The explanation is to be added as follows for the page context:
1.
Select a screen context
2.
Then click on the Record Explanation function in the header line of the macro editor.
SAP Workforce Performance Builder 9.3
Navigations - Recording and Editing
for which the explanation is to be displayed.
Customer
© 2014 SAP AG. All rights reserved.
123
3.
Now define where the explanation is to be located by clicking in the application. You will be prompted by a
note on the cursor.
4.
A dialog will then appear in which you can enter the explanatory text. Then confirm this by clicking on OK.
The recorded Explanation macro can then be further edited in the macro editor to customize the macro's
appearance and functionality if so required.
5.9.4
Recording an Active Area
The Active Area is an alternative object context which is used, among other things, for converting Hotspot
recordings from simulations. Creating an Active Area does not deposit any object information that recognize the
object when it is being called in the application. The macro therefore lends itself to static objects that cannot be
recognized free of defects when playing back the context assistant.
This is how you create an Active Area:
1.
Select a Page Context on which the Active Area is to be displayed.
2.
Then click on the Record Active Area function in the header line of the macro editor.
3.
Now click in the application to define the position of the Active Area. You will be prompted by a note on the
cursor
4.
A selection frame will then appear to which you can assign a position and size for the Active Area by moving it
vertically and horizontally. Confirm your selection by clicking on OK.
5.
After selecting the object a dialog box will appear in which you can define the Context Info as well as other
object context attributes. Refer to the settings section Recording settings in the object context dialog.
6.
Confirm the dialog by clicking on OK if you would like to complete the recording or click on Next to record
another object.
5.9.5
Customizing Page Information
When an application is being recorded, page information is sometimes generated that is not universally
applicable. That means that the page information only exists during the recording, but is no longer up-to-date
when the recording is played back by a user (or the information is not relevant for this user). For example, material
numbers or information associated with user roles. When a content is played back, a page key - which does not
match the application page currently being displayed - means that the help content associated with a recorded
application page cannot be displayed to users.
To make a content generically available for all users, you need to replace the information in the page keys by
regular expressions.
Replace page key attribute
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:
Note
When adapting several projects with the same page key, remember that the page keys should be exactly
the same. This is especially important for displaying the available content during the playback of a
desktop assistant.
124
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Navigations - Recording and Editing
1.
2.
3.
4.
Select an object or group in the project explorer.
or
Open a project in the project editor.
Click on Replace Page Key Attributes... in the Tools -> Context Administration menu.
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.
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.
Regular expression
Regular expressions are used to replace static texts of page keys with variable attributes. An attribute with a
regular expression receives the format: RegExp(/page key attribute/)
If an attribute contains a static and a dynamic component, this is expressed as follows:
RegExp(/static component */)
The asterisk (*) defines a placeholder for the dynamic component.
Examples of regular expressions:

at least one character, generally used for any input: .*

at least 5 characters:.{5}

at least 13 characters:.{13}

at least 3 numbers or points: [0-9\.]{3}

at least 4 letters from A-Z, upper case or lower case, no umlaut characters or special characters: [A-Za-z]{4}

at least 5 numbers (points) or letters from A-Z: [A-Za-z0-9\.]{5}
5.9.6
Updating navigations
For possible process changes and extensions in the navigation projects automatic updating of the navigations is
available during playback in the Navigator. This presupposes that the projects are held centrally on a server or fileshare.
The parameter Update Frequency is available to you in the section Navigation Playback Settings -> General ->
Advanced of the central configuration dialog. This is located in the Advanced subcategory visible when selecting
the option Show more. The value is specified in minutes
Save the navigation to your relevant storage location for update purposes. The navigation will be updated
automatically with the specified frequency during playback. Once it has been automatically updated, the
navigation will restart.
SAP Workforce Performance Builder 9.3
Navigations - Recording and Editing
Customer
© 2014 SAP AG. All rights reserved.
125
A navigation's update frequency should not be set at too high a value, so as to avoid unnecessary server queries.
An optimal value is between 3-6 hours or every 24 hours. This depends on the anticipated changes.
In a desktop assistant added objects are displayed with a star (
) in the content list.
Note
Bear in mind with automatic updating of a process assistant that if it happens to be running when it is
updated, the navigation will then start again from the beginning. Process assistant updates should
therefore be undertaken in the evening or at weekends, when low usage levels can be expected.
5.9.7
Editing bubbles
Bubbles are edited in the step view. You can change the bubble text and the size and position of the bubble here.
There are two buttons on the toolbar that can be used to switch between the view of the bubble for the current
macro and the bubbles for all macros in the step.
Note
The highlights of the actions cannot be changed because they are linked to the recorded control. Changes
can produce errors in the display for the navigation process.
5.9.7.1
Editing bubble texts
Bubble texts for the navigation macros can be edited right on the bubble or in the macro editor in the respective
mode.

Editing in the step view
Double-click on a bubble and an HTML editor will appear with various options for editing the content. For more
information on the HTML editor, refer to the HTML Editor section of the document. Edit your text as desired
and click on OK to confirm your changes.

Editing in the macro editor
Texts can be edited in the macro editor in the Text parameter. Click on the respective text field and the HTML
editor will appear. You can now edit the text.
5.9.7.2
Positioning bubbles
You can change the size and position of bubbles in the step view as follows:
Positioning the bubbles
1.
Click on the object you would like to edit.
2.
A red line will appear around the object. Click on the object again, this time holding the mouse button down.
3.
With the mouse button still pressed, drag the object to the desired position.
4.
Release the mouse button and the object is now positioned.
126
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Navigations - Recording and Editing
Changing bubble alignments
1.
Click on the object you would like to edit.
2.
A square will appear at the tip of the bubble, which you can use to turn the object. With bubbles that do not
have a tip, the square will appear in the middle of the bubble. Click on the dot and hold the mouse button
down.
3.
With the mouse button still pressed, pull the dot away from the bubble and until you have reached the desired
position. Pull the dot towards the middle of the bubble if you wish to hide the tip.
4.
Release the mouse button to set the new position.
5.9.8
Merging navigation projects
Several navigations can be integrated into a single project so that you can use content from various projects in
one navigation.
The advantage of this is that content can be accessed quickly and directly and additional projects do not need to
be loaded as the Navigator can only ever play back one navigation. Already existing objects also do not have to be
recorded twice.
If multiple simulations have been converted into navigations, then a complex navigation can be created quickly
and easily by inserting various projects into one project. It is not apparent to the user when playing back the
context assistant whether he is dealing with multiple projects.
Integrate projects using the following procedure:
1.
Create a new project to add the different navigations to with the New Project
You can also open an existing project from within the Project Editor.
function.
2.
In the Edit menu select the Include Navigation
3.
You can now select the project to be inserted from within the open dialog box. Do so by clicking on the Edit
button. This will open a dialog displaying all the projects within the workarea using the Navigation type. Select
the desired project and click on Ok.
4.
Then confirm the dialog by clicking on OK if you would like to insert the project or click on Next to insert the
project and select another project.
function.
The projects themselves are linked by the act of inserting them. A macro displaying the link will appear in the first
step. Linking the projects means that changes made in the original project are also incorporated in the link and
thus also displayed in the navigation.
The way in which the main bubble is displayed reflects the project from which the navigation is being called as the
Style
macro is located by default within the first step. Any customization should therefore also be applied in
this macro. If you have created a new project then the act of inserting the project automatically creates the
Display macro.
SAP Workforce Performance Builder 9.3
Navigations - Recording and Editing
Customer
© 2014 SAP AG. All rights reserved.
127
When playing back the navigation the Navigator reads out the context information, starting with the first step.
With multiple occurrences of content of one context type, such as for example the same page contexts, the
Navigator displays the first context to be read out. If one context that is the same is not to be preferred over
another, the macro with the currently used context is to be relegated to a stepfurther back in the navigation.
5.10 Playing back navigations
The basic prerequisite for playing back navigations is for the Navigator to be installed in the operating system.
This can be incorporated in the system either via the installation file or by copying the program folder from an
installation on another computer. Read below how to start navigations both with and without an existing Producer
installation.
Note
The playback of the navigation requires the corresponding GUI Theme (e.g. SAP Tradeshow) used for the
recording.
5.10.1
Previewing a navigation
At any time during the creation process you can preview the playing back of the navigation macros and thus check
for possible errors or necessary improvements. Proceed as follows:
1.
Click on Play Navigation
in the toolbar to start the project.
2.
Start or maximize the target application and go to the desired application page. If the help objects were
correctly created and linked to, they will now be displayed in the application page.
3.
Click on Stop Navigation
in the toolbar to exit the preview.
Note
A navigation preview is controlled by the Producer. The Navigator and its control functions are thus not
available in the preview.
5.10.2 Starting a navigation in the Producer
To open a navigation from within Producer, proceed as follows:
1.
Open the Project Explorer view.
2.
Select a navigation project in the tree structure.
3.
Expand the project entry to display the navigation that has been generated as a subordinate entry. Generated
navigations are identified as follows:
4.
You can launch the navigation by double clicking on the navigation icon.
5.
The Navigator icon will now appear in the task bar info area. Read more about the different icon statuses in
the chapter on Controlling the Navigator.
128
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Navigations - Recording and Editing
6.
Open the corresponding target application. The Navigator will now display supporting help content at the
relevant points defined in the application.
5.10.3 Playing back without the Producer
Navigations, like simulations, are part of a published Workarea and are portrayed in the library. Note, however,
that any navigations generated cannot form part of a simulation project and are therefore given their own entry in
the tree structure. That means that, especially when using converted navigations, duplicate step entries, but
which are different in the way they are applied, can arise. It is therefore recommended that the Workarea
structure be organized accordingly so as to avoid confusing users.
For example, you can use two similarly structured main strings to separate simulation and navigation or arrange
simulation and navigation in succession so as to ensure subject cohesion.
A manually created navigation on the other hand can, for example, already depict a major proportion of the
available simulations and should therefore possibly be placed at the end of a step string.
To load a navigation using library, proceed as follows:
1.
Open the library.
2.
Select a navigation project in the tree structure.
3.
You can launch the navigation by clicking on the corresponding button in the header area of the overview.
4.
Clicking opens the browser dialog for downloading files and offers you a file with the file extension *.dnt.
Note
No file links are updated when copying the Navigator program folder. In this case, the operating system is
unable to assign the file format *.dnt when the navigation is first launched. Click on the Open with... dialog
that opens in this case on Browse and specify the Navigator.exe file from the folder you have copied.
Activate the checkbox for the option Always open with this program to avoid having to repeat this action.
5.
Click on Open.
6.
The Navigator icon will now appear in the task bar info area. Read more about the different icon statuses in
the chapter on Controlling the Navigator.
7.
Open the corresponding target application. The Navigator will now display supporting help objects at the
relevant points defined in the application.
5.10.4 Playing Back the Desktop Assistant
The desktop assistant can be played back using the Producer or using the navigation file (*.dnt).
Note that for playback you need to generate the desktop assistant.
SAP Workforce Performance Builder 9.3
Navigations - Recording and Editing
Customer
© 2014 SAP AG. All rights reserved.
129
Start from the Producer
Start the desktop assistant from the Producer's project explorer for the authoring preview without a Navigator
installation.
For playback proceed as follows:
1.
Select the group with Desktop Assistant in the tree of the project explorer.
2.
Click the Play Desktop Assistant button in the object editor.
3.
Click in the target application. The available content will be shown and can be used.
4.
To stop the desktop assistant, goto the Producer.
5.
Click on the Stop Desktop Assistant button in the object editor.
Start with the DNT file
For general use, the desktop assistant can be executed using the DNT file of the group folder. It is recommended
that you store the published workarea on a web server and link to the DNT file from an intranet page. The user can
start the desktop assistant by clicking the link.
The path for launching a DNT file from a server should be provided as follows:
http://server/[...]/workarea/group/group_id/group.dnt
For further information, see the chapter Publishing Navigations.

Start Link: Desktop Assistant:
The property is available for a desktop assistant group in the project explorer and contains the link of the DNT
file.
You are able to generate a start link for a URL or folder of the publication. See also the chapter Defining a start
link.
5.10.5 Displaying the process assistant
The process assistant is displayed as a list of steps with all process steps listed in the main bubble. When the
process is running, the process steps that have already been completed are indicated by a check mark. This
allows the user to keep an overview of the process at all times and see all of the actions that have already been
completed. If a process step could not be found, this is indicated by a question mark. Here, we recommend
selecting the application page again so that page identification is reinitiated or switching to the correct application
page.
The object contexts are displayed as object bubbles next to the object to be carried out. The objects are also
emphasized with highlighting.
The sequence of a process assistant is as follows:
1.
First open the application with the application page where you want the process to start. Make any necessary
settings ahead of time.
2.
Then start the process assistant to be carried out.
3.
Click inside the application so that the process assistant can recognize it.
4.
The main bubble containing the overview of the process steps appears. The object context is displayed for the
first action to be performed.
5.
Carry out the process in the application as shown by the process assistant. Completed actions are indicated
by a check mark in the main bubble.
o If text is entered, it must be confirmed via the object bubble by clicking OK to complete the entry.
130
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Navigations - Recording and Editing
6.
After the process is complete, you can end the process assistant by clicking Close in the main bubble.
The process can be performed again by clicking the Restart button. The check marks are reset and you can
navigate to the beginning of your process in the application. The object bubble is then displayed for the first
action step.
Recommendation
To make effective use of a process assistant, you should always play it back from the beginning and not
start in the middle of the process.
Icons of the step list
Icon
Description
Step
Optional step
Current step
Step completed
Branch step
Step not found
Explanation
5.10.5.1
Dealing with non-standard behavior
When a navigation is played back, situations can sometimes occur which prevent a process from being carried
out. In this case, the Navigator provides information about the problem and how it can be solved. These situations
are:

The necessary application is not open

The application is on the wrong page

The necessary control is not available
SAP Workforce Performance Builder 9.3
Navigations - Recording and Editing
Customer
© 2014 SAP AG. All rights reserved.
131
You can then switch to the necessary application page and continue with the process or skip the step. The
process assistant can also be terminated.
5.11
Publishing navigations
The following sections give you an overview of what is involved in publishing navigations and explain the different
ways in which they can be provided to, and used by, end users.
5.11.1
Publishing a Workarea
Publishing navigations for the end user requires the associated Workarea to be published. Publication involves the
playing of all the files required for playing back navigations. These are configuration files and resources for
displaying and executing navigations as well as the navigations themselves. The published Workarea can then be
provided to the users.
Note
A prefix that specifies the storage location is to be defined for publishing navigations on a file share or web
server. For more information, see the section under publishing.
5.11.2
Playing back navigations locally
Local playback entails a navigation being launched from a Workarea filed on the observer's workstation. This
variant is used, for example, by authors to check the navigations that have been created.
Navigations can be played back locally by double clicking to launch them directly from Producer. Alternatively a
navigation can be launched from the library once the library has been opened from within the Producer.
But navigations can also be played back locally if a published Workarea was filed on the workstation. For example,
the library can be displayed to allow a navigation to be selected from it. The library is opened using the Workarea's
index.html. But a navigation can also be launched directly from within the project folder, this requires the
navigation file (*.dnt) to be launched.
5.11.3
Publishing navigations centrally
Publishing navigations centrally allows the Help content to be made available to multiple users as well supporting
concentrated editing and updating. Navigations are typically provided by the authors or administrators.
The following variants for central publication of navigations are possible:

Publishing navigations to a file share

Publishing navigations to a server
Filing navigations on a server allows the following advanced use:
132
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Navigations - Recording and Editing
o
Direct launch of navigations
o
Launch using the Manager learner view
5.11.3.1
Direct launch of navigations via a file share or web server
If navigations are to be launched from a web server or file share, then the published Workareas are to be filed on
the corresponding system. Specifying the path for the navigation file (*.dnt) allows you to link to it. These links can
then be made available to users, for example within an Intranet or via web applications.
Launching from a file share
Path information for launching a navigation from a file share is to be provided as follows:

Navigation file launch: \\server\[...]\workarea\project\project\navigation.dnt

Launch library: …\workarea\index.html
Ensure when using a file share that the users have the necessary access rights.
Launching from a web server
Path information for launching a navigation from a server is to be provided as follows:

Navigation file launch: http://server/[...]/workarea/project/project/navigation.dnt

Launch library: …/workarea/index.html
Playback navigations about HTTPS
If navigations are stored on a server, then these can be accessed via a Hypertext Transfer Protocol Secure
(HTTPS). It is to be noted that HTTPS protocols means of certificates showing their trustworthiness and be
deposited in the browser for a proper invocation of applications. If a certificate is not deposited as trustworthy in
the browser, with the call of a navigation a certificate error is displayed. About this note you can continue to load
the navigation or close the navigation.
In order to avoid certificate errors from the outset, the specific certificate for the HTTPS protocol is to be installed
as trustworthy in the browser. This can be done under Tools -> Internet Options -> Contents -> Certificates in the
tab Trusted Root Certification Authorities. The installation should be carried out by an administrator.
5.11.3.2
Executing navigations via the Manager
Manager can be used to save navigation projects to a web server, allowing them to be edited and published
centrally. Once the author has published the projects in Manager or Producer users can start the navigations from
the learner view or launch them from the library. The learner view is a component of the Manager in which learning
content is made available to learners.
Navigation on the Manager
For the playback of navigations from a Manager environment the following requirements are necessary:

SSO
An activated single sign on (SSO) is necessary for the playback of assigned content. Import the active
directory of the user and activate SSO afterwards.
SAP Workforce Performance Builder 9.3
Navigations - Recording and Editing
Customer
© 2014 SAP AG. All rights reserved.
133

Anonymous
Without the login the Manager allows the playback of navigations for anonymous user. Activate the
Anonymous user in your Manager and assign the navigations to the user.
5.11.3.3
Context sensitive navigation launch in SAP
To provide direct support to users in their work processes, the SAP Help menu can be made to incorporate
context sensitive navigations, which users can then selectively and quickly launch from the menu.
The navigations are saved on a server as published Workareas and can now be assigned to the Help menu in the
SAP system.
5.12 Macros of the navigations
Fundamentally, there are the following navigation macros:
Icon
Name
Context Assistant Style
Process Assistant Style
Application Context
Screen Context
Mouse Action
Input Text
Select Single
Radio / Checkbox
134
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Navigations - Recording and Editing
Icon
Name
Explanation
Active Area
Page Specifier
Include Navigation
Process Step
5.12.1
Context Assistant Style
The Context Assistant Style defines how the context assistant is displayed during playback. The macro is located
in the first step of a project.
The following settings are available:


Variant for Object Context:
The setting defines the variants for the object bubble. The following variants are available in the drop-down
list:
o
Help besides Object
o
Help as Tooltip
Show Highlights:
This option defines whether the highlights are automatically displayed during the navigation process if the
objects exist on the pages.
5.12.2
Process Assistant Style
The Process Assistant Style defines how the process assistant is displayed during playback. The macro is located
in the first step of a project.
SAP Workforce Performance Builder 9.3
Navigations - Recording and Editing
Customer
© 2014 SAP AG. All rights reserved.
135
The following settings are available:

Variant for Object Context:
The setting defines the variants for the object bubble. The following variants are available in the drop-down
list:
o Help besides Object
o Help as Tooltip

Style:
This setting defines the bubble style for displaying the object bubble. All of the bubbles available in the
workarea are displayed in the drop-down list.

Show Highlights:
This option defines whether the highlights are automatically displayed during the navigation process if the
objects exist on the pages.

Start from Arbitrary Step:
This option enables you to start the process assistant from an arbitrary step and not from the beginning of the
process.
Process Assistant Window
The style and positioning of the window used for the process assistant can be customized in this area.
This area contains the following settings:

Window Style:
This setting defines the style for displaying the window.

Window Position:
This value determines the position of the window on the screen. The values are specified in pixels and relate to
the upper left-hand corner of the screen.

Window Size:
These settings define the width and height of the window in pixels. If the amount of text to be displayed
exceeds the area available in the window, a scrollbar appears automatically.
Process End
The subcategory Process End is located in a the Display macro is used in the process assistant and displays
information at the end of a completed process. The process can also be restarted to use different entries by
clicking a button. The macro is usually found in the first step under the Display macro.
If you move the macro under a page context, the bubble is only displayed for this context. In this case, we
recommend deactivating the option to repeat the process and only display information in the bubble.

Text:
You can enter the text to be displayed in the bubble in the text box. The text box is preset with a default text.

Next Project:
This option defines a project that is started after the completion of the current process. The new process
starts immediately and no end bubble is displayed.
Advanced area

136
Source:
If a navigation was converted from a simulation, the parameter indicates the UID of the original project.
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Navigations - Recording and Editing
5.12.3
Process Step
The Process Step macro defines the individual process steps for the process. This macro can be used to define
the process sequence. This macro is found at the beginning of a step.
The name of the process step is defined in the Name field. This can be selected in the Next Process Step macro.
SAP Workforce Performance Builder 9.3
Navigations - Recording and Editing
Customer
© 2014 SAP AG. All rights reserved.
137
6
Quizzes
Quizzes help to focus on the users’ main tasks as well as evaluate their acquired knowledge and improve it. The
learning experience is enhanced by the high degree of interactivity and scope of multimedia enrichment in the
quiz items. Direct feedback and evaluation of responses maximize the learning effect and help to pinpoint and
plug existing gaps in knowledge in an entertaining way as well as confirm correct answers.
Presentation of a quiz
In the Producer, a quiz can be created and used in different ways:

Stand-alone project
Used to refresh knowledge or to examine a complete step

Help for process simulation
Used to examine the displayed process or parts of it
Quiz items
The Producer offers a wide range of quiz items, which can be used to create interesting, multi-layered and at the
same time comprehensive quizzes. The following quiz items are available:

Multiple Choice

Fill in the Fields

Fill in the Blanks

Matching

Connection

Sorting

Slide Control

Grid

Puzzle

Hotspot
The quiz items must be created and edited individually. When using quiz items, the main focus is on learner
interaction – answering a quiz using text input boxes, drop-down lists or moving objects using drag & drop.
For further information, see the chapter Quiz Items.
6.1
Quizzes in Projects
The following section explains how to create a quiz in a project and how to integrate quiz items into a process
simulation.
A quiz can be created for a project with the type Simulation. The individual quiz items in projects can contain
various media files including pictures, audio files and Flash files, thus allowing for a more interesting and more
layered design. The results can be analyzed automatically.
138
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Quizzes
Quiz item parameters
The quiz items in projects include a wide range of settings:

Central configuration - defines the style, feedback and general behavior of the quiz

General options - defines the task and points of a quiz item

Individual options - defines the individual content of a quiz item

Media settings - defines the individual media content of a quiz item

Feedback settings - defines the individual feedback of a quiz item
For further information, see the chapter Quiz Items.
In addition to the quiz items, the following macros are available to define the structure and evaluation of a quiz in a
project:

Quiz Selection:
If a step has multiple quiz items, this macro allows you to display the items in a random order (using the quiz
selection tool) or you can select only one quiz item from the step display. It is particularly useful for process
simulations that include quiz items.

Quiz Evaluation:
Once a quiz has been finished, the results can be displayed. This can apply to a full quiz, in which case the
macro in the last step needs to be placed in front of the Simulation End macro.
It is also possible to show this macro in a step as the result for multiple quiz items (for example, if quiz items
were integrated into a simulation). In this case, the macro should be added to the corresponding step as the
last macro.
Documentation
Quiz items can also be generated as documentation, which can be a useful aid to your simulations. The quiz items
are mostly designed as tables, which should be filled out as required. In accordance with the document’s format,
drop-down lists and drag & drop objects are displayed as general lists. Therefore with the documentation format,
it is more convenient to fill information in on the computer or on a print-out.
6.1.1
Central Settings for Quizzes
Several quiz settings can be adjusted in the central configuration dialog which define the way the quiz is presented
and proceeds in projects.
Open the dialog box via the menu Tools -> Settings... and select Standard -> Global Parameters -> Quiz. The
settings will be defined for all projects, the settings can also be fine-tuned Project Overrides within a project.

Quiz style:
A corresponding Style resource can be selected for a quiz's display.

Allow to skip quiz:
This setting lets you skip a quiz item without having to enter an answer. If this setting is deactivated, every
quiz must be answered in order to proceed on to the next one.

Time limit for complete quiz in seconds:
A time can be set in this parameter inside of which a full quiz must be answered. When a time limit has been
set, a clock appears showing the remaining time.
Note that it only makes sense to use this setting within a stand-alone quiz and it should not be used for
quizzes inserted into simulations. To read more on setting individual time limits for a quiz item, go to the
Options subcategory.
SAP Workforce Performance Builder 9.3
Quizzes
Customer
© 2014 SAP AG. All rights reserved.
139

In mode:
If quiz items are to be integrated into a simulation, it is necessary to activate the view in the corresponding
mode. Activate the desired mode.
Feedback Settings
After confirming a response the learner can be shown a notice stating whether or not the quiz was answered
correctly or incorrectly.

Activate Feedback:
When this parameter is set, the following feedback entries are shown.

Show Feedback as Popup:
When this parameter is set, a corresponding feedback box is shown as a pop-up window in the foreground.

Show correct answers:
When this parameter is set, in addition to Quiz not passed being shown, the correct answer will also be shown
when an incorrect answer has been entered.

Quiz passed:
The feedback text entered is shown when a quiz has been solved correctly.

Quiz failed:
The feedback text entered is shown when a quiz has been solved incorrectly.

Quiz timeout:
The feedback text entered is shown when the time limit for answering the quiz or quiz item has expired. A
value for this must be defined in the Time limit for complete quiz in seconds or Time limit in seconds
parameter.
6.1.2
Creating a Quiz
To create a stand-alone quiz that is made up of quiz items, proceed as follows:
1.
Create a new project in the Project Explorer. To do so, use the type Simulation.
The Use Audio option shouldn't be chosen. Audio files inserted into a quiz item are managed using the Media
file parameter and are not inserted via the step, like in simulations.
2.
To play a quiz the Simulation Start macro and the Simulation End macro are required. Create these first:
1.
2.
Here, insert two steps via the menu Insert -> Add Step.
Then go to the menu Insert -> Insert Special Macro and select the corresponding macro. Make sure
that the Simulation Start macro is located in the first step and the Simulation End macro can be
placed in the last step.
Note
The insertion of the points in the Simulation Start macro does not have any effect on the points of the quiz
items and does not need to be considered.
3.
To insert quiz items you will need steps. Add steps via the menu Insert -> Add Step. Place the steps between
the steps that contain the Simulation Start and Simulation End macros.
4.
Now insert the desired quiz items. These can be selected via the menu Insert -> Insert Quiz Item.
140
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Quizzes
One or more quiz items can be inserted for each step. This enables the sorting of quizzes according to theme
or the insertion of a quiz selection for specific quiz items.
Recommendation
Make sure that you do not insert too many quiz items into a step, to keep the project clear.
Additionally, it is recommended that the Allow to skip quiz option is activated when editing quizzes in the
central configuration dialog so that quiz items can be skipped without the user having to answer the
questions.
Edit the corresponding quiz items. More information on this can be found in the following sections and in the Quiz
Items section.
Recommendation
When you play a quiz via an LMS, you can stop the playback after a certain step and then restart it. In
order to ensure that the quiz works properly, it's recommended that when using an LMS, you should
create a separate step for each quiz item. If you add several quiz items to one step, once the playback has
been stopped, all of the quiz items must be answered again.
6.1.2.1
Integrating a Quiz in a Simulation
As well as being able to create a quiz, you can also integrate individual quiz items into available simulations. For
example, this can be useful if you want to ask questions relating to functions and processes directly after they are
shown, thereby improving user knowledge.
Note
First insert the quiz items into fully edited simulations for which ReRecording is not planned or was
already carried out. This is necessary as the Producer goes through the individual steps macro by macro
when ReRecording and the quiz items cannot be skipped.
To integrate a quiz into a simulation, proceed as follows:
1.
2.
Insert a new step:
1.
To do this, select the step after which the new step should be placed.
2.
Then go to the menu Insert -> Add Step and insert the new step.
Now create your quiz items by selecting the corresponding quiz item from the menu Insert -> Insert Quiz Item.
It is recommended that you insert multiple quiz items into a step. To finish, a Quiz Evaluation can be inserted
SAP Workforce Performance Builder 9.3
Quizzes
Customer
© 2014 SAP AG. All rights reserved.
141
into the step as the last macro. In doing so you also avoid unnecessary complexity from having too many
steps integrated into the existing simulation.
Now insert the corresponding quiz items. More information on this can be found in the following sections and in
the Quiz Item section.
To display the quizzes in the trainer it is necessary to activate the corresponding mode in which the quizzes are to
be shown. For more on this, see the Central settings for quizzes section.
6.1.2.2
Quiz Section
By selecting the Quiz Section macro, the display of the quiz items can be modified individually for each step. This
makes sense in terms of depicting the quiz items incorporated in the quiz section in any desired sequence or else
displaying only one randomly selected quiz item.
A requirement for a Quiz Section is that multiple quiz items be contained in a step. A Quiz Section that spans
multiple steps is not possible.
To create a Quiz Section, continue as follows:
1.
2.
3.
4.
142
Select a step to create a Quiz Section for all of the quiz items contained in the step.
In order to set up the Quiz Section for particular quiz items only in a step, select the quiz item which is
located in front of the start point of the desired quiz items. All successive quiz items within the step are
then incorporated in the Quiz Section.
Enter the Quiz Section macro via the menu Insert -> Insert Quiz Item. Following your selection, the Quiz
Section Begin macro is now inserted and the following quiz items indented. The quiz section is terminated
by the Quiz Section End macro.
Making this selection lets you change the order and display of the quiz items contained within the Quiz
Section macro. You can choose from the two following types:

Random choice:
The effect of the Random choice option is that only one, randomly selected, quiz item is shown in
each case for the entire duration of the quiz section.
Points: Enter the point value on which the individual quiz items should be based.

Shuffle quizzes (all):
This will display all the quiz items that have been selected in random order.

Shuffle quizzes (number):
This will display a specific number of quiz items that have been selected in random order.
Number: This specifies the number of quiz items to display.
Once you have set up a random choice you can define a general point value for it in the Points parameter of
the Quiz Section Begin macro. Each quiz item within the selection is then evaluated against this points
score.
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Quizzes
Deleting the Quiz Section
If a quiz section is no longer required in a Quiz Section, you have the option of removing it should you wish to do
so. Here, only the start and end macros of the Quiz Section are deleted. The quiz items remain intact.
You should proceed as follows:
1.
2.
Select the Quiz Section Begin or Quiz Section End macro.
Then click on the Remove Quiz Section button in the macro editor header or select the Remove Quiz
Section option in the macro's context menu.
6.1.2.3
Quiz Evaluation
Once the tasks have been completed, the Quiz Evaluation macro is available for evaluating a quiz. As an option,
this can be inserted in the last step of the project or at any point within a step and thus be used for evaluating
completely autonomous quiz projects or quiz within simulations.
It should be borne in mind here that a Quiz Evaluation returns an evaluation of all the preceding quiz items. If a
number of Quiz Evaluation macros are located within a project, the current quiz evaluation provides an overview of
all the quiz items from the last Quiz Evaluation macro.
The following settings can be selected for the Quiz Evaluation:

Required result:
The Required result defines a value which must be reached in order to pass the quiz. This is denoted as a
percentage value.
Evaluation format
You can determine the degree of detail in the evaluation by means of the Format setting. The following points are
available:

Quiz Total Score:
An evaluation of the possible points achievable and the number of points actually achieved are displayed.

Quiz and Item Total Score:
A table containing the title of the relevant quiz item, the result and the points score achieved is also displayed.

Total Scores & Total Item Feedback:
The table additionally shows the solutions to all of the quiz items.
Feedback
Feedback can be put in place in each case to confirm the existence/non existence of the quiz item. This is shown
beneath the general points evaluation.
The following settings are available for this:

Enable Feedback:
When this parameter is set, the following feedback entries are shown in the Quiz Evaluation.

Quiz passed:
The inputted feedback text is displayed if the required result was achieved.

Quiz failed:
The inputted feedback text is displayed if the required result was not achieved.
SAP Workforce Performance Builder 9.3
Quizzes
Customer
© 2014 SAP AG. All rights reserved.
143
6.1.3
Editing the Quiz Items
You can set additional properties of a quiz item individually. For an overview and description of the functionality of
quiz types, see the Quiz Items reference pages. The individual quiz itmes are described in more detail in their
corresponding chapters.
Pay attention to similarly described settings and approaches when creating quiz items so that the corresponding
functionality can be defined.
Note
In case the inputs of a quiz item are incomplete or faulty, an error message will be displayed when starting
the simulation. When closing the trainer appropriate corrections may be taken.
Incomplete or faulty quiz items will be skipped while playing the simulation.
There are a number of general settings for the quiz items which can be found in the Subcategory Media, Options
and Feedback. Consult the following sections for more information.
These settings can be used to personally design your quizzes.
6.1.3.1
General Quiz Items Parameters
Once you have created a quiz item you will be able to edit or add content to it.
When setting up quiz items it is necessary to set a question as well as the number of points required. You can also
name the quiz item.

Points:
This parameter allows you to set the point value required to have achieved a correctly answered quiz item. 1 is
set as the minimum default value for this.
This way, you have the option of dividing your quiz items into different levels of difficulty.

Title:
Enter a name for your quiz item. For example, it can be a subject area or a description of the quiz item. The
name is displayed during playback of the project in the top section of the tasks.

Task:
In the field enter a task for the quiz item.
Instead of entering a question, you can enter a media file as a question. For example, this can be a PowerPoint
slide. To read more on this, see the Show instead of question setting in the Subcategory Media.
6.1.3.2
Subcategory Media
In the Subcategory Media the Media File parameter can be used to insert a file for visual or acoustic display or
support of task-setting. This can be a picture, video or audio file.
To the right of the tasks section there is a media area for the Media File where it is placed after being inserted.
144
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Quizzes
Note that corresponding plug-ins are required for each inserted file and that they must be installed on the
computer. These are then used to view the corresponding file. For example, you will need a Flash plug-in for a
Flash file, the PDF Reader for a PDF file or the QuickTime Player for the QuickTime format. These plug-ins can be
downloaded from their respective manufacturers for free.
Note
Since video and audio files cannot be integrated into a Word document, Media Files are not produced with
everything else when creating the documentation.
Advanced Settings


Width, Height:
Use the Width and Height settings to change the format of the Media File after inserting a picture file.
Show instead of task:
Upon activating the Show instead of task setting the inserted Media File is shown instead of the task. Use
this setting if you wish to have the quiz tasks shown as PowerPoint slides.
Note
The Show instead of task setting cannot be adjusted in the Puzzle and Hotspot quiz items. This is because
a media file in the form of a picture file is already used for the display of the tasks for both of these quiz
items.
6.1.3.3
Subcategory Options
In the Options subsection you have the choice of setting a Time limit in seconds for every quiz item. You can use
this parameter to set a specific time within which the quiz item is to be answered.
This can be done individually for each quiz item or for the entire project via the Central Configuration Dialog.
Note
If the Time limit has been exceeded when answering a quiz item, the quiz item will be deemed to be
incorrectly answered on evaluation.
When a time limit has been set, a clock appears while a project is playing, showing the remaining time. If a time
limit has been defined in the Central Configuration Dialog for the entire project, an additional second clock will
appear.
Note
If you set a time in the Central Configuration Dialog for the entire project, then the combined individual
times of each of your quiz items should not surpass the value for the entire project.
There are additional individual quiz items settings available in the Subcategory Options. See the corresponding
sections in the overview section for the quiz items.
SAP Workforce Performance Builder 9.3
Quizzes
Customer
© 2014 SAP AG. All rights reserved.
145
6.1.3.4
Subcategory Feedback
After confirming an answer of a quiz item, you can have a dialog display whether or not the quiz was correctly
answered. In this case, the Enable Feedback parameter must be selected.
When the feedback setting is activated the feedback texts defined in the Central Configuration Dialog are shown
accordingly.
However, you can also define individual feedback texts for a quiz item, which would be shown instead of the
general settings. The following text fields can be used for this and can be shown by making changes to the
advanced settings:

Quiz passed:
This text is shown when the quiz has been answered correctly.

Quiz failed:
This text is shown when the quiz has been answered incorrectly.

Quiz timeout:
This text is shown when the time for answering the quiz has elapsed. In this case, a value for the Time limit in
Seconds parameter must be defined.
6.1.4
Quiz Playback
Playing back the quiz should be done via theTest mode. This is necessary to stop the trainer bar displaying and to
prevent navigating with the arrow keys so that a step is not skipped unintentionally.
When displaying the quiz in the library the other modes can be hidden or deactivated before the generation in the
Save settings.
If quiz items have been inserted into a simulation, then the modes in which the quizzes are to be shown should be
selected in the central configuration dialog.
6.2
Quiz Items
Quiz items are an optional group of items to be input manually. The following quiz items are available in the
Producer:
Icon
Name
Multiple Choice
Fill in the Fields
Fill in the Blanks
146
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Quizzes
Icon
Name
Matching
Connection
Sorting
Slide Control
Grid
Puzzle
Hotspot
The chapters describe the general characteristics and the usage of the objects.
6.2.1
Multiple Choice
Using the Multiple Choice quiz item you have the option of creating a question with one answer or multiple
answers. The quiz can be solved by selecting the correct answer.
Here, you have a number of design options available, for example, whether or not to create a question that is
answerable with just one correct answer, with multiple answers or with apparent multiple answers.
To create a Multiple Choice quiz item, proceed as follows:
1.
First enter the individual answering options into the Answer x parameter.
2.
Then specify the correct answer using the Answer x correct parameter. You can activate this parameter for a
number of answers as well.
If you flag more than one answer as being correct, the possible selections are displayed as checkboxes or
alternatively as radio buttons.
SAP Workforce Performance Builder 9.3
Quizzes
Customer
© 2014 SAP AG. All rights reserved.
147
Settings
Further settings can be chosen for this quiz item in the Options subsection.

Shuffle solutions:
When the Shuffle solutions setting has been activated the answers entered are mixed individually.

Force multiple choice:
Enable this parameter if you do not immediately want to show the user that there is only one correct answer
for a question for which there is only one possible response. This converts the input fields manually from radio
button type to the checkbox type.
6.2.2
Fill in the Fields
With the Fill in the Fields quiz item you can define a question with multiple answers. These answers should be
entered as text inputs.
The answer has to exactly match the string entered by the author as being the correct answer - if so much as one
character is wrong then the answer is deemed to have been incorrectly answered.
To create the quiz item, continue as follows:
1.
You can use the Answer x parameter to set one or more answers for this quiz item.
2.
The Input Type parameter allows the display type to be defined with which the answers are to be input.
Overview of the types with descriptions and examples:
Type
Description
Text
The answer can be entered in any way desired.
Text (case sensitive)
The answer must be entered with the same
capitalization as in the predefined answer.
Integer
1.
2.
Floating point number
3.
4.
Comma separated list
5.
6.
7.
8.
148
Customer
© 2014 SAP AG. All rights reserved.
The answer must be entered as a whole
number. Here, mathematical characters may
also be used.
E.g.: 1,1-3,<4
The answer must be entered as a floating point
number where the dots can be defined as
commas or dots. Mathematical signs may also
be used here.
E.g.: 1.1;1-3.4;<4,2
The answer must be entered as a list
separated with commas.
E.g.: Answer1,Answer2,Answer3
The answer can be entered in any way desired.
Only one answer can be selected from the list.
If identical answers are contained in the list,
SAP Workforce Performance Builder 9.3
Quizzes
Type
Description
each answer may only be entered once.
Comma separated list (case sensitive)
The answer must be entered with the same
capitalization as in the predefined answer.
Regular Expression
The answer must be entered as a mathematical string.
E.g.: (^term$)
Note
When creating the quiz item the answers entered and the type selection should match functionally in
order to allow an error-free entry.
6.2.3
Fill in the Blanks
With the Fill in the Blanks quiz item you can set a quiz which has text containing gaps to be filled in where words
should be.
To create one of these gap texts, proceed as follows:
1.
Enter a text you wish to create as a gap text.
2.
Define the gaps. Here you should enter 3 underscores as placeholders for the text that is to be entered.
Corresponding to the Type selected (see Point 3) the Producer creates the necessary input and selection
options at this position in the text.
Note
Make sure that number of defined gaps matches the number of answers.
3.
Select a interaction in which the answers are to be entered:
o
Text Input
o
Text Input (case sensitive)
o
Drop Down List
o
Drag & Drop
4.
Then define the answers. The order of the answers must correspond to the order of the defined gaps in the
text. Accordingly, Answer 1 refers to the first gap, Answer 2 to the second and so on.
5.
There are differences when entering answers depending on the type selected:
SAP Workforce Performance Builder 9.3
Quizzes
Customer
© 2014 SAP AG. All rights reserved.
149
o When working with a Text Input, insert an answer in the answer field.
You can also add a number of possible values. You have to mark all answers with an asterisk (*) before it:
e.g.: *Answer1,*Answer2
o For Drop Down Lists and Drag & Drop options it is necessary to define alternative answers for selection.
That is why a number of possible answers are to be inserted in the response field. The answers are
separated using a comma and the correct answer should be marked with an asterisk (*) before it.
Settings

Shuffle solutions:
Activate this setting to mix answers for the drag & drop and drop-down list types into the corresponding
selection for a gap.

First answer list only:
The use of just one answer list is possible in connection with the drop-down list and drag & drop types if only
one list with possible answers is to be made available for the entire Fill in the blanks, to which the answers
must be allocated accordingly. The correct answers are marked with an asterisk (*). Each answer can only be
used once for a gap.
6.2.4
Matching
You can create a quiz item in which texts or pictures must be matched to one another using the Matching quiz
item.
To create this quiz item, proceed as follows:
1.
First set up how the answers are to be matched. Here the drop-down list and the drag & drop settings can be
used under Type.
o In the drop-down list all available answers are listed out and must be chosen according to the question.
o With drag&drop all answers are available as fields in any order and are to be matched to the questions.
2.
Now define the matches. Here, a question must be entered and the matching answer must be defined in the
answer field.
To do this, you must enter the corresponding question / answer text into the text fields.
Note
Make sure that the number of questions is equal to the number of answers and that an answer has been
allocated to each question.
150
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Quizzes
Matching pictures
Alternatively, you can add pictures to texts. This means that either the question and answer both contain pictures
or only one of the two do. This can be done by inserting pictures using the HTML Editor. You should proceed as
follows:
1.
You may only use the drag & drop function for matching up pictures. Set up this functionality in the Type
section.
2.
In the HTML Editor of one of the questions or answers go to Insert Object
3.
Open the folder containing the picture you wish to insert and select the picture file. Confirm this with Open.
4.
In addition to the inserted picture you can also add text.
5.
Repeat steps 2 and 3 accordingly for the next questions / answers of the quiz item.
-> Insert image from file...
Note
Do not use picture files that are too large (height, width) for Matching so that they display correctly and
do not have to be cropped.
Recommendation
Where there is an association between an image question and text response, the height of the text field in
question aligns with that of the associated image. With images of different height, this results in different
text field heights, which betrays the correct allocation of the answers.
To align the text fields, you can modify the height of the text fields by using spaces (Return key).
6.2.5
Connection
This quiz item allows you to establish connections between questions and answers in text or image form. This
involves creating a line to highlight the assignment of a selected answer to a question.
To create a connection, select a question by clicking on it with the mouse. Then use the mouse again to specify
the appropriate answer.
The following is required to create a quiz item Connection:

Define the content to be connected. You can use both texts and images for this purpose.
Enter a Question in the appropriate field and it a corresponding Answer.
Note
Ensure that the number of questions matches the number of answers and that an answer is assigned to
each question.
When playing back the project, questions are presented in sequence and the answers out of sequence.
SAP Workforce Performance Builder 9.3
Quizzes
Customer
© 2014 SAP AG. All rights reserved.
151
Inserting images
To define images as a question or answer, proceed as follows:
1.
In the HTML Editor corresponding to a question or answer, go to the function Insert object
file...
-> Insert image
2.
Call up the folder containing the image to be inserted and select the image file. Confirm this by clicking on
Open.
3.
You can now insert an additional text in the text box to accompany the inserted image.
4.
Repeat steps 2 and 3 for the other questions and answers in the quiz item.
Note
Take care when Inserting images that you do not use image files that are too big (height, width) so that
they can be displayed correctly when arranging the objects and do not have to be wrapped.
6.2.6
Sorting
Text responses can be sorted into the correct order using the Sorting quiz item. This quiz item can be used, for
example, to ask questions about the order in which a process must be carried out where the individual steps must
be sorted.
To create a quiz item for sorting answers, proceed as follows:
1.
Use the Interaction option to select how the possible answers are to be displayed. Both the Drop Down List
and Drag & Drop options are available.
o All of the defined answers are displayed in the Drop Down List and should be selected accordingly.
o With Drag & Drop the answers are positioned as fields in any order and are to be sorted into the correct
order.
2.
Select an Alignment in which the answer fields are to be sorted. Vertical and Horizontal can be chosen here.
3.
Set the answers. Enter these into the answer fields in the correct order. These answers will be mixed up on
generation of the quiz.
Depending on the number of answers, a corresponding drop down list or drag & drop field is created.
6.2.7
Slide Control
In a slide control quiz, you can define a range of numbers and answer value within this range. During playback, the
learner has to choose an answer using the slide control.
152
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Quizzes
To create a slide control quiz, proceed as follows:
1.
Define a numerical range for your slider in the Range parameter. Enter the start and end values as whole
numbers separated by a hyphen.
Only one start and one end value can be defined. Additional values, for example, 2-5-9 are not permitted.
2.
Now set the answer as a whole number.
You can only define one number as the answer. It is not possible to select more than one number or define a
number range for the answer.
Note
Make sure that you only use integers. Using alternative numerical values or words is not permitted.
6.2.8
Grid
You can create tables in which questions and answers are placed opposite one another using the Grid quiz item.
The questions can be answered by ticking one of the possible answer options.
To create a Grid quiz item you must create a table with rows and columns. To do so, proceed as follows:
1.
Set the possible answers in the Possible answers section. The number of answers defines the number of
columns. These are then displayed horizontally in the head of the table.
When entering the answers, they must be separated by commas.
E.g.: File,Edit,View,Insert
2.
Formulate the questions for the quiz item in the Question x parameter. These are then ordered vertically in
the left rows.
3.
You can define the answers in the Position of the correct answer field. Here, a number value must be entered,
which refers back to an answer from the Possible answers parameter.
For example, if you defined three answers and want one of your questions to have Answer 2 as the correct
answer, then enter 2 into the answer field of the corresponding question.
Settings

Shuffle solutions:
Activate this parameter to show the Possible answers in any order. If this setting has been deactivated, the
entries made under possible responses are shown in the same order in which they were input in the text field.
SAP Workforce Performance Builder 9.3
Quizzes
Customer
© 2014 SAP AG. All rights reserved.
153
6.2.9
Puzzle
The Puzzle quiz item lets you create a puzzle from a picture file. The task is to reassemble the original picture
correctly.
Here, an uploaded picture is divided up by the Producer and the separate parts are mixed randomly. The degree of
fragmentation can be set individually. The user can then use drag&drop to arrange the image components in the
correct layout and thus generate the original image.
The following shows you how to go about creating a Puzzle quiz item:
1.
Insert a picture file via the Image parameter.
The file can be inserted using the Replace Image
command.
Note
Note that quiz puzzles do not contain Media File parameters. The Media File area is used to display the
help image and is therefore not available for use in other media files.
2.
After inserting the picture, the puzzle must be fragmented:
o Pieces horizontal: The numerical value entered defines the number of parts into which the original image
is subdivided horizontally.
o Pieces vertical: The numerical value entered defines the number of parts into which the original image is
subdivided vertically.
Note
If, when fragmenting the puzzle, two optically identical fields are found, it may be the case that the
Producer does not recognize which picture belongs to which field. For this reason, the different puzzle
parts should be fragmented in such a way as no identical parts appear.
Alternatively, it is possible to use an image processing program prior to this to change an optically
identical picture by inserting a different-colored point, the size of a single pixel, into the picture.
3.
The composition of the puzzle can be set using the Interaction selection. A difference is discerned between
the following two modes:
o arrange in one field
o arrange in second field
4.
This selection allows you to determine whether the user works directly within the parts of the puzzle shown or
is shown a second, empty field into which he drags the parts of the puzzle.
Note
Note that the puzzle quiz item is not produced as well on generation of the documentation as the option
of doing puzzles is not possible in the corresponding document format.
Further options

154
Help Image:
The original picture can be shown next to the puzzle by using the Show help image parameter. This parameter
is activated in the initial setup.
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Quizzes
6.2.10 Hotspot
With the Hotspot quiz item, a quiz can be created in which a pre-defined area on a picture must be specified by
selecting it.
To create a quiz for a Hotspot quiz item in a project, proceed as follows:
1.
Use the Image parameter to insert the corresponding picture file within whose area a section must be
selected by the user.
The file can be inserted using the Replace Image
command.
2.
After inserting the picture, it is necessary to define an area for selection. This area can only be defined in the
shape of a rectangle.
Select the Define Hotspot function in the header of the macro editor.
After selecting the Define Hotspot button a window will open in which the inserted picture will display. In it,
you will find a red selection box whose size and position can be changed so that the picture section can be set.
Now close the window with the Confirm Selection
button.
SAP Workforce Performance Builder 9.3
Quizzes
Customer
© 2014 SAP AG. All rights reserved.
155
7
Books and Book Pages
Books and book pages are a particular way of presenting learning content by using different simulations and
materials within a creative and diverse design and compilation.
Book pages are characterized by a strongly multimedia dimension combined with user interaction. They make it
possible to incorporate simulations and different media files, but also conventional documents and links to further
information.
Using different objects and media presents you with many and various opportunities for presenting and
communicating information. Moreover, the book page design as well can be individually edited and customized to
the content to be communicated.
By consolidating different book pages within one book you can divide your content into information units.
Easy to create, diverse applications
Book pages make it possible to create courses on a particular step quickly by inserting objects on the book page
and linking them to content.
In this way you can amalgamate the content of a number of simulations by combining different modes and
documents. However, because of the diverse ways of presenting information on book pages, it is not absolutely
necessary to integrate simulations into a book page. You can also design a book page using simple texts or video
files and thus provide these to the learner in addition to the individual simulations or else integrate them entirely
independently as an extension of the step.
Didactic benefit
Books and book pages promote independent learning and a stronger engagement with the facts as learners are
able to use and discover the content individually. They allow the student to work with the content that is relevant
to him and ensure variety due to different information formats.
7.1
Basic principle and structure
A book page is an HTML page on which different content can be filed in different forms and accessed.
It can accommodate various buttons for launching simulations and opening documents that can then be linked
within a Workarea. Media files for audio and video formats can also be integrated and can be presented using
appropriate playback applications. But information in traditional form, as an image or text, can also be created on
a book page.
A number of book pages can be combined in a book. A book can thus be understood as a type of group. Once a
book has been created, it can be displayed in the book reader, which the learner can use to flick through the pages
and launch and work through content.
156
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Books and Book Pages
7.2
Creating a book
You can use the project explorer to insert a book in your course structure. Proceed as follows:
1.
Select the New book button in the toolbar.
2.
Enter a name in the open dialog box and confirm this by clicking on OK to insert the book.
3.
The Template parameter allows an existing book to be used as a template for the new book. The Change...
function allows a book to be determined from the project structure.
4.
You can now insert the desired book pages in the book or create new book pages.
To organize steps you can insert a book or group in a book in the Project Explorer. This displays the book pages as
a subchapter in the book reader.
Note
Only insert book pages and books or groups in a book for structural purposes. Projects or documents are
not displayed in the book reader as you can link to this learning content directly via the book pages.
7.2.1
Defining a book page as a content page
You can create a page containing introductory information or a table of contents for a book. So that the student
can access the page at any time in the book reader, the page can be defined as a content page for the book. The
book page can then be launched directly in the book reader using a button in the control bar.
To define the Content Page select your book in the Project Explorer. Then go to Content Page in the object editor's
subcategory book reader and select the Edit link... option. You can now specify your book page in the open dialog.
Confirm this by clicking on OK.
7.2.2
Subcategory sound effects
The book reader uses audio effects to signal the turning of the pages and the act of closing the book reader. To
this end you can define individual audio files for a book in the WAV, MP3 or WMA formats. The settings are located
in the sub category Sound effects (project explorer).
Inserting an audio file
1.
2.
3.
4.
Select the book you want in the tree structure.
In the object editor, go to Turn Page or Close in the Sound effects category.
Select Edit link... In the dialog you can select a file from the workarea or insert a file using the Import...
button.
Confirm your selection by clicking on OK.
SAP Workforce Performance Builder 9.3
Books and Book Pages
Customer
© 2014 SAP AG. All rights reserved.
157
7.2.3
Subcategory book reader
Various parameters are itemized in the book reader (project explorer) sub category which you can use to define
the functionality in the book reader control bar. This allows you to customize them to your book's individual
requirements and hide any functions you do not want.
The following settings are available:

Hide book panel:
Activating this option hides the book panel.

Hide audio controls:
Activating this option hides the audio file and effects control functions.

Hide navigation controls:
Activating this option hides the buttons for scrolling through the book pages.

Hide index page button:
Activating this option hides the button for calling a specific start page.

Hide search button:
Activating this option hides the button for calling the search dialog.

Hide table of contents control:
Activating this option hides the book page option menu.

Hide progress control:
Activating this option hides the progress bar for displaying how the student is progressing with the learning
material in the book.

Single click opens book:
If this option is activated, the book will open as soon as it is selected in the tree structure in the library in the
book reader. If the option is deactivated, the book reader is started by double clicking or selecting the button
in the right hand view of the library.
7.2.4
Alternative navigations on book pages
Actions can be defined for buttons to allow a navigation on book pages to be executed from the control bar of the
book reader. These are universal properties and allow the user to jump between book pages and units.
If you would like to use such navigations, it is recommended that the objects be inserted into a template for book
pages. By doing so, they can be used for the entire book and will ensure consistency throughout your project.
More information on this step can be found under Link actions for the trainer and book reader.
To enter a link target, proceed as follows:
1.
Insert a book page object, e.g., Image or Active Area.
2.
Under Link to…, choose the option Edit link.... The editing dialog box will then appear.
3.
Select the desired action under Actions.
158
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Books and Book Pages
7.3
Creating a book page
Create a book page in the Project Explorer in the following steps:
1.
Select the appropriate book or location within the tree structure where the book page is to be inserted. You
can either insert a book page in a book or on a standalone basis
2.
Click on the New Book Page in the toolbar.
3.
Give the book page a name in the open dialog.
4.
The Template parameter allows an existing book page to be used as a template for the new book page. That
means that once a background design has been created, it can be retained for additional book pages. This
requires the template to be selected before creating the new book page.
The Change... function allows a book page to be determined from the project structure.
5.
Confirm the data you have entered by clicking on OK.
6.
The book page is then automatically opened in the book page editor where you can now edit it and insert
objects.
Editing the book pages
The inserted book pages are edited using the book page editor. You can use this to define the design and to create
objects.
The book page editor view port is a WYSIWYG editor: that means that the book page is subsequently displayed in
the book reader or in the library exactly as it is displayed when being edited.
Recommendation
To maintain clarity with a complex course structure, it is recommended that books and book pages be
inserted at the beginning or end of the structure or of a group. You should maintain consistency of the
positions to make it easier for the user to find his bearings within the library.
7.3.1
Defining the design
After creating the book page, it is opened in the book page editor using the Default style. You can use the Style
parameter to select the design you want in the object editor and customize it accordingly.
A style defines the background design, the design of the buttons for the linked learning content as well as the
appearance of the text box. Selecting a different skin therefore changes all of these objects. Before you select a
skin, it is advisable to insert some objects to be able to assess the overall design.
Customizing the background
You can customize the chosen background design as you like. You can use an available skin as a template which
can then be edited once it has been selected.
Various settings are available to you in the book page editor for displaying the book page:

Width and Height:
These values determine the book page's width and height. The values are stated in pixels.

Background Color:
Changing this value customizes the color of the outer surface surrounding the book page.
You can use Select Color... to define the desired color value. This can be defined in the RGB or HSV color
SAP Workforce Performance Builder 9.3
Books and Book Pages
Customer
© 2014 SAP AG. All rights reserved.
159
space or as a hexadecimal value.
You can also make the background transparent if you do not want any color to be displayed. This is done
using the Transparent button.

Page Color:
This value will determine the book page's background color. It is recommended that you enter a value in this
field if you choose not to use an image for the book page's background or if you use an image that does not
cover the entire book page itself.
When using the Page Color, activate the Image setting without selecting an image. This is necessary to hide
the page image or color of the book page style.

Border:
Defines the width of the border for the book page. The value is defined in pixels. If no border is to be displayed,
the value is to be set to 0.

Border Color:
This parameter can be used to define the color of the book page border. The Select color... function can be
used to define a corresponding value in the RGB or HSV color space or as a hexadecimal value. Ensure that
you have previously specified a width for the border so that it is actually displayed.

Border style:
Determines the style of the border that you can select from the drop-down list.

Image:
This parameter can be used to define an individual background image which replaces the image of the skin
that has been set.
You can call up the design parameters at any time while a book page is being created and amend them by clicking
on the background.
7.3.2
Inserting objects
The principle behind book pages is embedding buttons on them for linking to learning content as well as
interactive objects and media files. Learners can subsequently select objects at will and work through their
learning content or use the information they contain to advance their learning.
How they arrange the objects on the book page is left to their creativity. They can arrange them symmetrically or
lay them out as they see fit. In the process, they should however take care not to integrate too many objects on a
book page to avoid overloading the page with objects and information.
Proceed as follows when inserting and editing objects:
1.
In the toolbar, click on the button corresponding to the object type you would like to insert. This creates a
button or element for the selected object which allows the user to call up the learning content.
2.
Select the object to edit it.
3.
You can position the object on the book page using drag&drop. A red border appears when you select the
object. Click on it and keep the mouse key depressed during the positioning maneuver.
Additional functionality for positioning objects is available to you in the toolbar.
4.
Further editing of the object is by means of the object editor, which offers you the associated parameters. For
each object, proceed in accordance with the explanations in the relevant sections.
Once you have edited your book page, save it using the Save Book Page button in the toolbar.
160
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Books and Book Pages
7.3.3
Table of contents for book pages
A book page can have a table of contents faded in, which is displayed on the book page background independently
of the book reader.
The table of contents is constructed from a bar displaying the groups or book pages belonging to the first sub
level. The other groups and book pages can be launched from an option menu that is faded in using the button on
the right-hand side of the book page. Clicking on a group name opens a menu displaying the group content.
The table of contents on the book pages can be used as an alternative to the table of contents in the book reader.
This is accomplished by deactivating the book reader table of contents.
Recommendation
The width of the table of contents is restricted to the width of the book page. That is why when setting up
the groups it is recommended that short names or chapter numbers be issued, so that as many groups as
possible can be displayed on the bar.
Settings
A book page's table of contents can be defined using the Table of contents subcategory. This offers you the
following functionality:

Show:
This function can be used to activate the table of contents for the book page.
Note
The table of contents must be defined for each individual book page. If all of the book pages of a book are
to receive a table of contents, then it is advisable to define the table of contents for one book page and
then use this book page as a copy template when creating new book pages.

Position:
The table of contents bar can be faded in directly above the book page or in the window header. Use this
parameter to select the appropriate position.

Menu control:
This parameter can be used to select a control for the menu. This is displayed so as to be able to scroll within
a complex content structure.

Menu structure:
These options can be used to define the way in which the content is displayed in the menu.
o
Flat structure:
The groups and book pages are displayed in a flat structure such that all groups and book pages are
displayed on one level.
o
Indented contents:
The contents of a group are shown indented relative to the group itself. This improves clarity within a
complex content structure.
SAP Workforce Performance Builder 9.3
Books and Book Pages
Customer
© 2014 SAP AG. All rights reserved.
161
7.3.4
Further properties of a book page
Show Navigation Arrows
Instead of using the command bar to scroll through the book pages, you can do so using the buttons either side of
the book page. This makes it possible to work more intuitively with the book.
To display the buttons, activate the Show Navigation Arrows option for the book page in the book page editor.
Page Sound
The Page Sound parameter enables background music or an audio commentary to be inserted in a book page.
The student can start the audio file in the book reader in the control bar.
You can link to audio files inserted in the workarea or import them. To import, select Current object. Click on the
Import... button and then select your audio file. Clicking on Open inserts the audio file in the book page.
For information on how to add and edit an audio file, refer to the section on Editing an audio file.
Display Duration
This option allows you to determine the duration that a book page should be displayed in the book reader. Once
the time has elapsed, the book reader will automatically jump to the next book page. This feature allows you to
play books as a slide show or an automatic presentation. The value can be set in seconds.
7.3.5
Merging book pages
Merging book pages allows content from a different book page to be added to the content of the currently
selected book page. This is sensible, for example, when applying recurring elements or to have a structure
available created using construction lines.
When merging book pages, the desired objects are inserted on the book page, but with the added book page
continuing to have its own separate existence.
This is how you add the content of a one book page to another book page:
1.
In the book page editor, open the book page to which the content is to be added.
2.
Select the Merge Book Pages option in the toolbar.
3.
A dialog will now be displayed with the overview of the Workarea structure in which you can determine the
book page of your choice. The book page currently open will be shown grayed out in this structure.
Click on the book page and then on OK to confirm.
4.
In the next step, you will be presented with a dialog displaying the objects belonging to the chosen book page.
By making a selection in the selection boxes you can determine which objects you would like to apply to the
open book page. Confirm your selection by clicking on OK.
The objects are now inserted on the book page in the place in which they were located in the selected book page.
The objects also receive the book page style of the book page to which they were added.
162
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Books and Book Pages
7.3.6
Templates for Book Pages
Book page templates are special types of book pages, which define a layout and general objects for creating book
page content. Templates are useful for saving time and for ensuring uniformity for newly created objects in a
complex book and to support the content creation of many authors.
7.3.6.1
Creating a Book Page Template
You should create a template before creating a book. This ensures consistency and avoids the need to make
changes afterwards.
To create a book page template, proceed as follows:
1.
Click on the New Book Page in the toolbar.
2.
In the New Book Page dialog box, proceed as follows:
1.
Enter a name.
2.
Select a language.
3.
Click OK.
3.
The book page is opened in the book page editor.
4.
Select a style and create your standard elements of the template.
5.
Click Save and close the book page.
6.
Open the project explorer.
7.
Select Book Page Template as the Subtype for the created book page.
The icon of the object changes and displays the template type.
Note
An existing template cannot be used to create a new template. Always create a template without using
other templates.
Tips for creating templates

Create a group for your templates. Set the group to hidden, in order to hide it during content playback.

Lock the position of your objects, if you want to prevent objects from being changed accidentally.

Use guides to create a layout grid.

Define Text Styles for the content, to ensure consistency and straightforward adaptation.

Insert the layout and design relevant objects.
SAP Workforce Performance Builder 9.3
Books and Book Pages
Customer
© 2014 SAP AG. All rights reserved.
163
7.3.6.2
Defining a Book Page Template
You can use a book page template to create your book page content. There are different ways to activate a
template for a book page:

Define a default template for creating new book pages

Select a template when creating a new book page

Set a template in an existing book page
Define a default template
You can define a default template, which is always used for creating new book pages. This can be done as follows:
1.
Open the central configuration dialog box (menu Tools -> Settings...) in the area Producer -> Templates.
2.
In the property Book Page, click on Edit Link...
The object selection dialog box opens.
3.
Select the book page template and click OK.
4.
Confirm your changes in the central configuration dialog box with Apply.
5.
Click OK to close the dialog box.
When creating a new book page, the template is set by default. Further information is available in the chapter
Templates for Content Objects.
Select a template for a new book page
When creating a book page, you can set a template in the corresponding dialog box. If a template has been
defined as standard, you can select an alternative template for an individual page.Further information is available
in the chapter New Book Page.
Set a template in a book page
The Page object of a book page contains the setting Template, which displays the activated template. If you want
to use another template, select the book page from the drop-down list.The property only displays book pages with
the subtype Book Page Template.
7.3.6.3
Using a Book Page Template
The objects of an active book page template have the following characteristics:

they are inherited from the template

they use the properties as default (green button deactivated)

they are highlighted in blue in the objects list

they are positioned on the layers behind the objects of the created book page

they cannot be deleted - the objects are hidden automatically
Changing and resetting objects
The template objects use the defined properties by default, if the template is used for a general book page. You
can change the template objects for your content as required.
164
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Books and Book Pages
To change an object, you have to select the specific property by activating the green control in front of the
property name.
If you have changed objects, you can reset your changes by choosing the Reset Template Objects in the Edit
menu. Once reset, the parameters are unspecified (green control deactivated) and the default template is used.
Note
Changed objects keep their status even when objects are changed in the template. Click on Reset
Template Objects to change the objects in the book page to the current status of the template.
Tips for using templates

If you do not need an object on a book page, hide the object by using the Hide property in the object editor.

We recommend that you keep the template objects when the template is used as a book page because the
objects define a layout.
7.4
Objects of the Book Pages
The following section will give you an overview on the variety of objects available for enhancing your book pages.
The properties and editing options are described here in detail.
7.4.1
Object Overview
Different elements offer the opportunity to provide the learner with information. You can insert these using the
toolbar and edit them accordingly.
They offer you the following objects:
Icon
SAP Workforce Performance Builder 9.3
Books and Book Pages
Name
Icon
Name
Arrow
Demo Mode Link
Shape
Practice Mode Link
Bubble
Test Mode Link
Image
Concurrent Mode Link
Customer
© 2014 SAP AG. All rights reserved.
165
Icon
Name
Icon
Name
Text Box
Quiz Link
Placeholder
Book Page Link
Active Area
Book Link
Text Pop Up
Document Link
BPM Object
Flash Animation
Connection
Video Object
Time Control
Audio Object
Object Selection
HTML Document
Animation
For further information to the objects, read the corresponding sections.
166
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Books and Book Pages
7.4.1.1
Arrow
The arrow object is customizable. It creates a path for which you can choose from a variety of arrow heads. The
arrow's length, position and direction can be modified as desired.
Positioning a path point
There are path points at the beginning and end of an arrow that allow you to adjust its length and direction. Click
on one of the points and drag and drop it to the desired position on the book page.
Defining an arrow
An arrow object can be customized as follows:

Arrow color
This value defines the arrow's color. The Select color... option can be used to define an appropriate value.

Thickness
This value allows you to define the arrow's thickness. The value is given in pixels.

Arrow head 1 & 2
There are several different types of arrow heads to choose from:
None
Standard
Triangle - Hollow
Triangle - Filled
Diamond – Hollow
Diamond – Filled
Circle - Hollow
Circle - Filled

Advanced:
The size of the arrow heads can be changed in this area. The area can be displayed via the Advanced View.
The size of the arrow head can be defined in width and length and adjusted depending on the thickness of the
SAP Workforce Performance Builder 9.3
Books and Book Pages
Customer
© 2014 SAP AG. All rights reserved.
167
arrow. A value can be entered here between 2 and 20 that indicates the factor by which the length or width is
to be increased by the thickness.
7.4.1.2
Shape
The shape object displays a variety of shapes to choose from for the purpose of enhancing the visualization of
learning content, process flows and sequences. Shape objects can be used in a variety of ways and can contain
text.
To select and insert a shape, click on Insert shape.
Type and orientation
A drop-down list will appear in which you can select what kind of shape you would like to insert. For some shapes,
you can also define its orientation. For more information, refer to the section on Shapes Overview.
Design

Shape color
Here you can select a color for the shape. If you would like to define a value, click on Select color…

Shape value
This setting defines the shape's character. Values between 0 and 100 can be entered here. The outcome will
vary depending on the type of shape selected. For example, you can change the width of an arrow or smooth
the corners of a square.
Note that this setting is not available for all shapes. For more information, refer to the section on Shapes
Overview.
You will find descriptions on additional settings under the section on Editing Parameters.
Effects
Under Effects, there is a variety of settings that allow you to define the behavior and design of links.

Gradient
o Shape Color (Gradient)
o Border Color (Gradient)

Design Roll-Over
o Shape color
o Shape Color (Gradient)
o Border color
o Border Color (Gradient)

Design Click
o Shape color
o Shape Color (Gradient)
o Border color
o Border Color (Gradient)
168
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Books and Book Pages
7.4.1.3
Shapes Overview
This section will give you an overview of the shapes that are available in the Producer and includes a list of shapes
for which the orientation and/or shape value can be defined.
Shape
Direction / Shape Value
Basic Shapes
Ellipse
Triangle
Left, Right, Up, Down
Isosceles Triangle
Left, Right, Up, Down
Rectangle
Rounded Rectangle
Corner radius
Diamond
Parallelogram
Left, Right, Up, Down
Shape thickness
Trapezoid
Left, Right, Up, Down
Shape thickness
Pentagon
Left, Right, Up, Down
Regular Pentagon
Left, Right, Up, Down
Heptagon
Octagon
Decagon
Dodecagon
Chevron
Left, Right, Up, Down
Arrow (one direction)
Left, Right, Up, Down
Arrows
Arrow thickness
Arrow
(two directions)
Left Right
Up Down
Shape thickness
Arrow
(two directions kinked)
Left Up
Right Up
Left Down
Right Down
Shape thickness
Triple Arrow
SAP Workforce Performance Builder 9.3
Books and Book Pages
Shape thickness
Customer
© 2014 SAP AG. All rights reserved.
169
Shape
Direction / Shape Value
Quad Arrow
Shape thickness
Notched Arrow
Left, Right, Up, Down
Shape thickness
Stars
4-Point Star
Shape thickness
5-Point Star
Shape thickness
6-Point Star
Shape thickness
7-Point Star
Shape thickness
8-Point Star
Shape thickness
9-Point Star
Shape thickness
10-Point Star
Shape thickness
12-Point Star
Shape thickness
Plus
Shape thickness
Further Shapes
7.4.1.4
Bubble
Bubbles are ideal for adding visually-appealing textual content to your projects. Similar to those used in the
simulations, these bubbles also have a tip on them to point to a specific item on the page.
Creating bubbles
To create a bubble, click on the option Insert bubble. The following options will appear:

Text:
Click on the text field to open the HTML editor, where you can enter and format your text for the bubble.

Style:
Here you can choose which bubble style you would like to use. To edit your bubble, go to the menu Tools and
open the editing dialog box for your bubble style.

Alignment:
Here you can specify in which direction the tip of your bubble should be pointing. If you choose the option
Center – the bubble will have no point and it will be positions in the middle of the chosen area.

Title:
This text field allows you to enter a title for the bubble. When using titles, it is recommended that you also
enable the option Movable, which inserts a title bar at the top of your object.

Movable:
When this option is enabled, the bubble can be repositioned on the book page during playback. An additional
title bar will appear in the object that allows you to move the bubble per Drag & Drop. After it’s been
repositioned, the bubble will be displayed normally with no arrow markers.
170
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Books and Book Pages

Closable:
When this option is enabled, the bubble can be closed while the book page is playing. An X icon will appear in
the corner of the bubble for you to click on.
Under Actions, you can also manually add the icon Restore so you can quickly redisplay the bubble.
Manually changing text bubble alignments
A square will appear at the top of the bubble, which you can use to manually turn the object. With centrally-aligned
bubbles that do not have a tip, the square will appear in the middle of the bubble. Click on the square and hold the
mouse button down. With the mouse button still pressed, pull the dot away from the bubble and to the desired
position. Release the mouse button to set the new position.
7.4.1.5
Image
This function allows you to insert an image in any format. This can be a screenshot, for example, or the graphical
representation of a fact.
You can use the various functions Replace image
in the Image parameter to insert a corresponding image file.
Creating dynamic effects
Once you have defined a link for an image you can create dynamic effects for it to visualize its state when moving
the cursor over the image and when clicking on it.

Image Roll-Over:
You can use the Image Roll-Over option to insert an image that is faded in when the mouse is moved over it.

Click Image:
You can use the Image Image option to insert an image that is faded in when the image is clicked on.
Further options

Retain aspect ratio:
If this parameter is activated, the aspect ratio is retained when scaling an image. Deactivate this parameter if
you want to be free to change the size of an image.

Zoom:
The Zoom option allows you to zoom in and out of images on the book page. An icon will be inserted onto the
image. By clicking on the icon, the image will be shown in its original size. This allows you to insert an image
into the book page and save space when scaling it.

Link to:
You can use this parameter to link the image you have inserted with an external webpage or object from the
Workarea.

To create a link, go to the Insert link... function. A dialog will then open in which you can specify a link or select
an object from the Workarea. A link to a web page or similar is to be entered in the text field under Available.
This should be in the format http://www... Confirm your entry by clicking on OK.

Open in new window:
When launched, the linked page is automatically opened in a new browser window. If you would like to open
the page in the same window, then you should deactivate the setting Open in new window.
If the linked page or object from the Workarea is opened in a new window then you can define properties
dictating the appearance of the open browser window.
SAP Workforce Performance Builder 9.3
Books and Book Pages
Customer
© 2014 SAP AG. All rights reserved.
171
7.4.1.6
Text Box
Clicking on the Insert Text Box button inserts a field in which you can enter pure text. The size of this field can be
varied to accommodate longer texts.
Example, you can use the text field to provide general or introductory information about a step.
7.4.1.7
Placeholder
The Placeholder inserts a variable in order to dynamically allocate content to a specific location. For example:
book page title, descriptions, page number, etc. The placeholder object makes it easier to keep the layout
consistent throughout the project.
To use placeholders, it is recommended that you insert them into templates so that they will be available in all of
your book pages. For example, the page number can be integrated into all of the book pages in the same position.
Once an object has been inserted, choose the desired option from the Placeholder selection list. The respective
content will then be displayed in the text field.
You can choose from the following placeholders:

Book title

Book description

Book page title

Book page description

Chapter title

Chapter description

Page number

Page count
Note
The content of the placeholders are displayed during playback. It is recommended to start a book page
during editing to see how the content looks like.
7.4.1.8
Active Area
The Active Area is a text field in which you can insert a text or image. The entire area constitutes a button that can
be linked with an external web page or object from the Workarea. This allows further information, for example, to
be shown.
To create a link, go to the Insert link...
function. A dialog will then open in which you can specify a link or select
an object from the Workarea. A link to a web page or similar is to be entered in the text field under Available. This
should be in the format http://www... Confirm your entry by clicking on OK.
When launched, the linked page is automatically opened in a new browser window. If you would like to open the
page in the same window, you need to deactivate the setting Open in a new window.
If the linked page or object from the Workarea is opened in a new window, you can define properties for displaying
the browser window that has been opened.
172
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Books and Book Pages
Effects for active areas
Under Effects, you will find a list of settings that allow you to add dynamic effects to active surfaces in order to
improve its usability. The following actions can be defined:

Design Roll-Over

Design Click
Once one of these options has been enabled, additional settings will appear. The following settings can be defined
to change the object’s properties:

Background color

Font color

Border color
7.4.1.9
Text Pop-Up
This function inserts a text pop-up which can be opened by a button. You can insert any text you like in this box as
well as an image.
The text pop-up can be formatted using the Text Pop-Up position subcategory to adjust its size and position.
Defining type and title


Type:
Different types, differentiated by a corresponding icon, can be defined for displaying the textbox. Using
different types enables you to highlight the text box content and present it more clearly to the user.
The following types are available and can be selected using the parameter Type:
o
Standard
o
More Info
o
Tip
Title:
You can use the parameter Title to specify a title for the text box. If you do not want to display a title, you
should leave the field blank. The default setting for the Standard type is no title whereas placeholders are
displayed for the other types.
Further options

Show on Roll-Over:
This option allows you to define whether a text pop-up should appear when the mouse cursor rolls over the
icon. When the mouse cursor rolls out of the icon, the text pop-up will hide again. The text pop-up behaves in
the same way as a tooltip.

Fade In/Out:
This parameter defines whether the text pop-up is displayed or hidden with a fading in effect when being
opened or closed. Deactivate the setting if you wish to avoid this effect.

Hide Text Pop-Up in Editor:
The default setting is for the text pop-up to be displayed in the book page editor. Activate the parameter to
hide it for editing. If you would like to reinstate the text pop-up in the view, deactivate the setting.
SAP Workforce Performance Builder 9.3
Books and Book Pages
Customer
© 2014 SAP AG. All rights reserved.
173
7.4.1.10
Linking Content from the Workarea
You can link simulation modes, books and book pages you have created from your workarea on your book page.
You also can integrate different documents. For example, these can be Word or PowerPoint documents you have
generated or else files in Excel or PDF format inserted in the workarea.
For a quiz any simulation mode containing only quiz items can be selected. As a rule, the recommended mode is
Test mode as it does not allow the user to influence the process in any way.
Linking the content
Proceed as follows, to insert a link:
1.
In the toolbar, select the relevant type which you would like to link to content. A button is then created on your
book page.
2.
Select the Edit link… button (subcategory Link) adjacent to the Link to parameter in the object editor.
3.
A dialog displaying the Workarea structure will then open. Only the learning content corresponding to the type
of button you have inserted can be selected from this dialog. Specify the learning content you want by clicking
on it and click on OK to confirm.
The object is now linked to the button and can be selected and opened when viewing the book page.
Note
If a button is not linked, a note icon will appear on the button. Create the link as desired. This icon is only
visible from the book page editor screen.
Customizing an icon
Icons for inserted objects automatically have the same Style appearance that was defined for the book page itself.
It is, however, possible to customize an icon with your own image. To do so, click on the option Image. This can be
an existing image file or a screenshot that has not yet been created.
You can also define an object's icon to be used as default on all the book pages. To do so, go to Book Page
Initialization and insert the icon.
7.4.1.11
Flash Animation
The Flash Animation object displays Flash files (SWF) on a book page.
Note
To insert and view Flash animations, authors and users need a Flash Player installed on their
workstations. This can be downloaded from the websites of the relevant manufacturers. Consult your
administrator if required.
Inserting a flash animation
To insert a flash animation in your book page, proceed as follows:
1.
Click on Insert Flash Animation in the toolbar.
2.
Click on Edit link... for the Source parameter in the object editor.
3.
Click on Insert file... in the dialog box.
174
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Books and Book Pages
4.
Select the file from your directory and click on Open.
5.
Confirm the dialog box with OK.
The flash animation is now displayed on your book page and can be played back. The file is copied into the book
page folder.
Note
A page with the current settings is displayed by default for inserted media objects. This is only visible for
editing and is hidden during playback.
Further settings

Quality:
The playback quality of the inserted film can be defined for flash files. This allows you to reduce file loading
times. Use the drop-down list to select the required quality.

Window Mode:
Window mode affects the display of the background and the performance when playing a Flash animation.
Note
In Window Mode (Flash) tooltips are only displayed for the options Opaque Windowless and Transparent
Windowless. Tooltips are not displayed for the other options during playback.

Start automatically:
Activate this parameter if you want file playback to be started automatically after the book page has been
opened. If this setting is deactivated, the learner needs to start the media file manually.

Repeat:
Activate this parameter if you want the object to start again after playback.
7.4.1.12
Video
The Video object displays inserted video files on a book page in an embedded player window. The object supports
common video formats (see chapter Supported file formats on book pages).
Note
To insert and view videos, authors and users need the relevant playback applications for the required
formats to be installed on their workstations. These applications can be downloaded from the websites of
the relevant manufacturers. Consult your administrator if required.
Further information on formats is available in the chapter Requirements for video formats.
Inserting a video
To insert a video in your book page, proceed as follows:
1.
Click on Insert Video in the toolbar.
2.
Click on Edit link... for the Source parameter in the object editor.
3.
Click on Insert file... in the dialog box.
4.
Select the file from your directory and click on Open.
5.
Confirm the dialog with OK.
SAP Workforce Performance Builder 9.3
Books and Book Pages
Customer
© 2014 SAP AG. All rights reserved.
175
The video is now displayed on your book page and can be played back. The file has been copied into the book page
folder.
Note
A page with the current settings is displayed by default for inserted media objects. This is only visible for
editing and is hidden during playback.
Alternative source
The object supports a wide range of video formats within HTML 5 as well as further video plugins. The Alternative
Source parameters allow you to insert additional files in different formats for a Video object. The alternatives are
used to display a video, if a format cannot be played back due to a missing plugin or unsupported browser.
Further settings

Show Control:
Displays the control bar.

Start automatically:
Activate this parameter if you want file playback to be started automatically after the book page has been
opened. If this setting has been deactivated, the learner needs to start the media file manually.

Repeat:
Activate this parameter if you want the object to start again after playback.
7.4.1.13
Audio
The Audio object plays back audio files on a book page.
Note
The Audio object itself does not have a control option; it is only responsible for playing audio files. It is an
empty object that is not visible on the book page. You can learn how to create controls for the Audio
object in the relevant chapter.
Inserting an audio
To insert an audio file in your book page, proceed as follows:
1.
Click on Insert Audio in the toolbar.
2.
Click on Edit link... for the Source parameter in the object editor.
3.
Click on Insert file... in the dialog box.
4.
Select the file from your directory and click on Open.
5.
Confirm the dialog box with OK.
The audio file is now displayed on your book page and can be played back. The file is copied into the book page
folder.
Note
A page with the current settings is displayed by default for inserted media objects. This is only visible for
editing and is hidden during playback.
176
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Books and Book Pages
Further settings

Sound channel:
This parameter determines which channel is used for sound.

Volume:
This parameter defines the default value of the volume (0-100).

Start automatically:
Activate this parameter if you want file playback to be started automatically after the book page has been
opened. If this setting is deactivated, the learner needs to start the media file manually.

Repeat:
Activate this parameter if you want the object to start again after playback.
7.4.1.14
HTML Document
The element embeds HTML documents in an IFrame on the book page.
Insert a HTML document in your book page as follows:
1.
Click on the Insert HTML Document button in the toolbar.
2.
Click on Edit link... of the Source parameter in the object editor.
3.
Insert the Link of the desired HTML document.
4.
Click on OK.
The HTML document is now displayed on your book page.
Note
It is not possible to link to a local page, because of browser restrictions.
For linking a HTML Document object with a project of the workarea use the following link form:
e.g.: project!PR_B9F988F508BF12AA:standard.html
7.5
Object editing
Various parameters and functions are available for the inserted objects, which you can use to edit the design and
positioning of individual and multiple objects.
SAP Workforce Performance Builder 9.3
Books and Book Pages
Customer
© 2014 SAP AG. All rights reserved.
177
7.5.1
Editing parameters
There are various parameters available in the object editor for editing objects. These depend on the object in
question:
General


Name:
A name is automatically allocated to each object when it is inserted into the book. The name is
customizable and its purpose is for internal use. The name will appear in the list of objects and when
actions are assigned to it.
Text:
Enter a text that should be displayed for the object.
Design





Background Color:
This value can be used to define an object's background color. The Choose color... option can be used to
define an appropriate value.
Border:
Defines the width of the border. The value is defined in pixels. If no border is to be displayed, the value is to
be set to "0".
Border Color:
This parameter determines the color of an object's border. The Choose color... function can be used to
define a corresponding value in the RGB or HSV color space or as a hexadecimal value. Ensure that you
have previously specified a width for the border so that it is actually displayed.
Padding:
The parameter Padding defines the internal spacing between the border and the text or image. The value is
defined in pixels.
Scrolling Text (text field, active surface):
When this setting is enabled, text that is inserted will be displayed as scrolling text on the book page. The
scroll movement goes from right to left.
Formatting texts (Area: Design)





178
Font:
The Parameter identifies the text font. The default setting for this is Arial.
Font Size:
This parameter defines the font size. The value is defined in pixels.
Font Color:
This value can be used to define an object's text color. The Choose color... option can be used to define a
corresponding value in the RGB or HSV color space or as a hexadecimal value.
Alignment:
This parameter determines the alignment of the text in the text field. The default setting for this is left. The
alignments right and center are also available in the drop-down list.
Vertical Orientation:
This setting defines the vertical orientation of text. The text orientation is set by default to Top.
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Books and Book Pages
7.5.2
Advanced functions
The subcategory Size and Position offers various functions for positioning an object, modifying its size and
defining its behavior:

Left / Top:
Defines the position, measured from the lefthand edge of the book page to the lefthand edge of the object as
well as from the upper edge of the book page to the upper edge of the object.
An object can be precisely positioned on the book page by altering the values. The values are defined in pixels

Width / Height:
These values specify the selected object's dimensions and can be customized accordingly. The values are
defined in pixels

Locked:
This setting can be used to prevent objects from being dragged and dropped on the book page. This requires
the setting to be activated.

Hidden:
The parameter defines whether an object is to be displayed or not. Should you not wish to display an object on
the page then the parameter is to be deactivated.

Layer:
This parameter specifies the level on which an object is located on the book page. The background constitutes
level 0, all succeeding objects increase incrementally from one. The assignment of a level to an object is
determined by the sequence in which the objects were inserted on the page.
If objects are overlapping in the book page view, you can determine which of these objects should be located
in the topmost position. Do so by entering a value that is higher than that of the superimposed object.
Alternatively, you can move an object in the object list to the desired level. This depicts how the objects are
arranged on the layers.
The option Documentation allows you to export your book pages as documentation.

Show in documentation:
Activate this option for an object if you would like the object to be added automatically to your
documentation. This option is activated by default. Deactivate this option if you do not wish to have an object
appear in the documentation.
SAP Workforce Performance Builder 9.3
Books and Book Pages
Customer
© 2014 SAP AG. All rights reserved.
179
7.5.3
Inserting an image
The option Replace Image of an Image parameter allows you to insert images in an Image or Page object. The
following options are available:

Replace with screenshot of window:
By moving the mouse over the screen display, specific areas will be recognized and outlined in red. Click on
the mouse button to select the desired outlined area.

Replace with screenshot of object:
By moving the mouse over the screen display, specific objects will be recognized and outlined in red. Click on
the mouse button to select the outlined object.

Replace with screenshot of area:
With the mouse, pull the red frame over the desired area and release the mouse button.
After selecting the area, an editing window will appear where you can make adjustments as needed. To complete
the process, click on Confirm selection. The dialog box will close and the screenshot will be inserted into the HTML
editor.

Replace with image file...
A dialog box will open from which you can select an image from a data medium of your choice. Select the
desired image and click on Open (in the Editor) to insert the image.

Replace with image from workarea...
A dialog box will open, displaying the contents of the workarea. Select the desired image and click on OK (in
the Editor).
7.5.4
New window properties
If the link destination is opened in a new window, you can define the way it is displayed in subcategory Properties
of the new Window. The following parameters can be set:
Position
The values Top and Left are used to determine the distance of the new window from the top and left hand margin
of the screen area. The values are stated in pixels.
Size
The values Width and Height are used to define the size of the new window. The values are stated in pixels.
The parameter Full screen defines whether the window is to be opened in full screen view. This requires the setting
to be activated.
The parameter Resizable defines whether the window can be scaled or whether the defined size is to be retained.
Scaling requires the parameter to be activated.
Layout
You can have the following elements of the browser window displayed in the new window. To do so, activate the
relevant setting:

Location bar

Menu bar
180
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Books and Book Pages

Scroll bars

Status bar

Tool bar
7.5.5
Duplicate object
You can use the Duplicate function to duplicate an inserted object. Settings and shortcuts activated in this object
are retained and can be reused.
Select the object and click on the Duplicate button in the toolbar. The duplicate is placed directly above the object
and can then be positioned and edited on the book page.
7.5.6
Using guides
Guides can be used to allow elements to be positioned and aligned with precision. You can use them, for example,
to create design grids by drawing the guides on an empty book page then using this as a template for creating the
remaining book pages of your book.
Guides can be drawn both horizontally and vertically. The following buttons are available in the tool bar for
inserting the guides

Insert Vertical Guide

Insert Horizontal Guide
Once a guide has been inserted, the sizing handle can be used to move it on the book page using drag&drop.
Clicking on the sizing handle displays the guide. If another object is selected, the guide is deselected.
An object is aligned with the guide by moving it on the book page. When it is on a level with the guide, the line
appears gray and the object is automatically positioned level with it.
Note
In order to ensure that objects are properly aligned when dragging & dropping, you can activate the Snapin-place options for objects from the central configuration dialog. The settings can be found under
Application -> Book page editor.
SAP Workforce Performance Builder 9.3
Books and Book Pages
Customer
© 2014 SAP AG. All rights reserved.
181
7.5.7
Aligning objects
If you have positioned a number of objects on your book page, you can arrange these on one line. The following
functions are available to you here as a result of which the objects can be arranged on the edge in question:

Left align

Top align

Right align

Bottom align
These functions require a reference object to be selected on which the other objects will align themselves. Select
the reference object and then click on the objects to be aligned while holding the Ctrl button depressed. You can
then select the desired action in the toolbar.
7.5.8
Customizing object dimensions
To obtain uniform objects, you can align their dimensions with those of a reference object:

Same width

Same height

Same size
To this end, select a reference object with which the other objects will align themselves. Select the reference
object and then click on the objects to be aligned while holding the Ctrl button depressed. You can then select the
desired action in the toolbar.
7.5.9
Arranging objects
The same spacing can be assigned to objects to arrange them in a consistent horizontal or vertical plane. To do so
you must first align the objects horizontally or vertically on one line.
Select at least three objects to be arranged. This is required as two reference objects define a spacing with which
other objects align themselves.
Select the objects by clicking on them or draw a selection mask by clicking and holding the mouse button. Then
click on the button of the function you want.
182
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Books and Book Pages
Arrange objects horizontally

Equal horizontal distribution:
The spacing between the first object and the second is used as a template for subsequent objects and
customized.

Distribute horizontally:
The first and last object retain their position. The objects in between share the space so as to maintain equal
horizontal spacing.
Arrange objects vertically

Equal vertical distribution::
The spacing between the first object and the second is used as a template for subsequent objects and
customized.

Distribute vertically:
The first and last object retain their position. The objects in between share the space so as to maintain equal
vertical spacing.
7.5.10 Changing the level of objects
If an object is concealed by another object in the view, you can modify the level of the object in question. Select
the desired object and then click on one of the options.
If you would like to change an object's level by one position, select the following functions:

Forward one level

Backward one level
If you would like to place the object on the first or last level of all of the objects, then select the following function:

In the foreground

In the background
Alternatively, you can move an object in the object list to the desired level. This depicts how the objects are
arranged on the layers.
7.5.11
Creating a Flash button
Flash buttons are inserted to increase the design options available for book page controls. This is done using the
Flash animation object. You can do this both by inserting Flash files containing predefined links as well as Flash
files to which a link in the book page has been assigned.
This is how you create a Flash button:
1.
Insert a Flash object using Insert Flash Animation and select a Flash file. Also note the section on integrating
media files.
SAP Workforce Performance Builder 9.3
Books and Book Pages
Customer
© 2014 SAP AG. All rights reserved.
183
2.
Then select the Edit link... button in the parameter Link to.
Note
Assign only one link in the book page editor to the Flash button if the Flash film does not already contain a
link assigned to it when it was created in a Flash animation application.
3.
You can now use the dialog box to select an item of content in your Workarea or specify an external link in the
Available area. Confirm the dialog by clicking on OK.
Flash buttons can only be inserted in a book page and linked to one at a time.
7.6
Actions and effects on book pages
Incorporating multimedia and interactive elements by adding actions and effects will turn your book pages into a
didactically enhanced learning environment. You can choose from a wide variety of special effects to highlight
specific steps and objects that are sure to capture and retain the learner’s attention. By doing so, you will help
your users better focus on the important items that should be learned, and you will simultaneously promote
sustainable learning by creating and fostering an enjoyable, interactive learning environment in which the user can
explore, discover and retain new information.
Object actions can be used to add interactive effects to individual objects. These actions can be triggered
manually by the user or can be configured to run automatically. In addition, with special object actions, you can
use actions to define and control certain effects.
7.6.1
Object actions
You can define actions for book page objects in order to trigger the behavior of an entire book's or a book page’s
display, such as having objects automatically appear on the book page or jumping to the next page. Object actions
give authors greater flexibility in creating interactive content.
The actions can be defined in the object editor, in which you will find an area that is also called Actions. Specific
actions are displayed for each object that can be used in conjunction with them in book pages.
The components of an object action
An object action consists of an executable action, an object that should be affected via this action, and the
behavior to be triggered. The available actions and behaviors depend on the type of object and can be used in a
variety of ways. You will find more information on this step below (see An Overview of the Actions and An
Overview of the Behaviors).
The following is an example of how to insert an action into an Image object:
On Click > Text > Show
When the user clicks on the image, the Text object that was selected will appear.
Multiple behaviors assigned to one action
You can assign as many behaviors to one individual action as you would like. To trigger multiple behaviors, simply
click on the plus icon next to the dropdown box. This allows you, for example, to fade objects in and out. You can
remove a behavior by clicking on the minus icon next to the dropdown box.
184
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Books and Book Pages
The following section will give you an overview of the variety of object actions that are available for enhancing your
book pages and will describe specific use cases.
7.6.1.1
Fade objects in and out
A fade over effect can be used to naturally and smoothly fade objects in and out. The following behaviors can be
assigned to certain types of objects to obtain the desired effect:

Fade in

Fade out

Fade toggle
Timing fade effects
There is a Fade in/Fade out subcategory in the editor where you can define the exact length of time the effect
should take place for each object. The values are calculated in seconds.

Fade in duration

Fade out duration
7.6.1.2
Controlling audio with actions
Actions can be assigned to individual buttons in order to control an Audio object. You can customize the functions
to suit your specific needs. For example, you can define objects, e.g., an image or a text field, to be used as a
button. When the user clicks on the image or text button, you can define the button in such a way so that the
corresponding audio file will automatically play.
Recommendation
In the case where an Audio object should be controlled via a button, we recommend that you disable the
Audio object’s setting Start automatically. This will allow the user to interact with the learning content and
start the audio at the appropriate/desired time (e.g., by clicking on a play button). Moreover, you should
give your objects unique names upon inserting them into your book pages in order to create transparency
and facilitate selecting and assigning them when creating your learning content.
For more information, refer to the sections Overview of Actions and Overview of Behaviors.
Control actions
To create an object to control an audio file, such as an image, proceed as follows:
1.
Insert and position your Image object to be used for the button. (More detailed information on objects is
provided in a further section in this document.)
2.
From the subcategory Actions, you can define the specific actions that your Image object should execute.
1.
From the first dropdown list, select the Audio object that should be used for the action, e.g., On Click. This
will automatically create a link to the Audio object.
2.
From the second dropdown list, you can define the behavior, e.g., Play. You will find a variety of audio
behaviors listed here.
SAP Workforce Performance Builder 9.3
Books and Book Pages
Customer
© 2014 SAP AG. All rights reserved.
185
3.
You can now repeat these steps for any additional buttons that you would like to add.
Actions in an Audio object
Under the subcategory Actions, Audio objects can be used in combination with various object actions to control
the audio file.
For example, a button can be defined to switch back and forth between two different actions by clicking on it in
order to control the audio file, just like with the standard mute/unmute or play/pause buttons. This changeover
can be defined by inserting a second Image object and positioning this on top of the original image and then
defining the image to fade in and out accordingly. The following is an example of how to create an Audio object for
play/pause:

On play
> image “pause” > show
> image “play” > fade out

On pause
> image “play” > show
> image “Pause” > fade out
To display or minimize the full list of behaviors to choose from for an action, click on the plus and minus icons and
the list will appear.
7.6.1.3
Overview of the actions and behaviors
The list gives you an overview about common used types of actions and behaviors. The available types and also
further types depend on the used and linked elements.
Actions
Action
Description
On Click
Describes the action that should be carried out when
the element is clicked on.
On Mouse Roll-Over
Describes the action that should be carried out when
the element is moused over.
On Mouse Roll-Out
Describes the action that should be carried out when
the mouse rolls out of the element.
On Show
Describes the action that should be carried out when
the element appears.
On Hide
Describes the action that should be carried out when
the element disappears.
On Play
Describes the action that should be carried out when
the element is playing.
On Pause
Describes the action that should be carried out when
the element is paused.
On Stop
Describes the action that should be carried out when
186
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Books and Book Pages
Action
Description
the element is stopped.
On Finish
Describes the action that should be carried out after
the element has played.
On Mute
Describes the action that should be carried out when
the sound is deactivated.
On Unmute
Describes the action that should be carried out when
the sound is activated.
On Volume Change
Describes the action that should be carried out when
the volume is changed.
Behaviors
Behavior
Object
Show
Shows the specified element after an action is
executed.
Hide
Hides the specified element after an action is
executed.
Toggle
Shows/hides the specified element after an action is
executed.
Fade In
Fades in the specified element after an action is
executed.
Fade Out
Fades out the specified element after an action is
executed.
Fade Toggle
Toggles the fade in/ fade out of the the specified
element after an action is executed.
View Link
Views the link target of the specified element after an
action is executed.
7.6.2
Create effects and animation
Action objects can be used to add special effects and animation to your learning content to create motivating and
interactive presentations for the learners. The action objects are found in the book page editor. Besides the basic
actions that are available, you can define more complex actions for an object. You can influence an action’s
behavior by configuring its settings to suit your individual needs. The objects in this case are “blank”, only serving
as a definition for the actions and do not contain any content, such as text or images.
SAP Workforce Performance Builder 9.3
Books and Book Pages
Customer
© 2014 SAP AG. All rights reserved.
187
Recommendation
Before creating an action object, you should become familiar with how actions work so that you can take
advantage of their versatility.
How to modify objects and their behaviors
The following action objects are available in the book page editor:

Animation

Time Control

Object Selection
The following settings are available for these three objects:

Change position and size

Fade in/Fade out
7.6.2.1
Use cases
Action objects can be used in combination with additional book page objects, giving you a wide variety of use
cases and plenty of room for your own creativity. The following examples will give you an idea of how action
objects can be used:
Animation
Animations can be used to creatively highlight specific pieces of information. For example:

To attract the learner’s focus to a certain image, this image can be defined so that its size automatically
increases when the book page is displayed.

Several objects can be grouped together and displayed in a smaller format to save space. The user can then
individually click on the images to zoom in on them. In this way, the user can concentrate more on each
individual image and the respective learning material as needed.

Mouse rollovers and rollouts can be used to add effects to text and important information to enhance the
learning experience. The original state of the text will then be automatically restored.
Time Control
The Time Control allows you to define how long the action should take place:

You can use the Time control with images to create an automatic slide show in which the images
automatically fade in and out.

You can sequentially start various animations to create complex processes and visualizations.

The gradual fading in and out of text allows you to optimally visualize a sequence of information. Such
animated text is perfect for accompanying audio text, for example.
Object Selection
The Object Selection is ideal for sequentially selecting multiple objects. For example, an Object selection can be
used:

To create image galleries on book pages - the user can then click through the gallery at his own pace.

For visualizing process workflows in which individual steps can be selected.
188
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Books and Book Pages
7.6.2.2
Considerations for the creation
When working with action objects, we recommend that you take the following guidelines into consideration prior
to starting the creation process in order to be able to fully take advantage of their versatile functionality:

Before you begin, we suggest creating a storyboard to help you optimally plan which behaviors should be
assigned to which actions and how the users should interact with them.

Do not go overboard with the number of effects per page. Try to limit the number so that the important
information is highlighted, while simultaneously ensuring a transparent and user-friendly look and feel to each
page. Simple effects, such as clicking on objects and automatically having content fade in and out can prove
to be quite useful enhancements to your learning content as long as the page is not cluttered with so many
animations and interactive elements that it would overwhelm the user.

Always make sure you assign unique names to your objects (under the setting Name). This will make it easier
for you when selecting objects and actions so that you can quickly find the one you are looking for.

When inserting animations, make sure you know which level the objects are on in order to avoid accidentally
hiding them. On the other hand, when this technique is intentionally used, you can easily hide specific objects.

Animations that are used repeatedly throughout your book can be predefined on a book page template to
save you time when creating a new book page with the same animation.
7.6.2.3
Animation
Animation objects allow you to change the position and size of your animations. The Animation object actually
defines the final size and position for the animation. To adjust the animation's size, the Animation object can be
proportionally scaled in height.
Structure of an animation
The following explains how an animation works:

Initial State
The object to be animated (e.g., an image) is created with the same size and position as its initial state.

Final State
When the animation is activated, the object will change to the size and position of the Animation object (red
rectangle).
Creating an animation
The following is an example of how to create an animation:
1.
Create an Image object and position it as desired to serve as the initial position.
2.
Insert an Animation object (from the toolbar) and define its properties:
SAP Workforce Performance Builder 9.3
Books and Book Pages
Customer
© 2014 SAP AG. All rights reserved.
189
3.
1.
Move the Animation object to the desired final position and adjust the frame size. If the object should be
the same size as the image, you can enter the exact dimensions under Position.
2.
Name:
Enter a unique name for the object to facilitate allocating actions at a later time.
3.
Target object:
Select the Image object as the target object.
4.
Duration:
Here you can define how long the animation should run. The value is calculated in seconds.
The animation can be interactively triggered by the user or defined to run automatically by assigning actions
to the animation. For example:
o Action on Click – the user clicks on an Image or Text object to start the animation
o Action after Loading – the animation automatically plays when a book page is opened
o Action after Timeout – a Time control object can be used so that the animation will automatically play
after a defined period of timeFor each action, you have to select the Animation object from the first
dropdown list, and the behavior Start from the second dropdown list.
Once you have created your animation, you can test it out by clicking on the Preview button in the book page
editor.
Stopping an animation
In addition to the behavior Start, you can also define the animation to automatically stop. Simply select the
behavior Stop from the list. For example, you can add start and stop buttons to your animation by inserting and
defining Image objects.
Additional options

Easing:
Easing effects the time duration of an object, allowing the animation a more effective and smoother transition.
Easing can take place at the beginning, at the end or both. There are three types to distinguish between:
o Quadratic
o Cubic
o Sine

Action on Start (under Actions):
When an animation starts, another action can be triggered simultaneously. For example, an additional
animation can start, an audio file can play or a Text object can be displayed. This allows you to create
relationships between the objects and learning content can be sequentially structured if desired.

On Stop:
An action can be defined to be executed when an animation stops. In contrast to the option Action after
animation, this allows you to stop the animation at any time, thereby changing a button’s behavior, e.g., a
button can be defined to continue the animation.

Action after Animation (under Actions):
Once an action has been completed, another action can be triggered, such as other animations or
automatically jumping to the next page.
To do so, select the desired object and the action to be allocated to it under Settings.

Show Debug Information:
This setting allows an object’s status information to be displayed while the book page is playing. This will
display additional information on the object’s action while it is being executed in test mode to give you more
control over the action.
190
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Books and Book Pages
Note
When using images with transparency, clicking on the transparent area will trigger the animation. To
prevent undesired actions from being performed by the user, we recommend using images without any
transparency.
Recommendation
If you would like to re-use an animation that you have already created, you can copy and insert the
respective objects collectively in groups. The objects are automatically recreated and allocated without
requiring any additional post-editing work required.
7.6.2.4
Time Control
A Time Control object allows you to precisely time your actions. Images can automatically fade in and out or
animations can be combined to create sequences.
To set up a Time Control:
1.
First create the object that you would like to start off with. This could be an animation, an Image object or a
similar object.
2.
From the toolbar, insert the Time Control object.
3.
Next, define the time intervals and the corresponding actions.
To obtain a clear overview of your animation projects, we recommend that you arrange your objects and
actions according to their time control settings in chronological order.
1.
Time:
In this field, you can enter the length of time during which the action should be carried out. The value is
calculated in seconds.
Note
Time values are not automatically combined. If you would like to have multiple actions begin
simultaneously, you have to manually summarize and enter the time values, e.g., 20, 40, 60,...
2.
4.
Action after Time-out:
In this field, you can select the action that should be triggered once the defined period of time has run out.
For example: Image -> Show, Animation -> Start
In order to start a Time control, an action has to be triggered by the user. This can be a button, for example,
that starts a series of images. For this example: Actions -> Action on Click -> Time Control -> Action Start.
SAP Workforce Performance Builder 9.3
Books and Book Pages
Customer
© 2014 SAP AG. All rights reserved.
191
Additional options

Show Debug Information:
This setting allows an object’s status information to be displayed while the book page is playing. This will
display additional information on the object’s action while it is being executed in test mode to give you more
control over the action.
7.6.2.5
Object Selection
With the help of the Object Selection, you can fade objects in and out, one following another, which can be
triggered by user actions. This allows the user, for example, to click through a series of images in any preferred
order.
To create an Object Selection:
1.
Create your Image objects and position them as desired.
2.
Set all images to hidden except for the first one that should appear. This allows images to fade in one by one.
3.
From the toolbar, insert the Object Selection and define its properties:
4.
1.
Name:
Enter a unique name here so that you can easily identify your object selector when selecting it from the list
at a later time.
2.
Object 1-10:
Select the objects in the order in which they should appear, from 1-10.
Next, successively select the Image objects in order to assign the Object selection to the images. Under
Actions, you have to define an action for each individual image in order for it to be able to switch to the next
image, e.g., Action on Click. From the first dropdown list, choose the Object selection and from the second
dropdown list, select Activate 1-10 for each object.
Once you have created your Object selection, you can test it out by clicking on the Preview button from the book
page editor.
Additional options

Fade in:
This setting allows you to define a smooth transition effect for objects when they fade in and out.

Show Debug Information:
This setting allows an object’s status information to be displayed while the book page is playing. This will
display additional information on the object’s action while it is being executed in test mode to give you more
control over the action.
192
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Books and Book Pages
7.7
Templates for Text Units and Projects
The Producer allows you to insert the content of objects into a book page template, in order to use text units and
projects in books. This supports a separation between content and design. During playback, the properties of the
text units or projects with modes are inserted automatically by the book reader. Each object is displayed as a
single book page, which shows the defined content.
Proceed as follows to insert text units or projects into a book page:
1.
Create a book using the New Book toolbar entry.
2.
Insert the text units or projects into the book with the required structure. You can also use both types in a
book.
3.
Create a book page using the New Book Page toolbar entry. To use it as a template, we recommend that you
save the book page in a separate template group in the workarea structure.
4.
Open the book page in the book page editor.
5.
Insert empty text boxes as placeholders for the content properties of the objects. The property displayed by
each text box must be defined in the Name parameter of the text box:
Value
Description
caption
Name
shortdesc
Short Description
description
Description
6.
For projects, you can also insert a Mode Link in the template to use a specific project mode by default.
Insert the Mode Link for the required mode and define the use of the mode in the Name parameter of the
object:
Value
Description
demo_link
Demo Mode
uebung_link
Practice Mode
test_link
Test Mode
SAP Workforce Performance Builder 9.3
Books and Book Pages
Customer
© 2014 SAP AG. All rights reserved.
193
Value
Description
praxis_link
Concurrent Mode
7.
Save the book page.
8.
Open the central configuration dialog box (menu Tools -> Settings…) in the section Playback Settings -> book
reader. Define the following settings and confirm with OK:
Setting
Description
Text Units
Show text unit properties
Activate this setting to display text units in the book
reader.
Template for text units
Select your created book page template for the text
units.
Projects
Show project properties
Activate this setting to display projects in the book
reader .
Template for project pages
Select your created book page template for the
projects.
7.8
Modeling business processes
You can create models for business processes using the BPM object. The versatility of creation supports complex
models at several process levels.
A BPM object represents a process step here while the combination of several BPM objects represents the entire
process. You can use the Connection Object to combine process steps in the form of arrows and visualize their
sequence.
7.8.1
Creating processes
If you want to create a process manually, proceed as follows:
Structure of a process step
A process is comprised of BPM objects that are connected with arrows. You can use text boxes to insert the
actions and information necessary for a process step via the arrows.

Process step:
Indicates the name of the process step and is displayed in the main field of the object.

Role:
Indicates the role or function for the process step and is displayed in the lower field of the object.

Annotation:
Additional annotations for a process step can be entered in the respective field. The annotation is displayed by
194
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Books and Book Pages
clicking the icon in the object.
Icon: Bubble

Link to:
A link to another book page to access more in-depth information. For example, a process can be created as an
overview with more in-depth process steps on other book pages.
Icon: Arrow

Attachment:
Documents, projects, book pages or files can be linked by the attachment. Up to 10 attachments can be
defined. When opened via the icon, a menu is displayed with all attachments and the selected attachment
then opened in a new window.
Icon: Paper clip
The option Open link in new window allows you to define whether the attachment should open in the same or
in a new window. The window’s appearance can be defined under New Window Properties.
The content that is displayed via an icon can be accessed by clicking the icon.
Recommendation
The icons used for the BPM object are found in the respective book page style. If you want to use icons
other than the standard icons, they are to be replaced in the respective folder. Make sure to keep the
names and size of the icons.
Design of a process step

Text Style Role:
The design of the text and background for the role can be set in the Text Style Role area.

Design:
The background color of the field for the process name and the border of the entire object can be changed in
the area Design.
7.8.2
Connecting objects
The inserted BPM objects can be connected using a connection object and the process direction shown using
arrows. A path can be created with an arrow here. This can be either a simple line or a complex structure with
several path items.
Defining an arrow
An arrow object can be customized as follows:



Arrow color
This value defines the arrow's color. The Select color... option can be used to define an appropriate value.
Thickness
This value allows you to define the arrow's thickness. The value is given in pixels.
Arrow head 1 & 2
There are several different types of arrow heads to choose from.
Positioning a path point
There are path points at the beginning and end of an arrow that allow you to adjust its length and direction. Click
on one of the points and drag and drop it to the desired position on the book page.
SAP Workforce Performance Builder 9.3
Books and Book Pages
Customer
© 2014 SAP AG. All rights reserved.
195
Creating complex paths
Process structures don't usually just go in a straight line but are much more complex. You can use the connection
object to create paths with several path points and corners. Keep in mind that the paths can only be aligned
horizontally or vertically here. The number of path points is also limited to 10.
Inserting a path point:
1.
Press and hold the Shift key.
2.
Then click the mouse on the point where you want to add the new point.
3.
Drag this point to the position you want.
Removing a path point:
1.
Press and hold the Alt key.
2.
Then click the mouse on the point where you want to remove the point.
Keep in mind that only points at the end or beginning may be removed.
7.9
Global settings for book pages
The standard settings for creating and editing book pages can be defined from the central configuration dialog
box. There are three main global setting categories:

Templates (Application)
Templates can be defined for books and book pages and can be used when inserting new objects. Once the
template has been created, you can define its settings here under Templates.

Book Page Editor (Authoring Settings)
Here you can define the settings for the grid and grid lines in the book page editor as well as its behavior when
positioning objects.

Book Page Initialization (Authoring Settings)
Default settings can be defined here for book page objects. In this way, the book page objects are assigned
values that are automatically allocated to them upon creation.

Book Page Fallback Defaults (Playback Settings)
The fallback default settings can be configured here for book page objects. The Producer uses these values
when the respective setting is deactivated for a particular object.
Recommendation
To only snap-in objects when necessary, you can temporarily activate this snap-in behavior by holding
down the Ctrl button. The snap-in function overall is to be deactivated in the settings beforehand and the
desired snap-in options activated.
Furthermore, you can define settings for the playback of books and book pages with the book reader:

196
book reader (Playback Settings)
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Books and Book Pages
7.10 Books and book page view
For the book pages view it is necessary to distinguish whether these pages were inserted in a book or placed
individually. An individual book page is opened in the library view whereas a book is presented in the book reader.
After they are selected, modes linked on a book page are opened in the trainer.
Note
If you have inserted media files in a book page, then the corresponding playback application needs to be
installed on the users' workstations so that these files can be displayed.
Books view
Books that have been created are displayed in the book reader. This enables selection of, and scrolling within,
pages. Once a book page has been called, objects in it can then be launched or opened so that they can be worked
through.
When a book is called in the library it is launched directly in the book reader.
Book pages view
Individual book pages are not viewed in the book reader as this is intended for scrolling through a number of
pages.
If you select an individual book page in the library it will be displayed directly in the learning content view.
book reader style
The way the book reader is rendered can be determined in the project explorer when selecting a book in the object
editor. A dropdown list box for selecting the style is available to you in the Skin parameter. This is where you can
define an individual design for each book.
Note
Changing a skin for the book reader doesn’t changes the style for the book pages located within the book.
You can customize the style for each individual book page in the book page editor.
7.10.1
Preview in the book page editor
The Preview function exists in order to be able to view and use a book page during editing in the book page editor
in the same way it is displayed to the student. If you select this in the toolbar, you will be able to test your book
page's objects. These will then behave in the same way as they do when being presented in the library or book
reader.
In order to be able then to resume editing the objects, deactivate the button.
SAP Workforce Performance Builder 9.3
Books and Book Pages
Customer
© 2014 SAP AG. All rights reserved.
197
7.11
Supported file formats on book pages
Media plug-in
Supported file formats
Audio, Page Sound
*.mp3, *wav
Flash
*.swf
Media Player
*.mp3, *.wav, *.avi, *.mpeg, *.mpg, *.wmv
QuickTime
*.mp3, *.mp4, *.qt, *.mov
Image
*.gif, *.jpg, *.png, *.bmp, *.jpeg
Document
*.doc, *.docx, *.rtf, *.ppt, *.pptx, *.xls, *.xlsx, *.pdf,
*.html, *.htm
7.11.1
Requirements for video formats
The table gives an overview of the supported video formats of the SAP Workforce Performance Builder and the
possible operating systems and browsers:
Formats
Windows Vista / 7
Format
Codec
mp4
h264
IE 7 - IE
10
Firefox
Windows 8
Safari
Desktop
Mobile
Apple
Android
Safari /
Webkit
Webkit
mpeg4
avi
xvid
h264
mpg
mpeg2
wmv
wmv3
vc1
198
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Books and Book Pages
Formats
Windows Vista / 7
Windows 8
Apple
Android
mov
qt
Supported
Plugin / Codec required
Unsupported
SAP Workforce Performance Builder 9.3
Books and Book Pages
Customer
© 2014 SAP AG. All rights reserved.
199
8
Text Units
The text unit structure object makes it possible for you to integrate text components into your structure. Using
different typifications, a text unit offers various options for incorporating additional information and content into
your structure and using them for various output formats.
In its structure, the text unit object is slightly based on the topic object of the DITA method for representing
information structures. It provides a set of types to primarily target possible needs in structural creation and
administration of didactic content. Nevertheless it can be used as well to store project related or procedural
information within the workarea.
Types of the text unit
Changing the type of a text unit changes the symbol the object is displayed by in the tree view of the project
explorer. The following types are available.

General

Concept

Task

Reference

Problem

Job

Defect

Subsystem

Component

Function

Requirement

Glossary
Integration in the Project Explorer
The text unit object can be integrated anywhere in the tree structure, keeping in mind the possibilities of other
structure objects. Similar to the Group object, any structure object can be stored below a text unit.
8.1
Structure
Unlike, for example, projects, a text unit does not have any individual object content. Information is displayed
solely in the areas shown in the Project Editor: Title (1), Short description (2) and Description (3) and structurally
by selecting a document type. The functions of the HTML editor are available for making entries in the areas Short
description (2) and Description (3) .
200
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Text Units
You can structure you information more systematically because there is a distinction made between the input
areas Short description (2) and Description (3). If you use the optional Short description box, you can improve
user orientation within the information structure with much shorter texts that summarize the topic. The short
description can be used here exclusively for orientation purposes (example A) or simultaneously function as a
thematic introduction with a smooth transition to the detailed description (example B).
Example A
Example B
Title
Formatting in documents
Formatting in documents
Short description
This chapter shows you how
formatting is applied to document
areas and paragraphs.
It's happened to everyone.
An important document has to be
read quickly and its content
captured. However, the document
is poorly formatted or not
formatted at all - logical
correlations disappear because
there are no paragraphs or
headings while a lack of visual
information in the body text makes
comprehension difficult for the
brain.
Description
You can use formatting to
systematically highlight the main
content of your document for the
reader and structure the document
Well-formatted documents are
easier to read and their message is
clearer for the reader. But what do
you need to keep in mind if you
SAP Workforce Performance Builder 9.3
Text Units
Customer
© 2014 SAP AG. All rights reserved.
201
8.2
Example A
Example B
so that it is easier to read and
capture.....
want to format and structure a
document so that it is easy to
read? The projects shown in this
area...
Content-based separation through typification
The advantage of differentiating among different types of text units is that contents can be represented flexible
but consistent by the content-based logic of the available types. However, you may freely determine the content
specifications for a type different than the type name proposes but you should ensure to maintain a logic that you
applied once for a type to each object of that type in the workarea. This allows you to combine several types in
each structure level achieving parallel information layers to be added for example to a project.
Example:
A group "Formatting documents" might have the following types providing different information layers for
different use cases.
Type
Input field
Text
General
Title
Formatting in documents
Short description
It's happened to everyone.
An important document has to be
read quickly and its content
captured. However, the document
is poorly formatted or not
formatted at all - logical
correlations disappear because
there are no paragraphs or
headings while a lack of visual
information in the body text makes
comprehension difficult for the
brain.
Description
Well-formatted documents are
easier to read and their message is
clearer for the reader. But what do
you need to keep in mind if you
want to format and structure a
document so that it is easy to
read? The projects shown in this
area...
202
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Text Units
Type
Input field
Text
Task
Title
Formatting in documents
Short description
Create a formatted, easy to read
document.
Description
Create a document that uses the
formatting described and is thus
very easy to read. The document
has to be at least 20 pages long
with 30 chapters. Pay special
attention to creating header levels
to maintain a well-structured
content overview.
Title
Formatting in documents
Short description
On today's job market, being able
to format documents is a must.
Description
In an increasingly digitalized
working world, employees who
were not previously affected are
now being required to create
structured documents This affects
the building superintendent who
has to design notices for the
bulletin board as well as the
carpenter who wants to present his
work.
Title
Formatting in documents
Short description
A lot of information has already
been published about formatting.
Description
Formatting documents has already
been discussed and analyzed in
many places. In the following
section, you can find a selection of
recommended books and
websites:
Concept
Reference
SAP Workforce Performance Builder 9.3
Text Units

...

...
Customer
© 2014 SAP AG. All rights reserved.
203
8.3
Sample applications
You may adapt the use of text units and their types individually to your structure and your content model. Here
are some examples of using text units:
Additional information levels
You can use text units to provide your learners with additional extensive information in the form of comments (2)
or several chapters of extended documentation (1) for the structure display in the trainer. This makes it possible
for you to convey processes and process-relevant knowledge/understanding without having to make extensive
changes to project contents.
Separating information levels
You can create an additional level in your structure of dynamic learning content that, even though it follows the
structural model, is independent content-wise and displays different information for another target group. This
way, your structure can contain, for example, the didactic content for your learners as well as instructions and
information for other groups of people. After all content is complete, you can publish the learning content as usual
but also simultaneously generate a document about the steps to be followed, send it to all department heads in
your organization, thus making it possible for them to answer individual questions.
204
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Text Units
Combining information levels
The two previous examples can also be combined to show or update additional information for learners (2) and
other target groups (1) in a structure.
Customizing referenced content
Referencing makes it possible for you to always use the same object in different branch structures. The advantage
here is that content only has to be updated once. If you now, however, want to address different learning groups
using different branch structures, you have to clear the previous reference to import different descriptions or
instructions into the original references. Using text units makes it possible to add branch-specific instructions and
problems without having to dispense with the convenient added value of object referencing.
SAP Workforce Performance Builder 9.3
Text Units
Customer
© 2014 SAP AG. All rights reserved.
205
Object/topic-related display of information
Text units can also be used for additional object or branch-related information by means of additional
documentation types when creating the learning content. You can find three examples of how to use text units as
"notes" in the following section.
1.
Exact definition of requirements for the recording at the respective location
2.
Instructions for dealing with the respective component
3.
Goals agreed in the curriculum
206
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Text Units
9
Documentation
Documentations can be generated for different content types in different formats. This allows it to use
documentations additionally to other content types in a compact and printable format.
In the Producer it is possible to generate documentations for the following contents:

simulation projects

quiz

books / book pages
The supported formats for the generation are:

Word

PDF

PowerPoint

HTML
The documentations are differentiated into the types:

single document

master document

compound document
9.1
Requirements for documentation
The following requirements are necessary for the creation of documentations in the Word, PowerPoint and PDF
format.
File formats for Microsoft Office
The documents are generated in these formats depending on which version of Microsoft Office is installed:

Office 2003: doc/ppt

Office 2007 and 2010: docx/pptx
If you want to create the documents in the old format, activate the following option:
o
for single and master documents in the central configuration dialog (menu Tools -> Settings...) under
Standard -> Settings -> Documentation: Use old Office formats
o
for the compound document in the dialog when creating the document for Word with the option: Use old
Office format
Prerequisites for PDF documents
The supports PDF documents generated with MS Word versions 2007 and 2010.
While Word 2010 contains the standard settings for generating Word documents in general with the , for Word
2007, you must first install an additional add-in Microsoft Save as PDF in order for this feature to work properly.
This add-in can be downloaded from Microsoft's official website.
SAP Workforce Performance Builder 9.3
Documentation
Customer
© 2014 SAP AG. All rights reserved.
207
9.2
Documentation Settings
The structure of a document follows a predefined model. To individually customize a document, you can define
the structure and content to be inserted. There are numerous configuration parameters that influence the
appearance of documents specific for each type and format (based on fragments).
Managing documentation settings
The documentation settings are a resource type. This means you can manage individual settings and use them in
different workareas.
The documentation settings are summarized in the area Documentation Settings of the Central Configuration
Dialog. Alternatively the settings can be configured by choosing Resources -> Documentation Settings in the
project explorer menu.
In addition to the standard settings, you can create further settings by duplicating an existing setting and using it
as a base type:
1.
Open the Documentation Settings section of the resource tree.
2.
Select a documentation type to be used as a base type. For example, Standard Documentation.
3.
Click Duplicate… in the object editor.
4.
A settings dialog box opens. Enter a name for the setting.
5.
Confirm the dialog with OK to create the new setting.
Note
The Standard Documentation setting cannot be deleted because it is the basic setting resource of the
Producer.
9.2.1
Selecting documentation templates
The documentation templates for generating Word and PowerPoint documents are part of the Documentation
Style resource. An overview of the available templates are availabe in the chapter Documentation Templates.
Selecting a documentation template
The templates can be individually set for every documentation type on the relevant settings page.
To select the documentation templates, proceed as follows:
1.
Click on the Edit link… button next to the Template setting.
2.
A dialog appears that shows the workarea structure. Select a template from the Documentation Style
resource.
3.
Confirm the dialog by clicking on OK.
Master document:
You can configure the template for a master document in the settings dialog when generating a master document.
208
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Documentation
Integrating user-defined templates
If you would like to insert your own document template, proceed as follows:
1.
In the project explorer, open the Resources -> Adaptable Resources -> Documentation Style area.
2.
Click on the Insert file… button in the object editor toolbar.
3.
Select a documentation template.
4.
Confirm the dialog with Open.
If you want to remove a template from the workarea, select the template and click the Delete button.
9.2.2
Basic Settings and Fragments
The main settings for documentation are:

Base Type:
Defines the base type for the selected settings. This is defined when the documentation is created and cannot
be changed afterwards.

Name:
Defines the name of the selected settings.

Template:
Defines the documentation template used to generate the document.

Style:
Defines the documentation style used to generate the document.
The fragments determine the basic structure of the document:

Description:
Inserts the description of the project.

Title:
Inserts the title of the project.

Process flow:
Inserts the process flow for the project.

Table of contents:
A drop-down list appears here where you can specify the depth of the table of contents.

Project content:
This fragment inserts the content of the project.

Book page:
This function inserts a book page in the documentation. Choose Edit link... to select a book page.

Text unit:
This function inserts a text unit in the documentation. A text unit can be selected using Edit link...

Revision entry:
This selection defines where the content from the Revision Entry macro is placed. The relevant macro has to
be inserted into the project beforehand.

Input values:
This selection defines where the content from the Input values macro

is placed. The relevant macro has to be inserted into the project beforehand.
SAP Workforce Performance Builder 9.3
Documentation
Customer
© 2014 SAP AG. All rights reserved.
209

Blank line & break:
This fragment makes it possible to separate fragments using spacing and thus provide considerably more
structure.
o Page break
o Small blank line
o Medium blank line
o Large blank line
9.2.3
Subcategory Settings
Settings for specifying the selected content can be made in the various areas. Not all areas are available for all
documentation types.

Action Table:
Includes settings for the structure of the action table. See the relevant chapter.
Only BPP Document, Audit & Compliance Document

Screenshots:
Includes settings for the size, style and quality of screenshots.

Markers:
Includes settings for the style of highlights and arrows.

Numbering:
Includes settings for the structure and style of numberings.

Project Content:
Includes settings for specifying project content.

Included Objects:
Includes settings for specifying content included as fragments.

Quiz:
Includes settings for the display of quiz items.
only Standard Document, Work Document

Revision History:
Includes settings for specifying Revision Entry macros as revision history.

Input Values:
Includes display settings for input values of interactions.
9.2.4
Subcategory: Quiz
The quiz settings are available for the documentation types standard document and working document.

Show Quiz
The setting specifies if quiz items are displayed in a documentation.

Print solutions
This setting allows you to generate the solutions for the quiz items. This means you can differentiate between
210
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Documentation
a document intended for the examiner with all the correct answers and a document for the person being
examined without any of the answers.
9.2.5
Subcategory: Action Table
Specific settings can be defined for the documentation types BPP and Audit & Compliance document. There is an
additional sub-section called Action Table available with the relevant settings.
Defining the action table
The structure and content of the table can be defined to insert the explanations of the actions. A total of 5
columns can be defined as follows:

Hide Screens:
The Hide Screens option allows you to set up the screenshots display in the Screen macros.
If the option is activated you are provided with a screenshot and a table below containing all available actions
of the step.
If the option is deactivated, a serial table containing the actions is displayed. The single steps are numbered
consecutively.

Action Table:
This option specifies whether the actions are displayed as a table or as text only using a step by step
approach. If the 'table' setting is selected, you can define the table columns and content.

Table Width:
Defines the width of the Action Table in pixels.

Column 1 - 5: Content:
Defines the column for the information extracted from the macro and displayed in the documentation. When a
table is generated, the column name will be displayed in the relevant project language based on the content
glossary.
The column can also have a title allocated to it, which can be entered manually in the document.
Content
Explanation
Hide Column
Hides the column.
Numbering
Creates sequential numbering for the actions.
Text from Demo bubble / Practice bubble
Texts from the Demo or Practice bubbles of the
actions
Field name
Contains the field names of the actions
Value
Contains the entered value from the macros Text
entry, Single Text entry, Single choice.
ROC
Contains the ROC value defined for the entry macros.
Description
Contains the description defined for the entry macros.
Result, OK, Comment, Reference
Empty columns for manual creation of contents.

Column 1 - 5: Width (%):
Defines the width of the column as a percentage of the total width of the table.
SAP Workforce Performance Builder 9.3
Documentation
Customer
© 2014 SAP AG. All rights reserved.
211
9.2.6
Compound document settings
There are a variety of settings available for compound documents to assist you in defining the content to be
generated. The settings displayed here depend on the type of content that is available for the selected object. In
general, for every object type you can define whether it should be included in the document and how it should be
displayed.
Groups

Insert groups

Group description
Text units

Name

Description
Projects

Insert projects

Documentation type
The description for single documents corresponds to the fragments and cannot be disabled from a central
location.
Books

Insert books

Book description

Book page description

Book page format
Book pages

Maximum image width

Links

Background image
Output options

Include Hidden Objects
When this option is enabled, hidden documents will be added to the compound document. When this option is
disabled, hidden documents will be ignored and will not appear in the documentation.

Short description

Use old Office format
When this option is activated, documents are still generated in the doc format when Office 2007/2010 is
installed. If the option is deactivated, the docx format is created.

Template
This setting defines the template to be used for the Word and PDF documents.
9.2.7
Customizing Documentation Naming
The object names of generated documents are by default the names of the relevant document types. Duplicated
documentation settings use the defined name of the resource and do not have different content languages.
212
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Documentation
You can change document naming and add different languages. This can be done in the entity file of a
documentation setting resource. The entity file is an xml file that is available for each object in the workarea folder
structure. It contains general attributes for object administration.
Adapting the entity.xml
Proceed as follows to adapt the file:
Note
To customize naming in the entity.xml, you should have basic knowledge of editing XML files.
1.
Open the Documentation Settings tree in the Resources -> Adaptable Resources in the project explorer.
2.
Select the required resources or duplicated resources; click the right mouse button to open the context
menu.
3.
Click on the menu entry Open Folder.
4.
Open entity.xml in an editing program, for example notepad.
5.
Edit the file and enter your new naming.
6.
Save and close the file.
7.
Restart the Producer.
Now you can generate your documents with the new naming.
XML structure
Example of the XML structure:
Note
Only change the attributes mentioned here; otherwise errors may occur in resource administration.
<doc_settings created_by="author_name" creation_time="date_time" caption="work_doc"
version="resource_version" sub_type="document_type" cwa_recommended_sync_mode="synchronization">
<Language name="1031">
<Text name="work_doc">Arbeitsdokument</Text>
</Language>
<Language name="1033">
<Text name="work_doc">Work Document</Text>
</Language>
...
</doc_setting>
For each language, insert these attributes:
<Language name="language code">
<Text name="caption name">Document name</Text>
</Language>
An overview of the content languages and required language codes is available in the chapter Overview content
languages.
SAP Workforce Performance Builder 9.3
Documentation
Customer
© 2014 SAP AG. All rights reserved.
213
9.2.8
Documentation for Right-to-Left Languages
An additional Documentation Style (Right-to-Left) resource is available for creating documentation for content
with right-to-left languages. The resource is similar to the standard Documentation Style but includes right-to-left
adaptations in the templates. Further adaptations to templates can be performed individually. The resource is
located in the Adaptable Resources tree of the project explorer.
The following documentation formats are supported for right-to-left languages:

Microsoft Word

PDF

HTML
Note
The generation of Microsoft PowerPoint files is not supported for right-to-left text direction. The
documents have to be edited afterwards.
Requirements
To edit documentation in Microsoft Word, you need to activate a right-to-left language under Editing Language
and Keyboard Layout in Microsoft Office.
Note that in some situations, the activated right-to-left editing language can influence the direction of the table of
contents. If this is the case, you need to change the table of contents manually. Alternatively, remove the right-toleft editing language and generate the documentation again.
Activation
The resource Documentation Style (Right-to-Left) can be set individually for each document in the Documentation
Settings. The documentation settings are available in the Documentation Settings area of the central configuration
dialog box and in the Resources -> Documentation Settings area of the project explorer. Further information is
available in the chapter Selecting document templates.
9.3
Generating single documents
After a process has been recorded and the project edited, documentation can be generated. At least one Screen
macro and one interaction should be available for this purpose for capturing a result in the documen t.
You also have the option of designing your documentation using documentation macros. This allows you to
incorporate additional information.
To create a single document, proceed as follows:
1.
In the Project Editor, open the project for which you would like to create a single document.
2.
If you want to generate a Word document, you should first define a Headings Level for organizing the
headings. This is to be set up in the documentation settings under Documentation Settings -> Project
Content.
3.
Commence generation by means of the Documentation menu or in the toolbar by means of the corresponding
document type button:
214
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Documentation
o
Generate Word Document
There are various document types available for Word documents. Select from the menu the type you
would like to create.
o
Generate PDF Document
There are various document types available for PDF documents. Select from the menu the type you
would like to create.
o
Generate HTML Document
There are various document types available for HTML documents. Select from the menu the type you
would like to create.
o
Generate PowerPoint Document
The generated document is now displayed in the corresponding project in the Project Explorer and can be
launched from that location.
Recommendation
Various settings can be made which affect the document display when the individual document is
created. You can find more information in the section on configuring the individual document.
Note
In order to generate a PDF document, first refer to the prerequisites listed in the section above on
Requirements for documentation.
9.3.1
Types of Single Documents
There are different document types available for Word, PDF and HTML documents. The types are:

Standard
This document is not intended for a special use case and shows all project information incl. documentation
macros (i.e. such as step names, actions, advice, screenshots) that are not special prepared.

Job-Help
The document supplies a short and clearly structured project overview with step names and actions to be
carried out. The document does not contain any screenshots, documentation or explanation macros and is
thus ideally suited for practical use of an application.

Training Document
When generating a training manual, all relevant project information, including documentation macros (e.g.,
step name, actions, notes, screenshots…), will be automatically exported and formatted accordingly. This
type of documentation is ideal for supplementing training materials for learning processes.

Test Sheet
This document adds a table that is suitable for testing the user's experience. It is possible to make an inquiry
about actions, inputs and the expected results of the respective step. Also, the tutor has additional fields for
evaluation of the deliverables.

Work Document
This document supports the editing of projects and gives an overview about project details, its execution and
content. To do so, steps, screenshots, scores, task description, notes and the project language are read out.
SAP Workforce Performance Builder 9.3
Documentation
Customer
© 2014 SAP AG. All rights reserved.
215

HPQC Document
The Producer allows you to create documentation for the HP quality center. Recorded processes can be
defined as a quality standard and imported into the HP quality center.
The macro for the HPQC Header can be inserted into the document, which contains a directory path and a
description. The document contains a table with the individual actions listed as well as a column for manually
editing the results.

Process Guide
This document explains processes in a clear and simplified manner. Its user-friendly and visually appealing
layout makes it easy for the users to follow. There are three columns which display the following information:
o What to do – Text in demo bubble
o What to see – screenshot with highlights
o What to say – explanations, macros for notes and tips, etc.

BPP Document
The BPP document (Business Process Procedure) allows you to use recorded projects for describing and
illustrating business processes in an SAP environment in greater detail. A unique macro structure is created
with specific instructions for the documentation’s properties, modifications, headings, and descriptions. It is
also possible to create a customized table to illustrate the process steps.

Audit & Compliance Document
The purpose of this document is to verify and ensure compliancy with certifications and audits. Its “generic”
format can be customized to meet your specific requirements. A unique macro structure is created with
specific instructions for the documentation’s properties, modifications, headings and descriptions. It is also
possible to create a customized table to illustrate the process steps.
9.4
Editing single documents
Documentations can be edited on different ways:

Specific settings in the macros

Insert of documentations macros

Central settings for documentation
9.4.1
Documentation Macros
Aside from the macros that are solely used for the recording of projects, there are also additional documentationspecific macros. These are necessary for the recording of additional information useful for the later creation of
documentation.
You may select the documentation macro you desire in the menu Documentation -> Insert Documentation Macro.
It is inserted after the selected macro in the Producer thumbnail view.
This enables you to insert further headlines, text sections, screenshots or page breaks.
The description of the individual documentation macros and their functions can be found in the corresponding
section of this manual.
216
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Documentation
9.4.2
Macro Parameters
All interactions as well as the Page macro, have the parameter Show in Documentation in the Subcategory
Documentation. This option is activated after the recording. In the event that you do not want to use a screenshot
or an action in the documentation, this option may be switched off.
Examples of use

If the standard text from the project is not to be used in a step, such as entering the password, but the
password rules be set out in detail for example, then the Input Text macro in Show in Documentation option
may be deactivated for the Input Text macro recorded for this action and the documentation macro Highlight
inserted. The divergent text can then be captured there.

When an application is being recorded, it makes no sense using a dedicated screenshot for each step. Instead
you should depict actions that fundamentally relate to the same input screen on the same page on a single
screenshot in the documentation. In this case only the first screenshot in the corresponding Page macro
would remain with the option Show in Documentation in any Page macros that may follow being deactivated.
All actions are always automatically displayed on the last preceding screenshot in which the option Show in
Documentation is activated.
The Screenshot Position parameter, which can be accessed via the expanded view, applies to the screenshot in
the last preceding Page macro. This defines where the markers are to be positioned on the screenshot.
If a marker is not correctly positioned on the screenshot, then its parameter does not have to be directly edited; it
can be revised using the function Document Highlight in the macro editor.
The dimensions and cropping of screenshots can be adjusted in the Page macro. The original screenshot remains
unaffected. The part of the image used in the documentation can be revised as follows:

The displayed image size in the documentation can be changed by adjusting the corresponding parameter.

The image layout can be adjusted using the function Manual Crop.
SAP Workforce Performance Builder 9.3
Documentation
Customer
© 2014 SAP AG. All rights reserved.
217

The Step Name parameter is used as the heading before the screenshot. If no heading is to be inserted before
a page the option As Heading in Documentation must be unchecked.
9.4.3
Process Flow
The process flow provides a visualized overview of the recorded project, its steps and sequence. It clearly shows
the most important components of a step in a brief overview.
The process flow helps orient learners about which action steps take place at what point in the process when
working with a document.
The process flow can be generated for Word documentation and, if needs be, can also be edited at a later date. A
process flow is not generated for the Job Help Word file because this already contains a tabular overview of the
working steps.
Design of the process flow
Each step is shown in its own individual field in the process flow. These show the step name, the screenshot of the
Page macro as well as the Field Name of the action.
If a action does not have a Field Name, the Producer will automatically insert the relevant Field Icon.
The individual fields of the steps are linked to one another with arrows, which make clear the progression. Should
there be a page break, a bending arrow is inserted instead of a straight one.
Note
The picture files in the Field Icon are not scaled when being shown in the process flow. For this reason you
should make sure that these pictures are not too large. Here, it is recommended that you enter a Field
Name so that it is shown in place of the Field Icons in the process flow.
The start and end macro of the Form Structure or from branches as well as the Simulation Start and Simulation
End macros are not shown, but only the steps.
Documentation macros contained within a project are also not inserted into the process flow, as they are only
used in the design of the documentation and are not relevant to the process as a whole.
Settings for the process flow
The process flow can be shown individually for the documentation of a project. The setting is made in the central
configuration dialog as a fragment for the respective documentation type. You can determine the position for the
process flow here.
Every step of a project is shown in a process flow. Steps can also be individually deactivated for output if they are
not to be displayed in the process flow.
In this case, select the corresponding Page macro. Then deactivate the Show in Process setting in the
Subcategory Documentation of the macro editor.
Picture files of the arrows
The arrows of the process flow can be found in the resource Documentation Style. Both the straight arrow
(arrow.bmp) and the curved arrow (arrow-long.bmp) are located here.
These graphics can also be replaced with other pictures from your own library. You should ensure that the names
and sizes of the picture files remain the same.
218
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Documentation
9.4.4
Heading Levels
When generating a master document, the project and group structure in the project explorer is transferred to the
document and displayed as headings and a table of contents.
In order to render the numbering of the various headings correctly, the outline level of the project and step titles is
to be defined for each project before being generated as a single document. To this end, a Heading level is defined.
The required level is to be decided from the level of the project in the Project Explorer’s tree structure.
This value needs to be stipulated as the Producer does not differentiate the level at which the project resides nor
whether it is located in a main or sub folder when issuing single documents. Moreover, it is possible that only
certain projects are issued and that the heading levels vary as a result. This may be the case, for example, if only
the projects in a subordinate group folder are considered. The Heading levels can make this explicit.
Depending on the Heading level, the project and step titles are assigned to the relevant heading template in the
Word template when a document is issued. These are predefined for the various numberings and outline levels.
9.4.4.1
Setting the Heading Level
Heading levels for a single document
The Heading Level is to be defined in the documentation settings in the area Project Content with the Heading
Level parameter.
In a single document the structure is created with the project title and its steps. This yields a two-tier outline
structure.
To define a structure with the project title on the first heading level and its steps on the second level requires the
heading setting to be set to 1. The value 1 is to be used as a matter of course if a single document is not intended
for inclusion in a master document.
Example:
1 Project name
1.1 Step name
1.2 Step name
1.3 ...
Heading levels for a master document
When generating a master document, the Producer issues the group and project structure from project explorer.
A three-tier outline structure is formed comprising the group, project and step titles.
Before work can be begun on generating the master document, the group and project structure needs to be
defined in the project explorer. This is crucial for the layout of the master document.
The heading levels given to the single documents can be inferred from the structure.
Example:
1 Group name
1.1 Project name
1.1.1 Step name
1.1.2 Step name
SAP Workforce Performance Builder 9.3
Documentation
Customer
© 2014 SAP AG. All rights reserved.
219
1.1.3 ...
1.2 Project name
1.2.1 Step name
1.2.2 ...
Each project envisaged for the master document is then issued as a single document. Define the relevant Heading
level for each project before proceeding with generation.

A project that is assigned to a group located on the first level is to be found on the second level. So that the
headings in the single document began at that level, the setting must be set to 2.

If a project that resides within a subgroup in the Project Explorer is to be issued, then the Heading level should
be set to 3. The numbering then starts on level 3.

For greater project or group depth, the Heading level setting needs to be increased accordingly by the
appropriate depth.

If a project is not assigned to any group or if it resides at main folder level, then the Heading level is to be set to
1.
Note
The headings are capped at 9 in the document templates as only nine levels of numbering can be set up in
Word.
The highest setting for a Heading level should therefore be 8. That means that the project titles receive a
level 8 number and the steps, level 9. Therefore ensure that your project structure has a depth not
exceeding eight levels.
9.4.5
Process documents
In the Producer different documentation types are available for process documents according to certain criteria.
These documents are:

BPP document
The BPP document (Business Process Procedure) allows generating files of recorded projects for a more
detailed description and demonstration of business processes.

Audit & Compliance document
The document supports the verification and compliance of certified working processes.
Generating documentations
The documentation types BPP and Audit & Compliance documents can be generated in Word, PDF and HTML
formats. In order to create one of these documents a certain procedure is required. This should be done as
follows:
1.
Set up configurations in the documentation settings for the type
2.
Insert macros for the documentation type
3.
Edit inserted documentation macros
4.
Define ROC value and description in the interactions
5.
Generate the documentation
220
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Documentation
9.4.5.1
Documentation macros
Predefined documentation macros can be inserted for the documentation types BPP and Audit & Compliance
documentation. This is done in the Documentation -> Insert BPP Macros or Insert Audit & Compliance Macros
menu. The macros are inserted automatically during the first and last step.
The documentation macros are predefined default settings and can be customized after insertion.
9.4.5.1.1
BPP macros structure
In order to create a BPP document the particular BPP macros can be inserted in the project via the Insert -> Insert
Documentation Macro -> Insert BPP Macros function.
The structure of the BPP macros is as follows:





Macro Document Properties
Macro Revision Entry
Macros Description with titles.
1.
Overview (1st level title)
2. Purpose (2nd level title)
3. Business process overview (2nd level title)
4. Input data (2nd level title)
Macro Input Values
Macro Description with title Procedural Steps (1st level) for the actual cycle.
The process follows afterwards.

Title and text for scenarios associated with the process: Results / Related Scenarios
(in the last step)
In the macros with titles the titles and texts can be modified or texts can be added.
9.4.5.1.2
Audit & Compliance macro structure
In order to create an Audit & Compliance document the particular Audit & Compliance macros can be inserted in
the project via the Insert -> Insert Documentation Macro-> Insert Audit & Compliance Macros function.
The structure of the Audit & Compliance macros is as follows:




Macro Document Properties
Macro Revision Entry
Macro Page Break
Macros Description with titles (1st level title). Explanations can be inserted.
SAP Workforce Performance Builder 9.3
Documentation
Customer
© 2014 SAP AG. All rights reserved.
221
1.
2.
3.
4.
5.
6.
Purpose
Scope
References
Definitions
Document contents
Steps
In the macros with titles the titles and texts can be modified or texts can be added.
9.4.5.1.3
Predefined document properties
The Document Properties macro allows allocating predefined variables of a document template to a particular
content.
The predefined variables define the macro when the BPP or Audit & Compliance macros are inserted
automatically.
The template for the particular document type within the Producer contains the following variables:
BPP document properties
Name
Value
_bpp_id
ID
_bpp_owner
Author
_bpp_status
State
_bpp_description
Description
Audit & Compliance document properties
Name
Value
_ac_title
Title
_ac_docnumber
Document number
_ac_versionnumber
Version number
_ac_effectivedate
Effective date
_ac_requestedby
Requesting person requested by
_ac_approvedby
Approving person approved by
Assigning contents to variables
In the Document Properties macro the field Name and the field Value are available for a variable. Insert the content
that is to be generated into the Value field.
Note
Note when generating a HTML document the variables of the Document Properties macro cannot be
executed in HTML as these field functions are Word specific.
222
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Documentation
Note
The Document Properties can only be output for single documents as they relate to the corresponding
document templates. Avoid the use of this macro in a master document for this reason.
9.4.5.2
Settings in simulation macros
For some simulation macros which require an entry or a selection from the user additional information for the
action tables of the BPP and Audit & Compliance documents can be added. These settings can be found in the
documentation subcategory of the macro editor for the Input Text, Select Single and Radio/Checkbox macros.
In order to display the description and the ROC value in the action table a column has to be defined for it in the
central settings.
The following settings are available:

ROC (Required/Optional/Conditional)
The value defines the necessity of an action, whether it is required (R), optional (O) or conditioned by
something (C). The particular type can be selected in the choice box of the option and the character R, O or C
is displayed accordingly in the table.

Description
Additional information about a macro can be provided in the description field.
9.5
Compound Document
A compound document summarizes all of the content from one workarea into one document. Whereas a
centralized document only contains content from projects and groups, a compound document also includes the
following possibilities:

Groups

Text units

Projects

Books

Book pages
Note
When generating documentation, note that not all types of objects can be exported into the
documentation. Audio, video and animated objects cannot be used in this case.
SAP Workforce Performance Builder 9.3
Documentation
Customer
© 2014 SAP AG. All rights reserved.
223
9.5.1
Generating the Compound Document
To create a compound document, proceed as follows:
Make any adjustments in the documentation settings of the compound document for your documentation.
1.
Select the start object of the content structure - group or book.
2.
Go to Documentation -> Generate Compound Document...
3.
A dialog box with the following settings will appear.
o Start from
This defines the starting point for generating the document. The selected object will be displayed here.
You can select a different object by clicking on Edit link…
o Settings
This defines the resource of the documentation settings.
o Output format
This defines the format for your document: HTML document, Word document or PDF document
4.
Confirm your changes by clicking on Ok. The documentation will now be generated automatically.
Note
The heading level is automatically set in the document based on the structure level and the single
documents for projects are generated independently. The heading level option therefore does not have
any effect.
9.6
Master document
The various documents in the entire workarea or a specific selection of them can be merged into a master
document. This document is generated from within the Project Explorer view in the Producer and can be created
in Word or PDF format.
Preparations for creating a master document
The following preparations must be made for creating a master document:

Before you generate the master document, make sure you have created your individual documents with the
right header level so that the outline of the documents in the master document can be properly displayed.

If you want to insert the documents into the master document without descriptions and titles, this information
must be deactivated already when you generate the individual documents.

You can change the format template for the master document in the master settings under Documentation.

You can deactivate documents that you don't want to include in the master document using filters or the Hide
function.
224
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Documentation
9.6.1
Generating the master document
To create a master document, proceed as follows:
1.
You can create a master document for either the entire workarea or an individual selection. To do this, the
respective group is to be selected in the tree structure or defined in the dialog for creating the master
document
o
To create a master document for the entire workarea, the Content group at the top of the tree structure of
the Project Explorer must be selected.
o
To create a master document for a special group, this is to be selected in the tree structure. Then only the
individual documents within the group are included.
2.
Select the Documentation -> Generate Master Document... menu.
3.
A dialog opens where you can define your master document. Make the settings you want.
You can find explanations about the dialog in the section on settings for the master document.
4.
Click the Ok button to confirm the dialog. The document is generated.
After creation, the master document is inserted at the bottom of the tree structure and can be opened from
there.
See the respective section for information on displaying the master document in Word.
9.6.2
Settings for the master document
The following settings can be made in the dialog for generating a master document.

Starts from:
This selection determines the point in the tree structure starting at which the documents are to be output to
the master document. This lets you create a master document for a specific group. The object selected in the
tree structure is automatically displayed in the setting.
If another starting point is to be selected, this can be done using Edit link... A dialog opens where an object can
be defined in the tree structure. Confirm this by clicking Ok.

Type:
This selection determines the documentation type for the master document.
Keep in mind that book documentation is always generated as standard documentation.

Format:
This selection defines the format the master document is to be created in: Word, PDF or both formats

Insert individual documents:
Which content is to be output to the master document can be defined in this area.

o
Projects
o
Books
o
Book Pages
o
Other Documents
The setting adds Word documents imported to the workarea to the master document.
Include Titles and Descriptions:
Whether titles and descriptions are to be output for the content can be defined in this area. They are not
included if this option is deactivated. With the exception of the project, the title and the description are always
inserted together for other objects because fragments can be defined for projects.
SAP Workforce Performance Builder 9.3
Documentation
Customer
© 2014 SAP AG. All rights reserved.
225
o Project title
o Project description
o Group
o Book
o Book Page
o Text Unit
Note
If you don't want to insert titles and descriptions, these must be deactivated already when the individual
documents are created. For more information, see also the sections on configuring the individual
documents and book documentation.
9.6.3
Displaying the master document in Word
Once the master document has been opened in Word, it is displayed with its cover page, table of contents and
linked single documents.
Displaying single documents
When generating the master document, the single documents are not attached directly but shown as a link. You
can have these shown in the master document:
1.
To do so, select the Outline view to be able to continue editing the document. The Show Document option is
also to be activated for Word version 2007 and higher.
2.
Then click on the Collapse Subdocuments button in the toolbar.
Attaching single documents
The presentation of displayed single documents is not stored in the master document. You will get the links back
when you reopen the document. Further editing steps are required in order to obtain a complete document
incorporating the single documents.
Note
It is recommended that you only proceed with incorporation once the editing of your master document
has been fully completed and it is ready for publication. This will avoid duplication of effort in the event of
any additions where you will have to repeat these steps.
1.
Activate the Outline view and click the Collapse Subdocuments button (see above).
2.
You will find a document icon in front of each single document. Click on it to select the associated single
document. This process will only ever allow you to select one document.
3.
Now click on the Remove sub document button in the toolbar. The document has now been incorporated.
4.
Repeat items 2 and 3 for each additional single document. You can then switch to the Print preview (or
another view).
After the single documents have been incorporated, you should resave the document so that the original Master
Document is still available.
226
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Documentation
9.7
Documentation Templates
Documentation templates are used to generate Word, PDF and PowerPoint documents. The templates are stored
in the Documentation Style resource in the Adaptable Resource section of the project explorer. The resource
Documentation Style (Right-to-Left) contains the same templates with support for right-to-left languages.
The following file formats are supported:

.dot and .dotx for Word and PDF documents

.pot and .potx for PowerPoint documents
A workarea includes the following standard templates:
File Format
Document Type
Template File
Word / PDF
Single Document
neutralNoToc.dot
Single Document with Title
neutral_cover_NoToc.dot
Master Document
neutral.dot
Process Guide
neutral_demoscript.dot
BPP Document
neutral_bpp.dot
A&C Document
neutral_ac.dot
Power Point
neutral.pot
PowerPoint
Integrating a template
If you would like to insert a documentation template into a workarea, proceed as follows:
1.
Select the Documentation Style resource in the project explorer.
2.
Click on the Insert file... button in the object editor.
3.
This will open the file selection dialog box. Select the required file.
4.
Click on Open.
The template will now be integrated in the Documentation Style and can be used for generating documentation.
Copying a template
If you want to create your own template, it is recommended that you use an existing standard template as a
preset. To do so, proceed as follows:
1.
Open the context menu by right-clicking on a template in Documentation Style structure. The docstyle folder
opens.
2.
Open the dot folder.
3.
Copy the needed template to a separate folder and rename it.
Once you have adapted a template, import the file using the project explorer. Do not paste the file directly into the
dot folder, because the file will not be recognized by the resource structure.
SAP Workforce Performance Builder 9.3
Documentation
Customer
© 2014 SAP AG. All rights reserved.
227
9.7.1
Editing a Word Template
For Word templates you can edit the layout and the text styles.
Go in to the folder of your copied .dot file. Open the template in Word by right-clicking the file and clicking Open in
the context menu.
Note that changes in the page setup could affect the complete layout. We recommend that you test templates
after creating them.
Edit background
The background of a template is defined using the Header & Footer view. Double click the header or footer area to
change the view. You can then change the images and texts of the header and footer area.
Edit text styles
Text styles of the content use the same style defined in the text style editor. In the document templates, we
recommend that you only adapt the template-specific styles, for example, header and footer texts.
The used default text styles are:

Body

Headings

_Cover_Subtitle

_Cover_Title

_Title_Header

Footer
Recommendation
If you want to adapt a Word template for a document type, it is recommended that you adapt all
templates to have a consistent design in all documentation.
9.7.2
Editing a PowerPoint Template
PowerPoint templates in general are used to create documentation for simulations. When the document is
generated, the content is inserted with the bubble texts on the left side and the screenshots on the right side of a
slide.
Open the folder of your copied .pot file. Open the template in PowerPoint by right-clicking the file and clicking
Open in the context menu.
The adaptation possibilities for PowerPoint templates are limited. In general only the layout should be edited. The
adaptation can be done in the Slide Master.
Template components
A PowerPoint template includes two text fields:

228
Master title styles
The text field defines the position of the included content from the top
It is recommended that you leave the content position unchanged. If it is necessary to change the position,
then move the text field horizontally.
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Documentation

Master text styles
The text field defines the text style of the included content.
Highlight the texts in the text field. You can then change the Font settings in the Home tab.
Note that changes in the Master title styles could affect the complete layout. It is recommended that you test
templates after creating them.
Besides text fields, you can also adapt images as well as the header and the footer information of the template.
9.7.3
Explanation Icons
The explanation icons are used for explanation macro types in a simulation. To customize images, replace the
default images with your own images.
The images have the size 80x80 pixels and are in BMP format.
You can adapt the explanation icons of the simulation playback in the trainer Style additionally.
Type
Icon
Info
Remark
Tip
Warning
Replacing an image
This is necessary to assign the correct image file to the active explanation type.
To replace an explanation image in a workarea, proceed as follows:
1.
Select the icon file in the Documentation Style resource of the project explorer.
2.
Click on the Replace file... button in the object editor.
3.
This opens the file selection dialog box. Select the required file.
4.
Click on Open.
The icon is now integrated into the Documentation Style and can be used for generating documentation.
SAP Workforce Performance Builder 9.3
Documentation
Customer
© 2014 SAP AG. All rights reserved.
229
9.8
Special documentation fonts
If you would like to generate documentation using a special font for Asian character sets then you may need to
install this font on a temporary basis to avoid errors when displaying the document.
To do so, contact your administrator as administrator rights and your Windows system installation CD are
required for the installation.
To proceed with the installation, go to Start -&gt; Settings-&gt; System control -&gt; Regional and language options
in your operating system. Select the Languages tab and select the desired option under Additional language
support.
After clicking on OK the font will be installed from your Windows installation CD. You will find additional
information on the topic in your operating system's help.
230
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Documentation
10 Content Languages and Translation
The learning content is often used across locations in different countries and language regions and therefore
consists of multiple language versions. Therefore, consistent training material must be available in the relevant
languages. The following chapters explain how the content can be used in different languages and how to handle
translations.
10.1
Content Languages and Dictionaries
Each object in the workarea has an active content language. It is used to specify the included content's language
and to define the language for the interfaces of the trainer, library and book reader.For projects, the language
attribute defines the language of the text modules. Furthermore, when using filters you can define a language in
your search criteria. Each content language of the Producer is defined in the dictionaries.
You can select a content language when creating a content object using the Language parameter. The active
language of an object is displayed in the object editor.
Dictionary resources
The dictionaries are text resources of the workarea containing the content languages. The resource files are
located in the resource structure in the project explorer. There are two main dictionary types:


Playback Dictionary
The dictionary contains runtime texts for playback. These texts are the start & stop pages, the user interface
texts for the trainer bar, the book reader bar, the library and for the Navigator.
o
Navigator - includes the texts for navigation projects
o
Standard (Simulation) - includes the texts for simulation projects and books
Recording Dictionary
The dictionary contains the text modules of the content languages for the projects and documentation.
o
Simulation - simulation projects and documentation
o
Navigation - navigation projects
For the information on adapting dictionary texts, refer to the Customizing Dictionary Texts section.
View content language in tree
In the tree structure of the project explorer, you can show the content language of each object. This allows you to
see the language and sort the objects. There are two functions in the View menu:

Show Language - displays the language code

Show Language Icons - displays the flag icon of the language
SAP Workforce Performance Builder 9.3
Content Languages and Translation
Customer
© 2014 SAP AG. All rights reserved.
231
10.1.1
Generating Texts in Projects
During the recording or rerecording (only simulation) of a project, texts modules in different content languages
are inserted into the projects and thereby generate project content automatically.The text modules are part of the
content glossaries for simulation and navigation.
For simulation projects there are different texts for the Demo mode and the Practice mode. The texts in Demo
mode contain explanations to complement the simulation being demonstrated. The texts in Practice mode
contain clear instructions for users on what they should do to continue with the simulation.
For navigation projects there are one basic text type.
Translating text modules
When text modules are translated, the texts of a content language are replaced by those of the new language.
Text modules can be translated as follows:

Automated translation
With this function, you can change the content language of a project.
For further information, see the Automated Translation section.

Rerecording (only simulations)
With this function, you can change the content language and also record the application with the appropriate
language automatically.
For further information, see the Rerecording section.
Translate manually option
The Translate manually option indicates if the texts of macros with text modules have been changed. These texts
will not be replaced with another language during rerecording or automatic translation. When you export a
translation template, the texts are also exported.
The setting is available in interactions (Demo Bubble and Practice Bubble subcategory of the macro editor).
If a text needs to be translated, you can set the option Translate manually.
10.1.2
Overview content languages
The following table gives an overview about the available content languages:
Language Code
Decimal Value
Language
AR-SA
1025
Arabic
BG
1026
Bulgarian
CS
1029
Czech
DA
1030
Danish
DE-CH
2055
German (Swiss)
DE-DE
1031
German
EL
1032
Greek
EN-GB
2057
English (United Kingdom)
EN-US
1033
English (United States)
232
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Content Languages and Translation
Language Code
Decimal Value
Language
ES-ES
1034
Spanish
ES-CO
9226
Spanish (Colombian)
ET
1061
Estonian
FI
1035
Finnish
FR-CA
3084
French (Canada)
FR-FR
1036
French
HE
1037
Hebrew
HI
1081
Hindi
HR-HR
1050
Croatian
HU
1038
Hungarian
ID
1057
Indonesian
IT-IT
1040
Italian
JA
1041
Japanese
KO
1042
Korean
LT
1063
Lithuanian
LV
1062
Latvian
MS-MY
1086
Malay
NB
1044
Norwegian
NL-NL
1043
Dutch
PL
1045
Polish
PT-BR
1046
Portuguese (Brazil)
PT-PT
2070
Portuguese
RO
1048
Romanian
RU
1049
Russian
SK
1051
Slovak
SL
1060
Slovenian
SR-SP
2074
Serbian
SV-SE
1053
Swedish
TH
1054
Thai
TR
1055
Turkish
UK
1058
Ukrainian
SAP Workforce Performance Builder 9.3
Content Languages and Translation
Customer
© 2014 SAP AG. All rights reserved.
233
Language Code
Decimal Value
Language
VI
1066
Vietnamese
ZH-CN
2052
Chinese (Simplified)
ZH-TW
1028
Chinese (Traditional)
10.2 Translating Learning Contents
The Producer offers different possibilities for translating content. The main difference is between the translation
of text modules and the translation of manually created texts:

Translation templates – used for manually created texts of all content types

Automated translation – used for the translation of text modules in simulation and navigation projects

Rerecording – used for the translation of text modules in simulation projects and to record the interface in the
new target language
For further information, see the relevant sections.
Preparing for translation
The following steps are recommended as preparation for translation:

Translation should be done after creating and editing the source content, to ensure that all of the texts that
need to be translated can be edited fully.

Duplicate a content object before translating it, to ensure that the original content is not overwritten.

If you want to translate a project, first use the Automatic Translation function to translate the text modules.
10.3 Translating Using Translation Templates
The Producer provides the option of creating translation templates, to enable you to translate individual texts of a
project. All translatable texts are exported in a suitable format for translation. After translation the texts can be
imported into the Producer.
The translatable texts in the exported translation files are all manually created texts. In addition, it is possible to
export the text modules of the projects.
Translation templates
Translation templates simplify the translation process, as all texts can be accessed and edited directly. There are
two translation templates that can be used:

234
Microsoft Word
Translation can take place in the Word documents without any problems since the texts can be edited directly
without a translation program.
The translation file contains the texts as well as the identifying descriptions of the content objects. The
identifying descriptions are formatted in red and allocate a text to the corresponding content object. This
should not be changed.
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Content Languages and Translation
The available texts can be replaced using the translated texts. Delete the original text and replace it with the
required translation.

XLIFF 1.2
XLIFF (XML Localization Interchange File Format) is an XML-based format developed for generating texts for
translation from an application. This format is used especially for translation with the help of translation
programs.
The translation file contains the texts as well as the identifying descriptions of the content objects. To
translate texts using an XLIFF file, import the file into a suitable translation program.
10.3.1
Exporting a Translation File
The file can be exported from the project explorer, as well as for an individual content in the project editor or book
page editor.
To export a translation file, proceed as follows:
1.
Duplicate the source object and define the new language in the language parameter.
2.
Export the translation template by choosing Export Translation File… in the menu Tools -> Localization.
3.
Modify the settings in the Export Translation File dialog. Note that the Producer uses the ID of the object or
group as the file name.
For exporting translatable files, the following settings are available:
o
o
Format:
The settings define the format of the translatable text:
o
XLIFF 1.2
o
Microsoft Word Document
Structure:
The setting defines the export starting point in the tree. The objects below this point are exported.
o
All
o
Subtree
o
Current object
o
Combine in one file:
If you want to export several translatable files with this setting, you can combine them into one file. This
means you can reduce the number of translation files.
o
Only object information:
If you select this option, only the name, description and short description of the objects are exported.
o
Export generated project text:
This option also exports the generated project texts. This is useful for translators because the context of
the complete text is available.
o
Destination folder:
Specifies the folder for storing translatable files.
4.
Confirm the settings with OK to start the export.
5.
A dialog shows the export process. Confirm with OK once the export is finished.
6.
Afterwards a dialog box appears where you can open the exported translatable files or the destination folder.
The texts in the translation template can now be translated by the translators into the required languages.
SAP Workforce Performance Builder 9.3
Content Languages and Translation
Customer
© 2014 SAP AG. All rights reserved.
235
10.3.2 Importing a Translation File
Once translation is completed, you can now import the translated texts into the designated object or structure.
To import a translation file, proceed as follows:
1.
Open the project editor or the specific project in the project editor.
2.
Click on Import translation file… in the Menu Tools -> Localization.
3.
A dialog box opens. Choose your document and confirm it with Open.
The texts are imported and replace the original content.
Note
With Producer 9.1 exported translations files in Word format can't be imported into Producer 9.2, because
of changes in the ID format. Import the translation files by using a Producer 9.1 or export the translation
files with Producer 9.2 again.
10.4 Dictionary Editor
You can customize predefined bubble text modules and the texts used in the trainer; the Producer allows you
opportunity to edit these text files individually. That means that you can use terminology or sentences specific to
your own texts, which conform to your company's corporate language, or you can set up an additional project
language, which is not included as standard in the Producer.
The Edit Dictionary dialog box is available to you for editing the texts. That means that direct access to the text
files is not necessary.
236
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Content Languages and Translation
You can use the dialog box to edit the following texts:


Playback texts
These are the texts for the user interface of the trainer bar, the book reader bar and the library as well as
for the Navigator
Resource: Playback Dictionaries
Recording texts
These are the content languages for the texts of the projects and documentation.
Resource: Recording Dictionaries
Open dialog
You can open the Edit Dictionary dialog box using the resources in the project explorer and thereby access the
required text files directly. To do this, select the corresponding dictionary and then click on the Open Dictionary
button in the object editor.
Once the dialog box has been opened, the texts are automatically loaded from the relevant text file. By default, the
dialog box is opened with the dictionary in the active Producer language.
10.4.1
Structure and Functions
The basic parts of the dictionary editor are:

Toolbar
The toolbar includes the functions for editing the dictionary texts.

Text list
The text list displays the dictionary texts with IDs, states and values.
The dictionary editor includes several functions for managing texts:

New:
Creates a new dictionary entry.

Save:
Saves the changes of an edited dictionary.

Import as Excel File:
Imports an Excel file of the texts into the dictionary.

Export as Excel File:
Exports the texts of a dictionary into an Excel file for external translation. All languages are exported.

Cut, Copy, Paste:
With these functions, you can edit the texts of a dictionary.

Undo, Redo:
With these functions, you can switch between editing states.

Search:
With this function, you can search for an entry in the dictionary.
Clicking the button opens a dialog box where you can enter a search value and search criteria.

Filter:
With the function, you can filter the entries of a dictionary.
Clicking the button opens a dialog box where you can enter filter values and criteria.
To display the complete list again, remove the entries in the filter dialog box.
SAP Workforce Performance Builder 9.3
Content Languages and Translation
Customer
© 2014 SAP AG. All rights reserved.
237

New Language:
Creates a new dictionary language.

Language List:
With the language list, you can switch between the languages of a dictionary. The selected language is shown
in the text list.
10.4.2 Setting up a Dictionary
To edit the texts, first create a new dictionary. This involves copying the standard dictionary, which you use as a
template for editing the texts and IDs.
Note
Do not change the texts in the Standard dictionary so that you always have the original version available
at all times. Always set up a new dictionary.
1.
Select the appropriate dictionary group in the project explorer resources.
2.
Click on the New Dictionary button in the object editor.
3.
Enter a name in the dialog box. Click OK to confirm.
The Standard dictionary will now be copied automatically.
4.
To use the dictionary you have created for your trainer or as a content language, select the dictionary and
click on the Set as default function in the object editor. The entry is now shown in bold.
10.4.3 Editing an Entry
To customize the existing texts, open your dictionary in the Edit Dictionary dialog box. You can edit the text in the
dialog as follows:
Note
The text IDs cannot be changed as they are used to assign the texts in the content or user interface.
Caution
Do not change any variables or scripts contained in texts. These are used for allocating or formatting
applicable content. Changes can cause implementation errors.
Placeholders for assigning field names and icons can be found in square brackets [] in the text modules.
The variables are indicated by an @ sign or in curly brackets {...}. HTML / CSS scripts have diamond
brackets The text IDs cannot be changed as they are used to assign the texts in the content or user
interface..
1.
Double-click on the line of the text you want to edit.
2.
The editing dialog opens and contains the following areas:
o Language of translation template:
The upper field displays the original text.
You can view this text in another language by clicking on the Other... button.
238
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Content Languages and Translation
3.
o
Target language (Value):
Enter your text in the Target language field.
o
State:
Specify the State of your text using the drop-down list. This allows you to manage texts and editing
statuses. The following statuses are possible: new, needs-translation, translated, needs-review, needs-fix,
final
As a rule, the texts are given the status final. The status of an amended text is automatically set to new.
o
Comment:
Enter a comment needed for editing a particular text.
Click on Close to incorporate the text into your text document.
10.4.4 Creating a New Entry
In addition to using existing texts, you can also add further IDs for new texts, thus enlarging the recording
dictionary. These entries allow you to insert the texts using placeholders in your content. For further in formation,
refer to the chapter Inserting a placeholder in the Producer manual.
Set up new IDs as follows:
1.
Select the New button in the toolbar to open the editing dialog box. Alternatively, you can open it using the
New...list entry.
2.
Enter a name in the ID field. You can only enter an ID that does not already exist.
3.
Use the setting Add to all languages to specify whether you want to add the new entry only in the chosen
content language or in all content languages to the dictionaries.
To ensure consistency between content languages, the setting should be retained.
4.
Confirm the dialog box by clicking on OK.
Once the dialog box has been closed, the editing dialog box for the text opens. Now enter your text. Read the
section on editing texts.
For the IDs, you can then enter the texts in the other content languages you are using. To do so, select the
language you want from the drop-down list.
10.4.5 Creating a New Language
If you would like to add an additional language to those provided by the Producer, you can do so using the New
language function.
Creating a new language
1.
Click on the New Language button in the toolbar of the editor.
2.
A dialog box opens. Enter the following values:
o
Language:
Select the new language you would like to set up from the list. In this list you will find an overview of
different languages with their associated flags.
SAP Workforce Performance Builder 9.3
Content Languages and Translation
Customer
© 2014 SAP AG. All rights reserved.
239
o Copy from:
Select which project language you want to use as a template for your new language. This is required to
assign the texts to the corresponding IDs.
3.
Confirm your selection by clicking on OK. This will create a text file in the Dictionary for the new language you
have set up.
Translating a new language
You can now amend the texts or export them as an Excel file to have them translated into the corresponding
language by a translator. Once the Excel file has been translated, you can reimport it. The Export Excel and Import
Excel functions in the toolbar to allow you to do this.
10.4.6 Activating a Dictionary
The dictionary resources for simulation and books can be activated as follows:
Activating the Playback Dictionary
The created Playback Dictionary can be activated using the Playback Settings in the Producer.
1.
Open the central configuration dialog box using the Tools -> Settings menu.
2.
Select the section Playback Settings -> trainer - Global -> Visual properties.
3.
In the Playback Dictionary setting, select the created dictionary resource.
4.
Confirm the dialog box with OK.
The trainer - Global section activates the dictionary for the whole trainer. It is also possible to select an individual
dictionary for the book reader, library or a simulation mode on the relevant settings page.
Activating the Recording Dictionary
The created Recording Dictionary can be activated using the Playback Settings in the Producer.
1.
Select the dictionary resource in the resource tree of the project explorer.
2.
Click Set as Default in the object editor.
The resource name is now displayed in bold.
10.5 Spell checker
The spell checker enables automatic correction of the texts contained in the HTML editor. The text is checked
according to which project language is set. This requires a spell checker, accessed by the Producer, to be installed
in Microsoft Word in the relevant language.
In the same way as is familiar from Microsoft Word, a misspelled word is underlined with a red wavy line. You can
now either correct the spelling or else select the correct spelling by right clicking to call up the context menu.
240
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Content Languages and Translation
Activating spell checker
There is an option available to you in the Central Configuration Dialog for activating the spell checker. This option
is located in the Application -> General category.
The Default language for spell checking option can be used to define a language to be used if there is no language
package available in Microsoft Office for a language being used in a project.
SAP Workforce Performance Builder 9.3
Content Languages and Translation
Customer
© 2014 SAP AG. All rights reserved.
241
11
Publication
You can publish a Workarea to give your learners the files required for playing back the course content.
Besides the content to be published, a Workarea contains files which are not required for playing back after
publication and which unnecessarily increase the size of the published Workarea. For this reason, a copy
containing only the files required for playing is created in a target directory that you need to specify whenever you
publish a Workarea.
Publishing can be in different formats and be stored directly on a server or a file share. In addition to this, you can
specify rules for publication to avoid the need to reenter details when republishing.
Note
For learning content to be played in the browser, the PC concerned must be capable of certain settings.
For information on these, read Learner Settings in this manual.
11.1
Publication Types
A variety of publication types are available for publishing workarea or individual objects. These are:
Icon
Type
Description
Standard
This is the standard format for publishing workarea. This creates HTML and
JavaScript files in a folder structure, which can be played back using the trainer.
Incremental publishing is available for the Standard format; this enables adding,
removing and updating of objects in the published content.
EXE (Executable)
The formats are for executable files and support direct execution of content. The
whole workarea is stored in a file and this facilitates an exchange of files.
You can additionally define a filename for this format.
SLC (SAP
Learning Content)
242
Documents
The type lets you export all the documents available in a workarea to a folder and
thus deposit directly on a file system. You can publish the documents into a folder
structure or all files in one folder with the names of the content objects as file names.
SCORM
See the chapter Publishing SCORM/AICC.
SAP Learning
Solution (SCORM)
See the chapter Publishing SCORM/AICC.
AICC
See the chapter Publishing SCORM/AICC.
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Publication
11.2
Preparation for the Publishing
Before publishing a workarea, the content's tree structure must be defined in the same way as it should be used
for the publication. Besides the ability to move and categorize objects within the structure, you can also use the
Filter and the function Hide to more precisely define the content to be published. This will allow you to hide any
content that should not be published.
To read more on how to use the Filter, refer to the section on Filter and search in the workarea.
Note
Make sure that the filtered and hidden objects will not be needed for displaying your learning content. For
example, linked projects or a group for managing image objects should be made visible before publishing
your content.
11.3
Publishing a Workarea
This is how to publish a workarea:
1.
Launch the Publish Content... function via the Workarea -> Publish menu.
2.
When you execute the function, a dialog box appears and you can configure the following settings:
1.
3.
4.
Select the publication Type - Standard, Executable or SLC
2.
Enter the Target Folder for the workarea to be published. You can use the Browse for folder function to
change this.
If you select the EXE or SLC format, you can additionally specify a Target File.
3.
Enter a Navigation Prefix, when publishing navigation projects.
Click OK to return to the overview of objects in the workarea.
1.
Now select the objects you want to publish.
2.
If you selected the Standard type, you can publish objects incrementally. In other words you can add
objects to a published workarea, remove or update objects. Refer to the corresponding section for more
details.
3.
The Root object defines the root for the publication. This is important in order to be able to define the very
first object when publishing sub-trees.
4.
Additionally, you can define a Start object for your publication. This is the first object displayed when the
publication is accessed; it could be an introductory page in a book, for example.
Click Ok to complete the publication.
Publishing references
Referenced resources and objects can be verified so that only files that are really necessary are exported for
publishing purposes. This significantly optimizes the file size of a publication and also prevents necessary
references from being forgotten. When publishing an existing publication, references that are no longer used are
removed.
Before checking your references, you must first enable all the content to be published and disable all the
resources. Once this has been done, click on Check References in order to activate all the necessary references in
the tree structure.
SAP Workforce Performance Builder 9.3
Publication
Customer
© 2014 SAP AG. All rights reserved.
243
Caution
Never publish a Workarea in an existing or currently opened Workarea. The files will be overwritten by the
publishing process. Always create a new folder for publishing. Publish only in an existing Workarea if you
are updating and make sure the folder is not in use.
11.3.1
Incremental Publishing in Standard Format
Incremental publishing in Standard format gives you the option of adding, updating or removing objects to or in a
workarea. Functions for identifying and manipulating the status of objects in the published workarea are available
in the Publish Content... dialog.
To the left of an object you will see a button that lets you set the action for the publication event. Clicking the
button changes the setting. The current icon setting defines the action for the object when you publish the
workarea. Additionally, you can select the status in the context menu.
Icons states
Icon
Setting
Explanation
Add
Adds an object to the published
workarea on publication.
Update
Updates an object available in a
published workarea.
Remove
Removes an object from the
published workarea.
Omit
Omits the objects in the object
group for this publication.
Equals
Indicates that the object in the
workarea is identical to the object
in the published workarea.
Different states
The icon shows that the object
group contains objects with
different states.
Keep
This option lets you choose to keep
an object. This is the case if with
update candidates that you do not
wish to overwrite.
When you select an object, the following information is available for it:



244
Status – Gives you the current status of the objects in the workspace compared to the published workarea.
Suggestion – Proposes a possible course of action for publishing the object.
Setting – Shows the currently selected action for publishing the object.
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Publication
Note
Note that incremental publishing can only be performed for the Standard format. The reason for this is
that this process creates a folder structure which can be modified, whereas the individual files are created
from scratch when publishing EXE or SLC format.
11.4
Publishing Rules
Publishing rules make it easier to publish a workaround multiple times because you only need to make entries
once. The rules can be created and edited in the Edit Publishing Rules dialog box.
11.4.1
Creating Publishing Rules
To create publishing rules, proceed as follows:
1.
Open the Edit Publishing Rules dialog box by choosing Workarea -> Publish -> Edit Publishing Rules... in the
menu.
The dialog box lists all the existing publishing rules of the workarea.
2.
To create a publication rule, use one of the following buttons:
3.
o
Add:
Creates a new publishing rule.
A new publishing rule has a standard name in the Name field. After you click OK, the name is changed for
the resource.
o
Duplicate:
Creates a publishing rule using an existing resource.
When selecting a publishing rule from the list, you see the parameters on the right-hand side of the dialog box.
Now you can edit the publishing parameters explained in the chapter Publishing settings.
o
4.
Name:
Defines the name of the publishing rule. The name is used as the display name of the resource.
Generate Rule Name:
Generates a name. The name includes the defined root object and target folder/target file.
After you have finished your modifications, click one of the following buttons:
o
Publish:
Saves the created publishing rule and executes publishing.
o
Close:
Saves the created publishing rule and closes the dialog box.
The publishing rules created can be executed by selecting the rule set name in the Workarea -> Publish menu.
Alternatively select the resource and click on Publish in the object editor.
SAP Workforce Performance Builder 9.3
Publication
Customer
© 2014 SAP AG. All rights reserved.
245
11.4.2
Publishing Settings
The following settings are available for publishing a workarea or specific content:

Type:
The option menu allows you to select a publication format for the workarea.
See the chapter Publication types.

Start from:
Defines the starting point in the content tree structure from which you want to publish content. This enables
you to publish a specific group or the whole content.
Use the Edit link... to change the root object. A dialog box opens where you can specify an object in the tree
structure. Confirm this by clicking OK.

Use Filter:
This option menu allows you to select an existing filter to be applied to the publication.
See the chapter Filter and search in the workarea.

Include Dependent Objects:
Specifies, that all dependent content and resource objects are published.

Target Folder/Target File:
Specifies the storage location where you want the workarea to be published, or specifies the folder and file
name for an EXE/SLC file. Use the Search for folder button to select a folder as the storage location.

Clean Up Target Folder:
If this setting is activated, the target folder is always cleaned up before publishing. This setting is only
available for the type Standard.

Navigation Prefix:
The option allows you to define the location of the workarea for navigation projects. The prefix is necessary for
playback from a webserver or a file share.
See the chapter Publishing Navigations.
Note
The settings Include Dependent Objects and Clean Up Target Folder are mandatory for creating a
publishing rule.
Settings and Styles
In the subcategory you are able to define setting and style resources for the content playback:

Playback:
Defines the playback settings for playing back simulations and books/book pages. If you are using different
settings, you can activate the required resource.

Navigation Playback:
Defines the navigation playback settings for playing back navigations. If you are using different settings, you
can activate the required resource.

Text Styles:
Defines the text styles of the created content. If you are using different styles, you can activate the required
resource.
246
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Publication
11.4.3
Publishing Navigations
The ability to launch navigations from a web server or file-share requires you to specify the location where the
workarea is held when publishing. The Navigation Prefix text field is available to you when publishing content.
Enter the URL and workarea name in this field.
Web server example: http://yourwebserver/[...]/Workarea
File-Share example: …\Workarea\index.html
Note
Note that following publication the workarea storage location is to be retained with the navigations as
otherwise the defined prefix will no longer match the storage location. If you would like to file a workarea
in a different location then it needs to be republished with a modified prefix.
11.4.4
Publishing Documents
Publishing documents allows you to store all the documentation files from your workarea in a folder. To do this,
select Documents as the publishing type in the documentation settings.
Besides the general publishing settings, there are further settings available:

Include External Documents:
In general, only generated documents are published. Activate the setting if you also want to publish imported
documents.

Flat Structure:
Specifies that all documents are stored in the main folder. A content object name and the content type is
generated for each document. The document name starts with the content name, for example projectname documenttype.docx .
HTML documents and master documents cannot be published in a flat structure.
o

Sort by Type:
Specifies that the generated document name starts with the document type when publishing a flat
structure, for example documenttype - projectname.docx
Include Formats:
Activate the required document format to publish all available documents with the format:
o
Word / PowerPoint Documents
o
HTML Documents
o
PDF Documents
11.4.5
Multifile for Optimized Playback
A multifile can be created when publishing content. The multifile collects all relevant playback files from the
published content and resources, and stored in the publication. This allows the content to be started faster and is
recommended when storing content on a Web server or a file share.
SAP Workforce Performance Builder 9.3
Publication
Customer
© 2014 SAP AG. All rights reserved.
247
The generated multifile depends on the content you want to publish and can be used for the publishing types
Standard, Executable and SLC. Select the required multifile setting:

Pack Structure:
Includes the workarea structure information in the multifile.

Pack Resources:
Includes the resource information in the multifile.

Pack Projects:
Includes the project information in the multifile.

Pack Book Pages:
Includes the book page information in the multifile.
Note
Multifiles cannot be used for navigation projects, because the multifile is started by the trainer. Only use
the settings when publishing simulation projects, book pages and text units.
The required multifile information depends on your content. In general, you can use all the settings. The following
overview shows you different use cases for activating or deactivating a setting:
Setting
Status
Content
Pack Projects
Activate

Simulation projects are
published.
Pack Projects
Deactivate

Simulation projects are not
published.

Navigation projects are
published.

Projects are started from
another workarea.
Pack Book Pages
Activate

Book pages are published.
Pack Book Pages
Deactivate

Book pages are not published.

Navigation projects are
published.
Pack Structure
Activate

A complex structure is
published.
Pack Structure
Deactivate

Only one object or a small
number of objects are
published.

Navigation projects are
published.
Pack Resources
Activate

A large number of resources
are used for the content.
Pack Resources
Deactivate

Fewer resources are used for
the content.

Navigation projects are
published.
248
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Publication
11.4.6
Publishing Rules Resource
Created publication rules are stored as resources in the resource tree. This allows you to create general rules for a
content project and use the resources in an authoring environment. You can also export the resources as an
archive, which can be imported into another workarea.
Functions in the object editor
The following functions are available in the object editor for a selected resource:

Edit Publishing Rule:
Opens the Edit Publishing Rules dialog to change the rule settings.

Publish:
Executes the publishing with the defined rule settings.

Open Target Folder:
Opens the folder with the publicated content.
11.5
Publishing Individual Objects
It is not always necessary to publish the entire workarea. You can also output individual objects by using the
context menu when selecting an object in the tree structure of the project explorer. To publish an object, proceed
as follows:
1.
Select Publish Object... in the menu.
2.
A dialog box now opens where you can specify the Type and the Target folder/Target File.
More information on the settings is available in the chapter Publishing Settings.
Other functions in the dialog box:
o
Show Objects for Publishing:
Shows all dependent content and resource objects. After you click the button, all objects are listed in the
box above.
SAP Workforce Performance Builder 9.3
Publication
Customer
© 2014 SAP AG. All rights reserved.
249
o Save as Publishing Rule:
Select this option to save the defined settings for further publishing. The settings are stored as a
Publishing Rule resource.
3.
Click OK to confirm the dialog box.
After publishing is completed, a dialog box opens, where you can Start the publication or Open the target folder.
Click on Close to finish publishing.
11.6
Publication on a Server
To publish your content on a web server (e.g. Apache or IIS), the entire published workarea is copied to the
desired location on the server or the publishing is done directly into the target directory of the desired server. By
calling up the corresponding HTML file, a simulation can be viewed in a particular mode directly in the browser:
Example:
http://yourwebserver/[...]/workarea/projects/example/example_demo.html
To open a library belonging to a particular workarea, simply call up the parent directory in the browser:
Example:
http://yourwebserver/[...]/workarea/
11.7
Publication on an Intranet Share
To publish your content on the file share of an Intranet server, the entire published Workarea is copied to the
desired location on the server or the publishing is done directly into the target directory of the desired server. By
calling up the corresponding HTML file, a simulation can be viewed in a particular mode directly in the browser:
Example:
\\yourserver\example_share\[...]\workarea\projects\example1\example1_demo.html
To open a library belonging to a particular Workarea, simply call up the parent directory in the browser:
Example:
\\yourserver\example_share\[...]\workarea\index.html
Note
connection with the use of anti-virus software that is active when accessing an Intranet share, scanning all
the files necessary for playing back a simulation (as the files are called up) can result in a considerable
delay between calling up a simulation and the start of that simulation. It is therefore recommended that
simulations always be published on a web server, if possible.
11.8
Generating a Simulation Video
Video is an additional format for simulation playback in demo mode. This allows you to use the simulation in a
portable format and to publish it on media platforms.
250
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Publication
Videos can be created for simulation projects with or without audio in the AVI and MP4 format. The video includes
all playback resources.
A video does not display the trainer bar because the video can be controlled by using the player’s playback
window.
Generating a video
To generate a video, proceed as follows:
1.
Select a simulation project in the tree of the project explorer.
OR
Open a simulation project in the project editor.
2.
Click on Tools -> Generate Video...
The Generate Video dialog box opens.
3.
Change the settings in the dialog box as required.
See also the chapter Generate video dialog.
4.
Click on Start to generate the video.
Video generation starts and a progress bar displays the status.
5.
After the generation has been finished, a dialog box is displayed. The dialog box allows you, to playback the
video or to open the folder.
6.
Click on Finish to close the dialog box.
The video is stored in the project structure as demo.avi/mp4. You can open the project folder by using the Open
Folder button in the object editor.
11.8.1
Generate Video Dialog Box
The Generate Video dialog box is used to generate video for simulation projects. The dialog box contains settings
and commands for video generation and video preview and can be opened by using the Tools -> Generate Video...
menu.
The dialog box has the following areas:
Project Settings
This area displays a preview of the current frame for video generation. When the dialog box is opened, the image
displays the first frame.
Video Settings
The area contains the following settings for video generation:
SAP Workforce Performance Builder 9.3
Publication
Customer
© 2014 SAP AG. All rights reserved.
251

Presets:
Contains different formats to allow a video generation regarding specific use cases.

Video Codec:
Displays the active codec for video generation. The codec defines the format of the video.
o Settings...:
Opens a dialog box to configure the active codec. The drop-down list displays all installed codecs.
Only compatible codecs are displayed.

Crop Size:
Defines the size of the displayed image are of the simulation pages in pixels. Select a percentage value to
change the size.
o Custom Size:
The option allows you to enter an individual crop size. The text fields are activated.
o Show... / Hide:
Opens a window for resizing the video manually.
Changing the size of the window also changes the image. Once you have finished resized, close the
window to apply the changes.

Video Size:
Defines the size of the video in pixels and scales the images. Select a percentage value to change the size.
o Custom Size:
The option allows you to enter an individual size of the video. The text fields are activated.

Frame Rate (Frames per seconds):
Defines the number of images displayed in one second. The initial value is 24.
Note that a high frame rate leads to a longer generation time and a larger file size.

Audio Format:
Displays the active output format of the audio. The active audio format can be changed in the Change Audio
Format dialog box.
Video Output
The area contains information about the generation process.
Buttons
The bottom of the dialog box contains the following buttons and button statuses:
Icon
Description
Reload:
Reloads the project after video generation was
canceled. This allows you to change the settings and
start generation again.
A reload can be necessary, if changed settings are not
applied correctly.
Generate:
Starts video generation.
252
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Publication
Icon
Description
Pause:
Pauses video generation.
Continue:
Continue video generation from the paused status
with the current settings.
Close:
Closes the Generate Video dialog box after video
generation was canceled.
Cancel:
Cancels video generation. You can reload the project
afterwards.
Finish:
Closes the Generate Video dialog box after video
generation was finished successfully.
11.8.2
Crop Size and Video Size
The image shows you the use of the Crop Size and the Video Size for the video generation:
SAP Workforce Performance Builder 9.3
Publication
Customer
© 2014 SAP AG. All rights reserved.
253
The full image is kept in the generated video. During playback of the video the focus moves to the position of the
current highlight and bubble.
The video size can be smaller as the crop size - the image is scaled.
11.9
Publication on SAP Mobile Documents
Content published utilizing the SLC format can be opened and consumed directly on an iPad and iPhone via the
SAP Mobile Documents App for Apple iOS.
254
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Publication
To publish your content on SAP Mobile Documents you will need SAP Mobile Documents for Windows in latest
version 1.2 at minimum. Once you have installed the application publish your contents in format SLC directly to
your local SAP Mobile Documents folder (by default: Mobile Docs > My Documents in your local user directory).
After publishing synchronization to server will start automatically, providing you with the ability to load, play and
share the published content within your SAP Mobile Documents App.
Note
Setting up your publishing rule for publication as SLC to be used in SAP Mobile Documents deactivate all
options for Multifile functionality.
11.10 Local Playback
The generation of a simulation corresponds to local publication. As part of generation, all data necessary for
publication are created and filed in the workarea file. The simulation can then be viewed directly in the trainer. To
do so, select a mode for your project in the Project Explorer and then click on the command Playback with trainer.
The simulation can also be called up by clicking twice on the simulation in the project explorer or directly from the
Workarea as follows:
Example:
C:\workarea\projects\example1\example1_demo.html
A workare can be displayed in the library by clicking the button Open as library in the project explorer. In the
workarea defined filters are also used for the published workarea.
The library can also be opened directly in the browser via the following path:
Example:
C:\workarea\index.html
11.11 Defining a start link
The Start Link function provides you with an easy way of generating a link to learning content or the library. The
Start Link can then be attached to a webpage, for example, which can be used to launch learning content. This is
necessary if a workarea was published on a web server or file share.
The Start Link can be defined for all objects available in the Project Explorer. If you link a group, the library is
opened when the group is launched to display the associated content. An object's Start Link is displayed in the
object editor's Start Link parameter when an object is selected.
Note
To publish navigations to a web server you are required to use the Prefix function in the dialog for direct
publication. This option is the means by which the workarea storage location is assigned to the navigation
files so that the Navigator can find and launch the navigations when called.
General settings
When selecting the Workarea in the Project Explorer tree structure, a general rule can be defined in the Start Links
subcategory which is then used for creating all start links.
SAP Workforce Performance Builder 9.3
Publication
Customer
© 2014 SAP AG. All rights reserved.
255

Prefix:
The prefix defines a general URL or path preceding the Start Link. This can be the link to a web page, for
example.

Use prefix:
Activating this option uses the defined prefix to generate the start link.

Use dialog:
With this option activated, a dialog box for defining the link is opened when you select Copy Start Link function
in an object's context menu. If the option is deactivated, the link is copied directly and generated using the
general criteria previously defined.
11.11.1
Selecting an object's start link
To copy the Start Link for an object, right click in the Project explorer tree structure to open the context menu for
this object. Now select the Copy Start Link … function.

If prior to this the Use dialog option was deactivated, the Start Link will be copied directly.

If prior to this the Use dialog option was activated, a dialog box will open in which you can define the prefix.
The link is then copied by clicking on Copy.
The copy of the Start Link can now be inserted in the desired file and made available to users.
11.12 Publishing SCORM/AICC
Producer supports the export of workareas to SCORM and AICC for the import into a corresponding Learning
Management System (LMS). To find out which standard your LMS supports and which conditions must be met,
ask the person in your IT department who is responsible for administering your system.
SCORM Publishing
To import learning contents into LMS with SCORM, a compliant IMS manifest can be produced or exported from
Producer. In addition to the SCORM file, a ZIP archive of the contents and the corresponding resources for direct
import into the LMS is created.
The following formats are supported:

SCORM 1.2

SCORM 2004 3rd Edition

SCORM 2004 4rd Edition

SAVE 1.0 (SCORM 1.2)
AICC Publishing
To import learning contents into LMS with AICC, the files lms.au, lms.crs, lms.cst and lms.des are all stored in the
parent directory of the workarea. Under certain circumstances, they need to be adapted to the target system.
The Producer supports the AICC HACP format - the format AICC PENS is not supported.
256
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Publication
Publishing process
The following process is recommended for the publishing of SCORM or AICC:
1.
Create and structure the content.
2.
Adapt settings in the central configuration dialog.
3.
Adapt the settings in the publishing rule.
4.
Publish the workarea.
After the publishing, the ZIP file or the workarea folder with the included format-specific files can be imported into
LMS.
Note
Note that navigation projects cannot be used in LMS.
11.12.1 Preparation
To make the export possible, some preparations have to be made.
Content Structure
To export a SCORM file, the output structure of the contents needs to be defined in exactly the way it is supposed
to be displayed in LMS later on. It is possible to export multiple groups and projects, books with book pages and
projects, as well as single projects.
The workarea content exports depend on the group selection. If you want to export all the content in a workarea,
select the Content group and then start the export. If you only want to export a specific group, only select this
group. Furthermore the structure can be influenced by filter or with the Hide option to filter or hide content
objects that are not wanted.
Note
Note that correct tracking is only possible, if unused contents and modes are set to hidden.
Recommendations
Make sure that a text for the Task Description is entered for the Test mode. It can be edited in the macro
Simulation Start of the project.
11.12.2 Central configuration
The settings can be found in the Playback Settings of the central configuration dialog. Open the dialog about the
Tools -> Settings… menu. The settings can be set globally for the trainer and individually for each simulation
mode.
The following setting areas are relevant for the export:

Tracking (General)

Tracking (SCORM)

Tracking (AICC)
SAP Workforce Performance Builder 9.3
Publication
Customer
© 2014 SAP AG. All rights reserved.
257

New window properties
11.12.2.1 Tracking (General)
The Tracking (General) area contains general settings for tracking. The activation of the SCORM or AICC backend
for the communication interface can be done in the option Tracking backend. The following entries define the
tracking backend and have to be set globally in the trainer settings:

SCORM (automatic)

SCORM 1.2

SCORM 2004

AICC
11.12.2.2 Tracking (SCORM)
The Tracking (SCORM) area contains detailed settings for SCORM tracking:

Progress and result tracking:
Activates tracking of the status of the learning progress to calculate the results. Specify whether you want to
keep progress or calculated results only or both values.
o none
o only progress
o progress as result
o result and progress
o result and progress - incomplete when failed

Send success status:
Specifies when the information about a successful performed action is sent to LMS.
o never
o based on score
o when completed

Resume simulation:
Defines whether a simulation can be resumed after closing. Optionally a warning can be displayed when the
user tries to resume a completed simulation since this might reset the result.
o Yes
o No
o Show warning, if completed

Result type:
Specifies the form in which the result is transferred to LMS. Decide whether your LMS expects point-based or
percentage-based results.
o Points
o Percentage
258
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Publication

Score precision:
Specifies the decimal places for the result. The standard value is two decimal places (e.g. 0.95).

Commit data only once:
Transfers the results to LMS only when a simulation is exited. Use this setting to reduce the network traffic.

Track objective data:
Generates SCORM objectives for the subunits of the library or a book.

Allow restart of simulations:
Defines whether a restart button is shown on the stop page of a simulation.
The option should be deactivated if LMS does not support internal content playback.
Note
Note that the display of objective data differs from the used LMS and cannot be shown in every system.
11.12.2.3 Tracking (AICC)
The Tracking (AICC) area contains detailed settings for AICC tracking:





Progress and result tracking:
Activates tracking of the status of the learning progress to calculate the results. Specify whether you want to
keep progress or calculated results only or both values.
o
none
o
only progress
o
progress as result
o
result and progress
Send success status:
Specifies when the information about a successful performed action is sent to the LMS.
o
never
o
based on score
o
when completed
Resume simulation:
Defines whether a simulation can be resumed after closing. Optionally a warning can be displayed when the
user tries to resume a completed simulation since this might reset the result.
o
Yes
o
No
o
Show warning, if completed
Cross-domain support:
Defines the support for cross-domains for AICC tracking.
o
disabled
o
Flash
Allow restart of simulation:
Defines whether a restart button is shown on the stop page of a simulation.
The option should be deactivated if LMS does not support internal content playback.
SAP Workforce Performance Builder 9.3
Publication
Customer
© 2014 SAP AG. All rights reserved.
259
11.12.2.4 New window properties
The option Fullscreen in the New Window Properties must be always deactivated and disabled to prevent the
preview of a separate window. The browser window is regulated by the corresponding LMS. This selection ensures
smooth communication between the content and LMS.
The deactivation of the fullscreen should be done for the project modes and the book reader individually about the
appropriate setting pages.
Note
Note that the Fullscreen parameter should always be deactivated for the SCORM export to enable
trouble-free communication with LMS.
11.12.2.5 Tracking settings recommendations (SCORM)
For tracking of learning content in LMS, the SCORM specification uses a learning object as a sharable content
object (SCO). Only the SCO communicates with LMS, which means it sends status and score information and
requests data.
The following learning contents are distinguished for the SCO of a Producer workarea:

project mode

book with book pages

book with book pages including links to the project modes
To define the tracking of the content's completion there are different settings necessary for the learning contents:
Note
The following settings are recommendations for the use of learning contents in a LMS. Depending on the
LMS in use, other setting combinations may achieve the expected tracking result.

Global settings - trainer
The following settings should be defined in the global settings of the trainer:
o Tracking backend
o Commit data only once
The other settings can be set globally or individually for the specific project mode.

Completion of content
A book is completed if all contained book pages and project modes have been completed.
To exclude a project mode from tracking, set the option Progress and result tracking to none in the specific
mode settings. The setting also allows you to define whether the result or completion should be tracked.

Start linked mode in new window
The modes of a project can be linked on a book page with the book page object Mode Link. For the object, the
option Open Link in new Window needs to be activated. During playback, the mode starts in a new window and
not in the window of the book page.

Tracking of objective datas
With the in the central configuration dialog activated option Track objective datas detailed tracking
260
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Publication
information will be send to the LMS additionally to the SCO tracking data. The setting can be used for groups
and books with included contents.
Note
Note that the objective data cannot be displayed in every LMS.
11.12.1 Publishing Rules for SCORM/AICC
After the preparation of the content and the adaptation of the settings in the central configuration dialog, the
workarea and the LMS files can be published - see the chapters Publishing Rules. For SCORM and AICC there are
further settings in the publishing rules.
11.12.1.1
SCORM Settings
The subcategory SCORM includes the following settings for the SCORM publishing:
Version
Various format versions are available for the output of a SCORM file; you can select them from the Version
dropdown menu for the export process. When you select a version, the IMS manifest of the corresponding format
is generated to reflect the requirements. The versions are:

SCORM 1.2

SCORM 2004 3rd Edition

SCORM 2004 4rd Edition

SAVE 1.0 (SCORM 1.2)
SAVE 1.0 settings
Activate the version SAVE 1.0 (SCORM 1.2) to produce meta information in the IMS Manifest in accordance with
the SAVE 1.0 specifications. See also the chapter Using SAVE 1.0.
Further options for SAVE 1.0 are:

Copyright:
Indicates in the IMS Manifest's meta information whether the learning content is covered by copyright.

Version:
Indicates in the IMS Manifest's meta information the version of the issued content.
XML schema files
In some cases, LMS may need XML schema definitions, to be integrated into the SCORM packet. These contain
SCORM-specific structure definitions for XML documents and require correctly formatted files to work properly.

Include XML schema files:
All XML schema files are added to the SCORM packet.

Insert schemaLocations:
Attributes are integrated into the IMS Manifest file as a reference to the XML schema files.
SAP Workforce Performance Builder 9.3
Publication
Customer
© 2014 SAP AG. All rights reserved.
261
Start Parameters
In the generated manifest file, each simulation is given its own URL from which it can then be accessed.
In LMS, a simulation is sometimes opened using the query string of the URL. Here, corresponding attributes are
necessary. The selected Start parameters can be used to set which attributes are to be considered when entering
the starting URL. These are entered in the IMS manifest according to the selection.

Only"href“ attribute:
Standard setting for SCORM export.
One of the following settings should be used if a simulation cannot be accessed with the standard setting.

"href“"and "parameters" attributes:
A parameter attribute is also inserted which contains the query string. This starts with a question mark "?".

"href" and "parameters" (no ‘?’ delimiter):
A parameter attribute is also inserted which contains the query string.
Book Display
The option allows you to enable the publishing of books and book pages.
The available options define the structure for representation in LMS. This gives you the ability to reduce complex
books to a specific structural level, or display the whole book as an object. This setting has no influence on the
book structure in the book reader.

Ignore books:
This selection does not export the books available in the workarea into the SCORM manifest.

Show only books:
This section displays the books as book objects in LMS.

Show books and direct sub objects:
This option displays the books in LMS on two levels, namely a book and its subordinate objects on the first
level.

Show books and all sub objects:
This selection displays the complete structure of the books with all subordinate objects.

Include documentation:
This option allows you to export the documentation of the projects.
Note
Note that documentation and imported files cannot be tracked in LMS.
11.12.1.2
SCORM for SAP Learning Solution
The settings in the subcategory SAP Learning Solution are used for the connection and login with the LSO system.
General Settings

262
Learning Net Type:
Defines an ID for the publication. The ID is used in the SAP Learning Solution backend for the identification of
the learning net and different versions.
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Publication
o
Generate:
The button allows you to generate a new ID for the learning net type. The ID has to be added after the
publishing in the LSO backend.

Repository URL:
Defines the URL of the master repository of the SAP Learning Solution system.

Content Path:
Defines the path for the content upload, relative to the repository URL. If it does not exist the path will be
created automatically.
Without Load Balancing
With deactivated parameter Load Balancing the following parameter for connecting the LSO are available:

Application Server

System Number

Router
With Load Balancing
With activated parameter Load Balancing the following parameter for connecting the LSO are available:

Message Server

System ID

Group

Router
Secure Network Communication (SNC)
For the use of the Secure Network Communication there are the following settings:

Secure Network Communication:
Defines, if the Secure Network Communication is used.

No Single Sign-On:
Defines, that the Secure Network Communication is used without Single Sign-On. It is required to specify a
user and a password during the publishing.

SNC Name:
Defines the identification prefix for the backend system.

Quality of Protection (QoP):
Defines the protection level for the Secure Network Communication.
o
Authentication only
o
Integrity protection
o
Privacy protection
o
Default of backend system
o
Maximum security settings available
Further information about the Secure Network Communication is available in the SAP Help Portal.
SAP Workforce Performance Builder 9.3
Publication
Customer
© 2014 SAP AG. All rights reserved.
263
11.12.1.3
SCORM for SuccessFactors Learning
For the import of learning content into SuccessFactors Learning you can use the formats SCORM 2004 4th
Edition or AICC.
Consider the following settings:
Setting
Parameter
Value
Tracking (General): Tracking back
end
SCORM 2004
New window properties: fullscreen
Deactivated
Publishing Type
SCORM
SCORM: Version
SCORM 2004 4th Edition
trainer - Global
(Central Configuration Dialog ->
Playback Settings)
Tracking (General): Tracking back
end
AICC
Publishing Rule
Publishing Type
AICC
SCORM
trainer - Global
(Central Configuration Dialog ->
Playback Settings)
Publishing Rule
AICC
11.12.1.4 AICC Settings
The subcategory AICC includes the following settings for the AICC publishing:

File Prefix:
Defines the prefix of the server for the AICC package that is inserted into the lms.au file.

AICC Creator:
Defines the creator of the AICC package.
The information about whether a file name prefix or an AICC Creator needs to be specified should be requested
from the responsible system administrator of the target LMS.
11.12.2 Using SAVE 1.0
SAVE 1.0 (SCORM-Anwendung in der Versicherungswirtschaft - Using SCORM in the Insurance Industry) is a
recommendation for defining universal meta information and variables in the IMS Manifest. These specifications
are an extension of the SCORM 1.2 standard.
Note
Note that SAVE 1.0 can only be used for the SCORM 1.2 standard and not for SCORM 2004.
264
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Publication
The purpose of meta information defined using SAVE 1.0 is to define learning content issued in a SCORM package
in greater detail. The following parameters can be defined in the Producer:
Meta information
Description
title
Object name.
description
Object description - also used for associated modes.
keyword
Defined object search words - these are also used for
associated modes.
version
Version of the resources issued - the value can be
amended manually.
copyright
Definition of a copyright for the issued content. The
required information in the IMS Manifest is Yes or No.
The meta information title, description, keyword for an object can be defined in project explorer; the meta
information version and copyright are available as options in the Create SCORM/AICC dialog.
Note
When using the SAVE 1.0 standard you need to make sure that this is supported by the LMS you are
using.
11.13 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).
All types of information found in a workarea can be linked to the context-sensitive help file accordingly, such as
simulations, navigations, books and documentation.
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
NW Enterprise Portal
(Ajax Framework Page)
Version 7.3
COMPONENT, VIEW
SAP Workforce Performance Builder 9.3
Publication
Customer
© 2014 SAP AG. All rights reserved.
265
Application
Version
Parameter
NW Enterprise Portal
(Classic Framework Page)
Version 7.3
PAGEINDEX
Further informations about the implementation of the context-sensitive help in the applications are available in
the accordant installation guides.
11.13.1 Context Configuration
There are two methods for defining the context:

The context-sensitive information can be automatically extracted while recording a project in the SAP system.

The context–sensitive information can be manually defined under Context setting.
Recording the context in SAP
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.
Manually define the context
The contextual information can only be extracted automatically while the project is being recorded. For objects
such as books, book pages, groups and documents as well as for enhancing projects, the context must be
configured manually.
The contextual information is entered under the Context setting which can be opened by clicking on the button
Select View under the expanded view 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. 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
Wild cards 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.
266
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Publication
11.13.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...
3.
The settings dialog box opens:
o
Enter the Target Folder for storing the file.
o
Enter the URL of the published workarea with the included content,
for example http://server/workarea.
o
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.
Central workarea of a Manager
The context.html can also be exported for the central workarea of a Manager. In the URL setting, enter the
workarea location in this format: http://server/manager/wa/workarea_name/~tag/published.Specify published
content of the workarea by adding ~tag/published .
To access the content of the central workarea, users need to log on. Activate the Anonymous user to allow users
to bypass the logon.
11.13.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:

Preview Context File

Search and Replace
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.
SAP Workforce Performance Builder 9.3
Publication
Customer
© 2014 SAP AG. All rights reserved.
267
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
The function Search and Replace 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… menu entry.
2.
A dialog opens and includes the following parameters:
o Search: Specify the entry that should be searched.
o Replace by: Specify the entry that should be replaced.
3.
Confirm the dialog with Ok.
Afterwards, the search entry is replaced.
268
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Publication
12
Workarea and Administration
The following chapters give an introduction to the Workarea and the Centrals Workarea as soon as to the editing
and administration of resources and contents.
12.1
The Workarea
The workarea is the base directory for working with the Producer. It contains all the necessary files for creating
and playing back learning content as well as the actual files of the learning content that has been created.
Producing learning content always requires one workarea to be selected.
The Producer automatically creates all the relevant data and directories when a new workarea is set up. These
files deposited in the Workarea are available via the project explorer's tree structure, which can be used to
organize, edit and replace them. The files for creating and playing back learning content are filed as resources.
The learning content is created as projects and book pages and organized in groups and books.
When selecting the workarea within the tree structure, the path to the relevant folder is displayed on the right in
the object editor. If a central workarea was set up on a server, then this path will be displayed there as well.
Note
So that contents can be created and played back free from errors, no alteration to files and the workarea
directory structure is permitted.
The following sections will give you an overview of the workarea, how it is presented and used in the Project
Explorer and with what objects and how it is set up in the folder structure.
12.1.1
Structure and Objects of the Tree Structure
The objects contained within the workarea are displayed in the Producer in the project explorer tree structure.
This is broken down into the following areas and content:
Main Level
Level 1
Level 2
Level 3
Workarea
The topmost entry in the
tree structure shows the
local and Central
Workarea selection.
SAP Workforce Performance Builder 9.3
Workarea and Administration
Customer
© 2014 SAP AG. All rights reserved.
269
Main Level
Level 1
Level 2
Level 3
Resources
List of all of the resources
available in a Workarea
for organization and
editing.
Resource Group
Resource
Content
The Content group is the
base group with all of the
Workarea's available
learning content.
Group
Project: Simulation
Modes
Documents
Project: Context
Assistant, Process
270
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Workarea and Administration
Main Level
Level 1
Level 2
Level 3
Assistant
Mode
Book
Book Page
Text Unit
Master Document,
Compound Document
Shortcuts
These objects are
shortcuts to objects filed
in another location within
a tree structure which
allow these objects to be
launched directly.
Unsorted
Unsorted are where
Workarea objects that
are not assigned to any
base group are filed.
SAP Workforce Performance Builder 9.3
Workarea and Administration
Customer
© 2014 SAP AG. All rights reserved.
271
12.1.2
The Resources
The Resources
area is where you have access to all the Workarea files and settings you need for creating and
playing back learning content. These are broken down into resource groups each with their own individual
resources.
You can use the structure to apply settings for individual resources and exchange resources when using a Central
Workarea.
12.1.2.1
Resource Overview
The table provides you with an overview of the standard resources available in the workarea:
Resource
Adaptable Resources
Description
Contains adaptable resources of styles and settings.
The standard resources of the Adaptable Resources
are:

Authoring Settings

Playback Settings

Navigation Authoring Settings

Navigation Playback Settings

Text Style

Navigation Style

Desktop Assistant Style

trainer Standard Style

trainer Mobile Style

Documentation Style

Documentation Style (Right-to-Left)

Master Tags
Book Styles
Contains the book page and book reader design.
Bubble Styles
Contains the various bubble designs.
The Edit Bubble Styles... button in the object editor
can be used to launch the bubble style editor for
editing the bubbles.
Documentation Settings
Contains the settings for the generation of
documentation of all types.
You will receive the following functions when you
select a resource:
272
Customer
© 2014 SAP AG. All rights reserved.

Open Settings - Opens the selected setting
resource in the central configuration dialog.

Duplicate... - Duplicates the selected setting
SAP Workforce Performance Builder 9.3
Workarea and Administration
Resource
Description
resource for the creation of a setting variant.
Publishing Rules
Contains the publishing rules for the publishing of
content. The resource type is visible after a publishing
rule is defined.
See also the chapter Publishing Rules Resource.
Playback Dictionaries
This resource contains text blocks that can be used in
a content’s playback. Here we differentiate between:

Standard - library, trainer and book reader

Navigator
You will receive the following functions when you
select the resource group:

New dictionary – Setting up a new dictionary. This
causes the original folder to be copied, as a result
of which the standard texts can be transferred
into the new ones.
You will receive the following functions when you
select the resources:

Open Dictionary – Opens the dialog for
customizing the texts.
Help
This resource contains the Help files for the library,
trainer and book reader in the available languages.
Macrosets
Contains the macroset files. These are:

Navigation

Standard (Simulation)
Application Profiles
The resource contains the application profiles for
recording the applications.
Recording Dictionaries
The dictionary contains the bubble text modules for
the project types. These can be edited using the Edit
Dictionary dialog.
You will receive the following functions when you
select the resource group:

New dictionary – Setting up a new dictionary. This
causes the original folder to be copied, as a result
of which the standard texts can be transferred
into the new ones.
If you select a resource, you will receive the following
functions:
SAP Workforce Performance Builder 9.3
Workarea and Administration

Set as default – If a number of resources are
available, this allows you to determine which one
is to be used.

Open Dictionary – Opens the dialog for
customizing the texts.
Customer
© 2014 SAP AG. All rights reserved.
273
Resource
Description
Scripts
The Scripts resource contains all the scripts that
activate special functions.
Configurations
This resource contains the configuration files for the
content authoring and playback.
If additional resources were added, the resource to be
used can be defined via the Set as default function.
trainer
Contains the trainer configuration files.
Which trainer version is to be used can be defined in
the object editor using the Set as default function.
Filters
Contains the created filter definitions. The resource
type is visible after a filter is defined.
You will receive the following functions when you
select the resource group:

New Filter – Opens the Edit Filter dialog for the
creation of a new filter.
If you select a resource, you will receive the following
functions:
12.1.2.2

New Filter – Opens the Edit Filter dialog for the
editing of the selected filter.

Apply Filter – Activates the filter or search for the
content tree.
Managing Resources
You can import and update resources or manage them on the central workarea:
Importing resources
In addition to the already existing resources, you have the ability to import additional resources into the Workarea
as an archive.
1.
To do so, click on the Import Archive... function in the Workarea -> Administration menu.
2.
Select your archive file in the open dialog. Then click on Open.
3.
You will then see the files contained in the archive displayed in a dialog. You can now select which content is
to be imported into your workarea. Click on OK to import the selected resources.
4.
The import is displayed by a progress dialog. After completion, confirm this with OK.
The imported resource is now available in the relevant resource group in the resource overview. A number of
resources need to be activated for use. Also pay attention here to the resource overview.
274
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Workarea and Administration
Central workarea
When using a central workarea, the resources can be managed via the tree structure to make them available to all
authors. Individual authors can then download the resources for their own local workarea. A local workarea's
resources can also be transferred to the central workarea and exchanged.
This is done using the context menu when selecting a corresponding resource group or by means of the Central
Workarea menu.
Updating resources
If you have installed a new version of the Producer, you will need to migrate the standard installation resources.
Also pay attention here to the chapter Migrating a workarea.
12.1.2.3
Automatic Update
The Producer allows automatic resource updates to be set up. To this end, the resources to be updated can be
held centrally. This storage location will then appear in the Producer. When the Producer starts up, it checks
whether resources are available and then imports them into the Workarea.
Note
The function cannot be used for local workareas which are managed by a central workarea.
Defining the update function
You define the update function as follows:
1.
Create a resources file *.dkp containing all the necessary resources to be updated. To do so, export them
from the Producer using the Export Archive function.
2.
Now create update.xml. This identifies the resource files to be updated and the corresponding Producer
version. You will find the XML file structure below.
3.
Set up a folder in your target directory, on a server, for example. File update.xml here along with all the
resource files to be updated.
4.
Now specify the folder in the Central Configuration Dialog of the Producer to be updated under Application ->
Directories in the parameter Updates' path. To do so, go to Search for folder to select the storage location.
Once the Producer has started the available resources will automatically be imported into the Workarea.
Individual resources can now continue being filed in the folder and will be imported automatically each time the
Producer starts.
Note
Ensure when using the update function that it overwrites any resources in the workarea.
update.xml
The update.xml structure may appear as follows:
The function cannot be used for local workareas which are managed by a central workarea.
<Update>
<Application name="producer">
<AppVersion Minimum="9"/>
<Resource mandatory="true">ressource.dkp</Resource>
SAP Workforce Performance Builder 9.3
Workarea and Administration
Customer
© 2014 SAP AG. All rights reserved.
275
</Application>
</Update>
12.1.2.4
Copy Over a Bubble Style
The Copy Over function for a bubble style can be used, to replace a used bubble style with another resource. A
case can be, to update an outdated bubble with a new created resource. Thus, not each bubble must be changed
in the whole content.
To copy over a bubble, proceed as follows:
1.
Select the source bubble in the resource tree, which should override the old bubble.
2.
Click on Copy Over... in object editor.
3.
In the opened dialog, adapt the following parameters:
o Copy "Bubble name" over:
Select the bubble style, that should be overridden.
o Name:
Insert a name for the bubble.
The general name form is: Old Name (New Name)
4.
Click on Ok, to execute the override.
To restore a changed standard bubble style, use the Update Resources function.
12.1.3
The Learning Content
Various objects for creating content are available in the Producer. Each of these objects in the tree structure is a
reference to the actual object in the particular Workarea folder. This enables individually specific organization and
use of the objects in the local and Central Workarea. You can refer to, or create a shortcut to, an object multiple
times as well as manage its structure accordingly in conjunction with a Central Workarea.
The Content group is the highest learning content group and is created automatically when setting up a Workarea.
This is where all the learning content is filed. Furthermore, the structure contained in the group is used for
presentation in the library.
This group can be amended via Group options in the context menu with each available group capable of being
defined as the root group. This is necessary when using a Central Workarea so that the corresponding root group
can be set up locally.
Note
Bear in mind that only objects contained in the root group are displayed in the library. Shortcuts and
unsorted objects are not available in the library.
Root group in the Central Workarea
The root group of a Central Workarea cannot be changed.
It is therefore necessary, when working with a Central Workarea, to define the root group locally:
276
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Workarea and Administration
1.
First of all select the Check out object... function in the Central Workarea function. Define the Workarea
contents in the open dialog and click on Check out object.
The objects will then be filed as Unsorted.
2.
Now select the topmost group Open the Context menu and go to Group operations -> Set root. The group is
now set up as the root group, the previous group is filed under Unsorted and can be deleted.
12.1.3.1
Learning Content Objects
The following objects for creating and managing content are available in the Producer:
Projects
Projects are the basic objects for the creation of content. Two main types are available here, which differ in terms
of their creation and use.

Simulation
These are used to generate simulation modes that explain a process to the learner, who can work through it.
This involves the creation of screenshots with active areas.
Projects can also be created with quiz items and documentation generated from the projects.

Navigation
This projects illustrate the process directly within the application and are used to support the user while he is
working with it. This involves bubbles and highlights being displayed on the application user interface.
Simulation projects can be converted into a Navigation. That means that a process can be used both as a
simulation and as help in an application and does not need to be rerecorded.
The projects created can be inserted in a group for presentation in the library or exist on a standalone basis.
Book pages
Book pages are used to present modes, documents and other content in various media formats.
Once created, book pages can be inserted in a book or exist on a standalone basis.
Groups
Projects, book pages and books and documentation as well are structured by groups. These can be interleaved
with one another and also make possible a structured outline in a central document.
Books
Book pages are amalgamated into books. When book pages are inserted in a book, the book is displayed in the
book reader to make it possible to scroll the pages.
12.1.3.2
Templates for Content Objects
Templates can be made for objects that are created for workareas in the Project Explorer. The templates are
useful for saving time as well as for ensuring uniformity for newly created objects when more than one author is
working on a project.
Templates can be created for the following objects:

Projects

Groups

Book pages
SAP Workforce Performance Builder 9.3
Workarea and Administration
Customer
© 2014 SAP AG. All rights reserved.
277

Books

Text Units
Creating a template
To create a template, proceed as follows:
1.
First, create a new project by clicking on New Project from the toolbar in the project editor. It is recommended
that you save this in a folder in your workarea that is specifically for templates.
2.
A dialog box will appear. Enter a name for the template, e.g. Standard template. Confirm by clicking on Ok.
3.
Next, configure your project as desired. To do so, from the project editor, open the main configuration dialog
box and define all the project-specific settings.
For books and book pages, you can define the layout, the positioning grid and content.
4.
Save the project.
Choosing a template
If a template has already been created, you can use it to create a new object (group, book, page or project) or it
can be defined as a general template for creating new objects, which will then serve as the default settings for the
new objects.
To use an existing template, proceed as follows:

For an individual object
Create a new object. Then select your template from the dialog box under Template about the Change…
button. All the objects will then appear in the opened dialog box. Select your template and click on OK.

As a general template
If you would like to use a template for all the objects, open the central configuration dialog from the menu
Tools -> Settings in the area Application -> Templates. Select the desired template to be used for the object
and click on OK.
12.1.3.3
Using of References
The physical object of a learning content can be referred to as often as necessary. If changes are made in a
reference, these are also contained in the other references.
The opportunity therefore exists to use a particular object for different parts in a project structure. This is the
case, for example, if an object is to be offered for different target groups in conjunction with different additional
content.
Creating a reference
Note
Bear in mind that only one reference can be created for an object within a group. Create object references
only in different groups.
1.
278
To create a reference, select the desired object in the tree structure. Then, with the right mouse button held
down, move the object to the appropriate position using drag&drop.
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Workarea and Administration
2.
A context menu is opened when you release the mouse button. Select the Create reference menu option to
create the reference.
Note
If your references contain Word documents and you use them to create a central document, this central
document will include all the documents referred to. If you wish to block the publication of duplicate
documents, then you can hide them while the central document is being published or define the contents
by means of filters.
Recommendation
You can use filters to define the way objects are depicted for different users so that content is not
displayed to a user multiple times.
12.1.3.4
Creating Shortcuts
Shortcuts allow you to access any string within a complex project structure. For example, a project can be filed
locally as a reference from the Central Workarea so that it can quickly be made available for editing.
Note
As shortcuts refer to an object and are therefore not contained in the base group, they are not displayed
in the library.
Creating a shortcut
To create a shortcut, select the desired object and right click on the context menu to open it. Then click on New
shortcut.
The shortcut is now placed beneath the base group and flagged with a shortcut symbol
or book then it will be displayed with the associated sub objects.
. If the object is a group
Deleting a shortcut
To remove a shortcut, select the object with the shortcut symbol and delete it using the Delete (Del) key or via the
Edit -> Delete menu.
Linking a shortcut
To make it easy to link objects, up to five links are displayed in the Insert link dialog. This way, content used
multiple times can be selected quickly and directly.
12.1.3.5
Unsorted Objects
As the Workarea objects are references, objects may in certain circumstances be displayed in the Project Explorer
as being unsorted. This will be the case if an object is not assigned to the topmost or to a subordinate group.
Unsorted objects can arise for the following reasons:
SAP Workforce Performance Builder 9.3
Workarea and Administration
Customer
© 2014 SAP AG. All rights reserved.
279

by objects migrating

when importing archives

by downloading objects from a Central Workarea

by setting a new topmost group
The Unsorted
are arranged at the bottom of the tree structure.
Note
Unsorted objects are not displayed in the library. To display them, subordinate the objects to the topmost
group.
Inserting unsorted objects in the topmost group
You can assign unsorted objects to the topmost group and thus relocate them to the desired position within the
tree structure. This is done by dragging and dropping the object in question.
If you want to assign an object to a specific group or book then you can do so using the Append Unsorted. To do
so, select an object, open the context menu and click on Append Unsorted. All objects filed as being unsorted, are
then assigned to the group or book.
Unsorted objects when using the Central Workarea
Unsorted objects may appear in a Central Workarea for a variety of reasons. This is how you deal with a base
group in the central workarea:

Unsorted objects may occur when using a Central Workarea if an object is downloaded without the referenced
objects.
You can now also check out the referenced objects. These will then be located within the base group in their
actual position.

Unsorted objects can also occur if a Central Workarea has changed. This is then to be reallocated accordingly.

It is not possible to use multiple topmost groups in a Workarea. When downloading additional topmost
groups, these are set as unsorted objects.
When using a central workarea, always create a new Workarea.
12.1.4
Folder Structure in the Workarea
The content of the resources and learning content depicted in the Project Explorer's tree structure are filed in the
Workarea folder.
Folders in the Workarea have a flat structure. That means that the learning content folders are not nested.
Accordingly, projects, groups, book pages and resources as well all have their own folders in which the associated
files are held.
The corresponding learning content structure and basic object attributes are laid down in the topmost group's
entity.xml. Structural changes are automatically mirrored in the relevant file.
280
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Workarea and Administration
12.1.4.1
Resource Folders
The resource folders contain the necessary files for creation and playback. Similarly, the structure depicted in the
project explorer is available in the Workarea folder structure.
The folders in question can be launched directly via the project explorer. To do this, select the desired resource
group or resource, open the context menu and click on Open folder.
Note the section Resource overview for the content and names of the respective folders.
12.1.4.2
Learning Content Folders
The learning content folders are organized according to projects, groups, book pages and books. The learning
content is not filed within the structure, as portrayed in the tree structure, as this depicts object references. The
advantage of this is the ability to organize and manage the content in reference form in many different ways.
The current learning content structure is recorded in the entity.xml file contained in each folder. The group
operating as the topmost group records the content structure, and a corresponding subgroup or book the rest of
the content.
Projects (project)
The project directory contains the individual project folders. This is where the folders are located containing the
relevant files and documentation for the individual projects.
The macro folder contains the screenshots of the Screen macros as well as the field icons. The dump_page folder
where the screenshot img.png is stored is set up for the Screen macro. The screenshot is integrated into an HTML
page (index.html) for editing and display. The XML file page.xml containing applicable page information on the
screenshot is also available.
When documentation is created, the doc_files folder is set up, which holds the corresponding application page
screenshots and field icons.
The project file is stored in the project.dpr format. The name is the same for all projects, the advantage of which is
that the project name can be changed in the Producer at any time without difficulty. The name of a project in the
Project Explorer is also recorded in the entity.xml.
After a project has been generated, the various modes are filed as JavaScript files (*.js), which can be interpreted
by the trainer when being played back there.
Groups (group)
Projects, books and book pages as well as other groups can be filed in groups. This structure is then saved in
entity.xml. The folder can also contain filed documentation.
Book pages (slide)
The folder contains all the necessary files for displaying a book page. If images or media files were inserted, the
Producer files them in the folder.
slide.xml stores all the necessary information for building and displaying the book page and its objects. The book
page's entity.xml contains the book page name.
SAP Workforce Performance Builder 9.3
Workarea and Administration
Customer
© 2014 SAP AG. All rights reserved.
281
Books (book)
Books serve to combine a number of book pages. The folder contains the entity.xml, which records which book
pages have been included.
Text Units (cdoc)
The folder cdoc contains the files of the text units.
12.1.5
Creating a Workarea
If you would like to create a new Workarea, then select the Select Workarea... function in the Workarea menu.
1.
A Workarea selection dialog is opened after startup, offering a preset path for filing the folder.
This path is under:
%USERPROFILE%/Producer Workareas/ Workarea
Changing the name
If you would like to change the name of the Workarea, you can do so using the path data in the Target
directory. Replace the prescribed name with the new name.
Changing the base directory
1.
To set a different directory as the base directory, click on the Select button.
2.
Designate the folder in the directory structure in which the Workarea is to be set up and click on Create
new folder. Give this a name of your choosing.
3.
Then click on OK to confirm the dialog. The path for the Workarea folder is now displayed in the dialog.
2.
You will see the standard installation resources displayed in the window under the Target directory. You can
use this selection to define the resources to be used.
3.
Click on Create to set up the Workarea. The required files are now copied into the target directory.
Once all the files have been copied into the corresponding working directory, you can confirm the conclusion of
the creation process by clicking on OK. 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 via Import Archive…
12.1.6
Shortcut on Desktop
If you use several workareas, you can start the Producer with a specific workarea by using a shortcut. You have to
create a separate shortcut on your desktop for each workarea.
Note
Note that the default shortcut of the Producer always opens the last used workarea.
282
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Workarea and Administration
To create a shortcut, proceed as follows:
1.
Create a new workarea or open an existing workarea in the Producer.
2.
Select the workarea entry in the project explorer’s tree view.
3.
Click on the button Create a shortcut on desktop in the object editor.
The shortcut is created and is assigned the name of the workarea.
12.1.7
Multi-User Capability in Workareas
The workarea contains a mechanism that prevents multiple users in the same network from opening and usin g
the same workarea. This is the purpose of the *.lock file stored in the workarea folder.
If multiple users are to use a common structure for their projects, the use of a central workarea should be
considered.
Note
If Producer quits unexpectedly and the *.lock file is not automatically deleted, this should be done
manually to ensure that all users will be able to access the workarea.
12.2 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 - central 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
SAP Workforce Performance Builder 9.3
Workarea and Administration
Customer
© 2014 SAP AG. All rights reserved.
283
7.
Creation of a new Manager password (only Migration from 9.1)
8.
Migration of the central workarea by the master author
9.
Migration of the local workareas by the standard authors
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 user-defined
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.
For further information on changes in the resources, refer to the chapter 'Differences in Resource Structure'.
Migration of an Instant Producer workarea
The workarea migration of an Instant Producer 9.2 for the Enterprise Edition is executed automatically after the
first start of the program.
The workarea migration of an Instant Producer 9.2 for the Desktop Edition can be done after the migration of the
resources in the central workarea (see chapter Central Workarea - Enterprise Edition). The synchronization is
executed automatically after the first start of the program.
12.2.1
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.
284
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Workarea and Administration
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...
4.
A dialog opens automatically. Click on Migrate Workarea.
5.
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'.
6.
Click OK to start the migration.
The migration will now be executed.
7.
Click OK in the progress dialog, if the migration is completed.
8.
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.
9.
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.
12.2.2
Central Workarea - Enterprise Edition
When updating the workarea in an authoring environment with a central 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 central workarea the following preparations and requirements are necessary:
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 1863148 about the clean up of deleted files in a database.
SAP Workforce Performance Builder 9.3
Workarea and Administration
Customer
© 2014 SAP AG. All rights reserved.
285

Backup central 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 central 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 central workarea is only possible from the Manager version 9.2 or higher. Consider the
following:
o 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.
o 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 appears, insert your user data with the new password.
3.
Start editing resources to get all write permissions. Select the Resources tree and click on Central Workarea > Start editing all objects...
4.
Close the Producer.
5.
Click Shut down in the opened dialog. 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...
5.
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.
286
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Workarea and Administration
Through the switch of the Producer versions the authentication dialog may appear twice. Insert your user
data again.
6.
A dialog opens automatically. Click on Migrate Workarea.
7.
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'.
8.
Click OK 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.
9.
Click OK in the progress dialog, if the migration is completed.
10. The synchronization of all resources with the central workarea is started automatically.
Click OK in the progress dialog, if the synchronization is completed.
11. Click Restart in the opened dialog that the changes can take effect.
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 central workarea in your local workarea.
Migration steps for the standard author
After the migration of the central 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...
4.
The authentication dialog appears. Insert your user data with the new password.
5.
After the workarea opens, the synchronization of the resources with the central workarea starts
automatically.
If the authors use an Instant Producer the synchronization of the workarea is executed automatically after the
start of the program.
12.2.3
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.
SAP Workforce Performance Builder 9.3
Workarea and Administration
Customer
© 2014 SAP AG. All rights reserved.
287
Migration setting areas
The migration dialog box contains the following setting areas:

Documentation Settings and Style:
Contains the setting and style resources, that are relevant for generating documentation.

Authoring and Playback Settings:
Contains the setting resources, that are relevant for the creation and playback of content.

Deprecated Resources:
Contains outdated resources, which have to be removed. The resources will be replaced by new resource
types.

Required Resources:
Contains resources, which have to be installed. The resources are necessary for content creation and
playback.

Recommended Resources:
Contains resources, which can be installed optionally.

Incompatible Old Resources:
Contains outdated resources, which have to be replaced with a newer resource type.

Compatible Old Resources:
Contains resources of the same type, which have to be updated.

User Resources:
Contains resources, which have to be updated.

Customized User Resources:
Contains adapted resources, which have to be updated.
The areas that are shown depend on the available resources.
Migration actions
The following migration actions can be executed for a resource:

Convert:
Updates the files and structures of an available resource.

Install:
Integrates a new resource into the resource structure.
Can be used instead of converting a resource. Does not save the available settings.

Remove:
Deletes an outdated resource from the structure.

Overwrite:
Updates the files of an available resource.

Skip:
Keeps the current resource status.
When selecting a resource, you will see the version and included sub-resources in the help box at the bottom of
the dialog box.
288
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Workarea and Administration
12.2.4 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
For the migration of imported resources, proceed as follows:
1.
Open the Producer with an up-to-date workarea.
2.
If you use a central 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...
4.
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 central 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.
SAP Workforce Performance Builder 9.3
Workarea and Administration
Customer
© 2014 SAP AG. All rights reserved.
289
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.
Note, that it is not possible to change the name of the resources. Import only needed resources to keep a clearly
structure.
12.2.5
Differences in Resource Structure
The resource structure of the SAP Workforce Performance Builder 9.2 - 9.x release is different to the structure in
release 9.1. This means that a migration is necessary to guarantee error-free creation and playback of content.
For the standard resources the differences are as follows:
9.1 Resources
9.2 - 9.x Resources
Adaptable Resources
290
Customer
© 2014 SAP AG. All rights reserved.
Recommended Migration
Convert and Install
Authoring Settings
Convert
Playback Settings
Convert
Navigation Authoring Settings
Convert
Navigation Playback Settings
Install
Text Style
Install
Navigation Style
Install
SAP Workforce Performance Builder 9.3
Workarea and Administration
9.1 Resources
9.2 - 9.x Resources
Desktop Assistant Style
trainer Standard Style
(includes book Style, library Style,
Mouse Pointer, trainer Panel,
Popup Style, Quiz Style, Task
Window Style)
trainer Mobile Style
Documentation Style
(includes Documentation
Templates)
Recommended Migration
Install
Install
Install
Convert
Book Styles
Book Styles
Overwrite
Bubbles Types
Bubbles Types
Overwrite
Documentation Settings
Convert
Glossaries
Playback Dictionaries
Overwrite
Help
Help
Overwrite
library Styles
Macrosets
Remove
Macrosets
Overwrite
Mouse Pointers
Remove
trainer Panels
Remove
Popup Styles
Remove
Quiz Styles
Remove
Application Profiles
Application Profiles
Overwrite
Content Glossaries
Recording Dictionaries
Overwrite
Scripts
Scripts
Overwrite
Configurations / Styles
Configurations
Remove old resource
Install new resource
Task Window Styles
trainer
Remove
trainer
Remove old trainer
Install new trainer
SAP Workforce Performance Builder 9.3
Workarea and Administration
Customer
© 2014 SAP AG. All rights reserved.
291
12.3 Synchronization of a Central Workarea
The synchronization supports the communication between the local workarea in the Producer and the central
workarea of an authoring environment in Manager. The contents and resources can be shared easily, available
changes and new objects can be checked out or saved to the server as well as the editing starts with one click.
The following chapters give you an overview about the settings and use of the synchronization and show you use
cases for your daily work.
12.3.1
Synchronization behavior of an Object
Each object, content and resource, in a local workarea has an individual synchronization behavior. The behavior
defines how the synchronization is executed on the object.
The following synchronization behavior are available:
Behavior
Description
Example Use Case
Unmanaged
Saves the object only
locally. Changes cannot
be uploaded to the
central workarea.
Can be used to create an
object and to save it to
the server, if needed.
Upload / Download
When setting the
behavior, the write
permission is stored to
the server.
Read-only
Allows only to open an
object, but not to start
the editing.
When setting the
behavior, the write
permission is stored to
the server.
Edit and share
Allows the editing of the
object and the sharing
after the editing.
The behavior is
recommended, to finish
the editing at every time.
Can be used, to look into
projects and not to start
the editing. Through that,
the content can be edited
by another author in
parallel.
Synchronize Workarea
Can be used to edit an
object and save it
afterwards to the central
workarea.
Save to server
Can be used to edit an
object and to keep the
write permission during
Save to server
Finish editing
Synchronize Workarea
When setting the
behavior, the write
permission is stored
locally.
Edit and own
292
Allows the editing and the
owing of the write
permission of the object.
Customer
© 2014 SAP AG. All rights reserved.
Synchronize Workarea
SAP Workforce Performance Builder 9.3
Workarea and Administration
Behavior
Description
Example Use Case
The editing cannot be
finished.
The behavior is
recommended, to keep
the write token during
editing.
an editing process.
Upload / Download
When setting the
behavior, the write
permission is stored
locally.
Synchronization parameters in object editor
The Protocol area of the object editor includes the following synchronization parameters for a selected object:

Synchronization behavior:
Displays the current synchronization behavior of the object.

Recommended synchronization behavior:
Displays the synchronization behavior which is recommended for other authors. The behavior is set
automatically and depends on the synchronization behavior of the object.
The recommended synchronization behavior is also displayed in the Manager.
Example
o
Synchronization behavior : Edit and own - author owns write permission
o
Recommended synchronization behavior : Read-only - other authors can read, but not edit
12.3.2
Setting the synchronization behavior
The synchronization behavior can be set for a new object or can be changed for available objects.
Synchronization behavior of a new object
The creation dialog for a new object includes the setting Synchronization behavior. About the setting you can set
one of the following behavior:

Inherit from parent - uses the behavior of the parent macro

Unmanaged

Edit and share

Edit and own
After the creation of a new object the workarea has to be synchronized for the upload of the object to the central
workarea.
Synchronization behavior of available objects
A synchronization behavior can be set for an object or an object structure. To set the behavior, proceed as follows:
1.
Select an object in the tree of the project explorer.
2.
Click on the Central Workarea menu. Alternatively use the context menu of an object.
SAP Workforce Performance Builder 9.3
Workarea and Administration
Customer
© 2014 SAP AG. All rights reserved.
293
3.
Click on one of the entries:
o Set synchronization behavior - used for one object
o Set synchronization behavior for all objects - used for an object and the sub-objects.
A dialog opens, to select the objects. Confirm with OK.
4.
Afterwards, a dialog opens.
In the drop-down box select the needed synchronization behavior.
5.
Click on OK, to change the behavior.
After setting a synchronization behavior the object or tree is synchronized to the central workarea.
12.3.3
Synchronizing a Workarea
The synchronization of a workarea can be done by using the toolbar button Synchronize Workarea in the project
explorer. With click on the button, the Producer synchronizes the objects of the local workarea with the central
workarea regarding the synchronization behavior of the objects and the available changes. Through that the
objects are saved centrally and the local workarea is updated with central changes. This means, the
synchronization runs in both directions.
Recommendation
Depending on the number of objects and the available changes in a workarea the synchronization can
take a while. The synchronization should be done as preparation of the editing as well as after the editing
of a number of objects.
Note
After the synchronization your changes are visible on the Manager with some minutes delay. This
depends on the Default Caching Value in your server settings.
Locally changed objects
In a workarea edited objects are highlighted with a star icon. This gives you an overview, if changes are only local
available.
Synchronizing when closing Producer
When closing the Producer a dialog with the buttons Synchronize and Shut down is shown. With click on the
Synchronize button the synchronization is executed. This means, available changes are saved to the server and
294
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Workarea and Administration
the write permissions of the objects with the behavior Edit and share are returned.
With click on the Shut down button local changes and write permissions are kept.
12.3.4 Samples for using synchronization
The following samples show you, how to use the synchronization in different situations.
Create a new object (book, book page, project, etc.) in content structure
Steps to do:
1.
Start editing
parent object (i.e. group or book for inserting the new object).
2.
Select parent group and create New Project
3.
Synchronize Workarea
4.
Finish editing
with synchronization behavior Edit and share.
.
parent object and new object.
Recommendation
When using a slow internet connection, use the following alternative steps:
1.
Start editing parent object.
2.
Select parent group and create New Project with Unmanaged.
3.
Set synchronization behavior… to Edit and share (or Edit and own).
4.
Finish editing parent object and new object.
Change existing content
Steps to do:
1.
Start editing
the object you want to change.
2.
Synchronize Workarea
OR
as alternative Finish Editing
SAP Workforce Performance Builder 9.3
Workarea and Administration
or Save to Server
.
Customer
© 2014 SAP AG. All rights reserved.
295
Download new objects from Manager which are not in local workarea
Steps to do:

Synchronize Workarea
(if your local workarea has only a subtree of all content, you will get new objects
only for your subtree but not outside your tree)
OR
as alternative Menu Central Workarea -> Check out Objects…
(a dialog shows all new objects and you can
select the needed objects for download).
Retrieve all changed objects from Manager (changes of other authors)
Steps to do:

Synchronize Workarea
OR
as alternative Start editing all objects…
12.3.5
(and Finish editing all objects…
) for the desired subtree.
Managing central workarea without synchronization
The synchronization is the recommended function for the management of a local workarea with a central
workarea. To manage a local workarea without the synchronization, deactivate the option Enable synchronization
in the central configuration dialog. The setting is available in the section Application -> Central Workarea.
12.4 Refreshing Workarea and Objects
To reduce the loading time of the workarea the structure is not reloaded permanently. With the refresh functions
you are able to refresh the structure or individual objects manually to the current status. This can be done before
uploading a structure to the central workarea or after the checkout of sub-structures.
The following functions are available:
Function
Menu / Button
Description
Example Use Case
Refresh Workarea
Button in toolbar
Refreshes the workarea
structure.
After changes in
structure.
or
Menu Workarea
Refresh Workarea and all
Objects
Menu Workarea
Refreshes the workarea
structure and the object
references.
After changes in
structure and editing of
many objects.
Refresh Object
Object -> Context Menu
Refreshes the object
references.
After change of
screenshots in
interactions of
simulations.
296
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Workarea and Administration
12.5 Adapting the workarea structure externally
Independent to the editing and structuring of content objects in the project explorer you can edit the workarea
structure in an exported CSV file. This can be done for example as preparation for a content project to create a
first structure of the objects or to have an overview of a complex content structure for a cleanup.
The functions Export Structure and Import Structure are available in the menu Tools -> Workarea Structure.
The editing in the CSV file can be done for all content objects:

Group

Project

Book

Book Page

Text Unit
The following actions can be executed for an object:

Update:
The action changes an available object.
Can be used, to insert further object information, e.g. Keywords, Tags, or to change the position of an object
in the structure.

Add:
The action creates a new object.
Can be used, to add further objects or object structure with initial attributes, e.g. name, language.

Delete:
The action deletes an object and moves it to Unsorted.
Can be used for an cleanup of a structure.
12.5.1
Editing a structure
The export and import of a workarea structure can be done with the following steps.
Consider the following recommendations to allow a correct editing:

before editing, export a new workarea structure with the up-to-date objects

do not move any objects in the project explorer in the meantime

do not edit any object attributes in the project explorer in the meantime
1. Export of a workarea structure
To export a structure, proceed as follows:
3.
Select the root group of a structure or sub-structure.
4.
Click on the menu entry Tools -> Workarea Structure -> Export Structure...
A dialog opens.
5.
Select a folder as target directory.
6.
Insert a File Name.
7.
Click Save to export the structure.
SAP Workforce Performance Builder 9.3
Workarea and Administration
Customer
© 2014 SAP AG. All rights reserved.
297
2. Editing of the CSV file
Edit the workarea structure and the object information in the CSV file as needed and update, delete or add your
objects.
For further information about the structure and attributes of the CSV file see the chapter Structure of the CSV file.
3. Import of a workarea structure
To import or reimport a structure, proceed as follows:
1.
Select the root group of a structure or sub-structure.
2.
Click on the menu entry Tools -> Workarea Structure -> Import Structure...
A dialog opens.
3.
Select a CSV file with the needed structure.
4.
Click Open to import the structure.
5.
A dialog opens showing the actions to be executed.
Click Yes to import the file.
Click No to cancel and to change the CSV file.
12.5.2
Structure of the CSV file
The CSV file includes the following columns:

Action
Contains the action which is executed during import.
Possible values:
o update - also default, if no value is set
o add
o delete

Template
Contains the UID of a template object.
When creating a new object, the UID for a template can be inserted.

UID
Contains the UID of an object.
Do not change the UID to avoid an incorrect assignment.
When creating a new object, the field has to be empty. The UID will be generated during the creation of an
object.

Class
Contains the object type.
Possible values:
o group (Group)
o project (Project)
o book (Book)
o slide (Book Page)
o cdoc (Text Unit)
298
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Workarea and Administration

Caption
Contains the name of an object. The position in the column visualizes the position in the structure.
Insert a further column to create deeper structure. Leave the column headers empty.

Description
Contains the description of an object in HTML format.

ShortDesc
Contains the short description of an object in HTML format.

Keywords
Contains the keywords of an object.

ContextID
Contains the context IDs of an object.

Hidden
Defines the visibility of an object.
Possible values:
o
FALSE (object is visible)
o
TRUE (object is hidden)

Language
Defines the language of an object.
For possible values see chapter Overview content languages.

Tags
Contains the tags of an object.
In the rows the objects are ordered as the position in the project explorer.
12.6 Filters and Search in the Workarea
The ability to set up filters is offered to enable large workareas to be better administered. These can be applied to
the tree view in the project explorer, for publishing workareas or for the use in the library by the learners.
A filter is based on one or more properties that you can freely create using conditions and assign to the desired
learning content. These kinds of properties can be master tags or tags as well as language or type of objects. If a
filter is selected, only those objects are displayed in the tree view that correspond to the filter.
Additionally to filters a search allows the authors and learners to find individual content in a structure by inserting
a search term.
12.6.1
Master Tags and Tags
Tags are terms or strings that are defined by the authors and can be used to create filters. There are two types of
tag:

Master tags:
The type is used for the complete workarea and can be selected for each object.A master tag only needs to be
created once. Master tags are managed as Adaptable Resources in the resource tree.
The type is recommended for globally used tags.
For more information, see Managing Master Tags.
SAP Workforce Performance Builder 9.3
Workarea and Administration
Customer
© 2014 SAP AG. All rights reserved.
299

Tags:
The type is used for an individual object and has to be created each time it is assigned.
The type is recommended for object-specific tags.
For more information, see Assigning Tags.
12.6.1.1
Managing Master Tags
Master tags are managed in the Master Tags dialog box. Choose Tools -> Edit Master Tags... in the menu to open
this dialog box.
Creating and deleting master tags
In the Master Tags dialog box, you can create and delete master tags.
To create a master tag, proceed as follows:
1.
Click on the Add button. A dialog box opens.
2.
Enter the name of the master tag.
3.
Confirm with OK.
To remove a master tag, proceed as follows:
1.
Select the master tag in the list.
2.
Click on the Delete button.
Once you have created or deleted your master tags, close the dialog box by clicking on OK.
Master tag resource
When you create master tags, a Master Tags resource is created in the Adaptable Resources of the resource tree.
This resource includes all master tags. Choose the Edit Master Tags... button in the object editor to open the
editing dialog box.
The resource allows you to use the master tags consistently in different workareas and you can also handle the
resource in an authoring environment with a central workarea.
12.6.1.2
Assigning Tags
If you have defined master tags, you can assign them to the objects within your tree structure:
1.
Select the object in the tree structure to which you would like to assign a master tag.
2.
Then click on the button Edit Tags... next to the parameter Tags in the object editor to open the assignment
dialog.
3.
In this dialog you can now assign one or more master tags to the object. To do so, activate the corresponding
checkbox.
4.
Click on OK to confirm the dialog.
300
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Workarea and Administration
Creating a tag
You can create additional tags in the Edit Tags dialog. This allows you to provide a filter with more complex
criteria.
The tags created in this manner are not available in the Edit Master Tags... dialog and only used for the object.
To do this, enter a tag in the text box and click on Add. You can then assign the tag to your object.
If you want to delete the tag from the object, deselect the tag in the dialog and confirm with OK.
12.6.2 Creating Filters
To create a filter for your workarea, proceed as follows:
1.
Open the Edit Filter dialog. To do this, select New Filter... from the drop-down list above the tree structure.
2.
Enter a Filter Name in the upper text box.
If you do not enter a name, the combination of the filter criteria is inserted for it.
3.
You can specify the filter using the drop-down list.
You can find examples in the following section:
Selecting properties
You can select properties which are used to define the filter from the drop-down list on the left:
o
Tag
o
Name
o
Language
o
Description
o
Short description
o
Context
o
Keywords
o
UID
o
Object type
Selecting conditions
Criteria can be defined to further specify the filter in the drop-down list in the middle:
o
is (not for Description, Short description)
o
contains
o
begins with (not for Description, Short description)
o
ends with (not for Description, Short description)
o
does not contain (not for Description, Short description)
Tags and entries
You can select the existing master tags or tags using the drop-down list on the right.
Entries can also be made to describe the filter in accordance with the properties. These are not saved and
must be reentered if the filter is used again.
4.
After a filter definition is created, the and / or buttons are activated that you can use to include other
definitions to refine the filter.
o
And - All definitions have to correspond to the objects to be displayed.
SAP Workforce Performance Builder 9.3
Workarea and Administration
Customer
© 2014 SAP AG. All rights reserved.
301
o Or - One of the definitions has to correspond to the objects to be displayed. Definitions that have been
added can be removed again by clicking the Delete button.
5.
Once you have defined your filter, you can confirm the dialog by clicking OK.
The created filter is now available in the filter selection in the project explorer.
If you have selected a filter, you can use the buttons to the right of the drop-down list to select whether you want
to edit or delete this filter.
12.6.2.1
library Settings
The library Settings define how a filter affects the display of the library and whether the filter is to be displayed in
the library or is only intended for editing in the project explorer. The settings affect both the local as well as a
published workarea.

Generate prefiltered library with filter
By this setting the library opens in a filtered structure matching the active filter in the project explorer. If the
setting is deactivated the library displays all content, independent from the active filter.

Use filter in unfiltered library
By this setting the filter is displayed both in the project explorer and in the library. If the setting is deactivated,
the filter can only be used in the project explorer.

Use filter in prefiltered library
By this setting the filter is also available for selection in a prefiltered library. In case the filter will not return any
matches it will not be available within selection. By deactivating the setting, only the filter necessary for the
prefiltered status can be used.
12.6.2.2
Examples of Filter Definitions
The filter definitions can be combined any way you want. Several typical uses are described in the following
section:

Language – is – en-US
Objects are filtered according to their language with this filter. The language code has to be entered in this
case.
You can find the language code for your objects in the Language field of the object editor.

Description – contains – description text
Objects that contain a specific word or text passage as a description can be filtered out with this filter.
(similar to Name and Short description)

Context – contains – context name
Objects can be filtered using their context information with this filter.

Keywords – is not – keyword
Objects can be filtered using their keywords with this filter. In this case, objects that contain this term are
filtered out.

Object type – is - project
Objects can be filtered using their type with this filter. The object types that can be used are:
o group - Group
302
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Workarea and Administration
o
project - Project
o
book - Book
o
slide - Book Page
o
cdoc - Text Unit
12.6.3 Filter Resource
Filters are stored in the Filters resource type. This means you can use the filters consistently in different
workareas and you can also handle the resource in an authoring environment with a central workarea.
The Filters resource is stored in the resource tree of the project explorer. The resource is available once a filter has
been created.
Functions in the object editor
The following functions are available when selecting the Filters resource or a filter definition in the resource tree:

New Filter... (Resource group)
Opens the Edit Filter dialog box, where you can create a new filter.

Edit Filter... (Single resource)
Opens the Edit Filter dialog box where you can edit the selected filter.

Apply Filter (Single resource)
Activates the selected filter in the project explorer view.

Deactivate Filter (Single resource)
Deactivates the selected filter in the project explorer view.
12.6.4 Search Function
The search function enables you to perform specific searches for content in the tree structure of the Project
Explorer.The relevant content is displayed as soon as a keyword is entered. You can also start the search by
clicking the Search button.
If you want to reset a search, remove the keyword you entered or select no filter in the filter list.
The last term entered is saved in the filter list for direct reuse and is written as follows: Search: Keyword
Search options
Click the Show Search Options button to display settings that further specify the content you are searching for.
The list closes again when you click Hide Search Options. The options are:

Name

Description

Short description

Keywords

Context

UID
SAP Workforce Performance Builder 9.3
Workarea and Administration
Customer
© 2014 SAP AG. All rights reserved.
303
12.7 Glossary of Terms
A glossary of terms allows you to add term definitions to your content. During playback the learners have the
ability to select a specific term in a text and afterwards the glossary entry appears in a pop-up window.
The glossary of terms is a group with text units for the term definitions that are applied to the content.
Additionally you can display the glossary entries in a glossary view in the library. See chapter Glossary View in
library.
12.7.1
Creating a Glossary
To create a glossary, proceed as follows:
1.
Create a group using the New Group toolbar entry.
You can use several sub-groups to structure (e.g. alphabetic) the content in the project explorer or for the
glossary view in the library.
2.
Create the text units using the New Text Unit toolbar entry. Insert the text units into the group.
3.
Define the glossary entries. Each text unit includes an own term definition:
o Name: Insert the term. A term can consist of up to four words.
o Document Type: Select the type Glossary.
o Description: Insert the term definition.
4.
Afterwards, apply the glossary group to the workarea:
1.
Click on the Tools -> Glossary -> Apply Glossary… menu.
A setting dialog opens.
2.
Adapt the settings in the dialog according to your needs.
3.
Confirm the dialog with OK.
Settings of the apply glossary dialog
The settings dialog contains the following settings:

Use Glossary from Group:
Defines the glossary group containing the glossary text units.

Specific Language Only:
Defines, whether the glossary will only be applied to content with a specific content language.

Language:
Defines the content language for the setting Specific Language Only.

Apply Recursively:
Defines, whether the glossary is also used for the sub-objects of the selected content structure.

Apply to Descriptions / Short Descriptions:
Defines, whether the glossary will be applied to the respective object properties.

Apply inside Projects / Book Pages:
Defines, whether the glossary will be applied to the content of the respective objects.
Note
Make sure to use a consistent spelling in your content. To display a glossary entry correctly, the spelling
of a term in a text has to be equal with the glossary entry.
304
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Workarea and Administration
12.7.2
Removing a Glossary
The applied links of a glossary can be removed from the content or a specific group, when no longer needed or
outdated.
To remove a glossary, proceed as follows:
1.
Select the group in the project explorer.
2.
Click on Tools -> Glossary -> Remove Glossary… menu.
A setting dialog opens.
3.
Adapt the settings in the dialog according to your needs.
4.
Confirm the dialog with Ok.
Settings of the remove glossary dialog
The settings dialog contains the following settings:

Use Glossary from Group:
Defines the glossary group with the contained text units.

Specific Language Only:
Defines, that the glossary will only applied to content with a specific content language.

Language:
Defines the content language for the setting Specific Language Only.

Apply Recursively:
Defines, that the glossary is also used for the sub objects of the content structure.

Apply to Descriptions / Short Descriptions:
Defines, that the glossary will be applied to the parameters.

Apply inside Projects / Book Pages:
Defines, that the glossary will be applied to the content of this objects.
12.7.3
Importing a Glossary
For the easy creation of a glossary you can import a list (CSV file) of glossary entries. During the import the
Producer creates a text unit with the type Glossary for each glossary entry and inserts the texts contained in the
CSV file. Thus, you do not have to create each text unit individually.
The list of glossary texts should be a simple CSV file with the following structure:

first column: term
will be imported into the Name parameter

second column: term definition
will be imported into the Description parameter
To import the CSV file, proceed as follows:
1.
Create a group using the New Group toolbar entry.
2.
Click on Tools -> Glossary -> Import Glossary… menu.
A setting dialog opens.
3.
Adapt the settings:
SAP Workforce Performance Builder 9.3
Workarea and Administration
Customer
© 2014 SAP AG. All rights reserved.
305
o Import into Group:
Defines the glossary group in which to import the glossary.
o Language:
Defines the content language for the text units.
4.
Confirm the dialog with Ok.
If you want to apply the glossary, see the chapter 'Creating a glossary'.
12.7.4
Glossary View in library
The created glossary can be displayed as glossary view in the library. Via a button in the header bar the learner
can open the view. The course structure displays the contained groups of a glossary and the content view displays
the content of all text units for a selected group. The glossary root group will not be shown in the content tree of
the library.
Learners can use the glossary view to look up specific terms and descriptions which are part of the learning
content.
Activate the glossary view as follows:
1.
Open the central configuration dialog using the Tools -> Settings menu.
2.
Select the section Playback Settings -> library -> Visual properties.
3.
Select the created glossary in the Glossary group setting.
4.
Confirm the dialog with Ok.
Further settings

Use library language (Playback Settings -> library -> Glossary):
Defines, that only glossary entries with the language of the root group will be shown in the library. Deactivate
the option to show the glossary entries of all languages.
If the root group uses the language Multiple languages all glossary entries will be shown.
12.7.5
Glossary Styles
A glossary uses different styles for text and bubbles during the playback of content. This is necessary to
distinguish this type of content from the general content and to make it clearer to read for the user.
Glossary link
A special text style is available for the display of a glossary link in a text. The style is used automatically after the
glossary is applied.
The text style Glossary Link can be edited in the text style editor (menu Tools -> Edit Text Styles...) and is located
in the section Inline Styles.
Glossary in trainer
When you play back the library, a simulation or a book, the trainer functionality displays a glossary entry in a
window. The style of the window is defined using the current trainer style.
306
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Workarea and Administration
Glossary in a navigation
When you play back a navigation, you can define an individual bubble in the settings to display a term entry. The
central configuration dialog box (menu Tools -> Settings...) under Navigation Playback Settings -> Navigator ->
Glossary Bubble contains the following settings:

Style:
Defines the appearance of the glossary bubble. Here you can select a bubble style resource from the dropdown list.

Size:
Defines the width and height of the glossary bubble in pixels.
12.8 BPM Import
To structure your business processes in the Producer, you can import BPM structures (built in Business Process
Model (BPM) applications) into the workarea. A group and project structure with relevant object names is created
in the project explorer. A tree based on the structure is available where you can create the required content.
The structures of the following BPM applications can be imported:

ViFlow

Nimbus

Symbio

Aris
Note
To import an Aris structure, you need to have installed Symbio Suite, which the Producer uses for the
import process.
12.8.1
Importing a BPM Structure
Import your BPM structure as follows. Note that the import process can differ depending on the BPM application
you are using.
1.
Create the required process model in your BPM application.
2.
Publish this:
o
ViFlow
Publish the process model under Edit -> Publish from ViFlow. The structure.xml is created here as part of
the ViFlow web model in the html folder.
o
Nimbus
Publish the process model as a simplified XML structure (Simplified XML) to add all the process steps to
a file.
o
Symbio
Publish the process model as an XML structure.
o
Aris
Publish the process model as an XML structure.
SAP Workforce Performance Builder 9.3
Workarea and Administration
Customer
© 2014 SAP AG. All rights reserved.
307
3.
Now change to the Producer.
4.
In the project explorer, open the Tools -> Business Process Models menu and select the corresponding import
command for the required structure. The import dialog opens.
o Aris
The first time you import an Aris structure, a settings dialog opens. Enter the directories where the
executable file for the Symbio Suite and the temporary files are located. Confirm with OK.
See also chapter Settings for the Aris Import.
5.
Select the published structure file and click Open.
6.
A settings dialog opens. Modify the following settings and confirm with OK:
o Import type: new structure, update structure
o Create empty projects
o Language (only Symbio)
The folder structure is then created in the project explorer, where you can edit it and start creating content.
12.8.2 Settings for Aris Import
The settings dialog for Aris import can be opened using the Tools -> Business Process Models -> Aris Import:
Settings… menu. The following settings are available:

Symbio CLA-EXE:
The setting specifies the location of the cla.exe file for Symbio Suite.Symbio Suite must be installed to
execute the import.

Directory for temporary files:
During the import process, temporary files are created. Use this setting to specify a directory to store the
files.
12.8.3 Updating a BPM Structure
Updating a BPM structure in the Producer allows you to insert modified or new content from a BPM application
into an existing structure. This can be done using the import function by importing the updated structure. See the
chapter Import of a BPM structure.
To perform the update, you need to select the import type Update Structure in the import settings dialog. Also
select the language of the imported structure for the Symbio import.
The update is recommended for unmodified structures of the Producer, because manually created objects will be
moved into Unsorted. In the structure changed objects will be resorted like in the import structure.
12.8.4 Exporting Symbio Links
The export Symbio links function allows you to export the content structure of a workarea to an XML file for use in
the Symbio Suite. The file includes the links of the modes and documentation, as well as the title and language
information of the content.
308
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Workarea and Administration
Symbio links can be exported as follows:
1.
Open the Tools -> Business Process Models -> Export Symbio Links… menu in the Project Explorer.
2.
Select the base path of the workarea for the links. Confirm with OK.
3.
Select the target directory and insert a file name.
4.
Click Save to execute the export.
12.9 Insert a file
In addition to the learning content and documentation that has been created, you can insert other files. The Insert
file function in the Producer is available to you for this purpose. For example, these files can be Word or PDF files
containing additional or general information but images and media files are also possible.
This is how you insert a file:
1.
In project explorer, select an object in your tree structure.
2.
In the object editor header you will find the Insert file function. Click on it.
3.
Select the file that you want in the open dialog and click on Open.
The file is inserted in the last place within the object.
After they have been inserted, the files integrated in this way can be selected both in the Project Explorer and the
library and can also be inserted in book pages.
Note
If you insert a Word document, it is integrated along with everything else when a master document is
created. Therefore ensure that the document is hidden, if necessary, before a master document is
generated.
Recommendation
Instead of using the function to insert files, you can also drag and drop them to the project explorer. This
inserts the file in the currently selected object.
Updating a file
An imported file can be re-imported and updated by clicking on Update file. The Producer accesses the original file
location – this is the path that was entered and saved upon importing the file under the setting Original path.
The setting Last Import displays the date and time that the file was last imported so that you can verify whether
the file is up-to-date.
Recommendation
This option is only displayed if the original file is available. Otherwise, you can import a new file by clicking
on the option Replace file.
SAP Workforce Performance Builder 9.3
Workarea and Administration
Customer
© 2014 SAP AG. All rights reserved.
309
12.10 Reference Counter
The reference counter displays all existing object references from a workarea in the project explorer. This
facilitates finding and managing references.
To enable the reference counter, click on View -> Reference Counter.
A number will appear in front of an object in the tree structure to indicate how often it has been referenced. From
the object editor, the existing references for each selected object will be displayed based on the higher-ranking
objects. You can add links to be able to quickly jump to the objects. The reference that is currently selected is
highlighted.
In addition to the reference counter, the option Dependencies… is also displayed in the object editor. This button
will open a dialog box with a list of all existing dependencies for an object within a workarea.
12.11 Dependencies
The dependencies dialog box displays all existing references for an object within a workarea. This could be other
objects, files and resources. Displaying dependencies will provide you with an overview of existing references,
which is useful for publishing purposes.
The dialog box can be opened from the context menu for each object. Note that when the reference counter is
activated, the option Dependencies… will also be automatically displayed in the object editor.
Display

Dependencies: Dependencies - Tree
This displays the existing references in a tree structure format.

Dependencies: Dependencies - List
This displays the existing references as a list.

Referrer: Referrer - List
This displays the references in accordance with the individual referrers, e.g., according to which object or
resource is being used.
Displayed Objects

Recursive
When this setting is enabled, the corresponding sub-objects for the selected object will also appear.

References in structure
This displays existing references that have been directly allocated to an object.

References by parameter
This displays existing references that exist due to certain settings that have been defined.

Resources only
This will only display resources that have been referenced.

Show names
This will also display the names as they appear in the project explorer.
310
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Workarea and Administration
12.12 Reducing the File Size of the Content
The table contains tips for reducing the file size of the content:
Recommendation
Explanation
Function
Reduce screen resolution
Reduce the recording screen
resolution
(1024 x 768 is usually sufficient).
Central Configuration Dialog:
Authoring Settings -> Recording General -> Size
Simulation
See also chapter Recording General
Merge identical Screenshots
Merge Screen macros in a project.
Simulation
Documentation
Project Editor:
Tools -> Automation -> Merge
Screens
See also chapter Merge Pages
Clean up
Simulation
Publish content
Simulation
Delete all unreferenced objects
using the Clean Up function on a
project level.
Project Editor:
Menu Edit -> Clean Up...
Publishing the content will
automatically remove all files not
required for playback.
Project Explorer:
Menu Workarea -> Publish ->
Publish Content...
See also chapter Clean Up...
See also chapter Publishing a
workarea directly
Cropping the screenshots for
documents
Use auto crop to reduce the
screenshot size for documents.
Documentation
Project Editor:
Tools -> Automation -> Auto Crop
all Screenshots
See also chapter Auto Crop all
Screenshots
Reduce the color depth for
documents
Documentation
Reduce the color depth for
documentation screenshots.
Besides RGB quality, you can also
choose Indexed Color or Grayscale.
Central Configuration Dialog:
Documentation Settings ->
Documentation Type ->
Screenshots

Quality in Word/PDF
documentation

Quality in HTML
documentation
See also chapter Documentation
Settings
Use referenced content
Books
Create a media folder in a book.
The folder is published with the
book but should not be visible to
the learner.
You can add media files to the
media folder at any time. If a large
quantity of media files is used, the
SAP Workforce Performance Builder 9.3
Workarea and Administration
Customer
© 2014 SAP AG. All rights reserved.
311
Recommendation
Explanation
Function
folder can be divided into images,
videos, audio and so on.
Insert any media file into a book
page by importing it directly from
the workarea media folder as a
reference to avoid redundant files.
Check media content size before
importing
Books
Use templates
Books
Before importing media files into
the content folder, check the size
of each file and reduce the file size
if necessary (by compressing
images or using a different video or
audio codec).
To avoid redundancies caused by
background images, create a
template for each book page.
Central Configuration Dialog:
Application -> Templates
See also chapter Templates for
content objects
Project Explorer:
New Book Page dialog -> Template
See also chapter New Book Page
Example
Steps to reduce the size of documents
Result in KB
Standard project with 20 recorded steps &
documentation
4850
+ Merge Screens
4065
+ Merge Screens
2414
+ Auto Crop
+ Merge Screens
1374
+ Auto Crop
+ Grayscale
+ Merge Screens
935
+ Auto Crop
+ Indexed Color
312
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Workarea and Administration
13
Interface and Components
This chapter describes the structure of the Producer. This involves going into the Producer interface's different
areas and functions.
The interface oft the Producer switches between three main views:

the Project Explorer, which is used to edit the currently selected Workarea

the Project Editor, which is used to edit an open project

the Book Page Editor, which is used to edit an open book page
The Project Explorer and the open projects are arranged as tabs below the toolbars. The tab of the Project
Explorer is always located on the left.
The tab of the project which was opened last is always located right beside the tab of the Project Explorer.
In case there are more projects open than can be displayed in the tab bar, the invisible projects can accessed
using the pull-down menu on the right side of the tab bar.
In the tabs you will find a button with an X which can be used to close the corresponding project.
A context menu is opened by right-clicking on one of the tabs. This can be useful when you wish to close a project,
close all projects or close all projects except the one you are working on.
In addition, the projects can be accessed via the menu Window.
Depending on if you are working in the Project Explorer or the Project Editor, the menus and tool bars change to
provide the necessary tools, depending on the current context.
SAP Workforce Performance Builder 9.3
Interface and Components
Customer
© 2014 SAP AG. All rights reserved.
313
13.1
Project Explorer
The project explorer serves to organize the contents in a workarea. The project explorer window is divided into
two areas. These are the workarea organization structure on the left-hand side, and the object properties on the
right-hand side.
The structure built for the workarea within the project explorer is also the structure displayed later on in the library
of the published workarea.
13.1.1
Administration in the Tree Structure
The display name of the workarea is displayed in the header above the tree structure for easier orientation. The
Filter administration is located right below. Filters can be used to differentiate between views in a Workarea.
The display name and the path to its location are displayed in the root of the workarea.
The resources used in this workarea can be viewed in the upper part of the tree. The administration of the
resources is explained the related chapter of this help file.
The individual objects in the workarea can be edited directly in the tree structure. The project file, the generated
modes and the documentation files that have been generated appear for each project there. The following actions
are possible:

314
Using drag & drop (moving with the mouse pointer by holding the left button and then releasing it), any of the
projects of the Workarea can be sorted, regrouped and moved. The objects belonging to a project cannot,
however, be moved from one project to another.
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Interface and Components

If you hold the Shift key while dragging and dropping, the object, or project, and all of its content will be copied
to the chosen location instead of being moved. This means that the original will not be deleted.

In order to change the display name of an object in the library, you need to give it two single clicks separated
by a short interval (not a double-click). The display name can then be edited directly. It will also be changed
accordingly in the file structure of the workarea.

The Del key can also be used to delete projects.

These and more features are also available in the context menu by right-clicking above the corresponding
project.
Dependencies between objects and resources
Projects and book pages use specific resources, such as styles and configurations, for display and execution
purposes. In Producer you have a certain selection of resources and their use can differ from object to object. In
the project explorer you can visualize the resources used by a project or book page. This is useful when exporting
archives to identify existing dependencies and thus allow for the output of required resources.
Right click to select a project or book page, and then select Dependencies in the context menu. A dialog box
showing you all resources used then appears.
13.1.2
Object Editor in the Project Explorer
The object editor allows you to edit the settings for an object selected in the project explorer. Information on the
object as well as the current settings are displayed in the editor. In addition, actions are displayed in the editor's
heading that can be used for the selected object.
13.1.3
Parameters of the Macro Editor
Some of these parameters can be edited directly and are the same for all objects:
Parameter
Description
Name
Name is the name under which an object is shown in
project explorer, the library and the documentation.
library autostart
The library autostart parameter allows a particular
mode, book page or document to be started or
opened automatically when selecting an object in the
library. This function is useful, for example, if only one
mode is to be displayed in the library for a simulation
or else to highlight a particular mode or particular
document. When the mode has been terminated or
the document closed, the user is free to select the
project content as usual.
This function can also be defined for groups, for
example in order to display a document or book page
when selecting the group. the book page is hidden in
the library structure.
SAP Workforce Performance Builder 9.3
Interface and Components
Customer
© 2014 SAP AG. All rights reserved.
315
Parameter
Description
Description
In Description, you can edit a descriptive text, which
will be shown later in the library, together with the
object information. Formatting can be also applied by
using the buttons above the entry field. Besides the
usual text attributes, you can decide on the alignment
of the text and choose whether to have it displayed as
a list. Using the corresponding buttons, you can add
screenshots and other images to the text in order to
illustrate the description.
Preview
The Preview displays a thumbnail view of imported
graphic images or generated book pages.
Hide
This option will allow you to hide an object in the
library. It can also be used to hide objects when
generating global documentation or when publishing a
workarea.
Keywords
You can specify keywords for an object in the
Keywords parameter. The student can use these to
search for specific learning content in the library or in
the book reader.
The Keywords parameter can be unhidden by means
of the advanced functions. To define a number of
search terms, they should be entered separated by a
semicolon (e.g.: search_term1; search_term2).
Subcategory LMS
To evaluate the learning success in Test mode within an LMS (Learning Management System), the Maximum
Score and the Required Score can be specified in project explorer for the project.
To do this, enter the corresponding percentages for the project concerned in the Subcategory LMS of the object
editor. The project must be selected in the tree structure. The preset values are 100 and 80. The values entered
are used later on by the Simulation Start macro to calculate the numeric values for the Maximum Score and the
Required Score for the project.
13.2 Project Editor
The project editor can be used to record, create and edit projects. The project editor displays macros, settings
and screenshots as well as specific functions for the editing.
The project editor’s main components are as follows:
1.
Menus and toolbars
You will find more detailed information on the menus under the section Menu overview
2.
Thumbnail view
3.
Step view
4.
Macro editor
316
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Interface and Components
Caution
Projects that have been edited in the project editor in the step view cannot be used in the Producer
versions without this view. In order to view the step, new project configurations are required in order to
prevent any errors from occurring. Furthermore, objects will be deleted that are inserted on a
screendump without a macro.
To use the project editor without the step view, enter the expert feature no_wysiwyg=1; in the appropriate
area of the central configuration dialog.
Navigation in the Project Editor
An alternative and user-friendly way to navigate in the project editor is by using the mouse's scroll wheel and the
keyboard. This facilitates scrolling up and down in the workarea and alternating between objects from the step
view. In addition, the keyboard allows you to easily jump between steps and select macros. The following
shortcuts can be used:

Home: jumps to the first step

End: jumps to the last step

Page Up / Page Down: alternates between the steps or macros, depending on the currently selected object.
13.2.1
Thumbnail View
The thumbnail view sequentially displays the steps with their screenshots and corresponding macros. When
selecting a macro, the corresponding screenshot is displayed in the step with its highlights and bubbles, and the
macros settings are displayed in the macro editor.
SAP Workforce Performance Builder 9.3
Interface and Components
Customer
© 2014 SAP AG. All rights reserved.
317
Simply click on the macro you wish to edit. The selected macro will turn orange and the corresponding settings
and actions will be displayed in the macro editor.
The display size of the screenshots can be adjusted using the plus and minus keys or the numbers 1 to 5 on your
numeric keypad of your keyboard.
Changing the macro or step order using drag & drop
The order of the macros and steps in thumbnail view can be changed using drag & drop. You can even move one
or more macros within a step or all steps as a whole as well as assign new positions to one or more steps in the
project.
For this purpose, select one or more macros/steps. To do so, click on the objects. To be able to select multiple
macros or steps, hold down the Ctrl key on your keyboard while clicking on the objects. Drag your selection using
the left mouse button to the corresponding position and then release the mouse button.
Note
Changing the order of steps or macros always results in a subsequent change to the project itself. For this
reason you should make sure the project is still a coherent unit.
Icon for "Show in Documentation"
Every macro that has the Show in Documentation option has a small icon in the upper right-hand icon. This shows
the status of the option and thus also the macros to be included for the documentation. If the option is
deactivated, this is also visible in the icon.
13.2.2
Steps of a project
Steps organize a project into sections. Generally, steps consist of single actions on a particular page.
The steps are automatically inserted in the application for each new screenshot during recording. For recording, a
step contains all macros that are used before the next screen in the application in order to describe the action that
has been executed.
All steps are numbered consecutively, followed by the title of the step.
318
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Interface and Components
The step titles are displayed as a guide beneath the trainer progress display during playback in Demo mode. As
before, they subdivide the documentation generated into the corresponding chapters.
A step has various attributes that determine its behavior when a project is played back and for the creation of
documentation.
The Name of the step can be changed at any time. This is especially useful if the application windows always have
the same name when recording. The Producer takes on the name of the window as the title of the step. This
means that many steps may have the same name. The title may also be used as chapter titles in generated
documentation if this has been so defined. If you are planning to generate documentation, the titles of the steps
should be unique.
Jump Target determines the behavior of the step in the progress display of trainer.
Note
Within a recorded project, the first step has a special status. It generally includes only the Simulation
Start macro in order to properly initialize the project for playback. For this reason it is never set as a Jump
Target.
13.2.3
Step View
The step view displays the screenshot of the Screen macro and allows you to edit the highlights and bubbles for
the control directly on the screenshot. Here you can also add additional macros via the toolbar and position them
as desired.
The step view display
From the step view, different views can be activated to facilitate editing and positioning objects. A variety of
options are available from the toolbar:
SAP Workforce Performance Builder 9.3
Interface and Components
Customer
© 2014 SAP AG. All rights reserved.
319


The Modes button allows you to switch over to selected bubbles for editing purposes, allowing you to preview
the bubbles in each of the different modes. This setting will have an effect on the activated preview mode.
o
Edit Demo Mode
o
Edit Practice Mode
o
Edit Test Mode
o
Edit Concurrent Mode
For steps with more than one macro, all bubbles can also be viewed simultaneously. This facilitates
positioning bubbles and ensures that other areas in the application are not hidden by the bubbles by accident.
o
Show Bubbles for Step
o
Show Bubble for Macro
Position objects
There are two ways to position objects:

Via Drag & Drop

Via a keyboard using the arrow keys
13.2.4 Documentation View
The documentation view is a WYSIWYG editor for editing documentation in simulations. A document is displayed
in HTML format so that you can preview the content and structure. This editor allows you to quickly and easily
make any necessary changes to your documentation.
The documentation view only displays project content that can be inserted into documentation. Content that is
stored in another location other than in the project editor, such as description text, will not be displayed here.
Opening the documentation view
The documentation view can be enabled from the toolbar and used instead of the step view. Alternatively, you can
open this from the menu View -> Components -> Documentation View.
Editing documentation
The following editing options are available from the documentation view:

Hide macros for output into documentation:
Click on Hide in Documentation so that the selected macro will not appear in the document. In order to display
a hidden macro, click on Show in Documentation.
Note that documentation macros can not be hidden.

Adjusting highlights:
Macro highlights can be changed individually. Such changes have only effect on documentation - the
highlights for the simulation remain unchanged.

Adjusting text:
Text that can be edited is highlighted in yellow when the macro is selected. To make modifications to text,
double-click on the desired text from the HTML editor.
320
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Interface and Components
Note
Editing text in the documentation view can affect the different modes. Only make changes here when you
are sure that the changes should also be applied to the other modes.
13.2.5
Macro Editor
All the settings for the macro selected in the thumbnail view are displayed in the macro editor and can be directly
edited there as well. At the top of the editor, there are additional options for enhancing your macros.
The macro's settings are divided into application-specific categories which can be opened and closed by clicking
on the plus and minus symbol. The green button located in front of the setting's name indicates whether the
setting is active or inactive. By clicking on the setting, a description will be displayed at the bottom of the macro
editor.
In the title toolbar, you will find the option Layout selection, which allows you to switch the macro editor’s view
modes. Here you have the choice between standard and advanced views, in which the settings that are used less
frequently can be hidden or made visible depending on your needs.
Selecting multiple macros
If you would like to edit a specific setting for a type of macro, it is now possible to select several macros at one
time, which will display the common setting to be edited for all the macros at once. This feature will save you time,
eliminating the need to manually select each individual macro. From the Edit menu, simply click on the option
Select Macros by Type...
If the settings vary for the selected macros, a note will automatically appear on the screen. From here, you can
save the setting, edit it for all the macros or deactivate it. To make changes to the setting, click on the button in
front of the name. This will open a menu with the options Determine joint value and Delete values. Select the
desired action and edit the value as desired.
Insert a comment
You can enter a general comment to assist the editing in the Comment field. This is displayed in the thumbnail
view in place of the macro text.
You can amend the displayed comment as follows:

Comment preceded by '+': Comment is appended to the macro text in brackets

Comment preceded by '*': Comment is inserted in brackets in front of the macro text

Comment preceded by '/': The comment is not displayed, only the macro text
13.2.6 History
The History can be viewed as the memory of the Producer. It chronologically documents all actions that are taken,
starting with the opening of the project. This allows the user to return to any stage in the editing of the document,
going back to the opening or creation of the project. With a simple click on the History list item, it is possible to
directly undo or redo one or more actions. To provide the user with a better overview, the actions taken since the
SAP Workforce Performance Builder 9.3
Interface and Components
Customer
© 2014 SAP AG. All rights reserved.
321
document was last saved are marked with a plus. The history is used as the basis for the Undo and Redo
commands in the Edit menu.
13.3 Book Page Editor
The book page editor is where the book pages are edited. This is where you can define the book pages' design and
create the content.
After a book page has been created in the project explorer, it is opened in the book page editor. You also have the
option of opening the book page editor in the project explorer by double clicking on a book page.
The book page editor is broken down into the following areas:
1.
Toolbars
In the toolbar you will find a complete object overview from which you can insert the objects. Functionality is
also provided for editing the objects and book page.
2.
Object editor
The object editor is where you can define the individual objects' properties. To this end, when you select an
object you are offered corresponding parameters that are subdivided into various areas.
3.
Book explorer
The book explorer depicts the content of a book, its book pages and groups. Double-clicking selects a book
page for editing, which is then opened in a new tab.
4.
Object list
The object list provides you with an overview of all the objects inserted on the book page.
5.
Book page view
The book view is where the book page is shown for editing. Select the inserted objects to edit them. You can
use drag and drop to place the objects in the desired position.
322
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Interface and Components
The book view operates on the “what you see is what you get” (WYSIWYG) principle. That means that your
book page will be displayed in the book reader or library in the same way you created it.
In order to be able to test the objects, select the Preview function in the toolbar. The Producer will then
activate the corresponding functionality, such as launching a mode.
13.3.1
Object list
The object list provides you with an overview of all the objects inserted on the book page. You will find the book
page's background in the topmost position. Select this entry to edit the background.
The objects that have been inserted are itemized in a list and appear in the same order as they do on the
respective level. Selecting an object from the list will highlight this object on the book page. It is now ready to be
edited.
Changing an object‘s level
To position an object on a different level in a book page, simply drag & drop it to the desired position and level.
Hiding objects
From the list of objects, you can define whether objects should be hidden or visible on the book page. This is an
important setting to remember to use with actions. An Eye icon is displayed for each object, indicating its current
status: Show or Hide. To change an object's status, simply click on the desired status icon.
13.4 HTML Editor
The HTML editor allows you to create and edit text for various learning content. The HTML editor can be accessed
via the Producer from the project explorer, project editor or the book page editor. Text is created in HTML format
using a WYSIWYG display.
The editor contains a variety of options for editing and formatting text. These options are displayed in a pop-up
window that can be opened by clicking on a text field. The editor can also be repositioned on the screen via drag &
drop, and the size can be adjusted by pulling on the sides and corners.
Caution
The HTML editor is entirely HTML-based and does not support any additional integrated script. Such
script will be automatically deleted upon saving it in order to avoid problems with displaying and using the
learning content.
If you would like to use Java script in your html editor, contact your SAP consultant for assistance.
Inserting text and images
When inserting copied text or images into the HTML editor, in some cases it may be possible that the formatting is
displayed incorrectly. The HTML editor is equipped with several options to prevent this from happening. Copy
your text or image and click on the right mouse button in the HTML editor. The context menu option Paste in
format will appear with the following options:
SAP Workforce Performance Builder 9.3
Interface and Components
Customer
© 2014 SAP AG. All rights reserved.
323
For inserting text:


Formatted text – the formatting will be preserved
Unformatted text - removes any existing formatting
For inserting images:


Formatted text – the formatting will be preserved
Bitmap image – inserts the image as a bitmap
Recommendation
Since the HTML Editor displays text in HTML coding, a new paragraph (Projects that have been edited in
the project editor in the step view cannot be used in the Producer versions without this view. In order to
view the step, new project configurations are required in order to prevent any errors from occurring.
Furthermore, objects will be deleted that are inserted on a screendump without a macro.
To use the project editor without the step view, enter the expert feature no_wysiwyg=1; in the appropriate
area of the central configuration dialog....</p>) will be created by clicking on the Enter key, which should
normally give you larger line spacing. If, however, you would like to create a line break (<br />), then click
on the keys Shift + Enter.
13.4.1
Features of the HTML Editor
The toolbar offers basic functions for editing text and adding links and objects to your project:

Paragraph Style
Contains all defined paragraph and list styles.

Inline Style
Contains all defined inline styles.

Block Style
Contains all defined block styles.

Table Style
Contains all defined table styles.

Font type
A list will appear with all the available fonts that are installed on your PC.

Font size
A list will appear with predefined values for various font sizes

Align left / Centered / Align right

Numbered list / Bulleted list

Outdent / Indent

Insert object – see chapter

Search text – see chapter

Font color – see chapter

Bold / Italic / Underlined

Undo / Redo
This option allows you to undo and redo the last action performed.

Remove formatting
This option will reset the highlighted text back to its original format.
324
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Interface and Components

Maximize height / Restore down height
This option enlarges the window vertically to adjust itself to the screen size or resets the Editor to its original
size.

Maximize window / Restore down window
This option minimizes or maximizes the Editor's window size.

Close
This will close the HTML Editor. If changes have been made, a dialog box will appear reminding you to save
your changes.

Toggle background color
This option switches the background color from yellow to grey in order to better view and edit text with lighter
or darker font colors as needed.

Design / Source
This option allows you to switch between editing text and HTML source text.

OK
By clicking on OK, the changes will be saved and the HTML Editor will close.

Cancel
This option closes the HTML Editor without saving any changes.
13.4.2 Inserting a placeholder
The placeholder inserts a variable that is dynamically assigned to specific content. This content can include:
Project title, group descriptions, etc. The object thus makes it easier to consistently use information and to
change information in a central location. Complex content can also be combined. The inserted texts can then be
individually formatted.
If no content can be assigned to a placeholder, it is displayed as a variable. In this case, you should check the
selected placeholder and the desired content.
Note
You can only insert content from the objects themselves or the objects at the next higher level as
placeholders in this case.
To insert a placeholder, proceed as follows:
1.
2.
Click Insert placeholder... in the HTML Editor about the Insert object function. A dialog now opens where
you can define the placeholder.
Select the placeholder type and confirm the dialog by clicking Insert.
The following placeholders can be inserted:

Macro: Field Icon (inside of project)

Macro: Field Name (inside of project)

Macro: Hotkey (inside of project)

Macro: Input Text (inside of project)

Object: Name

Object: Description

Object: Short description
SAP Workforce Performance Builder 9.3
Interface and Components
Customer
© 2014 SAP AG. All rights reserved.
325
Inserting dictionary texts
Dictionary texts can be inserted from the recording dictionary as placeholders using the Placeholder dialog. These
adjust automatically to the activated object language and are thus versatile in how they are used. The
placeholders are to be entered manually in the text box below the drop-down list and should be written as follows:

– for pure text

– for HTML text
You can find the respective dictionary ID in the dialog for editing dictionary texts.
Inserting individual content
In addition to the standard placeholders, you can also specify placeholders for specific objects. The respective
UID of the object and an exclamation mark are to be added to the displayed placeholder variables in the text box.
This should have, for example, the following form:


Standard:
Extended:
Note
Keep in mind when using placeholders that they cannot currently be displayed in the Manager.
13.4.3 Inserting a screenshot or image
By clicking on the option Insert object , screenshots can be created from various views and then inserted into a
bubble. The following options are available for defining a screenshot:



Insert screenshot of window – by moving the mouse over the screen display, specific areas will be
recognized and outlined in red. Click on the mouse button to select the desired outlined area.
Insert screenshot of object – by moving the mouse over the screen display, specific objects will be
recognized and outlined in red. Click on the mouse button to select the outlined object.
Insert screenshot of area – with the mouse, pull the red frame over the desired area and release the mouse
button.
After selecting the area, an editing window will appear where you can make adjustments as needed. To complete
the process, click on Confirm selection. The dialog box will close and the screenshot will be inserted into the HTML
editor.
The option Insert Object allows you to insert graphic images. The following options are available:


326
Insert image file...
A dialog box will open from which you can select an image from a data medium of your choice. Select the
desired image and click on Open (in the Editor) to insert the image.
Insert image from workarea...
A dialog box will open, displaying the contents of the workarea. Select the desired image and click on OK (in
the Editor).
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Interface and Components
13.4.4 Inserting a link
You can insert a link into your text in order to call up a website or an object from your workarea. The Producer
provides you with several editing options for customizing your link.
Note
If you have linked content from the workarea with the bubble, then take care when publishing or issuing
archives that you issue the object you have linked to as well.
Select the Insert object
function in the HTML Editor. In the open menu, click on Insert link... A dialog will then
open in which you can designate the link. To do so, select one of the buttons:





Current Object:
Displays the current project's modes and documents.
Workarea:
Displays all of the workarea's modes and documents.
Free:
You can use this option to define a link to a web page.
Shortcut:
Shows linked content in the tree structure for direct selection. Up to five links are displayed here.
Actions:
Actions can be defined for controlling the trainer or book reader using this option.
If you have selected learning content or a link, then confirm the dialog with OK. The link destination is now
displayed as a link in the bubble.
Inserting a link into a step
If you are working within a project, you can insert a link within the project to jump to another step.
In the HTML editor, choose the option Insert object. Then click on the option Insert step link... A dialog box will
appear. Select the step you would like to have the link be associated with. Confirm by clicking on OK.
Importing files
When you select Current Object you are given access to the Insert file... button. Select this button to import a file
into your project. This can be a document or audio file, for example. A link with the file will be established
automatically after it has been imported.
You can remove a selected file from the workarea by clicking the Delete button.
Open in a new window
The option Open in new window allows you to determine whether the object is to be opened in the same project
window or a new one. Activating the option opens the link destination in a new window.
Selecting the option activates the Parameter button. This button displays a dialog in which you can define
properties for the new window.
Searching and filtering
Performing a search or selecting a filter in the header of the dialog makes it easier to find content in a complex
tree structure. The respective content is displayed directly when a keyword is entered. You can also start the
search by clicking the Search button. The filter list contains filters that have been created for selection. If you want
to reset the filters, select (no filter).
SAP Workforce Performance Builder 9.3
Interface and Components
Customer
© 2014 SAP AG. All rights reserved.
327
13.4.5 New window options
If you have activated the option Open in new window you can use the Parameter button to call a dialog containing
options for displaying the window. You have the following options at your disposal:
Position
The values Position to top and Position to left are used to determine the distance of the new window from the top
and left hand margin of the screen area. The values are stated in pixels.
Size
The values Width and Height are used to define the size of the new window. The values are stated in pixels.
The parameter Fullscreen defines whether the window is to be opened in full screen view. This requires the setting
to be activated.
The parameter Resizable defines whether the window can be scaled. This requires the parameter to be activated.
Layout
You can have the following macros of the browser window displayed in the new window by activating the relevant
setting:

Titlebar

Menubar

Toolbar

Scrollbars

Statusbar
13.4.6 Searching for text strings
If there are longer and more complex text strings in the HTML editor, there is a text search function to facilitate
finding specific text strings. Click on the option Search text. A dialog box will appear.
Dialog box for searching for text
A text field appears where you can enter one or more words to search for. The search function has several options
to choose from to quicken the search:

Match whole word only:
If this option is deactivated, possible matches will be shown directly during the search. If this option is
activated, the results will be displayed only when the entire word is found in the text.

Highlight all matches:
If this option is activated, all the matches found will be highlighted. If this option is deactivated, only the first
match will be highlighted.

Match case:
This defines whether the search should be case sensitive. If this option is activated, the search function will
only find exact matches. If this option is deactivated, capital or lowercase letters are irrelevant for the search.
The buttons Next and Previous allow you to switch between the displayed results. If no matches are found, a
message will appear at the bottom of the dialog box.
328
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Interface and Components
13.4.7
Overview of supported HTML tags
The following HTML tags are supported by the HTML editor:
Caution
If tags other than those listed here are used, they will be automatically deleted upon saving the changes in
your project. This is important because using tags that are not supported could cause problems when
displaying or using the learning content.
If you would like to use JavaScript, contact our technical support for assistance.
Description
Tags
Attributes
Paragraph
<p>.…</p>
Alignment: align=”left,center,right”
Headings
<h1>...</h1>
<h1> to <h6>
Text markup
italic: <i>…</i>
bold: <b>…</b>
underlined: <u>…</u>
Line break
<br />
Links
<a>…</a>
Link target: href=”…”
Images
<img />
Image source: src=”…”
Lists
unorder list: <ul>…</ul>
order list: <ol>…</ol>
list item: <li>…</li>
Table
<table>…</table>
Border: border=”…”
Cellspacing: cellspacing="..."
Cellpadding: cellpadding="..."
Table row
<tr>…</tr>
Height: height=”…”
Table cell
<td>…</td>
Alignment: align=”…”
Vertical alignment: valign=”…”
Width: width=”…”
Background color: backgroundcolor=”…”
Merge cells: colspan="..."
CSS styles
Inline-Element
SAP Workforce Performance Builder 9.3
Interface and Components
Style attributes: style="..."
<span>...</span>
Customer
© 2014 SAP AG. All rights reserved.
329
13.5 Audio Editor
The audio editor is used to create and edit audio files in the project editor or book page editor.
In the project editor, the audio editor can be opened using the menu: View -> Components.
In the book page editor, the audio editor can be opened using the Edit Audio… button in the macro editor of the
Page, if audio is available.
Structure of the audio editor
In the toolbar of the audio editor, there are several functions for creating and editing an audio file:

Import Audio File

Record Audio

Edit Text to Speech

Insert Silence

Trim Audio

Fade In / Fade Out

Normalize Audio

Change Dynamics

Editing functions
Cut, Copy, Insert, Delete

Zoom functions
Zoom In, Zoom Out, Show Selection, Show All

Playback functions
Play, Pause, Stop, Repeat
The audio track is displayed below the toolbar.
13.5.1
Text to Speech Dialog
The Text to Speech dialog allows you to create and convert texts into spoken audio files. The editor can be opened
using the Edit Text to Speech… button.
The editor includes the following settings and functions:

Text:
Here you enter the text that you want to generate as an audio file.
In simulation projects, the current bubble text of the step is available in the dialog and can be edited. When a
text is edited, the macro Text to Speech Override is created automatically.
Choose OK to convert the text to audio.

Silence:
The setting defines a silence, which is inserted at the beginning of an audio file before the Text to Speech
starts. The value is defined in milliseconds. If you do not want any silence at the beginning, then enter the
value '0'.

Play/Stop:
The Play button allows you to play back the text and then make changes afterwards.
With the Stop button, you can stop the playback.
330
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Interface and Components
13.5.2
Recording Dialog
The recording dialog for audio is used for recording spoken text. The dialog can be opened using the Record
Audio… button.
The editor has the following settings and functions:

Volume Level:
The Volume Level displays the current volume of the spoken text during the recording.

Start Recording / End Recording:
Click Start Recording to begin recording and then click End Recording to stop recording.
Once the recording is finished, the recording dialog is closed.

Settings:
Click Hide Settings / Show Settings buttons to hide or show the options for configuring the recording device.
Use the Recording Device dropdown menu to select an available device. Choose the Configure… button to
open a system dialog with further settings for the device.
The book page editor has additional settings for the recording audio in these formats:
o
Output Format
o
Editing Format
13.5.3
Dynamic Editor
The dynamic editor allows you to edit the sound and dynamic of an audio file. The dialog can be opened using the
Change Dynamics… button.
The editor has the following settings and functions:

Graph:
The graph is located on the left side of the editor and shows the amplitude level of the audio track. The graph
is structured as follows:
o
Path
o
Horizontal axis: input level
o
Vertical axis: output level
The axes are defined in decibels (dB).

Presets:
The presets enable you to easily set your required dynamic settings. There are default presets available and
you can also create your own presets.
o
Name:
The text field displays the name of the selected preset. A name can be defined for a new preset.
o
List:
The list displays the available presets. When you select a preset, the defined settings are used and the
amplitude is modified.
o
Add:
Click this button to add a new preset.
o
Delete:
Click this button to delete a preset.
SAP Workforce Performance Builder 9.3
Interface and Components
Customer
© 2014 SAP AG. All rights reserved.
331
o Reload Preset:
Click this button to reload the primary settings of the preset, if the settings have been changed.

Performance Detector:
The Performance Detector modifies the performance of the amplitude. The values are defined in milliseconds
(ms).
o Attack Time:
Defines the time needed to apply the filter to the amplitude.
o Release Time:
Defines the time needed to remove the filter from the amplitude.

Gain Processor:
The Gain Processor modifies the gain of the amplitude. The values are defined in milliseconds (ms).
o Attack Time:
Defines the time needed to apply the filter to the amplitude.
o Release Time:
Defines the time needed to remove the filter from the amplitude.

Lookahead:
Specifies the time that elapses before a filter is used. This means the start area of a filter can be excluded. The
value is defined in milliseconds (ms).

Play / Stop:
The Play button allows you to play back the audio with the defined settings and make changes afterwards.
With the Stop button, you can stop the playback.
Editing the path
A linear path shows the primary level. The path can be edited as follows:

Add a path point by left-clicking on the path

Delete a path point by right-clicking on the point

Move a path point by drag and drop
13.5.3.1
Creating and Deleting Presets
In addition to the presets provided, you can create your own presets, to quickly apply frequently used settings.
The presets are available for the complete workarea.
To create a preset, proceed as follows:
1.
Enter a name in the relevant field.
2.
Change the path and enter the values as required.
3.
Click on the Add button.
The preset is created with the defined values and is available in the list.
To delete a preset, proceed as follows:
1.
Select a preset in the list.
2.
Click on the Delete button.
3.
Confirm the dialog that appears.
332
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Interface and Components
13.6 Color Selection Dialog Box
The color selection dialog box allows you to define and customize your font colors. It can be used in various parts
of the Producer, such as in the HTML editor, the edit bubble styles dialog box, the book page editor, object editor,
etc. The dialog box can be opened by clicking on Choose color... / Font color.
The following settings are available for defining the color values:

Color wheel
The color wheel contains a wide variety of shades that can be selected by simply clicking on the desired color.

Brightness
The brightness control allows you to define the brightness of the color wheel or the selected color.

RGB color value
The RGB color value allows you to define a color via an RGB color space.

HSV color value
The HSV color value allows you to define a color using an HSV color space.

Web colors
This option displays all web-compatible color values in the color wheel and in the brightness control.

Hex – hexadecimal color value
The hexadecimal color value allows you to define a color using the RGB color space as a hexadecimal value.

Picker
The Picker allows you to choose a specific color shade on the screen. Click on the button and with the mouse
button held down, drag the picker icon onto the desired color shade. Release the mouse button to confirm the
color value shown.

New / Old
These two fields display the current (old) and the selected (new) color values. By clicking on Old, the New
color value will be removed and the value will be reset to its original state.

Quick picks
This option displays 16 standard, predefined shades in two different brightness levels for you to choose from.

Last used colors
This option displays the last 16 color shades that have been previously selected.
13.7 Style Editor
The style editor is the component for editing style resources in the Producer. The editor allows an individual
adaptation of interfaces for the playback functionalities, contents and bubbles based on style templates.
The dialog can be opened with the Tools -> Customization -> Edit Style Resources... menu.
SAP Workforce Performance Builder 9.3
Interface and Components
Customer
© 2014 SAP AG. All rights reserved.
333
The customizable style types for the style editor are:

trainer Style (Standard and Mobile)
Includes trainer bar, library, popup window, task window, book reader bar and quiz.
Divided into standard and mobile style
There are two style types:
Standard - for the playback of content on a PC
Mobile - for the playback of content on a mobile device

Navigator Style
Includes windows of the desktop assistant and process assistant.

Book Style
Adaptation of background, buttons and pop-up window.

Bubble Styles
Adaptation of bubbles based on different bubble styles.

Border Styles
Adaptation of borders based on different border styles.

Manager Style
User interface of the Manager – the style has to be implemented in the Manager after creation.
In the style editor, adapted styles are stored in the Adaptable Resources section of the project explorer’s resource
tree. Bubbles are stored in the Bubble Styles section.
334
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Interface and Components
Note
The created styles are always used for the current workarea. To use the styles in other workareas, export
the resources as an archive file.
13.7.1
Structure and Functions
The style editor can be opened using the Tools -> Edit Style Resources… menu. The basic parts of the editor are:

Style list
The style list on the top left shows the created styles.

Settings page
The settings page on the bottom left shows the settings for the selected style.

Preview
The preview on the right shows the selected style and the executed changes.
The style editor includes several functions for style management:

New…:
Creates a new style based on a template.

Delete:
Deletes a style from the style list and the resources.

Update Preview:
Updates the style preview to make changed style attributes visible.

Save:
Saves the changes of the currently opened style.

Close:
Closes the style editor.
Style preview
The preview of the style editor shows the selected style in the final status. It allows you to see executed changes
directly in the style components. After changing a style attribute, you need to update the preview to make the
changes visible in the view.
Last saved resource images - The style resources contain different images that are combined at runtime. The
trainer style shows an overview of the saved images in the preview view as well as the components. This means
that all parts of a style can be assessed. The changes will be visible after saving the style.
SAP Workforce Performance Builder 9.3
Interface and Components
Customer
© 2014 SAP AG. All rights reserved.
335
13.7.2
Creating a New Style
Before you adapt a style, you first need to create a new style in the style editor. This can be done as follows:
1.
Click on the New… button. A dialog box opens with the following settings:
o Template:
The setting shows the available style templates of the Producer.
o Name:
The setting defines the name of the style.
o Style ID:
The Style ID is used internally and cannot be changed afterwards.
2.
Confirm your settings with OK.
Once you have created a new style, a style resource will be created in the Adaptable Resources section of the
resources. The style editor shows the style in the preview and in the style list.
13.7.3
Style Attributes
Style editing in the style editor is based on the structured attributes and behaviors that allow resources to be
adapted quickly and easily. The attributes are located under Style Definition.
Note
It is not possible to change the size of a complete style or for parts of a style. This is to avoid functional
errors.
Colors
The basic adaptable attributes for styles are colors. The colors can be defined as hexadecimal values or using the
color selection dialog box. This dialog box can be opened using the Choose color… button.
Connected colors
The color attributes with a star ( * ) are set and changed automatically, when a higher-ranking color is changed.
For this behavior, do not specify the attribute. The green button is set to inactive.
This practice allows you to create a well-balanced color style and to reduce the effort for adaptations. Therefore it
is recommended that you only change the colors without a star.
This means each color of a default style only needs to be changed once and this change is applied to all other color
instances. Other color instances can also be changed but this makes editing much more complex.
Images
In some cases, images are used (mostly for logos). To change an image, you need to consider the size of the
original image. The new image should have the same size to fit in the layout. The used image size appears after
the attribute name.
The typical file formats for images are GIF, JPG, PNG, BMP. The default images are in PNG format.
Layout types
The settings area has two layout types, standard layout and advanced layout. The layouts can be changed using
the layout selection in the title bar.
336
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Interface and Components
The standard layout shows the higher-ranking colors of the style. It is sufficient to only change these colors to get
a complete defined style.
In the advanced layout, there are a lot more colors visible that allow you to specify the used colors in greater
detail.
Note
After adapting the settings, press the Update Preview button to see the changes.
13.7.4
trainer Style (including library and book reader)
The trainer is the playback component for simulations. The trainer style includes the following components:

trainer bar

library window

popup window

task window

book reader bar

quiz style

start, stop, load and error page
SAP Workforce Performance Builder 9.3
Interface and Components
Customer
© 2014 SAP AG. All rights reserved.
337
There are two different templates divided into style standard and style mobile. The mobile style is optimized for
playback on mobile devices.
13.7.4.1
Attributes of the trainer Style
This chapter describes the basic settings and sections for adapting the trainer style.

Name:
The setting defines the name of the style.

Logo:
There are two different logo sizes used for the library, control bars and various dialog boxes.
The first settings are the basic color settings for the trainer style. When these colors are changed, the other colors
are changed automatically in their gradation.

Fill color:
The setting defines the basic fill color. The gradients will be set automatically.

Active / Selection:
The setting defines the basic color for active and selected controls and texts.

Background color:
The setting defines the background color of the library, book reader, trainer.
Recommendation
It is recommended that you change the basic color settings first, because the settings influence all other
colors of the style. All other settings can be changed afterwards, to adapt the details.
Standard layout
The standard settings sections allow you to specify the colors for basic components of the style.

Dialog windows section:
These settings define the colors inside of the dialog boxes.

Text colors section:
These settings define the colors for the texts and the different statuses.

Icon colors section:
These settings define the color of the button icons and the different statuses.

Buttons section:
These settings define the color of the buttons and the different statuses.
Advanced layout – additional sections
The advanced layout sections and settings allow you to define parts of the style in detail.

library color bar section:
These settings define the colors of the area under the top bar of the library.

Orientation icon section:
These settings define the colors of the orientation buttons in the trainer and book reader bar.

Buttons (library content) section:
These settings define the color of the content buttons in the content view of the library.
338
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Interface and Components

Dialog splitter section:
These settings define the color of the splitter between the tree and content view in the library.

trainer bar section:
These settings define the color of the top and bottom lines of the library and book reader bar.

Progress indicator section:
These settings define the color of the progress indicator of the trainer and book reader bar.
In addition to the advanced layout sections, there are further settings available in the standard layout sections.
Color overview
The color overview is HTML page that includes all options with the corresponding colors in a table. This provides
you with an overview for proof of design standards.
To use the color overview, go to the style folder and open the colors.html file.
13.7.4.2
Explanation Icons
The explanation icons are used for explanation macro types in a simulation. To customize images, replace the
default images with your own images.
The images have the size 32x32 pixels and are in GIF format.
You can adapt the explanation icons of the documentation in the Documentation Style additionally.
Type
Icon
Info
Remark
Tip
Warning
Replacing an image
This is necessary to assign the correct image file to the active explanation type.
To replace an explanation image in a workarea, proceed as follows:
1.
Select the icon file in the trainer Style resource of the project explorer.
2.
Click on the Replace file... button in the object editor.
3.
This opens the file selection dialog box. Select the required file.
SAP Workforce Performance Builder 9.3
Interface and Components
Customer
© 2014 SAP AG. All rights reserved.
339
4.
Click on Open.
The icon is now integrated into the trainer Style and can be used for simulations.
13.7.4.3
Activating the trainer Style
The created trainer style can be activated using the Playback Settings in the Producer.
1.
Open the central configuration dialog using the Tools -> Settings menu.
2.
Select the section Playback Settings -> trainer - Global -> Visual properties.
3.
In the Style setting, select the created style resource.
4.
Confirm the dialog with OK.
The trainer - Global section activates the style for the whole trainer. It is also possible to select an individual style
for the book reader, library or a simulation mode on the relevant settings page.
13.7.5
Navigator Style
The Navigator is the playback application for navigation projects. The Navigator style includes the image files and
colors of the desktop assistant and the process assistant windows.
13.7.5.1
Attributes of the Navigator Style
This chapter describes the basic settings and sections for adapting the Navigator style.

Name:
Specifies the name of the style.

Logo:
The logo is used for the desktop assistant window.
The first settings are the basic color settings for the Navigator style. When these colors are changed, the other
colors are changed automatically in their gradation.

Main color 1:
The setting defines the basic fill color. The gradients will be set automatically.

Main color 2:
The setting defines the basic fill color. The gradients will be set automatically.

Text color:
The setting defines the basic color of the window texts.

Active / Selection:
The setting defines the basic color of active and selected controls and entries.
The setting areas allow you to define the components of the windows.

340
Icon colors:
These settings define the color of the lamp icon on the header and button and the different statuses.
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Interface and Components

Minimized Button:
These settings define the color of the button and the different statuses.
o
Button gloss:
The setting activates the gloss of the buttons.
o
Button effect:
The setting activates the effect of the buttons.
o
Gloss color (Advanced):
The setting defines the color of the button gloss. To use this color, activate the Button gloss option.

Header:
These settings define the colors of the header.

Menu bar:
These settings define the colors of the menu bar and buttons in the desktop assistant window.

List:
These settings define the colors of the object and step lists.

Dialog windows:
These settings define the colors of the windows.

Dialog buttons:
These settings define the colors of the buttons.
13.7.5.2
Activating the Navigator Style
The Navigator style you have created can be activated as follows:
Desktop Assistant
1.
Open the central configuration dialog box using the Tools -> Settings menu.
2.
Select the section Navigation Playback Settings -> Navigator.
3.
In the Style setting select the created style resource.
4.
Confirm the dialog box with OK.
Process Assistant
1.
Open the navigation project.
2.
Select the Process Assistant Style macro in the first step.
3.
Open the subcategory Process Assistant Window in the macro editor.
4.
Select the style resource in the Window Style option.
If the setting is deactivated, click on the green button.
5.
Save the project.
You are able to define the style as default of the Process Assistant Style macro for each new process assistant
project.
1.
Open the central configuration dialog box using the Tools -> Settings menu.
2.
Select the section Navigation Authoring Settings -> Macro Initialization -> Process Assistant Style.
3.
In the Style setting select the created style resource.
4.
Confirm the dialog box with OK.
SAP Workforce Performance Builder 9.3
Interface and Components
Customer
© 2014 SAP AG. All rights reserved.
341
13.7.6
Book Page Style
You can define specific book page styles to customize books. This can reflect the step of the content or can have a
company design.
The book page style can be selected for a book page in the Style parameter in the book page editor.
The book page style includes the following components:

background

buttons

pop-up window
13.7.6.1
Attributes of the Book Page Style
This chapter describes the basic settings and sections for adapting the book page style.

Name:
Specifies the name of the style.
The first settings are the basic color settings for the book page style. When these colors are changed, the other
colors will be changed automatically in their gradation.

342
Button border:
The setting defines the basic color for the borders of the buttons.
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Interface and Components

Button fill:
The setting define the fill color of the buttons.

Multi-color icons:
The setting defines the colors of the icons of the buttons. In general the icons are multi-color icons.
With deactivated setting further parameters are available to define icons with a single color.
The setting areas allow you to define the components of the book page.

Page background:
The settings define the image of the book page background.

Text pop-up - Window:
These settings define the colors of the window for the text pop-up.

Text pop-up - Button:
These settings define the colors of the buttons for the text pop-up.
13.7.7
Bubble Styles
You can define specific bubble styles for the individual customization of simulation or navigation content or book
pages.
The general structure of bubbles is a text field with a spike and header bar for the feedback bubble.
Bubble templates
The templates for bubbles in the style editor:
Bubble
Preview
Edge Bar
SAP Workforce Performance Builder 9.3
Interface and Components
Customer
© 2014 SAP AG. All rights reserved.
343
Bubble
Preview
Gloss Effect
Shadow
Gray
344
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Interface and Components
Note
The style editor is used for editing new bubbles. Existing bubble styles should be edited in the bubble style
editor.
13.7.7.1
Attributes of the Bubble Styles
The available bubble settings depend on the bubble style and characteristics.
Typical bubble style attributes for defining the main characteristics:

Name:
This setting specifies the name of the style.

Border:
This setting defines the color of the bubble’s border.

Content fill:
This setting defines the color of the bubble including the content part.

Header fill:
This setting defines the color of the bubble’s header.
Advanced layout – additional sections
The advanced layout sections and settings allow you to define parts of the style in detail.

Title text section:
The settings define the text style for the text in the bubbles title bar.
13.7.8
Border Styles
You can define specific border styles for the objects Text Box, Placeholders and Active Area on book pages, in
order to highlight content or to use the boxes as design elements.
The border styles can be selected individually for each object by using the Border Style parameter.
Border style templates
The templates for border styles in the style editor:
SAP Workforce Performance Builder 9.3
Interface and Components
Customer
© 2014 SAP AG. All rights reserved.
345
Border Style
Preview
Decor 1
Highlighter
Text Box Shadow
346
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Interface and Components
13.7.8.1
Attributes of Border Styles
The available border settings depend on the border style and characteristics.
Typical border style attributes for defining the main characteristics:

Name:
This setting specifies the name of the style.

Background color:
This setting specifies the color of the text box.

Fill background:
This setting activates the specified color of the text box.
Decor
The style includes the following further parameters:

Line color:
This setting specifies the color of the text box border.
Text Box Shadow
The style includes the following further parameters:

Add Effects (Advanced Layout):
These settings specify the color effects in the text box.

Shadow:
These settings specify the shadow of the text box and allow you to change the characteristic and color.
13.7.9
Manager Style
You can define a specific Manager style (based on your company design, for example) to customize the Manager
interface.
The Manager style must be copied manually into the Manager installation.
SAP Workforce Performance Builder 9.3
Interface and Components
Customer
© 2014 SAP AG. All rights reserved.
347
13.7.9.1
Attributes of the Manager Style
This chapter describes the basic settings and sections for adapting the Manager style.

Name
This setting specifies the name of the style.

Browser window title
This setting specifies the title of the Manager in the browser window.

Logo
This setting specifies the logo image that will be used in the header of the Manager.
Standard layout
The standard settings sections allow you to specify the colors for basic components of the Manager style.

348
Header
These settings define the color of the background and texts for the header. The fill color is divided into top and
bottom colors to define a gradient.
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Interface and Components

Menu bar
These settings define the color of the buttons and texts of the menu bar with different statuses.

Tree selection
These settings define the color for the status of the tree entries.

Table selection
These settings define the color for the status of the table entries.

Dialog windows
These settings define the color of the bars and texts for the dialog boxes.
Advanced layout – additional sections
The advanced layout sections and settings allow you to define parts of the Manger style in detail.

Glow effect
These settings define the glow effect of the header. It is positioned behind the logo and can be set in three
different sizes.

Submenu dropdown
These settings define the color of the menu and texts of the dropdown for the submenu.
Color overview
The color overview is HTML page that includes all options with the corresponding colors in a table. This provides
you with an overview for proof of design standards.
To use the color overview, go to the style folder and open the colors.html file.
13.7.9.2
Implementing the Manager Style
The Manager styles that you create are stored in the project explorer under Resources -> Adaptable Resources. To
include the style in a Manager installation, proceed as follows:
1.
Right-click on your Manager Style resource.
2.
In the context menu, select Open Folder.
3.
Open the manager-version folder of the resource.
4.
Open the Manager files in the webapps folder of your Tomcat installation, for example:
…\Apache Software Foundation\Tomcat6.0\webapps\ Manager_Installation
5.
Copy the files from the resource folder into the folder of your Manager installation, replacing the existing files.
Keep the other files in the installation folder untouched.
The files and folders are:
o
images
o
release
o
unprotected
o
webclient
o
index.htm
SAP Workforce Performance Builder 9.3
Interface and Components
Customer
© 2014 SAP AG. All rights reserved.
349
13.8 Text Style Editor
The text style editor is the component for editing text resources in the Producer. The editor allows you to
customize texts for consistent use in the content.
In the text style editor, adapted styles are stored in the Adaptable Resources section of the project explorer’s
resource tree. The created styles can be used in the HTML editor during content creation.
The dialog can be opened with the Tools -> Customization -> Edit Style Resources... menu.
Note
The created text styles are always used for the current workarea. To use the styles in other workareas,
export the resources as an archive file.
13.8.1
Structure and Functions
The style editor can be opened using the Tools -> Edit Text Styles… menu. The basic parts of the editor are:

350
Preview
The preview on the left of the screen shows the available styles and the executed changes.
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Interface and Components

Settings page
The settings page on the right of the screen shows the settings for the selected style.
The style editor includes several functions for managing styles:

New…:
Creates a new style based on an available style.

Duplicate:
The function duplicates the selected style. The duplicated style and the source style use the same base style.
A default style cannot be duplicated.

Inherit:
Inherits the selected style. The inherited style uses the source style as base style.

Delete:
Deletes a style from the style list and the resources.

Save:
Saves the changes of the currently opened style.

Close:
Closes the text style editor.
13.8.2 Text Style Categories
The text style editor has the following style categories in the preview view. Each section includes default styles and
adapted styles. The default styles cannot be changed.

Default Style:
Includes the default text style for all style definitions. The default text style only includes the Font Family and
Font Size.

Paragraph Styles:
Includes the paragraph and heading styles.

List Styles:
Includes styles for lists and list level.

Inline Styles:
Includes the inline styles for the combination of styles in a text.

Block Styles:
Includes block styles for the definition of text boxes text box entries.

Table Styles:
Includes table styles for the definition of tables and table entries.
13.8.3 Creating a Text Style
Before you can adapt a text style, you first need to create a new text style in the text style editor. This can be done
as follows:
1.
Click on the New… button.
2.
Adapt the following settings in the dialog box:
SAP Workforce Performance Builder 9.3
Interface and Components
Customer
© 2014 SAP AG. All rights reserved.
351
o Style type:
The setting shows the available style types. Select the type that you want to use as a template.
o Name:
Enter a name for the style.
3.
Confirm your settings with OK.
The new text style is added to the preview in the corresponding style category.
Duplicate or inherit a style
Alternatively you can also duplicate or inherit an existing style in a style section.

Duplicate:
Use this function if you want the duplicated style and the source style to use the same base style.
Note that a default style cannot be duplicated.

Inherit:
Use this function if you want the inherited style to use the source style as the base style.
The functions can be used as follows:
1.
Select the source style in the preview.
2.
Click on the Duplicate or Inherit button.
The new text style is added to the preview under the source style.
13.8.4 Editing a Text Style
To edit a text style, proceed as follows:
1.
Select the style that you want to change.
To open a style category, click on the category name.
2.
Edit the settings in the settings page.
Each text style includes style relevant parameters that can be adapted. The main sections are:
o Text - general parameters
o Paragraph
o Margin
o Padding
o Border
o List Level
3.
After you have made your changes, click on Save to save the resource.
13.9 Bubble Style Editor
The bubble style editor allows the adaptation of the bubble styles for projects and book pages. The editor can be
opened about the Tools -> Edit Bubble Styles… menu.
352
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Interface and Components
The basic parts of the editor are:

Bubble style list:
The bubble style list on the left side shows the available bubble styles.

Settings page:
The settings page on the right top side shows the settings for the selected bubble style.

Preview:
The preview on the right bottom side shows a preview of the selected style and the executed changes.
The bubble style editor includes several functions for the administration of bubble styles:

New…:
The button allows you to create a new bubble style based on a template.

Delete:
The button allows you to delete a bubble style from the resources.

Rotate:
The button allows you to rotate the spike of the bubble style in the preview.

Save:
The button allows you to save the changes of the currently opened bubble style.

Close:
The button allows you to close the bubble style editor.
Creating a new bubble style
For the adaptation of a bubble style at first it is necessary to create a new bubble style in the bubble style editor.
This can be done as follows:
1.
Click on the New… button.
2.
A dialog box opens with the following settings:
3.
o
Name
Enter a name for the bubble style.
o
Template
Select a bubble style templates from the drop down list.
Confirm your settings with Ok.
After creating a new bubble style a style resource is generated in the Bubble Styles section of the resources. The
bubble style is displayed in the preview and in the bubble style list of the bubble style editor.
13.9.1
Bubble Style Attributes
The basic adaptable attributes for the bubble styles are colors. The colors can be defined as hexadecimal value or
about the color selection dialog box. This dialog box can be opened about the Choose color… button.
Further information about the color selection dialog box is available in the Producer manual.
The main attributes for bubbles in the bubble style editor:

Key
The setting defines the ID of the bubble style and will be generated with the creation: It can’t be changed
afterwards.

Name
The setting defines the name of the bubble style.
SAP Workforce Performance Builder 9.3
Interface and Components
Customer
© 2014 SAP AG. All rights reserved.
353

Template
The setting defines the template of the bubble style and will be defined with the creation: It can’t be changed
afterwards.

Background Color
The setting defines the general body color of the bubble.

Title Bar Color
The setting defines the color of the title bar for the feedback bubble.

Border Color
The setting defines the color of the border.

Opacity
The setting defines the transparency of the bubble and will be defined in percent. In general it is 100%
Further attributes are bubble style dependent and can be the following color attributes:

Highlight

Gradient

Shadow

Inner Border

Outer Border

Type Sticky Note: border, background and highlight color for the arrow
13.9.2 Bubble Style Templates
The following Templates are available for the appearance of a bubble:
Name
Description
Gradient
The Gradient template depicts
bubbles with two-colored gradients
and thick borders.
354
Customer
© 2014 SAP AG. All rights reserved.
Design
SAP Workforce Performance Builder 9.3
Interface and Components
Name
Description
Thick Border
The Thick Border template depicts
bubbles a 2 pixel deep border and
without gloss.
Bold
The Bold template depicts bubbles
with two-colored thick borders and
a wide point.
Bulb
The Bulb template depicts bubbles
with no effects and with rounded
corners.
Simple
The Simple template depicts
bubbles with rounded corners.
SAP Workforce Performance Builder 9.3
Interface and Components
Design
Customer
© 2014 SAP AG. All rights reserved.
355
Name
Description
Standard
The Standard template depicts
bubbles with rounded corners and
gloss. This is the default for
simulations.
Formal
The Square template depicts
bubbles without rounded corners
and effects.
Glassdrops
The Glassdrops template depicts a
bubble with drops as the point
together with shadows and gloss.
Glossy
The Glossy template depicts a
bubble with gloss.
356
Customer
© 2014 SAP AG. All rights reserved.
Design
SAP Workforce Performance Builder 9.3
Interface and Components
Name
Description
Glossy Navigation
The Glossy Navigation template
depicts a yellow bubble with
orange glossy border. This is the
navigation default.
Glossy Transparent
The Glossy Transparent template
depicts a glossy, transparent
bubble.
Standard (Classic)
The Standard (Classic) template
depicts bubbles with rounded
corners and gloss.
Small
The Small template depicts
bubbles with small rounded
corners.
SAP Workforce Performance Builder 9.3
Interface and Components
Design
Customer
© 2014 SAP AG. All rights reserved.
357
Name
Description
Spike 45
The Spike 45 template depicts a
bubble with a point at an angle of
45 degrees and a 2 pixel deep
border.
Sticky Note
This template replaces the
traditional bubble with a Sticky
Note. This template also has an
arrow so that it can point to the
object it refers to.
Feedback (Classic)
The Feedback (Classic) template
depicts bubbles with rounded
corners and gloss.
Feedback
The Feedback template depicts
bubbles with rounded corners and
gloss.
358
Customer
© 2014 SAP AG. All rights reserved.
Design
SAP Workforce Performance Builder 9.3
Interface and Components
13.10 Using an External Editor for Images
Images are one of the main contents in objects, especially in projects. In some cases, it may be necessary to
change, update or retouch an image. You can use an image editing editor, in order to make it easier to edit images.
When editing content, you can open a specific image from the Producer in the external editor. Once the image has
been edited and saved, the changes are visible in the Producer.
An external editor can be used for all types of images in:

projects - navigation and simulation

book pages

style editor
Editing an image externally
To use an external editor, proceed as follows:
1.
Select the macro with the included image.
2.
Click on the Replace Image button (macro editor) of the image parameter and choose External Editor... from
the menu.
The image is opened in the editor and a dialog box appears.
Note
Do not close the dialog box when editing the image. When you close the dialog box, the changes are
discarded.
3.
Edit the image in the editor.
4.
Save the image in the editor and close the image.
5.
Click on OK in the dialog box to confirm the changes.
Defining the external editor
The default editor for editing images is Microsoft Paint. To set a different editor, proceed as follows:
1.
Click on the Browse... button (see above) in the dialog box.
2.
Select the executable file of the editor.
3.
Confirm with Open.
4.
Click Cancel or OK and restart the function for editing in the selected editor.
13.11 Toolbars
The toolbars in Producer allow you to access the most common menu commands by clicking on the
corresponding icon.
Moving the mouse over a button and leaving it there without clicking the mouse will cause a tooltip to be
displayed, which provides short, helpful information on the function of the tool.
The various toolbars can be shown or hidden by clicking on Toolbars in the View menu and making a selection.
SAP Workforce Performance Builder 9.3
Interface and Components
Customer
© 2014 SAP AG. All rights reserved.
359
13.12 Recording Bar for Recording
As soon as recording is initiated by executing the Record Application command, a recording bar for recording
applications appears at the top of the screen.
The recording bar includes the following sections and controls:
Status section
The status section shows if the user is expected to perform an action or if the Producer is working on a recording
in the background. In addition, supporting icons and text messages are displayed:
Status
Explanation
If an application is being recorded and the user is
required to perform an action, this section is green.
After an action has been performed (e.g. clicking on a
menu), the recording bar also shows what kind of
macro was detected with the action, as well as the text
that is automatically allocated to it in the bubbles in
the project (Name, Type, Value and Subtype).
If Producer is busy with an action in the background,
the status area is red and displays the message: busy.
When this is displayed, no actions should be taken in
the application being recorded.
If the recording feature has been paused, the status
section is yellow.
Buttons and menus
Beside the status section there are the following buttons and menus:
Button
Explanation
The Level Meter is displayed when recording a
simulation with audio. The control indicates the
recording of the audio.
The Profile list box contains the list of applications for
which an automatic application profile exists. If the
application is automatically detected, the correct
application profile is automatically selected and
shown in the list. This box can also be used to switch
between application profiles manually.
Click on Record to begin recording the process.
Afterwards, it will pause itself.
360
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Interface and Components
Button
Explanation
Clicking on the Pause button will pause the recording,
which is useful, e.g., when switching applications. It
will then resume recording (status Record).
Clicking on the button Stop will end the recording and
the macro Simulation End will be inserted into the last
step.
The Undo button allows you to reset the previous
action made in a project. Note that the Undo function
will only work with the last change made to your
project. You cannot delete multiple actions.
Menu Insert
Insert Explanation
see chapter Inserting additional macros
Insert Screenshot
see chapter Inserting additional macros
Menu Tools
In order to be able to edit a recorded control while the
recording is in progress, click on the Edit control
button in the recording bar once the corresponding
action has been performed. This opens the control
selection dialog which can then be used to apply
changes. Once the changes have been confirmed by
clicking on Ok, recording can be resumed.
The button Execute mouse actions defines whether a
control is to be recorded and executed in the
application or whether this is to be recorded without
an action.
Recording controls without executing actions may
make sense, for example, if a number of controls on a
page are to be recorded and explained without
quitting the application page. This requires the button
to be deactivated.
The Choose Application button allows you to reselect
an application for recording or else switch application.
After selecting the button click on the application to
define the application profile.
By clicking on Settings, you are taken directly to the
Record tab, which is normally accessed by clicking on
the Producer Tools menu and then on Settings.
SAP Workforce Performance Builder 9.3
Interface and Components
Customer
© 2014 SAP AG. All rights reserved.
361
Button
Explanation
Clicking on the button Minimize will minimize the
recording bar and an icon will appear in the Systray
instead. Controlling the recording can be carried out
over the context menu. By clicking on the icon, the
recording bar will return to its original size.
Clicking on the X will stop the recording. The program
will exit recording standby mode and the recording
bar will be hidden.
13.12.1 Recording Bar for ReRecording
The control bar for ReRecording applications works analogously. The only difference is that there are no icons for
starting, pausing and stopping the recording. Instead, there is a single icon for starting the ReRecording.
Status section
The status section shows if the user is expected to perform an action or if the is working on a recording in the
background. In addition, supporting icons and text messages are displayed:
Status
Explanation
If is busy with an action in the background, the status
area is red and displays the message: busy. When this
is displayed, no actions should be taken in the
application being recorded.
If an application is being recorded and the user is
required to perform an action, this section is green.
After an action has been performed (e.g. clicking on a
menu), the recording bar also shows what kind of
macro was detected with the action, as well as the text
that is automatically allocated to it in the bubbles in
the project (Name, Type, Value and Subtype).
If the recording feature has been activated but the
recording has not yet been started, the status section
is yellow.
362
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Interface and Components
Buttons and menus
Beside the status section there are the following buttons and menus:
Button
Explanation
The button Accept Control allows you to confirm a
control during rerecording in interactive mode and to
rerecord it.
If a control is not displayed correctly you can directly
rerecord it via the Show Control function. Select the
function and click on the control.
This button opens the Step Preview. The step preview
displays the originally recorded step, allowing it to be
replicated and the object customized accordingly
The Rerecord button starts the ReRecording process.
The parameter dialog is then opened.
Clicking on the Pause button will pause the
ReRecording session, which can useful, e.g., when
switching applications. It will then resume recording
(status ReRecord).
Menu Insert
The Record Control button starts automated
recording. This allows additional steps to be
automatically recorded during ReRecording. These
are inserted in front of the current step. The ESC key
terminates the recording mode and ReRecording
continues. This function is available during interactive
ReRecording.
Clicking on the button Stop will end the recording of
further actions in order to continue with the
ReRecording. The button will display the status
Record control.
The button Insert Explanation allows you to insert an
explanation macro during the ReRecording session.
Menu Tools
The Delete Control button offers the opportunity to
delete the currently selected object. Then the
ReRecording is resumed using the following object in
the tutorial.
SAP Workforce Performance Builder 9.3
Interface and Components
Customer
© 2014 SAP AG. All rights reserved.
363
Button
Explanation
The Skip Control button allows skipping a recorded
control if it does not need to be taken into account for
the ReRecording and thus remains unmodified.
The Choose Application button allows you to reselect
an application for ReRecording or else switch
application. After selecting the button click on the
application to define the application profile.
By clicking on Options, you are taken directly to the
Record tab, which is normally accessed by clicking on
the Producer Tools menu and then on Options.
Clicking on the button Minimize will minimize the
recording bar and an icon will appear in the Systray
instead. Controlling the recording can be carried out
over the context menu. By clicking on the icon, the
recording bar will return to its original size.
Clicking on the X will stop the recording. The program
will exit recording standby mode and the recording
bar will be hidden.
364
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Interface and Components
14 Menu Overview
This chapter describes the different functionality in the Producer menus.
14.1
Workarea Menu
The Workarea menu includes all the functions related to the general selection and administration of Workareas
and projects. In addition to selecting and creating Workareas, it is possible to archive and import Workareas and
projects, as well as open folders of the projects most recently displayed in Windows Explorer.
14.1.1
Select Workarea...
By clicking on Select Workarea…, you can create a folder or select an existing one. All objects are saved in that
folder as long as the workarea is active. This ensures that all relevant learning content files and resources are
saved in the proper hierarchical structure.
Note
An already existing workarea can only be selected. The resources in it can not be changed from this
dialog.
To be able to change resources, open the resource tree in the project explorer.
Note
You must always select a workarea. Content can only be created if there is an active workarea.
14.1.2
Export Archive…
This function creates an archive in the form of a DKP file (*.dkp). This allows you to transport an entire workarea,
individual learning content or resources simply and compactly.
This is how you create an archive:
1.
Select the command Export Archive... from the Workarea -> Administration menu. This will open a dialog for
selecting the content for the archive you wish to create.
2.
In the area on the left you will find all of the content and resources located in the Workarea. These are
selected by default.
To deselect the entire workarea, you need to deactivate the Workarea option. To deselect the resources or
content, deselect the relevant resource folder or topmost group.
SAP Workforce Performance Builder 9.3
Menu Overview
Customer
© 2014 SAP AG. All rights reserved.
365
3.
Compression type:
This parameter determines whether the files are to be compressed or not. Compression is recommended to
reduce the file size.
4.
Max. size before splitting volumes:
The technical size limit for a DKP file is 4GB. The drop-down list allows you to define a maximum volume size
of the DKP files generated. Once an archive file's maximum size has been reached, a new one will be created
automatically. As many archive files will be generated as are required to store the entire Workarea. This
allows large Workareas to be broken into a number of parts for transport, which can then be spread across a
number of DVDs or CDs, for example.
5.
With the options Select referenced resources and Select referenced content the referenced items are
automatically selected for the specific content.
6.
Click on OK to confirm the settings.
7.
The dialog for specifying the destination path and filename will then open. Provide this information as
appropriate. Confirm the dialog by clicking on Save to create the archive.
14.1.3
Import Archive…
You can insert an archive in the current Workarea using the Import Archive... command in the Workarea ->
Administration menu. This may be individual projects or customized resources, for example.
Proceed as follows:
1.
Select the command Import archive... from the Workarea -> Administration menu.
2.
Clicking on the command will open a dialog for selecting the archive. Select the file and click on Open.
3.
The archive content is displayed to you in an overview. You can select whether you would like to import all the
archive content or only a part of it.
Confirm the dialog by clicking on OK to insert the files in your Workarea.
Learning content inserted by importing the archive are filed as unsorted objects and can then be assigned to the
project structure.
If the same resources or learning content already exist in the workarea, you are alerted to this and asked whether
they are to be overwritten or duplicated.
Older archive formats
In addition to the DKP archive format, you also have the option to import archives from older versions of the
Producer in CAB format (*.cab) for Workareas and resources as well as DPP format (*.dpp) for an object archive.
These files are migrated into the Workarea and customized to the workarea's structure and technical
implementation in such a way as not to conflict with current content.
Once learning content has been imported, it needs to be regenerated so that it can be played back by the trainer.
14.1.4
Administration
The menu contains functions for the administration of the workarea.
366
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Menu Overview
14.1.4.1
Select Central Workarea…
This command registers the current local Workarea with a Central Workarea.
Note
The registration cannot be reverted. It should be done very carefully.
The creation of a Central Workarea is reserved to the administrator, who must have the feature activated in his
installation of Producer.
If a local Workarea is registered with a Central Workarea, the additional menu Central Workarea is available in the
menu bar. It contains the commands related to exchanging content with a Central Workarea.
If a Central Workarea is selected, the path is shown in the Central Workarea parameter in the project explorer. In
addition, the path is shown together with the path of the local Workarea in the header of the tree view.
Note
In order for several authors to use, a fast LAN (Local Area Network) infrastructure with high bandwidth
and low latency is required.
If the Central Workarea is accessed through a WAN connection (Wide Area Network), the bandwidth
(usually low) and high latency together with the SMB network protocol used by Producer result in
extremely long waiting times when performing remote actions on the Central Workarea.
14.1.4.2
Connect with Manager...
This command registers the current local Workarea with a Central Workarea of a Manager.
Note
The registration cannot be reverted. It should be done very carefully.
If a local Workarea is registered with a Central Workarea, the additional menu Central Workarea is available in the
menu bar. It contains the commands related to exchanging content with a Central Workarea.
If a Central Workarea is selected, the path is shown in the Central Workarea parameter in the project explorer. In
addition, the path is shown together with the path of the local Workarea in the header of the tree view.
14.1.4.3
Disconnect
The option Disconnect will completely disconnect a local workarea from a central workarea. The workarea can
then only be used locally. All existing connections to the workarea (resources and objects) will be removed.
SAP Workforce Performance Builder 9.3
Menu Overview
Customer
© 2014 SAP AG. All rights reserved.
367
14.1.4.4
Update Ressources…
The Update Resources... dialog exists to update the resources of a workarea.
The dialog will offer you the standard installation resources. The resources to be updated are selected once the
dialog has been opened.
The resource overview in the dialog corresponds to what is also available in the Project Explorer. The resources
comprise resource groups; each individual resource has a version number. New versions are referred to as an
upgrade , resources that are older than the current version as a downgrade.
If a resource is already available in the latest version, then you are alerted to this by freshen. Generally you can
disregard this. Overwriting the current resource is helpful, for example, if a resource was damaged during the
work process.
You can now select all the resources or only those to be updated. After selecting the resources, click on OK. These
are then imported into the Producer.
14.1.5
Publish
This menu contains the commands for publishing a Workarea. It also contains the publishing rules created by the
author, which can be executed directly from the menu.
When publishing a Workarea, only macros needed to playback content are copied to a target directory. Objects
which are not necessary or parts of the Workarea which have been masked by a filter are not copied to the target
directory. This reduces and optimizes the amount of files in the target Workarea.
14.1.5.1
Publish Content...
This command allows you to publish a workarea or only specific parts of a workarea. The overview displays the
workarea in just the same way it is available in the project explorer. This also takes account of the filter currently
being applied to the workarea in the project explorer view.
Also note the details in the section Publishing a workarea.
14.1.5.2
Edit Publishing Rules...
This is the dialog box where you create and manage publishing rules. A publishing rule is a fixed view of the
currently selected workarea of which a copy will be created as the publishable workarea. The dialog lets you define
the Name, Destination, Filter, Prefix and Type for a rule. The rule then becomes available as a directly selectable
item in the Workarea -> Publish menu.
Also refer to the section Creating publishing rules.
368
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Menu Overview
14.1.6
New Group
This creates a new group in the Workarea under the item that is currently selected.
After clicking on New Group from the workarea menu or the toolbar, a dialog box will appear. You have the
following options:


Name:
Enter a name for your group in this field. The default setting is the type of object with an ID.
Template:
This option allows you to use an existing group as a template for a new group. Using predefined settings
from an existing group will save you loads of time when creating a new group.
You can select additional templates by clicking on Change... A dialog box will appear. Select template for
the current object or the entire workarea. Click on the option No template if you do not wish to use any
templates for your group.
If a template has already been used, this template will act as the default and will be automatically selected
upon creating a new group.
Recommendation
You can make templates your default setting from the main configuration dialog box. Refer to the section
on Templates for content objects for more detailed information.


Language:
Here you can select a content language.
Synchronization:
If you are using a central workarea, you can use this option to manage your group with this.
The following settings are available:

Inherit from parent:
Sets the synchronization of the parent object.

Unmanaged:
Saves the object only locally.

Edit and share:
Allows the editing and shares the object.

Edit and own:
Allows the editing and owns the object.
Confirm by clicking on OK and your group will be created.
14.1.7
New Project
The New Project icon will create a new project in the current workarea group that was selected from the tree view
in the project explorer.
SAP Workforce Performance Builder 9.3
Menu Overview
Customer
© 2014 SAP AG. All rights reserved.
369
After clicking on New Project from the workarea menu or the toolbar, a dialog box will appear. You have the
following options:


Name:
Enter a name for your project in this field. The default setting is the type of object with an ID.
Template:
This option allows you to use an existing project as a template for a new project. Using predefined settings
from an existing project will save you loads of time when creating a new project.
You can select additional templates by clicking on Change... A dialog box will appear. Select template for
the current object or the entire workarea. Click on the option No template if you do not wish to use any
templates for your project.
If a template has already been used, this template will act as the default and will be automatically selected
upon creating a new project.
Recommendation
You can make templates your default setting from the main configuration dialog box. Refer to the section
on Templates for content objects for more detailed information.



Language:
Here you can select a language for the automatically generated texts of the bubbles that are created
during the recording.
Project Type:
This option defines the content to be created:

Simulation

Navigation
Use Audio:
This option allows you to create an audio project. You can assign audio files as well as convert bubble text
to text-to-speech. When you activate this option, the following settings will appear:

Output format:
Defines the audio format for playing back a project.

Editing format:
Defines the audio format for editing a project. The format can be changed in the Change Audio
Format dialog box (menu Audio)
Note
It is also possible to convert a completed project into an audio project. To do so, go the Edit menu in the
project editor and choose the option Convert to audio project.

370
Synchronization:
If you are using a central workarea, you can use this option to manage your project with this.
The following settings are available:

Inherit from parent:
Sets the synchronization of the parent object.

Unmanaged:
Saves the object only locally.

Edit and share:
Allows the editing and shares the object.
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Menu Overview

Edit and own:
Allows the editing and owns the object.
Confirm by clicking on OK and your project will be created. The Producer will automatically switch to the project
editor.
14.1.8
New Book
This creates a new book in the Workarea under the item that is currently selected.
After clicking on New Book from the workarea menu or the toolbar, a dialog box will appear. You have the following
options:


Name:
Enter a name for your book in this field. The default setting is the type of object with an ID.
Template:
This option allows you to use an existing book as a template for a new book. Using predefined settings
from an existing book will save you loads of time when creating a new book.
You can select additional templates by clicking on Change... A dialog box will appear. Select template for
the current object or the entire workarea. Click on the option No template if you do not wish to use any
templates for your book.
If a template has already been used, this template will act as the default and will be automatically selected
upon creating a new book.
Recommendation
You can make templates your default setting from the main configuration dialog box. Refer to the section
on Templates for content objects for more detailed information.


Language:
Here you can select a content language.
Synchronization:
If you are using a central workarea, you can use this option to manage your book with this.
The following settings are available:

Inherit from parent:
Sets the synchronization of the parent object.

Unmanaged:
Saves the object only locally.

Edit and share:
Allows the editing and shares the object.

Edit and own:
Allows the editing and owns the object.
Confirm by clicking on OK and your book will be created.
14.1.9
New Book Page
This creates a new book page in the Workarea under the item that is currently selected.
SAP Workforce Performance Builder 9.3
Menu Overview
Customer
© 2014 SAP AG. All rights reserved.
371
After clicking on New Book Page from the workarea menu or the toolbar, a dialog box will appear. You have the
following options:


Name:
Enter a name for your book page in this field. The default setting is the type of object with an ID.
Template:
This option allows you to use an existing book page as a template for a new book page. Using predefined
settings from an existing book page will save you loads of time when creating a new book page.
You can select additional templates by clicking on Change... A dialog box will appear. Select template for
the current object or the entire workarea. Click on the option No template if you do not wish to use any
templates for your book page.
If a template has already been used, this template will act as the default and will be automatically selected
upon creating a new book page.
Recommendation
You can make templates your default setting from the main configuration dialog box. Refer to the section
on Templates for content objects for more detailed information.


Language:
Here you can select a content language.
Synchronization:
If you are using a central workarea, you can use this option to manage your book page with this.
The following settings are available:

Inherit from parent:
Sets the synchronization of the parent object.

Unmanaged:
Saves the object only locally.

Edit and share:
Allows the editing and shares the object.

Edit and own:
Allows the editing and owns the object.
Confirm by clicking on OK and your book page will be created. The Producer will automatically switch to the
project editor.
14.1.10 New Text Unit
This creates a new text unit in the Workarea under the item that is currently selected.
After clicking on New Text Unit from the workarea menu or the toolbar, a dialog box will appear. You have the
following options:

Name:
Enter a name for your text unit in this field. The default setting is the type of object with an ID.

Template:
This option allows you to use an existing text unit as a template for a new text unit. Using predefined settings
from an existing text unit will save you loads of time when creating a new text unit.
You can select additional templates by clicking on Change... A dialog box will appear. Select template for the
current object or the entire workarea. Click on the option No template if you do not wish to use any templates
372
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Menu Overview
for your text unit.
If a template has already been used, this template will act as the default and will be automatically selected
upon creating a new text unit.
Recommendation
You can make templates your default setting from the main configuration dialog box. Refer to the section
on Templates for content objects for more detailed information.

Language:
Here you can select a content language.

Synchronization:
If you are using a central workarea, you can use this option to manage your text unit with this.
The following settings are available:
o
Inherit from parent:
Sets the synchronization of the parent object.
o
Stay unmanaged:
Saves the object only locally.
o
Edit and share:
Allows the editing and shares the object.
o
Edit and own:
Allows the editing and owns the object.
Confirm by clicking on OK and your text unit will be created.
14.1.11 Open Base Directory
This command opens the Workarea's base directory in Windows Explorer, which, in addition to the project folders,
contains the components of trainer needed to directly playback offline content.
14.1.12 Preview library
Running this function generates a library of contents based on the structure set up in the workarea and displays it
in a new browser window. Only objects that have not been set to Hidden will be included in the library.
14.1.13 Generate All Contents...
The function generates all project modes and preview images of the book pages in the current workarea. This is
especially important for migrated workareas or for a large number of imported content objects.
Open the dialog in the project explorer from the Workarea -> Generate all Contents… menu. The following settings
can be configured:
SAP Workforce Performance Builder 9.3
Menu Overview
Customer
© 2014 SAP AG. All rights reserved.
373

Structure:
Defines the structure for generating the content.
o Subtree – a selected subtree
o Root Group – the complete content structure
o All (including “Unsorted”) – the complete content structure and the unsorted objects

Content filter:
Defines specific content to be generated.
o Project Modes
o Book Page Previews

Update files for library:
Specifies that the library files are updated to include the generated modes for display in the content structure.
Confirm the dialog with OK to generate the contents.
14.1.14 Exit
This command exits Producer.
14.2 Central Workarea Menu
This menu is only available if the local Workarea was registered with a Central Workarea via the menu Workarea ->
Administration -> Select Central Workarea…
The menu contains commands for the management of objects between the local and the central workarea.
14.2.1
Check out Objects...
This command allows all of the objects contained in a Central Workarea to be downloaded to the local Workarea.
Selecting the command opens a list containing all the objects in the Central Workarea. The objects that are not yet
located in the local Workarea are selected. Once the desired objects have been selected, they can be copied to the
local Workarea using the Check out Object function.
14.2.2 Synchronize Workarea...
The command synchronizes the objects of the local workarea with the central workarea dependent on the
synchronization status of the objects.
374
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Menu Overview
14.2.3 Save to server (without synchronization)
This command saves the object currently selected in the Project Explorer to the Central Workarea.
14.2.4 Update from server
This command updates the object that has just been selected in the Project Explorer with an up-to-date copy of
the object from the Central Workarea.
14.2.5 Revert object...
This command replaces the local version of the object with the most recent version deposited in the Central
Workarea. This requires possession of the write permission for the object.
14.2.6 Start editing
This command acquires the write permission for the object selected in the Project Explorer from the Central
Workarea and updates the version available in the local Workarea. The object can then be edited in the local
Workarea.
An object for which no write permission is available is indicated by a red padlock on the object icon. If you possess
the write permission a green pencil appears on the object icon.
Note
You can only acquire the write permission for an object if it has not already been checked out by another
author from the Central Workarea into his local Workarea.
14.2.7
Finish editing
This command relinquishes the write permission for the object selected in the Project Explorer to the Central
Workarea and saves the changes made in the local Workarea within the Central Workarea.
The relinquished write permission is then symbolized on the object by a red padlock.
SAP Workforce Performance Builder 9.3
Menu Overview
Customer
© 2014 SAP AG. All rights reserved.
375
14.2.8 Change workflow...
This command allows an object's workflow to be edited. It opens a dialog box which can be used to enter a
comment and assign the object to another user. It is still possible to amend the status, set flags and publish the
object.
14.2.9 Add comment...
This command allows a comment to be made in respect of an object that has not yet been saved in the Central
Workarea.
14.2.10 Save all objects to server... (without synchronization)
This command saves a number of local Workarea objects to the Central Workarea. It does so by opening a dialog
in which the available objects can be selected.
14.2.11 Update all objects from server... (without synchronization)
This command updates the objects available in the local Workarea with an up-to-date copy from the Central
Workarea. It does so by opening a dialog displaying the objects contained in the Central Workarea which are to be
updated. These objects can then be selected and copied to the local Workarea using the Update from the Server
button.
14.2.12 Start editing all objects...
This command checks out the write permission for the objects available in the local Workarea. It does so by
opening a dialog displaying the objects contained in the Central Workarea. These objects can then be selected and
the objects' write permission checked out using the Commence Editing button. This involves copying the current
versions of the objects to the local Workarea.
The objects for which write permission has been checked out are indicated by a green pencil on the object icon.
Note
You can only acquire the write permission for an object if it has not already been checked out by another
author from the Central Workarea into his local Workarea.
376
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Menu Overview
14.2.13 Finish editing all objects...
This command relinquishes the write permission for all objects in the local Workarea and saves the changes
applied in the local Workarea to the Central Workarea. It does so by opening a dialog displaying the objects with
locally available write permission. The write permission for the selected objects can now be saved in the Central
Workarea using Finish editing.
The relinquished write permission is then symbolized on the object by a red padlock.
14.2.14 Change workflow for all objects...
This command allows editing of the workflow for all objects. It does so by opening a dialog in which the objects
available in the local Workarea can be selected. Clicking on Ok opens a dialog which can be used to enter a
comment along with a user to whom the objects are to be assigned. It is still possible to amend the status, set
flags and publish the objects.
14.2.15 Manage
The menu contains commands for the advanced management of objects in connection with a central workarea.
14.2.15.1 Set synchronization...
The command allows you to change the synchronization behavior for the selected object.
14.2.15.2 Remove from version management
The command allows you to remove the version management for the selected object and to use it only locally. The
object in the central workarea is not changed.
14.2.15.3 Set synchronization for all objects...
The command allows you to change the synchronization behavior for all objects or a selection of objects. Through
that the synchronization can be set consistently.
SAP Workforce Performance Builder 9.3
Menu Overview
Customer
© 2014 SAP AG. All rights reserved.
377
14.2.15.4 Remove all objects from version management...
The command allows you to remove the version management for all objects or a selection of objects and to use
the objects only locally. The objects in the central workarea are not changed.
14.2.15.5 Manage tags...
This command opens a dialog in which new flags can be created and existing flags can be deleted.
14.2.16 Manage tasks...
The command opens a dialog displaying the object tasks. Double clicking on a task selects the object in the
Project Explorer and closes the dialog box.
The Filter... button calls a dialog box in which various filter criteria by which the list can be filtered can be selected.
Remove Filter regenerates the original state.
14.2.17 Work offline
If the Manager is used to launch a Central Workarea this function allows the connection with the Manager to be
severed while work is in progress. The connection therefore only exists for downloading objects and for saving
objects on the server. While the connection is severed, entries in the Central Workarea menu are grayed out.
14.2.18 Open Manager
This command opens the Manager in a browser window. You can then log onto the Manager via the login area.
14.3 Project Menu
The Project menu contains functions for the administration of a project.
14.3.1
Save
The function saves the project currently open and displayed. In addition to the saving, the different modes will be
generated.
378
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Menu Overview
14.3.2 Export Archive...
You can use this feature to export an entire project folder from a Workarea to an archive file, allowing you to easily
move and integrate it into other Workareas. The archive file is saved in the *.dkp format.
14.3.3 Publish...
This command allows you to publish an individual project. That means that it is not necessary to issue numerous
resources and projects; projects can be distributed individually instead.
For further information, see the chapter Publishing Individual Objects.
14.3.4 Open Project Directory
This causes Windows Explorer to open the folder of the currently active project in the Workarea containing the
folders for the project files.
14.3.5 Duplicate...
The Duplicate... function allows you to duplicate an object or an object structure. Through that you can use the
available content for adaptations and variations and do not change the source object.
To duplicate an object, proceed as follows:
Note
What is required to duplicate a project is to close all the documentation and other files belonging to a
project. This is required in order to be able to duplicate the files as well.
1.
Select an object or a content tree in the project explorer.
or
Open a project or book page in the project editor or book page editor.
2.
Click on Edit -> Duplicate...
A setting dialog opens.
3.
Adapt the following settings:
o
Name:
With the setting you can change the name of the duplicate.
o
Duplicate subobjects:
With the setting you can duplicate also the subobjects of an selected content tree. If the setting is
deactivated, the subobjects will be created as reference.
The setting is shown, if you select a tree in the project explorer.
SAP Workforce Performance Builder 9.3
Menu Overview
Customer
© 2014 SAP AG. All rights reserved.
379
o Advanced:
With the activation of the setting, further settings will be shown. This are:
o Set Language:
With the setting you can change the content language of an object.
The setting does not influence the content and no automatic translation is executed.
o Replace in Name:
With the setting you can change the name of the objects by replacing parts of the name.
4.
Confirm the dialog with OK, to duplicate the object.
14.3.6 Convert to Audio Project
Menu item Convert to audio project in the Projects menu creates an audio project out of a regular project. This
allows you to convert a project to an audio project at a later date if you have not done so when creating the
project. Consequently, this menu item is also only displayed in projects without audio.
Note
Once a project has been converted into an audio project, this step cannot be undone.
Selecting the function opens the Select output audio format menu. The settings to be applied there are required to
define the properties of the audio project or its audio files:

Editing format
Defines the audio format in which the project is created and edited.

Output format
Defines the audio format in which the project is generated.
After the dialog has been confirmed by clicking on the OK button, the project is converted into an audio project.
This saves the project file as a WRP file. You also have audio editing functions at your disposal.
14.3.7
Close
Closes the project, which is currently open and displayed.
If you do not save the project before closing it, a dialog box will appear, prompting you to do so.
14.4 Book Page Menu
The Book Page menu combines the basic functions required for editing a book page file.
380
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Menu Overview
14.4.1
New Book Page
This creates a new book page in the Workarea under the item that is currently selected.
After clicking on New Book Page from the workarea menu or the toolbar, a dialog box will appear. You have the
following options:

Name:
Enter a name for your book page in this field. The default setting is the type of object with an ID.

Template:
This option allows you to use an existing book page as a template for a new book page. Using predefined
settings from an existing book page will save you loads of time when creating a new book page.
You can select additional templates by clicking on Change... A dialog box will appear. Select template for the
current object or the entire workarea. Click on the option No template if you do not wish to use any templates
for your book page.
If a template has already been used, this template will act as the default and will be automatically selected
upon creating a new book page.
Recommendation
You can make templates your default setting from the main configuration dialog box. Refer to the section
on Templates for content objects for more detailed information.

Language:
Here you can select a content language.

Synchronization:
If you are using a central workarea, you can use this option to manage your book page with this.
The following settings are available:
o
Inherit from parent:
Sets the synchronization of the parent object.
o
Unmanaged:
Saves the object only locally.
o
Edit and share:
Allows the editing and shares the object.
o
Edit and own:
Allows the editing and owns the object.
Confirm by clicking on OK and your book page will be created. The Producer will automatically switch to the
project editor.
14.4.2 Save Book Page
Saves the book page opened and displayed at that time.
SAP Workforce Performance Builder 9.3
Menu Overview
Customer
© 2014 SAP AG. All rights reserved.
381
14.4.3 Duplicate...
The Duplicate... function allows you to duplicate the book page together with the content it contains. This retains
the objects' configuration.
Duplicating a book page supports the creation of a book page in another language, for example, with only the links
and inserted text for the new language having to be replaced. In similar fashion, this supports the design of a basic
layout with specific objects in which the book page can be duplicated and used at will.
1.
Select the Duplicate... function in the Book Page menu. The original book page will then be closed to avoid
duplication errors as a result of the open file.
2.
A dialog will open in which you can name the duplicate. Confirm this by clicking on OK to create the duplicate.
14.4.4 Export Archive...
This function enables a book page to be exported from a Workarea into an archive file to facilitate the transport of
this file and be able to integrate it into other Workareas. The archive file is in the *.dkp format.
Select the Export Archive... function to create an archive. Then enter a name in the open dialog and select a
destination. Confirm the data you have entered by clicking on Save.
Note
Outputting an archive using this function excludes the Workarea's linked modes and documents.
Therefore, only use the function for book pages in which you have not created any links.
Alternatively you can use the function Export Archive... in the project explorer.
14.4.5 Publish...
This command allows you to publish an individual book page. That means that it is not necessary to issue
numerous resources and book pages; book pages can be distributed individually instead.
For further information, see the chapter Publishing Individual Objects.
14.4.6 Open Folder
This is used to open the directory of the currently active book page in the workarea, which contains the relevant
book page files.
14.4.7
Close
Closes the book page opened and displayed at that time in the book page editor.
382
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Menu Overview
If a book page has not been backed up before closing it, you will be alerted to the absence of a backup via a dialog.
14.5 Edit Menu
The Edit menu contains all the general features that directly manipulate objects.
14.5.1
Undo
This command is used to undo, i.e. reverse, an action and can be repeated until the first item in the history has
been reached.
14.5.2 Redo
This command is used to reverse the undo action, and can be repeated until the last item in the history has been
reached.
14.5.3 Cut
Cut cuts the selected macro or object and places it in the Windows clipboard. This command can be applied to
almost all macros, objects and input fields in Project Explorer and Project Editor.
14.5.4 Copy
Copy copies the selected macro or object to the Windows clipboard. This command can be applied to almost all
macros, objects and input fields in Project Explorer and Project Editor.
14.5.5 Paste
Executing the Paste command inserts the clipboard content at the insertion point in Producer. Note that clipboard
content must be compatible with the location into which it is inserted.
SAP Workforce Performance Builder 9.3
Menu Overview
Customer
© 2014 SAP AG. All rights reserved.
383
14.5.6 Delete
This command deletes the object or macro which has just been selected. It can be applied to almost all macros,
objects and input fields in Project Explorer and Project Editor.
14.5.7
Select All
Select All highlights the largest possible selection in the context of the currently active focus in Producer. It can be
applied to almost all macros, objects and input fields in Project Explorer, Project Editor or Book Page Editor.
14.5.8 Select Macros by Type...
This command gives you the ability to select all the objects of a specific macro type in the thumbnail view. The
dialog shows you all the macros available in the currently accessed course content and shows you a count. When
you select a macro type, all objects of this type are selected in the thumbnail view. This gives you the ability to
make settings for all macros of one type in the macro editor.
14.5.9 Search & Replace Bubble Content
Words or passages of text in all the bubbles contained in a project can be replaced using the Search & Replace
function.
In the field Search the term or text string is entered which is to be found within the bubbles of the project; in the
field Replace by the text string is entered which is to replace the original one.
For more complex tasks, the Search & Replace functionality of Producer can also be used with a regular
expression. In order to do so, activate the option Search & Replace using Regular Expressions. The semantics and
syntax for such task must comply with the standard PCRE (Perl Compatible Regular Expression). You can find
more information on this subject at: http://www.pcre.org
384
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Menu Overview
After triggering the function by clicking OK, an additional dialog informs you how many times the search string
was found and replaced.
Note
Searches performed by the search engine are case-sensitive!
If the content of a bubble has been modified by the command Search & Replace, it is considered to have been
edited manually, and the appropriate option is ticked in the subcategory Rerecord of the macro. This has an effect
on the automated translation and the export of a translatable.
14.6 Audio Menu
The menu contains functions for the editing of an audio file. It is only available, if the opened project is an audio
project.
14.6.1
Play Audio
This command plays the audio of the current step.
14.6.2 Stop Audio
The Stop command stops the playback of an audio.
14.6.3 Record Audio
This command records an audio for the current step.
14.6.4 Pause Audio
This command pauses the playback of an audio.
14.6.5 Repeat Audio
Switches loop mode for the playback of an audio on and off.
SAP Workforce Performance Builder 9.3
Menu Overview
Customer
© 2014 SAP AG. All rights reserved.
385
14.6.6 Import Audio File...
Audio files can be imported into Producer. The audio file is imported into the selected step. If no step is selected or
no step exists in the project, a new step is created automatically. Formats supported when importing audio files
are WAV, AVI and MP3.
Note
During import the audio files are converted into the editing format WAV.
If an audio file was imported into a step, this is indicated by an icon.
Note
Importing an audio file overwrites the existing audio of a step.
14.6.7
Import Audio Again
If an audio file is already imported into Producer, this action can be repeated without selecting the file in the
import dialog again. This is helpful if changes already made to the audio track did not work out as expected and
the audio track needs to be restored or the audio file was edited with an external editor and the changes need to
be applied to the project.
Note
Importing an audio file overwrites the existing audio of a step.
14.6.8 Export all Audio Files...
The audio track of a project can be exported from Producer as a file in WAV format for other purposes. All usual
sampling rates for audio files in this format are available.
14.6.9 Delete Audio
With this function existing audio file of a step can be deleted.
386
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Menu Overview
14.6.10 Change Audio Format...
The function allows you to change the editing format and the output format of the audio files for the current
project.
Editing Format
The internal audio format of a project which is used for editing can be changed at any time. All usual sampling
rates for work with digital audio in mono or stereo are available. Existing audio tracks are automatically converted
into the new format. This procedure is time intensive and can take several minutes.
Note
When changing the project from a higher to a lower sampling rate, the sound quality decreases. As soon
as the project is saved, the changes cannot be undone anymore.
Output Format
With the option the output format for generating a simulation can be defined.
14.6.11 Convert Text to Speech
With this function the bubble texts of a step can be converted in Text to Speech.
14.7 Menu Recording (Simulation)
The Action menu contains the following basic features needed to record simulations:

Record Application

Rerecord Application

Rerecord selected steps

Rerecord from current step
14.7.1
Record Application
This command activates the recording of simulation projects. A corresponding recording bar is displayed at the
top of the screen.
For further information on using the recording feature, see the relevant chapter in this manual.
SAP Workforce Performance Builder 9.3
Menu Overview
Customer
© 2014 SAP AG. All rights reserved.
387
14.7.2
Rerecord Application
This command starts the ReRecording of applications for simulation projects. It can be used to record a different
language version of an existing project and all its steps which has already been recorded using an application.
For further information on using the rerecording feature, see the relevant chapter in this manual.
14.8 Action Menu (Navigation)
The Action menu contains all the basic features needed to playback navigation projects:

Play Navigation

Stop Navigation
14.9 Insert Menu
The Insert menu contains all functions to insert a macro into a project or an object into a book page.
14.9.1
Insert Special Macro
Special macros are macros which influence the playback of a simulation and are not recorded during an
automated recording, but are added later during the editing process.
Explanations regarding the special macros can be found in the chapter Special Macros.
14.9.2 Insert Interactions
Interactions can be inserted via the menu entry. These can also be explanations and highlights in addition to
actions. They can be used to support existing content or for process changes in a simulation.
Explanations regarding the interactions can be found in the chapter Interactions.
Note
Keep in mind that, when inserting actions, no object information is saved. If a new recording is to be
made, the object is to be manually defined in its sequence or skipped. These can also not be used for
navigations. It is generally only recommend to create actions during a recording.
388
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Menu Overview
14.9.3 Insert Page Makro
Page macros can be inserted into simulations. This allows steps to be enriched with additional information.
Explanations regarding the page macros can be found in the section Page Macros.
14.9.4 Insert Quiz Item
Quiz items are stand-alone items used in the design of quizzes. These can be incorporated into a simulation or
function as an independent project.
From the menu Edit -> Insert Quiz Item you can select the quiz items and insert them into a project.
The descriptions of the quiz items can be found in the Quiz Items Reference.
14.9.5 Insert Documentation Macro
Documentation macros can be added to the project via this menu. The macro will be always added directly behind
the selected macro in the project.
The documentation macros are explained in the chapter Documentation Macros.
14.9.6 Add Step
This command inserts a new empty step in the currently open project. Depending on the position selected, the
step is inserted directly in front of the next step or as the last step.
14.10 Documentation Menu
This menu contains all necessary functions for generating documentation with Producer.
Project Explorer

Generate Single Documents

Generate Compound Document

Generate Master Document
Project Editor

Generate Word Document

Generate PDF Document

Generate HTML Document

Generate PowerPoint Document
SAP Workforce Performance Builder 9.3
Menu Overview
Customer
© 2014 SAP AG. All rights reserved.
389
14.10.1 Generate Master Document
This command generates a Word or PDF master document from all existing Word documents in the Workarea.
By clicking on the command, a dialog box opens in which the file name can be assigned and edited. The target
directory for the master document is displayed as before. This cannot be changed as the master document is filed
in each Workarea's doc folder so as to be displayed in the Project Explorer.
If a folder in the Workarea is selected, all existing Word documents that are located in this section of the Workarea
as part of a project will be merged into the master document. Documents that have been set under object
properties as being hidden will not, however, be included.
If the uppermost node, meaning the entire Workarea, is marked, a master document will be generated for the
whole of the Workarea.
14.10.2 Generate Word Document
This command generates the documentation of the recorded project as a MS Word document. In this regard, the
document template is the dot file specified in Documentation Settings.
The macros contained in the project are chronologically integrated into the documentation file, provided that they
are relevant to the documentation. In this case, data from documentation is always transferred to the macro
editor, or when documentation macros are used then their content is transferred.
The generated document is stored in the project directory folder and displayed accordingly in the library.
Note
The installation of Producer also contains a neutral template for generating documentation in MS Word
without a logo. It can be selected via the central configuration dialog.
14.10.3 Generate PDF Document
This command generates a PDF format document of the recorded project. The document is generated in the
same way as for Word documents. The PDF is generated using the set document template.
Note
Note that a PDF reader needs to be installed on the workstation to view the PDF documents.
Prerequisites
The Producer supports PDF files generated with MS Word versions 2007 and 2010.
While Word 2010 contains the standard settings for generating Word documents in general with the Producer, for
Word 2007, you must first install an additional add-in Microsoft Save as PDF in order for this feature to work
properly. This add-in can be downloaded from Microsoft's official website.
390
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Menu Overview
14.10.4 Generate HTML Document
This command works similarly to the command Generate Word Document, where as in this case a HTML
document is generated and no template is used for the creation of the document.
14.10.5 Generate PowerPoint Document
This command works in a similar way to the command Generate Word Document. As in this case, a PowerPoint
document is generated. It is also possible to change the basic template in the main settings.
Note
Controls (Field Icons) within bubbles are not displayed when creating PowerPoint documents. Therefore,
post processing of this bubble text fields is necessary.
14.11 View Menu
The View menu offers various options to configure the display of the program window. This makes it possible to
customize the general display of program parts, as well as the display of the various functions.
14.11.1 JavaScript Console
This command opens the JavaScript Console of Producer. A significant portion of the mechanics for recording in
Producer is based on JavaScript. The console can help track down problems that may occur in the course of
working on a project. In the case of an inquiry, SAP Support may ask you to open the JavaScript Console and
describe its contents. You can also easily copy the contents into a text file. Right-click in the console window and
select the command Copy all. The contents are now on the clipboard and can be pasted into a text document.
14.11.2 Layout & Components in the Project Editor
The project editor's view can be customized. You can change the layout and hide/display components as you so
that you can optimally work with the project editor in conjunction with the Producer.
Choice of layout
You can choose from a variety of different layouts to organize your standard components in the project editor.
Layout changes will influence the thumbnail view, step view and the macro editor. The various layouts make it
possible for you to change the look of your project editor to fit your needs, such as the screen size.
SAP Workforce Performance Builder 9.3
Menu Overview
Customer
© 2014 SAP AG. All rights reserved.
391
The following layouts are available:





Horizontal layout
The components are aligned horizontally.
Divided layout - 1
The thumbnails and steps are aligned side by side, with the macro editor below it.
Vertical layout
The components are aligned vertically.
Divided Layout - 2
The thumbnail view is displayed horizontally and the macro editor and WYSIWYG editor appear below next
to one another.
Divided Layout - 3
The thumbnail view is displayed horizontally and the WYSIWYG editor and macro editor appear below next
to one another.
Hide and display components
From the View menu, you can also define which components should be made visible in your layout. The following
components can be made visible or hidden:






Toolbars
Timeline
Thumbnail view
The WYSIWYG editor is subdivided into two views:

Step View

Documentation View
Macro Editor
History – to display the list, the macro editor must also be made visible
14.11.3 Floating Windows (Project Editor)
The option Floating windows makes it possible to position specific components from the project editor as desired,
independent of the main window on the screen, e.g., components can be repositioned onto a second monitor. This
function allows you to keep the main window free from too much clutter for your work comfort.
To enable this option, go to View -> Floating Windows and select the desired components. The selected
components will then be displayed in a new window that you can move freely or change its size. When the new
window is closed, the components will be automatically displayed in their original location.
The following components can be used in a floating window:

Audio editor

Thumbnail view

Macro editor

WYSIWYG editor (step view, documentation view)
392
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Menu Overview
14.11.4 Zoom
The Zoom functions enable you to zoom into a screen or page, which makes it easier to edit and position objects.
The zoom functions are available in the View menu and the toolbar of the project editor and the book page editor.
The following functions are available:

Zoom in - Ctrl+Num +

Zoom out - Ctrl+Num -

Show Selection

Zoom to Fit - Ctrl+Num 5

Zoom to 100% - Ctrl+Num 0
14.11.5 Set Preview Mode (Project Editor)
This command determines in which mode the preview of your project starts in the trainer.
14.11.6 Show/Hide Macros (Project Editor)
Macros not meant to be displayed are deselected in the opened dialog. Carrying out this action does not delete
them, and they can be shown again at any time.
14.11.7 Show Unknown References (Project Explorer)
Select this function to display a Workarea's Unknown References.
14.11.8 Show UIDs (Project Explorer)
Selecting this function displays the corresponding UIDs behind the name for the objects in the Workarea. With
projects that share the same name, this allows you to see whether these are references for one object or for
different objects.
14.11.9 Show Language (Project Explorer)
Selecting this function displays the project language abbreviation in the tree structure. This allows you to see at a
glance which project is in which project language.
SAP Workforce Performance Builder 9.3
Menu Overview
Customer
© 2014 SAP AG. All rights reserved.
393
14.11.10 Show Language Icons (Project Explorer)
Selecting this function displays the project flags in the tree structure. This allows you to see at a glance which
project is in which project language.
14.11.11 Show Reference Counter (Project Explorer)
When this option is enabled, the number of references will be displayed in the tree structure and an overview of
the references with links will appear in the object editor.
14.12 Tools Menu
This menu contains the Producer Central Configuration Dialog as well as tools providing general functionality
when working on a project.
14.12.1 Settings...
This menu command opens a dialog box that includes various tabs for configuring the basic settings of the
Producer. The settings are made independent of projects and are therefore available to every project that is
processed using the Producer.
More information about the various settings available can be found in the chapter on the Central Configuration
Dialog.
14.12.2 Keyboard Settings...
Many functions in Producer may be executed using keyboard shortcuts (hotkeys). It is important to distinguish
between shortcuts that relate to the Producer menu commands and keyboard shortcuts that relate to particular
actions during the recording of a step. All actions can be assigned or reassigned from default settings to
individually selected keys using the command Tools -> Keyboard Settings... This is where you may also assign
hotkeys to actions that have not been assigned a default shortcut setting.
This function allows the user to freely assign shortcuts to the keys that seem the most logical or are the easiest to
remember.
On the left you will see a complete list of available actions. These are subdivided into groups which can be selected
via a drop-down list box. The list box contains the actions in that group. If an action has been selected, its name
and its current key assignment are displayed. The PC keyboard layout is displayed on the right side of the screen.
Under the keyboard graphic in the Action box the name of the selected action is displayed along with the previous
and new key assignment (if any new assignment has been made).
394
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Menu Overview
All keys are color-coded. Yellow indicates the key assigned to the action in question. Red indicates that a key
already has an assignment. Green indicates a free key. Blue indicates whether the Shift, Alt, or Ctrl key needs to be
held for the particular action. White fields indicate keys that are not available for individual assignments.
The currently assigned keyboard shortcut for each of the different keys can be checked by moving the mouse
pointer over it. A small status line under the keyboard displays which action is using the key. Pressing the Shift, Alt
or Ctrl keys is simulated by simply clicking on the corresponding position on the keyboard display. Clicking it again
deactivates it.
To assign a new hotkey, simply click on the green key of your choice. When all changes have been made, click on
OK or Apply in order to activate all hotkeys. If you would like to return to the default settings, simply click on the
button System Default. Individual key assignments can be deactivated using the button Remove Hotkey. The key
will then be available for a new action assignment. Note that the corresponding action can no longer be carried out
with a keyboard shortcut until a new one is assigned.
In addition to default keyboard shortcuts, there are several actions that have no default keyboard shortcuts. You
may assign these shortcuts as you wish.
14.12.3 Localization
This menu contains tools for the import and export of translations as well as executing an automated language
and version change.
14.12.3.1 Export Translation File…
This command exports the manually altered content of all of a project's macros and the value in the field Step
name in the Screen macro to a translation template. This makes it simple for a translator to transfer the texts into
the desired language and then reimport them.
There are two translation template formats available for outputting:
SAP Workforce Performance Builder 9.3
Menu Overview
Customer
© 2014 SAP AG. All rights reserved.
395


Microsoft Word
XLIFF
The default output format for the translation template is Word. If you would like to create a translation template in
XLIFF then activate the setting Use XLIFF.
You will find additional information on outputting and how to work with translation templates in section
Translating using translation templates. Follow the explanations it contains so as to avoid errors when working
with the translation templates.
Caution
Pictures placed in the bubbles will not be applied to the exported MS Word file.
14.12.3.2 Import Translation File...
This function reimports a translation that was exported as a translatable and edited by a translator, using the
command Export translation file... Producer automatically overwrites the contents in the appropriate bubbles.
Caution
Pictures placed in the bubbles will also be overwritten by the translation.
14.12.3.3 Revise Input Values (Project Editor)
The Revise Input Values function allows the text box entries or choices made in the project to be revised prior to a
project being automatically translated or rerecorded. The text stored in each Input Text macro and the selected
entries from list boxes are all listed in a dialog and can be edited.
This function is useful if, because of the target language, entries need to be adapted or an existing piece of data
cannot be deleted after the original recording without additional effort.
Recommendation
For the ReRecording, the project values can be revised directly via the parameter dialog when starting
ReRecording.
396
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Menu Overview
14.12.3.4 Automated Translation (Project Editor)
In some cases it is not necessary to record the whole project again if only the contents of the bubbles need to be
translated into a different target language.
The command Automated Translation replaces the text modules inserted automatically into the bubbles of the
interactions with text modules of a different language offered by Producer.
In the dialog that appears the desired target language can be chosen.
Clicking on OK replaces all text modules with the text modules of the new target language.
The Automated Translation does not replace the contents of a bubble if the options Interactive Translate manually
in the subcategory Bubble of the macro editor are activated. These options are activated automatically if either
the text of bubble was changed manually or was altered by the function Search & Replace Bubble Content.
However, it also can be activated or deactivated manually at any time.
14.12.3.5 Modify Project Language (Project Editor)
The dialog Modify Project Language allows the project to be switched to another language or one supported by the
Producer. The project language determines in which language the text templates for the automatic generation of
the bubble texts will be used.
14.12.4 Edit Bubble Styles...
This command opens the Bubble Style Editor for Producer. Read more about its functionalities in the related
section of this help file.
14.12.5 Edit Master Tags...
Objects in the project explorer can belong to several tags which can be used later on with filters in order to mask
the content of a workarea for different kinds of users.
You can manage these tags in the dialog.
14.12.6 Bulk Changes
The menu contains automated functions for the editing of a number of macros in a project.
SAP Workforce Performance Builder 9.3
Menu Overview
Customer
© 2014 SAP AG. All rights reserved.
397
14.12.6.1 Replace Page Key Attribute
The function allows you to replace the information of the page keys by regular expressions in simulation or
navigation projects.
For further information see the chapter Customizing Page Informations.
14.12.6.2 Set Bubble Duration
This command sets the display duration for all the bubbles to the value entered in the dialog using an adjustable
display duration. Prior changes made in the macro editor to the duration of bubbles will be overwritten.
Use the Include Explanation parameter to set whether or not the defined bubble duration should also be used for
inserted Explanation macros or just for the bubbles of the interactions. If this parameter is activated, the
Explanation macros will also be shown with the defined bubble duration.
This parameter should be deactivated if individual times are to be used for the Explanation macros. This is
necessary if the respective macros contain longer texts and thus require more time for processing.
14.12.6.3 Auto Crop all Screenshots
This function creates a crop for a screenshot around the Control selected during the recording. This entails the
crop being applied in accordance with the settings defined in the Central Configuration Dialog in the Auto Crop
section. These are located in the Authoring Settings area.
Note
While ReRecording a simulation, you can retain the crop you have applied. To do so, activate the Keep
Crop option before starting the ReRecording. Pay attention in this regard to the section Project-specific
settings for ReRecording.
398
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Menu Overview
14.12.6.4 Uncrop all Screenshots
This function removes all the cropping applied manually or automatically to the screenshots in a project.
If you only want to remove the crop for individual screenshots, then this is achieved by selecting a Screen macro
or using the Uncrop function in the macro editor.
14.12.6.5 Merge selected Screens
This command merges all selected macros of the type Screen. The first screenshot is kept and all other selected
Screen macros are deleted. All the related macros are merged in a single step.
It is necessary to amalgamate Screen macros so as to be able to create a form structure or branches.
14.12.6.6 Merge Screens
The function allows you to merge a project's Screen macros automatically with a step. This involves merging
sequential steps with identical screenshots i.e. the same application page and it's status, into one step. The initial
Screen macro is retained and the following Screen macros deleted. Subsequent macros are inserted in the project
within the step according to the sequence in which they occur.
The merged Screen macros can now be used for a form structure, for preparing to generate navigations or other
post-editing, for example.
Note
To merge specific Screen macros only, refer to the Merge selected Pages function.
Graphical matching and tolerance
The Screen macros are merged by graphically matching the screenshots. The Producer compares individual
screenshot pixels to recognize differences. This includes differences that are already small, such as for example a
drop-down menu that is open on one screenshot and not on another. This menu occupies a particular area on the
screenshot which differs from the one with which it is being compared by a certain percentage.
The degree of percentage match for merging screenshots is defined by the tolerance. This value can be
ascertained in the Central Configuration Dialog using the Merge Screen Tolerance which can be found under
Authoring Settings -> Recording. Increasing the value raises the tolerance threshold. The standard value is 0.4 %,
resulting in screenshots that differ by 0.4% or less being merged.
Note
After the function has been executed, check whether the Screen macros have been merged correctly and
that no necessary screenshots have been deleted. It may be necessary to undo the merge, using Undo or
History and repeating the merge with a different tolerance.
Defining a tolerance
The optimal tolerance may differ from one application to the next. We therefore recommend that you test
different application values for different projects. This can be carried out for example by a master author who then
SAP Workforce Performance Builder 9.3
Menu Overview
Customer
© 2014 SAP AG. All rights reserved.
399
communicates the value identified as being optimal to the authors. When testing you should now ensure that
screenshots that differ only slightly, for example an open drop-down menu, are not merged. The tolerance
threshold should therefore be modified one small step at a time. (Example: increase 0.4% to 0.5%).
We recommend selecting a value greater than 0.0%. With this tolerance, screenshots exhibiting only small
differences, such as small animations or rollover effects, which are typically ignored when comparing
screenshots, are not merged.
14.12.7 Import
The menu contains functions for the import of content and files.
14.12.7.1 Import Images as Book Pages... (Project Explorer)
When creating backgrounds for your book pages, you can save time by importing images into the Producer to use
as a new book page. To import your images, proceed as follows:
1.
In the Project Explorer, select Tools -> Import-> Import images as book pages...
2.
Next, select your desired images to import and click on Open. You can select more than one image at a time.
A separate book page will be created for each image selected.
3.
A configuration dialog box will then appear:
Available settings for imported images
o Insert as image object:
Here you can decide whether the image should be inserted as an image object on the book page or
directly as an image on the book page's background.
o Orientation: Left/Top:
This defines the position of the image on the book page if you chose to insert the image as an object.
o Size: Width/Height:
This defines the image’s size. If the image has not been defined as an object, then this setting can be used
to adjust the image's size on the book page’s background.
o Resample image:
This option will adjust the image file to the defined width and height. When this option is deactivated, the
file will be imported in its original size.
o Keep aspect ratio:
This option will retain the image’s aspect ratio and adjusts itself to the width of the image accordingly.
This option ensures that the images are not proportionally distorted.
o Add to current book:
If a book is selected to be imported from the project explorer, this option allows you to define whether the
new book page should be inserted into the book. When this option is deactivated, the book page will be
inserted as a stand-alone object at the end of the object tree.
4.
400
Once the desired values have been entered, confirm by clicking on OK.
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Menu Overview
The book page with the image will then be created and inserted into the project explorer. The book page’s name
will be the same as the image title.
14.12.7.2 Import PowerPoint as a Book... (Project Explorer)
In order to be able to use PowerPoint presentations in a more versatile way, the obvious thing to do is to convert
them into books in the Producer. This will allow you to complement the slides with other macros, such as media
files. The conversion is performed via the Import PowerPoint as book… function in the Tools menu.
Converting a presentation into a book
To import a PowerPoint as book, proceed as follows:
1.
You can use the Project Explorer to import your PowerPoint slides as a book.
If you would like to incorporate these slides directly into an existing book, first select the book.
2.
Now select the Import PowerPoint as a book... function in the Tools menu.
3.
A dialog will appear for defining the size to be created.
If you selected a book from the tree structure you will also be presented with an option Add to current book.
Select this if you would like to incorporate the PowerPoint slides in the book.
Confirm the dialog by clicking on Ok.
4.
Open the desired presentation and select the slides to be imported. Then click on OK in the dialog displayed in
the Producer.
The slides are now imported into the Workarea and converted into image files. Each slide is created as an
individual book page, all the book pages then being consolidated into a book. The book is named after the
PowerPoint file and the book pages named after the slide in question.
The book and book pages are created in the default style during the import process.
You can add additional book pages to the book after it has been created, add additional content to the slides' book
pages or simply retain the presentation in its existing form.
If you have imported the slides into an existing book, they will be inserted in the existing book pages.
14.12.7.3 Import Images... (Project Editor)
This function allows you to import images into a project. The images can be used, for example, to enhance your
project contents with visual information or as an introduction for various sections within a project.
When importing an image into the Producer, a step and the macro Imported Page are automatically created.
To import an image, proceed as follows:
1.
Select the step into which image should be inserted.
2.
Then select Tools -> Import-> Import images...
3.
A dialog box will appear. Select the desired image or images. Then click on Open.
4.
You can now edit your image if desired.
o
Size: Width/Height:
Enter the desired Width and Height for your image.
SAP Workforce Performance Builder 9.3
Menu Overview
Customer
© 2014 SAP AG. All rights reserved.
401
o Display duration:
This option allows you to define how long an image is visible in the simulation. This image setting can also
be adjusted at a later time in the macro editor.
o Import as Screen macro:
When this option is activated, the image will be inserted as a Screen macro instead of an Imported Page.
Note: This option must be activated if you would like to create branches for your step.
o Resample images:
This option will adjust the image file to the defined width and height. When this option is deactivated, the
file will be imported in its original size.
o Insert Click macro:
When this option is activated, a Click macro will be inserted in the step additionally.
5.
Confirm the changes by clicking on OK, and the image will be imported.
Note
If you insert the images as Screen macro, the projects cannot be rerecorded. As the images cannot be
skipped during ReRecording, this leads to errors in the recording process. You should therefore perform a
ReRecording before importing the images.
14.12.7.4 PowerPoint Import... (Project Editor)
In addition to the regular steps, you can import slides from a PowerPoint document into a project. For example,
these can be used as supporting information for the content of a projector to introduce different sections of a
project.
Slides are converted into images when importing them into the Producer. One step and one Screen macro are
created for each slide and placed in it.
The following steps are necessary when importing PowerPoint slides:
1.
Open the PowerPoint file, from which you would like to import the slides into your project, in PowerPoint.
2.
Select the step after which the PowerPoint slides are to be placed.
3.
In the menu Tools -> Import click on the function PowerPoint Import...
4.
You can now apply settings for displaying the slides. Then click on the OK button to confirm the dialog.
1.
Specify the desired width and height of the slides.
2.
The Display duration defines for how long a slide is visible before the next one is displayed. You can also
subsequently amend this for each individual slide in the macro editor.
3.
Import as Screen macro:
When you activate this setting, the PowerPoint slides are inserted as Screen macro rather than as
Imported Pages. This is necessary if, for example, branches are to be created for an imported slide.
Note
If you insert the PowerPoint slides as Screen macro, the project cannot be rerecorded. As the slides
cannot be skipped during ReRecording, this leads to errors in the recording process. You should therefore
perform a ReRecording before importing the slides.
5.
402
The next step is to display a dialog requiring you to highlight the slides to be inserted.
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Menu Overview
Note
Do not close the dialog until after the slides have been selected as it is the dialog that starts the import
process.
Switch to PowerPoint and highlight the slides to be imported in your PowerPoint file's slide outline.
6.
Now confirm the dialog by clicking on OK.
14.12.7.5 Flash Page (Project Editor)
So that project can be made more varied and interesting, the Producer offers the facility for incorporating Flash
video clips. For example, these can display additional explanations or provide summary information about the
sections within a project.
The special Flash Page macro is available for incorporating Flash movie clips (SWF). The inserted file is displayed
as a standalone page as the simulation progresses.
Note
Bear in mind when using the Flash Page macro that a Flash Player for playing back SWF has to be
installed on the workstation of the individual using the projects.
This is how you create a Flash Page macro:
1.
So that the simulation remains clear and easy to follow, it is a good idea to create a new step for the macro.
To do this, go to Add Step
in the Edit menu.
2.
Insert the Flash Page macro in the step using the menu Tools -> Import. You can then edit the macro in the
macro editor.
3.
The Flash video clip to be shown can be incorporated in the macro using the SWF file parameter. To do so,
click on Select file , choose your SWF file and then click on Open.
4.
You can then customize the size of the view using the Width and Height settings.
5.
The content of a Flash video clip is not always suitable for each mode. You can therefore use the Available in
mode parameter to select the mode in which this is to be shown. To do so, activate the relevant type.
Recommendation
For more complex settings and applications, we recommend inserting Flash films as book page objects
and integrating the respective book page into the project.
SAP Workforce Performance Builder 9.3
Menu Overview
Customer
© 2014 SAP AG. All rights reserved.
403
14.12.8 Workarea Structure
Using the Tools -> Workarea Structure functions, you can export the workarea layout and existing references to
have an overview of them and to edit the workarea structure outside of the Producer. When displaying references,
only groups, projects, books and book pages are taken into consideration.
For further information to the workarea structure import and export see the chapter Editing the workarea
structure externally.
14.12.8.1 Export Reference List...
Exports an overview of the existing references on the workarea into a CSV file. The objects are listed in the order in
which they appear on the workarea. In addition to this, the superordinate reference and the UID are displayed.
To export a reference list, proceed as follows:
1.
Click on the menu entry Tools -> Workarea Structure -> Export Reference List.
A dialog opens.
2.
Select a folder as target directory.
3.
Insert a File Name.
4.
Click Save to export the reference list.
Structure of the CSV file
The CSV file includes the following columns:

Referenced Entity
Contains the objects of the workarea.

Referenced by
Contains the referenced object.

UID
Contains the UID for the objects.
14.12.9 Replace Bubble Styles...
The replacing of bubble styles allow you to change the bubbles of a project easily and not to edit each macro
individually. The function can be used for simulation and navigation projects.
The replacing of the bubble style do not influence the content of a project.
To replace a bubble style, proceed as follows:
1.
Select a project or a content tree in the project explorer.
or
Open a project in the project editor.
2.
Click on Tools -> Replace Bubble Styles...
3.
A setting dialog opens. Adapt the following settings:
404
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Menu Overview
o
Starts from (Project Explorer):
This selection determines the point in the tree structure starting at which the bubble styles should be
replaced. This lets you replace the bubble styles for a specific group. The object selected in the tree
structure is automatically displayed in the setting.
If another starting point is to be selected, this can be done using Edit link...
o
Only selected Macros (Project Editor):
With this setting only the bubble styles of the before selected macros will be replaced.
The setting will be displayed, if the dialog was opened in the project editor for a specific project.
o
Subcategories:
The dialog contains subcategories for the project types and modes.
o
4.
o
Demo Mode (Simulation)
o
Practice Mode (Simulation)
o
Navigation
Settings:
Each subcategory contains settings, to define the specific content.
o
Set Action Bubbles
Select a bubble style from the drop-down box.
o
Set Explanation Bubbles
Select a bubble style from the drop-down box.
o
Use Fallback
Activate the setting, to use the fallback bubble style.
Confirm the dialog with OK, to replace the bubble styles.
14.13 Window Menu
The menu displays the opened projects and book pages. It allows you to navigate between the content and the
project explorer.
14.14 Help Menu
This menu allows the user to access the Producer online help files, get info how to act in a possible support case
or display information about the Producer version being used.
Diagnostics... generates a text file containing valuable information which the SAP support staff can use to detect
configuration conflicts.
SAP Workforce Performance Builder 9.3
Menu Overview
Customer
© 2014 SAP AG. All rights reserved.
405
14.14.1 Diagnosis...
With Diagnostics... Producer automatically transmits key data; the hardware being used, the operating system
version, the installed Producer components, and the software components being used by Producer, such as
Microsoft Internet Explorer.
This information would be very useful to the SAP support staff if they needed to analyze a problem.
Save... stores the data in a text file which can then be easily sent as an attachment with an e-mail.
406
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Menu Overview
15
Central Configuration Dialog
The central configuration dialog contains all the global settings for working with Producer as well as the settings
for recording and editing contents and settings for the trainer installed in the current workarea. The central
configuration dialog is opened via the menu Tools -> Options...
General usage of the central configuration dialog
The functions and characteristics of the central configuration dialog are:

Layouts
The most setting pages using different layouts, that can be switched about the title bar.
Standard Layout - contains the basic settings
Advanced Layout - contains the further settings for advanced users

Green Control
Some of the settings have a green control, that allows it to activate or deactivate a setting. A deactivated
setting uses the default settings of the Producer. To edit a deactivated setting, the green control has to be
activated per click.

Project Override
The Project Override subcategory provides specific settings for the currently opened project. The global
settings are not affected.

Default Settings
The Default Settings button allows it to reject executed changes.

Restart
Some of the settings require a Producer restart before they become active. In this case a dialog shows up
when the settings are applied or the dialog is closed.
15.1
Initialization and fallback default parameters
Parameters defined in the central configuration dialog are differentiated in terms of how they are used into initial
and so-called fallback parameters. This involves differentiating according to whether they are supposed to initiate
a global default of the available parameters or overwrite non-individualized parameters.
Note
Parameters are saved for each Workarea where they are filed under Resources -> Configurations/Styles.
Particularly close attention is to be paid to this if individual parameter settings are also to be made
available to other authors or used as a Workarea standard when connecting to Manager.
SAP Workforce Performance Builder 9.3
Central Configuration Dialog
Customer
© 2014 SAP AG. All rights reserved.
407
15.1.1
Use in the macro settings
Macro Initialization and Macro Fallback Defaults allow you to define specific macro parameters across a workarea.
However, they do not apply in the case of individualized parameter definitions (with green lamp activated).
Macro Initialization
You can use the Macro Initialization to define all of the relevant macros' parameters prior to the project creation
process, thus ensuring the greatest possible project consistency. Parameters that are predefined using Macro
Initialization are shown as being activated in the relevant macro settings (the green lamp preceding the parameter
is activated). That means they they are unaffected by changes in the Macro Fallback Defaults.
Note
Note that Project Initialization depict initial parameters! The parameter definitions they contain only apply
once they have been established and are not applied to already existing projects.
MacroFallback Defaults
The Macro Fallback Defaults allow you to determine undefined parameters in all of the workarea's previously
recorded projects, thereby ensuring, for example, consistency within the workarea upon conclusion of the project
creation process. Unlike when defining Macro Initialization parameter settings made via the Macro Fallback
Defaults in the relevant macros are NOT shown as being activated (the green lamp preceding the parameter
remains inactive). The advantage of this is that settings specified using Macro Fallback Defaults can always be
changed globally again.
Note
Note that Macro Fallback Defaults only take effect in NON activated parameter data.
15.1.2
Application example
The following case study is intended to explain the different Macro Initialization and Macro Fallback Defaults
application examples using the explanation bubble.
When creating the workarea prior to recording the projects, it needs to be stipulated that all explanatory bubbles
to be inserted should use the Info display type. The author can apply any necessary variances himself on a case by
case basis although as a matter of principle the explanatory bubble should be used for this type of information.
To avoid inconsistencies as a result of omitting this parameter configuration and to free the author from having to
reapply this setting each time, this setting is defined as a Macro default.
To this end, parameter type (2) is defined in the central configuration dialog under Authoring Settings -> Macro
Initialization (1) -> Explanation. It will then be placed in the explanatory bubble in all the projects that are to be
recorded.
Once all projects have finished recording, it is recognized in the workarea finalization process that most
explanatory bubble content contains excessively detailed additional information, thus distorting in Test mode
what the learner has actually learned. As this was not considered in the planning phase, the parameter In Test
mode was not activated in any of the recorded projects and consequently was not defined either. At this point, the
extra effort of rectifying all the projects manually can be avoided by amending the specific Macro alternate
408
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Central Configuration Dialog
parameter. Deactivating the parameter In Test mode (2) in the central configuration dialog in Playback Settings ->
Macro Fallback Defaults parameter (1) -> Explanation deactivates the parameter in all workarea projects.
Note
Note that Macro Fallback Defaults only take effect with default parameters, namely ones which have not
been changed. Activated parameters (green lamp) are unaffected when an alternate parameter is
changed.
15.2 Application
The Application area contains the basic settings for the administration of the Producer. Further there are
configurations of the tools and the functions for the creation and editing of content.

General
The settings page influences the appearance and the use of specific editing tools of the Producer.

Central Workarea
The settings page influences the communication between the local and central workarea.

Directories
The settings page defines the auto save function and the automatic update of the Producer.

Save
The settings page defines the modes, which will be created when generating a project. All modes are activated
by default.

Templates
The settings page defines the templates for the creation of content objects.

Expert Features
The settings activate additional Producer functions. Note that the functions are not covered by the standard
support package and do not represent standard guaranteed system properties.
General usage of the central configuration dialog
The functions and characteristics of the central configuration dialog are:

Layouts
The most setting pages using different layouts, that can be switched about the title bar.
Standard Layout – contains the basic settings
Advanced Layout – contains the further settings for advanced users

Green Control
Some of the settings have a green control, that allows it to activate or deactivate a setting. A deactivated
setting uses the default settings of the Producer. To edit a deactivated setting, the green control has to be
activated per click.

Project Override
The Project Override subcategory provides specific settings for the currently opened project. The global
settings are not affected.

Default Settings
The Default Settings button allows it to reject executed changes.
SAP Workforce Performance Builder 9.3
Central Configuration Dialog
Customer
© 2014 SAP AG. All rights reserved.
409

Restart
Some of the settings require a Producer restart before they become active. In this case a dialog shows up
when the settings are applied or the dialog is closed.
15.2.1
General
Settings are located in this category which influence the appearance and the use of specific editing tools of
Producer.
Some of the settings require Producer to be restarted before they become active. In this case you will be informed
by a dialog as soon as the settings are applied or the dialog closes.

Primary Language:
Defines interface language of the Producer.

Secondary Language:
Defines the fallback user interface language of the Producer. In the primary language not available
translations will be shown in the secondary language.

Default language for spell checking:
This option defines a default language to be used for spell checking. Typically the language used is the one
defined for an object. If no language package for Windows Office is installed, the Producer uses the defined
default language.

Spell Check:
This options activates spell checking for HTML Editors. This presupposes an installed spell checker for
Microsoft Word.

Drag-and-drop macro editing:
Select the way you wish to work with events. Drag-and-drop event editing allows macros in the project editor
to be moved around by simply dragging the event to a new location.

Advanced Accessibility Features:
Enables the advanced accessibility features (magnifiers) of the Producer.
If the features are not needed, deactivate the option to save memory.

Move time with macros:
The effect of this option is that when a macro is inserted or removed, the other macros are seamlessly shifted
along the timeline or any gaps arising are closed. Move time with macros enables the other macros to
seamlessly shift along the timeline when a macro is inserted or removed. When a macro is inserted, all
subsequent macros shift back along the timeline by the exact duration of the inserted macro. If a macro is
deleted within a step, the resulting gap is automatically closed.

Max. most recently used folders:
This allows you to define how many of the recently opened directories are to be displayed in file dialogues.

Show disabled warnings:
If dialogs were suppressed by selecting the option Don't show this message again, activating this parameter
can redisplay the dialogs.

Use old Office formats:
This option is used to generate documents in the old format when Office 2007 or 2010 is installed. If the
option is deactivated, the docx and pptx formats are generated.
410
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Central Configuration Dialog
15.2.2
Central Workarea
The settings in this category influence the communication between the local and central workarea.
The main parts of the settings page are:

General:
The settings influence the creation and the handling of a central workarea.

Workflow Settings:
The settings define the behavior and the default values of the workflow dialog.

Recursive Operations:
The settings define, whether an operation is executed for an object and their sub-objects or only for the
object.

Show Tree Selection:
The settings define, whether the tree selection dialog is displayed when executing an operation.
15.2.3
Directories
The settings in this category affect the paths used by Producer for saving settings and other program
components, as well as the Autosave functionality.

Updates' path:
This allows automatic updates for associated resources to be configured. In the process, an administrator
creates a central folder in which the new resources are filed. When the path is specified, the new resources
are imported into the Workarea when the Producer is launched.

Autosave:
When this option is activated, projects are saved automatically at regular intervals with the time increment
entered under Autosave Interval.

Autosave Interval:
The value entered here specifies the frequency in minutes with which projects are automatically backed up if
the option Use Autosave is activated.
15.2.4 Save
Generate modes
In this area you can define which modes are to be created when saving a project. All modes are activated by
default. Deactivate a mode for a particular project type if you do not wish to generate that mode.

Navigation
o

Navi
Standard (Simulation)
o
Demo
o
Practice
o
Test
SAP Workforce Performance Builder 9.3
Central Configuration Dialog
Customer
© 2014 SAP AG. All rights reserved.
411
o Concurrent
Generate HTML start page (only Simulation)
With this settings HTML pages with mode links are generated when saving a project. The HTML pages can be used
to start a mode from a web page. The files are stored in the project folders.

Generate HTML to start:
Generates a HTML page with links to start each generated mode of a project.

Generate HTML for each mode to start:
Generates a HTML page for each generated mode to start a mode directly.
15.2.5
Templates
Under Settings, you can configure standard templates for use when creating new objects in the workarea. A
template is an object that has been created with predefined settings and properties. For more detailed
information, refer to the section on Templates for objects in the workarea in this user guide.
Templates can be created for the following types of objects:

Group

Project

Book

Book page

Text unit
15.2.6 Expert Features
In this category you may activate additional Producer functions that have been reserved for special users. This is
accomplished by entering parameters in the list. The syntax used for an entry follows this example: Feature=1;
One entry per line can be made. 1 activates a feature, 0 deactivates it without deleting the line.
Note that additional functionality created by entries made in this tab is not covered by the standard support
package offered by SAP AG and are not standard guaranteed system properties.
15.3 Authoring Settings
The Authoring area contains settings for the creation, recording and editing of simulation projects as soon as for
the creation of book pages.
The Authoring Settings are a resource type of the Adaptable Resources.

412
Record - General
The settings on this page define the recording of projects and include settings for the object recognition and
the screenshot creation.
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Central Configuration Dialog

Audio (Simulation)
The settings on this page define the usage of audio in simulation projects.

Auto Crop (Documentation)
The settings on this page define the cropping area for the auto crop function of documentation.

Recording (Simulation)
The settings on this page include functions for the recording of controls as soon as automated editing
functions which will be executed during the recording.

ReRecording (Simulation)
The settings on this page include functions for the rerecording of controls and for the handling of conflict
situations.

Macro Initialization (Simulation)
The Macro Initialization area includes the initial settings for all editable parameters of the macros. The
settings should be set before the recording or the insert of a macro to take effect.

Book Page Editor (Book Page)
The settings define the grid lines of the book pages in the book page editor as well as the snapping behavior
when moving an object in relation to other objects.

Book Page Initialization (Book Page)
The Book Page Initialization area includes the default settings for all editable parameters of the book page
objects. The settings should be set before the recording or the insert of an object to take effect.
15.3.1
Recording - General
The settings in this category pertain to the recording of projects. They control the way screenshots are made
when recording an application.
All settings made in this category are effective for projects which are recorded or edited after the change in
settings took place.
If a project is opened, the additional subcategory Project Overrides is available. It provides specific settings which
apply only to the currently opened project.
Settings

Record Bar Position:
Record bar Position determines whether the record bar for recording is displayed on the top or bottom edge
of the screen.

Area:
This setting determines if the entire window currently in the foreground should be copied, or a specifically
defined area of the screen. When the option Screen Area is selected, an area of the screen can be accurately
specified in Rect.

Rectangle:
The distance of the edges of the screen area to the top and to the left side of the screen is entered in the input
field. The button located beside it displays the selected area in a red frame. You may adjust the size and
position by placing your mouse pointer on an edge and dragging it to the desired position or size. The
corresponding values in the respective fields are updated automatically.
In addition, some default values may be selected. Screen defines the whole screen as the selected area, while
Workarea selects the whole screen excluding the windows task bar.
SAP Workforce Performance Builder 9.3
Central Configuration Dialog
Customer
© 2014 SAP AG. All rights reserved.
413

Stretch Appl. Window:
This option maximizes the application window when starting the recording and when rearranging the window.

Stretch newly opened Appl. Window too:
While the recording is underway, this option automatically maximizes a newly opened application window to
the initial window size.

Automatic profile change:
If application changes are performed during the recording process, the selected application profile might
need to be adapted. This option defines in that situation whether the profile is to be changed automatically
during the recording process.
If the "always change" option is selected and no application profile is associated with the shot, the standard
profile will be used.

Record Hot Keys:
With this option, the Producer is prompted during the recording process to record the keyboard shortcuts
that have been assigned.

Generate Window Information:
This option is used to save additional information that forms the basis for subsequent Control Recognition.
The process is computer intensive. It can be used in a later process for additional Control Recognition. The
process can be time intensive.

Control Recognition Method:
Profound recognition enables optimal control recognition via interfaces and thus the best possible read out of
page and object information. Simple recognition primarily allows graphical objects to be recognized. This is
required, for example, when recording via Citrix or when using terminal applications. An individual cursor is
displayed for this setting if the Allow Rollover Effects option is deactivated.
Note
When recording using the Simple recognition option the mouse option In dialog fields automatically jump
to the standard button is to be deactivated in the Windows settings. This mouse attribute impairs the
control recognition functionality by preventing mouse movements.

Allow RollOver Effects:
This setting defines whether rollover effects are suppressed during recording when moving the cursor over a
control. This prevents an unintended change of menu, for example, with rollover effects also not being visible
on the screenshot. Activate the option if you would like to allow rollover effects.
Fallback method for object recognition

Fallback Method:
When a control is not correctly identified during the recording, the Producer uses an alternative method in
order to create the control:
o Recognize Hotspot:
To create the control, an area that has been predefined in size is placed onto the position that has been
clicked on, and the macro settings are defined with standard values. Once the recording is complete, the
macro can be edited in the macro editor.
o Create Selection Dialog:
This option will open a new control selection dialog box in which the control can be manually defined.
414
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Central Configuration Dialog
15.3.2
Macro Initialization
The Macro Initialization area includes the initial settings for all editable parameters of the macros. The settings
override the default settings of the Producer and should be set before the recording or the insert of an element to
take effect. To initialize the parameters allow it to achieve consistency in the content creation and to reduce the
editing effort.
The area is separated into the macro groups:

Interactions

Special Macros

Page Macros

Quiz Items

Documentation Macros
15.3.3
Book Page Editor
Here you can define the grid lines for the book pages in the book page editor as well as the snap-in-place function
with the ledger lines, which is a helpful tool when dragging an object to ensure that they are properly aligned with
other objects.
Configuring the grid
The grid is part of the background and assists you in precisely designing the layout of your objects on a book page.
You can define the space between the grid lines as well as the distance from the upper-left corner. The settings for
the grid are:

Grid Spacing Horizontal

Grid Spacing Vertical

Grid Offset Left

Grid Offset Top
Configuring the snap-in-place function
You can activate and deactivate the Snap-in-place option as well as define which objects should use this option
and how much distance there should be between the object and the grid area where it will be snapped into place. If
this option is activated, when dragging an object, it will automatically lock to the grid, which facilitates positioning
objects and helps to maintain conformity and accuracy throughout your project. The settings for the snapping
are:

Show Snap Positions

Enable Snapping

Snapping Distance

Snap to Objects

Snap to Centers

Snap to Guiders

Snap to Grid

Snap to inner Border
SAP Workforce Performance Builder 9.3
Central Configuration Dialog
Customer
© 2014 SAP AG. All rights reserved.
415

Snap to outer Border
Recommendation
You can activate the snapping of objects temporally with pressed Ctrl key. For that deactivate the
snapping in general and activate the snapping to specific objects.
15.3.4 Book Page Initialization
The Book Page Initialization area includes the initial settings for all editable parameters of the book page objects.
The settings override the default settings of the Producer and should be set before the recording or the insert of
an object to take effect. To initialize the parameters allow it to achieve consistency in the content creation and to
reduce the editing effort.
The area is separated into the book page object groups:

Action Objects

Layout

Link Buttons

Media Objects

Book Page Objects
15.4 Playback Settings
The Playback area contains settings for the playback of simulation projects and of book pages which will be
interpreted at runtime of the trainer, book reader and library functionalities.
The Playback Settings are a resource type of the Adaptable Resources.

General (Simulation)
The settings on this page define the properties of simulation projects for the playback.
Specific settings for an opened project can be set on the Project Override subpage.

trainer
The settings on this page define the playback and tracking of content and the properties of the book reader
functionality.
The settings are the global settings for the use of the trainer functionality. Individual settings can be set on the
pages library, book reader, Concurrent Mode, Demo Mode, Practice Mode and Test Mode.

book reader
The settings on this page define the playback and tracking of content and the properties of the book reader
functionality.

library
The settings on this page define the playback of content and the properties of the library functionality.

Demo Mode
The settings on this page define the playback and tracking of the Demo Mode and the properties of the library
functionality.
Specific settings for an opened project can be set on the Project Override subpage.
416
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Central Configuration Dialog

Practice Mode
The settings on this page define the playback and tracking of the Practice Mode and the properties of the
library functionality.
Specific settings for an opened project can be set on the Project Override subpage.

Test Mode
The settings on this page define the playback and tracking of the Test Mode and the properties of the library
functionality.
Specific settings for an opened project can be set on the Project Override subpage.

Concurrent Mode
The settings on this page define the playback and tracking of the Concurrent Mode and the properties of the
library functionality.
Specific settings for an opened project can be set on the Project Override subpage.

Macro Fallback Defaults
The Macro Fallback Defaults area includes the fallback settings for all undefined and deactivated (green lamp)
parameters of the macros.

Book Page Fallback Defaults
The Book Page Fallback Defaults area includes the fallback settings for all undefined and deactivated (green
lamp) parameters of the book page objects.
15.4.1
General
The settings here define how highlights and bubbles are displayed globally for all projects contained in the current
workarea. They are used as default settings for all recorded highlights and bubbles. For changed settings to take
effect, the modes of a project need to be generated again.
In the subcategory Project Overrides the same group of settings can also be applied specifically to the current
project only. The global settings for all projects are not affected.

Explanation Link (Forward):
In the parameter you can specify a link text or image, which will be used for continuing a simulation in the
displayed explanation bubble. The text may contain HTML attributes.

Show note in Test mode:
If this option is activated, a bubble is displayed in Test mode which contains a link which opens an additional
window in Demo mode showing the actual step and closing it again afterwards. The bubbles for entry fields
also show the explanation from Practice mode.

Step-based Demo playback (Audio off):
Having deactivated the trainer bars audio button, this parameter will suppress automatic playback of Demo
mode. Instead every step has to be confirmed manually by clicking the automatically inserted Next button
within the action bubble. With activated audio, the playback will resume automatically when step based audio
has finished.

Show Mouse:
This option also shows the mouse pointer for actions that are performed in the application with the mouse. By
default the mouse pointer is hidden.
SAP Workforce Performance Builder 9.3
Central Configuration Dialog
Customer
© 2014 SAP AG. All rights reserved.
417
Highlights

Border:
This parameter defines the thickness of the project highlight frame in pixels. Pixel widths available are from 1
to 10.

Help Color:
This highlight color will be used in practice or test mode in case that the user is asking for help. The highlight
will be used to show areas of correct action.

Form Structure Color for Correct Answer:
This highlight color will be used in practice or test mode in case that the user is asking for help. The highlight
will be used to show areas of correct actions in a form structure.

Color:
This defines the color of the highlight border. The color may be entered directly as an RGB value in HEX
format or selected from out of the Color Picker dialog box.
Bubble

Bubblestyle OK:
Defines the Bubblestyle used for the text OK bubble when the option OK in Test mode is activated.
15.4.2 Macro Fallback Defaults
The Macro Fallback Defaults area includes the fallback settings for all undefined and deactivated (green lamp)
parameters of the macros. The settings take effect during the playback of the content and can always be changed.
To set fallback defaults allows it, to achieve consistency and to set undefined parameters centrally.
The area is separated into the macro groups:

Interactions

Special Macros

Page Macros

Quiz Items

Documentation Macros
Note
Note that the Macro Fallback Defaults only take effect in non-activated parameter data.
15.4.3 Book Page Fallback Defaults
The Book Page Fallback Defaults area includes the fallback settings for all undefined and deactivated (green lamp)
parameters of the book page objects. The settings take effect during the playback of the content and can always
be changed. To set fallback defaults allows it, to achieve consistency and to set undefined parameters centrally.
The area is separated into the book page object groups:

Action Objects

Layout
418
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Central Configuration Dialog

Link Buttons

Media Objects

Book Page Objects
Note
Note that the Book Page Fallback Defaults only take effect in non-activated parameter data.
15.4.4 Settings of trainer, book reader, library and Modes
The following chapters contain information about the setting areas and settings of:

trainer

book reader

library

Demo Mode

Practice Mode

Test Mode

Concurrent Mode
15.4.4.1
Audio
For the playback of audio content the trainer uses different audio channels. These allow the authors to
preconfigure the volume of the audio and the learners can change the volume during the playback individually.
The following channels can be adapted in the Audio subcategory for the Playback Settings of the trainer - Global,
book reader, Demo Mode, Practice Mode, Test Mode and Concurrent Mode:
Setting
Description
General
Defines the initial general volume of audio files (0100). The volume of all other sound channels depends
on this setting.
Narrative
Defines the initial volume (0-100) of the sound
channels Explanations and Page Sound.
Book sound
Defines the initial volume (0-100) of the sound channel
Book Sound.
Effects
Defines the initial volume (0-100) of the sound channel
Effects.
Simulation sound
Defines the initial volume (0-100) of the sounds that is
played in simulations.
For each audio channel a volume slider is displayed in the control bar.
SAP Workforce Performance Builder 9.3
Central Configuration Dialog
Customer
© 2014 SAP AG. All rights reserved.
419
15.4.4.2
Function Keys
Using the key functions, you can control the trainer via the keyboard. These correspond to the button
functionality.
The key functions are defined by default for Demo mode and Concurrent mode and the trainer, as it is possible to
manipulate the sequence of events in these modes. For the book reader and the library the hotkeys for Back, Next
and Feedback are used.
The following keys are assigned by default to their respective functions:
Function
Key
Play
Space
Pause
Space
Stop
Back
Left
Next
Right
Feedback
Ctrl + F1

Ignore Hotkeys for Browser:
Defines that the hotkeys of the browser cannot be used during content playback. The learner can use only the
navigations of the trainer and the specified hotkeys.
The following hotkeys will not be prevented:
Safari: CTRL+F, CTRL+P, CTRL+O
Internet Explorer: CTRL+P, CTRL+O, ALT+Home opens a new window
15.5 Navigation Authoring Settings
The Navigation Authoring area contains settings for the creation, recording and editing of navigation projects.
The Navigation Authoring Settings are a resource type of the Adaptable Resources.
Macro Initialization
The Macro Initialization area includes the default settings for all editable parameters of the macros. The settings
should be set before the recording or the insert of a macro to take effect.
15.5.1
Macro Initialization
The Macro Initialization area includes the initial settings for all editable parameters of the macros. The settings
override the default settings of the Producer and should be set before the recording or the insert of a macro to
take effect. To initialize the parameters allow it to achieve consistency in the content creation and to reduce the
editing effort.
420
Customer
© 2014 SAP AG. All rights reserved.
SAP Workforce Performance Builder 9.3
Central Configuration Dialog
15.6 Navigation Playback Settings
The Navigation Playback area contains settings for the playback of navigation projects and of book pages which
will be interpreted at runtime of the Navigator.
The Navigation Playback Settings are a resource type of the Adaptable Resources.

General
The settings on this page define the properties of navigation projects for the playback.
Specific settings for an opened project can be set on the Project Override subpage.

Macro Fallback Defaults
The Macro Fallback Defaults area includes the fallback settings for all undefined and deactivated (green lamp)
parameters of the macros.

Desktop Assistant Settings
The Desktop Assistant area contains settings for the playback of the desktop assistant.
15.6.1
Macro Fallback Defaults
The Macro Fallback Defaults area includes the fallback settings for all undefined and deactivated (green lamp)
parameters of the macros. The settings take effect during the playback of the content and can always be changed.
To set fallback defaults allows it, to achieve consistency and to set undefined parameters centrally.
Note
Note that the Macro Fallback Defaults only take effect in non-activated parameter data.
15.7 Documentation Settings
The Documentation Settings area contains settings for the creation of documentation. The properties of each
documentation type can be specified individually.
The Documentation Settings are a resource type.
Further information to the documentation settings is available in the chapter documentation.
SAP Workforce Performance Builder 9.3
Central Configuration Dialog
Customer
© 2014 SAP AG. All rights reserved.
421
www.sap.com/contactsap
Material Number
© 2014 SAP AG. All rights reserved.
No part of this publication may be reproduced or transmitted in any
form or for any purpose without the express permission of SAP AG.
The information contained herein may be changed without prior
notice.
Some software products marketed by SAP AG and its distributors
contain proprietary software components of other software
vendors.
Microsoft, Windows, Excel, Outlook, and PowerPoint are registered
trademarks of Microsoft Corporation.
IBM, DB2, DB2 Universal Database, System ads, System i5, System
p, System p5, System x, System z, System z10, System z9, z10, z9,
iSeries, pSeries, xSeries, zSeries, eServer, z/VM, z/OS, i5/OS,
S/390, OS/390, OS/400, AS/400, S/390 Parallel Enterprise
Server, PowerVM, Power Architecture, POWER6+, POWER6,
POWER5+, POWER5, POWER, OpenPower, PowerPC, BatchPipes,
BladeCenter, System Storage, GPFS, HACMP, RETAIN, DB2
Connect, RACF, Redbooks, OS/2, Parallel Sysplex, MVS/ESA, AIX,
Intelligent Miner, WebSphere, Netfinity, Tivoli and Informix are
trademarks or registered trademarks of IBM Corporation.
Linux is the registered trademark of Linus Torvalds in the U.S. and
other countries.
Adobe, the Adobe logo, Acrobat, PostScript, and Reader are either
trademarks or registered trademarks of Adobe Systems
Incorporated in the United States and/or other countries.
Apple, App Store, FaceTime, iBooks, iPad, iPhone, iPhoto, iPod,
iTunes, Multi-Touch, Objective-C, Retina, Safari, Siri, and Xcode are
trademarks or registered trademarks of Apple Inc.
Oracle and Java are registered trademarks of Oracle and its
affiliates.
UNIX, X/Open, OSF/1, and Motif are registered trademarks of the
Open Group.
Citrix, ICA, Program Neighborhood, MetaFrame, WinFrame,
VideoFrame, and MultiWin are trademarks or registered trademarks
of Citrix Systems, Inc.
HTML, XML, XHTML and W3C are trademarks or registered
trademarks of W3C®, World Wide Web Consortium, Massachusetts
Institute of Technology.
SAP, R/3, xApps, xApp, SAP NetWeaver, Duet, PartnerEdge,
ByDesign, SAP Business ByDesign, and other SAP products and
services mentioned herein as well as their respective logos are
trademarks or registered trademarks of SAP AG in Germany and in
several other countries all over the world. All other product and
service names mentioned are the trademarks of their respective
companies. Data contained in this document serves informational
purposes only. National product specifications may vary.
These materials are subject to change without notice. These
materials are provided by SAP AG and its affiliated companies ("SAP
Group") for informational purposes only, without representation or
warranty of any kind, and SAP Group shall not be liable for errors or
omissions with respect to the materials. The only warranties for SAP
Group 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.
Was this manual useful for you? yes no
Thank you for your participation!

* Your assessment is very important for improving the work of artificial intelligence, which forms the content of this project

Download PDF

advertisement