By default, when users search for people in IBM® Connections, inactive user profiles are excluded
from the search results. You can run a command to change your deployment
settings so that search results related to inactive users are automatically
included in search results.
Before you begin
To edit configuration files, you must use the IBM WebSphere® Application
Server wsadmin client. See Starting
the wsadmin client for details.
About this task
When you set the user profiles of employees who have left
your organization to inactive, by default, those profiles are not
listed in search results. Additionally, inactive users do not display
in the person type-ahead on the Advanced Search page.
End users can still filter search results to display inactive profiles
by selecting All People from the Show menu
on the Search Results page when the Profiles filter
is selected.If you want inactive profiles to display in search
results by default, you can run a SearchCellConfig command to update
the value of the includeInactiveUsers property in the search-config.xml file
to true. When this property is set to true, the person type ahead
on the Advanced Search page includes inactive
users.
For more information about the user life cycle in IBM Connections, see Managing
users.
Procedure
To include or exclude inactive users from search results,
complete the following steps.
- Start the wsadmin client from the following
directory of the system on which you installed the Deployment Manager:
app_server_root\profiles\dm_profile_root\bin
where
app_server_root 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.
- After the wsadmin command environment
has initialized, enter the following command to initialize the Search
environment and start the Search script interpreter:
execfile("searchAdmin.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.
When
the command is run successfully, the following message displays:
Search Administration initialized
-
Check out the Search cell-level configuration file, search-config.xml,
with the following command:
SearchCellConfig.checkOutConfig("working_dir",
"cellName")
Where:
- working_dir is the temporary directory to which you want to check out the
cell level configuration file. This directory must exist on the server where you are running the
wsadmin client. 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 run successfully.
- cellName is the name of the cell that the Search node belongs to. The command
is case-sensitive. 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()
For
example:
SearchCellConfig.checkOutConfig("c:/search_temp", "SearchServerNode01Cell")
- Use the following commands:
- SearchCellConfig.includeInactiveProfilesSearchResults()
Specifies that the documents corresponding to inactive user
profiles are included in search results. In a default installation
of IBM Connections, inactive
user profiles are automatically excluded from search results.
This command updates the checked out seach-config.xml file by setting:
<profilesSearch includeInactiveUsers="true"/> as a child element of
<config>.
- SearchCellConfig.excludeInactiveProfilesSearchResults()
Specifies that the documents corresponding to inactive user
profiles are excluded from search results. In a default installation
of IBM Connections, inactive
user profiles are automatically excluded from search results.
This command updates the checked out seach-config.xml file by setting:
<profilesSearch includeInactiveUsers="false"/> as a child element of
<config>.
- Check in the updated search-config.xml configuration
file using the following wsadmin client command:
SearchCellConfig.checkInConfig()
- To exit the wsadmin client, type exit at
the prompt.