by PT 8.60
Introduction
Component search records determine the search behavior and security for that component. Of course, this is for classic components. Fluid components require a search record defining the Level 0 key of the component, they just aren’t used.
However, the search record can be overridden on the menu. One specific component’s search behavior can be very different if that component is on multiple menus.
Starting with PeopleTools 8.60, Configurable Search can also override the search record.
Hierarchy of Search Record Overrides
From lowest to highest:
- Component Search Record
- Menu Item Override of Search record
- Configurable Search
Component Search Record
PeopleTools Application Designer requires the developer to declare a Search Record on the Component Properties Page (Use Tab) before that component can be saved. This is the default component search record and must tie in with the Level 0 key of the component.
Menu Item Search Record Override
Each component must be attached to a menu. The menu item will inherit the component’s search record. However, this can be overridden. Again, the search record must deliver a unique Level 0 key value to the component for the component to function properly.
Configurable Search
Starting with PeopleTools 8.60, the Configurable Search facility is the ultimate override of a Components search record. Configurable search can be as simple as designating which fields on the search record display and in what order or it can totally replace the existing search record.
If overriding the existing search record, the new search record must return to the component the same Unique Level 0 key structure the component is expecting.
Configurable Search works with the Content Reference. If a component appears on multiple menus, then the developer will have to choose which location of that component is to be overridden in Configurable Search.
The Configurable Search Page displays the current Search Record for the Component/Menu combination. If the Search record is overridden at the menu, that Menu Search Record Override will be shown on the configuration page.
Why Override a search Record?
Overriding the search record allows us to use the same component in different situations without modifying that component.
We can reuse a component for a specific user group with a targeted search record that doesn’t affect that same component with other users by attaching that component to a different menu and overriding the search record there.
For example: Employee Emergency Contacts. This component is available to the HR Admins, who can see all employees in the system.
By attaching it to a new menu and designing a new search record, we can give that component to Managers who can see the emergency contacts of just their team. Furthermore, maybe make this component/menu combination read only in security. The result is that we have repurposed a delivered component without modifying it or changing its behavior for the Workforce Admin users.
Has your search record been overridden?
The other side of this coin is when you are researching a component’s search record. If the component properties define the Search record, but the component’s search behavior is clearly something totally different, then start looking to see if the search record has been overridden.
The search record has been overridden at the Menu or, starting with PeopleTools 8.60, possibly Configurable Search
