Appendix: Configuring UPK Topics as Related Content

You can configure Oracle User Productivity Kit (UPK) modules and topics as component-level and page-level related content services. This appendix provides a brief overview of Oracle UPK and related content and describes how to:

• Create UPK-based related content service definitions.

• Assign UPK-based services as related content.

Note. In this appendix, the word topic is used to represent both topics and modules unless specified otherwise.

Understanding Oracle UPK and Related Content

Oracle UPK Developer and content is an end-user training solution that provides a single-source development and customization tool to enable rapid content creation and customization. UPK also can provide system process documentation, web-based training materials, role-based performance support, and other types of documentation.

PeopleSoft Related Content Framework is a set of PeopleTools definitions and processes that enable developers and subject matter experts to link application pages with contextually relevant content. The primary goal of related content services is to provide immediate access to relevant, contextual information for any PeopleSoft transaction without requiring any additional user effort. PeopleSoft Related Content Framework acts as an enterprise mashup, tying together all types of content such as Oracle Business Intelligence Enterprise Edition (OBIEE) analytics, queries, discussion threads, documentation, and relevant non-PeopleSoft data into a single tool—PeopleSoft application pages.

You can use the related content framework to set up access to UPK modules and topics so that any UPK content is available at the page or component levels under the Related Content menu as shown here:

Prerequisites

This table lists the necessary prerequisites for integrating UPK and related content and provides references to information about these prerequisites:

UPK Player Package Links

The UPK administrator will have access to the player package link (URL). The link should look similar to this:

http://upkservername/upk/content_subject/toc.html

If you change the player package link ending from toc.html to kp.html you can access the kp.html file.

This is a sample kp.html page:

Sample kp.html page

KP.HTML File Topic Modes

Each UPK installation includes a kp.html file that lists your UPK modules and topics. The kp.html file, which is located in the player package folder, enables you to manually link to a specific mode for a topic.

UPK modules can appear in five modes:

• Do It

• Know It

• Try It

• See It

• Concept

Right-click the topic link and select Properties to access the topic-specific URL. If you are creating task-oriented related content, right-click the Do It link. If you are creating concept-oriented related content, right-click the Concept link.

The Properties dialog box shows the URL in the Address field. Although the fields on the dialog box are display-only, you can highlight and copy the address as this example shows:

UPK topic URL

Note these points about the format of the URLs:

• For task-oriented information, the URL should look similar to this:

  http://upkserver/upk/peopletools/dhtml_kp.html?Guid=69f0376e-70fc-417c-a43c-ecd6afb72b29&Mode=D&Back

• For conceptual information, the URL should look similar to this:

  http://upkserver/upk/peopletools/tpc/0350d9a9-6013-4cc9-9022-016f815029ba/Parts/index.html

Use this table to verify that the link accesses the correct mode:

For each URL, the &Back fragment is extraneous for related content purposes. You delete this part of the URL when you create the service definition.

Service Definitions

You configure UPK topics as non-PeopleSoft URL service definitions.

In this example, you see the View Report Detail UPK topic that is configured as a non-PeopleSoft URL type:

Related content service definition for UPK topic

Related Content Menus and Frames

When you assign UPK services to content references, you assign the services as component-level related content only for these reasons:

• UPK service definitions do not require any parameters; therefore topics cannot be mapped at the field level.

• Users should be able to access UPK content from the Related Content drop-down menu. Only services assigned as related content appear in the Related Content drop-down menu.

Menu Item Labels

When you create a label for the service, consider the specific context of the service and use direct language. For example, if you want to add a service in which the UPK topic shows users how to submit a process in Do It mode, then Show me how to submit a process is an appropriate label.

Related Content Frame

If you assign the UPK topics to appear in the right frame, users can access multiple help topics simultaneously because they appear in individual pagelets. If you assign UPK topics to the bottom frame, one topic only is visible at a time because they appear in tabs.

Example UPK Topic in Related Content Frame

In this example, the UPK topic appears in the right related content frame:

Example UPK topic as related content on Process Monitor page

See Also

Framework Flexibility

Configuring the Related Content Menu

Configuring the Related Content Frames

Creating UPK-Based Related Content Service Definitions

This section discusses how to:

1. Modify the UPK player package link.

2. Create the UPK-based service definition

Modifying the UPK Player Package Link

To modify the UPK player package link:

1. Contact your UPK system administrator to obtain the player package link (URL).

2. Change the file name toc.html to kp.html so that the URL looks similar to this:

   http://upkservername/upk/content_subject/kp.html

3. Paste the link into your browser and access the file.

4. Find the topic. Right-click the Concept or Do It link associated with the topic. If you are creating task-oriented related content, right-click the Do It link; otherwise, click the Concept link.

5. From the pop-up menu, select Copy Shortcut.

   Alternately, select Properties and then copy the URL that you see on the dialog box.

6. If you are creating multiple service definitions, you might consider creating a spreadsheet that contains information similar to that which exists in this table::

   Topic	URL
   Process Scheduler - Concept	http://upkserver/upk/peopletools/tpc/0350d9a9-6013-4cc9-9022-016f815029ba/Parts/index.html
   Viewing Process Details - Do It	http://upkserver/upk/peopletools/dhtml_kp.html?Guid=69f0376e-70fc-417c-a43c-ecd6afb72b29&Mode=D&Back

7. For each task-oriented URL, remove the &Back at the end of the address.

8. Save your spreadsheet.

Creating the UPK-Based Service Definition

To create the UPK-based service definition:

1. Create a new related-content service definition.

   Choose a naming convention that makes UPK service definitions easily identifiable, for example UPK_<service_definition_name>

2. Enter the service name and description.

3. Select Non-PeopleSoft URL as the URL type.

4. In the External URL field, enter the URL to your kp.html file.

   It should look similar to this: http://myupksite.com/upk/mycontent/dhtml_kp.html?Guid=5cd5ba9f-c3a8-441f-923b-a8aca7e95b6e&Mode=D

5. Click the Test Related Content Service link.

   The Test Related Content Service page opens.

6. On the Test Related Content Service page, click the Test Related Content Service link.

7. Click the Return button to go back to the Define Related Content Service page.

8. For conceptual information, select the New Window check box to give the administrator the ability to enable the new window functionality for the user.

9. In the Select security options group box, select the Public Access check box.

10. Click the Save button.

    Note. UPK-based service definitions do not require additional parameters.

This completed service definition shows an external URL that accesses UPK content in Do It mode:

Note. You can use the Copy Service Definition button to clone this definition and save time creating new UPK-based service definitions.

See Also

Creating and Maintaining Non-PeopleSoft Related Content Service Definitions

Assigning UPK-Based Services as Related Content

Access the Manage Related Content Configuration page. (Select PeopleTools, Portal, Related Content Service, Manage Related Content Service.)

To assign UPK-based services as related content:

1. Click the Assign Related Content to Application Pages link.

2. Select the content reference.

   See Selecting a Content Reference.

3. On the Related Content tab, add the UPK service as component-level related content.

   See Assigning Component-Level Related Content.

4. Configure the related content menu.

   See Configuring the Related Content Menu.

5. Configure the related content frame.

   See Configuring the Related Content Frames.

6. Click the Save button.

7. Click the content reference link to test your configuration.