Oracle User Productivity Kit 3.5
Build high-quality training simulations using Oracle UPK 3.5
BIRMINGHAM - MUMBAI
Oracle User Productivity Kit 3.5
Copyright 2009 Packt Publishing
All rights reserved. No part of this book may be reproduced, stored in a retrieval system, or transmitted in any form or by any means, without the prior written permission of the publisher, except in the case of brief quotations embedded in critical articles or reviews.
Every effort has been made in the preparation of this book to ensure the accuracy of the information presented. However, the information contained in this book is sold without warranty, either express or implied. Neither the author, Packt Publishing, nor its dealers or distributors will be held liable for any damages caused or alleged to be caused directly or indirectly by this book.
Packt Publishing has endeavored to provide trademark information about all the companies and products mentioned in this book by the appropriate use of capitals. However, Packt Publishing cannot guarantee the accuracy of this information.
First published: September 2009
Production Reference: 2240909
Published by Packt Publishing Ltd. 32 Lincoln Road Olton Birmingham, B27 6PA, UK.
Cover Image by Parag Kadam (firstname.lastname@example.org)
ReviewerSjoerd De Vries
Acquisition EditorJames Lumden
Development EditorChaitanya Apte
Technical EditorChaitanya Apte
Editorial Team LeaderAkshara Aware
Project Team LeaderPriya Mukherji
Project CoordinatorAshwin Shetty
GraphicsNilesh R. Mohite
Production Coordinator Aparna Bhagat
Cover WorkAparna Bhagat
About the author
Dirk Manuel is a freelance documentation and training consultant, specializing in projects for the large-scale implementation of SAP. Dirk has been using UPK and its precursor OnDemand for five years, during which time he has developed hundreds of well-received simulations. Dirk has provided training on UPK and OnDemand to UPK developers in Europe, Asia Pacific, and the Americas.
Originally from the United Kingdom, Dirk has lived and worked in England, Germany, Belgium (twice), and Singapore, before settling in Houston, Texas.
Dirk has a B.Sc. (Hons.) in Computer Science, and a City & Guilds in the Communication of Technical Information. He is a Fellow of the Institute of Scientific and Technical Communicators (ISTC) and a Senior Member of the Society for Technical Communication (STC).
This book has been neither a labor of love nor a life's work. Being a Technical Writer by trade, documenting what I know is almost impossible to avoid. After being asked on several occasions if I could recommend a good book on UPK/OnDemand, and always having to reply that there simply weren't any books, good or bad, I decidedany books, good or bad, I decided books, good or bad, I decided to write my own.
This book is a distillation of five years' experience with UPK and OnDemand, and of teaching it to other developers.
I have seen many poor examples of simulations created using UPK or OnDemand, due primarily to a lack of knowledge on the part of the developers of the capabilities of UPK. My sole intention with this book is to show developers that it is not difficult to create truly impressive training simulations, with the correct knowledge and just a little effort.
I would like to thank the staff at Packt for their support, my long-standing client, ExxonMobil, for giving me the opportunity to learn so much about UPK and OnDemand, and the extremely knowledgeable Sjoerd De Vries, for doing such a great job on the technical review. I would also like to thank Seigun Kosabayashi and Yuki Iida for the Japanese texts, and Marc Wilms for the (petit) French.
About the reviewer
Sjoerd de Vries is a senior e-learning consultant and project manager for customers of SMS implementation engineers (http://www.smsnet.nl) in The Netherlands. In his work, he combines e-learning, documentation, and change management aspects to "engineers" in larger ERP and CRM software-implementation projects, for customers like SaraLee, Philip Morris, Ericsson, ExxonMobil, Hunter Douglas, ABN-AMRO, Dutch Ministry of Defense, and many others.
In these projects, the users of the software will have an important place in "learning by doing" and increasing performance support within their company. One of the preferred tools for almost 8 years is OnDemand software, currently renamed as Oracle's User Productivity Kit (UPK) as well as Knowledge Pathways (UPK Pro), also by Oracle.
As the first Dutch partner of OnDemand Software, SMS implementation engineers have implemented, trained, and supported OnDemand Software in Europe since 2001. Since 2004 the company also became a partner of Oracle to support the User Productivity Kit that was created by OnDemand Software to support Oracle implementations only. In 2008 OnDemand Software was acquired by Oracle and SMS implementation engineers became a Certified Partner of Oracle and also won the Best Partner Award.
The many years of experience in implementing, consulting, training, and content creation means that OnDemand and UPK have hardly any mysteries for Sjoerd. He became an appreciated and highly involved member of the OnDemand Software community (currently transitioned to the Oracle Support and LinkedIn communities about the UPK). At the last UPK Users' Conference in 2008, Sjoerd also won an "OSCA" award in an UPK contest. For his years of contribution to OnDemand and the later UPK, Sjoerd was asked to contribute to this book as a technical reviewer. Because sharing ideas and knowledge is his main job, he gladly cooperated and hopes that the readers of this book also will learn to like the UPK and understand its big advantage as a training and performance support tool.
Sjoerd has a Masters degree in Science and graduated after his study at the "Vrije Universiteit" in the Netherlands as a teacher (1st degree). After several jobs as a Biology teacher he joined SMS implementation engineers in 1998 and became an e-learning expert. Sjoerd is also chief editor of a Dutch web site for E-learning & Education.
Sjoerd is a real Dutch name and since it is often asked, it is pronounced as "shoe 'rd". Feel free to contact him via his company or LinkedIn.
I would like to dedicate this book to my children, Finn, Freya, and Gil, who are the reason why I still do what I do (even if they have no idea what that is).
Table of ContentsPreface 1Chapter 1: Oracle User Productivity Kit 7
What is UPK? 7A brief history of UPK 8
Why use UPK? 8Instructor-led training 10Self-paced learning 11
How does UPK work? 11Output formats 12
Online delivery 13Documentation 17
Deciding how you will use UPK 19Choosing delivery formats 19Styles and standards 20When to record 21What to record 21
Summary 22Chapter 2: Organizing your Library 23
Accessing the Library 24Working in the Developer screen 25
Changing the screen layout 26The Properties pane 26The Broken Links pane 27The Related Documents pane 28Arranging panes on the screen 28
Changing the information displayed for objects 32Working with Views 35
Table of Contents
[ ii ]
Choosing a structure for your Library 37Creating folders 40Changing the Library structure 40Summary 41
Chapter 3: Recording a Simulation 43How UPK captures a recording 43
Automatic recording 45Capturing actions 46
Problematic actions 46Planning your recording 47Setting your content defaults 50
General options 50Options for Bubble Text 52Options for the Introduction/End Frames 55Options for String Input 56
Our first recording 57Creating an empty Topic 58Recording an empty Topic 59Recording a Topic immediately 59The Recorder window 60
The Recorder window for automatic recording 62Our sample exercise 62
Setting your Recorder options 64Recording drag-and-drop activities 66Summary 78
Chapter 4: Editing a Topic 79Understanding the Topic Editor screen 80
The Screenshot pane 81The Frame Structure pane 82The Property Editor panes 86
Adjusting actions 87The Action Properties pane 87Working with mouse Actions 89
Adjusting Action Areas 90Adjusting Bubble Text 92
Working with keyboard Actions 94Working with string input Actions 98
Adjusting the string input action area 104Adjusting the background color 105Adjusting the font 107
Table of Contents
[ iii ]
Controlling what the user can enter 108Case sensitivity and password fields 114
Changing the Bubble 115The Bubble Properties pane 115Changing the Bubble format 116
Changing the Bubble pointer 116Repositioning the Bubble 117Changing the size of the Bubble 118Adding an icon to a Bubble 118
Changing the Bubble Text 119Template Text versus Custom Text 120Using Custom Text 121Choosing which texts are displayed 122Formatting Bubble Text 123Tagging Custom Text for different modes 124
Undo 127Adjusting your recording 128
Adding missing Frames 128Inserting a No-context Frame 130Replacing screenshots 131Re-recording a Topic 134Editing screenshots 136
Choosing an image editing application 136Editing a screenshot 138
Deleting Frames 141Summary 143
Chapter 5: Building an Outline 145Outlines versus the Library 145Organizing your Topics 146Building an Outline 148
Step 1: Creating an Outline 148Step 2: Inserting Outline Elements into an Outline 151Step 3: Inserting a Topic 152Step 4: Inserting Topic placeholders 153Adjusting the Outline 154
Summary 160Chapter 6: Publishing Your Content 161
Pre-publication checks 162Checking your spelling 162
Changing your spelling options 166Updating the Glossary links 168
Table of Contents
[ iv ]
Testing your content 168Previewing a Topic 170Publishing your content 171
Publishing contenta generic approach 171Published folder structure 179
Publishing for online use 180Creating a Player 180
Publishing options 181Generated files 184Example output 185
Creating an HTML Web Site 186Publishing options 186Generated files 186Example output 187
Creating an LMS Package 191Publishing options 192Generated files 194Example output 194
Creating Standalone Topic Files 195Publishing options 195Generated files 197Example output 197
Publishing Documents 198Publishing a System Process document 199
Document Properties 199Publishing options 201Generated files 203Example output 203
Publishing an Instructor Manual 205Document Properties 205Publishing options 205Generated files 205Example output 206
Publishing a Job Aid 207Document Properties 207Publishing options 207Generated files 207Example output 208
Publishing a Test Document 209Document Properties 209Publishing options 210Generated files 210Example output 210
Publishing an HP Quality Center test script 211Document Properties 212Publishing options 212
Table of Contents
[ v ]
Generated files 213Example output 213
Publishing a Training Guide 214Document Properties 214Publishing options 214Generated files 214Example output 214
Automatic publishing 216Settings files 216The command line command 216Publishing via a batch job 218
Integrating published content into other environments 219Integrating a Topic into a presentation 219Integrating UPK into your application 223
What is context capturing, and what does it do? 224SmartMatch and SmartHelp 229
Summary 230Chapter 7: Version Management 233
Checking in a content object 234UPK Workflow 235Step 1: Selecting the content objects 237Step 2: Confirming the scope of the check-in 237Step 3: Specifying a reason for the change 239
Checking out a content object 240Cancelling the check-out of a content object 241
Working with document versions 242Displaying an earlier version 243Reverting to an earlier version 243
Restoring a deleted document 245Exporting and importing content 246
Exporting content objects 247Importing content objects 249
Converting content from a previous version of UPK or OnDemand 252Summary 256
Chapter 8: Allowing Alternatives 257Adding Alternative Actions 257
Automatically capturing Alternative Actions 264Alternative Paths and Branches 265
Adding an Alternative Path 266Changing the end point of an Alternative Path 269Deleting an Alternative Path 269
Table of Contents
[ vi ]
Inserting a Decision Frame 270Inserting a Branch 273
Changing the order of paths 276Deleting a decision path 277Decision Frames in See It! mode 277Decision Frames in Know It? mode 278
Stretching the envelope with Alternative Paths 278Looping back 279Automatically responding to user input 279
Summary 281Chapter 9: Adding Value to Your Topics 283
Providing context through the use of Custom Text 284The Start Frame 284
Introduction Text: Version differences 286Action Frames 290The End Frame 291Explanation Frames 292Copying and Pasting Frames 298
Putting Web Pages to good use 301Using Web Pages in the Concept pane 302Using images in Web Pages 306Creating independent Web Pages 311Using Web Pages in Topics 311
Linking via a hyperlink 312Linking via an icon 314
Linking files through the use of Packages 316Creating a Package 317Adding files to a Package 318Linking a Package into a content object 320Linking to a URL 323
Using a Glossary 326Creating a glossary 328Assigning a Glossary to content objects 331Regenerating the Glossary links 333
Updating Glossary links after updating the Glossary itself 333Manually regenerating the Glossary links 335
Generating a stand-alone Glossary 336Summary 338
Chapter 10: Adding Value in the Player 339Working with roles 339
Defining your roles 340
Table of Contents
[ vii ]
Assigning roles to Topics 343Selecting roles in the Player 345Remembering a trainee's selection 348Publishing for a role 349Thinking beyond roles 352
Jump-in Points 352Defining jump-in points 353Selecting jump-in points in the Player 354
Facilitating effective searches 356Using Keywords 357
Assigning Keywords to a Topic 357Allowing trainees to change their Player options 359
Providing training on the Player 361What to explain 362How to train on the Player 362
Summary 364Chapter 11: Incorporating Sound into Your Topics 365
Displaying sound properties for a Frame 365Setting up your sound options 367Recording sound files for Template Text 369
Locating the sound files in the Library 372Recording custom text sound files 375Importing and exporting sound files 377
Exporting sound files 377Importing sound files 378
Deleting sound files 379Publishing sound 380
Sound in the Player 382Summary 382
Chapter 12: Configuring UPK 383Configuring Template Text 383
Understanding the template file 387The file header 387The section 388The section 388The section 390The section 392The sections 392The section 395The section 397The section 397
Table of Contents
[ viii ]
Creating a custom template 402Taking a copy of an existing template 402Editing a custom template 403Customizing the Template Text 404
Customizing the Template...