Remote API client on Windows

On Remote API Clients on Windows, configuration information is held in the Windows Registry. The Registry contains SNA network information(similar to the information held in the client network data file on Remote API Clients on AIX or Linux). It also contains some additional configuration information that is specific to Remote API Clients on Windows.

Note: Configuration information for a CPI-C application (the local TP name and local LU alias) can be specified either in environment variables or in the registry. You may need to use environment variables if you are using Windows Terminal Server and need to run multiple copies of the same application using different local LUs. For more details, see Appl_Name

The Client Configuration Utility provides a simple way of modifying the most commonly used client configuration parameters, and is the preferred method for modifying these parameters. You can start this program in either of the following ways:

  • From the Start menu, choose Configuration Utility from the Remote API Client on Windows program group.
  • From a command prompt, change to the directory where the client software is installed, and run the sxclconf command.

The Configuration Utility normally displays information in the language that you selected when installing the client software. If you prefer to see this information in a different language, you can do this by starting the Configuration Utility from a command prompt: change to the directory where the client software is installed, and then to the subdirectory corresponding to your preferred language, before running the sxclconf command. For example, to see the information in French, run the sxclconf command from the fr_FR subdirectory below the directory where the client software is installed.

The program displays the same Configuration window that was displayed in the initial install process. Refer to the Remote API Client on Windows installation chapter in IBM Communications Server for Data Center Deployment on AIX Quick Beginningsfor more details of how to modify these configuration parameters.

Note: After changing the client configuration parameters, you need to stop and restart the client before your changes take effect. For details of how to do this, see Disabling a remote API client on Windows and Enabling a remote API client on Windows.

In the Registry, the information is contained in values configured under subkeys of the following key:

\\HKEY_LOCAL_MACHINE\SOFTWARE\SNA Client\SxClient\Parameters

The possible values for each Registry subkey are as follows:

Configuration
   domain = domain_name
   maximum_process_count = nn
   maximum_header_count = nn
   maximum_element_count = nn
   invoked_tps = YES | NO
   lan_access_timeout = nn
   poll_timer = nn
   broadcast_attempt_count = nn
   server_lost_timeout = nn
   client_start_timeout = nn

Servers
   Server1 = * | [ webservername : [ portnumber : ] ]servername1
   Server2 = [ webservername : [ portnumber : ] ]servername2
      .
      .
      .
   Server9 = [ webservername : [ portnumber : ] ]servername9
Logging
   exception_logging_enabled = YES | NO
   audit_logging_enabled = YES | NO
   log_directory = directory
   error_file = error_filename
   backup_error_file = backup_error_filename
   error_file_wrap_size = error_file_size
   audit_file = audit_filename
   backup_audit_file = backup_audit_filename
   audit_file_wrap_size = audit_file_size
   succinct_errors = YES | NO
   succinct_audits = YES | NO

API_tracing
   file1 = trace_filename_1
   file2 = trace_filename_2
   flip_size = filesize
   truncation_length = length
   all_api = YES | NO
   appc = YES | NO
   cpic = YES | NO
   csv = YES | NO
   rui = YES | NO
   nof = YES | NO

CS_tracing
   file1 = cs_trace_filename_1
   file2 = cs_trace_filename_2
   flip_size = filesize
   admin_msg = YES | NO
   datagram = YES | NO
   data = YES | NO
   send = YES | NO
   receive = YES | NO

Internal_tracing
   file1 = internal_trace_filename_1
   file2 = internal_trace_filename_2
   flip_size = filesize
   trace_level = nn
   trace_flushing = YES | NO

Appl_Name
   APPCTPN = tp_name
   APPCLLU = lu_name

CSV_data
   CSVTBLG = table_G_filename
Note: The domain = domain_name value is the only required value in the Registry.

The following sections explain the configuration parameters. Where a parameter takes the values YES or NO, any string beginning with Y or y is interpreted as YES, and any string beginning with N or n is interpreted as NO.