UPK Architecture

 

 

 

Step

Action

1. 

Oracle's User Productivity Kit Developer can be installed two ways:

 

• Single user installation

• Multi-user installation

 

The following frames discuss the architecture of these two installation types.

2. 

If opting to install the UPK Developer in a single user environment, all the UPK program files as well as the database would be installed on the Content Developer's local machine. Unlike the multi-user installation, the single user installation does not require an external database.

 

After the UPK Developer is installed you are ready to start the content creation process. Content authors use the UPK Developer software to create documentation, training, and performance support materials.

3. 

Once content creation is complete, you are ready to publish the content. You publish content using the UPK Developer Publishing Wizard.

4. 

When you publish your content as a Player (one of the publishing outputs available to you), you have several options for deployment. This example shows how you can place the Player on a web server and provide your users with a link (URL) to launch it through a browser.

 

As you can see from this diagram, the architecture of a single user installation is simple.

5. 

This diagram illustrates the UPK multi-user architecture. The UPK multi-user Developer uses client/server architecture to provide content authoring functionality for large, distributed development teams as well as single users.

6. 

The UPK Developer Server manages the content created in the Developer. The server is built to store this information in a reliable and consistent manner as well as service multiple client workstations in an efficient and scalable manner.

7. 

The server has two components: the server software and a database that holds the content, called the Library.

 

There are a few ways you can deploy the multi-user Developer. In this example, the database is stored on the same server as the the server software.

8. 

In this example, the database is stored on a separate server from the server software.

9. 

The server software contains all of the logic for managing and securing the data within the Library. The server software responds to requests from the client desktops including:

 

• Adding new documents to the Library

• Locking (checking out) documents to an individual user

• Writing changes to the Library

• Adding or modifying authors who have access to the Library

• Retrieving documents from the Library

10. 

The Content Library is stored in the database which can be on the same server as the server software or a different server. The database stores all data shared by multiple authors in the development environment.

 

The database includes all content that is created such as topics, web pages, packages, modules, sections, keywords, glossaries, and roles. In addition, the Library also stores templates and publishing styles.

11. 

The client computer requires an installation of the Developer Client. The client also contains a client database (also referred to as the document cache) that is used and managed by the client desktop software.

 

After the UPK Developer is installed, you are ready to start the content creation process. Content authors use the UPK Developer software to create documentation, training, and performance support materials.

12. 

Once content creation is complete, you are ready to publish the content. You publish content using the UPK Developer Publishing Wizard.

13. 

When you publish your content as a Player (one of the publishing outputs available to you), you have several options for deployment. This example shows how you can place the Player on a web server and provide your users with a link (URL) to launch it through a browser.

14. 

This topic covered the architecture of the UPK single and multi-user installations.

End of Procedure.