Understanding the OSK DPK

This release of PeopleSoft PeopleTools supports the open-source OpenSearch suite for search, insights, and analytics. OpenSearch is a fully open-source search and analytics suite.

PeopleSoft PeopleTools 8.63 supports OpenSearch 3.2.0, OpenSearch Dashboards 3.2.0, Logstash 9.1.3, Data Prepper 2.10.2 and Fluent Bit 4.2.2.

For the most current information on the supported versions of OpenSearch, OpenSearch Dashboards, and Logstash, see the PeopleSoft Search Insights Home Page, (My Oracle Support, KA592) and the My Oracle Support certification matrix.

Oracle provides deployment packages that deliver the required OpenSearch software version, OpenSearch Dashboards, Logstash, Java-based plug-ins needed for integration with PeopleSoft environments, and customized code where required. Be sure to obtain and use the DPKs as described in this documentation.

The OSK DPK, which includes OpenSearch, OpenSearch Dashboards, Logstash, Data Prepper, and Fluent Bit, is supported on Linux and Microsoft Windows operating systems. Oracle recommends that the OpenSearch, OpenSearch Dashboards, and Logstash DPK be installed on servers that are separate from those used for PeopleSoft installations. You download the DPK from Oracle Software Delivery Cloud or My Oracle Support.

The OSK DPK includes:

  • OpenSearch

    OpenSearch is an open-source search engine used for the PeopleSoft Search Framework. OpenSearch is an open-source version of the Elasticsearch source code and is licensed under Apache Version 2.0, a Java-based information retrieval library.

  • OpenSearch Dashboards

    Use OpenSearch Dashboards to visualize data for OpenSearch server monitoring and application index monitoring, and to create PeopleSoft Insights to visualize application search indexes. The installation of OpenSearch Dashboards is optional.

    Note:

    The documentation typically refers to OpenSearch Dashboards when discussing installation and setup. The visualizations that users create with OpenSearch Dashboards are PeopleSoft Insights or simply Insights.

  • Data Prepper 2.10.2 and Fluent Bit 4.2.2, which are used by the PeopleSoft Log Analyzer.

    See Performance Monitor: Understanding Log Analyzer Manager.

  • Logstash

    Logstash collects JMX (Java Management Extensions) metrics from JMX servers and provides them to the search engine. The PeopleSoft Health Center displays the charts and data using OpenSearch Dashboards.

    The OSK DPK includes an input plug-in for the JMX agents used for the PeopleSoft Health Center. The installation of Logstash is optional. For the current release, Logstash is supported for use with PeopleSoft Health Center, and as a part of the external data integration feature. Due to security concerns, any other data indexed using this Logstash will not be supported.

  • PeopleSoft-developed plug-ins for OpenSearch, OpenSearch Dashboards, and Logstash

  • PeopleSoft-delivered customized code for OpenSearch

  • Oracle Java 21

  • Open-source Python software

  • PeopleSoft-developed Python scripts for OpenSearch deployment automation

The OSK DPK installation enables automatic setup of OpenSearch clusters, nodes, administrator user, and proxy user.

The following considerations were made when these DPKs were designed:

  • System administration experience with PeopleTools is required. If you are new to the PeopleSoft system, it may be necessary to familiarize yourself with the PeopleSoft architecture before proceeding.

  • System administration experience with OpenSearch is required. If you are new to the OpenSearch system, it may be necessary to familiarize yourself with the OpenSearch architecture before proceeding.