Using Pagelet Wizard

This chapter discusses how to:

  1. Enter pagelet identifying information.

  2. Select a pagelet data source.

  3. Specify pagelet data source parameters.

  4. Select a pagelet display format.

  5. Specify pagelet display options.

  6. Specify pagelet publication options.

Note. Before you start building a pagelet with Pagelet Wizard, familiarize yourself with all data sources. This enables you to evaluate the best way to retrieve the data that you want to display in the pagelet.

Examples of PeopleSoft Pure Internet Architecture pages in this chapter were captured with the PeopleTools default style sheet applied. PeopleSoft Pure Internet Architecture pages may display differently in your database depending on the applied style sheet. However, regardless of the style sheet applied, all page elements displayed remain the same.

See Also

Setting Up Pagelet Wizard Options

Click to jump to top of pageClick to jump to parent topicStep 1: Entering Pagelet Identifying Information

This section discusses how to specify pagelet 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

EOPPB_WIZ_INFO

Enterprise Components, Portal Utilities, Pagelet Wizard, Pagelet Wizard

Define description and summary information for a pagelet.

Click to jump to top of pageClick to jump to parent topicSpecifying Pagelet Information

Access the Specify Pagelet Information page.

Pagelet ID

Enter an ID for the pagelet. Each pagelet that you build with Pagelet Wizard must have a unique ID.

Pagelet Title

Enter a unique title for the pagelet. This value appears in the pagelet title bar, which is the solid bar at the top of the pagelet. If you change the pagelet title value for a published pagelet, you must unpublish and republish the pagelet for the change to take effect.

Description

Enter additional descriptive information to identify the pagelet. This reference text is used in Verity and search record searches.

Owner ID

Select the value that you want to use to identify pagelets created by the organization. The portal administrator can use this value when searching for pagelets through PeopleSoft Application Designer or SQL queries on the portal registry table.

Do not select a delivered PeopleSoft owner ID. You can define unique owner IDs for the organization by entering field translate values for the OBJECTOWNERID field using PeopleSoft Application Designer.

Category ID

To organize Pagelet Wizard pagelets, select a category assignment for the pagelet. You create pagelet categories on the Define Categories page. 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.

Categories provide another level of organization in addition to the owner ID. For example, you can use a departmental owner ID, and within that, categorize pagelets for that ID by pagelet type.

See Defining Pagelet Wizard Pagelet Categories.

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

This section discusses how to:

You can define other data sources by using the Define Data Types page.

See Also

Pagelet Wizard Data Sources

Defining Data Types

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

Page Name

Object Name

Navigation

Usage

Select Data Source

EOPPB_WIZ_DATASRC

Enterprise Components, Portal Utilities, Pagelet Wizard, Pagelet Wizard

Click the Next button or the icon for step 2.

Select the type of data source for the pagelet.

Click to jump to top of pageClick to jump to parent topicSelecting a Query Data Source

Access the Select Data Source page. Select PS Query in the Data Type field.

Queries typically return a number of columns and rows. Queries for pagelets should be selected based on available display space on the homepage. In addition, avoid selecting long-running queries that can delay the display of the homepage.

Keep in mind that public query results are available to portal viewers only if they have appropriate access to the underlying data record. Permission lists in the users’ role definitions must contain query access groups that include the records in the query definition.

Data Type

Select PS Query.

Data Source

Query Name

Select a query to serve as the data source for the pagelet. You can select any public query in the local database.

PeopleSoft queries provide SQL access to any table recognized by the PeopleSoft system. This includes external, remote tables that are recognized by the PeopleSoft system by way of a database link.

See Enterprise PeopleTools 8.45 PeopleBook: PeopleSoft Query, “Introduction to PeopleSoft Query”

Data Source Details

Inputs

Displays the data source parameter fields that correspond to the query’s input prompts. Also displays the required system-supplied .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.

Click to jump to top of pageClick to jump to parent topicSelecting an HTML Data Source

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

When you use HTML as the data source for a pagelet, the pagelet does not provide configurable parameters that enable criteria selection. Consequently, there is also no end user personalization for HTML data source pagelets.

When creating an HTML data source pagelet, you skip step 3 and proceed to step 4, in which you select the pagelet display format.

