Administering PeopleSoft Search Framework

This chapter provides an overview and discusses:

Click to jump to parent topicUnderstanding PeopleSoft Search Framework Administration

While the system administration related to the Search Framework architecture can include tasks involving SES, Integration Broker, application server domains, and so on, this section focuses only on the administration tasks that are included in the Search Framework administration interface, specifically under the menu, PeopleTools, Search Framework, Administration.

Click to jump to parent topicWorking With Search Instances

A search instance in the PeopleSoft Search Framework represents a single instance of the search engine. The search instance(s) created using the PeopleSoft Search Framework define the instances that will be used by the PeopleSoft applications to provide end user search.

The search instance definition specifies connectivity and other administration settings required for:

Click to jump to top of pageClick to jump to parent topicCreating Search Instances

To define a search instance, access the Search Instance Properties page by selecting PeopleTools, Search Framework, Administration, Search Instance.

Search Engine Details

To enable connectivity between your PeopleSoft system and SES, you need to provide these search engine values.

SSL Option

Select one of these options for SSL:

  • DISABLE. Select if you do not have SSL configured between SES and your PeopleSoft system.

  • ENABLE. Select if you do have SSL configured between SES and your PeopleSoft system and you want all communication between the servers SSL secured.

Host Name

Enter the server name of the host where SES is running, including the domain. The host name value can be a DNS name or an IP address.

For example:

server1.mycompany.com

or

123.111.4.168.mycompany.com

To specify the host, you may use the host name or an IP address.

Port

Enter the port on which SES listens for requests.

Ping

Click to make sure your host name and port are correct and that the SES server is available. A positive result displays the following message:

Ping Test Result: Success. Oracle Secure Enterprise Search Admin Service Version 11.1.2.2.0 (262,613)

Admin Service Credentials

Specify the SES administrative credentials so that your PeopleSoft system has the appropriate access to connect to the SES server and invoke searches and various administrative tasks, such as deploying search objects, building indexes, scheduling crawling, and so on.

User Name

Enter the user name for logging into the Secure Enterprise Search Administration GUI.

Password\Confirm Password

Enter the password associated with the administrative user name, and confirm it in the edit box below.

Test Login

Click to test the credentials you have specified against the selected SES server. A positive result displays the following message:

Login Success. (262, 615)

Query Service Credentials

Proxy Name

Enter a trusted entity from the list on the Federation Trusted Entities page in the SES Administration interface. (Global Settings, Federation Trusted Entities)

This enables the PeopleSoft system to log into SES using a proxy identity to run a query. In SES, this proxy account is a Trusted Entity. You may need to contact your SES administrator to obtain Trusted Entity credentials or to have those credentials created for the Search Framework query service.

Important! Even though the Search Framework is authenticated by SES as the Trusted Entity, SES uses the identity of the currently signed on PeopleSoft user for query authorization.

Password\Confirm Password

Enter and confirm the password associated with the trusted entity.

Call Back Properties

At times, SES will need to call back to the PeopleSoft system to access services, such as authentication services, so you need to provide the URL and password for this access.

URL

Enter the URL for the PeopleSoft system listening connector, using the following syntax:

http://<server>:<port./PSIGW/PeopleSoftServiceListeningConnector/<node>

User Name

Enter the PeopleSoft user name granted the permission list PTPT3300 with the role Search Server.

Note. This user name must exist as an active user profile on the PeopleSoft system listed in the URL specified. This is generally a system user as opposed to an interactive user. In addition, if you have attachments on an FTP server that will be accessed by SES, this user must also be authorized to access the FTP site.

Password\Confirm Password

Enter and confirm the password associated with the PeopleSoft user name.

Update deployed definitions

Click this link to invoke a bulk update for all definitions currently deployed to the SES server.

If you have changed any of the callback properties (URL, user name, or password), all currently deployed search definitions need to be updated with the new callback values to continue successful interaction with the Search Framework.

See Also

PeopleTools 8.52 Installation for <your platform>: "Configuring Integration Between PeopleSoft PeopleTools and Oracle SES"

Click to jump to top of pageClick to jump to parent topicModifying Search Instances

