Setting Up Pagelet Wizard Options

This chapter discusses how to:

Define Pagelet Wizard transformation types, display formats, and data types.
Define Pagelet Wizard Extensible Stylesheet Language (XSL) prototypes.
Define Pagelet Wizard headers and footers.
Define Pagelet Wizard pagelet categories.

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

Defining Pagelet Wizard Transformation Types, Display Formats, and Data Types

This section discusses how to:

Define transformation types.
Define display formats.
Define data types.

Pages Used to Define Pagelet Wizard Transformation Types, Display Formats, and Data Types

Page Name	Object Name	Navigation	Usage
Define Transform Types	EOPPB_TXFRMTYP_MTC	Enterprise Components, Portal Utilities, Pagelet Wizard, Define Transform Types	Define transformation methods that can be applied to Pagelet Wizard pagelet content.
Define Display Formats	EOPPB_DISPFRMT_MTC	Enterprise Components, Portal Utilities, Pagelet Wizard, Define Display Formats	Define display formats that can be used to format Pagelet Wizard pagelet content.
Define Data Types	EOPPB_DATATYPE_MTC	Enterprise Components, Portal Utilities, Pagelet Wizard, Define Data Types	Define data types that can be used to supply Pagelet Wizard with pagelet content.
Document Type Definition (DTD)	EOPPB_DATADTD_SBP	Click the View Document Type Definition (DTD) link on the Define Data Types page.	Access the DTD that describes the XML generated by the selected data type.

Defining Transformation Types

Access the Define Transform Types page.

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

PASSTHRU
XSL

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

This Define Transform Types page enables you to build your own transformation types. For example, you could create a new transformation type called ABC123. You would then extend Pagelet Wizard to perform ABC123 transformations by building a supporting application class and registering it as a transformation type. You could then create builders for assembling pagelet displays that create ABC123 transformation definitions.

See Pagelet Wizard Display Formats.

Transformation Type	Enter the internal name that you want to assign to the transformation type.
Description	For reference purposes only, enter a short description of the transformation type.
Long Description	For reference purposes only, enter a more detailed description of the transformation type.

Supporting Application Class

The application class specified here refers to the PeopleCode that implements the transformation type.

Package Name	Enter the application class package name that you want to use for the transformation type.
Path	Enter the application class path that you want to use for the transformation type.
Application Class ID	Enter the application class ID that you want to use for the transformation type. The class must exist in the application package name that you have specified.

Defining Display Formats

Access the Define Display Formats page.

A display format performs the following tasks:

Defines a TransformBuilder, which is code that builds a particular type of display format (chart, menu, list, and so forth).
Identifies the proper transformation to use with pagelets created with a specific display format builder.

For example, the chart display format defines the code that builds charts, and it specifies that Pagelet Wizard must use the XSL transformer for pagelets created using this display format.

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

CHART
CUSTOM
LIST
MENU
PASSTHRU
SEARCHREC
TABLE

Warning! Do not alter delivered field values for these display formats.

See Pagelet Wizard Display Formats.

Display Format ID	Enter the name that you want to assign to the display format.
Description	Enter a short description of the display format. This short description appears as the display format name value on the Select Display Format page in Pagelet Wizard.
Active	Select to activate the display format and make it a selectable value in Pagelet Wizard. If you deactivate a display format, the display format is no longer available for selection on the Select Display Format page when accessed for associated data types. Existing pagelets that have been created using a deactivated display format are unaffected; however, you can no longer use Pagelet Wizard to change the display settings for those pagelets.
Long Description	Enter a detailed description of the display format. This long description appears as the display format description on the Select Display Format page in Pagelet Wizard.
Sort Order	Enter a numeric value to specify the order in which you want the display format to appear as a selectable field value relative to other display formats on the Select Display Format page. See Step 4: Selecting a Pagelet Display Format.
Image Name	Select the image that you want to appear with the display format name and description on the Select Display Format page.
Transformation Type	Display formats use a transformation technology. Select the transformation type that you want to use for the display format. Available transformation types are defined on the Define Transform Types page. See Defining Transformation Types.

Pagelet Wizard Page

Page Name

Enter the object name of the page on which you want to be able to define display options for this display format.

Supporting Application Class

The application class specified here refers to the PeopleCode that implements the display format. This code is the builder that creates the definition that Pagelet Wizard uses (along with the transformer) to display the pagelet.

Package Name	Enter the application class package name to use for the display format.
Path	Enter the application class path to use for the display format.
Application Class ID	Enter the application class ID to use for the display format. The class must exist in the application package name that you specify.

Defining Data Types

Access the Define Data Types page.

Pagelet Wizard is delivered with the following data type definitions to support their associated data sources:

HTML
NAVIGATION COLLECTION
PSQUERY
SEARCHREC

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

