Service Group Application Reference

10.0 HotFix 1
- 10.5 HotFix 2
- 10.5 HotFix 1
- 10.5
- 10.2 HotFix 1
- 10.2
- 10.1
- 10.0

Back Next

Parameters

To modify a

Matching Scheme

, the application program calls the

DEBUG

Service with the following parameters:

No.	Name	Size (bytes)	Filled in by
1	Service name	8	Application
2	Response code	2	DEBUG
3	Function	1	Application
4	Scheme name	8	Application
5	Scheme definition	Variable	Application
6	Work-area	100,000 (minimum)	DEBUG

To modify an Algorithm Definition, the application program calls the DEBUG Service with the following parameters:

No.	Name	Size (bytes)	Filled in by
1	Service name	8	Application
2	Response code	2	DEBUG
3	Function	1	Application
4	Algorithm Name	8	Application
5	Option definition	80	Application
6	Work-area	100,000 (minimum)	DEBUG

SERVICE-NAME (8/32 bytes): The name of the Service for the
DEBUG
Service type as it has been defined in the Service Group Definition. The supplied Fast-start Service Group definitions simply use the name
DEBUG
.

RESPONSE-CODE (2 bytes): This parameter is filled in by the Service to indicate the success or otherwise of the Call, a value of
00
indicates that all was well, any other value flags a warning or an error. An extended response code is also returned in the Work Area, described below. For a description on how to check Response Codes, turn to the
How an Application Should Test the Response Code
section.

FUNCTION (1 byte): At present only functions 1 and 2 are supported.; Function 1
Is used to modify a Matching Scheme at run-time.
Function 2
Is used to modify an Algorithm at run-time.

SCHEME-NAME (function 1) (8 bytes): The name of the Matching Scheme to be modified. This must be one that was defined during the Customization & Generation process. For example:
SCHEME NAME=PERSONLY

ALGORITHM-NAME (function 2) (8 bytes): The name of the Algorithm to be modified. This must be one that was defined during the Customization & Generation process. For example:
ALGORITHM-DEFINITION NAME=PERSON

SCHEME-DEFINITION (function 1) (variable length): This parameter contains an optional Function parameter, a list of encoded Method definitions and a list of new Method options, followed by ’closing’ entries. The size of the Scheme definition is variable depending on whether a Function definition and/or the new Matching option syntax is being used.
The minimum size of one Scheme definition with no Function definition and no new syntax Method options is :
4 [no Function] + (32 bytes * x) + 12 [no new syntax Method options] + 8 (scheme closing entry) where (x) is the total number of Methods in the Scheme.
The layout of the Scheme definition is as follows (N.B. Level 1 fields are mandatory),

Level
Name
Size
Description

1 – Function parameter
Scheme Function length
n
Length of the Function (rounded up to the nearest multiple of 4) if present, + 4 (i.e. if no Function then size = 4).
(FUNCTION=)

1 – For each Method
Method Name
8
This is the user-defined, not the method module entry point name. Using the example below the name would be
LPERS
.
(NAME=)

Weight
4
One binary number (32 bits) that defines the weight.
(WEIGHT=)

Global options
4
One binary number (32 bits) that defines a bit pattern for the options used.
(GOPT=)

Local options
4
One binary number (32 bits) that defines a bit pattern for the options used.
(LOPT=)

Extra Options
4
One binary number (32 bits) that defines a bit pattern for the options used. NB. If no
XOPT
s then value is 64,0,0,0.
(XOPT=)

Offset
4
The field’s offset into the record, starting at 0 for the first position in the record.
(FIELD OFFSET=)

Repetition
4
Number of times field repeats.
(REPEAT=)

1 – New syntax Method option(s)
Total length of new syntax
Method option(s)
4
Total Length of new syntax Method options, including closing entries of 8 bytes (i.e. if no new Method options then value = 8). (e.g.
OPTION FLAGS
or
OPTION SCORES
)

2 – For each new syntax Method option
New Method Option length
4
One binary number (32 bits) that defines the length, e.g.
24
if only one sub-option defined.

New Method Option Name
8
Character definition of a new matching option. (e.g. "SCORES ")

New Method Sub- Option Name 1
8
Character definition of a new matching option value name. (e.g. "INIT ")

New Method Sub- Option Value 1
4
One binary number (32 bits) that defines the value for the Option Value Name. (e.g. 10)