You can modify any of the search instance values if the information changes for the specified server. That is, if the server receives a new IP address or a new DNS name, if the port for the search services changes, or if any credentials change, then the values can be updated as needed.

Important! You may not reuse a search instance entry for an entirely new instance of a search server. For example, if an existing search instance is no longer available, do not reuse the same PeopleSoft Search Instance entry for a new server. This causes unintended and undesired results.

Click to jump to top of pageClick to jump to parent topicDeleting Search Instances

Deleting a saved search instance is not supported.

Click to jump to parent topicAdministering Search Definitions and Search Categories

This section contains an overview and discusses:

Click to jump to top of pageClick to jump to parent topicUnderstanding Search Definition Administration

You create search definitions using the Search Framework Designer interface after the data is identified using PeopleSoft Query and Connected Query. You use the Search Framework Administration interface to deploy the search definitions and manage the search definitions on the SES server.

Before end users can run searches against the search indexes, the search definitions need to be deployed to the SES search engine so that SES can create the structure of the search index based on the search definition, crawl the defined search criteria, and populate the index with the results of the search definition query. When your search definitions are deployed on SES, they become an SES source that you can view under the Sources tab in the SES administrative interface.

Once the search definitions are deployed to SES, you use the Search Framework administration interface to manage them by sorting them in search categories, updating them, undeploying them, or deleting them as needed.

Click to jump to top of pageClick to jump to parent topicWorking with Search Definitions

To manage search definitions, access the Search Definitions page by selecting PeopleTools, Search Framework, Administration, Deploy\Delete Object.

Search Category Name

Use to display only those search definitions associated with a particular search category.

Filter by name

Use to enter full or partial definition names to reduce the list of search definitions appearing in the grid.

Note. The values are case-sensitive.

Deploy Search Definition (grid)

Displays all existing search definitions defined in the Search Framework. Columns in the grid are:

  • Deployable Definition Name. Displays the name of the search definitions you've created. Deployable search definitions are having a data source created in Query or Connected Query, as well as being defined in the Search Framework Designer interface.

  • Description. Displays your search definition description.

  • Status. Displays the state of search definition deployment: A search Definition is either Deployed or Undeployed.

  • Update Status. After running the Report Sync Issues audit, the results appear in this column indicating any required updates.

Select All

Click to select all the rows within the grid.

Note. If all rows in the grid have been selected, the button title changes to Deselect All.

Report Sync Issues

Runs an audit checking routine which reports where properties for a search definition differ between PeopleSoft and SES. If you have updated a deployed search definition it will no longer be synchronized with the representation on SES. Results of this check appear in the Update Status column (which, in the case of differences between the corresponding definitions becomes the View Report column). This applies only to deployed definitions.

Deploy

Deploy the PeopleSoft search definitions selected to the search engine (SES), where it becomes a searchable data source.

Note. You can deploy multiple search definitions at a time by selecting the corresponding check box in the first column of the grid and then choosing Deploy.

Note. When you deploy a search definition, the search category of the same name is automatically deployed.

Undeploy

Click to remove the representation of the selected search definitions from the search engine (SES).

Note. You can undeploy multiple search definitions at a time by selecting the corresponding check box in the first column of the grid and then choosing undeploy.

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

Note. The undeployed search definition will be removed from SES but it will still exist within the PeopleSoft system.

Note. For large indexes, it is recommended to undeploy them during the non-peak hours for performance reasons. While the status displays undeployed, the actual deletion occurs on SES asynchronously, and undeploying a larger index requires additional time on SES.

Update

Click to update the representation of the search definition on SES. If you have modified a deployed search definition, the PeopleSoft version and the version on SES will no longer match. Definitions that need to be updated will appear in the synchronization report. Clicking Update synchronizes the SES representation of the definition to match the PeopleSoft version.

Delete

Deletes the search definition from the Search Framework. This removes the search definition from the search definition list and from the search categories to which it is mapped. The underlying query and connected query are unaffected.

Running the Synchronization Report Process

In the event of differences found between the two systems, Search Framework prepares a Search Definition Compare Report, which you access by clicking the View Report link in the View Report column. Depending on the status of your search definitions in both the PeopleSoft system and the SES system, the results of the synchronization report will vary. This table describes some likely scenarios and the recommended action.

Update Status

Recommended Action

No update required for the definition.

No action is required. The definitions are identical between the two systems.

Update required definition out of sync.

Click the View Report link in the View Report column, and examine the reported differences. Resolve the differences as needed between the two systems, or click Update.

Definition unavailable in server.

Click the Reset Definition for Deploy link in the View Report column. This removes the previous definition on SES or any remaining settings related to it, making it available to be deployed again.

Undeployed definition. Choose a deployed definition.

Ignore the report if the definition is purposely undeployed, or deploy the definition.

When you select View Report, you may see a screen similar to this:

Property Type

Displays properties that have found to differ between the two systems. The values appearing in this column can be numerous, representing all the possible settings for a search definition, such as user ID, category, call back URL, and so on.

PeopleSoft

Displays the value defined for the search definition within the PeopleSoft system.

Search Server

Displays the value stored for the property on the search server.

OK

Click OK to leave the report and return to the previous page.

Updating Definitions

In the event of updates being required, clicking Update makes the version of the search definition on the search server match the properties for that definition stored within the PeopleSoft system. After the process runs, you should see in the Update Status column the following message:

Updated definition <definition name>

Click to jump to top of pageClick to jump to parent topicWorking with Search Categories

Search categories enable you to group search definitions within logical, manageable groups. You define search categories within the Search Framework Designer interface.

To manage search categories, access the Deploy Search Categories page by selecting PeopleTools, Search Framework, Administration, Deploy\Delete Object, Deploy Search Category.

Filter by name

Use to enter full or partial definition names to reduce the list of search categories appearing in the grid.

Deploy Search Category (grid)

Displays all existing search categories defined in the Search Framework. Columns in the grid are:

  • Deployable Definition Name. Displays the name of the search categories you've created. Deployable search categories are those having been defined in the Search Framework Designer interface.

  • Description. Displays your search category description.

  • Search Instance Name. Displays the search instance to which a search category is deployed.

  • Deploy Related Search Definition. Click to display the Deploy Search Definition page with the grid populated only with search definitions within the selected search category.

  • Status. Displays these states of search object deployment: Deployed, Undeployed or Auto Deployed. Search categories will be automatically deployed (Auto Deployed) if a search definition with the same name is deployed. You need to deploy search categories covering multiple search definitions manually.

  • Update Status. If you run a Report Sync Issues process from the Deploy Search Definition page, the process populates this column too if there are any differences between search categories on the two systems (PeopleSoft and SES).

Select All

Click to select all the rows within the grid.

Note. If all rows in the grid have been selected, the button label changes to Deselect All.

Deploy

Deploy the PeopleSoft search category to the search engine.

Note. You can deploy multiple search categories at a time by selecting the corresponding check box in the first column of the grid and then choosing Deploy.

Important! You must first deploy all the search definitions within a search category before deploying a search category. A search category cannot be empty on the search engine.

Undeploy

Click to remove the search category from the search engine.

Note. The search category will be removed from SES, but it will still exist within the PeopleSoft system.

Note. This does not undeploy the search definitions associated with a search category.

Delete

Deletes the search category from the Search Framework.

Note. This does not delete the search definitions associated with a search category.

Click to jump to parent topicManaging Search Context

This section provides an overview and discusses:

Click to jump to top of pageClick to jump to parent topicUnderstanding Search Contexts

Use search contexts to define which search groups appear in the search group drop-down Application Search Bar, depending on the context of the user. That is, depending on where users are in the interface, which determines their context, you can control what appears in the drop-down.

A search group is a search categories that you enable for the purpose of setting up search contexts. Search groups can fall into these three search contexts:

At each of these levels, a default search group can be selected. It is not required to have a default search group for any level.

Click to jump to top of pageClick to jump to parent topicDefining Search Contexts

Access the Define Search Context page by selecting PeopleTools, Search Framework, Administration, Define Search Context and choosing the appropriate context type (homepage, portal node, or work center).

Use the plus and minus buttons to add and remove the search categories to and from the search context.

Default

Select for the category that should be the default if the end user does not select a particular category.

Only one default search category can be selected for a search context.

Note. If no categories are added to the grid, then "all" will be the default, which means users can search across all search groups to which they have access.

Sequence

Specify a numerical sequence to define the order in which the search categories will appear in the Application Search Bar drop-down list.

Search Category Name

Select the search category to include for this search context.

Click to jump to top of pageClick to jump to parent topicViewing Search Contexts

To view your defined search contexts, access the View Search Contexts page by selecting PeopleTools, Search Framework, Administration, View Search Contexts.

Filter Contexts

Use the Filter Context controls to customize and narrow the contexts displayed.

Context Type

Select the context type you wish to view.

Node Name\Workcenter ID

Enter a specific node name or work center.

Clear

Click to clear the previous filter criteria.

Search Contexts

The Search Contexts section displays the search contexts that meet the criteria specified in the Filter Contexts section.

Edit Context

Click to modify the search context definition. The link opens the Define Search Context page with the selected search context open.

Click to jump to parent topicImporting Remote Search Groups

You can share search groups between databases to enable seamless navigation between systems. However, the nodes and the search groups need to be known to all systems involved. The imported search groups are treated as local search groups, and need to be modified as such. For example, imported groups need to be included in the search contexts to become available.

When you import search groups, you import them from a remote node, as defined in your Integration Broker configuration. When importing search groups, keep the following items in mind:

To import search groups from other systems, access the Remote Search Groups page by selecting PeopleTools, Search Framework, Administration, Remote Search Groups.

Note. Importing remote search groups retrieves all the search groups defined in that content system along with all related search categories, associated search definitions, and the list of faceted attributes.

Content Provider

Select the remote node defined in your system from which you want to import search groups.

Content providers must be defined as nodes known to your system using Integration Broker.

Import

Click to invoke the import process. This will import all search groups from the selected node.

Delete

Click to remove any unnecessary or obsolete search groups from your system.

See Also

Adding and Configuring Nodes

Setting Portal Nodes

Click to jump to parent topicWorking with Search Indexes

This section contains an overview and discusses:

Click to jump to top of pageClick to jump to parent topicUnderstanding the Index Build Process

Before end users can submit search requests against the Search Framework deployed objects, the search indexes must first be built on the search engine. Prior to the index being built, a deployed search definition is an empty shell, containing no searchable data. A search index needs to be built for each individual search definition.

An Application Engine program, PTSF_GENFEED, builds the search index and makes it available for SES.

Creating a search index with the Search Framework involves the following technologies:

Once you invoke a search index build from the Build Search Index page, the system automatically completes these general steps:

  1. The Schedule Search Index page initiates the PTSF_GENFEED Application Engine program.

  2. The Pre Processing Application Engine program defined for the search definition runs.

  3. PTSF_GENFEED Application Engine program runs the query (PeopleSoft Query or Connected Query) associated with the search definition.

  4. The output of the query becomes a data source for the Feeds Framework.

  5. The Feeds Framework converts the query output to an Oracle RSS Schema format and writes the SES Feed to the Integration Broker queue, and the Deletion query defined for the Search Definition runs.

  6. The Search Framework then creates an SES Schedule for the SES source associated with the search definition and sets the schedule disposition to "CRAWL immediately."

  7. The Post Processing Application Engine program defined for the search definition runs.

  8. The SES Crawler, using the URL of the Integration Broker queue where the SES Feed is located, initiates the crawling of the SES Feed.

Click to jump to top of pageClick to jump to parent topicBuilding Search Indexes

Access the Build Search Index page. (Select PeopleTools, Search Framework, Administration, Schedule Search Index.)