See Pagelet Wizard Data Sources.

Data Type	Enter the internal name that you want to assign to the data type.
Description	Enter a short description of the data type. This short description appears as the prompt list value when you select data sources in Pagelet Wizard.
Active	Select activate the data type and make it a selectable value in Pagelet Wizard. If you deactivate a data type, the data type is no longer available for selection on the Select Data Source page. If you deactivate a data type that is in use, associated pagelets do not display data. The pagelets display an error message instead.
Description	Enter a detailed description of the data type. This long description appears as the data type description on the Select Data Source page in Pagelet Wizard.

Supporting Application Class

The application class specified here refers to the PeopleCode that implements the data type. This is the code that Pagelet Wizard calls to retrieve the data for the pagelet.

Package Name	Enter the application class package name that you want to use for the data type.
Path	Enter the application class path that you want to use for the data type.
Application Class ID	Enter the application class ID that you want to use for the data type. The class must exist in the application package name that you specify.

Display Formats to use with this Data Type

Display Format ID

Enter the display formats that are supported by the data type. You can select from existing display formats defined on the Define Display Formats page.

See Defining Display Formats.

View Document Type Definition (DTD)

Click to access the Document Type Definition (DTD) page, where you can access the DTD that describes the XML generated by the selected data type.

Defining Pagelet Wizard XSL Prototypes

This section discusses how to define XSL prototypes for use in building Pagelet Wizard pagelets.

Page Used to Define Pagelet Wizard XSL Prototypes

Page Name	Object Name	Navigation	Usage
Define XSL	EOPPB_XSLPROT_MTCE	Enterprise Components, Portal Utilities, Pagelet Wizard, Define XSL	Create custom XSL definitions for use with Pagelet Wizard.

Defining XSL Prototypes

Access the Define XSL page.

Pagelet Wizard is delivered with the following XSL prototypes to support their associated data sources and display formats:

LIST_QUERY
NUMBERED_LIST_QUERY
TABLE_QUERY

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

XSL Prototype ID	Enter an ID for the XSL prototype.
Description	Enter a description of the XSL prototype. The text that you enter here appears as available XSL template field values on the Specify Display Options page when you create a custom display format pagelet. See Specifying Custom Display Options.
Active	Select to activate the XSL prototype and make it an available XSL template field value on the Specify Display Options page for custom display format pagelets. If you deactivate an XSL prototype, the prototype is no longer available for selection on the Specify Display Options page for the custom display format. Existing pagelets that have been created using the deactivated XSL prototype are unaffected.
Long Description	For reference purposes only, enter a long description of the XSL prototype.
Data Type	Select the applicable data type for the XSL prototype. You can assign only one data type per XSL prototype.
Define XSL	Enter XSL code for formatting pagelet XML data in the desired pagelet format.

Defining Pagelet Wizard Headers and Footers

This section discusses how to:

Define headers.
Define header images.
Define footers.
Define footer images.

Pages Used to Define Pagelet Wizard Headers and Footers

Page Name	Object Name	Navigation	Usage
Define Header	EOPPB_HDR_MTCE	Enterprise Components, Portal Utilities, 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	EOPPB_HDR_IMAGE	Enterprise Components, Portal Utilities, 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	EOPPB_HDR_PREVIEW	Enterprise Components, Portal Utilities, 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	EOPPB_FTR_MTCE	Enterprise Components, Portal Utilities, 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	EOPPB_FTR_IMAGE	Enterprise Components, Portal Utilities, Pagelet Wizard, Define Footers, Specify Image	Specify an image that you want to appear on the pagelet footer. Specify image properties.
Define Footers - Preview	EOPPB_FTR_PREVIEW	Enterprise Components, Portal Utilities, 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.

Defining Headers

Access the Define Header page.

Pagelet Header

Header ID	Enter an ID for the pagelet header.
Description	Enter a description of the pagelet header. The text that you enter here appears as the selectable field value in the Header field when users assign headers to pagelets on the Specify Display Options page.
Active	Select to activate the pagelet header and make it a selectable field value in the Header field on the Specify Display Options page. If you deactivate a header that is in use, the header no longer appears on associated pagelets. In addition, the header is not be available for selection on the Specify Display Options page.
Long Description	For reference purposes only, enter a long description of the pagelet header.
HTML Area	Enter the HTML code that you want to use to generate the pagelet header. You can enter both HTML text and image references. Alternatively, you can include an image by selecting it on the Specify Image page.
Delete Header	Click to delete the pagelet header design.

Defining Header Images

Access the Define Headers - Specify Image page.

Header Image

