This article looks at how the recent list interacts with custom entities.
There are 4 components to consider that make up the functionality of an entity’s recent list:
• The code that adds a record to the recent list.
• The find hyperlink (entity name and image in the recent list) and the screen it loads.
• The data that displays as a hyperlink.
• The screen that loads when a recent hyperlink is clicked.
The code that adds a record to the recent list
The first topic is how does an ASP page add a record to the recent list? The convention is that when a user loads a summary page for an entity record to add the ID of the record to the recent list, this is done by the eWare object in the following code sample:
eWare.SetContext(“EntityName”, “EntityId”);
This actually adds the record to Users.User_RecentList field value, which is what the DLL reads to build a user’s recent list.
The Find Hyperlink
How do you change the label which displays as the entity name next to entity’s image in the recent list? You need to add the following translation:
Caption Code: << your entity name >>
Caption Family: RecentList
Caption Family Type: Choices
US Translation: << your label for the USA users>>
You can then translate the find label into any language.
How do you know what ASP page will called if the user clicks the “entity name” label? Well, the answer is that the DLL is hard-coded to look in the CustomPages directory for:
CustomPages/<< your entity name >>/<< your entity name >>Find.asp
So make sure you follow the above naming convention by adding a sub-directory of your entity name and then an ASP page with a file name of “your entity name” + “Find.asp”.
The Data that Displays
The data that displays in the list is defined by the following translation record:
Caption Code: NameColumn
Caption Family: << your entity name >>
Caption Family Type: Tags
US Translation: << your field name for the USA users>>
The only limitation I have found is that you can only enter one field name in the translation. In order to see your change you will have to clear out the list.
The screen that loads when a recent hyperlink is clicked
The screen that is loaded when a record’s hyperlink is clicked in the recent list is defined the following translation record:
Caption Code: SummaryPage
Caption Family: << your entity name >>
Caption Family Type: Tags
US Translation: << your ASP page name for the USA users>>
There is one important note the DLL is hard-coded to look in the CustomPages directory for a directory of your entity name, so if the US translation page name was “DilbertSummary.asp” and the entity was called “ScoobyDoo” the DLL would make the hyperlink point to:
CustomPages/ScoobyDoo/DilbertSummary.asp
This does require an IISRESET before your change will be testable.