Administering PeoleSft Search Framework in PeopleTools 8 · Typical steps to add a new node to a...

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

Administering PeoleSft Search Framework in PeopleTools 8.56


Introduction

This video attempts to guide you on administering the PeopleSoft Search Framework and monitoring the Elasticsearch cluster.

This video will cover:

• Managing search instances.

• Different types of search definitions.

• Indexing process.

• Failover mechanism from PeopleSoft Search Framework.

• Monitoring an Elasticsearch cluster in Health Center.

Continued. . .


Introduction (cont.)

Additional Resources

You’ll find sources of additional information at the end of this presentation:

• Additional Information

– Information about Elasticsearch documentation.

– Accessing the Elasticsearch Spotlight Series videos.


Administering Search Framework Topics

PeopleSoft Search Framework – An Overview

Managing a Search Instance

Deploying Search Definitions and Categories

Indexing Search Data

Failover Mechanism in Search Framework

Monitoring Elasticsearch in Health Center

Additional Information



PeopleSoft Search Framework provides a centralized interface for:

– Creating search instance.

– Creating search definitions and search categories, including deploying search definitions and categories.

– Building and maintaining search indexes.

– Searching content using Global Search and Search pages.

Continued. . .


PeopleSoft Search Framework –An Overview (cont.)

• PeopleSoft Query or Connected Query

– Create search query

• Search Designer– Create search definition

– Create search category

Continued. . .


PeopleSoft Search Framework –An Overview (cont.)

• Search Administration

– Configure search framework and establish connectivity

– Deploy search definitions and categories

– Create index schedule

– Run index build process

– Monitor index run schedule

Continued. . .


PeopleSoft Search Framework – An Overview (Cont.)

End users can now submit searches against the search engine. End users typically use the following interfaces:

• Global Search.

• Search pages.


Managing Search Instance

• Search instance represents an instance of the search engine and provides connectivity between PeopleSoft and the search engine.

• Search instance can be created through the SEARCH_TEMPLATE template in Automated Configuration Manager.

• Alternatively, a search instance can be created in the Search Admin Activity Guide (PeopleTools, Search Framework, Search Admin Activity Guide, Configuration, Search Instance).

Continued. . .


Managing Search Instance (cont.)

Search Instance Properties section:

• Adding a new node to a search instance.

• Removing a node from a search instance.

Continued. . .



Search Instance Properties page provides options to:

• Configure search options (using Search Options link).

• Interact with the Elasticsearch search engine (using Elasticsearch Interact link).

Continued. . .



Elasticsearch Interact page:

• Cluster– Retrieves Elasticsearch cluster information.

• Count– Retrieves the number of indexed

documents.

• Mapping

– Retrieves attribute mapping information.

• Search

– Retrieves actual application data.


Search Definitions and Categories

• Search definition and search category are created in the Search Designer activity guide.

• Types of search definitions based on the data source.– PeopleSoft Query

– Connected Query

–Web

– File

• Search definition maps the PeopleSoft Query fields, web source, or file source to searchable attributes.

Continued. . .


Search Definitions and Categories (cont.)

• Search definition contains security attributes.

• Search definition can be mapped to more than one search category.

Continued. . .



Search Categories are essential for the Search Framework.

Search categories:

• Organize search definitions into manageable, logical groups of data.

• Are required for searches. Search queries run only against search categories, not search definitions. A search definition must be a member of a search category before it can be searched.

• Improve search performance and results by limiting the number of indexes searched.

Continued. . .



You use the Search Definition and Search Category tasks of the Search Designer Activity Guide to create search definitions and search categories, respectively.

(Navigation:

• PeopleTools, Search Framework, Search Designer Activity Guide, Search Definition.

• PeopleTools, Search Framework, Search Designer Activity Guide, Search Category.)

Continued. . .




• Deploying Search Definitions

• Deploying Search Categories


• DirectTransfer

• Setting Search Options

• Indexing Data within a Date Range

• Monitoring Indexing Process

• Troubleshooting Indexing Process

Continued. . .



• DirectTransfer – a new technology to transfer search documents.

• Introduced in PeopleTools 8.55.17.

• Full DirectTransfer in PeopleTools 8.55.19.

• Supports search definitions based on Query and Connected Query.

Continued. . .

DirectTransfer


DirectTransfer (cont.)

• Applicable to PeopleTools 8.55.17 and 8.55.18 patches and from PeopleTools 8.56.01 to 8.56.03 patch.

• Search Framework routes documents without attachments through Integration Gateway.

• Search Framework routes documents with attachments through the new DirectTransfertechnology. Continued. . .



• From PeopleTools 8.55.19 and later patches and PeopleTools 8.56.04 and later patches, Search Framework uses the DirectTransfertechnology, called Full DirectTransfer, for routing all search documents (with or without attachments) to the Elasticsearch search engine.

• Routing through Integration Gateway is a configurable option.

Continued. . .


• Configuration of settings on the Search Options page:– Enable Attachment Trace