Data Source

HTML Text

Enter the HTML code that you want to use as the data source for the pagelet. You can enter an HTML document or fragment. This HTML can include embedded JavaScript.

Ensure that the HTML that you enter generates content that is appropriately sized for pagelet display.

See Defining Data Types.

Click to jump to top of pageClick to jump to parent topicSelecting a Search Record Data Source

Access the Select Data Source page. Select Search Record in the Data Type field.

Search records typically return a number of columns and rows. When you select search records to be displayed on pagelets, consider the available display space on the homepage.

Data Type

Select Search Record.

Data Source

Portal Name

Select the portal in which the search record for the pagelet resides.

Content Reference

Select the content reference for the search record.

Access Type

Select the type of access for the search record data. Options are:

Basic Search Record: Select to have the search record pagelet retrieve data based on the basic search record defined in the selected portal.

CI: <component interface name>: Select when the basic search record does not provide the required functionality; for example, when security or PeopleCode considerations need to be taken into account This option is available if the selected search record has an associated component interface. Select to have the search record pagelet retrieve data by way of the component interface.

See Enterprise PeopleTools 8.45 PeopleBook: PeopleSoft Component Interfaces, “Developing the Component Interface”

Data Source Details

Inputs

Displays search record key input fields, as well as other system-required input fields that are used to derive data that is displayed on the search record pagelet.

Outputs

Displays search record key output fields, as well as other output fields for which search results are displayed on the search record pagelet. These output fields are derived from the drop-down list box fields on the search record.

If the SHOWRESULTS data source parameter field for the pagelet is set to N, the search key output fields appear as Search By drop-down list values on the pagelet.

Click to jump to top of pageClick to jump to parent topicSelecting a Navigation Collection Data Source

Access the Select Data Source page. Select Navigation Collection in the Data Type field.

The Navigation Collection that you use as the data source must have already been created using the Navigation Collections feature. However, the Navigation Collection does not need to exist in its final form. Any changes that you make to the underlying Navigation Collection used as the data source are immediately reflected on any pagelets created from that Navigation Collection.

See Using Navigation Collections.

Note. Although it is possible to create a Navigation Collection pagelet directly from the Navigation Collections feature, pagelets created using this feature cannot be maintained in Pagelet Wizard. Only Navigation Collection pagelets created specifically with Pagelet Wizard can be maintained in Pagelet Wizard.

Data Type

Select Navigation Collection.

Data Source

Portal Name

Select the portal that contains the navigation collection for the pagelet.

Collection Name

Select the name of the Navigation Collection that you want to use to create the pagelet.

Click to jump to top of pageClick to jump to parent topicStep 3: Specifying Pagelet Data Source Parameters

This section provides an overview of variables supported as data source parameters, lists common elements, and discusses how to:

Click to jump to top of pageClick to jump to parent topicUnderstanding System Variables Supported as Data Source Parameters

When you set the Usage Type field to System Variable or User Specified on the Specify Data Source Parameters page, you can enter a system variable such as %UserId, which the system substitutes at runtime with the actual value represented by the variable. The following system variables are supported as 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 end-user accessibility that you want to grant for the data source parameter field when it appears on the pagelet. Options are:

  • 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.

  • 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 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 as the usage type, click to access the Specify Data Source Parameter Values page.

See Specifying Data Source Parameter Values.

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

Page Name

Object Name

Navigation

Usage

Specify Data Source Parameters

EOPPB_WIZ_DATAPRMS

Enterprise Components, Portal Utilities, 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 required for the data to be displayed on the pagelet. For instance, when entering data source parameters for a query pagelet, you specify input data that extracts output data to the pagelet. The parameters vary depending on the data source selected on the Select Data Source page.

This page is accessible only when building a pagelet with a data source that allows modification of associated parameters. These data sources include PeopleSoft Query, search record, and Navigation Collections.

Note. This step is not applicable when creating pagelets with an HTML data source.

Specify Data Source Parameter Values

EOPPB_WIZ_PRMVALS

Click the User Values button on the Specify Data Source Parameters page.

Enter values for the end user to select from when personalizing user-specific parameters on a pagelet.

