Publishing a Folder or Content Item as a Pagelet

This section discusses how to:

  • Publish a pagelet from a folder or content item.

  • Publish a folder or content item from Pagelet Wizard.

  • Edit a published pagelet.

  • Publish a pagelet to multiple portals.

Note: When a content item is published as a pagelet, the Edit Content link displayed in the published pagelet will redirect the user to edit the content in the portal or site where the content resides, and not to the portal or site where the pagelet is displayed.

Access the Folder Properties - Publish Pagelet Wizard Definition page (select Content Management > Managed Content > Publish as Pagelet or Content Management > Managed Content > Browse Folders; click the Properties link; click the Publish as Pagelet link on the Folders Properties page).

Access the Text or HTML Properties - Publish Pagelet Wizard Definition page (select Content Management > Managed Content > Browse Folders; click the link for a folder to browse the folder hierarchy; click the Properties link; click the Publish as Pagelet link on the Text or HTML Properties page).

Access the File Attachment Properties - Publish Pagelet Wizard Definition page (select Content Management > Managed Content > Browse Folders; click the link for a folder to browse the folder hierarchy; click the Properties link; click the Publish as Pagelet link on the File Attachment Properties page).

Access the Web Site URL Properties - Publish Pagelet Wizard Definition page (select Content Management > Managed Content > Browse Folders; click the link for a folder to browse the folder hierarchy; click the Properties link; click the Publish as Pagelet link on the Web Site URL Properties page).

The following example demonstrates publishing a folder as a pagelet.

This example illustrates the fields and controls on the Folders Properties - Publish Pagelet Wizard Definition page.

 Folders Properties - Publish Pagelet Wizard Definition page

Note: The Folder Properties - Publish Pagelet Wizard Definition page is displayed when a folder has never been published as a pagelet. The Folders Properties - Publish as Pagelet page is displayed after a folder has been published as a pagelet.

Pagelet

The pagelet title and description from the Folder Properties page appear in the pagelet section. You may edit these two fields as necessary.

Field or Control

Description

Pagelet Title

Enter the pagelet title that will identify the pagelet.

Description

Enter a meaningful description for this pagelet.

Pagelet Folder

Select a folder to publish to. Only folders from the current site are available to select.

Pagelet Security

Select the security options for viewing the pagelet. The available options are:

  • Publish as Public, which enables all users to view the pagelet.

    Note: When publishing a content item as a pagelet, this is the only available option and it is selected by default.

  • Publish with Security Roles, which uses the roles defined on the Folder Security page when publishing the pagelet.

Note: If no roles are defined on the Folder Security page, the system automatically selects to publish the pagelet as Public.

Homepage Tabs

Use the Homepage Tabs section to define the homepage tab labels and behavior for the pagelet.

Field or Control

Description

Homepage Tab

Select the tabs that will display the pagelet.

Pagelet Behavior

Select the behavior options for the pagelet. The available options are:

  • Optional

    The pagelet will not automatically appear on the homepage. However, it is available for selection when users personalize their homepages. Do not use this setting for guest homepage pagelets because guest users do not have personalization privileges.

  • Optional-Default

    The pagelet will appear on all user homepages if they have access to the pagelet. The pagelet can be removed when users personalize their homepage. Do not use this setting for guest homepage pagelets because guest users do not have personalization privileges.

  • Required-Fixed

    The pagelet will appear on all user homepages if users have access to the pagelet. The placement of the pagelet cannot be changed, and the pagelet cannot be removed from the homepage.

  • Required

    The pagelet will appear on all user homepages if the user has access to the pagelet. The placement of the pagelet can be changed, but it cannot be removed from the homepage.

Publish

Click to display the Publish as Pagelet page, where you can review or edit the pagelet definition.

