The SSA-NAME3 Scalar Frequency Tables are used to generate a run-time scale "value" for a particular search criteria and strategy. This scale value is an estimate of the percentage of the file that may be retrieved for a particular search, given the search data, field type and search level used.

An application program, via the SSA-NAME3 API

ssan3_get_ranges

Control parameter

SEARCH_LIMIT

, may impose a "scale warning limit" for a particular search such that if that scale is exceeded, the program will receive a return code along with the search key ranges and be able to go back to the searcher with a message that the search may be too expensive, prior to executing the database I/O.

As Scalar Frequency Tables take up a significant amount of memory, they are not packaged in the Standard Populations. If a user wishes to make use of the

SEARCH_LIMIT

control, then a Scalar Frequency Table will need to be generated from the organization’s own data for the required Field(s). This is done using the Population Override Manager.