RELAY_MEDIADISPLAY Relaytag

Overview

Relaytags are ready-made widgets located on the WYSIWYG editor of a portal page, which enables you to quickly and easily add a wide variety of functionality to the pages of your Partner Portal. Relaytags can be used to display files and media resources, link to training courses, or enable a partner to monitor the progress of their opportunities. This article describes how to use the RELAY_MEDIADISPLAY Relaytag.  

Best Practice for Relaytags

While you can use more than one Relaytag on a single page, we recommend that you only do so if the Relaytags are querying different data. Interference and unexpected behavior may result if two Relaytags on a single page attempt to access the same data.

Before You Begin 

• Log in to the PRM admin site with elementTask level 2 rights or greater.   The instructions below assume that you have previously created the page you wish to add the Relaytag to.  In general, it is best practice to only display a single Relaytag per page. 
• You will also need the right to Add a Phrase and the appropriate language rights. 
• How to Add a Relaytag to a Partner Portal Page.

Partner Portal Result

This is an example of the Relaytag displayed in the Partner Portal. You can customize the results using the parameters below.

Figure: Portal page displaying RELAY_MEDIADISPLAY with example settings.

Relaytag Configuration

The RELAY_MEDIADISPLAY Relaytag delivers a fully search-able Media Library experience that can be presented to partners through the Portal. The Relaytag offers a very flexible interface that can change the look and feel of media searching and is configured entirely though the Relaytag settings.

Table 1. RELAY_MEDIADISPLAY Parameters

Parameters	Type	Description
Restrict files to these media groups	Multi-select List	Allows you to select which media groups to include in search results.
Restrict files to these resource types	Multi-select List	If a radio button or check-box type Profile has been applied to the File Entity, this can be displayed as a filter.
Advanced Filter - Available Profiles	Multi-select List	If a radio button or check-box type Profile has been applied to the File Entity, this can be displayed as an advanced filter. Users will need to open the Advanced Filters to see this filter set.
Filters display as	Multi-select	List Determines the appearance of the filter options.
Show Text Search Box	Multi-select List	Determines if users have a text search box in which to enter queries.
Disable List View	Multi-select List	When set to Yes, prevents the user from seeing the search results as a list view.
Default View	Multi-select List	Determines which view is initially presented to the user.
Data to Show in List View	Multi-select List	Determines which fields to display in the List view.
Data to Show in Grid View	Multi-select List	Determines which fields to display in the Grid view.
Paging Type	Multi-select List	Determines whether users will need to click a link to open additional results or if additional results will automatically display when the user scrolls to the bottom of the page.
Results Sort Order	Multi-select List	Determines which field the search results will be sorted by.
Records per Page	Multi-select List	Sets the number of results that are displayed on the page initially.
Grid Columns	Multi-select List	Sets the number of columns in the grid display.
Show Thumbnail Image	Radio Button	Determines if the title will show a thumbnail image of the file cover page.
Show File Extension Icon Image	Radio Button	Determines whether the icon image associated with the file type is displayed in the results.
Date Forma	Multi-select List	Select how you would like the date to be displayed.
Floating Header	Radio Button	Select Yes to anchor the header at the top of the window when scrolling.

Sample definition 

{{RELAY_MEDIADISPLAY mediaGroupRestriction=9 defaultView=Grid showThumbnailAsMainImage=No}} 

 

 

Related Topics 

• Video: Media Library Relaytags for Media Library
• Video: Media Library Build Banners
• Video: Media Library Create Rotating Banners