The original intent was for the CI to be a short lived, temporary resource that would provide Finalist mainframe customers with time to migrate, test, and become familiar with the new Finalist native interface. This section describes the easiest path to migrate from the CI to the native interface. The Finalist CI has a variety of names that are essentially aliases of each other. These names include FINAL, FINALOL, FINALI, LPFN000, and others. The CI should not be confused with the Finalist LPAM database access routines. LPAM is a separate callable interface (API) that is not addressed in this document.
The Finalist CI passes one parameter to the interface. The callarea parameter is defined by the COBOL copybook LPFNCL01 (BAL uses the copybook LPFNCL04, C uses LPFNCL0C). The callarea is 10,000 bytes long. This parameter serves multiple definitions depending on what function is being performed. By contrast, the Finalist native interface uses dedicated parameters for each function call (API).
The CI consists of three calls.
CI Call |
Description |
---|---|
Initialize (0) |
Initializes the Finalist environment based on setup parameters. |
Process (4, 5, 6, or 7) |
Cleanses an individual address and returns information about the address. In early Finalist versions, the 4, 5, 6, and 7 calls were different. These calls are now identical. |
Terminate (9) |
Terminates the Finalist environment, frees storage, and produces reports. |
Each CI call is described in detail in the following sections.