General Usage Notes

General Usage Notes

Using the tabs on the left-hand pane you can select from the six available API Functions (Open, Keys, Ranges, Match, Close, Info). When a tab is clicked, its available input parameters and parameter values will be listed in the left-hand pane below the tabs. The input parameters are made up of "Controls" to direct what specific action the function will take, and "Data" on which the function will perform its actions. Many of these parameters are "hotspots", meaning that a mouse click will transfer the selected parameter and value into the appropriate text box on the right-hand pane.
If a parameter is a hotspot, the mouse pointer will change to .
Hovering the mouse cursor over a parameter or parameter value will also display a pop-up description of that field.
When an API function tab is selected, the right-hand pane will change to show all of the function’s input and output parameters as text boxes. Input text boxes have a white background. Output text boxes have a grey background. These will be the parameters that are actually used to make the call.
As said in the first paragraph, some of the parameters and values can be easily entered into the text boxes via clicks on the values in the left-hand pane, however, others such as the actual name or address data to be used in a particular function call must be manually typed or cut and pasted into the input text boxes from another location.
Once the text boxes on the right-hand frame are completed, they will closely resemble how you would specify the parameters in your own program code. To execute a function, click on the
Call
button in the lower right-hand corner of the right-hand pane and view the results. It is useful when debugging program code to put in some print or display statements after the call to the SSA-NAME3 function. After running the program to produce some debug output, copy the parameters from the program’s function call into the Workbench environment to replicate the function call and check if the output is the same.
The Workbench will remember the results of each function as you move around the different functions. Read the Functions section in the
API Reference Guide
for more detail about each function.

File Menu Options

The
File
menu options are provides as follows:
Options
Description
File
Open New Window
If more than one Workbench screen is required, use the
File
Open
New Window
menu option. Windows can then be tiled to perform comparison tests between the same function type.
File
Close
Menu option
File
Close
will prompt to close the current Function Testing Environment session.
File
Exit
Menu option
File
Exit
will prompt to close and exit all Workbench sessions.

Edit Menu Options

The
Edit
menu options are provides as follows:
Options
Description
Edit
Cut,
Edit
Copy,
Edit
Paste
The menu options
Edit
Cut,
Edit
Copy
and
Edit
Paste
are useful to allow copying of Controls and Data from one textbox to another, or between Function screens.
Edit
Clear,
Edit
Clear All
Menu option
Edit
Clear
undoes the previous entry. Menu option
Edit
Clear
All clears all entries on the current function screen.
Edit
Contact Details
This menu option allows you to enter your contact information. Users are advised to complete this information as it helps Informatica Corporation to communicate with you regarding product features, diagnostics, and technical support. (Informatica Corporation respects your right to privacy. Data collected from this form will not be given, sold or shared with organizations external to Informatica Corporation).

Tools Menu Options

The
Tools
menu options are provides as follows:
Options
Description
Tools
Export Parameters
This menu option allows the parameters and results from the current screen to be saved in an external file. You may wish to do this, for example, to email the results to another developer.

Help Menu Options

The
Help
menu options are provides as follows:
Options
Description
Help
Overview
Selecting
Help
Overview
will launch the Documentation Overview manual.
Help
Introduction
Selecting
Help
Introduction
will launch the Introduction to SSA-NAME3 manual.
Help
API Reference
Selecting
Help
API Reference
will launch the SSA-NAME3 API REFERENCE manual.
Help
System Documentation
Selecting
Help
System Documentation
will browse the pr sub-folders ("systems") and display the available Populations in a new window.
Help|Population
Documentation
Selecting
Help
Population
Documentation
will interrogate the current Population and display its internal documentation. This includes information about the Population’s version and date, the Code Page(s) used, and the available Field Types, Key Levels, Search Levels, Match Purposes, Match Fields and Match Levels.

0 COMMENTS

We’d like to hear from you!