PeopleSoft Spotlight Series - Oracle · Title: How to Use the PowerPoint Template Author: rosemarie hitchens Created Date: 5/9/2017 3:53:15 PM

Copyright © 2017, Oracle and/or its affiliates. All rights reserved. |

PeopleSoft Spotlight SeriesMoving from Secure Enterprise Search to Elasticsearch


Moving from SES to Elasticsearch

Introduction and Prerequisites

Adding Elasticsearch Instance and Taking Bug Fixes

Deploying the Search Definition and Category

Building the Search Index

Testing

Going Live on Elasticsearch







Testing



Why Move from SES to Elasticsearch?

• Elasticsearch is a new search engine introduced in Tools 8.55.11.

• Implementation of Elasticsearch is similar to SES, providing for a nearly seamless transition.

• Better crawl and search performance.

• Better resource utilization on the search engine host.

• Easy to administer and maintain.

• SES and Verity will be deprecated as of PeopleTools 8.56. SES will still be supported until April 2018.


Understanding the Transition Process

High level steps include:

– Adding an Elasticsearch instance

– Taking Elasticsearch updates and fixes from latest PeopleSoft application image

– Deploying search definitions and categories on the Elasticsearch server

– Building the search index with full crawling

– Scheduling incremental crawling updates

– Performing user acceptance tests

– Going live on Elasticsearch


Transition Options

• Two ways to transition from SES to Elasticsearch:

– With production downtime

– Live cutover, without taking down your production environment

• Full crawl of all search definitions to build your indexes is required. Consider the time it will take for a full crawl of your search definitions when deciding which approach to take.


Two Options for Moving Users to Elasticsearch

• Move to production after Elasticsearch index is fully built:

– Good option if you want to avoid the resource contentions for Elasticsearch indexing while production environment is on SES.

– Set up separate test environment with Elasticsearch to perform acceptance testing.

– Take down production environment while building Elasticsearch index.

• Perform a live cutover to Elasticsearch in production:



Two Options for Moving Users to Elasticsearch

• Move to production after Elasticsearch index is fully built:

– Good option if you want to avoid the resource contentions for Elasticsearch indexing while production environment is on SES.

– Set up separate test environment with Elasticsearch to perform acceptance testing.

– Take down production environment while building Elasticsearch index.

• Perform a live cutover to Elasticsearch in production:

– Good option if you have a large number of search definitions and can’t afford the downtime for a full crawl of your definitions to build the index.

– Configure a new search instance for Elasticsearch on production server.

– You can still use SES while indexing and testing Elasticsearch.



Prerequisites

Meet these requirements before you begin moving to Elasticsearch:

• PeopleSoft 9.2 application

• Latest PeopleSoft Update Image for your application

• PeopleTools 8.55.11 or higher patch level

• Meet resource requirements for Elasticsearch

• One or more hosts provisioned to run Elasticsearch

• Elasticsearch updates installed in PeopleSoft environment. Download and deploy the Elasticsearch DPK.


Documentation on My Oracle Support

Elasticsearch documentation resources and instructions are available on My Oracle Support, PeopleTools 8.55.11 or Higher Elasticsearch Home Page (Doc ID 2205540.2):

• PeopleSoft Deployment Packages for Elasticsearch Installation (PeopleSoft PeopleTools 8.55)

• Moving from SES to Elasticsearch

• PeopleTools 8.55: Search Technology






Building Search Indexes

Testing



Adding an Elasticsearch Instance

Add an Elasticsearch instance to your existing PeopleSoft environment:

– Using the Search Instance Properties page

OR

– Using the Automated Configuration Manager (ACM) template:• SES_TEMPLATE if you are on PeopleTools 8.55.11

• SEARCH_TEMPLATE if you are on PeopleTools 8.55.12 or higher

Note: ACM templates can also be used to deploy search definitions and categories and build indexes.


Adding an Elasticsearch Instance (cont.)

• As of PeopleTools 8.55.11, you can add multiple search instances and prioritize them.

• SES and Elasticsearch search engines can coexist for the purpose of moving to Elasticsearch.

• You can set up a non-production PeopleSoft test environment and add an Elasticsearch instance.


Taking Elasticsearch Bug Fixes from the Latest Image

• Use selective adoption to take Elasticsearch updates and fixes from the latest PeopleSoft Update Image for your application.

• Apply the bugs to your PeopleSoft environment.

• Latest image is recommended, but you can find the minimum required image in which the latest Elasticsearch bug fixes were delivered and a list of bugs on My Oracle Support.

• See “PeopleSoft Applications: Elasticsearch Updates and Fixes” (Doc ID 2181988.1)


Elasticsearch Updates and Fixes Page







Testing



Using Custom Search Definitions and Pages

• If you want to use your own custom SES search definitions and pages, you will need to make changes to your PeopleSoft environment

• Make these changes (only required if using custom indexes):

– Use PT_SEARCH:SearchFilterGenerator APIs to replace OTEXT queries in the code.

– Use PT_SEARCH:SearchFilterGenerator APIs for any filters such as ATTRIBUTE:value and ATTRIBUTE:value used by the custom filter code.

– Select the Is Hierarchy option for any field on the Search Attribute Mapping page that has a soft hierarchy defined by the query in order to process the hierarchy defined in the hierarchy path. For more information, see PeopleTools 8.55: Search Technology, “Creating Query and Connected Query Search Definitions,” Mapping Search Attributes.


Deploying the Search Definition

• You must deploy your search definitions before building the index.

• Use the Deploy Search Definition page to:

• Select the Elasticsearch server on which to deploy the search definitions

• Select the search definitions to be deployed

• For more information see PeopleTools 8.55: Search Technology, “Administering PeopleSoft Search Framework,” Administering Search Definitions and Search Categories, Working with Search Definitions.