Image Source	Select the image source. Options are: System Catalog. Select to specify an image from the PeopleTools system image catalog. External Source. Select to specify an image from a source external to the PeopleTools system image catalog.
Image Name	If you select the System Catalog image source, click the Search button to access a list of existing images. If you select the External Source image source, enter a URL for the desired image file. All image types are supported. Ensure that the location of the image provides reliable access.
Alignment	Select the alignment of the image. Options are: Left: Select to align the image with the left margin of the pagelet. Right: Select to align the image with the right margin of the pagelet.
Height	Enter the image height in pixels if the image needs to be resized. If you enter an image height, the system adjusts the image width to fit the image height.
Width	Enter the image width in pixels if the image needs to be resized. If you enter an image width, the system adjusts the image height to fit the image width.
Float Over Text	Enter text that you want to appear when the user moves the cursor over the image.

Defining Footers

Access the Define Footer page.

Pagelet Footer

Footer ID	Enter an ID for the pagelet footer.
Description	Enter a description of the pagelet footer. The text that you enter here appears as the selectable field value in the Footer field when users assign footers to pagelets on the Specify Display Options page.
Active	Select to activate the pagelet footer and make it a selectable field value in the Footer field on the Specify Display Options page. If you deactivate a footer that is in use, the footer no longer appears on associated pagelets. In addition, the footer is not be available for selection on the Specify Display Options page.
Long Description	For reference purposes only, enter a long description of the pagelet footer.
HTML Area	Enter that HTML code that you want to use to generate the pagelet footer. You can enter both HTML text and image references. Alternatively, you can include an image by selecting it on the Specify Image page.
Delete Footer	Click to delete the pagelet footer design.

Defining Footer Images

Access the Define Footers - Specify Image page.

Footer Image

Image Source	Select the image source. Options are: System Catalog: Select to specify an image from the PeopleTools system image catalog. External Source: Select to specify an image from a source external to the PeopleTools system image catalog.
Image Name	If you select System Catalog as the image source, click the Search button to access a list of existing images. If you select External Source as the image source, enter a URL for the desired image file. All image types are supported. Ensure that the location of the image provides reliable access.
Alignment	Select the alignment of the image. Options are: Left: Select to align the image with the left margin of the pagelet. Right: Select to align the image with the right margin of the pagelet.
Height	Enter the image height in pixels if the image needs to be resized. If you enter an image height, the system adjusts the image width to fit the image height.
Width	Enter the image width in pixels if the image needs to be resized. If you enter an image width, the system adjusts the image height to fit the image width.
Float Over Text	Enter text that you want to appear when the user moves the cursor over the image.

Defining Pagelet Wizard Pagelet Categories

This section discusses how to define Pagelet Wizard pagelet categories.

Page Used to Define Pagelet Wizard Pagelet Categories

Page Name	Object Name	Navigation	Usage
Define Categories	EOPPB_PGLTCATG_MTC	Enterprise Components, Portal Utilities, Pagelet Wizard, Define Categories	Define categories used to organize pagelets created using Pagelet Wizard.

Defining Pagelet Categories

Access the Define Categories page.

Category ID

Enter a Pagelet Wizard pagelet category ID. 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.

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 your pagelets by pagelet type.

Description

Enter a description of the pagelet category. The text that you enter here appears as a field value in the Category ID field when users assign pagelets to categories on the Specify Pagelet Information page.

Active

Select to activate the pagelet category and make it a selectable field value in the Category ID field on the Specify Pagelet Information page.

If you deactivate a category, the category is no longer available for selection on the Specify Pagelet Information page. Existing pagelets that have been created using the deactivated category are unaffected.

Long Description

For reference purposes only, enter a long description of the pagelet category.

Delete Category

Click to delete a pagelet category. You are prompted to confirm the deletion.

If you delete a category, the category is no longer available for selection on the Specify Pagelet Information page. Existing pagelets that have been created using the deactivated category still appear, but the pagelet category is removed from the pagelet definition in Pagelet Wizard.

Category ID	Enter a Pagelet Wizard pagelet category ID. 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. 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 your pagelets by pagelet type.
Description	Enter a description of the pagelet category. The text that you enter here appears as a field value in the Category ID field when users assign pagelets to categories on the Specify Pagelet Information page.
Active	Select to activate the pagelet category and make it a selectable field value in the Category ID field on the Specify Pagelet Information page. If you deactivate a category, the category is no longer available for selection on the Specify Pagelet Information page. Existing pagelets that have been created using the deactivated category are unaffected.
Long Description	For reference purposes only, enter a long description of the pagelet category.
Delete Category	Click to delete a pagelet category. You are prompted to confirm the deletion. If you delete a category, the category is no longer available for selection on the Specify Pagelet Information page. Existing pagelets that have been created using the deactivated category still appear, but the pagelet category is removed from the pagelet definition in Pagelet Wizard.