Service Group Application Reference

Service Group Application Reference

Parameters

Parameters

The
TRACE
Service type is called
TRACE
. An application program Calls the
TRACE
Service with the following parameters:
No.
Name
Size (bytes)
Filled in by
1
Service name
8/32
Application
2
Response code
20
TRACE
3
Function
32-1000
Application
4
Name in
As defined in Algorithm
Application
5
Cleaned name
Same as Name in
TRACE
6
Words stack
576 (by default)
TRACE
7
Categories
20
TRACE
8
Work-area
90,000 (minimum)
SSAFMT
SERVICE-NAME (8/32 bytes)
The name of the Service for the
TRACE
service type as it has been defined in the Algorithm Definition. For example,
SERVICE-DEFINITION NAME=TRACEP * TYPE=TRACE ALGORITHM=PERSON
The name will be either 8 bytes if fixed in length, or up to 32 bytes if variable in length. Refer to the person responsible for defining and customizing the Algorithms.
RESPONSE-CODE (20 bytes)
This parameter is filled in by the Service to indicate the success or otherwise of the Call, a value of
00
in the first two positions indicates that all was well, any other value flags a warning or an error. For a description on how to check Response Codes, turn to the
How an Application Should Test the Response Code
section.
FUNCTION (32-1000 bytes)
Defines the
TRACE
Function. At present the
TRACE
Service only supports one function so this parameter should be specified as a blank function name, i.e. two asterisks, as follows;
**
NAME-IN (10-255 bytes)
This is the name to be Traced.
The length of this parameter must be the same as defined in this service’s Algorithm Definition
NAME-LENGTH
parameter.
CLEANED-NAME (10-255 bytes)
This is the name after physical cleaning by the Cleaning and Character Set rules defined for this Service’s Algorithm. This returned Cleaned name reflects the result of the early Cleaning only.
Note that this is different from the
NAMESET
Service which returns the fully Cleaned name. This is designed to only apply the minimal Cleaning and preserve as much of the original name as possible.
CLEANED-NAME
must have the same length as NAME-IN.
WORDS-STACK (576 bytes (default))
The expanded Words-stack has a 64 byte header and entries of 64 bytes each. The header has these fields:
Offset
Size
Description
0
2
Words-stack entries count
2
1
Compound name found indicator (value 1 or 0)
3
3
Major Marker start position
6
3
Major Marker end position
9
2
Major word position in stack
11
53
Filler for the rest of the header
While each entry has these fields:
Offset
Size
Description
0
24
Word, same as Formatting
24
1
Word type, same as Formatting
25
1
Word original type, this field is used for two different purposes:
It indicates the Word type as it was before changing it as a result of a Formatting rule (like making a Code into a Word or changing a Word to a Major).
If a word is deleted then it indicates the Edit-list type of the rule that caused it to be deleted.
26
1
Word is a common Major, C for Common, U for Uncommon.
27
1
Word is a common Minor, C for Common, U for Uncommon
28
3
Word start position in cleaned name, position start at 000 for the first position in the name.
31
3
Word end position in cleaned name
34
2
Word category
36
2
Word Scale as a Major
38
2
Word Scale as a Minor
40
24
Filler for the rest of the entry
The maximum number of entries is as specified in the Algorithm definition with the
WORDS-STACK-SIZE=
directive. Word-types are as defined in the
Nameset
section.
CATEGORIES (20 bytes)
Each time an Edit-list rule is executed it deposits a category name into the Categories list, these category names consist of two characters that form a mnemonic for the category type, for example:
PTPPPR.
has a personal title (PT), a prefix word (PP) and a prefix replace word (PR). These categories are defined in the Edit-list Definition File. A period terminates the list.
WORK-AREA (30,000 bytes)
A pointer to a general purpose Work-area.

0 COMMENTS

We’d like to hear from you!