Editing a SocketSearch Configuration File
|
Editing a SocketSearch Configuration File |
|
|
|
|
The SocketSearch Configuration File editor consists of four categories of parameters to be set in the SocketSearch configuration file.
Setup Page
The Setup page consists of at least ten parameters:
|
Name |
Description |
|
Required. Must be the value "SocketSearch" | |
|
Optional. The number of threads that are to be dedicated to servicing information retrieval requests. The default is 5. The reasonable limit is around 200 on Solaris. | |
|
Optional. If set, logictemplate is the Resource ID of the Logic Template to be executed when receiving an information retrieval request that does not name a Logic Template. If not set, every information retrieval request must explicitly name a Logic Template. | |
|
Optional. Is the number of Resource IDs for which to allocate storage. The value used in the LoadUpdate configuration file must match the value used in the SocketSearch configuration file. Each allocated and unused Resource ID only uses on the order of ten bytes of memory. So, allocate enough for the job. The default value is 1000. | |
|
Optional. Is the maximum number of Load Structures to support. The default is 5. | |
|
Required for each Load Structure to be accessed by SocketSearch. Is the maximum number of records for which memory should be reserved for a specific Load Structure that is to be processed by SocketSearch. <n> is the Resource ID of the Load Structure for which memory is being reserved. There is no default. | |
|
Optional. Is the size in kilobytes of the buffer used to read data retrieval requests. The default is 32. | |
|
Optional. Is the size in kilobytes of the scratch buffer used to perform calculations and generate string values while processing a data retrieval request. If a fair amount of string function logic is being performed, it may be necessary to increase this value. The default is 64. | |
|
Optional. Is the size in kilobytes of the buffer used to transmit the results of the data retrieval request to the client. If large HTML displays are to be generated occasionally in response to data retrieval queris, it may be necessary to increase this value. The default is 128. | |
|
Optional. Is the maximum number of results that can be returned at any one time from a data retrieval request. This is not the number of results to be returned. That is set within the Logic Template. This value simply sets aside sufficient memory to accomodate the request. The default is 1024. |
Communication Page
The Communication page consists of three parameters:
|
Name |
Description |
|
Optional. Is the number of requests that may be queued on the port. The default is 5. If more requests are received than the queue has room for, they are refused connection. | |
|
Optional. The port which is to be used for receiving data retrieval requests from clients. In Unix, if the port number is less than 1024, SocketSearch will have to be run as root. The port commonly used to service HTTP requests is 80. For that reason, the default for majorport is 80. | |
|
Optional. Is the number of seconds before communications time out on a read or write through the socket created on majorport. A zero indicates the socket never times out. The default is zero (0). |
Encoding Page
The Encoding page consists of seven parameters:
|
Name |
Description |
|
Optional. If set to ON, all requests must be properly http encoded or they will be refused. If set to OFF, an attempt will be made to process improperly encode requests. The default is ON. | |
|
Optional. If set to EURO, when scanning or displaying dates in a numerical format such as 02/01/2001 or 2/1/01, the order is assumed to be day-month-year. If set to US, the order is assumed to be month-day-year. The default is US, or month-day-year. | |
|
Used to define units of distance data. | |
|
Optional. If set to ON, any period or decimal point encountered whithin a section of text being indexed is removed, and the characters on either side made adjacent to each other with no intervening space. If set to OFF, any period or decimal point encountered whithin a section of text being indexed is replaced by a blank. The default is OFF. | |
|
Optional. If set to ON, any hyphen or minus sign encountered whithin a section of text being indexed is removed, and the characters on either side made adjacent to each other with no intervening space. If set to OFF, the disposition of the hyphen or minus sign is dependent on the value of blankhyphen. If both skip hyphen and blankhyphen are OFF the hyphen or minus sign remains in the text. Skiphyphen and blankhyphen may not both be one, but both may be zero. The default for skiphyphen is OFF. | |
|
Optional. If set to ON, any hyphen or minus sign encountered whithin a section of text being indexed is replanced by a blank. If set to OFF, the disposition of the hyphen or minus sign is dependent on the value of skiphyphen. If both skip hyphen and blankhyphen are OFF the hyphen or minus sign remains in the text. Skiphyphen and blankhyphen may not both be one, but both may be zero. The default for blankhyphen is OFF. | |
|
Optional. If set to ON, any apostrophe or single quote encountered whithin a section of text being indexed is removed, and the characters on either side made adjacent to each other with no intervening space. If set to OFF, any apostrophe or single quote encountered whithin a section of text being indexed is replaced by a blank. The default is OFF. |
Processing Page
The Processing page consists of five parameters:
|
Name |
Description |
|
Optional. If set to ON, all static buffers used by a data retrieval request are cleared before being used again. This is not required unless there appears to be a problem with the code. If set to OFF, only those buffers which must be cleared are cleared before being used again. The default is OFF. | |
|
Optional. Is the amount of time in seconds that SocketSearch waits in between checking for updates to the indexes or templates. The default is 10 seconds. | |
|
Optional. If set to ON, all previous versions of a load are purged from the “search/export” directory tree once the current version has been successfully loaded. If set to OFF, removing previous versions of the load is left to the user. The default is ON. | |
|
Optional. The number of seconds the system will wait on a search thread to respond to a request before it is assumed to be locked up and is forced into a recovery mode. A value of zero indicates wait forever. The default is zero (0). | |
|
Optional. If set, contains the path to a network file system mount point or other directory tree containing the directories and files normally found within the “search/load/export” directory tree. There is no default. |
After the SocketSearch configuration file has been edited, the next step would be to save the file.
|
|
|
