Using Pagelet Wizard with PeopleSoft Enterprise Portal

This chapter provides an overview of using Pagelet Wizard with PeopleSoft Enterprise Portal and discusses how to:

Note. This documentation discusses features for PeopleSoft Enterprise Portal that are available through the basic Pagelet Wizard PeopleTools only when PeopleSoft Enterprise Portal is installed.

The basic Pagelet Wizard PeopleTool is covered in Enterprise PeopleTools 8.48 PeopleBook: Internet Technology, “Using Pagelet Wizard.” Please refer to this PeopleTools PeopleBook for information about setting up and using the basic Pagelet Wizard PeopleTool.

Click to jump to parent topicUnderstanding How to Use Pagelet Wizard with PeopleSoft Enterprise Portal

When you use the basic Pagelet Wizard PeopleTool with PeopleSoft Enterprise Portal installed, Pagelet Wizard is able to transform content from additional data sources that are available only by way of PeopleSoft Enterprise Portal. As a result, Pagelet Wizard provides options and features that are unique to PeopleSoft Enterprise Portal. These are the options and features that are discussed in this PeopleBook.

See Also

Understanding Pagelet Wizard Data Types for PeopleSoft Enterprise Portal

Click to jump to parent topicDefining Pagelet Wizard Transformation Type, Display Formats, and Data Types

 

Click to jump to top of pageClick to jump to parent topicPages Used to Define Pagelet Wizard Transformation Types, Display Format, and Data Types

Page Name

Object Name

Navigation

Usage

Define Data Types

PTPPB_DATATYPE_MTC

Portal Administration, Pagelets, Pagelet Wizard, Define Data Types

Define the data types used by Pagelet Wizard.

Define Transform Types

PTPPB_TXFRMTYP_MTC

Portal Administration, Pagelets, Pagelet Wizard, Define Transform Types

Define the transform types used by Pagelet Wizard.

Define Display Formats

PTPPB_DISPFRMT_MTC

Portal Administration, Pagelets, Pagelet Wizard, Define Display Formats

Define the display formats used by Pagelet Wizard.

Click to jump to top of pageClick to jump to parent topicData Sources for Portal-Specific Pagelet Wizard

When you use Pagelet Wizard with the PeopleSoft Enterprise Portal installed, the following additional data sources become available:

Click to jump to top of pageClick to jump to parent topicDefining Transformation Types

Pagelet Wizard is delivered with the following transformation type definitions to support their associated display formats:

Warning! Do not alter delivered field values for these transformation types.

 

See Enterprise PeopleTools 8.48 PeopleBook: Internet Technology, “Using Pagelet Wizard,” Defining Transform Types

Click to jump to top of pageClick to jump to parent topicDefining Display Formats

These data type definitions can be accessed on the Define Display Formats page. You can also use this page to define other display formats.

Chart

Display pagelet data as a line, bar, pie, or histogram chart.

Custom

Specify a custom display transformation (XSL template) for your pagelet.

List

Display the pagelet data as a numbered or bulleted list.

Menu

Display the pagelet as a categorized tree or list-based navigation menu.

Passthru

Display the pagelet with no visual transformation.

Searchrec

Display a pagelet with a component's search results or a search dialog box for the component's search page.

Table

Display the pagelet data in tabular format, with customizable columns, visual display, and ordering.

See Enterprise PeopleTools 8.48 PeopleBook: Internet Technology, “Using Pagelet Wizard,” Overview of Pagelet Wizard Display Formats

Click to jump to top of pageClick to jump to parent topicDefining Data Types

When you use Pagelet Wizard with the PeopleSoft Enterprise Portal installed, the following additional data type definitions become available to support their associated data sources:

Warning! Do not alter delivered field values for these data types.

These data type definitions can be accessed on the Define Data Types page. You can also use this page to define other data types.

See Data Sources for Portal-Specific Pagelet Wizard.

See Enterprise PeopleTools 8.48 PeopleBook: Internet Technology, “Using Pagelet Wizard,” Defining Data Types

Click to jump to parent topicDefining Pagelet Wizard XSL Prototypes

This section describes how to define custom XSL definitions for Pagelet Wizard.

Click to jump to top of pageClick to jump to parent topicPage Used to Define Pagelet Wizard XSL Prototypes

Page Name

