Quick Reference

Environment Variables in EntireX

This document gives an overview of environment variables in EntireX and how they are used.

Table of Environment Variables

The table below provides an overview of environment variables used on the various platforms supported by EntireX.

Environment Variable Platform Opt/
Req 		Description More Information
z/OS Win UNIX z/VSE
EXXDIR     x   R Top level directory for EntireX.  
EXXVERS     x   R Version level directory of the EntireX. Deprecated. Kept for reasons of compatibility with earlier versions.  
PATH       x   R System variable. Additional program directories required by EntireX are added to this variable by the EntireX environment script. See Shell Environment Settings.
LD_LIBRARY_PATH     x   R System variable. Additional shared library directories required by EntireX are added to this variable by the EntireX environment script. See Shell Environment Settings.
LIBPATH     x   R Same as LD_LIBRARY_PATH on AIX. See Shell Environment Settings.
CLASSPATH   x x   R System variable. Additional JAR file path entries required by EntireX are added to this variable by the EntireX environment script (UNIX) or during installation (Windows).  
ETB_ATTR   x x   O Value of Broker attribute file. Set automatically by the Broker startup shell script. See Broker Attributes.
ETB_LOG   x x   O Accounting file. See Accounting in EntireX Broker.
ETB_NONACT
NONACT		 x x x
x 		O Limits the TCP/IP connection lifetime. Stub-to-broker connection non-activity time in seconds. If not 0, connections with a non-activity time greater than ETB_NONACT will be closed. See Limiting the TCP/IP Connection Lifetime under z/OS | UNIX | Windows | z/VSE.
ETB_POOLSIZE   x x   O Values: 0 (default) for an unlimited number, or greater than 0 to limit the number of active TCP/IP connections. Takes effect only if ETB_SOCKETPOOL is set to ON (default). See Configuring the Socket Pool under UNIX | Windows.
ETB_POOLTIMEOUT   x x   O Values: 300 (default) to set the number of seconds to wait for a free TCP/IP connection if the maximum number of active connections has been reached. Takes effect only if ETB_SOCKETPOOL is set to ON (default). See Configuring the Socket Pool under UNIX | Windows.
ETB_SOCKETPOOL x x x   O TCP/IP:
ON Default. Establish an affinity between threads and TCP/IP connections in a DVIPA environment.
OFF Do not establish an affinity.
See Support of Clustering in a High Availability Scenario under z/OS | UNIX | Windows.
SSL/TLS:
OFF Socket pooling is ignored for SSL transport. The behavior is like ETB_SOCKETPOOL=OFF. This was introduced in EntireX version 10.7 to make sure each SSL participant (thread) presents a valid certificate for authentication using SSL Client Certificates.
See Using SSL Certificates for Authentication in the EntireX Security documentation for z/OS.
ETB_STUBLOG
STUBLOG		 x x x
x 		O Trace level for the EntireX Broker API. See Tracing for Broker Stubs under z/OS | UNIX | Windows | z/VSE.
ETB_STUBLOGPATH   x x   O Under UNIX and Windows, the directory where the log file is created if ETB_STUBLOG is used.  
ETB_TIMEOUT
TIMEOUT 		x x x
x 		O Stub transport timeout. See Setting the Timeout for the Transport Method under z/OS | UNIX | Windows | BS2000 | z/VSE.
ERX_TRACELEVEL   x x   O Sets the trace level for EntireX RPC Runtime. Tracing for various EntireX components such as DCOM Wrapper, .NET Wrapper and C Wrapper. See Tracing webMethods EntireX under UNIX | Windows | BS2000 | z/VSE.
ETB_TRANSPORT
TRANSPORT 		x x x
x 		O Sets the default transport method for Broker stubs. See Transport Methods for Broker Stubs under z/OS | UNIX | Windows | BS2000 | z/VSE.
ADALNK   x x   O The Adabas module that is needed by the Broker kernel to access the Adabas persistent store. See Managing the Broker Persistent Store under z/OS | UNIX | Windows | BS2000.
ETBLNK     x   R Identifies the absolute path to the broker stubs library if EntireX Broker has been installed. See Broker Stubs.
ERX_TRACEFILE   x x   O Sets the name of the trace file for EntireX RPC Runtime. Tracing for various EntireX components such as DCOM Wrapper, .NET Wrapper and C Wrapper. See Tracing webMethods EntireX under UNIX | Windows | BS2000 | z/VSE.
ERX_ETBAPIVERS   x x   O Determines the Broker API version to use. EntireX components such as DCOM Wrapper, .NET Wrapper and C Wrapper and the EntireX Broker are able to detect automatically the best API version to use (if no environment variable is defined or the value 0 is assigned). However, for backward compatibility to EntireX Broker, it might be necessary to set a preferred API Version for the Broker.
ERX_CODEPAGE   x x   O Override or set a code page identifier used for ICU conversion for RPC clients generated with the C Wrapper, DCOM Wrapper and .NET Wrapper. For more information see Using Internationalization with the C Wrapper | DCOM Wrapper | .NET Wrapper.
MONITOR_BROKER_OUTFILE     x   O Specifies an alternative output file for EntireX command-line monitoring script monitor_broker_to_csv_file.bat. The default output is written to <drive>:\Users\user_id\documents\SoftwareAG\EntireX\out_monitor_broker.csv. See Monitoring Broker under EntireX Monitoring Scripts.
MONITOR_CLIENT_OUTFILE     x   O Specifies an alternative output file for EntireX command-line monitoring script monitor_client_to_csv_file.bat. The default output is written to <drive>:\Users\user_id\documents\SoftwareAG\EntireX\out_monitor_clients.csv. See Monitoring Clients.
MONITOR_SERVICE_OUTFILE     x   O Specifies an alternative output file for EntireX command-line monitoring script monitor_service_to_csv_file.bat. The default output is written to <drive>:\Users\user_id\documents\SoftwareAG\EntireX\out_monitor_service.csv. See Monitoring Services.
MONITOR_VERIFY     x   O If MONITOR_VERIFY=YES, an EntireX monitoring script that writes to a CSV file pauses on first execution so you can confirm that the correct parameters are being used.
If MONITOR_VERIFY=NO, the monitoring script writes to CSV file without waiting for your confirmation. 		 
NA2_BKDBGS   x x   O Security exit debug level. Used for protecting the Broker kernel on UNIX and Windows to leverage the local security system.  
NA2_BKDBGF   x x   O Security exit debug file. Used for protecting the Broker kernel on UNIX and Windows to leverage the local security system. See Setting up EntireX Security for Broker Kernel under UNIX | Windows.
NA2_BKDIAG   x x   O Security exit diagnostics. Use only if requested by Software AG Support.  
NA2_BKPRIV   x x   O Security exit setting. See Setting up EntireX Security for Broker Kernel under UNIX | Windows.
REGFILE     x   R RGS repository for Software AG Base Technology components under UNIX.  

Using Environment Variables under z/OS

Under CICS, Batch and IMS, use the SAGTOKEN Utility to set and delete environment variables. See SAGTOKEN Utility under Administering Broker Stubs in the z/OS Administration documentation.

In Com-plete, use the EXAENV environment store to set and delete environment variables. See EXAENV Environment Store under Administering Broker Stubs in the z/OS Administration documentation.

Using Environment Variables under UNIX

The following table shows how to use environment variables with the C, Bourne and Korn shells. For other shells, see your UNIX documentation.

C Shell

Action Syntax Example
Set environment variable setenv variable value setenv ERX_TRACELEVEL ADVANCED
Delete environment variable unsetenv variable unsetenv ERX_TRACELEVEL

Bourne and Korn Shells

Action Syntax Example
Set environment variable variable = value
export variable 		ERX_TRACELEVEL=ADVANCED
export ERX_TRACELEVEL
Delete environment variable unset variable unset ERX_TRACELEVEL

Using Environment Variables under Windows

The following table shows how to use environment variables under Windows:

Action Syntax Examples
Set environment variable SET variable = value SET ERX_TRACELEVEL=ADVANCED
SET ETB_STUBLOG=NONE
Delete environment variable SET variable = SET ERX_TRACELEVEL=

Using Environment Variables under BS2000 (Batch, Dialog)

Environment variables are emulated with SDF variables or, failing that, with job variables.

Replace all underscores in the variable names by hyphens. For example, variable ETB_STUBLOG is called ETB-STUBLOG under BS2000.

The following table shows how to use job variables under BS2000:

Action Syntax Example
Set environment variable /CATJV variable /CATJV ETB-STUBLOG
/SETJV variable,C'value' /SETJV ETB-STUBLOG,C'1'
Delete environment variable /ERAJV variable /ERAJV ETB-STUBLOG

Using Environment Variables under z/VSE

Action Syntax Examples
Set environment variable //SETPARM variable = value //SETPARM STUBLOG=2
Delete environment variable Remove SETPARM statement /* /SETPARM STUBLOG=2