Entire Net-Work Configuration Parameters

Entire Net-Work configuration settings are stored in a series of parameters. Some of these you can change; some you cannot or should not. You can change these configuration settings using:

  • Entire Net-Work System Management Hub (SMH) functions. For more information on this, read Entire Net-Work Client Administration (in the Entire Net-Work Client Installation and Administration Guide) and Entire Net-Work Server Administration (in the Entire Net-Work Server LUW Installation and Administration Guide).

  • Environment variables with the same names as the configuration parameter.

    Warning:
    Future releases of Entire Net-Work will not support configuration parameter settings in environment variables. For this reason, we recommend that you do not use this method.
  • API functions supplied with Entire Net-Work that can also be used in your application programs. Additional information on these functions is provided elsewhere in this document.

This document covers the following topics:


Configuration Parameter List

The following table describes each of the Entire Net-Work configuration parameters, indicating whether or not you can or should modify its setting, the platforms on which it is available, the default (if any), the name of the SMH parameter that can be used to change it, and the name of the tool that can be used to change it.

Parameter Description Can you change it? Platform Availability Default SMH Parameter Batch Tool
LNKADAESI whether the external security interface online application should be used instead of a user exit. yes Windows NO LNKADAESI AdaSetParameter (set for the LNKADAESI parameter)
LNKADASAF the library and function names of the user exit that will provide access to the secured Adabas resource via the Adabas SAF Security Kernel (ADASAF). yes UNIX and Windows "lnkxsaf lnkxsaf" LNKADASAF AdaSetParameter (set for the LNKADASAF parameter)
LNKTIMEOUT Global timeout for a response from a remote Adabas call. yes UNIX and Windows 1 minute ADABAS_TIMEOUT AdaSetTimeout
LNKTRACE ADALNK and Software AG transport services trace levels. yes UNIX and Windows 0 (zero) LNKTRACE and XTSTRACE AdaSetTrace
LNKUEX_0 the file and function names of the user exit that should be called before an Adabas ACB command is sent to the database.

Note:
LNKUEX_0 handling triggers an undocumented Natural feature; if the user exit is called and returns a non-zero response code, but the Adabas command is an RC command, the RC command is suppressed and a successful return is indicated to the calling program.

yes UNIX and Windows LNKUEX_0 none
LNKUEX_1 the file and function names of the user exit that should be called after an Adabas ACB command is sent to the database. yes UNIX and Windows LNKUEX_1 none
LNKUEX_ACBX_0 the file and function names of the user exit that should be called before an Adabas ACBX command is sent to the database.

Note:
LNKUEX_ACBX_0 handling triggers an undocumented Natural feature; if the user exit is called and returns a non-zero response code, but the Adabas command is an RC command, the RC command is suppressed and a successful return is indicated to the calling program.

yes UNIX and Windows LNKUEX_ACBX_0 none
LNKUEX_ACBX_1 the file and function names of the user exit that should be called after an Adabas ACBX command is sent to the database. yes UNIX and Windows LNKUEX_ACBX_1 none
WCLCODEDIR the directory where the Entire Net-Work Client code is stored

If you want to change the value of this configuration parameter, contact your Software AG support representative.

yes, with assistance UNIX local directory none none
WCLDATADIR the directory where the Entire Net-Work Client data is stored

If you want to change the value of this configuration parameter, contact your Software AG support representative.

yes, with assistance UNIX local directory none none
WCPCONFIG Entire Net-Work configuration file name yes UNIX and Windows local xts.config none AdaSetParameter (set for the WCPCONFIG parameter)
WCPDIR the directory where the Entire Net-Work code is stored

If you want to change the value of this configuration parameter, contact your Software AG support representative.

yes, with assistance UNIX and Windows local directory none none
WCPVERS the Entire Net-Work version

If you want to change the value of this configuration parameter, contact your Software AG support representative.

yes, with assistance UNIX and Windows none none

Configuration API Functions

This section describes the API functions you can use to set some of the Entire Net-Work configuration parameters.

AdaSetParameter API Function

You can use the AdaSetParameter API function to set values for the following parameters:

  • LNKADAESI: Valid values are "YES" (use the external security interface online application) or "NO" (use a user exit). The default is "NO". If LNKADAESI is set to "YES" and a value is given in LNKADASAF, the online application is used (LNKADAESI settings override LNKADASAF).

  • LNKADASAF: Specify the library and function names of the user exit that will provide access to the secured Adabas resource via the Adabas SAF Security Kernel (ADASAF). The library and function names should be specified with a space between them, using the following format:

    library function

    If no names are specified, the value "lnkxsaf lnkxsaf" is used. (The lnkxsaf library is either lnkxsaf.dll or lnkxsaf.so).

  • WCPCONFIG: Valid values for WCPCONFIG can be any valid file name.

The syntax of the AdaSetParameter API function is:

AdaSetParameter("parameter=value")

Replace parameter with one of the parameter names listed above and value with an appropriate value for that parameter.

In the following example, the name of the Entire Net-Work configuration file to be used is set to TEST.CFG:

AdaSetParameter("WCPCONFIG=TEST.CFG")

AdaSetTimeout API Function

Use the AdaSetTimeout API function to set a global time limit for a response from a remote Adabas call. The syntax of the AdaSetTimeout API function is:

AdaSetTimeout(dbid,seconds)

Replace dbid with a valid Adabas database ID and seconds with the number of seconds to use for the global time limit for the specified database.

In the following example, a 60-second timeout period is defined for database 12:

AdaSetTimeout(12,60)

AdaSetTrace API Function

Use the AdaSetTrace API function to set trace levels for ADALNK and Software AG transport services. The syntax of the AdaSetTrace API function is:

AdaSetTrace(level,{TRUE | FALSE})

Replace level with a valid trace level. Trace levels must be specified in hexadecimal and in the following format:

0xllxxxx

In the trace level syntax, substitute a hexadecimal value from "00" through "f1" for ll to represent the ADALNK trace level. Then substitute a hexadecimal value from "0000" through "FFFE" for xxxx to represent the Software AG transport services trace level.

Then specify TRUE or FALSE. If you specify TRUE, the trace level is set globally for all calls; if you specify FALSE, the trace level is set only for the thread in which the call is made.

In the following example, the maximum trace level is specified for both ADALNK and Software AG transport services, but only for the thread in which the call is made:

AdaSetTrace(0xf1FFFE,FALSE)

In the following example, the maximum trace level is specified for ADALNK calls and no tracing is performed for Software AG transport services. These settings are made globally for all calls:

AdaSetTrace(0xf10000,TRUE)

AdaSetSaf API Function

Use the AdaSetSaf API function to specify external security interface access information to the user exit that will provide access to the secured Adabas resource via the Adabas SAF Security Kernel (ADASAF). This is the same information you supply using the external security interface online application (read Accessing z/OS Resources Using the Online Security Application for more information).

The syntax of the AdaSetSaf API function is:

AdaSetSaf(PADASAF_INFO adasaf_info")

Replace adasaf_info with the name of a data structure that provides information in the following format:

  CE_CHAR  cUserID[8];         /* UserID                              */
  CE_CHAR  cPassword[8];       /* Password                            */
  CE_CHAR  cNewPassword[8];    /* NewPassword                         */

In the following example, the data structure "mysaf" is used to provide appropriate external security interface access information to secured Adabas resources via ADASAF:

AdaSetSaf(PADASAF_INFO mysaf