Profiles administrative commands

Profiles administrative commands
Use the commands listed to perform administrative tasks for Profiles. No file checkout or server restart is needed when using these commands.
The following sections define the commands that you can use when working with Profiles. Each section describes the commands for a specific service. The commands are listed in alphabetical order.

ProfilesConfigService
ProfilesService

ProfilesConfigService commands
ProfilesConfigService.checkOutConfig("<working_directory>", "<cell_name>")
Check Profiles configuration files out to a temporary directory.
This command takes the following parameters:

<working_directory> Temporary working directory to which the configuration files are copied. The files are kept in this working directory while you make changes to them.
<cell_name> Name of the IBM WAS cell hosting the IBM Connections application. To obtain the cell name:
print AdminControl.getCell()

For example:

AIX/Linux:
ProfilesConfigService.checkOutConfig("/opt/my_temp_dir", "ServerNode01Cell")

Microsoft Windows:
ProfilesConfigService.checkOutConfig("c:/temp","foo01Cell01")

ProfilesConfigService.showConfig()
Display the current configuration settings. Check out the configuration files with ProfilesConfigService.checkOutConfig before running ProfilesConfigService.showConfig.

ProfilesConfigService.updateConfig("<property>", "<value>")
Updates configuration properties.
This command takes the following parameters:

<property> One of the configuration properties that can be edited for Profiles.
<value> Acceptable values for properties can be restricted, for example, to either true or false.

ProfilesConfigService.checkInConfig()
Check in Profiles configuration files. Run from the wsadmin command processor.

ProfilesConfigService.checkOutPolicyConfig("<working_directory>", "<cell_name>")
Check the profiles-policy.xml and profiles-policy.xsd files out to a temporary directory.
This command takes the following parameters:

<working_directory> Temporary working directory to which the configuration files are copied. The files are kept in this working directory while you make changes to them.
<cell_name> Name of the WAS cell hosting the IBM Connections application. To obtain the cell name:
print AdminControl.getCell()

For example:

AIX/Linux:
ProfilesConfigService.checkOutPolicyConfig("/opt/my_temp_dir", "ServerNode01Cell")

Microsoft Windows:
ProfilesConfigService.checkOutPolicyConfig("c:/temp","foo01Cell01")

ProfilesConfigService.checkInPolicyConfig()
Check in the Profiles policy configuration files. Run from the wsadmin command processor.

ProfilesService commands
ProfilesService.deletePhoto(String user_email_addr)
Deletes image files associated with a user's email address. This command can be used only if the user has uploaded a photo to their profile. This command removes the photo.
For example:

ProfilesService.deletePhoto("john_doe@company.com")

ProfilesService.disableFullReportsToCache()
Disable the full report-to chain cache capability. This command does not take any arguments.

ProfilesService.enableFullReportsToCache(startDelay, interval, schedTime)
Enables the full report-to chain cache with the specified start delay in minutes, refresh interval in minutes, and scheduled refresh time in HH:MM format.
This cache is used to populate the full report-to chain view available in a user's profile. The cache contains the specified number of top employees in the organizational pyramid; it is not intended to store an entry for each profile. It stores the profiles of those people at the top of the chain who are included in many full report-to chain views.
For example:

ProfilesService.enableFullReportsToCache(5, 15, "23:00")

ProfilesService.purgeEventLogs()
Delete all event log entries in the EVENTLOG table. This command does not take any arguments.

ProfilesService.purgeEventLogsByDates(string startDate, string endDate)
Deletes event log entries created between the specified start date and end date.
This command takes the following parameters:
startDate
A string that specifies the start date for the period in MM/DD/YYYY format.

endDate
A string that specifies the end date for the period in MM/DD/YYYY format.

For example:

ProfilesService.purgeEventLogsByDates("06/21/2009", "06/26/2009")

This command deletes all the event log entries that were created on or after June 21st, 2009 and before June 26th, 2009 from the EVENTLOG table.

ProfilesService.purgeEventLogsByEventNameAndDates(eventName, string startDate, string endDate)
Deletes event log entries with the specified event name that were created between given start date and end date.
This command takes the following parameters:
eventName
The type of event that you want to remove from the EVENTLOG table. The following names are some examples of valid event names:

