Table of Contents

Search

  1. Preface
  2. Introduction
  3. Program Design
  4. SSA-NAME3 Functions
  5. Language Specific Guidelines
  6. Controls
  7. Advanced Controls
  8. Composite Keys
  9. Address Standardization
  10. ASM Workbench

SSA-NAME3 API Reference Guide

SSA-NAME3 API Reference Guide

ssan3_info Controls

ssan3_info Controls

The ssan3_info call returns information about a selected system or identifies the population file to use for the specified sample data.

Syntax

The ssan3_info control uses the following format:
ITEM=<Item Type> SELECT=<Field Name|Purpose Name>|ITEM_DATA=utf-8,<Length in Bytes>,<Sample Data>|DEBUG_ENABLE=<Y|N>|DEBUG_FILE=<File Name>

Definitions

Control
Description
ITEM
Specifies the type of information to retrieve.
Use one of the following item types:
  • item
    . Retrieves all the supported item types that you can use.
  • analyze_match
    . Analyzes the SSA-NAME3 fields that returns low match score and recommends how to improve the score.
  • column_check
    . Checks for concatenated columns.
  • ext_field_types
    . Retrieves the details of the fields that you extend.
  • field_id
    . Retrieves the internal ID of a field.
  • key_level
    . Retrieves all the available values of the
    Key_Level
    control.
  • map_data
    . Recommends the SSA-NAME3 field that you can use for the specified sample data.
  • map_field
    . Recommends the SSA-NAME3 field that matches with the column name in the sample data set.
  • map_profile
    . Recommends the columns that you can combine.
  • map_population
    . Recommends a suitable population that has most rules matching with the specified sample data.
  • match_report
    . Provides a match explainability report. To get the report, run the
    ssan3_match
    call. If you set the
    EXT_MATCH_EXPLAIN
    control to Y, it enables the additional match explainability information.
  • purpose.detail
    . Generates an XML report that contains the details of the match purposes. By default, you get the details of all the match purposes. If you specify a purpose name in the SELECT CONTROL, you get the details of the specified purpose.
  • purpose.list
    . Retrieves the details of the field that you specify in the SELECT control.
  • results.name_in
    . Retrieves the input data that you specify in the
    Key Field Data
    field.
  • results.categories
    . Retrieves the Edit-list categories triggered during the previous call.
  • results.cleaned
    . Displays the input data after cleansing the data.
  • results.word_stack
    . Retrieves the word-stack items triggered during the previous call.
  • results.key-table
    . Retrieves the additional data that the
    KEY-TABLE
    keyword generates.
    This additional data explains how SSA-NAME3 constructs each key based on the word stack order.
  • results.search_table
    . Retrieves the full search table, including the search limit values.
  • results.stab
    . Retrieves the additional data that the
    DEBUG
    keyword generates.
    The following sample response indicates how the key is generated for
    JAMES ALAN MACKINTOSH
    :
    0 'UU?BGI$$ UU?BGI$/ 60 0000 20 A1 P 00 03+01+00+00'
    The value
    03+01+00+00
    indicates that the key is generated in the order,
    MACKINTOSH JAMES
    .
  • suggest_population
    . Recommends a population based on the character code points present in the data.
  • trace_word_stack
    . Retrieves the
    TRACE Service
    details. For more information about the
    TRACE Service
    , see the
    TRACE
    chapter in the
    Informatica SSA-NAME3 (EXTN) Service Group Application Reference
    guide.
    The following sample uses the
    trace_word_stack
    control to retrieve the TRACE Service details:
    Controls: 'ITEM=trace_word_stack SELECT=Person_name ITEM_DATA=utf-8,1,14,michael taylor'
    Rsp_code: '0'
    SSA_msg: ''
    Count: 2
    0 'MICHAEL YYCC000006 2036
    1 'TAYLOR MYCU008013 3000
SELECT
Specifies the field name or the purpose name based on the item type to retrieve information about the field or purpose.
The
SELECT
control is applicable to the following item types:
  • purpose.detail
  • purpose.list
  • fieldlen
  • match_explain_count
  • field.options
The
purpose.list
and
fieldlen
item types require the
SELECT
control.
The
SELECT
control is optional for the
field.options
,
match_explain_count
, and
purpose.detail
item types. If you don't specify the
SELECT
control for these item types, the ssan3_info call retrieves information about all the fields or purposes.
For example:
ITEM=fieldlen SELECT=CreditCard
returns the key length of the
CreditCard
field and
ITEM=purpose.detail SELECT=Person_Name
generates an XML report that contains the details of the
Person_Name
purpose.
ITEM_DATA
Specifies the sample data for which you want to identify the population file to use. Ensure that you set the item type to
suggest_population
. Use the sample data that the Unicode format supports.
Use the following format:
ITEM_DATA=utf-8|utf-16,<Length>,<Sample Data>
For example,
ITEM_DATA=utf-8,15,abc def ghi jkl
indicates that the sample data is
abc def ghi jkl
and the length of sample data is
15
bytes.
MAP_DATA
Specifies the sample data for which you want to identity the SSA-NAME3 field to use. Ensure that you set the item type to
map_data
. Use the sample data that the Unicode format supports.
Use the following format:
MAP_DATA=utf-8,<Repeat Count>,<Length 1>,<Sample Data 1>[,<Length 2>,<Sample Data 2>...,<Length N>,<Sample Data N>]
For example,
MAP_DATA=utf-8,2,John Smith,10,John Smithe,11
indicates that you use two sets of sample data, one is John Smith and another is John Smithe.
DEBUG_ENABLE=[Y|N]
Verifies the input parameters and writes debug information about the parameters to a specified log file.
Default is
N
.
DEBUG_FILE
When
DEBUG_ENABLE
is set to
Y
,
DEBUG_FILE
specifies the name of the log file to which you want to write the debug information about the input parameters.

0 COMMENTS

We’d like to hear from you!