Installing the context-aware search engine on Windows, Linux, AIX, and Solaris systems

Before you can use the context-aware search, you must install and start the search engine on your operating system. If a server is renamed, restart the context-aware search engine so that it points to the new repository URL.


  1. Open a command line for your operating system and access the engine_install_dir/jazz/searchengine/eclipse subdirectory, where engine_install_dir is where you extracted the search engine.
  2. Run the component by running the scripting files or the executable file (search_engine.exe or search_engine). You might need to edit the script file to ensure that the JAVA_HOME environment variable is set to the location of the IBM® JRE. By default, a catt directory is created in the current working directory, and data is written to it. You can change the working directory with the -baseOutputDir parameter of the search_engine command. If you run the search_engine command with no parameters, a message is displayed indicating the parameter options. Start the search engine with one of the following commands that use standard authentication.
    On Windows operating systems:
    search_engine.bat -repository repositoryURL -userId username 
                      -pass password -engineId engine
    search_engine.exe -vm jrePath/bin/java -repository repositoryURL 
                      -userId username -pass password -engineId engine
    Note: While the examples contain the username and password variables for authentication, you can also specify the -certificate certifcate path or -smartCard authentication options if the server accepts them.
    On Linux, Linux on z/OS®, Linux on Power PC, AIX®, or Solaris operating systems:
    ./ -repository repositoryURL -userId username 
                       -pass password -engineId engine
    ./search_engine -vm jrePath/bin/java -repository repositoryURL 
                    -userId username -pass password -engineId engine
    • jrePath is the path to the IBM JRE. jrePath can be the jdk subdirectory or the eclipse/jdk subdirectory, depending on the installation method.
    • repositoryURL is your repository URL: for example,
    • username is the name of a user with read access to the project areas to be indexed.
    • Optional: password is the user password.
    • engine is the search engine identifier.
    • Optional: -passwordFile password file path is the path to an encrypted password file created with the -createPasswordFile parameter.
    • Optional: You can use -baseOutputDir dir as an extra parameter. In this case, dir is a base directory for writing and reading files. -baseOutputDir is needed if the current working directory is read only. By default, a catt directory is created under the current working directory and serves as the base directory.
      Note: Another search engine with the same output directory as -baseOutputDir for a running search engine exits with the following message: This application will exit - output directory is in use by a running search engine instance.
    • Optional: -verbose enables verbose output.
    • Optional: -createPasswordFile pass.txt, where pass.txt is the path to an encrypted password file that is being created with the -createPasswordFile parameter. pass.txt points to a file with any name.
      Note: Enter the command with the -createPasswordFile parameter as follows:
      search_engine.bat -createPasswordFile pass.txt
      Linux, Linux on z/OS, Linux on Power PC, AIX, or Solaris:
      ./ -createPasswordFile pass.txt
  3. To stop a search engine, press CTRL+C in the search engine command screen. On IBM i, if you are running the search engine interactively, press F3 to exit Qshell and stop it.

video icon Video channel
Software Education channel

learn icon Courses

IoT Academy
Skills Gateway

ask icon Community forums library

support icon Support

IBM Support Community
Deployment wiki