profiles.created
profiles.removed
profiles.updated
profiles.person.photo.updated
profiles.person.audio.updated
profiles.colleague.created
profiles.colleague.added
profiles.connection.rejected
profiles.person.tagged
profiles.person.selftagged
profiles.tag.removed
profiles.link.added
profiles.link.removed
profiles.status.updated
profiles.wallpost.created
profiles.wallpost.removed
profiles.wall.comment.added

For a complete list of valid event names for Profiles event log cleaning administrative tasks, refer to the following web page: Events_Reference

startDate
A string that specifies the start date for the period in MM/DD/YYYY format.

endDate
A string that specifies the end date for the period in MM/DD/YYYY format.

For example:

ProfilesService.purgeEventLogsByEventNameAndDates(profiles.colleague.created, "06/21/2009", "06/26/2009")

This command deletes all the profiles.colleague.created event log entries that were created on or after June 21st, 2009 and before June 26th, 2009 from the EVENTLOG table.

ProfilesService.rebuildLookAsideIndexes()
Creates a background process that runs through the Profiles database and corrects any issues. The command does not take any parameters.
When you run the command, a message is logged to record that the process has started and, after every block of 5000 users has been processed, a check-up message indicates the number of users that have been successfully updated or flags errors in that block of users.
At the end of the process, a message containing information about the total number of users updated, the number of users successfully updated, and the number of users with errors, is logged. The logs contain the UIDs of the users who could not be successfully updated as well as any error messages.
The logs are output to the SystemOut.log file of the IBM WAS node that the MBean connected to. Typically this is the first node defined in the Profiles cluster.

ProfilesService.reloadFullReportsToCache()
Forces a reload of the full report-to chain cache from the Profiles database. This command does not take any arguments.
Note: If the full report-to cache is disabled, it cannot be reloaded. This command fails when the cache is disabled.

ProfilesService.updateDescription(String user_email_addr, String new_content_for_description_field)
Replaces the existing description text associated with a user's email address with alternate description text enclosed by double quotes.
Description text is information contained on the About Me tab of a user's profile.
For example:

ProfilesService.updateDescription("ann_jones@company.com","This is new text that will be entered into the About Me tab for Ann.")

Note: Rich text cannot be entered with this command.

ProfilesService.updateExperience(String user_email_addr, String new_content_for_experience_field)
Replaces the existing experience text associated with a user's email address with alternate text enclosed by double quotes.
Experience is the information contained in the Background area of a user's profile.
For example:

ProfilesService.updateExperience("ann_jones@company.com","This is new text that will be entered into the Background field for Ann.")

Note: Rich text cannot be entered with this command.

ProfilesService.writeStatisticsToFile(String myStatsFile)
Writes the most recent Profiles statistics to a file.
The myStatsFile argument can include the full path and name of the statistics file. Note that the path must be relative to the server hosting the MBean used by this command.
For example:

ProfilesService.writeStatisticsToFile("d:/temp/profilesStats.txt")

Note: Statistics information can also be viewed in a browser using the following URL:
http://<server.company.com>/profiles/html/servermetrics.do

Commands for managing user data

ProfilesService.activateUserByUserId(String user_external_id, <updated_properties_list>)
ProfilesService.inactivateUser(String user_email_addr)
ProfilesService.inactivateUserByUserId(String userID)
ProfilesService.publishUserData(String user_email_addr)
ProfilesService.publishUserDataByUserId(String userID)
ProfilesService.swapUserAccessByUserId("user_to_activate","user_to_inactivate")
ProfilesService.updateUser(String user_email_addr, <updated_properties_list>)
ProfilesService.updateUserByUserId(String userID, <updated_properties_list>)

Parent topic:
Running Profiles administrative commands

Related concepts
Synchronize user data using administrative commands

Related tasks
Running administrative commands
Manage user data using Profiles administrative commands

Related reference
Profiles configuration properties

+
Search Tips | Advanced Search

<property>	One of the configuration properties that can be edited for Profiles.
<value>	Acceptable values for properties can be restricted, for example, to either true or false.