Note. This page is accessible only for data source parameters for which you have selected the User Specified usage type.

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

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

Data Source Parameters

Pagelet Wizard analyzes the selected query and retrieves a list of predefined parameters and any related prompt list values. You cannot add to the list of parameters.

Field Name

Displays the data source parameters that correspond to the query prompts associated with the selected query. Also displays the required system-supplied .MAXROWS query data source parameter that you can use to limit the amount of data returned on the pagelet.

Required

This option is selected if the data source parameter must have a value entered on the pagelet to retrieve data successfully. For example, the .MAXROWS field is required.

If this option is selected and display-only, the value is set in the application class at the application programming interface (API) level.

If you leave this option cleared, the data source parameter value can be clear at runtime, or it can be entered to refine the data selection criteria.

Reset to Default

Click to reset the values on this page to the default values specified by the query data source API.

Click to jump to top of pageClick to jump to parent topicSpecifying Search Record Data Source Parameters

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

Data Source Parameters

Pagelet Wizard analyzes the selected search record and retrieves a list of search keys required for the search record. You cannot add to the list of data source parameters.

For fields that are search keys but that are not displayed on the search prompt page or in the result set for the search record (for example, the setID, Business Unit, Operator ID, and Operclass fields), Pagelet Wizard assimilates the PeopleTools behavior and does not display the keys during design or at runtime. It simply binds in the same values that PeopleTools would use. These values are derived from the default field values established by the user in the PSRECDEFN table.

Field Name

Displays the data source parameters that correspond to the search keys required for the search record. Also displays the required system-supplied .MAXROWS and SHOWRESULTS search record data source parameters.

Use the .MAXROWS field to limit the amount of data returned to the pagelet.

Use the SHOWRESULTS field to determine whether search results appear on the pagelet.

If this field value is set to Y, search record results appear directly on the pagelet with links to transaction data.

In addition, if this field value is set to Y, the search results grid displays results based on the supplied data source parameter default key field values. If no defaults are supplied, all results appear, up to the .MAXROWS value defined for the pagelet.

If this field value is set to N, the pagelet displays a search prompt for the selected search record. The Search By drop-down list values available on the pagelet are the search keys for the search record.

If data source parameter default key field values have been defined, when the pagelet is initially accessed, the default value appears in the begins with pagelet field.

Required

This option is selected if the data source parameter must have a value entered on the pagelet to retrieve data successfully. For example, the .MAXROWS and SHOWRESULTS fields are required.

If this option is selected and display-only, the value is set in the application class at the API level.

Search key values are not required because the search record pagelet supports partially populated keys so that you can define the pagelet to return all possible results.

If you leave this option clear, the data source parameter value can be blank at runtime, or the value can be provided to refine the data selection criteria.

Reset to Default

Click to reset the values on this page to the default values specified by the search record data source API.

Click to jump to top of pageClick to jump to parent topicSpecifying Navigation Collection Data Source Parameters

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

Data Source Parameters

Pagelet Wizard analyzes the selected query and retrieves a list of predefined parameters and any related prompt list values. You cannot add to the list of parameters.

Field Name

Displays the following data source parameters required by the Navigation Collection data source.

.INCLUDECHILDREN: Determines whether the pagelet displays Navigation Collection child links.

.MAXCHILDLINKS: If the pagelet is defined to display child links, determines the maximum number of Navigation Collection child links to display.

Required

This option is selected if the data source parameter must contain a value on the pagelet to retrieve data successfully. For example, the .INCLUDECHILDREN field is required.

If this option is selected and display-only, the value is set in the application class at the API level.

Reset to Default

Click to reset the values on this page to the default values specified by the Navigation Collection data source API.

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

Access the Specify Data Source Parameter Values page.

Parameter Name

Displays the data source parameter for which you selected User Specified as the usage type on the Specify Data Source Parameters page.

Parameter Value

Enter values from which you want pagelet users to be able to select when personalizing user-specifiable parameters on a pagelet.

Default

Selecting a default value overrides the default value you defined for the data source parameter on the Specify Data Source Parameters page.

Click to jump to top of pageClick 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

EOPPB_WIZ_DISPFRMT

