PeopleSoft Enterprise Order Management 9.1 PeopleBook

Working with the Verity Search Engine in PeopleSoft Order Management

This chapter provides an overview of the Verity search engine and discusses how to:

Enable the Verity search engine.
Implement Verity search.
Configure Verity search indexing options.

Understanding the Verity Search Engine

This section discusses the ways available to use the Verity search capability and the predefined Order Management data object sets, search queries and search query data.

Customer Service Representatives (CSRs) often need to locate products or customers. The Verity search engine offers CSRs a flexible search mechanism. The Verity search engine searches records and fields to locate the requested information. For instance, if a CSR wanted to find all items with a specific description, he would identify the description on the search page and the search engine would locate the information from data contained in the specified records and fields.

PeopleSoft Order Management is delivered with Verity search capability. The Verity search collection is predefined but can be expanded if necessary.

Three ways are available to use the Verity search capability that is provided with PeopleSoft Order Management.

Use the predefined search collection and do not add fields to the search or the search results page.
Add additional fields as searchable criteria but do not add these fields to the search results page.
Add additional fields to the search and result pages.

Using the Predefined Order Management Verity Search Collection

PeopleSoft Order Management is shipped with a predefined Verity collection, which is a grouping of fields that are used by the Verity search engine to index and assist users in their search for products. To use the base Verity search collection, you need to enable the Verity Search option on the Order Management Installation Options page.

Adding Fields as Searchable Criteria

You can add fields to the verity collection if you want to expand the list of fields that you can use to perform a verity search.

When you add fields to the collection, you can use either batch updates and rebuild or incremental updates to build Verity index collections. You then perform searches against this collection.

Use the PeopleSoft Application Engine process (SAC_IDX_DATA) to build the Verity collection, which is accessible from the Build Verity Collection page. This process extracts data from the database and writes a few intermediate text files: the BIF files and the DAT files. These files are indexed into the Verity collection, which comprises multiple file folders.

See Defining New Search Index Fields.

Adding Fields as Searchable Criteria and to the Results Page

Adding a field to the results page of the verity search is slightly more complicated. You need to add the field to the verity search and rebuild the index but you also need to use the Application Designer to add the new search fields to the Order Entry Verity Search page (ORDENT_VERITY_SEC).

See Defining a New Search Query.

Predefined Order Management Data Object Sets

Several predefined data object sets are shipped with PeopleSoft Order Management. The tables will include all system data:

Record Name	Description	Sample Where Clause
SAC_IDX_DOS_HDR	Data Object Set Header	DOSET_NAME = 'OM_CUST_SOLDTO'
SAC_IDX_DOS_LN	Data Object Set Line	DOSET_NAME = 'OM_CUST_SOLDTO'
SAC_IDX_TBL	Search Index Table	INDEXNAME = 'OM_CUST_SOLDTO'
SAC_IDX_FIELDS	Search Index Fields	INDEXNAME = 'OM_CUST_SOLDTO'
SAC_IDX_DOS_XRF	Search Index and DO Set Cross Reference	INDEXNAME = 'OM_CUST_SOLDTO'

Predefined Order Management Search Queries

Several predefined search queries are shipped with PeopleSoft Order Management. The tables will include all system data:

Record Name	Description	Sample Where Clause
SAC_SRCH_QRY	Search Query	SRCH_QRY_ID = 'OM_CUST_SOLDTO'
SAC_SRCH_QRYFLDS	Search Query Fields	SRCH_QRY_ID = 'OM_CUST_SOLDTO'

Predefined Search Query Data

Several predefined search query data sets shipped with PeopleSoft Order Management. The tables will include all system data:

Record Name	Description	Sample Where Clause
SAC_SRCH_RSLT	Search Result	SRCH_RSLT_ID = 'OM_CUST_SOLDTO'
SAC_SRCH_RSLTFDS	Search Result Fields	SRCH_RSLT_ID = 'OM_CUST_SOLDTO'
SAC_SRCH_RLTQRY	Search Result Query Association	SRCH_RSLT_ID = 'OM_CUST_SOLDTO'

Enabling the Verity Search Engine

This section discusses how to enable the Verity search engine for use with PeopleSoft Order Management.

Page Used to Enable the Verity Search Engine

