Saturday, June 18, 2016

IBM Connections search, some wsadmin commands

Inside IBM Connections search is one of the most important task because is needed to maintain our environments healthy and easy to use for our users.

IBM has developed a lot of commands troug wsadmin console to maintain and administer this task

I like to share some useful command I've saved in my personal note.
All of this command (and many more) are available reading the official IBM wikis.

Wsadmin shell

All advanced administration task inside IBM Connections is available inside wsadmin shell.
We can open this shell using the following command on linux server

  • cd /opt/ibm/WebSphere/AppServer/profiles/Dmgr01/bin
  • ./ -lang jython -user waslocal -password password
At this time there are no IBM alternative from wsadmin shell and during last IBM Connect in Orlando Luis Benitez during the Q&A has confirmed there are not any plan to have a GUI for this task.

If you are not confortable with shell commandt there are some products from   Time To Act , or  Infoware that will provide you most of this commands though a web application console
Some useful search command

The first thing to do after having start the wsadmin is start the search administration


Some wsadmin commands could be launched on specific target application providing a "string applicatioNnames" that could be one of the following:

  • activities
  • all_configured
  • blogs
  • calendar
  • communities
  • dogear
  • ecm_files
  • files
  • forums
  • people_finder
  • profiles
  • status_updates
  • wikis.
  • all_configured 
The last options all_configured means the search command will run on all application currently installed


The following command will delete the specified index:


the following command will start immediatly to buil the specified index


During the execution of this kind of commands i suggest you to tail the SystemOut.log to see if any errors is occurring,

Search index backup

When you have an up and running environment probably could be used to have a search index backup to make a fastest restore in case of issues.

To make a one shot backup use:


this will perform the backup inside the path specified in WebSphere environment variable named  SEARCH_INDEX_BACKUP_DIR

If you like to schedule the backup ,you can do it with the Connections internal scheduler with the following command

SearchService.addBackupIndexTask("WeeklyIndexBackup", "0 0 2 ? * SAT","0 10 2 ? * SAT")

the backup will be done inside  SEARCH_INDEX_BACKUP_DIR

If we need to remove backup task like one scheduled in previous example we can use this command.


Restore search index

Before execute a restore of search index we have to stop all search task and prepare the HOMEPAGE database to successfully load the restored index
  • SearchService.disableAllTasks()
  • SearchService.notifyRestore("false")
Now we have to stop search server, delete the index, restore the index from backup , reload the service and notify to homepage db the restore done

  • Stop sarch server 
  • delete actual index
  • restore index from path specified inside  SEARCH_INDEX_BACKUP_DIR
  • Start search server
  • SearchService.enableAllTasks()
  • SearchService.notifyRestore("true")

Reload search index

during some task could be useful to reload the index with one of following command:
  • SearchService.reloadIndex()
  • SearchService.reloadIndexAllNodes()
The first will perform the reload (without a restart ) on current now, the second on all search node

Search Status Page

The search application have also a status page , available for search admin at following address:

1 comment: