PeopleSoft Spotlight Series - · PDF file–The Elasticsearch deployment sets up a Windows service. •Verify that the elasticsearch-service-x64 service is present and has status as

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

PeopleSoft Spotlight SeriesDeploying Elasticsearch

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

Introduction

Elasticsearch is an open-source search engine that you can install and deploy within the PeopleSoft Search Framework.

Presentation focus:

• Elasticsearch Deployment Options:– New installation of PeopleSoft 9.2 and Elasticsearch.

– Transition from existing Oracle SES to Elasticsearch with downtime.

– Transition from existing Oracle SES to Elasticsearch without downtime.

• Focus of this presentation: deploying Elasticsearch on a new installation of PeopleSoft 9.2.

Continued. . .


Introduction (cont.)

• Deploying Elasticsearch within the PeopleSoft Search Framework.

• Creating an Elasticsearch search instance.

• Adding additional Elasticsearch nodes.

Note: Other search engines supported by PeopleSoft include Verity and Oracle SES. SES and Verity will be deprecated as of PeopleTools 8.56, but SES will still be supported until April 2018.

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.• Moving from SES to Elasticsearch

• Elasticsearch Terminology

–Table of terminology used in the open-source Elasticsearch product and in the PeopleSoft Search Framework.


Deploying Elasticsearch Topics

PeopleSoft Search Framework and Elasticsearch

Understanding the Elasticsearch DPK

Prerequisites for Deploying Elasticsearch

Deploying Elasticsearch

Creating Elasticsearch Search Instance

Adding Additional Nodes to Elasticsearch Cluster

Additional Information




Understanding Elasticsearch DPK




Adding Additional Nodes in Elasticsearch Cluster




PeopleSoft Search Framework:

• Provides a centralized interface for

– Configuring a search engine.

– Creating search definitions and search categories.

– Building and maintaining search indexes.

– Searching content using Global Search and Search pages.

• For PeopleTools 8.55.11 and higher patch releases, Elasticsearch can be used as a search engine.

Continued. . .


PeopleSoft Search Framework and Elasticsearch (cont.)

• Deployment use cases

– Use case 1 – New installation of PeopleSoft 9.2 and Elasticsearch

– Use case 2 – Transition from existing Oracle SES to Elasticsearch with downtime

– Use case 3 – Transition from existing Oracle SES to Elasticsearch without downtime

Continued. . .



Use case 1 – New installation of PeopleSoft 9.2

and Elasticsearch



Use case 2 – Transition from existing Oracle SES

to Elasticsearch with downtime



Use case 3 – Transition from existing Oracle SES

to Elasticsearch without downtime












The Elasticsearch Deployment Package (DPK):

• Contains scripts to automate most of the tasks needed to set up an Elasticsearch environment.

• Sets up Elasticsearch nodes and cluster.

– A node is a single server that stores your data and participates in indexing and search capabilities.

– A cluster is a collection of one or more nodes that together hold all of your data and provides federated indexing and search capabilities across all nodes.

• Sets up the administrator user and the proxy user.

• Provides option to upgrade a previous Elasticsearch installation.Continued. . .


The Elasticsearch DPK includes:

• Open-source Elasticsearch software.

• PeopleSoft-delivered plug-ins for Elasticsearch.

– Used for authentication, authorization, encryption and file web crawling.

• PeopleSoft-delivered customized code for Elasticsearch.

• Software and scripts for Elasticsearch deployment automation.

– Python and Puppet software and scripts.

• Oracle Java JRE 1.8.

Continued. . .

Understanding the Elasticsearch DPK (Cont.)


Oracle PeopleSoft plans to deliver a new revision of the Elasticsearch DPK.

Refer to the PeopleTools 8.55.11 or Higher Elasticsearch Home Page (Doc ID 2205540.2) for the latest updates.

Continued. . .

Understanding the Elasticsearch DPK (Cont.)












Before deploying Elasticsearch there are hardware requirements and software requirements that must be met, as well as configuration recommendations.

See:

PeopleTools 8.55.11 or Higher Elasticsearch Home Page (Doc ID 2205540.2)

Continued. . .


Prerequisites for Deploying Elasticsearch (cont.)

• Hardware requirements

– Dedicated host computer, RAM, disk space, and CPU.

• Software requirements

– 64-bit Oracle certified platform.

– Physical or virtual Linux or Microsoft Windows Server operating system.

• Other recommendations

– Java heap size, swapping settings, disk drive types and file descriptors and memory-mapped files.











Steps for Deploying Elasticsearch

1. Download and extract the Elasticsearch DPK.

2. Run the DPK setup script to deploy and set up Elasticsearch.

3. Verify the Elasticsearch deployment.

4. Apply bug fixes delivered with the PeopleSoft Update Image.