To build a Search Framework search index:

  1. Select PeopleTools, Search Framework, Administration, Schedule Search Index.

  2. Enter a run control ID.

  3. On the Build Search Index page, select the appropriate options.

    Search Definition

    Select the search definition for which you are building the search index.

    Note. Each search definition needs its own index build scheduled individually. Once the Run Control is executed, the page becomes read-only. To change any parameters of the page, you need to create a new run control.

    Indexing Type

    Select one of the following:

    • Full index. Crawls all transactional data specified by the query criteria and rebuilds the entire index. This option requires the most time. This option must be selected the first time an index is built.

    • Incremental index. Updates the existing index and adds only documents associated with rows that have been added or updated since the last index build or update. The system determines the required updates based on a comparison between the timestamp of the index and the “last updated” field for the data row.

    Note. It is recommended to create one run control for incremental indexing, scheduled to run very frequently, and create another run control for full index rebuilding set to run less frequently. For example, incremental indexing might run daily, where a full index rebuild may be set to run every six months.

    Language Options

    Select one of the following:

    • All Languages. Builds an index for each language enabled on the database.

    • Base Language. Builds an index only for the base language defined for the database.

    Your selection depends on the languages enabled for your database and the languages through which you anticipate end users using to perform searches.

  4. Click Run.

  5. Use Process Monitor to verify program completion and success.

Note. Consider setting up separate run controls for full index builds and incremental index builds.

Note. Once the Run Control is executed, the page becomes read-only. To change any parameters of the page, you need to create a new run control.

Click to jump to top of pageClick to jump to parent topicViewing Search Index Build Process Details

After the PTSF_GENFEED program begins to run, you can view the details regarding that program run, which display on the Build Search Index page for that run control ID.

Note. The Details section shows the results of the most recent feed generation for this Search Definition. It may not be the same run control ID as the one you selected. If the run control ID differs from the one you selected, it will be highlighted.

Previous schedule status

Displays the status of the most recently executed index build process.

AE Status

Indicates whether the most recently executed PTSF_GENFEED Application Program ran to completion.

If the index build fails, this field displays the step where the process failed.

Resume Schedule

Appears in the case where the index build failed. If the index build fails, review the Crawler Log Files in the SES administration console. After determining and fixing the root cause, you can set the index build to:

  • Restart SES Crawl: Re-starts the SES crawl process on the previously generated feed.

  • Rebuild Index: Regenerates the search feed.

Feed generation status

Indicates whether the system successfully created the feed output, required to populate the index.

User ID

Displays the User ID who ran the run control, which may be a different user ID than the user who created the run control.

Language Option

Displays the language options selected for the index build process (All Languages or Base Language).

Indexing Type

Displays the index type (Full Index or Incremental Index).

Generated segment count

A segment is a chunk of XML which is complete in and of itself. A segment size is determined by the PeopleTools Options setting "Maximum Message Size." The number of segments is roughly equivalent to the size of the data divided by the Maximum Message Size setting.

See PeopleTools Options.

Segments returned to crawler

This is the number of segments sent to the crawler for indexing. This information may be useful in debugging issues where the feed generated does not equal the number of indexed segments.

Datetime prompt value

Displays the datatime prompt value for your underlying search query. If this is the first time running the process for a search index, the system uses 01/01/1900 to gather all possible data. For the incremental index, the data displayed represent the datetime that the last index was built. This date will be used for the next run to determine the incremental data that should be included.

View data feed

Click to view the extracted date that has been applied to the search index on the SES system. The data is in XML format.

A row appears in the grid for each language for which the system included in the index build. The link takes you to the Integration Broker Service Operations Monitor, Asynchronous Details page.

Note. To view the feed in the Integration Broker Monitor, you need security access to those pages.

Click to jump to top of pageClick to jump to parent topicViewing Search Index Feed XML

You may need to view the source XML for the search index to ensure the system is capturing the data you want populating your index or for other troubleshooting tasks.

To view the source XML feed data:

  1. Select PeopleTools, Search Framework, Administration, Schedule Search Index.

  2. Enter the appropriate run control ID.

  3. Expand the Details section for the search index build run.

  4. Click the View data feed link in the Language Code grid.

    This takes you to the Integration Broker Service Operations Monitor, Asynchronous Details page.

  5. On the Asynchronous Details, click Download XML.

Click to jump to parent topicWorking with Search Framework Definitions During Upgrades

These Search Framework definitions are managed objects, meaning they can be upgraded, added to projects, compared, copied, and so on: