RELAY_ENTITYLIST

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 Portal: RELAY_ENTITYLIST 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 need the user level permission 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.

Relaytag Configuration

The RELAY_ENTITYLIST allows you to display a list of entity records on a Portal page for any entity. It is more configurable than the deprecated RELAY_CUSTOMENTITY Relaytag. It allows you to add, edit, or delete records from the database table of any Entity. This Relaytag can be configured to filter the results which is particularly useful if you want to restrict visibility of records to a specific Partner. It is a fundamental building block of the Leads v2 and Opportunities v2 capabilities.

Table 1. RELAY_ENTITYLIST Parameters
Parameters	Type	Description
Entity Type	Drop-down List	This is the Entity that is to be made accessible through the RELAY_ENTITYLIST
Show These Columns	Guided Text	These are columns in the Entity's database table that you want to include in the display.This field uses predictive text to suggest available columns you can choose to add.
Filter Records By	Text	Use this field to filters results using Merge fields. For example, if you want the person viewing the page only to see results pertaining to their own organization you would insert this text:`organisationID=[[user.person.organisationID]]`
Permitted Actions	Drop-down List	Specify which actions users are permitted to perform through this list. The options are Add, View, Delete.
Entity Screen	Drop-down List	This is the Screen that will be displayed if the user clicks on a hyperlinked entry in the list.

You can add this Relaytag to a Portal page using the procedure described here.

Sample definition

{{RELAY_ENTITYLIST entityType=person showTheseColumns="LastName, FirstName" permittedActions=Add,View,Delete screenID=PerProfileSummary}}

Articles in this section