Object Name

Navigation

Usage

Define XSL

PTPPB_XSLPROT_MTCE

Portal Administration, Pagelet Wizard, Define XSL

Create custom XSL definitions for use with Pagelet Wizard.

Click to jump to top of pageClick to jump to parent topicDefining XSL Prototypes

When you use Pagelet Wizard with the PeopleSoft Enterprise Portal installed, the following additional XSL prototypes are delivered to support their associated data sources and display formats. All other XSL prototypes are listed in the PeopleTools Pagelet Wizard XSL prototypes.

XSL Prototype

Data Type

Description

GOOGLE_API

SOAP

GOOGLE LIST

PAPP_ACTION_ITEMS

ACTION_ITEMS

Action Items

PAPP_COMMUNITY_CALENDAR

COMMUNITY_CALENDAR

Community Calendar

PAPP_CWLINKS

CWLINKS

Collaborative Workspace Links

PAPP_DISCUSSION_FORUM

DISCUSSIONS

Recent Discussions

PAPP_NAV_SMALLIMAGES

NAVIGATION_COLLECTION

Small Images

PAPP_NEWS_PUBLICATION

NEWS_PUBLICATION

News Publication

PAPP_SC_EXPANDEDTREE

SHORTCUT_COLLECTION

Expanded View

PAPP_SC_FOLDERTREE

SHORTCUT_COLLECTION

Folder Tree

PAPP_SC_TWOLEVELTREE

SHORTCUT_COLLECTION

Two-Level View

Warning! Do not alter the delivered XSL for these XSL prototypes.

These XSL prototype definitions can be accessed on the Define XSL page. You can also use this page to define other XSL prototypes.

See Enterprise PeopleTools 8.48 PeopleBook: Internet Technology, “Using Pagelet Wizard,” Defining Pagelet Wizard XSL Prototypes.

Click to jump to parent topicDefining Pagelet Wizard Headers and Footers

The pages used to define pagelet headers and footer pagelets are available through the basic Pagelet Wizard PeopleTools pages when PeopleSoft Enterprise Portal is installed.

 

See Enterprise PeopleTools 8.48 PeopleBook: Internet Technology, “Using Pagelet Wizard,” Defining Pagelet Wizard Headers and Footers.

Click to jump to top of pageClick to jump to parent topicPages Used to Define Pagelet Wizard Headers and Footers

Page Name

Object Name

Navigation

Usage

Define Header

PTPPB_HDR_MTCE

Portal Administration, Pagelets, Pagelet Wizard, Define Headers, Define Header

Create a pagelet header design. Enter HTML that you want to appear on the header.

Define Headers - Specify Image

PTPPB_HDR_IMAGE

Portal Administration, Pagelets, Pagelet Wizard, Define Headers, Define Header, Specify Image

Specify an image that you want to appear on the pagelet header. Specify image properties.

Define Headers - Preview

PTPPB_HDR_PREVIEW

Portal Administration, Pagelets, Pagelet Wizard, Define Headers, Define Header, Preview

View the fully assembled pagelet header. After previewing the pagelet header, you can adjust the HTML and image parameters as needed.

Define Footer

PTPPB_FTR_MTCE

Portal Administration, Pagelets, Pagelet Wizard, Define Footers, Define Footer

Create a pagelet footer design. Enter HTML that you want to appear on the footer.

Define Footers - Specify Image

PTPPB_FTR_IMAGE

Portal Administration, Pagelets, Pagelet Wizard, Define Footers, Specify Image

Specify an image that you want to appear on the pagelet footer. Specify image properties.

Define Footers - Preview

PTPPB_FTR_PREVIEW

Portal Administration, Pagelets, Pagelet Wizard, Define Footers, Preview

View the fully assembled pagelet footer. After previewing the pagelet footer, you can adjust the HTML and image parameters as needed.

Click to jump to parent topicDefining Page Wizard Pagelet Categories

You can use category IDs to organize Pagelet Wizard pagelets. The portal administrator can use this value when running pagelet reports and when searching for pagelets that need to be moved between different portal sites

 

See Enterprise PeopleTools 8.48 PeopleBook: Internet Technology, “Using Pagelet Wizard,” Defining Pagelet Wizard Pagelet Categories.