Enterprise Components, Portal Utilities, 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.

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 available for selection on this page depend on the data source you have selected on the Select Data Source page. Options are:

Table

Available for query data source pagelets.

List

Available for query data source pagelets.

Chart

Available for query data source pagelets.

Menu

Available for Navigation Collection data source pagelets.

Search List

Available for search record data source pagelets.

Passthru

Available for HTML and query data source pagelets.

Custom

Available for HTML, Navigation Collection, query, and search record data source pagelets.

See Also

Step 5: Specifying Pagelet Display Options

Click to jump to top of pageClick to jump to parent topicStep 5: Specifying Pagelet Display Options

This section lists common elements and discusses how to:

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

This section discusses common elements used in this section.

Click the List Field Link Options button to access the Link Details page, where you can enter values that link elements in the pagelet to pages (components or URLs) that provide details about the data.

See Specifying Data Link Details.

Additional Text

The Additional Text group box contains options to add headers, footers, opening text, and closing text to a pagelet.

Header

Select a pagelet header. You can select from headers that are defined on the Define Header page.

See Defining Headers.

Opening Text

Select the type of opening text that you want to appear on the pagelet. Options are:

Freeform Text/HTML: The Text field appears. Enter the opening text that appears on the pagelet.

Message Catalog Entry: The Message Set and Number fields appear. Select the message set and message number that appear as opening text on the pagelet. You can select from the messages defined in the database.

See Enterprise PeopleTools 8.45 PeopleBook: System and Server Administration, “Using PeopleTools Utilities,” Message Catalog

Show “View Source Data” Link

Displays when PS Query is selected as the data source for a pagelet. Select to display the Full Query Results link on the pagelet. Click the Full Query Results link to access the full results of the query used for the pagelet.

Closing Text

Select the type of closing text that appears on the pagelet. Options are:

Freeform Text/HTML: The Text field appears. Enter the closing text that appears on the pagelet.

Message Catalog Entry: The Message Set and Number fields appear. Select the message set and message number that appear as closing text on the pagelet. You can select from the messages defined in the database.

See Enterprise PeopleTools 8.45 PeopleBook: System and Server Administration, “Using PeopleTools Utilities,” Message Catalog

Footer

Select a pagelet footer. You can select from footers that are defined on the Define Footer page.

See Defining Footers.

Customization

The Customization group box contains the option to customize your pagelet.

Customize

Click to customize the pagelet by applying a custom XSL template, or by directly editing the XSL resulting from the pagelet display options you have defined so far. When you click Customize, you switch from a non-custom display format selected on the Select Display Format page, to a custom format of your definition.

The XSL field is populated based upon preexisting display options set for the original non-custom display format. You can edit the XSL directly in the XSL field and retain as much of the original non-custom display options as you wish. Keep in mind that if you apply an XSL template using the XSL Template field, the XSL is regenerated based on the selected template and original non-custom display options you have set may be overridden. Making any edits to the XSL, either directly or by assigning a template, disconnects the pagelet definition from the original non-custom display format.

When you click the Customize button, the current pagelet definition is saved for restoration purposes. You can revert to this pre-customization pagelet definition by clicking the Undo Customizations button.

Clicking this button assigns your pagelet to the Custom design format on the Select Display Format page - Step 4. When you return to the Specify Publishing Options page - Step 5, you will access the version of the page for the Custom display format.

See Specifying Custom 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 (table format)

EOPPB_WIZ_DISP_TBL

Enterprise Components, Portal Utilities, Pagelet Wizard, Pagelet Wizard

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

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

Specify Display Options (passthru format)

EOPPB_WIZ_DISP_PST

Enterprise Components, Portal Utilities, Pagelet Wizard, Pagelet Wizard

Select the 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 (search list format)

EOPPB_WIZ_DISP_SRC

Enterprise Components, Portal Utilities, Pagelet Wizard, Pagelet Wizard

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

Enter pagelet search list formatting details and header and footer options. Preview the pagelet.

Specify Display Options (menu format)

EOPPB_WIZ_DISP_NAV

Enterprise Components, Portal Utilities, 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 pagelet menu formatting details and header and footer options. Preview the pagelet.

Specify Display Options (list format)

EOPPB_WIZ_DISP_LST