Pagelets for a folder or content item can be created and published using Pagelet Wizard and then managed from the properties page for that folder or content item. This section provides an overview of how to use Pagelet Wizard to complete the following six steps:

  • Step 1: Entering Pagelet Identifying Information.

  • Step 2: Selecting a Pagelet Data Source.

  • Step 3: Specifying Data Source Parameters.

  • Step 4: Selecting a Pagelet Display Format.

  • Step 5: Specifying Pagelet Display Options.

  • Step 6: Specifying Pagelet Publication Options.

Note: If you access Pagelet Wizard from the Go to Pagelet Wizard link, you will be modifying an existing pagelet definition. If you want to create a new pagelet definition, start from the Portal Administration or PeopleTools navigation path.

Where appropriate, this section provides details specific to using Pagelet Wizard to publish a folder or content item as a pagelet. The PeopleTools 8.53 PeopleBooks provide detailed information on using Pagelet Wizard.

See PeopleTools: PeopleTools Portal Technologies, “Using Pagelet Wizard to Create and Manage Pagelets.”

Step 1: Pagelet Wizard - Specify Pagelet Information Page

Access the Pagelet Wizard - Specify Pagelet Information page (Portal Administration > Pagelets > Pagelet Wizard > Pagelet Wizard; or click the Go to Pagelet Wizard link on the folder or content item properties Publish Pagelet Wizard Definition page).

This example illustrates the fields and controls on the Pagelet Wizard - Specify Pagelet Information page.

 Pagelet Wizard - Specify Pagelet Information page

Use the Pagelet Wizard - Specify Pagelet Information page to identify and categorize a pagelet.

See PeopleTools: PeopleTools Portal Technologies, “Using Pagelet Wizard to Create and Manage Pagelets,” Step 1: Entering Pagelet Identifying Information.

Step 2: Pagelet Wizard - Select Data Source Page