Click to jump to top of pageClick to jump to parent topicPage Used to Define Pagelet Wizard Pagelet Categories

Page Name

Object Name

Navigation

Usage

Define Categories

PTPPB_PGLTCATG_MTC

Portal Administration, Pagelets, Pagelet Wizard, Define Categories

Define categories used to organize pagelets created using Pagelet Wizard.

Click to jump to parent topicStep 1: Entering Pagelet Identifying Information

This section lists the page used to enter pagelet identifying information.

Click to jump to top of pageClick to jump to parent topicPage Used to Enter Pagelet Identifying Information

Page Name

Object Name

Navigation

Usage

Specify Pagelet Information

PTPPB_WIZ_INFO

  • Portal Administration, Pagelets, Pagelet Wizard, Pagelet Wizard

  • PeopleTools, Portal, Pagelet Wizard, Pagelet Wizard

Define description and summary information for a pagelet.

See Enterprise PeopleTools 8.48 PeopleBook: Internet Technology, “Using Pagelet Wizard,” Step 1: Entering Pagelet Identifying Information.

Click to jump to parent topicStep 2: Selecting a Pagelet Data Source

This section discusses how to:

Click to jump to top of pageClick to jump to parent topicPage Used to Select a Data Source

Page Name

Object Name

Navigation

Usage

Select Data Source

PTPPB_WIZ_DATASRC

  • Portal Administration, Pagelets, Pagelet Wizard, Pagelet Wizard

    Click the Next button or the icon for step 2.

  • PeopleTools, Portal, Pagelet Wizard, Pagelet Wizard

    Click the Next button or the icon for step 2.

Select the type of data source for the pagelet.

See Also

Enterprise PeopleTools 8.48 PeopleBook: Internet Technology, “Using Pagelet Wizard,” Step 2: Selecting a Pagelet Data Source.

Click to jump to top of pageClick to jump to parent topicSelecting the Action Items Data Source

Access the Select Data Source page. Select Action Items in the Data Type field.

Data Source

List

Select the Action Items list to display in the pagelet.

Data Source Details

Inputs

Displays the .MAXROWS query data source parameter that you can use to limit the amount of data returned to the pagelet.

Outputs

Displays the data source parameter fields that correspond to the query’s output.

See Working with Action Items.

Click to jump to top of pageClick to jump to parent topicSelecting the Collaborative Workspace Links Data Source

Access the Select Data Source page. Select Collaborative Workspace Links in the Data Type field.

Data Source

Portal Name

Select the portal that contains the Collaborative Workspace Links module collection for the pagelet.

Collection Name

Select the name of the Collaborative Workspace Links module collection that you want to use to create the pagelet.

Click to jump to top of pageClick to jump to parent topicSelecting the Community Calendars Data Source

Access the Select Data Source page. Select Community Calendars in the Data Type field.

 

Data Source

Calendar Source

Enter the calendar or calendars you want to use as a source for the pagelet. Valid values are:

  • Single Calendar, which will show the events from one calendar in the pagelet.

  • All Calendars, which will display events from all available calendars in the pagelet.

  • Workspace Calendar, which displays the content of the workspace calendar.

Calendar ID

Select the single calendar that you want to display in the pagelet.

See Working with Community Calendars.

Click to jump to top of pageClick to jump to parent topicSelecting the Content Management Data Source

Access the Select Data Source page. Select Content Management in the Data Type field.

Approved text or HTML content in the PeopleSoft Content Management system can be used as base data for a Pagelet Wizard pagelet.

See Understanding Enterprise Portal Content Management and Publication.

When you select Content Management as the data source, the pagelet does not provide configurable data source parameters. Consequently, when creating a Content Management data source pagelet, you bypass step 3 and proceed to step 4, in which you select the pagelet display format.

Data Source

Folder ID

Select the Content Management folder in which the content resides.

Content ID

Select the Content Management content that you want to use as the data source for the pagelet.

Content Path

Displays the Content Management site and folder path to the content.

Click to jump to top of pageClick to jump to parent topicSelecting a Content Management Folder Data Type

Access the Select Data Source page. Select Content Management Folder in the Data Type field.

 

Data Source

Site Name

Select the name of the site you want to use as the source of content for the pagelet.

Folder ID

Select the parent folder you want to use as the source of content for the pagelet.

Folder Title