Enterprise Components, Portal Utilities, Pagelet Wizard, Pagelet Wizard

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

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

Specify Display Options (chart format)

EOPPB_WIZ_DISP_CHT

Enterprise Components, Portal Utilities, Pagelet Wizard, Pagelet Wizard

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

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

Specify Display Options (custom format)

EOPPB_WIZ_DISP_CUS

Enterprise Components, Portal Utilities, 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 pagelet custom formatting details and header and footer options. Preview the pagelet.

Link Details

EOPPB_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.

Click to jump to top of pageClick to jump to parent topicSpecifying Table Display Options

Access the Specify Display Options page after selecting the Table option on the Select Display Format page.

Table Options

Select options that will display grid lines, alternate row shading, and row numbers on the table-formatted pagelet.

Columns

Column Name

Displays possible column headings provided by the selected data source parameters. Use the drop-down list boxes to set the order in which the columns appear on the table-formatted pagelet. Use the Add button or the Delete button to add or remove columns.

Alignment

Specify the alignment of the text in the column. Options are Center, Left, and Right.

Pagelet Preview

Displays a preview of the pagelet based on most display option settings on this page.

Click to jump to top of pageClick to jump to parent topicSpecifying Passthru Display Options

Access the Specify Display Options page after selecting the Passthru option on the Select Display Format page.

Pagelet Preview

Displays a preview of the pagelet based on most display option settings on this page.

Click to jump to top of pageClick to jump to parent topicSpecifying Search List Display Options

Access the Specify Display Options page after selecting the Search List option on the Select Display Format page.

Pagelet Preview

Displays a preview of the pagelet based on most display option settings on this page.

Click to jump to top of pageClick to jump to parent topicSpecifying Menu Display Options

Access the Specify Display Options page after selecting the Menu option on the Select Display Format page.

Menu Options

Top Level Title

Select to have the menu pagelet display the top-level title defined in the underlying Navigation Collection.

Top Level Description

Select to have the menu pagelet display the top-level description defined in the underlying Navigation Collection.

Maximum Columns

Select the number of columns to display (options are 1 through 4) on the Navigation Collection menu pagelet. Narrow pagelets display contents in one column. Wide pagelets can display contents in up to four columns.

See Pagelet Wizard Display Sizes.

Display Order

Select the order in which you want Navigation Collection elements to appear on the menu pagelet. When you create a Navigation Collection, you define the order of folders and links in the collection using options in the Placement Properties group box on the Edit Folder page and the Edit Link page. Options are:

Left to Right: Select to display the elements from left to right on the menu pagelet.

Top to Bottom. Select to display the elements from top to bottom on the menu pagelet.

Alternate Row Shading

Select to display alternate row shading on the menu-formatted pagelet.

Parent Images

Select the type of images you want to display for parent-level Navigation Collection elements (folders) on the menu pagelet. When you create a Navigation Collection, the collection definition includes specified large and small images that appear for parent-level elements in the Navigation Collection. Options are:

Large Images: Select to have the menu pagelet display the large folder image defined for the underlying Navigation Collection.

No Images: Select to prevent parent-level images from appearing on the menu pagelet.

Small Images: Select to have the menu pagelet display the small folder image defined for the underlying Navigation Collection.

Parent Descriptions

Select to have the menu pagelet display parent-level folder descriptions defined in the underlying Navigation Collection.

Child Display Type

Select the display type for child links on the menu pagelet. Options are:

Comma Delimited: Displays the maximum number of child links separated by commas.

List with Images: Displays the maximum number of child links accompanied by icons. This icon is the small content image selected in the Navigation Collection system or registry options for the underlying Navigation Collection.

Simple List: Displays the maximum number of child links, one child link per row. No bullets, numbers, or icons appear in the list.

Pagelet Preview

Displays a preview of the pagelet based on most display option settings on this page.

See Also

Using Navigation Collections

Click to jump to top of pageClick to jump to parent topicSpecifying List Display Options

Access the Specify Display Options page after selecting the List option on the Select Display Format page.

List Options

List Display Type

Select the list format for displaying query results on the list pagelet. Options are:

Bulleted List: Displays query results in a bulleted list.

Numbered List: Displays query results in a numbered list.