Access the Pagelet Wizard - Select Data Source page (click the Next button on the Pagelet Wizard - Specify Pagelet Information page.

Note: The fields that appear on this page depend on the Data Type value that you select.

This example shows Pagelet Wizard - Select Data Source page with Content Management data type selected for publishing a content item:

This example illustrates the fields and controls on the Pagelet Wizard - Select Data Source page (content item data type).

 Pagelet Wizard - Select Data Source page (content item data type)

Use the Pagelet Wizard - Select Data Source page to select the Pagelet Wizard data source type and to select the specific content item.

Field or Control

Description

Data Type

Use the Content Management data type (CMDATASOURCE) to make a Pagelet Wizard pagelet a publishing tool for a single piece of managed content or categorized content that is stored in content management system.

If you select the Content Management option, these fields appear: Folder ID, Content ID, and Content Path.

Note: Approved text or HTML content in the content management system can be used as base data for a Pagelet Wizard pagelet.

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.

When the content itself is not well formatted XML, Content Management data source pagelets will not be compatible with the Custom display format.

See PeopleTools: PeopleTools Portal Technologies, “Using Pagelet Wizard to Create and Manage Pagelets,” Step 2: Selecting a Pagelet Data Type.

Folder ID

Select the parent folder in which the content resides.

Content ID

Select the item of content (managed content or categorized 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.

This example shows Pagelet Wizard - Select Data Source page with Content Management Folder data type selected for publishing a folder:

This example illustrates the fields and controls on the Pagelet Wizard - Select Data Source page (content management folder data type). You can find definitions for the fields and controls later on this page.

 Pagelet Wizard - Select Data Source page (content management folder data type)

Use the Pagelet Wizard - Select Data Source page to select the Pagelet Wizard data source type and to select the specific folder.

Field or Control

Description

Data Type

Use the Content Management Folder data type (CMFOLDERDATASOURCE) to create a Pagelet Wizard pagelet that displays the content management child items (content and folders) for a given managed content or categorized content folder.

If you select the Content Management Folder option, these fields appear: Site Name, Folder ID, and Folder Title.

See, PeopleTools: Portal Technology, “Using Pagelet Wizard to Create and Manage Pagelets,” Step 2: Selecting a Pagelet Data Type.

Site Name

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

Folder ID

Select the folder that 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.

See PeopleTools: PeopleTools Portal Technologies, “Using Pagelet Wizard to Create and Manage Pagelets,” Step 2: Selecting a Pagelet Data Type.

See Understanding Managed Content.

Step 3: Specifying Data Source Parameters

Access the Pagelet Wizard - Specify Data Source Parameters page (select Content Management Folder as the data type on the Pagelet Wizard - Select Data Source page, and click the Next button).

Note: The Specify Data Source Parameters page is bypassed and is not accessible when the Content Management data type is selected for publishing a content item.

This example illustrates the fields and controls on the Pagelet Wizard - Specify Data Source Parameters page (folder data source). You can find definitions for the fields and controls later on this page.

 Pagelet Wizard - Specify Data Source Parameters page (folder data source)

Use the Pagelet Wizard - Specify Data Source Parameters page to configure the data source parameters that are required for data to be displayed in the pagelet.

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

Field or Control

Description

Field Name

Displays the name of the data source parameter.

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

  • .SHOWFEEDLINKS: Determines whether the pagelet displays feed links.

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 when it appears in the pagelet. Options are:

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

  • Context Sensitive: Select to enable Context Manager to specify a data source parameter value for this field.

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

  • Fixed: Select to enter a fixed value for the data source parameter that the 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 parameter name User. 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 parameter, the Customize button appears on the pagelet title bar.

    End users can click this button to access a personalization page, on which they can select a data source parameter value that they want to use for the pagelet. Users can select a value from a prompt, or they can manually enter their own value if no prompt values are available.

    See Publishing Action Item Pagelet Using the Wizard.

    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 then republish the pagelet.

Required

This check box is selected and disabled for parameters specified as administrator-specified, context-sensitive, fixed, and system variable; otherwise, it is selected but enabled for user-specified parameters.

Default Value

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

Note the following about default values:

  • 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 prompt values on the Pagelet Wizard - Specify Data Source Parameter Values page, that default value populates this field.

    If you select User Specified as the usage type, you can also 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 a system variable to use as the data source parameter value. You can use the Look up Value button to access a list of valid system variables.

    See PeopleTools: PeopleTools Portal Technologies, “Using Pagelet Wizard to Create and Manage Pagelets,” 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.

Values

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

See Publishing Action Item Pagelet Using the Wizard.

Text

Use the Personalization Instructions group 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.

Specifying Prompt Values for Data Source Parameters

Access the Pagelet Wizard - Specify Data Source Parameter Values page (click the Values link on the Pagelet Wizard - Specify Data Source Parameters page).

This example illustrates the fields and controls on the Pagelet Wizard - Specify Data Source Parameter Values page (folder data source). You can find definitions for the fields and controls later on this page.

 Pagelet Wizard - Specify Data Source Parameter Values page (folder data source)

Use the Pagelet Wizard - Specify Data Source Parameter Values page to specify the prompt values, which are displayed to users when they personalize the pagelet. In addition, specify the default value for the parameter.

Field or Control

Description

Parameter Value

Specify the parameter value.

Description

Provide an optional description of the parameter value.

Default

Select one value as the default value. If the parameter is required, then a default value is required; otherwise, it is optional.

See PeopleTools: PeopleTools Portal Technologies, “Using Pagelet Wizard to Create and Manage Pagelets,” Step 3: Specifying Data Source Parameters.

Step 4: Selecting a Pagelet Display Format

Access the Pagelet Wizard - Specify Display Format page by one of the following methods:

  • Selecting Content Management and a content item as the data type and clicking the Next button on the Pagelet Wizard - Select Data Source page.

  • Selecting Content Management Folder and a folder as the data type and clicking the Next button on the Pagelet Wizard - Specify Data Source Parameters page.

Note: The display formats that appear on this page depend on the data type that you selected on the Pagelet Wizard - Select Data Source page.

This example shows the Pagelet Wizard - Select Display Format page after selecting Content Management and a content item on the Pagelet Wizard - Select Data Source page:

This example illustrates the fields and controls on the Pagelet Wizard - Select Display Format page with a content item selected in the Pagelet Wizard - Select Data Source page. You can find definitions for the fields and controls later on this page.

 Pagelet Wizard - Select Display Format page with a content item selected in the Pagelet Wizard - Select Data Source page

Use the Pagelet Wizard - Select Display Format page to specify the data transformation method and display format for the pagelet.

Field or Control

Description

Passthru

Display the pagelet with no visual transformation.

Custom

Content Management data source pagelets will not be compatible with the Custom display format, when the contents are not well formatted XML. If you select the Custom option, in that case an error message appears asking you to correct the problem before continuing.

This example shows the Pagelet Wizard - Select Display Format page with Content Management Folder data type selected in the Pagelet Wizard - Select Data Source page:

This example illustrates the fields and controls on the Pagelet Wizard - Select Display Format page with a folder selected in the Pagelet Wizard - Select Data Source page.

 Pagelet Wizard - Select Display Format page with a folder selected in the Pagelet Wizard - Select Data Source page

Field or Control

Description

Menu

Select to display the pagelet as a categorized tree or list-based navigation menu.

Custom

Select to specify a custom display transformation (XSL template) for your pagelet.

See PeopleTools: PeopleTools Portal Technologies, “Using Pagelet Wizard to Create and Manage Pagelets,” Step 4: Selecting a Pagelet Display Format.

Pagelet Wizard - Specify Display Options Page

Use the Pagelet Wizard - Specify Display Options (custom format) page (PTPPB_WIZ_DISP_CUS) to enter the custom formatting details for the pagelet as well as header and footer options.

Preview the pagelet.

Navigation:

  • Select Custom as the display format and click the Next button on the Pagelet Wizard - Select Display Format page.

  • Click the Transformation button from any page in the wizard.

Note: The fields that appear on this page depend on the display format that you selected on the Pagelet Wizard - Select Display Format page.

This example shows Pagelet Wizard - Select Display Options page with Passthru display format selected for a content item on the Pagelet Wizard - Select Display Format page. Use this page to enter the pass through formatting details for the pagelet as well as header and footer options, and to preview the pagelet:

This example illustrates the fields and controls on the Pagelet Wizard - Select Display Options page with Passthru display format selected for a content item.

Pagelet Wizard - Select Display Options page with Passthru display format selected for a content item

This example shows Pagelet Wizard - Select Display Options page with Menu display format selected for a folder on the Pagelet Wizard - Select Display Format page. Use this page to enter the menu formatting details for the pagelet as well as header and footer options, and to preview the pagelet:

This example illustrates the fields and controls on the Pagelet Wizard - Specify Display Options page with Menu display format selected for a folder.

 Pagelet Wizard - Specify Display Options page with Menu display format selected for a folder

This example shows Pagelet Wizard - Select Display Options page with Custom display format selected in the Pagelet Wizard - Select Display Format page. Use this page to enter the custom formatting details for the pagelet as well as header and footer options, and to preview the pagelet:

This example illustrates the fields and controls on the Pagelet Wizard - Select Display Options page with Custom display format selected.

 Pagelet Wizard - Select Display Options page with Custom display format selected

Note: If you are modifying an existing pagelet definition or if you modify data source parameter definitions, you might need to reselect the XSL template, regenerate the XSL, or both to have the modified pagelet display actual data.

See PeopleTools: PeopleTools Portal Technologies, “Using Pagelet Wizard to Create and Manage Pagelets,” Step 5: Specifying Pagelet Display Options.

Pagelet Wizard - Specify Publishing Options Page

Use the Pagelet Wizard - Specify Publishing Options page (PTPPB_WIZ_PUBOPT) to specify the manner in which the pagelet is published.

Provide registration, caching, and security details, and register the pagelet.

Navigation:

  • Click the Next button on the Pagelet Wizard - Specify Display Options page.

  • Click the Register Pagelet button from any page in the wizard.

This example illustrates the fields and controls on the Pagelet Wizard - Specify Publishing Options page.

 Pagelet Wizard - Specify Publishing Options page

Use the Pagelet Wizard - Specify Publishing Options page to specify the type of pagelet that you want to publish. In addition, provide registration, caching, and security details, and register the pagelet.

See PeopleTools: PeopleTools Portal Technologies, “Using Pagelet Wizard to Create and Manage Pagelets,” Step 6: Specifying Pagelet Publication Options.

Access the Folder Properties - Publish as Pagelet page (click the Publish button on the Folder Properties - Publish Pagelet Wizard Definition page; or if this folder has already been published as a pagelet, click the Publish as Pagelet link on the Folder Properties page).

Access the Text or HTML Properties - Publish as Pagelet page (click the Publish button on the Text or HTML Properties - Publish Pagelet Wizard Definition page; or if this content item has already been published as a pagelet, click the Publish as Pagelet link on the Text or HTML Properties page).

Access the File Attachment Properties - Publish as Pagelet page (click the Publish button on the File Attachment Properties - Publish Pagelet Wizard Definition page; or if this content item has already been published as a pagelet, click the Publish as Pagelet link on the File Attachment Properties page).

Access the Web Site URL Properties - Publish as Pagelet page (click the Publish button on the Web Site URL Properties - Publish Pagelet Wizard Definition page; or if this content item has already been published as a pagelet, click the Publish as Pagelet link on the Web Site URL Properties page).

The following example demonstrates editing a published pagelet for a folder.

This example illustrates the fields and controls on the Folder Properties - Publish as Pagelet page. You can find definitions for the fields and controls later on this page.

 Folder Properties - Publish as Pagelet page

Use the Publish as Pagelet page to review, edit, or add Pagelet Wizard pagelet definitions for this folder or content item. To edit a pagelet definition, it must be marked as published and have a content reference in the current site.

Note: Pagelets for this folder or content item published directly from Pagelet Wizard also appear in this list.

Field or Control

Description

Published

Indicates the whether the pagelet is published.

Edit

Click to access the Publish Pagelet Wizard Definition page, where you can edit pagelet definitions.

Delete

Deletes this pagelet definition and the published pagelet content references in all sites.

Add Pagelet

Click to access the Publish Pagelet Wizard Definition page, where you can publish content as a pagelet to a site or portal.

Use the Publish to Multiple Portals page (PTPP_PMPUBPRTL) to publish the pagelet definition to additional portals and sites.

Navigation:

  • Click the Publish Pagelet in Other Sites link on the Publications Properties - Publish Pagelet Wizard Definition page.

  • Portal Administration, Pagelets, Publish Pagelets

  • PeopleTools, Portal, Portal Utilities, Publish Pagelets

Note: When a content item is published as a pagelet, the Edit Content link displayed in the published pagelet will redirect the user to edit the content in the portal or site where the content resides, and not to the portal or site where the pagelet is displayed.

Two pages are available for you to publish pagelets to multiple portals:

  • Use the Publish to Multiple Portals page to publish the pagelet definition to additional portals and sites.

    This example illustrates the fields and controls on the Publish to Multiple Portals page.

     Publish to Multiple Portals page

  • Use the Publish Multiple Pagelets page to publish multiple pagelet definitions to another portal or site.

    This example illustrates the fields and controls on the Publish Multiple Pagelets page.

     Publish Multiple Pagelets page

See PeopleTools: PeopleTools Portal Technologies, “Working With Navigation Pages,” Publishing Pagelets.