The system displays the name of the folder you've selected.

Click to jump to top of pageClick to jump to parent topicSelecting a Discussions Data Type

Access the Select Data Source page. Select Discussions in the Data Type field.

Data Source

Forum

Select the forum identifier that you want to use as the source of content for the pagelet.

Data Source Details

Inputs

Displays the .MAXROWS query data source parameter that you can use to limit the amount of data returned to the pagelet.

Outputs

Displays the data source parameter fields that correspond to the query’s output.

See Working With Discussion Forums.

Click to jump to top of pageClick to jump to parent topicSelecting a News Publications Data Source

Access the Select Data Source page. Select News Publications in the Data Type field.

Publication ID

Select the news publication that you want to use as the data source for the pagelet. Available news publications are created in the News Publications component.

See Setting Up and Working with News Publications.

Publication name

Displays the name of the news publication.

See Also

Working With Internet News Content

Click to jump to parent topicStep 3: Specifying Data Source Parameters

This section discusses how to:

Other data sources are discussed in the Enterprise PeopleTools 8.48 PeopleBook: Internet Technology “Using Pagelet Wizard,” Step 3: Specifying Pagelet Data Source Parameters

Click to jump to top of pageClick to jump to parent topicCommon Elements Used in This Section

Description

Displays a description of the data source parameter.

Usage Type

Select the type of accessibility that you want to grant for the data source parameter field when it appears on the pagelet. Options are:

  • Not Used: Select if it will not be used on the pagelet.

  • Fixed: Select to enter a fixed value for the data source parameter that the pagelet end user cannot modify.

  • System Variable: Select to assign a system variable as the data source parameter value. The value of the system variable is automatically inserted into the parameter when the pagelet appears. When you select this option, the pagelet end user cannot modify the data source parameter.

    For example, suppose that you specify %UserId as the system variable for a User data source parameter field. When the pagelet appears on a user’s homepage, the User field is populated by the %UserId system variable, which is the user ID used to access the pagelet.

  • Admin Specified: Select to enable those users with administrative privileges to specify variables for this field, as well as access the Configure link on the published pagelet and select from those parameters for users.

  • User Specified: Select to enable end users to specify a data source parameter value for this field. When a pagelet contains a user-specified field, the Customize button appears on the pagelet title bar.

    End users can click this button to access a personalization page, where they can select a data source parameter value that they want to appear by default on the pagelet when they access it. They can select a value from a prompt, or they can manually enter their own value if no prompt values are available.

    If you change the usage type from or to User Specified for a data source parameter on a published homepage pagelet, you must unpublish and republish the pagelet.

Default Value

If you select User Specified as the usage type and the data source parameter is a required value, you must enter the default value that should appear before a user enters a value. If the data source parameter is not a required value, you do not have to enter a default value.

If you select a default value when defining available user-specified values on the Specify Data Source Parameter Values page, that default value populates this field.

If you select User Specified as the usage type, you can enter a system variable as the default value. For example, to make the current date the default value for a user-specified parameter, enter a default value of %Date.

If you select System Variable as the usage type, you must enter the system variable to use as the data source parameter value.

See Enterprise PeopleTools 8.48 PeopleBook: Internet Technology, "Using Pagelet Wizard," Step 3: Specifying Pagelet Data Source Parameters, Understanding System Variables Supported as Data Source Parameters

If you select Fixed as the usage type, you must enter the fixed value.

You can enter a value that includes the % and * wildcards at the beginning or end of a value in the Default Value field.

If you select Fixed as the usage type and the data source parameter has associated prompt values, you can use the Look up Value button to search for available data source parameter values.

If you select System Variable as the usage type, you can use the Look up Value button to access a list of valid system variables.

If you select User Specified as the usage type, this button does not appear.

User Values

If you select User Specified or Admin Specified as the usage type, click to access the Specify Data Source Parameter Values page.

See Specifying Data Source Parameter Values.

Personalization Instructions

Use the Personalization Instructions text box to enter custom personalization instructions for the pagelet. These personalization instructions appear on the Personalization page of the pagelet.

Note. Personalization instructions must be translatable.

Click to jump to top of pageClick to jump to parent topicPage Used to Specify Data Source Parameters

Page Name

Object Name

Navigation

Usage

Specify Data Source Parameters