Page Name	Definition Name	Navigation	Usage
Order Management Installation Options	INSTALLATION_OM	Setup Financials/Supply Chain, Install, Installation Options Click the Order Management link.	Enable Verity search for the sales order.

Page Name

Definition Name

Navigation

Usage

Order Management Installation Options

INSTALLATION_OM

Setup Financials/Supply Chain, Install, Installation Options

Click the Order Management link.

Enable Verity search for the sales order.

Enabling the Verity Search Engine

Access the Order Management tab (click the Order Management link on the Order Management Installation Options page).

Verity Search

Select to enable Verity search for Order Management.

Note. When this option in selected, Verity search is enabled in addition to the PeopleTools standard search. If Verity Search is not selected, only the PeopleTools standard search is available.

Implementing Verity Search

This section discusses how to:

Define subject areas.
Define source data objects.
Identify fields.
Define expressions.
Define customer filters.

You can implement Verity search for sold to customer, ship to customer, bill to customer, and product. The implementation for each is similar to the product implementation. Only the product implementation is described here.

Pages Used to Implement Verity Search

Page Name	Definition Name	Navigation	Usage
Subject Areas	EOEW_OBJ_OWNER	Enterprise Components, Data Transformation, Setup Subject Areas, Subject Areas	Define subject areas, which are grouping mechanisms on translation sets, transformations, map rules, and map definitions.
Source Data Object	EOEW_SRCDO	Enterprise Components, Data Transformation, Define Source Data Objects, Source Data Object	Define a source data object.
Fields	EOEW_SRCFIELD	Enterprise Components, Data Transformation, Define Source Data Objects, Source Data Objects, Fields	Identify fields that are needed from the source record tables.
Expressions	EOEW_SRCFIELDEXPR	Enterprise Components, Data Transformation, Define Source Data Objects, Source Data Objects, Expressions	Define custom expressions to run against the source record.
Filters	EOEW_SRCFILTER	Enterprise Components, Data Transformation, Define Source Data Objects, Source Data Objects, Filters	Define a custom filter for the source record.
Preview	EOEW_SRCPREVIEW	Enterprise Components, Data Transformation, Define Source Data Objects, Source Data Objects, Preview	Preview the results of the SQL query. Click the Preview button to view a listing of the search criteria applied to the current data set.
View Query	EOEW_SRCQUERY	Enterprise Components, Data Transformation, Define Source Data Objects, Source Data Objects, View Query	View the SQL query. Click the Generate SQL button to view the SQL statement being built for this data source object.

Defining Subject Areas

Access the Subject Areas page (Enterprise Components, Data Transformation, Setup Subject Areas, Subject Areas).

Subject Area

Displays the group translations sets, transformations, map rules, and map definitions.

Description

The description that you use to identify the specific source data object.

Default Subject Area

Select this option if you want this subject area to be a default subject area.

When this option is selected, the subject area will be given as default when you create the source data object. If no default subject area exists, then when you create the source data object you must select a subject area.

Tablespace Name

Select the tablespace name that is associated with this subject area.

Create Temporary Table

Select this option if you want a temporary table to be created during the index process.

Defining Source Data Objects

Access the Source Data Object page (Enterprise Components, Data Transformation, Define Source Data Objects, Source Data Object).

Source Data Object

Identify a grouping of source records.

Subject Area	Select the group translations sets, transformations, map rules, and map definitions.
Description	Displays the specific source data object.
Source Record	Tables where you store fields within the PeopleSoft system, and where you want to define a relationship. For example, you may want to identify a relationship between the ship-to customer and the sold-to customers.

Identifying Fields

Access the Fields page (Enterprise Components, Data Transformation, Define Source Data Objects, Source Data Objects, Fields).

Source Data Object

Displays the internal ID for the source data object.

Source Record

Displays the source record for the source data object.

Source Fields

Displays the source fields for the source in the source record for the source data object.

Defining Expressions

Access the Expressions page (Enterprise Components, Data Transformation, Define Source Data Objects, Source Data Objects, Expressions).

Name

Displays the field name being referenced.

Field Type

Displays the type of field being referenced.

Length

Displays the length of the field being referenced.

Expression Statement

Enter the search expression that you want performed when this data object is referenced.

Clear

Click to clear the expression statement that is currently displayed in the Expression Statement field.

Operators

Select one or more operators to use to build your expression statement.

Data Source

