System Settings -- Search tab
|
|
The Search tab has five sections:
Note: You must configure or create a number of Dynamic System Settings to enable search facilities in PRPC. Verify that the settings have the values specified in this table:
| Dynamic System Setting | Set to: | Description |
|---|---|---|
| indexing/enabled | TRUE | Globally enables indexing |
| indexing/dataenabled | TRUE |
Enables indexing of Data- instances. Note: this setting is only relevant if indexing/enabled is set to TRUE. |
| indexing/ruleenabled | TRUE |
Enables indexing of Rule- instances. Note: this setting is only relevant if indexing/enabled is set to TRUE. |
| indexing/workenabled | TRUE |
Enables indexing of Work- instances. Note: this setting is only relevant if indexing/enabled is set to TRUE. |
| indexing/hostname |
Example: SD VPWIN80 |
The name of the host server where the index for this system will be stored. Enter the value from the Server Name field in SMA. |
| indexing/hostid |
Example: 5d0608f3789338db675 3e66a6b4bfb57 |
The node ID of the host machine where the index for this system will be stored. Enter the value from the Node ID field in SMA |
| indexing/explicitindexdir | Example: E:\PegaRULES\Indexes |
Forces PRPC to write its index files to a specific directory. When a value is not specified for this setting, the system uses a subdirectory of the PegaRULES temporary directory labelled PegaRULESIndex. The value specified must be an absolute file path, and there must be at least 1 GB of free space available in the directory. |
| SearchSoapURI |
Example: http://sdvpwin80:8080/ prweb/PRSOAPServlet |
The URL of the node which contains the index files for the system. This should be the URL for your system; however, instead of ending with “PRServlet” end with “PRSOAPServlet” In the multi-node setup, all the nodes in the system which do not have the index files must connect to the indexed node via a SOAP connection. |
| indexing/searcherror | FALSE |
This setting determines whether an error message displayd if indexing is not currently working. If this entry is set to TRUE, and there is an indexing problem, then when any search is done, a message displays at the top of the search results stating that indexing is not complete. Searching will continue to work – it will just search the things which had already been indexed. This error indicates that since indexing is not complete, some items may not be indexed yet. This feature is on a five-minute cycle to check whether indexing has been reenabled. Note: The FALSE setting for this entry is just for the initial configuration. If there is an error, this setting dynamically changes to TRUE. You do not have to change it back to FALSE. |
| indexing/updateTime | [This value is set by the system when the indexer agent is run.] | The System Indexer agent stores the entries to be indexed in a queue. The entries added in the queue are indexed by taking the updateTime as reference. |
| indexing/displayParsing Exceptions | FALSE | Determines whether the parsing exceptions that occur during indexing attachments are displayed in the logs. |
|
indexing/ attachmentsizethreshold |
5 MB | Indexing skips attachments to work objects that are larger than the threshold set here. |
| indexing/agentMonitoring | TRUE | Enables monitoring agent status for automated search alerts. |
| indexing/fileMonitoring | TRUE | Enables monitoring index file status for automated search alerts. The check Index API is called based on the frequency of monitoring set (see the next item). |
| indexing/frequency | HOURLY | Frequency of monitoring of file and agent status. The options are EVERY 5 MINUTES, HOURLY, WEEKLY, or YEARLY. |
Use the Index Administration settings to enable or disable indexing for classes under Rules-, Data-, and/or Work-.
Through a checkbox labeled Exclude this class from search? on the Advanced tab of the Class form, you can cause full text searching to skip over instances of a specific class. Search results then exclude any instances of that class.
Field |
Description |
 Enable Indexing |
Turn on/off all search indexing. |
|
Rules |
Turn on/off search indexing for all Rule- classes. |
|
Click Re-Index to build or rebuild indexes for rules.
|
|
|
Data |
Turn on/off search indexing for all Data- classes. |
|
Click Re-Index to build or rebuild indexes on Data- class instances.
|
|
Work |
Turn on/off the Enable Indexing button to build or rebuild indexes on Work- class instances.
|
Index Attachments |
Click this checkbox to index work item attachments. PDF, Microsoft Office, and text attachments are indexed and will be full-text searchable.
The Attachments Threshold field holds the maximum size in megabytes of attachments to be indexed. The default, which you can adjust to accommodate your system's needs, is 5 MB. The log file records the existence of attachments that exceed this threshold and that are not indexed. |
Click one of the three Check buttons to check the status of the index files. In the form that appears, click Run Full Diagnostic Check to launch a full diagnostic check of rules, data or work. This has the greatest chance of identifying issues, but also take the longest and uses the most resources.
Click one of the three Re-Index buttons to rebuild the complete index file for the selected type. For the Work- index files, a form appears where you can select
Below the radio buttons where you make your choice is a section where you can list the classes to include or exclude. You can add as many rows as you need, or remove rows you no longer need. This allows you to select a subset of classes to reindex, saving time and using less server capacity.
When you are ready, click OK to reindex; or click Cancel to close the form without reindexing.
You normally only need to perform these actions following initial installation, or if the search index files are accidentally deleted or corrupted.
Progress messages appear at the bottom of the page during the rebuild. Each responds with a success message when processing is complete. Additional details and progress messages appear in the system console log.
The system creates the indexes for these classes under the directory specified in the indexing/explicitindexdir Dynamic System Setting, as follows:
You can check or clear any of the boxes above while a PRPC server node is operating, but such index processing can affect system performance if the indexes are large. As a best practice, choose a time when the server is less busy to perform these one-time processor-intensive operations.
The Designer Studio search facility also allows search of Application Developer help topics. The Help search capability depends on a static index and is unaffected by the settings you record in this tab. During installation or upgrades, the help index file is automatically extracted from a binary file rule named HelpIndex.pxHelpIndexBinary.zip.
Displays the status of the Pega-RULES agents that incrementally update the search index files as changes are made to Rules-, Data-, and/or Work- instances. Also provides Start and/or Stop buttons to manually enable or disable these agents.
Field |
Description |
| Enabled? |
If enabled, and the agent is running, a check mark ( If disabled, and the agent is not running, an X ( |
| Agent |
The SystemIndexer agent is responsible for updating Rules- indices, and the SystemWorkIndexer agent is responsible for updating Work- and Data- indices. See Understanding the Pega-RULES agents. |
| Scheduling |
The scheduled frequency, in seconds, with which the agents run and update the indices. |
| Last Run Start |
Date and time of last run start. |
| Last Run Finish |
Date and time of last run finish. |
| Next Run Time |
Date and time of next scheduled run. |
| Exception Info |
Exception information field. |
If these two agents are not enabled, enable them.
In a multinode cluster system, the indexes that support search may be maintained only on one node. When a user connected with another node performs a full text search, an HTTP service request is sent from that node to the node with indexes. The search results are returned to the requesting node and displayed to the user.
The index host node settings are:
Field |
Description |
| Host Name | The name of the host server where the index will be stored (pxProcess.pxSystemNode). |
| Host ID | The node ID of the host machine where the index for this system is stored (pxProcess.pxSystemNodeID). |
| Index Directory |
Provide a directory name to force PRPC to write its index files to that directory. If no value is specified, PRPC writes index files to a subdirectory of the PegaRULES temporary directory PegaRULESIndex. The value you specify must be an absolute file path, and there must be at least 1GB of free space available in the directory. |
| Search SOAP URI | The URL of the node which contains the index files for the system. This should be the URL for your system; however, instead of ending with "PRServlet" it should end with "PRSOAPServlet". |
Modify these settings and click Submit. Build the indexes after updating the settings.
Note: The node ID (the host ID in the search landing page) is calculated based on the system name, the node name, and the PegaRULES temp directory. If the node ID changes because of the change in the temp directory then, on restart, the node ID is correctly set in the indexing/hostID field so that search and indexing work seamlessly.
Note: Lucene’s automatic index management merges data in various segments of the index files on the disc. This requires extra disc space. We recommend maintaining free space on the disc equal to three times the Lucene index directory’s size, to allow Lucene to merge efficiently and to avoid performance slowdowns.
You can set automated spot checks to run periodically on the status of search agents and index files, and to report on events and issues that arise. The system sends out alerts when
| Field | Description |
|
Automatically Monitor Agents
|
Check the checkbox to automatically monitor agents that are running. |
|
Automatically Monitor Files
|
Check the checkbox to automatically monitor file attachments. |
| Frequency of Monitoring | Select Every 5 Minutes, Hourly, Weekly, or Yearly. |
|
Send Email Notifications...
|
Check the checkbox to send notifications to specified recipients on completions of re-indexing and full diagnostic spot checks. Provide the email addresses of those who should receive Search Alerts in the Email Addresses field. Select the email sending address in the Email Account field. Click the icon to the right of the field to create a new account. |
Messages pertaining to search indexing appear in this area.
When you have updated settings, verify that this section displays messages about the changes to parameters you have made.
Click Submit for the changes to take effect, and to build the indexes.
) will be displayed.
) will be displayed.