– Attachment handlers

–Max Attachment Error Count

– Full Direct Transfer

• System considerations:

– PeopleSoft

– Elasticsearch

Continued. . .



• Error handling– Error link is displayed on the Build Search

Index page if the transfer of attachment data is not successful.

– Click the Error link to open the Attachment Transfer Exception Details page, which provides information on the request and response.

Continued. . .



• Error handling– Check the AE trace file for the total count of documents.

– The total count of documents should match the document count on the Elasticsearch Interact page.



• Specifying settings on the Search Options page:– Collate Indices

–Number of Shards

–Number of Replicas

Specifying Search Options


• Supports search definitions based on connected query.

• Search definition should have reasonably large volume data.

• Supports full indexing, rather than incremental indexing.

Indexing Data within a Date Range


• Monitoring the Indexing Process.–Monitor the progress of the indexing process on the Process Monitor page.

• Troubleshooting the Indexing Process.– Check the Error or Message Log links on the Build Search Index page.

– Check the Integration Broker queues. Also ensure that the IB Pub/Sub domain is active.

– Check the PeopleSoft MsgLog(<PIA_HOME>\webserv\<DOMAIN>\applications\peoplesoft\PSIGW.war\WEB-INF folder); set the log fence to 5.

– Check the Elasticsearch logs (ES_HOME/logs folder).

Monitoring and Troubleshooting


D E M O N S T R A T I O N


The demonstration discusses the interaction with Elasticsearch using the Elasticsearch Interact link on the Search Instance page. This demonstration assumes the following:

• You’re running a single Elasticsearch instance, for example, PTSF_DEFAULT.

• You’ve set up applications environments, for example, HCM, ELM, and FSCM that are sharing the same Elasticsearch instance – PTSF_DEFAULT.

• On each of your application environments, search definitions and categories are deployed and indexes are generated.

•The Collate Indices option is set to Y on the respective application environments.



The demonstration discusses the Cluster service type and a few of the Cluster APIs. When multiple applications share the Elasticsearch instance, you can retrieve the cluster information from any of the applications.

• Aliases – The search categories that are deployed and indexed are listed here along with the index to which it is deployed to.

• Indices – You will see default index for each environment, security index, and a separate index the HC_HR_JOB_DATA search definition.

•Health of cluster - Retrieves the name of the cluster, the status of the cluster in color codes, the number of nodes, the number of primary shards, etc.



The next three service types – Count, Mapping, and Search – are associated with the search definitions and categories that are deployed and indexed on each application. These service types will retrieve information only of the search definitions and categories deployed and indexed on the individual application environment.



End of Demonstration








Monitoring Elasticsearch In Health Center




• Elasticsearch uses distributed architecture and is built to be always available.

• PeopleSoft Search Framework provides a failover mechanism through multiple nodes in a search instance.

Continued. . .


Failover Mechanism in Search Framework (cont.)

Typical steps to add a new node to a search instance:

1. Install Elasticsearch on a new node.

2. Add the new node to the existing cluster.

3. Add the new node to the existing search instance on the Search Instance Properties page. (Navigation: PeopleTools, Search Framework, Search Admin Activity Guide, Configuration, Search Instance.)

Continued. . .


Failover Mechanism in Search Framework (cont.)

Multiple nodes in a search instance vs. using a load balancer in front of PeopleSoft.

• Node entry should point to the URL of the load balancer.

• Port entry should correspond to the port of the load balancer.


• PeopleSoft Health Center is a monitoring framework that:– Provides monitoring and performance data

– Provides an application dashboard.

– Provides a snapshot of Elasticsearch cluster.

• PeopleSoft Health Center needs to be configured.– Configuration steps described in the Performance Monitor online help.

Continued. . .



• Application Dashboard

• Elasticsearch Cluster Summary Section

– Cluster status color codes: Green, Yellow, Red.

Continued. . .

Monitoring Elasticsearch in Health Center (cont.)


Elasticsearch Cluster Summary Section

• Cluster details dashboard.

• Node details dashboard.

Continued. . .

Monitoring Elasticsearch in Health Center (cont.)


Cluster dashboard displays:– Cluster Summary

–Nodes Summary

– Indices Summary

Continued. . .

Cluster Dashboard


Node dashboard

displays:

– Summary

– JVM Section

Continued. . .

Node Dashboard


Node dashboard

displays:

– File System Section

– Index Activity Section

Continued. . .

Node Dashboard


Node dashboard

displays:

– Cache Activity Section

–Network Section

Node Dashboard


Additional Resources• PeopleTools Elasticsearch Home Page (Doc ID 2205540.2)

• Elasticsearch installation documentation

• 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

• PeopleSoft Elasticsearch Concept Page

http://www.peoplesoftinfo.com/

Administering PeoleSft Search Framework in PeopleTools 8 · Typical steps to add a new node to a...

Documents

Transcript of Administering PeoleSft Search Framework in PeopleTools 8 · Typical steps to add a new node to a...