Deploy Search Definition Page


Deploying the Search Category

• You must also deploy any additional search categories that include a group of search definitions. Use the Deploy Search Category page to:

– Select the Elasticsearch server on which you want to deploy the search categories

– Select the categories to be deployed

• For more information, see PeopleTools 8.55: Search Technology, “Administering PeopleSoft Search Framework,” Administering Search Definitions and Search Categories, Working with Search Categories.

Note: Any search category that has the same name as a search definition is automatically deployed when the search definition is deployed so you only have to deploy any undeployed search categories that you want to use.


Deploy Search Category Page







Testing




• After you deploy the search definition and category, use the Build Search Index page to perform a full crawl to build the search index on the Elasticsearch instance.

• For the indexing type, select the “Full Index” option.

• For more information, see PeopleTools 8.55: Search Technology, “Administering PeopleSoft Search Framework,” Working with Search Indexes, Building Search Indexes.

• For troubleshooting tips, see the PeopleTools 8.55.11 or Higher Elasticsearch Home Page, Troubleshooting and Known Issues tab (Doc ID 2205540.2).


Build Search Index Page







Testing



Assigning Users to Test Elasticsearch• You can validate the functionality by testing Elasticsearch using a few test users before moving

it to production.

• Assign the test users to test the PeopleSoft system with Elasticsearch using the Search User Instance page to assign the search instance for specific users.

• For more information, see PeopleTools 8.55: Search Technology, “Administering PeopleSoft Search Framework,” Working with Search Instances, Assigning Users to a Search Instance for Validating Indexes.


Testing Elasticsearch

• Test Elasticsearch on your PeopleSoft system using the Search Test Page to select the Elasticsearch instance from which you want to fetch search results for the specified definition.

• Perform thorough acceptance testing of Elasticsearch using your existing search scenarios and the test users.

• For more information, see PeopleTools 8.55: Search Technology, “Working with PeopleSoft Search Framework Utilities,” Using the Search Test Page.

Note: Using the Search Test Page bypasses component access and security to the search index. Getting results from the Search Test Page is the first step to validating the health of the index. You may also want to test with authorized users who use the associated component.


Search Test Page







Testing



Options for Moving Users to Elasticsearch

Two options for moving all users to Elasticsearch once acceptance testing is complete:

– Change the existing SES search instance to Elasticsearch in production, after downtime for index building: This option applies if you completed Elasticsearch acceptance testing in a non-production environment and plan to have a downtime while building the Elasticsearch index in production.

OR

– Live cutover to Elasticsearch, without downtime: Use the Search Instance Administration page to set the priority of the Elasticsearch instance to 1 so that all searches will be redirected to this search instance for all users. Allows the time for live cutover to Elasticsearch to be nearly zero.


Moving to Elasticsearch in Production

Steps to move to Elasticsearch in production if you performed acceptance testing in a non-production environment:

1. Undeploy all SES search definitions and categories

2. Change search instance configuration to point to Elasticsearch

3. Perform round-trip test to ensure connectivity to Elasticsearch

4. Deploy search definitions and categories and index data to the Elasticsearch server

5. Schedule incremental indexing to keep indexes updated.

6. Go live on Elasticsearch




1. Undeploy all SES search definitions and categories• Use the Deploy Search Category page to undeploy the search categories that are not

automatically deployed.

• Use the Deploy Search Definition page to undeploy the SES search definitions.

• When you undeploy a search definition, the search category of the same name is undeployed.

• See PeopleTools 8.55: Search Technology, “Administering PeopleSoft Search Framework,” Administering Search Definitions and Search Categories, sections Working with Search Definitions and Working with Search Categories.





2. Change search instance configuration to point to Elasticsearch• Use the Search Instance Properties page.

• For details, see PeopleTools 8.55: Search Technology, “Administering PeopleSoft Search Framework.”






3. Perform round-trip test to ensure connectivity to Elasticsearch• Use the Round-Trip Test page.

• For more information, see PeopleTools 8.55: Search Technology, “Working with PeopleSoft Search Framework Utilities,” Running Diagnostics.















5. Schedule incremental indexing to keep indexes updated• Use the Build Search Index page and the option “Incremental index” for indexing type.








5. Schedule incremental indexing to keep indexes updated



Live Cutover to Elasticsearch

Steps to perform a live cutover to Elasticsearch:

1. Reset the Elasticsearch instance priority

2. Reset the search instance for the testers

3. Schedule incremental indexing to keep indexes updated. Use the Build Search Index page and select the option “Incremental index” for indexing type.


Note: If you used the ACM template SEARCH_TEMPLATE to build your index, you can schedule incremental indexing using the run control IDs created by the template with the naming convention <SearchDefinition>_INCR.


Additional Information

• PeopleTools 8.55.11 or Higher Elasticsearch Home Page (Doc ID 2205540.2) – Elasticsearch Installation documentation

– Instructions to move your existing Oracle Secure Enterprise Search (SES) to Elasticsearch

– Implementation documentation for PeopleSoft Search Framework, including Elasticsearch

– Links to PeopleSoft application updates and fixes required for implementing Elasticsearch

– Troubleshooting and support documentation to assist with the installation and implementation

• PeopleSoft Information Portal (www.peoplesoftinfo.com)

– Elasticsearch Spotlight Series Videos:– Strategies for Using Elasticsearch with PeopleSoft

– Deploying Elasticsearch

– Administering and Monitoring Elasticsearch

– PeopleSoft Elasticsearch Concept Page

Documents

PeopleSoft Spotlight Series - Oracle · Title: How to Use the PowerPoint Template Author: rosemarie hitchens Created Date: 5/9/2017 3:53:15 PM