This chapter provides an overview of PeopleSoft Customer Relationship Management (PeopleSoft CRM) searching and discusses how to:
Define thesaurus and noise words.
Define record-based indexes.
Define HTTP-based indexes.
Define file-based indexes.
Configure search options.
Build and test a search collection.
Define jobsets to build the search collection.
Personalize search options at runtime.
This section discusses:
Search collections and their uses.
Solution and error searching.
Enhanced search capabilities.
Search index templates.
The Build Collection process (RB_SRCH_BLD).
System configuration.
Several PeopleSoft CRM transactions incorporate a search that is powered by Verity, a third-party search and retrieval tool. The system searches against a Verity collection, a separate set of files that contain data that is copied from the PeopleSoft CRM database. The subset of data that is included in a collection is based on search index templates that you define.
PeopleSoft CRM includes these collections:
The product catalog collection (CRM_RB_PRODCAT).
This collection is used to search for products that you can order. The search interface enables users to add selected products to an order, quote, lead, or opportunity. Product catalog searching is accessible from each of these objects as well as directly from the menu.
The unstructured email collection (CRM_RB_ERMS).
This collection is used by the email response management system (ERMS) in PeopleSoft Multichannel Communications. Text from inbound emails is put in the collection and then scored against keywords that you define. ERMS uses the scores to route the email to appropriate worklists so that the most qualified agents can review and respond to the email.
The solution and error message collection (CRM_RB_SRCHDB).
PeopleSoft call center applications use this collection in several ways.
The defect and fix collection (CRM_RB_DEFECTFIX).
This collection is used by call center applications to return matching defects and fixes for cases.
The self-service case collection (CRM_RC_CASE_SS).
This collection is used by the self-service support application to return matching solutions for cases.
The solution collection for the fieldservice application (CRM_RF_SRCHDB).
This collection is used by the fieldservice application to return matching defects and fixes for service orders.
The email workspace collection (ERMS_SRCHDB).
This collection is used by the email workspace to return matching solutions and templates (for sending response) for incoming emails.
The chat collection (SEARCH_SOLUTIONS).
This collection is used by the chat application to return matching solutions for questions that are entered in chat sessions.
You must update the product catalog collection and the solution and error message collection regularly to ensure access to current data. The system automatically updates the unstructured email collection every time it processes newly arrived emails.
See Also
Understanding Product, Pricing, and Catalog Setup
The Unstructured Email Process (RB_STR_EMAIL)
You can use the solution and error message search collection in various ways.
In the three PeopleSoft CRM call center applications (PeopleSoft Support, HelpDesk, and HelpDesk for Human Resources), Solution Advisor is used to search for objects that can help resolve a case. Search groups determine which objects are searchable in agent-facing and self-service versions of Solution Advisor:
The agent-facing version searches solutions; it also searches cases and troubleshooting scripts, both of which can lead the searcher to a solution.
The self-service version searches only solutions.
Both versions enable users to associate selected solutions with the case from which the Solution Advisor was invoked. The self-service version additionally enables self-service users to search for solutions outside the context of a case.
Solution Advisor for Service Orders
In PeopleSoft Integrated FieldService, Solution Advisor is used to search for solutions that are relevant to a service order. PeopleSoft Integrated FieldService does not track solution usage for service orders; search results are informational only.
Like Solution Advisor for cases, the type of object that gets searched (solutions only) is controlled through search group configuration. As delivered, Solution Advisor for service orders searches only solutions.
Two solution management operations incorporate searches:
Merging similar solutions.
Automatically relating similar solutions.
Both processes use searching to find solutions that are similar to a base solution that you indicate.
Error validation searches enable PeopleSoft Support and PeopleSoft HelpDesk users to search for known error messages that are similar to an error message that callers report. This helps users match reported information to a known error even when callers provide incomplete or misspelled information about the message.
This functionality is available only if error tracking is enabled for the call center business unit.
See Also
Working with My Service Orders
Defining Call Center Business Units and Display Template Options
“Searching Effectively Using Solution Advisor, ” http://www.peoplesoft.com/corp/en/products/ent/crm/resource_library.jsp#rp
Enhanced search capabilities enable you to provide the user with a robust, knowledge management solution.
Enhanced search capabilities include:
HTML indexing
File indexing
Thesaurus
Word variations
Verity search can be configured to include external content via the web through the use of the spider/crawl HTTP indexing capability. This feature allows data to be collected from external web sites. The spidering capability indexes the structure of the site and builds a reference index that becomes searchable through Verity. These HTML files become searchable through Solution Advisor, without physically pulling the content into the Verity collection. Results are returned in the form of URL links with content summaries for those pages in the search results. Stored summaries are displayed in cases where the referenced URL is no longer accessible.
When a customer service representative (CSR) is presented with a list of links to external content, they can navigate to the external content and view the content on the remote system. If they feel that the content is relevant and useful to the case they can choose to use this information as they would an attempted solution. External content can be converted into a new solution containing a complete copy of the text of this page as it existed at that moment in time. If the CSR deemed the information not relevant or useful to the problem, the external content is not converted into a solution and no associated content is brought into the solution database. External web content is converted into a solution the first time that an agent finds the information valuable to a case. For all future searches where the content of this page is deemed relevant by Solution Advisor, the system returns the solution and not the corresponding external link.
Verity can be configured to include collections that reside on file servers or directories. Verity's spider/crawl index file system capability is used to gather data from select files or directories (for example, a network drive share) and return links and summaries of those files in the search results. This allows agents to search for documents and other files that are related to the search criteria. The agent has the ability to create a relationship between the selected file and the transaction (case), to retain usage characteristics, and track the documents contribution to the successful resolution of the customer issue. When an external file is deemed relevant and attempted for the first time, it can be converted into a new solution so that it can be associated to the case.
Solution Advisor search can be configured to consider alternate words for one or many of the words in the search field. The accuracy and relevancy of the search results are improved when alternate words are considered in the search. For example, search criteria that included the word PC would also consider terms such as desktop, laptop, personal computer, and computer, in returning a set of solutions or other results related to the entered search criteria. You can create custom thesaurus for the keyword search, use the thesaurus that Verity delivers, or both.
Solution Advisor can be configured to allow a number of word variations, including the ability to search against alternate spellings of common words, search for words with similar sounds, search for derivative variations, and so on. Users can optionally disable spell check if performance implications are inherited by introduction of this feature.
Search index templates control the records and fields that are included in a collection.
Search Index Template Configuration
You create a separate search index template for each table or view that is included in a search collection. For example, users of Solution Advisor for cases need search index templates for cases, solutions, and troubleshooting guides.
PeopleSoft delivers search index templates for the search collections that are described in the preceding sections. You can modify these templates to change the fields that are searched, although it is not normally necessary to do so.
Search templates can include an optional SQL where (Structured Query Language where) clause to filter out data that you don't want added to the search collection. (This improves the performance of the process that builds the collection) They also include field-level options that determine which fields are searchable and which fields are returned to the originating application.
You can improve performance for both the collection build process and for searching by:
Including fewer fields in the search collection.
Avoiding long character fields such as comments.
You can also improve the efficiency of the build process by basing search index templates on views that contain only the fields to include in the collection. Behind the scenes, the PeopleCode is performing a %SelectAll command on the record, so if there are fewer fields in the record, the build is faster.
Delivered Search Index Templates
This table lists the records for which PeopleSoft delivers search index templates for the product catalog collection (CRM_RB_PRODCAT):
Record |
Description |
RX_CATSRCH_VW |
Product catalog |
RX_CATSRCH2_VW |
Product catalog external descriptions |
This table lists the records for which PeopleSoft delivers search index templates for the solution and error message collection (CRM_RB_SRCHDB):
Record |
Description |
RC_CASE |
Call center cases |
RC_ERROR_TBL |
Call center error records |
RC_PST_VW |
Troubleshooting guides |
RC_ASOLPRSRH_VW |
A view of solutions that enables the agent-facing version of Solution Advisor for cases to filter solutions based on related products |
RQ_DEFECT_VW |
Quality defects |
RQ_FIX_VW |
Quality fixes |
This following table lists the record for which PeopleSoft delivers search index templates for the unstructured email collection (CRM_RB_ERMS):
Record |
Description |
RB_UNSTR_VW |
Inbound emails |
This following table lists the records for which PeopleSoft delivers search index templates for the defect and fix collection (CRM_RB_DEFECTFIX):
Record |
Description |
RQ_DEFECT_VW |
Quality defects |
RQ_FIX_VW |
Quality fixes |
This following table lists the record for which PeopleSoft delivers search index templates for the self-service case collection (CRM_RC_CASE_SS ):
Record |
Description |
RC_ASOLPRSRH_VW |
A view of solutions that enables the customer-facing version of Solution Advisor for cases to filter solutions based on related products |
This following table lists the records for which PeopleSoft delivers search index templates for the solution collection for fieldservice (CRM_RF_SRCHDB):
Record |
Description |
RC_SOLUTION |
Solutions |
RF_SO_HDR |
Service order's header information |
This following table lists the records for which PeopleSoft delivers search index templates for the email workspace collection (ERMS_SRCHDB):
Record |
Description |
RB_SRCH_DOC_VW |
Template definitions that are used for email response. |
RC_SOLPRSRCH_VW |
Solutions |
This following table lists the record for which PeopleSoft delivers search index templates for the solution collection for chat (SEARCH_SOLUTIONS):
Record |
Description |
RC_SOLPRSRCH_VW |
Solutions |
After you set up index templates for collections, you use the Build Collection process to build the collection.
Building the Product Catalog Collection
When building the Product Catalog collection, run the Load Catalog Cache process (RO_CAT_PUSH1) before the Build Collection process.
The Product Catalog Collection job (BLD1CAT) incorporates both required processes.
Building the Unstructured Email Collection
You do not explicitly build the unstructured email collection. Instead, the Unstructured Content Analysis job incorporates both the Build Collection process and the process that analyzes and routes newly arrived inbound email.
Building Collections for External Contents
To search for information that exists outside the CRM system, such as external web pages and file systems of the enterprise, you need to build search collections for them as well. The procedure is the same as setting up a record-based collection. In the run control definition of the build external content process (RB_BLD_EXTCT), specify the type of external content (file or HTTP) and the index definition that is used to build the search collection.
Building Collections on Multiple Application Servers
The search collection resides on an application server. If you have multiple application servers, build the collection on each one. Having each application server access the collection files locally ensures optimum performance and simplifies the application server configuration.
There are two ways to manage multiple application servers:
Build the collections on one application server at a time.
When you do this, the build process runs on the PeopleSoft Process Scheduler server (and therefore on the application server) that you select in the Process Request page.
Build collections on all application servers at once.
To do this, set up a PeopleTools JobSet that initiates the processes on multiple PeopleSoft Process Scheduler servers.
The Build Collection process has two modes: create a new collection and update the existing collection. The Update mode is faster, but it has certain limitations. Be sure to use Create mode the first time that you build the collection and after you create a new search index template.
To always keep a copy of the collection online while it's being built in Create or Update mode, the system uses a temporary name for the collection that is being built, leaving the current collection available to users during the build process. When the build is complete, it swaps the active collection name with the temporary collection name so that the newly built collection is the one that is used for searches. The older version of the collection remains on the system, but only the newly built one is accessed during searches.
If the build collection process is run in update mode and no new data is added to the collection, the process completes with a success status (log information is available in the message log) instead of returning an error. It ensures that the update process doesn't get interrupted by the error especially for customers who set the build search collection process to recur regularly.
The Build Collection process performs this sequence of steps:
Accesses the setup files, the style files, and the index templates.
PeopleSoft CRM leverages the style files that are delivered by PeopleTools so no additional CRM-specific style files need to be installed separately. To make the style files work for CRM, the build search collection (RB_SRCH_BLD) modifies the style.uni file when it runs on a particular process scheduler server for the first time.
Creates the BIF (binary interchange file) and DAT (data) files for the data rows that meet the Where clause criteria.
An incremental update gathers changes to the index templates and new information that was added to the database since the last collection update. These new rows are used to create new BIF and DAT files that are added to the collection. This creates a new partition within the search collection and makes the data available in the search results.
Builds a BAT (batch) file or shell script that copies the Style.ufl file as well as other style files into the collection, based on language code.
Runs the MKVDK executable program that builds the collection. The file is located in the PS_HOME\appserv\prcs\database\files directory in Windows and in the Process Scheduler home directory in UNIX.
Updates the Date/Time field to indicate when the collection was created or updated.
Resets the usage count and the last usage Date/Time field if you selected the Reset Usage Count check box for the build.
After the process is finished (succeeded or failed), the log information of the MKVDK program is captured in a file called VerityOutput.Dat; the log is posted in the report repository. The log information is also displayed in the message log and the redirected terminal output on the View Log/Trace page. The content of the new collection is available in the <search collection name>.dat file on the same page.
Note. The same log process is also available to the external context collection building process.
Note. Most search transactions do not track usage counts. Solution Advisor does count usage for solutions, but it is based on associating the solution with a case, not on the usage count fields that you set up in Verity. If you accidentally reset usage counts, the PeopleSoft call center applications provide an update usage count process that can recount solution usage.
When the Build Collection process is complete, you can find the collection on the server's Verity search collection path in the directory with the same name as the collection in the appropriate language-specific directory.
To reduce the number of partitions in the database, configure search settings so that the collection is optimized on a regular basis. An optimization maximizes the size of the partitions that are in the collection. In most cases, optimize the collection after five incremental updates. Because the optimization frequency is set on the Search Settings page, you do not have to do anything when you run the build process.
Factors that affect Build Collection process performance include:
The amount of data that is processed.
Reducing the amount of data that is processed reduces the time that it takes to build the collection. You can limit the data that is included in the collection by including a Where clause in the search index template definition. Also, running incremental builds instead of full builds can reduce the amount of data that is processed during a build.
The speed of the computer that runs the Build Collection process.
Because the Build Collection process is CPU intensive, run it on a computer with a fast processor.
The amount of memory that is on the computer that runs the Build Collection process.
The computer should have at least 512 MB of memory.
Errors During the Build Collection Process
The build process fails under these conditions:
PS_HOME is not set or not on the Process Scheduler path.
The search collection path that is specified in the Build Collection page does not exist or is not accessible from the Process Scheduler server.
The path that you enter on the run control page is relative to the application server, not to the computer where the request is made (Process Scheduler is assumed to be running on the application server computer).
The Verity executables were not installed.
Verity is installed as part of PeopleTools.
The Process Scheduler does not have administrator ability to create or delete files.
This section discusses system configuration considerations.
Process Scheduler Configuration
When you initiate the Build Collection process, you select the PeopleSoft Process Scheduler server that will run the process and you provide a path to the collection files on the application server. Because the path is relative to the Process Scheduler server, the setup is greatly simplified if you set up a Process Scheduler server on each application server. This configuration means that whenever you build a collection, you provide the same (local) path regardless of which Process Scheduler server runs the process. It also ensures that the Process Scheduler server has access to the disk where the collection files reside.
Note. PeopleSoft strongly recommends that the Process Scheduler server and application server reside on the same server. If you have multiple application servers, we recommend that you set up a Process Scheduler server on each one.
A Process Scheduler that runs the Build Collection process must use a logon ID that has administrative abilities to create and remove the files and directories that are created as part of the Build Collection process.
To enable PeopleSoft Application Engine programs that call the Search API to locate collections, add the following section to the Process Scheduler configuration file, making sure to modify it with the appropriate collection name and path.
[Search Indexes] CRM_RB_SRCHDB=c:\pt880\data\search\cr880dvl ;========================================================================= ; Search index settings ;========================================================================= ; Search indexes can be given alternate locations if there is an entry here. ; Entries look like: IndexName=fs location (ie EMPLOYEE=c:\temp)
Please refer to the Supplemental Installation Instructions for PeopleSoft 8.9 Applications (available in Customer Connection) for step-by-step instructions on how to set up Verity searching in PeopleSoft CRM.
Application Server Configuration
Each search collection must have an entry in the Search Indexes section of the application server configuration file (PS_HOME\APPSERV\DomainName\psappsrv.cfg). The following example shows entries for the three PeopleSoft CRM collections; when you create entries on the application server, substitute the PS_HOME directory for C:\PT880 and use the actual database name.
[Search Indexes] CRM_RB_PRODCAT=C:\PT880\DATA\SEARCH\DatabaseName CRM_RB_SRCHDB=C:\PT880\DATA\SEARCH\DatabaseName CRM_RB_ERMS=c:\pt880\data\search\DatabaseName
For Windows NT and UNIX operating systems, make sure that the PS_HOME environments variable points to the current tools home directory; for example, PS_HOME= c:\pt880 on Windows NT, or /ps/psasgrp/casb on UNIX. The batch or shell file that builds or updates the collection uses this variable. It should not contain an ending slash or backslash.
For UNIX, make sure that the Verity executable programs are part of the path-defaulting set of directories. Make sure that MKDVK executable is part of the path. You must also make sure that chmod and sh are located in the home directory for the PeopleSoft Process Scheduler server or set a softlink pointing to those commands. For example:
ln -s /bin/chmod $PS_HOME/chmod ln -s /bin/sh $PS_HOME/sh
See Also
Supplemental Installation Instructions for PeopleSoft 8.9 Applications
This section discusses how to:
Load thesaurus and noise words.
Define a custom thesaurus.
Working with a delivered thesaurus.
Manage the thesaurus.
Define custom noise words.
Work with delivered noise words.
Manage noise words.
Page Name |
Object Name |
Navigation |
Usage |
RB_LOAD_VRTY_FILES |
Set Up CRM, Utilities, Search, Load Verity System Files, Load Verity Noise Words and Thesaurus |
Load thesaurus and noise words that are provided by Verity to the CRM system. |
|
RB_CSTM_THESAURUS |
Set Up CRM, Utilities, Search, Manage Thesaurus, Custom Thesaurus |
Define custom thesaurus entries for use in searching. |
|
Delivered Thesaurus |
RB_DLVD_THESAURUS |
Set Up CRM, Utilities, Search, Manage Thesaurus, Delivered Thesaurus |
View all thesaurus that are supplied by Verity and loaded on the system. |
Manage Thesaurus |
RB_ALL_THESAURUS |
Set Up CRM, Utilities, Search, Manage Thesaurus, Manage Thesaurus |
View and manage thesaurus entries from both delivered and custom sources. |
Custom Noisewords |
RB_CSTM_NOISEWORDS |
Set Up CRM, Utilities, Search, Manage Noisewords, Custom Noisewords |
Define custom noise word entries for use in searching. |
Delivered Noisewords |
RB_DLVD_NOISEWORDS |
Set Up CRM, Utilities, Search, Manage Noisewords, Delivered Noisewords |
View all noise words that are supplied by Verity and loaded on the system. |
RB_ALL_NOISEWORDS |
Set Up CRM, Utilities, Search, Manage Noisewords, Maintain Noisewords |
View and manage noise word entries from both delivered and custom sources. |
Access the Load Verity Noise Words and Thesaurus page.
Specify the type of data that you wish to load from files that are provided by Verity into the CRM database: thesaurus, noise words, or both. Based on the data and language selection, the AE process (RB_LOAD_VRTY) reads the respective Verity files and loads data into the CRM database.
This is not a mandatory step; run this AE process only if you wish to take advantage of the thesaurus and noise word lists that Verity provides.
Access the Custom Thesaurus page.
Synonym For |
The word for which the synonym will be defined. |
Synonym List |
The list of possible synonyms for the word. Separate the synonyms with a comma. |
Access the Delivered Thesaurus page.
The system displays all thesaurus that are supplied by Verity and loaded on the system. Deselect or delete the ones that you don't want to use in verity search.
Access the Manage Thesaurus page.
Select the types of thesaurus that you want to view. The system displays a list of entries for each type of thesaurus you select.
Access the Custom Noisewords page.
Custom Noise Word(s) |
Add words identified as noise words. |
The grid displays all noise words that have been added.
Access the Delivered Noisewords page.
The system displays all Verity delivered noise words. Deselect or delete the ones that you don't want to use in verity search.
Access the Maintain Noisewords page.
Select the type of noise word list to view. If All is selected, the grid displays the source of the entry.
To define record-based indexes, use the Search Settings and Search Index Template components.
This section discusses how to:
Define settings for building search collection.
Define record-based search index templates.
Page Name |
Object Name |
Navigation |
Usage |
RB_SRCH_PARMS |
Set Up CRM, Utilities, Search, Search Settings, Search Settings |
Define search collections and specify search settings that are used to build them. |
|
RB_SRCHIDX_TMPL |
Set Up CRM, Utilities, Search, Search Index Template, Search Index Template |
Define record-based search index templates and identify record fields to include in the search collection. |
|
RB_DEL_CONFIRM |
Click the Delete Index Template button on the Search Index Template page. |
Confirm deletion of the current index template. |
Access the Search Settings page.
Search Collection Name |
Displays the name of the search collection. |
Aging Interval in Days |
Not used in PeopleSoft CRM searches. |
Enter the frequency for optimizing the collection. Optimization maximizes the size of the partitions that are in the collection. The default value is 5. This means that every fifth time you build the collection, it is optimized to reduce the number of partitions and maximize the amount of data that is stored in each partition. |
|
Usage Increment and Usage Decrement |
Not used by PeopleSoft CRM. Solution usage counts are based on actual associations with cases. |
Schedule Name and Job Name |
Select the schedule and job that you established for this collection if you use a JobSet to build the collection. See Defining JobSets for the Build Collection Process. See Enterprise PeopleTools 8.45 PeopleBook: PeopleSoft Process Scheduler |
Access the Search Index Template page.
Collection Name |
Displays the collection that the search index template is associated with. Establish search collections and parameters that are used to build them on the Search Settings page. |
Displays the record (a table or view) with the data that is to be added to the collection. |
|
Enter an optional Where clause to limit the data that is accessed when the collection is built. |
|
Attachment Record and File Directory |
File attachments are not supported for this release of PeopleSoft CRM. Leave these fields clear. |
Search Collection Fields
The grid lists all of the fields in the record that are associated with this search index template. Do not remove any fields on the product catalog collection or the unstructured email collection.
This section discusses how to define HTTP-based indexes.
Page Name |
Object Name |
Navigation |
Usage |
RB_HTTPIDX_DEFN |
Set Up CRM, Utilities, Search, HTTP Index Definition, HTTP Index Definition |
Catalog the web pages to include in the HTTP collection. |
|
RB_HTTPIDX_MIME |
Set Up CRM, Utilities, Search, HTTP Index Definition, Mime Types |
Include or exclude specific MIME types for the collection. |
|
RB_HTTPIDX_FILE |
Set Up CRM, Utilities, Search, HTTP Index Definition, File Names |
Include or exclude specific file types for the collection. |
Access the HTTP Index Definition page.
HTTP Index name |
The name of the HTTP index. There can be more than one HTTP index. |
Depths of links for crawling
Depth of links |
Determines to what extent the Verity crawler should crawl into the URLs listed on this page. The recommended depth is 10. |
Starting URLs
URL |
List the URLs that the Verity Crawler should start crawling from. |
Stay in Domain |
Select to restrict the spidering to URLs in the same domain as the starting URL. |
Stay in Host |
Select to restrict the spidering to URLs on the same web server as the starting URL. |
Select to include specific MIME types. Any document type that is not selected will be ignored during the indexing process.
Filenames
Include All Filenames |
Select to index all file types. |
Include Specific Filenames |
Select to index only specified filenames. Specify the filename in the Filename List. Multiple file types can be specified by separating names with a space. |
Exclude Specific Filenames |
Select to exclude specific filenames from the index. Specify the filename in the Filename List. Multiple file types can be specified by separating names with a space. |
This section discusses how to define file-based indexes.
Page Name |
Object Name |
Navigation |
Usage |
RB_FILEIDX_DEFN |
Set Up CRM, Utilities, Search, File Index Definitions, File Index Definition |
Catalog the files to include in the collection. |
|
RB_FILEIDX_FILES |
Set Up CRM, Utilities, Search, File Index Definitions, File Index File Names |
Include or exclude specific files for the collection. |
Access the File Index Definition page.
File System Path |
Enter the file paths of file indexes to be searched at runtime. |
Access the File Index Filenames page.
File Index Filenames
Include All Filenames |
Select to index all file types. |
Include Specific Filenames |
Select to index only specified filenames. Specify the filename in the Filename List. Multiple file types can be specified by separating names with a space. |
Exclude Specific Filenames |
Select to exclude specific filenames from the index. Specify the filename in the Filename List. Multiple file types can be specified by separating names with a space. |
This section discusses how to configure search options.
Understanding Search Behavior
This table describes each of the search behaviors available for searches.
Search Behavior |
Definition |
Example |
With all words |
Search documents having references to all the words. |
Computer crashed returns documents containing both computer and crashed. |
With any words |
Search documents having references to any of the words. |
Software error returns documents containing either software or error. |
With the exact phrase |
Search documents having references to the exact phrase. |
Application Server returns documents matching exact phrase Application Server. |
Without the words |
Search documents excluding all the words. |
DSL Modem returns documents that do not contain either DSL or Modem. |
Words in proximity |
Search documents containing two or more words within n words, where n is an integer defined by the system administrator. |
Cell phone returns documents with cell and phone within the specified number of words. |
Words in a sentence |
Search documents having all the words in one sentence. |
Office 2000 returns documents with Office and 2000 within one sentence. |
Words in a paragraph |
Search documents having all the words in one paragraph. |
Clear cache returns documents with clear and cache in one paragraph. |
Words in same order |
Search documents having all the words in the same order. |
Meta data returns documents with meta and data in the same order. |
Understanding Word Variations
This table describes each of the word variations available for searches.
Word Variation |
Definition |
Example |
Alternate spellings |
Search documents ignoring typos in the search text. |
Temperaturee returns documents with temperature by ignoring typo. |
Use stemmings |
Search documents for stemmed or derivative variations. |
Film returns documents with film, films, and filmed. |
Exact words |
Search documents for exact words in search text. |
Film returns documents with film only. |
Include synonyms |
Search documents for word and include words with the same meaning. |
Unix returns documents with linux, Unix, and AIX. |
Words with similar sounds |
Search documents for words with similar letter patterns. |
Sale returns documents with sale, sail, sell, shell, and scale. |
Page Name |
Object Name |
Navigation |
Usage |
RB_VRTY_PAGE_CONFG |
Set Up CRM, Utilities, Search, Search Page Definitions, Search Definitions |
Define the search behavior and word variation options for the basic and advanced modes. |
|
RB_VRTY_PAGE_RIDX |
Set Up CRM, Utilities, Search, Search Page Definitions, Record Index List |
Indicate all the record- based indexes to be searched at runtime when the search is invoked from this page. |
|
RB_VRTY_PAGE_HIDX |
Set Up CRM, Utilities, Search, Search Page Definitions, HTTP Index List |
Indicate all the HTTP- based indexes to be searched at runtime when the search is invoked from this page. |
|
RB_VRTY_PAGE_FIDX |
Set Up CRM, Utilities, Search, Search Page Definitions, File Index List |
Indicate all the file- based indexes to be searched at runtime when the search is invoked from this page. |
Access the Search Definitions page.
Default Settings
Search Mode |
Select Basic or Advanced to set the default search mode. |
Results to display |
Enter the number of search documents to display. |
Basic Search Options
The Basic Search Options group box sets the values of search options if the page searches in Basic mode.
Search Behavior |
Select the default search behavior to use in Basic mode. |
Word Variations |
Select the word variation options to use in Basic mode. Proximity factor will be visible only if theSearch Behavior is Words in proximity. Maximum transformations will be visible only if the Word Variation type is Alternate spellings. You can select to make searches case sensitive, or to display noise words. |
Advanced Search Options
The Advanced Search Options group box sets the values of search option if the page searches in Advanced mode.
Search Behavior |
Select all search behaviors to use in Advanced mode. |
Word Variations |
Select all word variations to use in Advanced mode. |
Additional Options |
Select the word variation options to use in Advanced mode. Proximity factor will be visible only if theSearch Behavior is Words in proximity. Maximum transformations will be visible only if the Word Variation type is Alternate spellings. You can select to make searches case sensitive, or to display noise words. |
Access the Record Index List page.
One page can have more than one record index list and more than one record can be associated with a record index. The check box label corresponds to the record associated with the search index. Check boxes correspond to record zones within the record index.
Access the HTTP Index List page.
Displays all HTTP spiders for indexing Web pages on a specific search page. The spiders configured for this page are the only ones available at runtime when search text is input.
Access the File Index List page.
Displays a list of file indexes that will be searched at runtime.
To build and test a search collection, use the Build Search Collection component.
This section discusses how to:
Define parameters used to build a search collection.
Specify run control parameters and run the build collection process.
Specify run control parameters and run the build external content collection process.
Test searches.
Page Name |
Object Name |
Navigation |
Usage |
RB_SRCH_RUN_INDEX |
Set Up CRM, Utilities, Search, Build Search Collection, Build Search Collection |
Specify run control parameters for and run the build collection process. |
|
RB_EXT_CONTENT_RUN |
Set Up CRM, Utilities, Search, Build ExternalContent, Build External content Index |
Specify run control parameters for and run the build external content collection process. |
|
RB_SEARCH_DEMO |
Set Up CRM, Utilities, Search, Query Test, Search Query Test |
Test a search string to determine whether the data that is returned is what you expect from the collection. |
Access the Build Search Collection page.
Note. Normally you can run a process immediately after defining the process parameters. However, if you use a JobSet, you must define the JobSet between setting up the run control and running the process.
See Defining JobSets for the Build Collection Process.
Create a run control for each application server that is in the environment. Use a naming convention that identifies both the collection and the process scheduler server name. |
Once |
Select to execute the request the next time that the background process runs. After the background process runs, the process frequency is automatically set to Don't Run. |
Always |
Select to execute the request every time that the background process runs. |
Don't Run |
Select to ignore the request when the background process runs. |
Request ID and Description |
Enter descriptive information about the run control parameters. |
Collection Name |
Select the collection to build. |
Collection Directory |
Enter the directory path for the collection. The path is relative to the Process Scheduler server where the process runs, not to the computer where the request is made. Therefore, this path matches the Verity collection path on the application server (Process Scheduler is assumed to be running on the application server computer). If these paths do not match, you cannot create the collection. You can enter the path either in the UNC (universal naming convention) name format (which is the absolute path) or in the logical drive notation (which is relative to the machine where process scheduler runs). The PS_HOME environment variable must include any mapped drives. |
Server Operating Environment
Windows NT |
Select if Windows NT is the server operating environment. |
UNIX and $PS_Home Directory |
Select if UNIX is the server operating environment, and enter the value for the Process Scheduler home directory. This directory is used to create the shell script for building the collection. |
Search Collection Selection
Create New |
Select this option to run the Build Collection process in Create mode. The process creates a new search collection and overwrites the existing one. |
Select to run the Build Collection process in Update mode. This process gathers all additional information and changes to the index template records that have date/time stamps after the last update time for a collection. Only choose this option after the collection is created. |
|
Select to set the usage count on all objects in the collection to zero and the last usage date to null. This option is available only when creating a collection. The only usage counts that the system maintains are solution usage counts, and a separate process manages those. Normally, you should not reset usage counts as part of the Build Collection process. |
All Installed Languages |
Select to create collections for every language that is installed on the system. The languages that are built are based on the INSTALLED flag in the PSLANGUAGES table. |
Single Language and Language Code |
Select to create a collection for only the language code that you select. |
Search Index Templates
This group box displays information about the search index templates that belong to this collection.
Additional Page Elements for Running the Process
Access the Build External content Index page.
To build a collection for an external content, specify the external content type, index name, the directory where the collection resides, and the languages for which the collection is built.
External Content Type |
Select the type of extent content for which the collection is built. Options are HTTP Index and File Index. |
External Content Name |
Select the index definition to use to build the collection. If you select HTTP index as the external content type, only HTTP index definitions are available for selection in this field. The same is true for the file index type. |
Access the Query Test page.
This section discusses how to define JobSets and associate them with build collections:
Create run control records for the processes to run.
Access the Build Search Collection page.
For each collection that you maintain, create a run control record for each application server that is in the environment. Use a naming convention that identifies both the collection and the process scheduler server name.
Create the jobs to include in the JobSet.
Access the Job Definitions page under PeopleTools, Process Scheduler, Jobs.
Create a job that runs the Build Collection process once for each application server that is in the environment.
For example, if you have four application servers in the environment, then the job needs to have four processes, each running the Build Collection process. Set the job run mode to parallel so that the job items can run concurrently on the different servers.
PeopleSoft delivers a sample job, PRODCAT, that you can use as a model.
If you are building the Product Catalog collection, create a job that runs the Load Catalog Cache process and the job that you defined in the preceding step.
The Load Catalog Cache process loads the product catalog cache with the current contents of all catalogs. You must load the catalog cache before the collection is built, so put this process before the Build Collection process, and set the job run mode to serial.
PeopleSoft delivers a sample job, BUILDCAT, that you can use as a model.
Create the JobSet.
Access the JobSet Definitions page under PeopleTools, Process Scheduler, Schedule Job Set Definition.
Give the JobSet a meaningful name: If this is for the Product Catalog, then give it the name of the job that you created in the second step, otherwise, give it the name of the job that you created in the first step.
The Run Control ID that you enter is overridden in the next step, so you can enter any value.
If you would like this JobSet to run automatically at regularly scheduled intervals, you can optionally attach a recurrence definition to this JobSet.
Set up JobSet items.
Access the Schedule JobSet Items page under PeopleTools, Process Scheduler, Schedule Job Set Definition.
Add the jobs that you created in step two to the JobSet process list. Enter the following parameters for each:
On the General Settings tab in the process list, enter the run control ID that is specific to a process scheduler server.
For example, if you have two process scheduler servers named PSNT and PSNT2, and you're building the CRM_RB_SRCHDB collection (for solutions), then you might have run control IDs called SRCHDB_PSNT and SRCHDB_PSNT2.
On the Server Settings tab in the process list, enter the process scheduler server name in the Server Name field. Remember, each job runs on a separate Process Scheduler server.
Associate the JobSet with the collection.
Access the Search Settings page.
Enter the Schedule Name and Job Name next to the search collection that it applies to.
See Also
Enterprise PeopleTools 8.45 PeopleBook: PeopleSoft Process Scheduler