Client Management Support APIs

The Client Management Support APIs and the related exit programs are provided to act on the client information database found on the iSeries^(TM). Functions include adding clients to and removing clients from the server, updating client information, and refreshing the database with directory, hardware, and software information stored on the client.

The client information database is a set of physical and logical files enabling the use of iSeries database interfaces or SQL to retrieve client information. The information stored in the database has been retrieved using the Simple Network Management Protocol (SNMP) GET and GETNEXT requests from the client when connected to the iSeries.

The Client Software Management and Configuration APIs can call an exit program if it has been registered with the associated exit point of that API. The exit program can be registered by using the Work with Registration Information (WRKREGINF) command. When the API function is complete, the Add, Refresh, and Update exit programs are called; the associated exit programs notify you when the API functions have been completed. The Remove exit program is called before the API performs the remove function.

The Client Software Management and Configuration APIs are:

• Add Client (QZCAADDC, QzcaAddClient) allows applications to make clients known to iSeries.
• Get Client Handle (QzcaGetClientHandle) allows applications to know the assigned client handle if the client ID is known.
• Refresh Client Information (QZCAREFC, QzcaRefreshClientInfo) allows applications to refresh hardware, software, or all the information stored on the system with the information stored at the client.
• Remove Client (QZCARMVC, QzcaRemoveClient) allows an application to delete a client from the client database on the system, thereby making a client unknown to the system.
• Update Client Information (QZCAUPDC, QzcaUpdateClientInfo) allows applications to update miscellaneous information about the client that is stored on the system.

The Client Software Management and Configuration exit programs are:

• Add Client allows applications to be notified when clients are made known to the system.
• Lotus Notes Database processes an SQL table of all changes that occurred in the Notes database that is being shadowed from DB2 UDB for iSeries.
• Refresh Client Information allows applications to be notified when information about clients has been refreshed through the Refresh Client Information API from the system.
• Remove Client allows applications to be notified when clients are removed from the system.
• Update Client Information allows applications to be notified when information about clients has been updated through the Update Client Information API from the system.