Publishing a Calendar as a Pagelet

This section discusses how to:

  • Publish a pagelet from a calendar.

  • Publish a calendar from Pagelet Wizard.

  • Edit a published pagelet.

  • Publish a pagelet to multiple portals.

Page Name

Definition Name

Usage

Calendar Properties - Publish Pagelet Wizard Definition Page

EPPPB_PGLT_PUB

Create a pagelet definition for a calendar.

Pagelet Wizard - Specify Pagelet Information Page

PTPPB_WIZ_INFO

Provide information to identify and categorize a pagelet.

See Publishing a Calendar from Pagelet Wizard.

Pagelet Wizard - Select Data Source Page

PTPPB_WIZ_DATASRC

Select the type of data source for the pagelet.

See Publishing a Calendar from Pagelet Wizard.

Pagelet Wizard - Specify Data Source Parameters Page

PTPPB_WIZ_DATAPRMS

Configure the data source parameters that are required for data to be displayed in the pagelet.

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

See Publishing a Calendar from Pagelet Wizard.

Pagelet Wizard - Specify Data Source Parameter Values Page

PTPPB_WIZ_PRMVALS

Specify prompt values for the end user to select from when personalizing the pagelet.

This page is accessible only for data source parameters for which you have selected the User Specified or Admin Specified usage types.

See Publishing a Calendar from Pagelet Wizard

Pagelet Wizard - Select Display Format Page

PTPPB_WIZ_DISPFRMT

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

See Publishing a Calendar from Pagelet Wizard.

Pagelet Wizard - Specify Display Options Page

PTPPB_WIZ_DISP_CUS

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

See Publishing a Calendar from Pagelet Wizard.

Pagelet Wizard - Specify Publishing Options Page

PTPPB_WIZ_PUBOPT

Specify the manner in which the pagelet is published. Provide registration, caching, and security details, and register the pagelet.

See Publishing a Calendar from Pagelet Wizard.

Pagelet Wizard - Pagelet Creation Confirmed Page

PTPPB_WIZ_FINISH

Confirm that the creation of the pagelet is complete.

See Publishing a Calendar from Pagelet Wizard.

Calendar Properties - Publish as Pagelet Page

EPPPB_PGLT_LST

Administer pagelet definitions for a calendar.

Publish to Multiple Portals Page

PTPP_PMPUBPRTL

Publish the pagelet definition to additional portals and sites.

Publish multiple pagelet definitions to another portal or site.

Use the Calendar Properties - Publish Pagelet Wizard Definition page (EPPPB_PGLT_PUB) to create a pagelet definition for a calendar.

Navigation:

  • My Content, My Community Calendars

    Click the Properties link for the calendar on the My Community Calendars page.

    Click the Publish as Pagelet link on the Calendar Properties page.

  • Click the Add Pagelet button or the Edit button on the Calendar Properties - Publish as Pagelet page.

The following example illustrates the Calendar Properties - Publish Pagelet Wizard Definition page.

 Calendar Properties - Publish Pagelet Wizard Definition page

Use the Calendar Properties - Publish Pagelet Wizard Definition page to create a pagelet definition for a calendar.

Pagelet

The pagelet title and description from the Calendar Properties page appear in the Pagelet group box. You can edit these two fields, if necessary.

Field or Control

Description

Pagelet Title

Displays the title for the calendar, which can be edited as the title for the pagelet.

Description

Displays the description for the calendar, which can be edited as the description for the 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. Available options are:

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

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

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

Homepage Tabs

Use this group box 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.

Optional. The pagelet will not automatically appear on the homepage. However, it is available for selection when users personalize their homepages. This setting should not be used 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 homepages. This setting should not be used for guest homepage pagelets because guest users do not have personalization privileges.

Required-Fixed. The pagelet will appear on all user homepages if they 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 they have access to the pagelet. The placement of the pagelet can be changed, but it cannot be removed from the homepage.

Publish

Click the Publish button to publish this pagelet and display the Calendar Properties - Publish as Pagelet page, on which you can review or edit the pagelet definition

Pagelets for calendars can be created and published using Pagelet Wizard and then managed from the Calendar Properties page. 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 3 also includes “Specifying Prompt Values for 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 calendar as a pagelet. The PeopleTools 8.53 PeopleBooks provide detailed information on using Pagelet Wizard.

See the product documentation for PeopleTools: Portal Technology, “Using Pagelet Wizard to Create and Manage Pagelets.”

Step 1: Entering Pagelet Identifying Information

Access the Pagelet Wizard - Specify Pagelet Information page (click the Go to Pagelet Wizard link on the Calendar Properties - Publish Pagelet Wizard Definition page; or Portal Administration, Pagelets, Pagelet Wizard, Pagelet Wizard).

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

See the product documentation for PeopleTools: Portal Technology, “Using Pagelet Wizard to Create and Manage Pagelets,” Step 1: Entering Pagelet Identifying Information.

Step 2: Selecting a Pagelet Data Source

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

The following example illustrates the Pagelet Wizard - Select Data Source page (community calendars data type).

 Pagelet Wizard - Select Data Source page (community calendars data type)

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

Field or Control

Description

Data Type

For calendars, select Community Calendars.

Calendar Source

Select the type calendar to display in the pagelet: All Calendars or Single Calendar. Selecting All Calendars creates a pagelet similar to the delivered My Events pagelet.

Note: The Workspace Calendar option is for internal use.

Calendar ID

Select the calendar to display in the pagelet.

Step 3: Specifying Data Source Parameters

Access the Pagelet Wizard - Specify Data Source Parameters page (select Community Calendars as the data type on the Pagelet Wizard - Select Data Source page, then click the Next button).

The following example illustrates the Pagelet Wizard - Specify Data Source Parameters page (community calendars data source).

 Pagelet Wizard - Specify Data Source Parameters page (community calendars 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.

For calendars, the following data source parameters can be defined:

DATERANGE — Specifies the scope of the calendar: daily, weekly, or monthly.

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.

  • 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. Uers 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 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 the product documentation for PeopleTools: Portal Technology, "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 Values to access the Pagelet Wizard - Specify Data Source Parameter Values page.

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

The following example illustrates the Specify Data Source Parameter Values page (community calendars data type). Access the Pagelet Wizard - Specify Data Source Parameter Values page (click the Values link on the Pagelet Wizard - Specify Data Source Parameters page) as shown below.

 Specify Data Source Parameter Values page (community calendars data type)

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.

Field or Control

Description

Description

Provide an optional description of the parameter value.

Field or Control

Description

Default

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

Step 4: Selecting a Pagelet Display Format

Access the Pagelet Wizard - Select Display Format page (click the Next button on the Pagelet Wizard - Specify Data Source Parameters page).

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

See the product documentation for PeopleTools: Portal Technology, “Using Pagelet Wizard to Create and Manage Pagelets,” Step 4: Selecting a Pagelet Display Format.

Step 5: Specifying Pagelet Display Options

Access the Pagelet Wizard - Specify Display Options page (select Custom as the display format and click the Next button on the Pagelet Wizard - Select Display Format page}.

Use the Pagelet Wizard - Specify Display Options page to enter the custom formatting details for the pagelet as well as header and footer options, and to preview the pagelet.

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 the product documentation for PeopleTools: Portal Technology, “Using Pagelet Wizard to Create and Manage Pagelets,” Step 5: Specifying Pagelet Display Options.

Step 6: Specifying Pagelet Publication Options

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 icon from any page in the wizard.

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 the product documentation for PeopleTools: Portal Technology, “Using Pagelet Wizard to Create and Manage Pagelets,” Step 6: Specifying Pagelet Publication Options.

Use the Calendar Properties - Publish as Pagelet page (EPPPB_PGLT_LST) to administer pagelet definitions for a calendar.

Navigation:

  • Click the Publish button on the Calendar Properties - Publish Pagelet Wizard Definition page.

  • If this calendar has already been published as a pagelet, click the Publish as Pagelet link on the Calendar Properties page.

The following example illustrates the Calendar Properties - Publish as Pagelet page. Access the Calendar Properties - Publish as Pagelet Page (click the Publish button on the Calendar Properties - Publish Pagelet Wizard Definition page; or if this calendar has already been published as a pagelet, click the Publish as Pagelet link on the Calendar Properties page).

 Calendar Properties - Publish as Pagelet page

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

Note: Pagelets for this calendar published directly from Pagelet Wizard also appear in this list.

Field or Control

Description

Edit

Displays the Calendar Properties - Publish Pagelet Wizard Definition page on which you can make changes to the pagelet definition.

Delete

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

Add Pagelet

Adds a new pagelet definition based on the current calendar.

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.

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

See the product documentation for PeopleTools: Portal Technology.