Simple List: Displays query results in a list with no bullets or numbers.

List Field Name

Select the field whose values are displayed in the list on the pagelet.

Alternate-Row Shading

Select to use alternate-row shading on the list pagelet.

Pagelet Preview

Displays a preview of the pagelet based on most display option settings on this page.

Click to jump to top of pageClick to jump to parent topicSpecifying Chart Display Options

Access the Specify Display Options page after selecting the Chart option on the Select Display Format page.

To generate a chart pagelet using Pagelet Wizard, you include information related to the chart’s x axis and y axis. The y axis is the axis that contains the query data. In most charts, the y axis is the vertical axis. However, in a horizontal bar chart, the y axis is the horizontal axis. The x axis is the axis against which the y-axis data is measured.

For example, a chart pagelet may have a y axis that displays the number of times that a pagelet has been accessed. This access count can be displayed against an x axis that shows the name of the pagelet accessed.

Chart Options

Chart Type

Select the type of chart used to display the query results on the pagelet. Available chart formats are those supported by the PeopleCode Chart class.

See Enterprise PeopleTools 8.45 PeopleBook: PeopleCode API Reference, “Chart Class,” Understanding the Chart Class

X-Axis Field

Select the field used to derive x-axis values for the chart. Available values are determined by the data source’s output fields.

X-Axis Label

Select the field you want to use to derive the labels for the x-axis values for the chart. Available values are determined by the data source’s output fields.

X Label Angle

Enter the angle at which you want the text of the x-axis labels to appear along the x-axis on the pagelet.

Y Axis Data

Select to indicate whether the y-axis data is stored in rows or columns in the selected query. This enables the Pagelet Wizard to read query data and generate the chart.

in Columns: Select if the y-axis data is stored in columns.

For example, you might have query data stored as shown below:

Quarter

Revenue

Profit

Q1

3562

1010

Q2

3473

1290

Q3

4568

1490

Q4

5668

2769

 

Y Axis Data (continued)

in Rows: Select if the y-axis data to be used to generate the chart is stored in rows.

For example, you might have query data stored as shown below:

Quarter

Type

Value

Q1

Revenue

3562

Q1

Profit

1010

Q2

Revenue

3473

Q2

Profit

1290

Q3

Revenue

4568

Q3

Profit

1490

Q4

Revenue

5668

Q4

Profit

2769

 

Y-Axis Field

Select the field that you want to use to derive y-axis values for the chart. Available values are determined by the data source’s output fields.

If you set the Y Axis Data field to in Columns, you can select up to four y-axis fields to create a chart pagelet that displays data for multiple fields. For example, if you track sales figures for several departments over multiple years, you can assign each department its own y-axis value.

Color

Select the color for the y-axis data. If you select multiple y-axis fields, selecting a different color for each field improves pagelet usability. This option is available only if the y-axis data is in stored columns.

Y-Axis Series

This field is available if the Y Axis Data field is set to in Rows. Select the field used to generate a color-coded series of y-axis data. Colors are automatically assigned, but you can override them by supplying custom XSL.

Advanced Options

3D Angle

If you select a 3D chart type, enter the angle at which you want the 3D data to be displayed.

Legend

Select the area of the pagelet where the chart legend appears. Options are:

  • Bottom

  • Left

  • None

  • Right

  • Top

Height

Enter the height of the chart in pixels.

Width

Enter the width of the chart in pixels.

If you do not enter height or width values, the chart is automatically sized based on the pagelet position and size (narrow or wide).

See Pagelet Wizard Display Sizes.

Overlay Fields

Select up to three fields for which you want to display data using a line drawn over the background chart. Overlays apply to all charts types except 2D and 3D pie charts.

Pagelet Preview

Displays a preview of the pagelet based on most display option settings on this page.

Click to jump to top of pageClick to jump to parent topicSpecifying Custom Display Options

Access the Specify Display Options page after selecting the Custom option on the Select Display Format page.

Custom Options

XSL Template

Select the XSL template used to generate the custom format pagelet. Available XSL templates are defined on the Define XSL page. Only XSL templates defined for the selected data source are displayed.

See Defining Pagelet Wizard XSL Prototypes.

Generate

