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. Address Standardization
  9. ASM Workbench

SSA-NAME3 API Reference Guide

SSA-NAME3 API Reference Guide

The Basic API Sequences

The Basic API Sequences

An application using SSA-NAME3 Version 2 will normally make 5 API calls:
  1. ssan3_open()
    to open a session to the SSA-NAME3 services
  2. ssan3_close()
    to terminate an open session to SSA-NAME3
  3. ssan3_get_keys_encoded()
    to build keys on names or addresses
  4. ssan3_get_ranges_encoded()
    to get search ranges for names or addresses
  5. ssan3_match_encoded()
    to compare and match two records
In addition, if using the SSA-NAME3 Server, it is necessary to make the following two calls to open and close the socket connections:
  • ssan3_connect()
  • ssan3_disconnect()
If used, the
ssan3_connect
call should be done prior to the
ssan3_open call
, and the
ssan3_disconnect
call done after the
ssan3_close call
.
Only one connect, open, close and disconnect call should be made during the active life of the application or thread, that is from when the time the application or thread is started to the time it is terminated. These calls should frame the rest of the work done by the application.
It is imperative that socket-handles and Session-IDs are not shared across concurrent transactions or threads.
In addition, if using the SSA-NAME3 Server and you wish to use 5-byte binary keys in order to save on disk space, it is necessary to make the following two calls to convert the 8-byte keys passed from the SSA-NAME3 Server:
  • ssan3_convert_keys()
  • ssan3_convert_ranges()
    If used, the
    ssan3_convert_keys
    call should be done after the
    ssan3_get_keys_encoded
    call, and the
    ssan3_convert_ranges
    call done after the
    ssan3_get_ranges_encoded
    call.
Note that some databases, programming languages and transport mechanisms will not support binary keys. If you are unsure, you need to contact Informatica Corporation.
At a very high level, the sequence of API’s in an application using SSA-NAME3 is depicted as shown below:

0 COMMENTS

We’d like to hear from you!