Creating Rich Preview for PeopleSoft Links

PeopleSoft supports rich previews for PeopleSoft links by generating metadata that can be interpreted by external applications such as email clients, messaging tools, and social media platforms.

When a PeopleSoft link is shared, the preview can display meaningful information about the target content, including the page title, a short description, and an image thumbnail. Rich preview generation is supported through Open Graph metadata generated in the PeopleSoft HTML.

Open Graph metadata is used by external platforms to determine how a shared link should be displayed. PeopleSoft generates Open Graph meta tags in the HTML for supported pages so that applications such as email clients, messaging tools, and social media platforms can read the metadata and construct a preview.

Table 4-2 Open Graph tags and description

Open Graph Tag	PeopleSoft Source	Description
og:title	Content reference (CREF) label.	The CREF label is entered when you define a content reference. See Defining Content References.
og:description	CREF long description.	The CREF long description is entered when you define a content reference. The description used for og:description is limited to a maximum of 160 characters. See Defining Content References.
og:image	Image specified by the LINK_PREVIEW_IMG CREF attribute, or the default image if the attribute is not defined	The preview image should be a JPG image with a minimum size of 1200 x 630 pixels to provide sufficient quality for preview rendering.

Open Graph tags are generated by default for CREFs. However, some deployment scenarios may affect preview behavior. For example, environments behind corporate firewalls may not support external preview generation because the shared link is not publicly accessible. Similarly, environments using custom single sign-on or external LDAP authentication may not support direct page-specific previews. In such cases, a generic preview based on the sign-in page may be generated instead.

Example of rich preview for a PeopleSoft URL:

Using CREF Attributes for Link Preview Configuration

Use the following CREF attributes when configuring rich previews:

• LINK_PREVIEW - PeopleTools, by default, generates Open Graph tags for CREFs. If you want to disable link preview generation for the CREF, set the value to FALSE.
• LINK_PREVIEW_IMG - Specify the image to use for the thumbnail in the rich preview. If this attribute is not present, PeopleTools uses the default preview image.
• LINK_PREVIEW_APPCLASS - Specify an application class, which is an extension of the PeopleTools delivered base class (LinkPreview). The application class provides dynamic preview title and description values at runtime. If the application class cannot be run successfully, PeopleTools uses the CREF label and CREF description as fallback values.

Note:

Ensure that you do not select the Translate check box for the LINK_PREVIEW, LINK_PREVIEW_IMG, and LINK_PREVIEW_APPCLASS CREF attributes.

Using an Application Class for Dynamic Preview Content

For scenarios that require dynamic or parameterized preview content, PeopleTools supports the LINK_PREVIEW_APPCLASS CREF attribute.

PeopleTools delivers the base class LinkPreview in the application package PT_LINK_PREVIEW. Application teams can extend this base class and implement the GetLinkPreviewTitleAndDescription method to override the default title and description values used in the Open Graph metadata.

The following example shows how the UserProfileLinkPreview application class can extend the delivered base class and provide custom preview content:

import PT_LINK_PREVIEW:LinkPreview; 

class UserProfileLinkPreview extends PT_LINK_PREVIEW:LinkPreview 
	method GetLinkPreviewTitleAndDescription(&sTitle As string out, &sDescription As string out); 
end-class; 

method UserProfileLinkPreview 
	%Super = create PT_LINK_PREVIEW:LinkPreview();
end-method; 

method GetLinkPreviewTitleAndDescription 
	/+ &sTitle as String out, +/ 
	/+ &sDescription as String out +/ 

	&sTitle = "User Profile"; 
	&sDescription = "View and manage profile information for the selected user."; 
end-method;