Click to generate custom XSL for the pagelet based on the selected XSL template. This XSL is displayed in the XSL text box and is applied to the XML in the XML text box to generate the pagelet preview.

Pagelet Preview

Displays a preview of the pagelet based on most display option settings on this page.

Click to jump to top of pageClick to jump to parent topicSpecifying Data Link Details

Access the Link Details page.

You can access this page for field or column names that are displayed on the Specify Display Options page when you access the page for the table, list, and chart formats. Entering information on the Link Details page enables you to link data that appears on the pagelet to additional information.

Pagelet Wizard builds the column data link as follows using link path, parameter, and suffix values:

http://baseURL/linkpath1/linkpath2/…/linkpathN/?parm1=val1&parm2=val2&…&parmN=valNlinksuffix

Link Type

Select the type of link destination to define for the data. Options are:

Content Reference: Select to define data links to a content reference.

External URL: Select to define data links to an external URL.

Portal Name

Select the portal in which the content reference resides. This field appears when you select Content Reference as the link type.

Content Reference

Select the content reference to which the link points. This field appears when you select Content Reference as the link type.

Base URL

Enter the URL to which you want the link to point. This field appears when you select External URL as the link type. Options are:

Specified by Data: Select to have the system dynamically generate the link information based on the selected data field.

Fixed Text Entry: Select to hardcode the link information by entering a value.

Link Paths

Path Source

Select the method used to determine the link destination. Options are:

Specified by Data: Select to have the system dynamically generate the link information based on the selected data field.

Fixed Text Entry: Select to hardcode the link information by entering a value.

Link Path

This field appears if you select Specified by Data as the path source. Select the data field used to generate the link.

Parameter Value

This field appears if you select Fixed Text Entry as the path source. Enter a parameter value.

Link Parameters

Name Source

Select the method used to determine the link destination. Options are:

Specified by Data: Select to have the system dynamically generate the link information based on the selected data field.

Fixed Text Entry: Select to hardcode the link information by entering a value.

Parameter Name

Enter a value that corresponds to the value in the Parameter Value field.

Parameter Value

If you have selected Specified by Data as the name source, select a data field.

If you have selected Fixed Text Entry as the name source, enter a parameter value.

Link Suffix

Select the method used to determine the link destination.

Specified by Data: Select to have the system dynamically generate the link information based on the selected data field.

Fixed Text Entry: Select to hardcode the link information by entering a value.

If you have selected Specified by Data as the link suffix, select a data field.

If you have selected Fixed Text Entryas the link suffix, enter a parameter value.

Link Behavior

Options are:

Display in portal: Select if you want the content accessed by the data link to be displayed within the portal.

Open in a new window: Select if you want the content accessed by the data link to be displayed in a new window.

Reset to Default

Click to clear the values on this page and remove the link.

Click to jump to top of pageClick to jump to parent topicStep 6: Specifying Pagelet Publication Options

In this section, we discuss:

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

This section discusses common elements used in this section.

Enable Caching

Select to enable caching for the pagelet. Enabling caching improves performance because once the pagelet is stored in the cache memory using one of the caching types you define in the Caching Options group box, the next time the pagelet is accessed, it is retrieved and displayed from cache memory.

Caching Options

Entering caching options creates a content reference attribute for the new pagelet content reference. The content reference attribute contains the following information:

Once the pagelet is saved and registered, you can use Pagelet Wizard to alter caching options in the same way you can alter other registration information. However, altering caching option values will require that you re-register the pagelet.

See Enterprise PeopleTools 8.45 PeopleBook: Internet Technology, “Administering Portals,” Defining Content References

Caching Type

Private. Select to enable user-based caching. For example, pagelet caching is stored per user. If user A accesses the pagelet, only user A will access the pagelet from the cache.

Public. Select to enable application-based caching. For example, pagelet caching is stored per web server instance. If a user accesses the pagelet using web server instance 1, only other users accessing the pagelets using web server instance 1 will access the pagelet from the cache.

Role. Select to enable role-based caching. For example, pagelet caching is stored per role combination. If user A has roles 1, 2, and 3, only another user with all roles 1, 2, and 3 will access the pagelet from the cache.

Minutes to Cache

