Customizing search results informationAdded by IBM on February 11, 2013 | Version 1 (Original)
|Edit the searchResults.ftl file to customize the display of profile fields in views that render lists of users.
Before you begin
To edit configuration files, use the wsadmin client. See Starting the wsadmin client
for information about how to start the wsadmin tool.
About this task
Use the searchResults.ftl
template to customize the display of fields in either the Report-to Chain or Directory views.
Parent topic: Customizing display using templates
Adding custom extension attributes for Profiles
- Start the wsadmin client from the following directory of the system on which you installed the Deployment Manager:
is the WebSphere
® Application Server installation directory and dm_profile_root
is the Deployment Manager profile directory, typically dmgr01.
You must start the client from this directory or subsequent commands that you enter do not execute correctly.
- Use the wsadmin client to access and check out the Profiles business card configuration files.
- Enter the following command to access the Profiles configuration files:
execfile("profilesAdmin.py") If prompted to specify a service to connect to, type 1 to pick the first node in the list. Most commands can run on any node. If the command writes or reads information to or from a file using a local file path, you must pick the node where the file is stored.
- Enter the following command to check out the Profiles configuration files:
- working_directory is the temporary working directory to which the configuration XML and XSD files are copied and are stored while you make changes to them. Use forward slashes (/) to separate directories in the file path, even if you are using the Microsoft Windows operating system.
Note: AIX and Linux only: The directory must grant write permissions or the command does not complete successfully.
- cell_name is the name of the WebSphere Application Server cell hosting the Profiles application. This argument is required. It is also case-sensitive, so type it with care. If you do not know the cell name, you can determine it by typing the following command in the wsadmin command processor: print AdminControl.getCell()
- AIX or Linux:
- Microsoft Windows:
- Open the LotusConnections-config/profiles/templates/searchResults.ftl file.
- Modify the file contents to include any custom HTML or fields.
The views that use this template are listed in the Section
column in the following table.
Table 1. Section titles and descriptions for the searchResults.ftl template
|reportTo||Applies to the Full Report-to Chain view and Same Manager view available in the Report-to Chain section of the profile page.|
|directory||Applies to the profile directory search results available from the Directory view.|
By default, both views render the same results. To customize one of the view but not the other, use the supplied renderSection
macro. For example, to customize only the directory results, the following macro should surround the code section being customized:
… mark-up specific to the directory view ...
For more information about using these settings, see Example – Creating a simple profile data model and template customization
- Save your changes.
- After making changes, you must check the configuration files back in, and you must do so during the same wsadmin session in which you checked them out for the changes to take effect. See Applying property changes in Profiles for information about how to save and apply your changes.
- If you have enabled template reloading, your changes are reflected immediately in the user interface. If not, restart the application to recompile the template and display your customization changes.
If your desired customization requires profile record data for resolved codes, extension fields, secretary information, or manager information, you must also update your profiles-config.xml
file. Use the following procedure to specify the additional required data needed for input to the FreeMarker template processor:
- Open the profiles-config.xml file using a text editor.
- Locate the <template/> element whose attribute name is equal to searchResults.
- Modify the <templateDataModel/> section, using the following example, to include the <templateData/> element for the required data.
- Save your changes.
- Check in the updated profiles-config.xml file.
- Restart the server.
<!-- include if you render workLocation, organization, department information -->
<!-- include if and only if you render profile extension fields in the template -->
<!-- include if you render secretary name or email in the template -->
<!-- include if you render manager name or email in the template -->