This documentation applies to the 8.1 version of Remedy Action Request System, which is in "End of Version Support."

To view the latest version, select the version from the Product version menu.

Configuring full text search for a server group

Note

Starting from BMC Remedy AR System 8.1 Service Pack 1, the following new terms are used for FTS plug-ins:

  •     FTS Writer is called FTS Indexer
  •     FTS Reader is called FTS Searcher

Use the following information to understand how full text search (FTS) works and how it is configured in a server group environment.

Overview of how FTS works in a server group

FTS within BMC Remedy Action Request (AR) System is made up of the following primary components:

  • FTS code that manages the FTS functionality
  • FTS plug-in — a Java plug-in, which is the core index engine
  • Index

As events occur within AR System that cause data to be indexed, the AR System server sends that data, along with appropriate instructions, to the FTS plug-in, which then adds, deletes, or updates data within the index. Other events could include a request to search the index. AR System server sends the search request to the FTS plug-in, which performs the search and returns the results to AR System server. The AR System server then deals with the data accordingly.

When you configure a server group for FTS, ensure that the following conditions are met:

  • Only the primary FTS server is designated as the indexing server.

    Starting with Service Pack 1, in FTS high-availability architecture, more than one server in the group can be designated as the indexing server.

  • The primary FTS server is the single AR System server that also has the FTS collection and conf directories located on a local disk.

  • The primary FTS server hosts all instances of the FTS plug-ins.

You can designate a server as the primary FTS server by ranking it in the AR System Server Group Operation Ranking form. For more information, see Setting failover rankings for servers and operations.

FTS uses one plug-in as the writer (primary) and another plug-in as the reader (secondary). The reader and writer plug-ins are installed on the FTS indexing server. In a server group, only one writer instance must be running on the designated FTS indexing server. The FTS writer (primary) serves as the reader and writer for the FTS indexing server, as well as a writer for all servers.

Only the designated primary FTS server has a ranking entry in the AR System Server Group Operation Ranking form. The writer (primary) is connected to the FTS indexing server. The reader (secondary) serves as the reader for all the other servers in the group, so you must configure all other servers to connect to the reader instance running on the FTS indexing server. The reader instance runs on a separate port on the FTS indexing server.

The events that cause data to be written to the index result in data being put into the AR System database as a queue of items to index. Only a primary FTS indexing server processes index requests from this queue. However, any instance of AR System server can send a search request to its corresponding FTS plug-in. This ensures index integrity. To further ensure integrity of the system, the FTS plug-in design is such that any launched instance defaults to a read-only state until the primary FTS indexing server specifically initializes the primary plug-in instance for writing. For more information, see FTS plug-in configuration.The FTS indexing server communicates with the writer plug-in for all search and indexing requests. There is no search fail-over for the writer plug-in running on the FTS indexing server.

Note

  • The secondary reader plug-in serves the search requests from other servers and does not serve as a backup to the primary writer plug-in.

Configuring FTS for a server group

If you use FTS in a server group, only one server in the group can index data at a time.

Starting with Service Pack 1, in FTS high-availability architecture, more than one server in the group can index data.

Each primary FTS indexing server has its own virtual queue of data to index. When AR System queues data for indexing in parallel to AR Database changes in data, it queues separately for each primary FTS Indexing server as designated by the Server Group Ranking form for FTS.

In a server group, the server that owns the full text indexing operation processes all pending indexing tasks regardless of their server of origin. (The other servers have read-only access to the index files.)

FTS is configured after all servers in the group have been installed and configured to run within a server group. It is recommended that the FTS collection directory and the FTS configuration directory be located on the same computer.

To set up FTS in a server group

  1. Rank the FTS servers in the AR System Server Group Operation Ranking form. For more information, see Setting failover rankings for servers and operations.

    Note

    You should use the FTS indexing server, which is ranked 1 in the AR System Server Group Operation Ranking form, for searching and the other FTS indexing server, which is ranked 2, as the failover server.

  2. In a browser, open the BMC Remedy AR System Administration Console, and click System > General > FTS Configuration.
  3. Complete the form as per FTS Configuration form in the AR System Administration Console.

This version of the documentation is no longer supported. However, the documentation is available for your convenience. You will not be able to leave comments.

Comments

  1. Chris Cox

    An example of FTS in a server group would be useful here.  

    Nov 06, 2013 09:07
  2. Andreas Mitterdorfer

    I think the section is not correct anymore and needs to be updated.

    Eg. the statements

    If you use FTS in a server group, only one server in the group can index data at a time.

    Only the primary FTS server is designated as the indexing server.

    are not correct with the recent changes.

    See https://docs.bmc.com/docs/display/public/ars81/High-availability+architecture+for+FTS documenting eg. two indexing servers and two reading servers.

    Dec 11, 2013 10:11
  3. Cade Hoff

    Configuration is not clear for a Server Group with the new options.   Some how this needs to be updated to show configuration options before SP1 and After SP1 when things changed for High Availablity. 

    Dec 11, 2014 04:38