Implementing Fail-over Mechanism

This topic discusses the two ways of implementing fail-over mechanism in PeopleSoft Search Framework.

When you configure PeopleSoft Search Framework with OpenSearch, PeopleSoft Search Framework enables you to implement a fail-over mechanism.

When you use the multiple-nodes option and when you deploy search definitions/categories and generate indexes, OpenSearch automatically distributes the indexed data to the nodes based on its constructs of primary shards and replica shards.

You can create multiple nodes on the same machine or on different machines. If you are creating nodes on different machines, but want the nodes to be on the same cluster, refer to the OpenSearch documentation for information on how you can complete the setup.

To create another node using the installation instructions, refer to PeopleSoft Deployment Packages Installation for Search Components for the current release.

Complete these steps to set up multiple nodes in a search instance:

  1. After Installing the search engine, you need to configure the search functionality.

  2. Use PIA to configure the PeopleSoft Search Framework by creating a search instance.

  3. Enter information in the required fields and save the search instance.

  4. Install another node on the same machine or on a different machine. Follow the instructions in the PeopleSoft Deployment Packages Installation for Search Components for the current release.

  5. Reopen the search instance and In the Search Instance Properties grid, add the newly created node.

  6. Enter information in the required fields to point to the new node and save the search instance.

    Note: In a multi-node OpenSearch cluster, always ensure that the replica value is set to at least 1. For details, see Managing General Search Options.

  7. Deploy the search definitions/categories and generate indexes for the search instance.

Your search functionality is complete and ready for use. In the event that a node fails, PeopleSoft Search Framework automatically points searches to an active node of the search instance.

PeopleSoft Search Framework provides a mechanism for fail-over by enabling you to create multiple search instances. Search Framework enables you to specify priority for these multiple instances so that based on the priority, search will be directed to a different search instance when a search instance fails. If you want to implement this option, you should understand that you need to create another OpenSearch cluster that you will configure as a search instance on the PeopleSoft system.

When you create multiple search instances, you must ensure that you deploy search definitions/categories and generate indexes on all the search instances. This is to ensure that your search instances contain the same searchable data for a user.

Complete these steps to set up multiple search instances:

  1. After Installing the search engine, you need to configure the search functionality.

  2. Use PIA to configure the PeopleSoft Search Framework by creating a search instance.

  3. Create or reuse the existing search definitions and search categories.

  4. Deploy the search definitions/categories and generate indexes for the search instance.

    Your search functionality is complete and ready for use.

  5. Create another OpenSearch cluster by following the instructions in the installation guide.

  6. Use PIA to configure the PeopleSoft Search Framework by creating a search instance.

  7. Deploy the same search definitions/categories and generate indexes on the new search instance, that is, you are creating another cluster with the same details.

  8. On the Search Administration page PeopleTools > Search Framework > Administration > Search Administration, specify the priority for the search instances.

In the event that a search instance fails, PeopleSoft Search Framework will automatically point searches to the next search instance as specified in the priority list.