Specifying General Settings

Access the General page, by selecting PeopleTools, Search Framework, Search Designer Activity Guide, Search Definition.

Image: General Settings page

This example illustrates the fields and controls on the General Settings page. You can find definitions for the fields and controls later on this page.

Search Definition - General Settings page

Field or Control

Definition

Search Definition

Displays the search definition’s name as specified when adding a new value.

Note: At least one search definition must use the same name as the search category to which it belongs.

Description

Provide any additional information to distinguish the search definition.

Source Type

Displays the type of query used to define the searchable data. Options are: Query or Connected Query.

Source Name

Displays the name of the base Query or Connected Query.

View

Click to view the underlying query or connected query in either Query Manager or Connected Query Manager, respectively. This helps you to better understand the data being indexed by the search definition. When viewing the query or connected query from the PeopleSoft Search Framework, keep these items in mind:

  • To view the query or connected query, you must have the appropriate security permissions in place.

  • You cannot make changes to the query or connected query when accessing it from the PeopleSoft Search Framework. The View button is intended for informational purposes only.

Last Modified Date Time

Select the field specified in the query that determines the underlying record's update date and time. For example, LASTUPDDTTM.

URL Link

Select the query field containing the drilling URL defined for the query.

Image URL

Select the Drilling URL pointing to the image field, as defined in the drilling URL properties for the query. This field appears only if an image URL has been associated with the query.

Title

Define the title of the search result document. This is the bold, first line of the search result.

Both Title and Summary should be granulated enough to be unique (that is, no duplicates among different documents).

You can add text and bind variables to the title by clicking the *Title button. You cannot add text to the edit box directly.

Summary

Define the summary, or body, of the search result text. This is the text that appears below the title in a search result document.

You can add text and bind variables to the summary by clicking the *Summary button. You cannot add text to the edit box directly.

Save As

Click to clone the search definition. In the subsequent page, you need to enter a name for the cloned search definition.

When you clone a search definition, all the meta-data associated with the existing search definition is saved in the cloned search definition.

Note: The Save As button is not available when you create or define a new search definition.

In the Title\Summary dialog box you can insert custom text and bind variables, or a combination of the text and bind variables to accurately express the content of the search result document.

Image: Search Result Title edit box

This example illustrates the fields and controls on the Search Result Title edit box.

Title and Summary edit box

Field or Control

Definition

Insert Bind Variables Title Summary\Insert Bind Variables button

Click to launch the Insert Bind Variables dialog box and insert bind variables of the following types:

  • Query fields

  • Message catalog entries

  • System variables

When inserting bind variables into the title or summary text, you use the icon at the top left corner to open the Insert Bind Variables dialog box, enabling you to select the bind variable type and the specific bind variable. You can insert multiple bind variables and bind variable types within the title\summary text, as needed.

Image: Insert Bind Variables dialog box

This example illustrates the fields and controls on the Insert Bind Variables dialog box. You can find definitions for the fields and controls later on this page.

Insert Bind Variables dialog box

Field or Control

Definition

Query Fields

Use the Query Fields drop-down list to select the desired fields from the underlying query of the search definition.

Message Catalog

Specify the Message Set and Message Number to identify the specific message to display. To determine the text that displays use these options:

  • Message Catalog Text: Displays the Message Text edit box of the message catalog entry.

  • Message Catalog Explanation: Displays the Description edit box of the message catalog entry.

System Variables

Use the System Variables drop-down list to select the desired variable to display.