Table of Contents

Search

  1. Preface
  2. Introduction
  3. Definition File Overview
  4. Customization Steps
  5. Service Group Definition
  6. Algorithm Definition
  7. Edit-list Definition
  8. Matching Scheme Definition

Service Group Definition and Customization Guide

Service Group Definition and Customization Guide

Definition File Structure

Definition File Structure

To apply a matching method, you describe the field to match, the name of the method, and a list of matching options.
The definition file has a set structure.
COPY SSASCRM read in the file SSASCRM DEFINE METHOD=... define methods ... DEFINE closes the Method definitions SCHEME NAME=... define Scheme/s METHOD NAME=... FIELD OFFSET=... ... SCHEME END close the Scheme definitions ... END close definition file
A sample matching scheme definition file is as follows:
COPY SSASCRM MODULE N3MAPR * DEFINE METHOD=MNAME,EP=N3SCM,ALGNAME=PERSON DEFINE METHOD=DDATE,EP=N3SCD DEFINE METHOD=MSTREET,EP=N3SCM,ALGNAME=STREET DEFINE * * Matching to Rank Existing Customer Candidate List * ------------------------------------------------ * SCHEME NAME=RANK METHOD NAME=MNAME,WEIGHT=1, X GOPT=(LENGTH*50+REFMIN), X LOPT=(CONC+CINITA+INITLOW) OPTION SCORES VALUE INIT,10 FIELD OFFSET=0,REPEAT=1 METHOD NAME=DDATE,WEIGHT=1, X GOPT=(LENGTH*8+NULLE), X LOPT=(YYMMDD+RANGE*365) FIELD OFFSET=50,REPEAT=1 METHOD NAME=MSTREET,WEIGHT=1, X GOPT=(LENGTH*40+REFMIN+NULLE), X LOPT=(CONC) FIELD OFFSET=58,REPEAT=1 * SCHEME END * END
The following sections describe each element of a matching scheme definition file.

COPY SSASCRM

The
SSASCRM
file defines various constants to use in the
Scheme
and
Method
definitions.
SSASCRM
has definitions such as
REFMAXEQUX’1000000’
, which defines the value for the
REFMAX
global variable.

DEFINE METHOD=

The
DEFINE
macro describes the method’s entry point, internal name, and the algorithm used. For example,
DEFINE METHOD=MNAME,EP=N3SCM,ALGNAME=PERSON
describes a method called
MNAME
which has N3SCM method entry point. Use the word
MNAME
to refer to this method in the rest of the definition file. The DEFINE macro uses the following parameters:
EP=
The
EP=
directive defines the method entry point of the method. The entry point is the name of the CSECT for assembler methods, the PROGRAM-NAME for COBOL methods, or the function name for C methods. Use one of the following entry points:
  • N3SCC. Matches two strings.
  • N3SCD. Matches two dates with optional ranges.
  • N3SCE. Matches two years with optional ranges.
  • N3SCF. Matches a string according to a pattern.
  • N3SCG. Performs exact match.
  • N3SCJ. Matches the parts from two dates.
  • N3SCM. Matches two names.
  • N3SCO. Returns a user-defined score, weight, or both.
  • N3SCS. Matches two dates with extended options (new).
  • N3SCT. Matches the location based on the latitude and longitude coordinates.
You can refer the method names by their last letter such as C, D, E, F, G, J, L, M, O, S, or T.
ALGNAME=
Defines the algorithm name to use with the method.
The following table summarizes the needs of various methods with respect to
ALGNAME=
:
Method
Needs
ALG
Uses
ALG
Uses CS
from
ALG
Uses EL
from
ALG
Uses ST
from
ALG
Uses FT
from
ALG
If no
ALG
supplied
N3SCC
No
Yes
Yes
Yes
No
No
Uses internal CS
N3SCD
No
Yes
Yes
Yes
No
Yes
Uses internal CS
N3SCE
No
No
No
No
No
No
N/A
N3SCF
No
No
No
No
No
No
N/A
N3SCG
No
No
No
No
No
No
N/A
N3SCJ
No
Yes
Yes
Yes
No
Yes
Uses internal CS
N3SCM
Yes
Yes
Yes
Yes
Yes
Yes
Error
N3SCO
No
No
No
No
No
No
N/A
N3SCS
No
Yes
Yes
Yes
No
Yes
Uses internal CS
N3SCT
No
Yes
Yes
Yes
No
Yes
Uses internal CS
CS=Character Set, EL=Edit-list, ST=Word Stabilization, FT=Formatting User-exit

DEFINE

A single
DEFINE
without any options closes the list of Methods.

SCHEME NAME=

