PeopleSoft Search Framework Architecture

The server topology uses the essential elements of the PeopleSoft Internet Architecture, with the addition of Elasticsearch server.

PeopleSoft server architecture connected to Elasticsearch using Integration Broker and DirectTransfer

The web server and application server (the PeopleSoft Internet Architecture) provide the interface for the design, administration, and end user access. The PeopleSoft database stores the PeopleSoft queries that define the search data as well as the search definition meta data. PeopleSoft uses the Process Scheduler and Integration Broker’s publishing and subscription functionality to push application data to the Elasticsearch server. In Full Direct Transfer mode, PeopleSoft Search Framework pushes the documents with attachments and documents without attachments to Elasticsearch and bypasses Integration Broker. Elasticsearch stores the deployed search definitions and performs the typical search engine tasks, such as building indexes, crawling for updates, maintaining indexes, and servicing end-user search requests. An Elasticsearch cluster can have multiple nodes that assist in providing high availability and fail-over mechanism. Within the cluster, Elasticsearch internally maintains indexes among the nodes.

The following diagram depicts the relationships between all of the separate elements that are involved with the PeopleSoft Search Framework.

PeopleTools elements interacting with Elasticsearch elements

The following table describes the PeopleTools elements.

PeopleTools Element	Description
PeopleSoft Internet Architecture	Enables access to all aspects of the PeopleSoft Search Framework, including development, administrative, and end user interfaces.
Search Framework Designer	Enables application developers and implementation teams to perform design-time tasks, such as map query fields to search metadata, define search attributes, create search definitions, and create search categories.
Search Metadata	The metadata defined with both PeopleSoft Query and the Search Designer to describe the data that end users will run searches against.
PeopleSoft Query Connected Query	Provides familiar interface for creating SQL queries that declare exactly the data against which end users will run searches, and takes advantage of Query security.
Process Scheduler Integration Broker Publishing and Subscription	Facilitates the transfer of application data from PeopleSoft to the Elasticsearch server.
Search Framework Administration	Provides the interface for system administrators to perform tasks, such as creating a search instance, deploying search objects, and scheduling search index builds.
SFTP/HTTP Repository Server	Facilitates storing of attachments, which are associated with search definitions.
Search Framework User Interface	Provides the PeopleSoft application end user with the appropriate prompts and fields by which they can submit a search request and review results.
Search Query API	A PeopleCode API that enables application developers to form a valid search request from user input.
PeopleSoft Integration Broker	Facilitates the integration between PeopleTools elements and the search engine (Elasticsearch).
DirectTransfer	Facilitates the transfer of application data to the search engine (Elasticsearch) directly; bypassing the Integration Broker.

The following table describes the Elasticsearch elements.

Elasticsearch Element	Description
Indexing Process	The indexing process indexes document search attributes such as Title, Summary, search fields (fields to index), and so on. It can also index document-level security attributes if document-level security is being used. The indexing process uses two plug-ins: Mapper attachment plug-in - Elasticsearch uses this plug-in to process attachments, both from the database and from the repository (FTP, SFTP, HTTP). Note: In the PeopleSoft implementation of Elasticsearch 6.1.2, Elasticsearch uses the ingest-attachment plug-in to process attachments. Delete by Query plug-in - Elasticsearch uses this plug-in to delete the indexed data when you attempt to build an index again (incremental and full indexing).
Security Plug-in	This module gets invoked from the search engine for a user who initiates a search from an application. The search security framework is responsible for authentication, search user validation, and authorization of the search query request. The search engine does a callback with the call back user credentials and passes the search user ID to the PeopleSoft Security Service (Web service) which authorizes the users and gets security attribute for that user. Search results are filtered based on this security attribute. The security plug-in is built on top of the Elasticsearch Search Engine. In Elasticsearch 2.3.2, two security plug-ins are used: Authentication plug-in and Authorization plug-in. Authentication plug-in is responsible for authenticating search users. Authorization plug-in is responsible for getting security attributes for search users and filtering the search results based on the security attributes. Note: In the PeopleSoft implementation of Elasticsearch 6.1.2, the security plug-in (orcl-security-plugin) is used.
Administrative REST APIs	The administrative tasks include various processes, such as, deploying, undeploying, report synchronization, and updating. The http methods of GET, PUT, POST, and DELETE are used while sending the REST API requests to Elasticsearch. Delete By Query is a plug-in, which Elasticsearch uses to delete indexed data. Delete By Query is triggered when you: Undeploy a search definition, which is part of a collated index. Note: In the PeopleSoft implementation of Elasticsearch 6.1.2, collated index is not supported, that is, each search definition is an individual index. See Managing General Search Options. Initiate full indexing process. You should keep the following points in mind: The function of the Delete By Query plug-in is different from the function of the Delete button on the Deploy/Delete page. The Delete by Query plug-in does not remove the index mapping from Elasticsearch; it removes the indexed documents. The function of the Delete By Query plug-in is different from the Delete Query process in incremental indexing.
Query REST API	The Query plug-in works in conjunction with the PeopleCode Search API for application developers to compose search queries and execute them. The Query plug-in exposes various search features like filtering, sorting, grouping, restricting search scope, pagination, and so on.
Search Engine	PeopleSoft Search Framework works with Elasticsearch search engine. Elasticsearch is an open-source search engine, which is based on Apache Lucene™.