5. Set up the Elasticsearch instance in the PeopleSoft application.


Step 1: Download and Extract the Elasticsearch DPK

• Download the Elasticsearch DPK zip file from one of the following locations:– My Oracle Support (https://support.oracle.com)

– Oracle Software Delivery Cloud (https://edelivery.oracle.com)

• Extract the DPK zip file into a folder. – In this Spotlight series presentation the

Elasticsearch DPK folder is ES_INSTALL.

– Extract the DPK zip file in the same directory where

you downloaded it to, that is, ES_INSTALL.

– Creates directories as shown here.

Continued. . .

https://support.oracle.com/

https://edelivery.oracle.com/


Step 2: Run the DPK Setup Script

• Execute the Elasticsearch DPK setup script.

• Specify deployment options and settings, including:

– Define the PeopleSoft base directory.- Directory used for Elasticsearch installation and deployment components.

– Define the Administrator user password.• This Administrative user can authenticate requests on Elasticsearch.

– Define the password for Proxy user (people).• The Proxy user enables the PeopleSoft system to log into the search engine using a

proxy identity to run a query.

Continued. . .


Step 2: Run the DPK Setup Script (cont.)

– Define a name for the Elasticsearch cluster and specify the Elasticsearch HTTP port.

– Enter the host name(s) for any node(s) that are already members of a cluster.

– Specify the minimum number of master nodes.

– Specify the path where Elasticsearch data and logs should reside.

– Define the Java heap size.

– Review the status messages as the script runs and sets up the environment for Elasticsearch.

Continued. . .


Step 3: Verifying the Elasticsearch Installation

A successful deployment includes the following:

– The Elasticsearch deployment sets up a Windows service.• Verify that the elasticsearch-service-x64 service is present and has status as Running.

– Elasticsearch data and logs are written to the specified locations.

– These folders are created in the Elasticsearch base installation directory:• Elasticsearch Home folder (<BASE_DIR>/pt/es2.3.2).

• Java JRE folder (<BASE_DIR>/pt/es_jre1.8.0_74).

– These environment variables are set:• JAVA_HOME. Value set to <BASE_DIR>/pt/es_jre1.8.0_74.

• ES_HEAP_SIZE. Value set to that specified when running the setup script.


Step 4: Apply Bug Fixes for Your PeopleSoft Update Image

• To apply support bugs:

– Go to PeopleSoft Update Manager (PUM) Home Page, My Oracle Support, Doc ID 1641843.2.

– Locate and download the current Update Image (PI) for your PeopleSoft application.

Continued. . .


Step 4: Apply Bug Fixes for Your PeopleSoft Update Image (cont.)

– The features and fixes required for Elasticsearch are delivered beginning with the following images:

Product Code Image

PeopleSoft Human Capital Management HCM 9.2.018

PeopleSoft Enterprise Learning Management ELM 9.2.013

PeopleSoft Financials and Supply Chain Management FSCM 9.2.018

PeopleSoft Customer Relationship Management CRM 9.2.011

PeopleSoft Interaction Hub IH 9.1.03












Search Instance

• Represents a single instance of the Elasticsearch search engine.

• Defines the instances that your PeopleSoft application use to provide end-user search capabilities.

Continued. . .


Creating Elasticsearch Search Instance (cont.)

Search Instance (cont.)

• Specifies connectivity and administration settings for running queries against the search server, including:

– Elasticsearch host name.

– Elasticsearch port.

– Elasticsearch Administrator username and password.

– Elasticsearch Proxy username and password.

– More.

Continued. . .



Prerequisites

• Verify that you have the following security roles:

– Search Administrator.

– Search Developer

– Search Server and ACM Administrator

• See the Elasticsearch installation documentation for more information.

Continued. . .



PeopleTools Delivers Two Methods for Creating Search Instances

• Automated Configuration Manager

– Use an ACM template.

– Creates search instance plus search definitions, search categories, and indexing.

• Search Administration Activity Guide – Configuration activity / Search Instance Task.

– Search Instance Properties page.

– Creates the search instance only.• Deploying search definition, search categories, and indexing is done separately.

Continued. . .



Using Automated Configuration Manager

• ACM templates automate the configuration process.

• Use one of these templates based on your PeopleTools version:

Continued. . .

PeopleTools Version ACM Template

PeopleTools 8.55.11 SES_TEMPLATE

PeopleTools 8.55.12 and later SEARCH_TEMPLATE



Using Automated Configuration Manager - Configuration Template Definition Page

Navigation:

1. Select PeopleTools, Automated Config Manager, ACM Templates, Template Definition.

2. Select the SES_TEMPLATE (for PeopleTools 8.55.11)

3. Edit the template.

4. Save and run the template.

Continued. . .



Using Automated Configuration Manager - Configuration Template Definition Page

Navigation:

1. Select PeopleTools, Automated Config Manager, ACM Templates, Template Definition.

2. Select the SEARCH_TEMPLATE (for PeopleTools 8.55.12 and later patches)

3. Edit the template.

4. Save and run the template.

Continued. . .


DemonstrationIn the demonstration, we’re using an environment that is running PeopleTools 8.55.13, so we’ll demonstrate the creating of a search instance and building index using the SEARCH_TEMPLATE template. In the demonstration, first, we’ll create a search instance and verify that the search instance is created. Then, we’ll deploy and build index for the PTPORTALREGISTRY search definition.

• Navigate to Automated Configuration Manager.

• Locate SEARCH_TEMPLATE.

• Edit the delivered template with values as per your environment.

• Run the template.

• Verify that the search instance is created and the PTPORTALREGISTRY search definition and category is deployed and index is built.


Demonstration (cont.)

• Using SEARCH_TEMPLATE – On the Template Definition page, search for SEARCH_TEMPLATE.



Using the Search Administration Activity Guide / Search Instance Properties Page

Continued. . .

Navigation:1. Select PeopleTools, Search Framework,

Search Admin Activity Guide.

2. In the Configuration activity, click the Search Instance task.



Using the Search Administration Activity Guide - Search Instance Properties Page

Continued. . .

To create a search instance:

1. In the Search Instance section, enter a name for the search instance.

2. Select Elasticsearch as the search provider.

3. Specify values in the Search Instance Properties section for the Elasticsearch server.












• Elasticsearch manages failover through multiple nodes within a cluster.

• If a node fails, the other nodes in the cluster provide indexed data when a search is initiated.

Continued. . .


Adding Additional Nodes in Elasticsearch Cluster (cont.)

Adding an additional node involves these steps:

• Install Elasticsearch on a second server.

– Specify the same cluster name.Enter cluster name:

– Specify the IP address of the first node.

Enter host name of nodes which are already member of a cluster

[["127.0.0.1", "[::1]"]]:


Adding Additional Nodes in Elasticsearch Cluster (cont.)

Adding an additional node involves these steps:

• Open the elasticsearch.yml file for editing on the second server.

(Path: ES_HOME/config/elasticsearch.yml)











Additional ResourcesAdditional Information


Additional Resources

Term Use in Open Source Elasticsearch Use in PeopleSoft Search Framework

Cluster

A collection of one or more nodes (servers) that together holds your entire data and provides federated indexing and search capabilities across all nodes.

A cluster is specified (named) during Elasticsearch deployment.

NodeA node is a single server that is part of your cluster, stores your data, and participates in the cluster’s indexing and search capabilities.

A node corresponds to a search instance in PeopleSoft Search Framework.

Index

An index is a collection of documents that have somewhat similar characteristics. In a single cluster, you can define as many indexes as you want.

In a PeopleSoft implementation, by default, all the search definitions/search categories are deployed as part of a single index. However, you can create multiple indexes.

Elasticsearch Terminology

Continued. . .


Elasticsearch Terminology (cont.)Elasticsearch Terminology (cont.)


Type

Within an index, you can define one or more types. A type is a logical category/partition of your index whose semantics is completely up to you.

In a PeopleSoft implementation, each search definition corresponds to a type.

AliasAlias is a reference to an Elasticsearch index. An alias can be mapped to more than one index. That is, an alias enables you to group indexes.

In a PeopleSoft implementation, a search category is mapped as an Alias. The mapping of a search category to Alias allows you to group the search definitions (types in Elasticsearch) so that when search is performed on a search category, it returns documents from all the search definitions under it.

Continued. . .




DocumentA document is a basic unit of information that can be indexed. This document is expressed in JavaScript Object Notation (JSON) format.

Connected Query returns parent and child rows. In a PeopleSoft implementation, each row returned from the main query corresponds to a document and child information is attached to the main query and is sent as one document.

Shards

Elasticsearch provides the ability to subdivide your index into multiple pieces called shards. Thus, shards allow you to horizontally split/scale your content volume. When you create an index, you can define the number of shards that you want. Default value is 5..

Specify the number of shards on the Search Options page in PIA. After an index is created, you cannot change the number of shards.

Continued. . .




Replica Shards

Elasticsearch allows you to make one or more copies of your index’s shards into what are called replica shards, or replicas for short. Replica shards provide high availability in case a shard or a node fails.

Specify the number of replica shards on the Search Options page in PIA. After an index is created, you may change the number of replicas dynamically anytime.

Documents

PeopleSoft Spotlight Series - · PDF file–The Elasticsearch deployment sets up a Windows service. •Verify that the elasticsearch-service-x64 service is present and has status as