Monday, February 27th, 2012

Oracle UPK (User Productivity Kit) – Chapter 3. Installing the UPK and Creating the Outline

Greetings all,


In the previous chapter, the overview of the Oracle UPK tool and the end user experience became clear.

In the following chapter we will dive deeper into the UPK tool to see the developers point of view.

We will review the different types of installation and the UPK tool itself.


This chapter will cover the following topics:

-          How do we install the UPK developer tool?

-          What do we see when using the UPK developer tool?

-          How do I make my first “Hello World” outline?


Please Note: When you are going to install the Oracle UPK developer tool, make sure you use the UPK Version 11.0.

All the chapters that will be written for this blog, will be made with the Oracle UPK 11.0 professional version.

Installing the Oracle UPK tool and Creating an Outline.

The installation of the Oracle UPK tool is a very simple an easy process:


Step one: Gathering the installer files.

 -          Download the needed installation files from your company’s server, usually these files are bundled in a .zip/.rar file.

-          Unpack the .zip/.rar file.

-          Click on the setup file.

-          Click on the install button.

-          Select the language you wish to use for the UPK tool.


Step two: Selecting the configuration method and installing.

 We will now select the installation method for the UPK.

For this installation we will start with using the UPK locally. (Developing and publishing on your own pc)


-          Select the “Developer Single User” option from the configuration list.

Press next to continue.







-          It might be possible that some third party applications need to be installed. The UPK Developer needs these programs to run without problems.

Press next to continue.







-          After installing the third party applications, the installer will ask for a program folder to install the UPK program to. This will be default named “User Productivity Kit” and default pointed towards the C:// drive.

Press next to continue.
















-          After pressing install, the UPK “Developer Single User” will be installed on your pc.

-          Finish the installation.


Please note: All the other configuration options will be discussed in future blog chapters, in which we will dive deeper into the “Client/Server” and “Knowledge Center” parts of the UPK tool.


Step three: Starting the UPK developer tool and creating a profile:

 Now that we have installed the “Developer Single User”, we will start the UPK Developer.

 -          Click on the User Productivity Kit -> UPK Developer in the start menu.

-          For upcoming chapters, it might be handy to add the “UPK Developer” program to your start menu.

(This can be done by right clicking on the “UPK Developer” and selecting “Add to Start Menu)










The UPK loading screen shows.


When you open the “UPK Developer” program for the first time, you will see the program opening in the background and a pop-up will appear asking you to make a location for your library.

This is a onetime only process in which you will create a profile, which the “Developer Single User” will use to write the content for and will default start-up this profile each time you’ll start the program.









-          Create a profile name.











-          Select the folder to store the UPK data.


The UPK Developer will write all the data you will create with the UPK to this folder.

You have completed the onetime process of making a profile and adding a storage folder.


Step four: The UPK library:

The first time you start up the UPK developer, the standard library will be loaded. This might take a few minutes. This also is a onetime process. If you will restart the “UPK Developer” the loading will only take a few seconds.







After this process is done, you will see the “Start Screen”. This screen will allow you to create a new UPK outline or open an existing outline.

For this tutorial we will create a new outline.

-          Click on Open > Library.

The screen you see now is called the “Library”. In the library you will save all your existing and add your new UPK outlines.


The system has a default of 2 folders in this library. The “system” map, which will contain all the template files (icons, buttons, roles, publish tools, etc) the UPK will use when you create topics. (See above screen)

Please note: The system map may never be deleted. This folder is required for creating content.


The other folder, “Getting started with UPK folder” is an by Oracle made tutorial for new UPK users. If you wish to you can view this UPK tutorial to get a better feeling how the UPK tool works. (To open it, double click on the purple book)

For now, I will skip this tutorial, because in the upcoming chapters I will explain the content of this tutorial myself.








Step Five: Creating the UPK outline

Not that you got familiar with the library, it’s time to create our first UPK outline.

-          Within the library click on File > New > Folder










-          Fill in at “Enter a name for the new folder”: Hello World

The folder now appears in the library.







-          Click on File > New > Module




















-          Fill in at name: Workshop – Hello World

It automatically points to the new created /Hello World folder.


-          Select a Language, template, glossary and screen resolution (Optional)

-          Click on OK to create the new module.


You will now enter the ‘outline’ screen, which will open in a new tab.








-          Select the button  link new section. (Make sure you have the module selected)

-          Enter the name of your section For this example we will use the name “Hello World Lesson”









-          Select the button  link new topic. (Make sure you have the topic selected)

-          Enter the name of your topics. For this example we will use the name “Hello World topic”









Congratulations! You have now created your first UPK outline.

This outline consists of a:

-          Module

-          Section (lesson)

-          Topic


You can expand this outline by adding more lessons, modules or topics.

In this way you can create the desired outline for your project.

In the following chapter we will use the just create outline for recording our first UPK topic.


Thank you for your attention.

Stay Tuned!


 Viewed 2721 times by 875 visitors

Category: General / HR / Technical
You can follow any responses to this entry through the RSS 2.0 feed. You can skip to the end and leave a response. Pinging is currently not allowed.

2 Responses (last comment shown first)

May 31, 2012

Thank you very much! Your blog is a treasure. All the best!!

[Reply to this comment]

February 28, 2012

Hey Mike,

Thank you for this update, can’t wait for the topic about Hello world :)

Regards, Dasja

[Reply to this comment]