PTPPB_WIZ_DATAPRMS

  • Portal Administration, Pagelets, Pagelet Wizard, Pagelet Wizard

    Click the Next button on the Select Data Source page, or click the icon for step 3.

  • PeopleTools, Portal, Pagelet Wizard, Pagelet Wizard

    Click the Next button on the Select Data Source page, or click the icon for step 3.

Configure the data source parameters that are required for the data to be displayed on the pagelet. For instance, when entering data source parameters for a News Publications pagelet, you specify input data that determines the content and format of the news that is displayed on the pagelet. The parameters vary depending on the data source that is selected on the Select Data Source page.

This page is accessible only when you are building a pagelet with a data source that allows modification of associated parameters.

During this step, you can also select parameters for some data sources that allow administrative configuration of the pagelet after it has been published. In Enterprise Portal 9, you are considered a pagelet administrator and will have access to the Configure link on a pagelet when any of the following conditions are met.

  • You have Portal Administrator permissions.

  • You have Site Administrator permissions for the current site.

  • You have Administrator privileges for the current workspace.

Note. This step is not applicable when you are creating pagelets with Content Management data sources.

See Also

Enterprise PeopleTools 8.48 PeopleBook: Internet Technology, “Using Pagelet Wizard,” Step 3: Specifying Pagelet Data Source Parameters.

Click to jump to top of pageClick to jump to parent topicSpecifying Action Items Data Source Parameters

Access the Specify Data Source Parameters page after selecting Action Items as the data type on the Select Data Source page.

Click to jump to top of pageClick to jump to parent topicSpecifying Collaborative Workspace Links Data Source Parameters

Access the Specify Data Source Parameters page after selecting Collaborative Workspace Links as the data type on the Select Data Source page.

Click to jump to top of pageClick to jump to parent topicSpecifying Community Calendar Data Source Parameters

Access the Specify Data Source Parameters page after selecting Community Calendar as the data type on the Select Data Source page.

Click to jump to top of pageClick to jump to parent topicSpecifying Content Management Folder Data Source Parameters

Access the Specify Data Source Parameters page after selecting Content Management Folder as the data type on the Select Data Source page.

Click to jump to top of pageClick to jump to parent topicSpecifying Discussions Data Source Parameters

Access the Specify Data Source Parameters page after selecting Discussions as the data type on the Select Data Source page.

Click to jump to top of pageClick to jump to parent topicSpecifying News Publication Data Source Parameters

Access the Specify Data Source Parameters page after selecting News Publications as the data type on the Select Data Source page.

Field Name

.SHOW_TS_IMAGES: Set the Default Value field to Y if you want the pagelet to display images for top stories for the news publication.

.SHOW_SECTION_LINKS: Set the Default Value field to Y if you want the pagelet to display links to sections in the news publication.

.NUM_ARTICLES: Set the Default Value field to the number of articles that you want the pagelet to display.

Click to jump to top of pageClick to jump to parent topicSpecifying Data Source Parameter Values

Access the Data Source Parameters page by clicking the User Values button.

Select the parameter value to be displayed to the user as the default value for the field. Users can select from this list of valid values when they personalize the pagelet.

Click to jump to parent topicStep 4: Selecting a Pagelet Display Format

This section discusses how to select a display format.

Click to jump to top of pageClick to jump to parent topicPage Used to Select a Pagelet Display Format

Page Name

Object Name

Navigation

Usage

Select Display Format

PTPPB_WIZ_DISPFRMT

  • Portal Administration, Pagelets, Pagelet Wizard, Pagelet Wizard

    Click the Next button on the Specify Data Source Parameters page, or click the icon for step 4.

  • PeopleTools, Portal, Pagelet Wizard, Pagelet Wizard

    Click the Next button on the Specify Data Source Parameters page, or click the icon for step 4.

Specify the data transformation method and display format for the pagelet.

See Also

Enterprise PeopleTools 8.48 PeopleBook: Internet Technology, “Using Pagelet Wizard,” Step 4: Selecting a Pagelet Display Format.

Click to jump to top of pageClick to jump to parent topicSelecting a Display Format

Access the Select Display Format page.

Select the format to use for the pagelet. The display formats that are available for selection on this page depend on the data source that you have selected on the Select Data Source page. Options that are available for pagelets that are created using PeopleSoft Enterprise Portal-specific data sources are:

Passthru

The passthru display format is appropriate for creating a pagelet that displays data from the HTML data source. Because the passthru display format performs no further transformations on data from the data source, it should only be used with data sources that return HTML that can be directly displayed as a pagelet. Following is an example of a passthru pagelet displaying data from an HTML data source

Available for Content Management pagelets.

Custom

Use the custom display format when you want to use a display format other than the ones expressly listed in the Pagelet Wizard. When you select the custom display format, Pagelet Wizard enables you to select a format provided by one of the delivered XSL prototypes, or you can select an XSL template that you created on the Define XSL page.

Available for Action Items, Content Management, Content Management Folder, Collaboration Workspace Links, Community Calendars, Discussion, and News Publications pagelets.

Menu

Use the menu display format when want to show your pagelet data as a categorized tree or list-based navigational menu, with extensive visual options

Available for Collaboration Workspace Links, and Content Management Folder pagelets.

See Also

Enterprise PeopleTools 8.48 PeopleBook: Internet Technology, “Using Pagelet Wizard,” Step 4: Selecting a Pagelet Display Format

Click to jump to parent topicStep 5: Specifying Pagelet Display Options

This section lists the pages used to specify pagelet display options.

Click to jump to top of pageClick to jump to parent topicPages Used to Specify Pagelet Display Options

Page Name

Object Name

Navigation

Usage

Specify Display Options (passthru format)

PTPPB_WIZ_DISP_PST

  • Portal Administration, Pagelets, Pagelet Wizard, Pagelet Wizard

    Select Passthru as the display format and click the Next button on the Select Display Format page, or click the icon for step 5.

  • PeopleTools, Portal, Pagelet Wizard, Pagelet Wizard

    Select Passthru as the display format and click the Next button on the Select Display Format page, or click the icon for step 5.

Enter pagelet passthru formatting details and header and footer options. Preview the pagelet.

Specify Display Options (menu format)

PTPPB_WIZ_DISP_NAV

Portal Administration, Pagelets, Pagelet Wizard, Pagelet Wizard

Select Menu as the display format and click the Next button on the Select Display Format page, or click the icon for step 5.

Enter the pagelet menu formatting details and header and footer options. Preview the pagelet.

Specify Display Options (custom format)

PTPPB_WIZ_DISP_CUS

  • Portal Administration, Pagelets, Pagelet Wizard, Pagelet Wizard

    Select Custom as the display format and click the Next button on the Select Display Format page, or click the icon for step 5.

  • PeopleTools, Portal, Pagelet Wizard, Pagelet Wizard

    Select Custom as the display format and click the Next button on the Select Display Format page, or click the icon for step 5.

Enter the custom formatting details for the pagelet as well as header and footer options. Preview the pagelet.

Link Details

PTPPB_WIZ_LINK_DTL

Click the Link Options button on the Specify Display Options page.

Enter linking details that convert pagelet column data into drill-down links to pages that provide details about the pagelet data.

See Also

Enterprise PeopleTools 8.48 PeopleBook: Internet Technology, “Using Pagelet Wizard,” Step 5: Specifying Pagelet Display Options

Click to jump to parent topicStep 6: Specifying Pagelet Publication Options

This section lists the pages used to specify pagelet publication options.

Click to jump to top of pageClick to jump to parent topicPages Used to Specify Pagelet Publication Options

Page Name

Object Name

Navigation

Usage

Specify Publishing Options

PTPPB_WIZ_PUBOPT

  • Portal Administration, Pagelets, Pagelet Wizard, Pagelet Wizard

    Click the Next button on the Specify Display Options page, or click the icon for step 6.

  • PeopleTools, Portal, Pagelet Wizard, Pagelet Wizard

    Click the Next button on the Specify Display Options page, or click the icon for step 6.

Specify the type of pagelet that you want to publish. Provide registration, caching, and security details, and register the pagelet.

Pagelet Creation Confirmed

PTPPB_WIZ_FINISH

Click the Finish button on the Specify Publishing Options page.

Confirm that the creation of the pagelet is complete.

See Also

Enterprise PeopleTools 8.48 PeopleBook: Internet Technology, “Using Pagelet Wizard,” Step 6: Specifying Pagelet Publication Options