Select a data source: Values are:

Data Object Column: If you select this value, you must also select a data object column from the menu provided. This column will be used as a building block for your query.

Built in Function: If you select this value, you must also select a built in function from the menu provided. This function will be used as a building block for your query.

Constant Value: If you select this value, you must also select a constant value from the menu provided. This value will be used as a building block for your query.

Defining Custom Filters

Access the Filters page (Enterprise Components, Data Transformation, Define Source Data Objects, Source Data Objects, Filters).

Record Name	Select the record name to use to filter data.
Field Name	Select the field to use to filter values.
Operator	Select an operator to use to build your filter.
Value	Enter a specific value to use to filter.
Save Filters	Click the Save Filters button to reflect changes made on this page. This action captures the changes that are made to the Filters fields listed previously.

Configuring Verity Search Indexing Options

This section provides an overview of verity search index options and discusses how to:

Define a new search.
Define new search index fields.
Define a new search query.
Define the display for new search results.
Define a new search option.
Create and update the verity search collection.

Understanding Verity Search Index Options

PeopleSoft Order Management enables you to dynamically add or remove records and fields from the Verity search engine. To do this:

Determine whether an existing data object contains the field that you need to add or remove.
If you do not have an existing data object, create one.
Select the field from the data object and then index it as a field or a zone.
Either map the Verity field or zone to the database field, or define processing logic.
Build the verity collection.

Pages Used to Configure Verity Search Indexing Options

Page Name	Definition Name	Navigation	Usage
Define Search Index	SAC_IDX_DEFINE	Setup Financials/Supply Chain, Common Definitions, Search Indexes, Define Search Index	Define a new search. Identify the data object set, which contains the data source object, records, and fields. The data identified here becomes the search details on the sales order.
Define Search Index Fields	SAC_IDX_FIELDS	Setup Financials/Supply Chain, Common Definitions, Search Indexes Select the Define Search Index Fields tab.	Select fields from source records that will be used in the search index.
Define Search Query	SAC_SRCH_QRY	Setup Financials/Supply Chain, Common Definitions, Search Indexes, Define Search Query	Identify how the system searches the index and uses messages to define field labels when the work grid is dynamically populated.
Define Search Result	SAC_SRCH_RSLT	Setup Financials/Supply Chain, Common Definitions, Search Indexes, Define Search Results	Identify how the system displays the results of the search.
Define Search Options	SAC_SRCH_OPTIONS	Setup Financials/Supply Chain, Common Definitions, Search Indexes, Define Search Options	Identify how the system reads the search request, for example, case sensitivity, exact wording, or using a thesaurus.
Build Search Index	SAC_IDX_RUN_CTRL	Setup Financials/Supply Chain, Common Definitions, Search Indexes, Build Search Index	If you create your own search index, use this process to build the index.

Defining a New Search

Access the Define Search Index page (Setup Financials/Supply Chain, Common Definitions, Search Indexes, Define Search Index).

Search Index Name

The name of the search index.

Description

The description of the search index.

Staging Records for Update

The record that stores the keys for incremental updates.

Note. This table must share the same key structure as the master table.

Root Package ID

Identifies the application package that is used for indexing.

Create/Rebuilding

The application class extending the AppSearchIndex class that handles creating/rebuilding a new search index.

Update via Master Data Object

The application class extending the AppSearchIndex class that handles updating the search index based on selection criteria on the master table.

Update via Other Data Objects

The application class extending the AppSearchIndex class that handles updating the search index based on selection criteria on other tables.

Data Object Sets

Select a registered data object set to limit data retrieval.

Active

Select Active for all source data object sets that the system can use for this index.

Default

Select Default to tell the system which data object set to display as the default when the user accesses the Build Search Index page.

Datetime Stamp

Identifies the field as a date/time stamp field. This is used to compare date/time when updating last modified.

For each source data object set, you created a grouping of source data objects. In the Optional Source Field Setup section of the Search Index page, you can limit the amount of data that is retrieved from each source data object by creating a criterion. To do this:

Identify the record fields.

Define the search criterion, narrowing the set of data returned by the search by selecting one of the following values:

<	Less than.
<=	Less than or equal to.
<>	Less or greater than.
=	Equal to
>	Greater than.
>=	Greater than or equal to
Between	Between two entries
LIKE	Similar to

State the values of the specific field search criterion.

Defining New Search Index Fields

Access the Define Search Index Fields page (Setup Financials/Supply Chain, Common Definitions, Search Indexes, Define Search Index, Search Index Fields).

Use this page to define specific fields that are stored in the search index file.

Data Object	The name of the source data object as defined in the data object set assigned to this search index.
Field Name	The name of the data object field.
Index Field Name	The name of the search index field to be indexed into the collection. This name is the same as the record field name by default.
Field Type	Indexed as a Verity field and zone.
Priority	Identifies how the system determines which field values to use when two or more records contain the same field.
Index Key	Indicates fields to drive the indexing process.
Translate	Select Translate if the field needs related language processing.

Example of tasks required for adding a new simple field:

Insert a new field to the source data object that is used by the search index.
Identify the new field to be used for Verity indexing on the Search Index Field page.

This new field will be used in the Verity indexing engine for direct mapping.

Example of tasks required for adding a new field that requires customized processing:

Insert a new field to the source data object that is used by the search index.
Identify the new field to be used for Verity indexing on the Search Index Field page.
Extend the appropriate source data object class to include special processing.

Example of tasks required for adding a new field from a new record:

Add a new record to the appropriate source data object that is used by the search index.
Identify and insert the new fields from this record in the Data Object Definition page.
In the Define Data Object Set page, use the AnyDataObject application class to provide default direct mapping from the data object fields to Verity fields.
Identify the new field to be used for Verity indexing on the Search Index Field page.
Extend the appropriate source data object class to include special processing.

Defining a New Search Query

Access the Define Search Query page (Setup Financials/Supply Chain, Common Definitions, Search Indexes, Define Search Query).

Creating a Search Query

Use this page to define a group of fields that appear as users search fields on the transaction search page.

Search Query Id	The ID for this search query definition.
Description	The description for this search query definition.
Root Package	The application package that handles the search query mapping.
App Class (application class)	The application class extending the Format class that controls the formatting logic for the field.
Search Indexes	Click to define which search indexes to associate with the result set of this query. You can select more than one index.

Search Fields tab

Select the Search Fields tab.

Index	Defines the specific index that the query uses for the search.
Index Field Name	Enter the fields that are available for the search indexes associate with the selected search indexes.
Record Name	Enter the record names for the work record used in the transaction search scroll.
Field Name	Enter the work record fields that are used to enter search criteria when requesters are performing a search. This can also be fields that the system populates with search criteria in the background, for example SetID.
Constant	Search criteria that must always equal a specific, nonchanging value.
Range	Select to indicate that the search can be given a range. For example, Price can equal any amount from 20.00 USD to 25.00 USD.
Display	Defines whether the field is a background search criterion or a user-defined search criterion.

Fields Labels and App Class Tab

Select the Fields Labels and App Class tab.

If you are creating a new query, two options are available to display search fields on the Search Query page. You can either hard-code each field using Application Designer, or you can dynamically populate the searchable fields. The Field Labels and App Class tab is where you use messages to define field labels when the work grid is dynamically populated.

Msg Set (message set)	The message set displayed as the search field label.
Msg # (message number)	The message number displayed as the search field label.
Root Package ID	The application package ID for the specific field label.
App Class Path (application class path)	The application class for the specific field label.

When the transaction search page appears, the following information is displayed on the page:

The work record used for the search fields. For example, the user sees description.
The work record used for the search fields by range, if any. For example, the user can enter a price range.
The work record used for the search options grid. For example, the user can elect to use exact words or synonyms.

Note. Other fields, such as Currency in the case or price range, need to be manually created.

Defining the Display for New Search Results

Access the Define Search Result page (Setup Financials/Supply Chain, Common Definitions, Search Indexes, Define Search Result).

Based on how you elect to display your search results, the values returned from the Verity search index are mapped to the appropriate component record fields.

Search Result	Displays the ID for this search result definition.
Description	Displays the description for this search result definition.
Root Package	The application package that handles the search result mapping.
App Class (application class)	The application class that handles the search result mapping.
Search Queries	Identifies the search queries that are associated with this result set.
Index	Defines the specific index that the query uses for the search.
Index Field Name	The fields that are available for the search indexes associated with the selected search indexes.
Record Name	The record names for the work record that is used in the transaction search result scroll.
Field Name	The work record fields that are used to store values of an index field returned after you perform a search.

Defining a New Search Option

Access the Define Search Options page (Setup Financials/Supply Chain, Common Definitions, Search Indexes, Define Search Options).

Use the Define Search Options page to enable users to search using the following options:

CASE	Activate CASE if you require the search to be case sensitive.
EXACT	Activate EXACT if you require the search to have the exact word match.
THES (thesaurus)	Activate THES if using the thesaurus.

Creating and Updating the Verity Search Collection

Access the Build Search Index page (Setup Financials/Supply Chain, Common Definitions, Search Indexes, Build Search Index).

Use this page to define parameters for PeopleSoft Order Management customer and product searches. If you are not configuring the index, you need to complete these steps only:

Build a search index.
Run the Daemon process.

Note. If you will be configuring the index, you need to complete additional tasks prior to running these processes.

Index Name	If you are configuring your own index, you will create a new index and name it what you want. If you are using the delivered index, the index name is FDM_PV_ITEMCATALOG.
Build Options	Select the method that you want to use to build your search index. The filtering criteria changes based on the method that you select. Values are: Create New/Rebuild: Indicates that you are creating or rebuilding an index, and that you can limit the data retrieval by specifying a SetID. Process Last Modified: Runs the process based on the last modified incremental updates. Update All Items for a Vendor: Enables you to limit the update to a specific Vendor SetID, Vendor ID, or both. Update Specific SetID or Items: Enables you to limit the update to a specific SetID, range of Item IDs, or both. Update by Other Criteria: Enables you to limit the update by assigning a value to any or all of the criteria: Source Data Object Record Name Field Name
Source	If further data filtering is required, you can select the source data object set to assign to this search index.
Collection Language	Select a language code. You can index Verity for each language, for example English, Spanish, or Dutch. This enables you to support multiple languages in one system.
Index File Path	This field is populated from the Application Configuration file. It is display-only. Note. Ensure that the collection is accessible to all application servers and the process scheduler server that is running this process.
Chunk Size	Enter the number of rows to retrieve at one time when using the Verity search engine.

Select Run to run the process.

Subject Area	Displays the group translations sets, transformations, map rules, and map definitions.
Description	The description that you use to identify the specific source data object.
Default Subject Area	Select this option if you want this subject area to be a default subject area. When this option is selected, the subject area will be given as default when you create the source data object. If no default subject area exists, then when you create the source data object you must select a subject area.
Tablespace Name	Select the tablespace name that is associated with this subject area.
Create Temporary Table	Select this option if you want a temporary table to be created during the index process.

Source Data Object	Displays the internal ID for the source data object.
Source Record	Displays the source record for the source data object.
Source Fields	Displays the source fields for the source in the source record for the source data object.

Name	Displays the field name being referenced.
Field Type	Displays the type of field being referenced.
Length	Displays the length of the field being referenced.
Expression Statement	Enter the search expression that you want performed when this data object is referenced.
Clear	Click to clear the expression statement that is currently displayed in the Expression Statement field.
Operators	Select one or more operators to use to build your expression statement.
Data Source	Select a data source: Values are: Data Object Column: If you select this value, you must also select a data object column from the menu provided. This column will be used as a building block for your query. Built in Function: If you select this value, you must also select a built in function from the menu provided. This function will be used as a building block for your query. Constant Value: If you select this value, you must also select a constant value from the menu provided. This value will be used as a building block for your query.

Search Index Name	The name of the search index.
Description	The description of the search index.
Staging Records for Update	The record that stores the keys for incremental updates. Note. This table must share the same key structure as the master table.
Root Package ID	Identifies the application package that is used for indexing.
Create/Rebuilding	The application class extending the AppSearchIndex class that handles creating/rebuilding a new search index.
Update via Master Data Object	The application class extending the AppSearchIndex class that handles updating the search index based on selection criteria on the master table.
Update via Other Data Objects	The application class extending the AppSearchIndex class that handles updating the search index based on selection criteria on other tables.
Data Object Sets	Select a registered data object set to limit data retrieval.
Active	Select Active for all source data object sets that the system can use for this index.
Default	Select Default to tell the system which data object set to display as the default when the user accesses the Build Search Index page.
Datetime Stamp	Identifies the field as a date/time stamp field. This is used to compare date/time when updating last modified.