Return a Score only in the MATCH Result parameter. Normally, the Result parameter will contain the Score as well as other result information. Using this keyword means that the Result parameter contains only the Score, which is a 3-byte character representation of the Score achieved when matching two records. It has a value between 0 and 100. A value of 050 represents a Score of 50%.

SCORE-ONLY

is mutually exclusive with

VERBOSE

.

Specifies that the Result field will contain results in a

label=value

syntax. The default structure of the Result field is that results are in fixed, formatted positions. For example, the first three positions contain a Score, the next position contains a one-character "ruling" (see below).

This keyword is ignored if

SCORE-ONLY

is also specified.

Controls the setting of the match "ruling".

ACCEPT-LIMIT=

specifies a Score value equal to and above which a record will be considered as "accepted". The Score value can be specified without leading zeros. An accepted record is identified with a ruling of "A".

If using the default Result parameter format (i.e. no

VERBOSE

keyword), the ruling will be in position 4 of the Result parameter field.

If using the

VERBOSE

keyword, the ruling will be represented in the Result parameter as "

RULING=A

".

If a Score falls below the

ACCEPT-LIMIT

value, the Ruling is set to "undecided" ("

U

" in position 4 or "

RULING=U

"), unless a

REJECT-LIMIT=

value is also specified and the Score falls below that value, in which case the Ruling is set to "reject" ("

R

" in position 4 or "

RULING=R

").

This keyword is ignored if

SCORE-ONLY

is also specified.

Controls the setting of the match "ruling".

REJECT-LIMIT=

specifies a Score value below which a record will be considered as "rejected". The Score value can be specified without leading zeros. An rejected record is identified with a ruling of "R".

If using the default Result parameter format (that is, no

VERBOSE

keyword), the ruling will be in position 4 of the Result parameter field.

If using the

VERBOSE

keyword, the ruling will be represented in the Result parameter as "

RULING=R

".

If a Score is equal to or above the

REJECT-LIMIT

value, the Ruling is set to "undecided" ("U" in position 4 or "

RULING=U

"), unless an

ACCEPT-LIMIT=

value is also specified and the Score is equal to or above that value, in which case the Ruling is set to "accept" ("A" in position 4 or "

RULING=A

").

This keyword is ignored if

SCORE-ONLY

is also specified.

This keyword is ignored if

SCORE-ONLY

is also specified.

Return a Method-table in the Method-table field using the length specified, e.g.

MTBL=212

will return a Method-table of 212 bytes which happens to be the size that would be required for a three method scheme.

To determine the setting of the

MTBL=

function value, you must first know the number of methods being used in the Matching Scheme. The formula is then:

(Method Table header size + (number of Methods * Method Table entry size) + 4-byte terminator entry)

example, (25 + (number of methods * 61) + 4)

For example, if the number of methods were three, the

MTBL

parameter would be calculated as follows: 25 + (3 * 61) + 4 = 212

It is advisable to set this value high enough to cater for the Matching Scheme which has the highest number of Methods. Here are some useful calculations:

Number of Methods     MTBL size
       1                 90
       2                151
       3                212
       4                273
       5                334
       6                395
       7                456
       8                517

Refer to the

APPLICATION REFERENCE FOR SSA-NAME3 SERVICE GROUPS guide

for a definition of the layout of the Method table.

Return an extended Method table showing the position of the fields that matched in a multi-valued matching field, that is, using

REPEAT=

keyword. (Requires

MTBL=

to be specified.) Only available in Matching Method

N3SCM

.

Refer to the

APPLICATION REFERENCE FOR SSA-NAME3 SERVICE GROUPS guide

for a definition of the layout of the New Method table.

This keyword is always used on its own, and is only used on a special call to the MATCH service. It is used to extract the result value from a verbose

label=value

Result parameter field. If the

VERBOSE

keyword has been specified for a MATCH call, the results, for example the Score and the ruling, are returned as a series of

label=value

entries in the Result parameter.

The application can then make a subsequent call, specifying

EXTRACT=label

to extract the result value for that label into a separate field. Possible values are,

EXTRACT=SCORE
EXTRACT=RULING

Specifies a Score between 0-100 to be returned to the calling program if the sum of weights from all matching methods in a scheme is zero. For example,

NULL-SCORE=100

will return a Score of 100 if the all method weights in a scheme became zero.

Overrides, at run-time, the length and offset of a field specified in the matching scheme. Format is

FIELDS=ooooolllllrrrrr

, where

ooooo =

offset,

lllll =

length and

rrrrr =

repeat count.

For example, for a scheme with two fields Matching data with the following format:

PERSON-NAME   CHAR 50
ADDRESS       CHAR 100

The

FIELDS

function will be:

FIELDS=000000005000001000500010000001

Overrides, at run-time, the length and offset of a field specified in the matching scheme. Format is

FIELDS=ooooolllllrrrrree

, where

ooooo =

offset,

lllll

= length

rrrrr =

repeat count and

ee =

encoding type.

For example, for a scheme with two UTF-8 fields Matching data with the following format:

PERSON-NAME CHAR 50
ADDRESS CHAR 100

The

FIELDS

function will be:

FIELDS=00000000500000100050001000000188

Valid values for the encoding type are:

Y Unicode UTF-8 format

8 Unicode UTF-8 format

6 Unicode UTF-16 format

L Unicode UTF-16LE format

B Unicode UTF-16BE format

4 Unicode UCS-4 or UTF-32 format

J Japanese CP932 codepage (Shift-JIS)

S Chinese CP936 codepage (Simplified Chinese)

K Korean CP949 codepage

T Chinese CP950 codepage (Traditional Chinese)

Specifies additional work-area that will be used to save the processed Search Data, effectively meaning that the Search Data will only be processed once during repetitive MATCH calls for the same transaction. The performance gained will be directly proportional to the number of candidates matched. A minimum of 10000 bytes should be specified at the end of the existing workarea.

Format is

SCACHE=oooooollllll

, where

oooooo =

offset into workarea and

llllll =

length of additional work-area.

Format is

EARLY=nnn

, where

nnn

specifies a score above which the first Method in a Scheme must score to ensure the other Methods are evaluated. If the first Method does not score at least this value, then the score is returned with a decision of "

R

" (reject) and an indicator to say that an early exit took place (in the "Result" parameter of the Match call). The performance gained will be dependent on how many records satisfy the condition of early rejection.