New Method Sub-Option Name 2
8
Character definition of a new matching sub-option (e.g. "STD ")

New Method Sub-Option Value 2
4
One binary number (32 bits) that defines the value for the Option and Sub-option (e.g. 9)

1 – Closing entry
New Method option(s) closing entry
4
Blank entry terminates the
New Method
Option(s), value is 0.

1 – Closing entry
Method closing entry
4
Blank entry terminates the Method, value is 4.

1 – Closing entry
Scheme closing entry
8
Blank entry terminates the Scheme. (" ")

New Options and Sub-options must be specified in alphabetical order.
In COBOL, a 4-byte (32-bit) number is typically type COMP-2. In MVS Assembler it is A or F. In C it is LONG. In PL/1 it is FIXED BIN (31).
For example, if the Scheme definition is as follows,
SCHEME NAME=PERSONLY METHOD NAME=LPERS,GOPT=(LENGTH*50+REFMIN), LOPT=(CONC+CINITA+INITLOW) OPTION SCORES VALUE INIT,10 FIELD OFFSET=0
The program definition of that scheme is,
SCHEME_DEFINITION METHOD_NAME CHAR 8 VALUE "LPERS " WEIGHT LONG VALUE 1 GOPT LONG VALUE 3276800 LOPT LONG VALUE 10092544 XOPT LONG VALUE 1073741824 OFFSET LONG VALUE 0 REPETITION LONG VALUE 1 NEW_OPTION CHAR 8 VALUE "SCORES " SUB_OPTION_NAME_1 CHAR 8 VALUE "INIT " SUB_OPTION_VALUE_1 LONG VALUE 10 NEW_OPTION_END LONG VALUE 0 METHOD_END LONG VALUE 4 SCHEME_END CHAR 8 VALUE " "

Level	Name	Size	Description
1 – Function parameter	Scheme Function length	n	Length of the Function (rounded up to the nearest multiple of 4) if present, + 4 (i.e. if no Function then size = 4). (FUNCTION=)
1 – For each Method	Method Name	8	This is the user-defined, not the method module entry point name. Using the example below the name would be LPERS . (NAME=)
	Weight	4	One binary number (32 bits) that defines the weight. (WEIGHT=)
	Global options	4	One binary number (32 bits) that defines a bit pattern for the options used. (GOPT=)
	Local options	4	One binary number (32 bits) that defines a bit pattern for the options used. (LOPT=)
	Extra Options	4	One binary number (32 bits) that defines a bit pattern for the options used. NB. If no XOPT s then value is 64,0,0,0. (XOPT=)
	Offset	4	The field’s offset into the record, starting at 0 for the first position in the record. (FIELD OFFSET=)
	Repetition	4	Number of times field repeats. (REPEAT=)
1 – New syntax Method option(s)	Total length of new syntax Method option(s)	4	Total Length of new syntax Method options, including closing entries of 8 bytes (i.e. if no new Method options then value = 8). (e.g. OPTION FLAGS or OPTION SCORES )
2 – For each new syntax Method option	New Method Option length	4	One binary number (32 bits) that defines the length, e.g. 24 if only one sub-option defined.
	New Method Option Name	8	Character definition of a new matching option. (e.g. "SCORES ")
	New Method Sub- Option Name 1	8	Character definition of a new matching option value name. (e.g. "INIT ")
	New Method Sub- Option Value 1	4	One binary number (32 bits) that defines the value for the Option Value Name. (e.g. 10)
	New Method Sub-Option Name 2	8	Character definition of a new matching sub-option (e.g. "STD ")
	New Method Sub-Option Value 2	4	One binary number (32 bits) that defines the value for the Option and Sub-option (e.g. 9)
1 – Closing entry	New Method option(s) closing entry	4	Blank entry terminates the New Method Option(s), value is 0.
1 – Closing entry	Method closing entry	4	Blank entry terminates the Method, value is 4.
1 – Closing entry	Scheme closing entry	8	Blank entry terminates the Scheme. (" ")

OPTION-DEFINITION (function 2) (80 bytes): This parameter is an option definition for the Algorithm.; For example,
SSA-NAME3-OPTIONS=NYNNNNNNNNNNNNNNNNNNNNNNN

Rename Saved Search

Table of Contents

Service Group Application Reference

Service Group Application Reference

Parameters

Parameters