The SCHEME macro starts the definition of a new Scheme. It has one operand,
NAME=[name]
, where
[name]
is a name (not longer than 8 characters) by which the application will access the Scheme. This name should be unique for the definition file.
FUNCTION=
Allows specification of
MATCH
Function keywords.
MATCH
Function keywords can also be defined in the Service Group definition (see the
Service Group definition
section) or by the calling program (see the MATCH section of the
APPLICATION REFERENCE guide
). When specified,
MATCH
Function keywords defined in the Scheme definition take precedence. The keywords should defined as:
FUNCTION=’*keyword,keyword*’ or FUNCTION=’Pre-definedFunctionName’
For example,
SCHEME NAME=RANK,FUNCTION=’*ACCEPT-LIMIT=90,REJECT-LIMIT=70*’ METHOD NAME=LNAME,GOPT=(LENGTH*50+REFMIN), X LOPT=(CONC+CINITA+INITLOW),WEIGHT=1 FIELD OFFSET=0,REPEAT=1
METHOD
The
METHOD
macro starts the definition of a Method inside a Scheme. You can have one or more Methods in a Scheme and the same method can be used more than once (on different fields or with different options for example). The operands are:
Operands
Description
NAME=
The first operand defines a Method to be used by this Scheme. This name must be one of those previously defined with the
DEFINE METHOD= [name]
directive earlier in the file. For example,
... DEFINE METHOD=MNAME,EP=N3SCM,ALGORITHM=PERSON ... SCHEME NAME=RANK METHOD NAME=MNAME...
says that Scheme RANK uses the Method called MNAME. The Method definition can be split over multiple lines. This is done by placing a continuation character in column 72, then continuing the definition in column 16 of the following line. For example,
METHOD NAME=MNAME,WEIGHT=1, GOPT=(LENGTH*50+REFMIN), X LOPT=(CONC+CINITA+INITLOW) X FIELD OFFSET=0,REPEAT=1
WEIGHT=
The
WEIGHT=
directive defines a weighting factor for this Method. It has meaning only when a Scheme has two or more Methods. This parameter is optional, if not used the default weight of 1 is used. For a full description of the usage of weights, see
Weights
section.
GOPT=
This operand stands for Global Options. Global Options apply to more than one method, hence the name Global. The options are passed on to the Method Entry Point to control its behavior.
Global options are specified with the following syntax,
GOPT= ([option]+[option]...)
where
[option]
is one or more of the options defined in the section describing the Global Options. Multiple options are separated with a plus (+) character. Some global options are implemented with the following syntax,
XOPT= ([option][+[option]...])
The next section,
Global Options
, lists the syntax which each global option uses.
LOPT=
This operand stands for Local Options. Local options apply to an individual method. The options are passed on to the Method to control its behavior.
Local options are specified with the following syntax,
LOPT= ([option][+[option]...])
where
[option]
is one or more of the options defined in the section describing the Local Options. Multiple options are separated with a plus (+) character.
XOPT=
This operand stands for Extended Options. Extended Options were added to support some new Local & Global Options.
Extended Local options are specified with the following syntax,
XOPT=option][+[option]...])
where
[option]
is one or more of the options defined in the section describing the Global or Local Options. Multiple options are separated with a plus (+) character.
OPTION VALUE
These operands support even newer Local Options. These options apply to an individual Method only and are passed on to the Method to control its behavior. This operand is specified with the following syntax,
OPTION Option-Name VALUE Value-Name,[Value]
All of the Local Options specified by either
LOPT=
,
XOPT=
and
OPTION VALUE
, are described in the Local Options section.

FIELD

Operand
Description
OFFSET=
This option defines the location of the first character of the field to be operated on by the Method. This is used in conjunction with the
LENGTH
option to tell the Method what field to work with. Note that the first character in the passed data is location 0, not 1. The syntax for using the
OFFSET=
operand is,
FIELD OFFSET=[number]
where
[number]
is a decimal number in the range 0 to 65535. Note that on some platforms, this offset is limited by the platform’s architecture and may in fact be less than 64Kb.
REPEAT=
This option defines the number of repeating fields for this field definition. The syntax for using the
REPEAT=
operand is,
FIELD OFFSET=nn,REPEAT=[number]
where
[number]
is a decimal number of the number of repeating fields. Refer to a description of Repeating Fields in N3SCM in the
Repeating fields
section to see an example of how this is used. This option is available for all methods except N3SCO.

SCHEME END

Defines the end of the Scheme definitions. This line marks the end of ALL Schemes, there is no need to mark the end of each Scheme in the module.

END

This
END
directive closes the definition file.

0 COMMENTS

We’d like to hear from you!