Enter the number of minutes for which you want the pagelet to remain in the cache. If you do not enter a value, a default value of 30 minutes is used.

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

EOPPB_WIZ_PUBOPT

Enterprise Components, Portal Utilities, 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 and security details, and register the pagelet.

Pagelet Creation Confirmed

EOPPB_WIZ_FINISH

Click the Finish button on the Specify Publishing Options page.

Confirm that the creation of the pagelet is complete.

Click to jump to top of pageClick to jump to parent topicSpecifying Publication Options

Access the Specify Publishing Options page.

When you access a pagelet definition on this page, the pagelet’s registration option (Homepage Pagelet or Template Pagelet) is reflected only as it exists in the portal you are currently logged in to. Select the registration option to publish the pagelet to the portal where you are currently logged in.

For example, if you access ABC123 pagelet, the Homepage Pagelet option is selected only if the portal where you are currently logged in contains a CREF for the ABC123 pagelet. If there is no CREF for this pagelet in the current portal, even if there is a CREF for this pagelet in another portal on the same database, the Homepage Pagelet option will be clear. Select the Homepage Pagelet option to publish the pagelet to the current portal.

Homepage Pagelet

Select this option to publish the pagelet as a homepage pagelet that can be added to a user’s homepage.

Note. The option to use Pagelet Wizard pagelets published as homepage pagelets is available if you have licensed PeopleSoft Enterprise Portal or a Portal Pack.

Folder

Select the pagelet folder to which you want to assign the pagelet. The pagelet appears in this pagelet category on the Personalize Content page, which users access to add or remove pagelets from their homepages.

See Enterprise PeopleTools 8.45 PeopleBook: Using PeopleSoft Applications, “Setting User Preferences,” Personalizing Content

Advanced Options

Hide Pagelet Title Bar

Select to display the pagelet without a title bar.

Hide Pagelet Border

Select to display the pagelet without a border.

Requires Personalization

Select to specify that the pagelet requires end-user personalization. The pagelet displays a personalization button that accesses a personalization page. The pagelet requires that the end user access the personalization page to personalize and specify data source parameter values before it displays data. A message notifying the user of the personalization requirement appears on the pagelet. If this option is clear, the pagelet displays data using the default data source parameter values provided.

Template Pagelet

Select this option to publish the pagelet as a template pagelet that can be added to a PeopleSoft template. When used in conjunction with Intelligent Context Manager™, template pagelets can extract and leverage keys specified by the target transaction for the template.

Note. The option to use Pagelet Wizard pagelets published as template pagelets is available if you have licensed PeopleSoft Enterprise Portal or a Portal Pack.

Advanced Options

Behavior if Keys not Present

Select one of the following options to indicate how pagelet data is displayed if target transaction keys are not present to populate the pagelet’s parameters. Options are:

Use Specified Defaults: If target transaction keys are not present, the pagelet will display data using the defaults specified in Step 3: Specify Pagelet Data Source Parameters.

Display Message: If target transaction keys are not present, the pagelet does not display data but instead displays a message.

Hide Pagelet: If target transaction keys are not present, the pagelet does not appear.

Pagelet Security

If you change any pagelet security options for a registered pagelet, you must re-register the pagelet.

Security Type

Select the type of security that you want to assign to the pagelet. Options are:

Public Access: Select to designate that all users can access the pagelet.

Select Security Access: Select to assign role- or permission list-based security to the pagelet. The Selected Security scroll area appears.

Author Access

Select to provide the pagelet author with access to the pagelet regardless of any security restrictions assigned to the pagelet. This access is granted based on the author’s user ID.

Selected Security

Type

Select the type of security assigned to the pagelet. Specified security is applied to the content reference entries when the pagelets are registered. Options are:

Permission List: Select to assign permission list-based security to the pagelet. Select a permission list in the Name field.

Role: Select to assign role-based security to the pagelet. Select a role in the Name field.

Finish

Click to complete the creation of the pagelet. The Pagelet Creation Confirmed page appears.

After you click the Finish button for a pagelet, the button no longer appears when you access the pagelet definition in Pagelet Wizard. Once a pagelet has been created, you can apply any modifications to the pagelet definition by clicking the Save button.